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 the YIN algorithm
25 This algorithm was developed by A. de Cheveigne and H. Kawahara and
28 De Cheveigné, A., Kawahara, H. (2002) "YIN, a fundamental frequency
29 estimator for speech and music", J. Acoust. Soc. Am. 111, 1917-1930.
31 see http://recherche.ircam.fr/equipes/pcm/pub/people/cheveign.html
32 http://recherche.ircam.fr/equipes/pcm/cheveign/ps/2002_JASA_YIN_proof.pdf
34 \example pitch/test-pitchyin.c
38 #ifndef _AUBIO_PITCHYIN_H
39 #define _AUBIO_PITCHYIN_H
45 /** pitch detection object */
46 typedef struct _aubio_pitchyin_t aubio_pitchyin_t;
48 /** creation of the pitch detection object
50 \param buf_size size of the input buffer to analyse
53 aubio_pitchyin_t *new_aubio_pitchyin (uint_t buf_size);
55 /** deletion of the pitch detection object
57 \param o pitch detection object as returned by new_aubio_pitchyin()
60 void del_aubio_pitchyin (aubio_pitchyin_t * o);
62 /** execute pitch detection an input buffer
64 \param o pitch detection object as returned by new_aubio_pitchyin()
65 \param samples_in input signal vector (length as specified at creation time)
66 \param cands_out pitch period candidates, in samples
69 void aubio_pitchyin_do (aubio_pitchyin_t * o, const fvec_t * samples_in, fvec_t * cands_out);
72 /** set tolerance parameter for YIN algorithm
74 \param o YIN pitch detection object
75 \param tol tolerance parameter for minima selection [default 0.15]
78 uint_t aubio_pitchyin_set_tolerance (aubio_pitchyin_t * o, smpl_t tol);
80 /** get tolerance parameter for YIN algorithm
82 \param o YIN pitch detection object
83 \return tolerance parameter for minima selection [default 0.15]
86 smpl_t aubio_pitchyin_get_tolerance (aubio_pitchyin_t * o);
88 /** get current confidence of YIN algorithm
90 \param o YIN pitch detection object
91 \return confidence parameter
94 smpl_t aubio_pitchyin_get_confidence (aubio_pitchyin_t * o);
100 #endif /* _AUBIO_PITCHYIN_H */