1f639d6a22340d0b34d43e74288ad4646c54668a
[pitch] / pitch.cpp
1 #include <stdio.h>
2 #include <stdlib.h>
3 #include <unistd.h>
4 #include <fcntl.h>
5 #include <complex>
6 #include <cassert>
7 #include <algorithm>
8 #include <fftw3.h>
9 #include <sys/ioctl.h>
10 #include <linux/soundcard.h>
11
12 #define SAMPLE_RATE     22050
13 #define FFT_LENGTH      4096     /* in samples */
14 #define PAD_FACTOR      2        /* 1/pf of the FFT samples are real samples, the rest are padding */
15 #define OVERLAP         4        /* 1/ol samples will be replaced in the buffer every frame. Should be
16                                   * a multiple of 2 for the Hamming window (see
17                                   * http://www-ccrma.stanford.edu/~jos/parshl/Choice_Hop_Size.html).
18                                   */
19
20 #define EQUAL_TEMPERAMENT     0
21 #define WELL_TEMPERED_GUITAR  1
22
23 #define TUNING WELL_TEMPERED_GUITAR
24
25 int get_dsp_fd();
26 void read_chunk(int fd, double *in, unsigned num_samples);
27 void apply_window(double *in, double *out, unsigned num_samples);
28 std::pair<double, double> find_peak(double *in, unsigned num_samples);
29 void find_peak_magnitudes(std::complex<double> *in, double *out, unsigned num_samples);
30 std::pair<double, double> adjust_for_overtones(std::pair<double, double> base, double *in, unsigned num_samples);
31 double bin_to_freq(double bin, unsigned num_samples);
32 double freq_to_bin(double freq, unsigned num_samples);
33 std::string freq_to_tonename(double freq);
34 std::pair<double, double> interpolate_peak(double ym1, double y0, double y1);
35 void print_spectrogram(double freq, double amp);
36 void write_sine(int dsp_fd, double freq, unsigned num_samples);
37
38 int main()
39 {
40         double *in, *in_windowed;
41         std::complex<double> *out;
42         double *bins;
43         fftw_plan p;
44
45         // allocate memory
46         in = reinterpret_cast<double *> (fftw_malloc(sizeof(double) * FFT_LENGTH / PAD_FACTOR));
47         in_windowed = reinterpret_cast<double *> (fftw_malloc(sizeof(double) * FFT_LENGTH));
48         out = reinterpret_cast<std::complex<double> *> (fftw_malloc(sizeof(std::complex<double>) * (FFT_LENGTH / 2 + 1)));
49         bins = reinterpret_cast<double *> (fftw_malloc(sizeof(double) * FFT_LENGTH / 2 + 1));
50
51         memset(in, 0, sizeof(double) * FFT_LENGTH / PAD_FACTOR);
52
53         // init FFTW
54         p = fftw_plan_dft_r2c_1d(FFT_LENGTH, in_windowed, reinterpret_cast<fftw_complex *> (out), FFTW_ESTIMATE);
55         
56         int fd = get_dsp_fd();
57         for ( ;; ) {
58                 read_chunk(fd, in, FFT_LENGTH);
59                 apply_window(in, in_windowed, FFT_LENGTH);
60                 fftw_execute(p);
61                 find_peak_magnitudes(out, bins, FFT_LENGTH);
62                 std::pair<double, double> peak = find_peak(bins, FFT_LENGTH);
63                 peak = adjust_for_overtones(peak, bins, FFT_LENGTH);
64
65                 if (peak.first < 50.0 || peak.second - log10(FFT_LENGTH) < 0.0) {
66 #if TUNING == WELL_TEMPERED_GUITAR
67                         printf("......\n");
68 #else           
69                         printf("............\n");
70 #endif
71                 } else {
72                         print_spectrogram(peak.first, peak.second - log10(FFT_LENGTH));
73                 }
74         }
75 }
76
77 int get_dsp_fd()
78 {
79         int fd = open("/dev/dsp", O_RDWR);
80         if (fd == -1) {
81                 perror("/dev/dsp");
82                 exit(1);
83         }
84         
85         ioctl(3, SNDCTL_DSP_RESET, 0);
86         
87         int fmt = AFMT_S16_LE;   // FIXME
88         ioctl(fd, SNDCTL_DSP_SETFMT, &fmt);
89
90         int chan = 1;
91         ioctl(fd, SOUND_PCM_WRITE_CHANNELS, &chan);
92         
93         int rate = SAMPLE_RATE;
94         ioctl(fd, SOUND_PCM_WRITE_RATE, &rate);
95
96         ioctl(3, SNDCTL_DSP_SYNC, 0);
97         
98         return fd;
99 }
100
101 #if 1
102 void read_chunk(int fd, double *in, unsigned num_samples)
103 {
104         int ret;
105         unsigned to_read = num_samples / PAD_FACTOR / OVERLAP;
106         short buf[to_read];
107
108         memmove(in, in + to_read, (num_samples / PAD_FACTOR - to_read) * sizeof(double));
109         
110         ret = read(fd, buf, to_read * sizeof(short));
111         if (ret == 0) {
112                 printf("EOF\n");
113                 exit(0);
114         }
115
116         if (ret != int(to_read * sizeof(short))) {
117                 // blah
118                 perror("read");
119                 exit(1);
120         }
121         
122         for (unsigned i = 0; i < to_read; ++i)
123                 in[i + (num_samples / PAD_FACTOR - to_read)] = double(buf[i]);
124 }
125 #else
126 // make a pure 440hz sine for testing
127 void read_chunk(int fd, double *in, unsigned num_samples)
128 {
129         static double theta = 0.0;
130         for (unsigned i = 0; i < num_samples; ++i) {
131                 in[i] = cos(theta);
132                 theta += 2.0 * M_PI * 440.0 / double(SAMPLE_RATE);
133         }
134 }
135 #endif
136
137 void write_sine(int dsp_fd, double freq, unsigned num_samples) 
138 {
139         static double theta = 0.0;
140         short buf[num_samples];
141         
142         for (unsigned i = 0; i < num_samples; ++i) {
143                 buf[i] = short(cos(theta) * 16384.0);
144                 theta += 2.0 * M_PI * freq / double(SAMPLE_RATE);
145         }
146
147         write(dsp_fd, buf, num_samples * sizeof(short));
148 }
149
150 // Apply a standard Hamming window to our input data.
151 void apply_window(double *in, double *out, unsigned num_samples)
152 {
153         static double *win_data;
154         static unsigned win_len;
155         static bool win_inited = false;
156
157         // Initialize the window for the first time
158         if (!win_inited) {
159                 win_len = num_samples / PAD_FACTOR;
160                 win_data = new double[win_len];
161
162                 for (unsigned i = 0; i < win_len; ++i) {
163                         win_data[i] = 0.54 - 0.46 * cos(2.0 * M_PI * double(i) / double(win_len - 1));
164                 }
165
166                 win_inited = true;
167         }
168
169         assert(win_len == num_samples / PAD_FACTOR);
170         
171         for (unsigned i = 0; i < win_len; ++i) {
172                 out[i] = in[i] * win_data[i];
173         }
174         for (unsigned i = win_len; i < num_samples; ++i) {
175                 out[i] = 0.0;
176         }
177 }
178
179 void find_peak_magnitudes(std::complex<double> *in, double *out, unsigned num_samples)
180 {
181         for (unsigned i = 0; i < num_samples / 2 + 1; ++i)
182                 out[i] = abs(in[i]);
183 }
184
185 std::pair<double, double> find_peak(double *in, unsigned num_samples)
186 {
187         double best_peak = in[0];
188         unsigned best_bin = 0;
189
190         for (unsigned i = 1; i < num_samples / 2 + 1; ++i) {
191                 if (in[i] > best_peak) {
192                         best_peak = in[i];
193                         best_bin = i;
194                 }
195         }
196         
197         if (best_bin == 0 || best_bin == num_samples / 2) {
198                 return std::make_pair(-1.0, 0.0);
199         }
200
201 #if 0
202         printf("undertone strength: %+4.2f %+4.2f %+4.2f [%+4.2f] %+4.2f %+4.2f %+4.2f\n",
203                 20.0 * log10(in[best_bin*4] / FFT_LENGTH),
204                 20.0 * log10(in[best_bin*3] / FFT_LENGTH),
205                 20.0 * log10(in[best_bin*2] / FFT_LENGTH),
206                 20.0 * log10(in[best_bin] / FFT_LENGTH),
207                 20.0 * log10(in[best_bin/2] / FFT_LENGTH),
208                 20.0 * log10(in[best_bin/3] / FFT_LENGTH),
209                 20.0 * log10(in[best_bin/4] / FFT_LENGTH));
210 #endif
211
212         // see if we might have hit an overtone (set a limit of 5dB)
213         for (unsigned i = 4; i >= 1; --i) {
214                 if (best_bin != best_bin / i &&
215                     20.0 * log10(in[best_bin] / in[best_bin / i]) < 5.0f) {
216 #if 0
217                         printf("Overtone of degree %u!\n", i);
218 #endif
219                         best_bin /= i;
220
221                         // consider sliding one bin up or down
222                         if (best_bin > 0 && in[best_bin - 1] > in[best_bin] && in[best_bin - 1] > in[best_bin - 2]) {
223                                 --best_bin;
224                         } else if (best_bin < num_samples / 2 && in[best_bin + 1] > in[best_bin] && in[best_bin + 1] > in[best_bin + 2]) {
225                                 ++best_bin;
226                         }
227                            
228                         break;
229                 }
230         }
231
232         std::pair<double, double> peak = 
233                 interpolate_peak(in[best_bin - 1],
234                                  in[best_bin],
235                                  in[best_bin + 1]);
236                 
237         return std::make_pair(bin_to_freq(double(best_bin) + peak.first, num_samples), peak.second);
238 }
239
240 // it's perhaps not ideal to _first_ find the peak and _then_ the harmonics --
241 // ideally, one should find the set of all peaks and then determine the likely
242 // base from that... something for later. :-)
243 std::pair<double, double> adjust_for_overtones(std::pair<double, double> base, double *in, unsigned num_samples)
244 {
245         double mu = base.first, var = 1.0 / (base.second * base.second);
246         printf("mu=%f, var=%f\n", mu, var);
247
248         for (unsigned i = 2; i < 10; ++i) {
249                 unsigned middle = unsigned(floor(freq_to_bin(base.first, num_samples) * i + 0.5));
250                 unsigned lower = middle - (i+1)/2, upper = middle + (i+1)/2;
251
252                 if (upper >= num_samples)
253                         upper = num_samples - 2;
254
255                 // printf("Searching in [%u,%u] = %f..%f\n", lower, upper, bin_to_freq(lower, num_samples), bin_to_freq(upper, num_samples));
256
257                 // search for a peak in this interval
258                 double best_harmonics_freq = -1.0;
259                 double best_harmonics_amp = -1.0;
260                 for (unsigned j = lower; j <= upper; ++j) {
261                         if (in[j] > in[j-1] && in[j] > in[j+1]) {
262                                 std::pair<double, double> peak =
263                                         interpolate_peak(in[j - 1],
264                                                 in[j],
265                                                 in[j + 1]);
266                                 
267                                 if (peak.second > best_harmonics_amp) {
268                                         best_harmonics_freq = bin_to_freq(j + peak.first, num_samples);
269                                         best_harmonics_amp = peak.second;
270                                 }
271                         }
272                 }
273
274                 if (best_harmonics_amp <= 0.0)
275                         continue;
276
277                 //printf("Found overtone %u at %.2f (amp=%5.2fdB)\n", i, best_harmonics_freq,
278                 //       best_harmonics_amp);
279
280                 double this_mu = best_harmonics_freq / double(i);
281                 double this_var = 1.0 / (best_harmonics_amp * best_harmonics_amp);
282
283                 double k = var / (var + this_var);
284                 mu = (1.0 - k) * mu + k * this_mu;
285                 var *= (1.0 - k);
286
287                 printf("mu=%f, var=%f\n", mu, var);
288         }
289         return std::make_pair(mu, base.second);
290 }
291
292 double bin_to_freq(double bin, unsigned num_samples)
293 {
294         return bin * SAMPLE_RATE / double(num_samples);
295 }
296 double freq_to_bin(double freq, unsigned num_samples)
297 {
298         return freq * double(num_samples) / double(SAMPLE_RATE);
299 }
300
301 /*
302  * Given three bins, find the interpolated real peak based
303  * on their magnitudes. To do this, we execute the following
304  * plan:
305  * 
306  * Fit a polynomial of the form ax^2 + bx + c = 0 to the data
307  * we have. Maple readily yields our coefficients, assuming
308  * that we have the values at x=-1, x=0 and x=1:
309  *
310  * > f := x -> a*x^2 + b*x + c;                                
311  * 
312  *                               2
313  *           f := x -> a x  + b x + c
314  * 
315  * > cf := solve({ f(-1) = ym1, f(0) = y0, f(1) = y1 }, { a, b, c });
316  * 
317  *                            y1    ym1       y1    ym1
318  *        cf := {c = y0, b = ---- - ---, a = ---- + --- - y0}
319  *                            2      2        2      2
320  *
321  * Now let's find the maximum point for the polynomial (it has to be
322  * a maximum, since y0 is the greatest value):
323  *
324  * > xmax := solve(subs(cf, diff(f(x), x)) = 0, x);
325  * 
326  *                                -y1 + ym1
327  *                   xmax := -------------------
328  *                           2 (y1 + ym1 - 2 y0)
329  *
330  * We could go further and insert {fmax,a,b,c} into the original
331  * polynomial, but it just gets hairy. We calculate a, b and c separately
332  * instead.
333  *
334  * http://www-ccrma.stanford.edu/~jos/parshl/Peak_Detection_Steps_3.html
335  * claims that detection is almost twice as good when using dB scale instead
336  * of linear scale for the input values, so we use that. (As a tiny bonus,
337  * we get back dB scale from the function.)
338  */
339 std::pair<double, double> interpolate_peak(double ym1, double y0, double y1)
340 {
341         ym1 = log10(ym1);
342         y0 = log10(y0);
343         y1 = log10(y1);
344
345 #if 0
346         assert(y0 >= y1);
347         assert(y0 >= ym1);
348 #endif
349         
350         double a = 0.5 * y1 + 0.5 * ym1 - y0;
351         double b = 0.5 * y1 - 0.5 * ym1;
352         double c = y0;
353         
354         double xmax = (ym1 - y1) / (2.0 * (y1 + ym1 - 2.0 * y0));
355         double ymax = 20.0 * (a * xmax * xmax + b * xmax + c) - 90.0;
356
357         return std::make_pair(xmax, ymax);
358 }
359
360 std::string freq_to_tonename(double freq)
361 {
362         std::string notenames[] = { "C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B" };
363         double half_notes_away = 12.0 * log2(freq / 440.0) - 3.0;
364         int hnai = int(floor(half_notes_away + 0.5));
365         int octave = (hnai + 48) / 12;
366
367         char buf[256];
368         sprintf(buf, "%s%d + %.2f [%d]", notenames[((hnai % 12) + 12) % 12].c_str(), octave, half_notes_away - hnai, hnai);
369         return buf;
370 }
371
372 #if TUNING == EQUAL_TEMPERAMENT
373 void print_spectrogram(double freq, double amp)
374 {
375         std::string notenames[] = { "C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B" };
376         double half_notes_away = 12.0 * log2(freq / 440.0) - 3.0;
377         int hnai = int(floor(half_notes_away + 0.5));
378         int octave = (hnai + 48) / 12;
379
380         for (int i = 0; i < 12; ++i)
381                 if (i == ((hnai % 12) + 12) % 12)
382                         printf("#");
383                 else
384                         printf(".");
385
386         printf(" (%-2s%d %+.2f, %5.2fHz) [%5.2fdB]  [", notenames[((hnai % 12) + 12) % 12].c_str(), octave, half_notes_away - hnai,
387                 freq, amp);
388
389         double off = half_notes_away - hnai;
390         for (int i = -10; i <= 10; ++i) {
391                 if (off >= (i-0.5) * 0.05 && off < (i+0.5) * 0.05) {
392                         printf("#");
393                 } else {
394                         if (i == 0) {
395                                 printf("|");
396                         } else {
397                                 printf("-");
398                         }
399                 }
400         }
401         printf("]\n");
402
403 }
404 #else
405 struct note {
406         char notename[16];
407         double freq;
408 };
409 static note notes[] = {
410         { "E-3", 110.0 * (3.0/4.0) },
411         { "A-3", 110.0 },
412         { "D-4", 110.0 * (4.0/3.0) },
413         { "G-4", 110.0 * (4.0/3.0)*(4.0/3.0) },
414         { "B-4", 440.0 * (3.0/4.0)*(3.0/4.0) },
415         { "E-5", 440.0 * (3.0/4.0) }
416 };
417
418 void print_spectrogram(double freq, double amp)
419 {
420         double best_away = 999999999.9;
421         unsigned best_away_ind = 0;
422         
423         for (unsigned i = 0; i < sizeof(notes)/sizeof(note); ++i) {
424                 double half_notes_away = 12.0 * log2(freq / notes[i].freq);
425                 if (fabs(half_notes_away) < fabs(best_away)) {
426                         best_away = half_notes_away;
427                         best_away_ind = i;
428                 }
429         }
430         
431         for (unsigned i = 0; i < sizeof(notes)/sizeof(note); ++i)
432                 if (i == best_away_ind)
433                         printf("#");
434                 else
435                         printf(".");
436
437         printf(" (%s %+.2f, %5.2fHz) [%5.2fdB]  [", notes[best_away_ind].notename, best_away, freq, amp);
438
439         for (int i = -10; i <= 10; ++i) {
440                 if (best_away >= (i-0.5) * 0.05 && best_away < (i+0.5) * 0.05) {
441                         printf("#");
442                 } else {
443                         if (i == 0) {
444                                 printf("|");
445                         } else {
446                                 printf("-");
447                         }
448                 }
449         }
450         printf("]\n");
451 }
452 #endif