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.
25 Notes::Notes(float inputSampleRate) :
26 Plugin(inputSampleRate),
33 m_onsettype(aubio_onset_complex),
35 m_pitchtype(aubio_pitch_yinfft),
36 m_pitchmode(aubio_pitchm_freq),
45 if (m_onsetdet) aubio_onsetdetection_free(m_onsetdet);
46 if (m_pitchdet) del_aubio_pitchdetection(m_pitchdet);
47 if (m_ibuf) del_fvec(m_ibuf);
48 if (m_onset) del_fvec(m_onset);
49 if (m_fftgrain) del_cvec(m_fftgrain);
50 if (m_pv) del_aubio_pvoc(m_pv);
51 if (m_peakpick) del_aubio_peakpicker(m_peakpick);
55 Notes::getName() const
61 Notes::getDescription() const
63 return "Aubio Note Tracker";
67 Notes::getMaker() const
69 return "Paul Brossier (plugin by Chris Cannam)";
73 Notes::getPluginVersion() const
79 Notes::getCopyright() const
85 Notes::initialise(size_t channels, size_t stepSize, size_t blockSize)
87 m_channelCount = channels;
88 m_stepSize = stepSize;
89 m_blockSize = blockSize;
91 size_t processingBlockSize;
92 if (m_onsettype == aubio_onset_energy ||
93 m_onsettype == aubio_onset_hfc) {
94 processingBlockSize = stepSize * 2;
96 processingBlockSize = stepSize * 4;
99 m_ibuf = new_fvec(stepSize, channels);
100 m_onset = new_fvec(1, channels);
101 m_fftgrain = new_cvec(processingBlockSize, channels);
102 m_pv = new_aubio_pvoc(processingBlockSize, stepSize, channels);
103 m_peakpick = new_aubio_peakpicker(m_threshold);
105 m_onsetdet = new_aubio_onsetdetection(m_onsettype, processingBlockSize, channels);
107 m_pitchdet = new_aubio_pitchdetection(processingBlockSize * 4,
110 lrintf(m_inputSampleRate),
115 m_currentOnset = Vamp::RealTime::zeroTime;
116 m_haveCurrent = false;
127 Notes::getPreferredStepSize() const
133 Notes::getPreferredBlockSize() const
135 return 4*getPreferredStepSize();
139 Notes::getParameterDescriptors() const
143 ParameterDescriptor desc;
144 desc.name = "onsettype";
145 desc.description = "Onset Detection Function Type";
148 desc.defaultValue = (int)aubio_onset_complex;
149 desc.isQuantized = true;
150 desc.quantizeStep = 1;
151 desc.valueNames.push_back("Energy Based");
152 desc.valueNames.push_back("Spectral Difference");
153 desc.valueNames.push_back("High-Frequency Content");
154 desc.valueNames.push_back("Complex Domain");
155 desc.valueNames.push_back("Phase Deviation");
156 desc.valueNames.push_back("Kullback-Liebler");
157 desc.valueNames.push_back("Modified Kullback-Liebler");
158 list.push_back(desc);
160 desc = ParameterDescriptor();
161 desc.name = "pitchtype";
162 desc.description = "Pitch Detection Function Type";
165 desc.defaultValue = (int)aubio_pitch_yinfft;
166 desc.isQuantized = true;
167 desc.quantizeStep = 1;
168 desc.valueNames.push_back("YIN Frequency Estimator");
169 desc.valueNames.push_back("Spectral Comb");
170 desc.valueNames.push_back("Schmitt");
171 desc.valueNames.push_back("Fast Harmonic Comb");
172 desc.valueNames.push_back("YIN with FFT");
173 list.push_back(desc);
175 desc = ParameterDescriptor();
176 desc.name = "peakpickthreshold";
177 desc.description = "Peak Picker Threshold";
180 desc.defaultValue = 0.3;
181 desc.isQuantized = false;
182 list.push_back(desc);
184 desc = ParameterDescriptor();
185 desc.name = "silencethreshold";
186 desc.description = "Silence Threshold";
187 desc.minValue = -120;
189 desc.defaultValue = -90;
191 desc.isQuantized = false;
192 list.push_back(desc);
198 Notes::getParameter(std::string param) const
200 if (param == "onsettype") {
202 } else if (param == "pitchtype") {
204 } else if (param == "peakpickthreshold") {
206 } else if (param == "silencethreshold") {
214 Notes::setParameter(std::string param, float value)
216 if (param == "onsettype") {
217 switch (lrintf(value)) {
218 case 0: m_onsettype = aubio_onset_energy; break;
219 case 1: m_onsettype = aubio_onset_specdiff; break;
220 case 2: m_onsettype = aubio_onset_hfc; break;
221 case 3: m_onsettype = aubio_onset_complex; break;
222 case 4: m_onsettype = aubio_onset_phase; break;
223 case 5: m_onsettype = aubio_onset_kl; break;
224 case 6: m_onsettype = aubio_onset_mkl; break;
226 } else if (param == "pitchtype") {
227 switch (lrintf(value)) {
228 case 0: m_pitchtype = aubio_pitch_yin; break;
229 case 1: m_pitchtype = aubio_pitch_mcomb; break;
230 case 2: m_pitchtype = aubio_pitch_schmitt; break;
231 case 3: m_pitchtype = aubio_pitch_fcomb; break;
232 case 4: m_pitchtype = aubio_pitch_yinfft; break;
234 } else if (param == "peakpickthreshold") {
236 } else if (param == "silencethreshold") {
242 Notes::getOutputDescriptors() const
249 d.description = "Notes";
250 d.hasFixedBinCount = true;
252 d.binNames.push_back("Frequency");
253 d.binNames.push_back("Duration");
254 d.binNames.push_back("Velocity");
255 d.hasKnownExtents = false;
256 d.isQuantized = false;
257 d.sampleType = OutputDescriptor::VariableSampleRate;
265 Notes::process(float **inputBuffers, Vamp::RealTime timestamp)
267 for (size_t i = 0; i < m_stepSize; ++i) {
268 for (size_t j = 0; j < m_channelCount; ++j) {
269 fvec_write_sample(m_ibuf, inputBuffers[j][i], j, i);
273 aubio_pvoc_do(m_pv, m_ibuf, m_fftgrain);
274 aubio_onsetdetection(m_onsetdet, m_fftgrain, m_onset);
276 bool isonset = aubio_peakpick_pimrt(m_onset, m_peakpick);
278 float frequency = aubio_pitchdetection(m_pitchdet, m_ibuf);
280 m_notebuf.push_back(frequency);
281 if (m_notebuf.size() > m_median) m_notebuf.pop_front();
283 float level = aubio_level_detection(m_ibuf, m_silence);
285 FeatureSet returnFeatures;
291 if (m_haveCurrent) pushNote(returnFeatures, timestamp);
296 if (m_count > 0) ++m_count;
297 if (m_count == m_median) {
298 if (m_haveCurrent) pushNote(returnFeatures, timestamp);
299 m_currentOnset = timestamp;
300 m_currentLevel = level;
301 m_haveCurrent = true;
305 m_lastTimeStamp = timestamp;
306 return returnFeatures;
310 Notes::getRemainingFeatures()
312 FeatureSet returnFeatures;
313 if (m_haveCurrent) pushNote(returnFeatures, m_lastTimeStamp);
314 return returnFeatures;
318 Notes::pushNote(FeatureSet &fs, const Vamp::RealTime &offTime)
320 std::deque<float> toSort = m_notebuf;
321 std::sort(toSort.begin(), toSort.end());
322 float median = toSort[toSort.size()/2];
323 if (median < 45.0) return;
326 feature.hasTimestamp = true;
327 feature.timestamp = m_currentOnset;
328 feature.values.push_back(median);
329 // feature.values.push_back(FLOOR(aubio_freqtomidi(median) + 0.5));
330 feature.values.push_back
331 (Vamp::RealTime::realTime2Frame(offTime, lrintf(m_inputSampleRate)) -
332 Vamp::RealTime::realTime2Frame(m_currentOnset, lrintf(m_inputSampleRate)));
333 feature.values.push_back(m_currentLevel);
334 fs[0].push_back(feature);