27319718b1f8/code-docs/FixedTempoEstimator_8h_source.html

 /* -*- 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-2009 Chris Cannam and QMUL.

     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 _FIXED_TEMPO_ESTIMATOR_PLUGIN_H_
 #define _FIXED_TEMPO_ESTIMATOR_PLUGIN_H_

 #include "vamp-sdk/Plugin.h"

 class FixedTempoEstimator : public Vamp::Plugin
 {
 public:
     FixedTempoEstimator(float inputSampleRate);
     virtual ~FixedTempoEstimator();

     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;

     size_t getPreferredStepSize() const;
     size_t getPreferredBlockSize() const;

     ParameterList getParameterDescriptors() const;
     float getParameter(std::string id) const;
     void setParameter(std::string id, float value);

     OutputList getOutputDescriptors() const;

     FeatureSet process(const float *const *inputBuffers,
                        Vamp::RealTime timestamp);

     FeatureSet getRemainingFeatures();

 protected:
     class D;
     D *m_d;
 };


 #endif
Vamp::Plugin::OutputList
std::vector< OutputDescriptor > OutputList
Definition: vamp-sdk/Plugin.h:335

Chris@6: FixedTempoEstimator::getPreferredStepSize
size_t getPreferredStepSize() const
Get the preferred step size (window increment – the distance in sample frames between the start fram...
Definition: FixedTempoEstimator.cpp:665

Chris@6: FixedTempoEstimator::getOutputDescriptors
OutputList getOutputDescriptors() const
Get the outputs of this plugin.
Definition: FixedTempoEstimator.cpp:710

Chris@6: Vamp::Plugin
Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...
Definition: vamp-sdk/Plugin.h:124

Chris@6: Vamp::Plugin::InputDomain
InputDomain
Definition: vamp-sdk/Plugin.h:152

Chris@6: FixedTempoEstimator::process
FeatureSet process(const float *const *inputBuffers, Vamp::RealTime timestamp)
Process a single block of input data.
Definition: FixedTempoEstimator.cpp:716

Chris@6: Vamp::Plugin::FrequencyDomain
Definition: vamp-sdk/Plugin.h:152

Chris@6: FixedTempoEstimator::~FixedTempoEstimator
virtual ~FixedTempoEstimator()
Definition: FixedTempoEstimator.cpp:623

Chris@6: Vamp::Plugin::FeatureSet
std::map< int, FeatureList > FeatureSet
Definition: vamp-sdk/Plugin.h:395

Chris@6: FixedTempoEstimator::getParameter
float getParameter(std::string id) const
Get the value of a named parameter.
Definition: FixedTempoEstimator.cpp:698

Chris@6: FixedTempoEstimator::getInputDomain
InputDomain getInputDomain() const
Get the plugin&#39;s required input domain.
Definition: FixedTempoEstimator.h:55

Chris@6: FixedTempoEstimator::getMaker
std::string getMaker() const
Get the name of the author or vendor of the plugin in human-readable form.
Definition: FixedTempoEstimator.cpp:647

Chris@6: FixedTempoEstimator::getCopyright
std::string getCopyright() const
Get the copyright statement or licensing summary for the plugin.
Definition: FixedTempoEstimator.cpp:659

Chris@6: FixedTempoEstimator::reset
void reset()
Reset the plugin after use, to prepare it for another clean run.
Definition: FixedTempoEstimator.cpp:686

Chris@6: FixedTempoEstimator::getName
std::string getName() const
Get a human-readable name or title of the plugin.
Definition: FixedTempoEstimator.cpp:635

Chris@6: FixedTempoEstimator::D
Definition: FixedTempoEstimator.cpp:50

Chris@6: FixedTempoEstimator
Example plugin that estimates the tempo of a short fixed-tempo sample.
Definition: FixedTempoEstimator.h:46

Chris@6: FixedTempoEstimator::getIdentifier
std::string getIdentifier() const
Get the computer-usable name of the plugin.
Definition: FixedTempoEstimator.cpp:629

Chris@6: Vamp::RealTime
RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...
Definition: vamp-sdk/RealTime.h:66

Chris@6: FixedTempoEstimator::getRemainingFeatures
FeatureSet getRemainingFeatures()
After all blocks have been processed, calculate and return any remaining features derived from the co...
Definition: FixedTempoEstimator.cpp:722

Chris@6: FixedTempoEstimator::setParameter
void setParameter(std::string id, float value)
Set a named parameter.
Definition: FixedTempoEstimator.cpp:704

Chris@6: FixedTempoEstimator::getPreferredBlockSize
size_t getPreferredBlockSize() const
Get the preferred block size (window size – the number of sample frames passed in each block to the ...
Definition: FixedTempoEstimator.cpp:671

Chris@6: FixedTempoEstimator::m_d
D * m_d
Definition: FixedTempoEstimator.h:79

Chris@6: FixedTempoEstimator::getParameterDescriptors
ParameterList getParameterDescriptors() const
Get the controllable parameters of this plugin.
Definition: FixedTempoEstimator.cpp:692

Chris@6: FixedTempoEstimator::getDescription
std::string getDescription() const
Get a human-readable description for the plugin, typically a line of text that may optionally be disp...
Definition: FixedTempoEstimator.cpp:641

Chris@6: FixedTempoEstimator::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, step size (window increment, in sample frames) and block size (window size, in sample frames).
Definition: FixedTempoEstimator.cpp:677

Chris@6: Plugin.h

Chris@6: FixedTempoEstimator::getPluginVersion
int getPluginVersion() const
Get the version number of the plugin.
Definition: FixedTempoEstimator.cpp:653

Chris@6: FixedTempoEstimator::FixedTempoEstimator
FixedTempoEstimator(float inputSampleRate)
Definition: FixedTempoEstimator.cpp:617

Chris@6: Vamp::PluginBase::ParameterList
std::vector< ParameterDescriptor > ParameterList
Definition: vamp-sdk/PluginBase.h:203

Chris@6: