src/pitch/pitchyin.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 /* This algorithm was developped by A. de Cheveigne and H. Kawahara and
  22  * published in:
  23  *
  24  * de Cheveigné, A., Kawahara, H. (2002) "YIN, a fundamental frequency
  25  * estimator for speech and music", J. Acoust. Soc. Am. 111, 1917-1930.
  26  *
  27  * see http://recherche.ircam.fr/equipes/pcm/pub/people/cheveign.html
  28  */
  29
  30 #include "aubio_priv.h"
  31 #include "fvec.h"
  32 #include "mathutils.h"
  33 #include "pitch/pitchyin.h"
  34
  35 struct _aubio_pitchyin_t
  36 {
  37   fvec_t *yin;
  38   smpl_t tol;
  39 };
  40
  41 /** compute difference function
  42
  43   \param input input signal
  44   \param yinbuf output buffer to store difference function (half shorter than input)
  45
  46 */
  47 void aubio_pitchyin_diff (fvec_t * input, fvec_t * yinbuf);
  48
  49 /** in place computation of the YIN cumulative normalised function
  50
  51   \param yinbuf input signal (a square difference function), also used to store function
  52
  53 */
  54 void aubio_pitchyin_getcum (fvec_t * yinbuf);
  55
  56 /** detect pitch in a YIN function
  57
  58   \param yinbuf input buffer as computed by aubio_pitchyin_getcum
  59
  60 */
  61 uint_t aubio_pitchyin_getpitch (fvec_t * yinbuf);
  62
  63 aubio_pitchyin_t *
  64 new_aubio_pitchyin (uint_t bufsize)
  65 {
  66   aubio_pitchyin_t *o = AUBIO_NEW (aubio_pitchyin_t);
  67   o->yin = new_fvec (bufsize / 2);
  68   o->tol = 0.15;
  69   return o;
  70 }
  71
  72 void
  73 del_aubio_pitchyin (aubio_pitchyin_t * o)
  74 {
  75   del_fvec (o->yin);
  76   AUBIO_FREE (o);
  77 }
  78
  79 /* outputs the difference function */
  80 void
  81 aubio_pitchyin_diff (fvec_t * input, fvec_t * yin)
  82 {
  83   uint_t j, tau;
  84   smpl_t tmp;
  85   for (tau = 0; tau < yin->length; tau++) {
  86     yin->data[tau] = 0.;
  87   }
  88   for (tau = 1; tau < yin->length; tau++) {
  89     for (j = 0; j < yin->length; j++) {
  90       tmp = input->data[j] - input->data[j + tau];
  91       yin->data[tau] += SQR (tmp);
  92     }
  93   }
  94 }
  95
  96 /* cumulative mean normalized difference function */
  97 void
  98 aubio_pitchyin_getcum (fvec_t * yin)
  99 {
 100   uint_t tau;
 101   smpl_t tmp;
 102   tmp = 0.;
 103   yin->data[0] = 1.;
 104   //AUBIO_DBG("%f\t",yin->data[0]);
 105   for (tau = 1; tau < yin->length; tau++) {
 106     tmp += yin->data[tau];
 107     yin->data[tau] *= tau / tmp;
 108     //AUBIO_DBG("%f\t",yin->data[tau]);
 109   }
 110   //AUBIO_DBG("\n");
 111 }
 112
 113 uint_t
 114 aubio_pitchyin_getpitch (fvec_t * yin)
 115 {
 116   uint_t tau = 1;
 117   do {
 118     if (yin->data[tau] < 0.1) {
 119       while (yin->data[tau + 1] < yin->data[tau]) {
 120         tau++;
 121       }
 122       return tau;
 123     }
 124     tau++;
 125   } while (tau < yin->length);
 126   //AUBIO_DBG("No pitch found");
 127   return 0;
 128 }
 129
 130
 131 /* all the above in one */
 132 void
 133 aubio_pitchyin_do (aubio_pitchyin_t * o, fvec_t * input, fvec_t * out)
 134 {
 135   smpl_t tol = o->tol;
 136   fvec_t *yin = o->yin;
 137   uint_t j, tau = 0;
 138   sint_t period;
 139   smpl_t tmp = 0., tmp2 = 0.;
 140   yin->data[0] = 1.;
 141   for (tau = 1; tau < yin->length; tau++) {
 142     yin->data[tau] = 0.;
 143     for (j = 0; j < yin->length; j++) {
 144       tmp = input->data[j] - input->data[j + tau];
 145       yin->data[tau] += SQR (tmp);
 146     }
 147     tmp2 += yin->data[tau];
 148     yin->data[tau] *= tau / tmp2;
 149     period = tau - 3;
 150     if (tau > 4 && (yin->data[period] < tol) &&
 151         (yin->data[period] < yin->data[period + 1])) {
 152       out->data[0] = fvec_quadint (yin, period);
 153       goto beach;
 154     }
 155   }
 156   out->data[0] = fvec_quadint (yin, fvec_min_elem (yin));
 157 beach:
 158   return;
 159 }
 160
 161 uint_t
 162 aubio_pitchyin_set_tolerance (aubio_pitchyin_t * o, smpl_t tol)
 163 {
 164   o->tol = tol;
 165   return 0;
 166 }
 167
 168 smpl_t
 169 aubio_pitchyin_get_tolerance (aubio_pitchyin_t * o)
 170 {
 171   return o->tol;
 172 }