man pages section 3: Multimedia Library Functions

Exit Print View

Updated: July 2014
 
 

mlib_SignalUpSampleFIRInit_S16_S16 (3MLIB)

Name

mlib_SignalUpSampleFIRInit_S16_S16, mlib_SignalUpSampleFIRInit_S16S_S16S - upsampling with filtering

Synopsis

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

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

Description

Each of these functions allocates memory for the internal state structure and converts the parameters into an internal representation for upsampling immediately followed by FIR filtering.

Parameters

Each of the functions 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

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_SignalUpSampleFIR_S16_S16_Sat(3MLIB), mlib_SignalUpSampleFIRFree_S16_S16(3MLIB), attributes(5)