src/spectral/mfcc.h: remove obsolete reference to libxtract, update copyright and...
authorPaul Brossier <piem@piem.org>
Thu, 17 Sep 2009 18:04:00 +0000 (20:04 +0200)
committerPaul Brossier <piem@piem.org>
Thu, 17 Sep 2009 18:04:00 +0000 (20:04 +0200)
src/spectral/mfcc.h

index 1a2cbda155d55461345ebb70db153822bb9e9765..199469287095087c4adb6c5b7546b83b69f5fcee 100644 (file)
@@ -1,32 +1,30 @@
 /*
-   Copyright (C) 2007 Amaury Hazan <ahazan@iua.upf.edu>
-                  and Paul Brossier <piem@piem.org>
+   Copyright (C) 2007-2009 Paul Brossier <piem@aubio.org>
+                       and Amaury Hazan <ahazan@iua.upf.edu>
 
-   This program is free software; you can redistribute it and/or modify
+   This file is part of Aubio.
+
+   Aubio is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
-   This program is distributed in the hope that it will be useful,
+   Aubio is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-*/
+   along with Aubio.  If not, see <http://www.gnu.org/licenses/>.
 
-/* part of this mfcc implementation were inspired from LibXtract
-   http://libxtract.sourceforge.net/
 */
 
-#ifndef MFCC_H 
-#define MFCC_H 
+#ifndef MFCC_H
+#define MFCC_H
 
 #ifdef __cplusplus
-extern "C" {
+extern "C"
+{
 #endif
 
 typedef struct aubio_mfcc_t_ aubio_mfcc_t;
@@ -34,28 +32,31 @@ typedef struct aubio_mfcc_t_ aubio_mfcc_t;
 /** create mfcc object
 
   \param win_s size of analysis buffer (and length the FFT transform)
-  \param samplerate 
-  \param n_coefs: number of desired coefs
+  \param samplerate audio sampling rate
+  \param n_coefs number of desired coefficientss
 
 */
-aubio_mfcc_t * new_aubio_mfcc (uint_t win_s, uint_t samplerate, uint_t n_filters, uint_t n_coefs);
+aubio_mfcc_t *new_aubio_mfcc (uint_t win_s, uint_t samplerate,
+      uint_t n_filters, uint_t n_coefs);
+
 /** delete mfcc object
 
   \param mf mfcc object as returned by new_aubio_mfcc
 
 */
-void del_aubio_mfcc(aubio_mfcc_t *mf);
+void del_aubio_mfcc (aubio_mfcc_t * mf);
+
 /** mfcc object processing
 
   \param mf mfcc object as returned by new_aubio_mfcc
   \param in input spectrum (win_s long)
-  \param out output mel coefficients buffer (n_filters/2 +1 long)
+  \param out output mel coefficients buffer (n_coeffs long)
 
 */
-void aubio_mfcc_do(aubio_mfcc_t * mf, cvec_t *in, fvec_t *out);
+void aubio_mfcc_do (aubio_mfcc_t * mf, cvec_t * in, fvec_t * out);
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif // MFCC_H
+#endif                          // MFCC_H