jamie@254: /*
jamie@254:  * Copyright (C) 2012 Jamie Bullock
jamie@254:  *
jamie@254:  * Permission is hereby granted, free of charge, to any person obtaining a copy
jamie@254:  * of this software and associated documentation files (the "Software"), to
jamie@254:  * deal in the Software without restriction, including without limitation the
jamie@254:  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
jamie@254:  * sell copies of the Software, and to permit persons to whom the Software is
jamie@254:  * furnished to do so, subject to the following conditions:
jamie@254:  *
jamie@254:  * The above copyright notice and this permission notice shall be included in
jamie@254:  * all copies or substantial portions of the Software.
jamie@254:  *
jamie@254:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
jamie@254:  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
jamie@254:  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
jamie@254:  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
jamie@254:  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
jamie@254:  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
jamie@254:  * IN THE SOFTWARE.
jamie@254:  *
jamie@254:  */
jamie@254: 
jamie@254: /** \file xtract_stateful.h: declares functions that extract features that require stateful data to be retained between frames */
jamie@254: #ifndef XTRACT_STATEFUL_H
jamie@254: #define XTRACT_STATEFUL_H
jamie@254: 
jamie@254: #ifdef __cplusplus
jamie@254: extern "C" {
jamie@254: #endif
jamie@254: 	
jamie@254: /**
jamie@254:  * \defgroup stateful feature extraction functions and data structures
jamie@254:  *
jamie@254:  * Functions that extract a feature over multiple frames
jamie@254:  *
jamie@254:  * @{
jamie@254:  */
jamie@254: 
jamie@254:     
jamie@254: #include <stdint.h>
jamie@254: #include <string.h>
jamie@254: 
jamie@254: typedef struct xtract_last_n_state_ xtract_last_n_state;
jamie@254:         
jamie@254: xtract_last_n_state *xtract_last_n_state_new(size_t capacity);
jamie@254: void xtract_last_n_state_delete(xtract_last_n_state *last_n_state);
jamie@254: 
jamie@254:     
jamie@254: /**
jamie@254:  *  Write a vector of the last N input values to `result`
jamie@254:  *
jamie@254:  *  @param state  a pointer to an xtract_peak_picker_state struct as allocated by xtract_peak_picker_state_new()
jamie@254:  *  @param data   a pointer to a double representing the current input value
jamie@254:  *  @param N      an integer representing 'N' the number of values to be written to *result
jamie@254:  *  @param argv   a pointer to NULL
jamie@254:  *  @param result a pointer to an array of doubles representing the last N values, where the nth value is the current one. The array must have been allocated to size N elements and initialised by the caller
jamie@254:  *
jamie@254:  */
jamie@254: int xtract_last_n(const xtract_last_n_state *state, const double *data, const int N, const void *argv, double *result);
jamie@254:     
jamie@254: #ifdef __cplusplus
jamie@254: }
jamie@254: #endif
jamie@254: 
jamie@254: #endif