src/pitch/pitchschmitt.h

   1 /*
   2   Copyright (C) 2003-2009 Paul Brossier <piem@aubio.org>
   3
   4   This file is part of aubio.
   5
   6   aubio is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   aubio is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with aubio.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** \file
  22
  23    Pitch detection using a Schmitt trigger
  24
  25    This pitch extraction method implements a Schmitt trigger to estimate the
  26    period of a signal.
  27
  28    This file was derived from the tuneit project, written by Mario Lang to
  29    detect the fundamental frequency of a sound.
  30
  31    see http://delysid.org/tuneit.html
  32
  33 */
  34
  35 #ifndef _PITCHSCHMITT_H
  36 #define _PITCHSCHMITT_H
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /** pitch detection object */
  43 typedef struct _aubio_pitchschmitt_t aubio_pitchschmitt_t;
  44
  45 /** execute pitch detection on an input buffer
  46
  47   \param p pitch detection object as returned by new_aubio_pitchschmitt
  48   \param input input signal window (length as specified at creation time)
  49   \param output pitch period estimates, in samples
  50
  51 */
  52 void aubio_pitchschmitt_do (aubio_pitchschmitt_t * p, fvec_t * in,
  53     fvec_t * out);
  54
  55 /** creation of the pitch detection object
  56
  57   \param buf_size size of the input buffer to analyse
  58
  59 */
  60 aubio_pitchschmitt_t *new_aubio_pitchschmitt (uint_t buf_size);
  61
  62 /** deletion of the pitch detection object
  63
  64   \param p pitch detection object as returned by new_aubio_pitchschmitt
  65
  66 */
  67 void del_aubio_pitchschmitt (aubio_pitchschmitt_t * p);
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif
  72
  73 #endif /* _PITCHSCHMITT_H */
  74