plugins/Tempo.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 <math.h>
  18 #include "Tempo.h"
  19
  20 using std::string;
  21 using std::vector;
  22 using std::cerr;
  23 using std::endl;
  24
  25 Tempo::Tempo(float inputSampleRate) :
  26     Plugin(inputSampleRate),
  27     m_ibuf(0),
  28     m_beat(0),
  29     m_bpm(0),
  30     m_onsettype(OnsetComplex),
  31     m_tempo(0),
  32     m_threshold(0.3),
  33     m_silence(-70)
  34 {
  35 }
  36
  37 Tempo::~Tempo()
  38 {
  39     if (m_ibuf) del_fvec(m_ibuf);
  40     if (m_beat) del_fvec(m_beat);
  41     if (m_tempo) del_aubio_tempo(m_tempo);
  42 }
  43
  44 string
  45 Tempo::getIdentifier() const
  46 {
  47     return "aubiotempo";
  48 }
  49
  50 string
  51 Tempo::getName() const
  52 {
  53     return "Aubio Beat Tracker";
  54 }
  55
  56 string
  57 Tempo::getDescription() const
  58 {
  59     return "Estimate the musical tempo and track beat positions";
  60 }
  61
  62 string
  63 Tempo::getMaker() const
  64 {
  65     return "Paul Brossier (method by Matthew Davies, plugin by Chris Cannam)";
  66 }
  67
  68 int
  69 Tempo::getPluginVersion() const
  70 {
  71     return 2;
  72 }
  73
  74 string
  75 Tempo::getCopyright() const
  76 {
  77     return "GPL";
  78 }
  79
  80 bool
  81 Tempo::initialise(size_t channels, size_t stepSize, size_t blockSize)
  82 {
  83     if (channels != 1) {
  84         std::cerr << "Tempo::initialise: channels must be 1" << std::endl;
  85         return false;
  86     }
  87
  88     m_stepSize = stepSize;
  89     m_blockSize = blockSize;
  90
  91     m_ibuf = new_fvec(stepSize);
  92     m_beat = new_fvec(2);
  93
  94     m_delay = Vamp::RealTime::frame2RealTime(3 * stepSize,
  95                                              lrintf(m_inputSampleRate));
  96
  97     m_lastBeat = Vamp::RealTime::zeroTime - m_delay - m_delay;
  98
  99     m_tempo = new_aubio_tempo
 100         (const_cast<char *>(getAubioNameForOnsetType(m_onsettype)),
 101          blockSize,
 102          stepSize,
 103          lrintf(m_inputSampleRate));
 104
 105     aubio_tempo_set_silence(m_tempo, m_silence);
 106     aubio_tempo_set_threshold(m_tempo, m_threshold);
 107
 108     return true;
 109 }
 110
 111 void
 112 Tempo::reset()
 113 {
 114 }
 115
 116 size_t
 117 Tempo::getPreferredStepSize() const
 118 {
 119     return 512;
 120 }
 121
 122 size_t
 123 Tempo::getPreferredBlockSize() const
 124 {
 125     return 2 * getPreferredStepSize();
 126 }
 127
 128 Tempo::ParameterList
 129 Tempo::getParameterDescriptors() const
 130 {
 131     ParameterList list;
 132
 133     ParameterDescriptor desc;
 134     desc.identifier = "onsettype";
 135     desc.name = "Onset Detection Function Type";
 136     desc.minValue = 0;
 137     desc.maxValue = 7;
 138     desc.defaultValue = (int)OnsetComplex;
 139     desc.isQuantized = true;
 140     desc.quantizeStep = 1;
 141     desc.valueNames.push_back("Energy Based");
 142     desc.valueNames.push_back("Spectral Difference");
 143     desc.valueNames.push_back("High-Frequency Content");
 144     desc.valueNames.push_back("Complex Domain");
 145     desc.valueNames.push_back("Phase Deviation");
 146     desc.valueNames.push_back("Kullback-Liebler");
 147     desc.valueNames.push_back("Modified Kullback-Liebler");
 148     desc.valueNames.push_back("Spectral Flux");
 149     list.push_back(desc);
 150
 151     desc = ParameterDescriptor();
 152     desc.identifier = "peakpickthreshold";
 153     desc.name = "Peak Picker Threshold";
 154     desc.minValue = 0;
 155     desc.maxValue = 1;
 156     desc.defaultValue = 0.3;
 157     desc.isQuantized = false;
 158     list.push_back(desc);
 159
 160     desc = ParameterDescriptor();
 161     desc.identifier = "silencethreshold";
 162     desc.name = "Silence Threshold";
 163     desc.minValue = -120;
 164     desc.maxValue = 0;
 165     desc.defaultValue = -70;
 166     desc.unit = "dB";
 167     desc.isQuantized = false;
 168     list.push_back(desc);
 169
 170     return list;
 171 }
 172
 173 float
 174 Tempo::getParameter(std::string param) const
 175 {
 176     if (param == "onsettype") {
 177         return m_onsettype;
 178     } else if (param == "peakpickthreshold") {
 179         return m_threshold;
 180     } else if (param == "silencethreshold") {
 181         return m_silence;
 182     } else {
 183         return 0.0;
 184     }
 185 }
 186
 187 void
 188 Tempo::setParameter(std::string param, float value)
 189 {
 190     if (param == "onsettype") {
 191         switch (lrintf(value)) {
 192         case 0: m_onsettype = OnsetEnergy; break;
 193         case 1: m_onsettype = OnsetSpecDiff; break;
 194         case 2: m_onsettype = OnsetHFC; break;
 195         case 3: m_onsettype = OnsetComplex; break;
 196         case 4: m_onsettype = OnsetPhase; break;
 197         case 5: m_onsettype = OnsetKL; break;
 198         case 6: m_onsettype = OnsetMKL; break;
 199         case 7: m_onsettype = OnsetSpecFlux; break;
 200         }
 201     } else if (param == "peakpickthreshold") {
 202         m_threshold = value;
 203     } else if (param == "silencethreshold") {
 204         m_silence = value;
 205     }
 206 }
 207
 208 Tempo::OutputList
 209 Tempo::getOutputDescriptors() const
 210 {
 211     OutputList list;
 212
 213     OutputDescriptor d;
 214     d.identifier = "beats";
 215     d.name = "Beats";
 216     d.unit = "";
 217     d.hasFixedBinCount = true;
 218     d.binCount = 0;
 219     d.sampleType = OutputDescriptor::VariableSampleRate;
 220     d.sampleRate = 0;
 221     list.push_back(d);
 222
 223     d.identifier = "tempo";
 224     d.name = "Tempo";
 225     d.unit = "bpm";
 226     d.hasFixedBinCount = true;
 227     d.binCount = 1;
 228     d.hasKnownExtents = false;
 229     d.isQuantized = false;
 230     d.sampleType = OutputDescriptor::OneSamplePerStep;
 231     list.push_back(d);
 232
 233     return list;
 234 }
 235
 236 Tempo::FeatureSet
 237 Tempo::process(const float *const *inputBuffers, Vamp::RealTime timestamp)
 238 {
 239     for (size_t i = 0; i < m_stepSize; ++i) {
 240         fvec_write_sample(m_ibuf, inputBuffers[0][i], i);
 241     }
 242
 243     aubio_tempo_do(m_tempo, m_ibuf, m_beat);
 244
 245     bool istactus = m_beat->data[0];
 246
 247     m_bpm = aubio_tempo_get_bpm(m_tempo);
 248
 249     FeatureSet returnFeatures;
 250
 251     if (istactus == true) {
 252         if (timestamp - m_lastBeat >= m_delay) {
 253             Feature onsettime;
 254             onsettime.hasTimestamp = true;
 255             if (timestamp < m_delay) timestamp = m_delay;
 256             onsettime.timestamp = timestamp - m_delay;
 257             returnFeatures[0].push_back(onsettime);
 258             m_lastBeat = timestamp;
 259         }
 260     }
 261
 262     if (m_bpm >= 30 && m_bpm <= 206) {
 263         Feature tempo;
 264         tempo.hasTimestamp = false;
 265         tempo.values.push_back(m_bpm);
 266         returnFeatures[1].push_back(tempo);
 267     }
 268
 269     return returnFeatures;
 270 }
 271
 272 Tempo::FeatureSet
 273 Tempo::getRemainingFeatures()
 274 {
 275     return FeatureSet();
 276 }
 277