Changeset e84ab04 for src

Timestamp:

Dec 17, 2013, 5:37:52 PM (11 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+

Children:

01b277c

Parents:

4ed0ed1

Message:

src/musicutils.h: minimal doc about windows

File:

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

src/musicutils.h

@@ -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
 
  */