1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
4 Vamp feature extraction plugins using Paul Brossier's Aubio library.
6 Centre for Digital Music, Queen Mary, University of London.
7 This file copyright 2006 Chris Cannam.
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.
24 Notes::Notes(float inputSampleRate) :
25 Plugin(inputSampleRate),
32 m_onsettype(aubio_onset_mkl),
34 m_pitchtype(aubio_pitch_fcomb),
35 m_pitchmode(aubio_pitchm_freq),
44 if (m_onsetdet) aubio_onsetdetection_free(m_onsetdet);
45 if (m_pitchdet) del_aubio_pitchdetection(m_pitchdet);
46 if (m_ibuf) del_fvec(m_ibuf);
47 if (m_onset) del_fvec(m_onset);
48 if (m_fftgrain) del_cvec(m_fftgrain);
49 if (m_pv) del_aubio_pvoc(m_pv);
50 if (m_peakpick) del_aubio_peakpicker(m_peakpick);
54 Notes::getName() const
60 Notes::getDescription() const
62 return "Aubio Note Tracker";
66 Notes::getMaker() const
68 return "Paul Brossier (plugin by Chris Cannam)";
72 Notes::getPluginVersion() const
78 Notes::getCopyright() const
84 Notes::initialise(size_t channels, size_t stepSize, size_t blockSize)
86 m_channelCount = channels;
87 m_stepSize = stepSize;
88 m_blockSize = blockSize;
90 size_t processingBlockSize;
91 if (m_onsettype == aubio_onset_energy ||
92 m_onsettype == aubio_onset_hfc) {
93 processingBlockSize = stepSize * 2;
95 processingBlockSize = stepSize * 4;
98 m_ibuf = new_fvec(stepSize, channels);
99 m_onset = new_fvec(1, channels);
100 m_fftgrain = new_cvec(processingBlockSize, channels);
101 m_pv = new_aubio_pvoc(processingBlockSize, stepSize, channels);
102 m_peakpick = new_aubio_peakpicker(m_threshold);
104 m_onsetdet = new_aubio_onsetdetection(m_onsettype, processingBlockSize, channels);
106 m_pitchdet = new_aubio_pitchdetection(processingBlockSize * 4,
109 lrintf(m_inputSampleRate),
114 m_currentOnset = Vamp::RealTime::zeroTime;
115 m_haveCurrent = false;
126 Notes::getPreferredStepSize() const
128 if (m_onsettype == aubio_onset_energy ||
129 m_onsettype == aubio_onset_hfc) {
137 Notes::getPreferredBlockSize() const
139 return getPreferredStepSize();
143 Notes::getParameterDescriptors() const
147 ParameterDescriptor desc;
148 desc.name = "onsettype";
149 desc.description = "Onset Detection Function Type";
152 desc.defaultValue = (int)aubio_onset_mkl;
153 desc.isQuantized = true;
154 desc.quantizeStep = 1;
155 desc.valueNames.push_back("Energy Based");
156 desc.valueNames.push_back("Spectral Difference");
157 desc.valueNames.push_back("High-Frequency Content");
158 desc.valueNames.push_back("Complex Domain");
159 desc.valueNames.push_back("Phase Deviation");
160 desc.valueNames.push_back("Kullback-Liebler");
161 desc.valueNames.push_back("Modified Kullback-Liebler");
162 list.push_back(desc);
164 desc = ParameterDescriptor();
165 desc.name = "pitchtype";
166 desc.description = "Pitch Detection Function Type";
169 desc.defaultValue = (int)aubio_pitch_fcomb;
170 desc.isQuantized = true;
171 desc.quantizeStep = 1;
172 desc.valueNames.push_back("YIN Frequency Estimator");
173 desc.valueNames.push_back("Spectral Comb");
174 desc.valueNames.push_back("Schmitt");
175 desc.valueNames.push_back("Fast Harmonic Comb");
176 desc.valueNames.push_back("YIN with FFT");
177 list.push_back(desc);
179 desc = ParameterDescriptor();
180 desc.name = "peakpickthreshold";
181 desc.description = "Peak Picker Threshold";
184 desc.defaultValue = 0.3;
185 desc.isQuantized = false;
186 list.push_back(desc);
188 desc = ParameterDescriptor();
189 desc.name = "silencethreshold";
190 desc.description = "Silence Threshold";
191 desc.minValue = -120;
193 desc.defaultValue = -90;
195 desc.isQuantized = false;
196 list.push_back(desc);
202 Notes::getParameter(std::string param) const
204 if (param == "onsettype") {
206 } else if (param == "pitchtype") {
208 } else if (param == "peakpickthreshold") {
210 } else if (param == "silencethreshold") {
218 Notes::setParameter(std::string param, float value)
220 if (param == "onsettype") {
221 switch (lrintf(value)) {
222 case 0: m_onsettype = aubio_onset_energy; break;
223 case 1: m_onsettype = aubio_onset_specdiff; break;
224 case 2: m_onsettype = aubio_onset_hfc; break;
225 case 3: m_onsettype = aubio_onset_complex; break;
226 case 4: m_onsettype = aubio_onset_phase; break;
227 case 5: m_onsettype = aubio_onset_kl; break;
228 case 6: m_onsettype = aubio_onset_mkl; break;
230 } else if (param == "pitchtype") {
231 switch (lrintf(value)) {
232 case 0: m_pitchtype = aubio_pitch_yin; break;
233 case 1: m_pitchtype = aubio_pitch_mcomb; break;
234 case 2: m_pitchtype = aubio_pitch_schmitt; break;
235 case 3: m_pitchtype = aubio_pitch_fcomb; break;
236 case 4: m_pitchtype = aubio_pitch_yinfft; break;
238 } else if (param == "peakpickthreshold") {
240 } else if (param == "silencethreshold") {
246 Notes::getOutputDescriptors() const
253 d.description = "Notes";
254 d.hasFixedBinCount = true;
256 d.binNames.push_back("Frequency");
257 d.binNames.push_back("Duration");
258 d.binNames.push_back("Velocity");
259 d.hasKnownExtents = false;
260 d.isQuantized = false;
261 d.sampleType = OutputDescriptor::VariableSampleRate;
269 Notes::process(float **inputBuffers, Vamp::RealTime timestamp)
271 for (size_t i = 0; i < m_stepSize; ++i) {
272 for (size_t j = 0; j < m_channelCount; ++j) {
273 fvec_write_sample(m_ibuf, inputBuffers[j][i], j, i);
277 aubio_pvoc_do(m_pv, m_ibuf, m_fftgrain);
278 aubio_onsetdetection(m_onsetdet, m_fftgrain, m_onset);
280 bool isonset = aubio_peakpick_pimrt(m_onset, m_peakpick);
282 float frequency = aubio_pitchdetection(m_pitchdet, m_ibuf);
284 m_notebuf.push_back(frequency);
285 if (m_notebuf.size() > m_median) m_notebuf.pop_front();
287 float level = aubio_level_detection(m_ibuf, m_silence);
289 FeatureSet returnFeatures;
295 if (m_haveCurrent) pushNote(returnFeatures, timestamp);
300 if (m_count > 0) ++m_count;
301 if (m_count == m_median) {
302 if (m_haveCurrent) pushNote(returnFeatures, timestamp);
303 m_currentOnset = timestamp;
304 m_currentLevel = level;
305 m_haveCurrent = true;
309 m_lastTimeStamp = timestamp;
310 return returnFeatures;
314 Notes::getRemainingFeatures()
316 FeatureSet returnFeatures;
317 if (m_haveCurrent) pushNote(returnFeatures, m_lastTimeStamp);
318 return returnFeatures;
322 Notes::pushNote(FeatureSet &fs, const Vamp::RealTime &offTime)
324 std::deque<float> toSort = m_notebuf;
325 std::sort(toSort.begin(), toSort.end());
326 float median = toSort[toSort.size()/2];
327 if (median < 45.0) return;
330 feature.hasTimestamp = true;
331 feature.timestamp = m_currentOnset;
332 feature.values.push_back(median);
333 // feature.values.push_back(FLOOR(aubio_freqtomidi(median) + 0.5));
334 feature.values.push_back
335 (Vamp::RealTime::realTime2Frame(offTime, lrintf(m_inputSampleRate)) -
336 Vamp::RealTime::realTime2Frame(m_currentOnset, lrintf(m_inputSampleRate)));
337 feature.values.push_back(m_currentLevel);
338 fs[0].push_back(feature);