Chris@1: Chris@1: Chris@1:
Chris@1: Chris@3: Chris@1:
Chris@1: VampPluginSDK
Chris@3: 2.4
Chris@1:
Chris@1:
Chris@1: |
Chris@1:
Chris@1:
Chris@1:
Chris@1:
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ Chris@1: 00002 Chris@1: 00003 /* Chris@1: 00004 Vamp Chris@1: 00005 Chris@1: 00006 An API for audio analysis and feature extraction plugins. Chris@1: 00007 Chris@1: 00008 Centre for Digital Music, Queen Mary, University of London. Chris@1: 00009 Copyright 2006 Chris Cannam. Chris@1: 00010 Chris@1: 00011 Permission is hereby granted, free of charge, to any person Chris@1: 00012 obtaining a copy of this software and associated documentation Chris@1: 00013 files (the "Software"), to deal in the Software without Chris@1: 00014 restriction, including without limitation the rights to use, copy, Chris@1: 00015 modify, merge, publish, distribute, sublicense, and/or sell copies Chris@1: 00016 of the Software, and to permit persons to whom the Software is Chris@1: 00017 furnished to do so, subject to the following conditions: Chris@1: 00018 Chris@1: 00019 The above copyright notice and this permission notice shall be Chris@1: 00020 included in all copies or substantial portions of the Software. Chris@1: 00021 Chris@1: 00022 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, Chris@1: 00023 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF Chris@1: 00024 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND Chris@1: 00025 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR Chris@1: 00026 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF Chris@1: 00027 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION Chris@1: 00028 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Chris@1: 00029 Chris@1: 00030 Except as contained in this notice, the names of the Centre for Chris@1: 00031 Digital Music; Queen Mary, University of London; and Chris Cannam Chris@1: 00032 shall not be used in advertising or otherwise to promote the sale, Chris@1: 00033 use or other dealings in this Software without prior written Chris@1: 00034 authorization. Chris@1: 00035 */ Chris@1: 00036 Chris@1: 00037 #include "PercussionOnsetDetector.h" Chris@1: 00038 Chris@1: 00039 using std::string; Chris@1: 00040 using std::vector; Chris@1: 00041 using std::cerr; Chris@1: 00042 using std::endl; Chris@1: 00043 Chris@1: 00044 #include <cmath> Chris@1: 00045 Chris@1: 00046 Chris@1: 00047 PercussionOnsetDetector::PercussionOnsetDetector(float inputSampleRate) : Chris@1: 00048 Plugin(inputSampleRate), Chris@1: 00049 m_stepSize(0), Chris@1: 00050 m_blockSize(0), Chris@1: 00051 m_threshold(3), Chris@1: 00052 m_sensitivity(40), Chris@1: 00053 m_priorMagnitudes(0), Chris@1: 00054 m_dfMinus1(0), Chris@1: 00055 m_dfMinus2(0) Chris@1: 00056 { Chris@1: 00057 } Chris@1: 00058 Chris@1: 00059 PercussionOnsetDetector::~PercussionOnsetDetector() Chris@1: 00060 { Chris@1: 00061 delete[] m_priorMagnitudes; Chris@1: 00062 } Chris@1: 00063 Chris@1: 00064 string Chris@1: 00065 PercussionOnsetDetector::getIdentifier() const Chris@1: 00066 { Chris@1: 00067 return "percussiononsets"; Chris@1: 00068 } Chris@1: 00069 Chris@1: 00070 string Chris@1: 00071 PercussionOnsetDetector::getName() const Chris@1: 00072 { Chris@1: 00073 return "Simple Percussion Onset Detector"; Chris@1: 00074 } Chris@1: 00075 Chris@1: 00076 string Chris@1: 00077 PercussionOnsetDetector::getDescription() const Chris@1: 00078 { Chris@1: 00079 return "Detect percussive note onsets by identifying broadband energy rises"; Chris@1: 00080 } Chris@1: 00081 Chris@1: 00082 string Chris@1: 00083 PercussionOnsetDetector::getMaker() const Chris@1: 00084 { Chris@1: 00085 return "Vamp SDK Example Plugins"; Chris@1: 00086 } Chris@1: 00087 Chris@1: 00088 int Chris@1: 00089 PercussionOnsetDetector::getPluginVersion() const Chris@1: 00090 { Chris@1: 00091 return 2; Chris@1: 00092 } Chris@1: 00093 Chris@1: 00094 string Chris@1: 00095 PercussionOnsetDetector::getCopyright() const Chris@1: 00096 { Chris@1: 00097 return "Code copyright 2006 Queen Mary, University of London, after Dan Barry et al 2005. Freely redistributable (BSD license)"; Chris@1: 00098 } Chris@1: 00099 Chris@1: 00100 size_t Chris@1: 00101 PercussionOnsetDetector::getPreferredStepSize() const Chris@1: 00102 { Chris@1: 00103 return 0; Chris@1: 00104 } Chris@1: 00105 Chris@1: 00106 size_t Chris@1: 00107 PercussionOnsetDetector::getPreferredBlockSize() const Chris@1: 00108 { Chris@1: 00109 return 1024; Chris@1: 00110 } Chris@1: 00111 Chris@1: 00112 bool Chris@1: 00113 PercussionOnsetDetector::initialise(size_t channels, size_t stepSize, size_t blockSize) Chris@1: 00114 { Chris@1: 00115 if (channels < getMinChannelCount() || Chris@1: 00116 channels > getMaxChannelCount()) return false; Chris@1: 00117 Chris@1: 00118 m_stepSize = stepSize; Chris@1: 00119 m_blockSize = blockSize; Chris@1: 00120 Chris@1: 00121 m_priorMagnitudes = new float[m_blockSize/2]; Chris@1: 00122 Chris@1: 00123 for (size_t i = 0; i < m_blockSize/2; ++i) { Chris@1: 00124 m_priorMagnitudes[i] = 0.f; Chris@1: 00125 } Chris@1: 00126 Chris@1: 00127 m_dfMinus1 = 0.f; Chris@1: 00128 m_dfMinus2 = 0.f; Chris@1: 00129 Chris@1: 00130 return true; Chris@1: 00131 } Chris@1: 00132 Chris@1: 00133 void Chris@1: 00134 PercussionOnsetDetector::reset() Chris@1: 00135 { Chris@1: 00136 for (size_t i = 0; i < m_blockSize/2; ++i) { Chris@1: 00137 m_priorMagnitudes[i] = 0.f; Chris@1: 00138 } Chris@1: 00139 Chris@1: 00140 m_dfMinus1 = 0.f; Chris@1: 00141 m_dfMinus2 = 0.f; Chris@1: 00142 } Chris@1: 00143 Chris@1: 00144 PercussionOnsetDetector::ParameterList Chris@1: 00145 PercussionOnsetDetector::getParameterDescriptors() const Chris@1: 00146 { Chris@1: 00147 ParameterList list; Chris@1: 00148 Chris@1: 00149 ParameterDescriptor d; Chris@1: 00150 d.identifier = "threshold"; Chris@1: 00151 d.name = "Energy rise threshold"; Chris@1: 00152 d.description = "Energy rise within a frequency bin necessary to count toward broadband total"; Chris@1: 00153 d.unit = "dB"; Chris@1: 00154 d.minValue = 0; Chris@1: 00155 d.maxValue = 20; Chris@1: 00156 d.defaultValue = 3; Chris@1: 00157 d.isQuantized = false; Chris@1: 00158 list.push_back(d); Chris@1: 00159 Chris@1: 00160 d.identifier = "sensitivity"; Chris@1: 00161 d.name = "Sensitivity"; Chris@1: 00162 d.description = "Sensitivity of peak detector applied to broadband detection function"; Chris@1: 00163 d.unit = "%"; Chris@1: 00164 d.minValue = 0; Chris@1: 00165 d.maxValue = 100; Chris@1: 00166 d.defaultValue = 40; Chris@1: 00167 d.isQuantized = false; Chris@1: 00168 list.push_back(d); Chris@1: 00169 Chris@1: 00170 return list; Chris@1: 00171 } Chris@1: 00172 Chris@1: 00173 float Chris@1: 00174 PercussionOnsetDetector::getParameter(std::string id) const Chris@1: 00175 { Chris@1: 00176 if (id == "threshold") return m_threshold; Chris@1: 00177 if (id == "sensitivity") return m_sensitivity; Chris@1: 00178 return 0.f; Chris@1: 00179 } Chris@1: 00180 Chris@1: 00181 void Chris@1: 00182 PercussionOnsetDetector::setParameter(std::string id, float value) Chris@1: 00183 { Chris@1: 00184 if (id == "threshold") { Chris@1: 00185 if (value < 0) value = 0; Chris@1: 00186 if (value > 20) value = 20; Chris@1: 00187 m_threshold = value; Chris@1: 00188 } else if (id == "sensitivity") { Chris@1: 00189 if (value < 0) value = 0; Chris@1: 00190 if (value > 100) value = 100; Chris@1: 00191 m_sensitivity = value; Chris@1: 00192 } Chris@1: 00193 } Chris@1: 00194 Chris@1: 00195 PercussionOnsetDetector::OutputList Chris@1: 00196 PercussionOnsetDetector::getOutputDescriptors() const Chris@1: 00197 { Chris@1: 00198 OutputList list; Chris@1: 00199 Chris@1: 00200 OutputDescriptor d; Chris@1: 00201 d.identifier = "onsets"; Chris@1: 00202 d.name = "Onsets"; Chris@1: 00203 d.description = "Percussive note onset locations"; Chris@1: 00204 d.unit = ""; Chris@1: 00205 d.hasFixedBinCount = true; Chris@1: 00206 d.binCount = 0; Chris@1: 00207 d.hasKnownExtents = false; Chris@1: 00208 d.isQuantized = false; Chris@1: 00209 d.sampleType = OutputDescriptor::VariableSampleRate; Chris@1: 00210 d.sampleRate = m_inputSampleRate; Chris@1: 00211 list.push_back(d); Chris@1: 00212 Chris@1: 00213 d.identifier = "detectionfunction"; Chris@1: 00214 d.name = "Detection Function"; Chris@1: 00215 d.description = "Broadband energy rise detection function"; Chris@1: 00216 d.binCount = 1; Chris@1: 00217 d.isQuantized = true; Chris@1: 00218 d.quantizeStep = 1.0; Chris@1: 00219 d.sampleType = OutputDescriptor::OneSamplePerStep; Chris@1: 00220 list.push_back(d); Chris@1: 00221 Chris@1: 00222 return list; Chris@1: 00223 } Chris@1: 00224 Chris@1: 00225 PercussionOnsetDetector::FeatureSet Chris@1: 00226 PercussionOnsetDetector::process(const float *const *inputBuffers, Chris@1: 00227 Vamp::RealTime ts) Chris@1: 00228 { Chris@1: 00229 if (m_stepSize == 0) { Chris@1: 00230 cerr << "ERROR: PercussionOnsetDetector::process: " Chris@1: 00231 << "PercussionOnsetDetector has not been initialised" Chris@1: 00232 << endl; Chris@1: 00233 return FeatureSet(); Chris@1: 00234 } Chris@1: 00235 Chris@1: 00236 int count = 0; Chris@1: 00237 Chris@1: 00238 for (size_t i = 1; i < m_blockSize/2; ++i) { Chris@1: 00239 Chris@1: 00240 float real = inputBuffers[0][i*2]; Chris@1: 00241 float imag = inputBuffers[0][i*2 + 1]; Chris@1: 00242 Chris@1: 00243 float sqrmag = real * real + imag * imag; Chris@1: 00244 Chris@1: 00245 if (m_priorMagnitudes[i] > 0.f) { Chris@1: 00246 float diff = 10.f * log10f(sqrmag / m_priorMagnitudes[i]); Chris@1: 00247 Chris@1: 00248 // std::cout << "i=" << i << ", sqrmag=" << sqrmag << ", prior=" << m_priorMagnitudes[i] << ", diff=" << diff << ", threshold=" << m_threshold << " " << (diff >= m_threshold ? "[*]" : "") << std::endl; Chris@1: 00249 Chris@1: 00250 if (diff >= m_threshold) ++count; Chris@1: 00251 } Chris@1: 00252 Chris@1: 00253 m_priorMagnitudes[i] = sqrmag; Chris@1: 00254 } Chris@1: 00255 Chris@1: 00256 FeatureSet returnFeatures; Chris@1: 00257 Chris@1: 00258 Feature detectionFunction; Chris@1: 00259 detectionFunction.hasTimestamp = false; Chris@1: 00260 detectionFunction.values.push_back(count); Chris@1: 00261 returnFeatures[1].push_back(detectionFunction); Chris@1: 00262 Chris@1: 00263 if (m_dfMinus2 < m_dfMinus1 && Chris@1: 00264 m_dfMinus1 >= count && Chris@1: 00265 m_dfMinus1 > ((100 - m_sensitivity) * m_blockSize) / 200) { Chris@1: 00266 Chris@1: 00267 //std::cout << "result at " << ts << "! (count == " << count << ", prev == " << m_dfMinus1 << ")" << std::endl; Chris@1: 00268 Chris@1: 00269 Feature onset; Chris@1: 00270 onset.hasTimestamp = true; Chris@1: 00271 onset.timestamp = ts - Vamp::RealTime::frame2RealTime Chris@1: 00272 (m_stepSize, int(m_inputSampleRate + 0.5)); Chris@1: 00273 returnFeatures[0].push_back(onset); Chris@1: 00274 } Chris@1: 00275 Chris@1: 00276 m_dfMinus2 = m_dfMinus1; Chris@1: 00277 m_dfMinus1 = count; Chris@1: 00278 Chris@1: 00279 return returnFeatures; Chris@1: 00280 } Chris@1: 00281 Chris@1: 00282 PercussionOnsetDetector::FeatureSet Chris@1: 00283 PercussionOnsetDetector::getRemainingFeatures() Chris@1: 00284 { Chris@1: 00285 return FeatureSet(); Chris@1: 00286 } Chris@1: 00287 Chris@3: