comparison xtract/libxtract.h @ 98:ca40a0dc29d6

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).

  *                                                                          
  * \param *data: a pointer to the start of the input data (usually the first element in an array)                         
  *                                                                          
  * \param N: the number of elements to be processed          
  *                                                                          
- * \param *argv: an abitrary number of additional arguments, used to pass additional parameters to the function being called
+ * \param *argv: an abitrary number of additional arguments, used to pass additional parameters to the function being called. All arguments are compulsary!
  *                                                                          
  * \param *result: a pointer to the first element in the result                              
  *                                                                          
  * Each function will iterate over N array elements, the first of which is  
  * pointed to by *data. It is up to the calling function to ensure that the array is in the format expected by the function being called.

  * \param sr: The sample audio sample rate
  * \param *band_limits: a pointer to an array of BARK_BANDS ints
  */
 int xtract_init_bark(int N, float sr, int *band_limits);
 
+/** \brief An initialisation function for functions using FFT
+ *
+ * This function initialises global data structures used by functions requiring FFT functionality. It can be called multiple times with different feature names. Calling it more than once with the same feature name is not a valid operation and will result in a memory leak.
+ *
+ * \param N: the size of the FFT
+ * \param feature_name: the name of the feature the FFT is being used for, 
+ * e.g. XTRACT_DCT
+ *
+ */
+int xtract_init_fft(int N, int feature_name);
+
 /* \brief A function to build an array of function descriptors */
 void *xtract_make_descriptors();
 
 /* \brief A function to free an array of function descriptors */
 int xtract_free_descriptors(void *fd);