cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: Vamp Plugins Ontology cannam@136: cannam@136:

Overview of Terms

cannam@136:

An alphabetical index of the ontology terms, divided into classes, properties and individuals. All the terms are hyperlinked to their detailed description for quick reference.

cannam@136:

Classes: | Configuration | DenseOutput | Feature | InputDomain | Parameter | ParameterDescriptor | Plugin | PluginDescription | PluginLibrary | PluginOutput | PluginProgram | SampleType | SparseOutput | TrackLevelOutput | Transform | TransformType |

cannam@136:

Properties: | available_plugin | cannam@136: bin_count | cannam@136: bin_names | cannam@136: block_size | cannam@136: computes_feature_type | cannam@136: default_value | cannam@136: duration | cannam@136: engine | cannam@136: fixed_bin_count | cannam@136: identifier | cannam@136: input_domain | cannam@136: max_value | cannam@136: min_value | cannam@136: name | cannam@136: output_descriptor | cannam@136: parameter | cannam@136: parameter_descriptor | cannam@136: plugin_description | cannam@136: program | cannam@136: quantized_step | cannam@136: sample_rate | cannam@136: sample_type | cannam@136: start | cannam@136: step_size | cannam@136: transform_type | cannam@136: unit | cannam@136: value | cannam@136: vamp_API_version | cannam@136: window_type | cannam@136:

cannam@136:

Individuals: | Effect | cannam@136: FeatureExtraction | cannam@136: FixedSampleRate | cannam@136: OneSamplePerStep | cannam@136: VariableSampleRate | cannam@136: frequency_domain | cannam@136: time_domain | cannam@136:

Classes

Class: vamp:Configuration - unstable -

cannam@136: Configuration cannam@136: - For extension (SV implementation of Transform).
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
in-range-of:program
cannam@136: cannam@136:

Class: vamp:DenseOutput - unstable -

cannam@136: DenseOutput cannam@136: - Specific output type comprising large binary data (e.g.: chromagram).
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
sub-class-of:PluginOutput
cannam@136: cannam@136:

Class: vamp:Feature - deprecated -

cannam@136: Feature cannam@136: - This may be removed mighty soon as we rely on the Audio Features Ontology for this cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136:
cannam@136: cannam@136:

Class: vamp:InputDomain - stable -

cannam@136: InputDomain cannam@136: - Plugins warn about the input domain they require so the host can convert properly the input data. Note that this is not necessary if the host is using a PluginAdapter to wrap plugins (see Vamp doc).
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
in-range-of:input_domain
cannam@136: cannam@136:

Class: vamp:Parameter - unstable -

cannam@136: Parameter cannam@136: - Parameter used by the plugin transform to set up the plugin. The parameter class instances should be instantiated according to the specific vamp:PluginDescriptor instance for each plugin.
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
in-range-of:parameter
in-domain-of:valueparameter_descriptor
cannam@136: cannam@136:

Class: vamp:ParameterDescriptor - stable -

cannam@136: ParameterDescriptor cannam@136: - Descriptior of a plugin parameter. Hosts require to know about the specific type and form of the parameters of a particular plugin for a correct transform setup.
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
in-range-of:default_valuemin_valuemax_valueparameter_descriptor
in-domain-of:quantized_stepunitidentifier
cannam@136: cannam@136:

Class: vamp:Plugin - stable -

cannam@136: Plugin cannam@136: - Vamp plugin is an implementation of a feature extraction algorithm based on the Vamp API.
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
in-range-of:engineavailable_plugin
in-domain-of:input_domainoutput_descriptorparameter_descriptorplugin_description
cannam@136: cannam@136:

Class: vamp:PluginDescription - unstable -

cannam@136: PluginDescription cannam@136: - The plugin descriptor provides basic metadata of the plugin. We may remove this and link directly to the plugin instance.
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
in-range-of:plugin_description
in-domain-of:vamp_API_versionnameidentifier
cannam@136: cannam@136:

Class: vamp:PluginLibrary - stable -

cannam@136: PluginLibrary cannam@136: - Library of Vamp Plugins. This may need to include rights.
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
in-domain-of:available_plugin
cannam@136: cannam@136:

Class: vamp:PluginOutput - unstable -

cannam@136: PluginOutput cannam@136: - Descriptior of the plugin output. This descriptor provides necessary information to interpret correctly the output features. The output type will determine how to read the temporal information of the extracted feature and how to manage the burden of ouput data.
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
in-range-of:min_valuemax_valueoutput_descriptor
in-domain-of:computes_feature_typesample_typebin_namesbin_countquantized_stepsample_rateunitfixed_bin_countidentifier
cannam@136: cannam@136:

