rename aubio_pitchdetection to aubio_pitch
[aubio.git] / src / pitch / pitch.h
similarity index 80%
rename from src/pitch/pitchdetection.h
rename to src/pitch/pitch.h
index e84c57020aa531a905589af303e2f2a13b792a2a..df64db849167e83e33ee06b6fa6636f7498abb3f 100644 (file)
@@ -16,8 +16,8 @@
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
    */
 
-#ifndef PITCHAUTOTCORR_H
-#define PITCHAUTOTCORR_H
+#ifndef PITCH_H
+#define PITCH_H
 
 #ifdef __cplusplus
 extern "C" {
@@ -33,33 +33,33 @@ extern "C" {
 */
 
 /** pitch detection object */
-typedef struct _aubio_pitchdetection_t aubio_pitchdetection_t;
+typedef struct _aubio_pitch_t aubio_pitch_t;
 
 /** execute pitch detection on an input signal frame
 
-  \param o pitch detection object as returned by new_aubio_pitchdetection()
+  \param o pitch detection object as returned by new_aubio_pitch()
   \param in input signal of size [hopsize x channels]
   \param out output pitch candidates of size [1 x channes]
 
 */
-void aubio_pitchdetection_do (aubio_pitchdetection_t * o, fvec_t * in,
+void aubio_pitch_do (aubio_pitch_t * o, fvec_t * in,
     fvec_t * out);
 
 /** change yin or yinfft tolerance threshold
 
-  \param o pitch detection object as returned by new_aubio_pitchdetection()
+  \param o pitch detection object as returned by new_aubio_pitch()
   \param tol tolerance default is 0.15 for yin and 0.85 for yinfft
 
 */
-uint_t aubio_pitchdetection_set_tolerance (aubio_pitchdetection_t * o,
+uint_t aubio_pitch_set_tolerance (aubio_pitch_t * o,
     smpl_t tol);
 
 /** deletion of the pitch detection object
 
-  \param o pitch detection object as returned by new_aubio_pitchdetection()
+  \param o pitch detection object as returned by new_aubio_pitch()
 
 */
-void del_aubio_pitchdetection (aubio_pitchdetection_t * o);
+void del_aubio_pitch (aubio_pitch_t * o);
 
 /** creation of the pitch detection object
 
@@ -70,20 +70,20 @@ void del_aubio_pitchdetection (aubio_pitchdetection_t * o);
   \param samplerate sampling rate of the signal
 
 */
-aubio_pitchdetection_t *new_aubio_pitchdetection (char_t * mode,
+aubio_pitch_t * new_aubio_pitch (char_t * mode,
     uint_t bufsize, uint_t hopsize, uint_t channels, uint_t samplerate);
 
 /** set the output unit of the pitch detection object 
 
-  \param o pitch detection object as returned by new_aubio_pitchdetection()
+  \param o pitch detection object as returned by new_aubio_pitch()
   \param mode set pitch units for output
 
 */
-uint_t aubio_pitchdetection_set_unit (aubio_pitchdetection_t * o,
+uint_t aubio_pitch_set_unit (aubio_pitch_t * o,
     char_t * mode);
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif /*PITCHDETECTION_H*/
+#endif /*PITCH_H*/