SpectralCentroid.h
Go to the documentation of this file.
/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
/*
Vamp
An API for audio analysis and feature extraction plugins.
Centre for Digital Music, Queen Mary, University of London.
Copyright 2006 Chris Cannam.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy,
modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the names of the Centre for
Digital Music; Queen Mary, University of London; and Chris Cannam
shall not be used in advertising or otherwise to promote the sale,
use or other dealings in this Software without prior written
authorization.
*/
#ifndef _SPECTRAL_CENTROID_PLUGIN_H_
#define _SPECTRAL_CENTROID_PLUGIN_H_
#include "vamp-sdk/Plugin.h"
class SpectralCentroid : public Vamp::Plugin
{
public:
SpectralCentroid(float inputSampleRate);
virtual ~SpectralCentroid();
bool initialise(size_t channels, size_t stepSize, size_t blockSize);
void reset();
InputDomain getInputDomain() const { return FrequencyDomain; }
std::string getIdentifier() const;
std::string getName() const;
std::string getDescription() const;
std::string getMaker() const;
int getPluginVersion() const;
std::string getCopyright() const;
OutputList getOutputDescriptors() const;
FeatureSet process(const float *const *inputBuffers,
Vamp::RealTime timestamp);
FeatureSet getRemainingFeatures();
protected:
size_t m_stepSize;
size_t m_blockSize;
};
#endif
SpectralCentroid
Example plugin that calculates the centre of gravity of the frequency domain representation of each b...
Definition SpectralCentroid.h:48
SpectralCentroid::getPluginVersion
int getPluginVersion() const
Get the version number of the plugin.
Definition SpectralCentroid.cpp:92
SpectralCentroid::m_blockSize
size_t m_blockSize
Definition SpectralCentroid.h:74
SpectralCentroid::~SpectralCentroid
virtual ~SpectralCentroid()
Definition SpectralCentroid.cpp:63
SpectralCentroid::m_stepSize
size_t m_stepSize
Definition SpectralCentroid.h:73
SpectralCentroid::getIdentifier
std::string getIdentifier() const
Get the computer-usable name of the plugin.
Definition SpectralCentroid.cpp:68
SpectralCentroid::getInputDomain
InputDomain getInputDomain() const
Get the plugin's required input domain.
Definition SpectralCentroid.h:56
SpectralCentroid::getRemainingFeatures
FeatureSet getRemainingFeatures()
After all blocks have been processed, calculate and return any remaining features derived from the co...
Definition SpectralCentroid.cpp:192
SpectralCentroid::reset
void reset()
Reset the plugin after use, to prepare it for another clean run.
Definition SpectralCentroid.cpp:116
SpectralCentroid::getMaker
std::string getMaker() const
Get the name of the author or vendor of the plugin in human-readable form.
Definition SpectralCentroid.cpp:86
SpectralCentroid::getName
std::string getName() const
Get a human-readable name or title of the plugin.
Definition SpectralCentroid.cpp:74
SpectralCentroid::initialise
bool initialise(size_t channels, size_t stepSize, size_t blockSize)
Initialise a plugin to prepare it for use with the given number of input channels,...
Definition SpectralCentroid.cpp:104
SpectralCentroid::getDescription
std::string getDescription() const
Get a human-readable description for the plugin, typically a line of text that may optionally be disp...
Definition SpectralCentroid.cpp:80
SpectralCentroid::process
FeatureSet process(const float *const *inputBuffers, Vamp::RealTime timestamp)
Process a single block of input data.
Definition SpectralCentroid.cpp:146
SpectralCentroid::getOutputDescriptors
OutputList getOutputDescriptors() const
Get the outputs of this plugin.
Definition SpectralCentroid.cpp:121
SpectralCentroid::getCopyright
std::string getCopyright() const
Get the copyright statement or licensing summary for the plugin.
Definition SpectralCentroid.cpp:98
Vamp::Plugin
Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...
Definition vamp-sdk/Plugin.h:125
Vamp::Plugin::OutputList
std::vector< OutputDescriptor > OutputList
Definition vamp-sdk/Plugin.h:335
Vamp::Plugin::InputDomain
InputDomain
Definition vamp-sdk/Plugin.h:152
Vamp::Plugin::FrequencyDomain
@ FrequencyDomain
Definition vamp-sdk/Plugin.h:152
Vamp::Plugin::FeatureSet
std::map< int, FeatureList > FeatureSet
Definition vamp-sdk/Plugin.h:395
Vamp::RealTime
RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...
Definition vamp-sdk/RealTime.h:67
Plugin.h