VampPluginSDK  2.9
SpectralCentroid.h
Go to the documentation of this file.
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
2 
3 /*
4  Vamp
5 
6  An API for audio analysis and feature extraction plugins.
7 
8  Centre for Digital Music, Queen Mary, University of London.
9  Copyright 2006 Chris Cannam.
10 
11  Permission is hereby granted, free of charge, to any person
12  obtaining a copy of this software and associated documentation
13  files (the "Software"), to deal in the Software without
14  restriction, including without limitation the rights to use, copy,
15  modify, merge, publish, distribute, sublicense, and/or sell copies
16  of the Software, and to permit persons to whom the Software is
17  furnished to do so, subject to the following conditions:
18 
19  The above copyright notice and this permission notice shall be
20  included in all copies or substantial portions of the Software.
21 
22  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
26  ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
27  CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 
30  Except as contained in this notice, the names of the Centre for
31  Digital Music; Queen Mary, University of London; and Chris Cannam
32  shall not be used in advertising or otherwise to promote the sale,
33  use or other dealings in this Software without prior written
34  authorization.
35 */
36 
37 #ifndef _SPECTRAL_CENTROID_PLUGIN_H_
38 #define _SPECTRAL_CENTROID_PLUGIN_H_
39 
40 #include "vamp-sdk/Plugin.h"
41 
48 {
49 public:
50  SpectralCentroid(float inputSampleRate);
51  virtual ~SpectralCentroid();
52 
53  bool initialise(size_t channels, size_t stepSize, size_t blockSize);
54  void reset();
55 
57 
58  std::string getIdentifier() const;
59  std::string getName() const;
60  std::string getDescription() const;
61  std::string getMaker() const;
62  int getPluginVersion() const;
63  std::string getCopyright() const;
64 
66 
67  FeatureSet process(const float *const *inputBuffers,
68  Vamp::RealTime timestamp);
69 
71 
72 protected:
73  size_t m_stepSize;
74  size_t m_blockSize;
75 };
76 
77 
78 #endif
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::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
Example plugin that calculates the centre of gravity of the frequency domain representation of each b...
Definition: SpectralCentroid.h:47
SpectralCentroid::~SpectralCentroid
virtual ~SpectralCentroid()
Definition: SpectralCentroid.cpp:63
SpectralCentroid::m_stepSize
size_t m_stepSize
Definition: SpectralCentroid.h:73
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::reset
void reset()
Reset the plugin after use, to prepare it for another clean run.
Definition: SpectralCentroid.cpp:116
SpectralCentroid::getName
std::string getName() const
Get a human-readable name or title of the plugin.
Definition: SpectralCentroid.cpp:74
Vamp::Plugin::InputDomain
InputDomain
Definition: vamp-sdk/Plugin.h:152
SpectralCentroid::SpectralCentroid
SpectralCentroid(float inputSampleRate)
Definition: SpectralCentroid.cpp:56
Vamp::Plugin
Definition: vamp-sdk/Plugin.h:124
SpectralCentroid::getInputDomain
InputDomain getInputDomain() const
Get the plugin's required input domain.
Definition: SpectralCentroid.h:56
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
Vamp::Plugin::OutputList
std::vector< OutputDescriptor > OutputList
Definition: vamp-sdk/Plugin.h:335
SpectralCentroid::getIdentifier
std::string getIdentifier() const
Get the computer-usable name of the plugin.
Definition: SpectralCentroid.cpp:68
SpectralCentroid::getOutputDescriptors
OutputList getOutputDescriptors() const
Get the outputs of this plugin.
Definition: SpectralCentroid.cpp:121
Plugin.h
SpectralCentroid::getRemainingFeatures
FeatureSet getRemainingFeatures()
After all blocks have been processed, calculate and return any remaining features derived from the co...
Definition: SpectralCentroid.cpp:192
Vamp::RealTime
Definition: vamp-sdk/RealTime.h:66
Vamp::Plugin::FrequencyDomain
@ FrequencyDomain
Definition: vamp-sdk/Plugin.h:152
SpectralCentroid::process
FeatureSet process(const float *const *inputBuffers, Vamp::RealTime timestamp)
Process a single block of input data.
Definition: SpectralCentroid.cpp:146
Vamp::Plugin::FeatureSet
std::map< int, FeatureList > FeatureSet
Definition: vamp-sdk/Plugin.h:395
SpectralCentroid::getCopyright
std::string getCopyright() const
Get the copyright statement or licensing summary for the plugin.
Definition: SpectralCentroid.cpp:98