Mercurial > hg > vamp-plugin-sdk
comparison rdf/doc/vamp.html @ 136:1b1ebb0f10ac
* update RDF from km-rdf repository
| author | cannam |
|---|---|
| date | Wed, 11 Jun 2008 09:14:27 +0000 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 135:6bffd86a103d | 136:1b1ebb0f10ac |
|---|---|
| 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | |
| 2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> | |
| 3 <head> | |
| 4 <link rel="meta" type="application/rdf+xml" title="FOAF" href="" /> | |
| 5 <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> | |
| 6 <meta name="author" content="" /> | |
| 7 <link href="style.css" rel="stylesheet" type="text/css" /><meta name="robots" content="all" /> | |
| 8 <title>Vamp Plugins Ontology</title> | |
| 9 </head> | |
| 10 <body><h2 id="overview">Overview of Terms</h2> | |
| 11 <p>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.</p><div class="glance" id="glance"> | |
| 12 <p>Classes: | <a href="#term_Configuration">Configuration</a> | <a href="#term_DenseOutput">DenseOutput</a> | <a href="#term_Feature">Feature</a> | <a href="#term_InputDomain">InputDomain</a> | <a href="#term_Parameter">Parameter</a> | <a href="#term_ParameterDescriptor">ParameterDescriptor</a> | <a href="#term_Plugin">Plugin</a> | <a href="#term_PluginDescription">PluginDescription</a> | <a href="#term_PluginLibrary">PluginLibrary</a> | <a href="#term_PluginOutput">PluginOutput</a> | <a href="#term_PluginProgram">PluginProgram</a> | <a href="#term_SampleType">SampleType</a> | <a href="#term_SparseOutput">SparseOutput</a> | <a href="#term_TrackLevelOutput">TrackLevelOutput</a> | <a href="#term_Transform">Transform</a> | <a href="#term_TransformType">TransformType</a> | </p> | |
| 13 <p>Properties: | <a href="#term_available_plugin">available_plugin</a> | | |
| 14 <a href="#term_bin_count">bin_count</a> | | |
| 15 <a href="#term_bin_names">bin_names</a> | | |
| 16 <a href="#term_block_size">block_size</a> | | |
| 17 <a href="#term_computes_feature_type">computes_feature_type</a> | | |
| 18 <a href="#term_default_value">default_value</a> | | |
| 19 <a href="#term_duration">duration</a> | | |
| 20 <a href="#term_engine">engine</a> | | |
| 21 <a href="#term_fixed_bin_count">fixed_bin_count</a> | | |
| 22 <a href="#term_identifier">identifier</a> | | |
| 23 <a href="#term_input_domain">input_domain</a> | | |
| 24 <a href="#term_max_value">max_value</a> | | |
| 25 <a href="#term_min_value">min_value</a> | | |
| 26 <a href="#term_name">name</a> | | |
| 27 <a href="#term_output_descriptor">output_descriptor</a> | | |
| 28 <a href="#term_parameter">parameter</a> | | |
| 29 <a href="#term_parameter_descriptor">parameter_descriptor</a> | | |
| 30 <a href="#term_plugin_description">plugin_description</a> | | |
| 31 <a href="#term_program">program</a> | | |
| 32 <a href="#term_quantized_step">quantized_step</a> | | |
| 33 <a href="#term_sample_rate">sample_rate</a> | | |
| 34 <a href="#term_sample_type">sample_type</a> | | |
| 35 <a href="#term_start">start</a> | | |
| 36 <a href="#term_step_size">step_size</a> | | |
| 37 <a href="#term_transform_type">transform_type</a> | | |
| 38 <a href="#term_unit">unit</a> | | |
| 39 <a href="#term_value">value</a> | | |
| 40 <a href="#term_vamp_API_version">vamp_API_version</a> | | |
| 41 <a href="#term_window_type">window_type</a> | | |
| 42 </p> | |
| 43 <p>Individuals: | <a href="#term_Effect">Effect</a> | | |
| 44 <a href="#term_FeatureExtraction">FeatureExtraction</a> | | |
| 45 <a href="#term_FixedSampleRate">FixedSampleRate</a> | | |
| 46 <a href="#term_OneSamplePerStep">OneSamplePerStep</a> | | |
| 47 <a href="#term_VariableSampleRate">VariableSampleRate</a> | | |
| 48 <a href="#term_frequency_domain">frequency_domain</a> | | |
| 49 <a href="#term_time_domain">time_domain</a> | | |
| 50 </p></div><h2 id="terms_classes">Classes</h2><div class="specterm" id="term_Configuration"><h3>Class: vamp:Configuration - unstable - </h3> | |
| 51 <em>Configuration</em> | |
| 52 - For extension (SV implementation of Transform).<br/> | |
| 53 | |
| 54 <br/> | |
| 55 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 56 <br/> | |
| 57 <table style="th { float: top; }"><tr><th>in-range-of:</th><td><a href="#term_program">program</a></td> | |
| 58 </tr> | |
| 59 | |
| 60 | |
| 61 </table> | |
| 62 | |
| 63 </div><div class="specterm" id="term_DenseOutput"><h3>Class: vamp:DenseOutput - unstable - </h3> | |
| 64 <em>DenseOutput</em> | |
| 65 - Specific output type comprising large binary data (e.g.: chromagram).<br/> | |
| 66 | |
| 67 <br/> | |
| 68 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 69 <br/> | |
| 70 <table style="th { float: top; }"> | |
| 71 | |
| 72 <tr><th>sub-class-of:</th><td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 73 </tr> | |
| 74 </table> | |
| 75 | |
| 76 </div><div class="specterm" id="term_Feature"><h3>Class: vamp:Feature - deprecated - </h3> | |
| 77 <em>Feature</em> | |
| 78 - This may be removed mighty soon as we rely on the Audio Features Ontology for this | |
| 79 <br/> | |
| 80 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 81 <br/> | |
| 82 <table style="th { float: top; }"> | |
| 83 | |
| 84 </table> | |
| 85 | |
| 86 </div><div class="specterm" id="term_InputDomain"><h3>Class: vamp:InputDomain - stable - </h3> | |
| 87 <em>InputDomain</em> | |
| 88 - 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).<br/> | |
| 89 | |
| 90 <br/> | |
| 91 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 92 <br/> | |
| 93 <table style="th { float: top; }"><tr><th>in-range-of:</th><td><a href="#term_input_domain">input_domain</a></td> | |
| 94 </tr> | |
| 95 | |
| 96 | |
| 97 </table> | |
| 98 | |
| 99 </div><div class="specterm" id="term_Parameter"><h3>Class: vamp:Parameter - unstable - </h3> | |
| 100 <em>Parameter</em> | |
| 101 - 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.<br/> | |
| 102 | |
| 103 <br/> | |
| 104 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 105 <br/> | |
| 106 <table style="th { float: top; }"><tr><th>in-range-of:</th><td><a href="#term_parameter">parameter</a></td> | |
| 107 </tr> | |
| 108 | |
| 109 <tr><th>in-domain-of:</th><td><a href="#term_value">value</a></td> | |
| 110 <td><a href="#term_parameter_descriptor">parameter_descriptor</a></td> | |
| 111 </tr> | |
| 112 | |
| 113 </table> | |
| 114 | |
| 115 </div><div class="specterm" id="term_ParameterDescriptor"><h3>Class: vamp:ParameterDescriptor - stable - </h3> | |
| 116 <em>ParameterDescriptor</em> | |
| 117 - 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.<br/> | |
| 118 | |
| 119 <br/> | |
| 120 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 121 <br/> | |
| 122 <table style="th { float: top; }"><tr><th>in-range-of:</th><td><a href="#term_default_value">default_value</a></td> | |
| 123 <td><a href="#term_min_value">min_value</a></td> | |
| 124 <td><a href="#term_max_value">max_value</a></td> | |
| 125 <td><a href="#term_parameter_descriptor">parameter_descriptor</a></td> | |
| 126 </tr> | |
| 127 | |
| 128 <tr><th>in-domain-of:</th><td><a href="#term_quantized_step">quantized_step</a></td> | |
| 129 <td><a href="#term_unit">unit</a></td> | |
| 130 <td><a href="#term_identifier">identifier</a></td> | |
| 131 </tr> | |
| 132 | |
| 133 </table> | |
| 134 | |
| 135 </div><div class="specterm" id="term_Plugin"><h3>Class: vamp:Plugin - stable - </h3> | |
| 136 <em>Plugin</em> | |
| 137 - Vamp plugin is an implementation of a feature extraction algorithm based on the Vamp API. <br/> | |
| 138 | |
| 139 <br/> | |
| 140 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 141 <br/> | |
| 142 <table style="th { float: top; }"><tr><th>in-range-of:</th><td><a href="#term_engine">engine</a></td> | |
| 143 <td><a href="#term_available_plugin">available_plugin</a></td> | |
| 144 </tr> | |
| 145 | |
| 146 <tr><th>in-domain-of:</th><td><a href="#term_input_domain">input_domain</a></td> | |
| 147 <td><a href="#term_output_descriptor">output_descriptor</a></td> | |
| 148 <td><a href="#term_parameter_descriptor">parameter_descriptor</a></td> | |
| 149 <td><a href="#term_plugin_description">plugin_description</a></td> | |
| 150 </tr> | |
| 151 | |
| 152 </table> | |
| 153 | |
| 154 </div><div class="specterm" id="term_PluginDescription"><h3>Class: vamp:PluginDescription - unstable - </h3> | |
| 155 <em>PluginDescription</em> | |
| 156 - The plugin descriptor provides basic metadata of the plugin. We may remove this and link directly to the plugin instance.<br/> | |
| 157 | |
| 158 <br/> | |
| 159 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 160 <br/> | |
| 161 <table style="th { float: top; }"><tr><th>in-range-of:</th><td><a href="#term_plugin_description">plugin_description</a></td> | |
| 162 </tr> | |
| 163 | |
| 164 <tr><th>in-domain-of:</th><td><a href="#term_vamp_API_version">vamp_API_version</a></td> | |
| 165 <td><a href="#term_name">name</a></td> | |
| 166 <td><a href="#term_identifier">identifier</a></td> | |
| 167 </tr> | |
| 168 | |
| 169 </table> | |
| 170 | |
| 171 </div><div class="specterm" id="term_PluginLibrary"><h3>Class: vamp:PluginLibrary - stable - </h3> | |
| 172 <em>PluginLibrary</em> | |
| 173 - Library of Vamp Plugins. This may need to include rights.<br/> | |
| 174 | |
| 175 <br/> | |
| 176 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 177 <br/> | |
| 178 <table style="th { float: top; }"> | |
| 179 <tr><th>in-domain-of:</th><td><a href="#term_available_plugin">available_plugin</a></td> | |
| 180 </tr> | |
| 181 | |
| 182 </table> | |
| 183 | |
| 184 </div><div class="specterm" id="term_PluginOutput"><h3>Class: vamp:PluginOutput - unstable - </h3> | |
| 185 <em>PluginOutput</em> | |
| 186 - 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.<br/> | |
| 187 | |
| 188 <br/> | |
| 189 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 190 <br/> | |
| 191 <table style="th { float: top; }"><tr><th>in-range-of:</th><td><a href="#term_min_value">min_value</a></td> | |
| 192 <td><a href="#term_max_value">max_value</a></td> | |
| 193 <td><a href="#term_output_descriptor">output_descriptor</a></td> | |
| 194 </tr> | |
| 195 | |
| 196 <tr><th>in-domain-of:</th><td><a href="#term_computes_feature_type">computes_feature_type</a></td> | |
| 197 <td><a href="#term_sample_type">sample_type</a></td> | |
| 198 <td><a href="#term_bin_names">bin_names</a></td> | |
| 199 <td><a href="#term_bin_count">bin_count</a></td> | |
| 200 <td><a href="#term_quantized_step">quantized_step</a></td> | |
| 201 <td><a href="#term_sample_rate">sample_rate</a></td> | |
| 202 <td><a href="#term_unit">unit</a></td> | |
| 203 <td><a href="#term_fixed_bin_count">fixed_bin_count</a></td> | |
| 204 <td><a href="#term_identifier">identifier</a></td> | |
| 205 </tr> | |
| 206 | |
| 207 </table> | |
| 208 | |
| 209 </div><div class="specterm" id="term_PluginProgram"><h3>Class: vamp:PluginProgram - unstable - </h3> | |
| 210 <em>PluginProgram</em> | |
| 211 - 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.<br/> | |
| 212 | |
| 213 <br/> | |
| 214 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 215 <br/> | |
| 216 <table style="th { float: top; }"><tr><th>in-range-of:</th><td><a href="#term_program">program</a></td> | |
| 217 </tr> | |
| 218 | |
| 219 <tr><th>in-domain-of:</th><td><a href="#term_identifier">identifier</a></td> | |
| 220 </tr> | |
| 221 | |
| 222 </table> | |
| 223 | |
| 224 </div><div class="specterm" id="term_SampleType"><h3>Class: vamp:SampleType - stable - </h3> | |
| 225 <em>SampleType</em> | |
| 226 - Sample type specifies the temporal information of the plugin output. This information should be confronted with the output type for a correct interpretation.<br/> | |
| 227 | |
| 228 <br/> | |
| 229 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 230 <br/> | |
| 231 <table style="th { float: top; }"><tr><th>in-range-of:</th><td><a href="#term_sample_type">sample_type</a></td> | |
| 232 </tr> | |
| 233 | |
| 234 | |
| 235 </table> | |
| 236 | |
| 237 </div><div class="specterm" id="term_SparseOutput"><h3>Class: vamp:SparseOutput - unstable - </h3> | |
| 238 <em>SparseOutput</em> | |
| 239 - Specific output type used in sparse data outputs (e.g.: key detector).<br/> | |
| 240 | |
| 241 <br/> | |
| 242 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 243 <br/> | |
| 244 <table style="th { float: top; }"> | |
| 245 | |
| 246 <tr><th>sub-class-of:</th><td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 247 </tr> | |
| 248 </table> | |
| 249 | |
| 250 </div><div class="specterm" id="term_TrackLevelOutput"><h3>Class: vamp:TrackLevelOutput - unstable - </h3> | |
| 251 <em>TrackLevelOutput</em> | |
| 252 - 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.<br/> | |
| 253 | |
| 254 <br/> | |
| 255 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 256 <br/> | |
| 257 <table style="th { float: top; }"> | |
| 258 | |
| 259 <tr><th>sub-class-of:</th><td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 260 </tr> | |
| 261 </table> | |
| 262 | |
| 263 </div><div class="specterm" id="term_Transform"><h3>Class: vamp:Transform - stable - </h3> | |
| 264 <em>Transform</em> | |
| 265 - The Transform defines the environment of any audio processing computation. <br/> | |
| 266 | |
| 267 <br/> | |
| 268 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 269 <br/> | |
| 270 <table style="th { float: top; }"> | |
| 271 <tr><th>in-domain-of:</th><td><a href="#term_duration">duration</a></td> | |
| 272 <td><a href="#term_start">start</a></td> | |
| 273 <td><a href="#term_window_type">window_type</a></td> | |
| 274 <td><a href="#term_transform_type">transform_type</a></td> | |
| 275 <td><a href="#term_block_size">block_size</a></td> | |
| 276 <td><a href="#term_step_size">step_size</a></td> | |
| 277 <td><a href="#term_parameter">parameter</a></td> | |
| 278 <td><a href="#term_program">program</a></td> | |
| 279 <td><a href="#term_engine">engine</a></td> | |
| 280 <td><a href="#term_sample_rate">sample_rate</a></td> | |
| 281 <td><a href="#term_identifier">identifier</a></td> | |
| 282 </tr> | |
| 283 | |
| 284 </table> | |
| 285 | |
| 286 </div><div class="specterm" id="term_TransformType"><h3>Class: vamp:TransformType - unstable - </h3> | |
| 287 <em>TransformType</em> | |
| 288 - Specifies the type of transform. May be feature extraction, effect...<br/> | |
| 289 | |
| 290 <br/> | |
| 291 <p style="float: right; font-size: small;">[<a href="#glance">back to top</a>]</p> | |
| 292 <br/> | |
| 293 <table style="th { float: top; }"> | |
| 294 | |
| 295 </table> | |
| 296 | |
| 297 </div><h2 id="terms_props">Properties</h2><div class="specterm" id="term_available_plugin"> | |
| 298 <h3>Property: vamp:available_plugin - stable - </h3> | |
| 299 <em>available_plugin</em> - Available plugins in the library<br/> | |
| 300 | |
| 301 <br/><table style="th { float: top; }"> | |
| 302 <tr><th>Domain:</th> | |
| 303 <td><a href="#term_PluginLibrary">PluginLibrary</a></td> | |
| 304 | |
| 305 </tr> | |
| 306 <tr><th>Range:</th> | |
| 307 <td><a href="#term_Plugin">Plugin</a></td> | |
| 308 </tr> | |
| 309 | |
| 310 | |
| 311 </table> | |
| 312 <br/></div><div class="specterm" id="term_bin_count"> | |
| 313 <h3>Property: vamp:bin_count - unstable - </h3> | |
| 314 <em>bin_count</em> - Number of elements of the bin output. This information is necessary to define the output as belonging to a specific subclass of Plugin Output.<br/> | |
| 315 | |
| 316 <br/><table style="th { float: top; }"> | |
| 317 <tr><th>Domain:</th> | |
| 318 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 319 | |
| 320 </tr> | |
| 321 <tr><th>Range:</th> | |
| 322 </tr> | |
| 323 | |
| 324 | |
| 325 </table> | |
| 326 <br/></div><div class="specterm" id="term_bin_names"> | |
| 327 <h3>Property: vamp:bin_names - unstable - </h3> | |
| 328 <em>bin_names</em> - List of bin names if available<br/> | |
| 329 | |
| 330 <br/><table style="th { float: top; }"> | |
| 331 <tr><th>Domain:</th> | |
| 332 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 333 | |
| 334 </tr> | |
| 335 <tr><th>Range:</th> | |
| 336 </tr> | |
| 337 | |
| 338 | |
| 339 </table> | |
| 340 <br/></div><div class="specterm" id="term_block_size"> | |
| 341 <h3>Property: vamp:block_size - stable - </h3> | |
| 342 <em>block_size</em> - Specifies the block size for the framing. <br/> | |
| 343 | |
| 344 <br/><table style="th { float: top; }"> | |
| 345 <tr><th>Domain:</th> | |
| 346 <td><a href="#term_Transform">Transform</a></td> | |
| 347 | |
| 348 </tr> | |
| 349 <tr><th>Range:</th> | |
| 350 </tr> | |
| 351 | |
| 352 | |
| 353 </table> | |
| 354 <br/></div><div class="specterm" id="term_computes_feature_type"> | |
| 355 <h3>Property: vamp:computes_feature_type - unstable - </h3> | |
| 356 <em>computes_feature_type</em> - Feature Types output by the plugin. Links the vamp ontology to the audio features ontology.<br/> | |
| 357 | |
| 358 <br/><table style="th { float: top; }"> | |
| 359 <tr><th>Domain:</th> | |
| 360 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 361 | |
| 362 </tr> | |
| 363 <tr><th>Range:</th> | |
| 364 <td><a href="http://purl.org/ontology/af/AudioFeature">af:AudioFeature</a></td> | |
| 365 </tr> | |
| 366 | |
| 367 | |
| 368 </table> | |
| 369 <br/></div><div class="specterm" id="term_default_value"> | |
| 370 <h3>Property: vamp:default_value - unstable - </h3> | |
| 371 <em>default_value</em> - Default value of the parameter<br/> | |
| 372 | |
| 373 <br/><table style="th { float: top; }"> | |
| 374 <tr><th>Domain:</th> | |
| 375 | |
| 376 </tr> | |
| 377 <tr><th>Range:</th> | |
| 378 <td><a href="#term_ParameterDescriptor">ParameterDescriptor</a></td> | |
| 379 </tr> | |
| 380 | |
| 381 | |
| 382 </table> | |
| 383 <br/></div><div class="specterm" id="term_duration"> | |
| 384 <h3>Property: vamp:duration - unstable - </h3> | |
| 385 <em>duration</em> - Specifies temporal information when processing a data stream. <br/> | |
| 386 | |
| 387 <br/><table style="th { float: top; }"> | |
| 388 <tr><th>Domain:</th> | |
| 389 <td><a href="#term_Transform">Transform</a></td> | |
| 390 | |
| 391 </tr> | |
| 392 <tr><th>Range:</th> | |
| 393 </tr> | |
| 394 | |
| 395 | |
| 396 </table> | |
| 397 <br/></div><div class="specterm" id="term_engine"> | |
| 398 <h3>Property: vamp:engine - stable - </h3> | |
| 399 <em>engine</em> - Specifies the plugin in execution. This is an extension to use Transform with other plugin libraries<br/> | |
| 400 | |
| 401 <br/><table style="th { float: top; }"> | |
| 402 <tr><th>Domain:</th> | |
| 403 <td><a href="#term_Transform">Transform</a></td> | |
| 404 | |
| 405 </tr> | |
| 406 <tr><th>Range:</th> | |
| 407 <td><a href="#term_Plugin">Plugin</a></td> | |
| 408 </tr> | |
| 409 | |
| 410 | |
| 411 </table> | |
| 412 <br/></div><div class="specterm" id="term_fixed_bin_count"> | |
| 413 <h3>Property: vamp:fixed_bin_count - unstable - </h3> | |
| 414 <em>fixed_bin_count</em> - Fixed bin count. A boolean type.<br/> | |
| 415 | |
| 416 <br/><table style="th { float: top; }"> | |
| 417 <tr><th>Domain:</th> | |
| 418 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 419 | |
| 420 </tr> | |
| 421 <tr><th>Range:</th> | |
| 422 </tr> | |
| 423 | |
| 424 | |
| 425 </table> | |
| 426 <br/></div><div class="specterm" id="term_identifier"> | |
| 427 <h3>Property: vamp:identifier - stable - </h3> | |
| 428 <em>identifier</em> - Machine-readable identifier for Vamp plugin classes (and Transform).<br/> | |
| 429 | |
| 430 <br/><table style="th { float: top; }"> | |
| 431 <tr><th>Domain:</th> | |
| 432 <td><a href="#term_Transform">Transform</a></td> | |
| 433 <td><a href="#term_ParameterDescriptor">ParameterDescriptor</a></td> | |
| 434 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 435 <td><a href="#term_PluginProgram">PluginProgram</a></td> | |
| 436 <td><a href="#term_PluginDescription">PluginDescription</a></td> | |
| 437 | |
| 438 </tr> | |
| 439 <tr><th>Range:</th> | |
| 440 </tr> | |
| 441 | |
| 442 | |
| 443 </table> | |
| 444 <br/></div><div class="specterm" id="term_input_domain"> | |
| 445 <h3>Property: vamp:input_domain - stable - </h3> | |
| 446 <em>input_domain</em> - Input domain allowed by the plugin (time or frequency).<br/> | |
| 447 | |
| 448 <br/><table style="th { float: top; }"> | |
| 449 <tr><th>Domain:</th> | |
| 450 <td><a href="#term_Plugin">Plugin</a></td> | |
| 451 | |
| 452 </tr> | |
| 453 <tr><th>Range:</th> | |
| 454 <td><a href="#term_InputDomain">InputDomain</a></td> | |
| 455 </tr> | |
| 456 | |
| 457 | |
| 458 </table> | |
| 459 <br/></div><div class="specterm" id="term_max_value"> | |
| 460 <h3>Property: vamp:max_value - unstable - </h3> | |
| 461 <em>max_value</em> - Maximum value of the parameter range<br/> | |
| 462 | |
| 463 <br/><table style="th { float: top; }"> | |
| 464 <tr><th>Domain:</th> | |
| 465 | |
| 466 </tr> | |
| 467 <tr><th>Range:</th> | |
| 468 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 469 <td><a href="#term_ParameterDescriptor">ParameterDescriptor</a></td> | |
| 470 </tr> | |
| 471 | |
| 472 | |
| 473 </table> | |
| 474 <br/></div><div class="specterm" id="term_min_value"> | |
| 475 <h3>Property: vamp:min_value - unstable - </h3> | |
| 476 <em>min_value</em> - Minimum value of the parameter range<br/> | |
| 477 | |
| 478 <br/><table style="th { float: top; }"> | |
| 479 <tr><th>Domain:</th> | |
| 480 | |
| 481 </tr> | |
| 482 <tr><th>Range:</th> | |
| 483 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 484 <td><a href="#term_ParameterDescriptor">ParameterDescriptor</a></td> | |
| 485 </tr> | |
| 486 | |
| 487 | |
| 488 </table> | |
| 489 <br/></div><div class="specterm" id="term_name"> | |
| 490 <h3>Property: vamp:name - stable - </h3> | |
| 491 <em>name</em> - Human-readable identifier for the plugin.<br/> | |
| 492 | |
| 493 <br/><table style="th { float: top; }"> | |
| 494 <tr><th>Domain:</th> | |
| 495 <td><a href="#term_PluginDescription">PluginDescription</a></td> | |
| 496 | |
| 497 </tr> | |
| 498 <tr><th>Range:</th> | |
| 499 </tr> | |
| 500 | |
| 501 | |
| 502 </table> | |
| 503 <br/></div><div class="specterm" id="term_output_descriptor"> | |
| 504 <h3>Property: vamp:output_descriptor - stable - </h3> | |
| 505 <em>output_descriptor</em> - Links each output type to the plugin.<br/> | |
| 506 | |
| 507 <br/><table style="th { float: top; }"> | |
| 508 <tr><th>Domain:</th> | |
| 509 <td><a href="#term_Plugin">Plugin</a></td> | |
| 510 | |
| 511 </tr> | |
| 512 <tr><th>Range:</th> | |
| 513 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 514 </tr> | |
| 515 | |
| 516 | |
| 517 </table> | |
| 518 <br/></div><div class="specterm" id="term_parameter"> | |
| 519 <h3>Property: vamp:parameter - stable - </h3> | |
| 520 <em>parameter</em> - Specifies the parameter to set the plugin in execution. <br/> | |
| 521 | |
| 522 <br/><table style="th { float: top; }"> | |
| 523 <tr><th>Domain:</th> | |
| 524 <td><a href="#term_Transform">Transform</a></td> | |
| 525 | |
| 526 </tr> | |
| 527 <tr><th>Range:</th> | |
| 528 <td><a href="#term_Parameter">Parameter</a></td> | |
| 529 </tr> | |
| 530 | |
| 531 | |
| 532 </table> | |
| 533 <br/></div><div class="specterm" id="term_parameter_descriptor"> | |
| 534 <h3>Property: vamp:parameter_descriptor - stable - </h3> | |
| 535 <em>parameter_descriptor</em> - Links each parameter descriptor to the plugin.<br/> | |
| 536 | |
| 537 <br/><table style="th { float: top; }"> | |
| 538 <tr><th>Domain:</th> | |
| 539 <td><a href="#term_Parameter">Parameter</a></td> | |
| 540 <td><a href="#term_Plugin">Plugin</a></td> | |
| 541 | |
| 542 </tr> | |
| 543 <tr><th>Range:</th> | |
| 544 <td><a href="#term_ParameterDescriptor">ParameterDescriptor</a></td> | |
| 545 </tr> | |
| 546 | |
| 547 | |
| 548 </table> | |
| 549 <br/></div><div class="specterm" id="term_parameter_descriptor"> | |
| 550 <h3>Property: vamp:parameter_descriptor - stable - </h3> | |
| 551 <em>parameter_descriptor</em> - Specifies exactly the type of descriptor to set in the transform by linking it.<br/> | |
| 552 | |
| 553 <br/><table style="th { float: top; }"> | |
| 554 <tr><th>Domain:</th> | |
| 555 <td><a href="#term_Parameter">Parameter</a></td> | |
| 556 <td><a href="#term_Plugin">Plugin</a></td> | |
| 557 | |
| 558 </tr> | |
| 559 <tr><th>Range:</th> | |
| 560 <td><a href="#term_ParameterDescriptor">ParameterDescriptor</a></td> | |
| 561 </tr> | |
| 562 | |
| 563 | |
| 564 </table> | |
| 565 <br/></div><div class="specterm" id="term_plugin_description"> | |
| 566 <h3>Property: vamp:plugin_description - stable - </h3> | |
| 567 <em>plugin_description</em> - 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).<br/> | |
| 568 | |
| 569 <br/><table style="th { float: top; }"> | |
| 570 <tr><th>Domain:</th> | |
| 571 <td><a href="#term_Plugin">Plugin</a></td> | |
| 572 | |
| 573 </tr> | |
| 574 <tr><th>Range:</th> | |
| 575 <td><a href="#term_PluginDescription">PluginDescription</a></td> | |
| 576 </tr> | |
| 577 | |
| 578 | |
| 579 </table> | |
| 580 <br/></div><div class="specterm" id="term_program"> | |
| 581 <h3>Property: vamp:program - stable - </h3> | |
| 582 <em>program</em> - Extension for configuration. <br/> | |
| 583 | |
| 584 <br/><table style="th { float: top; }"> | |
| 585 <tr><th>Domain:</th> | |
| 586 <td><a href="#term_Transform">Transform</a></td> | |
| 587 | |
| 588 </tr> | |
| 589 <tr><th>Range:</th> | |
| 590 <td><a href="#term_Configuration">Configuration</a></td> | |
| 591 <td><a href="#term_PluginProgram">PluginProgram</a></td> | |
| 592 </tr> | |
| 593 | |
| 594 | |
| 595 </table> | |
| 596 <br/></div><div class="specterm" id="term_program"> | |
| 597 <h3>Property: vamp:program - stable - </h3> | |
| 598 <em>program</em> - 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?<br/> | |
| 599 | |
| 600 <br/><table style="th { float: top; }"> | |
| 601 <tr><th>Domain:</th> | |
| 602 <td><a href="#term_Transform">Transform</a></td> | |
| 603 | |
| 604 </tr> | |
| 605 <tr><th>Range:</th> | |
| 606 <td><a href="#term_Configuration">Configuration</a></td> | |
| 607 <td><a href="#term_PluginProgram">PluginProgram</a></td> | |
| 608 </tr> | |
| 609 | |
| 610 | |
| 611 </table> | |
| 612 <br/></div><div class="specterm" id="term_quantized_step"> | |
| 613 <h3>Property: vamp:quantized_step - unstable - </h3> | |
| 614 <em>quantized_step</em> - Quantized step (if any). We do not include isQuantized.<br/> | |
| 615 | |
| 616 <br/><table style="th { float: top; }"> | |
| 617 <tr><th>Domain:</th> | |
| 618 <td><a href="#term_ParameterDescriptor">ParameterDescriptor</a></td> | |
| 619 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 620 | |
| 621 </tr> | |
| 622 <tr><th>Range:</th> | |
| 623 </tr> | |
| 624 | |
| 625 | |
| 626 </table> | |
| 627 <br/></div><div class="specterm" id="term_sample_rate"> | |
| 628 <h3>Property: vamp:sample_rate - stable - </h3> | |
| 629 <em>sample_rate</em> - Specifies the sample rate if it is not constant.<br/> | |
| 630 | |
| 631 <br/><table style="th { float: top; }"> | |
| 632 <tr><th>Domain:</th> | |
| 633 <td><a href="#term_Transform">Transform</a></td> | |
| 634 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 635 | |
| 636 </tr> | |
| 637 <tr><th>Range:</th> | |
| 638 </tr> | |
| 639 | |
| 640 | |
| 641 </table> | |
| 642 <br/></div><div class="specterm" id="term_sample_rate"> | |
| 643 <h3>Property: vamp:sample_rate - stable - </h3> | |
| 644 <em>sample_rate</em> - Sample rate of the output if any. Should be read depending on SampleType and Output classes.<br/> | |
| 645 | |
| 646 <br/><table style="th { float: top; }"> | |
| 647 <tr><th>Domain:</th> | |
| 648 <td><a href="#term_Transform">Transform</a></td> | |
| 649 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 650 | |
| 651 </tr> | |
| 652 <tr><th>Range:</th> | |
| 653 </tr> | |
| 654 | |
| 655 | |
| 656 </table> | |
| 657 <br/></div><div class="specterm" id="term_sample_rate"> | |
| 658 <h3>Property: vamp:sample_rate - unstable - </h3> | |
| 659 <em>sample_rate</em> - Specifies the sample rate if it is not constant.<br/> | |
| 660 | |
| 661 <br/><table style="th { float: top; }"> | |
| 662 <tr><th>Domain:</th> | |
| 663 <td><a href="#term_Transform">Transform</a></td> | |
| 664 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 665 | |
| 666 </tr> | |
| 667 <tr><th>Range:</th> | |
| 668 </tr> | |
| 669 | |
| 670 | |
| 671 </table> | |
| 672 <br/></div><div class="specterm" id="term_sample_rate"> | |
| 673 <h3>Property: vamp:sample_rate - unstable - </h3> | |
| 674 <em>sample_rate</em> - Sample rate of the output if any. Should be read depending on SampleType and Output classes.<br/> | |
| 675 | |
| 676 <br/><table style="th { float: top; }"> | |
| 677 <tr><th>Domain:</th> | |
| 678 <td><a href="#term_Transform">Transform</a></td> | |
| 679 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 680 | |
| 681 </tr> | |
| 682 <tr><th>Range:</th> | |
| 683 </tr> | |
| 684 | |
| 685 | |
| 686 </table> | |
| 687 <br/></div><div class="specterm" id="term_sample_type"> | |
| 688 <h3>Property: vamp:sample_type - unstable - </h3> | |
| 689 <em>sample_type</em> - The sample type specifies the temporal information of the output.<br/> | |
| 690 | |
| 691 <br/><table style="th { float: top; }"> | |
| 692 <tr><th>Domain:</th> | |
| 693 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 694 | |
| 695 </tr> | |
| 696 <tr><th>Range:</th> | |
| 697 <td><a href="#term_SampleType">SampleType</a></td> | |
| 698 </tr> | |
| 699 | |
| 700 | |
| 701 </table> | |
| 702 <br/></div><div class="specterm" id="term_start"> | |
| 703 <h3>Property: vamp:start - unstable - </h3> | |
| 704 <em>start</em> - Specifies temporal information when processing a data stream. <br/> | |
| 705 | |
| 706 <br/><table style="th { float: top; }"> | |
| 707 <tr><th>Domain:</th> | |
| 708 <td><a href="#term_Transform">Transform</a></td> | |
| 709 | |
| 710 </tr> | |
| 711 <tr><th>Range:</th> | |
| 712 </tr> | |
| 713 | |
| 714 | |
| 715 </table> | |
| 716 <br/></div><div class="specterm" id="term_step_size"> | |
| 717 <h3>Property: vamp:step_size - stable - </h3> | |
| 718 <em>step_size</em> - Specifies the step size for the framing. <br/> | |
| 719 | |
| 720 <br/><table style="th { float: top; }"> | |
| 721 <tr><th>Domain:</th> | |
| 722 <td><a href="#term_Transform">Transform</a></td> | |
| 723 | |
| 724 </tr> | |
| 725 <tr><th>Range:</th> | |
| 726 </tr> | |
| 727 | |
| 728 | |
| 729 </table> | |
| 730 <br/></div><div class="specterm" id="term_transform_type"> | |
| 731 <h3>Property: vamp:transform_type - unstable - </h3> | |
| 732 <em>transform_type</em> - Specifies the transform type (we could do this by subclassin transform instead of using a property). <br/> | |
| 733 | |
| 734 <br/><table style="th { float: top; }"> | |
| 735 <tr><th>Domain:</th> | |
| 736 <td><a href="#term_Transform">Transform</a></td> | |
| 737 | |
| 738 </tr> | |
| 739 <tr><th>Range:</th> | |
| 740 </tr> | |
| 741 | |
| 742 | |
| 743 </table> | |
| 744 <br/></div><div class="specterm" id="term_unit"> | |
| 745 <h3>Property: vamp:unit - unstable - </h3> | |
| 746 <em>unit</em> - Unit of the output/parameter. A string type<br/> | |
| 747 | |
| 748 <br/><table style="th { float: top; }"> | |
| 749 <tr><th>Domain:</th> | |
| 750 <td><a href="#term_ParameterDescriptor">ParameterDescriptor</a></td> | |
| 751 <td><a href="#term_PluginOutput">PluginOutput</a></td> | |
| 752 | |
| 753 </tr> | |
| 754 <tr><th>Range:</th> | |
| 755 </tr> | |
| 756 | |
| 757 | |
| 758 </table> | |
| 759 <br/></div><div class="specterm" id="term_value"> | |
| 760 <h3>Property: vamp:value - stable - </h3> | |
| 761 <em>value</em> - Specifies the current value of the parameter. <br/> | |
| 762 | |
| 763 <br/><table style="th { float: top; }"> | |
| 764 <tr><th>Domain:</th> | |
| 765 <td><a href="#term_Parameter">Parameter</a></td> | |
| 766 | |
| 767 </tr> | |
| 768 <tr><th>Range:</th> | |
| 769 </tr> | |
| 770 | |
| 771 | |
| 772 </table> | |
| 773 <br/></div><div class="specterm" id="term_vamp_API_version"> | |
| 774 <h3>Property: vamp:vamp_API_version - stable - </h3> | |
| 775 <em>vamp_API_version</em> - Version of the Vamp API used to implement this plugin.<br/> | |
| 776 | |
| 777 <br/><table style="th { float: top; }"> | |
| 778 <tr><th>Domain:</th> | |
| 779 <td><a href="#term_PluginDescription">PluginDescription</a></td> | |
| 780 | |
| 781 </tr> | |
| 782 <tr><th>Range:</th> | |
| 783 </tr> | |
| 784 | |
| 785 | |
| 786 </table> | |
| 787 <br/></div><div class="specterm" id="term_window_type"> | |
| 788 <h3>Property: vamp:window_type - unstable - </h3> | |
| 789 <em>window_type</em> - Specifies the window type (they should be individuals and clearly not here). <br/> | |
| 790 | |
| 791 <br/><table style="th { float: top; }"> | |
| 792 <tr><th>Domain:</th> | |
| 793 <td><a href="#term_Transform">Transform</a></td> | |
| 794 | |
| 795 </tr> | |
| 796 <tr><th>Range:</th> | |
| 797 </tr> | |
| 798 | |
| 799 | |
| 800 </table> | |
| 801 <br/></div><h2 id="terms_inds">Individuals</h2><div class="specterm" id="term_Effect"> | |
| 802 <h3>Individual: Effect - </h3> | |
| 803 <em>Effect</em> - Effect transform. This may be just a subclass of Transform... | |
| 804 | |
| 805 <br/><table style="th { float: top; }"><tr><th>Class:</th> | |
| 806 <td><a href="#term_TransformType">vamp:TransformType</a></td> | |
| 807 </tr></table></div><div class="specterm" id="term_FeatureExtraction"> | |
| 808 <h3>Individual: FeatureExtraction - </h3> | |
| 809 <em>Feature Extraction</em> - Feature extraction transform. This may be just a subclass of Transform... | |
| 810 | |
| 811 <br/><table style="th { float: top; }"><tr><th>Class:</th> | |
| 812 <td><a href="#term_TransformType">vamp:TransformType</a></td> | |
| 813 </tr></table></div> |