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:     
cannam@0:     This program is free software; you can redistribute it and/or
cannam@0:     modify it under the terms of the GNU General Public License as
cannam@0:     published by the Free Software Foundation; either version 2 of the
cannam@0:     License, or (at your option) any later version.  See the file
cannam@0:     COPYING included with this distribution for more information.
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_fftgrain(0),
cannam@0:     m_onset(0),
cannam@0:     m_pv(0),
cannam@0:     m_peakpick(0),
cannam@0:     m_onsetdet(0),
piem@2:     m_onsettype(aubio_onset_complex),
cannam@0:     m_threshold(0.3),
cannam@1:     m_silence(-90),
cannam@1:     m_channelCount(1)
cannam@0: {
cannam@0: }
cannam@0: 
cannam@0: Onset::~Onset()
cannam@0: {
cannam@0:     if (m_onsetdet) aubio_onsetdetection_free(m_onsetdet);
cannam@0:     if (m_ibuf) del_fvec(m_ibuf);
cannam@0:     if (m_onset) del_fvec(m_onset);
cannam@0:     if (m_fftgrain) del_cvec(m_fftgrain);
cannam@0:     if (m_pv) del_aubio_pvoc(m_pv);
cannam@0:     if (m_peakpick) del_aubio_peakpicker(m_peakpick);
cannam@0: }
cannam@0: 
cannam@0: string
cannam@0: Onset::getName() const
cannam@0: {
cannam@0:     return "aubioonset";
cannam@0: }
cannam@0: 
cannam@0: string
cannam@0: Onset::getDescription() const
cannam@0: {
cannam@0:     return "Aubio Onset Detector";
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@0:     return 1;
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@0:     m_channelCount = channels;
cannam@0:     m_stepSize = stepSize;
cannam@0:     m_blockSize = blockSize;
cannam@0: 
cannam@0:     m_ibuf = new_fvec(stepSize, channels);
cannam@0:     m_onset = new_fvec(1, channels);
piem@2:     m_fftgrain = new_cvec(blockSize, channels);
piem@2:     m_pv = new_aubio_pvoc(blockSize, stepSize, channels);
cannam@0:     m_peakpick = new_aubio_peakpicker(m_threshold);
cannam@0: 
piem@2:     m_onsetdet = new_aubio_onsetdetection(m_onsettype, blockSize, channels);
cannam@3:     
cannam@3:     m_delay = Vamp::RealTime::frame2RealTime(4 * stepSize,
cannam@3:                                              lrintf(m_inputSampleRate));
cannam@3: 
cannam@3:     m_lastOnset = Vamp::RealTime::zeroTime - m_delay - m_delay;
cannam@0: 
cannam@0:     return true;
cannam@0: }
cannam@0: 
cannam@0: void
cannam@0: Onset::reset()
cannam@0: {
cannam@0: }
cannam@0: 
cannam@0: size_t
cannam@0: Onset::getPreferredStepSize() const
cannam@0: {
piem@2:     return 512;
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@0:     desc.name = "onsettype";
cannam@0:     desc.description = "Onset Detection Function Type";
cannam@0:     desc.minValue = 0;
cannam@0:     desc.maxValue = 6;
piem@2:     desc.defaultValue = (int)aubio_onset_complex;
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@0:     list.push_back(desc);
cannam@0: 
cannam@0:     desc = ParameterDescriptor();
cannam@0:     desc.name = "peakpickthreshold";
cannam@0:     desc.description = "Peak Picker Threshold";
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@0:     desc.name = "silencethreshold";
cannam@0:     desc.description = "Silence Threshold";
cannam@0:     desc.minValue = -120;
cannam@0:     desc.maxValue = 0;
cannam@0:     desc.defaultValue = -90;
cannam@0:     desc.unit = "dB";
cannam@0:     desc.isQuantized = false;
cannam@0:     list.push_back(desc);
cannam@0: 
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") {
cannam@0:         return m_threshold;
cannam@0:     } else if (param == "silencethreshold") {
cannam@0:         return m_silence;
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@0:         case 0: m_onsettype = aubio_onset_energy; break;
cannam@0:         case 1: m_onsettype = aubio_onset_specdiff; break;
cannam@0:         case 2: m_onsettype = aubio_onset_hfc; break;
cannam@0:         case 3: m_onsettype = aubio_onset_complex; break;
cannam@0:         case 4: m_onsettype = aubio_onset_phase; break;
cannam@0:         case 5: m_onsettype = aubio_onset_kl; break;
cannam@0:         case 6: m_onsettype = aubio_onset_mkl; break;
cannam@0:         }
cannam@0:     } else if (param == "peakpickthreshold") {
cannam@0:         m_threshold = value;
cannam@0:     } else if (param == "silencethreshold") {
cannam@0:         m_silence = value;
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@0:     d.name = "onsets";
cannam@0:     d.unit = "";
cannam@0:     d.description = "Onsets";
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: 
cannam@1:     d = OutputDescriptor();
cannam@1:     d.name = "detectionfunction";
cannam@1:     d.unit = "";
cannam@1:     d.description = "Onset Detection Function";
cannam@1:     d.hasFixedBinCount = true;
cannam@1:     d.binCount = m_channelCount;
cannam@1:     d.hasKnownExtents = false;
cannam@1:     d.isQuantized = false;
cannam@1:     d.sampleType = OutputDescriptor::OneSamplePerStep;
cannam@1:     list.push_back(d);
cannam@1: 
cannam@0:     return list;
cannam@0: }
cannam@0: 
cannam@0: Onset::FeatureSet
cannam@12: Onset::process(const float *const *inputBuffers,
cannam@12:                Vamp::RealTime timestamp)
cannam@0: {
cannam@0:     for (size_t i = 0; i < m_stepSize; ++i) {
cannam@0:         for (size_t j = 0; j < m_channelCount; ++j) {
cannam@0:             fvec_write_sample(m_ibuf, inputBuffers[j][i], j, i);
cannam@0:         }
cannam@0:     }
cannam@0: 
cannam@0:     aubio_pvoc_do(m_pv, m_ibuf, m_fftgrain);
cannam@0:     aubio_onsetdetection(m_onsetdet, m_fftgrain, m_onset);
cannam@0: 
cannam@0:     bool isonset = aubio_peakpick_pimrt(m_onset, m_peakpick);
cannam@0: 
cannam@0:     if (isonset) {
cannam@0:         if (aubio_silence_detection(m_ibuf, m_silence)) {
cannam@0:             isonset = false;
cannam@0:         }
cannam@0:     }
cannam@0: 
cannam@0:     FeatureSet returnFeatures;
cannam@0: 
cannam@0:     if (isonset) {
cannam@3:         if (timestamp - m_lastOnset >= m_delay) {
cannam@3:             Feature onsettime;
cannam@3:             onsettime.hasTimestamp = true;
piem@5:             if (timestamp < m_delay) timestamp = m_delay;
cannam@3:             onsettime.timestamp = timestamp - m_delay;
cannam@3:             returnFeatures[0].push_back(onsettime);
cannam@3:             m_lastOnset = timestamp;
cannam@3:         }
cannam@0:     }
cannam@1:     Feature feature;
cannam@1:     for (size_t j = 0; j < m_channelCount; ++j) {
cannam@1:         feature.values.push_back(m_onset->data[j][0]);
cannam@1:     }
cannam@1:     returnFeatures[1].push_back(feature);
cannam@0: 
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: