VampPluginSDK: SpectralCentroid.cpp Source File

00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@0: 00002 
cannam@0: 00003 /*
cannam@0: 00004     Vamp
cannam@0: 00005 
cannam@0: 00006     An API for audio analysis and feature extraction plugins.
cannam@0: 00007 
cannam@0: 00008     Centre for Digital Music, Queen Mary, University of London.
cannam@0: 00009     Copyright 2006 Chris Cannam.
cannam@0: 00010   
cannam@0: 00011     Permission is hereby granted, free of charge, to any person
cannam@0: 00012     obtaining a copy of this software and associated documentation
cannam@0: 00013     files (the "Software"), to deal in the Software without
cannam@0: 00014     restriction, including without limitation the rights to use, copy,
cannam@0: 00015     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@0: 00016     of the Software, and to permit persons to whom the Software is
cannam@0: 00017     furnished to do so, subject to the following conditions:
cannam@0: 00018 
cannam@0: 00019     The above copyright notice and this permission notice shall be
cannam@0: 00020     included in all copies or substantial portions of the Software.
cannam@0: 00021 
cannam@0: 00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@0: 00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@0: 00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@0: 00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@0: 00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@0: 00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@0: 00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@0: 00029 
cannam@0: 00030     Except as contained in this notice, the names of the Centre for
cannam@0: 00031     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@0: 00032     shall not be used in advertising or otherwise to promote the sale,
cannam@0: 00033     use or other dealings in this Software without prior written
cannam@0: 00034     authorization.
cannam@0: 00035 */
cannam@0: 00036 
cannam@0: 00037 #include "SpectralCentroid.h"
cannam@0: 00038 
cannam@0: 00039 using std::string;
cannam@0: 00040 using std::vector;
cannam@0: 00041 using std::cerr;
cannam@0: 00042 using std::endl;
cannam@0: 00043 
cannam@0: 00044 #include <cmath>
cannam@0: 00045 
cannam@0: 00046 
cannam@0: 00047 SpectralCentroid::SpectralCentroid(float inputSampleRate) :
cannam@0: 00048     Plugin(inputSampleRate),
cannam@0: 00049     m_stepSize(0),
cannam@0: 00050     m_blockSize(0)
cannam@0: 00051 {
cannam@0: 00052 }
cannam@0: 00053 
cannam@0: 00054 SpectralCentroid::~SpectralCentroid()
cannam@0: 00055 {
cannam@0: 00056 }
cannam@0: 00057 
cannam@0: 00058 string
cannam@0: 00059 SpectralCentroid::getIdentifier() const
cannam@0: 00060 {
cannam@0: 00061     return "spectralcentroid";
cannam@0: 00062 }
cannam@0: 00063 
cannam@0: 00064 string
cannam@0: 00065 SpectralCentroid::getName() const
cannam@0: 00066 {
cannam@0: 00067     return "Spectral Centroid";
cannam@0: 00068 }
cannam@0: 00069 
cannam@0: 00070 string
cannam@0: 00071 SpectralCentroid::getDescription() const
cannam@0: 00072 {
cannam@0: 00073     return "Calculate the centroid frequency of the spectrum of the input signal";
cannam@0: 00074 }
cannam@0: 00075 
cannam@0: 00076 string
cannam@0: 00077 SpectralCentroid::getMaker() const
cannam@0: 00078 {
cannam@0: 00079     return "Vamp SDK Example Plugins";
cannam@0: 00080 }
cannam@0: 00081 
cannam@0: 00082 int
cannam@0: 00083 SpectralCentroid::getPluginVersion() const
cannam@0: 00084 {
cannam@0: 00085     return 2;
cannam@0: 00086 }
cannam@0: 00087 
cannam@0: 00088 string
cannam@0: 00089 SpectralCentroid::getCopyright() const
cannam@0: 00090 {
cannam@0: 00091     return "Freely redistributable (BSD license)";
cannam@0: 00092 }
cannam@0: 00093 
cannam@0: 00094 bool
cannam@0: 00095 SpectralCentroid::initialise(size_t channels, size_t stepSize, size_t blockSize)
cannam@0: 00096 {
cannam@0: 00097     if (channels < getMinChannelCount() ||
cannam@0: 00098         channels > getMaxChannelCount()) return false;
cannam@0: 00099 
cannam@0: 00100     m_stepSize = stepSize;
cannam@0: 00101     m_blockSize = blockSize;
cannam@0: 00102 
cannam@0: 00103     return true;
cannam@0: 00104 }
cannam@0: 00105 
cannam@0: 00106 void
cannam@0: 00107 SpectralCentroid::reset()
cannam@0: 00108 {
cannam@0: 00109 }
cannam@0: 00110 
cannam@0: 00111 SpectralCentroid::OutputList
cannam@0: 00112 SpectralCentroid::getOutputDescriptors() const
cannam@0: 00113 {
cannam@0: 00114     OutputList list;
cannam@0: 00115 
cannam@0: 00116     OutputDescriptor d;
cannam@0: 00117     d.identifier = "logcentroid";
cannam@0: 00118     d.name = "Log Frequency Centroid";
cannam@0: 00119     d.description = "Centroid of the log weighted frequency spectrum";
cannam@0: 00120     d.unit = "Hz";
cannam@0: 00121     d.hasFixedBinCount = true;
cannam@0: 00122     d.binCount = 1;
cannam@0: 00123     d.hasKnownExtents = false;
cannam@0: 00124     d.isQuantized = false;
cannam@0: 00125     d.sampleType = OutputDescriptor::OneSamplePerStep;
cannam@0: 00126     list.push_back(d);
cannam@0: 00127 
cannam@0: 00128     d.identifier = "linearcentroid";
cannam@0: 00129     d.name = "Linear Frequency Centroid";
cannam@0: 00130     d.description = "Centroid of the linear frequency spectrum";
cannam@0: 00131     list.push_back(d);
cannam@0: 00132 
cannam@0: 00133     return list;
cannam@0: 00134 }
cannam@0: 00135 
cannam@0: 00136 SpectralCentroid::FeatureSet
cannam@0: 00137 SpectralCentroid::process(const float *const *inputBuffers, Vamp::RealTime)
cannam@0: 00138 {
cannam@0: 00139     if (m_stepSize == 0) {
cannam@0: 00140         cerr << "ERROR: SpectralCentroid::process: "
cannam@0: 00141              << "SpectralCentroid has not been initialised"
cannam@0: 00142              << endl;
cannam@0: 00143         return FeatureSet();
cannam@0: 00144     }
cannam@0: 00145 
cannam@0: 00146     double numLin = 0.0, numLog = 0.0, denom = 0.0;
cannam@0: 00147 
cannam@0: 00148     for (size_t i = 1; i <= m_blockSize/2; ++i) {
cannam@0: 00149         double freq = (double(i) * m_inputSampleRate) / m_blockSize;
cannam@0: 00150         double real = inputBuffers[0][i*2];
cannam@0: 00151         double imag = inputBuffers[0][i*2 + 1];
cannam@0: 00152         double power = sqrt(real * real + imag * imag) / (m_blockSize/2);
cannam@0: 00153         numLin += freq * power;
cannam@0: 00154         numLog += log10f(freq) * power;
cannam@0: 00155         denom += power;
cannam@0: 00156     }
cannam@0: 00157 
cannam@0: 00158     FeatureSet returnFeatures;
cannam@0: 00159 
cannam@0: 00160 //    std::cerr << "power " << denom << ", block size " << m_blockSize << std::endl;
cannam@0: 00161 
cannam@0: 00162     if (denom != 0.0) {
cannam@0: 00163         float centroidLin = float(numLin / denom);
cannam@0: 00164         float centroidLog = powf(10, float(numLog / denom));
cannam@0: 00165 
cannam@0: 00166         Feature feature;
cannam@0: 00167         feature.hasTimestamp = false;
cannam@0: 00168         if (!std::isnan(centroidLog) && !std::isinf(centroidLog)) {
cannam@0: 00169             feature.values.push_back(centroidLog);
cannam@0: 00170         }
cannam@0: 00171         returnFeatures[0].push_back(feature);
cannam@0: 00172 
cannam@0: 00173         feature.values.clear();
cannam@0: 00174         if (!std::isnan(centroidLin) && !std::isinf(centroidLin)) {
cannam@0: 00175             feature.values.push_back(centroidLin);
cannam@0: 00176         }
cannam@0: 00177         returnFeatures[1].push_back(feature);
cannam@0: 00178     }
cannam@0: 00179 
cannam@0: 00180     return returnFeatures;
cannam@0: 00181 }
cannam@0: 00182 
cannam@0: 00183 SpectralCentroid::FeatureSet
cannam@0: 00184 SpectralCentroid::getRemainingFeatures()
cannam@0: 00185 {
cannam@0: 00186     return FeatureSet();
cannam@0: 00187 }
cannam@0: 00188 
cannam@0: