aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl
diff options
context:
space:
mode:
Diffstat (limited to 'lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl')
-rw-r--r--lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl40
1 files changed, 14 insertions, 26 deletions
diff --git a/lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl b/lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl
index 1c9b508..9313b11 100644
--- a/lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl
+++ b/lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl
@@ -16,8 +16,9 @@ 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>The host provides access to all the relevant information via the
-bufsz:access feature.</p>
+<p>This extension only defines data-only features and properties and has no C
+API of its own. The host provides all the relevant information to the plugin as <a
+href="http://lv2plug.in/ns/ext/options#options">options</a></p>
<p>To require restrictions on the block length, plugins can require additional
features: bufsz:boundedBlockLength, bufsz:powerOf2BlockLength, and
@@ -25,36 +26,25 @@ bufsz:fixedBlockLength. These features are data-only, that is they merely
indicate a restriction and do not carry any data or API.</p>
""" .
-bufsz:access
- a lv2:Feature ;
- lv2:documentation """
-<p>The feature that provides access to buffer size information. This feature
-is the only one in this extension which carries data: to implement it the host
-passes a feature with URI LV2_BUF_SIZE__access and an LV2_Buf_Size_Access
-for data, which provides functions the plugin can call to investigate the
-buffer size.</p>
-""" .
-
bufsz:boundedBlockLength
a lv2:Feature ;
lv2:documentation """
-<p>A feature that indicates the host will provide a minimum and maximum block
-length via LV2_Buf_Size_Access::get_sample_count(). Plugins that copy data
-from audio inputs can require this feature to ensure they know how much space
-is required for auxilliary buffers. Note the minimum may be zero, this feature
-is mainly useful to ensure a maximum is available.</p>
+<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 plugins to create auxiliary buffers.</p>
+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. If available,
-LV2_Buf_Size_Access::get_sample_count() must report this value for both min
-and max.</p>
+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>
@@ -64,11 +54,9 @@ 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. If available,
-LV2_Buf_Size_Access::get_sample_count() must report this value for both min
-and max. Note this feature does not guarantee the value is the same each call,
-to ensure that the plugin must require both this feature and
-bufsz:fixedBlockLength.</p>
+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>