annotate examples/SpectralCentroid.cpp @ 190:1982246a3902

* Provide PluginWrapper method for getting hold of a nested wrapper directly (a bit gross, but useful) * Use the above to enable the simple host to adjust timestamps appropriately when printing out results from input domain adapter wrapped plugins
author cannam
date Wed, 17 Sep 2008 13:16:09 +0000
parents aa64a46320d4
children a5187dad96cd
rev   line source
cannam@0 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
cannam@0 2
cannam@0 3 /*
cannam@0 4 Vamp
cannam@0 5
cannam@0 6 An API for audio analysis and feature extraction plugins.
cannam@0 7
cannam@0 8 Centre for Digital Music, Queen Mary, University of London.
cannam@0 9 Copyright 2006 Chris Cannam.
cannam@0 10
cannam@0 11 Permission is hereby granted, free of charge, to any person
cannam@0 12 obtaining a copy of this software and associated documentation
cannam@0 13 files (the "Software"), to deal in the Software without
cannam@0 14 restriction, including without limitation the rights to use, copy,
cannam@0 15 modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@0 16 of the Software, and to permit persons to whom the Software is
cannam@0 17 furnished to do so, subject to the following conditions:
cannam@0 18
cannam@0 19 The above copyright notice and this permission notice shall be
cannam@0 20 included in all copies or substantial portions of the Software.
cannam@0 21
cannam@0 22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@0 23 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@0 24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@6 25 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@0 26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@0 27 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@0 28 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@0 29
cannam@0 30 Except as contained in this notice, the names of the Centre for
cannam@0 31 Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@0 32 shall not be used in advertising or otherwise to promote the sale,
cannam@0 33 use or other dealings in this Software without prior written
cannam@0 34 authorization.
cannam@0 35 */
cannam@0 36
cannam@0 37 #include "SpectralCentroid.h"
cannam@0 38
cannam@0 39 using std::string;
cannam@0 40 using std::vector;
cannam@0 41 using std::cerr;
cannam@0 42 using std::endl;
cannam@0 43
cannam@7 44 #include <cmath>
cannam@7 45
cannam@0 46
cannam@0 47 SpectralCentroid::SpectralCentroid(float inputSampleRate) :
cannam@0 48 Plugin(inputSampleRate),
cannam@0 49 m_stepSize(0),
cannam@21 50 m_blockSize(0)
cannam@0 51 {
cannam@0 52 }
cannam@0 53
cannam@0 54 SpectralCentroid::~SpectralCentroid()
cannam@0 55 {
cannam@0 56 }
cannam@0 57
cannam@0 58 string
cannam@49 59 SpectralCentroid::getIdentifier() const
cannam@0 60 {
cannam@0 61 return "spectralcentroid";
cannam@0 62 }
cannam@0 63
cannam@0 64 string
cannam@49 65 SpectralCentroid::getName() const
cannam@49 66 {
cannam@49 67 return "Spectral Centroid";
cannam@49 68 }
cannam@49 69
cannam@49 70 string
cannam@0 71 SpectralCentroid::getDescription() const
cannam@0 72 {
cannam@49 73 return "Calculate the centroid frequency of the spectrum of the input signal";
cannam@0 74 }
cannam@0 75
cannam@0 76 string
cannam@0 77 SpectralCentroid::getMaker() const
cannam@0 78 {
cannam@43 79 return "Vamp SDK Example Plugins";
cannam@0 80 }
cannam@0 81
cannam@0 82 int
cannam@0 83 SpectralCentroid::getPluginVersion() const
cannam@0 84 {
cannam@0 85 return 2;
cannam@0 86 }
cannam@0 87
cannam@0 88 string
cannam@0 89 SpectralCentroid::getCopyright() const
cannam@0 90 {
cannam@7 91 return "Freely redistributable (BSD license)";
cannam@0 92 }
cannam@0 93
cannam@0 94 bool
cannam@0 95 SpectralCentroid::initialise(size_t channels, size_t stepSize, size_t blockSize)
cannam@0 96 {
cannam@0 97 if (channels < getMinChannelCount() ||
cannam@0 98 channels > getMaxChannelCount()) return false;
cannam@0 99
cannam@0 100 m_stepSize = stepSize;
cannam@0 101 m_blockSize = blockSize;
cannam@0 102
cannam@0 103 return true;
cannam@0 104 }
cannam@0 105
cannam@0 106 void
cannam@0 107 SpectralCentroid::reset()
cannam@0 108 {
cannam@0 109 }
cannam@0 110
cannam@0 111 SpectralCentroid::OutputList
cannam@0 112 SpectralCentroid::getOutputDescriptors() const
cannam@0 113 {
cannam@0 114 OutputList list;
cannam@0 115
cannam@0 116 OutputDescriptor d;
cannam@49 117 d.identifier = "logcentroid";
cannam@49 118 d.name = "Log Frequency Centroid";
cannam@49 119 d.description = "Centroid of the log weighted frequency spectrum";
cannam@0 120 d.unit = "Hz";
cannam@9 121 d.hasFixedBinCount = true;
cannam@9 122 d.binCount = 1;
cannam@0 123 d.hasKnownExtents = false;
cannam@0 124 d.isQuantized = false;
cannam@0 125 d.sampleType = OutputDescriptor::OneSamplePerStep;
cannam@0 126 list.push_back(d);
cannam@0 127
cannam@49 128 d.identifier = "linearcentroid";
cannam@49 129 d.name = "Linear Frequency Centroid";
cannam@49 130 d.description = "Centroid of the linear frequency spectrum";
cannam@0 131 list.push_back(d);
cannam@0 132
cannam@0 133 return list;
cannam@0 134 }
cannam@0 135
cannam@190 136 //static int scount = 0;
cannam@190 137
cannam@0 138 SpectralCentroid::FeatureSet
cannam@190 139 SpectralCentroid::process(const float *const *inputBuffers, Vamp::RealTime timestamp)
cannam@0 140 {
cannam@0 141 if (m_stepSize == 0) {
cannam@0 142 cerr << "ERROR: SpectralCentroid::process: "
cannam@0 143 << "SpectralCentroid has not been initialised"
cannam@0 144 << endl;
cannam@0 145 return FeatureSet();
cannam@0 146 }
cannam@0 147
cannam@190 148 // std::cerr << "SpectralCentroid::process: count = " << scount++ << ", timestamp = " << timestamp << ", total power = ";
cannam@190 149
cannam@0 150 double numLin = 0.0, numLog = 0.0, denom = 0.0;
cannam@0 151
cannam@47 152 for (size_t i = 1; i <= m_blockSize/2; ++i) {
cannam@0 153 double freq = (double(i) * m_inputSampleRate) / m_blockSize;
cannam@0 154 double real = inputBuffers[0][i*2];
cannam@0 155 double imag = inputBuffers[0][i*2 + 1];
cannam@0 156 double power = sqrt(real * real + imag * imag) / (m_blockSize/2);
cannam@0 157 numLin += freq * power;
cannam@0 158 numLog += log10f(freq) * power;
cannam@0 159 denom += power;
cannam@0 160 }
cannam@0 161
cannam@190 162 // std::cerr << denom << std::endl;
cannam@190 163
cannam@0 164 FeatureSet returnFeatures;
cannam@0 165
cannam@0 166 if (denom != 0.0) {
cannam@0 167 float centroidLin = float(numLin / denom);
cannam@19 168 float centroidLog = powf(10, float(numLog / denom));
cannam@47 169
cannam@0 170 Feature feature;
cannam@0 171 feature.hasTimestamp = false;
cannam@48 172 if (!std::isnan(centroidLog) && !std::isinf(centroidLog)) {
cannam@47 173 feature.values.push_back(centroidLog);
cannam@47 174 }
cannam@0 175 returnFeatures[0].push_back(feature);
cannam@47 176
cannam@0 177 feature.values.clear();
cannam@48 178 if (!std::isnan(centroidLin) && !std::isinf(centroidLin)) {
cannam@47 179 feature.values.push_back(centroidLin);
cannam@47 180 }
cannam@0 181 returnFeatures[1].push_back(feature);
cannam@0 182 }
cannam@0 183
cannam@0 184 return returnFeatures;
cannam@0 185 }
cannam@0 186
cannam@0 187 SpectralCentroid::FeatureSet
cannam@0 188 SpectralCentroid::getRemainingFeatures()
cannam@0 189 {
cannam@0 190 return FeatureSet();
cannam@0 191 }
cannam@0 192