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

AGC configuration structure. More...

#include <agc_api.h>

Public Attributes

int adapt
 
int adapt_on_vad
 
int soft_clipping
 
float_s32_t gain
 
float_s32_t max_gain
 
float_s32_t min_gain
 
float_s32_t upper_threshold
 
float_s32_t lower_threshold
 
float_s32_t gain_inc
 
float_s32_t gain_dec
 
int lc_enabled
 
int lc_n_frame_far
 
int lc_n_frame_near
 
float_s32_t lc_corr_threshold
 
float_s32_t lc_bg_power_gamma
 
float_s32_t lc_gamma_inc
 
float_s32_t lc_gamma_dec
 
float_s32_t lc_far_delta
 
float_s32_t lc_near_delta
 
float_s32_t lc_near_delta_far_active
 
float_s32_t lc_gain_max
 
float_s32_t lc_gain_double_talk
 
float_s32_t lc_gain_silence
 
float_s32_t lc_gain_min
 

Detailed Description

AGC configuration structure.

This structure contains configuration settings that can be changed to alter the behaviour of the AGC instance.

Members with the "lc_" prefix are parameters for the Loss Control feature.

Member Data Documentation

◆ adapt

int agc_config_t::adapt

Boolean to enable AGC adaption; if enabled, the gain to apply will adapt based on the peak of the input frame and the upper/lower threshold parameters.

◆ adapt_on_vad

int agc_config_t::adapt_on_vad

Boolean to enable adaption based on the VAD meta-data; if enabled, adaption will always be performed when voice activity is detected. This must be disabled if the application doesn't have a VAD.

◆ gain

float_s32_t agc_config_t::gain

The current gain to be applied, not including loss control.

◆ gain_dec

float_s32_t agc_config_t::gain_dec

Factor by which to decrease the gain during adaption.

◆ gain_inc

float_s32_t agc_config_t::gain_inc

Factor by which to increase the gain during adaption.

◆ lc_bg_power_gamma

float_s32_t agc_config_t::lc_bg_power_gamma

Gamma coefficient for estimating the power of the far-end background noise.

◆ lc_corr_threshold

float_s32_t agc_config_t::lc_corr_threshold

Threshold for far-end correlation above which to indicate far-end activity only.

◆ lc_enabled

int agc_config_t::lc_enabled

Boolean to enable loss control. This must be disabled if the application doesn't have an AEC.

◆ lc_far_delta

float_s32_t agc_config_t::lc_far_delta

Delta multiplier used when only far-end activity is detected.

◆ lc_gain_double_talk

float_s32_t agc_config_t::lc_gain_double_talk

Loss control gain to apply when double-talk is detected.

◆ lc_gain_max

float_s32_t agc_config_t::lc_gain_max

Loss control gain to apply when near-end activity only is detected.

◆ lc_gain_min

float_s32_t agc_config_t::lc_gain_min

Loss control gain to apply when far-end activity only is detected.

◆ lc_gain_silence

float_s32_t agc_config_t::lc_gain_silence

Loss control gain to apply when silence is detected.

◆ lc_gamma_dec

float_s32_t agc_config_t::lc_gamma_dec

Factor by which to decrease the loss control gain when greater than target value.

◆ lc_gamma_inc

float_s32_t agc_config_t::lc_gamma_inc

Factor by which to increase the loss control gain when less than target value.

◆ lc_n_frame_far

int agc_config_t::lc_n_frame_far

Number of frames required to consider far-end audio active.

◆ lc_n_frame_near

int agc_config_t::lc_n_frame_near

Number of frames required to consider near-end audio active.

◆ lc_near_delta

float_s32_t agc_config_t::lc_near_delta

Delta multiplier used when only near-end activity is detected.

◆ lc_near_delta_far_active

float_s32_t agc_config_t::lc_near_delta_far_active

Delta multiplier used when both near-end and far-end activity is detected.

◆ lower_threshold

float_s32_t agc_config_t::lower_threshold

The lower limit for the gained peak of the frame when adaption is enabled.

◆ max_gain

float_s32_t agc_config_t::max_gain

The maximum gain allowed when adaption is enabled.

◆ min_gain

float_s32_t agc_config_t::min_gain

The minimum gain allowed when adaption is enabled.

◆ soft_clipping

int agc_config_t::soft_clipping

Boolean to enable soft-clipping of the output frame.

◆ upper_threshold

float_s32_t agc_config_t::upper_threshold

The upper limit for the gained peak of the frame when adaption is enabled.


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