386 lines
14 KiB
C
386 lines
14 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2018-2025 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
|
|
#ifndef _dsps_fir_H_
|
|
#define _dsps_fir_H_
|
|
|
|
|
|
#include "dsp_err.h"
|
|
|
|
#include "dsps_fir_platform.h"
|
|
#include "dsp_common.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
/**
|
|
* @brief Data struct of f32 fir filter
|
|
*
|
|
* This structure is used by a filter internally. A user should access this structure only in case of
|
|
* extensions for the DSP Library.
|
|
* All fields of this structure are initialized by the dsps_fir_init_f32(...) function.
|
|
*/
|
|
typedef struct fir_f32_s {
|
|
float *coeffs; /*!< Pointer to the coefficient buffer.*/
|
|
float *delay; /*!< Pointer to the delay line buffer.*/
|
|
int N; /*!< FIR filter coefficients amount.*/
|
|
int pos; /*!< Position in delay line.*/
|
|
int decim; /*!< Decimation factor.*/
|
|
int16_t use_delay; /*!< The delay line was allocated by init function.*/
|
|
/**
|
|
* @brief Interpolation parameters
|
|
*
|
|
* @note This is used for multi-rate FIR filter
|
|
*/
|
|
int delay_size; /*!< Size of the delay line.*/
|
|
int interp; /*!< Interpolation factor.*/
|
|
int interp_pos; /*!< Interpolation position.*/
|
|
int start_pos; /*!< Start position for decimation counter.*/
|
|
} fir_f32_t;
|
|
|
|
/**
|
|
* @brief Data struct of s16 fir filter
|
|
*
|
|
* This structure is used by a filter internally. A user should access this structure only in case of
|
|
* extensions for the DSP Library.
|
|
* All fields of this structure are initialized by the dsps_fir_init_s16(...) function.
|
|
*/
|
|
typedef struct fir_s16_s {
|
|
int16_t *coeffs; /*!< Pointer to the coefficient buffer.*/
|
|
int16_t *delay; /*!< Pointer to the delay line buffer.*/
|
|
int16_t coeffs_len; /*!< FIR filter coefficients amount.*/
|
|
int16_t pos; /*!< Position in delay line.*/
|
|
int16_t decim; /*!< Decimation factor.*/
|
|
int16_t d_pos; /*!< Actual decimation counter.*/
|
|
int16_t shift; /*!< Shift value of the result.*/
|
|
int32_t *rounding_buff; /*!< Rounding buffer for the purposes of esp32s3 ee.ld.accx.ip assembly instruction */
|
|
int32_t rounding_val; /*!< Rounding value*/
|
|
int16_t free_status; /*!< Indicator for dsps_fird_s16_aes3_free() function*/
|
|
|
|
/**
|
|
* @brief Interpolation parameters
|
|
*
|
|
* @note This is used for multi-rate FIR filter
|
|
*/
|
|
int16_t delay_size; /*!< Size of the delay line.*/
|
|
int16_t interp; /*!< Interpolation factor.*/
|
|
int16_t interp_pos; /*!< Interpolation position.*/
|
|
int16_t start_pos; /*!< Start position for decimation counter.*/
|
|
} fir_s16_t;
|
|
|
|
/**
|
|
* @brief initialize structure for 32 bit FIR filter
|
|
*
|
|
* Function initialize structure for 32 bit floating point FIR filter
|
|
* The implementation use ANSI C and could be compiled and run on any platform
|
|
*
|
|
* @param fir: pointer to fir filter structure, that must be preallocated
|
|
* @param coeffs: array with FIR filter coefficients. Must be length N
|
|
* @param delay: array for FIR filter delay line. Must have a length = coeffs_len + 4
|
|
* @param coeffs_len: FIR filter length. Length of coeffs array. For esp32s3 length should be divided by 4 and aligned to 16.
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - One of the error codes from DSP library
|
|
*/
|
|
esp_err_t dsps_fir_init_f32(fir_f32_t *fir, float *coeffs, float *delay, int coeffs_len);
|
|
|
|
/**
|
|
* @brief initialize structure for 32 bit Decimation FIR filter
|
|
* Function initialize structure for 32 bit floating point FIR filter with decimation
|
|
* The implementation use ANSI C and could be compiled and run on any platform
|
|
*
|
|
* @param fir: pointer to fir filter structure, that must be preallocated
|
|
* @param coeffs: array with FIR filter coefficients. Must be length N
|
|
* @param delay: array for FIR filter delay line. Must be length N
|
|
* @param N: FIR filter length. Length of coeffs and delay arrays.
|
|
* @param decim: decimation factor.
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - One of the error codes from DSP library
|
|
*/
|
|
esp_err_t dsps_fird_init_f32(fir_f32_t *fir, float *coeffs, float *delay, int N, int decim);
|
|
|
|
/**
|
|
* @brief initialize structure for 16 bit Decimation FIR filter
|
|
* Function initialize structure for 16 bit signed fixed point FIR filter with decimation
|
|
* The implementation use ANSI C and could be compiled and run on any platform
|
|
*
|
|
* @param fir: pointer to fir filter structure, that must be preallocated
|
|
* @param coeffs: array with FIR filter coefficients. Must be length N
|
|
* @param delay: array for FIR filter delay line. Must be length N
|
|
* @param coeffs_len: FIR filter length. Length of coeffs and delay arrays.
|
|
* @param decim: decimation factor.
|
|
* @param start_pos: initial value of decimation counter. Must be [0..d)
|
|
* @param shift: shift position of the result
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - One of the error codes from DSP library
|
|
*/
|
|
esp_err_t dsps_fird_init_s16(fir_s16_t *fir, int16_t *coeffs, int16_t *delay, int16_t coeffs_len, int16_t decim, int16_t start_pos, int16_t shift);
|
|
|
|
|
|
/**@{*/
|
|
/**
|
|
* @brief 32 bit floating point FIR filter
|
|
*
|
|
* Function implements FIR filter
|
|
* The extension (_ansi) uses ANSI C and could be compiled and run on any platform.
|
|
* The extension (_ae32) is optimized for ESP32 chip.
|
|
*
|
|
* @param fir: pointer to fir filter structure, that must be initialized before
|
|
* @param[in] input: input array
|
|
* @param[out] output: array with the result of FIR filter
|
|
* @param[in] len: length of input and result arrays
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - One of the error codes from DSP library
|
|
*/
|
|
esp_err_t dsps_fir_f32_ansi(fir_f32_t *fir, const float *input, float *output, int len);
|
|
esp_err_t dsps_fir_f32_ae32(fir_f32_t *fir, const float *input, float *output, int len);
|
|
esp_err_t dsps_fir_f32_aes3(fir_f32_t *fir, const float *input, float *output, int len);
|
|
/**@}*/
|
|
|
|
/**@{*/
|
|
/**
|
|
* @brief 32 bit floating point Decimation FIR filter
|
|
*
|
|
* Function implements FIR filter with decimation
|
|
* The extension (_ansi) uses ANSI C and could be compiled and run on any platform.
|
|
* The extension (_ae32) is optimized for ESP32 chip.
|
|
*
|
|
* @param fir: pointer to fir filter structure, that must be initialized before
|
|
* @param input: input array
|
|
* @param output: array with the result of FIR filter
|
|
* @param len: length of result array
|
|
*
|
|
* @return: function returns the number of samples stored in the output array
|
|
* depends on the previous state value could be [0..len/decimation]
|
|
*/
|
|
int dsps_fird_f32_ansi(fir_f32_t *fir, const float *input, float *output, int len);
|
|
int dsps_fird_f32_ae32(fir_f32_t *fir, const float *input, float *output, int len);
|
|
int dsps_fird_f32_aes3(fir_f32_t *fir, const float *input, float *output, int len);
|
|
int dsps_fird_f32_arp4(fir_f32_t *fir, const float *input, float *output, int len);
|
|
/**@}*/
|
|
|
|
/**@{*/
|
|
/**
|
|
* @brief 16 bit signed fixed point Decimation FIR filter
|
|
*
|
|
* Function implements FIR filter with decimation
|
|
* The extension (_ansi) uses ANSI C and could be compiled and run on any platform.
|
|
* The extension (_ae32) is optimized for ESP32 chip.
|
|
*
|
|
* @param fir: pointer to fir filter structure, that must be initialized before
|
|
* @param input: input array
|
|
* @param output: array with the result of the FIR filter
|
|
* @param len: length of the result array
|
|
*
|
|
* @return: function returns the number of samples stored in the output array
|
|
* depends on the previous state value could be [0..len/decimation]
|
|
*/
|
|
int32_t dsps_fird_s16_ansi(fir_s16_t *fir, const int16_t *input, int16_t *output, int32_t len);
|
|
int32_t dsps_fird_s16_ae32(fir_s16_t *fir, const int16_t *input, int16_t *output, int32_t len);
|
|
int32_t dsps_fird_s16_aes3(fir_s16_t *fir, const int16_t *input, int16_t *output, int32_t len);
|
|
int32_t dsps_fird_s16_arp4(fir_s16_t *fir, const int16_t *input, int16_t *output, int32_t len);
|
|
/**@}*/
|
|
|
|
/**@{*/
|
|
/**
|
|
* @brief initialize structure for multi-rate FIR filter
|
|
* Function initialize structure for 32 bit floating point multi-rate FIR filter
|
|
* The implementation use ANSI C and could be compiled and run on any platform
|
|
*
|
|
* @param fir: pointer to fir filter structure, that must be preallocated
|
|
* @param coeffs: array with FIR filter coefficients. Must be length N
|
|
* @param delay: array for FIR filter delay line. Must be length N
|
|
* @param length: FIR filter length. Length of coeffs and delay arrays.
|
|
* @param interp: interpolation factor.
|
|
* @param decim: decimation factor.
|
|
* @param start_pos: initial value of decimation counter. Must be [0..decim)
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - One of the error codes from DSP library
|
|
*/
|
|
esp_err_t dsps_firmr_init_f32(fir_f32_t *fir, float *coeffs, float *delay, int length, int interp, int decim, int start_pos );
|
|
/**@}*/
|
|
|
|
/**@{*/
|
|
/**
|
|
* @brief initialize structure for multi-rate FIR filter
|
|
* Function initialize structure for 16 bit signed fixed point multi-rate FIR filter
|
|
* The implementation use ANSI C and could be compiled and run on any platform
|
|
*
|
|
* @param fir: pointer to fir filter structure, that must be preallocated
|
|
* @param coeffs: array with FIR filter coefficients. Must be length N
|
|
* @param delay: array for FIR filter delay line. Must be length N
|
|
* @param length: FIR filter length. Length of coeffs and delay arrays.
|
|
* @param interp: interpolation factor.
|
|
* @param decim: decimation factor.
|
|
* @param start_pos: initial value of decimation counter. Must be [0..decim)
|
|
* @param shift: shift of accumulator value to store in the output array.
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - One of the error codes from DSP library
|
|
*/
|
|
esp_err_t dsps_firmr_init_s16(fir_s16_t *fir, int16_t *coeffs, int16_t *delay, int16_t length, int16_t interp, int16_t decim, int16_t start_pos, int16_t shift);
|
|
/**@}*/
|
|
|
|
/**@{*/
|
|
/**
|
|
* @brief 32 bit floating point multi-rate FIR filter
|
|
*
|
|
* Function implements FIR filter with decimation
|
|
* The extension (_ansi) uses ANSI C and could be compiled and run on any platform.
|
|
* The extension (_ae32) is optimized for ESP32 chip.
|
|
*
|
|
* @param fir: pointer to fir filter structure, that must be initialized before
|
|
* @param input: input array
|
|
* @param output: array with the result of the FIR filter
|
|
* @param input_len: length of the input array
|
|
*
|
|
* @return
|
|
* - amount of samples stored in the output array
|
|
* - depends on the previous state value
|
|
* - could be [0..len*intepr/decimation]
|
|
*
|
|
*/
|
|
int dsps_firmr_f32_ansi(fir_f32_t *fir, const float *input, float *output, int input_len);
|
|
/**@}*/
|
|
|
|
/**@{*/
|
|
/**
|
|
* @brief 16 bit signed fixed point multi-rate FIR filter
|
|
*
|
|
* Function implements FIR filter with decimation
|
|
* The extension (_ansi) uses ANSI C and could be compiled and run on any platform.
|
|
* The extension (_ae32) is optimized for ESP32 chip.
|
|
*
|
|
* @param fir: pointer to fir filter structure, that must be initialized before
|
|
* @param input: input array
|
|
* @param output: array with the result of the FIR filter
|
|
* @param input_len: length of the intput array
|
|
*
|
|
* @return: function returns the number of samples stored in the output array
|
|
* depends on the previous state value could be [0..len*intepr/decimation]
|
|
*/
|
|
int32_t dsps_firmr_s16_ansi(fir_s16_t *fir, const int16_t *input, int16_t *output, int32_t input_len);
|
|
/**@}*/
|
|
|
|
|
|
/**@{*/
|
|
/**
|
|
* @brief support arrays freeing function
|
|
*
|
|
* Function frees all the arrays, which were created during the initialization of the fir_s16_t structure
|
|
* 1. frees allocated memory for rounding buffer, for the purposes of esp32s3 ee.ld.accx.ip assembly instruction
|
|
* 2. frees allocated memory in case the delay line is NULL
|
|
* 3. frees allocated memory in case the length of the filter (and the delay line) is not divisible by 8
|
|
* and new delay line and filter coefficients arrays are created for the purpose of the esp32s3 assembly
|
|
*
|
|
* @param fir: pointer to fir filter structure, that must be initialized before
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t dsps_fird_s16_aexx_free(fir_s16_t *fir);
|
|
/**@}*/
|
|
|
|
|
|
/**@{*/
|
|
/**
|
|
* @brief support arrays freeing function
|
|
*
|
|
* Function frees the delay line arrays, if it was allocated by the init functions.
|
|
*
|
|
* @param fir: pointer to fir filter structure, that must be initialized before
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t dsps_fir_f32_free(fir_f32_t *fir);
|
|
/**@}*/
|
|
|
|
|
|
/**@{*/
|
|
/**
|
|
* @brief Array reversal
|
|
*
|
|
* Function reverses 16-bit long array members for the purpose of the dsps_fird_s16_aes3 implementation
|
|
* The function has to be called either during the fir struct initialization or every time the coefficients change
|
|
*
|
|
* @param arr: pointer to the array to be reversed
|
|
* @param len: length of the array to be reversed
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
*/
|
|
esp_err_t dsps_16_array_rev(int16_t *arr, int16_t len);
|
|
/**@}*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
|
|
#if CONFIG_DSP_OPTIMIZED
|
|
|
|
#if (dsps_fir_f32_ae32_enabled == 1)
|
|
#define dsps_fir_f32 dsps_fir_f32_ae32
|
|
#elif (dsps_fir_f32_aes3_enabled == 1)
|
|
#define dsps_fir_f32 dsps_fir_f32_aes3
|
|
#else
|
|
#define dsps_fir_f32 dsps_fir_f32_ansi
|
|
#endif
|
|
|
|
#if (dsps_fird_f32_aes3_enabled == 1)
|
|
#define dsps_fird_f32 dsps_fird_f32_aes3
|
|
#define dsps_firmr_f32 dsps_firmr_f32_ansi
|
|
#elif (dsps_fird_f32_ae32_enabled == 1)
|
|
#define dsps_fird_f32 dsps_fird_f32_ae32
|
|
#define dsps_firmr_f32 dsps_firmr_f32_ansi
|
|
#elif (dsps_fird_f32_arp4_enabled == 1)
|
|
#define dsps_fird_f32 dsps_fird_f32_arp4
|
|
#define dsps_firmr_f32 dsps_firmr_f32_ansi
|
|
#else
|
|
#define dsps_fird_f32 dsps_fird_f32_ansi
|
|
#define dsps_firmr_f32 dsps_firmr_f32_ansi
|
|
#endif
|
|
|
|
|
|
#if (dsps_fird_s16_ae32_enabled == 1)
|
|
#define dsps_fird_s16 dsps_fird_s16_ae32
|
|
#define dsps_firmr_s16 dsps_firmr_s16_ansi
|
|
#elif (dsps_fird_s16_aes3_enabled == 1)
|
|
#define dsps_fird_s16 dsps_fird_s16_aes3
|
|
#define dsps_firmr_s16 dsps_firmr_s16_ansi
|
|
#elif (dsps_fird_s16_arp4_enabled == 1)
|
|
#define dsps_fird_s16 dsps_fird_s16_arp4
|
|
#define dsps_firmr_s16 dsps_firmr_s16_ansi
|
|
#else
|
|
#define dsps_fird_s16 dsps_fird_s16_ansi
|
|
#define dsps_firmr_s16 dsps_firmr_s16_ansi
|
|
#endif
|
|
|
|
#else // CONFIG_DSP_OPTIMIZED
|
|
|
|
#define dsps_fir_f32 dsps_fir_f32_ansi
|
|
#define dsps_fird_f32 dsps_fird_f32_ansi
|
|
#define dsps_firmr_f32 dsps_firmr_f32_ansi
|
|
#define dsps_fird_s16 dsps_fird_s16_ansi
|
|
#define dsps_firmr_s16 dsps_firmr_s16_ansi
|
|
|
|
#endif // CONFIG_DSP_OPTIMIZED
|
|
|
|
#endif // _dsps_fir_H_
|