aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/buf-size/buf-size.ttl
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2018-09-22 20:38:01 +0200
committerDavid Robillard <d@drobilla.net>2018-09-22 20:38:58 +0200
commit4db67120efca2d4c200d2e1ba5cf3d7b97cab97e (patch)
tree793630dd2a17b78d805dc4bc5cd50fbdd0ace3bd /lv2/buf-size/buf-size.ttl
parent160ecb9601c9687a1093e124e936dcbd78aef43c (diff)
downloadlv2-4db67120efca2d4c200d2e1ba5cf3d7b97cab97e.tar.xz
Install standard headers to simpler include paths
Diffstat (limited to 'lv2/buf-size/buf-size.ttl')
-rw-r--r--lv2/buf-size/buf-size.ttl129
1 files changed, 129 insertions, 0 deletions
diff --git a/lv2/buf-size/buf-size.ttl b/lv2/buf-size/buf-size.ttl
new file mode 100644
index 0000000..f8a9d60
--- /dev/null
+++ b/lv2/buf-size/buf-size.ttl
@@ -0,0 +1,129 @@
+@prefix bufsz: <http://lv2plug.in/ns/ext/buf-size#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix opts: <http://lv2plug.in/ns/ext/options#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+<http://lv2plug.in/ns/ext/buf-size>
+ a lv2:Specification ;
+ rdfs:seeAlso <buf-size.h> ,
+ <lv2-buf-size.doap.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/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>
+""" .
+
+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>
+""" .
+
+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>
+""" .
+
+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>
+""" .
+
+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>
+""" .
+
+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>
+""" .
+
+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>
+""" .
+
+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>
+""" .
+
+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> """ .