Chris@1: Chris@1: Chris@1: Chris@1: Chris@3: Chris@6: Chris@6: Chris@1: VampPluginSDK: PercussionOnsetDetector Class Reference Chris@1: Chris@6: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1:
Chris@1:
VampPluginSDK Chris@6:  2.7 Chris@1:
Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
PercussionOnsetDetector Class Reference
Chris@3:
Chris@1:
Chris@3: Chris@1:

Example plugin that detects percussive events. Chris@1: More...

Chris@1: Chris@1:

#include <PercussionOnsetDetector.h>

Chris@1:
Chris@1: Inheritance diagram for PercussionOnsetDetector:
Chris@1:
Chris@1:
Inheritance graph
Chris@1: Chris@6: Chris@6: Chris@6: Chris@1:
[legend]
Chris@1: Chris@6: Chris@3: Chris@6: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6:

Chris@1: Public Types

enum  InputDomain { TimeDomain, Chris@1: FrequencyDomain Chris@1: }
 
typedef std::vector< OutputDescriptorOutputList
 
typedef std::vector< FeatureFeatureList
 
typedef std::map< int, FeatureListFeatureSet
 
typedef std::vector< ParameterDescriptorParameterList
 
typedef std::vector< std::string > ProgramList
 
Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@6:

Chris@1: Public Member Functions

 PercussionOnsetDetector (float inputSampleRate)
 
virtual ~PercussionOnsetDetector ()
 
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). More...
 
void reset ()
 Reset the plugin after use, to prepare it for another clean run. More...
 
InputDomain getInputDomain () const
 Get the plugin's required input domain. More...
 
std::string getIdentifier () const
 Get the computer-usable name of the plugin. More...
 
std::string getName () const
 Get a human-readable name or title of the plugin. More...
 
std::string getDescription () const
 Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". More...
 
std::string getMaker () const
 Get the name of the author or vendor of the plugin in human-readable form. More...
 
int getPluginVersion () const
 Get the version number of the plugin. More...
 
std::string getCopyright () const
 Get the copyright statement or licensing summary for the plugin. More...
 
