AmplitudeFollower.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.
This file copyright 2006 Dan Stowell.
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 _AMPLITUDE_FOLLOWER_PLUGIN_H_
#define _AMPLITUDE_FOLLOWER_PLUGIN_H_
#include "vamp-sdk/Plugin.h"
class AmplitudeFollower : public Vamp::Plugin
{
public:
AmplitudeFollower(float inputSampleRate);
virtual ~AmplitudeFollower();
bool initialise(size_t channels, size_t stepSize, size_t blockSize);
void reset();
InputDomain getInputDomain() const { return TimeDomain; }
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;
ParameterList getParameterDescriptors() const;
float getParameter(std::string paramid) const;
void setParameter(std::string paramid, float newval);
FeatureSet process(const float *const *inputBuffers,
Vamp::RealTime timestamp);
FeatureSet getRemainingFeatures();
protected:
size_t m_stepSize;
float m_previn;
float m_clampcoef;
float m_relaxcoef;
};
#endif
Vamp::Plugin::OutputList
std::vector< OutputDescriptor > OutputList
Definition: vamp-sdk/Plugin.h:327
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
AmplitudeFollower::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: AmplitudeFollower.cpp:105
Vamp::Plugin::InputDomain
InputDomain
Definition: vamp-sdk/Plugin.h:152
AmplitudeFollower::getOutputDescriptors
OutputList getOutputDescriptors() const
Get the outputs of this plugin.
Definition: AmplitudeFollower.cpp:128
AmplitudeFollower::AmplitudeFollower
AmplitudeFollower(float inputSampleRate)
An implementation of SuperCollider's amplitude-follower algorithm as a simple Vamp plugin...
Definition: AmplitudeFollower.cpp:55
Vamp::Plugin::FeatureSet
std::map< int, FeatureList > FeatureSet
Definition: vamp-sdk/Plugin.h:387
AmplitudeFollower::getRemainingFeatures
FeatureSet getRemainingFeatures()
After all blocks have been processed, calculate and return any remaining features derived from the co...
Definition: AmplitudeFollower.cpp:243
AmplitudeFollower::getMaker
std::string getMaker() const
Get the name of the author or vendor of the plugin in human-readable form.
Definition: AmplitudeFollower.cpp:87
Vamp::Plugin::TimeDomain
Definition: vamp-sdk/Plugin.h:152
Vamp::RealTime
RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...
Definition: vamp-sdk/RealTime.h:66
AmplitudeFollower::getInputDomain
InputDomain getInputDomain() const
Get the plugin's required input domain.
Definition: AmplitudeFollower.h:56
AmplitudeFollower::getIdentifier
std::string getIdentifier() const
Get the computer-usable name of the plugin.
Definition: AmplitudeFollower.cpp:69
AmplitudeFollower::getDescription
std::string getDescription() const
Get a human-readable description for the plugin, typically a line of text that may optionally be disp...
Definition: AmplitudeFollower.cpp:81
AmplitudeFollower::reset
void reset()
Reset the plugin after use, to prepare it for another clean run.
Definition: AmplitudeFollower.cpp:122
AmplitudeFollower::m_stepSize
size_t m_stepSize
Definition: AmplitudeFollower.h:77
AmplitudeFollower::getName
std::string getName() const
Get a human-readable name or title of the plugin.
Definition: AmplitudeFollower.cpp:75
AmplitudeFollower::m_previn
float m_previn
Definition: AmplitudeFollower.h:78
AmplitudeFollower::getCopyright
std::string getCopyright() const
Get the copyright statement or licensing summary for the plugin.
Definition: AmplitudeFollower.cpp:99
AmplitudeFollower::getParameterDescriptors
ParameterList getParameterDescriptors() const
Get the controllable parameters of this plugin.
Definition: AmplitudeFollower.cpp:148
AmplitudeFollower::getPluginVersion
int getPluginVersion() const
Get the version number of the plugin.
Definition: AmplitudeFollower.cpp:93
AmplitudeFollower::m_clampcoef
float m_clampcoef
Definition: AmplitudeFollower.h:79
Plugin.h
AmplitudeFollower::m_relaxcoef
float m_relaxcoef
Definition: AmplitudeFollower.h:80
AmplitudeFollower::setParameter
void setParameter(std::string paramid, float newval)
Set a named parameter.
Definition: AmplitudeFollower.cpp:179
AmplitudeFollower::process
FeatureSet process(const float *const *inputBuffers, Vamp::RealTime timestamp)
Process a single block of input data.
Definition: AmplitudeFollower.cpp:200
AmplitudeFollower::~AmplitudeFollower
virtual ~AmplitudeFollower()
Definition: AmplitudeFollower.cpp:64
AmplitudeFollower
Example plugin implementing the SuperCollider amplitude follower function.
Definition: AmplitudeFollower.h:47
AmplitudeFollower::getParameter
float getParameter(std::string paramid) const
Get the value of a named parameter.
Definition: AmplitudeFollower.cpp:188
Vamp::PluginBase::ParameterList
std::vector< ParameterDescriptor > ParameterList
Definition: vamp-sdk/PluginBase.h:199