aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/lv2plug.in/ns/ext/parameters/parameters.ttl
blob: 8f05f74ae79b24e53e30db44a521c38afe005a40 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
@prefix lv2:   <http://lv2plug.in/ns/lv2core#> .
@prefix param: <http://lv2plug.in/ns/ext/parameters#> .
@prefix pg:    <http://lv2plug.in/ns/ext/port-groups#> .
@prefix rdf:   <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs:  <http://www.w3.org/2000/01/rdf-schema#> .

<http://lv2plug.in/ns/ext/parameters>
	a lv2:Specification ;
	rdfs:seeAlso <../../meta/meta.ttl> ,
		<lv2-parameters.doap.ttl> ;
	lv2:documentation """
<p>This vocabulary describes parameters common in audio processing software.  A
<q>parameter</q> is purely a metadata concept, unrelated to any particular code
mechanism.  Parameters are used to assign meaning to controls (e.g. using
lv2:designation for ports) so they can be used more intelligently or presented
to the user more efficiently.</p> """ .

param:ControlGroup
	a rdfs:Class ;
	rdfs:subClassOf pg:Group ;
	rdfs:comment """
A group representing a set of associated controls.
""" .

param:amplitude
	a lv2:Parameter ;
	rdfs:label "amplitude" .

param:attack
	a lv2:Parameter ;
	rdfs:label "attack" ;
	rdfs:comment "The duration of an envelope's attack stage." .

param:cutoffFrequency
	a lv2:Parameter ;
	rdfs:label "cutoff frequency" .

param:decay
	a lv2:Parameter ;
	rdfs:label "decay" ;
	rdfs:comment "The duration of an envelope's decay stage." .

param:delay
	a lv2:Parameter ;
	rdfs:label "delay" ;
	rdfs:comment "The duration of an envelope's delay stage." .

param:frequency
	a lv2:Parameter ;
	rdfs:label "frequency" .

param:hold
	a lv2:Parameter ;
	rdfs:label "hold" ;
	rdfs:comment "The duration of an envelope's hold stage." .

param:pulseWidth
	a lv2:Parameter ;
	rdfs:label "pulse width" ;
	rdfs:comment "The width of a pulse of a rectangular waveform." .

param:ratio
	a lv2:Parameter ;
	rdfs:label "ratio" ;
	rdfs:comment "Compression ration." .

param:release
	a lv2:Parameter ;
	rdfs:label "release" ;
	rdfs:comment "The duration of an envelope's release stage." .

param:resonance
	a lv2:Parameter ;
	rdfs:label "resonance" ;
	rdfs:comment "The resonance of a filter." .

param:sustain
	a lv2:Parameter ;
	rdfs:label "sustain" ;
	rdfs:comment "The level (not duration) of an envelope's sustain stage." .

param:threshold
	a lv2:Parameter ;
	rdfs:label "threshold" ;
	rdfs:comment "Compression threshold." .

param:waveform
	a lv2:Parameter ;
	rdfs:label "waveform" .

param:gain
	a lv2:Parameter ;
	rdfs:label "gain" ;
	rdfs:comment "A factor which controls an output level." .

param:wetDryRatio
	a lv2:Parameter ;
	rdfs:label "wet/dry ratio" ;
	lv2:documentation """
<p>The ratio between processed and bypass components in output signal.  The dry
and wet percentages can be calculated from the following equations:</p>

<pre class="c-code">
    dry = (wetDryRatio.maximum - wetDryRatio.value) / wetDryRatio.maximum
    wet = wetDryRatio.value / wetDryRatio.maximum
</pre>

<p>Typically, maximum value of 1 or 100 and minimum value of 0 should be
used.</p>
""" .

param:wetLevel
	a lv2:Parameter ;
	rdfs:label "wet level" ;
	rdfs:comment "The level of the processed component of a signal." .

param:dryLevel
	a lv2:Parameter ;
	rdfs:label "dry level" ;
	rdfs:comment "The level of the unprocessed component of a signal." .

param:bypass
	a lv2:Parameter ;
	rdfs:label "bypass" ;
	rdfs:comment "A boolean parameter that disabled processing if true." .

param:sampleRate
	a lv2:Parameter ;
	rdfs:label "sample rate" ;
	rdfs:comment "A sample rate in Hz." .

param:EnvelopeControls
	a rdfs:Class ;
	rdfs:subClassOf param:ControlGroup ;
	rdfs:label "DAHDSR Envelope Controls" ;
	pg:element [
		lv2:index 0 ;
		lv2:designation param:delay
	] , [
		lv2:index 1 ;
		lv2:designation param:attack
	] , [
		lv2:index 2 ;
		lv2:designation param:hold
	] , [
		lv2:index 3 ;
		lv2:designation param:decay
	] , [
		lv2:index 4 ;
		lv2:designation param:sustain
	] , [
		lv2:index 5 ;
		lv2:designation param:release
	] .

param:OscillatorControls
	a rdfs:Class ;
	rdfs:subClassOf param:ControlGroup ;
	rdfs:label "Oscillator Controls" ;
	pg:element [
		lv2:designation param:frequency
	] , [
		lv2:designation param:amplitude
	] , [
		lv2:designation param:waveform
	] , [
		lv2:designation param:pulseWidth
	] .

param:FilterControls
	a rdfs:Class ;
	rdfs:subClassOf param:ControlGroup ;
	rdfs:label "Filter Controls" ;
	pg:element [
		lv2:designation param:cutoffFrequency
	] , [
		lv2:designation param:resonance
	] .

param:CompressorControls
	a rdfs:Class ;
	rdfs:subClassOf param:ControlGroup ;
	rdfs:label "Compressor Controls" ;
	pg:element [
		lv2:designation param:threshold
	] , [
		lv2:designation param:ratio
	] .