src/pitch/pitch.c

   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 */
  41 typedef 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 */
  54 typedef 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 */
  64 typedef void (*aubio_pitch_detect_t) (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf);
  65
  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);
  68
  69 /** callback to fetch the confidence of the algorithm */
  70 typedef smpl_t (*aubio_pitch_get_conf_t) (void * p);
  71
  72 /** generic pitch detection structure */
  73 struct _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   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 */
  88 };
  89
  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);
  97
  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);
 102
 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);
 105
 106
 107 aubio_pitch_t *
 108 new_aubio_pitch (char_t * pitch_mode,
 109     uint_t bufsize, uint_t hopsize, uint_t samplerate)
 110 {
 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;
 127   else {
 128     AUBIO_ERR ("unknown pitch detection method %s, using default.\n",
 129         pitch_mode);
 130     pitch_type = aubio_pitcht_default;
 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->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;
 168       break;
 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;
 173       break;
 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;
 178       break;
 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);
 185       break;
 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);
 192       break;
 193     default:
 194       break;
 195   }
 196   return p;
 197
 198 beach:
 199   AUBIO_FREE(p);
 200   return NULL;
 201 }
 202
 203 void
 204 del_aubio_pitch (aubio_pitch_t * p)
 205 {
 206   switch (p->type) {
 207     case aubio_pitcht_yin:
 208       del_fvec (p->buf);
 209       del_aubio_pitchyin (p->p_object);
 210       break;
 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);
 216       break;
 217     case aubio_pitcht_schmitt:
 218       del_fvec (p->buf);
 219       del_aubio_pitchschmitt (p->p_object);
 220       break;
 221     case aubio_pitcht_fcomb:
 222       del_fvec (p->buf);
 223       del_aubio_pitchfcomb (p->p_object);
 224       break;
 225     case aubio_pitcht_yinfft:
 226       del_fvec (p->buf);
 227       del_aubio_pitchyinfft (p->p_object);
 228       break;
 229     case aubio_pitcht_specacf:
 230       del_fvec (p->buf);
 231       del_aubio_pitchspecacf (p->p_object);
 232       break;
 233     default:
 234       break;
 235   }
 236   AUBIO_FREE (p);
 237 }
 238
 239 void
 240 aubio_pitch_slideblock (aubio_pitch_t * p, fvec_t * ibuf)
 241 {
 242   uint_t overlap_size = p->buf->length - ibuf->length;
 243 #if 1 //!HAVE_MEMCPY_HACKS
 244   uint_t j;
 245   for (j = 0; j < overlap_size; j++) {
 246     p->buf->data[j] = p->buf->data[j + ibuf->length];
 247   }
 248   for (j = 0; j < ibuf->length; j++) {
 249     p->buf->data[j + overlap_size] = ibuf->data[j];
 250   }
 251 #else
 252   smpl_t *data = p->buf->data;
 253   smpl_t *newdata = ibuf->data;
 254   memmove(data, data + ibuf->length, overlap_size);
 255   memcpy(data + overlap_size, newdata, ibuf->length);
 256 #endif
 257 }
 258
 259 uint_t
 260 aubio_pitch_set_unit (aubio_pitch_t * p, char_t * pitch_unit)
 261 {
 262   uint_t err = AUBIO_OK;
 263   aubio_pitch_mode pitch_mode;
 264   if (strcmp (pitch_unit, "freq") == 0)
 265     pitch_mode = aubio_pitchm_freq;
 266   else if (strcmp (pitch_unit, "hertz") == 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, "Hz") == 0)
 271     pitch_mode = aubio_pitchm_freq;
 272   else if (strcmp (pitch_unit, "f0") == 0)
 273     pitch_mode = aubio_pitchm_freq;
 274   else if (strcmp (pitch_unit, "midi") == 0)
 275     pitch_mode = aubio_pitchm_midi;
 276   else if (strcmp (pitch_unit, "cent") == 0)
 277     pitch_mode = aubio_pitchm_cent;
 278   else if (strcmp (pitch_unit, "bin") == 0)
 279     pitch_mode = aubio_pitchm_bin;
 280   else if (strcmp (pitch_unit, "default") == 0)
 281     pitch_mode = aubio_pitchm_default;
 282   else {
 283     AUBIO_ERR ("unknown pitch detection unit %s, using default\n", pitch_unit);
 284     pitch_mode = aubio_pitchm_default;
 285     err = AUBIO_FAIL;
 286   }
 287   p->mode = pitch_mode;
 288   switch (p->mode) {
 289     case aubio_pitchm_freq:
 290       p->conv_cb = freqconvpass;
 291       break;
 292     case aubio_pitchm_midi:
 293       p->conv_cb = freqconvmidi;
 294       break;
 295     case aubio_pitchm_cent:
 296       /* bug: not implemented */
 297       p->conv_cb = freqconvmidi;
 298       break;
 299     case aubio_pitchm_bin:
 300       p->conv_cb = freqconvbin;
 301       break;
 302     default:
 303       break;
 304   }
 305   return err;
 306 }
 307
 308 uint_t
 309 aubio_pitch_set_tolerance (aubio_pitch_t * p, smpl_t tol)
 310 {
 311   switch (p->type) {
 312     case aubio_pitcht_yin:
 313       aubio_pitchyin_set_tolerance (p->p_object, tol);
 314       break;
 315     case aubio_pitcht_yinfft:
 316       aubio_pitchyinfft_set_tolerance (p->p_object, tol);
 317       break;
 318     default:
 319       break;
 320   }
 321   return AUBIO_OK;
 322 }
 323
 324 uint_t
 325 aubio_pitch_set_silence (aubio_pitch_t * p, smpl_t silence)
 326 {
 327   if (silence <= 0 && silence >= -200) {
 328     p->silence = silence;
 329     return AUBIO_OK;
 330   } else {
 331     AUBIO_ERR("pitch: could not set silence to %.2f", silence);
 332     return AUBIO_FAIL;
 333   }
 334 }
 335
 336 smpl_t
 337 aubio_pitch_get_silence (aubio_pitch_t * p)
 338 {
 339   return p->silence;
 340 }
 341
 342
 343 /* do method, calling the detection callback, then the conversion callback */
 344 void
 345 aubio_pitch_do (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf)
 346 {
 347   p->detect_cb (p, ibuf, obuf);
 348   if (aubio_silence_detection(ibuf, p->silence) == 1) {
 349     obuf->data[0] = 0.;
 350   }
 351   obuf->data[0] = p->conv_cb (obuf->data[0], p->samplerate, p->bufsize);
 352 }
 353
 354 /* do method for each algorithm */
 355 void
 356 aubio_pitch_do_mcomb (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf)
 357 {
 358   aubio_filter_do (p->filter, ibuf);
 359   aubio_pvoc_do (p->pv, ibuf, p->fftgrain);
 360   aubio_pitchmcomb_do (p->p_object, p->fftgrain, obuf);
 361   obuf->data[0] = aubio_bintofreq (obuf->data[0], p->samplerate, p->bufsize);
 362 }
 363
 364 void
 365 aubio_pitch_do_yin (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf)
 366 {
 367   smpl_t pitch = 0.;
 368   aubio_pitch_slideblock (p, ibuf);
 369   aubio_pitchyin_do (p->p_object, p->buf, obuf);
 370   pitch = obuf->data[0];
 371   if (pitch > 0) {
 372     pitch = p->samplerate / (pitch + 0.);
 373   } else {
 374     pitch = 0.;
 375   }
 376   obuf->data[0] = pitch;
 377 }
 378
 379
 380 void
 381 aubio_pitch_do_yinfft (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * obuf)
 382 {
 383   smpl_t pitch = 0.;
 384   aubio_pitch_slideblock (p, ibuf);
 385   aubio_pitchyinfft_do (p->p_object, p->buf, obuf);
 386   pitch = obuf->data[0];
 387   if (pitch > 0) {
 388     pitch = p->samplerate / (pitch + 0.);
 389   } else {
 390     pitch = 0.;
 391   }
 392   obuf->data[0] = pitch;
 393 }
 394
 395 void
 396 aubio_pitch_do_specacf (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * out)
 397 {
 398   smpl_t pitch = 0., period;
 399   aubio_pitch_slideblock (p, ibuf);
 400   aubio_pitchspecacf_do (p->p_object, p->buf, out);
 401   //out->data[0] = aubio_bintofreq (out->data[0], p->samplerate, p->bufsize);
 402   period = out->data[0];
 403   if (period > 0) {
 404     pitch = p->samplerate / period;
 405   } else {
 406     pitch = 0.;
 407   }
 408   out->data[0] = pitch;
 409 }
 410
 411 void
 412 aubio_pitch_do_fcomb (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * out)
 413 {
 414   aubio_pitch_slideblock (p, ibuf);
 415   aubio_pitchfcomb_do (p->p_object, p->buf, out);
 416   out->data[0] = aubio_bintofreq (out->data[0], p->samplerate, p->bufsize);
 417 }
 418
 419 void
 420 aubio_pitch_do_schmitt (aubio_pitch_t * p, fvec_t * ibuf, fvec_t * out)
 421 {
 422   smpl_t period, pitch = 0.;
 423   aubio_pitch_slideblock (p, ibuf);
 424   aubio_pitchschmitt_do (p->p_object, p->buf, out);
 425   period = out->data[0];
 426   if (period > 0) {
 427     pitch = p->samplerate / period;
 428   } else {
 429     pitch = 0.;
 430   }
 431   out->data[0] = pitch;
 432 }
 433
 434 /* conversion callbacks */
 435 smpl_t
 436 freqconvbin(smpl_t f, uint_t samplerate, uint_t bufsize)
 437 {
 438   return aubio_freqtobin(f, samplerate, bufsize);
 439 }
 440
 441 smpl_t
 442 freqconvmidi (smpl_t f, uint_t samplerate UNUSED, uint_t bufsize UNUSED)
 443 {
 444   return aubio_freqtomidi (f);
 445 }
 446
 447 smpl_t
 448 freqconvpass (smpl_t f, uint_t samplerate UNUSED, uint_t bufsize UNUSED)
 449 {
 450   return f;
 451 }
 452
 453 /* confidence callbacks */
 454 smpl_t
 455 aubio_pitch_get_confidence (aubio_pitch_t * p)
 456 {
 457   if (p->conf_cb) {
 458     return p->conf_cb(p->p_object);
 459   }
 460   return 0.;
 461 }