VampPluginSDK 2.10
PluginHostAdapter.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 _VAMP_PLUGIN_HOST_ADAPTER_H_
38#define _VAMP_PLUGIN_HOST_ADAPTER_H_
39
40#include "hostguard.h"
41#include "Plugin.h"
42
43#include <vamp/vamp.h>
44
45#include <vector>
46
47_VAMP_SDK_HOSTSPACE_BEGIN(PluginHostAdapter.h)
48
49namespace Vamp {
50
69{
70public:
72 float inputSampleRate);
74
75 static std::vector<std::string> getPluginPath();
76
77 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
78 void reset();
79
81
82 unsigned int getVampApiVersion() const;
83 std::string getIdentifier() const;
84 std::string getName() const;
85 std::string getDescription() const;
86 std::string getMaker() const;
87 int getPluginVersion() const;
88 std::string getCopyright() const;
89
91 float getParameter(std::string) const;
92 void setParameter(std::string, float);
93
95 std::string getCurrentProgram() const;
96 void selectProgram(std::string);
97
98 size_t getPreferredStepSize() const;
99 size_t getPreferredBlockSize() const;
100
101 size_t getMinChannelCount() const;
102 size_t getMaxChannelCount() const;
103
105
106 FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
107
109
110protected:
112
115};
116
117}
118
119_VAMP_SDK_HOSTSPACE_END(PluginHostAdapter.h)
120
121#endif
122
123
std::vector< ParameterDescriptor > ParameterList
std::vector< std::string > ProgramList
PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescri...
const VampPluginDescriptor * m_descriptor
ProgramList getPrograms() const
Get the program settings available in this plugin.
void setParameter(std::string, float)
Set a named parameter.
size_t getPreferredStepSize() const
Get the preferred step size (window increment – the distance in sample frames between the start frame...
FeatureSet process(const float *const *inputBuffers, RealTime timestamp)
Process a single block of input data.
void reset()
Reset the plugin after use, to prepare it for another clean run.
int getPluginVersion() const
Get the version number of the plugin.
size_t getMaxChannelCount() const
Get the maximum supported number of input channels.
std::string getName() const
Get a human-readable name or title of the plugin.
PluginHostAdapter(const VampPluginDescriptor *descriptor, float inputSampleRate)
std::string getIdentifier() const
Get the computer-usable name of the plugin.
std::string getCopyright() const
Get the copyright statement or licensing summary for the plugin.
size_t getMinChannelCount() const
Get the minimum supported number of input channels.
ParameterList getParameterDescriptors() const
Get the controllable parameters of this plugin.
void selectProgram(std::string)
Select a program.
float getParameter(std::string) const
Get the value of a named parameter.
FeatureSet getRemainingFeatures()
After all blocks have been processed, calculate and return any remaining features derived from the co...
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 getDescription() const
Get a human-readable description for the plugin, typically a line of text that may optionally be disp...
std::string getCurrentProgram() const
Get the current program.
std::string getMaker() const
Get the name of the author or vendor of the plugin in human-readable form.
OutputList getOutputDescriptors() const
Get the outputs of this plugin.
static std::vector< std::string > getPluginPath()
unsigned int getVampApiVersion() const
Get the Vamp API compatibility level of the plugin.
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,...
InputDomain getInputDomain() const
Get the plugin's required input domain.
void convertFeatures(VampFeatureList *, FeatureSet &)
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
#define _VAMP_SDK_HOSTSPACE_END(h)
Definition: hostguard.h:59
#define _VAMP_SDK_HOSTSPACE_BEGIN(h)
Definition: hostguard.h:56
Definition: FFT.h:43
RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...
void * VampPluginHandle
Definition: vamp.h:246