aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/resize-port/resize-port.ttl
blob: 6688f90062925ba8b60733b6f91a14d749df4db0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
@prefix lv2:  <http://lv2plug.in/ns/lv2core#> .
@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 rsz:  <http://lv2plug.in/ns/ext/resize-port#> .
@prefix xsd:  <http://www.w3.org/2001/XMLSchema#> .

<http://lv2plug.in/ns/ext/resize-port>
	a lv2:Specification ;
	rdfs:seeAlso <resize-port.h> ,
		<lv2-resize-port.doap.ttl> ;
	lv2:documentation """
<p>This extension defines a feature, rsz:resize, which allows plugins to
dynamically resize their output port buffers.</p>

<p>In addition to the dynamic feature, there are properties which describe the
space required for a particular port buffer which can be used statically in
data files.</p>
""" .

rsz:resize
	a lv2:Feature ;
	lv2:documentation """
<p>A feature to resize output port buffers in LV2_Plugin_Descriptor::run().</p>

<p>To support this feature, the host must pass an LV2_Feature to the plugin's
instantiate method with URI LV2_RESIZE_PORT__resize and a pointer to a
LV2_Resize_Port_Resize structure.  This structure provides a resize_port
function which plugins may use to resize output port buffers as necessary.</p>
""" .

rsz:asLargeAs
	a rdf:Property ,
		owl:DatatypeProperty ;
	rdfs:domain lv2:Port ;
	rdfs:range lv2:Symbol ;
	rdfs:label "as large as" ;
	lv2:documentation """
<p>Indicates that a port requires at least as much buffer space as the port
with the given symbol on the same plugin instance.  This may be used for any
ports, but is generally most useful to indicate an output port must be at least
as large as some input port (because it will copy from it).  If a port is
asLargeAs several ports, it is asLargeAs the largest such port (not the sum of
those ports' sizes).</p>

<p>The host guarantees that whenever an ObjectPort's run method is called, any
output O that is obj:asLargeAs an input I is connected to a buffer large enough
to copy I, or NULL if the port is lv2:connectionOptional.</p>
""" .

rsz:minimumSize
	a rdf:Property ,
		owl:DatatypeProperty ,
		owl:FunctionalProperty ;
	rdfs:domain lv2:Port ;
	rdfs:range xsd:nonNegativeInteger ;
	rdfs:label "minimum size" ;
	rdfs:comment """
Indicates that a port requires a buffer at least this large, in bytes.  Any
host that supports the resize-port feature MUST connect any port with a
minimumSize specified to a buffer at least as large as the value given for this
property.  Any host, especially those that do NOT support dynamic port
resizing, SHOULD do so or reduced functionality may result.
""" .