#include <vamp.h>
Definition at line 206 of file 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. |
unsigned int _VampPluginDescriptor::vampApiVersion |
API version with which this descriptor is compatible.
Definition at line 209 of file vamp.h.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::getVampApiVersion().
const char* _VampPluginDescriptor::identifier |
Computer-usable name of the plugin.
Must not change. [a-zA-Z0-9_]
Definition at line 212 of file vamp.h.
Referenced by Vamp::HostExt::PluginLoader::Impl::enumeratePlugins(), Vamp::PluginAdapterBase::Impl::getDescriptor(), Vamp::PluginHostAdapter::getIdentifier(), Vamp::HostExt::PluginLoader::Impl::loadPlugin(), and Vamp::PluginAdapterBase::Impl::~Impl().
const char* _VampPluginDescriptor::name |
Human-readable name of the plugin.
May be translatable.
Definition at line 215 of file vamp.h.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), Vamp::PluginHostAdapter::getName(), and Vamp::PluginAdapterBase::Impl::~Impl().
const char* _VampPluginDescriptor::description |
Human-readable short text about the plugin.
May be translatable.
Definition at line 218 of file vamp.h.
Referenced by Vamp::PluginHostAdapter::getDescription(), Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginAdapterBase::Impl::~Impl().
const char* _VampPluginDescriptor::maker |
Human-readable name of plugin's author or vendor.
Definition at line 221 of file vamp.h.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), Vamp::PluginHostAdapter::getMaker(), and Vamp::PluginAdapterBase::Impl::~Impl().
Version number of the plugin.
Definition at line 224 of file vamp.h.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::getPluginVersion().
const char* _VampPluginDescriptor::copyright |
Human-readable summary of copyright or licensing for plugin.
Definition at line 227 of file vamp.h.
Referenced by Vamp::PluginHostAdapter::getCopyright(), Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginAdapterBase::Impl::~Impl().
unsigned int _VampPluginDescriptor::parameterCount |
Number of parameter inputs.
Definition at line 230 of file vamp.h.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), Vamp::PluginHostAdapter::getParameter(), Vamp::PluginHostAdapter::getParameterDescriptors(), Vamp::PluginHostAdapter::setParameter(), and Vamp::PluginAdapterBase::Impl::~Impl().
Fixed descriptors for parameter inputs.
Definition at line 233 of file vamp.h.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), Vamp::PluginHostAdapter::getParameter(), Vamp::PluginHostAdapter::getParameterDescriptors(), Vamp::PluginHostAdapter::setParameter(), and Vamp::PluginAdapterBase::Impl::~Impl().
unsigned int _VampPluginDescriptor::programCount |
Number of programs.
Definition at line 236 of file vamp.h.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), Vamp::PluginHostAdapter::getPrograms(), Vamp::PluginHostAdapter::selectProgram(), and Vamp::PluginAdapterBase::Impl::~Impl().
const char** _VampPluginDescriptor::programs |
Fixed names for programs.
Definition at line 239 of file vamp.h.
Referenced by Vamp::PluginHostAdapter::getCurrentProgram(), Vamp::PluginAdapterBase::Impl::getDescriptor(), Vamp::PluginHostAdapter::getPrograms(), Vamp::PluginHostAdapter::selectProgram(), and Vamp::PluginAdapterBase::Impl::~Impl().
Preferred input domain for audio input (time or frequency).
Definition at line 242 of file vamp.h.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::getInputDomain().
VampPluginHandle(* _VampPluginDescriptor::instantiate)(const struct _VampPluginDescriptor *, float inputSampleRate) |
Create and return a new instance of this plugin.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::PluginHostAdapter().
Destroy an instance of this plugin.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::~PluginHostAdapter().
int(* _VampPluginDescriptor::initialise)(VampPluginHandle, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize) |
Initialise an instance following parameter configuration.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::initialise().
Reset an instance, ready to use again on new input data.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::reset().
float(* _VampPluginDescriptor::getParameter)(VampPluginHandle, int) |
Get a parameter value.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::getParameter().
void(* _VampPluginDescriptor::setParameter)(VampPluginHandle, int, float) |
Set a parameter value.
May only be called before initialise.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::setParameter().
unsigned int(* _VampPluginDescriptor::getCurrentProgram)(VampPluginHandle) |
Get the current program (if programCount > 0).
Referenced by Vamp::PluginHostAdapter::getCurrentProgram(), and Vamp::PluginAdapterBase::Impl::getDescriptor().
void(* _VampPluginDescriptor::selectProgram)(VampPluginHandle, unsigned int) |
Set the current program.
May only be called before initialise.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::selectProgram().
unsigned int(* _VampPluginDescriptor::getPreferredStepSize)(VampPluginHandle) |
Get the plugin's preferred processing window increment in samples.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::getPreferredStepSize().
unsigned int(* _VampPluginDescriptor::getPreferredBlockSize)(VampPluginHandle) |
Get the plugin's preferred processing window size in samples.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::getPreferredBlockSize().
unsigned int(* _VampPluginDescriptor::getMinChannelCount)(VampPluginHandle) |
Get the minimum number of input channels this plugin can handle.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::getMinChannelCount().
unsigned int(* _VampPluginDescriptor::getMaxChannelCount)(VampPluginHandle) |
Get the maximum number of input channels this plugin can handle.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::getMaxChannelCount().
unsigned int(* _VampPluginDescriptor::getOutputCount)(VampPluginHandle) |
Get the number of feature outputs (distinct sets of results).
Referenced by Vamp::PluginHostAdapter::convertFeatures(), Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::getOutputDescriptors().
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.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::getOutputDescriptors().
Destroy a descriptor for a feature output.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::getOutputDescriptors().
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.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::process().
Return any remaining features at the end of processing.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginHostAdapter::getRemainingFeatures().
Release a feature set returned from process or getRemainingFeatures.
Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), Vamp::PluginHostAdapter::getRemainingFeatures(), and Vamp::PluginHostAdapter::process().