aboutsummaryrefslogtreecommitdiff
path: root/xtract/xtract_vector.h
diff options
context:
space:
mode:
authorJamie Bullock <jamie@postlude.co.uk>2007-10-06 16:36:00 +0000
committerJamie Bullock <jamie@postlude.co.uk>2007-10-06 16:36:00 +0000
commit7044486fdcc4d806f46c35ec4787ae48fa26c369 (patch)
tree06134837cf5be10309e18065700ae95592a6851f /xtract/xtract_vector.h
parent944e692ddd2862827821ef498dc6e5a570c26752 (diff)
downloadLibXtract-7044486fdcc4d806f46c35ec4787ae48fa26c369.tar.gz
LibXtract-7044486fdcc4d806f46c35ec4787ae48fa26c369.tar.bz2
LibXtract-7044486fdcc4d806f46c35ec4787ae48fa26c369.zip
Removed fftw_plan from xtraction functions. Created new init function xtract_init_fft() for creating plans, which have global scope. Updated examples to reflect the change. New configure option: --with-fft_optimisation (0 = FFTW_ESTIMATE, 1 = FFTW_MEASURE, 2 = FFTW_PATIENT).
Diffstat (limited to 'xtract/xtract_vector.h')
-rw-r--r--xtract/xtract_vector.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/xtract/xtract_vector.h b/xtract/xtract_vector.h
index ad97f16..e67ae6d 100644
--- a/xtract/xtract_vector.h
+++ b/xtract/xtract_vector.h
@@ -38,7 +38,7 @@ extern "C" {
*
* \param *data: a pointer to the first element in an array of floats representing an audio vector
* \param N: the number of array elements to be considered
- * \param *argv: a pointer to an array of floats, the first representing (samplerate / N), the second will be cast to an integer and determines the spectrum type (e.g. XTRACT_MAGNITUDE_SPECTRUM, XTRACT_LOG_POWER_SPECTRUM). An optional third argument determines whether or not the DC component is included in the output. If argv[2] == 1, then the DC component is included in which case the size of the array pointed to by *result must be N+2. For any further use of the array pointed to by *result, the value of N must reflect the (larger) array size.
+ * \param *argv: a pointer to an array of floats, the first representing (samplerate / N), the second will be cast to an integer and determines the spectrum type (e.g. XTRACT_MAGNITUDE_SPECTRUM, XTRACT_LOG_POWER_SPECTRUM). The third argument determines whether or not the DC component is included in the output. If argv[2] == 1, then the DC component is included in which case the size of the array pointed to by *result must be N+2. For any further use of the array pointed to by *result, the value of N must reflect the (larger) array size.
* \param *result: a pointer to an array of size N containing N/2 magnitude/power/log magnitude/log power coefficients and N/2 bin frequencies.
*/
int xtract_spectrum(const float *data, const int N, const void *argv, float *result);