Class: vamp:PluginProgram - unstable -

cannam@136: PluginProgram cannam@136: - Plugin program defines a predefined context of parameters. We may not need a concept for this and just a property linking a string representing the program name.
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
in-range-of:program
in-domain-of:identifier
cannam@136: cannam@136:

Class: vamp:SampleType - stable -

cannam@136: SampleType cannam@136: - Sample type specifies the temporal information of the plugin output. This information should be confronted with the output type for a correct interpretation.
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
in-range-of:sample_type
cannam@136: cannam@136:

Class: vamp:SparseOutput - unstable -

cannam@136: SparseOutput cannam@136: - Specific output type used in sparse data outputs (e.g.: key detector).
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
sub-class-of:PluginOutput
cannam@136: cannam@136:

Class: vamp:TrackLevelOutput - unstable -

cannam@136: TrackLevelOutput cannam@136: - Specific output type that returns track level information. This sort of output will require a "hacky" interpretation of the feature timestamp as it will reflect some track metadata instead of temporal data.
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
sub-class-of:PluginOutput
cannam@136: cannam@136:

Class: vamp:Transform - stable -

cannam@136: Transform cannam@136: - The Transform defines the environment of any audio processing computation.
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
in-domain-of:durationstartwindow_typetransform_typeblock_sizestep_sizeparameterprogramenginesample_rateidentifier
cannam@136: cannam@136:

Class: vamp:TransformType - unstable -

cannam@136: TransformType cannam@136: - Specifies the type of transform. May be feature extraction, effect...
cannam@136: cannam@136:
cannam@136:

[back to top]

cannam@136:
cannam@136: cannam@136: cannam@136:
cannam@136: cannam@136:

Properties

cannam@136:

Property: vamp:available_plugin - stable -

cannam@136: available_plugin - Available plugins in the library
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:PluginLibrary
Range:Plugin
cannam@136:
cannam@136:

Property: vamp:bin_count - unstable -

cannam@136: bin_count - Number of elements of the bin output. This information is necessary to define the output as belonging to a specific subclass of Plugin Output.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:PluginOutput
Range:
cannam@136:
cannam@136:

Property: vamp:bin_names - unstable -

cannam@136: bin_names - List of bin names if available
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:PluginOutput
Range:
cannam@136:
cannam@136:

Property: vamp:block_size - stable -

cannam@136: block_size - Specifies the block size for the framing.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Transform
Range:
cannam@136:
cannam@136:

Property: vamp:computes_feature_type - unstable -

cannam@136: computes_feature_type - Feature Types output by the plugin. Links the vamp ontology to the audio features ontology.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:PluginOutput
Range:af:AudioFeature
cannam@136:
cannam@136:

Property: vamp:default_value - unstable -

cannam@136: default_value - Default value of the parameter
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:
Range:ParameterDescriptor
cannam@136:
cannam@136:

Property: vamp:duration - unstable -

cannam@136: duration - Specifies temporal information when processing a data stream.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Transform
Range:
cannam@136:
cannam@136:

Property: vamp:engine - stable -

cannam@136: engine - Specifies the plugin in execution. This is an extension to use Transform with other plugin libraries
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Transform
Range:Plugin
cannam@136:
cannam@136:

Property: vamp:fixed_bin_count - unstable -

cannam@136: fixed_bin_count - Fixed bin count. A boolean type.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:PluginOutput
Range:
cannam@136:
cannam@136:

Property: vamp:identifier - stable -

cannam@136: identifier - Machine-readable identifier for Vamp plugin classes (and Transform).
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:TransformParameterDescriptorPluginOutputPluginProgramPluginDescription
Range:
cannam@136:
cannam@136:

Property: vamp:input_domain - stable -

cannam@136: input_domain - Input domain allowed by the plugin (time or frequency).
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Plugin
Range:InputDomain
cannam@136:
cannam@136:

Property: vamp:max_value - unstable -

cannam@136: max_value - Maximum value of the parameter range
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:
Range:PluginOutputParameterDescriptor
cannam@136:
cannam@136:

Property: vamp:min_value - unstable -

cannam@136: min_value - Minimum value of the parameter range
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:
Range:PluginOutputParameterDescriptor
cannam@136:
cannam@136:

Property: vamp:name - stable -

cannam@136: name - Human-readable identifier for the plugin.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:PluginDescription
Range:
cannam@136:
cannam@136:

