aboutsummaryrefslogtreecommitdiff
path: root/xtract/xtract_vector.h
diff options
context:
space:
mode:
authorJamie Bullock <jamie@postlude.co.uk>2008-02-15 12:43:13 +0000
committerJamie Bullock <jamie@postlude.co.uk>2008-02-15 12:43:13 +0000
commite876da1b38221d8020d81b72926d2dee5c2bdc55 (patch)
tree5795d6dca0e668a43298f1099a61f19831f419f7 /xtract/xtract_vector.h
parent24738b0d1371876dc18cb21b516b3e43984e6dbc (diff)
downloadLibXtract-e876da1b38221d8020d81b72926d2dee5c2bdc55.tar.gz
LibXtract-e876da1b38221d8020d81b72926d2dee5c2bdc55.tar.bz2
LibXtract-e876da1b38221d8020d81b72926d2dee5c2bdc55.zip
- Fixed bugs in xtract_flatness(), or at least added necessary
documentation and error checking to avoid problems - Added xtract_is_denormal() helper function and XTRACT_DENORMAL_FOUND return code - Replaced all instances of log, sqrt, exp etc. with respective floating point counterparts (logf etc.) - Added check for architecture endianness to configure script - Bug fix to PD example, now no longer crashes if no arguments are given - Minor documentation updates
Diffstat (limited to 'xtract/xtract_vector.h')
-rw-r--r--xtract/xtract_vector.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/xtract/xtract_vector.h b/xtract/xtract_vector.h
index e758f10..07bf176 100644
--- a/xtract/xtract_vector.h
+++ b/xtract/xtract_vector.h
@@ -43,6 +43,8 @@ extern "C" {
*
* The magnitude/power coefficients are scaled to the range 0-1 so that for a given coefficient x, 0 <= x <= 1
*
+ * \note Before calling xtract_spectrum(), the FFT must be initialised by calling xtract_init_fft(N, XTRACT_SPECTRUM)
+ *
*/
int xtract_spectrum(const float *data, const int N, const void *argv, float *result);