Content-type: text/html Man page of mlib_SignalDownSample_S16_S16

mlib_SignalDownSample_S16_S16

Section: mediaLib Library Functions (3MLIB)
Updated: 2 Mar 2007
Index Return to Main Contents
 

NAME

mlib_SignalDownSample_S16_S16, mlib_SignalDownSample_S16S_S16S, mlib_SignalDownSample_F32_F32, mlib_SignalDownSample_F32S_F32S - signal downsampling  

SYNOPSIS

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

mlib_status mlib_SignalDownSample_S16_S16(mlib_s16 *dst, 
    const mlib_s16 *src, mlib_s32 factor, mlib_s32 phase, 
    mlib_s32 n);

mlib_status mlib_SignalDownSample_S16S_S16S(mlib_s16 *dst, 
    const mlib_s16 *src, mlib_s32 factor, mlib_s32 phase, 
    mlib_s32 n);

mlib_status mlib_SignalDownSample_F32_F32(mlib_f32 *dst, 
    const mlib_f32 *src, mlib_s32 factor, mlib_s32 phase, 
    mlib_s32 n);

mlib_status mlib_SignalDownSample_F32S_F32S(mlib_f32 *dst, 
    const mlib_f32 *src, mlib_s32 factor, mlib_s32 phase, 
    mlib_s32 n);

 

DESCRIPTION

Each of these functions performs downsampling.

For monaural signals, the following equation is used:

dst[i] = src[i*factor + phase]

where i = 0, 1, ..., (n - 1 - phase)/factor.

For stereo signals, the following equation is used:

dst[2*i]     = src[2*(i*factor + phase)]
dst[2*i + 1] = src[2*(i*factor + phase) + 1]

where i = 0, 1, ..., (n - 1 - phase)/factor.  

PARAMETERS

Each of the functions takes the following arguments:

dst

Output signal array.

src

Input signal array.

factor

Factor by which to downsample. factor ≥ 1.

phase

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

n

Number of samples in the input signal array.

 

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 TYPEATTRIBUTE VALUE

Interface StabilityCommitted

MT-Level

 

SEE ALSO

mlib_SignalUpSample_S16_S16(3MLIB), attributes(5)


 

Index

NAME
SYNOPSIS
DESCRIPTION
PARAMETERS
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:38:14 GMT, October 02, 2010