Property: vamp:output_descriptor - stable -

cannam@136: output_descriptor - Links each output type to the plugin.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Plugin
Range:PluginOutput
cannam@136:
cannam@136:

Property: vamp:parameter - stable -

cannam@136: parameter - Specifies the parameter to set the plugin in execution.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Transform
Range:Parameter
cannam@136:
cannam@136:

Property: vamp:parameter_descriptor - stable -

cannam@136: parameter_descriptor - Links each parameter descriptor to the plugin.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:ParameterPlugin
Range:ParameterDescriptor
cannam@136:
cannam@136:

Property: vamp:parameter_descriptor - stable -

cannam@136: parameter_descriptor - Specifies exactly the type of descriptor to set in the transform by linking it.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:ParameterPlugin
Range:ParameterDescriptor
cannam@136:
cannam@136:

Property: vamp:plugin_description - stable -

cannam@136: plugin_description - Links the plugin descriptor to the plugin (it may be redundant for an RDF decription to have a plugin descriptor in between an actual plugin and its properties).
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Plugin
Range:PluginDescription
cannam@136:
cannam@136:

Property: vamp:program - stable -

cannam@136: program - Extension for configuration.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Transform
Range:ConfigurationPluginProgram
cannam@136:
cannam@136:

Property: vamp:program - stable -

cannam@136: program - Specifies the program to set the plugin in execution. Here the plugin program matches with the one in the plugin descriptor. There is not descriptor required for the program (just a string), is it?
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Transform
Range:ConfigurationPluginProgram
cannam@136:
cannam@136:

Property: vamp:quantized_step - unstable -

cannam@136: quantized_step - Quantized step (if any). We do not include isQuantized.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:ParameterDescriptorPluginOutput
Range:
cannam@136:
cannam@136:

Property: vamp:sample_rate - stable -

cannam@136: sample_rate - Specifies the sample rate if it is not constant.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:TransformPluginOutput
Range:
cannam@136:
cannam@136:

Property: vamp:sample_rate - stable -

cannam@136: sample_rate - Sample rate of the output if any. Should be read depending on SampleType and Output classes.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:TransformPluginOutput
Range:
cannam@136:
cannam@136:

Property: vamp:sample_rate - unstable -

cannam@136: sample_rate - Specifies the sample rate if it is not constant.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:TransformPluginOutput
Range:
cannam@136:
cannam@136:

Property: vamp:sample_rate - unstable -

cannam@136: sample_rate - Sample rate of the output if any. Should be read depending on SampleType and Output classes.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:TransformPluginOutput
Range:
cannam@136:
cannam@136:

Property: vamp:sample_type - unstable -

cannam@136: sample_type - The sample type specifies the temporal information of the output.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:PluginOutput
Range:SampleType
cannam@136:
cannam@136:

Property: vamp:start - unstable -

cannam@136: start - Specifies temporal information when processing a data stream.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Transform
Range:
cannam@136:
cannam@136:

Property: vamp:step_size - stable -

cannam@136: step_size - Specifies the step size for the framing.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Transform
Range:
cannam@136:
cannam@136:

Property: vamp:transform_type - unstable -

cannam@136: transform_type - Specifies the transform type (we could do this by subclassin transform instead of using a property).
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Transform
Range:
cannam@136:
cannam@136:

Property: vamp:unit - unstable -

cannam@136: unit - Unit of the output/parameter. A string type
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:ParameterDescriptorPluginOutput
Range:
cannam@136:
cannam@136:

Property: vamp:value - stable -

cannam@136: value - Specifies the current value of the parameter.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Parameter
Range:
cannam@136:
cannam@136:

Property: vamp:vamp_API_version - stable -

cannam@136: vamp_API_version - Version of the Vamp API used to implement this plugin.
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:PluginDescription
Range:
cannam@136:
cannam@136:

Property: vamp:window_type - unstable -

cannam@136: window_type - Specifies the window type (they should be individuals and clearly not here).
cannam@136: cannam@136:
cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136: cannam@136:
Domain:Transform
Range:
cannam@136:

Individuals

cannam@136:

Individual: Effect -

cannam@136: Effect - Effect transform. This may be just a subclass of Transform... cannam@136: cannam@136:
cannam@136: cannam@136:
Class:vamp:TransformType
cannam@136:

Individual: FeatureExtraction -

cannam@136: Feature Extraction - Feature extraction transform. This may be just a subclass of Transform... cannam@136: cannam@136:
cannam@136: cannam@136:
Class:vamp:TransformType