3608b292d97d7b7154d85e11e8baa142fd887a9b
[aubio.git] / 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   smpl_t confidence;  /**< confidence */
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
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   p->fftout = new_fvec (bufsize);
66   p->sqrmag = new_fvec (bufsize);
67   p->yinfft = new_fvec (bufsize / 2 + 1);
68   p->tol = 0.85;
69   p->win = new_aubio_window ("hanningz", bufsize);
70   p->weight = new_fvec (bufsize / 2 + 1);
71   for (i = 0; i < p->weight->length; i++) {
72     freq = (smpl_t) i / (smpl_t) bufsize *(smpl_t) samplerate;
73     while (freq > freqs[j]) {
74       j += 1;
75     }
76     a0 = weight[j - 1];
77     f0 = freqs[j - 1];
78     a1 = weight[j];
79     f1 = freqs[j];
80     if (f0 == f1) {           // just in case
81       p->weight->data[i] = a0;
82     } else if (f0 == 0) {     // y = ax+b
83       p->weight->data[i] = (a1 - a0) / f1 * freq + a0;
84     } else {
85       p->weight->data[i] = (a1 - a0) / (f1 - f0) * freq +
86           (a0 - (a1 - a0) / (f1 / f0 - 1.));
87     }
88     while (freq > freqs[j]) {
89       j += 1;
90     }
91     //AUBIO_DBG("%f\n",p->weight->data[i]);
92     p->weight->data[i] = DB2LIN (p->weight->data[i]);
93     //p->weight->data[i] = SQRT(DB2LIN(p->weight->data[i]));
94   }
95   // check for octave errors above 1300 Hz
96   p->short_period = (uint_t)ROUND(samplerate / 1300.);
97   return p;
98 }
99
100 void
101 aubio_pitchyinfft_do (aubio_pitchyinfft_t * p, fvec_t * input, fvec_t * output)
102 {
103   uint_t tau, l;
104   uint_t length = p->fftout->length;
105   uint_t halfperiod;
106   fvec_t *fftout = p->fftout;
107   fvec_t *yin = p->yinfft;
108   smpl_t tmp = 0., sum = 0.;
109   // window the input
110   for (l = 0; l < input->length; l++) {
111     p->winput->data[l] = p->win->data[l] * input->data[l];
112   }
113   // get the real / imag parts of its fft
114   aubio_fft_do_complex (p->fft, p->winput, fftout);
115   // get the squared magnitude spectrum, applying some weight
116   p->sqrmag->data[0] = SQR(fftout->data[0]);
117   p->sqrmag->data[0] *= p->weight->data[0];
118   for (l = 1; l < length / 2; l++) {
119     p->sqrmag->data[l] = SQR(fftout->data[l]) + SQR(fftout->data[length - l]);
120     p->sqrmag->data[l] *= p->weight->data[l];
121     p->sqrmag->data[length - l] = p->sqrmag->data[l];
122   }
123   p->sqrmag->data[length / 2] = SQR(fftout->data[length / 2]);
124   p->sqrmag->data[length / 2] *= p->weight->data[length / 2];
125   // get sum of weighted squared mags
126   for (l = 0; l < length / 2 + 1; l++) {
127     sum += p->sqrmag->data[l];
128   }
129   sum *= 2.;
130   // get the real / imag parts of the fft of the squared magnitude
131   aubio_fft_do_complex (p->fft, p->sqrmag, fftout);
132   yin->data[0] = 1.;
133   for (tau = 1; tau < yin->length; tau++) {
134     // compute the square differences
135     yin->data[tau] = sum - fftout->data[tau];
136     // and the cumulative mean normalized difference function
137     tmp += yin->data[tau];
138     yin->data[tau] *= tau / tmp;
139   }
140   // find best candidates
141   tau = fvec_min_elem (yin);
142   if (yin->data[tau] < p->tol) {
143     // no interpolation, directly return the period as an integer
144     //output->data[0] = tau;
145     //return;
146
147     // 3 point quadratic interpolation
148     //return fvec_quadratic_peak_pos (yin,tau,1);
149     /* additional check for (unlikely) octave doubling in higher frequencies */
150     if (tau > p->short_period) {
151       output->data[0] = fvec_quadratic_peak_pos (yin, tau);
152     } else {
153       /* should compare the minimum value of each interpolated peaks */
154       halfperiod = FLOOR (tau / 2 + .5);
155       if (yin->data[halfperiod] < p->tol)
156         output->data[0] = fvec_quadratic_peak_pos (yin, halfperiod);
157       else
158         output->data[0] = fvec_quadratic_peak_pos (yin, tau);
159     }
160   } else {
161     output->data[0] = 0.;
162   }
163 }
164
165 void
166 del_aubio_pitchyinfft (aubio_pitchyinfft_t * p)
167 {
168   del_fvec (p->win);
169   del_aubio_fft (p->fft);
170   del_fvec (p->yinfft);
171   del_fvec (p->sqrmag);
172   del_fvec (p->fftout);
173   del_fvec (p->winput);
174   del_fvec (p->weight);
175   AUBIO_FREE (p);
176 }
177
178 smpl_t
179 aubio_pitchyinfft_get_confidence (aubio_pitchyinfft_t * o) {
180   o->confidence = 1. - fvec_min (o->yinfft);
181   return o->confidence;
182 }
183
184 uint_t
185 aubio_pitchyinfft_set_tolerance (aubio_pitchyinfft_t * p, smpl_t tol)
186 {
187   p->tol = tol;
188   return 0;
189 }
190
191 smpl_t
192 aubio_pitchyinfft_get_tolerance (aubio_pitchyinfft_t * p)
193 {
194   return p->tol;
195 }