Content-type: text/html Man page of mlib_SignalSineWaveInit_F32

mlib_SignalSineWaveInit_F32

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

NAME

mlib_SignalSineWaveInit_F32 - sine wave generation  

SYNOPSIS

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

mlib_status mlib_SignalSineWaveInit_F32(void **state, 
    mlib_f32 mag, mlib_f32 freq, mlib_f32 phase);

 

DESCRIPTION

The mlib_SignalSineWaveInit_F32() function allocates memory for an internal state structure and converts the parameters of the wave to an internal representation.  

PARAMETERS

The function takes the following arguments:

state

Internal state structure.

mag

Magnitude of sine wave to be generated, in Q15 format.

freq

Angular frequency of the sine wave to be generated, measured in radians per sample.

phase

Start phase of the sine wave to be generated, measured in radians.

 

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

Interface StabilityCommitted

MT-Level

 

SEE ALSO

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:13 GMT, October 02, 2010