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

IC adaption controller configuration structure. More...

#include <ic_state.h>

Public Attributes

float_s32_t leakage_alpha
 
float_s32_t voice_chance_alpha
 
fixed_s32_t energy_alpha_slow_q30
 
fixed_s32_t energy_alpha_fast_q30
 
float_s32_t out_to_in_ratio_limit
 
float_s32_t instability_recovery_leakage_alpha
 
uint8_t enable_adaption
 
uint8_t enable_adaption_controller
 
uint8_t enable_filter_instability_recovery
 

Detailed Description

IC adaption controller configuration structure.

This structure contains configuration settings that can be changed to alter the behaviour of the adaption controller. This includes processing of the raw VAD probability input and optional stability controller logic. It is automatically included as part of the IC state and initialised by ic_init().

The initial values for these configuration parameters are defined in ic_defines.h.

Member Data Documentation

◆ enable_adaption

uint8_t ic_adaption_controller_config_t::enable_adaption

Boolean which controls whether the IC adapts when ic_adapt() is called.

◆ enable_adaption_controller

uint8_t ic_adaption_controller_config_t::enable_adaption_controller

Boolean which controls whether Mu is automatically adjusted from the VAD input.

◆ enable_filter_instability_recovery

uint8_t ic_adaption_controller_config_t::enable_filter_instability_recovery

Boolean which controls whether to enable detection and recovery from instability in the case when the adaption controller is enabled.

◆ energy_alpha_fast_q30

fixed_s32_t ic_adaption_controller_config_t::energy_alpha_fast_q30

Fast alpha used filtering input and output energies of IC.

◆ energy_alpha_slow_q30

fixed_s32_t ic_adaption_controller_config_t::energy_alpha_slow_q30

Slow alpha used filtering input and output energies of IC.

◆ instability_recovery_leakage_alpha

float_s32_t ic_adaption_controller_config_t::instability_recovery_leakage_alpha

Setting of H_hat leakage which gets set if fast ratio exceeds a threshold.

◆ leakage_alpha

float_s32_t ic_adaption_controller_config_t::leakage_alpha

Alpha used for leaking away H_hat, allowing filter to slowly forget adaption.

◆ out_to_in_ratio_limit

float_s32_t ic_adaption_controller_config_t::out_to_in_ratio_limit

Ratio of the output to input at which the filter will reset. Setting it to 2.0 is a good rule of thumb.

◆ voice_chance_alpha

float_s32_t ic_adaption_controller_config_t::voice_chance_alpha

Alpha used for low pass filtering the voice chance estimate based on VAD input.


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