DSPLib_filter.h

#ifndef __DSPLIB_FILTER_H__
#define __DSPLIB_FILTER_H__

//******************************************************************************
//
//
//******************************************************************************

//******************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//******************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif

//******************************************************************************
//
//
//******************************************************************************
#define MSP_ALIGN_FIR_Q15(n)        (n*4)

//******************************************************************************
//
//
//******************************************************************************
#define MSP_ALIGN_FIR_IQ31(n)        (n*8)

//******************************************************************************
//
//
//******************************************************************************
#define MSP_ALIGN_CMPLX_FIR_Q15(n)  (n*8)

//******************************************************************************
//
//
//******************************************************************************
#define MSP_ALIGN_CMPLX_FIR_IQ31(n) (n*16)

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_fir_q15_params {
    uint16_t length;
    uint16_t tapLength;
    const _q15 *coeffs;
    bool enableCircularBuffer;
} msp_fir_q15_params;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_fir_iq31_params {
    uint16_t length;
    uint16_t tapLength;
    const _iq31 *coeffs;
    bool enableCircularBuffer;
} msp_fir_iq31_params;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_cmplx_fir_q15_params{
    uint16_t length;
    uint16_t tapLength;
    const _q15 *coeffs;
    bool enableCircularBuffer;
} msp_cmplx_fir_q15_params;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_cmplx_fir_iq31_params{
    uint16_t length;
    uint16_t tapLength;
    const _iq31 *coeffs;
    bool enableCircularBuffer;
} msp_cmplx_fir_iq31_params;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_biquad_df1_q15_coeffs {
    _q15 b2;
    _q15 b1By2;
    _q15 b0;
    uint16_t reserved1;
    _q15 a2;
    _q15 a1By2;
} msp_biquad_df1_q15_coeffs;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_biquad_df1_q15_states {
    _q15 x2;
    _q15 x1;
    _q15 y2;
    _q15 y1;
} msp_biquad_df1_q15_states;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_biquad_df1_q15_params {
    uint16_t length;
    const msp_biquad_df1_q15_coeffs *coeffs;
    msp_biquad_df1_q15_states *states;
} msp_biquad_df1_q15_params;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_biquad_cascade_df1_q15_params {
    uint16_t length;
    uint16_t stages;
    const msp_biquad_df1_q15_coeffs *coeffs;
    msp_biquad_df1_q15_states *states;
} msp_biquad_cascade_df1_q15_params;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_biquad_df2_q15_coeffs {
    uint16_t reserved1;
    _q15 a2;
    _q15 a1By2;
    _q15 a0;
    _q15 b0;
    _q15 b1By2;
    _q15 b2;
    uint16_t reserved2;
} msp_biquad_df2_q15_coeffs;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_biquad_df2_q15_states {
    _q15 q1;
    _q15 q2;
} msp_biquad_df2_q15_states;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_biquad_df2_q15_params {
    uint16_t length;
    const msp_biquad_df2_q15_coeffs *coeffs;
    msp_biquad_df2_q15_states *states;
} msp_biquad_df2_q15_params;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_biquad_cascade_df2_q15_params {
    uint16_t length;
    uint16_t stages;
    const msp_biquad_df2_q15_coeffs *coeffs;
    msp_biquad_df2_q15_states *states;
} msp_biquad_cascade_df2_q15_params;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_biquad_df2_ext_q15_coeffs {
    _iq31 bias;
    uint16_t reserved1;
    _q15 a2;
    _q15 a1By2;
    _q15 a0;
    _q15 b0;
    _q15 b1By2;
    _q15 b2;
    uint16_t reserved2;
} msp_biquad_df2_ext_q15_coeffs;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_biquad_df2_ext_q15_states {
    _q15 q1;
    _q15 q2;
    _q15 minEven;
    _q15 minOdd;
    _q15 maxEven;
    _q15 maxOdd;
    _q15 min;
    _q15 max;
} msp_biquad_df2_ext_q15_states;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_biquad_df2_ext_q15_params {
    uint16_t length;
    const msp_biquad_df2_ext_q15_coeffs *coeffs;
    msp_biquad_df2_ext_q15_states *states;
} msp_biquad_df2_ext_q15_params;

//******************************************************************************
//
//
//******************************************************************************
typedef struct msp_biquad_cascade_df2_ext_q15_params {
    uint16_t length;
    uint16_t stages;
    const msp_biquad_df2_ext_q15_coeffs *coeffs;
    msp_biquad_df2_ext_q15_states *states;
} msp_biquad_cascade_df2_ext_q15_params;

//******************************************************************************
//
//
//******************************************************************************
extern msp_status msp_fir_q15(
                        const msp_fir_q15_params *params,
                        const _q15 *src,
                        _q15 *dst);

//******************************************************************************
//
//
//******************************************************************************
extern msp_status msp_fir_iq31(
                        const msp_fir_iq31_params *params,
                        const _iq31 *src,
                        _iq31 *dst);

//******************************************************************************
//
//
//******************************************************************************
extern msp_status msp_cmplx_fir_q15(
                        const msp_cmplx_fir_q15_params *params,
                        const _q15 *src,
                        _q15 *dst);

//******************************************************************************
//
//
//******************************************************************************
extern msp_status msp_cmplx_fir_iq31(
                        const msp_cmplx_fir_iq31_params *params,
                        const _iq31 *src,
                        _iq31 *dst);

//******************************************************************************
//
//
//******************************************************************************
extern msp_status msp_biquad_df1_q15(
                        const msp_biquad_df1_q15_params *params,
                        const _q15 *src,
                        _q15 *dst);

//******************************************************************************
//
//
//******************************************************************************
extern msp_status msp_biquad_cascade_df1_q15(
                        const msp_biquad_cascade_df1_q15_params *params,
                        const _q15 *src,
                        _q15 *dst);

//******************************************************************************
//
//
//******************************************************************************
extern msp_status msp_biquad_df2_q15(
                        const msp_biquad_df2_q15_params *params,
                        const _q15 *src,
                        _q15 *dst);

//******************************************************************************
//
//
//******************************************************************************
extern msp_status msp_biquad_cascade_df2_q15(
                        const msp_biquad_cascade_df2_q15_params *params,
                        const _q15 *src,
                        _q15 *dst);

//******************************************************************************
//
//
//******************************************************************************
extern msp_status msp_biquad_df2_ext_q15(
                        const msp_biquad_df2_ext_q15_params *params,
                        const _q15 *src,
                        _q15 *dst);

//******************************************************************************
//
//
//******************************************************************************
extern msp_status msp_biquad_cascade_df2_ext_q15(
                        const msp_biquad_cascade_df2_ext_q15_params *params,
                        const _q15 *src,
                        _q15 *dst);

//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

#endif //__DSPLIB_FILTER_H__