cannam@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@0: 
cannam@0: /*
cannam@0:     Vamp feature extraction plugins using Paul Brossier's Aubio library.
cannam@0: 
cannam@0:     Centre for Digital Music, Queen Mary, University of London.
cannam@0:     This file copyright 2006 Chris Cannam.
cannam@0:     
piem@112:     This file is part of vamp-aubio-plugins.
piem@112: 
piem@112:     vamp-aubio is free software: you can redistribute it and/or modify
piem@112:     it under the terms of the GNU General Public License as published by
piem@112:     the Free Software Foundation, either version 3 of the License, or
piem@112:     (at your option) any later version.
piem@112: 
piem@112:     vamp-aubio is distributed in the hope that it will be useful,
piem@112:     but WITHOUT ANY WARRANTY; without even the implied warranty of
piem@112:     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
piem@112:     GNU General Public License for more details.
piem@112: 
piem@112:     You should have received a copy of the GNU General Public License
piem@112:     along with aubio.  If not, see <http://www.gnu.org/licenses/>.
cannam@0: 
cannam@0: */
cannam@0: 
piem@2: #include <math.h>
cannam@0: #include "Onset.h"
cannam@0: 
cannam@0: using std::string;
cannam@0: using std::vector;
cannam@0: using std::cerr;
cannam@0: using std::endl;
cannam@0: 
cannam@0: Onset::Onset(float inputSampleRate) :
cannam@0:     Plugin(inputSampleRate),
cannam@0:     m_ibuf(0),
cannam@0:     m_onset(0),
cannam@0:     m_onsetdet(0),
piem@145:     m_onsettype(OnsetDefault),
cannam@0:     m_threshold(0.3),
piem@148:     m_silence(-90),
cannam@34:     m_minioi(4)
cannam@0: {
piem@148: 
cannam@0: }
cannam@0: 
cannam@0: Onset::~Onset()
cannam@0: {
cannam@33:     if (m_onsetdet) del_aubio_onset(m_onsetdet);
cannam@0:     if (m_ibuf) del_fvec(m_ibuf);
cannam@0:     if (m_onset) del_fvec(m_onset);
cannam@0: }
cannam@0: 
cannam@0: string
cannam@13: Onset::getIdentifier() const
cannam@0: {
cannam@0:     return "aubioonset";
cannam@0: }
cannam@0: 
cannam@0: string
cannam@13: Onset::getName() const
cannam@13: {
cannam@13:     return "Aubio Onset Detector";
cannam@13: }
cannam@13: 
cannam@13: string
cannam@0: Onset::getDescription() const
cannam@0: {
cannam@13:     return "Estimate note onset times";
cannam@0: }
cannam@0: 
cannam@0: string
cannam@0: Onset::getMaker() const
cannam@0: {
cannam@0:     return "Paul Brossier (plugin by Chris Cannam)";
cannam@0: }
cannam@0: 
cannam@0: int
cannam@0: Onset::getPluginVersion() const
cannam@0: {
cannam@31:     return 2;
cannam@0: }
cannam@0: 
cannam@0: string
cannam@0: Onset::getCopyright() const
cannam@0: {
cannam@0:     return "GPL";
cannam@0: }
cannam@0: 
cannam@0: bool
cannam@0: Onset::initialise(size_t channels, size_t stepSize, size_t blockSize)
cannam@0: {
cannam@32:     if (channels != 1) {
cannam@32:         std::cerr << "Onset::initialise: channels must be 1" << std::endl;
cannam@32:         return false;
cannam@32:     }
cannam@32: 
cannam@0:     m_stepSize = stepSize;
cannam@0:     m_blockSize = blockSize;
cannam@0: 
cannam@32:     m_ibuf = new_fvec(stepSize);
cannam@32:     m_onset = new_fvec(1);
cannam@0: 
cannam@37:     reset();
cannam@0: 
cannam@0:     return true;
cannam@0: }
cannam@0: 
cannam@0: void
cannam@0: Onset::reset()
cannam@0: {
cannam@37:     if (m_onsetdet) del_aubio_onset(m_onsetdet);
cannam@37: 
cannam@37:     m_onsetdet = new_aubio_onset
cannam@37:         (const_cast<char *>(getAubioNameForOnsetType(m_onsettype)),
cannam@37:          m_blockSize,
cannam@37:          m_stepSize,
cannam@37:          lrintf(m_inputSampleRate));
piem@148: 
cannam@37:     aubio_onset_set_threshold(m_onsetdet, m_threshold);
cannam@37:     aubio_onset_set_silence(m_onsetdet, m_silence);
cannam@37:     aubio_onset_set_minioi(m_onsetdet, m_minioi);
cannam@37: 
cannam@0: }
cannam@0: 
cannam@0: size_t
cannam@0: Onset::getPreferredStepSize() const
cannam@0: {
piem@148:     return 256;
cannam@0: }
cannam@0: 
cannam@0: size_t
cannam@0: Onset::getPreferredBlockSize() const
cannam@0: {
cannam@3:     return 2 * getPreferredStepSize();
cannam@0: }
cannam@0: 
cannam@0: Onset::ParameterList
cannam@0: Onset::getParameterDescriptors() const
cannam@0: {
cannam@0:     ParameterList list;
cannam@0:     
cannam@0:     ParameterDescriptor desc;
cannam@13:     desc.identifier = "onsettype";
cannam@13:     desc.name = "Onset Detection Function Type";
piem@64:     desc.description = "Type of onset detection function to use";
cannam@0:     desc.minValue = 0;
cannam@34:     desc.maxValue = 7;
piem@145:     desc.defaultValue = (int)OnsetDefault;
cannam@0:     desc.isQuantized = true;
cannam@0:     desc.quantizeStep = 1;
cannam@0:     desc.valueNames.push_back("Energy Based");
cannam@0:     desc.valueNames.push_back("Spectral Difference");
cannam@0:     desc.valueNames.push_back("High-Frequency Content");
cannam@0:     desc.valueNames.push_back("Complex Domain");
cannam@0:     desc.valueNames.push_back("Phase Deviation");
cannam@0:     desc.valueNames.push_back("Kullback-Liebler");
cannam@0:     desc.valueNames.push_back("Modified Kullback-Liebler");
cannam@34:     desc.valueNames.push_back("Spectral Flux");
piem@145:     desc.valueNames.push_back("Default");
cannam@0:     list.push_back(desc);
cannam@0: 
cannam@0:     desc = ParameterDescriptor();
cannam@13:     desc.identifier = "peakpickthreshold";
cannam@13:     desc.name = "Peak Picker Threshold";
piem@64:     desc.description = "Threshold used for peak picking, the higher the more detections";
cannam@0:     desc.minValue = 0;
cannam@0:     desc.maxValue = 1;
cannam@0:     desc.defaultValue = 0.3;
cannam@0:     desc.isQuantized = false;
cannam@0:     list.push_back(desc);
cannam@0: 
cannam@0:     desc = ParameterDescriptor();
cannam@13:     desc.identifier = "silencethreshold";
cannam@13:     desc.name = "Silence Threshold";
piem@64:     desc.description = "Silence threshold, the higher the least detection";
cannam@0:     desc.minValue = -120;
cannam@0:     desc.maxValue = 0;
piem@148:     desc.defaultValue = -90;
cannam@0:     desc.unit = "dB";
cannam@0:     desc.isQuantized = false;
cannam@0:     list.push_back(desc);
cannam@0: 
cannam@34:     desc = ParameterDescriptor();
cannam@34:     desc.identifier = "minioi";
cannam@34:     desc.name = "Minimum Inter-Onset Interval";
piem@64:     desc.description = "Time interval below which two consecutive onsets should be merged";
cannam@34:     desc.minValue = 0;
cannam@34:     desc.maxValue = 40;
cannam@34:     desc.defaultValue = 4;
cannam@34:     desc.unit = "ms";
cannam@34:     desc.isQuantized = true;
cannam@34:     desc.quantizeStep = 1;
cannam@34:     list.push_back(desc);
cannam@34: 
cannam@0:     return list;
cannam@0: }
cannam@0: 
cannam@0: float
cannam@0: Onset::getParameter(std::string param) const
cannam@0: {
cannam@0:     if (param == "onsettype") {
cannam@0:         return m_onsettype;
cannam@0:     } else if (param == "peakpickthreshold") {
piem@148:         if (m_onsetdet) {
piem@148:             return aubio_onset_get_threshold(m_onsetdet);
piem@148:         } else {
piem@148:             return m_threshold;
piem@148:         }
cannam@0:     } else if (param == "silencethreshold") {
piem@148:         if (m_onsetdet) {
piem@148:             return aubio_onset_get_silence(m_onsetdet);
piem@148:         } else {
piem@148:             return m_silence;
piem@148:         }
cannam@34:     } else if (param == "minioi") {
piem@148:         if (m_onsetdet) {
piem@148:             return aubio_onset_get_minioi(m_onsetdet);
piem@148:         } else {
piem@148:             return m_minioi;
piem@148:         }
cannam@0:     } else {
cannam@0:         return 0.0;
cannam@0:     }
cannam@0: }
cannam@0: 
cannam@0: void
cannam@0: Onset::setParameter(std::string param, float value)
cannam@0: {
cannam@0:     if (param == "onsettype") {
cannam@0:         switch (lrintf(value)) {
cannam@33:         case 0: m_onsettype = OnsetEnergy; break;
cannam@33:         case 1: m_onsettype = OnsetSpecDiff; break;
cannam@33:         case 2: m_onsettype = OnsetHFC; break;
cannam@33:         case 3: m_onsettype = OnsetComplex; break;
cannam@33:         case 4: m_onsettype = OnsetPhase; break;
cannam@33:         case 5: m_onsettype = OnsetKL; break;
cannam@33:         case 6: m_onsettype = OnsetMKL; break;
cannam@34:         case 7: m_onsettype = OnsetSpecFlux; break;
piem@148:         case 8: m_onsettype = OnsetDefault; break;
cannam@0:         }
piem@148:         if (!m_onsetdet) initialise(1, 256, 512);
cannam@0:     } else if (param == "peakpickthreshold") {
cannam@0:         m_threshold = value;
piem@148:         if (m_onsetdet)
piem@148:             aubio_onset_set_threshold(m_onsetdet, m_threshold);
cannam@0:     } else if (param == "silencethreshold") {
cannam@0:         m_silence = value;
piem@148:         if (m_onsetdet)
piem@148:             aubio_onset_set_silence(m_onsetdet, m_silence);
cannam@34:     } else if (param == "minioi") {
cannam@34:         m_minioi = value;
piem@148:         if (m_onsetdet)
piem@148:             aubio_onset_set_minioi(m_onsetdet, m_minioi);
cannam@0:     }
cannam@0: }
cannam@0: 
cannam@0: Onset::OutputList
cannam@0: Onset::getOutputDescriptors() const
cannam@0: {
cannam@0:     OutputList list;
cannam@0: 
cannam@0:     OutputDescriptor d;
cannam@13:     d.identifier = "onsets";
cannam@13:     d.name = "Onsets";
piem@64:     d.description = "List of times at which a note onset was detected";
cannam@0:     d.unit = "";
cannam@0:     d.hasFixedBinCount = true;
cannam@0:     d.binCount = 0;
cannam@3:     d.sampleType = OutputDescriptor::VariableSampleRate;
cannam@3:     d.sampleRate = 0;
cannam@0:     list.push_back(d);
cannam@0: 
piem@71:     d.identifier = "odf";
piem@71:     d.name = "Onset detection function";
piem@71:     d.description = "Output of the onset detection function";
piem@71:     d.binCount = 1;
piem@71:     d.isQuantized = true;
piem@71:     d.quantizeStep = 1.0;
piem@71:     d.sampleType = OutputDescriptor::OneSamplePerStep;
piem@71:     list.push_back(d);
piem@71: 
piem@71:     d.identifier = "todf";
piem@71:     d.name = "Thresholded Onset detection function";
piem@71:     d.description = "Output of the thresholded onset detection function";
piem@71:     d.binCount = 1;
piem@71:     d.isQuantized = true;
piem@71:     d.quantizeStep = 1.0;
piem@71:     d.sampleType = OutputDescriptor::OneSamplePerStep;
piem@71:     list.push_back(d);
piem@71: 
cannam@0:     return list;
cannam@0: }
cannam@0: 
cannam@0: Onset::FeatureSet
cannam@12: Onset::process(const float *const *inputBuffers,
piem@149:                UNUSED Vamp::RealTime timestamp)
cannam@0: {
cannam@0:     for (size_t i = 0; i < m_stepSize; ++i) {
piem@52:         fvec_set_sample(m_ibuf, inputBuffers[0][i], i);
cannam@0:     }
cannam@0: 
cannam@33:     aubio_onset_do(m_onsetdet, m_ibuf, m_onset);
cannam@0: 
piem@148:     smpl_t isonset = m_onset->data[0];
cannam@0: 
cannam@0:     FeatureSet returnFeatures;
cannam@0: 
cannam@0:     if (isonset) {
piem@148:         Feature onsettime;
piem@148:         onsettime.hasTimestamp = true;
piem@148:         onsettime.timestamp = Vamp::RealTime::fromSeconds(aubio_onset_get_last_s(m_onsetdet));
piem@148:         returnFeatures[0].push_back(onsettime);
cannam@0:     }
cannam@38: 
piem@71:     Feature odf;
piem@71:     odf.hasTimestamp = false;
piem@71:     odf.values.push_back(aubio_onset_get_descriptor(m_onsetdet));
piem@71:     returnFeatures[1].push_back(odf);
piem@71: 
piem@71:     Feature todf;
piem@71:     todf.hasTimestamp = false;
piem@71:     todf.values.push_back(aubio_onset_get_thresholded_descriptor(m_onsetdet));
piem@71:     returnFeatures[2].push_back(todf);
piem@71: 
cannam@0:     return returnFeatures;
cannam@0: }
cannam@0: 
cannam@0: Onset::FeatureSet
cannam@0: Onset::getRemainingFeatures()
cannam@0: {
cannam@0:     return FeatureSet();
cannam@0: }
cannam@0: