Mercurial > hg > libxtract
comparison xtract/xtract_scalar.h @ 83:5fadbacdb2a7
Minor mods and typos corrections that were lurking uncommitted
author | Jamie Bullock <jamie@postlude.co.uk> |
---|---|
date | Mon, 20 Aug 2007 08:12:04 +0000 |
parents | afb298ce1b4d |
children | 35a3bb5c3ffd |
comparison
equal
deleted
inserted
replaced
82:b1afb3a257b6 | 83:5fadbacdb2a7 |
---|---|
26 #ifdef __cplusplus | 26 #ifdef __cplusplus |
27 extern "C" { | 27 extern "C" { |
28 #endif | 28 #endif |
29 | 29 |
30 /** | 30 /** |
31 * \defgroup scalar extraction functions | 31 * \defgroup scalar scalar extraction functions |
32 * | 32 * |
33 * Defines scalar extraction functions, and their parameters. | 33 * Defines scalar extraction functions, and their parameters. |
34 * @{ | 34 * @{ |
35 */ | 35 */ |
36 | 36 |
198 | 198 |
199 /** \brief Extract the spectral spread of an input vector using a method described by Casagrande(2005) | 199 /** \brief Extract the spectral spread of an input vector using a method described by Casagrande(2005) |
200 * | 200 * |
201 * \param *data: a pointer to the first element in an array of floats representing the magnitude coefficients from the spectrum of an audio vector, (e.g. the first half of the array pointed to by *result from xtract_spectrum(). | 201 * \param *data: a pointer to the first element in an array of floats representing the magnitude coefficients from the spectrum of an audio vector, (e.g. the first half of the array pointed to by *result from xtract_spectrum(). |
202 * \param N: the number of elements to be considered | 202 * \param N: the number of elements to be considered |
203 * \param *argv: a pointer to NULL | 203 * \param *argv: a pointer to a float corresponding to the spectral centroid |
204 * \param *result: the spectral spread of N values from the array pointed to by *data | 204 * \param *result: the spectral spread of N values from the array pointed to by *data |
205 */ | 205 */ |
206 int xtract_spread(const float *data, const int N, const void *argv, float *result); | 206 int xtract_spread(const float *data, const int N, const void *argv, float *result); |
207 | 207 |
208 /* Zero crossing rate */ | 208 /* Zero crossing rate */ |