XCORE SDK
XCORE Software Development Kit
Public Attributes | List of all members
ic_config_params_t Struct Reference

IC configuration structure. More...

#include <ic_state.h>

Public Attributes

uint8_t bypass
 
int32_t gamma_log2
 
uint32_t sigma_xx_shift
 
fixed_s32_t ema_alpha_q30
 
float_s32_t delta
 

Detailed Description

IC configuration structure.

This structure contains configuration settings that can be changed to alter the behaviour of the IC instance. An instance of this structure is is automatically included as part of the IC state.

It controls the behaviour of the main filter and normalisation thereof. The initial values for these configuration parameters are defined in ic_defines.h and are initialised by ic_init().

Member Data Documentation

◆ bypass

uint8_t ic_config_params_t::bypass

Boolean to control bypassing of filter stage and adaption stage. When set the delayed y audio samples are passed unprocessed to the output. It is recommended to perform an initialisation of the instance after bypass is set as the room transfer function may have changed during that time.

◆ delta

float_s32_t ic_config_params_t::delta

Delta value used in denominator to avoid large values when calculating inverse X energy.

◆ ema_alpha_q30

fixed_s32_t ic_config_params_t::ema_alpha_q30

Alpha used for calculating error_ema_energy in adapt.

◆ gamma_log2

int32_t ic_config_params_t::gamma_log2

Up scaling factor for X energy calculation used for normalisation.

◆ sigma_xx_shift

uint32_t ic_config_params_t::sigma_xx_shift

Down scaling factor for X energy for used for normalisation.


The documentation for this struct was generated from the following file: