source: src/pitch/pitch.c @ afa21cdc

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since afa21cdc was afa21cdc, checked in by Paul Brossier <piem@piem.org>, 8 years ago

src/pitch/pitch.c: fail on wrong method, warn on wrong unit, improve error messages

  • Property mode set to 100644
File size: 14.3 KB
Line 
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#include "aubio_priv.h"
22#include "fvec.h"
23#include "cvec.h"
24#include "lvec.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"
37
38#define DEFAULT_PITCH_SILENCE -50.
39
40/** pitch detection algorithms */
41typedef enum
42{
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 */
49  aubio_pitcht_default
50    = aubio_pitcht_yinfft, /**< `default` */
51} aubio_pitch_type;
52
53/** pitch detection output modes */
54typedef enum
55{
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 */
61} aubio_pitch_mode;
62
63/** callback to get pitch candidate, defined below */
64typedef void (*aubio_pitch_detect_t) (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
65
66/** callback to convert pitch from one unit to another, defined below */
67typedef smpl_t(*aubio_pitch_convert_t) (smpl_t value, uint_t samplerate, uint_t bufsize);
68
69/** callback to fetch the confidence of the algorithm */
70typedef smpl_t (*aubio_pitch_get_conf_t) (void * p);
71
72/** generic pitch detection structure */
73struct _aubio_pitch_t
74{
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  fvec_t *filtered;               /**< filtered input */
82  aubio_pvoc_t *pv;               /**< phase vocoder for mcomb */
83  cvec_t *fftgrain;               /**< spectral frame for mcomb */
84  fvec_t *buf;                    /**< temporary buffer for yin */
85  aubio_pitch_detect_t detect_cb; /**< callback to get the pitch candidates */
86  aubio_pitch_convert_t conv_cb;  /**< callback to convert it to the desired unit */
87  aubio_pitch_get_conf_t conf_cb; /**< pointer to the current confidence callback */
88  smpl_t silence;                 /**< silence threshold */
89};
90
91/* callback functions for pitch detection */
92static void aubio_pitch_do_mcomb (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
93static void aubio_pitch_do_yin (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
94static void aubio_pitch_do_schmitt (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
95static void aubio_pitch_do_fcomb (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
96static void aubio_pitch_do_yinfft (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
97static void aubio_pitch_do_specacf (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
98
99/* internal functions for frequency conversion */
100static smpl_t freqconvbin (smpl_t f, uint_t samplerate, uint_t bufsize);
101static smpl_t freqconvmidi (smpl_t f, uint_t samplerate, uint_t bufsize);
102static smpl_t freqconvpass (smpl_t f, uint_t samplerate, uint_t bufsize);
103
104/* adapter to stack ibuf new samples at the end of buf, and trim `buf` to `bufsize` */
105void aubio_pitch_slideblock (aubio_pitch_t * p, const fvec_t * ibuf);
106
107
108aubio_pitch_t *
109new_aubio_pitch (const char_t * pitch_mode,
110    uint_t bufsize, uint_t hopsize, uint_t samplerate)
111{
112  aubio_pitch_t *p = AUBIO_NEW (aubio_pitch_t);
113  aubio_pitch_type pitch_type;
114  if (strcmp (pitch_mode, "mcomb") == 0)
115    pitch_type = aubio_pitcht_mcomb;
116  else if (strcmp (pitch_mode, "yinfft") == 0)
117    pitch_type = aubio_pitcht_yinfft;
118  else if (strcmp (pitch_mode, "yin") == 0)
119    pitch_type = aubio_pitcht_yin;
120  else if (strcmp (pitch_mode, "schmitt") == 0)
121    pitch_type = aubio_pitcht_schmitt;
122  else if (strcmp (pitch_mode, "fcomb") == 0)
123    pitch_type = aubio_pitcht_fcomb;
124  else if (strcmp (pitch_mode, "specacf") == 0)
125    pitch_type = aubio_pitcht_specacf;
126  else if (strcmp (pitch_mode, "default") == 0)
127    pitch_type = aubio_pitcht_default;
128  else {
129    AUBIO_ERR ("pitch: unknown pitch detection method ‘%s’\n", pitch_mode);
130    goto beach;
131  }
132
133  // check parameters are valid
134  if ((sint_t)hopsize < 1) {
135    AUBIO_ERR("pitch: got hopsize %d, but can not be < 1\n", hopsize);
136    goto beach;
137  } else if ((sint_t)bufsize < 1) {
138    AUBIO_ERR("pitch: got buffer_size %d, but can not be < 1\n", bufsize);
139    goto beach;
140  } else if (bufsize < hopsize) {
141    AUBIO_ERR("pitch: hop size (%d) is larger than win size (%d)\n", bufsize, hopsize);
142    goto beach;
143  } else if ((sint_t)samplerate < 1) {
144    AUBIO_ERR("pitch: samplerate (%d) can not be < 1\n", samplerate);
145    goto beach;
146  }
147
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;
153  p->conf_cb = NULL;
154  switch (p->type) {
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);
161      break;
162    case aubio_pitcht_mcomb:
163      p->filtered = new_fvec (hopsize);
164      p->pv = new_aubio_pvoc (bufsize, hopsize);
165      p->fftgrain = new_cvec (bufsize);
166      p->p_object = new_aubio_pitchmcomb (bufsize, hopsize);
167      p->filter = new_aubio_filter_c_weighting (samplerate);
168      p->detect_cb = aubio_pitch_do_mcomb;
169      break;
170    case aubio_pitcht_fcomb:
171      p->buf = new_fvec (bufsize);
172      p->p_object = new_aubio_pitchfcomb (bufsize, hopsize);
173      p->detect_cb = aubio_pitch_do_fcomb;
174      break;
175    case aubio_pitcht_schmitt:
176      p->buf = new_fvec (bufsize);
177      p->p_object = new_aubio_pitchschmitt (bufsize);
178      p->detect_cb = aubio_pitch_do_schmitt;
179      break;
180    case aubio_pitcht_yinfft:
181      p->buf = new_fvec (bufsize);
182      p->p_object = new_aubio_pitchyinfft (samplerate, bufsize);
183      p->detect_cb = aubio_pitch_do_yinfft;
184      p->conf_cb = (aubio_pitch_get_conf_t)aubio_pitchyinfft_get_confidence;
185      aubio_pitchyinfft_set_tolerance (p->p_object, 0.85);
186      break;
187    case aubio_pitcht_specacf:
188      p->buf = new_fvec (bufsize);
189      p->p_object = new_aubio_pitchspecacf (bufsize);
190      p->detect_cb = aubio_pitch_do_specacf;
191      p->conf_cb = (aubio_pitch_get_conf_t)aubio_pitchspecacf_get_tolerance;
192      aubio_pitchspecacf_set_tolerance (p->p_object, 0.85);
193      break;
194    default:
195      break;
196  }
197  return p;
198
199beach:
200  AUBIO_FREE(p);
201  return NULL;
202}
203
204void
205del_aubio_pitch (aubio_pitch_t * p)
206{
207  switch (p->type) {
208    case aubio_pitcht_yin:
209      del_fvec (p->buf);
210      del_aubio_pitchyin (p->p_object);
211      break;
212    case aubio_pitcht_mcomb:
213      del_fvec (p->filtered);
214      del_aubio_pvoc (p->pv);
215      del_cvec (p->fftgrain);
216      del_aubio_filter (p->filter);
217      del_aubio_pitchmcomb (p->p_object);
218      break;
219    case aubio_pitcht_schmitt:
220      del_fvec (p->buf);
221      del_aubio_pitchschmitt (p->p_object);
222      break;
223    case aubio_pitcht_fcomb:
224      del_fvec (p->buf);
225      del_aubio_pitchfcomb (p->p_object);
226      break;
227    case aubio_pitcht_yinfft:
228      del_fvec (p->buf);
229      del_aubio_pitchyinfft (p->p_object);
230      break;
231    case aubio_pitcht_specacf:
232      del_fvec (p->buf);
233      del_aubio_pitchspecacf (p->p_object);
234      break;
235    default:
236      break;
237  }
238  AUBIO_FREE (p);
239}
240
241void
242aubio_pitch_slideblock (aubio_pitch_t * p, const fvec_t * ibuf)
243{
244  uint_t overlap_size = p->buf->length - ibuf->length;
245#if 1 //!HAVE_MEMCPY_HACKS
246  uint_t j;
247  for (j = 0; j < overlap_size; j++) {
248    p->buf->data[j] = p->buf->data[j + ibuf->length];
249  }
250  for (j = 0; j < ibuf->length; j++) {
251    p->buf->data[j + overlap_size] = ibuf->data[j];
252  }
253#else
254  smpl_t *data = p->buf->data;
255  smpl_t *newdata = ibuf->data;
256  memmove(data, data + ibuf->length, overlap_size);
257  memcpy(data + overlap_size, newdata, ibuf->length);
258#endif
259}
260
261uint_t
262aubio_pitch_set_unit (aubio_pitch_t * p, const char_t * pitch_unit)
263{
264  uint_t err = AUBIO_OK;
265  aubio_pitch_mode pitch_mode;
266  if (strcmp (pitch_unit, "freq") == 0)
267    pitch_mode = aubio_pitchm_freq;
268  else if (strcmp (pitch_unit, "hertz") == 0)
269    pitch_mode = aubio_pitchm_freq;
270  else if (strcmp (pitch_unit, "Hertz") == 0)
271    pitch_mode = aubio_pitchm_freq;
272  else if (strcmp (pitch_unit, "Hz") == 0)
273    pitch_mode = aubio_pitchm_freq;
274  else if (strcmp (pitch_unit, "f0") == 0)
275    pitch_mode = aubio_pitchm_freq;
276  else if (strcmp (pitch_unit, "midi") == 0)
277    pitch_mode = aubio_pitchm_midi;
278  else if (strcmp (pitch_unit, "cent") == 0)
279    pitch_mode = aubio_pitchm_cent;
280  else if (strcmp (pitch_unit, "bin") == 0)
281    pitch_mode = aubio_pitchm_bin;
282  else if (strcmp (pitch_unit, "default") == 0)
283    pitch_mode = aubio_pitchm_default;
284  else {
285    AUBIO_WRN("pitch: unknown pitch detection unit ‘%s’, using default\n",
286        pitch_unit);
287    pitch_mode = aubio_pitchm_default;
288    err = AUBIO_FAIL;
289  }
290  p->mode = pitch_mode;
291  switch (p->mode) {
292    case aubio_pitchm_freq:
293      p->conv_cb = freqconvpass;
294      break;
295    case aubio_pitchm_midi:
296      p->conv_cb = freqconvmidi;
297      break;
298    case aubio_pitchm_cent:
299      /* bug: not implemented */
300      p->conv_cb = freqconvmidi;
301      break;
302    case aubio_pitchm_bin:
303      p->conv_cb = freqconvbin;
304      break;
305    default:
306      break;
307  }
308  return err;
309}
310
311uint_t
312aubio_pitch_set_tolerance (aubio_pitch_t * p, smpl_t tol)
313{
314  switch (p->type) {
315    case aubio_pitcht_yin:
316      aubio_pitchyin_set_tolerance (p->p_object, tol);
317      break;
318    case aubio_pitcht_yinfft:
319      aubio_pitchyinfft_set_tolerance (p->p_object, tol);
320      break;
321    default:
322      break;
323  }
324  return AUBIO_OK;
325}
326
327smpl_t
328aubio_pitch_get_tolerance (aubio_pitch_t * p)
329{
330  smpl_t tolerance = 1.;
331  switch (p->type) {
332    case aubio_pitcht_yin:
333      tolerance = aubio_pitchyin_get_tolerance (p->p_object);
334      break;
335    case aubio_pitcht_yinfft:
336      tolerance = aubio_pitchyinfft_get_tolerance (p->p_object);
337      break;
338    default:
339      break;
340  }
341  return tolerance;
342}
343
344uint_t
345aubio_pitch_set_silence (aubio_pitch_t * p, smpl_t silence)
346{
347  if (silence <= 0 && silence >= -200) {
348    p->silence = silence;
349    return AUBIO_OK;
350  } else {
351    AUBIO_WRN("pitch: could not set silence to %.2f\n", silence);
352    return AUBIO_FAIL;
353  }
354}
355
356smpl_t
357aubio_pitch_get_silence (aubio_pitch_t * p)
358{
359  return p->silence;
360}
361
362
363/* do method, calling the detection callback, then the conversion callback */
364void
365aubio_pitch_do (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf)
366{
367  p->detect_cb (p, ibuf, obuf);
368  if (aubio_silence_detection(ibuf, p->silence) == 1) {
369    obuf->data[0] = 0.;
370  }
371  obuf->data[0] = p->conv_cb (obuf->data[0], p->samplerate, p->bufsize);
372}
373
374/* do method for each algorithm */
375void
376aubio_pitch_do_mcomb (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf)
377{
378  aubio_filter_do_outplace (p->filter, ibuf, p->filtered);
379  aubio_pvoc_do (p->pv, ibuf, p->fftgrain);
380  aubio_pitchmcomb_do (p->p_object, p->fftgrain, obuf);
381  obuf->data[0] = aubio_bintofreq (obuf->data[0], p->samplerate, p->bufsize);
382}
383
384void
385aubio_pitch_do_yin (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf)
386{
387  smpl_t pitch = 0.;
388  aubio_pitch_slideblock (p, ibuf);
389  aubio_pitchyin_do (p->p_object, p->buf, obuf);
390  pitch = obuf->data[0];
391  if (pitch > 0) {
392    pitch = p->samplerate / (pitch + 0.);
393  } else {
394    pitch = 0.;
395  }
396  obuf->data[0] = pitch;
397}
398
399
400void
401aubio_pitch_do_yinfft (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf)
402{
403  smpl_t pitch = 0.;
404  aubio_pitch_slideblock (p, ibuf);
405  aubio_pitchyinfft_do (p->p_object, p->buf, obuf);
406  pitch = obuf->data[0];
407  if (pitch > 0) {
408    pitch = p->samplerate / (pitch + 0.);
409  } else {
410    pitch = 0.;
411  }
412  obuf->data[0] = pitch;
413}
414
415void
416aubio_pitch_do_specacf (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * out)
417{
418  smpl_t pitch = 0., period;
419  aubio_pitch_slideblock (p, ibuf);
420  aubio_pitchspecacf_do (p->p_object, p->buf, out);
421  //out->data[0] = aubio_bintofreq (out->data[0], p->samplerate, p->bufsize);
422  period = out->data[0];
423  if (period > 0) {
424    pitch = p->samplerate / period;
425  } else {
426    pitch = 0.;
427  }
428  out->data[0] = pitch;
429}
430
431void
432aubio_pitch_do_fcomb (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * out)
433{
434  aubio_pitch_slideblock (p, ibuf);
435  aubio_pitchfcomb_do (p->p_object, p->buf, out);
436  out->data[0] = aubio_bintofreq (out->data[0], p->samplerate, p->bufsize);
437}
438
439void
440aubio_pitch_do_schmitt (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * out)
441{
442  smpl_t period, pitch = 0.;
443  aubio_pitch_slideblock (p, ibuf);
444  aubio_pitchschmitt_do (p->p_object, p->buf, out);
445  period = out->data[0];
446  if (period > 0) {
447    pitch = p->samplerate / period;
448  } else {
449    pitch = 0.;
450  }
451  out->data[0] = pitch;
452}
453
454/* conversion callbacks */
455smpl_t
456freqconvbin(smpl_t f, uint_t samplerate, uint_t bufsize)
457{
458  return aubio_freqtobin(f, samplerate, bufsize);
459}
460
461smpl_t
462freqconvmidi (smpl_t f, uint_t samplerate UNUSED, uint_t bufsize UNUSED)
463{
464  return aubio_freqtomidi (f);
465}
466
467smpl_t
468freqconvpass (smpl_t f, uint_t samplerate UNUSED, uint_t bufsize UNUSED)
469{
470  return f;
471}
472
473/* confidence callbacks */
474smpl_t
475aubio_pitch_get_confidence (aubio_pitch_t * p)
476{
477  if (p->conf_cb) {
478    return p->conf_cb(p->p_object);
479  }
480  return 0.;
481}
Note: See TracBrowser for help on using the repository browser.