Changes in src/pitch/pitchmcomb.h [69b11d8:168337e]

File:

• src/pitch/pitchmcomb.h (modified) (4 diffs)

src/pitch/pitchmcomb.h

@@ -24 +24 @@
 
   This fundamental frequency estimation algorithm implements spectral
-  flattening, multi-comb filtering and peak histogramming.
+  flattening, multi-comb filtering and peak histogramming. 
 
   This method was designed by Juan P. Bello and described in:
@@ -31 +31 @@
   Music''.  PhD thesis, Centre for Digital Music, Queen Mary University of
   London, London, UK, 2003.
-
-  \example pitch/test-pitchmcomb.c
 
 */
@@ -47 +45 @@
 
 /** execute pitch detection on an input spectral frame
-
+ 
   \param p pitch detection object as returned by new_aubio_pitchmcomb
-  \param in_fftgrain input signal spectrum as computed by aubio_pvoc_do
-  \param out_cands pitch candidate frequenciess, in bins
-
+  \param fftgrain input signal spectrum as computed by aubio_pvoc_do 
+ 
 */
-void aubio_pitchmcomb_do (aubio_pitchmcomb_t * p, cvec_t * in_fftgrain,
-    fvec_t * out_cands);
+void aubio_pitchmcomb_do (aubio_pitchmcomb_t * p, cvec_t * fftgrain,
+    fvec_t * output);
 
 /** creation of the pitch detection object
-
-  \param buf_size size of the input buffer to analyse
-  \param hop_size step size between two consecutive analysis instant
-
+ 
+  \param buf_size size of the input buffer to analyse 
+  \param hop_size step size between two consecutive analysis instant 
+  \param samplerate sampling rate of the signal 
+ 
 */
 aubio_pitchmcomb_t *new_aubio_pitchmcomb (uint_t buf_size, uint_t hop_size);
 
 /** deletion of the pitch detection object
-
+ 
   \param p pitch detection object as returned by new_aubio_pitchfcomb
-
+ 
 */
 void del_aubio_pitchmcomb (aubio_pitchmcomb_t * p);
@@ -75 +73 @@
 #endif
 
-#endif /* PITCHMCOMB_H */
+#endif/*PITCHMCOMB_H*/