AcousticBF Exported Functions

Functions
uint32_t	AcousticEC_getMemorySize (AcousticEC_Handler_t *pHandler)
	Fills the "internal_memory_size" of the pHandler parameter passed as argument with a value representing the right amount of memory needed by the library, depending on the specific static parameters adopted. More...
uint32_t	AcousticEC_Init (AcousticEC_Handler_t *pHandler)
	Library initialization. More...
uint32_t	AcousticEC_Data_Input (void *ptrPrimary, void *ptrReference, void *ptrBufferOut, AcousticEC_Handler_t *pHandler)
	Library data input and output function. More...
uint32_t	AcousticEC_Process (AcousticEC_Handler_t *pHandler)
	Library run function, performs audio analysis when all required data has been collected. More...
uint32_t	AcousticEC_setConfig (AcousticEC_Handler_t *pHandler, AcousticEC_Config_t *pConfig)
	Library setup function, it sets the values for dynamic parameters. It can be called at runtime to change dynamic parameters. More...
uint32_t	AcousticEC_getConfig (AcousticEC_Handler_t *pHandler, AcousticEC_Config_t *pConfig)
	Fills the pConfig structure with the actual dynamic parameters as they are used inside the library. More...
uint32_t	AcousticEC_GetLibVersion (char *version)
	To be used to retrieve version information. More...

Detailed Description

Function Documentation

uint32_t AcousticEC_Data_Input	(	void *	ptrPrimary,
		void *	ptrReference,
		void *	ptrBufferOut,
		AcousticEC_Handler_t *	pHandler
	)

Library data input and output function.

Parameters

ptrPrimary	pointer to an array that contains PCM samples (16 bit signed int) of the primary signal (1 ms = 16 samples at 16 KHZ).
ptrReference	pointer to an array that contains PCM samples (16 bit signed int) of the reference (echo) signal (1 ms = 16 samples at 16 KHZ).
ptrBufferOut	pointer to an array that will contain output PCM samples (1 ms for processed channel = 16 samples at 16 KHZ).
pHandler	pointer to the handler of the current SpeexAEC instance running.

Return values

1	if data collection is finished and libSpeexAEC_Process must be called, 0 otherwise.

Note

Input/output function reads and write samples skipping the required number of values depending on the ptr_Mx_channels configuration

uint32_t AcousticEC_getConfig	(	AcousticEC_Handler_t *	pHandler,
		AcousticEC_Config_t *	pConfig
	)

Fills the pConfig structure with the actual dynamic parameters as they are used inside the library.

Parameters

pHandler	AcousticEC_Handler_t filled with desired parameters.
pConfig	pointer to the dynamic parameters handler that will be filled with the current library configuration.

Return values

0	if everything is ok, 1 otherwise.

uint32_t AcousticEC_GetLibVersion

(

char *

version

)

To be used to retrieve version information.

Parameters

none

Return values

Version

Number.

uint32_t AcousticEC_getMemorySize

(

AcousticEC_Handler_t *

pHandler

)

Fills the "internal_memory_size" of the pHandler parameter passed as argument with a value representing the right amount of memory needed by the library, depending on the specific static parameters adopted.

Parameters

pHandler

AcousticEC_Handler_t filled with desired parameters.

Return values

0	if everything is fine.

uint32_t AcousticEC_Init

(

AcousticEC_Handler_t *

pHandler

)

Library initialization.

Parameters

pHandler

AcousticEC_Handler_t filled with desired parameters.

Return values

0	if everything is fine. different from 0 if erroneous parameters have been passed to the Init function and the default value has been used. The specific error can be recognized by checking the relative bit in the returned word.

uint32_t AcousticEC_Process

(

AcousticEC_Handler_t *

pHandler

)

Library run function, performs audio analysis when all required data has been collected.

Parameters

pHandler

pointer to the handler of the current SpeexAEC instance running

Return values

0	if everything is ok, 1 otherwise.

uint32_t AcousticEC_setConfig	(	AcousticEC_Handler_t *	pHandler,
		AcousticEC_Config_t *	pConfig
	)

Library setup function, it sets the values for dynamic parameters. It can be called at runtime to change dynamic parameters.

Parameters

pHandler	AcousticEC_Handler_t filled with desired parameters.
pConfig	pointer to the dynamic parameters handler that will be filled with the current library configuration.

Return values

0	if everything is ok, 1 otherwise.