size_t getPreferredStepSize () const
 Get the preferred step size (window increment – the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin. More...
 
size_t getPreferredBlockSize () const
 Get the preferred block size (window size – the number of sample frames passed in each block to the process() function). More...
 
ParameterList getParameterDescriptors () const
 Get the controllable parameters of this plugin. More...
 
float getParameter (std::string id) const
 Get the value of a named parameter. More...
 
void setParameter (std::string id, float value)
 Set a named parameter. More...
 
OutputList getOutputDescriptors () const
 Get the outputs of this plugin. More...
 
FeatureSet process (const float *const *inputBuffers, Vamp::RealTime timestamp)
 Process a single block of input data. More...
 
FeatureSet getRemainingFeatures ()
 After all blocks have been processed, calculate and return any remaining features derived from the complete input. More...
 
virtual size_t getMinChannelCount () const
 Get the minimum supported number of input channels. More...
 
virtual size_t getMaxChannelCount () const
 Get the maximum supported number of input channels. More...
 
virtual std::string getType () const
 Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase. More...
 
virtual unsigned int getVampApiVersion () const
 Get the Vamp API compatibility level of the plugin. More...
 
virtual ProgramList getPrograms () const
 Get the program settings available in this plugin. More...
 
virtual std::string getCurrentProgram () const
 Get the current program. More...
 
virtual void selectProgram (std::string)
 Select a program. More...
 
Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@1:

Chris@1: Protected Attributes

size_t m_stepSize
 
size_t m_blockSize
 
float m_threshold
 
float m_sensitivity
 
float * m_priorMagnitudes
 
float m_dfMinus1
 
float m_dfMinus2
 
float m_inputSampleRate
 
Chris@6:

Detailed Description

Chris@1:

Example plugin that detects percussive events.

Chris@1: Chris@6:

Definition at line 46 of file PercussionOnsetDetector.h.

Chris@6:

Member Typedef Documentation

Chris@6: Chris@6:

◆ OutputList

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
typedef std::vector<OutputDescriptor> Vamp::Plugin::OutputList
Chris@6:
Chris@6: inherited
Chris@6:
Chris@6: Chris@6:

Definition at line 335 of file vamp-sdk/Plugin.h.

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6:

◆ FeatureList

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
typedef std::vector<Feature> Vamp::Plugin::FeatureList
Chris@6:
Chris@6: inherited
Chris@6:
Chris@6: Chris@6:

Definition at line 393 of file vamp-sdk/Plugin.h.

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6:

◆ FeatureSet

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
typedef std::map<int, FeatureList> Vamp::Plugin::FeatureSet
Chris@6:
Chris@6: inherited
Chris@6:
Chris@6: Chris@6:

Definition at line 395 of file vamp-sdk/Plugin.h.

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6:

◆ ParameterList

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
typedef std::vector<ParameterDescriptor> Vamp::PluginBase::ParameterList
Chris@6:
Chris@6: inherited
Chris@6:
Chris@6: Chris@6:

Definition at line 203 of file vamp-sdk/PluginBase.h.

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6:

◆ ProgramList

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
typedef std::vector<std::string> Vamp::PluginBase::ProgramList
Chris@6:
Chris@6: inherited
Chris@6:
Chris@6: Chris@6:

Definition at line 225 of file vamp-sdk/PluginBase.h.

Chris@6: Chris@6:
Chris@6:
Chris@6:

Member Enumeration Documentation

Chris@6: Chris@6:

◆ InputDomain

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
enum Vamp::Plugin::InputDomain
Chris@6:
Chris@6: inherited
Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6:
Enumerator
TimeDomain 
FrequencyDomain 
Chris@6: Chris@6:

Definition at line 152 of file vamp-sdk/Plugin.h.

Chris@6: Chris@6:
Chris@6:
Chris@6:

Constructor & Destructor Documentation

Chris@6: Chris@6:

◆ PercussionOnsetDetector()

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
PercussionOnsetDetector::PercussionOnsetDetector (float inputSampleRate)
Chris@6:
Chris@1: Chris@6:

Definition at line 47 of file PercussionOnsetDetector.cpp.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ ~PercussionOnsetDetector()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
PercussionOnsetDetector::~PercussionOnsetDetector ()
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@6:

Definition at line 59 of file PercussionOnsetDetector.cpp.

Chris@1: Chris@6:

References m_priorMagnitudes.

Chris@1: Chris@1:
Chris@1:
Chris@6:

Member Function Documentation

Chris@6: Chris@6:

◆ initialise()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
bool PercussionOnsetDetector::initialise (size_t inputChannels,
size_t stepSize,
size_t blockSize 
)
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@1:

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).

Chris@1:

The input sample rate should have been already specified at construction time.

Chris@1:

Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.

Chris@1: Chris@1:

Implements Vamp::Plugin.

Chris@1: Chris@6:

Definition at line 113 of file PercussionOnsetDetector.cpp.

Chris@1: Chris@6:

References Vamp::Plugin::getMaxChannelCount(), Vamp::Plugin::getMinChannelCount(), m_blockSize, m_dfMinus1, m_dfMinus2, m_priorMagnitudes, and m_stepSize.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ reset()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
void PercussionOnsetDetector::reset ()
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@1:

Reset the plugin after use, to prepare it for another clean run.

Chris@1:

Not called for the first initialisation (i.e. initialise must also do a reset).

Chris@1: Chris@1:

Implements Vamp::Plugin.

Chris@1: Chris@6:

Definition at line 134 of file PercussionOnsetDetector.cpp.

Chris@1: Chris@6:

References m_blockSize, m_dfMinus1, m_dfMinus2, and m_priorMagnitudes.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getInputDomain()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
InputDomain PercussionOnsetDetector::getInputDomain () const
Chris@6:
Chris@6: inlinevirtual
Chris@6:
Chris@1: Chris@1:

Get the plugin's required input domain.

Chris@6:

If this is TimeDomain, the samples provided to the process() function (below) will be in the time domain, as for a traditional audio processing plugin.

Chris@6:

If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to process(). The input data for the FFT will be rotated so as to place the origin in the centre of the block. The plugin does not get to choose the window type – the host will either let the user do so, or will use a Hanning window.

Chris@1: Chris@1:

Implements Vamp::Plugin.

Chris@1: Chris@6:

Definition at line 55 of file PercussionOnsetDetector.h.

Chris@1: Chris@6:

References Vamp::Plugin::FrequencyDomain, getCopyright(), getDescription(), getIdentifier(), getMaker(), getName(), getOutputDescriptors(), getParameter(), getParameterDescriptors(), getPluginVersion(), getPreferredBlockSize(), getPreferredStepSize(), getRemainingFeatures(), process(), and setParameter().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getIdentifier()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
string PercussionOnsetDetector::getIdentifier () const
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@1:

