Mercurial > hg > sv-dependency-builds

annotate src/vamp-plugin-sdk-2.4/rdf/doc/vamp.html @ 12:b7bda433d832

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