Changes in src/pitchdetection.h [6d4ec49:f44b111]

File:

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

src/pitchdetection.h

@@ -15 +15 @@
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-   */
+*/
 
 #ifndef PITCHAUTOTCORR_H
@@ -26 +26 @@
 /** \file
 
-  Generic method for pitch detection
+  Generic method for pitch detection  
 
   This file creates the objects required for the computation of the selected
@@ -35 +35 @@
 /** pitch detection algorithm */
 typedef enum {
-  aubio_pitch_yin,     /**< YIN algorithm */
-  aubio_pitch_mcomb,   /**< Multi-comb filter */
-  aubio_pitch_schmitt, /**< Schmitt trigger */
-  aubio_pitch_fcomb,   /**< Fast comb filter */
-  aubio_pitch_yinfft   /**< Spectral YIN */
+        aubio_pitch_yin,     /**< YIN algorithm */
+        aubio_pitch_mcomb,   /**< Multi-comb filter */
+        aubio_pitch_schmitt, /**< Schmitt trigger */
+        aubio_pitch_fcomb,   /**< Fast comb filter */
+        aubio_pitch_yinfft   /**< Spectral YIN */
 } aubio_pitchdetection_type;
 
 /** pitch detection output mode */
 typedef enum {
-  aubio_pitchm_freq,   /**< Frequency (Hz) */
-  aubio_pitchm_midi,   /**< MIDI note (0.,127) */
-  aubio_pitchm_cent,   /**< Cent */
-  aubio_pitchm_bin     /**< Frequency bin (0,bufsize) */
+        aubio_pitchm_freq,   /**< Frequency (Hz) */
+        aubio_pitchm_midi,   /**< MIDI note (0.,127) */
+        aubio_pitchm_cent,   /**< Cent */
+        aubio_pitchm_bin     /**< Frequency bin (0,bufsize) */
 } aubio_pitchdetection_mode;
 
@@ -54 +54 @@
 
 /** execute pitch detection on an input signal frame
-
+ 
   \param p pitch detection object as returned by new_aubio_pitchdetection
-  \param ibuf input signal of length hopsize
-
+  \param ibuf input signal of length hopsize 
+ 
 */
 smpl_t aubio_pitchdetection(aubio_pitchdetection_t * p, fvec_t * ibuf);
 
 /** change yin or yinfft tolerance threshold
-
+  
   default is 0.15 for yin and 0.85 for yinfft
-
+ 
 */
 void aubio_pitchdetection_set_yinthresh(aubio_pitchdetection_t *p, smpl_t thres);
 
 /** deletion of the pitch detection object
-
+ 
   \param p pitch detection object as returned by new_aubio_pitchdetection
-
+ 
 */
 void del_aubio_pitchdetection(aubio_pitchdetection_t * p);
 
 /** creation of the pitch detection object
-
-  \param bufsize size of the input buffer to analyse
-  \param hopsize step size between two consecutive analysis instant
+ 
+  \param bufsize size of the input buffer to analyse 
+  \param hopsize step size between two consecutive analysis instant 
   \param channels number of channels to analyse
-  \param samplerate sampling rate of the signal
+  \param samplerate sampling rate of the signal 
   \param type set pitch detection algorithm
   \param mode set pitch units for output
-
+ 
 */
-aubio_pitchdetection_t * new_aubio_pitchdetection(uint_t bufsize,
-    uint_t hopsize,
-    uint_t channels,
-    uint_t samplerate,
-    aubio_pitchdetection_type type,
-    aubio_pitchdetection_mode mode);
+aubio_pitchdetection_t * new_aubio_pitchdetection(uint_t bufsize, 
+        uint_t hopsize, 
+        uint_t channels,
+        uint_t samplerate,
+        aubio_pitchdetection_type type,
+        aubio_pitchdetection_mode mode);
 
 #ifdef __cplusplus
@@ -96 +96 @@
 #endif
 
-#endif /*PITCHDETECTION_H*/
+#endif /*PITCHDETECTION_H*/