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