VampPluginSDK  2.10
FixedTempoEstimator.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-2009 Chris Cannam and QMUL.
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 _FIXED_TEMPO_ESTIMATOR_PLUGIN_H_
38 #define _FIXED_TEMPO_ESTIMATOR_PLUGIN_H_
39 
40 #include "vamp-sdk/Plugin.h"
41 
47 {
48 public:
49  FixedTempoEstimator(float inputSampleRate);
50  virtual ~FixedTempoEstimator();
51 
52  bool initialise(size_t channels, size_t stepSize, size_t blockSize);
53  void reset();
54 
56 
57  std::string getIdentifier() const;
58  std::string getName() const;
59  std::string getDescription() const;
60  std::string getMaker() const;
61  int getPluginVersion() const;
62  std::string getCopyright() const;
63 
64  size_t getPreferredStepSize() const;
65  size_t getPreferredBlockSize() const;
66 
68  float getParameter(std::string id) const;
69  void setParameter(std::string id, float value);
70 
72 
73  FeatureSet process(const float *const *inputBuffers,
74  Vamp::RealTime timestamp);
75 
77 
78 protected:
79  class D;
80  D *m_d;
81 };
82 
83 
84 #endif
FixedTempoEstimator::reset
void reset()
Reset the plugin after use, to prepare it for another clean run.
Definition: FixedTempoEstimator.cpp:688
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,...
Definition: FixedTempoEstimator.cpp:679
FixedTempoEstimator::getName
std::string getName() const
Get a human-readable name or title of the plugin.
Definition: FixedTempoEstimator.cpp:637
FixedTempoEstimator::getParameterDescriptors
ParameterList getParameterDescriptors() const
Get the controllable parameters of this plugin.
Definition: FixedTempoEstimator.cpp:694
FixedTempoEstimator::FixedTempoEstimator
FixedTempoEstimator(float inputSampleRate)
Definition: FixedTempoEstimator.cpp:619
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:643
FixedTempoEstimator::getRemainingFeatures
FeatureSet getRemainingFeatures()
After all blocks have been processed, calculate and return any remaining features derived from the co...
Definition: FixedTempoEstimator.cpp:724
FixedTempoEstimator::getInputDomain
InputDomain getInputDomain() const
Get the plugin's required input domain.
Definition: FixedTempoEstimator.h:55
FixedTempoEstimator::m_d
D * m_d
Definition: FixedTempoEstimator.h:79
FixedTempoEstimator::process
FeatureSet process(const float *const *inputBuffers, Vamp::RealTime timestamp)
Process a single block of input data.
Definition: FixedTempoEstimator.cpp:718
FixedTempoEstimator
Example plugin that estimates the tempo of a short fixed-tempo sample.
Definition: FixedTempoEstimator.h:46
FixedTempoEstimator::D
Definition: FixedTempoEstimator.cpp:50
FixedTempoEstimator::getPluginVersion
int getPluginVersion() const
Get the version number of the plugin.
Definition: FixedTempoEstimator.cpp:655
Vamp::Plugin::InputDomain
InputDomain
Definition: vamp-sdk/Plugin.h:152
FixedTempoEstimator::~FixedTempoEstimator
virtual ~FixedTempoEstimator()
Definition: FixedTempoEstimator.cpp:625
FixedTempoEstimator::setParameter
void setParameter(std::string id, float value)
Set a named parameter.
Definition: FixedTempoEstimator.cpp:706
FixedTempoEstimator::getPreferredBlockSize
size_t getPreferredBlockSize() const
Get the preferred block size (window size – the number of sample frames passed in each block to the p...
Definition: FixedTempoEstimator.cpp:673
Vamp::Plugin
Definition: vamp-sdk/Plugin.h:124
FixedTempoEstimator::getMaker
std::string getMaker() const
Get the name of the author or vendor of the plugin in human-readable form.
Definition: FixedTempoEstimator.cpp:649
FixedTempoEstimator::getIdentifier
std::string getIdentifier() const
Get the computer-usable name of the plugin.
Definition: FixedTempoEstimator.cpp:631
FixedTempoEstimator::getPreferredStepSize
size_t getPreferredStepSize() const
Get the preferred step size (window increment – the distance in sample frames between the start frame...
Definition: FixedTempoEstimator.cpp:667
Vamp::Plugin::OutputList
std::vector< OutputDescriptor > OutputList
Definition: vamp-sdk/Plugin.h:335
Vamp::PluginBase::ParameterList
std::vector< ParameterDescriptor > ParameterList
Definition: vamp-sdk/PluginBase.h:203
Plugin.h
FixedTempoEstimator::getOutputDescriptors
OutputList getOutputDescriptors() const
Get the outputs of this plugin.
Definition: FixedTempoEstimator.cpp:712
Vamp::RealTime
Definition: vamp-sdk/RealTime.h:66
Vamp::Plugin::FrequencyDomain
@ FrequencyDomain
Definition: vamp-sdk/Plugin.h:152
FixedTempoEstimator::getCopyright
std::string getCopyright() const
Get the copyright statement or licensing summary for the plugin.
Definition: FixedTempoEstimator.cpp:661
FixedTempoEstimator::getParameter
float getParameter(std::string id) const
Get the value of a named parameter.
Definition: FixedTempoEstimator.cpp:700
Vamp::Plugin::FeatureSet
std::map< int, FeatureList > FeatureSet
Definition: vamp-sdk/Plugin.h:395