Get the computer-usable name of the plugin.

Chris@1:

This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.

Chris@1:

This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).

Chris@1:

Example: "zero_crossings"

Chris@1: Chris@1:

Implements Vamp::PluginBase.

Chris@1: Chris@6:

Definition at line 65 of file PercussionOnsetDetector.cpp.

Chris@6: Chris@6:

Referenced by getInputDomain().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getName()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
string PercussionOnsetDetector::getName () const
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@1:

Get a human-readable name or title of the plugin.

Chris@1:

This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").

Chris@1:

Example: "Zero Crossings"

Chris@1: Chris@1:

Implements Vamp::PluginBase.

Chris@1: Chris@6:

Definition at line 71 of file PercussionOnsetDetector.cpp.

Chris@6: Chris@6:

Referenced by getInputDomain().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getDescription()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
string PercussionOnsetDetector::getDescription () const
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@1:

Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name".

Chris@1:

May be empty if the name has said it all already.

Chris@1:

Example: "Detect and count zero crossing points"

Chris@1: Chris@1:

Implements Vamp::PluginBase.

Chris@1: Chris@6:

Definition at line 77 of file PercussionOnsetDetector.cpp.

Chris@6: Chris@6:

Referenced by getInputDomain().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getMaker()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
string PercussionOnsetDetector::getMaker () const
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@1:

Get the name of the author or vendor of the plugin in human-readable form.

Chris@1:

This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.

Chris@1: Chris@1:

Implements Vamp::PluginBase.

Chris@1: Chris@6:

Definition at line 83 of file PercussionOnsetDetector.cpp.

Chris@6: Chris@6:

Referenced by getInputDomain().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getPluginVersion()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
int PercussionOnsetDetector::getPluginVersion () const
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@1:

Get the version number of the plugin.

Chris@1: Chris@1:

Implements Vamp::PluginBase.

Chris@1: Chris@6:

Definition at line 89 of file PercussionOnsetDetector.cpp.

Chris@6: Chris@6:

Referenced by getInputDomain().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getCopyright()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
string PercussionOnsetDetector::getCopyright () const
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@1:

Get the copyright statement or licensing summary for the plugin.

Chris@1:

This can be an informative text, without the same presentation constraints as mentioned for getMaker above.

Chris@1: Chris@1:

Implements Vamp::PluginBase.

Chris@1: Chris@6:

Definition at line 95 of file PercussionOnsetDetector.cpp.

Chris@6: Chris@6:

Referenced by getInputDomain().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getPreferredStepSize()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
size_t PercussionOnsetDetector::getPreferredStepSize () const
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@6:

Get the preferred step size (window increment – the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin.

Chris@6:

This should be called before initialise().

Chris@6:

A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the initialise() call.

Chris@1: Chris@6:

Reimplemented from Vamp::Plugin.

Chris@1: Chris@6:

Definition at line 101 of file PercussionOnsetDetector.cpp.

Chris@6: Chris@6:

Referenced by getInputDomain().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getPreferredBlockSize()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
size_t PercussionOnsetDetector::getPreferredBlockSize () const
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@6:

Get the preferred block size (window size – the number of sample frames passed in each block to the process() function).

Chris@6:

This should be called before initialise().

Chris@6:

A plugin that can handle any block size may return 0. The final block size will be set in the initialise() call.

Chris@1: Chris@6:

Reimplemented from Vamp::Plugin.

Chris@1: Chris@6:

Definition at line 107 of file PercussionOnsetDetector.cpp.

Chris@6: Chris@6:

Referenced by getInputDomain().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getParameterDescriptors()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
PercussionOnsetDetector::ParameterList PercussionOnsetDetector::getParameterDescriptors () const
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1:
Chris@6: Chris@6:

◆ getParameter()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float PercussionOnsetDetector::getParameter (std::string ) const
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@1:

Get the value of a named parameter.

Chris@1:

The argument is the identifier field from that parameter's descriptor.

Chris@1: Chris@6:

Reimplemented from Vamp::PluginBase.

Chris@1: Chris@6:

Definition at line 174 of file PercussionOnsetDetector.cpp.

Chris@1: Chris@6:

References m_sensitivity, and m_threshold.

Chris@6: Chris@6:

Referenced by getInputDomain().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ setParameter()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
void PercussionOnsetDetector::setParameter (std::string ,
float  
)
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@1:

Set a named parameter.

Chris@1:

The first argument is the identifier field from that parameter's descriptor.

Chris@1: Chris@1:

Reimplemented from Vamp::PluginBase.

Chris@1: Chris@6:

Definition at line 182 of file PercussionOnsetDetector.cpp.

Chris@1: Chris@6:

References m_sensitivity, and m_threshold.

Chris@6: Chris@6:

Referenced by getInputDomain().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getOutputDescriptors()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
PercussionOnsetDetector::OutputList PercussionOnsetDetector::getOutputDescriptors () const
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1:
Chris@6: Chris@6:

◆ process()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
PercussionOnsetDetector::FeatureSet PercussionOnsetDetector::process (const float *const * inputBuffers,
Vamp::RealTime timestamp 
)
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@1:

Process a single block of input data.

Chris@1:

If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp in this case will be the real time in seconds of the start of the supplied block of samples.

Chris@1:

If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).

