#include <Plugin.h>
cannam@0: cannam@0: cannam@0:
cannam@0: List of all members.
Definition at line 198 of file Plugin.h.
cannam@0:Public Types | |
| enum | SampleType { OneSamplePerStep, cannam@0: FixedSampleRate, cannam@0: VariableSampleRate cannam@0: } |
Public Attributes | |
| std::string | identifier |
| The name of the output, in computer-usable form. | |
| std::string | name |
| The human-readable name of the output. | |
| std::string | description |
| A human-readable short text describing the output. | |
| std::string | unit |
| The unit of the output, in human-readable form. | |
| bool | hasFixedBinCount |
| True if the output has the same number of values per sample for every output sample. | |
| size_t | binCount |
| The number of values per result of the output. | |
| std::vector< std::string > | binNames |
| The (human-readable) names of each of the bins, if appropriate. | |
| bool | hasKnownExtents |
| True if the results in each output bin fall within a fixed numeric range (minimum and maximum values). | |
| float | minValue |
| Minimum value of the results in the output. | |
| float | maxValue |
| Maximum value of the results in the output. | |
| bool | isQuantized |
| True if the output values are quantized to a particular resolution. | |
| float | quantizeStep |
| Quantization resolution of the output values (e.g. | |
| SampleType | sampleType |
| Positioning in time of the output results. | |
| float | sampleRate |
| Sample rate of the output results, as samples per second. | |
| enum Vamp::Plugin::OutputDescriptor::SampleType | cannam@0:
cannam@0:
| OneSamplePerStep | cannam@0: Results from each process() align with that call's block start. |
| FixedSampleRate | cannam@0: Results are evenly spaced in time (sampleRate specified below). |
| VariableSampleRate | cannam@0: Results are unevenly spaced and have individual timestamps. |
cannam@0:
| std::string Vamp::Plugin::OutputDescriptor::identifier | cannam@0:
cannam@0: The name of the output, in computer-usable form. cannam@0:
cannam@0: Should be reasonably short and without whitespace or punctuation, using the characters [a-zA-Z0-9_-] only. Example: "zero_crossing_count" cannam@0:
Definition at line 206 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), ZeroCrossing::getOutputDescriptors(), SpectralCentroid::getOutputDescriptors(), Vamp::PluginHostAdapter::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), and AmplitudeFollower::getOutputDescriptors().
cannam@0: cannam@0:| std::string Vamp::Plugin::OutputDescriptor::name | cannam@0:
cannam@0: The human-readable name of the output. cannam@0:
cannam@0: Example: "Zero Crossing Counts" cannam@0:
Definition at line 212 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), ZeroCrossing::getOutputDescriptors(), SpectralCentroid::getOutputDescriptors(), Vamp::PluginHostAdapter::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), and AmplitudeFollower::getOutputDescriptors().
cannam@0: cannam@0:| std::string Vamp::Plugin::OutputDescriptor::description | cannam@0:
cannam@0: A human-readable short text describing the output. cannam@0:
cannam@0: May be empty if the name has said it all already. Example: "The number of zero crossing points per processing block" cannam@0:
Definition at line 219 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), ZeroCrossing::getOutputDescriptors(), SpectralCentroid::getOutputDescriptors(), Vamp::PluginHostAdapter::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), and AmplitudeFollower::getOutputDescriptors().
cannam@0: cannam@0:| std::string Vamp::Plugin::OutputDescriptor::unit | cannam@0:
cannam@0: The unit of the output, in human-readable form. cannam@0:
cannam@0: cannam@0:
Definition at line 224 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), ZeroCrossing::getOutputDescriptors(), SpectralCentroid::getOutputDescriptors(), Vamp::PluginHostAdapter::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), and AmplitudeFollower::getOutputDescriptors().
cannam@0: cannam@0:| bool Vamp::Plugin::OutputDescriptor::hasFixedBinCount | cannam@0:
cannam@0: True if the output has the same number of values per sample for every output sample. cannam@0:
cannam@0: Outputs for which this is false are unlikely to be very useful in a general-purpose host. cannam@0:
Definition at line 231 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), ZeroCrossing::getOutputDescriptors(), SpectralCentroid::getOutputDescriptors(), Vamp::PluginHostAdapter::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), and AmplitudeFollower::getOutputDescriptors().
cannam@0: cannam@0:| size_t Vamp::Plugin::OutputDescriptor::binCount | cannam@0:
cannam@0: The number of values per result of the output. cannam@0:
cannam@0: Undefined if hasFixedBinCount is false. If this is zero, the output is point data (i.e. only the time of each output is of interest, the value list will be empty). cannam@0:
Definition at line 239 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), ZeroCrossing::getOutputDescriptors(), SpectralCentroid::getOutputDescriptors(), Vamp::PluginHostAdapter::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), and AmplitudeFollower::getOutputDescriptors().
cannam@0: cannam@0:| std::vector<std::string> Vamp::Plugin::OutputDescriptor::binNames | cannam@0:
cannam@0: The (human-readable) names of each of the bins, if appropriate. cannam@0:
cannam@0: This is always optional. cannam@0:
Definition at line 245 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), and Vamp::PluginHostAdapter::getOutputDescriptors().
cannam@0: cannam@0:| bool Vamp::Plugin::OutputDescriptor::hasKnownExtents | cannam@0:
cannam@0: True if the results in each output bin fall within a fixed numeric range (minimum and maximum values). cannam@0:
cannam@0: Undefined if binCount is zero. cannam@0:
Definition at line 252 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), ZeroCrossing::getOutputDescriptors(), SpectralCentroid::getOutputDescriptors(), Vamp::PluginHostAdapter::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), and AmplitudeFollower::getOutputDescriptors().
cannam@0: cannam@0:| float Vamp::Plugin::OutputDescriptor::minValue | cannam@0:
cannam@0: Minimum value of the results in the output. cannam@0:
cannam@0: Undefined if hasKnownExtents is false or binCount is zero. cannam@0:
Definition at line 258 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), and Vamp::PluginHostAdapter::getOutputDescriptors().
cannam@0: cannam@0:| float Vamp::Plugin::OutputDescriptor::maxValue | cannam@0:
cannam@0: Maximum value of the results in the output. cannam@0:
cannam@0: Undefined if hasKnownExtents is false or binCount is zero. cannam@0:
Definition at line 264 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), and Vamp::PluginHostAdapter::getOutputDescriptors().
cannam@0: cannam@0:| bool Vamp::Plugin::OutputDescriptor::isQuantized | cannam@0:
cannam@0: True if the output values are quantized to a particular resolution. cannam@0:
cannam@0: Undefined if binCount is zero. cannam@0:
Definition at line 270 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), ZeroCrossing::getOutputDescriptors(), SpectralCentroid::getOutputDescriptors(), Vamp::PluginHostAdapter::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), and AmplitudeFollower::getOutputDescriptors().
cannam@0: cannam@0:| float Vamp::Plugin::OutputDescriptor::quantizeStep | cannam@0:
cannam@0: Quantization resolution of the output values (e.g. cannam@0:
cannam@0: 1.0 if they are all integers). Undefined if isQuantized is false or binCount is zero. cannam@0:
Definition at line 277 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), ZeroCrossing::getOutputDescriptors(), Vamp::PluginHostAdapter::getOutputDescriptors(), and PercussionOnsetDetector::getOutputDescriptors().
cannam@0: cannam@0:| SampleType Vamp::Plugin::OutputDescriptor::sampleType | cannam@0:
cannam@0: Positioning in time of the output results. cannam@0:
cannam@0: cannam@0:
Definition at line 294 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), ZeroCrossing::getOutputDescriptors(), SpectralCentroid::getOutputDescriptors(), Vamp::PluginHostAdapter::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), and AmplitudeFollower::getOutputDescriptors().
cannam@0: cannam@0:| float Vamp::Plugin::OutputDescriptor::sampleRate | cannam@0:
cannam@0: Sample rate of the output results, as samples per second. cannam@0:
cannam@0: Undefined if sampleType is OneSamplePerStep.
cannam@0: If sampleType is VariableSampleRate and this value is non-zero, then it may be used to calculate a resolution for the output (i.e. the "duration" of each sample, in time, will be 1/sampleRate seconds). It's recommended to set this to zero if that behaviour is not desired. cannam@0:
Definition at line 306 of file Plugin.h.
cannam@0: cannam@0:Referenced by Vamp::PluginAdapterBase::Impl::getOutputDescriptor(), ZeroCrossing::getOutputDescriptors(), Vamp::PluginHostAdapter::getOutputDescriptors(), and PercussionOnsetDetector::getOutputDescriptors().
cannam@0: cannam@0:cannam@0:
1.5.5
cannam@0:
cannam@0: