diff options
author | David Robillard <d@drobilla.net> | 2020-03-22 16:36:44 +0100 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2020-04-10 19:46:04 +0200 |
commit | 430284545345539c9ffb31df889debac1d3888b5 (patch) | |
tree | dc9bb1f32f0d6fe34a7339221389048e199f14a5 /lv2/buf-size/buf-size.ttl | |
parent | c4514483da1ab4f49148f9c4fe4ff5b559323217 (diff) | |
download | lv2-430284545345539c9ffb31df889debac1d3888b5.tar.xz |
Move documentation to metadata files and convert it to Markdown
Diffstat (limited to 'lv2/buf-size/buf-size.ttl')
-rw-r--r-- | lv2/buf-size/buf-size.ttl | 99 |
1 files changed, 18 insertions, 81 deletions
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 . |