Chris@1:

Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.)

Chris@1: Chris@1:

Implements Vamp::Plugin.

Chris@1: Chris@6:

Definition at line 226 of file PercussionOnsetDetector.cpp.

Chris@1: Chris@6:

References Vamp::RealTime::frame2RealTime(), Vamp::Plugin::Feature::hasTimestamp, m_blockSize, m_dfMinus1, m_dfMinus2, Vamp::Plugin::m_inputSampleRate, m_priorMagnitudes, m_sensitivity, m_stepSize, m_threshold, Vamp::Plugin::Feature::timestamp, and Vamp::Plugin::Feature::values.

Chris@6: Chris@6:

Referenced by getInputDomain().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getRemainingFeatures()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
PercussionOnsetDetector::FeatureSet PercussionOnsetDetector::getRemainingFeatures ()
Chris@6:
Chris@6: virtual
Chris@6:
Chris@1: Chris@1:

After all blocks have been processed, calculate and return any remaining features derived from the complete input.

Chris@1: Chris@1:

Implements Vamp::Plugin.

Chris@1: Chris@6:

Definition at line 283 of file PercussionOnsetDetector.cpp.

Chris@6: Chris@6:

Referenced by getInputDomain().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getMinChannelCount()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
virtual size_t Vamp::Plugin::getMinChannelCount () const
Chris@6:
Chris@6: inlinevirtualinherited
Chris@6:
Chris@1: Chris@1:

Get the minimum supported number of input channels.

Chris@1: Chris@6:

Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

Chris@1: Chris@6:

Definition at line 199 of file vamp-sdk/Plugin.h.

Chris@1: Chris@6:

Referenced by enumeratePlugins(), FixedTempoEstimator::initialise(), initialise(), AmplitudeFollower::initialise(), SpectralCentroid::initialise(), ZeroCrossing::initialise(), PowerSpectrum::initialise(), and runPlugin().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getMaxChannelCount()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
virtual size_t Vamp::Plugin::getMaxChannelCount () const
Chris@6:
Chris@6: inlinevirtualinherited
Chris@6:
Chris@1: Chris@1:

Get the maximum supported number of input channels.

Chris@1: Chris@6:

Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

Chris@1: Chris@6:

Definition at line 204 of file vamp-sdk/Plugin.h.

Chris@1: Chris@6:

Referenced by enumeratePlugins(), FixedTempoEstimator::initialise(), initialise(), AmplitudeFollower::initialise(), SpectralCentroid::initialise(), ZeroCrossing::initialise(), PowerSpectrum::initialise(), and runPlugin().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getType()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
virtual std::string Vamp::Plugin::getType () const
Chris@6:
Chris@6: inlinevirtualinherited
Chris@6:
Chris@1: Chris@6:

Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.

Chris@1:

Do not reimplement this function in your subclass.

Chris@1: Chris@1:

Implements Vamp::PluginBase.

Chris@1: Chris@6:

Definition at line 438 of file vamp-sdk/Plugin.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getVampApiVersion()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
virtual unsigned int Vamp::PluginBase::getVampApiVersion () const
Chris@6:
Chris@6: inlinevirtualinherited
Chris@6:
Chris@1: Chris@1:

Get the Vamp API compatibility level of the plugin.

Chris@1: Chris@6:

Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

Chris@1: Chris@6:

Definition at line 68 of file vamp-sdk/PluginBase.h.

Chris@1: Chris@6:

