opensolaris man page for mlib_signalresamplefirinit_s16s_s16s

mlib_SignalReSampleFIRInit_S16_S16(3MLIB)		    mediaLib Library Functions			 mlib_SignalReSampleFIRInit_S16_S16(3MLIB)

NAME
       mlib_SignalReSampleFIRInit_S16_S16,    mlib_SignalReSampleFIRInit_S16S_S16S,    mlib_SignalReSampleFIRInit_F32_F32,    mlib_SignalReSample-
       FIRInit_F32S_F32S - initialization for resampling with filtering

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

       mlib_status mlib_SignalReSampleFIRInit_S16_S16(void **state,
	    const mlib_f32 *flt, mlib_s32 tap, mlib_s32 ufactor,
	    mlib_s32 uphase, mlib_s32 dfactor, mlib_s32 dphase);

       mlib_status mlib_SignalReSampleFIRInit_S16S_S16S(void **state,
	    const mlib_f32 *flt, mlib_s32 tap, mlib_s32 ufactor,
	    mlib_s32 uphase, mlib_s32 dfactor, mlib_s32 dphase);

       mlib_status mlib_SignalReSampleFIRInit_F32_F32(void **state,
	    const mlib_f32 *flt, mlib_s32 tap, mlib_s32 ufactor,
	    mlib_s32 uphase, mlib_s32 dfactor, mlib_s32 dphase);

       mlib_status mlib_SignalReSampleFIRInit_F32S_F32S(void **state,
	    const mlib_f32 *flt, mlib_s32 tap, mlib_s32 ufactor,
	    mlib_s32 uphase, mlib_s32 dfactor, mlib_s32 dphase);

DESCRIPTION
       Each of these functions allocates memory for the internal state structure and converts the parameters into an internal  representation  for
       rational sample rate conversion with FIR filtering between upsampling and downsampling.

PARAMETERS
       Each of the functions takes the following arguments:

       state	  Internal state structure.

       flt	  Filter coefficient array, two-channel interleaved in the cases of stereo.

       tap	  Taps of the filter.

       ufactor	  Factor by which to upsample.

       uphase	  Phase in upsampling. 0 <= uphase < ufactor.

       dfactor	  Factor by which to downsample.

       dphase	  Phase in downsampling. 0 <= dphase < dfactor.

RETURN VALUES
       Each of the functions 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
       mlib_SignalReSampleFIR_S16_S16_Sat(3MLIB), mlib_SignalReSampleFIR_F32_F32(3MLIB), mlib_SignalReSampleFIRFree_S16_S16(3MLIB), mlib_SignalRe-
       SampleFIRFree_F32_F32(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007				 mlib_SignalReSampleFIRInit_S16_S16(3MLIB)