man pages section 3: Multimedia Library Functions

Exit Print View

Updated: July 2014
 
 

mlib_SignalWhiteNoiseInit_F32 (3MLIB)

Name

mlib_SignalWhiteNoiseInit_F32 - white noise generation

Synopsis

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

mlib_status mlib_SignalWhiteNoiseInit_F32(void **state, mlib_f32 mag,
     mlib_f32 seed);

Description

The mlib_SignalWhiteNoiseInit_F32() function allocates memory for an internal state structure and converts the parameters into an internal representation.

Parameters

The function takes the following arguments:

state

Internal state structure.

mag

Magnitude of white noise to be generated, in Q15 format.

seed

Seed value for the pseudorandom number generator.

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)