27b817d6521244f86f984ed6b2b3b32664d949d8
[vamp-aubio-plugins.git] / plugins / Tempo.cpp
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
2
3 /*
4     Vamp feature extraction plugins using Paul Brossier's Aubio library.
5
6     Centre for Digital Music, Queen Mary, University of London.
7     This file copyright 2006 Chris Cannam.
8     
9     This program is free software; you can redistribute it and/or
10     modify it under the terms of the GNU General Public License as
11     published by the Free Software Foundation; either version 2 of the
12     License, or (at your option) any later version.  See the file
13     COPYING included with this distribution for more information.
14
15 */
16
17 #include <math.h>
18 #include "Tempo.h"
19
20 using std::string;
21 using std::vector;
22 using std::cerr;
23 using std::endl;
24
25 //#define HAVE_AUBIO_LOCKED_TEMPO_HACK
26
27 Tempo::Tempo(float inputSampleRate) :
28     Plugin(inputSampleRate),
29     m_ibuf(0),
30     m_fftgrain(0),
31     m_onset(0),
32     m_pv(0),
33     m_peakpick(0),
34     m_onsetdet(0),
35     m_onsettype(aubio_onset_specdiff),
36     m_beattracking(0),
37     m_dfframe(0),
38     m_btout(0),
39     m_btcounter(0),
40     m_threshold(0.3),
41     m_silence(-90)
42 {
43 }
44
45 Tempo::~Tempo()
46 {
47     if (m_onsetdet) aubio_onsetdetection_free(m_onsetdet);
48     if (m_ibuf) del_fvec(m_ibuf);
49     if (m_onset) del_fvec(m_onset);
50     if (m_fftgrain) del_cvec(m_fftgrain);
51     if (m_pv) del_aubio_pvoc(m_pv);
52     if (m_peakpick) del_aubio_peakpicker(m_peakpick);
53     if (m_beattracking) del_aubio_beattracking(m_beattracking);
54     if (m_dfframe) del_fvec(m_dfframe);
55     if (m_btout) del_fvec(m_btout);
56 }
57
58 string
59 Tempo::getIdentifier() const
60 {
61     return "aubiotempo";
62 }
63
64 string
65 Tempo::getName() const
66 {
67     return "Aubio Beat Tracker";
68 }
69
70 string
71 Tempo::getDescription() const
72 {
73     return "Estimate the musical tempo and track beat positions";
74 }
75
76 string
77 Tempo::getMaker() const
78 {
79     return "Paul Brossier (method by Matthew Davies, plugin by Chris Cannam)";
80 }
81
82 int
83 Tempo::getPluginVersion() const
84 {
85     return 2;
86 }
87
88 string
89 Tempo::getCopyright() const
90 {
91     return "GPL";
92 }
93
94 bool
95 Tempo::initialise(size_t channels, size_t stepSize, size_t blockSize)
96 {
97     if (channels != 1) {
98         std::cerr << "Tempo::initialise: channels must be 1" << std::endl;
99         return false;
100     }
101
102     m_stepSize = stepSize;
103     m_blockSize = blockSize;
104
105     m_ibuf = new_fvec(stepSize);
106     m_onset = new_fvec(1);
107     m_fftgrain = new_cvec(blockSize);
108     m_pv = new_aubio_pvoc(blockSize, stepSize);
109     m_peakpick = new_aubio_peakpicker(m_threshold);
110
111     m_onsetdet = new_aubio_onsetdetection(m_onsettype, blockSize);
112     
113     m_delay = Vamp::RealTime::frame2RealTime(3 * stepSize,
114                                              lrintf(m_inputSampleRate));
115
116     m_lastBeat = Vamp::RealTime::zeroTime - m_delay - m_delay;
117
118     m_winlen = 512*512/stepSize;
119     m_dfframe = new_fvec(m_winlen,channels);
120     m_btstep = m_winlen/4;
121     m_btout = new_fvec(m_btstep,channels);
122     m_beattracking = new_aubio_beattracking(m_winlen,channels);
123
124     return true;
125 }
126
127 void
128 Tempo::reset()
129 {
130 }
131
132 size_t
133 Tempo::getPreferredStepSize() const
134 {
135     return 512;
136 }
137
138 size_t
139 Tempo::getPreferredBlockSize() const
140 {
141     return 2 * getPreferredStepSize();
142 }
143
144 Tempo::ParameterList
145 Tempo::getParameterDescriptors() const
146 {
147     ParameterList list;
148     
149     ParameterDescriptor desc;
150     desc.identifier = "onsettype";
151     desc.name = "Onset Detection Function Type";
152     desc.minValue = 0;
153     desc.maxValue = 6;
154     desc.defaultValue = (int)aubio_onset_complex;
155     desc.isQuantized = true;
156     desc.quantizeStep = 1;
157     desc.valueNames.push_back("Energy Based");
158     desc.valueNames.push_back("Spectral Difference");
159     desc.valueNames.push_back("High-Frequency Content");
160     desc.valueNames.push_back("Complex Domain");
161     desc.valueNames.push_back("Phase Deviation");
162     desc.valueNames.push_back("Kullback-Liebler");
163     desc.valueNames.push_back("Modified Kullback-Liebler");
164     list.push_back(desc);
165
166     desc = ParameterDescriptor();
167     desc.identifier = "peakpickthreshold";
168     desc.name = "Peak Picker Threshold";
169     desc.minValue = 0;
170     desc.maxValue = 1;
171     desc.defaultValue = 0.3;
172     desc.isQuantized = false;
173     list.push_back(desc);
174
175     desc = ParameterDescriptor();
176     desc.identifier = "silencethreshold";
177     desc.name = "Silence Threshold";
178     desc.minValue = -120;
179     desc.maxValue = 0;
180     desc.defaultValue = -90;
181     desc.unit = "dB";
182     desc.isQuantized = false;
183     list.push_back(desc);
184
185     return list;
186 }
187
188 float
189 Tempo::getParameter(std::string param) const
190 {
191     if (param == "onsettype") {
192         return m_onsettype;
193     } else if (param == "peakpickthreshold") {
194         return m_threshold;
195     } else if (param == "silencethreshold") {
196         return m_silence;
197     } else {
198         return 0.0;
199     }
200 }
201
202 void
203 Tempo::setParameter(std::string param, float value)
204 {
205     if (param == "onsettype") {
206         switch (lrintf(value)) {
207         case 0: m_onsettype = aubio_onset_energy; break;
208         case 1: m_onsettype = aubio_onset_specdiff; break;
209         case 2: m_onsettype = aubio_onset_hfc; break;
210         case 3: m_onsettype = aubio_onset_complex; break;
211         case 4: m_onsettype = aubio_onset_phase; break;
212         case 5: m_onsettype = aubio_onset_kl; break;
213         case 6: m_onsettype = aubio_onset_mkl; break;
214         }
215     } else if (param == "peakpickthreshold") {
216         m_threshold = value;
217     } else if (param == "silencethreshold") {
218         m_silence = value;
219     }
220 }
221
222 Tempo::OutputList
223 Tempo::getOutputDescriptors() const
224 {
225     OutputList list;
226
227     OutputDescriptor d;
228     d.identifier = "beats";
229     d.name = "Beats";
230     d.unit = "";
231     d.hasFixedBinCount = true;
232     d.binCount = 0;
233     d.sampleType = OutputDescriptor::VariableSampleRate;
234     d.sampleRate = 0;
235     list.push_back(d);
236
237 #ifdef HAVE_AUBIO_LOCKED_TEMPO_HACK
238     d.identifier = "tempo";
239     d.name = "Tempo";
240     d.unit = "bpm";
241     d.hasFixedBinCount = true;
242     d.binCount = 1;
243     d.hasKnownExtents = false;
244     d.isQuantized = false;
245     d.sampleType = OutputDescriptor::OneSamplePerStep;
246     list.push_back(d);
247 #endif
248
249     return list;
250 }
251
252 Tempo::FeatureSet
253 Tempo::process(const float *const *inputBuffers, Vamp::RealTime timestamp)
254 {
255     for (size_t i = 0; i < m_stepSize; ++i) {
256         for (size_t j = 0; j < m_channelCount; ++j) {
257             fvec_write_sample(m_ibuf, inputBuffers[j][i], j, i);
258         }
259     }
260
261     aubio_pvoc_do(m_pv, m_ibuf, m_fftgrain);
262     aubio_onsetdetection(m_onsetdet, m_fftgrain, m_onset);
263
264 #ifdef HAVE_AUBIO_LOCKED_TEMPO_HACK
265     float locked_tempo = 0;
266 #endif
267
268     if ( m_btcounter == m_btstep - 1 ) {
269 #ifdef HAVE_AUBIO_LOCKED_TEMPO_HACK
270         aubio_beattracking_do(m_beattracking,m_dfframe,m_btout,&locked_tempo);
271 #else
272         aubio_beattracking_do(m_beattracking,m_dfframe,m_btout);
273 #endif
274         /* rotate dfframe */
275         for (size_t i = 0 ; i < m_winlen - m_btstep; i++ ) 
276                 m_dfframe->data[0][i] = m_dfframe->data[0][i+m_btstep];
277         for (size_t i = m_winlen - m_btstep ; i < m_winlen; i++ ) 
278                 m_dfframe->data[0][i] = 0.;
279                 
280         m_btcounter = -1;
281     }
282     m_btcounter++;
283     bool isonset = aubio_peakpick_pimrt_wt( m_onset, m_peakpick, 
284         &(m_dfframe->data[0][m_winlen - m_btstep + m_btcounter]));
285     bool istactus = 0;
286
287     /* check if any of the predicted beat correspond to the current time */
288     for (size_t i = 1; i < m_btout->data[0][0]; i++ ) { 
289             if (m_btcounter == m_btout->data[0][i]) {
290                     if (aubio_silence_detection(m_ibuf, m_silence)) {
291                             isonset  = false;
292                             istactus = false;
293                     } else {
294                             istactus = true;
295                     }
296             }
297     }
298
299     FeatureSet returnFeatures;
300
301     if (istactus == true) {
302         if (timestamp - m_lastBeat >= m_delay) {
303             Feature onsettime;
304             onsettime.hasTimestamp = true;
305             if (timestamp < m_delay) timestamp = m_delay;
306             onsettime.timestamp = timestamp - m_delay;
307             returnFeatures[0].push_back(onsettime);
308             m_lastBeat = timestamp;
309         }
310     }
311
312 #ifdef HAVE_AUBIO_LOCKED_TEMPO_HACK
313     if (locked_tempo >= 30 && locked_tempo <= 206) {
314         if (locked_tempo > 145) locked_tempo /= 2;
315         std::cerr << "Locked tempo: " << locked_tempo << std::endl;
316         Feature tempo;
317         tempo.hasTimestamp = false;
318         tempo.values.push_back(locked_tempo);
319         returnFeatures[1].push_back(tempo);
320     }
321 #endif
322
323     return returnFeatures;
324 }
325
326 Tempo::FeatureSet
327 Tempo::getRemainingFeatures()
328 {
329     return FeatureSet();
330 }
331