annotate src/vamp-plugin-sdk-2.4/rdf/doc/vamp.html @ 97:efb4b8187266

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