Vamp::HostExt::PluginChannelAdapter Class Reference
#include <vamp-sdk/hostext/PluginChannelAdapter.h>
cannam@0: cannam@0:
cannam@0: List of all members.
Detailed Description
cannam@0: PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that expect a different number of input channels from the number actually available in the source audio data. cannam@0:cannam@0: A host using PluginChannelAdapter may ignore the getMinChannelCount and getMaxChannelCount reported by the plugin, and still expect the plugin to run.
cannam@0: PluginChannelAdapter implements the following policy:
cannam@0:
-
cannam@0:
- If the plugin supports the provided number of channels directly, PluginChannelAdapter will just run the plugin as normal.
cannam@0:
-
cannam@0:
- If the plugin only supports exactly one channel but more than one channel is provided, PluginChannelAdapter will use the mean of the channels. This ensures that the resulting values remain within the same magnitude range as expected for mono data.
cannam@0:
-
cannam@0:
- If the plugin requires more than one channel but exactly one is provided, the provided channel will be duplicated across all the plugin input channels.
cannam@0: If none of the above apply:
cannam@0:
-
cannam@0:
- If the plugin requires more channels than are provided, the minimum acceptable number of channels will be produced by adding empty (zero valued) channels to those provided.
cannam@0:
-
cannam@0:
- If the plugin requires fewer channels than are provided, the maximum acceptable number of channels will be produced by discarding the excess channels.
cannam@0: Hosts requiring a different channel policy from the above will need to implement it themselves, instead of using PluginChannelAdapter.
cannam@0: Note that PluginChannelAdapter does not override the minimum and maximum channel counts returned by the wrapped plugin. The host will need to be aware that it is using a PluginChannelAdapter, and be prepared to ignore these counts as necessary. (This contrasts with the approach used in PluginInputDomainAdapter, which aims to make the host completely unaware of which underlying input domain is in fact in use.)
cannam@0: (The rationale for this is that a host may wish to use the PluginChannelAdapter but still discriminate in some way on the basis of the number of channels actually supported. For example, a simple stereo audio host may prefer to reject plugins that require more than two channels on the grounds that doesn't actually understand what they are for, rather than allow the channel adapter to make a potentially meaningless channel conversion for them.)
cannam@0: In every respect other than its management of channels, the PluginChannelAdapter behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted.
cannam@0:
- Note:
- This class was introduced in version 1.1 of the Vamp plugin SDK.
Definition at line 109 of file PluginChannelAdapter.h.
cannam@0:Public Types | |
| enum | InputDomain { TimeDomain, cannam@0: FrequencyDomain cannam@0: } |
| typedef std::vector cannam@0: < OutputDescriptor > | OutputList |
| typedef std::vector< Feature > | FeatureList |
| typedef std::map< int, cannam@0: FeatureList > | FeatureSet |
| typedef std::vector cannam@0: < ParameterDescriptor > | ParameterList |
| typedef std::vector< std::string > | ProgramList |
Public Member Functions | |
| PluginChannelAdapter (Plugin *plugin) | |
| virtual | ~PluginChannelAdapter () |
| 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, step size (window increment, in sample frames) and block size (window size, in sample frames). | |
| 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. | |
| InputDomain | getInputDomain () const |
| Get the plugin's required input domain. | |
| unsigned int | getVampApiVersion () const |
| Get the Vamp API compatibility level of the plugin. | |
| std::string | getIdentifier () const |
| Get the computer-usable name of the plugin. | |
| std::string | getName () const |
| Get a human-readable name or title of the plugin. | |
| std::string | getDescription () const |
| Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". | |
| std::string | getMaker () const |
| Get the name of the author or vendor of the plugin in human-readable form. | |
| int | getPluginVersion () const |
| Get the version number of the plugin. | |
| std::string | getCopyright () const |
| Get the copyright statement or licensing summary for the plugin. | |
| ParameterList | getParameterDescriptors () const |
| Get the controllable parameters of this plugin. | |
| float | getParameter (std::string) const |
| Get the value of a named parameter. | |
| void | setParameter (std::string, float) |
| Set a named parameter. | |
| ProgramList | getPrograms () const |
| Get the program settings available in this plugin. | |
| std::string | getCurrentProgram () const |
| Get the current program. | |
| void | selectProgram (std::string) |
| Select a program. | |
| size_t | getPreferredStepSize () const |
| Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin. | |
| size_t | getPreferredBlockSize () const |
| Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function). | |
| size_t | getMinChannelCount () const |
| Get the minimum supported number of input channels. | |
| size_t | getMaxChannelCount () const |
| Get the maximum supported number of input channels. | |
| OutputList | getOutputDescriptors () const |
| Get the outputs of this plugin. | |
| FeatureSet | getRemainingFeatures () |
| After all blocks have been processed, calculate and return any remaining features derived from the complete input. | |
| virtual std::string | getType () const |
| Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase. | |
Protected Attributes | |
| Impl * | m_impl |
| Plugin * | m_plugin |
| float | m_inputSampleRate |
Classes | |
| class | Impl |
Member Typedef Documentation
cannam@0: cannam@0:typedef std::vector<OutputDescriptor> Vamp::Plugin::OutputList [inherited] |
cannam@0:
typedef std::vector<Feature> Vamp::Plugin::FeatureList [inherited] |
cannam@0:
typedef std::map<int, FeatureList> Vamp::Plugin::FeatureSet [inherited] |
cannam@0:
typedef std::vector<ParameterDescriptor> Vamp::PluginBase::ParameterList [inherited] |
cannam@0:
cannam@0: cannam@0:
Definition at line 195 of file PluginBase.h.
cannam@0: cannam@0:typedef std::vector<std::string> Vamp::PluginBase::ProgramList [inherited] |
cannam@0:
cannam@0: cannam@0:
Definition at line 217 of file PluginBase.h.
cannam@0: cannam@0:cannam@0:
Member Enumeration Documentation
cannam@0: cannam@0:enum Vamp::Plugin::InputDomain [inherited] |
cannam@0:
cannam@0:
Constructor & Destructor Documentation
cannam@0: cannam@0:| Vamp::HostExt::PluginChannelAdapter::PluginChannelAdapter | cannam@0:( | cannam@0:Plugin * | cannam@0:plugin | cannam@0:) | cannam@0:cannam@0: |
cannam@0: cannam@0:
Definition at line 62 of file PluginChannelAdapter.cpp.
cannam@0: cannam@0:References m_impl.
cannam@0: cannam@0:| Vamp::HostExt::PluginChannelAdapter::~PluginChannelAdapter | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: [virtual] |
cannam@0:
cannam@0: cannam@0:
Definition at line 68 of file PluginChannelAdapter.cpp.
cannam@0: cannam@0:References m_impl.
cannam@0: cannam@0:cannam@0:
Member Function Documentation
cannam@0: cannam@0:| bool Vamp::HostExt::PluginChannelAdapter::initialise | cannam@0:( | cannam@0:size_t | cannam@0:inputChannels, | cannam@0:|
| cannam@0: | cannam@0: | size_t | cannam@0:stepSize, | cannam@0:|
| cannam@0: | cannam@0: | size_t | cannam@0:blockSize | cannam@0: |
| cannam@0: | ) | cannam@0: [virtual] |
cannam@0:
cannam@0: Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). cannam@0:
cannam@0: The input sample rate should have been already specified at construction time.
cannam@0: Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. cannam@0:
Reimplemented from Vamp::HostExt::PluginWrapper.
cannam@0: cannam@0:Definition at line 74 of file PluginChannelAdapter.cpp.
cannam@0: cannam@0:References Vamp::HostExt::PluginChannelAdapter::Impl::initialise(), and m_impl.
cannam@0: cannam@0:| PluginChannelAdapter::FeatureSet Vamp::HostExt::PluginChannelAdapter::process | cannam@0:( | cannam@0:const float *const * | cannam@0:inputBuffers, | cannam@0:|
| cannam@0: | cannam@0: | RealTime | cannam@0:timestamp | cannam@0: |
| cannam@0: | ) | cannam@0: [virtual] |
cannam@0:
cannam@0: Process a single block of input data. cannam@0:
cannam@0: If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp will be the real time in seconds of the start of the supplied block of samples.
cannam@0: If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).
cannam@0: Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.) cannam@0:
Reimplemented from Vamp::HostExt::PluginWrapper.
cannam@0: cannam@0:Definition at line 80 of file PluginChannelAdapter.cpp.
cannam@0: cannam@0:References m_impl, and Vamp::HostExt::PluginChannelAdapter::Impl::process().
cannam@0: cannam@0:| void Vamp::HostExt::PluginWrapper::reset | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: [virtual, inherited] |
cannam@0:
cannam@0: Reset the plugin after use, to prepare it for another clean run. cannam@0:
cannam@0: Not called for the first initialisation (i.e. initialise must also do a reset). cannam@0:
Implements Vamp::Plugin.
cannam@0: cannam@0:Reimplemented in Vamp::HostExt::PluginBufferingAdapter.
cannam@0: cannam@0:Definition at line 68 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::HostExt::PluginWrapper::m_plugin, and Vamp::Plugin::reset().
cannam@0: cannam@0:| Plugin::InputDomain Vamp::HostExt::PluginWrapper::getInputDomain | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the plugin's required input domain. cannam@0:
cannam@0: If this is TimeDomain, the samples provided to the process() function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to process(). The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. cannam@0:
Implements Vamp::Plugin.
cannam@0: cannam@0:Reimplemented in Vamp::HostExt::PluginInputDomainAdapter.
cannam@0: cannam@0:Definition at line 74 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::Plugin::getInputDomain(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the Vamp API compatibility level of the plugin. cannam@0:
cannam@0: cannam@0:
Reimplemented from Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 80 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::PluginBase::getVampApiVersion(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| std::string Vamp::HostExt::PluginWrapper::getIdentifier | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the computer-usable name of the plugin. cannam@0:
cannam@0: This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.
cannam@0: This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).
cannam@0: Example: "zero_crossings" cannam@0:
Implements Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 86 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::PluginBase::getIdentifier(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| std::string Vamp::HostExt::PluginWrapper::getName | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get a human-readable name or title of the plugin. cannam@0:
cannam@0: This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").
cannam@0: Example: "Zero Crossings" cannam@0:
Implements Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 92 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::PluginBase::getName(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| std::string Vamp::HostExt::PluginWrapper::getDescription | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". cannam@0:
cannam@0: May be empty if the name has said it all already.
cannam@0: Example: "Detect and count zero crossing points" cannam@0:
Implements Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 98 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::PluginBase::getDescription(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| std::string Vamp::HostExt::PluginWrapper::getMaker | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the name of the author or vendor of the plugin in human-readable form. cannam@0:
cannam@0: This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. cannam@0:
Implements Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 104 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::PluginBase::getMaker(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| int Vamp::HostExt::PluginWrapper::getPluginVersion | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the version number of the plugin. cannam@0:
cannam@0: cannam@0:
Implements Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 110 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::PluginBase::getPluginVersion(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| std::string Vamp::HostExt::PluginWrapper::getCopyright | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the copyright statement or licensing summary for the plugin. cannam@0:
cannam@0: This can be an informative text, without the same presentation constraints as mentioned for getMaker above. cannam@0:
Implements Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 116 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::PluginBase::getCopyright(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| PluginBase::ParameterList Vamp::HostExt::PluginWrapper::getParameterDescriptors | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the controllable parameters of this plugin. cannam@0:
cannam@0: cannam@0:
Reimplemented from Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 122 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::PluginBase::getParameterDescriptors(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| float Vamp::HostExt::PluginWrapper::getParameter | cannam@0:( | cannam@0:std::string | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the value of a named parameter. cannam@0:
cannam@0: The argument is the identifier field from that parameter's descriptor. cannam@0:
Reimplemented from Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 128 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::PluginBase::getParameter(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| void Vamp::HostExt::PluginWrapper::setParameter | cannam@0:( | cannam@0:std::string | cannam@0:, | cannam@0:|
| cannam@0: | cannam@0: | float | cannam@0:cannam@0: | |
| cannam@0: | ) | cannam@0: [virtual, inherited] |
cannam@0:
cannam@0: Set a named parameter. cannam@0:
cannam@0: The first argument is the identifier field from that parameter's descriptor. cannam@0:
Reimplemented from Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 134 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::HostExt::PluginWrapper::m_plugin, and Vamp::PluginBase::setParameter().
cannam@0: cannam@0:| PluginBase::ProgramList Vamp::HostExt::PluginWrapper::getPrograms | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the program settings available in this plugin. cannam@0:
cannam@0: A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.
cannam@0: The programs must have unique names. cannam@0:
Reimplemented from Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 140 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::PluginBase::getPrograms(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| std::string Vamp::HostExt::PluginWrapper::getCurrentProgram | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the current program. cannam@0:
cannam@0: cannam@0:
Reimplemented from Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 146 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::PluginBase::getCurrentProgram(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| void Vamp::HostExt::PluginWrapper::selectProgram | cannam@0:( | cannam@0:std::string | cannam@0:cannam@0: | ) | cannam@0: [virtual, inherited] |
cannam@0:
cannam@0: Select a program. cannam@0:
cannam@0: (If the given program name is not one of the available programs, do nothing.) cannam@0:
Reimplemented from Vamp::PluginBase.
cannam@0: cannam@0:Definition at line 152 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::HostExt::PluginWrapper::m_plugin, and Vamp::PluginBase::selectProgram().
cannam@0: cannam@0:| size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the process() function) for the plugin. cannam@0:
cannam@0: This should be called before initialise().
cannam@0: A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the initialise() call. cannam@0:
Reimplemented from Vamp::Plugin.
cannam@0: cannam@0:Reimplemented in Vamp::HostExt::PluginBufferingAdapter, and Vamp::HostExt::PluginInputDomainAdapter.
cannam@0: cannam@0:Definition at line 158 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::Plugin::getPreferredStepSize(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function). cannam@0:
cannam@0: This should be called before initialise().
cannam@0: A plugin that can handle any block size may return 0. The final block size will be set in the initialise() call. cannam@0:
Reimplemented from Vamp::Plugin.
cannam@0: cannam@0:Reimplemented in Vamp::HostExt::PluginInputDomainAdapter.
cannam@0: cannam@0:Definition at line 164 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::Plugin::getPreferredBlockSize(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:Referenced by Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize().
cannam@0: cannam@0:| size_t Vamp::HostExt::PluginWrapper::getMinChannelCount | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the minimum supported number of input channels. cannam@0:
cannam@0: cannam@0:
Reimplemented from Vamp::Plugin.
cannam@0: cannam@0:Definition at line 170 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::Plugin::getMinChannelCount(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the maximum supported number of input channels. cannam@0:
cannam@0: cannam@0:
Reimplemented from Vamp::Plugin.
cannam@0: cannam@0:Definition at line 175 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::Plugin::getMaxChannelCount(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| Plugin::OutputList Vamp::HostExt::PluginWrapper::getOutputDescriptors | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [virtual, inherited] |
cannam@0:
cannam@0: Get the outputs of this plugin. cannam@0:
cannam@0: An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the process() call. cannam@0:
Implements Vamp::Plugin.
cannam@0: cannam@0:Reimplemented in Vamp::HostExt::PluginBufferingAdapter.
cannam@0: cannam@0:Definition at line 181 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::Plugin::getOutputDescriptors(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| Plugin::FeatureSet Vamp::HostExt::PluginWrapper::getRemainingFeatures | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: [virtual, inherited] |
cannam@0:
cannam@0: After all blocks have been processed, calculate and return any remaining features derived from the complete input. cannam@0:
cannam@0: cannam@0:
Implements Vamp::Plugin.
cannam@0: cannam@0:Reimplemented in Vamp::HostExt::PluginBufferingAdapter.
cannam@0: cannam@0:Definition at line 193 of file PluginWrapper.cpp.
cannam@0: cannam@0:References Vamp::Plugin::getRemainingFeatures(), and Vamp::HostExt::PluginWrapper::m_plugin.
cannam@0: cannam@0:| virtual std::string Vamp::Plugin::getType | cannam@0:( | cannam@0:cannam@0: | ) | cannam@0: const [inline, virtual, inherited] |
cannam@0:
cannam@0: Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase. cannam@0:
cannam@0: Do not reimplement this function in your subclass. cannam@0:
Implements Vamp::PluginBase.
cannam@0: cannam@0: cannam@0: cannam@0:cannam@0:
Member Data Documentation
cannam@0: cannam@0:Impl* Vamp::HostExt::PluginChannelAdapter::m_impl [protected] |
cannam@0:
cannam@0: cannam@0:
Definition at line 120 of file PluginChannelAdapter.h.
cannam@0: cannam@0:Referenced by initialise(), PluginChannelAdapter(), process(), and ~PluginChannelAdapter().
cannam@0: cannam@0:Plugin* Vamp::HostExt::PluginWrapper::m_plugin [protected, inherited] |
cannam@0:
cannam@0: cannam@0:
Definition at line 99 of file PluginWrapper.h.
cannam@0: cannam@0:Referenced by Vamp::HostExt::PluginWrapper::getCopyright(), Vamp::HostExt::PluginWrapper::getCurrentProgram(), Vamp::HostExt::PluginWrapper::getDescription(), Vamp::HostExt::PluginWrapper::getIdentifier(), Vamp::HostExt::PluginWrapper::getInputDomain(), Vamp::HostExt::PluginWrapper::getMaker(), Vamp::HostExt::PluginWrapper::getMaxChannelCount(), Vamp::HostExt::PluginWrapper::getMinChannelCount(), Vamp::HostExt::PluginWrapper::getName(), Vamp::HostExt::PluginWrapper::getOutputDescriptors(), Vamp::HostExt::PluginWrapper::getParameter(), Vamp::HostExt::PluginWrapper::getParameterDescriptors(), Vamp::HostExt::PluginWrapper::getPluginVersion(), Vamp::HostExt::PluginWrapper::getPreferredBlockSize(), Vamp::HostExt::PluginWrapper::getPreferredStepSize(), Vamp::HostExt::PluginWrapper::getPrograms(), Vamp::HostExt::PluginWrapper::getRemainingFeatures(), Vamp::HostExt::PluginWrapper::getVampApiVersion(), Vamp::HostExt::PluginWrapper::initialise(), Vamp::HostExt::PluginWrapper::process(), Vamp::HostExt::PluginWrapper::reset(), Vamp::HostExt::PluginWrapper::selectProgram(), Vamp::HostExt::PluginWrapper::setParameter(), Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::~PluginDeletionNotifyAdapter(), and Vamp::HostExt::PluginWrapper::~PluginWrapper().
cannam@0: cannam@0:float Vamp::Plugin::m_inputSampleRate [protected, inherited] |
cannam@0:
cannam@0: cannam@0:
Definition at line 397 of file Plugin.h.
cannam@0: cannam@0:Referenced by ZeroCrossing::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), Vamp::HostExt::PluginRateExtractor::getRate(), AmplitudeFollower::initialise(), Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter(), Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter(), ZeroCrossing::process(), SpectralCentroid::process(), and PercussionOnsetDetector::process().
cannam@0: cannam@0:cannam@0:
The documentation for this class was generated from the following files: cannam@0:
