Changeset 78fa561 for src

Timestamp:

May 17, 2006, 9:38:32 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:

ebfbd15

Parents:

7f3ccc5e

Message:

update pitch method comments
update pitch method comments

Location:

src

Files:

• pitchschmitt.c (modified) (1 diff)
• pitchschmitt.h (modified) (2 diffs)

src/pitchschmitt.c

@@ -17 +17 @@
 
 */
-
-/* 
-  
-   This file was taken from the tuneit project, in the file
-   tuneit.c -- Detect fundamental frequency of a sound
-   see http://delysid.org/tuneit.html 
-  
- */
 
 #include "aubio_priv.h"

src/pitchschmitt.h

@@ -18 +18 @@
 */
 
+/** \file 
+
+   Pitch detection using a Schmitt trigger 
+ 
+   This pitch extraction method implements a Schmitt trigger to estimate the
+   period of a signal.
+
+   This file was derived from the tuneit project, written by Mario Lang to
+   detect the fundamental frequency of a sound.
+   
+   see http://delysid.org/tuneit.html 
+
+*/
+
 #ifndef _PITCHSCHMITT_H
 #define _PITCHSCHMITT_H
@@ -25 +39 @@
 #endif
 
+/** pitch detection object */
 typedef struct _aubio_pitchschmitt_t aubio_pitchschmitt_t;
 
+/** execute pitch detection on an input buffer 
+ 
+  \param p pitch detection object as returned by new_aubio_pitchschmitt 
+  \param input input signal window (length as specified at creation time) 
+ 
+*/
 smpl_t aubio_pitchschmitt_detect (aubio_pitchschmitt_t *p, fvec_t * input);
+/** creation of the pitch detection object
+ 
+  \param size size of the input buffer to analyse 
+  \param samplerate sampling rate of the signal 
+ 
+*/
 aubio_pitchschmitt_t * new_aubio_pitchschmitt (uint_t size, uint_t samplerate);
+/** deletion of the pitch detection object
+ 
+  \param p pitch detection object as returned by new_aubio_pitchschmitt 
+ 
+*/
 void del_aubio_pitchschmitt (aubio_pitchschmitt_t *p);