68322d8cff2b680aaf9dfd738a4851be7d652ae0
[vamp-aubio-plugins.git] / plugins / Onset.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 "Onset.h"
18
19 using std::string;
20 using std::vector;
21 using std::cerr;
22 using std::endl;
23
24 Onset::Onset(float inputSampleRate) :
25     Plugin(inputSampleRate),
26     m_ibuf(0),
27     m_fftgrain(0),
28     m_onset(0),
29     m_pv(0),
30     m_peakpick(0),
31     m_onsetdet(0),
32     m_onsettype(aubio_onset_mkl),
33     m_threshold(0.3),
34     m_silence(-90),
35     m_channelCount(1)
36 {
37 }
38
39 Onset::~Onset()
40 {
41     if (m_onsetdet) aubio_onsetdetection_free(m_onsetdet);
42     if (m_ibuf) del_fvec(m_ibuf);
43     if (m_onset) del_fvec(m_onset);
44     if (m_fftgrain) del_cvec(m_fftgrain);
45     if (m_pv) del_aubio_pvoc(m_pv);
46     if (m_peakpick) del_aubio_peakpicker(m_peakpick);
47 }
48
49 string
50 Onset::getName() const
51 {
52     return "aubioonset";
53 }
54
55 string
56 Onset::getDescription() const
57 {
58     return "Aubio Onset Detector";
59 }
60
61 string
62 Onset::getMaker() const
63 {
64     return "Paul Brossier (plugin by Chris Cannam)";
65 }
66
67 int
68 Onset::getPluginVersion() const
69 {
70     return 1;
71 }
72
73 string
74 Onset::getCopyright() const
75 {
76     return "GPL";
77 }
78
79 bool
80 Onset::initialise(size_t channels, size_t stepSize, size_t blockSize)
81 {
82     m_channelCount = channels;
83     m_stepSize = stepSize;
84     m_blockSize = blockSize;
85
86     size_t processingBlockSize;
87     if (m_onsettype == aubio_onset_energy ||
88         m_onsettype == aubio_onset_hfc) {
89         processingBlockSize = stepSize * 2;
90     } else {
91         processingBlockSize = stepSize * 4;
92     }
93
94     m_ibuf = new_fvec(stepSize, channels);
95     m_onset = new_fvec(1, channels);
96     m_fftgrain = new_cvec(processingBlockSize, channels);
97     m_pv = new_aubio_pvoc(processingBlockSize, stepSize, channels);
98     m_peakpick = new_aubio_peakpicker(m_threshold);
99
100     m_onsetdet = new_aubio_onsetdetection(m_onsettype, processingBlockSize, channels);
101
102     return true;
103 }
104
105 void
106 Onset::reset()
107 {
108 }
109
110 size_t
111 Onset::getPreferredStepSize() const
112 {
113     if (m_onsettype == aubio_onset_energy ||
114         m_onsettype == aubio_onset_hfc) {
115         return 512;
116     } else {
117         return 128;
118     }
119 }
120
121 size_t
122 Onset::getPreferredBlockSize() const
123 {
124     return getPreferredStepSize();
125 }
126
127 Onset::ParameterList
128 Onset::getParameterDescriptors() const
129 {
130     ParameterList list;
131     
132     ParameterDescriptor desc;
133     desc.name = "onsettype";
134     desc.description = "Onset Detection Function Type";
135     desc.minValue = 0;
136     desc.maxValue = 6;
137     desc.defaultValue = (int)aubio_onset_mkl;
138     desc.isQuantized = true;
139     desc.quantizeStep = 1;
140     desc.valueNames.push_back("Energy Based");
141     desc.valueNames.push_back("Spectral Difference");
142     desc.valueNames.push_back("High-Frequency Content");
143     desc.valueNames.push_back("Complex Domain");
144     desc.valueNames.push_back("Phase Deviation");
145     desc.valueNames.push_back("Kullback-Liebler");
146     desc.valueNames.push_back("Modified Kullback-Liebler");
147     list.push_back(desc);
148
149     desc = ParameterDescriptor();
150     desc.name = "peakpickthreshold";
151     desc.description = "Peak Picker Threshold";
152     desc.minValue = 0;
153     desc.maxValue = 1;
154     desc.defaultValue = 0.3;
155     desc.isQuantized = false;
156     list.push_back(desc);
157
158     desc = ParameterDescriptor();
159     desc.name = "silencethreshold";
160     desc.description = "Silence Threshold";
161     desc.minValue = -120;
162     desc.maxValue = 0;
163     desc.defaultValue = -90;
164     desc.unit = "dB";
165     desc.isQuantized = false;
166     list.push_back(desc);
167
168     return list;
169 }
170
171 float
172 Onset::getParameter(std::string param) const
173 {
174     if (param == "onsettype") {
175         return m_onsettype;
176     } else if (param == "peakpickthreshold") {
177         return m_threshold;
178     } else if (param == "silencethreshold") {
179         return m_silence;
180     } else {
181         return 0.0;
182     }
183 }
184
185 void
186 Onset::setParameter(std::string param, float value)
187 {
188     if (param == "onsettype") {
189         switch (lrintf(value)) {
190         case 0: m_onsettype = aubio_onset_energy; break;
191         case 1: m_onsettype = aubio_onset_specdiff; break;
192         case 2: m_onsettype = aubio_onset_hfc; break;
193         case 3: m_onsettype = aubio_onset_complex; break;
194         case 4: m_onsettype = aubio_onset_phase; break;
195         case 5: m_onsettype = aubio_onset_kl; break;
196         case 6: m_onsettype = aubio_onset_mkl; break;
197         }
198     } else if (param == "peakpickthreshold") {
199         m_threshold = value;
200     } else if (param == "silencethreshold") {
201         m_silence = value;
202     }
203 }
204
205 Onset::OutputList
206 Onset::getOutputDescriptors() const
207 {
208     OutputList list;
209
210     OutputDescriptor d;
211     d.name = "onsets";
212     d.unit = "";
213     d.description = "Onsets";
214     d.hasFixedBinCount = true;
215     d.binCount = 0;
216     d.sampleType = OutputDescriptor::OneSamplePerStep;
217     list.push_back(d);
218
219     d = OutputDescriptor();
220     d.name = "detectionfunction";
221     d.unit = "";
222     d.description = "Onset Detection Function";
223     d.hasFixedBinCount = true;
224     d.binCount = m_channelCount;
225     d.hasKnownExtents = false;
226     d.isQuantized = false;
227     d.sampleType = OutputDescriptor::OneSamplePerStep;
228     list.push_back(d);
229
230     return list;
231 }
232
233 Onset::FeatureSet
234 Onset::process(float **inputBuffers, Vamp::RealTime /* timestamp */)
235 {
236     for (size_t i = 0; i < m_stepSize; ++i) {
237         for (size_t j = 0; j < m_channelCount; ++j) {
238             fvec_write_sample(m_ibuf, inputBuffers[j][i], j, i);
239         }
240     }
241
242     aubio_pvoc_do(m_pv, m_ibuf, m_fftgrain);
243     aubio_onsetdetection(m_onsetdet, m_fftgrain, m_onset);
244
245     bool isonset = aubio_peakpick_pimrt(m_onset, m_peakpick);
246
247     if (isonset) {
248         if (aubio_silence_detection(m_ibuf, m_silence)) {
249             isonset = false;
250         }
251     }
252
253     FeatureSet returnFeatures;
254
255     if (isonset) {
256         returnFeatures[0].push_back(Feature());
257     }
258     Feature feature;
259     for (size_t j = 0; j < m_channelCount; ++j) {
260         feature.values.push_back(m_onset->data[j][0]);
261     }
262     returnFeatures[1].push_back(feature);
263
264     return returnFeatures;
265 }
266
267 Onset::FeatureSet
268 Onset::getRemainingFeatures()
269 {
270     return FeatureSet();
271 }
272