filter_fo.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2024 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef FILTER_FO_H
#define FILTER_FO_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include "dcl.h"
#include <stdlib.h>
 
#define _FILTER_FO_Obj_  dcl_df11
typedef DCL_DF11         FILTER_FO_Obj;
typedef DCL_DF11     *FILTER_FO_Handle;
 
//*****************************************************************************
//
//
//*****************************************************************************
static inline float32_t
FILTER_FO_get_a1(FILTER_FO_Handle handle)
{
    return(handle->a1);
} // end of FILTER_FO_get_a1() function
 
//*****************************************************************************
//
//
//*****************************************************************************
static inline float32_t
FILTER_FO_get_b0(FILTER_FO_Handle handle)
{
    return(handle->b0);
} // end of FILTER_FO_get_b0() function
 
//*****************************************************************************
//
//
//*****************************************************************************
static inline float32_t
FILTER_FO_get_b1(FILTER_FO_Handle handle)
{
    return(handle->b1);
} // end of FILTER_FO_get_b1() function
 
//*****************************************************************************
//
//
//*****************************************************************************
static inline float32_t
FILTER_FO_get_x1(FILTER_FO_Handle handle)
{
    return(handle->d1);
} // end of FILTER_FO_get_x1() function
 
//*****************************************************************************
//
//
//*****************************************************************************
static inline float32_t
FILTER_FO_get_y1(FILTER_FO_Handle handle)
{
    return(handle->d2);
} // end of FILTER_FO_get_y1() function
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void
FILTER_FO_getDenCoeffs(FILTER_FO_Handle handle, float32_t *pa1);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void
FILTER_FO_getInitialConditions(FILTER_FO_Handle handle, float32_t *px1,
                               float32_t *py1);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void
FILTER_FO_getNumCoeffs(FILTER_FO_Handle handle, float32_t *pb0, float32_t *pb1);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern FILTER_FO_Handle
FILTER_FO_init(void *pMemory, const size_t numBytes);
 
//*****************************************************************************
//
//
//*****************************************************************************
static inline float32_t
FILTER_FO_run(FILTER_FO_Handle handle, const float32_t inputValue)
{
    return(DCL_runDF11(handle,inputValue));
} // end of FILTER_FO_run() function
 
//*****************************************************************************
//
//
//*****************************************************************************
static inline float32_t
FILTER_FO_run_form_0(FILTER_FO_Handle handle, const float32_t inputValue)
{
    float32_t a1 = handle->a1;
    float32_t b0 = handle->b0;
    float32_t d2 = handle->d2;
 
    //
    // Compute the output
    //
    handle->d2 = (b0 * inputValue) - (a1 * d2);
 
    return(handle->d2);
} // end of FILTER_FO_run_form_0() function
 
//*****************************************************************************
//
//
//*****************************************************************************
static inline void
FILTER_FO_set_a1(FILTER_FO_Handle handle, const float32_t a1)
{
    handle->a1 = a1;
 
    return;
} // end of FILTER_FO_set_a1() function
 
//*****************************************************************************
//
//
//*****************************************************************************
static inline void
FILTER_FO_set_b0(FILTER_FO_Handle handle, const float32_t b0)
{
    handle->b0 = b0;
 
    return;
} // end of FILTER_FO_set_b0() function
 
//*****************************************************************************
//
//
//*****************************************************************************
static inline void
FILTER_FO_set_b1(FILTER_FO_Handle handle, const float32_t b1)
{
    handle->b1 = b1;
 
    return;
} // end of FILTER_FO_set_b1() function
 
//*****************************************************************************
//
//
//*****************************************************************************
static inline void
FILTER_FO_set_x1(FILTER_FO_Handle handle, const float32_t x1)
{
    handle->d1 = x1;
 
    return;
} // end of FILTER_FO_set_x1() function
 
//*****************************************************************************
//
//
//*****************************************************************************
static inline void
FILTER_FO_set_y1(FILTER_FO_Handle handle, const float32_t y1)
{
    handle->d2 = y1;
 
    return;
} // end of FILTER_FO_set_y1() function
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void
FILTER_FO_setDenCoeffs(FILTER_FO_Handle handle, const float32_t a1);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void
FILTER_FO_setInitialConditions(FILTER_FO_Handle handle, const float32_t d1,
                               const float32_t d2);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void
FILTER_FO_setNumCoeffs(FILTER_FO_Handle handle, const float32_t b0,
                       const float32_t b1);
 
#ifdef __cplusplus
}
#endif
 
#endif // FILTER_FO_H