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 #include "aubio_priv.h"
25 #include "mathutils.h"
26 #include "musicutils.h"
27 #include "spectral/phasevoc.h"
28 #include "temporal/filter.h"
29 #include "temporal/c_weighting.h"
30 #include "pitch/pitchmcomb.h"
31 #include "pitch/pitchyin.h"
32 #include "pitch/pitchfcomb.h"
33 #include "pitch/pitchschmitt.h"
34 #include "pitch/pitchyinfft.h"
35 #include "pitch/pitchspecacf.h"
36 #include "pitch/pitch.h"
38 #define DEFAULT_PITCH_SILENCE -50.
40 /** pitch detection algorithms */
43 aubio_pitcht_yin, /**< `yin`, YIN algorithm */
44 aubio_pitcht_mcomb, /**< `mcomb`, Multi-comb filter */
45 aubio_pitcht_schmitt, /**< `schmitt`, Schmitt trigger */
46 aubio_pitcht_fcomb, /**< `fcomb`, Fast comb filter */
47 aubio_pitcht_yinfft, /**< `yinfft`, Spectral YIN */
48 aubio_pitcht_specacf, /**< `specacf`, Spectral autocorrelation */
50 = aubio_pitcht_yinfft, /**< `default` */
53 /** pitch detection output modes */
56 aubio_pitchm_freq, /**< Frequency (Hz) */
57 aubio_pitchm_midi, /**< MIDI note (0.,127) */
58 aubio_pitchm_cent, /**< Cent */
59 aubio_pitchm_bin, /**< Frequency bin (0,bufsize) */
60 aubio_pitchm_default = aubio_pitchm_freq, /**< the one used when "default" is asked */
63 /** callback to get pitch candidate, defined below */
64 typedef void (*aubio_pitch_detect_t) (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf);
66 /** callback to convert pitch from one unit to another, defined below */
67 typedef smpl_t(*aubio_pitch_convert_t) (smpl_t value, uint_t samplerate, uint_t bufsize);
69 /** callback to fetch the confidence of the algorithm */
70 typedef smpl_t (*aubio_pitch_get_conf_t) (void * p);
72 /** generic pitch detection structure */
75 aubio_pitch_type type; /**< pitch detection mode */
76 aubio_pitch_mode mode; /**< pitch detection output mode */
77 uint_t samplerate; /**< samplerate */
78 uint_t bufsize; /**< buffer size */
79 void *p_object; /**< pointer to pitch object */
80 aubio_filter_t *filter; /**< filter */
81 aubio_pvoc_t *pv; /**< phase vocoder for mcomb */
82 cvec_t *fftgrain; /**< spectral frame for mcomb */
83 fvec_t *buf; /**< temporary buffer for yin */
84 aubio_pitch_detect_t detect_cb; /**< callback to get the pitch candidates */
85 aubio_pitch_convert_t conv_cb; /**< callback to convert it to the desired unit */
86 aubio_pitch_get_conf_t conf_cb; /**< pointer to the current confidence callback */
87 smpl_t silence; /**< silence threshold */
90 /* callback functions for pitch detection */
91 static void aubio_pitch_do_mcomb (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf);
92 static void aubio_pitch_do_yin (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf);
93 static void aubio_pitch_do_schmitt (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf);
94 static void aubio_pitch_do_fcomb (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf);
95 static void aubio_pitch_do_yinfft (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf);
96 static void aubio_pitch_do_specacf (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf);
98 /* conversion functions for frequency conversions */
99 smpl_t freqconvbin (smpl_t f, uint_t samplerate, uint_t bufsize);
100 smpl_t freqconvmidi (smpl_t f, uint_t samplerate, uint_t bufsize);
101 smpl_t freqconvpass (smpl_t f, uint_t samplerate, uint_t bufsize);
103 /* adapter to stack ibuf new samples at the end of buf, and trim `buf` to `bufsize` */
104 void aubio_pitch_slideblock (aubio_pitch_t * p, fvec_t * ibuf);
108 new_aubio_pitch (char_t * pitch_mode,
109 uint_t bufsize, uint_t hopsize, uint_t samplerate)
111 aubio_pitch_t *p = AUBIO_NEW (aubio_pitch_t);
112 aubio_pitch_type pitch_type;
113 if (strcmp (pitch_mode, "mcomb") == 0)
114 pitch_type = aubio_pitcht_mcomb;
115 else if (strcmp (pitch_mode, "yinfft") == 0)
116 pitch_type = aubio_pitcht_yinfft;
117 else if (strcmp (pitch_mode, "yin") == 0)
118 pitch_type = aubio_pitcht_yin;
119 else if (strcmp (pitch_mode, "schmitt") == 0)
120 pitch_type = aubio_pitcht_schmitt;
121 else if (strcmp (pitch_mode, "fcomb") == 0)
122 pitch_type = aubio_pitcht_fcomb;
123 else if (strcmp (pitch_mode, "specacf") == 0)
124 pitch_type = aubio_pitcht_specacf;
125 else if (strcmp (pitch_mode, "default") == 0)
126 pitch_type = aubio_pitcht_default;
128 AUBIO_ERR ("unknown pitch detection method %s, using default.\n",
130 pitch_type = aubio_pitcht_default;
133 // check parameters are valid
134 if ((sint_t)hopsize < 1) {
135 AUBIO_ERR("onset: got hopsize %d, but can not be < 1\n", hopsize);
137 } else if ((sint_t)bufsize < 1) {
138 AUBIO_ERR("onset: got buffer_size %d, but can not be < 1\n", bufsize);
140 } else if (bufsize < hopsize) {
141 AUBIO_ERR("onset: hop size (%d) is larger than win size (%d)\n", bufsize, hopsize);
143 } else if ((sint_t)samplerate < 1) {
144 AUBIO_ERR("onset: samplerate (%d) can not be < 1\n", samplerate);
148 p->samplerate = samplerate;
149 p->type = pitch_type;
150 aubio_pitch_set_unit (p, "default");
151 p->bufsize = bufsize;
152 p->silence = DEFAULT_PITCH_SILENCE;
155 case aubio_pitcht_yin:
156 p->buf = new_fvec (bufsize);
157 p->p_object = new_aubio_pitchyin (bufsize);
158 p->detect_cb = aubio_pitch_do_yin;
159 p->conf_cb = (aubio_pitch_get_conf_t)aubio_pitchyin_get_confidence;
160 aubio_pitchyin_set_tolerance (p->p_object, 0.15);
162 case aubio_pitcht_mcomb:
163 p->pv = new_aubio_pvoc (bufsize, hopsize);
164 p->fftgrain = new_cvec (bufsize);
165 p->p_object = new_aubio_pitchmcomb (bufsize, hopsize);
166 p->filter = new_aubio_filter_c_weighting (samplerate);
167 p->detect_cb = aubio_pitch_do_mcomb;
169 case aubio_pitcht_fcomb:
170 p->buf = new_fvec (bufsize);
171 p->p_object = new_aubio_pitchfcomb (bufsize, hopsize);
172 p->detect_cb = aubio_pitch_do_fcomb;
174 case aubio_pitcht_schmitt:
175 p->buf = new_fvec (bufsize);
176 p->p_object = new_aubio_pitchschmitt (bufsize);
177 p->detect_cb = aubio_pitch_do_schmitt;
179 case aubio_pitcht_yinfft:
180 p->buf = new_fvec (bufsize);
181 p->p_object = new_aubio_pitchyinfft (samplerate, bufsize);
182 p->detect_cb = aubio_pitch_do_yinfft;
183 p->conf_cb = (aubio_pitch_get_conf_t)aubio_pitchyinfft_get_confidence;
184 aubio_pitchyinfft_set_tolerance (p->p_object, 0.85);
186 case aubio_pitcht_specacf:
187 p->buf = new_fvec (bufsize);
188 p->p_object = new_aubio_pitchspecacf (bufsize);
189 p->detect_cb = aubio_pitch_do_specacf;
190 p->conf_cb = (aubio_pitch_get_conf_t)aubio_pitchspecacf_get_tolerance;
191 aubio_pitchspecacf_set_tolerance (p->p_object, 0.85);
204 del_aubio_pitch (aubio_pitch_t * p)
207 case aubio_pitcht_yin:
209 del_aubio_pitchyin (p->p_object);
211 case aubio_pitcht_mcomb:
212 del_aubio_pvoc (p->pv);
213 del_cvec (p->fftgrain);
214 del_aubio_filter (p->filter);
215 del_aubio_pitchmcomb (p->p_object);
217 case aubio_pitcht_schmitt:
219 del_aubio_pitchschmitt (p->p_object);
221 case aubio_pitcht_fcomb:
223 del_aubio_pitchfcomb (p->p_object);
225 case aubio_pitcht_yinfft:
227 del_aubio_pitchyinfft (p->p_object);
229 case aubio_pitcht_specacf:
231 del_aubio_pitchspecacf (p->p_object);
240 aubio_pitch_slideblock (aubio_pitch_t * p, fvec_t * ibuf)
242 uint_t j = 0, overlap_size = 0;
243 overlap_size = p->buf->length - ibuf->length;
244 for (j = 0; j < overlap_size; j++) {
245 p->buf->data[j] = p->buf->data[j + ibuf->length];
247 for (j = 0; j < ibuf->length; j++) {
248 p->buf->data[j + overlap_size] = ibuf->data[j];
253 aubio_pitch_set_unit (aubio_pitch_t * p, char_t * pitch_unit)
255 uint_t err = AUBIO_OK;
256 aubio_pitch_mode pitch_mode;
257 if (strcmp (pitch_unit, "freq") == 0)
258 pitch_mode = aubio_pitchm_freq;
259 else if (strcmp (pitch_unit, "hertz") == 0)
260 pitch_mode = aubio_pitchm_freq;
261 else if (strcmp (pitch_unit, "Hertz") == 0)
262 pitch_mode = aubio_pitchm_freq;
263 else if (strcmp (pitch_unit, "Hz") == 0)
264 pitch_mode = aubio_pitchm_freq;
265 else if (strcmp (pitch_unit, "f0") == 0)
266 pitch_mode = aubio_pitchm_freq;
267 else if (strcmp (pitch_unit, "midi") == 0)
268 pitch_mode = aubio_pitchm_midi;
269 else if (strcmp (pitch_unit, "cent") == 0)
270 pitch_mode = aubio_pitchm_cent;
271 else if (strcmp (pitch_unit, "bin") == 0)
272 pitch_mode = aubio_pitchm_bin;
273 else if (strcmp (pitch_unit, "default") == 0)
274 pitch_mode = aubio_pitchm_default;
276 AUBIO_ERR ("unknown pitch detection unit %s, using default\n", pitch_unit);
277 pitch_mode = aubio_pitchm_default;
280 p->mode = pitch_mode;
282 case aubio_pitchm_freq:
283 p->conv_cb = freqconvpass;
285 case aubio_pitchm_midi:
286 p->conv_cb = freqconvmidi;
288 case aubio_pitchm_cent:
289 /* bug: not implemented */
290 p->conv_cb = freqconvmidi;
292 case aubio_pitchm_bin:
293 p->conv_cb = freqconvbin;
302 aubio_pitch_set_tolerance (aubio_pitch_t * p, smpl_t tol)
305 case aubio_pitcht_yin:
306 aubio_pitchyin_set_tolerance (p->p_object, tol);
308 case aubio_pitcht_yinfft:
309 aubio_pitchyinfft_set_tolerance (p->p_object, tol);
318 aubio_pitch_set_silence (aubio_pitch_t * p, smpl_t silence)
320 if (silence <= 0 && silence >= -200) {
321 p->silence = silence;
324 AUBIO_ERR("pitch: could not set silence to %.2f", silence);
330 aubio_pitch_get_silence (aubio_pitch_t * p)
336 /* do method, calling the detection callback, then the conversion callback */
338 aubio_pitch_do (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf)
340 p->detect_cb (p, ibuf, obuf);
341 if (aubio_silence_detection(ibuf, p->silence) == 1) {
344 obuf->data[0] = p->conv_cb (obuf->data[0], p->samplerate, p->bufsize);
347 /* do method for each algorithm */
349 aubio_pitch_do_mcomb (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf)
351 aubio_filter_do (p->filter, ibuf);
352 aubio_pvoc_do (p->pv, ibuf, p->fftgrain);
353 aubio_pitchmcomb_do (p->p_object, p->fftgrain, obuf);
354 obuf->data[0] = aubio_bintofreq (obuf->data[0], p->samplerate, p->bufsize);
358 aubio_pitch_do_yin (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf)
361 aubio_pitch_slideblock (p, ibuf);
362 aubio_pitchyin_do (p->p_object, p->buf, obuf);
363 pitch = obuf->data[0];
365 pitch = p->samplerate / (pitch + 0.);
369 obuf->data[0] = pitch;
374 aubio_pitch_do_yinfft (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf)
377 aubio_pitch_slideblock (p, ibuf);
378 aubio_pitchyinfft_do (p->p_object, p->buf, obuf);
379 pitch = obuf->data[0];
381 pitch = p->samplerate / (pitch + 0.);
385 obuf->data[0] = pitch;
389 aubio_pitch_do_specacf (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * out)
391 smpl_t pitch = 0., period;
392 aubio_pitch_slideblock (p, ibuf);
393 aubio_pitchspecacf_do (p->p_object, p->buf, out);
394 //out->data[0] = aubio_bintofreq (out->data[0], p->samplerate, p->bufsize);
395 period = out->data[0];
397 pitch = p->samplerate / period;
401 out->data[0] = pitch;
405 aubio_pitch_do_fcomb (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * out)
407 aubio_pitch_slideblock (p, ibuf);
408 aubio_pitchfcomb_do (p->p_object, p->buf, out);
409 out->data[0] = aubio_bintofreq (out->data[0], p->samplerate, p->bufsize);
413 aubio_pitch_do_schmitt (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * out)
415 smpl_t period, pitch = 0.;
416 aubio_pitch_slideblock (p, ibuf);
417 aubio_pitchschmitt_do (p->p_object, p->buf, out);
418 period = out->data[0];
420 pitch = p->samplerate / period;
424 out->data[0] = pitch;
427 /* conversion callbacks */
429 freqconvbin(smpl_t f, uint_t samplerate, uint_t bufsize)
431 return aubio_freqtobin(f, samplerate, bufsize);
435 freqconvmidi (smpl_t f, uint_t samplerate UNUSED, uint_t bufsize UNUSED)
437 return aubio_freqtomidi (f);
441 freqconvpass (smpl_t f, uint_t samplerate UNUSED, uint_t bufsize UNUSED)
446 /* confidence callbacks */
448 aubio_pitch_get_confidence (aubio_pitch_t * p)
451 return p->conf_cb(p->p_object);