2 Copyright (C) 2003-2013 Paul Brossier <piem@aubio.org>
4 This file is part of aubio.
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.
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.
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/>.
23 Pitch detection using a fast harmonic comb filter
25 This pitch extraction method implements a fast harmonic comb filter to
26 determine the fundamental frequency of a harmonic sound.
28 This file was derived from the tuneit project, written by Mario Lang to
29 detect the fundamental frequency of a sound.
31 See http://delysid.org/tuneit.html
33 \example pitch/test-pitchfcomb.c
37 #ifndef AUBIO_PITCHFCOMB_H
38 #define AUBIO_PITCHFCOMB_H
44 /** pitch detection object */
45 typedef struct _aubio_pitchfcomb_t aubio_pitchfcomb_t;
47 /** execute pitch detection on an input buffer
49 \param p pitch detection object as returned by new_aubio_pitchfcomb
50 \param input input signal window (length as specified at creation time)
51 \param output pitch candidates in bins
54 void aubio_pitchfcomb_do (aubio_pitchfcomb_t * p, const fvec_t * input,
57 /** creation of the pitch detection object
59 \param buf_size size of the input buffer to analyse
60 \param hop_size step size between two consecutive analysis instant
63 aubio_pitchfcomb_t *new_aubio_pitchfcomb (uint_t buf_size, uint_t hop_size);
65 /** deletion of the pitch detection object
67 \param p pitch detection object as returned by new_aubio_pitchfcomb
70 void del_aubio_pitchfcomb (aubio_pitchfcomb_t * p);
76 #endif /* AUBIO_PITCHFCOMB_H */