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