Mercurial > hg > sv-dependency-builds

annotate src/vamp-plugin-sdk-2.5/rdf/doc/vamp.html @ 108:1813f30f2f15

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