Changeset 7f3ccc5e for src/pitchyin.h

Timestamp:

May 17, 2006, 8:16:59 PM (19 years ago)

Author:

Paul Brossier <piem@altern.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:

78fa561

Parents:

ba11e53

Message:

update pitch method comments
update pitch method comments

File:

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

src/pitchyin.h

@@ -17 +17 @@
 */
 
-/* This algorithm was developped by A. de Cheveigne and H. Kawahara and
- * published in:
- * 
- * de Cheveigné, A., Kawahara, H. (2002) "YIN, a fundamental frequency
- * estimator for speech and music", J. Acoust. Soc. Am. 111, 1917-1930.  
- *
- * see http://recherche.ircam.fr/equipes/pcm/pub/people/cheveign.html
- */
+/** \file 
+  
+  Pitch detection using the YIN algorithm
+ 
+  This algorithm was developped by A. de Cheveigne and H. Kawahara and
+  published in:
+  
+  De Cheveigné, A., Kawahara, H. (2002) "YIN, a fundamental frequency
+  estimator for speech and music", J. Acoust. Soc. Am. 111, 1917-1930.  
+ 
+  see http://recherche.ircam.fr/equipes/pcm/pub/people/cheveign.html
+
+*/
 
 #ifndef PITCHYIN_H
@@ -33 +38 @@
 #endif
 
+/** compute difference function
+  
+  \param input input signal 
+  \param yinbuf output buffer to store difference function (half shorter than input)
+
+*/
 void aubio_pitchyin_diff(fvec_t * input, fvec_t * yinbuf);
 
+/** in place computation of the YIN cumulative normalised function 
+  
+  \param yinbuf input signal (a square difference function), also used to store function 
+
+*/
 void aubio_pitchyin_getcum(fvec_t * yinbuf);
 
+/** detect pitch in a YIN function
+  
+  \param yinbuf input buffer as computed by aubio_pitchyin_getcum
+
+*/
 uint_t aubio_pitchyin_getpitch(fvec_t *yinbuf);
 
+/** fast implementation of the YIN algorithm 
+  
+  \param input input signal 
+  \param yinbuf input buffer used to compute the YIN function
+  \param tol tolerance parameter for minima selection [default 0.15]
+
+*/
 smpl_t aubio_pitchyin_getpitchfast(fvec_t * input, fvec_t *yinbuf, smpl_t tol);