src/pitch/pitchyinfft.c

   1 /*
   2   Copyright (C) 2003-2013 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 "mathutils.h"
  25 #include "spectral/fft.h"
  26 #include "pitch/pitchyinfft.h"
  27
  28 /** pitch yinfft structure */
  29 struct _aubio_pitchyinfft_t
  30 {
  31   fvec_t *win;        /**< temporal weighting window */
  32   fvec_t *winput;     /**< windowed spectrum */
  33   fvec_t *sqrmag;     /**< square difference function */
  34   fvec_t *weight;     /**< spectral weighting window (psychoacoustic model) */
  35   fvec_t *fftout;     /**< Fourier transform output */
  36   aubio_fft_t *fft;   /**< fft object to compute square difference function */
  37   fvec_t *yinfft;     /**< Yin function */
  38   smpl_t tol;         /**< Yin tolerance */
  39   uint_t peak_pos;    /**< currently selected peak pos*/
  40   uint_t short_period; /** shortest period under which to check for octave error */
  41 };
  42
  43 static const smpl_t freqs[] = {
  44      0.,    20.,    25.,   31.5,    40.,    50.,    63.,    80.,   100.,   125.,
  45    160.,   200.,   250.,   315.,   400.,   500.,   630.,   800.,  1000.,  1250.,
  46   1600.,  2000.,  2500.,  3150.,  4000.,  5000.,  6300.,  8000.,  9000., 10000.,
  47  12500., 15000., 20000., 25100., -1.
  48 };
  49
  50 static const smpl_t weight[] = {
  51   -75.8,  -70.1,  -60.8,  -52.1,  -44.2,  -37.5,  -31.3,  -25.6,  -20.9,  -16.5,
  52   -12.6,  -9.60,  -7.00,  -4.70,  -3.00,  -1.80,  -0.80,  -0.20,  -0.00,   0.50,
  53    1.60,   3.20,   5.40,   7.80,   8.10,   5.30,  -2.40,  -11.1,  -12.8,  -12.2,
  54   -7.40,  -17.8,  -17.8,  -17.8
  55 };
  56
  57 aubio_pitchyinfft_t *
  58 new_aubio_pitchyinfft (uint_t samplerate, uint_t bufsize)
  59 {
  60   uint_t i = 0, j = 1;
  61   smpl_t freq = 0, a0 = 0, a1 = 0, f0 = 0, f1 = 0;
  62   aubio_pitchyinfft_t *p = AUBIO_NEW (aubio_pitchyinfft_t);
  63   p->winput = new_fvec (bufsize);
  64   p->fft = new_aubio_fft (bufsize);
  65   if (!p->fft) goto beach;
  66   p->fftout = new_fvec (bufsize);
  67   p->sqrmag = new_fvec (bufsize);
  68   p->yinfft = new_fvec (bufsize / 2 + 1);
  69   p->tol = 0.85;
  70   p->peak_pos = 0;
  71   p->win = new_aubio_window ("hanningz", bufsize);
  72   p->weight = new_fvec (bufsize / 2 + 1);
  73   for (i = 0; i < p->weight->length; i++) {
  74     freq = (smpl_t) i / (smpl_t) bufsize *(smpl_t) samplerate;
  75     while (freq > freqs[j] && freqs[j] > 0) {
  76       //AUBIO_DBG("freq %3.5f > %3.5f \tsamplerate %d (Hz) \t"
  77       //    "(weight length %d, bufsize %d) %d %d\n", freq, freqs[j],
  78       //    samplerate, p->weight->length, bufsize, i, j);
  79       j += 1;
  80     }
  81     a0 = weight[j - 1];
  82     f0 = freqs[j - 1];
  83     a1 = weight[j];
  84     f1 = freqs[j];
  85     if (f0 == f1) {           // just in case
  86       p->weight->data[i] = a0;
  87     } else if (f0 == 0) {     // y = ax+b
  88       p->weight->data[i] = (a1 - a0) / f1 * freq + a0;
  89     } else {
  90       p->weight->data[i] = (a1 - a0) / (f1 - f0) * freq +
  91           (a0 - (a1 - a0) / (f1 / f0 - 1.));
  92     }
  93     while (freq > freqs[j]) {
  94       j += 1;
  95     }
  96     //AUBIO_DBG("%f\n",p->weight->data[i]);
  97     p->weight->data[i] = DB2LIN (p->weight->data[i]);
  98     //p->weight->data[i] = SQRT(DB2LIN(p->weight->data[i]));
  99   }
 100   // check for octave errors above 1300 Hz
 101   p->short_period = (uint_t)ROUND(samplerate / 1300.);
 102   return p;
 103
 104 beach:
 105   if (p->winput) del_fvec(p->winput);
 106   AUBIO_FREE(p);
 107   return NULL;
 108 }
 109
 110 void
 111 aubio_pitchyinfft_do (aubio_pitchyinfft_t * p, const fvec_t * input, fvec_t * output)
 112 {
 113   uint_t tau, l;
 114   uint_t length = p->fftout->length;
 115   uint_t halfperiod;
 116   fvec_t *fftout = p->fftout;
 117   fvec_t *yin = p->yinfft;
 118   smpl_t tmp = 0., sum = 0.;
 119   // window the input
 120   fvec_weighted_copy(input, p->win, p->winput);
 121   // get the real / imag parts of its fft
 122   aubio_fft_do_complex (p->fft, p->winput, fftout);
 123   // get the squared magnitude spectrum, applying some weight
 124   p->sqrmag->data[0] = SQR(fftout->data[0]);
 125   p->sqrmag->data[0] *= p->weight->data[0];
 126   for (l = 1; l < length / 2; l++) {
 127     p->sqrmag->data[l] = SQR(fftout->data[l]) + SQR(fftout->data[length - l]);
 128     p->sqrmag->data[l] *= p->weight->data[l];
 129     p->sqrmag->data[length - l] = p->sqrmag->data[l];
 130   }
 131   p->sqrmag->data[length / 2] = SQR(fftout->data[length / 2]);
 132   p->sqrmag->data[length / 2] *= p->weight->data[length / 2];
 133   // get sum of weighted squared mags
 134   for (l = 0; l < length / 2 + 1; l++) {
 135     sum += p->sqrmag->data[l];
 136   }
 137   sum *= 2.;
 138   // get the real / imag parts of the fft of the squared magnitude
 139   aubio_fft_do_complex (p->fft, p->sqrmag, fftout);
 140   yin->data[0] = 1.;
 141   for (tau = 1; tau < yin->length; tau++) {
 142     // compute the square differences
 143     yin->data[tau] = sum - fftout->data[tau];
 144     // and the cumulative mean normalized difference function
 145     tmp += yin->data[tau];
 146     if (tmp != 0) {
 147       yin->data[tau] *= tau / tmp;
 148     } else {
 149       yin->data[tau] = 1.;
 150     }
 151   }
 152   // find best candidates
 153   tau = fvec_min_elem (yin);
 154   if (yin->data[tau] < p->tol) {
 155     // no interpolation, directly return the period as an integer
 156     //output->data[0] = tau;
 157     //return;
 158
 159     // 3 point quadratic interpolation
 160     //return fvec_quadratic_peak_pos (yin,tau,1);
 161     /* additional check for (unlikely) octave doubling in higher frequencies */
 162     if (tau > p->short_period) {
 163       output->data[0] = fvec_quadratic_peak_pos (yin, tau);
 164     } else {
 165       /* should compare the minimum value of each interpolated peaks */
 166       halfperiod = FLOOR (tau / 2 + .5);
 167       if (yin->data[halfperiod] < p->tol)
 168         p->peak_pos = halfperiod;
 169       else
 170         p->peak_pos = tau;
 171       output->data[0] = fvec_quadratic_peak_pos (yin, p->peak_pos);
 172     }
 173   } else {
 174     p->peak_pos = 0;
 175     output->data[0] = 0.;
 176   }
 177 }
 178
 179 void
 180 del_aubio_pitchyinfft (aubio_pitchyinfft_t * p)
 181 {
 182   del_fvec (p->win);
 183   del_aubio_fft (p->fft);
 184   del_fvec (p->yinfft);
 185   del_fvec (p->sqrmag);
 186   del_fvec (p->fftout);
 187   del_fvec (p->winput);
 188   del_fvec (p->weight);
 189   AUBIO_FREE (p);
 190 }
 191
 192 smpl_t
 193 aubio_pitchyinfft_get_confidence (aubio_pitchyinfft_t * o) {
 194   return 1. - o->yinfft->data[o->peak_pos];
 195 }
 196
 197 uint_t
 198 aubio_pitchyinfft_set_tolerance (aubio_pitchyinfft_t * p, smpl_t tol)
 199 {
 200   p->tol = tol;
 201   return 0;
 202 }
 203
 204 smpl_t
 205 aubio_pitchyinfft_get_tolerance (aubio_pitchyinfft_t * p)
 206 {
 207   return p->tol;
 208 }