#include <vamp.h>
Public Attributes | |
unsigned int | vampApiVersion |
API version with which this descriptor is compatible. | |
const char * | identifier |
Computer-usable name of the plugin. | |
const char * | name |
Human-readable name of the plugin. | |
const char * | description |
Human-readable short text about the plugin. | |
const char * | maker |
Human-readable name of plugin's author or vendor. | |
int | pluginVersion |
Version number of the plugin. | |
const char * | copyright |
Human-readable summary of copyright or licensing for plugin. | |
unsigned int | parameterCount |
Number of parameter inputs. | |
const VampParameterDescriptor ** | parameters |
Fixed descriptors for parameter inputs. | |
unsigned int | programCount |
Number of programs. | |
const char ** | programs |
Fixed names for programs. | |
VampInputDomain | inputDomain |
Preferred input domain for audio input (time or frequency). | |
VampPluginHandle(* | instantiate )(const struct _VampPluginDescriptor *, float inputSampleRate) |
Create and return a new instance of this plugin. | |
void(* | cleanup )(VampPluginHandle) |
Destroy an instance of this plugin. | |
int(* | initialise )(VampPluginHandle, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize) |
Initialise an instance following parameter configuration. | |
void(* | reset )(VampPluginHandle) |
Reset an instance, ready to use again on new input data. | |
float(* | getParameter )(VampPluginHandle, int) |
Get a parameter value. | |
void(* | setParameter )(VampPluginHandle, int, float) |
Set a parameter value. | |
unsigned int(* | getCurrentProgram )(VampPluginHandle) |
Get the current program (if programCount > 0). | |
void(* | selectProgram )(VampPluginHandle, unsigned int) |
Set the current program. | |
unsigned int(* | getPreferredStepSize )(VampPluginHandle) |
Get the plugin's preferred processing window increment in samples. | |
unsigned int(* | getPreferredBlockSize )(VampPluginHandle) |
Get the plugin's preferred processing window size in samples. | |
unsigned int(* | getMinChannelCount )(VampPluginHandle) |
Get the minimum number of input channels this plugin can handle. | |
unsigned int(* | getMaxChannelCount )(VampPluginHandle) |
Get the maximum number of input channels this plugin can handle. | |
unsigned int(* | getOutputCount )(VampPluginHandle) |
Get the number of feature outputs (distinct sets of results). | |
VampOutputDescriptor *(* | getOutputDescriptor )(VampPluginHandle, unsigned int) |
Get a descriptor for a given feature output. | |
void(* | releaseOutputDescriptor )(VampOutputDescriptor *) |
Destroy a descriptor for a feature output. | |
VampFeatureList *(* | process )(VampPluginHandle, const float *const *inputBuffers, int sec, int nsec) |
Process an input block and return a set of features. | |
VampFeatureList *(* | getRemainingFeatures )(VampPluginHandle) |
Return any remaining features at the end of processing. | |
void(* | releaseFeatureSet )(VampFeatureList *) |
Release a feature set returned from process or getRemainingFeatures. |
Definition at line 248 of file vamp.h.
unsigned int _VampPluginDescriptor::vampApiVersion |
const char* _VampPluginDescriptor::identifier |
const char* _VampPluginDescriptor::name |
const char* _VampPluginDescriptor::description |
const char* _VampPluginDescriptor::maker |
const char* _VampPluginDescriptor::copyright |
unsigned int _VampPluginDescriptor::parameterCount |
unsigned int _VampPluginDescriptor::programCount |
const char** _VampPluginDescriptor::programs |
VampPluginHandle(* _VampPluginDescriptor::instantiate)(const struct _VampPluginDescriptor *, float inputSampleRate) |
Create and return a new instance of this plugin.
Destroy an instance of this plugin.
int(* _VampPluginDescriptor::initialise)(VampPluginHandle, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize) |
Initialise an instance following parameter configuration.
Reset an instance, ready to use again on new input data.
float(* _VampPluginDescriptor::getParameter)(VampPluginHandle, int) |
Get a parameter value.
void(* _VampPluginDescriptor::setParameter)(VampPluginHandle, int, float) |
Set a parameter value.
May only be called before initialise.
unsigned int(* _VampPluginDescriptor::getCurrentProgram)(VampPluginHandle) |
Get the current program (if programCount > 0).
void(* _VampPluginDescriptor::selectProgram)(VampPluginHandle, unsigned int) |
Set the current program.
May only be called before initialise.
unsigned int(* _VampPluginDescriptor::getPreferredStepSize)(VampPluginHandle) |
Get the plugin's preferred processing window increment in samples.
unsigned int(* _VampPluginDescriptor::getPreferredBlockSize)(VampPluginHandle) |
Get the plugin's preferred processing window size in samples.
unsigned int(* _VampPluginDescriptor::getMinChannelCount)(VampPluginHandle) |
Get the minimum number of input channels this plugin can handle.
unsigned int(* _VampPluginDescriptor::getMaxChannelCount)(VampPluginHandle) |
Get the maximum number of input channels this plugin can handle.
unsigned int(* _VampPluginDescriptor::getOutputCount)(VampPluginHandle) |
Get the number of feature outputs (distinct sets of results).
VampOutputDescriptor*(* _VampPluginDescriptor::getOutputDescriptor)(VampPluginHandle, unsigned int) |
Get a descriptor for a given feature output.
Returned pointer is valid only until next call to getOutputDescriptor for this handle, or releaseOutputDescriptor for this descriptor. Host must call releaseOutputDescriptor after use.
Destroy a descriptor for a feature output.
VampFeatureList*(* _VampPluginDescriptor::process)(VampPluginHandle, const float *const *inputBuffers, int sec, int nsec) |
Process an input block and return a set of features.
Returned pointer is valid only until next call to process, getRemainingFeatures, or cleanup for this handle, or releaseFeatureSet for this feature set. Host must call releaseFeatureSet after use.
Return any remaining features at the end of processing.
Release a feature set returned from process or getRemainingFeatures.