feature_extract.h

Go to the documentation of this file.

/*
 *  Created on: Nov 20, 2025
 */
// #############################################################################
//
//  FILE:   feature_extract.h
//
//
// #############################################################################
//
/*
 * Copyright (c) 2024-2026, Texas Instruments Incorporated
 * 
 *  All rights reserved not granted herein.
 *  Limited License.
 * 
 *  Texas Instruments Incorporated grants a world-wide, royalty-free,
 *  non-exclusive license under copyrights and patents it now or hereafter
 *  owns or controls to make, have made, use, import, offer to sell and sell
 *  ("Utilize") this software subject to the terms herein. With respect to the
 *  foregoing patent license, such license is granted solely to the extent that
 *  any such patent is necessary to Utilize the software alone. The patent
 *  license shall not apply to any combinations which include this software,
 *  other than combinations with devices manufactured by or for TI ("TI
 *  Devices"). No hardware patent is licensed hereunder.
 * 
 *  Redistributions must preserve existing copyright notices and reproduce
 *  this license (including the above copyright notice and the disclaimer and
 *  (if applicable) source code license limitations below) in the documentation
 *  and/or other materials provided with the distribution.
 * 
 *  Redistribution and use in binary form, without modification, are permitted
 *  provided that the following conditions are met:
 * 
 *    * No reverse engineering, decompilation, or disassembly of this software
 *      is permitted with respect to any software provided in binary form.
 *    * Any redistribution and use are licensed by TI for use only with TI Devices.
 *    * Nothing shall obligate TI to provide you with source code for the software
 *      licensed and provided to you in object code.
 * 
 *  If software source code is provided to you, modification and redistribution
 *  of the source code are permitted provided that the following conditions are
 *  met:
 * 
 *    * Any redistribution and use of the source code, including any resulting
 *      derivative works, are licensed by TI for use only with TI Devices.
 *    * Any redistribution and use of any object code compiled from the source
 *      code and any resulting derivative works, are licensed by TI for use
 *      only with TI Devices.
 * 
 *  Neither the name of Texas Instruments Incorporated nor the names of its
 *  suppliers may be used to endorse or promote products derived from this
 *  software without specific prior written permission.
 * 
 *  DISCLAIMER.
 * 
 *  THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "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 TI AND TI'S LICENSORS 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 FEATURE_EXTRACT_H_
#define FEATURE_EXTRACT_H_

// Peripheral includes
#include "math.h"
#if defined(__TMS320C2000__) || defined(__C29__)
#include "driverlib.h"
#else
#include "stdint.h"
#include "stdbool.h"
#endif

#include "user_input_config.h"

#if defined(FE_FFT_COL) && !defined(FE_MODEL_SC)
#define FE_MODEL_SC (FE_VARIABLES / 2)
#endif

#ifdef __cplusplus
extern "C" {
#endif

#if defined(SKIP_NORMALIZE)
typedef int8_t model_input_t;
#else
typedef float model_input_t;
#endif

#if defined(OUTPUT_INT)
typedef int8_t model_output_t;
#else
typedef float model_output_t;
#endif

typedef struct {
    void* input_buffer;                 
    void* output_buffer;                
    void* history_buffer;               
    void* scratch_buffer;               
    bool test_feature_extraction;       
    int32_t size_required_by_library;   
} feature_extraction;

typedef feature_extraction* feature_extraction_handle;

void FE_allocFeatureExtract(feature_extraction_handle fe);

void FE_initFeatureExtract(feature_extraction_handle fe);

void FE_runFeatureExtract(feature_extraction_handle fe);

int FE_compareModelInput(model_input_t* expected_array, model_input_t* obtained_array);

int FE_compareModelOutput(model_output_t* expected_array, model_output_t* obtained_array);

#ifdef __cplusplus
}
#endif  /* extern "C" */

#endif /* FEATURE_EXTRACT_H_ */