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, const 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   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 */
  92 static void aubio_pitch_do_mcomb (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
  93 static void aubio_pitch_do_yin (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
  94 static void aubio_pitch_do_schmitt (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
  95 static void aubio_pitch_do_fcomb (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
  96 static void aubio_pitch_do_yinfft (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
  97 static void aubio_pitch_do_specacf (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf);
  98
  99 /* conversion functions for frequency conversions */
 100 smpl_t freqconvbin (smpl_t f, uint_t samplerate, uint_t bufsize);
 101 smpl_t freqconvmidi (smpl_t f, uint_t samplerate, uint_t bufsize);
 102 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` */
 105 void aubio_pitch_slideblock (aubio_pitch_t * p, const fvec_t * ibuf);
 106
 107
 108 aubio_pitch_t *
 109 new_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 ("unknown pitch detection method %s, using default.\n",
 130         pitch_mode);
 131     pitch_type = aubio_pitcht_default;
 132   }
 133
 134   // check parameters are valid
 135   if ((sint_t)hopsize < 1) {
 136     AUBIO_ERR("pitch: got hopsize %d, but can not be < 1\n", hopsize);
 137     goto beach;
 138   } else if ((sint_t)bufsize < 1) {
 139     AUBIO_ERR("pitch: got buffer_size %d, but can not be < 1\n", bufsize);
 140     goto beach;
 141   } else if (bufsize < hopsize) {
 142     AUBIO_ERR("pitch: hop size (%d) is larger than win size (%d)\n", bufsize, hopsize);
 143     goto beach;
 144   } else if ((sint_t)samplerate < 1) {
 145     AUBIO_ERR("pitch: samplerate (%d) can not be < 1\n", samplerate);
 146     goto beach;
 147   }
 148
 149   p->samplerate = samplerate;
 150   p->type = pitch_type;
 151   aubio_pitch_set_unit (p, "default");
 152   p->bufsize = bufsize;
 153   p->silence = DEFAULT_PITCH_SILENCE;
 154   p->conf_cb = NULL;
 155   switch (p->type) {
 156     case aubio_pitcht_yin:
 157       p->buf = new_fvec (bufsize);
 158       p->p_object = new_aubio_pitchyin (bufsize);
 159       p->detect_cb = aubio_pitch_do_yin;
 160       p->conf_cb = (aubio_pitch_get_conf_t)aubio_pitchyin_get_confidence;
 161       aubio_pitchyin_set_tolerance (p->p_object, 0.15);
 162       break;
 163     case aubio_pitcht_mcomb:
 164       p->filtered = new_fvec (hopsize);
 165       p->pv = new_aubio_pvoc (bufsize, hopsize);
 166       p->fftgrain = new_cvec (bufsize);
 167       p->p_object = new_aubio_pitchmcomb (bufsize, hopsize);
 168       p->filter = new_aubio_filter_c_weighting (samplerate);
 169       p->detect_cb = aubio_pitch_do_mcomb;
 170       break;
 171     case aubio_pitcht_fcomb:
 172       p->buf = new_fvec (bufsize);
 173       p->p_object = new_aubio_pitchfcomb (bufsize, hopsize);
 174       p->detect_cb = aubio_pitch_do_fcomb;
 175       break;
 176     case aubio_pitcht_schmitt:
 177       p->buf = new_fvec (bufsize);
 178       p->p_object = new_aubio_pitchschmitt (bufsize);
 179       p->detect_cb = aubio_pitch_do_schmitt;
 180       break;
 181     case aubio_pitcht_yinfft:
 182       p->buf = new_fvec (bufsize);
 183       p->p_object = new_aubio_pitchyinfft (samplerate, bufsize);
 184       p->detect_cb = aubio_pitch_do_yinfft;
 185       p->conf_cb = (aubio_pitch_get_conf_t)aubio_pitchyinfft_get_confidence;
 186       aubio_pitchyinfft_set_tolerance (p->p_object, 0.85);
 187       break;
 188     case aubio_pitcht_specacf:
 189       p->buf = new_fvec (bufsize);
 190       p->p_object = new_aubio_pitchspecacf (bufsize);
 191       p->detect_cb = aubio_pitch_do_specacf;
 192       p->conf_cb = (aubio_pitch_get_conf_t)aubio_pitchspecacf_get_tolerance;
 193       aubio_pitchspecacf_set_tolerance (p->p_object, 0.85);
 194       break;
 195     default:
 196       break;
 197   }
 198   return p;
 199
 200 beach:
 201   AUBIO_FREE(p);
 202   return NULL;
 203 }
 204
 205 void
 206 del_aubio_pitch (aubio_pitch_t * p)
 207 {
 208   switch (p->type) {
 209     case aubio_pitcht_yin:
 210       del_fvec (p->buf);
 211       del_aubio_pitchyin (p->p_object);
 212       break;
 213     case aubio_pitcht_mcomb:
 214       del_fvec (p->filtered);
 215       del_aubio_pvoc (p->pv);
 216       del_cvec (p->fftgrain);
 217       del_aubio_filter (p->filter);
 218       del_aubio_pitchmcomb (p->p_object);
 219       break;
 220     case aubio_pitcht_schmitt:
 221       del_fvec (p->buf);
 222       del_aubio_pitchschmitt (p->p_object);
 223       break;
 224     case aubio_pitcht_fcomb:
 225       del_fvec (p->buf);
 226       del_aubio_pitchfcomb (p->p_object);
 227       break;
 228     case aubio_pitcht_yinfft:
 229       del_fvec (p->buf);
 230       del_aubio_pitchyinfft (p->p_object);
 231       break;
 232     case aubio_pitcht_specacf:
 233       del_fvec (p->buf);
 234       del_aubio_pitchspecacf (p->p_object);
 235       break;
 236     default:
 237       break;
 238   }
 239   AUBIO_FREE (p);
 240 }
 241
 242 void
 243 aubio_pitch_slideblock (aubio_pitch_t * p, const fvec_t * ibuf)
 244 {
 245   uint_t overlap_size = p->buf->length - ibuf->length;
 246 #if 1 //!HAVE_MEMCPY_HACKS
 247   uint_t j;
 248   for (j = 0; j < overlap_size; j++) {
 249     p->buf->data[j] = p->buf->data[j + ibuf->length];
 250   }
 251   for (j = 0; j < ibuf->length; j++) {
 252     p->buf->data[j + overlap_size] = ibuf->data[j];
 253   }
 254 #else
 255   smpl_t *data = p->buf->data;
 256   smpl_t *newdata = ibuf->data;
 257   memmove(data, data + ibuf->length, overlap_size);
 258   memcpy(data + overlap_size, newdata, ibuf->length);
 259 #endif
 260 }
 261
 262 uint_t
 263 aubio_pitch_set_unit (aubio_pitch_t * p, const char_t * pitch_unit)
 264 {
 265   uint_t err = AUBIO_OK;
 266   aubio_pitch_mode pitch_mode;
 267   if (strcmp (pitch_unit, "freq") == 0)
 268     pitch_mode = aubio_pitchm_freq;
 269   else if (strcmp (pitch_unit, "hertz") == 0)
 270     pitch_mode = aubio_pitchm_freq;
 271   else if (strcmp (pitch_unit, "Hertz") == 0)
 272     pitch_mode = aubio_pitchm_freq;
 273   else if (strcmp (pitch_unit, "Hz") == 0)
 274     pitch_mode = aubio_pitchm_freq;
 275   else if (strcmp (pitch_unit, "f0") == 0)
 276     pitch_mode = aubio_pitchm_freq;
 277   else if (strcmp (pitch_unit, "midi") == 0)
 278     pitch_mode = aubio_pitchm_midi;
 279   else if (strcmp (pitch_unit, "cent") == 0)
 280     pitch_mode = aubio_pitchm_cent;
 281   else if (strcmp (pitch_unit, "bin") == 0)
 282     pitch_mode = aubio_pitchm_bin;
 283   else if (strcmp (pitch_unit, "default") == 0)
 284     pitch_mode = aubio_pitchm_default;
 285   else {
 286     AUBIO_ERR ("unknown pitch detection unit %s, using default\n", 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
 311 uint_t
 312 aubio_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
 327 uint_t
 328 aubio_pitch_set_silence (aubio_pitch_t * p, smpl_t silence)
 329 {
 330   if (silence <= 0 && silence >= -200) {
 331     p->silence = silence;
 332     return AUBIO_OK;
 333   } else {
 334     AUBIO_ERR("pitch: could not set silence to %.2f", silence);
 335     return AUBIO_FAIL;
 336   }
 337 }
 338
 339 smpl_t
 340 aubio_pitch_get_silence (aubio_pitch_t * p)
 341 {
 342   return p->silence;
 343 }
 344
 345
 346 /* do method, calling the detection callback, then the conversion callback */
 347 void
 348 aubio_pitch_do (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf)
 349 {
 350   p->detect_cb (p, ibuf, obuf);
 351   if (aubio_silence_detection(ibuf, p->silence) == 1) {
 352     obuf->data[0] = 0.;
 353   }
 354   obuf->data[0] = p->conv_cb (obuf->data[0], p->samplerate, p->bufsize);
 355 }
 356
 357 /* do method for each algorithm */
 358 void
 359 aubio_pitch_do_mcomb (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf)
 360 {
 361   aubio_filter_do_outplace (p->filter, ibuf, p->filtered);
 362   aubio_pvoc_do (p->pv, ibuf, p->fftgrain);
 363   aubio_pitchmcomb_do (p->p_object, p->fftgrain, obuf);
 364   obuf->data[0] = aubio_bintofreq (obuf->data[0], p->samplerate, p->bufsize);
 365 }
 366
 367 void
 368 aubio_pitch_do_yin (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf)
 369 {
 370   smpl_t pitch = 0.;
 371   aubio_pitch_slideblock (p, ibuf);
 372   aubio_pitchyin_do (p->p_object, p->buf, obuf);
 373   pitch = obuf->data[0];
 374   if (pitch > 0) {
 375     pitch = p->samplerate / (pitch + 0.);
 376   } else {
 377     pitch = 0.;
 378   }
 379   obuf->data[0] = pitch;
 380 }
 381
 382
 383 void
 384 aubio_pitch_do_yinfft (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * obuf)
 385 {
 386   smpl_t pitch = 0.;
 387   aubio_pitch_slideblock (p, ibuf);
 388   aubio_pitchyinfft_do (p->p_object, p->buf, obuf);
 389   pitch = obuf->data[0];
 390   if (pitch > 0) {
 391     pitch = p->samplerate / (pitch + 0.);
 392   } else {
 393     pitch = 0.;
 394   }
 395   obuf->data[0] = pitch;
 396 }
 397
 398 void
 399 aubio_pitch_do_specacf (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * out)
 400 {
 401   smpl_t pitch = 0., period;
 402   aubio_pitch_slideblock (p, ibuf);
 403   aubio_pitchspecacf_do (p->p_object, p->buf, out);
 404   //out->data[0] = aubio_bintofreq (out->data[0], p->samplerate, p->bufsize);
 405   period = out->data[0];
 406   if (period > 0) {
 407     pitch = p->samplerate / period;
 408   } else {
 409     pitch = 0.;
 410   }
 411   out->data[0] = pitch;
 412 }
 413
 414 void
 415 aubio_pitch_do_fcomb (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * out)
 416 {
 417   aubio_pitch_slideblock (p, ibuf);
 418   aubio_pitchfcomb_do (p->p_object, p->buf, out);
 419   out->data[0] = aubio_bintofreq (out->data[0], p->samplerate, p->bufsize);
 420 }
 421
 422 void
 423 aubio_pitch_do_schmitt (aubio_pitch_t * p, const fvec_t * ibuf, fvec_t * out)
 424 {
 425   smpl_t period, pitch = 0.;
 426   aubio_pitch_slideblock (p, ibuf);
 427   aubio_pitchschmitt_do (p->p_object, p->buf, out);
 428   period = out->data[0];
 429   if (period > 0) {
 430     pitch = p->samplerate / period;
 431   } else {
 432     pitch = 0.;
 433   }
 434   out->data[0] = pitch;
 435 }
 436
 437 /* conversion callbacks */
 438 smpl_t
 439 freqconvbin(smpl_t f, uint_t samplerate, uint_t bufsize)
 440 {
 441   return aubio_freqtobin(f, samplerate, bufsize);
 442 }
 443
 444 smpl_t
 445 freqconvmidi (smpl_t f, uint_t samplerate UNUSED, uint_t bufsize UNUSED)
 446 {
 447   return aubio_freqtomidi (f);
 448 }
 449
 450 smpl_t
 451 freqconvpass (smpl_t f, uint_t samplerate UNUSED, uint_t bufsize UNUSED)
 452 {
 453   return f;
 454 }
 455
 456 /* confidence callbacks */
 457 smpl_t
 458 aubio_pitch_get_confidence (aubio_pitch_t * p)
 459 {
 460   if (p->conf_cb) {
 461     return p->conf_cb(p->p_object);
 462   }
 463   return 0.;
 464 }