opensolaris man page for mlib_signalupsamplefirinit_f32_f32

mlib_SignalUpSampleFIRInit_F32_F32(3MLIB)		    mediaLib Library Functions			 mlib_SignalUpSampleFIRInit_F32_F32(3MLIB)

NAME
       mlib_SignalUpSampleFIRInit_F32_F32 - upsampling with filtering

SYNOPSIS
       cc [ flag... ] file... -lmlib [ library... ]
       #include <mlib.h>

       mlib_status mlib_SignalUpSampleFIRInit_F32_F32(void **state,
	    const mlib_f32 *flt, mlib_s32 tap, mlib_s32 factor,
	    mlib_s32 phase);

DESCRIPTION
       The  mlib_SignalUpSampleFIRInit_F32_F32()  function  allocates  memory for the internal state structure and converts the parameters into an
       internal representation for upsampling immediately followed by FIR filtering.

PARAMETERS
       The function takes the following arguments:

       state	 Internal state structure.

       flt	 Filter coefficient array.

       tap	 Taps of the filter.

       factor	 Factor by which to upsample.

       phase	 Parameter that determines the relative position of an input value, within the output signal. 0 <= phase < factor.

RETURN VALUES
       The function returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       attributes(5)

SunOS 5.11							    2 Mar 2007				 mlib_SignalUpSampleFIRInit_F32_F32(3MLIB)