diff options
Diffstat (limited to 'lv2/buf-size')
| -rw-r--r-- | lv2/buf-size/buf-size.meta.ttl | 114 | ||||
| -rw-r--r-- | lv2/buf-size/buf-size.ttl | 99 |
2 files changed, 131 insertions, 82 deletions
diff --git a/lv2/buf-size/buf-size.meta.ttl b/lv2/buf-size/buf-size.meta.ttl index 88b9d59..b1d8011 100644 --- a/lv2/buf-size/buf-size.meta.ttl +++ b/lv2/buf-size/buf-size.meta.ttl @@ -1,6 +1,8 @@ +@prefix bufsz: <http://lv2plug.in/ns/ext/buf-size#> . @prefix dcs: <http://ontologi.es/doap-changeset#> . @prefix doap: <http://usefulinc.com/ns/doap#> . @prefix foaf: <http://xmlns.com/foaf/0.1/> . +@prefix lv2: <http://lv2plug.in/ns/lv2core#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . <http://lv2plug.in/ns/ext/buf-size> @@ -41,5 +43,115 @@ rdfs:label "Initial release." ] ] - ] . + ] ; + lv2:documentation """ + +This extension defines a facility for plugins to get information about the +block length (the sample_count parameter of LV2_Descriptor::run) and port +buffer sizes, as well as several features which can be used to restrict the +block length. + +This extension defines features and properties but has no special purpose +API of its own. The host provides all the relevant information to the plugin +as [options](options.html). + +To require restrictions on the block length, plugins can require additional +features: bufsz:boundedBlockLength, bufsz:powerOf2BlockLength, and +bufsz:fixedBlockLength. These features are data-only, that is they merely +indicate a restriction and do not carry any data or API. + +"""^^lv2:Markdown . + +bufsz:boundedBlockLength + lv2:documentation """ + +A feature that indicates the host will provide both the bufsz:minBlockLength +and bufsz:maxBlockLength options to the plugin. Plugins that copy data from +audio inputs can require this feature to ensure they know how much space is +required for auxiliary buffers. Note the minimum may be zero, this feature is +mainly useful to ensure a maximum is available. + +All hosts SHOULD support this feature, since it is simple to support and +necessary for any plugins that may need to copy the input. + +"""^^lv2:Markdown . + +bufsz:fixedBlockLength + lv2:documentation """ + +A feature that indicates the host will always call LV2_Descriptor::run() with +the same value for sample_count. This length MUST be provided as the value of +both the bufsz:minBlockLength and bufsz:maxBlockLength options. + +Note that requiring this feature may severely limit the number of hosts capable +of running the plugin. + +"""^^lv2:Markdown . + +bufsz:powerOf2BlockLength + lv2:documentation """ + +A feature that indicates the host will always call LV2_Descriptor::run() with a +power of two sample_count. Note that this feature does not guarantee the value +is the same each call, to guarantee a fixed power of two block length plugins +must require both this feature and bufsz:fixedBlockLength. + +Note that requiring this feature may severely limit the number of hosts capable +of running the plugin. + +"""^^lv2:Markdown . + +bufsz:coarseBlockLength + lv2:documentation """ + +A feature that indicates the plugin prefers coarse, regular block lengths. For +example, plugins that do not implement sample-accurate control use this feature +to indicate that the host should not split the run cycle because controls have +changed. + +Note that this feature is merely a hint, and does not guarantee a fixed block +length. The run cycle may be split for other reasons, and the blocksize itself +may change anytime. + +"""^^lv2:Markdown . + +bufsz:maxBlockLength + lv2:documentation """ + +The maximum block length the host will ever request the plugin to process at +once, that is, the maximum `sample_count` parameter that will ever be passed to +LV2_Descriptor::run(). + +"""^^lv2:Markdown . + +bufsz:minBlockLength + lv2:documentation """ + +The minimum block length the host will ever request the plugin to process at +once, that is, the minimum `sample_count` parameter that will ever be passed to +LV2_Descriptor::run(). + +"""^^lv2:Markdown . + +bufsz:nominalBlockLength + lv2:documentation """ + +The typical block length the host will request the plugin to process at once, +that is, the typical `sample_count` parameter that will be passed to +LV2_Descriptor::run(). This will usually be equivalent, or close to, the +maximum block length, but there are no strong guarantees about this value +whatsoever. Plugins may use this length for optimization purposes, but MUST +NOT assume the host will always process blocks of this length. In particular, +the host MAY process longer blocks. + +"""^^lv2:Markdown . + +bufsz:sequenceSize + lv2:documentation """ + +This should be provided as an option by hosts that support event ports +(including but not limited to MIDI), so plugins have the ability to allocate +auxiliary buffers large enough to copy the input. + +"""^^lv2:Markdown . diff --git a/lv2/buf-size/buf-size.ttl b/lv2/buf-size/buf-size.ttl index f41fc67..8f277d9 100644 --- a/lv2/buf-size/buf-size.ttl +++ b/lv2/buf-size/buf-size.ttl @@ -8,123 +8,60 @@ <http://lv2plug.in/ns/ext/buf-size> a lv2:Specification ; + rdfs:label "LV2 Buf Size" ; + rdfs:comment "Access to, and restrictions on, buffer sizes." ; rdfs:seeAlso <buf-size.h> , - <buf-size.meta.ttl> ; - lv2:documentation """ -<p>This extension defines a facility for plugins to get information about the -block length (the sample_count parameter of LV2_Descriptor::run) and -port buffer sizes, as well as several features which can be used to restrict -the block length.</p> - -<p>This extension defines features and properties but has no special purpose -API of its own. The host provides all the relevant information to the plugin -as <a href="options.html#options">options</a>.</p> - -<p>To require restrictions on the block length, plugins can require additional -features: bufsz:boundedBlockLength, bufsz:powerOf2BlockLength, and -bufsz:fixedBlockLength. These features are data-only, that is they merely -indicate a restriction and do not carry any data or API.</p> -""" . + <buf-size.meta.ttl> . bufsz:boundedBlockLength a lv2:Feature ; - lv2:documentation """ -<p>A feature that indicates the host will provide both the bufsz:minBlockLength -and bufsz:maxBlockLength options to the plugin. Plugins that copy data from -audio inputs can require this feature to ensure they know how much space is -required for auxiliary buffers. Note the minimum may be zero, this feature is -mainly useful to ensure a maximum is available.</p> - -<p>All hosts SHOULD support this feature, since it is simple to support and -necessary for any plugins that may need to copy the input.</p> -""" . + rdfs:label "bounded block length" ; + rdfs:comment "Block length has lower and upper bounds." . bufsz:fixedBlockLength a lv2:Feature ; - lv2:documentation """ -<p>A feature that indicates the host will always call LV2_Descriptor::run() -with the same value for sample_count. This length MUST be provided as the -value of both the bufsz:minBlockLength and bufsz:maxBlockLength options.</p> - -<p>Note that requiring this feature may severely limit the number of hosts -capable of running the plugin.</p> -""" . + rdfs:label "fixed block length" ; + rdfs:comment "Block length never changes." . bufsz:powerOf2BlockLength a lv2:Feature ; - lv2:documentation """ -<p>A feature that indicates the host will always call LV2_Descriptor::run() -with a power of two sample_count. Note that this feature does not guarantee -the value is the same each call, to guarantee a fixed power of two block length -plugins must require both this feature and bufsz:fixedBlockLength.</p> - -<p>Note that requiring this feature may severely limit the number of hosts -capable of running the plugin.</p> -""" . + rdfs:label "power of 2 block length" ; + rdfs:comment "Block length is a power of 2." . bufsz:coarseBlockLength a lv2:Feature ; rdfs:label "coarse block length" ; - lv2:documentation """ -<p>A feature that indicates the plugin prefers coarse, regular block lengths. -For example, plugins that do not implement sample-accurate control use this -feature to indicate that the host should not split the run cycle because -controls have changed.</p> - -<p>Note that this feature is merely a hint, and does not guarantee a fixed -block length. The run cycle may be split for other reasons, and the blocksize -itself may change anytime.</p> -""" . + rdfs:comment "Plugin prefers coarse block length without buffer splitting." . bufsz:maxBlockLength a rdf:Property , owl:DatatypeProperty , opts:Option ; rdfs:label "maximum block length" ; - rdfs:range xsd:nonNegativeInteger ; - lv2:documentation """ -<p>The maximum block length the host will ever request the plugin to process at -once, that is, the maximum <code>sample_count</code> parameter that will ever -be passed to LV2_Descriptor::run().</p> -""" . + rdfs:comment "Block length has an upper bound." ; + rdfs:range xsd:nonNegativeInteger . bufsz:minBlockLength a rdf:Property , owl:DatatypeProperty , opts:Option ; rdfs:label "minimum block length" ; - rdfs:range xsd:nonNegativeInteger ; - lv2:documentation """ -<p>The minimum block length the host will ever request the plugin to process at -once, that is, the minimum <code>sample_count</code> parameter that will ever -be passed to LV2_Descriptor::run().</p> -""" . + rdfs:comment "Block length has a lower bound." ; + rdfs:range xsd:nonNegativeInteger . bufsz:nominalBlockLength a rdf:Property , owl:DatatypeProperty , opts:Option ; rdfs:label "nominal block length" ; - rdfs:range xsd:nonNegativeInteger ; - lv2:documentation """ -<p>The typical block length the host will request the plugin to process at -once, that is, the typical <code>sample_count</code> parameter that will -be passed to LV2_Descriptor::run(). This will usually be equivalent, or close -to, the maximum block length, but there are no strong guarantees about this -value whatsoever. Plugins may use this length for optimization purposes, but -MUST NOT assume the host will always process blocks of this length. In -particular, the host MAY process longer blocks.</p> -""" . + rdfs:comment "Typical block length that will most often be processed." ; + rdfs:range xsd:nonNegativeInteger . bufsz:sequenceSize a rdf:Property , owl:DatatypeProperty , opts:Option ; rdfs:label "sequence size" ; - rdfs:range xsd:nonNegativeInteger ; - lv2:documentation """ -<p>The maximum size of a sequence, in bytes. This should be provided as an -option by hosts that support event ports (including but not limited to MIDI), -so plugins have the ability to allocate auxiliary buffers large enough to copy -the input.</p> """ . + rdfs:comment "The maximum size of a sequence, in bytes." ; + rdfs:range xsd:nonNegativeInteger . |