Mercurial > hg > vamp-plugin-sdk

annotate rdf/doc/vamp.html @ 280:9b831bd58aa7

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