2 Copyright (C) 2003-2009 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/>.
21 /* This algorithm was developed by A. de Cheveigné and H. Kawahara and
24 * de Cheveigné, A., Kawahara, H. (2002) "YIN, a fundamental frequency
25 * estimator for speech and music", J. Acoust. Soc. Am. 111, 1917-1930.
27 * see http://recherche.ircam.fr/equipes/pcm/pub/people/cheveign.html
30 #include "aubio_priv.h"
32 #include "mathutils.h"
33 #include "pitch/pitchyin.h"
35 struct _aubio_pitchyin_t
43 /** compute difference function
45 \param input input signal
46 \param yinbuf output buffer to store difference function (half shorter than input)
49 void aubio_pitchyin_diff (fvec_t * input, fvec_t * yinbuf);
51 /** in place computation of the YIN cumulative normalised function
53 \param yinbuf input signal (a square difference function), also used to store function
56 void aubio_pitchyin_getcum (fvec_t * yinbuf);
58 /** detect pitch in a YIN function
60 \param yinbuf input buffer as computed by aubio_pitchyin_getcum
63 uint_t aubio_pitchyin_getpitch (const fvec_t * yinbuf);
67 new_aubio_pitchyin (uint_t bufsize)
69 aubio_pitchyin_t *o = AUBIO_NEW (aubio_pitchyin_t);
70 o->yin = new_fvec (bufsize / 2);
77 del_aubio_pitchyin (aubio_pitchyin_t * o)
84 /* outputs the difference function */
86 aubio_pitchyin_diff (fvec_t * input, fvec_t * yin)
90 for (tau = 0; tau < yin->length; tau++) {
93 for (tau = 1; tau < yin->length; tau++) {
94 for (j = 0; j < yin->length; j++) {
95 tmp = input->data[j] - input->data[j + tau];
96 yin->data[tau] += SQR (tmp);
101 /* cumulative mean normalized difference function */
103 aubio_pitchyin_getcum (fvec_t * yin)
108 //AUBIO_DBG("%f\t",yin->data[0]);
109 for (tau = 1; tau < yin->length; tau++) {
110 tmp += yin->data[tau];
111 yin->data[tau] *= tau / tmp;
112 //AUBIO_DBG("%f\t",yin->data[tau]);
118 aubio_pitchyin_getpitch (const fvec_t * yin)
122 if (yin->data[tau] < 0.1) {
123 while (yin->data[tau + 1] < yin->data[tau]) {
129 } while (tau < yin->length);
130 //AUBIO_DBG("No pitch found");
135 /* all the above in one */
137 aubio_pitchyin_do (aubio_pitchyin_t * o, const fvec_t * input, fvec_t * out)
139 const smpl_t tol = o->tol;
140 fvec_t* yin = o->yin;
141 const smpl_t *input_data = input->data;
142 const uint_t length = yin->length;
143 smpl_t *yin_data = yin->data;
146 smpl_t tmp, tmp2 = 0.;
149 for (tau = 1; tau < length; tau++) {
151 for (j = 0; j < length; j++) {
152 tmp = input_data[j] - input_data[j + tau];
153 yin_data[tau] += SQR (tmp);
155 tmp2 += yin_data[tau];
157 yin->data[tau] *= tau / tmp2;
162 if (tau > 4 && (yin_data[period] < tol) &&
163 (yin_data[period] < yin_data[period + 1])) {
164 o->peak_pos = (uint_t)period;
165 out->data[0] = fvec_quadratic_peak_pos (yin, o->peak_pos);
169 o->peak_pos = (uint_t)fvec_min_elem (yin);
170 out->data[0] = fvec_quadratic_peak_pos (yin, o->peak_pos);
174 aubio_pitchyin_get_confidence (aubio_pitchyin_t * o) {
175 return 1. - o->yin->data[o->peak_pos];
179 aubio_pitchyin_set_tolerance (aubio_pitchyin_t * o, smpl_t tol)
186 aubio_pitchyin_get_tolerance (aubio_pitchyin_t * o)