Acoustic EC Software Library: D:/Documents/Repositories/DMIC/Private/Fw/OSX_Libraries/EchoCancellation/trunk/export/acoustic_ec.h Source File

STM32 Acoustic EC

previous page next page
acoustic_ec.h
1 
55 /* Define to prevent recursive inclusion -------------------------------------*/
56 #ifndef __ACOUSTIC_EC_H
57 #define __ACOUSTIC_EC_H
58 
59 /* Includes ------------------------------------------------------------------*/
60 #include "stdint.h"
61 /* Exported constants --------------------------------------------------------*/
62 /* Exported macro ------------------------------------------------------------*/
63 /* Exported define -----------------------------------------------------------*/
64 /* Exported functions ------------------------------------------------------- */
65 /* Exported types ------------------------------------------------------------*/
66 
83 #define ACOUSTIC_EC_TAIL_LENGTH_ERROR ((uint32_t)0x00000001)
84 #define ACOUSTIC_EC_AEC_LEVEL_ERROR ((uint32_t)0x00000002)
85 #define ACOUSTIC_EC_PTR_CHANNELS_ERROR ((uint32_t)0x00000004)
86 #define ACOUSTIC_EC_PREPROCESS_ERROR ((uint32_t)0x00000010)
87 
88 #ifndef ACOUSTIC_LOCK_ERROR
89 #define ACOUSTIC_LOCK_ERROR ((uint32_t)0x10000000)
90 #endif
91 
99 #define ACOUSTIC_EC_PREPROCESS_ENABLE ((uint32_t)0x00000001)
100 #define ACOUSTIC_EC_PREPROCESS_DISABLE ((uint32_t)0x00000000)
101 
117 typedef struct
118 {
119  uint16_t tail_length;
120  uint32_t preprocess_init;
121  uint16_t ptr_primary_channels;
122  uint16_t ptr_reference_channels;
123  uint16_t ptr_output_channels;
124  uint32_t internal_memory_size;
127  uint32_t * pInternalMemory;
129 }
130 AcousticEC_Handler_t;
131 
135 typedef struct
136 {
137  uint32_t preprocess_state;
138  uint32_t AGC_value;
139  uint32_t residual_echo_remove;
140  int32_t noise_suppress_default;
141  int32_t echo_suppress_default;
142  int32_t echo_suppress_active;
143 }
144 AcousticEC_Config_t;
145 
160 uint32_t AcousticEC_getMemorySize(AcousticEC_Handler_t * pHandler);
161 
169 uint32_t AcousticEC_Init(AcousticEC_Handler_t * pHandler);
170 
184 uint32_t AcousticEC_Data_Input(void *ptrPrimary, void *ptrReference, void *ptrBufferOut, AcousticEC_Handler_t * pHandler);
185 
191 uint32_t AcousticEC_Process(AcousticEC_Handler_t * pHandler);
192 
200 uint32_t AcousticEC_setConfig(AcousticEC_Handler_t * pHandler, AcousticEC_Config_t * pConfig);
201 
208 uint32_t AcousticEC_getConfig(AcousticEC_Handler_t * pHandler, AcousticEC_Config_t * pConfig);
209 
215 uint32_t AcousticEC_GetLibVersion(char *version);
216 
217 
218 
230 #endif /*__ACOUSTIC_EC_H*/
231 
232 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/
AcousticEC_Config_t
Library dynamic configuration handler. It contains dynamic parameters.
Definition: acoustic_ec.h:135
AcousticEC_Init
uint32_t AcousticEC_Init(AcousticEC_Handler_t *pHandler)
Library initialization.
AcousticEC_Config_t::residual_echo_remove
uint32_t residual_echo_remove
Definition: acoustic_ec.h:139
AcousticEC_Handler_t::ptr_primary_channels
uint16_t ptr_primary_channels
Definition: acoustic_ec.h:121
AcousticEC_Handler_t::ptr_reference_channels
uint16_t ptr_reference_channels
Definition: acoustic_ec.h:122
AcousticEC_setConfig
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 cha...
AcousticEC_Process
uint32_t AcousticEC_Process(AcousticEC_Handler_t *pHandler)
Library run function, performs audio analysis when all required data has been collected.
AcousticEC_Config_t::noise_suppress_default
int32_t noise_suppress_default
Definition: acoustic_ec.h:140
AcousticEC_Config_t::echo_suppress_default
int32_t echo_suppress_default
Definition: acoustic_ec.h:141
AcousticEC_getConfig
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...
AcousticEC_Config_t::AGC_value
uint32_t AGC_value
Definition: acoustic_ec.h:138
AcousticEC_Handler_t::internal_memory_size
uint32_t internal_memory_size
Definition: acoustic_ec.h:124
AcousticEC_GetLibVersion
uint32_t AcousticEC_GetLibVersion(char *version)
To be used to retrieve version information.
AcousticEC_Handler_t::pInternalMemory
uint32_t * pInternalMemory
Definition: acoustic_ec.h:127
AcousticEC_Handler_t::tail_length
uint16_t tail_length
Definition: acoustic_ec.h:119
AcousticEC_Data_Input
uint32_t AcousticEC_Data_Input(void *ptrPrimary, void *ptrReference, void *ptrBufferOut, AcousticEC_Handler_t *pHandler)
Library data input and output function.
AcousticEC_Handler_t
Library handler. It keeps track of the static parameters and it handles the internal state of the alg...
Definition: acoustic_ec.h:117
AcousticEC_getMemorySize
uint32_t AcousticEC_getMemorySize(AcousticEC_Handler_t *pHandler)
Fills the "internal_memory_size" of the pHandler parameter passed as argument with a value representi...
AcousticEC_Config_t::echo_suppress_active
int32_t echo_suppress_active
Definition: acoustic_ec.h:142
AcousticEC_Handler_t::ptr_output_channels
uint16_t ptr_output_channels
Definition: acoustic_ec.h:123
AcousticEC_Handler_t::preprocess_init
uint32_t preprocess_init
Definition: acoustic_ec.h:120
AcousticEC_Config_t::preprocess_state
uint32_t preprocess_state
Definition: acoustic_ec.h:137
Generated by   doxygen 1.8.11
previous page start next page