Changeset 78fa561


Ignore:
Timestamp:
May 17, 2006, 9:38:32 PM (18 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:
2 edited

Legend:

Unmodified
Added
Removed
  • src/pitchschmitt.c

    r7f3ccc5e r78fa561  
    1717
    1818*/
    19 
    20 /*
    21  
    22    This file was taken from the tuneit project, in the file
    23    tuneit.c -- Detect fundamental frequency of a sound
    24    see http://delysid.org/tuneit.html
    25  
    26  */
    2719
    2820#include "aubio_priv.h"
  • src/pitchschmitt.h

    r7f3ccc5e r78fa561  
    1818*/
    1919
     20/** \file
     21
     22   Pitch detection using a Schmitt trigger
     23 
     24   This pitch extraction method implements a Schmitt trigger to estimate the
     25   period of a signal.
     26
     27   This file was derived from the tuneit project, written by Mario Lang to
     28   detect the fundamental frequency of a sound.
     29   
     30   see http://delysid.org/tuneit.html
     31
     32*/
     33
    2034#ifndef _PITCHSCHMITT_H
    2135#define _PITCHSCHMITT_H
     
    2539#endif
    2640
     41/** pitch detection object */
    2742typedef struct _aubio_pitchschmitt_t aubio_pitchschmitt_t;
    2843
     44/** execute pitch detection on an input buffer
     45 
     46  \param p pitch detection object as returned by new_aubio_pitchschmitt
     47  \param input input signal window (length as specified at creation time)
     48 
     49*/
    2950smpl_t aubio_pitchschmitt_detect (aubio_pitchschmitt_t *p, fvec_t * input);
     51/** creation of the pitch detection object
     52 
     53  \param size size of the input buffer to analyse
     54  \param samplerate sampling rate of the signal
     55 
     56*/
    3057aubio_pitchschmitt_t * new_aubio_pitchschmitt (uint_t size, uint_t samplerate);
     58/** deletion of the pitch detection object
     59 
     60  \param p pitch detection object as returned by new_aubio_pitchschmitt
     61 
     62*/
    3163void del_aubio_pitchschmitt (aubio_pitchschmitt_t *p);
    3264
Note: See TracChangeset for help on using the changeset viewer.