Referenced by enumeratePlugins().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getPrograms()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
virtual ProgramList Vamp::PluginBase::getPrograms () const
Chris@6:
Chris@6: inlinevirtualinherited
Chris@6:
Chris@1: Chris@1:

Get the program settings available in this plugin.

Chris@1:

A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.

Chris@1:

The programs must have unique names.

Chris@1: Chris@6:

Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

Chris@1: Chris@6:

Definition at line 237 of file vamp-sdk/PluginBase.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ getCurrentProgram()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
virtual std::string Vamp::PluginBase::getCurrentProgram () const
Chris@6:
Chris@6: inlinevirtualinherited
Chris@6:
Chris@1: Chris@1:

Get the current program.

Chris@1: Chris@6:

Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

Chris@1: Chris@6:

Definition at line 242 of file vamp-sdk/PluginBase.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ selectProgram()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
virtual void Vamp::PluginBase::selectProgram (std::string )
Chris@6:
Chris@6: inlinevirtualinherited
Chris@6:
Chris@1: Chris@1:

Select a program.

Chris@1:

(If the given program name is not one of the available programs, do nothing.)

Chris@1: Chris@1:

Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.

Chris@1: Chris@6:

Definition at line 248 of file vamp-sdk/PluginBase.h.

Chris@6: Chris@6:

References _VAMP_SDK_PLUGSPACE_END.

Chris@1: Chris@1:
Chris@1:
Chris@6:

Member Data Documentation

Chris@6: Chris@6:

◆ m_stepSize

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
size_t PercussionOnsetDetector::m_stepSize
Chris@6:
Chris@6: protected
Chris@6:
Chris@1: Chris@6:

Definition at line 79 of file PercussionOnsetDetector.h.

Chris@1: Chris@6:

Referenced by initialise(), and process().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ m_blockSize

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
size_t PercussionOnsetDetector::m_blockSize
Chris@6:
Chris@6: protected
Chris@6:
Chris@1: Chris@6:

Definition at line 80 of file PercussionOnsetDetector.h.

Chris@1: Chris@6:

Referenced by initialise(), process(), and reset().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ m_threshold

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float PercussionOnsetDetector::m_threshold
Chris@6:
Chris@6: protected
Chris@6:
Chris@1: Chris@6:

Definition at line 82 of file PercussionOnsetDetector.h.

Chris@1: Chris@6:

Referenced by getParameter(), process(), and setParameter().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ m_sensitivity

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float PercussionOnsetDetector::m_sensitivity
Chris@6:
Chris@6: protected
Chris@6:
Chris@1: Chris@6:

Definition at line 83 of file PercussionOnsetDetector.h.

Chris@1: Chris@6:

Referenced by getParameter(), process(), and setParameter().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ m_priorMagnitudes

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float* PercussionOnsetDetector::m_priorMagnitudes
Chris@6:
Chris@6: protected
Chris@6:
Chris@1: Chris@6:

Definition at line 84 of file PercussionOnsetDetector.h.

Chris@1: Chris@6:

Referenced by initialise(), process(), reset(), and ~PercussionOnsetDetector().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ m_dfMinus1

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float PercussionOnsetDetector::m_dfMinus1
Chris@6:
Chris@6: protected
Chris@6:
Chris@1: Chris@6:

Definition at line 85 of file PercussionOnsetDetector.h.

Chris@1: Chris@6:

Referenced by initialise(), process(), and reset().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ m_dfMinus2

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float PercussionOnsetDetector::m_dfMinus2
Chris@6:
Chris@6: protected
Chris@6:
Chris@1: Chris@6:

Definition at line 86 of file PercussionOnsetDetector.h.

Chris@1: Chris@6:

Referenced by initialise(), process(), and reset().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ m_inputSampleRate

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float Vamp::Plugin::m_inputSampleRate
Chris@6:
Chris@6: protectedinherited
Chris@6:
Chris@1: Chris@6:

Definition at line 444 of file vamp-sdk/Plugin.h.

Chris@1: Chris@6:

Referenced by ZeroCrossing::getOutputDescriptors(), getOutputDescriptors(), AmplitudeFollower::initialise(), SpectralCentroid::process(), ZeroCrossing::process(), and process().

Chris@1: Chris@1:
Chris@1:
Chris@1:
The documentation for this class was generated from the following files: Chris@3:
Chris@6:
Chris@6: Chris@6: Chris@1: Chris@1: