aec_api.h

// Copyright 2022 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.
#ifndef AEC_API_H
#define AEC_API_H
 
#include <stdio.h>
#include <string.h>
#include "bfp_math.h"
#include "xs3_math.h"
#include "aec_state.h"
 
void aec_init(
        aec_state_t *main_state,
        aec_state_t *shadow_state,
        aec_shared_state_t *shared_state,
        uint8_t *main_mem_pool,
        uint8_t *shadow_mem_pool,
        unsigned num_y_channels,
        unsigned num_x_channels,
        unsigned num_main_filter_phases,
        unsigned num_shadow_filter_phases);
 
 
void aec_frame_init(
        aec_state_t *main_state,
        aec_state_t *shadow_state,
        const int32_t (*y_data)[AEC_FRAME_ADVANCE],
        const int32_t (*x_data)[AEC_FRAME_ADVANCE]);
 
void aec_calc_freq_domain_energy(
        float_s32_t *fd_energy,
        const bfp_complex_s32_t *input);
 
void aec_calc_time_domain_ema_energy(
        float_s32_t *ema_energy,
        const bfp_s32_t *input,
        unsigned start_offset,
        unsigned length,
        const aec_config_params_t *conf);
 
void aec_forward_fft(
        bfp_complex_s32_t *output,
        bfp_s32_t *input);
 
void aec_inverse_fft(
        bfp_s32_t *output,
        bfp_complex_s32_t *input
        );
 
void aec_calc_X_fifo_energy(
        aec_state_t *state,
        unsigned ch,
        unsigned recalc_bin);
 
void aec_update_X_fifo_and_calc_sigmaXX(
        aec_state_t *state,
        unsigned ch);
 
void aec_calc_Error_and_Y_hat(
        aec_state_t *state,
        unsigned ch);
 
void aec_calc_coherence(
        aec_state_t *state,
        unsigned ch);
 
void aec_calc_output(
        aec_state_t *state,
        int32_t (*output)[AEC_FRAME_ADVANCE],
        unsigned ch);
 
void aec_calc_normalisation_spectrum(
        aec_state_t *state,
        unsigned ch,
        unsigned is_shadow);
 
void aec_compare_filters_and_calc_mu(
        aec_state_t *main_state,
        aec_state_t *shadow_state);
 
void aec_calc_T(
        aec_state_t *state,
        unsigned y_ch,
        unsigned x_ch);
 
void aec_filter_adapt(
        aec_state_t *state,
        unsigned y_ch);
 
void aec_update_X_fifo_1d(
        aec_state_t *state);
 
float_s32_t aec_calc_corr_factor(
        aec_state_t *state,
        unsigned ch);
 
float_s32_t aec_calc_max_input_energy(
        const int32_t (*input_data)[AEC_FRAME_ADVANCE],
        int num_channels);
 
void aec_reset_state(aec_state_t *main_state, aec_state_t *shadow_state);
 
uint32_t aec_detect_input_activity(const int32_t (*input_data)[AEC_FRAME_ADVANCE], float_s32_t active_threshold, int32_t num_channels);
 
//TODO pending documentation and examples for L2 APIs
void aec_l2_calc_Error_and_Y_hat(
        bfp_complex_s32_t *Error,
        bfp_complex_s32_t *Y_hat,
        const bfp_complex_s32_t *Y,
        const bfp_complex_s32_t *X_fifo,
        const bfp_complex_s32_t *H_hat,
        unsigned num_x_channels,
        unsigned num_phases,
        unsigned start_offset,
        unsigned length,
        int32_t bypass_enabled);
 
void aec_l2_adapt_plus_fft_gc(
        bfp_complex_s32_t *H_hat_ph,
        const bfp_complex_s32_t *X_fifo_ph,
        const bfp_complex_s32_t *T_ph
        );
 
void aec_l2_bfp_complex_s32_unify_exponent(
        bfp_complex_s32_t *chunks,
        int32_t *final_exp,
        uint32_t *final_hr,
        const uint32_t *mapping,
        uint32_t array_len,
        uint32_t desired_index,
        uint32_t min_headroom);
 
void aec_l2_bfp_s32_unify_exponent(
        bfp_s32_t *chunks,
        int32_t *final_exp,
        uint32_t *final_hr,
        const uint32_t *mapping,
        uint32_t array_len,
        uint32_t desired_index,
        uint32_t min_headroom);
#endif