au3/lib-src/libvamp/rdf/doc/vamp.html
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.
Classes: | Configuration | DenseOutput | Feature | InputDomain | Parameter | ParameterDescriptor | Plugin | PluginDescription | PluginLibrary | PluginOutput | PluginProgram | SampleType | SparseOutput | TrackLevelOutput | Transform | TransformType |
Properties: | available_plugin | bin_count | bin_names | block_size | computes_feature_type | default_value | duration | engine | fixed_bin_count | identifier | input_domain | max_value | min_value | name | output_descriptor | parameter | parameter_descriptor | plugin_description | program | quantized_step | sample_rate | sample_type | start | step_size | transform_type | unit | value | vamp_API_version | window_type |
Individuals: | Effect | FeatureExtraction | FixedSampleRate | OneSamplePerStep | VariableSampleRate | frequency_domain | time_domain |
Configuration - For extension (SV implementation of Transform).
| in-range-of: | program |
DenseOutput - Specific output type comprising large binary data (e.g.: chromagram).
| sub-class-of: | PluginOutput |
Feature - This may be removed mighty soon as we rely on the Audio Features Ontology for this
InputDomain - 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).
| in-range-of: | input_domain |
Parameter - 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.
| in-range-of: | parameter | | in-domain-of: | value | parameter_descriptor |
ParameterDescriptor - 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.
| in-range-of: | default_value | min_value | max_value | parameter_descriptor | | in-domain-of: | quantized_step | unit | identifier |
Plugin - Vamp plugin is an implementation of a feature extraction algorithm based on the Vamp API.
| in-range-of: | engine | available_plugin | | in-domain-of: | input_domain | output_descriptor | parameter_descriptor | plugin_description |
PluginDescription - The plugin descriptor provides basic metadata of the plugin. We may remove this and link directly to the plugin instance.
| in-range-of: | plugin_description | | in-domain-of: | vamp_API_version | name | identifier |
PluginLibrary - Library of Vamp Plugins. This may need to include rights.
| in-domain-of: | available_plugin |
PluginOutput - 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.
| in-range-of: | min_value | max_value | output_descriptor | | in-domain-of: | computes_feature_type | sample_type | bin_names | bin_count | quantized_step | sample_rate | unit | fixed_bin_count | identifier |
PluginProgram - 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.
| in-range-of: | program | | in-domain-of: | identifier |
SampleType - Sample type specifies the temporal information of the plugin output. This information should be confronted with the output type for a correct interpretation.
| in-range-of: | sample_type |
SparseOutput - Specific output type used in sparse data outputs (e.g.: key detector).
| sub-class-of: | PluginOutput |
TrackLevelOutput - 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.
| sub-class-of: | PluginOutput |
Transform - The Transform defines the environment of any audio processing computation.
| in-domain-of: | duration | start | window_type | transform_type | block_size | step_size | parameter | program | engine | sample_rate | identifier |
TransformType - Specifies the type of transform. May be feature extraction, effect...
available_plugin - Available plugins in the library
| Domain: | PluginLibrary | | Range: | Plugin |
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.
| Domain: | PluginOutput |
| Range: |
|---|
bin_names - List of bin names if available
| Domain: | PluginOutput |
| Range: |
|---|
block_size - Specifies the block size for the framing.
| Domain: | Transform |
| Range: |
|---|
computes_feature_type - Feature Types output by the plugin. Links the vamp ontology to the audio features ontology.
| Domain: | PluginOutput | | Range: | af:AudioFeature |
default_value - Default value of the parameter
| Domain: |
|---|
| Range: |
duration - Specifies temporal information when processing a data stream.
| Domain: | Transform |
| Range: |
|---|
engine - Specifies the plugin in execution. This is an extension to use Transform with other plugin libraries
| Domain: | Transform | | Range: | Plugin |
fixed_bin_count - Fixed bin count. A boolean type.
| Domain: | PluginOutput |
| Range: |
|---|
identifier - Machine-readable identifier for Vamp plugin classes (and Transform).
| Domain: | Transform | ParameterDescriptor | PluginOutput | PluginProgram | PluginDescription |
| Range: |
|---|
input_domain - Input domain allowed by the plugin (time or frequency).
| Domain: | Plugin | | Range: | InputDomain |
max_value - Maximum value of the parameter range
| Domain: |
|---|
| Range: |
min_value - Minimum value of the parameter range
| Domain: |
|---|
| Range: |
name - Human-readable identifier for the plugin.
| Domain: | PluginDescription |
| Range: |
|---|
output_descriptor - Links each output type to the plugin.
| Domain: | Plugin | | Range: | PluginOutput |
parameter - Specifies the parameter to set the plugin in execution.
| Domain: | Transform | | Range: | Parameter |
parameter_descriptor - Links each parameter descriptor to the plugin.
| Domain: | Parameter | Plugin | | Range: | ParameterDescriptor |
parameter_descriptor - Specifies exactly the type of descriptor to set in the transform by linking it.
| Domain: | Parameter | Plugin | | Range: | ParameterDescriptor |
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).
| Domain: | Plugin | | Range: | PluginDescription |
program - Extension for configuration.
| Domain: | Transform | | Range: | Configuration | PluginProgram |
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?
| Domain: | Transform | | Range: | Configuration | PluginProgram |
quantized_step - Quantized step (if any). We do not include isQuantized.
| Domain: | ParameterDescriptor | PluginOutput |
| Range: |
|---|
sample_rate - Specifies the sample rate if it is not constant.
| Domain: | Transform | PluginOutput |
| Range: |
|---|
sample_rate - Sample rate of the output if any. Should be read depending on SampleType and Output classes.
| Domain: | Transform | PluginOutput |
| Range: |
|---|
sample_rate - Specifies the sample rate if it is not constant.
| Domain: | Transform | PluginOutput |
| Range: |
|---|
sample_rate - Sample rate of the output if any. Should be read depending on SampleType and Output classes.
| Domain: | Transform | PluginOutput |
| Range: |
|---|
sample_type - The sample type specifies the temporal information of the output.
| Domain: | PluginOutput | | Range: | SampleType |
start - Specifies temporal information when processing a data stream.
| Domain: | Transform |
| Range: |
|---|
step_size - Specifies the step size for the framing.
| Domain: | Transform |
| Range: |
|---|
transform_type - Specifies the transform type (we could do this by subclassin transform instead of using a property).
| Domain: | Transform |
| Range: |
|---|
unit - Unit of the output/parameter. A string type
| Domain: | ParameterDescriptor | PluginOutput |
| Range: |
|---|
value - Specifies the current value of the parameter.
| Domain: | Parameter |
| Range: |
|---|
vamp_API_version - Version of the Vamp API used to implement this plugin.
| Domain: | PluginDescription |
| Range: |
|---|
window_type - Specifies the window type (they should be individuals and clearly not here).
| Domain: | Transform |
| Range: |
|---|
Effect - Effect transform. This may be just a subclass of Transform...
| Class: | vamp:TransformType |
Feature Extraction - Feature extraction transform. This may be just a subclass of Transform...
| Class: | vamp:TransformType |