Chris@23: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@23: 
Chris@23: /*
Chris@23:     Vamp
Chris@23: 
Chris@23:     An API for audio analysis and feature extraction plugins.
Chris@23: 
Chris@23:     Centre for Digital Music, Queen Mary, University of London.
Chris@23:     Copyright 2006 Chris Cannam.
Chris@23:   
Chris@23:     Permission is hereby granted, free of charge, to any person
Chris@23:     obtaining a copy of this software and associated documentation
Chris@23:     files (the "Software"), to deal in the Software without
Chris@23:     restriction, including without limitation the rights to use, copy,
Chris@23:     modify, merge, publish, distribute, sublicense, and/or sell copies
Chris@23:     of the Software, and to permit persons to whom the Software is
Chris@23:     furnished to do so, subject to the following conditions:
Chris@23: 
Chris@23:     The above copyright notice and this permission notice shall be
Chris@23:     included in all copies or substantial portions of the Software.
Chris@23: 
Chris@23:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@23:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@23:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Chris@23:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
Chris@23:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@23:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@23:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@23: 
Chris@23:     Except as contained in this notice, the names of the Centre for
Chris@23:     Digital Music; Queen Mary, University of London; and Chris Cannam
Chris@23:     shall not be used in advertising or otherwise to promote the sale,
Chris@23:     use or other dealings in this Software without prior written
Chris@23:     authorization.
Chris@23: */
Chris@23: 
Chris@23: #include "SpectralCentroid.h"
Chris@23: 
Chris@23: using std::string;
Chris@23: using std::vector;
Chris@23: using std::cerr;
Chris@23: using std::endl;
Chris@23: 
Chris@23: #include <math.h>
Chris@23: 
Chris@23: #ifdef __SUNPRO_CC
Chris@23: #include <ieeefp.h>
Chris@23: #define isinf(x) (!finite(x))
Chris@23: #endif
Chris@23: 
Chris@23: #ifdef WIN32
Chris@23: #define isnan(x) false
Chris@23: #define isinf(x) false
Chris@23: #endif
Chris@23: 
Chris@23: SpectralCentroid::SpectralCentroid(float inputSampleRate) :
Chris@23:     Plugin(inputSampleRate),
Chris@23:     m_stepSize(0),
Chris@23:     m_blockSize(0)
Chris@23: {
Chris@23: }
Chris@23: 
Chris@23: SpectralCentroid::~SpectralCentroid()
Chris@23: {
Chris@23: }
Chris@23: 
Chris@23: string
Chris@23: SpectralCentroid::getIdentifier() const
Chris@23: {
Chris@23:     return "spectralcentroid";
Chris@23: }
Chris@23: 
Chris@23: string
Chris@23: SpectralCentroid::getName() const
Chris@23: {
Chris@23:     return "Spectral Centroid";
Chris@23: }
Chris@23: 
Chris@23: string
Chris@23: SpectralCentroid::getDescription() const
Chris@23: {
Chris@23:     return "Calculate the centroid frequency of the spectrum of the input signal";
Chris@23: }
Chris@23: 
Chris@23: string
Chris@23: SpectralCentroid::getMaker() const
Chris@23: {
Chris@23:     return "Vamp SDK Example Plugins";
Chris@23: }
Chris@23: 
Chris@23: int
Chris@23: SpectralCentroid::getPluginVersion() const
Chris@23: {
Chris@23:     return 2;
Chris@23: }
Chris@23: 
Chris@23: string
Chris@23: SpectralCentroid::getCopyright() const
Chris@23: {
Chris@23:     return "Freely redistributable (BSD license)";
Chris@23: }
Chris@23: 
Chris@23: bool
Chris@23: SpectralCentroid::initialise(size_t channels, size_t stepSize, size_t blockSize)
Chris@23: {
Chris@23:     if (channels < getMinChannelCount() ||
Chris@23: 	channels > getMaxChannelCount()) return false;
Chris@23: 
Chris@23:     m_stepSize = stepSize;
Chris@23:     m_blockSize = blockSize;
Chris@23: 
Chris@23:     return true;
Chris@23: }
Chris@23: 
Chris@23: void
Chris@23: SpectralCentroid::reset()
Chris@23: {
Chris@23: }
Chris@23: 
Chris@23: SpectralCentroid::OutputList
Chris@23: SpectralCentroid::getOutputDescriptors() const
Chris@23: {
Chris@23:     OutputList list;
Chris@23: 
Chris@23:     OutputDescriptor d;
Chris@23:     d.identifier = "logcentroid";
Chris@23:     d.name = "Log Frequency Centroid";
Chris@23:     d.description = "Centroid of the log weighted frequency spectrum";
Chris@23:     d.unit = "Hz";
Chris@23:     d.hasFixedBinCount = true;
Chris@23:     d.binCount = 1;
Chris@23:     d.hasKnownExtents = false;
Chris@23:     d.isQuantized = false;
Chris@23:     d.sampleType = OutputDescriptor::OneSamplePerStep;
Chris@23:     list.push_back(d);
Chris@23: 
Chris@23:     d.identifier = "linearcentroid";
Chris@23:     d.name = "Linear Frequency Centroid";
Chris@23:     d.description = "Centroid of the linear frequency spectrum";
Chris@23:     list.push_back(d);
Chris@23: 
Chris@23:     return list;
Chris@23: }
Chris@23: 
Chris@23: SpectralCentroid::FeatureSet
Chris@23: SpectralCentroid::process(const float *const *inputBuffers, Vamp::RealTime timestamp)
Chris@23: {
Chris@23:     if (m_stepSize == 0) {
Chris@23: 	cerr << "ERROR: SpectralCentroid::process: "
Chris@23: 	     << "SpectralCentroid has not been initialised"
Chris@23: 	     << endl;
Chris@23: 	return FeatureSet();
Chris@23:     }
Chris@23: 
Chris@23:     double numLin = 0.0, numLog = 0.0, denom = 0.0;
Chris@23: 
Chris@23:     for (size_t i = 1; i <= m_blockSize/2; ++i) {
Chris@23: 	double freq = (double(i) * m_inputSampleRate) / m_blockSize;
Chris@23: 	double real = inputBuffers[0][i*2];
Chris@23: 	double imag = inputBuffers[0][i*2 + 1];
Chris@23: 	double scalemag = sqrt(real * real + imag * imag) / (m_blockSize/2);
Chris@23: 	numLin += freq * scalemag;
Chris@23:         numLog += log10f(freq) * scalemag;
Chris@23: 	denom += scalemag;
Chris@23:     }
Chris@23: 
Chris@23:     FeatureSet returnFeatures;
Chris@23: 
Chris@23:     if (denom != 0.0) {
Chris@23: 	float centroidLin = float(numLin / denom);
Chris@23: 	float centroidLog = powf(10, float(numLog / denom));
Chris@23: 
Chris@23: 	Feature feature;
Chris@23: 	feature.hasTimestamp = false;
Chris@23: 
Chris@23:         if (!isnan(centroidLog) && !isinf(centroidLog)) {
Chris@23:             feature.values.push_back(centroidLog);
Chris@23:         }
Chris@23: 	returnFeatures[0].push_back(feature);
Chris@23: 
Chris@23:         feature.values.clear();
Chris@23:         if (!isnan(centroidLin) && !isinf(centroidLin)) {
Chris@23:             feature.values.push_back(centroidLin);
Chris@23:         }
Chris@23: 	returnFeatures[1].push_back(feature);
Chris@23:     }
Chris@23: 
Chris@23:     return returnFeatures;
Chris@23: }
Chris@23: 
Chris@23: SpectralCentroid::FeatureSet
Chris@23: SpectralCentroid::getRemainingFeatures()
Chris@23: {
Chris@23:     return FeatureSet();
Chris@23: }
Chris@23: