From 78fa56189f5017b6e7888c7d7785a9296a9611dd Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Wed, 17 May 2006 19:38:32 +0000 Subject: [PATCH] update pitch method comments update pitch method comments --- src/pitchschmitt.c | 8 -------- src/pitchschmitt.h | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 8 deletions(-) diff --git a/src/pitchschmitt.c b/src/pitchschmitt.c index 087f21d0..04cf0179 100644 --- a/src/pitchschmitt.c +++ b/src/pitchschmitt.c @@ -17,14 +17,6 @@ */ -/* - - 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" #include "sample.h" #include "pitchschmitt.h" diff --git a/src/pitchschmitt.h b/src/pitchschmitt.h index c673be04..8a3192e2 100644 --- a/src/pitchschmitt.h +++ b/src/pitchschmitt.h @@ -17,6 +17,20 @@ */ +/** \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 @@ -24,10 +38,28 @@ extern "C" { #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); -- 2.26.2