IC state structure. More...

#include <ic_state.h>

Public Attributes
bfp_s32_t	y_bfp [IC_Y_CHANNELS]

bfp_complex_s32_t	Y_bfp [IC_Y_CHANNELS]

int32_t	y [IC_Y_CHANNELS][IC_FRAME_LENGTH+FFT_PADDING]

bfp_s32_t	x_bfp [IC_X_CHANNELS]

bfp_complex_s32_t	X_bfp [IC_X_CHANNELS]

int32_t	x [IC_X_CHANNELS][IC_FRAME_LENGTH+FFT_PADDING]

bfp_s32_t	prev_y_bfp [IC_Y_CHANNELS]

int32_t	y_prev_samples [IC_Y_CHANNELS][IC_FRAME_LENGTH - IC_FRAME_ADVANCE]

bfp_s32_t	prev_x_bfp [IC_X_CHANNELS]

int32_t	x_prev_samples [IC_X_CHANNELS][IC_FRAME_LENGTH - IC_FRAME_ADVANCE]

bfp_complex_s32_t	Y_hat_bfp [IC_Y_CHANNELS]

complex_s32_t	Y_hat [IC_Y_CHANNELS][IC_FD_FRAME_LENGTH]

bfp_complex_s32_t	Error_bfp [IC_Y_CHANNELS]

bfp_s32_t	error_bfp [IC_Y_CHANNELS]

complex_s32_t	Error [IC_Y_CHANNELS][IC_FD_FRAME_LENGTH]

bfp_complex_s32_t	H_hat_bfp [IC_Y_CHANNELS][IC_X_CHANNELS *IC_FILTER_PHASES]

complex_s32_t	H_hat [IC_Y_CHANNELS][IC_FILTER_PHASES *IC_X_CHANNELS][IC_FD_FRAME_LENGTH]

bfp_complex_s32_t	X_fifo_bfp [IC_X_CHANNELS][IC_FILTER_PHASES]

bfp_complex_s32_t	X_fifo_1d_bfp [IC_X_CHANNELS *IC_FILTER_PHASES]

complex_s32_t	X_fifo [IC_X_CHANNELS][IC_FILTER_PHASES][IC_FD_FRAME_LENGTH]

bfp_complex_s32_t	T_bfp [IC_X_CHANNELS]

bfp_s32_t	inv_X_energy_bfp [IC_X_CHANNELS]

int32_t	inv_X_energy [IC_X_CHANNELS][IC_FD_FRAME_LENGTH]

bfp_s32_t	X_energy_bfp [IC_X_CHANNELS]

int32_t	X_energy [IC_X_CHANNELS][IC_FD_FRAME_LENGTH]

unsigned	X_energy_recalc_bin

bfp_s32_t	overlap_bfp [IC_Y_CHANNELS]

int32_t	overlap [IC_Y_CHANNELS][IC_FRAME_OVERLAP]

int32_t	y_input_delay [IC_Y_CHANNELS][IC_Y_CHANNEL_DELAY_SAMPS]

uint32_t	y_delay_idx [IC_Y_CHANNELS]

float_s32_t	mu [IC_Y_CHANNELS][IC_X_CHANNELS]

float_s32_t	error_ema_energy [IC_Y_CHANNELS]

float_s32_t	max_X_energy [IC_X_CHANNELS]

bfp_s32_t	sigma_XX_bfp [IC_X_CHANNELS]

int32_t	sigma_XX [IC_X_CHANNELS][IC_FD_FRAME_LENGTH]

float_s32_t	sum_X_energy [IC_X_CHANNELS]

ic_config_params_t	config_params

ic_adaption_controller_state_t	ic_adaption_controller_state

Detailed Description

IC state structure.

This is the main state structure for an instance of the Interference Canceller. Before use it must be initialised using the ic_init() function. It contains everything needed for the IC instance including configuration and internal state of both the filter, adaption logic and adaption controller.

Member Data Documentation

◆ config_params

ic_config_params_t ic_state_t::config_params

Configuration parameters for the IC.

◆ Error

complex_s32_t ic_state_t::Error[IC_Y_CHANNELS][IC_FD_FRAME_LENGTH]

Storage for Error and error mantissas. Note IFFT is done in-place so the Error storage is reused for error.

◆ Error_bfp

bfp_complex_s32_t ic_state_t::Error_bfp[IC_Y_CHANNELS]

BFP array pointing to the frequency domain Error output.

◆ error_bfp

bfp_s32_t ic_state_t::error_bfp[IC_Y_CHANNELS]

BFP array pointing to the time domain Error output.

◆ error_ema_energy

float_s32_t ic_state_t::error_ema_energy[IC_Y_CHANNELS]

Filtered error energy.

◆ H_hat

complex_s32_t ic_state_t::H_hat[IC_Y_CHANNELS][IC_FILTER_PHASES *IC_X_CHANNELS][IC_FD_FRAME_LENGTH]

Storage for H_hat mantissas.

◆ H_hat_bfp

bfp_complex_s32_t ic_state_t::H_hat_bfp[IC_Y_CHANNELS][IC_X_CHANNELS *IC_FILTER_PHASES]

BFP array pointing to the frequency domain estimate of transfer function.

◆ ic_adaption_controller_state

ic_adaption_controller_state_t ic_state_t::ic_adaption_controller_state

State and configuration parameters for the IC adaption controller.

◆ inv_X_energy

int32_t ic_state_t::inv_X_energy[IC_X_CHANNELS][IC_FD_FRAME_LENGTH]

Storage for inv_X_energy mantissas.

◆ inv_X_energy_bfp

bfp_s32_t ic_state_t::inv_X_energy_bfp[IC_X_CHANNELS]

BFP array pointing to the inverse X energies used for normalisation.

◆ max_X_energy

float_s32_t ic_state_t::max_X_energy[IC_X_CHANNELS]

Used to keep track of peak X energy.

◆ mu

float_s32_t ic_state_t::mu[IC_Y_CHANNELS][IC_X_CHANNELS]

Mu value used for controlling adaption rate.

◆ overlap

int32_t ic_state_t::overlap[IC_Y_CHANNELS][IC_FRAME_OVERLAP]

Storage for overlap mantissas.

◆ overlap_bfp

bfp_s32_t ic_state_t::overlap_bfp[IC_Y_CHANNELS]

BFP array pointing to the overlap array used for windowing and overlap operations.

◆ prev_x_bfp

bfp_s32_t ic_state_t::prev_x_bfp[IC_X_CHANNELS]

BFP array pointing to previous x samples which are used for framing.

◆ prev_y_bfp

bfp_s32_t ic_state_t::prev_y_bfp[IC_Y_CHANNELS]

BFP array pointing to previous y samples which are used for framing.

◆ sigma_XX

int32_t ic_state_t::sigma_XX[IC_X_CHANNELS][IC_FD_FRAME_LENGTH]

Storage for sigma_XX mantissas.

◆ sigma_XX_bfp

bfp_s32_t ic_state_t::sigma_XX_bfp[IC_X_CHANNELS]

BFP array pointing to the EMA filtered X input energy.

◆ sum_X_energy

float_s32_t ic_state_t::sum_X_energy[IC_X_CHANNELS]

X energy sum used for maintaining the X FIFO.

◆ T_bfp

bfp_complex_s32_t ic_state_t::T_bfp[IC_X_CHANNELS]

BFP array pointing to the frequency domain T used for adapting the filter coefficients (H). Note there is no associated storage because we re-use the x input array as a memory optimisation.