Changes in src/musicutils.h [5b41ef9:e84ab04]

File:

• src/musicutils.h (modified) (5 diffs)

src/musicutils.h

@@ -1 +1 @@
 /*
-  Copyright (C) 2003-2009 Paul Brossier <piem@aubio.org>
+  Copyright (C) 2003-2013 Paul Brossier <piem@aubio.org>
 
   This file is part of aubio.
@@ -23 +23 @@
  */
 
-#ifndef MUSICUTILS_H
-#define MUSICUTILS_H
+#ifndef _AUBIO__MUSICUTILS_H
+#define _AUBIO__MUSICUTILS_H
 
 #ifdef __cplusplus
@@ -31 +31 @@
 
 /** create window 
+
+  \param window_type type of the window to create
+  \param size length of the window to create (see fvec_set_window())
  
+*/
+fvec_t *new_aubio_window (char_t * window_type, uint_t size);
+
+/** set elements of a vector to window coefficients
+
+  \param window exsting ::fvec_t to use
+  \param window_type type of the window to create
+
+  List of available window types: "rectangle", "hamming", "hanning",
+  "hanningz", "blackman", "blackman_harris", "gaussian", "welch", "parzen",
+  "default".
+
+  "default" is equivalent to "hanningz".
+
   References:
     
@@ -42 +59 @@
   (<a href="http://profs.sci.univr.it/%7Edafx/Final-Papers/ps/Bernardini.ps.gz">
   ps.gz</a>)
-
-*/
-fvec_t *new_aubio_window (char_t * window_type, uint_t size);
-
-/** set elements of a vector to window coefficients
 
  */
@@ -149 +161 @@
 #endif
 
-#endif
-
+#endif /* _AUBIO__MUSICUTILS_H */