VampPluginSDK 2.10
PercussionOnsetDetector.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 _PERCUSSION_ONSET_DETECTOR_PLUGIN_H_
38#define _PERCUSSION_ONSET_DETECTOR_PLUGIN_H_
39
40#include "vamp-sdk/Plugin.h"
41
47{
48public:
49 PercussionOnsetDetector(float inputSampleRate);
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
78protected:
79 size_t m_stepSize;
81
87};
88
89
90#endif
Example plugin that detects percussive events.
size_t getPreferredStepSize() const
Get the preferred step size (window increment – the distance in sample frames between the start frame...
std::string getMaker() const
Get the name of the author or vendor of the plugin in human-readable form.
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,...
std::string getDescription() const
Get a human-readable description for the plugin, typically a line of text that may optionally be disp...
InputDomain getInputDomain() const
Get the plugin's required input domain.
OutputList getOutputDescriptors() const
Get the outputs of this plugin.
void reset()
Reset the plugin after use, to prepare it for another clean run.
std::string getName() const
Get a human-readable name or title of the plugin.
void setParameter(std::string id, float value)
Set a named parameter.
size_t getPreferredBlockSize() const
Get the preferred block size (window size – the number of sample frames passed in each block to the p...
std::string getIdentifier() const
Get the computer-usable name of the plugin.
float getParameter(std::string id) const
Get the value of a named parameter.
std::string getCopyright() const
Get the copyright statement or licensing summary for the plugin.
FeatureSet getRemainingFeatures()
After all blocks have been processed, calculate and return any remaining features derived from the co...
int getPluginVersion() const
Get the version number of the plugin.
FeatureSet process(const float *const *inputBuffers, Vamp::RealTime timestamp)
Process a single block of input data.
ParameterList getParameterDescriptors() const
Get the controllable parameters of this plugin.
std::vector< ParameterDescriptor > ParameterList
Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...
std::vector< OutputDescriptor > OutputList
std::map< int, FeatureList > FeatureSet
RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...