aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.gitignore11
-rw-r--r--.gitlab-ci.yml159
-rw-r--r--.gitmodules3
-rw-r--r--README82
-rw-r--r--README.md82
-rw-r--r--doc/asciidoc.css534
-rw-r--r--doc/doxy-style.css909
-rw-r--r--doc/footer.html20
-rw-r--r--doc/header.html57
-rw-r--r--doc/htaccess.in6
-rw-r--r--doc/index.html.in80
-rw-r--r--doc/layout.xml226
-rw-r--r--doc/mainpage.dox21
-rw-r--r--doc/mainpage.md3
-rw-r--r--doc/pygments.css61
-rw-r--r--doc/reference.doxygen.in2624
-rw-r--r--doc/style.css1044
-rw-r--r--lv2/atom/atom-test-utils.c71
-rw-r--r--lv2/atom/atom-test.c (renamed from lv2/lv2plug.in/ns/ext/atom/atom-test.c)98
-rw-r--r--lv2/atom/atom.h (renamed from lv2/lv2plug.in/ns/ext/atom/atom.h)99
-rw-r--r--lv2/atom/atom.meta.ttl542
-rw-r--r--lv2/atom/atom.ttl247
-rw-r--r--lv2/atom/forge-overflow-test.c237
-rw-r--r--lv2/atom/forge.h (renamed from lv2/lv2plug.in/ns/ext/atom/forge.h)167
-rw-r--r--lv2/atom/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/atom/manifest.ttl)7
-rw-r--r--lv2/atom/util.h (renamed from lv2/lv2plug.in/ns/ext/atom/util.h)203
-rw-r--r--lv2/buf-size/buf-size.h (renamed from lv2/lv2plug.in/ns/ext/buf-size/buf-size.h)33
-rw-r--r--lv2/buf-size/buf-size.meta.ttl157
-rw-r--r--lv2/buf-size/buf-size.ttl67
-rw-r--r--lv2/buf-size/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/buf-size/manifest.ttl)4
-rw-r--r--lv2/core/attributes.h59
-rw-r--r--lv2/core/lv2.h (renamed from lv2/lv2plug.in/ns/lv2core/lv2.h)270
-rw-r--r--lv2/core/lv2_util.h102
-rw-r--r--lv2/core/lv2core.meta.ttl906
-rw-r--r--lv2/core/lv2core.ttl674
-rw-r--r--lv2/core/manifest.ttl15
-rw-r--r--lv2/core/meta.ttl (renamed from lv2/lv2plug.in/ns/meta/meta.ttl)158
-rw-r--r--lv2/core/people.ttl51
-rw-r--r--lv2/data-access/data-access.h (renamed from lv2/lv2plug.in/ns/ext/data-access/data-access.h)28
-rw-r--r--lv2/data-access/data-access.meta.ttl (renamed from lv2/lv2plug.in/ns/ext/data-access/lv2-data-access.doap.ttl)26
-rw-r--r--lv2/data-access/data-access.ttl11
-rw-r--r--lv2/data-access/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/data-access/manifest.ttl)2
-rw-r--r--lv2/dynmanifest/dynmanifest.h (renamed from lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h)36
-rw-r--r--lv2/dynmanifest/dynmanifest.meta.ttl131
-rw-r--r--lv2/dynmanifest/dynmanifest.ttl25
-rw-r--r--lv2/dynmanifest/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/dynmanifest/manifest.ttl)3
-rw-r--r--lv2/event/event-helpers.h (renamed from lv2/lv2plug.in/ns/ext/event/event-helpers.h)103
-rw-r--r--lv2/event/event.h (renamed from lv2/lv2plug.in/ns/ext/event/event.h)75
-rw-r--r--lv2/event/event.meta.ttl246
-rw-r--r--lv2/event/event.ttl86
-rw-r--r--lv2/event/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/event/manifest.ttl)4
-rw-r--r--lv2/instance-access/instance-access.h (renamed from lv2/lv2plug.in/ns/ext/instance-access/instance-access.h)30
-rw-r--r--lv2/instance-access/instance-access.meta.ttl (renamed from lv2/lv2plug.in/ns/ext/instance-access/lv2-instance-access.doap.ttl)21
-rw-r--r--lv2/instance-access/instance-access.ttl11
-rw-r--r--lv2/instance-access/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/instance-access/manifest.ttl)2
-rw-r--r--lv2/log/log.h (renamed from lv2/lv2plug.in/ns/ext/log/log.h)43
-rw-r--r--lv2/log/log.meta.ttl126
-rw-r--r--lv2/log/log.ttl48
-rw-r--r--lv2/log/logger.h (renamed from lv2/lv2plug.in/ns/ext/log/logger.h)64
-rw-r--r--lv2/log/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/log/manifest.ttl)4
-rw-r--r--lv2/lv2plug.in/ns/ext/atom/atom.ttl601
-rw-r--r--lv2/lv2plug.in/ns/ext/atom/lv2-atom.doap.ttl68
-rw-r--r--lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl99
-rw-r--r--lv2/lv2plug.in/ns/ext/buf-size/lv2-buf-size.doap.ttl33
-rw-r--r--lv2/lv2plug.in/ns/ext/data-access/data-access.ttl23
-rw-r--r--lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.ttl90
-rw-r--r--lv2/lv2plug.in/ns/ext/dynmanifest/lv2-dynmanifest.doap.ttl54
-rw-r--r--lv2/lv2plug.in/ns/ext/event/event.ttl162
-rw-r--r--lv2/lv2plug.in/ns/ext/event/lv2-event.doap.ttl89
-rw-r--r--lv2/lv2plug.in/ns/ext/instance-access/instance-access.ttl22
-rw-r--r--lv2/lv2plug.in/ns/ext/log/log.ttl63
-rw-r--r--lv2/lv2plug.in/ns/ext/log/lv2-log.doap.ttl42
-rw-r--r--lv2/lv2plug.in/ns/ext/morph/lv2-morph.doap.ttl23
-rw-r--r--lv2/lv2plug.in/ns/ext/morph/morph.ttl86
-rw-r--r--lv2/lv2plug.in/ns/ext/options/lv2-options.doap.ttl33
-rw-r--r--lv2/lv2plug.in/ns/ext/options/options.ttl105
-rw-r--r--lv2/lv2plug.in/ns/ext/parameters/lv2-parameters.doap.ttl38
-rw-r--r--lv2/lv2plug.in/ns/ext/patch/lv2-patch.doap.ttl36
-rw-r--r--lv2/lv2plug.in/ns/ext/patch/patch.h55
-rw-r--r--lv2/lv2plug.in/ns/ext/patch/patch.ttl367
-rw-r--r--lv2/lv2plug.in/ns/ext/port-groups/lv2-port-groups.doap.ttl35
-rw-r--r--lv2/lv2plug.in/ns/ext/port-groups/port-groups.h64
-rw-r--r--lv2/lv2plug.in/ns/ext/port-groups/port-groups.ttl724
-rw-r--r--lv2/lv2plug.in/ns/ext/port-props/lv2-port-props.doap.ttl34
-rw-r--r--lv2/lv2plug.in/ns/ext/presets/lv2-presets.doap.ttl60
-rw-r--r--lv2/lv2plug.in/ns/ext/presets/presets.h34
-rw-r--r--lv2/lv2plug.in/ns/ext/presets/presets.ttl84
-rw-r--r--lv2/lv2plug.in/ns/ext/resize-port/lv2-resize-port.doap.ttl23
-rw-r--r--lv2/lv2plug.in/ns/ext/resize-port/resize-port.ttl64
-rw-r--r--lv2/lv2plug.in/ns/ext/state/lv2-state.doap.ttl46
-rw-r--r--lv2/lv2plug.in/ns/ext/state/state.ttl349
-rw-r--r--lv2/lv2plug.in/ns/ext/time/lv2-time.doap.ttl33
-rw-r--r--lv2/lv2plug.in/ns/ext/time/time.h49
-rw-r--r--lv2/lv2plug.in/ns/ext/uri-map/uri-map.ttl24
-rw-r--r--lv2/lv2plug.in/ns/ext/urid/lv2-urid.doap.ttl47
-rw-r--r--lv2/lv2plug.in/ns/ext/urid/urid.ttl39
-rw-r--r--lv2/lv2plug.in/ns/ext/worker/lv2-worker.doap.ttl23
-rw-r--r--lv2/lv2plug.in/ns/ext/worker/worker.ttl57
-rw-r--r--lv2/lv2plug.in/ns/extensions/ui/lv2-ui.doap.ttl122
-rw-r--r--lv2/lv2plug.in/ns/extensions/ui/ui.h408
-rw-r--r--lv2/lv2plug.in/ns/extensions/ui/ui.ttl452
-rw-r--r--lv2/lv2plug.in/ns/extensions/units/units.h62
-rw-r--r--lv2/lv2plug.in/ns/index.html.in28
-rw-r--r--lv2/lv2plug.in/ns/lv2core/README42
-rw-r--r--lv2/lv2plug.in/ns/lv2core/lv2core.doap.ttl146
-rw-r--r--lv2/lv2plug.in/ns/lv2core/lv2core.pc.in10
-rw-r--r--lv2/lv2plug.in/ns/lv2core/lv2core.ttl1083
-rw-r--r--lv2/lv2plug.in/ns/lv2core/manifest.ttl9
-rw-r--r--lv2/lv2plug.in/ns/lv2core/wscript83
-rw-r--r--lv2/lv2plug.in/ns/meta/manifest.ttl8
-rw-r--r--lv2/midi/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/midi/manifest.ttl)4
-rw-r--r--lv2/midi/midi.h (renamed from lv2/lv2plug.in/ns/ext/midi/midi.h)110
-rw-r--r--lv2/midi/midi.meta.ttl (renamed from lv2/lv2plug.in/ns/ext/midi/lv2-midi.doap.ttl)73
-rw-r--r--lv2/midi/midi.ttl (renamed from lv2/lv2plug.in/ns/ext/midi/midi.ttl)177
-rw-r--r--lv2/morph/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/morph/manifest.ttl)2
-rw-r--r--lv2/morph/morph.h (renamed from lv2/lv2plug.in/ns/ext/morph/morph.h)35
-rw-r--r--lv2/morph/morph.meta.ttl90
-rw-r--r--lv2/morph/morph.ttl46
-rw-r--r--lv2/options/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/options/manifest.ttl)5
-rw-r--r--lv2/options/options.h (renamed from lv2/lv2plug.in/ns/ext/options/options.h)40
-rw-r--r--lv2/options/options.meta.ttl129
-rw-r--r--lv2/options/options.ttl44
-rw-r--r--lv2/parameters/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/parameters/manifest.ttl)5
-rw-r--r--lv2/parameters/parameters.h (renamed from lv2/lv2plug.in/ns/ext/parameters/parameters.h)72
-rw-r--r--lv2/parameters/parameters.meta.ttl75
-rw-r--r--lv2/parameters/parameters.ttl (renamed from lv2/lv2plug.in/ns/ext/parameters/parameters.ttl)98
-rw-r--r--lv2/patch/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/patch/manifest.ttl)5
-rw-r--r--lv2/patch/patch.h68
-rw-r--r--lv2/patch/patch.meta.ttl374
-rw-r--r--lv2/patch/patch.ttl251
-rw-r--r--lv2/port-groups/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/port-groups/manifest.ttl)4
-rw-r--r--lv2/port-groups/port-groups.h72
-rw-r--r--lv2/port-groups/port-groups.meta.ttl144
-rw-r--r--lv2/port-groups/port-groups.ttl807
-rw-r--r--lv2/port-props/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/port-props/manifest.ttl)3
-rw-r--r--lv2/port-props/port-props.h (renamed from lv2/lv2plug.in/ns/ext/port-props/port-props.h)45
-rw-r--r--lv2/port-props/port-props.meta.ttl (renamed from lv2/lv2plug.in/ns/ext/port-props/port-props.ttl)197
-rw-r--r--lv2/port-props/port-props.ttl79
-rw-r--r--lv2/presets/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/presets/manifest.ttl)2
-rw-r--r--lv2/presets/presets.h42
-rw-r--r--lv2/presets/presets.meta.ttl133
-rw-r--r--lv2/presets/presets.ttl60
-rw-r--r--lv2/resize-port/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/resize-port/manifest.ttl)2
-rw-r--r--lv2/resize-port/resize-port.h (renamed from lv2/lv2plug.in/ns/ext/resize-port/resize-port.h)40
-rw-r--r--lv2/resize-port/resize-port.meta.ttl74
-rw-r--r--lv2/resize-port/resize-port.ttl36
-rw-r--r--lv2/state/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/state/manifest.ttl)5
-rw-r--r--lv2/state/state.h (renamed from lv2/lv2plug.in/ns/ext/state/state.h)151
-rw-r--r--lv2/state/state.meta.ttl457
-rw-r--r--lv2/state/state.ttl60
-rw-r--r--lv2/time/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/time/manifest.ttl)4
-rw-r--r--lv2/time/time.h54
-rw-r--r--lv2/time/time.meta.ttl112
-rw-r--r--lv2/time/time.ttl (renamed from lv2/lv2plug.in/ns/ext/time/time.ttl)74
-rw-r--r--lv2/ui/manifest.ttl (renamed from lv2/lv2plug.in/ns/extensions/ui/manifest.ttl)7
-rw-r--r--lv2/ui/ui.h539
-rw-r--r--lv2/ui/ui.meta.ttl627
-rw-r--r--lv2/ui/ui.ttl248
-rw-r--r--lv2/units/manifest.ttl (renamed from lv2/lv2plug.in/ns/extensions/units/manifest.ttl)4
-rw-r--r--lv2/units/units.h70
-rw-r--r--lv2/units/units.meta.ttl (renamed from lv2/lv2plug.in/ns/extensions/units/lv2-units.doap.ttl)72
-rw-r--r--lv2/units/units.ttl (renamed from lv2/lv2plug.in/ns/extensions/units/units.ttl)111
-rw-r--r--lv2/uri-map/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/uri-map/manifest.ttl)3
-rw-r--r--lv2/uri-map/uri-map.h (renamed from lv2/lv2plug.in/ns/ext/uri-map/uri-map.h)33
-rw-r--r--lv2/uri-map/uri-map.meta.ttl (renamed from lv2/lv2plug.in/ns/ext/uri-map/lv2-uri-map.doap.ttl)22
-rw-r--r--lv2/uri-map/uri-map.ttl14
-rw-r--r--lv2/urid/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/urid/manifest.ttl)3
-rw-r--r--lv2/urid/urid.h (renamed from lv2/lv2plug.in/ns/ext/urid/urid.h)44
-rw-r--r--lv2/urid/urid.meta.ttl84
-rw-r--r--lv2/urid/urid.ttl22
-rw-r--r--lv2/worker/manifest.ttl (renamed from lv2/lv2plug.in/ns/ext/worker/manifest.ttl)5
-rw-r--r--lv2/worker/worker.h (renamed from lv2/lv2plug.in/ns/ext/worker/worker.h)78
-rw-r--r--lv2/worker/worker.meta.ttl82
-rw-r--r--lv2/worker/worker.ttl25
-rw-r--r--lv2specgen/DTD/xhtml-datatypes-1.mod.1103
-rw-r--r--lv2specgen/DTD/xhtml-metaAttributes-1.mod154
-rw-r--r--lv2specgen/DTD/xhtml-rdfa-1.dtd472
-rw-r--r--lv2specgen/DTD/xhtml-rdfa-model-1.mod249
-rwxr-xr-xlv2specgen/lv2docgen.py17
-rwxr-xr-xlv2specgen/lv2specgen.py1666
-rw-r--r--lv2specgen/template.html136
-rw-r--r--plugins/README.txt2
-rw-r--r--plugins/eg-amp.lv2/README.txt (renamed from plugins/eg01-amp.lv2/README.txt)18
-rw-r--r--plugins/eg-amp.lv2/amp.c (renamed from plugins/eg01-amp.lv2/amp.c)64
-rw-r--r--plugins/eg-amp.lv2/amp.ttl (renamed from plugins/eg01-amp.lv2/amp.ttl)20
-rw-r--r--plugins/eg-amp.lv2/manifest.ttl.in68
l---------plugins/eg-amp.lv2/waf (renamed from plugins/eg01-amp.lv2/waf)0
-rw-r--r--plugins/eg-amp.lv2/wscript51
-rw-r--r--plugins/eg-fifths.lv2/README.txt3
-rw-r--r--plugins/eg-fifths.lv2/fifths.c193
-rw-r--r--plugins/eg-fifths.lv2/fifths.ttl30
-rw-r--r--plugins/eg-fifths.lv2/manifest.ttl.in8
-rw-r--r--plugins/eg-fifths.lv2/uris.h55
l---------plugins/eg-fifths.lv2/waf (renamed from plugins/eg02-midigate.lv2/waf)0
-rw-r--r--plugins/eg-fifths.lv2/wscript49
-rw-r--r--plugins/eg-metro.lv2/README.txt (renamed from plugins/eg03-metro.lv2/README.txt)0
-rw-r--r--plugins/eg-metro.lv2/manifest.ttl.in (renamed from plugins/eg03-metro.lv2/manifest.ttl.in)0
-rw-r--r--plugins/eg-metro.lv2/metro.c (renamed from plugins/eg03-metro.lv2/metro.c)70
-rw-r--r--plugins/eg-metro.lv2/metro.ttl (renamed from plugins/eg03-metro.lv2/metro.ttl)0
l---------plugins/eg-metro.lv2/waf (renamed from plugins/eg03-metro.lv2/waf)0
-rw-r--r--plugins/eg-metro.lv2/wscript50
-rw-r--r--plugins/eg-midigate.lv2/README.txt (renamed from plugins/eg02-midigate.lv2/README.txt)0
-rw-r--r--plugins/eg-midigate.lv2/manifest.ttl.in (renamed from plugins/eg02-midigate.lv2/manifest.ttl.in)0
-rw-r--r--plugins/eg-midigate.lv2/midigate.c (renamed from plugins/eg02-midigate.lv2/midigate.c)69
-rw-r--r--plugins/eg-midigate.lv2/midigate.ttl (renamed from plugins/eg02-midigate.lv2/midigate.ttl)0
l---------plugins/eg-midigate.lv2/waf (renamed from plugins/eg04-sampler.lv2/waf)0
-rw-r--r--plugins/eg-midigate.lv2/wscript49
-rw-r--r--plugins/eg-params.lv2/README.txt21
-rw-r--r--plugins/eg-params.lv2/manifest.ttl.in7
-rw-r--r--plugins/eg-params.lv2/params.c526
-rw-r--r--plugins/eg-params.lv2/params.ttl126
-rw-r--r--plugins/eg-params.lv2/state_map.h114
-rw-r--r--plugins/eg-params.lv2/wscript49
-rw-r--r--plugins/eg-sampler.lv2/README.txt (renamed from plugins/eg04-sampler.lv2/README.txt)1
-rw-r--r--plugins/eg-sampler.lv2/atom_sink.h42
-rw-r--r--plugins/eg-sampler.lv2/click.wav (renamed from plugins/eg04-sampler.lv2/click.wav)bin644 -> 644 bytes
-rw-r--r--plugins/eg-sampler.lv2/manifest.ttl.in (renamed from plugins/eg04-sampler.lv2/manifest.ttl.in)0
-rw-r--r--plugins/eg-sampler.lv2/peaks.h271
-rw-r--r--plugins/eg-sampler.lv2/sampler.c603
-rw-r--r--plugins/eg-sampler.lv2/sampler.ttl (renamed from plugins/eg04-sampler.lv2/sampler.ttl)17
-rw-r--r--plugins/eg-sampler.lv2/sampler_ui.c465
-rw-r--r--plugins/eg-sampler.lv2/uris.h (renamed from plugins/eg04-sampler.lv2/uris.h)90
l---------plugins/eg-sampler.lv2/waf1
-rw-r--r--plugins/eg-sampler.lv2/wscript64
-rw-r--r--plugins/eg-scope.lv2/README.txt (renamed from plugins/eg05-scope.lv2/README.txt)10
-rw-r--r--plugins/eg-scope.lv2/examploscope.c (renamed from plugins/eg05-scope.lv2/examploscope.c)153
-rw-r--r--plugins/eg-scope.lv2/examploscope.ttl.in (renamed from plugins/eg05-scope.lv2/examploscope.ttl.in)0
-rw-r--r--plugins/eg-scope.lv2/examploscope_ui.c (renamed from plugins/eg05-scope.lv2/examploscope_ui.c)105
-rw-r--r--plugins/eg-scope.lv2/manifest.ttl.in (renamed from plugins/eg05-scope.lv2/manifest.ttl.in)3
-rw-r--r--plugins/eg-scope.lv2/uris.h (renamed from plugins/eg05-scope.lv2/uris.h)10
-rw-r--r--plugins/eg-scope.lv2/wscript56
-rw-r--r--plugins/eg01-amp.lv2/manifest.ttl.in101
-rw-r--r--plugins/eg01-amp.lv2/wscript67
-rw-r--r--plugins/eg02-midigate.lv2/wscript65
-rw-r--r--plugins/eg03-metro.lv2/wscript64
-rw-r--r--plugins/eg04-sampler.lv2/sampler.c483
-rw-r--r--plugins/eg04-sampler.lv2/sampler_ui.c201
-rw-r--r--plugins/eg04-sampler.lv2/wscript80
-rw-r--r--plugins/eg05-scope.lv2/wscript73
-rwxr-xr-xplugins/literasc.py36
-rw-r--r--plugins/wscript19
-rw-r--r--schemas.lv2/README (renamed from schemas/README)4
-rw-r--r--schemas.lv2/dcs.ttl (renamed from schemas/dcs.ttl)57
-rw-r--r--schemas.lv2/dct.ttl340
-rw-r--r--schemas.lv2/doap.ttl707
-rw-r--r--schemas.lv2/foaf.ttl (renamed from schemas/foaf.ttl)69
-rw-r--r--schemas.lv2/manifest.ttl34
-rw-r--r--schemas.lv2/owl.ttl (renamed from schemas/owl.ttl)105
-rw-r--r--schemas.lv2/rdf.ttl (renamed from schemas/rdf.ttl)10
-rw-r--r--schemas.lv2/rdfs.ttl (renamed from schemas/rdfs.ttl)17
-rw-r--r--schemas.lv2/xsd.ttl (renamed from schemas/xsd.ttl)281
-rw-r--r--schemas/aboutdcmi.ttl15
-rw-r--r--schemas/dc.ttl176
-rw-r--r--schemas/dcam.ttl31
-rw-r--r--schemas/dct.ttl1036
-rw-r--r--schemas/dctype.ttl145
-rw-r--r--schemas/doap.ttl403
-rw-r--r--schemas/skos.ttl278
-rwxr-xr-xutil/lv2_validate.in111
-rwxr-xr-xwafbin96114 -> 709 bytes
m---------waflib0
-rw-r--r--wscript869
262 files changed, 22102 insertions, 14103 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..9a895df
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,11 @@
+# generated files and folders
+.waf-*
+.lock-waf*
+/build
+*.pyc
+NEWS
+
+# misc editor/tools
+*.swp
+cscope.*
+tags
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
new file mode 100644
index 0000000..6f91102
--- /dev/null
+++ b/.gitlab-ci.yml
@@ -0,0 +1,159 @@
+stages: [build, test, deploy]
+
+variables:
+ GIT_SUBMODULE_STRATEGY: normal
+
+.build_template: &build_definition
+ stage: build
+ artifacts:
+ paths: ["build/", ".lock-waf*"]
+
+.test_template: &test_definition
+ stage: test
+ artifacts:
+ paths: [build/coverage]
+
+
+arm32_dbg:
+ <<: *build_definition
+ image: lv2plugin/debian-arm32
+ script: python ./waf configure build -dsT
+ variables:
+ CC: "arm-linux-gnueabihf-gcc"
+ CXX: "arm-linux-gnueabihf-g++"
+
+test:arm32_dbg:
+ <<: *test_definition
+ image: lv2plugin/debian-arm32
+ script: python ./waf test --wrapper=qemu-arm
+ needs: [arm32_dbg]
+
+
+arm32_rel:
+ <<: *build_definition
+ image: lv2plugin/debian-arm32
+ script: python ./waf configure build -sT
+ variables:
+ CC: "arm-linux-gnueabihf-gcc"
+ CXX: "arm-linux-gnueabihf-g++"
+
+test:arm32_rel:
+ <<: *test_definition
+ image: lv2plugin/debian-arm32
+ script: python ./waf test --wrapper=qemu-arm
+ needs: [arm32_rel]
+
+
+arm64_dbg:
+ <<: *build_definition
+ image: lv2plugin/debian-arm64
+ script: python ./waf configure build -dsT
+ variables:
+ CC: "aarch64-linux-gnu-gcc"
+ CXX: "aarch64-linux-gnu-g++"
+
+test:arm64_dbg:
+ <<: *test_definition
+ image: lv2plugin/debian-arm64
+ script: python ./waf test --wrapper=qemu-aarch64
+ needs: [arm64_dbg]
+
+
+arm64_rel:
+ <<: *build_definition
+ image: lv2plugin/debian-arm64
+ script: python ./waf configure build -sT
+ variables:
+ CC: "aarch64-linux-gnu-gcc"
+ CXX: "aarch64-linux-gnu-g++"
+
+test:arm64_rel:
+ <<: *test_definition
+ image: lv2plugin/debian-arm64
+ script: python ./waf test --wrapper=qemu-aarch64
+ needs: [arm64_rel]
+
+
+x64_dbg:
+ <<: *build_definition
+ image: lv2plugin/debian-x64
+ script: python ./waf configure build -dsT
+
+test:x64_dbg:
+ <<: *test_definition
+ image: lv2plugin/debian-x64
+ script: python ./waf test
+ needs: [x64_dbg]
+
+
+x64_rel:
+ <<: *build_definition
+ image: lv2plugin/debian-x64
+ script: python ./waf configure build -sT
+
+test:x64_rel:
+ <<: *test_definition
+ image: lv2plugin/debian-x64
+ script: python ./waf test
+ needs: [x64_rel]
+
+
+mac_dbg:
+ <<: *build_definition
+ script: python ./waf configure build -dsT --no-coverage
+ tags: [macos]
+
+test:mac_dbg:
+ <<: *test_definition
+ script: python ./waf test
+ needs: [mac_dbg]
+ tags: [macos]
+
+
+mac_rel:
+ <<: *build_definition
+ script: python ./waf configure build -sT --no-coverage
+ tags: [macos]
+
+test:mac_rel:
+ <<: *test_definition
+ script: python ./waf test
+ needs: [mac_rel]
+ tags: [macos]
+
+
+win_dbg:
+ <<: *build_definition
+ script: python ./waf configure build -dT --no-coverage
+ tags: [windows,msvc,python]
+
+test:win_dbg:
+ <<: *test_definition
+ script: python ./waf test
+ needs: [win_dbg]
+ tags: [windows,msvc,python]
+
+
+win_rel:
+ <<: *build_definition
+ script: python ./waf configure build -T --no-coverage
+ tags: [windows,msvc,python]
+
+test:win_rel:
+ <<: *test_definition
+ script: python ./waf test
+ needs: [win_rel]
+ tags: [windows,msvc,python]
+
+
+pages:
+ stage: deploy
+ script: mv build/coverage/ public/
+ needs: ["test:x64_dbg"]
+ artifacts:
+ expire_in: 30 days
+ paths: [public]
+ rules:
+ - if: $CI_MERGE_REQUEST_ID
+ when: never
+ - when: on_success
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..cc8b569
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "waflib"]
+ path = waflib
+ url = ../../drobilla/autowaf.git
diff --git a/README b/README
deleted file mode 100644
index 2687acc..0000000
--- a/README
+++ /dev/null
@@ -1,82 +0,0 @@
-LV2
-===
-
-LV2 is a plugin standard for audio systems. It defines a minimal yet extensible
-C API for plugin code and a format for plugin "bundles". See
-<http://lv2plug.in> for more information.
-
-This package contains specifications (a C header and/or a schema in Turtle),
-documentation generation tools, and example plugins.
-
-Building and installation requires only Python 2.6 and, optionally, Doxygen.
-
-
-Installation
-------------
-
-A typical build looks something like this:
-
- ./waf configure --prefix /foo
- ./waf
- sudo ./waf install
-
-or, for packaging:
-
- DESTDIR=/foo/lv2 ./waf install
-
-For help on the various options available, run:
-
- ./waf --help
-
-The bundle installation directory can be set with the --lv2-dir option, e.g.:
-
- ./waf configure --lv2-dir /foo/lib/lv2
-
-Similarly, --lv2-user will install to the user LV2 directory (e.g. ~/.lv2).
-
-
-Packaging
----------
-
-Specification bundles are both a build and run time dependency of programs that
-use LV2. Programs expect their data to be available somewhere in LV2_PATH.
-
-See <http://lv2plug.in/trac/wiki/Filesystem_Hierarchy_Standard> for details on
-the standard installation paths.
-
-Do not split up LV2 bundles, they must remain self-contained. This is a
-requirement, not a suggestion, and it supercedes any rules your distribution
-may have which were likely designed for libraries (note LV2 specifications are
-just text, not libraries). You are free to link or copy things anywhere, but
-under no circumstances should an incomplete part of a bundle be installed.
-
-Other than that, things may be split up in any way. In particular it is a good
-idea to split specifications, tools, and plugins into separate packages.
-
-
-Header Installation
--------------------
-
-The install stage installs symbolic links to headers in bundles. This is to
-support universal C includes that do not change from system to system. For
-example, the URID extension's header can always be included like so:
-
- #include "lv2/lv2plug.in/ns/ext/urid/urid.h"
-
-Note that some specification headers themselves have such include lines, which
-must not be modified. The details of how this is achieved are unimportant and
-may be tailored to particular systems. The requirement is simply that this
-style of include must work for any header in a specification.
-
-If you are having problems with symbolic links for whatever reason, configure
-with the --copy-headers option, which will make copies instead.
-
-
-Documentation
--------------
-
-Configuring with the --docs option will build the documentation for all the
-included specifications if Doxygen is available. For example:
-
- ./waf configure --docs
- ./waf
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a69441b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,82 @@
+LV2
+===
+
+LV2 is a plugin standard for audio systems. It defines a minimal yet extensible
+C API for plugin code and a format for plugin "bundles". See
+<http://lv2plug.in> for more information.
+
+This package contains specifications (C headers and Turtle files),
+documentation generation tools, and example plugins.
+
+Building and installation requires only Python 2.6. Building the documentation
+requires Doxygen.
+
+
+Installation
+------------
+
+A typical build looks something like this:
+
+ ./waf configure --prefix=/foo
+ ./waf
+ sudo ./waf install
+
+or, for packaging:
+
+ DESTDIR=/home/packager/lv2root ./waf install
+
+For help on the other available options, run:
+
+ ./waf --help
+
+The bundle installation directory can be set with the --lv2dir option, e.g.:
+
+ ./waf configure --lv2dir=/foo/lib/lv2
+
+Configuring with `--lv2-user` will install bundles to the user-local location.
+
+
+Packaging
+---------
+
+Specification bundles are both a build-time and run-time dependency of programs
+that use LV2. Programs expect their data to be available somewhere in
+`LV2_PATH`.
+
+See <http://lv2plug.in/pages/filesystem-hierarchy-standard.html> for details on
+the standard installation paths.
+
+Do not split up LV2 bundles, they are self-contained and must remain whole.
+Other than that, things may be split to suit distribution needs. For example,
+separate packages for specifications, tools, and plugins, may be good idea.
+
+
+Header Installation
+-------------------
+
+By default symbolic links to headers in bundles are installed to `INCLUDEDIR`.
+If symbolic links are a problem, configure with `--copy-headers` and copies
+will be installed instead.
+
+Headers are installed in two paths, the universal URI-based style:
+
+ #include "lv2/lv2plug.in/ns/ext/urid/urid.h"
+
+and the newer simple core style:
+
+ #include "lv2/urid/urid.h"
+
+Projects are encouraged to migrate to the latter style, though note that this
+style of include path may only be used by official LV2 specifications.
+
+
+Documentation
+-------------
+
+Configuring with the --docs option will build the documentation for all the
+included specifications if Doxygen is available. For example:
+
+ ./waf configure --docs
+ ./waf
+
+Specification documentation is also availabe online at <http://lv2plug.in/ns>.
diff --git a/doc/asciidoc.css b/doc/asciidoc.css
new file mode 100644
index 0000000..59bf677
--- /dev/null
+++ b/doc/asciidoc.css
@@ -0,0 +1,534 @@
+/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
+
+/* Default font. */
+body {
+ font-family: serif;
+}
+
+/* Title font. */
+h1, h2, h3, h4, h5, h6,
+div.title, caption.title,
+thead, p.table.header,
+#toctitle,
+#author, #revnumber, #revdate, #revremark,
+#footer {
+ font-family: sans-serif;
+}
+
+body {
+ margin: 1em 5% 1em 5%;
+}
+
+a {
+ /* color: blue; */
+ color: #5e72a5;
+ text-decoration: underline;
+}
+a:visited {
+ color: #4c3b5b;
+}
+
+em {
+ font-style: italic;
+ color: navy;
+}
+
+strong {
+ font-weight: bold;
+ color: #083194;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ color: black;
+ margin-top: 1.2em;
+ margin-bottom: 0.5em;
+ line-height: 1.3;
+}
+
+h1, h2, h3 {
+ border-bottom: 2px solid silver;
+}
+h2 {
+ padding-top: 0.5em;
+}
+h3 {
+ float: left;
+}
+h3 + * {
+ clear: left;
+}
+h5 {
+ font-size: 1.0em;
+}
+
+div.sectionbody {
+ margin-left: 0;
+}
+
+hr {
+ border: 1px solid silver;
+}
+
+p {
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+}
+
+ul, ol, li > p {
+ margin-top: 0;
+}
+ul > li { color: #aaa; }
+ul > li > * { color: black; }
+
+.monospaced, code, pre {
+ font-family: monospace;
+ font-size: inherit;
+ color: black;
+ padding: 0;
+ margin: 0;
+}
+pre {
+ white-space: pre-wrap;
+}
+
+#author {
+ color: black;
+ font-weight: bold;
+ font-size: 1.1em;
+}
+#email {
+}
+#revnumber, #revdate, #revremark {
+}
+
+#footer {
+ font-size: small;
+ border-top: 2px solid silver;
+ padding-top: 0.5em;
+ margin-top: 4.0em;
+}
+#footer-text {
+ float: left;
+ padding-bottom: 0.5em;
+}
+#footer-badges {
+ float: right;
+ padding-bottom: 0.5em;
+}
+
+#preamble {
+ margin-top: 1.5em;
+ margin-bottom: 1.5em;
+}
+div.imageblock, div.exampleblock, div.verseblock,
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
+div.admonitionblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
+}
+div.admonitionblock {
+ margin-top: 2.0em;
+ margin-bottom: 2.0em;
+ margin-right: 10%;
+ color: #606060;
+}
+
+div.content { /* Block element content. */
+ padding: 0;
+}
+
+/* Block element titles. */
+div.title, caption.title {
+ color: #527bbd;
+ font-weight: bold;
+ text-align: left;
+ margin-top: 1.0em;
+ margin-bottom: 0.5em;
+}
+div.title + * {
+ margin-top: 0;
+}
+
+td div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content + div.title {
+ margin-top: 0.0em;
+}
+
+div.sidebarblock > div.content {
+ background: #ffffee;
+ border: 1px solid #dddddd;
+ border-left: 4px solid #f0f0f0;
+ padding: 0.5em;
+}
+
+div.listingblock > div.content {
+ border: 1px solid #dddddd;
+ border-left: 5px solid #f0f0f0;
+ background: #f8f8f8;
+ padding: 0.5em;
+}
+
+div.quoteblock, div.verseblock {
+ padding-left: 1.0em;
+ margin-left: 1.0em;
+ margin-right: 10%;
+ border-left: 5px solid #f0f0f0;
+ color: #888;
+}
+
+div.quoteblock > div.attribution {
+ padding-top: 0.5em;
+ text-align: right;
+}
+
+div.verseblock > pre.content {
+ font-family: inherit;
+ font-size: inherit;
+}
+div.verseblock > div.attribution {
+ padding-top: 0.75em;
+ text-align: left;
+}
+/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
+div.verseblock + div.attribution {
+ text-align: left;
+}
+
+div.admonitionblock .icon {
+ vertical-align: top;
+ font-size: 1.1em;
+ font-weight: bold;
+ text-decoration: underline;
+ color: #527bbd;
+ padding-right: 0.5em;
+}
+div.admonitionblock td.content {
+ padding-left: 0.5em;
+ border-left: 3px solid #dddddd;
+}
+
+div.exampleblock > div.content {
+ border-left: 3px solid #dddddd;
+ padding-left: 0.5em;
+}
+
+div.imageblock div.content { padding-left: 0; }
+span.image img { border-style: none; vertical-align: text-bottom; }
+a.image:visited { color: white; }
+
+dl {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+dt {
+ margin-top: 0.5em;
+ margin-bottom: 0;
+ font-style: normal;
+ color: navy;
+}
+dd > *:first-child {
+ margin-top: 0.1em;
+}
+
+ul, ol {
+ list-style-position: outside;
+}
+ol.arabic {
+ list-style-type: decimal;
+}
+ol.loweralpha {
+ list-style-type: lower-alpha;
+}
+ol.upperalpha {
+ list-style-type: upper-alpha;
+}
+ol.lowerroman {
+ list-style-type: lower-roman;
+}
+ol.upperroman {
+ list-style-type: upper-roman;
+}
+
+div.compact ul, div.compact ol,
+div.compact p, div.compact p,
+div.compact div, div.compact div {
+ margin-top: 0.1em;
+ margin-bottom: 0.1em;
+}
+
+tfoot {
+ font-weight: bold;
+}
+td > div.verse {
+ white-space: pre;
+}
+
+div.hdlist {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+div.hdlist tr {
+ padding-bottom: 15px;
+}
+dt.hdlist1.strong, td.hdlist1.strong {
+ font-weight: bold;
+}
+td.hdlist1 {
+ vertical-align: top;
+ font-style: normal;
+ padding-right: 0.8em;
+ color: navy;
+}
+td.hdlist2 {
+ vertical-align: top;
+}
+div.hdlist.compact tr {
+ margin: 0;
+ padding-bottom: 0;
+}
+
+.comment {
+ background: yellow;
+}
+
+.footnote, .footnoteref {
+ font-size: 0.8em;
+}
+
+span.footnote, span.footnoteref {
+ vertical-align: super;
+}
+
+#footnotes {
+ margin: 20px 0 20px 0;
+ padding: 7px 0 0 0;
+}
+
+#footnotes div.footnote {
+ margin: 0 0 5px 0;
+}
+
+#footnotes hr {
+ border: none;
+ border-top: 1px solid silver;
+ height: 1px;
+ text-align: left;
+ margin-left: 0;
+ width: 20%;
+ min-width: 100px;
+}
+
+div.colist td {
+ padding-right: 0.5em;
+ padding-bottom: 0.3em;
+ vertical-align: top;
+}
+div.colist td img {
+ margin-top: 0.3em;
+}
+
+@media print {
+ #footer-badges { display: none; }
+}
+
+#toc {
+ margin-bottom: 2.5em;
+}
+
+#toctitle {
+ color: black;
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 1.0em;
+ margin-bottom: 0.1em;
+}
+
+div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+div.toclevel2 {
+ margin-left: 2em;
+ font-size: 0.9em;
+}
+div.toclevel3 {
+ margin-left: 4em;
+ font-size: 0.9em;
+}
+div.toclevel4 {
+ margin-left: 6em;
+ font-size: 0.9em;
+}
+
+span.aqua { color: aqua; }
+span.black { color: black; }
+span.blue { color: blue; }
+span.fuchsia { color: fuchsia; }
+span.gray { color: gray; }
+span.green { color: green; }
+span.lime { color: lime; }
+span.maroon { color: maroon; }
+span.navy { color: navy; }
+span.olive { color: olive; }
+span.purple { color: purple; }
+span.red { color: red; }
+span.silver { color: silver; }
+span.teal { color: teal; }
+span.white { color: white; }
+span.yellow { color: yellow; }
+
+span.aqua-background { background: aqua; }
+span.black-background { background: black; }
+span.blue-background { background: blue; }
+span.fuchsia-background { background: fuchsia; }
+span.gray-background { background: gray; }
+span.green-background { background: green; }
+span.lime-background { background: lime; }
+span.maroon-background { background: maroon; }
+span.navy-background { background: navy; }
+span.olive-background { background: olive; }
+span.purple-background { background: purple; }
+span.red-background { background: red; }
+span.silver-background { background: silver; }
+span.teal-background { background: teal; }
+span.white-background { background: white; }
+span.yellow-background { background: yellow; }
+
+span.big { font-size: 2em; }
+span.small { font-size: 0.6em; }
+
+span.underline { text-decoration: underline; }
+span.overline { text-decoration: overline; }
+span.line-through { text-decoration: line-through; }
+
+div.unbreakable { page-break-inside: avoid; }
+
+
+/*
+ * xhtml11 specific
+ *
+ * */
+
+div.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
+}
+div.tableblock > table {
+ border: 1px dashed #ccc;
+}
+thead, p.table.header {
+ font-weight: bold;
+ color: #527bbd;
+}
+p.table {
+ margin-top: 0;
+}
+th.tableblock {
+ font-weight: bold;
+ border: 1px dashed #ccc;
+}
+td.tableblock, th.tableblock {
+ border: 1px dashed #ccc;
+}
+/* Because the table frame attribute is overriden by CSS in most browsers. */
+div.tableblock > table[frame="void"] {
+ border-style: none;
+}
+div.tableblock > table[frame="hsides"] {
+ border-left-style: none;
+ border-right-style: none;
+}
+div.tableblock > table[frame="vsides"] {
+ border-top-style: none;
+ border-bottom-style: none;
+}
+
+
+/*
+ * html5 specific
+ *
+ * */
+
+table.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
+}
+thead, p.tableblock.header {
+ font-weight: bold;
+ color: black;
+}
+p.tableblock {
+ margin-top: 0;
+}
+table.tableblock {
+ border: 0;
+ border-spacing: 0px;
+ border-style: hidden;
+ border-color: #ccc;
+ border-collapse: collapse;
+}
+th.tableblock, td.tableblock {
+ border-width: 1px;
+ padding: 4px;
+ border: 1px dashed #ccc;
+}
+
+table.tableblock.frame-topbot {
+ border-left-style: hidden;
+ border-right-style: hidden;
+}
+table.tableblock.frame-sides {
+ border-top-style: hidden;
+ border-bottom-style: hidden;
+}
+table.tableblock.frame-none {
+ border-style: hidden;
+}
+
+th.tableblock.halign-left, td.tableblock.halign-left {
+ text-align: left;
+}
+th.tableblock.halign-center, td.tableblock.halign-center {
+ text-align: center;
+}
+th.tableblock.halign-right, td.tableblock.halign-right {
+ text-align: right;
+}
+
+th.tableblock.valign-top, td.tableblock.valign-top {
+ vertical-align: top;
+}
+th.tableblock.valign-middle, td.tableblock.valign-middle {
+ vertical-align: middle;
+}
+th.tableblock.valign-bottom, td.tableblock.valign-bottom {
+ vertical-align: bottom;
+}
+
+
+/*
+ * manpage specific
+ *
+ * */
+
+body.manpage h1 {
+ padding-top: 0.5em;
+ padding-bottom: 0.5em;
+ border-top: 2px solid silver;
+ border-bottom: 2px solid silver;
+}
+body.manpage h2 {
+ border-style: none;
+}
+body.manpage div.sectionbody {
+ margin-left: 3em;
+}
+
+@media print {
+ body.manpage div#toc { display: none; }
+}
diff --git a/doc/doxy-style.css b/doc/doxy-style.css
index b01ac5d..df8fcea 100644
--- a/doc/doxy-style.css
+++ b/doc/doxy-style.css
@@ -1,598 +1,863 @@
body {
- font-size: medium;
- font-family: sans-serif;
-}
-
-#titlearea {
- display: none;
-}
-
-h1 h2 h3 h4 h5 h6 {
- font-weight: bold;
+ background: #FFF;
+ color: #222;
+ font-style: normal;
+ line-height: 1.6em;
+ margin-left: auto;
+ margin-right: auto;
+ padding: 1em;
+ max-width: 60em;
+ font-family: "SF Pro Text", Verdana, "DejaVu Sans", sans-serif;
+ text-rendering: optimizeLegibility;
}
h1 {
- font-size: 164%;
+ font-size: 1.68em;
+ font-weight: 500;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ line-height: 2em;
+ margin: 0 0 0.25em 0;
}
h2 {
- font-size: 132%;
+ line-height: 1.68em;
+ font-size: 1.41em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 1.25em 0 0.5em 0;
}
h3 {
- font-size: 124%;
+ line-height: 1.41em;
+ font-size: 1.18em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 1.25em 0 0.5em 0;
}
h4 {
- font-size: 116%;
+ line-height: 1.18em;
+ font-size: 1em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 1.25em 0 0.5em 0;
}
-h5 {
- font-size: 108%;
+h5, h6 {
+ font-size: 0.7em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 1.25em 0 0.5em 0;
}
-h6 {
- font-size: 100%;
+a {
+ color: #546E00;
+ text-decoration: none;
}
-p {
- margin: 0 0 1ex 0;
+h1 a, h2 a, h3 a, h4 a, h5 a, h6 a {
+ color: #444;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+h1 a:link, h2 a:link, h3 a:link, h4 a:link, h5 a:link, h6 a:link {
+ color: #444;
}
-br {
- display: none;
+h1 a:visited, h2 a:visited, h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited {
+ color: #444;
+}
+
+p {
+ margin: 0.5em 0 0.5em 0;
}
dt {
- font-weight: 700;
+ font-weight: 600;
}
-div.multicol {
+dd {
+ margin-left: 2em;
}
-p.startli,p.startdd,p.starttd {
- margin-top: 2px;
+caption {
+ font-weight: 700;
}
-p.endli {
- margin-bottom: 0;
+.title, #projectname {
+ line-height: 1.0125em;
+ margin: 0.75em 0 0 0;
}
-p.enddd {
- margin-bottom: 4px;
+.titlearea .header .titlebox, #projectname {
+ font-size: 1.68em;
+ font-weight: 400;
+ margin-bottom: 0.25em;
+ margin-top: 0;
}
-p.endtd {
- margin-bottom: 2px;
+#header {
+ padding: 0 0 0.5em 0;
+ border-bottom: 1px solid #EEE;
}
-caption {
- font-weight: 700;
+.header .headertitle .title {
+ line-height: 1.68em;
+ font-size: 1.68em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
}
-span.legend {
- font-size: 70%;
- text-align: center;
+.ingroups {
+ display: none;
}
-h3.version {
- font-size: 90%;
- text-align: center;
+.title .ingroups a {
+ font-size: small;
+ margin-left: 1em;
}
-div.qindex,div.navtab {
- background-color: #EBEFF6;
- border: 1px solid #A3B4D7;
- text-align: center;
- margin: 2px;
- padding: 2px;
+#titlebox, #metabox {
+ display: inline-block;
}
-div.qindex,div.navpath {
- width: 100%;
- line-height: 140%;
+#titlebox {
+ display: inline-block;
+ width: 75%;
+ left: 0;
+ top: 0;
}
-div.navtab {
- margin-right: 15px;
+#title {
+ margin-bottom: 0.25em;
+ line-height: 1.25em;
+ font-size: 2.5em;
+ color: #333;
+ font-weight: 600;
}
-/* @group Link Styling */
-a {
- color: #3D8C57;
- text-decoration: none;
+.PageDoc {
+ margin-top: 1.5em;
}
-.contents a:visited {
- color: #50755E;
+.PageDoc .header .headertitle .title {
+ display: none;
}
-a:hover {
- text-decoration: underline;
+#shortdesc {
+ margin: 0;
+ color: #666;
+ display: inline-block;
+ font-style: italic;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ padding: 0;
}
-a.qindexHL {
- background-color: #9CAFD4;
- color: #FFF;
- border: 1px double #869DCA;
+#titlearea {
+ margin: 0.25em auto 0 auto;
+ padding: 0;
+ position: relative;
+ clear: both;
+ line-height: 1em;
+}
+
+.legend {
+ font-size: small;
+ text-align: center;
}
-a.code {
- color: #4665A2;
+.version {
+ font-size: small;
+ text-align: center;
}
-a.codeRef {
- color: #4665A2;
+div.qindex,div.navtab {
+ background-color: #EBEFF6;
+ border: 1px solid #A3B4D7;
+ text-align: center;
+ margin: 2px;
+ padding: 2px;
+}
+
+div.navtab {
+ margin-right: 15px;
+}
+
+.contents a:visited {
+ color: #344E00;
+}
+
+a.qindexHL {
+ background-color: #9CAFD4;
+ color: #FFF;
+ border: 1px double #869DCA;
+}
+
+code {
+ color: #444;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
}
-/* @end */
dl.el {
- margin-left: -1cm;
+ margin-left: -1cm;
}
.fragment {
- font-family: monospace, fixed;
- font-size: 105%;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
}
pre.fragment {
- border: 1px solid #C4C4C4;
- background-color: #F9F9F9;
- padding: 4px 6px;
- margin: 4px 8px 4px 2px;
- overflow: auto;
- font-size: 9pt;
- line-height: 125%;
+ border: 1px solid #C4C4C4;
+ background-color: #F9F9F9;
+ padding: 0.5em;
+ overflow: auto;
}
div.ah {
- background-color: #000;
- font-weight: 700;
- color: #FFF;
- margin-bottom: 3px;
- margin-top: 3px;
- padding: .2em;
- border: thin solid #333;
+ background-color: #000;
+ font-weight: 700;
+ color: #FFF;
+ margin-bottom: 3px;
+ margin-top: 3px;
+ padding: 0.2em;
+ border: thin solid #333;
}
div.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- margin-bottom: 6px;
- font-weight: 700;
+ margin-left: 16px;
+ margin-top: 12px;
+ margin-bottom: 6px;
+ font-weight: 700;
+}
+
+h2.groupheader {
+ line-height: 1.18em;
+ font-size: 1em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 1.25em 0 0.5em 0;
+}
+
+a + h2.groupheader {
+ display: none;
}
div.groupText {
- margin-left: 16px;
- font-style: italic;
+ margin-left: 16px;
+ font-style: italic;
}
-body {
- background: #FFF;
- color: #000;
- margin: 0;
+div.contents, #content {
+ max-width: 60em;
+ margin-left: auto;
+ margin-right: auto;
}
-div.contents {
- margin-top: 10px;
- margin-left: 10px;
- margin-right: 10px;
+.groupheader + p {
+ font-style: italic;
+ color: #666;
+ margin: 0 0 1em 0;
}
td.indexkey {
- background-color: #EBEFF6;
- font-weight: 700;
- border: 1px solid #C4CFE5;
- margin: 2px 0;
- padding: 2px 10px;
+ background-color: #EBEFF6;
+ font-weight: 700;
+ border: 1px solid #C4CFE5;
+ margin: 2px 0;
+ padding: 2px 10px;
}
td.indexvalue {
- background-color: #EBEFF6;
- border: 1px solid #C4CFE5;
- padding: 2px 10px;
- margin: 2px 0;
+ background-color: #EBEFF6;
+ border: 1px solid #C4CFE5;
+ padding: 2px 10px;
+ margin: 2px 0;
}
-tr.memlist {
- background-color: #EEF1F7;
+table.memname {
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+ border-spacing: 0;
}
-p.formulaDsp {
- text-align: center;
+table.memname tbody tr:last-child {
+ display: none;
+}
+
+table.memname tbody tr:only-child {
+ display: table-cell;
+}
+
+table.memname tbody tr:nth-last-child(2)::after {
+ content: ")";
+}
+
+tr.memlist {
+ background-color: #EEF1F7;
}
-img.formulaDsp {
+p.formulaDsp {
+ text-align: center;
}
img.formulaInl {
- vertical-align: middle;
+ vertical-align: middle;
}
div.center {
- text-align: center;
- margin-top: 0;
- margin-bottom: 0;
- padding: 0;
+ text-align: center;
+ margin-top: 0;
+ margin-bottom: 0;
+ padding: 0;
}
div.center img {
- border: 0;
+ border: 0;
}
address.footer {
- text-align: right;
- padding-right: 12px;
+ text-align: right;
}
img.footer {
- border: 0;
- vertical-align: middle;
+ border: 0;
+ vertical-align: middle;
}
-/* @group Code Colorization */
span.keyword {
- color: green;
+ color: #586E75;
}
span.keywordtype {
- color: #604020;
+ color: #546E00;
}
span.keywordflow {
- color: #e08000;
+ color: #586E75;
}
span.comment {
- color: maroon;
+ color: #6C71C4;
}
span.preprocessor {
- color: #806020;
+ color: #D33682;
}
span.stringliteral {
- color: #002080;
+ color: #CB4B16;
}
span.charliteral {
- color: teal;
+ color: #CB4B16;
}
-span.vhdldigit {
- color: #F0F;
+td.tiny {
+ font-size: x-small;
}
-span.vhdlkeyword {
- color: #700070;
+.dirtab {
+ padding: 4px;
+ border-collapse: collapse;
+ border: 1px solid #A3B4D7;
}
-span.vhdllogic {
- color: red;
+th.dirtab {
+ background: #EBEFF6;
+ font-weight: 700;
}
-/* @end */
-td.tiny {
- font-size: 75%;
+hr {
+ height: 0;
+ border: none;
+ border-top: 1px solid #DDD;
+ margin: 2em 0;
}
-.dirtab {
- padding: 4px;
- border-collapse: collapse;
- border: 1px solid #A3B4D7;
+#footer {
+ bottom: 0;
+ clear: both;
+ font-size: x-small;
+ margin: 2em 0 0;
+ padding: 0 1em 1em 1em;
+ vertical-align: top;
+ color: #888;
}
-th.dirtab {
- background: #EBEFF6;
- font-weight: 700;
+td.ititle {
+ padding-bottom: 0.75em;
}
-hr {
- height: 0;
- border: none;
- border-top: 1px solid #DDD;
- margin: 2em 0 1em;
+table.memberdecls {
+ border-spacing: 0.125em;
+ line-height: 1.3em;
}
-hr.footer {
- height: 1px;
+table.memberdecls h3 {
+ line-height: 1.18em;
+ font-size: 1em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 1.25em 0 0.5em 0;
}
-/* @group Member Descriptions */
-table.memberdecls {
- border-spacing: 0;
- font-size: small;
+tr.inherit_header td {
+ padding: 1em 0 0.5em 0;
}
.mdescLeft,.mdescRight,.memItemLeft,.memItemRight,.memTemplItemLeft,.memTemplItemRight,.memTemplParams {
- background-color: #FBFBFB;
- margin: 0;
- padding: 0.25ex;
+ margin: 0;
+ padding: 0;
}
.mdescLeft,.mdescRight {
- color: #555;
+ color: #555;
}
.memItemLeft,.memItemRight,.memTemplParams {
- border-top: 1px solid #DDD;
+ border: 0;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
}
.memItemLeft,.memTemplItemLeft {
- white-space: nowrap;
- padding-left: 2em;
+ white-space: nowrap;
+ padding-left: 2em;
+}
+
+.memItemLeft a.el {
+ font-weight: bold;
}
.memTemplParams {
- color: #464646;
- white-space: nowrap;
+ color: #464646;
+ white-space: nowrap;
+}
+
+td.memSeparator {
+ display: none;
+}
+
+td.mlabels-left {
+ margin-left: 0;
+ padding-left: 0;
+}
+
+td.mlabels-right {
+ color: #B4C342;
+ font-weight: normal;
+ margin-left: 1em;
+ vertical-align: bottom;
+}
+
+.memtitle {
+ border-bottom: 1px solid #EEE;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ font-size: 1.18em;
+ font-weight: 600;
+ line-height: 1.41em;
+ margin: 1.5em 0 0 0;
+}
+
+.permalink {
+ display: none;
}
-/* @end */
-/* @group Member Details */
-/* Styles for detailed member documentation */
.memtemplate {
- font-size: 80%;
- color: #4665A2;
- font-weight: bold;
+ color: #888;
+ font-style: italic;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+ font-size: small;
}
.memnav {
- background-color: #EBEFF6;
- border: 1px solid #A3B4D7;
- text-align: center;
- margin: 2px;
- margin-right: 15px;
- padding: 2px;
+ background-color: #EEE;
+ border: 1px solid #B4C342;
+ text-align: center;
+ margin: 2px;
+ margin-right: 15px;
+ padding: 2px;
}
.memitem {
- padding: 0;
- margin: 1ex 0 2ex 0;
- border: 1px solid #CCC;
+ padding: 0;
+ margin: 0 0 3em 0;
}
-.memname {
- white-space: nowrap;
- font-weight: bold;
+.memproto {
+ border-bottom: 1px solid #EEE;
+ border-left: 1px solid #EEE;
+ color: #444;
+ float: right;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+ font-size: small;
+ margin-bottom: 1em;
+ margin-left: 1em;
+ padding: 0.25em 0 0.25em 0.25em;
}
-.memproto {
- border-bottom: 1px solid #DDD;
- padding: 0.5ex;
- font-weight: bold;
- background-color: #F3F3F3;
+.memproto .paramname {
+ font-style: normal;
+ padding-right: 0.25em;
+}
+
+.mlabels {
+ padding-left: 0;
+ padding-right: 0;
}
.memdoc {
- padding: 1ex;
- background-color: #FBFBFB;
- border-top-width: 0;
+ padding: 0;
+}
+
+.memdoc > p:first-child, .memdoc .textblock > p:first-child {
+ font-style: italic;
+ color: #444;
+ margin-bottom: 0.75em;
+ margin-top: 0;
+ padding-top: 0.25em;
+ font-weight: normal;
+}
+
+.memdoc > p:first-child, .memdoc .textblock > h3:first-child {
+ color: #444;
+ margin-bottom: 0.75em;
+ margin-top: 0;
+ padding-top: 0.25em;
+ font-weight: normal;
+ color: #444;
+ font-size: 0.9em;
}
.paramkey {
- text-align: right;
+ text-align: right;
}
.paramtype {
- white-space: nowrap;
+ color: #666;
+ padding: 0 0.25em 0 0.25em;
+ white-space: nowrap;
+}
+
+.params .paramname {
+ color: #111;
+ white-space: nowrap;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+ font-style: italic;
+ padding-right: 0.5em;
+ vertical-align: top;
+}
+
+.fieldname {
+ color: #000;
+}
+
+.fieldtable {
+ margin-top: 1em;
+ border-collapse: collapse;
+}
+
+.fieldtable tbody tr:first-child {
+ display: none;
+}
+
+td.fieldname {
+ vertical-align: top;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+}
+
+td.fielddoc {
+ padding: 0.125em 0.5em 0 0.5em;
+ vertical-align: top;
}
-.paramname {
- color: #602020;
- white-space: nowrap;
+.fieldtable tbody tr td {
+ border-top: 1px dashed #DDD;
+ border-bottom: 1px dashed #DDD;
}
-.paramname em {
- font-style: normal;
+td.fieldtype {
+ color: #666;
+ padding: 0 0.5em 0 0;
+ vertical-align: top;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+}
+
+td.fielddoc p {
+ margin: 0;
+ padding: 0 0.5em 0 0;
+}
+
+p.reference {
+ font-size: x-small;
+ font-style: italic;
}
-/* @end */
-/* @group Directory (tree) */
-/* for the tree view */
.ftvtree {
- font-family: sans-serif;
- margin: 0;
+ font-family: "DejaVu Sans", Verdana, Helvetica, Arial, sans-serif;
+ margin: 0;
}
-/* these are for tree view when used as main index */
.directory {
- font-size: 9pt;
- font-weight: bold;
- margin: 5px;
+ margin: 0.5em;
}
.directory h3 {
- margin: 0;
- margin-top: 1em;
- font-size: 11pt;
+ margin: 0;
+ margin-top: 1em;
+ font-size: 11pt;
}
.directory > h3 {
- margin-top: 0;
+ margin-top: 0;
}
.directory p {
- margin: 0;
- white-space: nowrap;
+ margin: 0;
+ white-space: nowrap;
}
.directory div {
- display: none;
- margin: 0;
+ display: none;
+ margin: 0;
}
.directory img {
- vertical-align: -30%;
+ vertical-align: -30%;
+}
+
+td.entry {
+ font-family: "DejaVu Sans", Verdana, Helvetica, Arial, sans-serif;
+ font-weight: 400;
+ padding-right: 1em;
+}
+
+.arrow {
+ color: #CCC;
+ user-select: none;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 22px;
+ vertical-align: top;
+}
+
+td.entry b {
+ font-family: "DejaVu Sans", Verdana, Helvetica, Arial, sans-serif;
+ font-weight: 400;
+ font-size: 130%;
}
-/* these are for tree view when not used as main index */
.directory-alt {
- font-size: 100%;
- font-weight: bold;
+ font-size: 100%;
+ font-weight: bold;
}
.directory-alt h3 {
- margin: 0;
- margin-top: 1em;
- font-size: 11pt;
+ margin: 0;
+ margin-top: 1em;
+ font-size: 11pt;
}
.directory-alt > h3 {
- margin-top: 0;
+ margin-top: 0;
}
.directory-alt p {
- margin: 0;
- white-space: nowrap;
+ margin: 0;
+ white-space: nowrap;
}
.directory-alt div {
- display: none;
- margin: 0;
+ display: none;
+ margin: 0;
}
.directory-alt img {
- vertical-align: -30%;
+ vertical-align: -30%;
}
-/* @end */
div.dynheader {
- margin-top: 8px;
+ margin-top: 8px;
}
address {
- font-style: normal;
- color: #2A3D61;
+ font-style: normal;
+ color: #444;
}
table.doxtable {
- border-collapse: collapse;
- margin: 0.5ex;
+ border-collapse: collapse;
+ margin: 0.5em;
}
table.doxtable td,table.doxtable th {
- border: 1px solid #DDD;
- padding: 3px 7px 2px;
+ border: 1px solid #DDD;
+ padding: 3px 7px 2px;
}
table.doxtable th {
- background-color: #F3F3F3;
- color: #000;
- padding-bottom: 4px;
- padding-top: 5px;
- text-align: left;
- font-weight: bold;
+ background-color: #F3F3F3;
+ color: #000;
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align: left;
+ font-weight: bold;
}
.tabsearch {
- top: 0;
- left: 10px;
- height: 36px;
- z-index: 101;
- overflow: hidden;
- font-size: 13px;
+ top: 0;
+ left: 10px;
+ height: 36px;
+ z-index: 101;
+ overflow: hidden;
+ font-size: 13px;
+}
+
+div.navpath {
+ color: #DDD;
}
.navpath ul {
- font-size: 11px;
- height: 30px;
- line-height: 30px;
- color: #8AA0CC;
- border: 1px solid #C2CDE4;
- overflow: hidden;
- margin: 0;
- padding: 0;
+ overflow: hidden;
+ margin: 0;
+ padding: 0;
}
.navpath li {
- list-style-type: none;
- float: left;
- padding-left: 10px;
- padding-right: 15px;
- color: #364D7C;
+ float: left;
+ padding-left: 0;
+ margin-left: 0.5em;
+ padding-right: 1em;
}
.navpath a {
- height: 32px;
- display: block;
- text-decoration: none;
- outline: none;
-}
-
-.navpath a:hover {
- color: #6884BD;
+ display: block;
+ text-decoration: none;
+ outline: none;
}
div.summary {
- float: right;
- font-size: 8pt;
- padding-right: 5px;
- width: 50%;
- text-align: right;
+ font-size: small;
+ font-family: "DejaVu Sans", Verdana, Helvetica, Arial, sans-serif;
+ margin: 0;
+ padding: 0.25em 0;
+ display: none;
}
div.summary a {
- white-space: nowrap;
+ white-space: nowrap;
+}
+
+#metabox {
+ display: inline-block;
+ font-size: x-small;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ position: absolute;
+ right: 0;
+ bottom: 0.25em;
+ color: #666;
+ font-style: italic;
}
-div.header {
- background-color: #F3F3F3;
- margin: 0;
- border-bottom: 1px solid #DDD;
+#meta {
+ border-style: hidden;
+ margin-right: 0.25em;
}
-div.headertitle {
- background-color: #ECF3F1;
- padding: 5px 5px 5px 10px;
- font-size: 180%;
- font-weight: bold;
+#meta tr, #meta th, #meta td {
+ background-color: transparent;
+ border: 0;
+ margin: 0;
+ font-weight: normal;
+}
+
+#meta th {
+ text-align: right;
+}
+
+#meta th::after {
+ content: ":";
}
div.line {
- font-family: monospace, fixed;
- font-size: 13px;
- min-height: 13px;
- line-height: 1.0;
- text-wrap: unrestricted;
- white-space: -moz-pre-wrap; /* Moz */
- white-space: -pre-wrap; /* Opera 4-6 */
- white-space: -o-pre-wrap; /* Opera 7 */
- white-space: pre-wrap; /* CSS3 */
- word-wrap: break-word; /* IE 5.5+ */
- text-indent: -53px;
- padding-left: 53px;
- padding-bottom: 0px;
- margin: 0px;
- -webkit-transition-property: background-color, box-shadow;
- -webkit-transition-duration: 0.5s;
- -moz-transition-property: background-color, box-shadow;
- -moz-transition-duration: 0.5s;
- -ms-transition-property: background-color, box-shadow;
- -ms-transition-duration: 0.5s;
- -o-transition-property: background-color, box-shadow;
- -o-transition-duration: 0.5s;
- transition-property: background-color, box-shadow;
- transition-duration: 0.5s;
-}
-
-div.line.glow {
- background-color: cyan;
- box-shadow: 0 0 10px cyan;
+ font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
+ line-height: 1.4em;
+ white-space: pre-wrap;
}
+.glow {
+ background-color: #2AA198;
+ box-shadow: 0 0 10px #2AA198;
+}
span.lineno {
- padding-right: 4px;
- text-align: right;
- border-right: 2px solid #0F0;
- background-color: #E8E8E8;
- white-space: pre;
+ padding-right: 4px;
+ text-align: right;
+ border-right: 2px solid #546E00;
+ background-color: #E8E8E8;
+ white-space: pre;
}
+
span.lineno a {
- background-color: #D8D8D8;
+ background-color: #D8D8D8;
}
span.lineno a:hover {
- background-color: #C8C8C8;
+ background-color: #C8C8C8;
+}
+
+.tabs, .tabs2, .navpath {
+ padding: 0.25em 0;
+ font-size: small;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 0;
+}
+
+th {
+ text-align: left;
+ font-size: 110%;
+ font-weight: 500;
+}
+
+.mlabel {
+ padding: 0.125em;
+}
+
+#navrow1, #navrow2 {
+ /* Disable menu from Doxygen 1.8.15, it is faked in the template */
+ display: none;
+}
+
+.tablist {
+ margin: 0;
+ padding: 0;
+ display: table;
+}
+
+.tablist li {
+ display: table-cell;
+ line-height: 2em;
+ list-style: none;
+ border-bottom: 0;
+}
+
+.tablist a {
+ display: block;
+ padding: 0 1em 0 0;
+ text-decoration: none;
+ outline: none;
+}
+
+.tabs3 .tablist a {
+ padding: 0 10px;
+}
+
+.tablist li.current a {
+ color: #222;
+}
+
+span.icon {
+ display: none;
}
diff --git a/doc/footer.html b/doc/footer.html
new file mode 100644
index 0000000..0dc6919
--- /dev/null
+++ b/doc/footer.html
@@ -0,0 +1,20 @@
+<!-- HTML footer for doxygen 1.8.15-->
+<!-- start footer part -->
+<!--BEGIN GENERATE_TREEVIEW-->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+ <ul>
+ $navpath
+ <li class="footer">$generatedby
+ <a href="http://www.doxygen.org/index.html">Doxygen $doxygenversion</li>
+ </ul>
+</div>
+<!--END GENERATE_TREEVIEW-->
+<!--BEGIN !GENERATE_TREEVIEW-->
+<div id="footer">
+ <address class="footer">$generatedby
+ <a href="http://www.doxygen.org/">Doxygen</a> $doxygenversion
+ </address>
+</div>
+<!--END !GENERATE_TREEVIEW-->
+</body>
+</html>
diff --git a/doc/header.html b/doc/header.html
index 6ff2e60..2e419e3 100644
--- a/doc/header.html
+++ b/doc/header.html
@@ -1,24 +1,37 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<title>LV2: File List</title>
-<link href="tabs.css" rel="stylesheet" type="text/css"/>
-<link href="doxy-style.css" rel="stylesheet" type="text/css" />
-</head>
-<body>
-<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
-<div id="titlearea">
-<table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">LV2
- &#160;<span id="projectnumber">1.0.13</span>
- </div>
- </td>
- </tr>
- </tbody>
-</table>
-</div>
-<!-- end header part -->
+ <head>
+ <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+ <!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
+ <!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
+ <link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
+ $extrastylesheet
+ </head>
+ <body>
+ <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+
+ <!--BEGIN TITLEAREA-->
+ <div id="titlearea">
+ <div id="header">
+ <div id="titlebox">
+ <!--BEGIN PROJECT_LOGO-->
+ <div id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></div>
+ <!--END PROJECT_LOGO-->
+ <!--BEGIN PROJECT_NAME-->
+ <h1 id="title">$projectname</h1>
+ <!--END PROJECT_NAME-->
+ <!--BEGIN PROJECT_BRIEF-->
+ <div id="shortdesc">$projectbrief</div>
+ <!--END PROJECT_BRIEF-->
+ </div>
+ <div id="metabox">
+ <table id="meta">
+ <!--BEGIN PROJECT_NUMBER-->
+ <tr><th>Version</th><td>$projectnumber</td></tr>
+ <!--END PROJECT_NUMBER-->
+ </table>
+ </div>
+ </div>
+ </div>
+ <!--END TITLEAREA-->
+ <!-- end header part -->
diff --git a/doc/htaccess.in b/doc/htaccess.in
index 7a21951..e1ac1df 100644
--- a/doc/htaccess.in
+++ b/doc/htaccess.in
@@ -13,12 +13,12 @@ RewriteCond %{HTTP_ACCEPT} !application/rdf\+xml.*(text/html|application/xhtml\+
RewriteCond %{HTTP_ACCEPT} text/html [OR]
RewriteCond %{HTTP_ACCEPT} application/xhtml\+xml [OR]
RewriteCond %{HTTP_USER_AGENT} ^Mozilla/.*
-RewriteRule ^$ @NAME@.html [L]
+RewriteRule ^(.*)$ $1.html [L]
# Rewrite rule to serve Turtle content from the vocabulary URI if requested
RewriteCond %{HTTP_ACCEPT} text/turtle [OR]
RewriteCond %{HTTP_ACCEPT} application/x-turtle
-RewriteRule ^$ @NAME@.ttl [L]
+RewriteRule ^(.*)$ $1.ttl [L]
# Serve HTML page by default
-RewriteRule ^$ @NAME@.html [L]
+RewriteRule ^(.*)$ $1.html [L]
diff --git a/doc/index.html.in b/doc/index.html.in
new file mode 100644
index 0000000..875ad39
--- /dev/null
+++ b/doc/index.html.in
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>LV2 Specifications</title>
+ <meta http-equiv="Content-Type"
+ content="application/xhtml+xml;charset=utf-8" />
+ <link rel="stylesheet" type="text/css"
+ href="../aux/style.css" />
+ </head>
+ <body>
+
+ <!-- HEADER -->
+ <div id="topbar">
+ <div id="header">
+ <div id="titlebox">
+ <h1 id="title">LV2 Specifications</h1>
+ </div>
+ <div id="metabox">
+ <table id="meta">
+ <tr><th>Version</th><td>@LV2_VERSION@</td></tr>
+ <tr><th>Date</th><td>@DATE@</td></tr>
+ <tr><th>Discuss</th>
+ <td>
+ <a href="mailto:devel@lists.lv2plug.in">devel@lists.lv2plug.in</a>
+ <a href="http://lists.lv2plug.in/listinfo.cgi/devel-lv2plug.in">(subscribe)</a>
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+ </div>
+
+ <div id="content">
+
+ <!-- INDEX -->
+ <div class="section">
+ <a id="sec-index"></a>
+ <table class="index" summary="An index of LV2 specifications">
+ <thead>
+ <tr>
+ <th>Specification</th>
+ <th>API</th>
+ <th>Description</th>
+ <th>Version</th>
+ <th>Status</th>
+ </tr>
+ </thead>
+ <tbody>
+ @ROWS@
+ </tbody>
+ </table>
+ </div>
+
+ <!-- FOOTER -->
+ <div id="footer">
+ <div>
+ This document is available under the
+ <a about="" rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
+ Creative Commons Attribution-ShareAlike License
+ </a>
+ </div>
+ <div>
+ Valid
+ <a about="" rel="dct:conformsTo" resource="http://www.w3.org/TR/rdfa-syntax"
+ href="http://validator.w3.org/check?uri=referer">
+ XHTML+RDFa
+ </a>
+ and
+ <a about="" rel="dct:conformsTo" resource="http://www.w3.org/TR/CSS2"
+ href="http://jigsaw.w3.org/css-validator/check/referer">
+ CSS
+ </a>
+ generated from the LV2 source distribution.
+ </div>
+ </div>
+
+ </div>
+ </body>
+</html>
diff --git a/doc/layout.xml b/doc/layout.xml
new file mode 100644
index 0000000..1f63a76
--- /dev/null
+++ b/doc/layout.xml
@@ -0,0 +1,226 @@
+<doxygenlayout version="1.0">
+ <!-- Generated by doxygen 1.8.17 -->
+ <!-- Navigation index tabs for HTML output -->
+ <navindex>
+ <tab type="mainpage" visible="yes" title=""/>
+ <tab type="pages" visible="yes" title="" intro=""/>
+ <tab type="modules" visible="yes" title="" intro=""/>
+ <tab type="namespaces" visible="yes" title="">
+ <tab type="namespacelist" visible="yes" title="" intro=""/>
+ <tab type="namespacemembers" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="interfaces" visible="yes" title="">
+ <tab type="interfacelist" visible="yes" title="" intro=""/>
+ <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="interfacehierarchy" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="classes" visible="yes" title="">
+ <tab type="classlist" visible="yes" title="" intro=""/>
+ <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="hierarchy" visible="yes" title="" intro=""/>
+ <tab type="classmembers" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="structs" visible="yes" title="">
+ <tab type="structlist" visible="yes" title="" intro=""/>
+ <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ </tab>
+ <tab type="exceptions" visible="yes" title="">
+ <tab type="exceptionlist" visible="yes" title="" intro=""/>
+ <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="files" visible="yes" title="">
+ <tab type="filelist" visible="yes" title="" intro=""/>
+ <tab type="globals" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="examples" visible="yes" title="" intro=""/>
+ </navindex>
+
+ <!-- Layout definition for a class page -->
+ <class>
+ <briefdescription visible="yes"/>
+ <detaileddescription title=""/>
+ <includes visible="$SHOW_INCLUDE_FILES"/>
+ <inheritancegraph visible="$CLASS_GRAPH"/>
+ <collaborationgraph visible="$COLLABORATION_GRAPH"/>
+ <memberdecl>
+ <nestedclasses visible="yes" title=""/>
+ <publictypes title=""/>
+ <services title=""/>
+ <interfaces title=""/>
+ <publicslots title=""/>
+ <signals title=""/>
+ <publicmethods title=""/>
+ <publicstaticmethods title=""/>
+ <publicattributes title=""/>
+ <publicstaticattributes title=""/>
+ <protectedtypes title=""/>
+ <protectedslots title=""/>
+ <protectedmethods title=""/>
+ <protectedstaticmethods title=""/>
+ <protectedattributes title=""/>
+ <protectedstaticattributes title=""/>
+ <packagetypes title=""/>
+ <packagemethods title=""/>
+ <packagestaticmethods title=""/>
+ <packageattributes title=""/>
+ <packagestaticattributes title=""/>
+ <properties title=""/>
+ <events title=""/>
+ <privatetypes title=""/>
+ <privateslots title=""/>
+ <privatemethods title=""/>
+ <privatestaticmethods title=""/>
+ <privateattributes title=""/>
+ <privatestaticattributes title=""/>
+ <friends title=""/>
+ <related title="" subtitle=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <memberdef>
+ <inlineclasses title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <services title=""/>
+ <interfaces title=""/>
+ <constructors title=""/>
+ <functions title=""/>
+ <related title=""/>
+ <variables title=""/>
+ <properties title=""/>
+ <events title=""/>
+ </memberdef>
+ <allmemberslink visible="yes"/>
+ <usedfiles visible="$SHOW_USED_FILES"/>
+ <authorsection visible="yes"/>
+ </class>
+
+ <!-- Layout definition for a namespace page -->
+ <namespace>
+ <briefdescription visible="yes"/>
+ <detaileddescription title=""/>
+ <memberdecl>
+ <nestednamespaces visible="yes" title=""/>
+ <constantgroups visible="yes" title=""/>
+ <interfaces visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <structs visible="yes" title=""/>
+ <exceptions visible="yes" title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <memberdef>
+ <inlineclasses title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ </memberdef>
+ <authorsection visible="yes"/>
+ </namespace>
+
+ <!-- Layout definition for a file page -->
+ <file>
+ <briefdescription visible="yes"/>
+ <detaileddescription title=""/>
+ <includes visible="$SHOW_INCLUDE_FILES"/>
+ <includegraph visible="$INCLUDE_GRAPH"/>
+ <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
+ <sourcelink visible="yes"/>
+ <memberdecl>
+ <interfaces visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <structs visible="yes" title=""/>
+ <exceptions visible="yes" title=""/>
+ <namespaces visible="yes" title=""/>
+ <constantgroups visible="yes" title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <memberdef>
+ <inlineclasses title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ </memberdef>
+ <authorsection/>
+ </file>
+
+ <!-- Layout definition for a group page -->
+ <group>
+ <briefdescription visible="yes"/>
+ <detaileddescription title=""/>
+ <groupgraph visible="$GROUP_GRAPHS"/>
+ <memberdecl>
+ <nestedgroups visible="yes" title=""/>
+ <dirs visible="yes" title=""/>
+ <files visible="yes" title=""/>
+ <namespaces visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <enumvalues title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <signals title=""/>
+ <publicslots title=""/>
+ <protectedslots title=""/>
+ <privateslots title=""/>
+ <events title=""/>
+ <properties title=""/>
+ <friends title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <memberdef>
+ <pagedocs/>
+ <inlineclasses title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <enumvalues title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <signals title=""/>
+ <publicslots title=""/>
+ <protectedslots title=""/>
+ <privateslots title=""/>
+ <events title=""/>
+ <properties title=""/>
+ <friends title=""/>
+ </memberdef>
+ <authorsection visible="yes"/>
+ </group>
+
+ <!-- Layout definition for a directory page -->
+ <directory>
+ <briefdescription visible="yes"/>
+ <detaileddescription title=""/>
+ <directorygraph visible="yes"/>
+ <memberdecl>
+ <dirs visible="yes"/>
+ <files visible="yes"/>
+ </memberdecl>
+ </directory>
+</doxygenlayout>
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
deleted file mode 100644
index 920ef1d..0000000
--- a/doc/mainpage.dox
+++ /dev/null
@@ -1,21 +0,0 @@
-/** @mainpage
- *
- * This is the documentation for the LV2 specification and its
- * official extensions.
- *
- * An LV2 extension generally has two parts: the specification in
- * <a href="http://www.w3.org/TeamSubmission/turtle/">Turtle</a>
- * (e.g. ext.lv2/ext.ttl), and an accompanying
- * <a href="http://en.wikipedia.org/wiki/C99">C</a> header (e.g. ext.lv2/ext.h).
- * The header documentation is generated with <a href="http://doxygen.org">
- * Doxygen</a> and hyperlinked (in both directions) with the specification
- * documentation generated from Turtle with
- * <a href="http://drobilla.net/software/lv2specgen">lv2specgen</a>.
- *
- * \li <a href="../../ns/index.html">LV2 Specifications</a>
- * \li <a href="annotated.html">Data Structures</a>
- * \li <a href="files.html">Headers</a>
- */
-
-#define NOTHING_HERE
-
diff --git a/doc/mainpage.md b/doc/mainpage.md
new file mode 100644
index 0000000..561bc93
--- /dev/null
+++ b/doc/mainpage.md
@@ -0,0 +1,3 @@
+This is the API documentation for LV2.
+
+For an index and higher level documentation, see the corresponding [specification documentation](../../ns/index.html).
diff --git a/doc/pygments.css b/doc/pygments.css
new file mode 100644
index 0000000..4fb3387
--- /dev/null
+++ b/doc/pygments.css
@@ -0,0 +1,61 @@
+.c { color: #6C71C4; font-style: italic } /* Comment */
+.err { border: 1px solid #DC322F } /* Error */
+.k { color: #888888 } /* Keyword */
+.o { color: #839496 } /* Operator */
+.cm { color: #6C71C4; font-style: italic } /* Comment.Multiline */
+.cp { color: #D33682 } /* Comment.Preproc */
+.c1 { color: #6C71C4; font-style: italic } /* Comment.Single */
+.cs { color: #6C71C4; font-style: italic } /* Comment.Special */
+.gd { color: #A00000 } /* Generic.Deleted */
+.ge { font-style: italic } /* Generic.Emph */
+.gr { color: #DC322F } /* Generic.Error */
+.gh { color: #6C71C4; font-weight: bold } /* Generic.Heading */
+.gi { color: #859900 } /* Generic.Inserted */
+.go { color: #808080 } /* Generic.Output */
+.gp { color: #268BD2; font-weight: bold } /* Generic.Prompt */
+.gs { font-weight: bold } /* Generic.Strong */
+.gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.gt { color: #0040D0 } /* Generic.Traceback */
+.kc { color: #586E75; font-weight: bold } /* Keyword.Constant */
+.kd { color: #586E75; font-weight: bold } /* Keyword.Declaration */
+.kn { color: #586E75; font-weight: bold } /* Keyword.Namespace */
+.kp { color: #586E75 } /* Keyword.Pseudo */
+.kr { color: #586E75; font-weight: bold } /* Keyword.Reserved */
+.kt { color: #546E00 } /* Keyword.Type */
+.m { color: #666666 } /* Literal.Number */
+.s { color: #CB4B16 } /* Literal.String */
+.na { color: #7D9029 } /* Name.Attribute */
+.nb { color: #008000 } /* Name.Builtin */
+.nc { color: #000000; } /* Name.Class */
+.no { color: #880000 } /* Name.Constant */
+.nd { color: #AA22FF } /* Name.Decorator */
+.ni { color: #999999; font-weight: bold } /* Name.Entity */
+.ne { color: #D2413A; font-weight: bold } /* Name.Exception */
+.nf { color: #000000; } /* Name.Function */
+.nl { color: #A0A000 } /* Name.Label */
+.nn { color: #555555 } /* Name.Namespace */
+.nt { color: #223322; } /* Name.Tag */
+.nv { color: #222222 } /* Name.Variable */
+.ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+.w { color: #bbbbbb } /* Text.Whitespace */
+.mf { color: #000000 } /* Literal.Number.Float */
+.mh { color: #000000 } /* Literal.Number.Hex */
+.mi { color: #000000 } /* Literal.Number.Integer */
+.mo { color: #000000 } /* Literal.Number.Oct */
+.sb { color: #CB4B16 } /* Literal.String.Backtick */
+.sc { color: #CB4B16 } /* Literal.String.Char */
+.sd { color: #CB4B16; font-style: italic } /* Literal.String.Doc */
+.s2 { color: #CB4B16 } /* Literal.String.Double */
+.se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
+.sh { color: #CB4B16 } /* Literal.String.Heredoc */
+.si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
+.sx { color: #008000 } /* Literal.String.Other */
+.sr { color: #BB6688 } /* Literal.String.Regex */
+.s1 { color: #CB4B16 } /* Literal.String.Single */
+.ss { color: #00629D } /* Literal.String.Symbol */
+.bp { color: #008000 } /* Name.Builtin.Pseudo */
+.vc { color: #00629D } /* Name.Variable.Class */
+.vg { color: #00629D } /* Name.Variable.Global */
+.vi { color: #00629D } /* Name.Variable.Instance */
+.il { color: #666666 } /* Literal.Number.Integer.Long */
+.p { color: #888888 } /* Punctuation */
diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in
index 718a74c..622fa54 100644
--- a/doc/reference.doxygen.in
+++ b/doc/reference.doxygen.in
@@ -1,348 +1,437 @@
-# Doxyfile 1.8.1.1
+# Doxyfile 1.8.15
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
-# All text after a hash (#) is considered a comment and will be ignored.
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single hash (#) is considered a comment and will be ignored.
# The format is:
-# TAG = value [value, ...]
-# For lists items can also be appended using:
-# TAG += value [value, ...]
-# Values that contain spaces should be placed between quotes (" ").
+# TAG = value [value, ...]
+# For lists, items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (\" \").
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
-# This tag specifies the encoding used for all characters in the config file
-# that follow. The default is UTF-8 which is also the encoding used for all
+# This tag specifies the encoding used for all characters in the configuration
+# file that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
-# http://www.gnu.org/software/libiconv for the list of possible encodings.
+# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
+# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8
-# The PROJECT_NAME tag is a single word (or sequence of words) that should
-# identify the project. Note that if you do not use Doxywizard you need
-# to put quotes around the project name if it contains spaces.
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
PROJECT_NAME = LV2
-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
-# This could be handy for archiving the generated documentation or
-# if some version control system is used.
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
+# could be handy for archiving the generated documentation or if some version
+# control system is used.
PROJECT_NUMBER = @LV2_VERSION@
# Using the PROJECT_BRIEF tag one can provide an optional one line description
-# for a project that appears at the top of each page and should give viewer
-# a quick idea about the purpose of the project. Keep the description short.
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
-PROJECT_BRIEF =
+PROJECT_BRIEF = "An open and extensible audio plugin standard"
-# With the PROJECT_LOGO tag one can specify an logo or icon that is
-# included in the documentation. The maximum height of the logo should not
-# exceed 55 pixels and the maximum width should not exceed 200 pixels.
-# Doxygen will copy the logo to the output directory.
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# the logo to the output directory.
PROJECT_LOGO =
-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
-# base path where the generated documentation will be put.
-# If a relative path is entered, it will be relative to the location
-# where doxygen was started. If left blank the current directory will be used.
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
-OUTPUT_DIRECTORY = @LV2_DOC_DIR@
+OUTPUT_DIRECTORY = .
-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
-# 4096 sub-directories (in 2 levels) under the output directory of each output
-# format and will distribute the generated files over these directories.
-# Enabling this option can be useful when feeding doxygen a huge amount of
-# source files, where putting all generated files in the same directory would
-# otherwise cause performance problems for the file system.
+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system.
+# The default value is: NO.
CREATE_SUBDIRS = NO
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES = NO
+
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
-# The default language is English, other supported languages are:
-# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
-# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
-# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
-# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
-# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
-# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
OUTPUT_LANGUAGE = English
-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
-# include brief member descriptions after the members that are listed in
-# the file and class documentation (similar to JavaDoc).
-# Set to NO to disable this.
+# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all generated output in the proper direction.
+# Possible values are: None, LTR, RTL and Context.
+# The default value is: None.
+
+OUTPUT_TEXT_DIRECTION = None
+
+# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
+# descriptions after the members that are listed in the file and class
+# documentation (similar to Javadoc). Set to NO to disable this.
+# The default value is: YES.
-BRIEF_MEMBER_DESC = YES
+BRIEF_MEMBER_DESC = NO
-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
-# the brief description of a member or function before the detailed description.
-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
+# description of a member or function before the detailed description
+#
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
+# The default value is: YES.
REPEAT_BRIEF = YES
-# This tag implements a quasi-intelligent brief description abbreviator
-# that is used to form the text in various listings. Each string
-# in this list, if found as the leading text of the brief description, will be
-# stripped from the text and the result after processing the whole list, is
-# used as the annotated text. Otherwise, the brief description is used as-is.
-# If left blank, the following values are used ("$name" is automatically
-# replaced with the name of the entity): "The $name class" "The $name widget"
-# "The $name file" "is" "provides" "specifies" "contains"
-# "represents" "a" "an" "the"
+# This tag implements a quasi-intelligent brief description abbreviator that is
+# used to form the text in various listings. Each string in this list, if found
+# as the leading text of the brief description, will be stripped from the text
+# and the result, after processing the whole list, is used as the annotated
+# text. Otherwise, the brief description is used as-is. If left blank, the
+# following values are used ($name is automatically replaced with the name of
+# the entity):The $name class, The $name widget, The $name file, is, provides,
+# specifies, contains, represents, a, an and the.
ABBREVIATE_BRIEF =
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
-# Doxygen will generate a detailed section even if there is only a brief
+# doxygen will generate a detailed section even if there is only a brief
# description.
+# The default value is: NO.
-ALWAYS_DETAILED_SEC = NO
+ALWAYS_DETAILED_SEC = YES
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
+# The default value is: NO.
INLINE_INHERITED_MEMB = NO
-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
-# path before files name in the file list and in the header files. If set
-# to NO the shortest path that makes the file name unique will be used.
+# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
+# before files name in the file list and in the header files. If set to NO the
+# shortest path that makes the file name unique will be used
+# The default value is: YES.
FULL_PATH_NAMES = YES
-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
-# can be used to strip a user-defined part of the path. Stripping is
-# only done if one of the specified strings matches the left-hand part of
-# the path. The tag can be used to show relative paths in the file list.
-# If left blank the directory from which doxygen is run is used as the
-# path to strip.
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
+# Stripping is only done if one of the specified strings matches the left-hand
+# part of the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the path to
+# strip.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH =
-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
-# the path mentioned in the documentation of a class, which tells
-# the reader which header file to include in order to use a class.
-# If left blank only the name of the header file containing the class
-# definition is used. Otherwise one should specify the include paths that
-# are normally passed to the compiler using the -I flag.
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
+# path mentioned in the documentation of a class, which tells the reader which
+# header file to include in order to use a class. If left blank only the name of
+# the header file containing the class definition is used. Otherwise one should
+# specify the list of include paths that are normally passed to the compiler
+# using the -I flag.
STRIP_FROM_INC_PATH =
-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
-# (but less readable) file names. This can be useful if your file system
-# doesn't support long names like on DOS, Mac, or CD-ROM.
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
+# less readable) file names. This can be useful is your file systems doesn't
+# support long names like on DOS, Mac, or CD-ROM.
+# The default value is: NO.
SHORT_NAMES = NO
-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
-# will interpret the first line (until the first dot) of a JavaDoc-style
-# comment as the brief description. If set to NO, the JavaDoc
-# comments will behave just like regular Qt-style comments
-# (thus requiring an explicit @brief command for a brief description.)
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
+# first line (until the first dot) of a Javadoc-style comment as the brief
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
JAVADOC_AUTOBRIEF = YES
-# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
-# interpret the first line (until the first dot) of a Qt-style
-# comment as the brief description. If set to NO, the comments
-# will behave just like regular Qt-style comments (thus requiring
-# an explicit \brief command for a brief description.)
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
QT_AUTOBRIEF = NO
-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
-# treat a multi-line C++ special comment block (i.e. a block of //! or ///
-# comments) as a brief description. This used to be the default behaviour.
-# The new default is to treat a multi-line C++ comment block as a detailed
-# description. Set this tag to YES if you prefer the old behaviour instead.
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
+# a brief description. This used to be the default behavior. The new default is
+# to treat a multi-line C++ comment block as a detailed description. Set this
+# tag to YES if you prefer the old behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
MULTILINE_CPP_IS_BRIEF = NO
-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
-# member inherits the documentation from any documented member that it
-# re-implements.
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
INHERIT_DOCS = YES
-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
-# a new page for each member. If set to NO, the documentation of a member will
-# be part of the file/class/namespace that contains it.
+# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
+# page for each member. If set to NO, the documentation of a member will be part
+# of the file/class/namespace that contains it.
+# The default value is: NO.
SEPARATE_MEMBER_PAGES = NO
-# The TAB_SIZE tag can be used to set the number of spaces in a tab.
-# Doxygen uses this value to replace tabs by spaces in code fragments.
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
+# uses this value to replace tabs by spaces in code fragments.
+# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 4
-# This tag can be used to specify a number of aliases that acts
-# as commands in the documentation. An alias has the form "name=value".
-# For example adding "sideeffect=\par Side Effects:\n" will allow you to
-# put the command \sideeffect (or @sideeffect) in the documentation, which
-# will result in a user-defined paragraph with heading "Side Effects:".
-# You can put \n's in the value part of an alias to insert newlines.
+# This tag can be used to specify a number of aliases that act as commands in
+# the documentation. An alias has the form:
+# name=value
+# For example adding
+# "sideeffect=@par Side Effects:\n"
+# will allow you to put the command \sideeffect (or @sideeffect) in the
+# documentation, which will result in a user-defined paragraph with heading
+# "Side Effects:". You can put \n's in the value part of an alias to insert
+# newlines (in the resulting output). You can put ^^ in the value part of an
+# alias to insert a newline as if a physical newline was in the original file.
+# When you need a literal { or } or , in the value part of an alias you have to
+# escape them by means of a backslash (\), this can lead to conflicts with the
+# commands \{ and \} for these it is advised to use the version @{ and @} or use
+# a double escape (\\{ and \\})
ALIASES =
# This tag can be used to specify a number of word-keyword mappings (TCL only).
-# A mapping has the form "name=value". For example adding
-# "class=itcl::class" will allow you to use the command class in the
-# itcl::class meaning.
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
TCL_SUBST =
-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
-# sources only. Doxygen will then generate output that is more tailored for C.
-# For instance, some of the names that are used will be different. The list
-# of all members will be omitted, etc.
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = YES
-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
-# sources only. Doxygen will then generate output that is more tailored for
-# Java. For instance, namespaces will be presented as packages, qualified
-# scopes will look different, etc.
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
-# sources only. Doxygen will then generate output that is more tailored for
-# Fortran.
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
-# sources. Doxygen will then generate output that is tailored for
-# VHDL.
+# sources. Doxygen will then generate output that is tailored for VHDL.
+# The default value is: NO.
OPTIMIZE_OUTPUT_VHDL = NO
+# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
+# sources only. Doxygen will then generate output that is more tailored for that
+# language. For instance, namespaces will be presented as modules, types will be
+# separated into more groups, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_SLICE = NO
+
# Doxygen selects the parser to use depending on the extension of the files it
-# parses. With this tag you can assign which parser to use for a given extension.
-# Doxygen has a built-in mapping, but you can override or extend it using this
-# tag. The format is ext=language, where ext is a file extension, and language
-# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
-# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
-# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
-# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
-# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension, and
+# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
+# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
+# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
+# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
+# tries to guess whether the code is fixed or free formatted code, this is the
+# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
+# .inc files as Fortran files (default is PHP), and .f files as C (default is
+# Fortran), use: inc=Fortran f=C.
+#
+# Note: For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen.
EXTENSION_MAPPING =
-# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
-# comments according to the Markdown format, which allows for more readable
-# documentation. See http://daringfireball.net/projects/markdown/ for details.
-# The output of markdown processing is further processed by doxygen, so you
-# can mix doxygen, HTML, and XML commands with Markdown formatting.
-# Disable only in case of backward compatibilities issues.
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See https://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
MARKDOWN_SUPPORT = YES
+# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
+# to that level are automatically included in the table of contents, even if
+# they do not have an id attribute.
+# Note: This feature currently applies only to Markdown headings.
+# Minimum value: 0, maximum value: 99, default value: 0.
+# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
+
+TOC_INCLUDE_HEADINGS = 0
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT = YES
+
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
-# to include (a tag file for) the STL sources as input, then you should
-# set this tag to YES in order to let doxygen match functions declarations and
-# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
-# func(std::string) {}). This also makes the inheritance and collaboration
+# to include (a tag file for) the STL sources as input, then you should set this
+# tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string);
+# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
+# The default value is: NO.
CPP_CLI_SUPPORT = NO
-# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
-# Doxygen will parse them like normal C++ but will assume all classes use public
-# instead of private inheritance when no explicit protection keyword is present.
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
+# will parse them like normal C++ but will assume all classes use public instead
+# of private inheritance when no explicit protection keyword is present.
+# The default value is: NO.
SIP_SUPPORT = NO
-# For Microsoft's IDL there are propget and propput attributes to indicate getter
-# and setter methods for a property. Setting this option to YES (the default)
-# will make doxygen replace the get and set methods by a property in the
-# documentation. This will only work if the methods are indeed getting or
-# setting a simple type. If this is not the case, or you want to show the
-# methods anyway, you should set this option to NO.
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES will make
+# doxygen to replace the get and set methods by a property in the documentation.
+# This will only work if the methods are indeed getting or setting a simple
+# type. If this is not the case, or you want to show the methods anyway, you
+# should set this option to NO.
+# The default value is: YES.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
-# tag is set to YES, then doxygen will reuse the documentation of the first
+# tag is set to YES then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
+# The default value is: NO.
DISTRIBUTE_GROUP_DOC = NO
-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
-# the same type (for instance a group of public functions) to be put as a
-# subgroup of that type (e.g. under the Public Functions section). Set it to
-# NO to prevent subgrouping. Alternatively, this can be done per class using
-# the \nosubgrouping command.
+# If one adds a struct or class to a group and this option is enabled, then also
+# any nested class or struct is added to the same group. By default this option
+# is disabled and one has to add nested compounds explicitly via \ingroup.
+# The default value is: NO.
+
+GROUP_NESTED_COMPOUNDS = NO
+
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
+# (for instance a group of public functions) to be put as a subgroup of that
+# type (e.g. under the Public Functions section). Set it to NO to prevent
+# subgrouping. Alternatively, this can be done per class using the
+# \nosubgrouping command.
+# The default value is: YES.
SUBGROUPING = YES
-# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
-# unions are shown inside the group in which they are included (e.g. using
-# @ingroup) instead of on a separate page (for HTML and Man pages) or
-# section (for LaTeX and RTF).
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
-INLINE_GROUPED_CLASSES = NO
+INLINE_GROUPED_CLASSES = YES
-# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
-# unions with only public data fields will be shown inline in the documentation
-# of the scope in which they are defined (i.e. file, namespace, or group
-# documentation), provided this scope is documented. If set to NO (the default),
-# structs, classes, and unions are shown on a separate page (for HTML and Man
-# pages) or section (for LaTeX and RTF).
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
-INLINE_SIMPLE_STRUCTS = NO
+INLINE_SIMPLE_STRUCTS = YES
-# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
-# is documented as struct, union, or enum with the name of the typedef. So
+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
+# enum is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
-# namespace, or class. And the struct will be named TypeS. This can typically
-# be useful for C code in case the coding convention dictates that all compound
+# namespace, or class. And the struct will be named TypeS. This can typically be
+# useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
TYPEDEF_HIDES_STRUCT = YES
-# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
-# determine which symbols to keep in memory and which to flush to disk.
-# When the cache is full, less often used symbols will be written to disk.
-# For small to medium size projects (<1000 input files) the default value is
-# probably good enough. For larger projects a too small cache size can cause
-# doxygen to be busy swapping symbols to and from disk most of the time
-# causing a significant performance penalty.
-# If the system has enough physical memory increasing the cache will improve the
-# performance by keeping more symbols in memory. Note that the value works on
-# a logarithmic scale so increasing the size by one will roughly double the
-# memory usage. The cache size is given by this formula:
-# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
-# corresponding to a cache size of 2^16 = 65536 symbols.
-
-SYMBOL_CACHE_SIZE = 0
-
-# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
-# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
-# their name and scope. Since this can be an expensive process and often the
-# same symbol appear multiple times in the code, doxygen keeps a cache of
-# pre-resolved symbols. If the cache is too small doxygen will become slower.
-# If the cache is too large, memory is wasted. The cache size is given by this
-# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
-# corresponding to a cache size of 2^16 = 65536 symbols.
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_CACHE_SIZE = 0
@@ -350,363 +439,435 @@ LOOKUP_CACHE_SIZE = 0
# Build related configuration options
#---------------------------------------------------------------------------
-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
-# documentation are documented, even if no documentation was available.
-# Private class members and static file members will be hidden unless
-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
+# documentation are documented, even if no documentation was available. Private
+# class members and static file members will be hidden unless the
+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
-EXTRACT_ALL = YES
+EXTRACT_ALL = NO
-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
-# will be included in the documentation.
+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
EXTRACT_PRIVATE = YES
-# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
EXTRACT_PACKAGE = NO
-# If the EXTRACT_STATIC tag is set to YES all static members of a file
-# will be included in the documentation.
+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
EXTRACT_STATIC = YES
-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
-# defined locally in source files will be included in the documentation.
-# If set to NO only classes defined in header files are included.
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO,
+# only classes defined in header files are included. Does not have any effect
+# for Java sources.
+# The default value is: YES.
EXTRACT_LOCAL_CLASSES = YES
-# This flag is only useful for Objective-C code. When set to YES local
-# methods, which are defined in the implementation section but not in
-# the interface are included in the documentation.
-# If set to NO (the default) only methods in the interface are included.
+# This flag is only useful for Objective-C code. If set to YES, local methods,
+# which are defined in the implementation section but not in the interface are
+# included in the documentation. If set to NO, only methods in the interface are
+# included.
+# The default value is: NO.
EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
-# 'anonymous_namespace{file}', where file will be replaced with the base
-# name of the file that contains the anonymous namespace. By default
-# anonymous namespaces are hidden.
+# 'anonymous_namespace{file}', where file will be replaced with the base name of
+# the file that contains the anonymous namespace. By default anonymous namespace
+# are hidden.
+# The default value is: NO.
EXTRACT_ANON_NSPACES = NO
-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
-# undocumented members of documented classes, files or namespaces.
-# If set to NO (the default) these members will be included in the
-# various overviews, but no documentation section is generated.
-# This option has no effect if EXTRACT_ALL is enabled.
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO these
+# members will be included in the various overviews, but no documentation
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
HIDE_UNDOC_MEMBERS = NO
-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
-# undocumented classes that are normally visible in the class hierarchy.
-# If set to NO (the default) these classes will be included in the various
-# overviews. This option has no effect if EXTRACT_ALL is enabled.
+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy. If set
+# to NO, these classes will be included in the various overviews. This option
+# has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
HIDE_UNDOC_CLASSES = NO
-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
-# friend (class|struct|union) declarations.
-# If set to NO (the default) these declarations will be included in the
-# documentation.
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# (class|struct|union) declarations. If set to NO, these declarations will be
+# included in the documentation.
+# The default value is: NO.
HIDE_FRIEND_COMPOUNDS = NO
-# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
-# documentation blocks found inside the body of a function.
-# If set to NO (the default) these blocks will be appended to the
-# function's detailed documentation block.
+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
+# documentation blocks found inside the body of a function. If set to NO, these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
HIDE_IN_BODY_DOCS = NO
-# The INTERNAL_DOCS tag determines if documentation
-# that is typed after a \internal command is included. If the tag is set
-# to NO (the default) then the documentation will be excluded.
-# Set it to YES to include the internal documentation.
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
INTERNAL_DOCS = NO
-# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
-# file names in lower-case letters. If set to YES upper-case letters are also
+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
+# names in lower-case letters. If set to YES, upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
+# The default value is: system dependent.
CASE_SENSE_NAMES = YES
-# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
-# will show members with their full class and namespace scopes in the
-# documentation. If set to YES the scope will be hidden.
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES, the
+# scope will be hidden.
+# The default value is: NO.
HIDE_SCOPE_NAMES = NO
-# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
-# will put a list of the files that are included by a file in the documentation
-# of that file.
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
+# append additional text to a page's title, such as Class Reference. If set to
+# YES the compound reference will be hidden.
+# The default value is: NO.
+
+HIDE_COMPOUND_REFERENCE= NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
SHOW_INCLUDE_FILES = NO
-# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
-# will list include files with double quotes in the documentation
-# rather than with sharp brackets.
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
FORCE_LOCAL_INCLUDES = NO
-# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
-# is inserted in the documentation for inline members.
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
INLINE_INFO = YES
-# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
-# will sort the (detailed) documentation of file and class members
-# alphabetically by member name. If set to NO the members will appear in
-# declaration order.
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
+# (detailed) documentation of file and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order.
+# The default value is: YES.
SORT_MEMBER_DOCS = NO
-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
-# brief documentation of file, namespace and class members alphabetically
-# by member name. If set to NO (the default) the members will appear in
-# declaration order.
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: NO.
SORT_BRIEF_DOCS = NO
-# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
-# will sort the (brief and detailed) documentation of class members so that
-# constructors and destructors are listed first. If set to NO (the default)
-# the constructors will appear in the respective orders defined by
-# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
-# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
-# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
+# (brief and detailed) documentation of class members so that constructors and
+# destructors are listed first. If set to NO the constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: NO.
SORT_MEMBERS_CTORS_1ST = NO
-# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
-# hierarchy of group names into alphabetical order. If set to NO (the default)
-# the group names will appear in their defined order.
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
+# of group names into alphabetical order. If set to NO the group names will
+# appear in their defined order.
+# The default value is: NO.
SORT_GROUP_NAMES = NO
-# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
-# sorted by fully-qualified names, including namespaces. If set to
-# NO (the default), the class list will be sorted only by class name,
-# not including the namespace part.
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
+# fully-qualified names, including namespaces. If set to NO, the class list will
+# be sorted only by class name, not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
-# Note: This option applies only to the class list, not to the
-# alphabetical list.
+# Note: This option applies only to the class list, not to the alphabetical
+# list.
+# The default value is: NO.
SORT_BY_SCOPE_NAME = YES
-# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
-# do proper type resolution of all parameters of a function it will reject a
-# match between the prototype and the implementation of a member function even
-# if there is only one candidate or it is obvious which candidate to choose
-# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
-# will still accept a match between prototype and implementation in such cases.
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
STRICT_PROTO_MATCHING = NO
-# The GENERATE_TODOLIST tag can be used to enable (YES) or
-# disable (NO) the todo list. This list is created by putting \todo
-# commands in the documentation.
+# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
+# list. This list is created by putting \todo commands in the documentation.
+# The default value is: YES.
GENERATE_TODOLIST = YES
-# The GENERATE_TESTLIST tag can be used to enable (YES) or
-# disable (NO) the test list. This list is created by putting \test
-# commands in the documentation.
+# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
+# list. This list is created by putting \test commands in the documentation.
+# The default value is: YES.
GENERATE_TESTLIST = YES
-# The GENERATE_BUGLIST tag can be used to enable (YES) or
-# disable (NO) the bug list. This list is created by putting \bug
-# commands in the documentation.
+# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
+# list. This list is created by putting \bug commands in the documentation.
+# The default value is: YES.
GENERATE_BUGLIST = YES
-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
-# disable (NO) the deprecated list. This list is created by putting
-# \deprecated commands in the documentation.
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
+# the deprecated list. This list is created by putting \deprecated commands in
+# the documentation.
+# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES
-# The ENABLED_SECTIONS tag can be used to enable conditional
-# documentation sections, marked by \if sectionname ... \endif.
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \endcond blocks.
ENABLED_SECTIONS =
-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
-# the initial value of a variable or macro consists of for it to appear in
-# the documentation. If the initializer consists of more lines than specified
-# here it will be hidden. Use a value of 0 to hide initializers completely.
-# The appearance of the initializer of individual variables and macros in the
-# documentation can be controlled using \showinitializer or \hideinitializer
-# command in the documentation regardless of this setting.
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have for it to appear in the
+# documentation. If the initializer consists of more lines than specified here
+# it will be hidden. Use a value of 0 to hide initializers completely. The
+# appearance of the value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
MAX_INITIALIZER_LINES = 30
-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
-# at the bottom of the documentation of classes and structs. If set to YES the
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
+# the bottom of the documentation of classes and structs. If set to YES, the
# list will mention the files that were used to generate the documentation.
+# The default value is: YES.
SHOW_USED_FILES = YES
-# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
-# This will remove the Files entry from the Quick Index and from the
-# Folder Tree View (if specified). The default is YES.
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
+# will remove the Files entry from the Quick Index and from the Folder Tree View
+# (if specified).
+# The default value is: YES.
SHOW_FILES = YES
-# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
-# Namespaces page.
-# This will remove the Namespaces entry from the Quick Index
-# and from the Folder Tree View (if specified). The default is YES.
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
+# page. This will remove the Namespaces entry from the Quick Index and from the
+# Folder Tree View (if specified).
+# The default value is: YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
-# popen()) the command <command> <input-file>, where <command> is the value of
-# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
-# provided by doxygen. Whatever the program writes to standard output
-# is used as the file version. See the manual for examples.
+# popen()) the command command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file
-# that represents doxygen's defaults, run doxygen with the -l option.
-# You can optionally specify a file name after the option, if omitted
-# DoxygenLayout.xml will be used as the name of the layout file.
+# that represents doxygen's defaults, run doxygen with the -l option. You can
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
+# will be used as the name of the layout file.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
-LAYOUT_FILE =
+LAYOUT_FILE = @LV2_SRCDIR@/doc/layout.xml
-# The CITE_BIB_FILES tag can be used to specify one or more bib files
-# containing the references data. This must be a list of .bib files. The
-# .bib extension is automatically appended if omitted. Using this command
-# requires the bibtex tool to be installed. See also
-# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
-# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
-# feature you need bibtex and perl available in the search path.
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. See also \cite for info how to create references.
CITE_BIB_FILES =
#---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
+# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
-# The QUIET tag can be used to turn on/off the messages that are generated
-# by doxygen. Possible values are YES and NO. If left blank NO is used.
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
QUIET = YES
# The WARNINGS tag can be used to turn on/off the warning messages that are
-# generated by doxygen. Possible values are YES and NO. If left blank
-# NO is used.
+# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
WARNINGS = YES
-# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
-# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
-# automatically be disabled.
+# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: YES.
-WARN_IF_UNDOCUMENTED = NO
+WARN_IF_UNDOCUMENTED = YES
-# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
-# potential errors in the documentation, such as not documenting some
-# parameters in a documented function, or documenting parameters that
-# don't exist or using markup commands wrongly.
+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some parameters
+# in a documented function, or documenting parameters that don't exist or using
+# markup commands wrongly.
+# The default value is: YES.
WARN_IF_DOC_ERROR = YES
-# The WARN_NO_PARAMDOC option can be enabled to get warnings for
-# functions that are documented, but have no documentation for their parameters
-# or return value. If set to NO (the default) doxygen will only warn about
-# wrong or incomplete parameter documentation, but not about the absence of
-# documentation.
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO, doxygen will only warn about wrong or incomplete
+# parameter documentation, but not about the absence of documentation. If
+# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
+# The default value is: NO.
WARN_NO_PARAMDOC = NO
-# The WARN_FORMAT tag determines the format of the warning messages that
-# doxygen can produce. The string should contain the $file, $line, and $text
-# tags, which will be replaced by the file and line number from which the
-# warning originated and the warning text. Optionally the format may contain
-# $version, which will be replaced by the version of the file (if it could
-# be obtained via FILE_VERSION_FILTER)
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered.
+# The default value is: NO.
+
+WARN_AS_ERROR = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
+# can produce. The string should contain the $file, $line, and $text tags, which
+# will be replaced by the file and line number from which the warning originated
+# and the warning text. Optionally the format may contain $version, which will
+# be replaced by the version of the file (if it could be obtained via
+# FILE_VERSION_FILTER)
+# The default value is: $file:$line: $text.
WARN_FORMAT = "$file:$line: $text"
-# The WARN_LOGFILE tag can be used to specify a file to which warning
-# and error messages should be written. If left blank the output is written
-# to stderr.
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr).
WARN_LOGFILE =
#---------------------------------------------------------------------------
-# configuration options related to the input files
+# Configuration options related to the input files
#---------------------------------------------------------------------------
-# The INPUT tag can be used to specify the files and/or directories that contain
-# documented source files. You may enter file names like "myfile.cpp" or
-# directories like "/usr/src/myproject". Separate the files or directories
-# with spaces.
-
-INPUT = @LV2_SRCDIR@/doc/mainpage.dox \
- lv2/lv2plug.in/ns/ext/atom/atom.h \
- lv2/lv2plug.in/ns/ext/atom/forge.h \
- lv2/lv2plug.in/ns/ext/atom/util.h \
- lv2/lv2plug.in/ns/ext/buf-size/buf-size.h \
- lv2/lv2plug.in/ns/ext/data-access/data-access.h \
- lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h \
- lv2/lv2plug.in/ns/ext/event/event-helpers.h \
- lv2/lv2plug.in/ns/ext/event/event.h \
- lv2/lv2plug.in/ns/ext/instance-access/instance-access.h \
- lv2/lv2plug.in/ns/ext/log/log.h \
- lv2/lv2plug.in/ns/ext/midi/midi.h \
- lv2/lv2plug.in/ns/ext/morph/morph.h \
- lv2/lv2plug.in/ns/ext/options/options.h \
- lv2/lv2plug.in/ns/ext/patch/patch.h \
- lv2/lv2plug.in/ns/ext/port-groups/port-groups.h \
- lv2/lv2plug.in/ns/ext/resize-port/resize-port.h \
- lv2/lv2plug.in/ns/ext/state/state.h \
- lv2/lv2plug.in/ns/ext/time/time.h \
- lv2/lv2plug.in/ns/ext/uri-map/uri-map.h \
- lv2/lv2plug.in/ns/ext/urid/urid.h \
- lv2/lv2plug.in/ns/ext/worker/worker.h \
- lv2/lv2plug.in/ns/extensions/ui/ui.h \
- lv2/lv2plug.in/ns/lv2core/lv2.h
+# The INPUT tag is used to specify the files and/or directories that contain
+# documented source files. You may enter file names like myfile.cpp or
+# directories like /usr/src/myproject. Separate the files or directories with
+# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
+# Note: If this tag is empty the current directory is searched.
+
+INPUT = @LV2_SRCDIR@/doc/mainpage.md \
+ @LV2_SRCDIR@/lv2/atom/atom.h \
+ @LV2_SRCDIR@/lv2/atom/forge.h \
+ @LV2_SRCDIR@/lv2/atom/util.h \
+ @LV2_SRCDIR@/lv2/buf-size/buf-size.h \
+ @LV2_SRCDIR@/lv2/core/lv2.h \
+ @LV2_SRCDIR@/lv2/data-access/data-access.h \
+ @LV2_SRCDIR@/lv2/dynmanifest/dynmanifest.h \
+ @LV2_SRCDIR@/lv2/event/event-helpers.h \
+ @LV2_SRCDIR@/lv2/event/event.h \
+ @LV2_SRCDIR@/lv2/instance-access/instance-access.h \
+ @LV2_SRCDIR@/lv2/log/log.h \
+ @LV2_SRCDIR@/lv2/log/logger.h \
+ @LV2_SRCDIR@/lv2/midi/midi.h \
+ @LV2_SRCDIR@/lv2/morph/morph.h \
+ @LV2_SRCDIR@/lv2/options/options.h \
+ @LV2_SRCDIR@/lv2/parameters/parameters.h \
+ @LV2_SRCDIR@/lv2/patch/patch.h \
+ @LV2_SRCDIR@/lv2/port-groups/port-groups.h \
+ @LV2_SRCDIR@/lv2/port-props/port-props.h \
+ @LV2_SRCDIR@/lv2/presets/presets.h \
+ @LV2_SRCDIR@/lv2/resize-port/resize-port.h \
+ @LV2_SRCDIR@/lv2/state/state.h \
+ @LV2_SRCDIR@/lv2/time/time.h \
+ @LV2_SRCDIR@/lv2/ui/ui.h \
+ @LV2_SRCDIR@/lv2/units/units.h \
+ @LV2_SRCDIR@/lv2/uri-map/uri-map.h \
+ @LV2_SRCDIR@/lv2/urid/urid.h \
+ @LV2_SRCDIR@/lv2/worker/worker.h
# This tag can be used to specify the character encoding of the source files
-# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
-# also the default input encoding. Doxygen uses libiconv (or the iconv built
-# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
-# the list of possible encodings.
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
+# possible encodings.
+# The default value is: UTF-8.
INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
-# and *.h) to filter out the source-files in the directories. If left
-# blank the following patterns are tested:
-# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
-# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
-# *.f90 *.f *.for *.vhd *.vhdl
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# read by doxygen.
+#
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
+# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
+# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
+# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
FILE_PATTERNS =
-# The RECURSIVE tag can be used to turn specify whether or not subdirectories
-# should be searched for input files as well. Possible values are YES and NO.
-# If left blank NO is used.
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
RECURSIVE = NO
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
+#
# Note that relative paths are relative to the directory from which doxygen is
# run.
@@ -715,14 +876,16 @@ EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
+# The default value is: NO.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
-# certain files from those directories. Note that the wildcards are matched
-# against the file with absolute path, so to exclude all test directories
-# for example use the pattern */test/*
+# certain files from those directories.
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS =
@@ -731,755 +894,1169 @@ EXCLUDE_PATTERNS =
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS =
-# The EXAMPLE_PATH tag can be used to specify one or more files or
-# directories that contain example code fragments that are included (see
-# the \include command).
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
-# and *.h) to filter out the source-files in the directories. If left
-# blank all files are included.
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
EXAMPLE_PATTERNS =
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
-# searched for input files to be used with the \include or \dontinclude
-# commands irrespective of the value of the RECURSIVE tag.
-# Possible values are YES and NO. If left blank NO is used.
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
EXAMPLE_RECURSIVE = NO
-# The IMAGE_PATH tag can be used to specify one or more files or
-# directories that contain image that are included in the documentation (see
-# the \image command).
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be included in the documentation (see the
+# \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
-# by executing (via popen()) the command <filter> <input-file>, where <filter>
-# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
-# input file. Doxygen will then use the output that the filter program writes
-# to standard output.
-# If FILTER_PATTERNS is specified, this tag will be
-# ignored.
+# by executing (via popen()) the command:
+#
+# <filter> <input-file>
+#
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
+# name of an input file. Doxygen will then use the output that the filter
+# program writes to standard output. If FILTER_PATTERNS is specified, this tag
+# will be ignored.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
-# basis.
-# Doxygen will compare the file name with each pattern and apply the
-# filter if there is a match.
-# The filters are a list of the form:
-# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
-# info on how filters are used. If FILTER_PATTERNS is empty or if
-# non of the patterns match the file name, INPUT_FILTER is applied.
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form: pattern=filter
+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
-# INPUT_FILTER) will be used to filter the input files when producing source
-# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# INPUT_FILTER) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
FILTER_SOURCE_FILES = NO
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
-# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
-# and it is also possible to disable source filtering for a specific pattern
-# using *.ext= (so without naming a filter). This option only has effect when
-# FILTER_SOURCE_FILES is enabled.
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
FILTER_SOURCE_PATTERNS =
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE = @LV2_SRCDIR@/doc/mainpage.md
+
#---------------------------------------------------------------------------
-# configuration options related to source browsing
+# Configuration options related to source browsing
#---------------------------------------------------------------------------
-# If the SOURCE_BROWSER tag is set to YES then a list of source files will
-# be generated. Documented entities will be cross-referenced with these sources.
-# Note: To get rid of all source code in the generated output, make sure also
-# VERBATIM_HEADERS is set to NO.
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
+# generated. Documented entities will be cross-referenced with these sources.
+#
+# Note: To get rid of all source code in the generated output, make sure that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
SOURCE_BROWSER = NO
-# Setting the INLINE_SOURCES tag to YES will include the body
-# of functions and classes directly in the documentation.
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
INLINE_SOURCES = NO
-# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
-# doxygen to hide any special comment blocks from generated source code
-# fragments. Normal C, C++ and Fortran comments will always remain visible.
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
STRIP_CODE_COMMENTS = YES
-# If the REFERENCED_BY_RELATION tag is set to YES
-# then for each documented function all documented
-# functions referencing it will be listed.
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# entity all documented functions referencing it will be listed.
+# The default value is: NO.
REFERENCED_BY_RELATION = NO
-# If the REFERENCES_RELATION tag is set to YES
-# then for each documented function all documented entities
-# called/used by that function will be listed.
+# If the REFERENCES_RELATION tag is set to YES then for each documented function
+# all documented entities called/used by that function will be listed.
+# The default value is: NO.
REFERENCES_RELATION = NO
-# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
-# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
-# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
-# link to the source code.
-# Otherwise they will link to the documentation.
+# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
+# to YES then the hyperlinks from functions in REFERENCES_RELATION and
+# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
+# link to the documentation.
+# The default value is: YES.
REFERENCES_LINK_SOURCE = YES
-# If the USE_HTAGS tag is set to YES then the references to source code
-# will point to the HTML generated by the htags(1) tool instead of doxygen
-# built-in source browser. The htags tool is part of GNU's global source
-# tagging system (see http://www.gnu.org/software/global/global.html). You
-# will need version 4.8.6 or higher.
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code will
+# point to the HTML generated by the htags(1) tool instead of doxygen built-in
+# source browser. The htags tool is part of GNU's global source tagging system
+# (see https://www.gnu.org/software/global/global.html). You will need version
+# 4.8.6 or higher.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
USE_HTAGS = NO
-# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
-# will generate a verbatim copy of the header file for each class for
-# which an include is specified. Set to NO to disable this.
+# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
+# verbatim copy of the header file for each class for which an include is
+# specified. Set to NO to disable this.
+# See also: Section \class.
+# The default value is: YES.
VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
-# configuration options related to the alphabetical class index
+# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
-# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
-# of all compounds will be generated. Enable this if the project
-# contains a lot of classes, structs, unions or interfaces.
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
+# compounds will be generated. Enable this if the project contains a lot of
+# classes, structs, unions or interfaces.
+# The default value is: YES.
ALPHABETICAL_INDEX = NO
-# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
-# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
-# in which this list will be split (can be a number in the range [1..20])
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5
-# In case all classes in a project start with a common prefix, all
-# classes will be put under the same header in the alphabetical index.
-# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
-# should be ignored while generating the index headers.
+# In case all classes in a project start with a common prefix, all classes will
+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
+# can be used to specify a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
-# configuration options related to the HTML output
+# Configuration options related to the HTML output
#---------------------------------------------------------------------------
-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
-# generate HTML output.
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
+# The default value is: YES.
GENERATE_HTML = YES
-# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `html' will be used as the default path.
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
-# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
-# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
-# doxygen will generate files with .html extension.
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FILE_EXTENSION = .html
-# The HTML_HEADER tag can be used to specify a personal HTML header for
-# each generated HTML page. If it is left blank doxygen will generate a
-# standard header. Note that when using a custom header you are responsible
-# for the proper inclusion of any scripts and style sheets that doxygen
-# needs, which is dependent on the configuration options used.
-# It is advised to generate a default header using "doxygen -w html
-# header.html footer.html stylesheet.css YourConfigFile" and then modify
-# that header. Note that the header is subject to change so you typically
-# have to redo this when upgrading to a newer version of doxygen or when
-# changing the value of configuration settings such as GENERATE_TREEVIEW!
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER = @LV2_SRCDIR@/doc/header.html
-# The HTML_FOOTER tag can be used to specify a personal HTML footer for
-# each generated HTML page. If it is left blank doxygen will generate a
-# standard footer.
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FOOTER = @LV2_SRCDIR@/doc/footer.html
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
+# sheet that is used by each HTML page. It can be used to fine-tune the look of
+# the HTML output. If left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_FOOTER =
+HTML_STYLESHEET = @LV2_SRCDIR@/doc/doxy-style.css
-# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
-# style sheet that is used by each HTML page. It can be used to
-# fine-tune the look of the HTML output. If the tag is left blank doxygen
-# will generate a default style sheet. Note that doxygen will try to copy
-# the style sheet file to the HTML output directory, so don't put your own
-# style sheet in the HTML output directory as well, or it will be erased!
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefore more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_STYLESHEET = @LV2_SRCDIR@/doc/doxy-style.css
+HTML_EXTRA_STYLESHEET =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
-# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
-# files. In the HTML_STYLESHEET file, use the file name only. Also note that
-# the files will be copied as-is; there are no commands or markers available.
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_FILES =
-# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
-# Doxygen will adjust the colors in the style sheet and background images
-# according to this color. Hue is specified as an angle on a colorwheel,
-# see http://en.wikipedia.org/wiki/Hue for more information.
-# For instance the value 0 represents red, 60 is yellow, 120 is green,
-# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
-# The allowed range is 0 to 359.
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the style sheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 160
-# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
-# the colors in the HTML output. For a value of 0 the output will use
-# grayscales only. A value of 255 will produce the most vivid colors.
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_COLORSTYLE_SAT = 60
+HTML_COLORSTYLE_SAT = 30
-# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
-# the luminance component of the colors in the HTML output. Values below
-# 100 gradually make the output lighter, whereas values above 100 make
-# the output darker. The value divided by 100 is the actual gamma applied,
-# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
-# and 100 does not change the gamma.
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 100
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
-# page will contain the date and time when the page was generated. Setting
-# this to NO can help when comparing the output of multiple runs.
+# page will contain the date and time when the page was generated. Setting this
+# to YES can help to show when doxygen was last run and thus if the
+# documentation is up to date.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = NO
+# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
+# documentation will contain a main index with vertical navigation menus that
+# are dynamically created via Javascript. If disabled, the navigation index will
+# consists of multiple levels of tabs that are statically embedded in every HTML
+# page. Disable this option to support browsers that do not have Javascript,
+# like the Qt help browser.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_MENUS = NO
+
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = NO
-# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
-# entries shown in the various tree structured indices initially; the user
-# can expand and collapse entries dynamically later on. Doxygen will expand
-# the tree to such a level that at most the specified number of entries are
-# visible (unless a fully collapsed tree already exceeds this amount).
-# So setting the number of entries 1 will produce a full collapsed tree by
-# default. 0 is a special value representing an infinite number of entries
-# and will result in a full expanded tree by default.
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100
-# If the GENERATE_DOCSET tag is set to YES, additional index files
-# will be generated that can be used as input for Apple's Xcode 3
-# integrated development environment, introduced with OSX 10.5 (Leopard).
-# To create a documentation set, doxygen will generate a Makefile in the
-# HTML output directory. Running make will produce the docset in that
-# directory and running "make install" will install the docset in
-# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
-# it at startup.
-# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
-# for more information.
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
+# generated that can be used as input for Apple's Xcode 3 integrated development
+# environment (see: https://developer.apple.com/xcode/), introduced with OSX
+# 10.5 (Leopard). To create a documentation set, doxygen will generate a
+# Makefile in the HTML output directory. Running make will produce the docset in
+# that directory and running make install will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
+# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
+# genXcode/_index.html for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_DOCSET = NO
-# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
-# feed. A documentation feed provides an umbrella under which multiple
-# documentation sets from a single provider (such as a company or product suite)
-# can be grouped.
+# This tag determines the name of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDNAME = "Doxygen generated docs"
-# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
-# should uniquely identify the documentation set bundle. This should be a
-# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
-# will append .docset to the name.
+# This tag specifies a string that should uniquely identify the documentation
+# set bundle. This should be a reverse domain-name style string, e.g.
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project
-# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
-# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher
-# If the GENERATE_HTMLHELP tag is set to YES, additional index files
-# will be generated that can be used as input for tools like the
-# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
-# of the generated HTML documentation.
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO
-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
-# be used to specify the file name of the resulting .chm file. You
-# can add a path in front of the file if the result should not be
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
+# file. You can add a path in front of the file if the result should not be
# written to the html output directory.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE =
-# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
-# be used to specify the location (absolute path including file name) of
-# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
-# the HTML help compiler on the generated index.hhp.
+# The HHC_LOCATION tag can be used to specify the location (absolute path
+# including file name) of the HTML help compiler (hhc.exe). If non-empty,
+# doxygen will try to run the HTML help compiler on the generated index.hhp.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION =
-# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
-# controls if a separate .chi index file is generated (YES) or that
-# it should be included in the master .chm file (NO).
+# The GENERATE_CHI flag controls if a separate .chi index file is generated
+# (YES) or that it should be included in the master .chm file (NO).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO
-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
-# is used to encode HtmlHelp index (hhk), content (hhc) and project file
-# content.
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING =
-# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
-# controls whether a binary table of contents is generated (YES) or a
-# normal table of contents (NO) in the .chm file.
+# The BINARY_TOC flag controls whether a binary table of contents is generated
+# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO
-# The TOC_EXPAND flag can be set to YES to add extra items for group members
-# to the contents of the HTML help documentation and to the tree view.
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
-# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
-# that can be used as input for Qt's qhelpgenerator to generate a
-# Qt Compressed Help (.qch) of the generated HTML documentation.
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
+# (.qch) of the generated HTML documentation.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_QHP = NO
-# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
-# be used to specify the file name of the resulting .qch file.
-# The path specified is relative to the HTML output folder.
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
+# the file name of the resulting .qch file. The path specified is relative to
+# the HTML output folder.
+# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE =
-# The QHP_NAMESPACE tag specifies the namespace to use when generating
-# Qt Help Project output. For more information please see
-# http://doc.trolltech.com/qthelpproject.html#namespace
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE =
-# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
-# Qt Help Project output. For more information please see
-# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = doc
-# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
-# add. For more information please see
-# http://doc.trolltech.com/qthelpproject.html#custom-filters
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME =
-# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
-# custom filter to add. For more information please see
-# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
-# Qt Help Project / Custom Filters</a>.
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
-# project's
-# filter section matches.
-# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
-# Qt Help Project / Filter Attributes</a>.
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
-# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
-# be used to specify the location of Qt's qhelpgenerator.
-# If non-empty doxygen will try to run qhelpgenerator on the generated
-# .qhp file.
+# The QHG_LOCATION tag can be used to specify the location of Qt's
+# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
+# generated .qhp file.
+# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION =
-# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
-# will be generated, which together with the HTML files, form an Eclipse help
-# plugin. To install this plugin and make it available under the help contents
-# menu in Eclipse, the contents of the directory containing the HTML and XML
-# files needs to be copied into the plugins directory of eclipse. The name of
-# the directory within the plugins directory should be the same as
-# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
-# the help appears.
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they form an Eclipse help plugin. To
+# install this plugin and make it available under the help contents menu in
+# Eclipse, the contents of the directory containing the HTML and XML files needs
+# to be copied into the plugins directory of eclipse. The name of the directory
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
+# After copying Eclipse needs to be restarted before the help appears.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_ECLIPSEHELP = NO
-# A unique identifier for the eclipse help plugin. When installing the plugin
-# the directory name containing the HTML and XML files should also have
-# this name.
+# A unique identifier for the Eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have this
+# name. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project
-# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
-# at top of each HTML page. The value NO (the default) enables the index and
-# the value YES disables it. Since the tabs have the same information as the
-# navigation tree you can set this option to NO if you already set
-# GENERATE_TREEVIEW to YES.
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
-# structure should be generated to display hierarchical information.
-# If the tag value is set to YES, a side panel will be generated
-# containing a tree-like index structure (just like the one that
-# is generated for HTML Help). For this to work a browser that supports
-# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
-# Windows users are probably better off using the HTML help feature.
-# Since the tree basically has the same information as the tab index you
-# could consider to set DISABLE_INDEX to NO when enabling this option.
+# structure should be generated to display hierarchical information. If the tag
+# value is set to YES, a side panel will be generated containing a tree-like
+# index structure (just like the one that is generated for HTML Help). For this
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
+# (i.e. any modern browser). Windows users are probably better off using the
+# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = NO
-# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
-# (range [0,1..20]) that doxygen will group on one line in the generated HTML
-# documentation. Note that a value of 0 will completely suppress the enum
-# values from appearing in the overview section.
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
-ENUM_VALUES_PER_LINE = 4
+ENUM_VALUES_PER_LINE = 1
-# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
-# used to set the initial width (in pixels) of the frame in which the tree
-# is shown.
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
TREEVIEW_WIDTH = 250
-# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
-# links to external symbols imported via tag files in a separate window.
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO
-# Use this tag to change the font size of Latex formulas included
-# as images in the HTML documentation. The default is 10. Note that
-# when you change the font size after a successful doxygen run you need
-# to manually remove any form_*.png images from the HTML output directory
-# to force them to be regenerated.
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. When you change the font size after a successful
+# doxygen run you need to manually remove any form_*.png images from the HTML
+# output directory to force them to be regenerated.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 10
-# Use the FORMULA_TRANPARENT tag to determine whether or not the images
-# generated for formulas are transparent PNGs. Transparent PNGs are
-# not supported properly for IE 6.0, but are supported on all modern browsers.
-# Note that when changing this option you need to delete any form_*.png files
-# in the HTML output before the changes have effect.
+# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES
-# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
-# (see http://www.mathjax.org) which uses client side Javascript for the
-# rendering instead of using prerendered bitmaps. Use this if you do not
-# have LaTeX installed or if you want to formulas look prettier in the HTML
-# output. When enabled you may also need to install MathJax separately and
-# configure the path to it using the MATHJAX_RELPATH option.
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# https://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO
-# When MathJax is enabled you need to specify the location relative to the
-# HTML output directory using the MATHJAX_RELPATH option. The destination
-# directory should contain the MathJax.js script. For instance, if the mathjax
-# directory is located at the same level as the HTML output directory, then
-# MATHJAX_RELPATH should be ../mathjax. The default value points to
-# the MathJax Content Delivery Network so you can quickly see the result without
-# installing MathJax.
-# However, it is strongly recommended to install a local
-# copy of MathJax from http://www.mathjax.org before deployment.
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from https://www.mathjax.org before deployment.
+# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
+# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
-# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
-# names that should be enabled during MathJax rendering.
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_EXTENSIONS =
-# When the SEARCHENGINE tag is enabled doxygen will generate a search box
-# for the HTML output. The underlying search engine uses javascript
-# and DHTML and should work on any modern browser. Note that when using
-# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
-# (GENERATE_DOCSET) there is already a search function so this one should
-# typically be disabled. For large projects the javascript based search engine
-# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
+# the HTML output. The underlying search engine uses javascript and DHTML and
+# should work on any modern browser. Note that when using HTML help
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be disabled.
+# For large projects the javascript based search engine can be slow, then
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = NO
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
-# implemented using a PHP enabled web server instead of at the web client
-# using Javascript. Doxygen will generate the search PHP script and index
-# file to put on the web server. The advantage of the server
-# based approach is that it scales better to large projects and allows
-# full text search. The disadvantages are that it is more difficult to setup
-# and does not have live searching capabilities.
+# implemented using a web server instead of a web client using Javascript. There
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# setting. When disabled, doxygen will generate a PHP script for searching and
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# and searching needs to be provided by external tools. See the section
+# "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: https://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: https://xapian.org/). See the section "External Indexing and
+# Searching" for details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
#---------------------------------------------------------------------------
-# configuration options related to the LaTeX output
+# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
-# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
-# generate Latex output.
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
+# The default value is: YES.
GENERATE_LATEX = NO
-# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `latex' will be used as the default path.
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
-# invoked. If left blank `latex' will be used as the default command name.
-# Note that when enabling USE_PDFLATEX this option is only used for
-# generating bitmaps for formulas in the HTML output, but not in the
-# Makefile that is written to the output directory.
+# invoked.
+#
+# Note that when not enabling USE_PDFLATEX the default is latex when enabling
+# USE_PDFLATEX the default is pdflatex and when in the later case latex is
+# chosen this is overwritten by pdflatex. For specific output languages the
+# default can have been set differently, this depends on the implementation of
+# the output language.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME = latex
-# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
-# generate index for LaTeX. If left blank `makeindex' will be used as the
-# default command name.
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# Note: This tag is used in the Makefile / make.bat.
+# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
+# (.tex).
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex
-# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
-# LaTeX documents. This may be useful for small projects and may help to
-# save some trees in general.
+# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
+# generate index for LaTeX.
+# Note: This tag is used in the generated output file (.tex).
+# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
+# The default value is: \makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_MAKEINDEX_CMD = \makeindex
+
+# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO
-# The PAPER_TYPE tag can be used to set the paper type that is used
-# by the printer. Possible values are: a4, letter, legal and
-# executive. If left blank a4wide will be used.
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4wide
-# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
-# packages that should be included in the LaTeX output.
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. The package can be specified just
+# by its name or with the correct syntax as to be used with the LaTeX
+# \usepackage command. To get the times font for instance you can specify :
+# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
+# To use the option intlimits with the amsmath package you can specify:
+# EXTRA_PACKAGES=[intlimits]{amsmath}
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES =
-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
-# the generated latex document. The header should contain everything until
-# the first chapter. If it is left blank doxygen will generate a
-# standard header. Notice: only use this tag if you know what you are doing!
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
+# generated LaTeX document. The header should contain everything until the first
+# chapter. If it is left blank doxygen will generate a standard header. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
+# string, for the replacement values of the other commands the user is referred
+# to HTML_HEADER.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER =
-# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
-# the generated latex document. The footer should contain everything after
-# the last chapter. If it is left blank doxygen will generate a
-# standard footer. Notice: only use this tag if you know what you are doing!
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER =
-# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
-# is prepared for conversion to pdf (using ps2pdf). The pdf file will
-# contain links (just like the HTML output) instead of page references
-# This makes the output suitable for online browsing using a pdf viewer.
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# LaTeX style sheets that are included after the standard style sheets created
+# by doxygen. Using this option one can overrule certain style aspects. Doxygen
+# will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_STYLESHEET =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES =
-PDF_HYPERLINKS = NO
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
+# contain links (just like the HTML output) instead of page references. This
+# makes the output suitable for online browsing using a PDF viewer.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
-# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
-# plain latex in the generated Makefile. Set this option to YES to get a
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES, to get a
# higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
-USE_PDFLATEX = NO
+USE_PDFLATEX = YES
-# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
-# command to the generated LaTeX files. This will instruct LaTeX to keep
-# running if errors occur, instead of asking the user for help.
-# This option is also used when generating formulas in HTML.
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
+# command to the generated LaTeX files. This will instruct LaTeX to keep running
+# if errors occur, instead of asking the user for help. This option is also used
+# when generating formulas in HTML.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO
-# If LATEX_HIDE_INDICES is set to YES then doxygen will not
-# include the index chapters (such as File Index, Compound Index, etc.)
-# in the output.
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO
-# If LATEX_SOURCE_CODE is set to YES then doxygen will include
-# source code with syntax highlighting in the LaTeX output.
-# Note that which sources are shown also depends on other settings
-# such as SOURCE_BROWSER.
+# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
+# code with syntax highlighting in the LaTeX output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_SOURCE_CODE = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
-# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
-# http://en.wikipedia.org/wiki/BibTeX for more info.
+# bibliography, e.g. plainnat, or ieeetr. See
+# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
+# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_TIMESTAMP = NO
+
+# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
+# path from which the emoji images will be read. If a relative path is entered,
+# it will be relative to the LATEX_OUTPUT directory. If left blank the
+# LATEX_OUTPUT directory will be used.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EMOJI_DIRECTORY =
+
#---------------------------------------------------------------------------
-# configuration options related to the RTF output
+# Configuration options related to the RTF output
#---------------------------------------------------------------------------
-# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
-# The RTF output is optimized for Word 97 and may not look very pretty with
-# other RTF readers or editors.
+# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
+# RTF output is optimized for Word 97 and may not look too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
GENERATE_RTF = NO
-# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `rtf' will be used as the default path.
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf
-# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
-# RTF documents. This may be useful for small projects and may help to
-# save some trees in general.
+# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO
-# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
-# will contain hyperlink fields. The RTF file will
-# contain links (just like the HTML output) instead of page references.
-# This makes the output suitable for online browsing using WORD or other
-# programs which support those fields.
-# Note: wordpad (write) and others do not support links.
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
+# contain hyperlink fields. The RTF file will contain links (just like the HTML
+# output) instead of page references. This makes the output suitable for online
+# browsing using Word or some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO
-# Load style sheet definitions from file. Syntax is similar to doxygen's
-# config file, i.e. a series of assignments. You only have to provide
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# configuration file, i.e. a series of assignments. You only have to provide
# replacements, missing definitions are set to their default value.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE =
-# Set optional variables used in the generation of an rtf document.
-# Syntax is similar to doxygen's config file.
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's configuration file. A template extensions file can be
+# generated using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
+# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
+# with syntax highlighting in the RTF output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_SOURCE_CODE = NO
+
#---------------------------------------------------------------------------
-# configuration options related to the man page output
+# Configuration options related to the man page output
#---------------------------------------------------------------------------
-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
-# generate man pages
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
GENERATE_MAN = NO
-# The MAN_OUTPUT tag is used to specify where the man pages will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `man' will be used as the default path.
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man
-# The MAN_EXTENSION tag determines the extension that is added to
-# the generated man pages (default is the subroutine's section .3)
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3
-# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
-# then it will generate one additional man file for each entity
-# documented in the real man page(s). These additional files
-# only source the real man page, but without them the man command
-# would be unable to find the correct page. The default is NO.
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR =
+
+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
+# will generate one additional man file for each entity documented in the real
+# man page(s). These additional files only source the real man page, but without
+# them the man command would be unable to find the correct page.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
-# configuration options related to the XML output
+# Configuration options related to the XML output
#---------------------------------------------------------------------------
-# If the GENERATE_XML tag is set to YES Doxygen will
-# generate an XML file that captures the structure of
-# the code including all documentation.
+# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
+# captures the structure of the code including all documentation.
+# The default value is: NO.
GENERATE_XML = NO
-# The XML_OUTPUT tag is used to specify where the XML pages will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `xml' will be used as the default path.
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml
-# The XML_SCHEMA tag can be used to specify an XML schema,
-# which can be used by a validating XML parser to check the
-# syntax of the XML files.
+# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
+# listings (including syntax highlighting and cross-referencing information) to
+# the XML output. Note that enabling this will significantly increase the size
+# of the XML output.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
-XML_SCHEMA =
+XML_PROGRAMLISTING = YES
-# The XML_DTD tag can be used to specify an XML DTD,
-# which can be used by a validating XML parser to check the
-# syntax of the XML files.
+# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
+# namespace members in file scope as well, matching the HTML output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_XML is set to YES.
-XML_DTD =
+XML_NS_MEMB_FILE_SCOPE = NO
-# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
-# dump the program listings (including syntax highlighting
-# and cross-referencing information) to the XML output. Note that
-# enabling this will significantly increase the size of the XML output.
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
-XML_PROGRAMLISTING = YES
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT = docbook
+
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
+# program listings (including syntax highlighting and cross-referencing
+# information) to the DOCBOOK output. Note that enabling this will significantly
+# increase the size of the DOCBOOK output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
-# configuration options for the AutoGen Definitions output
+# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
-# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
-# generate an AutoGen Definitions (see autogen.sf.net) file
-# that captures the structure of the code including all
-# documentation. Note that this feature is still experimental
-# and incomplete at the moment.
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
+# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
+# the structure of the code including all documentation. Note that this feature
+# is still experimental and incomplete at the moment.
+# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
-# configuration options related to the Perl module output
+# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
-# If the GENERATE_PERLMOD tag is set to YES Doxygen will
-# generate a Perl module file that captures the structure of
-# the code including all documentation. Note that this
-# feature is still experimental and incomplete at the
-# moment.
+# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
+# file that captures the structure of the code including all documentation.
+#
+# Note that this feature is still experimental and incomplete at the moment.
+# The default value is: NO.
GENERATE_PERLMOD = NO
-# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
-# the necessary Makefile rules, Perl scripts and LaTeX code to be able
-# to generate PDF and DVI output from the Perl module output.
+# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
+# output from the Perl module output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_LATEX = NO
-# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
-# nicely formatted so it can be parsed by a human reader.
-# This is useful
-# if you want to understand what is going on.
-# On the other hand, if this
-# tag is set to NO the size of the Perl module output will be much smaller
-# and Perl will parse it just the same.
+# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
+# formatted so it can be parsed by a human reader. This is useful if you want to
+# understand what is going on. On the other hand, if this tag is set to NO, the
+# size of the Perl module output will be much smaller and Perl will parse it
+# just the same.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_PRETTY = YES
-# The names of the make variables in the generated doxyrules.make file
-# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
-# This is useful so different doxyrules.make files included by the same
-# Makefile don't overwrite each other's variables.
+# The names of the make variables in the generated doxyrules.make file are
+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
+# so different doxyrules.make files included by the same Makefile don't
+# overwrite each other's variables.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX =
@@ -1487,329 +2064,432 @@ PERLMOD_MAKEVAR_PREFIX =
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
-# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
-# evaluate all C-preprocessor directives found in the sources and include
-# files.
+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
ENABLE_PREPROCESSING = YES
-# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
-# names in the source code. If set to NO (the default) only conditional
-# compilation will be performed. Macro expansion can be done in a controlled
-# way by setting EXPAND_ONLY_PREDEF to YES.
+# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
+# in the source code. If set to NO, only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-MACRO_EXPANSION = NO
+MACRO_EXPANSION = YES
-# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
-# then the macro expansion is limited to the macros specified with the
-# PREDEFINED and EXPAND_AS_DEFINED tags.
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
+# the macro expansion is limited to the macros specified with the PREDEFINED and
+# EXPAND_AS_DEFINED tags.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-EXPAND_ONLY_PREDEF = NO
+EXPAND_ONLY_PREDEF = YES
-# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
-# pointed to by INCLUDE_PATH will be searched when a #include is found.
+# If the SEARCH_INCLUDES tag is set to YES, the include files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
-# contain include files that are not input files but should be processed by
-# the preprocessor.
+# contain include files that are not input files but should be processed by the
+# preprocessor.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
-# directories. If left blank, the patterns specified with FILE_PATTERNS will
-# be used.
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
+# used.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
INCLUDE_FILE_PATTERNS =
-# The PREDEFINED tag can be used to specify one or more macro names that
-# are defined before the preprocessor is started (similar to the -D option of
-# gcc). The argument of the tag is a list of macros of the form: name
-# or name=definition (no spaces). If the definition and the = are
-# omitted =1 is assumed. To prevent a macro definition from being
-# undefined via #undef or recursively expanded use the := operator
-# instead of the = operator.
+# The PREDEFINED tag can be used to specify one or more macro names that are
+# defined before the preprocessor is started (similar to the -D option of e.g.
+# gcc). The argument of the tag is a list of macros of the form: name or
+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
+# is assumed. To prevent a macro definition from being undefined via #undef or
+# recursively expanded use the := operator instead of the = operator.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-PREDEFINED =
+PREDEFINED = LV2_DISABLE_DEPRECATION_WARNINGS
-# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
-# this tag can be used to specify a list of macro names that should be expanded.
-# The macro definition that is found in the sources will be used.
-# Use the PREDEFINED tag if you want to use a different macro definition that
-# overrules the definition found in the source code.
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
+# tag can be used to specify a list of macro names that should be expanded. The
+# macro definition that is found in the sources will be used. Use the PREDEFINED
+# tag if you want to use a different macro definition that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED =
-# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
-# doxygen's preprocessor will remove all references to function-like macros
-# that are alone on a line, have an all uppercase name, and do not end with a
-# semicolon, because these will confuse the parser if not removed.
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all references to function-like macros that are alone on a line, have
+# an all uppercase name, and do not end with a semicolon. Such function macros
+# are typically used for boiler-plate code, and will confuse the parser if not
+# removed.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
-# Configuration::additions related to external references
+# Configuration options related to external references
#---------------------------------------------------------------------------
-# The TAGFILES option can be used to specify one or more tagfiles. For each
-# tag file the location of the external documentation should be added. The
-# format of a tag file without this location is as follows:
-#
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. The format of
+# a tag file without this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
-#
# TAGFILES = file1=loc1 "file2 = loc2" ...
-# where "loc1" and "loc2" can be relative or absolute paths
-# or URLs. Note that each tag file must have a unique name (where the name does
-# NOT include the path). If a tag file is not located in the directory in which
-# doxygen is run, you must also specify the path to the tagfile here.
+# where loc1 and loc2 can be relative or absolute paths or URLs. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: Each tag file must have a unique name (where the name does NOT include
+# the path). If a tag file is not located in the directory in which doxygen is
+# run, you must also specify the path to the tagfile here.
TAGFILES =
-# When a file name is specified after GENERATE_TAGFILE, doxygen will create
-# a tag file that is based on the input files it reads.
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
+# tag file that is based on the input files it reads. See section "Linking to
+# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = tags
-# If the ALLEXTERNALS tag is set to YES all external classes will be listed
-# in the class index. If set to NO only the inherited external classes
-# will be listed.
+# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
+# the class index. If set to NO, only the inherited external classes will be
+# listed.
+# The default value is: NO.
ALLEXTERNALS = NO
-# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
-# in the modules index. If set to NO, only the current project's groups will
-# be listed.
+# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will be
+# listed.
+# The default value is: YES.
EXTERNAL_GROUPS = YES
-# The PERL_PATH should be the absolute path and name of the perl script
-# interpreter (i.e. the result of `which perl').
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
-PERL_PATH = /usr/bin/perl
+EXTERNAL_PAGES = YES
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
-# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
-# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
-# or super classes. Setting the tag to NO turns the diagrams off. Note that
-# this option also works with HAVE_DOT disabled, but it is recommended to
-# install and use dot, since it yields more powerful graphs.
+# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
+# disabled, but it is recommended to install and use dot, since it yields more
+# powerful graphs.
+# The default value is: YES.
CLASS_DIAGRAMS = YES
-# You can define message sequence charts within doxygen comments using the \msc
-# command. Doxygen will then run the mscgen tool (see
-# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
-# documentation. The MSCGEN_PATH tag allows you to specify the directory where
-# the mscgen tool resides. If left empty the tool is assumed to be found in the
-# default search path.
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
-MSCGEN_PATH =
+DIA_PATH =
-# If set to YES, the inheritance and collaboration graphs will hide
-# inheritance and usage relations if the target is undocumented
-# or is not a class.
+# If set to YES the inheritance and collaboration graphs will hide inheritance
+# and usage relations if the target is undocumented or is not a class.
+# The default value is: YES.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
-# available from the path. This tool is part of Graphviz, a graph visualization
-# toolkit from AT&T and Lucent Bell Labs. The other options in this section
-# have no effect if this option is set to NO (the default)
+# available from the path. This tool is part of Graphviz (see:
+# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
+# Bell Labs. The other options in this section have no effect if this option is
+# set to NO
+# The default value is: NO.
HAVE_DOT = NO
-# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
-# allowed to run in parallel. When set to 0 (the default) doxygen will
-# base this on the number of processors available in the system. You can set it
-# explicitly to a value larger than 0 to get control over the balance
-# between CPU load and processing speed.
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = 0
-# By default doxygen will use the Helvetica font for all dot files that
-# doxygen generates. When you want a differently looking font you can specify
-# the font name using DOT_FONTNAME. You need to make sure dot is able to find
-# the font, which can be done by putting it in a standard location or by setting
-# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
-# directory containing the font.
+# When you want a differently looking font in the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You need to make
+# sure dot is able to find the font, which can be done by putting it in a
+# standard location or by setting the DOTFONTPATH environment variable or by
+# setting DOT_FONTPATH to the directory containing the font.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
-DOT_FONTNAME = FreeSans
+DOT_FONTNAME =
-# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
-# The default size is 10pt.
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTSIZE = 10
-# By default doxygen will tell dot to use the Helvetica font.
-# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
-# set the path where dot can find it.
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH =
-# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
-# will generate a graph for each documented class showing the direct and
-# indirect inheritance relations. Setting this tag to YES will force the
-# CLASS_DIAGRAMS tag to NO.
+# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
+# each documented class showing the direct and indirect inheritance relations.
+# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
CLASS_GRAPH = YES
-# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
-# will generate a graph for each documented class showing the direct and
-# indirect implementation dependencies (inheritance, containment, and
-# class references variables) of the class with other documented classes.
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
+# graph for each documented class showing the direct and indirect implementation
+# dependencies (inheritance, containment, and class references variables) of the
+# class with other documented classes.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = YES
-# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
-# will generate a graph for groups, showing the direct groups dependencies
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = YES
-# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = NO
-# If the UML_LOOK tag is enabled, the fields and methods are shown inside
-# the class node. If there are many fields or methods and many nodes the
-# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
-# threshold limits the number of items for each type to make the size more
-# managable. Set this to 0 for no limit. Note that the threshold may be
-# exceeded by 50% before the limit is enforced.
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
UML_LIMIT_NUM_FIELDS = 10
-# If set to YES, the inheritance and collaboration graphs will show the
-# relations between templates and their instances.
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = YES
-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
-# tags are set to YES then doxygen will generate a graph for each documented
-# file showing the direct and indirect include dependencies of the file with
-# other documented files.
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
+# YES then doxygen will generate a graph for each documented file showing the
+# direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDE_GRAPH = NO
-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
-# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
-# documented header file showing the documented files that directly or
-# indirectly include this file.
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
+# set to YES then doxygen will generate a graph for each documented file showing
+# the direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDED_BY_GRAPH = NO
-# If the CALL_GRAPH and HAVE_DOT options are set to YES then
-# doxygen will generate a call dependency graph for every global function
-# or class method. Note that enabling this option will significantly increase
-# the time of a run. So in most cases it will be better to enable call graphs
-# for selected functions only using the \callgraph command.
+# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command. Disabling a call graph can be
+# accomplished by means of the command \hidecallgraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = NO
-# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
-# doxygen will generate a caller dependency graph for every global function
-# or class method. Note that enabling this option will significantly increase
-# the time of a run. So in most cases it will be better to enable caller
-# graphs for selected functions only using the \callergraph command.
+# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable caller graphs for selected
+# functions only using the \callergraph command. Disabling a caller graph can be
+# accomplished by means of the command \hidecallergraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = NO
-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
-# will generate a graphical hierarchy of all classes instead of a textual one.
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = YES
-# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
-# then doxygen will show the dependencies a directory has on other directories
-# in a graphical way. The dependency relations are determined by the #include
-# relations between the files in the directories.
+# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
+# dependencies a directory has on other directories in a graphical way. The
+# dependency relations are determined by the #include relations between the
+# files in the directories.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = NO
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
-# generated by dot. Possible values are svg, png, jpg, or gif.
-# If left blank png will be used. If you choose svg you need to set
-# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
-# visible in IE 9+ (other browsers do not have this requirement).
+# generated by dot. For an explanation of the image formats see the section
+# output formats in the documentation of the dot tool (Graphviz (see:
+# http://www.graphviz.org/)).
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
+# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
+# png:gdiplus:gdiplus.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
-# Note that this requires a modern browser other than Internet Explorer.
-# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
-# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
-# visible. Older versions of IE do not have SVG support.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO
-# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
-# contain dot files that are included in the documentation (see the
-# \dotfile command).
+# contain dot files that are included in the documentation (see the \dotfile
+# command).
+# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
# The MSCFILE_DIRS tag can be used to specify one or more directories that
-# contain msc files that are included in the documentation (see the
-# \mscfile command).
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
MSCFILE_DIRS =
-# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
-# nodes that will be shown in the graph. If the number of nodes in a graph
-# becomes larger than this value, doxygen will truncate the graph, which is
-# visualized by representing a node as a red box. Note that doxygen if the
-# number of direct children of the root node in a graph is already larger than
-# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
-# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_DIRS =
+
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file. If left blank, it is assumed
+# PlantUML is not used or called during a preprocessing step. Doxygen will
+# generate a warning when it encounters a \startuml command in this case and
+# will not generate output for the diagram.
+
+PLANTUML_JAR_PATH =
+
+# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
+# configuration file for plantuml.
+
+PLANTUML_CFG_FILE =
+
+# When using plantuml, the specified paths are searched for files specified by
+# the !include statement in a plantuml block.
+
+PLANTUML_INCLUDE_PATH =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
+# that will be shown in the graph. If the number of nodes in a graph becomes
+# larger than this value, doxygen will truncate the graph, which is visualized
+# by representing a node as a red box. Note that doxygen if the number of direct
+# children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
+# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50
-# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
-# graphs generated by dot. A depth value of 3 means that only nodes reachable
-# from the root by following a path via at most 3 edges will be shown. Nodes
-# that lay further from the root node will be omitted. Note that setting this
-# option to 1 or 2 may greatly reduce the computation time needed for large
-# code bases. Also note that the size of a graph can be further restricted by
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
+# generated by dot. A depth value of 3 means that only nodes reachable from the
+# root by following a path via at most 3 edges will be shown. Nodes that lay
+# further from the root node will be omitted. Note that setting this option to 1
+# or 2 may greatly reduce the computation time needed for large code bases. Also
+# note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
-# background. This is disabled by default, because dot on Windows does not
-# seem to support this out of the box. Warning: Depending on the platform used,
-# enabling this option may lead to badly anti-aliased labels on the edges of
-# a graph (i.e. they become hard to read).
+# background. This is disabled by default, because dot on Windows does not seem
+# to support this out of the box.
+#
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO
-# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
-# makes dot run faster, but since only newer versions of dot (>1.8.10)
-# support this, this feature is disabled by default.
+# makes dot run faster, but since only newer versions of dot (>1.8.10) support
+# this, this feature is disabled by default.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = YES
-# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
-# generate a legend page explaining the meaning of the various boxes and
-# arrows in the dot generated graphs.
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES
-# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
-# remove the intermediate dot files that are used to generate
-# the various graphs.
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
+# files that are used to generate the various graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
DOT_CLEANUP = YES
diff --git a/doc/style.css b/doc/style.css
index c7a6280..cf32b28 100644
--- a/doc/style.css
+++ b/doc/style.css
@@ -1,571 +1,703 @@
-/* Specgen style */
+@import "./pygments.css";
+
+/* Generic page style */
+
+body {
+ background: #FFF;
+ color: #222;
+ font-family: "DejaVu Sans", "SF Pro Text", Verdana, sans-serif;
+ font-style: normal;
+ line-height: 1.6em;
+ margin-left: auto;
+ margin-right: auto;
+ max-width: 60em;
+ padding: 1em;
+}
+
+h1 {
+ font-family: "DejaVu Sans Condensed", Helvetica, Arial, sans-serif;
+ font-size: 2.38em;
+ font-weight: 600;
+ line-height: 1.41em;
+ margin: 0 0 0.25em 0;
+}
+
+h2 {
+ font-family: "DejaVu Sans Condensed", Helvetica, Arial, sans-serif;
+ font-size: 1.68em;
+ font-weight: 600;
+ line-height: 1.3em;
+ margin: 1.25em 0 0.5em 0;
+}
+
+h3 {
+ font-family: "DejaVu Sans Condensed", Helvetica, Arial, sans-serif;
+ font-size: 1.41em;
+ font-weight: 600;
+ line-height: 1.19em;
+ margin: 1.25em 0 0.5em 0;
+}
+
+h4 {
+ font-family: "DejaVu Sans Condensed", Helvetica, Arial, sans-serif;
+ font-size: 1.19em;
+ font-weight: 600;
+ line-height: 1.09em;
+ margin: 1.25em 0 0.5em 0;
+}
-html, body {
- font-family: sans-serif;
- font-size: 100%;
- background-color: #fff;
- color: #000;
- margin: 0;
- padding: 0;
+h5, h6 {
+ font-family: "DejaVu Sans Condensed", Helvetica, Arial, sans-serif;
+ font-size: 1em;
+ font-weight: 600;
+ line-height: 1em;
+ margin: 1.25em 0 0.5em 0;
}
-a:link, a:visited {
- text-decoration: none;
+
+a {
+ color: #546E00;
+ text-decoration: none;
+}
+
+h1 a, h2 a, h3 a, h4 a, h5 a, h6 a {
+ color: #222;
}
+
a:link {
- color: #3D8C57;
+ color: #546E00;
+ text-decoration: none;
}
+
a:visited {
- color: #50755E;
+ color: #546E00;
}
+
a:hover {
- text-decoration: underline;
+ text-decoration: underline;
+}
+
+h1 a:link, h2 a:link, h3 a:link, h4 a:link, h5 a:link, h6 a:link {
+ color: #222;
+}
+
+h1 a:visited, h2 a:visited, h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited {
+ color: #222;
}
+
img {
- border: 0;
+ border: 0;
}
-h1, h2, h3, h4, h5, h6 {
- line-height: 1em;
- margin: 1em 0 0.5em 0;
+
+p {
+ margin: 0.5em 0 0.5em 0;
}
-h1 {
- font-size: 180%;
- font-weight: 900;
+
+blockquote {
+ border-left: 1px solid #CCC;
+ margin-left: 1em;
+ padding-left: 1em;
}
-h2 {
- font-size: 140%;
- font-weight: 650;
+
+pre, code, kbd, samp {
+ color: #444;
+ font-family: "DejaVu Sans Mono", "SF Mono", Consolas, monospace;
+ margin: 1em 0;
+ white-space: pre;
}
-h3 {
- font-size: 130%;
- font-weight: 600;
+
+ul, ol {
+ margin: 0 0 0.5em 0;
+ padding-top: 0;
}
-h4 {
- font-size: 120%;
- font-weight: 550;
-}
-h5 {
- font-size: 110%;
- font-weight: 500;
-}
-h6 {
- font-size: 100%;
- font-weight: 450;
-}
-#header {
- background-color: #F3F3F3;
- border: 0;
- border-bottom: 1px solid #DDD;
- margin: 0 0 1em 0;
- padding: 1ex;
-}
-#title {
- font-size: 200%;
- font-weight: 700;
- margin: .25ex 0 .25ex 0;
- padding: 0;
+
+dt {
+ font-weight: 600;
+ margin: 0.75em 0 0.125em 0;
+}
+
+dt::after {
+ content: ": ";
+ margin-right: 0.5em;
+}
+
+hr {
+ background-color: #EEE;
+ border: 0;
+ color: gray;
+ height: 1px;
+ margin-bottom: 1.5ex;
+ margin-top: 1.5ex;
+}
+
+table {
+ border-collapse: collapse;
+ border-spacing: 1em 1em;
+ border-style: hidden;
+ border: 0;
+ margin: 0;
+}
+
+th {
+ border: 1px solid #EEE;
+ padding: 0.25em 0.5em;
+ text-align: left;
+}
+
+table tbody tr th {
+ text-align: left;
+}
+
+td {
+ border: 1px solid #EEE;
+ padding: 0.25em 0.5em;
+ vertical-align: top;
+}
+
+caption {
+ caption-side: bottom;
+ font-size: small;
+ font-style: italic;
+ margin: 0.75em 0;
+}
+
+footer {
+ color: #444;
+ font-size: small;
+}
+
+/* Specgen style */
+
+#titlebox {
+ display: inline-block;
+ max-width: 60%;
+ left: 0;
+ top: 0;
+}
+
+#metabox {
+ display: inline-block;
+ font-size: x-small;
+ font-family: "DejaVu Sans Condensed", Helvetica, Arial, sans-serif;
+ position: absolute;
+ right: 0;
+ bottom: 0.25em;
+ color: #666;
+ font-style: italic;
}
+
+#meta {
+ border-style: hidden;
+}
+
+#meta tr, #meta th, #meta td {
+ border: 0;
+ font-weight: normal;
+ padding: 0 0 0.125em 0;
+ background-color: transparent;
+}
+
+#meta th {
+ padding-right: 0.5em;
+ text-align: right;
+}
+
+#meta th::after {
+ content: ": ";
+}
+
#subtitle {
- margin: 0 auto 2ex 0.5ex;
+ font-size: small;
}
+
+#shortdesc {
+ padding: 0;
+ margin: 0 0 0.5em 0;
+ font-style: italic;
+ color: #666;
+ display: inline-block;
+}
+
#logo {
- height: 63px;
- margin-left: 1em;
- margin-top: 10px;
- width: 100px;
+ height: 63px;
+ margin-left: 1em;
+ margin-top: 10px;
+ width: 100px;
}
+
+#titlesep {
+ color: #EEE;
+}
+
#content-body {
- border-bottom: 0;
- display: block;
- font-size: 75%;
- left: 0;
- margin-left: 2em;
- min-width: 660px;
- padding: 3px 10px 0 0;
- position: absolute;
- top: 63px;
- width: 93.900002%;
- z-index: 0;
-}
-#body-main {
- font-size: 100%;
- line-height: 1.4em;
- margin-left: 19em;
- padding: 0 .55em 40px 0;
-}
-#left-hand-navigation {
- left: 1ex;
- position: absolute;
- top: 100px;
- z-index: 1;
+ border-bottom: 0;
+ display: block;
+ font-size: 75%;
+ left: 0;
+ margin-left: 2em;
+ min-width: 660px;
+ padding: 3px 10px 0 0;
+ position: absolute;
+ top: 63px;
+ width: 93.900002%;
+ z-index: 0;
}
+
#menu {
- font-size: 75%;
- margin-bottom: 5px;
- padding: 0;
- width: 16em;
+ font-size: 75%;
+ margin-bottom: 5px;
+ padding: 0;
+ width: 16em;
}
+
#menu ul {
- border: 0;
- list-style: none;
- margin: 0;
- padding: 0;
+ border: 0;
+ list-style: none;
+ margin: 0;
+ padding: 0;
}
+
+#menu a {
+ text-decoration: none;
+}
+
#menu ul.level-one a {
- background-color: #f5f5f5;
- border: 1px solid #dadada;
- color: #4b5a6a;
- display: block;
- margin: 0 0 4px 1.4em;
- padding: 2px 2px 2px 4px;
- text-transform: uppercase;
- width: 13.4em!important;
+ background-color: #F5F5F5;
+ border: 1px solid #DADADA;
+ color: #4B5A6A;
+ display: block;
+ margin: 0 0 4px 1.4em;
+ padding: 2px 2px 2px 4px;
+ text-transform: uppercase;
+ width: 13.4em !important;
}
-#menu ul.level-one a.selected {
- background-color: #FFF;
- border-left: 3px solid #ffdb4c;
- color: #000;
+
+#menu ul.level-two a {
+ background: none;
+ background-color: transparent;
+ border: 0;
+ border-top: 1px solid #DDD;
+ color: #3C4B7B;
+ display: block;
+ margin: 0 3em 0 1.5em;
+ padding: 0.1em;
+ text-transform: none;
+ width: 11em !important;
}
-#menu ul.level-two li:first-child a {
- border-top: 0;
+
+#menu ul.level-three a {
+ border: 0;
+ color: #5E72A5;
+ display: block;
+ font-size: 95%;
+ margin: 0 3em 0 1.8em;
+ padding: 0.1em 0.1em 0.1em 1em;
+ width: 10em !important;
}
-#menu ul.level-two a {
- background: none;
- background-color: transparent;
- border: 0;
- border-top: 1px solid #ddd;
- color: #3c4b7b;
- display: block;
- margin: 0 3em 0 1.5em;
- padding: .1em;
- text-transform: none;
- width: 11em!important;
+
+#menu ul.level-one a:hover,
+#menu ul.level-two a:hover,
+#menu ul.level-three a:hover {
+ color: #000;
+ text-decoration: underline;
+}
+
+#menu ul.level-one a.selected {
+ background-color: #FFF;
+ border-left: 3px solid #FFDB4C;
+ color: #000;
}
+
#menu ul.level-two a:visited {
- color: #4c3b5b;
+ color: #4C3B5B;
+}
+
+#menu ul.level-two li:first-child a {
+ border-top: 0;
}
+
#menu ul.level-one ul.level-two a.selected {
- background-color: #FFF;
- border-left: 0;
- color: #000;
- font-weight: 700;
+ background-color: #FFF;
+ border-left: 0;
+ color: #000;
+ font-weight: 700;
}
+
#menu li ul {
- margin-bottom: 7px;
-}
-#menu a {
- text-decoration: none;
-}
-#menu ul.level-three a {
- border: 0;
- color: #5e72a5;
- display: block;
- font-size: 95%;
- margin: 0 3em 0 1.8em;
- padding: .1em .1em .1em 1em;
- width: 10em!important;
+ margin-bottom: 7px;
}
+
#menu ul.level-three li.selected a.selected {
- color: #000;
- font-weight: 400;
+ color: #000;
+ font-weight: 400;
}
+
#menu ul.level-three {
- margin-top: 5px;
-}
-#left-hand-navigation h4 {
- color: #4c5b6b;
- font-size: 77%;
- margin: .2em 0 .3em;
- padding: .4em 0 0 1.5em;
-}
-#left-hand-navigation h4 a {
- color: #4c5b6b;
- font-weight: 700;
- text-decoration: none;
-}
-#body-main ul, #body-main li {
- margin-left: 1em;
- padding-left: 0;
-}
-#utility-menu {
- font-size: 88%;
- height: 85px;
- margin: 0;
- padding: 0;
- position: absolute;
- right: 4%;
- top: 0;
- width: 400px;
- z-index: 1;
-}
-#utility-menu a {
- color: #436a85;
- padding: 0 .5em;
- text-decoration: none;
-}
-#utility-menu a:hover {
- text-decoration: underline;
-}
-#utility-menu #screen-switcher {
- bottom: 0;
- margin: 0;
- padding: 0;
- position: absolute;
- right: 0;
-}
-#screen-switcher dl {
- margin: 0;
- padding: 0;
+ margin-top: 5px;
}
+
#searchbox {
- font-weight: 700;
- position: absolute;
- right: 0;
- text-align: right;
- top: 0;
- vertical-align: middle;
- white-space: nowrap;
- width: 28.1em;
+ font-weight: 700;
+ position: absolute;
+ right: 0;
+ text-align: right;
+ top: 0;
+ vertical-align: middle;
+ white-space: nowrap;
+ width: 28.1em;
}
+
#search {
- color: #a38e60;
- padding: 5px 5px 0 0;
+ color: #A38E60;
+ padding: 5px 5px 0 0;
}
+
#search .input-text {
- background-color: #FFF;
- border: 1px solid #c4cccc;
- font-size: 116%;
- font-weight: 400;
- margin-top: 3px;
- vertical-align: top;
- width: 11em;
+ background-color: #FFF;
+ border: 1px solid #C4CCCC;
+ font-size: 116%;
+ font-weight: 400;
+ margin-top: 3px;
+ vertical-align: top;
+ width: 11em;
}
+
#search .input-button {
- background-color: #f8f7f7;
- border-bottom: 1px solid #6f7777;
- border-left: 1px solid #c4cccc;
- border-right: 1px solid #6f7777;
- border-top: 1px solid #c4cccc;
- color: #234;
- font-weight: 700;
- margin: 3px .4em 0;
- padding: 0 .2em;
- vertical-align: text-top;
+ background-color: #F8F7F7;
+ border-bottom: 1px solid #6F7777;
+ border-left: 1px solid #C4CCCC;
+ border-right: 1px solid #6F7777;
+ border-top: 1px solid #C4CCCC;
+ color: #234;
+ font-weight: 700;
+ margin: 3px 0.4em 0;
+ padding: 0 0.2em;
+ vertical-align: text-top;
}
+
input.formbutton {
- background-color: #f8f7f7;
- border-bottom: 1px solid #6f7777;
- border-left: 1px solid #c4cccc;
- border-right: 1px solid #6f7777;
- border-top: 1px solid #c4cccc;
- color: #234;
- font-weight: 700;
- vertical-align: text-top;
+ background-color: #F8F7F7;
+ border-bottom: 1px solid #6F7777;
+ border-left: 1px solid #C4CCCC;
+ border-right: 1px solid #6F7777;
+ border-top: 1px solid #C4CCCC;
+ color: #234;
+ font-weight: 700;
+ vertical-align: text-top;
}
+
.formtextinput {
- background-color: #FFF;
- border: 1px solid #c4cccc;
- font-size: 116%;
- font-weight: 400;
- vertical-align: top;
-}
-div#content table {
- clear: right;
+ background-color: #FFF;
+ border: 1px solid #C4CCCC;
+ font-size: 116%;
+ font-weight: 400;
+ vertical-align: top;
}
-#body-main h1.pageheading {
- margin: 40px 0 10px;
+
+#content table {
+ clear: right;
}
+
.content-section {
- margin-top: 15px;
+ margin-top: 15px;
}
+
.content-section h1 {
- margin: 0 0 10px;
+ margin: 0 0 10px;
}
+
.content-section p {
- margin: 0 0 5px;
- padding-left: 12px;
+ margin: 0 0 5px;
+ padding-left: 12px;
}
+
.content-section .pubdate {
- color: #696969;
- margin: 0 0 8px;
- padding: 0 0 0 12px;
+ color: #696969;
+ margin: 0 0 8px;
+ padding: 0 0 0 12px;
}
+
blockquote {
- border-left: 1px solid #ccc;
- margin-left: 1em;
- padding-left: 1em;
-}
-#utility-menu dl {
- font-size: 80%;
- font-weight: 700;
- text-align: right;
-}
-#utility-menu dd {
- display: inline;
- font-weight: 400;
- margin: 0;
- padding: 0 0 0 8px;
-}
-#utility-menu dd a {
- color: #888;
- margin: 0;
- padding: 0;
-}
-#utility-menu dt {
- margin: 0;
+ border-left: 1px solid #CCC;
+ margin-left: 1em;
+ padding-left: 1em;
}
+
#footer {
- bottom: 0;
- clear: both;
- font-size: x-small;
- margin: 2em 0 0;
- padding: 0 1em 1em 1em;
- vertical-align: top;
- background-color: #F3F3F3;
- border-top: 1px solid #DDD;
-}
-#footer div {
- padding-top: 1em;
+ bottom: 0;
+ clear: both;
+ font-size: x-small;
+ margin: 2em 0 0 0;
+ padding: 0;
+ color: #888;
}
#searchbox a.reference, #searchbox span.reference {
- color: #339;
- font-size: 85%;
- font-weight: 400;
- position: absolute;
- right: 8.3em;
- text-decoration: none;
- top: 2.9em;
-}
-#content {
- font-size: 115%;
- min-height: 500px;
+ color: #339;
+ font-size: 85%;
+ font-weight: 400;
+ position: absolute;
+ right: 8.3em;
+ text-decoration: none;
+ top: 2.9em;
}
-#body-main .success p {
- margin: 4px 8px;
+
+#topbar {
+ line-height: 1em;
+ border-bottom: 1px solid #EEE;
}
-body {
- background: #FFF;
- color: #000;
- margin: 0;
+
+@media print {
+ #topbar {
+ color: #000;
+ margin: 0.25em auto 0.25em auto;
+ padding: 0.25em 0.5em 0.5em 0.5em;
+ max-width: 60em;
+ position: relative;
+ }
+
+ #contentsbox {
+ display: none;
+ }
+
+ #topbar a, #title a, #topbar a:visited, #title a:visited {
+ color: #000;
+ }
+
+ #contents {
+ display: none;
+ }
}
-:link {
- background: transparent;
- color: #00C;
+
+@media screen {
+ #topbar {
+ margin: 0.25em auto 0.25em auto;
+ padding: 0;
+ max-width: 60em;
+ position: relative;
+ }
+
+ #contentsbox {
+ color: #546E00;
+ font-size: small;
+ margin: 0 0 1.5em 0;
+ }
+
+ #contents {
+ display: inline;
+ padding: 0;
+ }
+
+ #contents li {
+ display: inline;
+ list-style-type: none;
+ margin-left: 0;
+ margin-right: 0.5em;
+ padding: 0.25ex 0.25ex 0.25ex 0;
+ }
}
-:visited {
- background: transparent;
- color: #609;
+
+#content {
+ clear: both;
+ padding: 0;
+ max-width: 60em;
+ margin-left: auto;
+ margin-right: auto;
}
-a:active {
- background: transparent;
- color: #C00;
+
+.section {
+ clear: right;
+ padding: 0 0 1.5em 0;
}
-.sec {
- border-bottom: 1px dashed #CCC;
- color: #000;
- margin: 1em 1em 0.5em 1em;
- padding: 1ex 0 0.5ex 0;
+
+.category {
+ font-size: small;
+ color: #AAA;
+ float: right;
+ vertical-align: bottom;
+ padding: 0;
+ margin: 0;
+ padding-right: 0.25em;
}
-ul, ol {
- margin-top: 0;
- padding-top: 0;
- margin: 0 0 0.5ex 0;
+
+.label {
+ font-style: italic;
+ margin-top: 0.25em;
+ color: #666;
}
-.content {
- margin-left: 2em;
- margin-right: 2em;
+
+table.index {
+ border: 0;
+ line-height: 1.5em;
+ margin-top: 2em;
}
-.label {
- font-style: italic;
- margin: 1ex 0;
+
+.index ul {
+ padding-left: 1.25em;
+ margin-left: 0;
+ list-style-type: circle;
}
-.index {
- margin-left: 1em;
+
+.index ul li {
+ padding-left: 0;
+ color: #888;
}
+
.prop {
- margin: 0;
- padding: 0;
+ margin: 0;
+ padding: 0;
}
+
.description {
- margin-bottom: 0.75em;
+ margin-top: 0;
+ margin-bottom: 0.75em;
+}
+
+.blankdesc, .blankdef {
+ border-spacing: 0;
+ margin: 0;
+ padding-left: 0;
+ padding-right: 0;
}
-.blankdesc {
- margin: 0;
- padding: 0;
+
+.blankdesc tbody tr td, .blankdef {
+ border: 0 !important;
}
-.blankterm {
- padding-right: .5em;
+
+.blankdesc td {
+ padding-right: 0.5em;
+}
+
+.blankdesc tbody tr td:first-child {
+ border-left: 1px solid #BBB;
+ text-align: right;
}
+
.terminfo, .restriction {
- border-collapse: collapse;
- border-style: hidden;
+ border-collapse: collapse;
+ border-spacing: 0;
+ font-size: small;
+ color: #666;
+ border-radius: 0;
+ border-bottom-left-radius: 6px;
+}
+
+
+table.terminfo {
+ border-top: 0;
+ border-collapse: collapse;
+ margin: -1px 0 2em 2em;
+ padding: 0.25em 0 0.25em 0;
+ float: right;
+ border-bottom: 1px solid #EEE;
+ border-left: 1px solid #EEE;
+ border-bottom-left-radius: 6px;
+ max-width: 50%;
+ line-height: 1.4em;
+ min-width: 25%;
+}
+
+table.terminfo td {
+ padding: 0 0.5em;
}
+
.restriction {
- margin: 0 0 0.5ex 0;
- padding: 0;
- vertical-align: text-top;
+ border-style: hidden;
+ margin: 0 0 0.5ex 0;
+ padding: 0;
+ vertical-align: text-top;
}
+
.restriction td {
- vertical-align: text-top;
+ vertical-align: text-top;
}
+
.terminfo th {
- padding: 0 1ex 0 0;
+ padding: 0 0.5em;
+ text-align: right;
+ vertical-align: top;
}
+
.specterm {
- background-color: #FBFBFB;
- border: 0;
- border: 1px solid #CCC;
- margin: 0;
- padding: 0;
- margin-bottom: 1em;
+ border: 0;
+ margin: 0;
+ padding: 1em 0;
+ clear: both;
}
+
.specterm h3 {
- padding: 0.5ex;
- margin: 0;
- border-bottom: 1px solid #DDD;
- background-color: #F3F3F3;
+ display: inline-block;
+ margin-bottom: 0.25em;
+ width: 80%;
+}
+
+.spectermtype {
+ color: #888;
+ display: inline-block;
+ font-size: small;
+ font-style: italic;
+ box-sizing: border-box;
+ margin: 0;
+ padding: 0 0.25em 0 0;
+ text-align: right;
+ vertical-align: bottom;
+ width: 20%;
}
+
.spectermbody {
- padding: 0 1em 1ex 1em;
+ border-top: 1px solid #EEE;
+ padding: 0;
}
-dl {
- margin: 0;
- padding: 0;
+
+.spectermbody .description .comment > p:first-child {
+ color: #444;
+ font-style: italic;
+ margin-bottom: 0.75em;
}
-dt {
- font-weight: 700;
- margin-top: .75ex;
+
+dl {
+ margin: 0;
+ padding: 0;
}
+
hr {
- background-color: silver;
- border: 0;
- color: gray;
- height: 1px;
- margin-bottom: 1.5ex;
- margin-top: 1.5ex;
+ background-color: #EEE;
+ border: 0;
+ color: gray;
+ height: 1px;
+ margin-bottom: 1.5ex;
+ margin-top: 1.5ex;
}
+
div.head {
- margin-bottom: 1em;
+ margin-bottom: 1em;
}
+
div.head h1 {
- clear: both;
- margin-top: 2em;
+ clear: both;
+ margin-top: 2em;
}
+
div.head table {
- margin-left: 2em;
- margin-top: 2em;
-}
-table {
- border-collapse: collapse;
- border-style: hidden;
- margin: 0;
-}
-th {
- vertical-align: text-top;
-}
-td, th {
- border: 1px dashed #ccc;
- padding: 0.3ex 0.5em 0.3ex 0.5em;
-}
-#meta {
- margin: 1ex 0 0 0.5ex;
- font-size: small;
-}
-#meta tr th {
- padding-left: 0;
+ margin-left: 2em;
+ margin-top: 2em;
}
-pre {
- margin: 1em 1em 1em 4em;
- padding: 0;
-}
-code {
- color: #373;
- font-family: fixed,monospace;
- font-weight: 500;
-}
-#menu li, #searchbox form, ul#iconbar li, #body-main .success p a {
- display: inline;
-}
-#menu ul.level-one a:hover, #menu ul.level-two a:hover, #menu ul.level-three a:hover, #left-hand-navigation h4 a:hover {
- color: #000;
- text-decoration: underline;
-}
-h1, h2, h3, h4, h5, h6, th {
- text-align: left;
+
+#menu li {
+ display: inline;
}
+
.error {
- color: red;
- font-weight: bold;
+ color: #990A1B;
}
+
.warning {
- color: orange;
- font-weight: bold;
+ color: #7B6000;
}
+
.success {
- color: green;
- font-weight: bold;
-}
-
-/* Pygments Style */
-.hll { background-color: #ffffcc }
-.c { color: #408080; font-style: italic } /* Comment */
-.err { border: 1px solid #FF0000 } /* Error */
-.k { color: #BB712B; } /* Keyword */
-.o { color: #666666 } /* Operator */
-.cm { color: #408080; font-style: italic } /* Comment.Multiline */
-.cp { color: #D33682 } /* Comment.Preproc */
-.c1 { color: #408080; font-style: italic } /* Comment.Single */
-.cs { color: #408080; font-style: italic } /* Comment.Special */
-.gd { color: #A00000 } /* Generic.Deleted */
-.ge { font-style: italic } /* Generic.Emph */
-.gr { color: #FF0000 } /* Generic.Error */
-.gh { color: #000080; font-weight: bold } /* Generic.Heading */
-.gi { color: #00A000 } /* Generic.Inserted */
-.go { color: #808080 } /* Generic.Output */
-.gp { color: #000080; font-weight: bold } /* Generic.Prompt */
-.gs { font-weight: bold } /* Generic.Strong */
-.gu { color: #800080; font-weight: bold } /* Generic.Subheading */
-.gt { color: #0040D0 } /* Generic.Traceback */
-.kc { color: #008000; font-weight: bold } /* Keyword.Constant */
-.kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
-.kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
-.kp { color: #008000 } /* Keyword.Pseudo */
-.kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
-.kt { color: #3E873E } /* Keyword.Type */
-.m { color: #666666 } /* Literal.Number */
-.s { color: #BA2121 } /* Literal.String */
-.na { color: #7D9029 } /* Name.Attribute */
-.nb { color: #008000 } /* Name.Builtin */
-.nc { color: #000000; font-weight: bold } /* Name.Class */
-.no { color: #880000 } /* Name.Constant */
-.nd { color: #AA22FF } /* Name.Decorator */
-.ni { color: #999999; font-weight: bold } /* Name.Entity */
-.ne { color: #D2413A; font-weight: bold } /* Name.Exception */
-.nf { color: #222222; font-weight: bold } /* Name.Function */
-.nl { color: #A0A000 } /* Name.Label */
-.nn { color: #000000 } /* Name.Namespace */
-.nt { color: #334433; } /* Name.Tag */
-.nv { color: #19177C } /* Name.Variable */
-.ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
-.w { color: #bbbbbb } /* Text.Whitespace */
-.mf { color: #666666 } /* Literal.Number.Float */
-.mh { color: #666666 } /* Literal.Number.Hex */
-.mi { color: #666666 } /* Literal.Number.Integer */
-.mo { color: #666666 } /* Literal.Number.Oct */
-.sb { color: #BA2121 } /* Literal.String.Backtick */
-.sc { color: #BA2121 } /* Literal.String.Char */
-.sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
-.s2 { color: #BA2121 } /* Literal.String.Double */
-.se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
-.sh { color: #BA2121 } /* Literal.String.Heredoc */
-.si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
-.sx { color: #008000 } /* Literal.String.Other */
-.sr { color: #BB6688 } /* Literal.String.Regex */
-.s1 { color: #BA2121 } /* Literal.String.Single */
-.ss { color: #19177C } /* Literal.String.Symbol */
-.bp { color: #008000 } /* Name.Builtin.Pseudo */
-.vc { color: #19177C } /* Name.Variable.Class */
-.vg { color: #19177C } /* Name.Variable.Global */
-.vi { color: #19177C } /* Name.Variable.Instance */
-.il { color: #666666 } /* Literal.Number.Integer.Long */
-.p { color: #999999 } /* Punctuation */
+ color: #546E00;
+}
+
+.highlight, .codehilite {
+ margin-left: 2em;
+}
diff --git a/lv2/atom/atom-test-utils.c b/lv2/atom/atom-test-utils.c
new file mode 100644
index 0000000..057dada
--- /dev/null
+++ b/lv2/atom/atom-test-utils.c
@@ -0,0 +1,71 @@
+/*
+ Copyright 2012-2018 David Robillard <http://drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#include "lv2/atom/atom.h"
+#include "lv2/atom/forge.h"
+#include "lv2/atom/util.h"
+#include "lv2/urid/urid.h"
+
+#include <stdarg.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+char** uris = NULL;
+uint32_t n_uris = 0;
+
+static char*
+copy_string(const char* str)
+{
+ const size_t len = strlen(str);
+ char* dup = (char*)malloc(len + 1);
+ memcpy(dup, str, len + 1);
+ return dup;
+}
+
+static LV2_URID
+urid_map(LV2_URID_Map_Handle handle, const char* uri)
+{
+ for (uint32_t i = 0; i < n_uris; ++i) {
+ if (!strcmp(uris[i], uri)) {
+ return i + 1;
+ }
+ }
+
+ uris = (char**)realloc(uris, ++n_uris * sizeof(char*));
+ uris[n_uris - 1] = copy_string(uri);
+ return n_uris;
+}
+
+static void
+free_urid_map(void)
+{
+ for (uint32_t i = 0; i < n_uris; ++i) {
+ free(uris[i]);
+ }
+
+ free(uris);
+}
+
+static int
+test_fail(const char* fmt, ...)
+{
+ va_list args;
+ va_start(args, fmt);
+ fprintf(stderr, "error: ");
+ vfprintf(stderr, fmt, args);
+ va_end(args);
+ return 1;
+}
diff --git a/lv2/lv2plug.in/ns/ext/atom/atom-test.c b/lv2/atom/atom-test.c
index 3159156..5189d9d 100644
--- a/lv2/lv2plug.in/ns/ext/atom/atom-test.c
+++ b/lv2/atom/atom-test.c
@@ -1,5 +1,5 @@
/*
- Copyright 2012 David Robillard <http://drobilla.net>
+ Copyright 2012-2015 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -14,49 +14,14 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-#include <stdarg.h>
-#include <stdio.h>
-#include <stdlib.h>
-
-#include "lv2/lv2plug.in/ns/ext/atom/forge.h"
-#include "lv2/lv2plug.in/ns/ext/atom/util.h"
-
-char** uris = NULL;
-size_t n_uris = 0;
-
-static char*
-copy_string(const char* str)
-{
- const size_t len = strlen(str);
- char* dup = (char*)malloc(len + 1);
- memcpy(dup, str, len + 1);
- return dup;
-}
-
-static LV2_URID
-urid_map(LV2_URID_Map_Handle handle, const char* uri)
-{
- for (size_t i = 0; i < n_uris; ++i) {
- if (!strcmp(uris[i], uri)) {
- return i + 1;
- }
- }
-
- uris = (char**)realloc(uris, ++n_uris * sizeof(char*));
- uris[n_uris - 1] = copy_string(uri);
- return n_uris;
-}
+#include "lv2/atom/atom-test-utils.c"
+#include "lv2/atom/atom.h"
+#include "lv2/atom/forge.h"
+#include "lv2/atom/util.h"
+#include "lv2/urid/urid.h"
-static int
-test_fail(const char* fmt, ...)
-{
- va_list args;
- va_start(args, fmt);
- fprintf(stderr, "error: ");
- vfprintf(stderr, fmt, args);
- va_end(args);
- return 1;
-}
+#include <stdint.h>
+#include <stdlib.h>
int
main(void)
@@ -90,10 +55,10 @@ main(void)
LV2_Atom_Forge_Frame obj_frame;
LV2_Atom* obj = lv2_atom_forge_deref(
- &forge, lv2_atom_forge_resource(&forge, &obj_frame, 0, eg_Object));
+ &forge, lv2_atom_forge_object(&forge, &obj_frame, 0, eg_Object));
// eg_one = (Int)1
- lv2_atom_forge_property_head(&forge, eg_one, 0);
+ lv2_atom_forge_key(&forge, eg_one);
LV2_Atom_Int* one = (LV2_Atom_Int*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_int(&forge, 1));
if (one->body != 1) {
@@ -101,7 +66,7 @@ main(void)
}
// eg_two = (Long)2
- lv2_atom_forge_property_head(&forge, eg_two, 0);
+ lv2_atom_forge_key(&forge, eg_two);
LV2_Atom_Long* two = (LV2_Atom_Long*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_long(&forge, 2));
if (two->body != 2) {
@@ -109,7 +74,7 @@ main(void)
}
// eg_three = (Float)3.0
- lv2_atom_forge_property_head(&forge, eg_three, 0);
+ lv2_atom_forge_key(&forge, eg_three);
LV2_Atom_Float* three = (LV2_Atom_Float*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_float(&forge, 3.0f));
if (three->body != 3) {
@@ -117,7 +82,7 @@ main(void)
}
// eg_four = (Double)4.0
- lv2_atom_forge_property_head(&forge, eg_four, 0);
+ lv2_atom_forge_key(&forge, eg_four);
LV2_Atom_Double* four = (LV2_Atom_Double*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_double(&forge, 4.0));
if (four->body != 4) {
@@ -125,7 +90,7 @@ main(void)
}
// eg_true = (Bool)1
- lv2_atom_forge_property_head(&forge, eg_true, 0);
+ lv2_atom_forge_key(&forge, eg_true);
LV2_Atom_Bool* t = (LV2_Atom_Bool*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_bool(&forge, true));
if (t->body != 1) {
@@ -133,7 +98,7 @@ main(void)
}
// eg_false = (Bool)0
- lv2_atom_forge_property_head(&forge, eg_false, 0);
+ lv2_atom_forge_key(&forge, eg_false);
LV2_Atom_Bool* f = (LV2_Atom_Bool*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_bool(&forge, false));
if (f->body != 0) {
@@ -141,9 +106,9 @@ main(void)
}
// eg_path = (Path)"/foo/bar"
- const char* pstr = "/foo/bar";
- const size_t pstr_len = strlen(pstr);
- lv2_atom_forge_property_head(&forge, eg_path, 0);
+ const char* pstr = "/foo/bar";
+ const uint32_t pstr_len = (uint32_t)strlen(pstr);
+ lv2_atom_forge_key(&forge, eg_path);
LV2_Atom_String* path = (LV2_Atom_String*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_uri(&forge, pstr, pstr_len));
char* pbody = (char*)LV2_ATOM_BODY(path);
@@ -152,9 +117,9 @@ main(void)
}
// eg_uri = (URI)"http://example.org/value"
- const char* ustr = "http://example.org/value";
- const size_t ustr_len = strlen(ustr);
- lv2_atom_forge_property_head(&forge, eg_uri, 0);
+ const char* ustr = "http://example.org/value";
+ const uint32_t ustr_len = (uint32_t)strlen(ustr);
+ lv2_atom_forge_key(&forge, eg_uri);
LV2_Atom_String* uri = (LV2_Atom_String*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_uri(&forge, ustr, ustr_len));
char* ubody = (char*)LV2_ATOM_BODY(uri);
@@ -164,7 +129,7 @@ main(void)
// eg_urid = (URID)"http://example.org/value"
LV2_URID eg_value = urid_map(NULL, "http://example.org/value");
- lv2_atom_forge_property_head(&forge, eg_urid, 0);
+ lv2_atom_forge_key(&forge, eg_urid);
LV2_Atom_URID* urid = (LV2_Atom_URID*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_urid(&forge, eg_value));
if (urid->body != eg_value) {
@@ -172,7 +137,7 @@ main(void)
}
// eg_string = (String)"hello"
- lv2_atom_forge_property_head(&forge, eg_string, 0);
+ lv2_atom_forge_key(&forge, eg_string);
LV2_Atom_String* string = (LV2_Atom_String*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_string(
&forge, "hello", strlen("hello")));
@@ -182,7 +147,7 @@ main(void)
}
// eg_literal = (Literal)"hello"@fr
- lv2_atom_forge_property_head(&forge, eg_literal, 0);
+ lv2_atom_forge_key(&forge, eg_literal);
LV2_Atom_Literal* literal = (LV2_Atom_Literal*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_literal(
&forge, "bonjour", strlen("bonjour"),
@@ -193,7 +158,7 @@ main(void)
}
// eg_tuple = "foo",true
- lv2_atom_forge_property_head(&forge, eg_tuple, 0);
+ lv2_atom_forge_key(&forge, eg_tuple);
LV2_Atom_Forge_Frame tuple_frame;
LV2_Atom_Tuple* tuple = (LV2_Atom_Tuple*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_tuple(&forge, &tuple_frame));
@@ -225,7 +190,7 @@ main(void)
}
// eg_vector = (Vector<Int>)1,2,3,4
- lv2_atom_forge_property_head(&forge, eg_vector, 0);
+ lv2_atom_forge_key(&forge, eg_vector);
int32_t elems[] = { 1, 2, 3, 4 };
LV2_Atom_Vector* vector = (LV2_Atom_Vector*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_vector(
@@ -236,7 +201,7 @@ main(void)
}
// eg_vector2 = (Vector<Int>)1,2,3,4
- lv2_atom_forge_property_head(&forge, eg_vector2, 0);
+ lv2_atom_forge_key(&forge, eg_vector2);
LV2_Atom_Forge_Frame vec_frame;
LV2_Atom_Vector* vector2 = (LV2_Atom_Vector*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_vector_head(
@@ -250,7 +215,7 @@ main(void)
}
// eg_seq = (Sequence)1, 2
- lv2_atom_forge_property_head(&forge, eg_seq, 0);
+ lv2_atom_forge_key(&forge, eg_seq);
LV2_Atom_Forge_Frame seq_frame;
LV2_Atom_Sequence* seq = (LV2_Atom_Sequence*)lv2_atom_forge_deref(
&forge, lv2_atom_forge_sequence_head(&forge, &seq_frame, 0));
@@ -284,7 +249,7 @@ main(void)
++n_events;
}
- unsigned n_props = 0;
+ int n_props = 0;
LV2_ATOM_OBJECT_FOREACH((LV2_Atom_Object*)obj, prop) {
if (!prop->key) {
return test_fail("Corrupt property %u has no key\n", n_props);
@@ -338,7 +303,7 @@ main(void)
LV2_ATOM_OBJECT_QUERY_END
};
- unsigned n_matches = lv2_atom_object_query((LV2_Atom_Object*)obj, q);
+ int n_matches = lv2_atom_object_query((LV2_Atom_Object*)obj, q);
for (int n = 0; n < 2; ++n) {
if (n_matches != n_props) {
return test_fail("Query failed, %u matches != %u\n",
@@ -392,6 +357,7 @@ main(void)
0);
}
- printf("All tests passed.\n");
+ free_urid_map();
+
return 0;
}
diff --git a/lv2/lv2plug.in/ns/ext/atom/atom.h b/lv2/atom/atom.h
index 8169167..8c0f30a 100644
--- a/lv2/lv2plug.in/ns/ext/atom/atom.h
+++ b/lv2/atom/atom.h
@@ -1,5 +1,5 @@
/*
- Copyright 2008-2012 David Robillard <http://drobilla.net>
+ Copyright 2008-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -15,65 +15,72 @@
*/
/**
- @file atom.h C header for the LV2 Atom extension
- <http://lv2plug.in/ns/ext/atom>.
+ @defgroup atom Atom
+ @ingroup lv2
+
+ A generic value container and several data types, see
+ <http://lv2plug.in/ns/ext/atom> for details.
+
+ @{
*/
#ifndef LV2_ATOM_H
#define LV2_ATOM_H
-#include <stdint.h>
#include <stddef.h>
+#include <stdint.h>
-#define LV2_ATOM_URI "http://lv2plug.in/ns/ext/atom"
-#define LV2_ATOM_PREFIX LV2_ATOM_URI "#"
-
-#define LV2_ATOM__Atom LV2_ATOM_PREFIX "Atom"
-#define LV2_ATOM__AtomPort LV2_ATOM_PREFIX "AtomPort"
-#define LV2_ATOM__Blank LV2_ATOM_PREFIX "Blank"
-#define LV2_ATOM__Bool LV2_ATOM_PREFIX "Bool"
-#define LV2_ATOM__Chunk LV2_ATOM_PREFIX "Chunk"
-#define LV2_ATOM__Double LV2_ATOM_PREFIX "Double"
-#define LV2_ATOM__Event LV2_ATOM_PREFIX "Event"
-#define LV2_ATOM__Float LV2_ATOM_PREFIX "Float"
-#define LV2_ATOM__Int LV2_ATOM_PREFIX "Int"
-#define LV2_ATOM__Literal LV2_ATOM_PREFIX "Literal"
-#define LV2_ATOM__Long LV2_ATOM_PREFIX "Long"
-#define LV2_ATOM__Number LV2_ATOM_PREFIX "Number"
-#define LV2_ATOM__Object LV2_ATOM_PREFIX "Object"
-#define LV2_ATOM__Path LV2_ATOM_PREFIX "Path"
-#define LV2_ATOM__Property LV2_ATOM_PREFIX "Property"
-#define LV2_ATOM__Resource LV2_ATOM_PREFIX "Resource"
-#define LV2_ATOM__Sequence LV2_ATOM_PREFIX "Sequence"
-#define LV2_ATOM__Sound LV2_ATOM_PREFIX "Sound"
-#define LV2_ATOM__String LV2_ATOM_PREFIX "String"
-#define LV2_ATOM__Tuple LV2_ATOM_PREFIX "Tuple"
-#define LV2_ATOM__URI LV2_ATOM_PREFIX "URI"
-#define LV2_ATOM__URID LV2_ATOM_PREFIX "URID"
-#define LV2_ATOM__Vector LV2_ATOM_PREFIX "Vector"
-#define LV2_ATOM__atomTransfer LV2_ATOM_PREFIX "atomTransfer"
-#define LV2_ATOM__beatTime LV2_ATOM_PREFIX "beatTime"
-#define LV2_ATOM__bufferType LV2_ATOM_PREFIX "bufferType"
-#define LV2_ATOM__childType LV2_ATOM_PREFIX "childType"
-#define LV2_ATOM__eventTransfer LV2_ATOM_PREFIX "eventTransfer"
-#define LV2_ATOM__frameTime LV2_ATOM_PREFIX "frameTime"
-#define LV2_ATOM__supports LV2_ATOM_PREFIX "supports"
-#define LV2_ATOM__timeUnit LV2_ATOM_PREFIX "timeUnit"
-
-#define LV2_ATOM_REFERENCE_TYPE 0
+#define LV2_ATOM_URI "http://lv2plug.in/ns/ext/atom" ///< http://lv2plug.in/ns/ext/atom
+#define LV2_ATOM_PREFIX LV2_ATOM_URI "#" ///< http://lv2plug.in/ns/ext/atom#
+
+#define LV2_ATOM__Atom LV2_ATOM_PREFIX "Atom" ///< http://lv2plug.in/ns/ext/atom#Atom
+#define LV2_ATOM__AtomPort LV2_ATOM_PREFIX "AtomPort" ///< http://lv2plug.in/ns/ext/atom#AtomPort
+#define LV2_ATOM__Blank LV2_ATOM_PREFIX "Blank" ///< http://lv2plug.in/ns/ext/atom#Blank
+#define LV2_ATOM__Bool LV2_ATOM_PREFIX "Bool" ///< http://lv2plug.in/ns/ext/atom#Bool
+#define LV2_ATOM__Chunk LV2_ATOM_PREFIX "Chunk" ///< http://lv2plug.in/ns/ext/atom#Chunk
+#define LV2_ATOM__Double LV2_ATOM_PREFIX "Double" ///< http://lv2plug.in/ns/ext/atom#Double
+#define LV2_ATOM__Event LV2_ATOM_PREFIX "Event" ///< http://lv2plug.in/ns/ext/atom#Event
+#define LV2_ATOM__Float LV2_ATOM_PREFIX "Float" ///< http://lv2plug.in/ns/ext/atom#Float
+#define LV2_ATOM__Int LV2_ATOM_PREFIX "Int" ///< http://lv2plug.in/ns/ext/atom#Int
+#define LV2_ATOM__Literal LV2_ATOM_PREFIX "Literal" ///< http://lv2plug.in/ns/ext/atom#Literal
+#define LV2_ATOM__Long LV2_ATOM_PREFIX "Long" ///< http://lv2plug.in/ns/ext/atom#Long
+#define LV2_ATOM__Number LV2_ATOM_PREFIX "Number" ///< http://lv2plug.in/ns/ext/atom#Number
+#define LV2_ATOM__Object LV2_ATOM_PREFIX "Object" ///< http://lv2plug.in/ns/ext/atom#Object
+#define LV2_ATOM__Path LV2_ATOM_PREFIX "Path" ///< http://lv2plug.in/ns/ext/atom#Path
+#define LV2_ATOM__Property LV2_ATOM_PREFIX "Property" ///< http://lv2plug.in/ns/ext/atom#Property
+#define LV2_ATOM__Resource LV2_ATOM_PREFIX "Resource" ///< http://lv2plug.in/ns/ext/atom#Resource
+#define LV2_ATOM__Sequence LV2_ATOM_PREFIX "Sequence" ///< http://lv2plug.in/ns/ext/atom#Sequence
+#define LV2_ATOM__Sound LV2_ATOM_PREFIX "Sound" ///< http://lv2plug.in/ns/ext/atom#Sound
+#define LV2_ATOM__String LV2_ATOM_PREFIX "String" ///< http://lv2plug.in/ns/ext/atom#String
+#define LV2_ATOM__Tuple LV2_ATOM_PREFIX "Tuple" ///< http://lv2plug.in/ns/ext/atom#Tuple
+#define LV2_ATOM__URI LV2_ATOM_PREFIX "URI" ///< http://lv2plug.in/ns/ext/atom#URI
+#define LV2_ATOM__URID LV2_ATOM_PREFIX "URID" ///< http://lv2plug.in/ns/ext/atom#URID
+#define LV2_ATOM__Vector LV2_ATOM_PREFIX "Vector" ///< http://lv2plug.in/ns/ext/atom#Vector
+#define LV2_ATOM__atomTransfer LV2_ATOM_PREFIX "atomTransfer" ///< http://lv2plug.in/ns/ext/atom#atomTransfer
+#define LV2_ATOM__beatTime LV2_ATOM_PREFIX "beatTime" ///< http://lv2plug.in/ns/ext/atom#beatTime
+#define LV2_ATOM__bufferType LV2_ATOM_PREFIX "bufferType" ///< http://lv2plug.in/ns/ext/atom#bufferType
+#define LV2_ATOM__childType LV2_ATOM_PREFIX "childType" ///< http://lv2plug.in/ns/ext/atom#childType
+#define LV2_ATOM__eventTransfer LV2_ATOM_PREFIX "eventTransfer" ///< http://lv2plug.in/ns/ext/atom#eventTransfer
+#define LV2_ATOM__frameTime LV2_ATOM_PREFIX "frameTime" ///< http://lv2plug.in/ns/ext/atom#frameTime
+#define LV2_ATOM__supports LV2_ATOM_PREFIX "supports" ///< http://lv2plug.in/ns/ext/atom#supports
+#define LV2_ATOM__timeUnit LV2_ATOM_PREFIX "timeUnit" ///< http://lv2plug.in/ns/ext/atom#timeUnit
+
+#define LV2_ATOM_REFERENCE_TYPE 0 ///< The special type for a reference atom
#ifdef __cplusplus
extern "C" {
#endif
+/** @cond */
/** This expression will fail to compile if double does not fit in 64 bits. */
typedef char lv2_atom_assert_double_fits_in_64_bits[
((sizeof(double) <= sizeof(uint64_t)) * 2) - 1];
+/** @endcond */
/**
Return a pointer to the contents of an Atom. The "contents" of an atom
is the data past the complete type-specific header.
- @param type The type of the atom, e.g. LV2_Atom_String.
+ @param type The type of the atom, for example LV2_Atom_String.
@param atom A variable-sized atom.
*/
#define LV2_ATOM_CONTENTS(type, atom) \
@@ -173,7 +180,7 @@ typedef struct {
LV2_Atom_Vector_Body body; /**< Body. */
} LV2_Atom_Vector;
-/** The body of an atom:Property (e.g. in an atom:Object). */
+/** The body of an atom:Property (typically in an atom:Object). */
typedef struct {
uint32_t key; /**< Key (predicate) (mapped URI). */
uint32_t context; /**< Context URID (may be, and generally is, 0). */
@@ -189,7 +196,7 @@ typedef struct {
/** The body of an atom:Object. May be cast to LV2_Atom. */
typedef struct {
- uint32_t id; /**< URID (atom:Resource) or blank ID (atom:Blank). */
+ uint32_t id; /**< URID, or 0 for blank. */
uint32_t otype; /**< Type URID (same as rdf:type, for fast dispatch). */
/* Contents (a series of property bodies) follow here. */
} LV2_Atom_Object_Body;
@@ -219,7 +226,7 @@ typedef struct {
LV2_Descriptor::run(), the default stamp type is audio frames.
The contents of a sequence is a series of LV2_Atom_Event, each aligned
- to 64-bits, e.g.:
+ to 64-bits, for example:
<pre>
| Event 1 (size 6) | Event 2
| | | | | | | | |
@@ -239,6 +246,10 @@ typedef struct {
LV2_Atom_Sequence_Body body; /**< Body. */
} LV2_Atom_Sequence;
+/**
+ @}
+*/
+
#ifdef __cplusplus
} /* extern "C" */
#endif
diff --git a/lv2/atom/atom.meta.ttl b/lv2/atom/atom.meta.ttl
new file mode 100644
index 0000000..7b04180
--- /dev/null
+++ b/lv2/atom/atom.meta.ttl
@@ -0,0 +1,542 @@
+@prefix atom: <http://lv2plug.in/ns/ext/atom#> .
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/atom>
+ a doap:Project ;
+ doap:name "LV2 Atom" ;
+ doap:shortdesc "A generic value container and several data types." ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ doap:created "2007-00-00" ;
+ doap:developer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "2.2" ;
+ doap:created "2019-02-03" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.16.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add lv2_atom_object_get_typed() for easy type-safe access to object properties."
+ ]
+ ]
+ ] , [
+ doap:revision "2.0" ;
+ doap:created "2014-08-08" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.10.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Deprecate Blank and Resource in favour of just Object."
+ ] , [
+ rdfs:label "Add lv2_atom_forge_is_object_type() and lv2_atom_forge_is_blank() to ease backwards compatibility."
+ ] , [
+ rdfs:label "Add lv2_atom_forge_key() for terser object writing."
+ ] , [
+ rdfs:label "Add lv2_atom_sequence_clear() and lv2_atom_sequence_append_event() helper functions."
+ ]
+ ]
+ ] , [
+ doap:revision "1.8" ;
+ doap:created "2014-01-04" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.8.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Make lv2_atom_*_is_end() arguments const."
+ ]
+ ]
+ ] , [
+ doap:revision "1.6" ;
+ doap:created "2013-05-26" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.6.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix crash in forge.h when pushing atoms to a full buffer."
+ ]
+ ]
+ ] , [
+ doap:revision "1.4" ;
+ doap:created "2013-01-27" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix lv2_atom_sequence_end()."
+ ] , [
+ rdfs:label "Remove atom:stringType in favour of owl:onDatatype so generic tools can understand and validate atom literals."
+ ] , [
+ rdfs:label "Improve atom documentation."
+ ]
+ ]
+ ] , [
+ doap:revision "1.2" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix implicit conversions in forge.h that are invalid in C++11."
+ ] , [
+ rdfs:label "Fix lv2_atom_object_next() on 32-bit platforms."
+ ] , [
+ rdfs:label "Add lv2_atom_object_body_get()."
+ ] , [
+ rdfs:label "Fix outdated documentation in forge.h."
+ ] , [
+ rdfs:label "Use consistent label style."
+ ] , [
+ rdfs:label "Add LV2_ATOM_CONTENTS_CONST and LV2_ATOM_BODY_CONST."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+An atom:Atom is a simple generic data container for holding any type of Plain
+Old Data (POD). An Atom can contain simple primitive types like integers,
+floating point numbers, and strings; as well as structured data like lists and
+dictionary-like <q>Objects</q>. Since Atoms are POD, they can be easily copied
+(for example, with `memcpy()`) anywhere and are suitable for use in real-time
+code.
+
+Every atom starts with an LV2_Atom header, followed by the contents. This
+allows code to process atoms without requiring special code for every type of
+data. For example, plugins that mutually understand a type can be used
+together in a host that does not understand that type, because the host is only
+required to copy atoms, not interpret their contents. Similarly, plugins (such
+as routers, delays, or data structures) can meaningfully process atoms of a
+type unknown to them.
+
+Atoms should be used anywhere values of various types must be stored or
+transmitted. An atom:AtomPort can be used to transmit atoms via ports. An
+atom:AtomPort that contains a atom:Sequence can be used for sample accurate
+communication of events, such as MIDI.
+
+### Serialisation
+
+Each Atom type defines a binary format for use at runtime, but also a
+serialisation that is natural to express in Turtle format. Thus, this
+specification defines a powerful real-time appropriate data model, as well as a
+portable way to serialise any data in that model. This is particularly useful
+for inter-process communication, saving/restoring state, and describing values
+in plugin data files.
+
+### Custom Atom Types
+
+While it is possible to define new Atom types for any binary format, the
+standard types defined here are powerful enough to describe almost anything.
+Implementations SHOULD build structures out of the types provided here, rather
+than define new binary formats (for example, using atom:Object rather than a
+new C `struct` type). Host and tool implementations have support for
+serialising all standard types, so new binary formats are an implementation
+burden which harms interoperabilty. In particular, plugins SHOULD NOT expect
+UI communication or state saving with custom binary types to work. In general,
+new Atom types should only be defined where absolutely necessary due to
+performance reasons and serialisation is not a concern.
+
+"""^^lv2:Markdown .
+
+atom:Atom
+ lv2:documentation """
+
+An LV2_Atom has a 32-bit `size` and `type`, followed by a body of `size` bytes.
+Atoms MUST be 64-bit aligned.
+
+All concrete Atom types (subclasses of this class) MUST define a precise binary
+layout for their body.
+
+The `type` field is the URI of an Atom type mapped to an integer.
+Implementations SHOULD gracefully pass through, or ignore, atoms with unknown
+types.
+
+All atoms are POD by definition except references, which as a special case have
+`type` 0. An Atom MUST NOT contain a Reference. It is safe to copy any
+non-reference Atom with a simple `memcpy`, even if the implementation does not
+understand `type`. Though this extension reserves the type 0 for references,
+the details of reference handling are currently unspecified. A future revision
+of this extension, or a different extension, may define how to use non-POD data
+and references. Implementations MUST NOT send references to another
+implementation unless the receiver is explicitly known to support references
+(e.g. by supporting a feature).
+
+The special case of a null atom with both `type` and `size` 0 is not considered
+a reference.
+
+"""^^lv2:Markdown .
+
+atom:Chunk
+ lv2:documentation """
+
+This type is used to indicate a certain amount of space is available. For
+example, output ports with a variably sized type are connected to a Chunk so
+the plugin knows the size of the buffer available for writing.
+
+The use of a Chunk should be constrained to a local scope, since
+interpreting it is impossible without context. However, if serialised to RDF,
+a Chunk may be represented directly as an xsd:base64Binary string, for example:
+
+ :::turtle
+ [] eg:someChunk "vu/erQ=="^^xsd:base64Binary .
+
+"""^^lv2:Markdown .
+
+atom:String
+ lv2:documentation """
+
+The body of an LV2_Atom_String is a C string in UTF-8 encoding, i.e. an array
+of bytes (`uint8_t`) terminated with a NULL byte (`'\\0'`).
+
+This type is for free-form strings, but SHOULD NOT be used for typed data or
+text in any language. Use atom:Literal unless translating the string does not
+make sense and the string has no meaningful datatype.
+
+"""^^lv2:Markdown .
+
+atom:Literal
+ lv2:documentation """
+
+This type is compatible with rdfs:Literal and is capable of expressing a
+string in any language or a value of any type. A Literal has a
+`datatype` and `lang` followed by string data in UTF-8
+encoding. The length of the string data in bytes is `size -
+sizeof(LV2_Atom_Literal)`, including the terminating NULL character. The
+`lang` field SHOULD be a URI of the form
+&lt;http://lexvo.org/id/iso639-3/LANG&gt; or
+&lt;http://lexvo.org/id/iso639-1/LANG&gt; where LANG is a 3-character ISO 693-3
+language code, or a 2-character ISO 693-1 language code, respectively.
+
+A Literal may have a `datatype` or a `lang`, but never both.
+
+For example, a Literal can be <q>Hello</q> in English:
+
+ :::c
+ void set_to_hello_in_english(LV2_Atom_Literal* lit) {
+ lit->atom.type = map(expand("atom:Literal"));
+ lit->atom.size = 14;
+ lit->body.datatype = 0;
+ lit->body.lang = map("http://lexvo.org/id/iso639-1/en");
+ memcpy(LV2_ATOM_CONTENTS(LV2_Atom_Literal, lit),
+ "Hello",
+ sizeof("Hello")); // Assumes enough space
+ }
+
+or a Turtle string:
+
+ :::c
+ void set_to_turtle_string(LV2_Atom_Literal* lit, const char* ttl) {
+ lit->atom.type = map(expand("atom:Literal"));
+ lit->atom.size = 64;
+ lit->body.datatype = map("http://www.w3.org/2008/turtle#turtle");
+ lit->body.lang = 0;
+ memcpy(LV2_ATOM_CONTENTS(LV2_Atom_Literal, lit),
+ ttl,
+ strlen(ttl) + 1); // Assumes enough space
+ }
+
+"""^^lv2:Markdown .
+
+atom:Path
+ lv2:documentation """
+
+A Path is a URI reference with only a path component: no scheme, authority,
+query, or fragment. In particular, paths to files in the same bundle may be
+cleanly written in Turtle files as a relative URI. However, implementations
+may assume any binary Path (e.g. in an event payload) is a valid file path
+which can passed to system functions like fopen() directly, without any
+character encoding or escape expansion required.
+
+Any implemenation that creates a Path atom to transmit to another is
+responsible for ensuring it is valid. A Path SHOULD always be absolute, unless
+there is some mechanism in place that defines a base path. Since this is not
+the case for plugin instances, effectively any Path sent to or received from a
+plugin instance MUST be absolute.
+
+"""^^lv2:Markdown .
+
+atom:URI
+ lv2:documentation """
+
+This is useful when a URI is needed but mapping is inappropriate, for example
+with temporary or relative URIs. Since the ability to distinguish URIs from
+plain strings is often necessary, URIs MUST NOT be transmitted as atom:String.
+
+This is not strictly a URI, since UTF-8 is allowed. Escaping and related
+issues are the host's responsibility.
+
+"""^^lv2:Markdown .
+
+atom:URID
+ lv2:documentation """
+
+A URID is typically generated with the LV2_URID_Map provided by the host .
+
+"""^^lv2:Markdown .
+
+atom:Vector
+ lv2:documentation """
+
+A homogeneous series of atom bodies with equivalent type and size.
+
+An LV2_Atom_Vector is a 32-bit `child_size` and `child_type` followed by `size
+/ child_size` atom bodies.
+
+For example, an atom:Vector containing 42 elements of type atom:Float:
+
+ :::c
+ struct VectorOf42Floats {
+ uint32_t size; // sizeof(LV2_Atom_Vector_Body) + (42 * sizeof(float);
+ uint32_t type; // map(expand("atom:Vector"))
+ uint32_t child_size; // sizeof(float)
+ uint32_t child_type; // map(expand("atom:Float"))
+ float elems[42];
+ };
+
+Note that it is possible to construct a valid Atom for each element of the
+vector, even by an implementation which does not understand `child_type`.
+
+If serialised to RDF, a Vector SHOULD have the form:
+
+ :::turtle
+ eg:someVector
+ a atom:Vector ;
+ atom:childType atom:Int ;
+ rdf:value (
+ "1"^^xsd:int
+ "2"^^xsd:int
+ "3"^^xsd:int
+ "4"^^xsd:int
+ ) .
+
+"""^^lv2:Markdown .
+
+atom:Tuple
+ lv2:documentation """
+
+The body of a Tuple is simply a series of complete atoms, each aligned to
+64 bits.
+
+If serialised to RDF, a Tuple SHOULD have the form:
+
+ :::turtle
+ eg:someVector
+ a atom:Tuple ;
+ rdf:value (
+ "1"^^xsd:int
+ "3.5"^^xsd:float
+ "etc"
+ ) .
+
+"""^^lv2:Markdown .
+
+atom:Property
+ lv2:documentation """
+
+An LV2_Atom_Property has a URID `key` and `context`, and an Atom `value`. This
+corresponds to an RDF Property, where the <q>key</q> is the <q>predicate</q>
+and the <q>value</q> is the object.
+
+The `context` field can be used to specify a different context for each
+property, where this is useful. Otherwise, it may be 0.
+
+Properties generally only exist as part of an atom:Object. Accordingly,
+they will typically be represented directly as properties in RDF (see
+atom:Object). If this is not possible, they may be expressed as partial
+reified statements, for example:
+
+ :::turtle
+ eg:someProperty
+ rdf:predicate eg:theKey ;
+ rdf:object eg:theValue .
+
+"""^^lv2:Markdown .
+
+atom:Object
+ lv2:documentation """
+
+An <q>Object</q> is an atom with a set of properties. This corresponds to an
+RDF Resource, and can be thought of as a dictionary with URID keys.
+
+An LV2_Atom_Object body has a uint32_t `id` and `type`, followed by a series of
+atom:Property bodies (LV2_Atom_Property_Body). The LV2_Atom_Object_Body::otype
+field is equivalent to a property with key rdf:type, but is included in the
+structure to allow for fast dispatching.
+
+Code SHOULD check for objects using lv2_atom_forge_is_object() or
+lv2_atom_forge_is_blank() if a forge is available, rather than checking the
+atom type directly. This will correctly handle the deprecated atom:Resource
+and atom:Blank types.
+
+When serialised to RDF, an Object is represented as a resource, for example:
+
+ :::turtle
+ eg:someObject
+ eg:firstPropertyKey "first property value" ;
+ eg:secondPropertyKey "first loser" ;
+ eg:andSoOn "and so on" .
+
+"""^^lv2:Markdown .
+
+atom:Resource
+ lv2:documentation """
+
+This class is deprecated. Use atom:Object directly instead.
+
+An atom:Object where the <code>id</code> field is a URID, that is, an Object
+with a URI.
+
+"""^^lv2:Markdown .
+
+atom:Blank
+ lv2:documentation """
+
+This class is deprecated. Use atom:Object with ID 0 instead.
+
+An atom:Object where the LV2_Atom_Object::id is a blank node ID (NOT a URI).
+The ID of a Blank is valid only within the context the Blank appears in. For
+ports this is the context of the associated run() call, i.e. all ports share
+the same context so outputs can contain IDs that correspond to IDs of blanks in
+the input.
+
+"""^^lv2:Markdown .
+
+atom:Sound
+ lv2:documentation """
+
+The format of a atom:Sound is the same as the buffer format for lv2:AudioPort
+(except the size may be arbitrary). An atom:Sound inherently depends on the
+sample rate, which is assumed to be known from context. Because of this,
+directly serialising an atom:Sound is probably a bad idea, use a standard
+format like WAV instead.
+
+"""^^lv2:Markdown .
+
+atom:Event
+ lv2:documentation """
+
+An Event is typically an element of an atom:Sequence. Note that this is not an Atom type since it begins with a timestamp, not an atom header.
+
+"""^^lv2:Markdown .
+
+atom:Sequence
+ lv2:documentation """
+
+A flat sequence of atom:Event, that is, a series of time-stamped Atoms.
+
+LV2_Atom_Sequence_Body.unit describes the time unit for the contained atoms.
+If the unit is known from context (e.g. run() stamps are always audio frames),
+this field may be zero. Otherwise, it SHOULD be either units:frame or
+units:beat, in which case ev.time.frames or ev.time.beats is valid,
+respectively.
+
+If serialised to RDF, a Sequence has a similar form to atom:Vector, but for
+brevity the elements may be assumed to be atom:Event, for example:
+
+ :::turtle
+ eg:someSequence
+ a atom:Sequence ;
+ rdf:value (
+ [
+ atom:frameTime 1 ;
+ rdf:value "901A01"^^midi:MidiEvent
+ ] [
+ atom:frameTime 3 ;
+ rdf:value "902B02"^^midi:MidiEvent
+ ]
+ ) .
+
+"""^^lv2:Markdown .
+
+atom:AtomPort
+ lv2:documentation """
+
+Ports of this type are connected to an LV2_Atom with a type specified by
+atom:bufferType.
+
+Output ports with a variably sized type MUST be initialised by the host before
+every run() to an atom:Chunk with size set to the available space. The plugin
+reads this size to know how much space is available for writing. In all cases,
+the plugin MUST write a complete atom (including header) to outputs. However,
+to be robust, hosts SHOULD initialise output ports to a safe sentinel (e.g. the
+null Atom) before calling run().
+
+"""^^lv2:Markdown .
+
+atom:bufferType
+ lv2:documentation """
+
+Indicates that an AtomPort may be connected to a certain Atom type. A port MAY
+support several buffer types. The host MUST NOT connect a port to an Atom with
+a type not explicitly listed with this property. The value of this property
+MUST be a sub-class of atom:Atom. For example, an input port that is connected
+directly to an LV2_Atom_Double value is described like so:
+
+ :::turtle
+ &lt;plugin&gt;
+ lv2:port [
+ a lv2:InputPort , atom:AtomPort ;
+ atom:bufferType atom:Double ;
+ ] .
+
+This property only describes the types a port may be directly connected to. It
+says nothing about the expected contents of containers. For that, use
+atom:supports.
+
+"""^^lv2:Markdown .
+
+atom:supports
+ lv2:documentation """
+
+This property is defined loosely, it may be used to indicate that anything
+<q>supports</q> an Atom type, wherever that may be useful. It applies
+<q>recursively</q> where collections are involved.
+
+In particular, this property can be used to describe which event types are
+expected by a port. For example, a port that receives MIDI events is described
+like so:
+
+ :::turtle
+ &lt;plugin&gt;
+ lv2:port [
+ a lv2:InputPort , atom:AtomPort ;
+ atom:bufferType atom:Sequence ;
+ atom:supports midi:MidiEvent ;
+ ] .
+
+"""^^lv2:Markdown .
+
+atom:eventTransfer
+ lv2:documentation """
+
+Transfer of individual events in a port buffer. Useful as the `format` for a
+LV2UI_Write_Function.
+
+This protocol applies to ports which contain events, usually in an
+atom:Sequence. The host must transfer each individual event to the recipient.
+The format of the received data is an LV2_Atom, there is no timestamp header.
+
+"""^^lv2:Markdown .
+
+atom:atomTransfer
+ lv2:documentation """
+
+Transfer of the complete atom in a port buffer. Useful as the `format` for a
+LV2UI_Write_Function.
+
+This protocol applies to atom ports. The host must transfer the complete atom
+contained in the port, including header.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/atom/atom.ttl b/lv2/atom/atom.ttl
new file mode 100644
index 0000000..ddfb430
--- /dev/null
+++ b/lv2/atom/atom.ttl
@@ -0,0 +1,247 @@
+@prefix atom: <http://lv2plug.in/ns/ext/atom#> .
+@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 ui: <http://lv2plug.in/ns/extensions/ui#> .
+@prefix units: <http://lv2plug.in/ns/extensions/units#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+<http://lv2plug.in/ns/ext/atom>
+ a owl:Ontology ;
+ rdfs:seeAlso <atom.h> ,
+ <util.h> ,
+ <forge.h> ,
+ <atom.meta.ttl> ;
+ rdfs:label "LV2 Atom" ;
+ rdfs:comment "A generic value container and several data types." .
+
+atom:cType
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ owl:FunctionalProperty ;
+ rdfs:label "C type" ;
+ rdfs:comment "The C type that describes the binary representation of an Atom type." ;
+ rdfs:domain rdfs:Class ;
+ rdfs:range lv2:Symbol .
+
+atom:Atom
+ a rdfs:Class ;
+ rdfs:label "Atom" ;
+ rdfs:comment "Abstract base class for all atoms." ;
+ atom:cType "LV2_Atom" .
+
+atom:Chunk
+ a rdfs:Class ,
+ rdfs:Datatype ;
+ rdfs:subClassOf atom:Atom ;
+ rdfs:label "Chunk" ;
+ rdfs:comment "A chunk of memory with undefined contents." ;
+ owl:onDatatype xsd:base64Binary .
+
+atom:Number
+ a rdfs:Class ;
+ rdfs:subClassOf atom:Atom ;
+ rdfs:label "Number" ;
+ rdfs:comment "Base class for numeric types." .
+
+atom:Int
+ a rdfs:Class ,
+ rdfs:Datatype ;
+ rdfs:subClassOf atom:Number ;
+ rdfs:label "Int" ;
+ rdfs:comment "A native `int32_t`." ;
+ atom:cType "LV2_Atom_Int" ;
+ owl:onDatatype xsd:int .
+
+atom:Long
+ a rdfs:Class ,
+ rdfs:Datatype ;
+ rdfs:subClassOf atom:Number ;
+ rdfs:label "Long" ;
+ rdfs:comment "A native `int64_t`." ;
+ atom:cType "LV2_Atom_Long" ;
+ owl:onDatatype xsd:long .
+
+atom:Float
+ a rdfs:Class ,
+ rdfs:Datatype ;
+ rdfs:subClassOf atom:Number ;
+ rdfs:label "Float" ;
+ rdfs:comment "A native `float`." ;
+ atom:cType "LV2_Atom_Float" ;
+ owl:onDatatype xsd:float .
+
+atom:Double
+ a rdfs:Class ,
+ rdfs:Datatype ;
+ rdfs:subClassOf atom:Number ;
+ rdfs:label "Double" ;
+ rdfs:comment "A native `double`." ;
+ atom:cType "LV2_Atom_Double" ;
+ owl:onDatatype xsd:double .
+
+atom:Bool
+ a rdfs:Class ,
+ rdfs:Datatype ;
+ rdfs:subClassOf atom:Atom ;
+ rdfs:label "Bool" ;
+ rdfs:comment "An atom:Int where 0 is false and any other value is true." ;
+ atom:cType "LV2_Atom_Bool" ;
+ owl:onDatatype xsd:boolean .
+
+atom:String
+ a rdfs:Class ,
+ rdfs:Datatype ;
+ rdfs:subClassOf atom:Atom ;
+ rdfs:label "String" ;
+ rdfs:comment "A UTF-8 string." ;
+ atom:cType "LV2_Atom_String" ;
+ owl:onDatatype xsd:string .
+
+atom:Literal
+ a rdfs:Class ;
+ rdfs:subClassOf atom:Atom ;
+ rdfs:label "Literal" ;
+ rdfs:comment "A UTF-8 string literal with optional datatype or language." ;
+ atom:cType "LV2_Atom_Literal" .
+
+atom:Path
+ a rdfs:Class ,
+ rdfs:Datatype ;
+ rdfs:subClassOf atom:URI ;
+ owl:onDatatype atom:URI ;
+ rdfs:label "Path" ;
+ rdfs:comment "A local file path." .
+
+atom:URI
+ a rdfs:Class ,
+ rdfs:Datatype ;
+ rdfs:subClassOf atom:String ;
+ owl:onDatatype xsd:anyURI ;
+ rdfs:label "URI" ;
+ rdfs:comment "A URI string." .
+
+atom:URID
+ a rdfs:Class ;
+ rdfs:subClassOf atom:Atom ;
+ rdfs:label "URID" ;
+ rdfs:comment "An unsigned 32-bit integer ID for a URI." ;
+ atom:cType "LV2_Atom_URID" .
+
+atom:Vector
+ a rdfs:Class ;
+ rdfs:subClassOf atom:Atom ;
+ rdfs:label "Vector" ;
+ rdfs:comment "A homogeneous sequence of atom bodies with equivalent type and size." ;
+ atom:cType "LV2_Atom_Vector" .
+
+atom:Tuple
+ a rdfs:Class ;
+ rdfs:subClassOf atom:Atom ;
+ rdfs:label "Tuple" ;
+ rdfs:comment "A sequence of atoms with varying type and size." .
+
+atom:Property
+ a rdfs:Class ;
+ rdfs:subClassOf atom:Atom ;
+ rdfs:label "Property" ;
+ rdfs:comment "A property of an atom:Object." ;
+ atom:cType "LV2_Atom_Property" .
+
+atom:Object
+ a rdfs:Class ;
+ rdfs:subClassOf atom:Atom ;
+ rdfs:label "Object" ;
+ rdfs:comment "A collection of properties." ;
+ atom:cType "LV2_Atom_Object" .
+
+atom:Resource
+ a rdfs:Class ;
+ rdfs:subClassOf atom:Object ;
+ rdfs:label "Resource" ;
+ rdfs:comment "A named collection of properties with a URI." ;
+ owl:deprecated "true"^^xsd:boolean ;
+ atom:cType "LV2_Atom_Object" .
+
+atom:Blank
+ a rdfs:Class ;
+ rdfs:subClassOf atom:Object ;
+ rdfs:label "Blank" ;
+ rdfs:comment "An anonymous collection of properties without a URI." ;
+ owl:deprecated "true"^^xsd:boolean ;
+ atom:cType "LV2_Atom_Object" .
+
+atom:Sound
+ a rdfs:Class ;
+ rdfs:subClassOf atom:Vector ;
+ rdfs:label "Sound" ;
+ rdfs:comment "A atom:Vector of atom:Float which represents an audio waveform." ;
+ atom:cType "LV2_Atom_Vector" .
+
+atom:frameTime
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ owl:FunctionalProperty ;
+ rdfs:range xsd:decimal ;
+ rdfs:label "frame time" ;
+ rdfs:comment "A time stamp in audio frames." .
+
+atom:beatTime
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ owl:FunctionalProperty ;
+ rdfs:range xsd:decimal ;
+ rdfs:label "beat time" ;
+ rdfs:comment "A time stamp in beats." .
+
+atom:Event
+ a rdfs:Class ;
+ rdfs:label "Event" ;
+ atom:cType "LV2_Atom_Event" ;
+ rdfs:comment "An atom with a time stamp prefix in a sequence." .
+
+atom:Sequence
+ a rdfs:Class ;
+ rdfs:subClassOf atom:Atom ;
+ rdfs:label "Sequence" ;
+ atom:cType "LV2_Atom_Sequence" ;
+ rdfs:comment "A sequence of events." .
+
+atom:AtomPort
+ a rdfs:Class ;
+ rdfs:subClassOf lv2:Port ;
+ rdfs:label "Atom Port" ;
+ rdfs:comment "A port which contains an atom:Atom." .
+
+atom:bufferType
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain atom:AtomPort ;
+ rdfs:range rdfs:Class ;
+ rdfs:label "buffer type" ;
+ rdfs:comment "An atom type that a port may be connected to." .
+
+atom:childType
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:label "child type" ;
+ rdfs:comment "The type of children in a container." .
+
+atom:supports
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:label "supports" ;
+ rdfs:comment "A supported atom type." ;
+ rdfs:range rdfs:Class .
+
+atom:eventTransfer
+ a ui:PortProtocol ;
+ rdfs:label "event transfer" ;
+ rdfs:comment "A port protocol for transferring events." .
+
+atom:atomTransfer
+ a ui:PortProtocol ;
+ rdfs:label "atom transfer" ;
+ rdfs:comment "A port protocol for transferring atoms." .
+
diff --git a/lv2/atom/forge-overflow-test.c b/lv2/atom/forge-overflow-test.c
new file mode 100644
index 0000000..a580d69
--- /dev/null
+++ b/lv2/atom/forge-overflow-test.c
@@ -0,0 +1,237 @@
+/*
+ Copyright 2019 David Robillard <http://drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#include "lv2/atom/atom-test-utils.c"
+#include "lv2/atom/atom.h"
+#include "lv2/atom/forge.h"
+#include "lv2/atom/util.h"
+#include "lv2/urid/urid.h"
+
+#include <assert.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include <string.h>
+
+static int
+test_string_overflow(void)
+{
+#define MAX_CHARS 15
+
+ static const size_t capacity = sizeof(LV2_Atom_String) + MAX_CHARS + 1;
+ static const char* str = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
+
+ uint8_t* buf = (uint8_t*)malloc(capacity);
+ LV2_URID_Map map = { NULL, urid_map };
+ LV2_Atom_Forge forge;
+ lv2_atom_forge_init(&forge, &map);
+
+ // Check that writing increasingly long strings fails at the right point
+ for (size_t count = 0; count < MAX_CHARS; ++count) {
+ lv2_atom_forge_set_buffer(&forge, buf, capacity);
+
+ const LV2_Atom_Forge_Ref ref =
+ lv2_atom_forge_string(&forge, str, count);
+ if (!ref) {
+ return test_fail("Failed to write %zu byte string\n", count);
+ }
+ }
+
+ // Failure writing to an exactly full forge
+ LV2_Atom_Forge_Ref ref = 0;
+ if ((ref = lv2_atom_forge_string(&forge, str, MAX_CHARS + 1))) {
+ return test_fail("Successfully wrote past end of buffer\n");
+ }
+
+ // Failure writing body after successfully writing header
+ lv2_atom_forge_set_buffer(&forge, buf, sizeof(LV2_Atom) + 1);
+ if ((ref = lv2_atom_forge_string(&forge, "AB", 2))) {
+ return test_fail("Successfully wrote atom header past end\n");
+ }
+
+ free(buf);
+ return 0;
+}
+
+static int
+test_literal_overflow(void)
+{
+ static const size_t capacity = sizeof(LV2_Atom_Literal) + 2;
+
+ uint8_t* buf = (uint8_t*)malloc(capacity);
+ LV2_URID_Map map = { NULL, urid_map };
+ LV2_Atom_Forge_Ref ref = 0;
+ LV2_Atom_Forge forge;
+ lv2_atom_forge_init(&forge, &map);
+
+ // Failure in atom header
+ lv2_atom_forge_set_buffer(&forge, buf, 1);
+ if ((ref = lv2_atom_forge_literal(&forge, "A", 1, 0, 0))) {
+ return test_fail("Successfully wrote atom header past end\n");
+ }
+
+ // Failure in literal header
+ lv2_atom_forge_set_buffer(&forge, buf, sizeof(LV2_Atom) + 1);
+ if ((ref = lv2_atom_forge_literal(&forge, "A", 1, 0, 0))) {
+ return test_fail("Successfully wrote literal header past end\n");
+ }
+
+ // Success (only room for one character + null terminator)
+ lv2_atom_forge_set_buffer(&forge, buf, capacity);
+ if (!(ref = lv2_atom_forge_literal(&forge, "A", 1, 0, 0))) {
+ return test_fail("Failed to write small enough literal\n");
+ }
+
+ // Failure in body
+ lv2_atom_forge_set_buffer(&forge, buf, capacity);
+ if ((ref = lv2_atom_forge_literal(&forge, "AB", 2, 0, 0))) {
+ return test_fail("Successfully wrote literal body past end\n");
+ }
+
+ free(buf);
+ return 0;
+}
+
+static int
+test_sequence_overflow(void)
+{
+ static const size_t size = sizeof(LV2_Atom_Sequence) + 6 * sizeof(LV2_Atom);
+ LV2_URID_Map map = { NULL, urid_map };
+
+ // Test over a range that fails in the sequence header and event components
+ for (size_t capacity = 1; capacity < size; ++capacity) {
+ uint8_t* buf = (uint8_t*)malloc(capacity);
+
+ LV2_Atom_Forge forge;
+ lv2_atom_forge_init(&forge, &map);
+ lv2_atom_forge_set_buffer(&forge, buf, capacity);
+
+ LV2_Atom_Forge_Frame frame;
+ LV2_Atom_Forge_Ref ref =
+ lv2_atom_forge_sequence_head(&forge, &frame, 0);
+
+ assert(capacity >= sizeof(LV2_Atom_Sequence) || !frame.ref);
+ assert(capacity >= sizeof(LV2_Atom_Sequence) || !ref);
+
+ lv2_atom_forge_frame_time(&forge, 0);
+ lv2_atom_forge_int(&forge, 42);
+ lv2_atom_forge_pop(&forge, &frame);
+
+ free(buf);
+ }
+
+ return 0;
+}
+
+static int
+test_vector_head_overflow(void)
+{
+ static const size_t size = sizeof(LV2_Atom_Vector) + 3 * sizeof(LV2_Atom);
+ LV2_URID_Map map = { NULL, urid_map };
+
+ // Test over a range that fails in the vector header and elements
+ for (size_t capacity = 1; capacity < size; ++capacity) {
+ uint8_t* buf = (uint8_t*)malloc(capacity);
+
+ LV2_Atom_Forge forge;
+ lv2_atom_forge_init(&forge, &map);
+ lv2_atom_forge_set_buffer(&forge, buf, capacity);
+
+ LV2_Atom_Forge_Frame frame;
+ LV2_Atom_Forge_Ref ref = lv2_atom_forge_vector_head(
+ &forge, &frame, sizeof(int32_t), forge.Int);
+
+ assert(capacity >= sizeof(LV2_Atom_Vector) || !frame.ref);
+ assert(capacity >= sizeof(LV2_Atom_Vector) || !ref);
+
+ lv2_atom_forge_int(&forge, 1);
+ lv2_atom_forge_int(&forge, 2);
+ lv2_atom_forge_int(&forge, 3);
+ lv2_atom_forge_pop(&forge, &frame);
+
+ free(buf);
+ }
+
+ return 0;
+}
+
+static int
+test_vector_overflow(void)
+{
+ static const size_t size = sizeof(LV2_Atom_Vector) + 3 * sizeof(LV2_Atom);
+ static const int32_t vec[] = { 1, 2, 3 };
+ LV2_URID_Map map = { NULL, urid_map };
+
+ // Test over a range that fails in the vector header and elements
+ for (size_t capacity = 1; capacity < size; ++capacity) {
+ uint8_t* buf = (uint8_t*)malloc(capacity);
+
+ LV2_Atom_Forge forge;
+ lv2_atom_forge_init(&forge, &map);
+ lv2_atom_forge_set_buffer(&forge, buf, capacity);
+
+ LV2_Atom_Forge_Ref ref = lv2_atom_forge_vector(
+ &forge, sizeof(int32_t), forge.Int, 3, vec);
+
+ assert(capacity >= sizeof(LV2_Atom_Vector) || !ref);
+
+ free(buf);
+ }
+
+ return 0;
+}
+
+static int
+test_tuple_overflow(void)
+{
+ static const size_t size = sizeof(LV2_Atom_Tuple) + 3 * sizeof(LV2_Atom);
+ LV2_URID_Map map = { NULL, urid_map };
+
+ // Test over a range that fails in the tuple header and elements
+ for (size_t capacity = 1; capacity < size; ++capacity) {
+ uint8_t* buf = (uint8_t*)malloc(capacity);
+
+ LV2_Atom_Forge forge;
+ lv2_atom_forge_init(&forge, &map);
+ lv2_atom_forge_set_buffer(&forge, buf, capacity);
+
+ LV2_Atom_Forge_Frame frame;
+ LV2_Atom_Forge_Ref ref = lv2_atom_forge_tuple(&forge, &frame);
+
+ assert(capacity >= sizeof(LV2_Atom_Tuple) || !frame.ref);
+ assert(capacity >= sizeof(LV2_Atom_Tuple) || !ref);
+
+ lv2_atom_forge_int(&forge, 1);
+ lv2_atom_forge_float(&forge, 2.0f);
+ lv2_atom_forge_string(&forge, "three", 5);
+ lv2_atom_forge_pop(&forge, &frame);
+
+ free(buf);
+ }
+
+ return 0;
+}
+
+int
+main(void)
+{
+ const int ret = test_string_overflow() || test_literal_overflow() ||
+ test_sequence_overflow() || test_vector_head_overflow() ||
+ test_vector_overflow() || test_tuple_overflow();
+
+ free_urid_map();
+
+ return ret;
+}
diff --git a/lv2/lv2plug.in/ns/ext/atom/forge.h b/lv2/atom/forge.h
index c825806..e992ff2 100644
--- a/lv2/lv2plug.in/ns/ext/atom/forge.h
+++ b/lv2/atom/forge.h
@@ -1,5 +1,5 @@
/*
- Copyright 2008-2012 David Robillard <http://drobilla.net>
+ Copyright 2008-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -39,21 +39,30 @@
This header is non-normative, it is provided for convenience.
*/
+/**
+ @defgroup forge Forge
+ @ingroup atom
+ @{
+*/
+
#ifndef LV2_ATOM_FORGE_H
#define LV2_ATOM_FORGE_H
-#include <assert.h>
+#include "lv2/atom/atom.h"
+#include "lv2/atom/util.h"
+#include "lv2/core/attributes.h"
+#include "lv2/urid/urid.h"
-#include "lv2/lv2plug.in/ns/ext/atom/atom.h"
-#include "lv2/lv2plug.in/ns/ext/atom/util.h"
-#include "lv2/lv2plug.in/ns/ext/urid/urid.h"
+#include <assert.h>
+#include <stdbool.h>
#ifdef __cplusplus
extern "C" {
-#else
-# include <stdbool.h>
#endif
+// Disable deprecation warnings for Blank and Resource
+LV2_DISABLE_DEPRECATION_WARNINGS
+
/** Handle for LV2_Atom_Forge_Sink. */
typedef void* LV2_Atom_Forge_Sink_Handle;
@@ -72,9 +81,9 @@ typedef LV2_Atom*
LV2_Atom_Forge_Ref ref);
/** A stack frame used for keeping track of nested Atom containers. */
-typedef struct _LV2_Atom_Forge_Frame {
- struct _LV2_Atom_Forge_Frame* parent;
- LV2_Atom_Forge_Ref ref;
+typedef struct LV2_Atom_Forge_Frame {
+ struct LV2_Atom_Forge_Frame* parent;
+ LV2_Atom_Forge_Ref ref;
} LV2_Atom_Forge_Frame;
/** A "forge" for creating atoms by appending to a buffer. */
@@ -89,7 +98,7 @@ typedef struct {
LV2_Atom_Forge_Frame* stack;
- LV2_URID Blank;
+ LV2_URID Blank LV2_DEPRECATED;
LV2_URID Bool;
LV2_URID Chunk;
LV2_URID Double;
@@ -97,9 +106,10 @@ typedef struct {
LV2_URID Int;
LV2_URID Long;
LV2_URID Literal;
+ LV2_URID Object;
LV2_URID Path;
LV2_URID Property;
- LV2_URID Resource;
+ LV2_URID Resource LV2_DEPRECATED;
LV2_URID Sequence;
LV2_URID String;
LV2_URID Tuple;
@@ -112,9 +122,9 @@ static inline void
lv2_atom_forge_set_buffer(LV2_Atom_Forge* forge, uint8_t* buf, size_t size);
/**
- Initialise @p forge.
+ Initialise `forge`.
- URIs will be mapped using @p map and stored, a reference to @p map itself is
+ URIs will be mapped using `map` and stored, a reference to `map` itself is
not held.
*/
static inline void
@@ -129,6 +139,7 @@ lv2_atom_forge_init(LV2_Atom_Forge* forge, LV2_URID_Map* map)
forge->Int = map->map(map->handle, LV2_ATOM__Int);
forge->Long = map->map(map->handle, LV2_ATOM__Long);
forge->Literal = map->map(map->handle, LV2_ATOM__Literal);
+ forge->Object = map->map(map->handle, LV2_ATOM__Object);
forge->Path = map->map(map->handle, LV2_ATOM__Path);
forge->Property = map->map(map->handle, LV2_ATOM__Property);
forge->Resource = map->map(map->handle, LV2_ATOM__Resource);
@@ -140,14 +151,11 @@ lv2_atom_forge_init(LV2_Atom_Forge* forge, LV2_URID_Map* map)
forge->Vector = map->map(map->handle, LV2_ATOM__Vector);
}
+/** Access the Atom pointed to by a reference. */
static inline LV2_Atom*
lv2_atom_forge_deref(LV2_Atom_Forge* forge, LV2_Atom_Forge_Ref ref)
{
- if (forge->buf) {
- return (LV2_Atom*)ref;
- } else {
- return forge->deref(forge->handle, ref);
- }
+ return forge->buf ? (LV2_Atom*)ref : forge->deref(forge->handle, ref);
}
/**
@@ -168,7 +176,11 @@ lv2_atom_forge_push(LV2_Atom_Forge* forge,
{
frame->parent = forge->stack;
frame->ref = ref;
- forge->stack = frame;
+
+ if (ref) {
+ forge->stack = frame; // Don't push, so walking the stack is always safe
+ }
+
return ref;
}
@@ -176,8 +188,12 @@ lv2_atom_forge_push(LV2_Atom_Forge* forge,
static inline void
lv2_atom_forge_pop(LV2_Atom_Forge* forge, LV2_Atom_Forge_Frame* frame)
{
- assert(frame == forge->stack);
- forge->stack = frame->parent;
+ if (frame->ref) {
+ // If frame has a valid ref, it must be the top of the stack
+ assert(frame == forge->stack);
+ forge->stack = frame->parent;
+ }
+ // Otherwise, frame was not pushed because of overflow, do nothing
}
/** Return true iff the top of the stack has the given type. */
@@ -188,18 +204,37 @@ lv2_atom_forge_top_is(LV2_Atom_Forge* forge, uint32_t type)
(lv2_atom_forge_deref(forge, forge->stack->ref)->type == type);
}
+/** Return true iff `type` is an atom:Object. */
+static inline bool
+lv2_atom_forge_is_object_type(const LV2_Atom_Forge* forge, uint32_t type)
+{
+ return (type == forge->Object ||
+ type == forge->Blank ||
+ type == forge->Resource);
+}
+
+/** Return true iff `type` is an atom:Object with a blank ID. */
+static inline bool
+lv2_atom_forge_is_blank(const LV2_Atom_Forge* forge,
+ uint32_t type,
+ const LV2_Atom_Object_Body* body)
+{
+ return (type == forge->Blank ||
+ (type == forge->Object && body->id == 0));
+}
+
/**
@}
@name Output Configuration
@{
*/
-/** Set the output buffer where @p forge will write atoms. */
+/** Set the output buffer where `forge` will write atoms. */
static inline void
lv2_atom_forge_set_buffer(LV2_Atom_Forge* forge, uint8_t* buf, size_t size)
{
forge->buf = buf;
- forge->size = size;
+ forge->size = (uint32_t)size;
forge->offset = 0;
forge->deref = NULL;
forge->sink = NULL;
@@ -208,7 +243,7 @@ lv2_atom_forge_set_buffer(LV2_Atom_Forge* forge, uint8_t* buf, size_t size)
}
/**
- Set the sink function where @p forge will write output.
+ Set the sink function where `forge` will write output.
The return value of forge functions is an LV2_Atom_Forge_Ref which is an
integer type safe to use as a pointer but is otherwise opaque. The sink
@@ -318,11 +353,10 @@ lv2_atom_forge_atom(LV2_Atom_Forge* forge, uint32_t size, uint32_t type)
static inline LV2_Atom_Forge_Ref
lv2_atom_forge_primitive(LV2_Atom_Forge* forge, const LV2_Atom* a)
{
- if (lv2_atom_forge_top_is(forge, forge->Vector)) {
- return lv2_atom_forge_raw(forge, LV2_ATOM_BODY(a), a->size);
- } else {
- return lv2_atom_forge_write(forge, a, sizeof(LV2_Atom) + a->size);
- }
+ return (lv2_atom_forge_top_is(forge, forge->Vector)
+ ? lv2_atom_forge_raw(forge, LV2_ATOM_BODY_CONST(a), a->size)
+ : lv2_atom_forge_write(
+ forge, a, (uint32_t)sizeof(LV2_Atom) + a->size));
}
/** Write an atom:Int. */
@@ -392,7 +426,7 @@ lv2_atom_forge_typed_string(LV2_Atom_Forge* forge,
return out;
}
-/** Write an atom:String. Note that @p str need not be NULL terminated. */
+/** Write an atom:String. Note that `str` need not be NULL terminated. */
static inline LV2_Atom_Forge_Ref
lv2_atom_forge_string(LV2_Atom_Forge* forge, const char* str, uint32_t len)
{
@@ -400,7 +434,7 @@ lv2_atom_forge_string(LV2_Atom_Forge* forge, const char* str, uint32_t len)
}
/**
- Write an atom:URI. Note that @p uri need not be NULL terminated.
+ Write an atom:URI. Note that `uri` need not be NULL terminated.
This does not map the URI, but writes the complete URI string. To write
a mapped URI, use lv2_atom_forge_urid().
*/
@@ -410,7 +444,7 @@ lv2_atom_forge_uri(LV2_Atom_Forge* forge, const char* uri, uint32_t len)
return lv2_atom_forge_typed_string(forge, forge->URI, uri, len);
}
-/** Write an atom:Path. Note that @p path need not be NULL terminated. */
+/** Write an atom:Path. Note that `path` need not be NULL terminated. */
static inline LV2_Atom_Forge_Ref
lv2_atom_forge_path(LV2_Atom_Forge* forge, const char* path, uint32_t len)
{
@@ -503,7 +537,7 @@ lv2_atom_forge_tuple(LV2_Atom_Forge* forge, LV2_Atom_Forge_Frame* frame)
}
/**
- Write the header of an atom:Resource.
+ Write the header of an atom:Object.
The passed frame will be initialised to represent this object. To complete
the object, write a sequence of properties, then pop the frame with
@@ -514,12 +548,12 @@ lv2_atom_forge_tuple(LV2_Atom_Forge* forge, LV2_Atom_Forge_Frame* frame)
LV2_URID eg_Cat = map("http://example.org/Cat");
LV2_URID eg_name = map("http://example.org/name");
- // Write object header
+ // Start object with type eg_Cat and blank ID
LV2_Atom_Forge_Frame frame;
- lv2_atom_forge_resource(forge, &frame, 1, eg_Cat);
+ lv2_atom_forge_object(forge, &frame, 0, eg_Cat);
- // Write property: eg:name = "Hobbes"
- lv2_atom_forge_property_head(forge, eg_name, 0);
+ // Append property eg:name = "Hobbes"
+ lv2_atom_forge_key(forge, eg_name);
lv2_atom_forge_string(forge, "Hobbes", strlen("Hobbes"));
// Finish object
@@ -527,13 +561,34 @@ lv2_atom_forge_tuple(LV2_Atom_Forge* forge, LV2_Atom_Forge_Frame* frame)
@endcode
*/
static inline LV2_Atom_Forge_Ref
+lv2_atom_forge_object(LV2_Atom_Forge* forge,
+ LV2_Atom_Forge_Frame* frame,
+ LV2_URID id,
+ LV2_URID otype)
+{
+ const LV2_Atom_Object a = {
+ { (uint32_t)sizeof(LV2_Atom_Object_Body), forge->Object },
+ { id, otype }
+ };
+ return lv2_atom_forge_push(
+ forge, frame, lv2_atom_forge_write(forge, &a, sizeof(a)));
+}
+
+/**
+ The same as lv2_atom_forge_object(), but for object:Resource.
+
+ This function is deprecated and should not be used in new code.
+ Use lv2_atom_forge_object() directly instead.
+*/
+LV2_DEPRECATED
+static inline LV2_Atom_Forge_Ref
lv2_atom_forge_resource(LV2_Atom_Forge* forge,
LV2_Atom_Forge_Frame* frame,
LV2_URID id,
LV2_URID otype)
{
const LV2_Atom_Object a = {
- { sizeof(LV2_Atom_Object) - sizeof(LV2_Atom), forge->Resource },
+ { (uint32_t)sizeof(LV2_Atom_Object_Body), forge->Resource },
{ id, otype }
};
return lv2_atom_forge_push(
@@ -541,8 +596,12 @@ lv2_atom_forge_resource(LV2_Atom_Forge* forge,
}
/**
- The same as lv2_atom_forge_resource(), but for object:Blank.
+ The same as lv2_atom_forge_object(), but for object:Blank.
+
+ This function is deprecated and should not be used in new code.
+ Use lv2_atom_forge_object() directly instead.
*/
+LV2_DEPRECATED
static inline LV2_Atom_Forge_Ref
lv2_atom_forge_blank(LV2_Atom_Forge* forge,
LV2_Atom_Forge_Frame* frame,
@@ -550,7 +609,7 @@ lv2_atom_forge_blank(LV2_Atom_Forge* forge,
LV2_URID otype)
{
const LV2_Atom_Object a = {
- { sizeof(LV2_Atom_Object) - sizeof(LV2_Atom), forge->Blank },
+ { (uint32_t)sizeof(LV2_Atom_Object_Body), forge->Blank },
{ id, otype }
};
return lv2_atom_forge_push(
@@ -558,8 +617,23 @@ lv2_atom_forge_blank(LV2_Atom_Forge* forge,
}
/**
- Write the header for a property body (likely in an Object).
- See lv2_atom_forge_resource() documentation for an example.
+ Write a property key in an Object, to be followed by the value.
+
+ See lv2_atom_forge_object() documentation for an example.
+*/
+static inline LV2_Atom_Forge_Ref
+lv2_atom_forge_key(LV2_Atom_Forge* forge,
+ LV2_URID key)
+{
+ const LV2_Atom_Property_Body a = { key, 0, { 0, 0 } };
+ return lv2_atom_forge_write(forge, &a, 2 * (uint32_t)sizeof(uint32_t));
+}
+
+/**
+ Write the header for a property body in an object, with context.
+
+ If you do not need the context, which is almost certainly the case,
+ use the simpler lv2_atom_forge_key() instead.
*/
static inline LV2_Atom_Forge_Ref
lv2_atom_forge_property_head(LV2_Atom_Forge* forge,
@@ -567,7 +641,7 @@ lv2_atom_forge_property_head(LV2_Atom_Forge* forge,
LV2_URID context)
{
const LV2_Atom_Property_Body a = { key, context, { 0, 0 } };
- return lv2_atom_forge_write(forge, &a, 2 * sizeof(uint32_t));
+ return lv2_atom_forge_write(forge, &a, 2 * (uint32_t)sizeof(uint32_t));
}
/**
@@ -579,7 +653,7 @@ lv2_atom_forge_sequence_head(LV2_Atom_Forge* forge,
uint32_t unit)
{
const LV2_Atom_Sequence a = {
- { sizeof(LV2_Atom_Sequence) - sizeof(LV2_Atom), forge->Sequence },
+ { (uint32_t)sizeof(LV2_Atom_Sequence_Body), forge->Sequence },
{ unit, 0 }
};
return lv2_atom_forge_push(
@@ -610,8 +684,11 @@ lv2_atom_forge_beat_time(LV2_Atom_Forge* forge, double beats)
/**
@}
+ @}
*/
+LV2_RESTORE_WARNINGS
+
#ifdef __cplusplus
} /* extern "C" */
#endif
diff --git a/lv2/lv2plug.in/ns/ext/atom/manifest.ttl b/lv2/atom/manifest.ttl
index 4c94643..46d6de5 100644
--- a/lv2/lv2plug.in/ns/ext/atom/manifest.ttl
+++ b/lv2/atom/manifest.ttl
@@ -1,8 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/atom>
a lv2:Specification ;
- lv2:minorVersion 1 ;
- lv2:microVersion 6 ;
+ lv2:minorVersion 2 ;
+ lv2:microVersion 2 ;
rdfs:seeAlso <atom.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/ext/atom/util.h b/lv2/atom/util.h
index d247ad8..383d304 100644
--- a/lv2/lv2plug.in/ns/ext/atom/util.h
+++ b/lv2/atom/util.h
@@ -1,5 +1,5 @@
/*
- Copyright 2008-2012 David Robillard <http://drobilla.net>
+ Copyright 2008-2015 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -22,43 +22,48 @@
This header is non-normative, it is provided for convenience.
*/
+/**
+ @defgroup util Utilities
+ @ingroup atom
+ @{
+*/
+
#ifndef LV2_ATOM_UTIL_H
#define LV2_ATOM_UTIL_H
+#include "lv2/atom/atom.h"
+
#include <stdarg.h>
+#include <stdbool.h>
#include <stdint.h>
#include <string.h>
-#include "lv2/lv2plug.in/ns/ext/atom/atom.h"
-
#ifdef __cplusplus
extern "C" {
-#else
-# include <stdbool.h>
#endif
/** Pad a size to 64 bits. */
static inline uint32_t
lv2_atom_pad_size(uint32_t size)
{
- return (size + 7) & (~7);
+ return (size + 7U) & (~7U);
}
-/** Return the total size of @p atom, including the header. */
+/** Return the total size of `atom`, including the header. */
static inline uint32_t
lv2_atom_total_size(const LV2_Atom* atom)
{
- return sizeof(LV2_Atom) + atom->size;
+ return (uint32_t)sizeof(LV2_Atom) + atom->size;
}
-/** Return true iff @p atom is null. */
+/** Return true iff `atom` is null. */
static inline bool
lv2_atom_is_null(const LV2_Atom* atom)
{
return !atom || (atom->type == 0 && atom->size == 0);
}
-/** Return true iff @p a is equal to @p b. */
+/** Return true iff `a` is equal to `b`. */
static inline bool
lv2_atom_equals(const LV2_Atom* a, const LV2_Atom* b)
{
@@ -83,23 +88,23 @@ lv2_atom_sequence_begin(const LV2_Atom_Sequence_Body* body)
static inline LV2_Atom_Event*
lv2_atom_sequence_end(const LV2_Atom_Sequence_Body* body, uint32_t size)
{
- return (LV2_Atom_Event*)((uint8_t*)body + lv2_atom_pad_size(size));
+ return (LV2_Atom_Event*)((const uint8_t*)body + lv2_atom_pad_size(size));
}
-/** Return true iff @p i has reached the end of @p body. */
+/** Return true iff `i` has reached the end of `body`. */
static inline bool
lv2_atom_sequence_is_end(const LV2_Atom_Sequence_Body* body,
uint32_t size,
- LV2_Atom_Event* i)
+ const LV2_Atom_Event* i)
{
- return (uint8_t*)i >= ((uint8_t*)body + size);
+ return (const uint8_t*)i >= ((const uint8_t*)body + size);
}
-/** Return an iterator to the element following @p i. */
+/** Return an iterator to the element following `i`. */
static inline LV2_Atom_Event*
lv2_atom_sequence_next(const LV2_Atom_Event* i)
{
- return (LV2_Atom_Event*)((uint8_t*)i
+ return (LV2_Atom_Event*)((const uint8_t*)i
+ sizeof(LV2_Atom_Event)
+ lv2_atom_pad_size(i->body.size));
}
@@ -109,7 +114,9 @@ lv2_atom_sequence_next(const LV2_Atom_Event* i)
@param seq The sequence to iterate over
@param iter The name of the iterator
- This macro is used similarly to a for loop (which it expands to), e.g.:
+ This macro is used similarly to a for loop (which it expands to), for
+ example:
+
@code
LV2_ATOM_SEQUENCE_FOREACH(sequence, ev) {
// Do something with ev (an LV2_Atom_Event*) here...
@@ -129,30 +136,76 @@ lv2_atom_sequence_next(const LV2_Atom_Event* i)
/**
@}
+ @name Sequence Utilities
+ @{
+*/
+
+/**
+ Clear all events from `sequence`.
+
+ This simply resets the size field, the other fields are left untouched.
+*/
+static inline void
+lv2_atom_sequence_clear(LV2_Atom_Sequence* seq)
+{
+ seq->atom.size = sizeof(LV2_Atom_Sequence_Body);
+}
+
+/**
+ Append an event at the end of `sequence`.
+
+ @param seq Sequence to append to.
+ @param capacity Total capacity of the sequence atom
+ (as set by the host for sequence output ports).
+ @param event Event to write.
+
+ @return A pointer to the newly written event in `seq`,
+ or NULL on failure (insufficient space).
+*/
+static inline LV2_Atom_Event*
+lv2_atom_sequence_append_event(LV2_Atom_Sequence* seq,
+ uint32_t capacity,
+ const LV2_Atom_Event* event)
+{
+ const uint32_t total_size = (uint32_t)sizeof(*event) + event->body.size;
+ if (capacity - seq->atom.size < total_size) {
+ return NULL;
+ }
+
+ LV2_Atom_Event* e = lv2_atom_sequence_end(&seq->body, seq->atom.size);
+ memcpy(e, event, total_size);
+
+ seq->atom.size += lv2_atom_pad_size(total_size);
+
+ return e;
+}
+
+/**
+ @}
@name Tuple Iterator
@{
*/
-/** Get an iterator pointing to the first element in @p tup. */
+/** Get an iterator pointing to the first element in `tup`. */
static inline LV2_Atom*
lv2_atom_tuple_begin(const LV2_Atom_Tuple* tup)
{
return (LV2_Atom*)(LV2_ATOM_BODY(tup));
}
-/** Return true iff @p i has reached the end of @p body. */
+/** Return true iff `i` has reached the end of `body`. */
static inline bool
-lv2_atom_tuple_is_end(const void* body, uint32_t size, LV2_Atom* i)
+lv2_atom_tuple_is_end(const void* body, uint32_t size, const LV2_Atom* i)
{
- return (uint8_t*)i >= ((uint8_t*)body + size);
+ return (const uint8_t*)i >= ((const uint8_t*)body + size);
}
-/** Return an iterator to the element following @p i. */
+/** Return an iterator to the element following `i`. */
static inline LV2_Atom*
lv2_atom_tuple_next(const LV2_Atom* i)
{
return (LV2_Atom*)(
- (uint8_t*)i + sizeof(LV2_Atom) + lv2_atom_pad_size(i->size));
+ (const uint8_t*)i + sizeof(LV2_Atom) + lv2_atom_pad_size(i->size));
}
/**
@@ -160,21 +213,23 @@ lv2_atom_tuple_next(const LV2_Atom* i)
@param tuple The tuple to iterate over
@param iter The name of the iterator
- This macro is used similarly to a for loop (which it expands to), e.g.:
+ This macro is used similarly to a for loop (which it expands to), for
+ example:
+
@code
- LV2_ATOMO_TUPLE_FOREACH(tuple, elem) {
+ LV2_ATOM_TUPLE_FOREACH(tuple, elem) {
// Do something with elem (an LV2_Atom*) here...
}
@endcode
*/
#define LV2_ATOM_TUPLE_FOREACH(tuple, iter) \
for (LV2_Atom* (iter) = lv2_atom_tuple_begin(tuple); \
- !lv2_atom_tuple_is_end(LV2_ATOM_BODY(tuple), (tuple)->size, (iter)); \
+ !lv2_atom_tuple_is_end(LV2_ATOM_BODY(tuple), (tuple)->atom.size, (iter)); \
(iter) = lv2_atom_tuple_next(iter))
/** Like LV2_ATOM_TUPLE_FOREACH but for a headerless tuple body. */
#define LV2_ATOM_TUPLE_BODY_FOREACH(body, size, iter) \
- for (LV2_Atom* (iter) = (LV2_Atom*)body; \
+ for (LV2_Atom* (iter) = (LV2_Atom*)(body); \
!lv2_atom_tuple_is_end(body, size, (iter)); \
(iter) = lv2_atom_tuple_next(iter))
@@ -184,31 +239,31 @@ lv2_atom_tuple_next(const LV2_Atom* i)
@{
*/
-/** Return a pointer to the first property in @p body. */
+/** Return a pointer to the first property in `body`. */
static inline LV2_Atom_Property_Body*
lv2_atom_object_begin(const LV2_Atom_Object_Body* body)
{
return (LV2_Atom_Property_Body*)(body + 1);
}
-/** Return true iff @p i has reached the end of @p obj. */
+/** Return true iff `i` has reached the end of `obj`. */
static inline bool
-lv2_atom_object_is_end(const LV2_Atom_Object_Body* body,
- uint32_t size,
- LV2_Atom_Property_Body* i)
+lv2_atom_object_is_end(const LV2_Atom_Object_Body* body,
+ uint32_t size,
+ const LV2_Atom_Property_Body* i)
{
- return (uint8_t*)i >= ((uint8_t*)body + size);
+ return (const uint8_t*)i >= ((const uint8_t*)body + size);
}
-/** Return an iterator to the property following @p i. */
+/** Return an iterator to the property following `i`. */
static inline LV2_Atom_Property_Body*
lv2_atom_object_next(const LV2_Atom_Property_Body* i)
{
- const LV2_Atom* const value = (LV2_Atom*)(
- (uint8_t*)i + 2 * sizeof(uint32_t));
+ const LV2_Atom* const value = (const LV2_Atom*)(
+ (const uint8_t*)i + 2 * sizeof(uint32_t));
return (LV2_Atom_Property_Body*)(
- (uint8_t*)i + lv2_atom_pad_size(sizeof(LV2_Atom_Property_Body)
- + value->size));
+ (const uint8_t*)i + lv2_atom_pad_size(
+ (uint32_t)sizeof(LV2_Atom_Property_Body) + value->size));
}
/**
@@ -216,10 +271,12 @@ lv2_atom_object_next(const LV2_Atom_Property_Body* i)
@param obj The object to iterate over
@param iter The name of the iterator
- This macro is used similarly to a for loop (which it expands to), e.g.:
+ This macro is used similarly to a for loop (which it expands to), for
+ example:
+
@code
LV2_ATOM_OBJECT_FOREACH(object, i) {
- // Do something with prop (an LV2_Atom_Property_Body*) here...
+ // Do something with i (an LV2_Atom_Property_Body*) here...
}
@endcode
*/
@@ -246,15 +303,16 @@ typedef struct {
const LV2_Atom** value; /**< Found value (output set by query function) */
} LV2_Atom_Object_Query;
+/** Sentinel for lv2_atom_object_query(). */
static const LV2_Atom_Object_Query LV2_ATOM_OBJECT_QUERY_END = { 0, NULL };
/**
Get an object's values for various keys.
- The value pointer of each item in @p query will be set to the location of
- the corresponding value in @p object. Every value pointer in @p query MUST
- be initialised to NULL. This function reads @p object in a single linear
- sweep. By allocating @p query on the stack, objects can be "queried"
+ The value pointer of each item in `query` will be set to the location of
+ the corresponding value in `object`. Every value pointer in `query` MUST
+ be initialised to NULL. This function reads `object` in a single linear
+ sweep. By allocating `query` on the stack, objects can be "queried"
quickly without allocating any memory. This function is realtime safe.
This function can only do "flat" queries, it is not smart enough to match
@@ -390,6 +448,63 @@ lv2_atom_object_get(const LV2_Atom_Object* object, ...)
}
/**
+ Variable argument version of lv2_atom_object_query() with types.
+
+ This is like lv2_atom_object_get(), but each entry has an additional
+ parameter to specify the required type. Only atoms with a matching type
+ will be selected.
+
+ The arguments should be a series of uint32_t key, const LV2_Atom**, uint32_t
+ type triples, terminated by a zero key. The value pointers MUST be
+ initialized to NULL. For example:
+
+ @code
+ const LV2_Atom_String* name = NULL;
+ const LV2_Atom_Int* age = NULL;
+ lv2_atom_object_get(obj,
+ uris.name_key, &name, uris.atom_String,
+ uris.age_key, &age, uris.atom_Int
+ 0);
+ @endcode
+*/
+static inline int
+lv2_atom_object_get_typed(const LV2_Atom_Object* object, ...)
+{
+ int matches = 0;
+ int n_queries = 0;
+
+ /* Count number of keys so we can short-circuit when done */
+ va_list args;
+ va_start(args, object);
+ for (n_queries = 0; va_arg(args, uint32_t); ++n_queries) {
+ if (!va_arg(args, const LV2_Atom**) ||
+ !va_arg(args, uint32_t)) {
+ return -1;
+ }
+ }
+ va_end(args);
+
+ LV2_ATOM_OBJECT_FOREACH(object, prop) {
+ va_start(args, object);
+ for (int i = 0; i < n_queries; ++i) {
+ const uint32_t qkey = va_arg(args, uint32_t);
+ const LV2_Atom** qval = va_arg(args, const LV2_Atom**);
+ const uint32_t qtype = va_arg(args, uint32_t);
+ if (!*qval && qkey == prop->key && qtype == prop->value.type) {
+ *qval = &prop->value;
+ if (++matches == n_queries) {
+ return matches;
+ }
+ break;
+ }
+ }
+ va_end(args);
+ }
+ return matches;
+}
+
+/**
+ @}
@}
*/
diff --git a/lv2/lv2plug.in/ns/ext/buf-size/buf-size.h b/lv2/buf-size/buf-size.h
index 20cd8fd..7655c77 100644
--- a/lv2/lv2plug.in/ns/ext/buf-size/buf-size.h
+++ b/lv2/buf-size/buf-size.h
@@ -1,5 +1,5 @@
/*
- Copyright 2007-2012 David Robillard <http://drobilla.net>
+ Copyright 2007-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -17,14 +17,29 @@
#ifndef LV2_BUF_SIZE_H
#define LV2_BUF_SIZE_H
-#define LV2_BUF_SIZE_URI "http://lv2plug.in/ns/ext/buf-size"
-#define LV2_BUF_SIZE_PREFIX LV2_BUF_SIZE_URI "#"
+/**
+ @defgroup buf-size Buffer Size
+ @ingroup lv2
-#define LV2_BUF_SIZE__boundedBlockLength LV2_BUF_SIZE_PREFIX "boundedBlockLength"
-#define LV2_BUF_SIZE__fixedBlockLength LV2_BUF_SIZE_PREFIX "fixedBlockLength"
-#define LV2_BUF_SIZE__maxBlockLength LV2_BUF_SIZE_PREFIX "maxBlockLength"
-#define LV2_BUF_SIZE__minBlockLength LV2_BUF_SIZE_PREFIX "minBlockLength"
-#define LV2_BUF_SIZE__powerOf2BlockLength LV2_BUF_SIZE_PREFIX "powerOf2BlockLength"
-#define LV2_BUF_SIZE__sequenceSize LV2_BUF_SIZE_PREFIX "sequenceSize"
+ Access to, and restrictions on, buffer sizes; see
+ <http://lv2plug.in/ns/ext/buf-size> for details.
+
+ @{
+*/
+
+#define LV2_BUF_SIZE_URI "http://lv2plug.in/ns/ext/buf-size" ///< http://lv2plug.in/ns/ext/buf-size
+#define LV2_BUF_SIZE_PREFIX LV2_BUF_SIZE_URI "#" ///< http://lv2plug.in/ns/ext/buf-size#
+
+#define LV2_BUF_SIZE__boundedBlockLength LV2_BUF_SIZE_PREFIX "boundedBlockLength" ///< http://lv2plug.in/ns/ext/buf-size#boundedBlockLength
+#define LV2_BUF_SIZE__fixedBlockLength LV2_BUF_SIZE_PREFIX "fixedBlockLength" ///< http://lv2plug.in/ns/ext/buf-size#fixedBlockLength
+#define LV2_BUF_SIZE__maxBlockLength LV2_BUF_SIZE_PREFIX "maxBlockLength" ///< http://lv2plug.in/ns/ext/buf-size#maxBlockLength
+#define LV2_BUF_SIZE__minBlockLength LV2_BUF_SIZE_PREFIX "minBlockLength" ///< http://lv2plug.in/ns/ext/buf-size#minBlockLength
+#define LV2_BUF_SIZE__nominalBlockLength LV2_BUF_SIZE_PREFIX "nominalBlockLength" ///< http://lv2plug.in/ns/ext/buf-size#nominalBlockLength
+#define LV2_BUF_SIZE__powerOf2BlockLength LV2_BUF_SIZE_PREFIX "powerOf2BlockLength" ///< http://lv2plug.in/ns/ext/buf-size#powerOf2BlockLength
+#define LV2_BUF_SIZE__sequenceSize LV2_BUF_SIZE_PREFIX "sequenceSize" ///< http://lv2plug.in/ns/ext/buf-size#sequenceSize
+
+/**
+ @}
+*/
#endif /* LV2_BUF_SIZE_H */
diff --git a/lv2/buf-size/buf-size.meta.ttl b/lv2/buf-size/buf-size.meta.ttl
new file mode 100644
index 0000000..b1d8011
--- /dev/null
+++ b/lv2/buf-size/buf-size.meta.ttl
@@ -0,0 +1,157 @@
+@prefix bufsz: <http://lv2plug.in/ns/ext/buf-size#> .
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/buf-size>
+ a doap:Project ;
+ doap:name "LV2 Buf Size" ;
+ doap:shortdesc "Access to, and restrictions on, buffer sizes." ;
+ doap:created "2012-08-07" ;
+ doap:developer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "1.4" ;
+ doap:created "2015-09-18" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.14.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add bufsz:nominalBlockLength option."
+ ] , [
+ rdfs:label "Add bufsz:coarseBlockLength feature."
+ ]
+ ]
+ ] , [
+ doap:revision "1.2" ;
+ doap:created "2012-12-21" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix typo in bufsz:sequenceSize label."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+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.
+
+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 [options](options.html).
+
+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.
+
+"""^^lv2:Markdown .
+
+bufsz:boundedBlockLength
+ lv2:documentation """
+
+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.
+
+All hosts SHOULD support this feature, since it is simple to support and
+necessary for any plugins that may need to copy the input.
+
+"""^^lv2:Markdown .
+
+bufsz:fixedBlockLength
+ lv2:documentation """
+
+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.
+
+Note that requiring this feature may severely limit the number of hosts capable
+of running the plugin.
+
+"""^^lv2:Markdown .
+
+bufsz:powerOf2BlockLength
+ lv2:documentation """
+
+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.
+
+Note that requiring this feature may severely limit the number of hosts capable
+of running the plugin.
+
+"""^^lv2:Markdown .
+
+bufsz:coarseBlockLength
+ lv2:documentation """
+
+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.
+
+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.
+
+"""^^lv2:Markdown .
+
+bufsz:maxBlockLength
+ lv2:documentation """
+
+The maximum block length the host will ever request the plugin to process at
+once, that is, the maximum `sample_count` parameter that will ever be passed to
+LV2_Descriptor::run().
+
+"""^^lv2:Markdown .
+
+bufsz:minBlockLength
+ lv2:documentation """
+
+The minimum block length the host will ever request the plugin to process at
+once, that is, the minimum `sample_count` parameter that will ever be passed to
+LV2_Descriptor::run().
+
+"""^^lv2:Markdown .
+
+bufsz:nominalBlockLength
+ lv2:documentation """
+
+The typical block length the host will request the plugin to process at once,
+that is, the typical `sample_count` 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.
+
+"""^^lv2:Markdown .
+
+bufsz:sequenceSize
+ lv2:documentation """
+
+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.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/buf-size/buf-size.ttl b/lv2/buf-size/buf-size.ttl
new file mode 100644
index 0000000..8863198
--- /dev/null
+++ b/lv2/buf-size/buf-size.ttl
@@ -0,0 +1,67 @@
+@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 owl:Ontology ;
+ rdfs:label "LV2 Buf Size" ;
+ rdfs:comment "Access to, and restrictions on, buffer sizes." ;
+ rdfs:seeAlso <buf-size.h> ,
+ <buf-size.meta.ttl> .
+
+bufsz:boundedBlockLength
+ a lv2:Feature ;
+ rdfs:label "bounded block length" ;
+ rdfs:comment "Block length has lower and upper bounds." .
+
+bufsz:fixedBlockLength
+ a lv2:Feature ;
+ rdfs:label "fixed block length" ;
+ rdfs:comment "Block length never changes." .
+
+bufsz:powerOf2BlockLength
+ a lv2:Feature ;
+ 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" ;
+ 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: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: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: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:comment "The maximum size of a sequence, in bytes." ;
+ rdfs:range xsd:nonNegativeInteger .
+
diff --git a/lv2/lv2plug.in/ns/ext/buf-size/manifest.ttl b/lv2/buf-size/manifest.ttl
index 2578336..d242f97 100644
--- a/lv2/lv2plug.in/ns/ext/buf-size/manifest.ttl
+++ b/lv2/buf-size/manifest.ttl
@@ -1,9 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/buf-size>
a lv2:Specification ;
lv2:minorVersion 1 ;
- lv2:microVersion 2 ;
+ lv2:microVersion 4 ;
rdfs:seeAlso <buf-size.ttl> .
diff --git a/lv2/core/attributes.h b/lv2/core/attributes.h
new file mode 100644
index 0000000..7465c22
--- /dev/null
+++ b/lv2/core/attributes.h
@@ -0,0 +1,59 @@
+/*
+ Copyright 2018 David Robillard <http://drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#ifndef LV2_CORE_ATTRIBUTES_H
+#define LV2_CORE_ATTRIBUTES_H
+
+/**
+ @defgroup attributes Attributes
+ @ingroup lv2
+
+ Macros for source code attributes.
+
+ @{
+*/
+
+#if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
+#define LV2_DEPRECATED __attribute__((__deprecated__))
+#else
+#define LV2_DEPRECATED
+#endif
+
+#if defined(__clang__)
+#define LV2_DISABLE_DEPRECATION_WARNINGS \
+ _Pragma("clang diagnostic push") \
+ _Pragma("clang diagnostic ignored \"-Wdeprecated-declarations\"")
+#elif __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
+#define LV2_DISABLE_DEPRECATION_WARNINGS \
+ _Pragma("GCC diagnostic push") \
+ _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
+#else
+#define LV2_DISABLE_DEPRECATION_WARNINGS
+#endif
+
+#if defined(__clang__)
+#define LV2_RESTORE_WARNINGS _Pragma("clang diagnostic pop")
+#elif __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
+#define LV2_RESTORE_WARNINGS _Pragma("GCC diagnostic pop")
+#else
+#define LV2_RESTORE_WARNINGS
+#endif
+
+/**
+ @}
+*/
+
+#endif /* LV2_CORE_ATTRIBUTES_H */
diff --git a/lv2/lv2plug.in/ns/lv2core/lv2.h b/lv2/core/lv2.h
index fb4df4d..9b2de6f 100644
--- a/lv2/lv2plug.in/ns/lv2core/lv2.h
+++ b/lv2/core/lv2.h
@@ -19,9 +19,19 @@
*/
/**
- @file lv2.h
- API for the LV2 specification <http://lv2plug.in/ns/lv2core>.
- Revision: 6.5
+ @defgroup lv2 LV2
+
+ The LV2 specification.
+
+ @{
+*/
+
+/**
+ @defgroup lv2core LV2 Core
+
+ Core LV2 specification, see <http://lv2plug.in/ns/lv2core> for details.
+
+ @{
*/
#ifndef LV2_H_INCLUDED
@@ -29,92 +39,93 @@
#include <stdint.h>
-#define LV2_CORE_URI "http://lv2plug.in/ns/lv2core"
-#define LV2_CORE_PREFIX LV2_CORE_URI "#"
-
-#define LV2_CORE__AllpassPlugin LV2_CORE_PREFIX "AllpassPlugin"
-#define LV2_CORE__AmplifierPlugin LV2_CORE_PREFIX "AmplifierPlugin"
-#define LV2_CORE__AnalyserPlugin LV2_CORE_PREFIX "AnalyserPlugin"
-#define LV2_CORE__AudioPort LV2_CORE_PREFIX "AudioPort"
-#define LV2_CORE__BandpassPlugin LV2_CORE_PREFIX "BandpassPlugin"
-#define LV2_CORE__CVPort LV2_CORE_PREFIX "CVPort"
-#define LV2_CORE__ChorusPlugin LV2_CORE_PREFIX "ChorusPlugin"
-#define LV2_CORE__CombPlugin LV2_CORE_PREFIX "CombPlugin"
-#define LV2_CORE__CompressorPlugin LV2_CORE_PREFIX "CompressorPlugin"
-#define LV2_CORE__ConstantPlugin LV2_CORE_PREFIX "ConstantPlugin"
-#define LV2_CORE__ControlPort LV2_CORE_PREFIX "ControlPort"
-#define LV2_CORE__ConverterPlugin LV2_CORE_PREFIX "ConverterPlugin"
-#define LV2_CORE__DelayPlugin LV2_CORE_PREFIX "DelayPlugin"
-#define LV2_CORE__DistortionPlugin LV2_CORE_PREFIX "DistortionPlugin"
-#define LV2_CORE__DynamicsPlugin LV2_CORE_PREFIX "DynamicsPlugin"
-#define LV2_CORE__EQPlugin LV2_CORE_PREFIX "EQPlugin"
-#define LV2_CORE__EnvelopePlugin LV2_CORE_PREFIX "EnvelopePlugin"
-#define LV2_CORE__ExpanderPlugin LV2_CORE_PREFIX "ExpanderPlugin"
-#define LV2_CORE__ExtensionData LV2_CORE_PREFIX "ExtensionData"
-#define LV2_CORE__Feature LV2_CORE_PREFIX "Feature"
-#define LV2_CORE__FilterPlugin LV2_CORE_PREFIX "FilterPlugin"
-#define LV2_CORE__FlangerPlugin LV2_CORE_PREFIX "FlangerPlugin"
-#define LV2_CORE__FunctionPlugin LV2_CORE_PREFIX "FunctionPlugin"
-#define LV2_CORE__GatePlugin LV2_CORE_PREFIX "GatePlugin"
-#define LV2_CORE__GeneratorPlugin LV2_CORE_PREFIX "GeneratorPlugin"
-#define LV2_CORE__HighpassPlugin LV2_CORE_PREFIX "HighpassPlugin"
-#define LV2_CORE__InputPort LV2_CORE_PREFIX "InputPort"
-#define LV2_CORE__InstrumentPlugin LV2_CORE_PREFIX "InstrumentPlugin"
-#define LV2_CORE__LimiterPlugin LV2_CORE_PREFIX "LimiterPlugin"
-#define LV2_CORE__LowpassPlugin LV2_CORE_PREFIX "LowpassPlugin"
-#define LV2_CORE__MixerPlugin LV2_CORE_PREFIX "MixerPlugin"
-#define LV2_CORE__ModulatorPlugin LV2_CORE_PREFIX "ModulatorPlugin"
-#define LV2_CORE__MultiEQPlugin LV2_CORE_PREFIX "MultiEQPlugin"
-#define LV2_CORE__OscillatorPlugin LV2_CORE_PREFIX "OscillatorPlugin"
-#define LV2_CORE__OutputPort LV2_CORE_PREFIX "OutputPort"
-#define LV2_CORE__ParaEQPlugin LV2_CORE_PREFIX "ParaEQPlugin"
-#define LV2_CORE__PhaserPlugin LV2_CORE_PREFIX "PhaserPlugin"
-#define LV2_CORE__PitchPlugin LV2_CORE_PREFIX "PitchPlugin"
-#define LV2_CORE__Plugin LV2_CORE_PREFIX "Plugin"
-#define LV2_CORE__PluginBase LV2_CORE_PREFIX "PluginBase"
-#define LV2_CORE__Point LV2_CORE_PREFIX "Point"
-#define LV2_CORE__Port LV2_CORE_PREFIX "Port"
-#define LV2_CORE__PortProperty LV2_CORE_PREFIX "PortProperty"
-#define LV2_CORE__Resource LV2_CORE_PREFIX "Resource"
-#define LV2_CORE__ReverbPlugin LV2_CORE_PREFIX "ReverbPlugin"
-#define LV2_CORE__ScalePoint LV2_CORE_PREFIX "ScalePoint"
-#define LV2_CORE__SimulatorPlugin LV2_CORE_PREFIX "SimulatorPlugin"
-#define LV2_CORE__SpatialPlugin LV2_CORE_PREFIX "SpatialPlugin"
-#define LV2_CORE__Specification LV2_CORE_PREFIX "Specification"
-#define LV2_CORE__SpectralPlugin LV2_CORE_PREFIX "SpectralPlugin"
-#define LV2_CORE__UtilityPlugin LV2_CORE_PREFIX "UtilityPlugin"
-#define LV2_CORE__WaveshaperPlugin LV2_CORE_PREFIX "WaveshaperPlugin"
-#define LV2_CORE__appliesTo LV2_CORE_PREFIX "appliesTo"
-#define LV2_CORE__binary LV2_CORE_PREFIX "binary"
-#define LV2_CORE__connectionOptional LV2_CORE_PREFIX "connectionOptional"
-#define LV2_CORE__control LV2_CORE_PREFIX "control"
-#define LV2_CORE__default LV2_CORE_PREFIX "default"
-#define LV2_CORE__designation LV2_CORE_PREFIX "designation"
-#define LV2_CORE__documentation LV2_CORE_PREFIX "documentation"
-#define LV2_CORE__enumeration LV2_CORE_PREFIX "enumeration"
-#define LV2_CORE__extensionData LV2_CORE_PREFIX "extensionData"
-#define LV2_CORE__freeWheeling LV2_CORE_PREFIX "freeWheeling"
-#define LV2_CORE__hardRTCapable LV2_CORE_PREFIX "hardRTCapable"
-#define LV2_CORE__inPlaceBroken LV2_CORE_PREFIX "inPlaceBroken"
-#define LV2_CORE__index LV2_CORE_PREFIX "index"
-#define LV2_CORE__integer LV2_CORE_PREFIX "integer"
-#define LV2_CORE__isLive LV2_CORE_PREFIX "isLive"
-#define LV2_CORE__latency LV2_CORE_PREFIX "latency"
-#define LV2_CORE__maximum LV2_CORE_PREFIX "maximum"
-#define LV2_CORE__microVersion LV2_CORE_PREFIX "microVersion"
-#define LV2_CORE__minimum LV2_CORE_PREFIX "minimum"
-#define LV2_CORE__minorVersion LV2_CORE_PREFIX "minorVersion"
-#define LV2_CORE__name LV2_CORE_PREFIX "name"
-#define LV2_CORE__optionalFeature LV2_CORE_PREFIX "optionalFeature"
-#define LV2_CORE__port LV2_CORE_PREFIX "port"
-#define LV2_CORE__portProperty LV2_CORE_PREFIX "portProperty"
-#define LV2_CORE__project LV2_CORE_PREFIX "project"
-#define LV2_CORE__reportsLatency LV2_CORE_PREFIX "reportsLatency"
-#define LV2_CORE__requiredFeature LV2_CORE_PREFIX "requiredFeature"
-#define LV2_CORE__sampleRate LV2_CORE_PREFIX "sampleRate"
-#define LV2_CORE__scalePoint LV2_CORE_PREFIX "scalePoint"
-#define LV2_CORE__symbol LV2_CORE_PREFIX "symbol"
-#define LV2_CORE__toggled LV2_CORE_PREFIX "toggled"
+#define LV2_CORE_URI "http://lv2plug.in/ns/lv2core" ///< http://lv2plug.in/ns/lv2core
+#define LV2_CORE_PREFIX LV2_CORE_URI "#" ///< http://lv2plug.in/ns/lv2core#
+
+#define LV2_CORE__AllpassPlugin LV2_CORE_PREFIX "AllpassPlugin" ///< http://lv2plug.in/ns/lv2core#AllpassPlugin
+#define LV2_CORE__AmplifierPlugin LV2_CORE_PREFIX "AmplifierPlugin" ///< http://lv2plug.in/ns/lv2core#AmplifierPlugin
+#define LV2_CORE__AnalyserPlugin LV2_CORE_PREFIX "AnalyserPlugin" ///< http://lv2plug.in/ns/lv2core#AnalyserPlugin
+#define LV2_CORE__AudioPort LV2_CORE_PREFIX "AudioPort" ///< http://lv2plug.in/ns/lv2core#AudioPort
+#define LV2_CORE__BandpassPlugin LV2_CORE_PREFIX "BandpassPlugin" ///< http://lv2plug.in/ns/lv2core#BandpassPlugin
+#define LV2_CORE__CVPort LV2_CORE_PREFIX "CVPort" ///< http://lv2plug.in/ns/lv2core#CVPort
+#define LV2_CORE__ChorusPlugin LV2_CORE_PREFIX "ChorusPlugin" ///< http://lv2plug.in/ns/lv2core#ChorusPlugin
+#define LV2_CORE__CombPlugin LV2_CORE_PREFIX "CombPlugin" ///< http://lv2plug.in/ns/lv2core#CombPlugin
+#define LV2_CORE__CompressorPlugin LV2_CORE_PREFIX "CompressorPlugin" ///< http://lv2plug.in/ns/lv2core#CompressorPlugin
+#define LV2_CORE__ConstantPlugin LV2_CORE_PREFIX "ConstantPlugin" ///< http://lv2plug.in/ns/lv2core#ConstantPlugin
+#define LV2_CORE__ControlPort LV2_CORE_PREFIX "ControlPort" ///< http://lv2plug.in/ns/lv2core#ControlPort
+#define LV2_CORE__ConverterPlugin LV2_CORE_PREFIX "ConverterPlugin" ///< http://lv2plug.in/ns/lv2core#ConverterPlugin
+#define LV2_CORE__DelayPlugin LV2_CORE_PREFIX "DelayPlugin" ///< http://lv2plug.in/ns/lv2core#DelayPlugin
+#define LV2_CORE__DistortionPlugin LV2_CORE_PREFIX "DistortionPlugin" ///< http://lv2plug.in/ns/lv2core#DistortionPlugin
+#define LV2_CORE__DynamicsPlugin LV2_CORE_PREFIX "DynamicsPlugin" ///< http://lv2plug.in/ns/lv2core#DynamicsPlugin
+#define LV2_CORE__EQPlugin LV2_CORE_PREFIX "EQPlugin" ///< http://lv2plug.in/ns/lv2core#EQPlugin
+#define LV2_CORE__EnvelopePlugin LV2_CORE_PREFIX "EnvelopePlugin" ///< http://lv2plug.in/ns/lv2core#EnvelopePlugin
+#define LV2_CORE__ExpanderPlugin LV2_CORE_PREFIX "ExpanderPlugin" ///< http://lv2plug.in/ns/lv2core#ExpanderPlugin
+#define LV2_CORE__ExtensionData LV2_CORE_PREFIX "ExtensionData" ///< http://lv2plug.in/ns/lv2core#ExtensionData
+#define LV2_CORE__Feature LV2_CORE_PREFIX "Feature" ///< http://lv2plug.in/ns/lv2core#Feature
+#define LV2_CORE__FilterPlugin LV2_CORE_PREFIX "FilterPlugin" ///< http://lv2plug.in/ns/lv2core#FilterPlugin
+#define LV2_CORE__FlangerPlugin LV2_CORE_PREFIX "FlangerPlugin" ///< http://lv2plug.in/ns/lv2core#FlangerPlugin
+#define LV2_CORE__FunctionPlugin LV2_CORE_PREFIX "FunctionPlugin" ///< http://lv2plug.in/ns/lv2core#FunctionPlugin
+#define LV2_CORE__GatePlugin LV2_CORE_PREFIX "GatePlugin" ///< http://lv2plug.in/ns/lv2core#GatePlugin
+#define LV2_CORE__GeneratorPlugin LV2_CORE_PREFIX "GeneratorPlugin" ///< http://lv2plug.in/ns/lv2core#GeneratorPlugin
+#define LV2_CORE__HighpassPlugin LV2_CORE_PREFIX "HighpassPlugin" ///< http://lv2plug.in/ns/lv2core#HighpassPlugin
+#define LV2_CORE__InputPort LV2_CORE_PREFIX "InputPort" ///< http://lv2plug.in/ns/lv2core#InputPort
+#define LV2_CORE__InstrumentPlugin LV2_CORE_PREFIX "InstrumentPlugin" ///< http://lv2plug.in/ns/lv2core#InstrumentPlugin
+#define LV2_CORE__LimiterPlugin LV2_CORE_PREFIX "LimiterPlugin" ///< http://lv2plug.in/ns/lv2core#LimiterPlugin
+#define LV2_CORE__LowpassPlugin LV2_CORE_PREFIX "LowpassPlugin" ///< http://lv2plug.in/ns/lv2core#LowpassPlugin
+#define LV2_CORE__MixerPlugin LV2_CORE_PREFIX "MixerPlugin" ///< http://lv2plug.in/ns/lv2core#MixerPlugin
+#define LV2_CORE__ModulatorPlugin LV2_CORE_PREFIX "ModulatorPlugin" ///< http://lv2plug.in/ns/lv2core#ModulatorPlugin
+#define LV2_CORE__MultiEQPlugin LV2_CORE_PREFIX "MultiEQPlugin" ///< http://lv2plug.in/ns/lv2core#MultiEQPlugin
+#define LV2_CORE__OscillatorPlugin LV2_CORE_PREFIX "OscillatorPlugin" ///< http://lv2plug.in/ns/lv2core#OscillatorPlugin
+#define LV2_CORE__OutputPort LV2_CORE_PREFIX "OutputPort" ///< http://lv2plug.in/ns/lv2core#OutputPort
+#define LV2_CORE__ParaEQPlugin LV2_CORE_PREFIX "ParaEQPlugin" ///< http://lv2plug.in/ns/lv2core#ParaEQPlugin
+#define LV2_CORE__PhaserPlugin LV2_CORE_PREFIX "PhaserPlugin" ///< http://lv2plug.in/ns/lv2core#PhaserPlugin
+#define LV2_CORE__PitchPlugin LV2_CORE_PREFIX "PitchPlugin" ///< http://lv2plug.in/ns/lv2core#PitchPlugin
+#define LV2_CORE__Plugin LV2_CORE_PREFIX "Plugin" ///< http://lv2plug.in/ns/lv2core#Plugin
+#define LV2_CORE__PluginBase LV2_CORE_PREFIX "PluginBase" ///< http://lv2plug.in/ns/lv2core#PluginBase
+#define LV2_CORE__Point LV2_CORE_PREFIX "Point" ///< http://lv2plug.in/ns/lv2core#Point
+#define LV2_CORE__Port LV2_CORE_PREFIX "Port" ///< http://lv2plug.in/ns/lv2core#Port
+#define LV2_CORE__PortProperty LV2_CORE_PREFIX "PortProperty" ///< http://lv2plug.in/ns/lv2core#PortProperty
+#define LV2_CORE__Resource LV2_CORE_PREFIX "Resource" ///< http://lv2plug.in/ns/lv2core#Resource
+#define LV2_CORE__ReverbPlugin LV2_CORE_PREFIX "ReverbPlugin" ///< http://lv2plug.in/ns/lv2core#ReverbPlugin
+#define LV2_CORE__ScalePoint LV2_CORE_PREFIX "ScalePoint" ///< http://lv2plug.in/ns/lv2core#ScalePoint
+#define LV2_CORE__SimulatorPlugin LV2_CORE_PREFIX "SimulatorPlugin" ///< http://lv2plug.in/ns/lv2core#SimulatorPlugin
+#define LV2_CORE__SpatialPlugin LV2_CORE_PREFIX "SpatialPlugin" ///< http://lv2plug.in/ns/lv2core#SpatialPlugin
+#define LV2_CORE__Specification LV2_CORE_PREFIX "Specification" ///< http://lv2plug.in/ns/lv2core#Specification
+#define LV2_CORE__SpectralPlugin LV2_CORE_PREFIX "SpectralPlugin" ///< http://lv2plug.in/ns/lv2core#SpectralPlugin
+#define LV2_CORE__UtilityPlugin LV2_CORE_PREFIX "UtilityPlugin" ///< http://lv2plug.in/ns/lv2core#UtilityPlugin
+#define LV2_CORE__WaveshaperPlugin LV2_CORE_PREFIX "WaveshaperPlugin" ///< http://lv2plug.in/ns/lv2core#WaveshaperPlugin
+#define LV2_CORE__appliesTo LV2_CORE_PREFIX "appliesTo" ///< http://lv2plug.in/ns/lv2core#appliesTo
+#define LV2_CORE__binary LV2_CORE_PREFIX "binary" ///< http://lv2plug.in/ns/lv2core#binary
+#define LV2_CORE__connectionOptional LV2_CORE_PREFIX "connectionOptional" ///< http://lv2plug.in/ns/lv2core#connectionOptional
+#define LV2_CORE__control LV2_CORE_PREFIX "control" ///< http://lv2plug.in/ns/lv2core#control
+#define LV2_CORE__default LV2_CORE_PREFIX "default" ///< http://lv2plug.in/ns/lv2core#default
+#define LV2_CORE__designation LV2_CORE_PREFIX "designation" ///< http://lv2plug.in/ns/lv2core#designation
+#define LV2_CORE__documentation LV2_CORE_PREFIX "documentation" ///< http://lv2plug.in/ns/lv2core#documentation
+#define LV2_CORE__enumeration LV2_CORE_PREFIX "enumeration" ///< http://lv2plug.in/ns/lv2core#enumeration
+#define LV2_CORE__extensionData LV2_CORE_PREFIX "extensionData" ///< http://lv2plug.in/ns/lv2core#extensionData
+#define LV2_CORE__freeWheeling LV2_CORE_PREFIX "freeWheeling" ///< http://lv2plug.in/ns/lv2core#freeWheeling
+#define LV2_CORE__hardRTCapable LV2_CORE_PREFIX "hardRTCapable" ///< http://lv2plug.in/ns/lv2core#hardRTCapable
+#define LV2_CORE__inPlaceBroken LV2_CORE_PREFIX "inPlaceBroken" ///< http://lv2plug.in/ns/lv2core#inPlaceBroken
+#define LV2_CORE__index LV2_CORE_PREFIX "index" ///< http://lv2plug.in/ns/lv2core#index
+#define LV2_CORE__integer LV2_CORE_PREFIX "integer" ///< http://lv2plug.in/ns/lv2core#integer
+#define LV2_CORE__isLive LV2_CORE_PREFIX "isLive" ///< http://lv2plug.in/ns/lv2core#isLive
+#define LV2_CORE__latency LV2_CORE_PREFIX "latency" ///< http://lv2plug.in/ns/lv2core#latency
+#define LV2_CORE__maximum LV2_CORE_PREFIX "maximum" ///< http://lv2plug.in/ns/lv2core#maximum
+#define LV2_CORE__microVersion LV2_CORE_PREFIX "microVersion" ///< http://lv2plug.in/ns/lv2core#microVersion
+#define LV2_CORE__minimum LV2_CORE_PREFIX "minimum" ///< http://lv2plug.in/ns/lv2core#minimum
+#define LV2_CORE__minorVersion LV2_CORE_PREFIX "minorVersion" ///< http://lv2plug.in/ns/lv2core#minorVersion
+#define LV2_CORE__name LV2_CORE_PREFIX "name" ///< http://lv2plug.in/ns/lv2core#name
+#define LV2_CORE__optionalFeature LV2_CORE_PREFIX "optionalFeature" ///< http://lv2plug.in/ns/lv2core#optionalFeature
+#define LV2_CORE__port LV2_CORE_PREFIX "port" ///< http://lv2plug.in/ns/lv2core#port
+#define LV2_CORE__portProperty LV2_CORE_PREFIX "portProperty" ///< http://lv2plug.in/ns/lv2core#portProperty
+#define LV2_CORE__project LV2_CORE_PREFIX "project" ///< http://lv2plug.in/ns/lv2core#project
+#define LV2_CORE__prototype LV2_CORE_PREFIX "prototype" ///< http://lv2plug.in/ns/lv2core#prototype
+#define LV2_CORE__reportsLatency LV2_CORE_PREFIX "reportsLatency" ///< http://lv2plug.in/ns/lv2core#reportsLatency
+#define LV2_CORE__requiredFeature LV2_CORE_PREFIX "requiredFeature" ///< http://lv2plug.in/ns/lv2core#requiredFeature
+#define LV2_CORE__sampleRate LV2_CORE_PREFIX "sampleRate" ///< http://lv2plug.in/ns/lv2core#sampleRate
+#define LV2_CORE__scalePoint LV2_CORE_PREFIX "scalePoint" ///< http://lv2plug.in/ns/lv2core#scalePoint
+#define LV2_CORE__symbol LV2_CORE_PREFIX "symbol" ///< http://lv2plug.in/ns/lv2core#symbol
+#define LV2_CORE__toggled LV2_CORE_PREFIX "toggled" ///< http://lv2plug.in/ns/lv2core#toggled
#ifdef __cplusplus
extern "C" {
@@ -134,10 +145,10 @@ typedef void * LV2_Handle;
Features allow hosts to make additional functionality available to plugins
without requiring modification to the LV2 API. Extensions may define new
- features and specify the @ref URI and @ref data to be used if necessary.
+ features and specify the `URI` and `data` to be used if necessary.
Some features, such as lv2:isLive, do not require the host to pass data.
*/
-typedef struct _LV2_Feature {
+typedef struct {
/**
A globally unique, case-sensitive identifier (URI) for this feature.
@@ -149,7 +160,7 @@ typedef struct _LV2_Feature {
Pointer to arbitrary data.
The format of this data is defined by the extension which describes the
- feature with the given @ref URI.
+ feature with the given `URI`.
*/
void * data;
} LV2_Feature;
@@ -160,7 +171,7 @@ typedef struct _LV2_Feature {
This structure provides the core functions necessary to instantiate and use
a plugin.
*/
-typedef struct _LV2_Descriptor {
+typedef struct LV2_Descriptor {
/**
A globally unique, case-sensitive identifier for this plugin.
@@ -182,9 +193,8 @@ typedef struct _LV2_Descriptor {
@param sample_rate Sample rate, in Hz, for the new plugin instance.
@param bundle_path Path to the LV2 bundle which contains this plugin
- binary. It MUST include the trailing directory separator (e.g. '/') so
- that simply appending a filename will yield the path to that file in the
- bundle.
+ binary. It MUST include the trailing directory separator so that simply
+ appending a filename will yield the path to that file in the bundle.
@param features A NULL terminated array of LV2_Feature structs which
represent the features the host supports. Plugins may refuse to
@@ -198,10 +208,10 @@ typedef struct _LV2_Descriptor {
@return A handle for the new plugin instance, or NULL if instantiation
has failed.
*/
- LV2_Handle (*instantiate)(const struct _LV2_Descriptor * descriptor,
- double sample_rate,
- const char * bundle_path,
- const LV2_Feature *const * features);
+ LV2_Handle (*instantiate)(const struct LV2_Descriptor * descriptor,
+ double sample_rate,
+ const char * bundle_path,
+ const LV2_Feature *const * features);
/**
Connect a port on a plugin instance to a memory location.
@@ -232,7 +242,7 @@ typedef struct _LV2_Descriptor {
it does, the plugin's behaviour is undefined (a crash is likely).
@param data_location Pointer to data of the type defined by the port
- type in the plugin's RDF data (e.g. an array of float for an
+ type in the plugin's RDF data (for example, an array of float for an
lv2:AudioPort). This pointer must be stored by the plugin instance and
used to read/write data when run() is called. Data present at the time
of the connect_port() call MUST NOT be considered meaningful.
@@ -275,12 +285,12 @@ typedef struct _LV2_Descriptor {
things that the plugin MUST NOT do within the run() function (see
lv2core.ttl for details).
- As a special case, when @p sample_count == 0, the plugin should update
- any output ports that represent a single instant in time (e.g. control
- ports, but not audio ports). This is particularly useful for latent
- plugins, which should update their latency output port so hosts can
- pre-roll plugins to compute latency. Plugins MUST NOT crash when
- @p sample_count == 0.
+ As a special case, when `sample_count` is 0, the plugin should update
+ any output ports that represent a single instant in time (for example,
+ control ports, but not audio ports). This is particularly useful for
+ latent plugins, which should update their latency output port so hosts
+ can pre-roll plugins to compute latency. Plugins MUST NOT crash when
+ `sample_count` is 0.
@param instance Instance to be run.
@@ -340,40 +350,45 @@ typedef struct _LV2_Descriptor {
} LV2_Descriptor;
/**
+ Helper macro needed for LV2_SYMBOL_EXPORT when using C++.
+*/
+#ifdef __cplusplus
+# define LV2_SYMBOL_EXTERN extern "C"
+#else
+# define LV2_SYMBOL_EXTERN
+#endif
+
+/**
Put this (LV2_SYMBOL_EXPORT) before any functions that are to be loaded
by the host as a symbol from the dynamic library.
*/
#ifdef _WIN32
-# define LV2_SYMBOL_EXPORT __declspec(dllexport)
+# define LV2_SYMBOL_EXPORT LV2_SYMBOL_EXTERN __declspec(dllexport)
#else
-# define LV2_SYMBOL_EXPORT
+# define LV2_SYMBOL_EXPORT LV2_SYMBOL_EXTERN __attribute__((visibility("default")))
#endif
/**
Prototype for plugin accessor function.
- This is part of the old discovery API, which has been replaced due to being
- inadequate for some plugins. It is limited because the bundle path is not
- available during discovery, and it relies on non-portable shared library
- constructors/destructors. However, this API is still supported and plugins
- are not required to migrate.
-
Plugins are discovered by hosts using RDF data (not by loading libraries).
See http://lv2plug.in for details on the discovery process, though most
hosts should use an existing library to implement this functionality.
- A plugin library MUST include a function called "lv2_descriptor" with this
- prototype. This function MUST have C-style linkage (if you are using C++
- this is taken care of by the 'extern "C"' clause at the top of this file).
+ This is the simple plugin discovery API, suitable for most statically
+ defined plugins. Advanced plugins that need access to their bundle during
+ discovery can use lv2_lib_descriptor() instead. Plugin libraries MUST
+ include a function called "lv2_descriptor" or "lv2_lib_descriptor" with
+ C-style linkage, but SHOULD provide "lv2_descriptor" wherever possible.
When it is time to load a plugin (designated by its URI), the host loads the
plugin's library, gets the lv2_descriptor() function from it, and uses this
function to find the LV2_Descriptor for the desired plugin. Plugins are
accessed by index using values from 0 upwards. This function MUST return
NULL for out of range indices, so the host can enumerate plugins by
- increasing @p index until NULL is returned.
+ increasing `index` until NULL is returned.
- Note that @p index has no meaning, hosts MUST NOT depend on it remaining
+ Note that `index` has no meaning, hosts MUST NOT depend on it remaining
consistent between loads of the plugin library.
*/
LV2_SYMBOL_EXPORT
@@ -421,7 +436,7 @@ typedef struct {
Plugins are accessed by index using values from 0 upwards. Out of range
indices MUST result in this function returning NULL, so the host can
- enumerate plugins by increasing @a index until NULL is returned.
+ enumerate plugins by increasing `index` until NULL is returned.
*/
const LV2_Descriptor * (*get_plugin)(LV2_Lib_Handle handle,
uint32_t index);
@@ -430,12 +445,20 @@ typedef struct {
/**
Prototype for library accessor function.
+ This is the more advanced discovery API, which allows plugin libraries to
+ access their bundles during discovery, which makes it possible for plugins to
+ be dynamically defined by files in their bundle. This API also has an
+ explicit cleanup function, removing any need for non-portable shared library
+ destructors. Simple plugins that do not require these features may use
+ lv2_descriptor() instead.
+
This is the entry point for a plugin library. Hosts load this symbol from
the library and call this function to obtain a library descriptor which can
be used to access all the contained plugins. The returned object must not
be destroyed (using LV2_Lib_Descriptor::cleanup()) until all plugins loaded
from that library have been destroyed.
*/
+LV2_SYMBOL_EXPORT
const LV2_Lib_Descriptor *
lv2_lib_descriptor(const char * bundle_path,
const LV2_Feature *const * features);
@@ -452,3 +475,8 @@ typedef const LV2_Lib_Descriptor *
#endif
#endif /* LV2_H_INCLUDED */
+
+/**
+ @}
+ @}
+*/
diff --git a/lv2/core/lv2_util.h b/lv2/core/lv2_util.h
new file mode 100644
index 0000000..0792941
--- /dev/null
+++ b/lv2/core/lv2_util.h
@@ -0,0 +1,102 @@
+/*
+ Copyright 2016 David Robillard <http://drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+/**
+ @defgroup util Utilities
+ @ingroup lv2core
+ @{
+*/
+
+#include "lv2/core/lv2.h"
+
+#include <stdarg.h>
+#include <stdbool.h>
+#include <string.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ Return the data for a feature in a features array.
+
+ If the feature is not found, NULL is returned. Note that this function is
+ only useful for features with data, and can not detect features that are
+ present but have NULL data.
+*/
+static inline void*
+lv2_features_data(const LV2_Feature*const* features,
+ const char* const uri)
+{
+ if (features) {
+ for (const LV2_Feature*const* f = features; *f; ++f) {
+ if (!strcmp(uri, (*f)->URI)) {
+ return (*f)->data;
+ }
+ }
+ }
+ return NULL;
+}
+
+/**
+ Query a features array.
+
+ This function allows getting several features in one call, and detect
+ missing required features, with the same caveat of lv2_features_data().
+
+ The arguments should be a series of const char* uri, void** data, bool
+ required, terminated by a NULL URI. The data pointers MUST be initialized
+ to NULL. For example:
+
+ @code
+ LV2_URID_Log* log = NULL;
+ LV2_URID_Map* map = NULL;
+ const char* missing = lv2_features_query(
+ features,
+ LV2_LOG__log, &log, false,
+ LV2_URID__map, &map, true,
+ NULL);
+ @endcode
+
+ @return NULL on success, otherwise the URI of this missing feature.
+*/
+static inline const char*
+lv2_features_query(const LV2_Feature* const* features, ...)
+{
+ va_list args;
+ va_start(args, features);
+
+ const char* uri = NULL;
+ while ((uri = va_arg(args, const char*))) {
+ void** data = va_arg(args, void**);
+ bool required = va_arg(args, int);
+
+ *data = lv2_features_data(features, uri);
+ if (required && !*data) {
+ return uri;
+ }
+ }
+
+ return NULL;
+}
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+/**
+ @}
+*/
diff --git a/lv2/core/lv2core.meta.ttl b/lv2/core/lv2core.meta.ttl
new file mode 100644
index 0000000..1dca855
--- /dev/null
+++ b/lv2/core/lv2core.meta.ttl
@@ -0,0 +1,906 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/lv2core>
+ a doap:Project ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ doap:name "LV2" ;
+ doap:homepage <http://lv2plug.in> ;
+ doap:created "2004-04-21" ;
+ doap:shortdesc "An extensible open standard for audio plugins" ;
+ doap:programming-language "C" ;
+ doap:developer <http://plugin.org.uk/swh.xrdf#me> ,
+ <http://drobilla.net/drobilla#me> ;
+ doap:maintainer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "18.0" ;
+ doap:created "2020-04-26" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.18.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add lv2:Markdown datatype."
+ ] , [
+ rdfs:label "Deprecate lv2:reportsLatency."
+ ]
+ ]
+ ] , [
+ doap:revision "16.0" ;
+ doap:created "2019-02-03" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.16.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add lv2:MIDIPlugin class."
+ ] , [
+ rdfs:label "Rework port restrictions so that presets can be validated."
+ ]
+ ]
+ ] , [
+ doap:revision "14.0" ;
+ doap:created "2016-09-18" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.14.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add lv2_util.h with lv2_features_data() and lv2_features_query()."
+ ] , [
+ rdfs:label "Add lv2:enabled designation."
+ ]
+ ]
+ ] , [
+ doap:revision "12.4" ;
+ doap:created "2015-04-07" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.12.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Relax domain of lv2:minimum lv2:maximum and lv2:default so they can be used to describe properties/parameters as well."
+ ] , [
+ rdfs:label "Add extern C and visibility attribute to LV2_SYMBOL_EXPORT."
+ ] , [
+ rdfs:label "Add lv2:isSideChain port property."
+ ]
+ ]
+ ] , [
+ doap:revision "12.2" ;
+ doap:created "2014-08-08" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.10.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Clarify lv2_descriptor() and lv2_lib_descriptor() documentation."
+ ]
+ ]
+ ] , [
+ doap:revision "12.0" ;
+ doap:created "2014-01-04" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.8.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add lv2:prototype for property inheritance."
+ ]
+ ]
+ ] , [
+ doap:revision "10.0" ;
+ doap:created "2013-02-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add lv2:EnvelopePlugin class."
+ ] , [
+ rdfs:label "Add lv2:control for designating primary event-based control ports."
+ ] , [
+ rdfs:label "Set range of lv2:designation to lv2:Designation."
+ ] , [
+ rdfs:label "Make lv2:Parameter rdfs:subClassOf rdf:Property."
+ ] , [
+ rdfs:label "Reserve minor version 0 for unstable development plugins."
+ ]
+ ]
+ ] , [
+ doap:revision "8.2" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Use consistent label style."
+ ]
+ ]
+ ] , [
+ doap:revision "8.0" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix LV2_SYMBOL_EXPORT and lv2_descriptor prototype for Windows."
+ ] , [
+ rdfs:label "Add metadata concept of a designation, a channel or parameter description which can be assigned to ports for more intelligent use by hosts."
+ ] , [
+ rdfs:label "Add new discovery API which allows libraries to read bundle files during discovery, makes library construction/destruction explicit, and adds extensibility to prevent future breakage."
+ ] , [
+ rdfs:label "Relax the range of lv2:index so it can be used for things other than ports."
+ ] , [
+ rdfs:label "Remove lv2:Resource, which turned out to be meaningless."
+ ] , [
+ rdfs:label "Add lv2:CVPort."
+ ] , [
+ rdfs:label "Merge with unified LV2 package."
+ ]
+ ]
+ ] , [
+ doap:revision "6.0" ;
+ doap:created "2011-11-21" ;
+ doap:file-release <http://lv2plug.in/spec/lv2core-6.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Rename core.lv2 and lv2.ttl to lv2core.lv2 and lv2core.ttl to adhere to modern conventions."
+ ] , [
+ rdfs:label "Add lv2:extensionData and lv2:ExtensionData for plugins to indicate that they support some URI for extension_data()."
+ ] , [
+ rdfs:label "Remove lv2config in favour of the simple convention that specifications install headers to standard URI-based paths."
+ ] , [
+ rdfs:label "Switch to the ISC license, a simple BSD-style license (with permission of all contributors to lv2.h and its ancestor, ladspa.h)."
+ ] , [
+ rdfs:label "Make lv2core.ttl a valid OWL 2 DL ontology."
+ ] , [
+ rdfs:label "Improve documentation."
+ ]
+ ]
+ ] , [
+ doap:revision "4.0" ;
+ doap:created "2011-03-18" ;
+ doap:file-release <http://lv2plug.in/spec/lv2core-4.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Make doap:license suggested, but not required (for wrappers)."
+ ] , [
+ rdfs:label "Define lv2:binary (MUST be in manifest.ttl)."
+ ] , [
+ rdfs:label "Define lv2:minorVersion and lv2:microVersion (MUST be in manifest.ttl)."
+ ] , [
+ rdfs:label "Define lv2:documentation and use it to document lv2core."
+ ] , [
+ rdfs:label "Add lv2:FunctionPlugin and lv2:ConstantPlugin classes."
+ ] , [
+ rdfs:label "Move lv2:AmplifierPlugin under lv2:DynamicsPlugin."
+ ] , [
+ rdfs:label "Loosen domain of lv2:optionalFeature and lv2:requiredFeature (to allow re-use in extensions)."
+ ] , [
+ rdfs:label "Add generic lv2:Resource and lv2:PluginBase classes."
+ ] , [
+ rdfs:label "Fix definition of lv2:minimum etc. (used for values, not scale points)."
+ ] , [
+ rdfs:label "More precisely define properties with OWL."
+ ] , [
+ rdfs:label "Move project metadata to manifest."
+ ] , [
+ rdfs:label "Add lv2:enumeration port property."
+ ] , [
+ rdfs:label "Define run() pre-roll special case (sample_count == 0)."
+ ]
+ ]
+ ] , [
+ doap:revision "3.0" ;
+ doap:created "2008-11-08" ;
+ doap:file-release <http://lv2plug.in/spec/lv2core-3.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Require that serialisations refer to ports by symbol rather than index."
+ ] , [
+ rdfs:label "Minor stylistic changes to lv2.ttl."
+ ] , [
+ rdfs:label "No header changes."
+ ]
+ ]
+ ] , [
+ doap:revision "2.0" ;
+ doap:created "2008-02-10" ;
+ doap:file-release <http://lv2plug.in/spec/lv2core-2.0.tar.gz> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+LV2 is an interface for writing audio plugins in C or compatible languages,
+which can be dynamically loaded into many _host_ applications. This core
+specification is simple and minimal, but is designed so that _extensions_ can
+be defined to add more advanced features, making it possible to implement
+nearly any feature.
+
+LV2 maintains a strong distinction between code and data. Plugin code is in a
+shared library, while data is in a companion data file written in
+[Turtle](https://www.w3.org/TR/turtle/). Code, data, and any other resources
+(such as waveforms) are shipped together in a bundle directory. The code
+contains only the executable portions of the plugin. All other data is
+provided in the data file(s). This makes plugin data flexible and extensible,
+and allows the host to do everything but run the plugin without loading or
+executing any code. Among other advantages, this makes hosts more robust
+(broken plugins can't crash a host during discovery) and allows generic tools
+written in any language to work with LV2 data. The LV2 specification itself is
+distributed in a similar way.
+
+An LV2 plugin library is suitable for dynamic loading (for example with
+`dlopen()`) and provides one or more plugin descriptors via `lv2_descriptor()`
+or `lv2_lib_descriptor()`. These can be instantiated to create plugin
+instances, which can be run directly on data or connected together to perform
+advanced signal processing tasks.
+
+Plugins communicate via _ports_, which can transmit any type of data. Data is
+processed by first connecting each port to a buffer, then repeatedly calling
+the `run()` method to process blocks of data.
+
+This core specification defines two types of port, equivalent to those in
+[LADSPA](http://www.ladspa.org/), lv2:ControlPort and lv2:AudioPort, as well as
+lv2:CVPort which has the same format as an audio port but is interpreted as
+non-audible control data. Audio ports contain arrays with one `float` element
+per sample, allowing a block of audio to be processed in a single call to
+`run()`. Control ports contain single `float` values, which are fixed and
+valid for the duration of the call to `run()`. Thus the _control rate_ is
+determined by the block size, which is controlled by the host (and not
+necessarily constant).
+
+### Threading Rules
+
+To faciliate use in multi-threaded programs, LV2 functions are partitioned into
+several threading classes:
+
+| Discovery Class | Instantiation Class | Audio Class |
+|----------------------------------|-------------------------------|------------------------------- |
+| lv2_descriptor() | LV2_Descriptor::instantiate() | LV2_Descriptor::run() |
+| lv2_lib_descriptor() | LV2_Descriptor::cleanup() | LV2_Descriptor::connect_port() |
+| LV2_Descriptor::extension_data() | LV2_Descriptor::activate() | |
+| | LV2_Descriptor::deactivate() | |
+
+Hosts MUST guarantee that:
+
+ * A function in any class is never called concurrently with another function
+ in that class.
+
+ * A _Discovery_ function is never called concurrently with any other fuction
+ in the same shared object file.
+
+ * An _Instantiation_ function for an instance is never called concurrently
+ with any other function for that instance.
+
+Any simultaneous calls that are not explicitly forbidden by these rules are
+allowed. For example, a host may call `run()` for two different plugin
+instances simultaneously.
+
+Plugin functions in any class MUST NOT manipulate any state which might affect
+other plugins or the host (beyond the contract of that function), for example
+by using non-reentrant global functions.
+
+Extensions to this specification which add new functions MUST declare in which
+of these classes the functions belong, define new classes for them, or
+otherwise precisely describe their threading rules.
+
+"""^^lv2:Markdown .
+
+lv2:Specification
+ lv2:documentation """
+
+An LV2 specification typically contains a vocabulary description, C headers to
+define an API, and any other resources that may be useful. Specifications,
+like plugins, are distributed and installed as bundles so that hosts may
+discover them.
+
+"""^^lv2:Markdown .
+
+lv2:Markdown
+ lv2:documentation """
+
+This datatype is typically used for documentation in
+[Markdown](https://daringfireball.net/projects/markdown/syntax) syntax.
+
+Generally, documentation with this datatype should stay as close to readable
+plain text as possible, but may use core Markdown syntax for nicer
+presentation. Documentation can assume that basic extensions like codehilite
+and tables are available.
+
+"""^^lv2:Markdown .
+
+lv2:documentation
+ lv2:documentation """
+
+Relates a Resource to extended documentation.
+
+LV2 specifications are documented using this property with an lv2:Markdown
+datatype.
+
+If the value has no explicit datatype, it is assumed to be a valid XHTML Basic
+1.1 fragment suitable for use as the content of the <code>&lt;body&gt;</code>
+element of a page.
+
+XHTML Basic is a W3C Recommendation which defines a simplified subset of XHTML
+intended to be reasonable to implement with limited resources, for exampe on
+embedded devices. See [XHTML Basic, Section
+3](http://www.w3.org/TR/xhtml-basic/#s_xhtmlmodules) for a list of valid tags.
+
+"""^^lv2:Markdown .
+
+lv2:PluginBase
+ lv2:documentation """
+
+An abstract plugin-like resource that may not actually be an LV2 plugin, for
+example that may not have a lv2:binary. This is useful for describing things
+that share common structure with a plugin, but are not themselves an actul
+plugin, such as presets.
+
+"""^^lv2:Markdown .
+
+lv2:Plugin
+ lv2:documentation """
+
+To be discovered by hosts, plugins MUST explicitly have an rdf:type of lv2:Plugin
+in their bundle's manifest, for example:
+
+ :::turtle
+ &lt;http://example.org/my-plugin&gt; a lv2:Plugin .
+
+Plugins should have a doap:name property that is at most a few words in length
+using title capitalization, for example <q>Tape Delay Unit</q>.
+
+"""^^lv2:Markdown .
+
+lv2:PortBase
+ lv2:documentation """
+
+Similar to lv2:PluginBase, this is an abstract port-like resource that may not
+be a fully specified LV2 port. For example, this is used for preset "ports"
+which do not specify an index.
+
+"""^^lv2:Markdown .
+
+lv2:Port
+ lv2:documentation """
+
+All LV2 port descriptions MUST have a rdf:type that is one of lv2:Port,
+lv2:InputPort or lv2:OutputPort. Additionally, there MUST be at least one
+other rdf:type which more precisely describes type of the port, for example
+lv2:AudioPort.
+
+Hosts that do not support a specific port class MUST NOT instantiate the
+plugin, unless that port has the lv2:connectionOptional property set.
+
+A port has two identifiers: a (numeric) index, and a (textual) symbol. The
+index can be used as an identifier at run-time, but persistent references to
+ports (for example in presets or save files) MUST use the symbol. Only the
+symbol is guaranteed to refer to the same port on all plugins with a given URI,
+that is the index for a port may differ between plugin binaries.
+
+"""^^lv2:Markdown .
+
+lv2:AudioPort
+ lv2:documentation """
+
+Ports of this type are connected to a buffer of `float` audio samples, which
+the host guarantees have `sample_count` elements in any call to
+LV2_Descriptor::run().
+
+Audio samples are normalized between -1.0 and 1.0, though there is no
+requirement for samples to be strictly within this range.
+
+"""^^lv2:Markdown .
+
+lv2:CVPort
+ lv2:documentation """
+
+Ports of this type have the same buffer format as an lv2:AudioPort, except the
+buffer represents audio-rate control data rather than audio. Like a
+lv2:ControlPort, a CV port SHOULD have properties describing its value, in
+particular lv2:minimum, lv2:maximum, and lv2:default.
+
+Hosts may present CV ports to users as controls in the same way as control
+ports. Conceptually, aside from the buffer format, a CV port is the same as a
+control port, so hosts can use all the same properties and expectations.
+
+In particular, this port type does not imply any range, unit, or meaning for
+its values. However, if there is no inherent unit to the values, for example
+if the port is used to modulate some other value, then plugins SHOULD use a
+normalized range, either from -1.0 to 1.0, or from 0.0 to 1.0.
+
+It is generally safe to connect an audio output to a CV input, but not
+vice-versa. Hosts must take care to prevent data from a CVPort port from being
+used as audio.
+
+"""^^lv2:Markdown .
+
+lv2:project
+ lv2:documentation """
+
+This property provides a way to group plugins and/or related resources. A
+project may have useful metadata common to all plugins (such as homepage,
+author, version history) which would be wasteful to list separately for each
+plugin.
+
+Grouping via projects also allows users to find plugins in hosts by project,
+which is often how they are remembered. For this reason, a project that
+contains plugins SHOULD always have a doap:name. It is also a good idea for
+each plugin and the project itself to have an lv2:symbol property, which allows
+nice quasi-global identifiers for plugins, for example `myproj.superamp` which
+can be useful for display or fast user entry.
+
+"""^^lv2:Markdown .
+
+lv2:prototype
+ lv2:documentation """
+
+This property can be used to <q>include</q> common properties in several
+descriptions, serving as a sort of template mechanism. If a plugin has a
+prototype, then the host must load all the properties for the prototype as if
+they were properties of the plugin. That is, if `:plug lv2:prototype :prot`,
+then for each triple `:prot p o`, the triple `:plug p o` should be loaded.
+
+This facility is useful for distributing data-only plugins that rely on a
+common binary, for example those where the internal state is loaded from some
+other file. Such plugins can refer to a prototype in a template LV2 bundle
+which is installed by the corresponding software.
+
+"""^^lv2:Markdown .
+
+lv2:minorVersion
+ lv2:documentation """
+
+This, along with lv2:microVersion, is used to distinguish between different
+versions of the <q>same</q> resource, for example to load only the bundle with
+the most recent version of a plugin. An LV2 version has a minor and micro
+number with the usual semantics:
+
+ * The minor version MUST be incremented when backwards (but not forwards)
+ compatible additions are made, for example the addition of a port to a
+ plugin.
+
+ * The micro version is incremented for changes which do not affect
+ compatibility at all, for example bug fixes or documentation updates.
+
+Note that there is deliberately no major version: all versions with the same
+URI are compatible by definition. Replacing a resource with a newer version of
+that resource MUST NOT break anything. If a change violates this rule, then
+the URI of the resource (which serves as the major version) MUST be changed.
+
+Plugins and extensions MUST adhere to at least the following rules:
+
+ * All versions of a plugin with a given URI MUST have the <q>same</q> set of
+ mandatory (not lv2:connectionOptional) ports with respect to lv2:symbol and
+ rdf:type. In other words, every port on a particular version is guaranteed
+ to exist on a future version with same lv2:symbol and at least those
+ rdf:types.
+
+ * New ports MAY be added without changing the plugin URI if and only if they
+ are lv2:connectionOptional and the minor version is incremented.
+
+ * The minor version MUST be incremented if the index of any port (identified
+ by its symbol) is changed.
+
+ * All versions of a specification MUST be compatible in the sense that an
+ implementation of the new version can interoperate with an implementation
+ of any previous version.
+
+Anything that depends on a specific version of a plugin (including referencing
+ports by index) MUST refer to the plugin by both URI and version. However,
+implementations should be tolerant where possible.
+
+When hosts discover several installed versions of a resource, they SHOULD warn
+the user and load only the most recent version.
+
+An odd minor _or_ micro version, or minor version zero, indicates that the
+resource is a development version. Hosts and tools SHOULD clearly indicate
+this wherever appropriate. Minor version zero is a special case for
+pre-release development of plugins, or experimental plugins that are not
+intended for stable use at all. Hosts SHOULD NOT expect such a plugin to
+remain compatible with any future version. Where feasible, hosts SHOULD NOT
+expose such plugins to users by default, but may provide an option to display
+them.
+
+"""^^lv2:Markdown .
+
+lv2:microVersion
+ lv2:documentation """
+
+Releases of plugins and extensions MUST be explicitly versioned. Correct
+version numbers MUST always be maintained for any versioned resource that is
+published. For example, after a release, if a change is made in the development
+version in source control, the micro version MUST be incremented (to an odd
+number) to distinguish this modified version from the previous release.
+
+This property describes half of a resource version. For detailed documentation
+on LV2 resource versioning, see lv2:minorVersion.
+
+"""^^lv2:Markdown .
+
+lv2:binary
+ lv2:documentation """
+
+The value of this property must be the URI of a shared library object,
+typically in the same bundle as the data file which contains this property.
+The actual type of the library is platform specific.
+
+This is a required property of a lv2:Plugin which MUST be included in the
+bundle's `manifest.ttl` file. The lv2:binary of a lv2:Plugin is the shared
+object containing the lv2_descriptor() or lv2_lib_descriptor() function. This
+probably may also be used similarly by extensions to relate other resources to
+their implementations (it is not implied that a lv2:binary on an arbitrary
+resource is an LV2 plugin library).
+
+"""^^lv2:Markdown .
+
+lv2:appliesTo
+ lv2:documentation """
+
+This is primarily intended for discovery purposes: bundles that describe
+resources that work with particular plugins (like presets or user interfaces)
+SHOULD specify this in their `manifest.ttl` so the host can associate them with
+the correct plugin. For example:
+
+ :::turtle
+ &lt;thing&gt;
+ a ext:Thing ;
+ lv2:appliesTo &lt;plugin&gt; ;
+ rdfs:seeAlso &lt;thing.ttl&gt; .
+
+Using this pattern is preferable for large amounts of data, since the host may
+choose whether/when to load the data.
+
+"""^^lv2:Markdown .
+
+lv2:Symbol
+ lv2:documentation """
+
+The first character of a symbol must be one of `_`, `a-z` or `A-Z`, and
+subsequent characters may additionally be `0-9`. This is, among other things,
+a valid C identifier, and generally compatible in most contexts which have
+restrictions on string identifiers, such as file paths.
+
+"""^^lv2:Markdown .
+
+lv2:symbol
+ lv2:documentation """
+
+The value of this property MUST be a valid lv2:Symbol, and MUST NOT have a
+language tag.
+
+A symbol is a unique identifier with respect to the parent, for example a
+port's symbol is a unique identifiers with respect to its plugin. The plugin
+author MUST change the plugin URI if any port symbol is changed or removed.
+
+"""^^lv2:Markdown .
+
+lv2:name
+ lv2:documentation """
+
+Unlike lv2:symbol, this is unrestricted, may be translated, and is not relevant
+for compatibility. The name is not necessarily unique and MUST NOT be used as
+an identifier.
+
+"""^^lv2:Markdown .
+
+lv2:shortName
+ lv2:documentation """
+
+This is the same as lv2:name, with the additional requirement that the value is
+shorter than 16 characters.
+
+"""^^lv2:Markdown .
+
+lv2:Designation
+ lv2:documentation """
+
+A designation is metadata that describes the meaning or role of something. By
+assigning a designation to a port using lv2:designation, the port's content
+becomes meaningful and can be used more intelligently by the host.
+
+"""^^lv2:Markdown .
+
+lv2:Channel
+ lv2:documentation """
+
+A specific channel, for example the <q>left</q> channel of a stereo stream. A
+channel may be audio, or another type such as a MIDI control stream.
+
+"""^^lv2:Markdown .
+
+lv2:Parameter
+ lv2:documentation """
+
+A parameter is a designation for a control.
+
+A parameter defines the meaning of a control, not the method of conveying its
+value. For example, a parameter could be controlled via a lv2:ControlPort,
+messages, or both.
+
+A lv2:ControlPort can be associated with a parameter using lv2:designation.
+
+"""^^lv2:Markdown .
+
+lv2:designation
+ lv2:documentation """
+
+This property is used to give a port's contents a well-defined meaning. For
+example, if a port has the designation `eg:gain`, then the value of that port
+represents the `eg:gain` of the plugin instance.
+
+Ports should be given designations whenever possible, particularly if a
+suitable designation is already defined. This allows the host to act more
+intelligently and provide a more effective user interface. For example, if the
+plugin has a BPM parameter, the host may automatically set that parameter to
+the current tempo.
+
+"""^^lv2:Markdown .
+
+lv2:freeWheeling
+ lv2:documentation """
+
+If true, this means that all processing is happening as quickly as possible,
+not in real-time. When free-wheeling there is no relationship between the
+passage of real wall-clock time and the passage of time in the data being
+processed.
+
+"""^^lv2:Markdown .
+
+lv2:enabled
+ lv2:documentation """
+
+If this value is greater than zero, the plugin processes normally. If this
+value is zero, the plugin is expected to bypass all signals unmodified. The
+plugin must provide a click-free transition between the enabled and disabled
+(bypassed) states.
+
+Values less than zero are reserved for future use (such as click-free
+insertion/removal of latent plugins), and should be treated like zero
+(bypassed) by current implementations.
+
+"""^^lv2:Markdown .
+
+lv2:control
+ lv2:documentation """
+
+This should be used as the lv2:designation of ports that are used to send
+commands and receive responses. Typically this will be an event port that
+supports some protocol, for example MIDI or LV2 Atoms.
+
+"""^^lv2:Markdown .
+
+lv2:Point
+ lv2:documentation """
+
+ * A Point MUST have at least one rdfs:label which is a string.
+
+ * A Point MUST have exactly one rdf:value with a type that is compatible with
+ the type of the corresponding Port.
+
+"""^^lv2:Markdown .
+
+lv2:default
+ lv2:documentation """
+
+The host SHOULD set the port to this value initially, and in any situation
+where the port value should be cleared or reset.
+
+"""^^lv2:Markdown .
+
+lv2:minimum
+ lv2:documentation """
+
+This is a soft limit: the plugin is required to gracefully accept all values in
+the range of a port's data type.
+
+"""^^lv2:Markdown .
+
+lv2:maximum
+ lv2:documentation """
+
+This is a soft limit: the plugin is required to gracefully accept all values in
+the range of a port's data type.
+
+"""^^lv2:Markdown .
+
+lv2:optionalFeature
+ lv2:documentation """
+
+To support this feature, the host MUST pass its URI and any additional data to
+the plugin in LV2_Descriptor::instantiate().
+
+The plugin MUST NOT fail to instantiate if an optional feature is not supported
+by the host.
+
+"""^^lv2:Markdown .
+
+lv2:requiredFeature
+ lv2:documentation """
+
+To support this feature, the host MUST pass its URI and any additional data to
+the plugin in LV2_Descriptor::instantiate().
+
+The host MUST check this property before attempting to instantiate a plugin,
+and not attempt to instantiate plugins which require features it does not
+support. The plugin MUST fail to instantiate if a required feature is not
+supported by the host. Note that these rules are intentionally redundant for
+resilience: neither host nor plugin should assume that the other does not
+violate them.
+
+"""^^lv2:Markdown .
+
+lv2:ExtensionData
+ lv2:documentation """
+
+This is additional data that a plugin may return from
+LV2_Descriptor::extension_data(). This is generally used to add APIs to extend
+that defined by LV2_Descriptor.
+
+"""^^lv2:Markdown .
+
+lv2:extensionData
+ lv2:documentation """
+
+If a plugin has a value for this property, it must be a URI that defines the
+extension data. The plugin should return the appropriate data when
+LV2_Descriptor::extension_data() is called with that URI as a parameter.
+
+"""^^lv2:Markdown .
+
+lv2:isLive
+ lv2:documentation """
+
+This feature is for plugins that have time-sensitive internals, for example
+communicating in real time over a socket. It indicates to the host that its
+input and output must not be cached or subject to significant latency, and that
+calls to LV2_Descriptor::run() should be made at a rate that roughly
+corresponds to wall clock time (according to the `sample_count` parameter).
+
+Note that this feature is not related to <q>hard real-time</q> execution
+requirements (see lv2:hardRTCapable).
+
+"""^^lv2:Markdown .
+
+lv2:inPlaceBroken
+ lv2:documentation """
+
+This feature indicates that the plugin may not work correctly if the host
+elects to use the same data location for both input and output. Plugins that
+will fail to work correctly if ANY input port is connected to the same location
+as ANY output port MUST require this feature. Doing so should be avoided
+whenever possible since it prevents hosts from running the plugin on data
+<q>in-place</q>.
+
+"""^^lv2:Markdown .
+
+lv2:hardRTCapable
+ lv2:documentation """
+
+This feature indicates that the plugin is capable of running in a <q>hard
+real-time</q> environment. This should be the case for most audio processors,
+so most plugins are expected to have this feature.
+
+To support this feature, plugins MUST adhere to the following in all of their
+audio class functions (LV2_Descriptor::run() and
+LV2_Descriptor::connect_port()):
+
+ * There is no use of `malloc()`, `free()` or any other heap memory management
+ functions.
+
+ * There is no use of any library functions which do not adhere to these
+ rules. The plugin may assume that the standard C math library functions
+ are safe.
+
+ * There is no access to files, devices, pipes, sockets, system calls, or any
+ other mechanism that might result in the process or thread blocking.
+
+ * The maximum amount of time for a `run()` call is bounded by some expression
+ of the form `A + B * sample_count`, where `A` and `B` are platform specific
+ constants. Note that this bound does not depend on input signals or plugin
+ state.
+
+"""^^lv2:Markdown .
+
+lv2:portProperty
+ lv2:documentation """
+
+States that a port has a particular lv2:PortProperty. This may be ignored
+without catastrophic effects, though it may be useful, for example to provide a
+sensible user interface for the port.
+
+"""^^lv2:Markdown .
+
+lv2:connectionOptional
+ lv2:documentation """
+
+This property means that the port does not have to be connected to valid data
+by the host. To leave a port <q>unconnected</q>, the host MUST explicitly
+connect the port to `NULL`.
+
+"""^^lv2:Markdown .
+
+lv2:reportsLatency
+ lv2:documentation """
+
+This property indicates that the port is used to express the processing latency
+incurred by the plugin, expressed in samples. The latency may be affected by
+the current sample rate, plugin settings, or other factors, and may be changed
+by the plugin at any time. Where the latency is frequency dependent the plugin
+may choose any appropriate value. If a plugin introduces latency it MUST
+provide EXACTLY ONE port with this property set. In <q>fuzzy</q> cases the
+value should be the most reasonable one based on user expectation of
+input/output alignment. For example, musical delay plugins should not report
+their delay as latency, since it is an intentional effect that the host should
+not compensate for.
+
+This property is deprecated, use a lv2:designation of lv2:latency instead,
+following the same rules as above:
+
+ :::turtle
+ <http://example.org/plugin>
+ lv2:port [
+ a lv2:OutputPort , lv2:ControlPort ;
+ lv2:designation lv2:latency ;
+ lv2:symbol "latency" ;
+ ]
+
+"""^^lv2:Markdown .
+
+lv2:toggled
+ lv2:documentation """
+
+Indicates that the data item should be considered a boolean toggle. Data less
+than or equal to zero should be considered <q>off</q> or <q>false</q>, and data
+above zero should be considered <q>on</q> or <q>true</q>.
+
+"""^^lv2:Markdown .
+
+lv2:sampleRate
+ lv2:documentation """
+
+Indicates that any specified bounds should be interpreted as multiples of the
+sample rate. For example, a frequency range from 0 Hz to the Nyquist frequency
+(half the sample rate) can be specified by using this property with lv2:minimum
+0.0 and lv2:maximum 0.5. Hosts that support bounds at all MUST support this
+property.
+
+"""^^lv2:Markdown .
+
+lv2:integer
+ lv2:documentation """
+
+Indicates that all the reasonable values for a port are integers. For such
+ports, a user interface should provide a stepped control that only allows
+choosing integer values.
+
+Note that this is only a hint, and that the plugin MUST operate reasonably even
+if such a port has a non-integer value.
+
+"""^^lv2:Markdown .
+
+lv2:enumeration
+ lv2:documentation """
+
+Indicates that all the rasonable values for a port are defined by
+lv2:scalePoint properties. For such ports, a user interface should provide a selector that allows the user to choose any of the scale point values by name. It is recommended to show the value as well if possible.
+
+Note that this is only a hint, and that the plugin MUST operate reasonably even
+if such a port has a value that does not correspond to a scale point.
+
+"""^^lv2:Markdown .
+
+lv2:isSideChain
+ lv2:documentation """
+
+Indicates that a port is a <q>sidechain</q>, which affects the output somehow
+but should not be considered a part of the main signal chain. Sidechain ports
+SHOULD be lv2:connectionOptional, and may be ignored by hosts.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/core/lv2core.ttl b/lv2/core/lv2core.ttl
new file mode 100644
index 0000000..f5836c6
--- /dev/null
+++ b/lv2/core/lv2core.ttl
@@ -0,0 +1,674 @@
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@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 xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+<http://lv2plug.in/ns/lv2core>
+ a owl:Ontology ;
+ rdfs:label "LV2" ;
+ rdfs:comment "An extensible open standard for audio plugins." ;
+ rdfs:seeAlso <lv2.h> ,
+ <lv2_util.h> ,
+ <lv2core.meta.ttl> .
+
+lv2:Specification
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf doap:Project ;
+ rdfs:label "Specification" ;
+ rdfs:comment "An LV2 specifiation." .
+
+lv2:Markdown
+ a rdfs:Datatype ;
+ owl:onDatatype xsd:string ;
+ rdfs:label "Markdown" ;
+ rdfs:comment "A string in Markdown syntax." .
+
+lv2:documentation
+ a rdf:Property ,
+ owl:AnnotationProperty ;
+ rdfs:range rdfs:Literal ;
+ rdfs:label "documentation" ;
+ rdfs:comment "Extended documentation." ;
+ rdfs:seeAlso <http://www.w3.org/TR/xhtml-basic/> .
+
+lv2:PluginBase
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:label "Plugin Base" ;
+ rdfs:comment "Base class for a plugin-like resource." .
+
+lv2:Plugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:PluginBase ;
+ rdfs:label "Plugin" ;
+ rdfs:comment "An LV2 plugin." ;
+ rdfs:subClassOf [
+ a owl:Restriction ;
+ owl:onProperty doap:name ;
+ owl:someValuesFrom rdf:PlainLiteral ;
+ rdfs:comment "A plugin MUST have at least one untranslated doap:name."
+ ] , [
+ a owl:Restriction ;
+ owl:onProperty lv2:port ;
+ owl:allValuesFrom lv2:Port ;
+ rdfs:comment "All ports on a plugin MUST be fully specified lv2:Port instances."
+ ] .
+
+lv2:PortBase
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:label "Port Base" ;
+ rdfs:comment "Base class for a port-like resource." ;
+ rdfs:subClassOf [
+ a owl:Restriction ;
+ owl:onProperty lv2:symbol ;
+ owl:cardinality 1 ;
+ rdfs:comment "A port MUST have exactly one lv2:symbol."
+ ] .
+
+lv2:Port
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:label "Port" ;
+ rdfs:comment "An LV2 plugin port." ;
+ rdfs:subClassOf lv2:PortBase ,
+ [
+ a owl:Restriction ;
+ owl:onProperty lv2:name ;
+ owl:minCardinality 1 ;
+ rdfs:comment "A port MUST have at least one lv2:name."
+ ] .
+
+lv2:InputPort
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Port ;
+ rdfs:label "Input Port" ;
+ rdfs:comment "A port connected to constant data which is read during `run()`." .
+
+lv2:OutputPort
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Port ;
+ rdfs:label "Output Port" ;
+ rdfs:comment "A port connected to data which is written during `run()`." .
+
+lv2:ControlPort
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Port ;
+ rdfs:label "Control Port" ;
+ rdfs:comment "A port connected to a single `float`." .
+
+lv2:AudioPort
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Port ;
+ rdfs:label "Audio Port" ;
+ rdfs:comment "A port connected to an array of float audio samples." .
+
+lv2:CVPort
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Port ;
+ rdfs:label "CV Port" ;
+ rdfs:comment "A port connected to an array of float control values." .
+
+lv2:port
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain lv2:PluginBase ;
+ rdfs:range lv2:PortBase ;
+ rdfs:label "port" ;
+ rdfs:comment "A port (input or output) on this plugin." .
+
+lv2:project
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:range doap:Project ;
+ rdfs:label "project" ;
+ rdfs:comment "The project this is a part of." .
+
+lv2:prototype
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:label "prototype" ;
+ rdfs:comment "The prototype to inherit properties from." .
+
+lv2:minorVersion
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:range xsd:nonNegativeInteger ;
+ rdfs:label "minor version" ;
+ rdfs:comment "The minor version of this resource." .
+
+lv2:microVersion
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:range xsd:nonNegativeInteger ;
+ rdfs:label "micro version" ;
+ rdfs:comment "The micro version of this resource." .
+
+lv2:binary
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:range owl:Thing ;
+ rdfs:label "binary" ;
+ rdfs:comment "The binary of this resource." .
+
+lv2:appliesTo
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:range lv2:Plugin ;
+ rdfs:label "applies to" ;
+ rdfs:comment "The plugin this resource is related to." .
+
+lv2:index
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ owl:FunctionalProperty ;
+ rdfs:range xsd:unsignedInt ;
+ rdfs:label "index" ;
+ rdfs:comment "A non-negative zero-based 32-bit index." .
+
+lv2:Symbol
+ a rdfs:Datatype ;
+ owl:onDatatype xsd:string ;
+ owl:withRestrictions (
+ [
+ xsd:pattern "[_a-zA-Z][_a-zA-Z0-9]*"
+ ]
+ ) ;
+ rdfs:label "Symbol" ;
+ rdfs:comment "A short restricted name used as a strong identifier." .
+
+lv2:symbol
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ owl:FunctionalProperty ;
+ rdfs:label "symbol" ;
+ rdfs:range lv2:Symbol ,
+ rdf:PlainLiteral ;
+ rdfs:comment "The symbol that identifies this resource in the context of its parent." .
+
+lv2:name
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:label "name" ;
+ rdfs:range xsd:string ;
+ rdfs:comment "A display name for labeling in a user interface." .
+
+lv2:shortName
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:label "short name" ;
+ rdfs:range xsd:string ;
+ rdfs:comment "A short display name for labeling in a user interface." .
+
+lv2:Designation
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf rdf:Property ;
+ rdfs:label "Designation" ;
+ rdfs:comment "A designation which defines the meaning of some data." .
+
+lv2:Channel
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Designation ;
+ rdfs:label "Channel" ;
+ rdfs:comment "An individual channel, such as left or right." .
+
+lv2:Parameter
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Designation ,
+ rdf:Property ;
+ rdfs:label "Parameter" ;
+ rdfs:comment "A property that is a plugin parameter." .
+
+lv2:designation
+ a rdf:Property ,
+ owl:ObjectProperty ,
+ owl:FunctionalProperty ;
+ rdfs:range rdf:Property ;
+ rdfs:label "designation" ;
+ rdfs:comment "The designation that defines the meaning of this input or output." .
+
+lv2:latency
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:range xsd:nonNegativeInteger ;
+ rdfs:label "latency" ;
+ rdfs:comment "The latency introduced, in frames." .
+
+lv2:freeWheeling
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:label "free-wheeling" ;
+ rdfs:range xsd:boolean ;
+ rdfs:comment "Whether processing is currently free-wheeling." .
+
+lv2:enabled
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:label "enabled" ;
+ rdfs:range xsd:int ;
+ rdfs:comment "Whether processing is currently enabled (not bypassed)." .
+
+lv2:control
+ a lv2:Channel ;
+ rdfs:label "control" ;
+ rdfs:comment "The primary control channel." .
+
+lv2:Point
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:label "Point" ;
+ rdfs:comment "An interesting point in a value range." .
+
+lv2:ScalePoint
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Point ;
+ rdfs:label "Scale Point" ;
+ rdfs:comment "A single `float` Point for control inputs." .
+
+lv2:scalePoint
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:range lv2:ScalePoint ;
+ rdfs:label "scale point" ;
+ rdfs:comment "A scale point of a port or parameter." .
+
+lv2:default
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ owl:FunctionalProperty ;
+ rdfs:label "default" ;
+ rdfs:comment "The default value for this control." .
+
+lv2:minimum
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ owl:FunctionalProperty ;
+ rdfs:label "minimum" ;
+ rdfs:comment "The minimum value for this control." .
+
+lv2:maximum
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ owl:FunctionalProperty ;
+ rdfs:label "maximum" ;
+ rdfs:comment "The maximum value for this control." .
+
+lv2:Feature
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:label "Feature" ;
+ rdfs:comment "An additional feature which may be used or required." .
+
+lv2:optionalFeature
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:range lv2:Feature ;
+ rdfs:label "optional feature" ;
+ rdfs:comment "An optional feature that is supported if available." .
+
+lv2:requiredFeature
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:range lv2:Feature ;
+ rdfs:label "required feature" ;
+ rdfs:comment "A required feature that must be available to run." .
+
+lv2:ExtensionData
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:label "Extension Data" ;
+ rdfs:comment "Additional data defined by an extension." .
+
+lv2:extensionData
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:range lv2:ExtensionData ;
+ rdfs:label "extension data" ;
+ rdfs:comment "Extension data provided by a plugin or other binary." .
+
+lv2:isLive
+ a lv2:Feature ;
+ rdfs:label "is live" ;
+ rdfs:comment "Plugin has a real-time dependency." .
+
+lv2:inPlaceBroken
+ a lv2:Feature ;
+ rdfs:label "in-place broken" ;
+ rdfs:comment "Plugin requires separate locations for input and output." .
+
+lv2:hardRTCapable
+ a lv2:Feature ;
+ rdfs:label "hard real-time capable" ;
+ rdfs:comment "Plugin is capable of running in a hard real-time environment." .
+
+lv2:PortProperty
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:label "Port Property" ;
+ rdfs:comment "A particular property that a port has." .
+
+lv2:portProperty
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain lv2:Port ;
+ rdfs:range lv2:PortProperty ;
+ rdfs:label "port property" ;
+ rdfs:comment "A property of this port hosts may find useful." .
+
+lv2:connectionOptional
+ a lv2:PortProperty ;
+ rdfs:label "connection optional" ;
+ rdfs:comment "The property that this port may be connected to NULL." .
+
+lv2:reportsLatency
+ a lv2:PortProperty ;
+ owl:deprecated "true"^^xsd:boolean ;
+ rdfs:label "reports latency" ;
+ rdfs:comment "Control port value is the plugin latency in frames." .
+
+lv2:toggled
+ a lv2:PortProperty ;
+ rdfs:label "toggled" ;
+ rdfs:comment "Control port value is considered a boolean toggle." .
+
+lv2:sampleRate
+ a lv2:PortProperty ;
+ rdfs:label "sample rate" ;
+ rdfs:comment "Control port bounds are interpreted as multiples of the sample rate." .
+
+lv2:integer
+ a lv2:PortProperty ;
+ rdfs:label "integer" ;
+ rdfs:comment "Control port values are treated as integers." .
+
+lv2:enumeration
+ a lv2:PortProperty ;
+ rdfs:label "enumeration" ;
+ rdfs:comment "Control port scale points represent all useful values." .
+
+lv2:isSideChain
+ a lv2:PortProperty ;
+ rdfs:label "is side-chain" ;
+ rdfs:comment "Signal for port should not be considered a main input or output." .
+
+lv2:GeneratorPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Plugin ;
+ rdfs:label "Generator Plugin" ;
+ rdfs:comment "A plugin that generates new sound internally." .
+
+lv2:InstrumentPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:GeneratorPlugin ;
+ rdfs:label "Instrument Plugin" ;
+ rdfs:comment "A plugin intended to be played as a musical instrument." .
+
+lv2:OscillatorPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:GeneratorPlugin ;
+ rdfs:label "Oscillator Plugin" ;
+ rdfs:comment "A plugin that generates output with an oscillator." .
+
+lv2:UtilityPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Plugin ;
+ rdfs:label "Utility Plugin" ;
+ rdfs:comment "A utility plugin that is not a typical audio effect or generator." .
+
+lv2:ConverterPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:UtilityPlugin ;
+ rdfs:label "Converter Plugin" ;
+ rdfs:comment "A plugin that converts its input into a different form." .
+
+lv2:AnalyserPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:UtilityPlugin ;
+ rdfs:label "Analyser Plugin" ;
+ rdfs:comment "A plugin that analyses its input and emits some useful information." .
+
+lv2:MixerPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:UtilityPlugin ;
+ rdfs:label "Mixer Plugin" ;
+ rdfs:comment "A plugin that mixes some number of inputs into some number of outputs." .
+
+lv2:SimulatorPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Plugin ;
+ rdfs:label "Simulator Plugin" ;
+ rdfs:comment "A plugin that aims to emulate some environmental effect or musical equipment." .
+
+lv2:DelayPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Plugin ;
+ rdfs:label "Delay Plugin" ;
+ rdfs:comment "An effect that intentionally delays its input as an effect." .
+
+lv2:ModulatorPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Plugin ;
+ rdfs:label "Modulator Plugin" ;
+ rdfs:comment "An effect that modulats its input as an effect." .
+
+lv2:ReverbPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Plugin ,
+ lv2:SimulatorPlugin ,
+ lv2:DelayPlugin ;
+ rdfs:label "Reverb Plugin" ;
+ rdfs:comment "An effect that adds reverberation to its input." .
+
+lv2:PhaserPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:ModulatorPlugin ;
+ rdfs:label "Phaser Plugin" ;
+ rdfs:comment "An effect that periodically sweeps a filter over its input." .
+
+lv2:FlangerPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:ModulatorPlugin ;
+ rdfs:label "Flanger Plugin" ;
+ rdfs:comment "An effect that mixes slightly delayed copies of its input." .
+
+lv2:ChorusPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:ModulatorPlugin ;
+ rdfs:label "Chorus Plugin" ;
+ rdfs:comment "An effect that mixes significantly delayed copies of its input." .
+
+lv2:FilterPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Plugin ;
+ rdfs:label "Filter Plugin" ;
+ rdfs:comment "An effect that manipulates the frequency spectrum of its input." .
+
+lv2:LowpassPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:FilterPlugin ;
+ rdfs:label "Lowpass Filter Plugin" ;
+ rdfs:comment "A filter that attenuates frequencies above some cutoff." .
+
+lv2:BandpassPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:FilterPlugin ;
+ rdfs:label "Bandpass Filter Plugin" ;
+ rdfs:comment "A filter that attenuates frequencies outside of some band." .
+
+lv2:HighpassPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:FilterPlugin ;
+ rdfs:label "Highpass Filter Plugin" ;
+ rdfs:comment "A filter that attenuates frequencies below some cutoff." .
+
+lv2:CombPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:FilterPlugin ;
+ rdfs:label "Comb FilterPlugin" ;
+ rdfs:comment "A filter that adds a delayed version of its input to itself." .
+
+lv2:AllpassPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:FilterPlugin ;
+ rdfs:label "Allpass Plugin" ;
+ rdfs:comment "A filter that changes the phase relationship between frequency components." .
+
+lv2:EQPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:FilterPlugin ;
+ rdfs:label "Equaliser Plugin" ;
+ rdfs:comment "A plugin that adjusts the balance between frequency components." .
+
+lv2:ParaEQPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:EQPlugin ;
+ rdfs:label "Parametric EQ Plugin" ;
+ rdfs:comment "A plugin that adjusts the balance between configurable frequency components." .
+
+lv2:MultiEQPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:EQPlugin ;
+ rdfs:label "Multiband EQ Plugin" ;
+ rdfs:comment "A plugin that adjusts the balance between a fixed set of frequency components." .
+
+lv2:SpatialPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Plugin ;
+ rdfs:label "Spatial Plugin" ;
+ rdfs:comment "A plugin that manipulates the position of audio in space." .
+
+lv2:SpectralPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Plugin ;
+ rdfs:label "Spectral Plugin" ;
+ rdfs:comment "A plugin that alters the spectral properties of audio." .
+
+lv2:PitchPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:SpectralPlugin ;
+ rdfs:label "Pitch Shifter Plugin" ;
+ rdfs:comment "A plugin that shifts the pitch of its input." .
+
+lv2:AmplifierPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:DynamicsPlugin ;
+ rdfs:label "Amplifier Plugin" ;
+ rdfs:comment "A plugin that primarily changes the volume of its input." .
+
+lv2:EnvelopePlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:DynamicsPlugin ;
+ rdfs:label "Envelope Plugin" ;
+ rdfs:comment "A plugin that applies an envelope to its input." .
+
+lv2:DistortionPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Plugin ;
+ rdfs:label "Distortion Plugin" ;
+ rdfs:comment "A plugin that adds distortion to its input." .
+
+lv2:WaveshaperPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:DistortionPlugin ;
+ rdfs:label "Waveshaper Plugin" ;
+ rdfs:comment "An effect that alters the shape of input waveforms." .
+
+lv2:DynamicsPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Plugin ;
+ rdfs:label "Dynamics Plugin" ;
+ rdfs:comment "A plugin that alters the envelope or dynamic range of its input." .
+
+lv2:CompressorPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:DynamicsPlugin ;
+ rdfs:label "Compressor Plugin" ;
+ rdfs:comment "A plugin that reduces the dynamic range of its input." .
+
+lv2:ExpanderPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:DynamicsPlugin ;
+ rdfs:label "Expander Plugin" ;
+ rdfs:comment "A plugin that expands the dynamic range of its input." .
+
+lv2:LimiterPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:DynamicsPlugin ;
+ rdfs:label "Limiter Plugin" ;
+ rdfs:comment "A plugin that limits its input to some maximum level." .
+
+lv2:GatePlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:DynamicsPlugin ;
+ rdfs:label "Gate Plugin" ;
+ rdfs:comment "A plugin that attenuates signals below some threshold." .
+
+lv2:FunctionPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:UtilityPlugin ;
+ rdfs:label "Function Plugin" ;
+ rdfs:comment "A plugin whose output is a mathmatical function of its input." .
+
+lv2:ConstantPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:GeneratorPlugin ;
+ rdfs:label "Constant Plugin" ;
+ rdfs:comment "A plugin that emits constant values." .
+
+lv2:MIDIPlugin
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Plugin ;
+ rdfs:label "MIDI Plugin" ;
+ rdfs:comment "A plugin that primarily processes MIDI messages." .
+
diff --git a/lv2/core/manifest.ttl b/lv2/core/manifest.ttl
new file mode 100644
index 0000000..7f1512b
--- /dev/null
+++ b/lv2/core/manifest.ttl
@@ -0,0 +1,15 @@
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/lv2core>
+ a lv2:Specification ;
+ lv2:minorVersion 18 ;
+ lv2:microVersion 0 ;
+ rdfs:seeAlso <lv2core.ttl> .
+
+<http://lv2plug.in/ns/lv2>
+ a doap:Project ;
+ rdfs:seeAlso <meta.ttl> ,
+ <people.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/meta/meta.ttl b/lv2/core/meta.ttl
index 94c8dd5..721fba8 100644
--- a/lv2/lv2plug.in/ns/meta/meta.ttl
+++ b/lv2/core/meta.ttl
@@ -1,23 +1,10 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix meta: <http://lv2plug.in/ns/meta#> .
-@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@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/meta>
- a owl:Ontology ;
- doap:license <http://opensource.org/licenses/isc> ;
- doap:name "LV2 Meta" ;
- doap:shortdesc "LV2 project metadata" ;
- doap:created "2012-03-25" ;
- doap:maintainer <http://drobilla.net/drobilla#me> ;
- rdfs:comment """
-This document describes metadata relevant to the LV2 project.
-""" .
-
<http://opensource.org/licenses/isc>
rdf:value """
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
@@ -28,9 +15,11 @@ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH R
<http://lv2plug.in/ns/lv2>
a doap:Project ;
lv2:symbol "lv2" ;
+ rdfs:label "LV2" ;
+ rdfs:comment "The LV2 Plugin Interface Project." ;
doap:name "LV2" ;
doap:license <http://opensource.org/licenses/isc> ;
- doap:shortdesc "The LV2 Plugin Interface Project" ;
+ doap:shortdesc "The LV2 Plugin Interface Project." ;
doap:description "LV2 is a plugin standard for audio systems. It defines a minimal yet extensible C API for plugin code and a format for plugin bundles" ;
doap:created "2006-05-10" ;
doap:homepage <http://lv2plug.in/> ;
@@ -43,17 +32,105 @@ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH R
doap:developer <http://drobilla.net/drobilla#me> ,
<http://plugin.org.uk/swh.xrdf#me> ;
doap:helper meta:larsl ,
+ meta:bmwiedemann ,
meta:gabrbedd ,
meta:daste ,
meta:kfoltman ,
meta:paniq ;
doap:release [
- doap:revision "1.6.1" ;
- doap:created "2013-10-15" ;
+ doap:revision "1.18.0" ;
+ doap:created "2020-04-26" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.18.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Improve documentation."
+ ] , [
+ rdfs:label "Separate extended documentation from primary data."
+ ]
+ ]
+ ] , [
+ doap:revision "1.16.0" ;
+ doap:created "2019-02-03" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.16.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add core/attributes.h utility header."
+ ] , [
+ rdfs:label "eg-sampler: Add waveform display to UI."
+ ] , [
+ rdfs:label "eg-midigate: Respond to \"all notes off\" MIDI message."
+ ] , [
+ rdfs:label "Simplify use of lv2specgen."
+ ] , [
+ rdfs:label "Add lv2_validate utility."
+ ] , [
+ rdfs:label "Install headers to simpler paths."
+ ] , [
+ rdfs:label "Aggressively deprecate uri-map and event extensions."
+ ] , [
+ rdfs:label "Upgrade build system and fix building with Python 3.7."
+ ]
+ ]
+ ] , [
+ doap:revision "1.14.0" ;
+ doap:created "2016-09-19" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.14.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label """eg-scope: Don't feed back UI state updates."""
+ ] , [
+ rdfs:label "eg-sampler: Fix handling of state file paths."
+ ] , [
+ rdfs:label "eg-sampler: Support thread-safe state restoration."
+ ]
+ ]
+ ] , [
+ doap:revision "1.12.0" ;
+ doap:created "2015-04-07" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.12.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "eg-sampler: Support patch:Get, and request initial state from UI."
+ ] , [
+ rdfs:label "eg-sampler: Add gain parameter."
+ ] , [
+ rdfs:label "Fix merging of version histories in specification documentation."
+ ] , [
+ rdfs:label "Improve API documentation."
+ ] , [
+ rdfs:label "Simplify property restrictions by removing redundancy."
+ ]
+ ]
+ ] , [
+ doap:revision "1.10.0" ;
+ doap:created "2014-08-08" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.10.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "lv2specgen: Display deprecated warning on classes marked owl:deprecated."
+ ] , [
+ rdfs:label "Fix -Wconversion warnings in headers."
+ ] , [
+ rdfs:label "Upgrade to waf 1.7.16."
+ ]
+ ]
+ ] , [
+ doap:revision "1.8.0" ;
+ doap:created "2014-01-04" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.8.0.tar.bz2> ;
dcs:blame <http://drobilla.net/drobilla#me> ;
dcs:changeset [
dcs:item [
rdfs:label "Add scope example plugin from Robin Gareus."
+ ] , [
+ rdfs:label "lv2specgen: Fix links to externally defined terms."
+ ] , [
+ rdfs:label "Install lv2specgen for use by other projects."
]
]
] , [
@@ -101,51 +178,10 @@ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH R
dcs:blame <http://drobilla.net/drobilla#me> ;
dcs:changeset [
dcs:item [
- rdfs:label "Initial release as a unified project. Projects can now simply depend on the pkg-config package 'lv2' for all official LV2 APIs."
+ rdfs:label """Initial release as a unified project. Projects can now simply depend on the pkg-config package 'lv2' for all official LV2 APIs."""
] , [
rdfs:label "New extensions: atom, log, parameters, patch, port-groups, port-props, resize-port, state, time, worker."
]
]
] .
-<http://drobilla.net/drobilla#me>
- a foaf:Person ;
- foaf:name "David Robillard" ;
- foaf:mbox <mailto:d@drobilla.net> ;
- rdfs:seeAlso <http://drobilla.net/drobilla> .
-
-<http://plugin.org.uk/swh.xrdf#me>
- a foaf:Person ;
- foaf:name "Steve Harris" ;
- foaf:mbox <mailto:steve@plugin.org.uk> ;
- rdfs:seeAlso <http://plugin.org.uk/swh.xrdf> .
-
-meta:larsl
- a foaf:Person ;
- foaf:name "Lars Luthman" ;
- foaf:mbox <mailto:lars.luthman@gmail.com> .
-
-meta:gabrbedd
- a foaf:Person ;
- foaf:name "Gabriel M. Beddingfield" ;
- foaf:mbox <mailto:gabrbedd@gmail.com> .
-
-meta:daste
- a foaf:Person ;
- foaf:name "Stefano D'Angelo" ;
- foaf:mbox <mailto:zanga.mail@gmail.com> .
-
-meta:kfoltman
- a foaf:Person ;
- foaf:name "Krzysztof Foltman" ;
- foaf:mbox <mailto:wdev@foltman.com> .
-
-meta:paniq
- a foaf:Person ;
- foaf:name "Leonard Ritter" ;
- foaf:mbox <mailto:paniq@paniq.org> .
-
-meta:harry
- a foaf:Person ;
- foaf:name "Harry van Haaren" ;
- foaf:mbox <harryhaaren@gmail.com> .
diff --git a/lv2/core/people.ttl b/lv2/core/people.ttl
new file mode 100644
index 0000000..52d0384
--- /dev/null
+++ b/lv2/core/people.ttl
@@ -0,0 +1,51 @@
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix meta: <http://lv2plug.in/ns/meta#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://drobilla.net/drobilla#me>
+ a foaf:Person ;
+ foaf:name "David Robillard" ;
+ foaf:mbox <mailto:d@drobilla.net> ;
+ rdfs:seeAlso <http://drobilla.net/drobilla> .
+
+<http://plugin.org.uk/swh.xrdf#me>
+ a foaf:Person ;
+ foaf:name "Steve Harris" ;
+ foaf:mbox <mailto:steve@plugin.org.uk> ;
+ rdfs:seeAlso <http://plugin.org.uk/swh.xrdf> .
+
+meta:larsl
+ a foaf:Person ;
+ foaf:name "Lars Luthman" ;
+ foaf:mbox <mailto:lars.luthman@gmail.com> .
+
+meta:gabrbedd
+ a foaf:Person ;
+ foaf:name "Gabriel M. Beddingfield" ;
+ foaf:mbox <mailto:gabrbedd@gmail.com> .
+
+meta:daste
+ a foaf:Person ;
+ foaf:name """Stefano D'Angelo""" ;
+ foaf:mbox <mailto:zanga.mail@gmail.com> .
+
+meta:kfoltman
+ a foaf:Person ;
+ foaf:name "Krzysztof Foltman" ;
+ foaf:mbox <mailto:wdev@foltman.com> .
+
+meta:paniq
+ a foaf:Person ;
+ foaf:name "Leonard Ritter" ;
+ foaf:mbox <mailto:paniq@paniq.org> .
+
+meta:harry
+ a foaf:Person ;
+ foaf:name "Harry van Haaren" ;
+ foaf:mbox <harryhaaren@gmail.com> .
+
+meta:bmwiedemann
+ a foaf:Person ;
+ foaf:name "Bernhard M. Wiedemann" ;
+ foaf:mbox <bwiedemann@suse.de> .
+
diff --git a/lv2/lv2plug.in/ns/ext/data-access/data-access.h b/lv2/data-access/data-access.h
index b19f65f..f57b1e2 100644
--- a/lv2/lv2plug.in/ns/ext/data-access/data-access.h
+++ b/lv2/data-access/data-access.h
@@ -1,6 +1,6 @@
/*
LV2 Data Access Extension
- Copyright 2008-2011 David Robillard <http://drobilla.net>
+ Copyright 2008-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -16,18 +16,24 @@
*/
/**
- @file data-access.h
- C header for the LV2 Extension Data extension
- <http://lv2plug.in/ns/ext/data-access>.
+ @defgroup data-access Data Access
+ @ingroup lv2
- This extension defines a method for (e.g.) plugin UIs to have (possibly
- marshalled) access to the extension_data function on a plugin instance.
+ Access to plugin extension_data() for UIs, see
+ <http://lv2plug.in/ns/ext/data-access> for details.
+
+ @{
*/
#ifndef LV2_DATA_ACCESS_H
#define LV2_DATA_ACCESS_H
-#define LV2_DATA_ACCESS_URI "http://lv2plug.in/ns/ext/data-access"
+#define LV2_DATA_ACCESS_URI "http://lv2plug.in/ns/ext/data-access" ///< http://lv2plug.in/ns/ext/data-access
+#define LV2_DATA_ACCESS_PREFIX LV2_DATA_ACCESS_URI "#" ///< http://lv2plug.in/ns/ext/data-access#
+
+#ifdef __cplusplus
+extern "C" {
+#endif
/**
The data field of the LV2_Feature for this extension.
@@ -52,4 +58,12 @@ typedef struct {
const void* (*data_access)(const char* uri);
} LV2_Extension_Data_Feature;
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
#endif /* LV2_DATA_ACCESS_H */
+
+/**
+ @}
+*/
diff --git a/lv2/lv2plug.in/ns/ext/data-access/lv2-data-access.doap.ttl b/lv2/data-access/data-access.meta.ttl
index 084d935..3184110 100644
--- a/lv2/lv2plug.in/ns/ext/data-access/lv2-data-access.doap.ttl
+++ b/lv2/data-access/data-access.meta.ttl
@@ -1,15 +1,16 @@
+@prefix da: <http://lv2plug.in/ns/ext/data-access#> .
@prefix dcs: <http://ontologi.es/doap-changeset#> .
@prefix doap: <http://usefulinc.com/ns/doap#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/data-access>
a doap:Project ;
- rdfs:seeAlso <data-access.h> ,
- <../../meta/meta.ttl> ;
+ rdfs:seeAlso <data-access.h> ;
doap:license <http://opensource.org/licenses/isc> ;
doap:name "LV2 Data Access" ;
- doap:shortdesc "Provides access to LV2_Descriptor::extension_data()." ;
+ doap:shortdesc "Provides access to plugin extension data." ;
doap:created "2008-00-00" ;
doap:developer <http://drobilla.net/drobilla#me> ;
doap:release [
@@ -56,4 +57,21 @@
rdfs:label "Initial release."
]
]
- ] .
+ ] ;
+ lv2:documentation """
+
+This extension defines a feature, LV2_Extension_Data_Feature, which provides
+access to LV2_Descriptor::extension_data() for plugin UIs or other potentially
+remote users of a plugin.
+
+Note that the use of this extension by UIs violates the important principle of
+UI/plugin separation, and is potentially a source of many problems.
+Accordingly, **use of this extension is highly discouraged**, and plugins
+should not expect hosts to support it, since it is often impossible to do so.
+
+To support this feature the host must pass an LV2_Feature struct to
+LV2_Descriptor::extension_data() with URI LV2_DATA_ACCESS_URI and data pointed
+to an instance of LV2_Extension_Data_Feature.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/data-access/data-access.ttl b/lv2/data-access/data-access.ttl
new file mode 100644
index 0000000..0185cd0
--- /dev/null
+++ b/lv2/data-access/data-access.ttl
@@ -0,0 +1,11 @@
+@prefix da: <http://lv2plug.in/ns/ext/data-access#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/data-access>
+ a lv2:Feature ;
+ rdfs:label "data access" ;
+ rdfs:comment "A feature that provides access to plugin extension data." ;
+ rdfs:seeAlso <data-access.h> ,
+ <data-access.meta.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/ext/data-access/manifest.ttl b/lv2/data-access/manifest.ttl
index 85e50fc..9585a5e 100644
--- a/lv2/lv2plug.in/ns/ext/data-access/manifest.ttl
+++ b/lv2/data-access/manifest.ttl
@@ -1,4 +1,4 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/data-access>
diff --git a/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h b/lv2/dynmanifest/dynmanifest.h
index b62f8ef..16274e4 100644
--- a/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h
+++ b/lv2/dynmanifest/dynmanifest.h
@@ -16,20 +16,24 @@
*/
/**
- @file dynmanifest.h
- C header for the LV2 Dynamic Manifest extension
- <http://lv2plug.in/ns/ext/dynmanifest>.
- Revision: 1.2
+ @defgroup dynmanifest Dynamic Manifest
+ @ingroup lv2
+
+ Support for dynamic data generation, see
+ <http://lv2plug.in/ns/ext/dynmanifest> for details.
+
+ @{
*/
#ifndef LV2_DYN_MANIFEST_H_INCLUDED
#define LV2_DYN_MANIFEST_H_INCLUDED
-#include <stdio.h>
+#include "lv2/core/lv2.h"
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
+#include <stdio.h>
-#define LV2_DYN_MANIFEST_URI "http://lv2plug.in/ns/ext/dynmanifest"
+#define LV2_DYN_MANIFEST_URI "http://lv2plug.in/ns/ext/dynmanifest" ///< http://lv2plug.in/ns/ext/dynmanifest
+#define LV2_DYN_MANIFEST_PREFIX LV2_DYN_MANIFEST_URI "#" ///< http://lv2plug.in/ns/ext/dynmanifest#
#ifdef __cplusplus
extern "C" {
@@ -72,7 +76,7 @@ int lv2_dyn_manifest_open(LV2_Dyn_Manifest_Handle * handle,
example, if the plugin library exposes a regular LV2 plugin, it should
output only a triple like the following:
- <http://www.example.com/plugin/uri> a lv2:Plugin .
+ <http://example.org/plugin> a lv2:Plugin .
The objects that are elegible for exposure are those that would need to be
represented by a subject node in a static manifest.
@@ -82,8 +86,8 @@ int lv2_dyn_manifest_open(LV2_Dyn_Manifest_Handle * handle,
@param fp FILE * identifying the resource the host has to set up for the
dynamic manifest generator. The host MUST pass a writable, empty resource to
this function, and the dynamic manifest generator MUST ONLY perform write
- operations on it at the end of the stream (e.g., using only fprintf(),
- fwrite() and similar).
+ operations on it at the end of the stream (for example, using only
+ fprintf(), fwrite() and similar).
@return 0 on success, otherwise a non-zero error code.
*/
@@ -96,11 +100,11 @@ int lv2_dyn_manifest_get_subjects(LV2_Dyn_Manifest_Handle handle,
The dynamic manifest generator has to fill the resource with data related to
object represented by the given URI. For example, if the library exposes a
regular LV2 plugin whose URI, as retrieved by the host using
- lv2_dyn_manifest_get_subjects() is http://www.example.com/plugin/uri, it
+ lv2_dyn_manifest_get_subjects() is http://example.org/plugin then it
should output something like:
<pre>
- <http://www.example.com/plugin/uri>
+ <http://example.org/plugin>
a lv2:Plugin ;
doap:name "My Plugin" ;
lv2:binary <mylib.so> ;
@@ -112,8 +116,8 @@ int lv2_dyn_manifest_get_subjects(LV2_Dyn_Manifest_Handle handle,
@param fp FILE * identifying the resource the host has to set up for the
dynamic manifest generator. The host MUST pass a writable resource to this
function, and the dynamic manifest generator MUST ONLY perform write
- operations on it at the current position of the stream (e.g. using only
- fprintf(), fwrite() and similar).
+ operations on it at the current position of the stream (for example, using
+ only fprintf(), fwrite() and similar).
@param uri URI to get data about (in the "plain" form, i.e., absolute URI
without Turtle prefixes).
@@ -142,3 +146,7 @@ void lv2_dyn_manifest_close(LV2_Dyn_Manifest_Handle handle);
#endif
#endif /* LV2_DYN_MANIFEST_H_INCLUDED */
+
+/**
+ @}
+*/
diff --git a/lv2/dynmanifest/dynmanifest.meta.ttl b/lv2/dynmanifest/dynmanifest.meta.ttl
new file mode 100644
index 0000000..4e66d98
--- /dev/null
+++ b/lv2/dynmanifest/dynmanifest.meta.ttl
@@ -0,0 +1,131 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix dman: <http://lv2plug.in/ns/ext/dynmanifest#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/dynmanifest>
+ a doap:Project ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ doap:name "LV2 Dynamic Manifest" ;
+ doap:homepage <http://naspro.atheme.org> ;
+ doap:created "2009-06-13" ;
+ doap:shortdesc "Support for dynamic manifest data generation." ;
+ doap:programming-language "C" ;
+ doap:developer <http://lv2plug.in/ns/meta#daste> ;
+ doap:release [
+ doap:revision "1.6" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Use consistent label style."
+ ]
+ ]
+ ] , [
+ doap:revision "1.4" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Merge with unified LV2 package."
+ ]
+ ]
+ ] , [
+ doap:revision "1.2" ;
+ doap:created "2011-11-21" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-dynmanifest-1.2.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Improve documentation."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2010-04-10" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-dyn-manifest-1.0.tar.gz> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+The LV2 API, on its own, cannot be used to write plugin libraries where data is
+dynamically generated at runtime, since LV2 requires needed information to be
+provided in one or more static data (RDF) files. This API addresses this
+limitation by extending the LV2 API.
+
+To detect that a plugin library implements a dynamic manifest generator, the
+host checks its static manifest for a description like:
+
+ :::turtle
+ <http://example.org/my-dynamic-manifest>
+ a dman:DynManifest ;
+ lv2:binary <mydynmanifest.so> .
+
+To load the data, the host loads the library (`mydynmanifest.so` in this
+example) as usual and fetches the dynamic Turtle data from it using this API.
+
+The host is allowed to request regeneration of the dynamic manifest multiple
+times, and the plugin library is expected to provide updated data if/when
+possible. All data and references provided via this API before the last
+regeneration of the dynamic manifest is to be considered invalid by the host,
+including plugin descriptors whose URIs were discovered using this API.
+
+### Accessing Data
+
+To access data using this API, the host must:
+
+ 1. Call lv2_dyn_manifest_open().
+
+ 2. Create a `FILE` for functions to write data to (for example with `tmpfile()`).
+
+ 3. Get a list of exposed subject URIs using lv2_dyn_manifest_get_subjects().
+
+ 4. Call lv2_dyn_manifest_get_data() for each URI of interest to write the
+ related data to the file.
+
+ 5. Call lv2_dyn_manifest_close().
+
+ 6. Parse the content of the file(s).
+
+ 7. Remove the file(s).
+
+Each call to the above mentioned dynamic manifest functions MUST write a
+complete, valid Turtle document (including all needed prefix definitions) to
+the output FILE.
+
+Each call to lv2_dyn_manifest_open() causes the (re)generation of the dynamic
+manifest data, and invalidates all data fetched before the call.
+
+In case the plugin library uses this same API to access other dynamic
+manifests, it MUST implement some mechanism to avoid potentially endless loops
+(such as A loads B, B loads A, etc.) and, in case such a loop is detected, the
+operation MUST fail. For this purpose, use of a static boolean flag is
+suggested.
+
+### Threading Rules
+
+All of the functions defined by this specification belong to the Discovery
+class.
+
+
+"""^^lv2:Markdown .
+
+dman:DynManifest
+ lv2:documentation """
+
+There MUST NOT be any instances of dman:DynManifest in the generated manifest.
+
+All relative URIs in the generated data MUST be relative to the base path that
+would be used to parse a normal LV2 manifest (the bundle path).
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/dynmanifest/dynmanifest.ttl b/lv2/dynmanifest/dynmanifest.ttl
new file mode 100644
index 0000000..4e2e830
--- /dev/null
+++ b/lv2/dynmanifest/dynmanifest.ttl
@@ -0,0 +1,25 @@
+@prefix dman: <http://lv2plug.in/ns/ext/dynmanifest#> .
+@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 xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+<http://lv2plug.in/ns/ext/dynmanifest>
+ a owl:Ontology ;
+ rdfs:label "LV2 Dyn Manifest" ;
+ rdfs:comment "Support for dynamic manifest data generation." ;
+ rdfs:seeAlso <dynmanifest.h> ,
+ <dynmanifest.meta.ttl> .
+
+dman:DynManifest
+ a rdfs:Class ;
+ rdfs:label "Dynamic Manifest" ;
+ rdfs:subClassOf [
+ a owl:Restriction ;
+ owl:onProperty lv2:binary ;
+ owl:minCardinality 1 ;
+ rdfs:comment "A DynManifest MUST have at least one lv2:binary."
+ ] ;
+ rdfs:comment "Dynamic manifest for an LV2 binary." .
+
diff --git a/lv2/lv2plug.in/ns/ext/dynmanifest/manifest.ttl b/lv2/dynmanifest/manifest.ttl
index 784fb30..db27a73 100644
--- a/lv2/lv2plug.in/ns/ext/dynmanifest/manifest.ttl
+++ b/lv2/dynmanifest/manifest.ttl
@@ -1,4 +1,4 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/dynmanifest>
@@ -6,3 +6,4 @@
lv2:minorVersion 1 ;
lv2:microVersion 6 ;
rdfs:seeAlso <dynmanifest.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/ext/event/event-helpers.h b/lv2/event/event-helpers.h
index 5420271..ca3abec 100644
--- a/lv2/lv2plug.in/ns/ext/event/event-helpers.h
+++ b/lv2/event/event-helpers.h
@@ -1,5 +1,5 @@
/*
- Copyright 2008-2012 David Robillard <http://drobilla.net>
+ Copyright 2008-2015 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -22,18 +22,20 @@
#ifndef LV2_EVENT_HELPERS_H
#define LV2_EVENT_HELPERS_H
+#include "lv2/core/attributes.h"
+#include "lv2/event/event.h"
+
+#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
-#include "lv2/lv2plug.in/ns/ext/event/event.h"
-
#ifdef __cplusplus
extern "C" {
-#else
-# include <stdbool.h>
#endif
+LV2_DISABLE_DEPRECATION_WARNINGS
+
/** @file
* Helper functions for the LV2 Event extension
* <http://lv2plug.in/ns/ext/event>.
@@ -50,7 +52,7 @@ extern "C" {
static inline uint16_t
lv2_event_pad_size(uint16_t size)
{
- return (size + 7) & (~7);
+ return (uint16_t)(size + 7U) & (uint16_t)(~7U);
}
@@ -60,7 +62,7 @@ lv2_event_pad_size(uint16_t size)
static inline void
lv2_event_buffer_reset(LV2_Event_Buffer* buf,
uint16_t stamp_type,
- uint8_t *data)
+ uint8_t* data)
{
buf->data = data;
buf->header_size = sizeof(LV2_Event_Buffer);
@@ -80,24 +82,23 @@ lv2_event_buffer_new(uint32_t capacity, uint16_t stamp_type)
buf->capacity = capacity;
lv2_event_buffer_reset(buf, stamp_type, (uint8_t *)(buf + 1));
return buf;
- } else {
- return NULL;
}
+ return NULL;
}
/** An iterator over an LV2_Event_Buffer.
*
* Multiple simultaneous read iterators over a single buffer is fine,
- * but changing the buffer invalidates all iterators (e.g. RW Lock). */
+ * but changing the buffer invalidates all iterators. */
typedef struct {
LV2_Event_Buffer* buf;
uint32_t offset;
} LV2_Event_Iterator;
-/** Reset an iterator to point to the start of @a buf.
- * @return True if @a iter is valid, otherwise false (buffer is empty) */
+/** Reset an iterator to point to the start of `buf`.
+ * @return True if `iter` is valid, otherwise false (buffer is empty) */
static inline bool
lv2_event_begin(LV2_Event_Iterator* iter,
LV2_Event_Buffer* buf)
@@ -108,8 +109,8 @@ lv2_event_begin(LV2_Event_Iterator* iter,
}
-/** Check if @a iter is valid.
- * @return True if @a iter is valid, otherwise false (past end of buffer) */
+/** Check if `iter` is valid.
+ * @return True if `iter` is valid, otherwise false (past end of buffer) */
static inline bool
lv2_event_is_valid(LV2_Event_Iterator* iter)
{
@@ -117,9 +118,9 @@ lv2_event_is_valid(LV2_Event_Iterator* iter)
}
-/** Advance @a iter forward one event.
- * @a iter must be valid.
- * @return True if @a iter is valid, otherwise false (reached end of buffer) */
+/** Advance `iter` forward one event.
+ * `iter` must be valid.
+ * @return True if `iter` is valid, otherwise false (reached end of buffer) */
static inline bool
lv2_event_increment(LV2_Event_Iterator* iter)
{
@@ -127,21 +128,21 @@ lv2_event_increment(LV2_Event_Iterator* iter)
return false;
}
- LV2_Event* const ev = (LV2_Event*)(
- (uint8_t*)iter->buf->data + iter->offset);
+ LV2_Event* const ev = (LV2_Event*)(iter->buf->data + iter->offset);
- iter->offset += lv2_event_pad_size(sizeof(LV2_Event) + ev->size);
+ iter->offset += lv2_event_pad_size(
+ (uint16_t)((uint16_t)sizeof(LV2_Event) + ev->size));
return true;
}
/** Dereference an event iterator (get the event currently pointed at).
- * @a iter must be valid.
- * @a data if non-NULL, will be set to point to the contents of the event
+ * `iter` must be valid.
+ * `data` if non-NULL, will be set to point to the contents of the event
* returned.
- * @return A Pointer to the event @a iter is currently pointing at, or NULL
- * if the end of the buffer is reached (in which case @a data is
+ * @return A Pointer to the event `iter` is currently pointing at, or NULL
+ * if the end of the buffer is reached (in which case `data` is
* also set to NULL). */
static inline LV2_Event*
lv2_event_get(LV2_Event_Iterator* iter,
@@ -151,18 +152,18 @@ lv2_event_get(LV2_Event_Iterator* iter,
return NULL;
}
- LV2_Event* const ev = (LV2_Event*)(
- (uint8_t*)iter->buf->data + iter->offset);
+ LV2_Event* const ev = (LV2_Event*)(iter->buf->data + iter->offset);
- if (data)
+ if (data) {
*data = (uint8_t*)ev + sizeof(LV2_Event);
+ }
return ev;
}
-/** Write an event at @a iter.
- * The event (if any) pointed to by @a iter will be overwritten, and @a iter
+/** Write an event at `iter`.
+ * The event (if any) pointed to by `iter` will be overwritten, and `iter`
* incremented to point to the following event (i.e. several calls to this
* function can be done in sequence without twiddling iter in-between).
* @return True if event was written, otherwise false (buffer is full). */
@@ -174,14 +175,15 @@ lv2_event_write(LV2_Event_Iterator* iter,
uint16_t size,
const uint8_t* data)
{
- if (!iter->buf)
+ if (!iter->buf) {
return false;
+ }
- if (iter->buf->capacity - iter->buf->size < sizeof(LV2_Event) + size)
+ if (iter->buf->capacity - iter->buf->size < sizeof(LV2_Event) + size) {
return false;
+ }
- LV2_Event* const ev = (LV2_Event*)(
- (uint8_t*)iter->buf->data + iter->offset);
+ LV2_Event* const ev = (LV2_Event*)(iter->buf->data + iter->offset);
ev->frames = frames;
ev->subframes = subframes;
@@ -190,7 +192,7 @@ lv2_event_write(LV2_Event_Iterator* iter,
memcpy((uint8_t*)ev + sizeof(LV2_Event), data, size);
++iter->buf->event_count;
- size = lv2_event_pad_size(sizeof(LV2_Event) + size);
+ size = lv2_event_pad_size((uint16_t)(sizeof(LV2_Event) + size));
iter->buf->size += size;
iter->offset += size;
@@ -208,11 +210,12 @@ lv2_event_reserve(LV2_Event_Iterator* iter,
uint16_t type,
uint16_t size)
{
- if (iter->buf->capacity - iter->buf->size < sizeof(LV2_Event) + size)
+ const uint16_t total_size = (uint16_t)(sizeof(LV2_Event) + size);
+ if (iter->buf->capacity - iter->buf->size < total_size) {
return NULL;
+ }
- LV2_Event* const ev = (LV2_Event*)((uint8_t*)iter->buf->data +
- iter->offset);
+ LV2_Event* const ev = (LV2_Event*)(iter->buf->data + iter->offset);
ev->frames = frames;
ev->subframes = subframes;
@@ -220,16 +223,16 @@ lv2_event_reserve(LV2_Event_Iterator* iter,
ev->size = size;
++iter->buf->event_count;
- size = lv2_event_pad_size(sizeof(LV2_Event) + size);
- iter->buf->size += size;
- iter->offset += size;
+ const uint16_t padded_size = lv2_event_pad_size(total_size);
+ iter->buf->size += padded_size;
+ iter->offset += padded_size;
return (uint8_t*)ev + sizeof(LV2_Event);
}
-/** Write an event at @a iter.
- * The event (if any) pointed to by @a iter will be overwritten, and @a iter
+/** Write an event at `iter`.
+ * The event (if any) pointed to by `iter` will be overwritten, and `iter`
* incremented to point to the following event (i.e. several calls to this
* function can be done in sequence without twiddling iter in-between).
* @return True if event was written, otherwise false (buffer is full). */
@@ -238,26 +241,28 @@ lv2_event_write_event(LV2_Event_Iterator* iter,
const LV2_Event* ev,
const uint8_t* data)
{
- if (iter->buf->capacity - iter->buf->size < sizeof(LV2_Event) + ev->size)
+ const uint16_t total_size = (uint16_t)(sizeof(LV2_Event) + ev->size);
+ if (iter->buf->capacity - iter->buf->size < total_size) {
return false;
+ }
- LV2_Event* const write_ev = (LV2_Event*)(
- (uint8_t*)iter->buf->data + iter->offset);
+ LV2_Event* const write_ev = (LV2_Event*)(iter->buf->data + iter->offset);
*write_ev = *ev;
memcpy((uint8_t*)write_ev + sizeof(LV2_Event), data, ev->size);
++iter->buf->event_count;
- const uint16_t size = lv2_event_pad_size(sizeof(LV2_Event) + ev->size);
- iter->buf->size += size;
- iter->offset += size;
+ const uint16_t padded_size = lv2_event_pad_size(total_size);
+ iter->buf->size += padded_size;
+ iter->offset += padded_size;
return true;
}
+LV2_RESTORE_WARNINGS
+
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* LV2_EVENT_HELPERS_H */
-
diff --git a/lv2/lv2plug.in/ns/ext/event/event.h b/lv2/event/event.h
index aeb1332..aa67390 100644
--- a/lv2/lv2plug.in/ns/ext/event/event.h
+++ b/lv2/event/event.h
@@ -1,5 +1,5 @@
/*
- Copyright 2008-2011 David Robillard <http://drobilla.net>
+ Copyright 2008-2016 David Robillard <http://drobilla.net>
Copyright 2006-2007 Lars Luthman <lars.luthman@gmail.com>
Permission to use, copy, modify, and/or distribute this software for any
@@ -16,46 +16,50 @@
*/
/**
- @file event.h
- C API for the LV2 Event extension <http://lv2plug.in/ns/ext/event>.
-
- This extension is a generic transport mechanism for time stamped events
- of any type (e.g. MIDI, OSC, ramps, etc). Each port can transport mixed
- events of any type; the type of events and timestamps are defined by a URI
- which is mapped to an integer by the host for performance reasons.
-
- This extension requires the host to support the LV2 URI Map extension.
- Any host which supports this extension MUST guarantee that any call to
- the LV2 URI Map uri_to_id function with the URI of this extension as the
- 'map' argument returns a value within the range of uint16_t.
+ @defgroup event Event
+ @ingroup lv2
+
+ Generic time-stamped events, see <http://lv2plug.in/ns/ext/event> for
+ details.
+
+ @{
*/
#ifndef LV2_EVENT_H
#define LV2_EVENT_H
-#define LV2_EVENT_URI "http://lv2plug.in/ns/ext/event"
-#define LV2_EVENT_PREFIX LV2_EVENT_URI "#"
+#define LV2_EVENT_URI "http://lv2plug.in/ns/ext/event" ///< http://lv2plug.in/ns/ext/event
+#define LV2_EVENT_PREFIX LV2_EVENT_URI "#" ///< http://lv2plug.in/ns/ext/event#
+
+#define LV2_EVENT__Event LV2_EVENT_PREFIX "Event" ///< http://lv2plug.in/ns/ext/event#Event
+#define LV2_EVENT__EventPort LV2_EVENT_PREFIX "EventPort" ///< http://lv2plug.in/ns/ext/event#EventPort
+#define LV2_EVENT__FrameStamp LV2_EVENT_PREFIX "FrameStamp" ///< http://lv2plug.in/ns/ext/event#FrameStamp
+#define LV2_EVENT__TimeStamp LV2_EVENT_PREFIX "TimeStamp" ///< http://lv2plug.in/ns/ext/event#TimeStamp
+#define LV2_EVENT__generatesTimeStamp LV2_EVENT_PREFIX "generatesTimeStamp" ///< http://lv2plug.in/ns/ext/event#generatesTimeStamp
+#define LV2_EVENT__generic LV2_EVENT_PREFIX "generic" ///< http://lv2plug.in/ns/ext/event#generic
+#define LV2_EVENT__inheritsEvent LV2_EVENT_PREFIX "inheritsEvent" ///< http://lv2plug.in/ns/ext/event#inheritsEvent
+#define LV2_EVENT__inheritsTimeStamp LV2_EVENT_PREFIX "inheritsTimeStamp" ///< http://lv2plug.in/ns/ext/event#inheritsTimeStamp
+#define LV2_EVENT__supportsEvent LV2_EVENT_PREFIX "supportsEvent" ///< http://lv2plug.in/ns/ext/event#supportsEvent
+#define LV2_EVENT__supportsTimeStamp LV2_EVENT_PREFIX "supportsTimeStamp" ///< http://lv2plug.in/ns/ext/event#supportsTimeStamp
-#define LV2_EVENT__Event LV2_EVENT_PREFIX "Event"
-#define LV2_EVENT__EventPort LV2_EVENT_PREFIX "EventPort"
-#define LV2_EVENT__FrameStamp LV2_EVENT_PREFIX "FrameStamp"
-#define LV2_EVENT__TimeStamp LV2_EVENT_PREFIX "TimeStamp"
-#define LV2_EVENT__generatesTimeStamp LV2_EVENT_PREFIX "generatesTimeStamp"
-#define LV2_EVENT__generic LV2_EVENT_PREFIX "generic"
-#define LV2_EVENT__inheritsEvent LV2_EVENT_PREFIX "inheritsEvent"
-#define LV2_EVENT__inheritsTimeStamp LV2_EVENT_PREFIX "inheritsTimeStamp"
-#define LV2_EVENT__supportsEvent LV2_EVENT_PREFIX "supportsEvent"
-#define LV2_EVENT__supportsTimeStamp LV2_EVENT_PREFIX "supportsTimeStamp"
+#define LV2_EVENT_AUDIO_STAMP 0 ///< Special timestamp type for audio frames
-#define LV2_EVENT_AUDIO_STAMP 0
+#include "lv2/core/attributes.h"
#include <stdint.h>
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+LV2_DISABLE_DEPRECATION_WARNINGS
+
/**
The best Pulses Per Quarter Note for tempo-based uint32_t timestamps.
Equal to 2^12 * 5 * 7 * 9 * 11 * 13 * 17, which is evenly divisble
by all integers from 1 through 18 inclusive, and powers of 2 up to 2^12.
*/
+LV2_DEPRECATED
static const uint32_t LV2_EVENT_PPQN = 3136573440U;
/**
@@ -71,12 +75,13 @@ static const uint32_t LV2_EVENT_PPQN = 3136573440U;
memcpy(ev_copy, ev, sizeof(LV2_Event) + ev->size); (or equivalent)
*/
+LV2_DEPRECATED
typedef struct {
/**
The frames portion of timestamp. The units used here can optionally be
set for a port (with the lv2ev:timeUnits property), otherwise this is
audio frames, corresponding to the sample_count parameter of the LV2 run
- method (e.g. frame 0 is the first frame for that call to run).
+ method (frame 0 is the first frame for that call to run).
*/
uint32_t frames;
@@ -131,6 +136,7 @@ typedef struct {
| | | | | | | | | | | | | | | | | | | | | | | | |
|FRAMES |SUBFRMS|TYP|LEN|DATA..DATA..PAD|FRAMES | ...
*/
+LV2_DEPRECATED
typedef struct {
/**
The contents of the event buffer. This may or may not reside in the
@@ -214,6 +220,7 @@ typedef struct {
/**
Opaque pointer to host data.
*/
+LV2_DEPRECATED
typedef void* LV2_Event_Callback_Data;
@@ -225,6 +232,7 @@ typedef void* LV2_Event_Callback_Data;
and data pointed to an instance of this struct. Note this feature
is not mandatory to support the event extension.
*/
+LV2_DEPRECATED
typedef struct {
/**
Opaque pointer to host data.
@@ -251,7 +259,7 @@ typedef struct {
@param context The calling context. Like event types, this is a mapped
URI, see lv2_context.h. Simple plugin with just a run() method should
pass 0 here (the ID of the 'standard' LV2 run context). The host
- guarantees that this function is realtime safe iff @a context is
+ guarantees that this function is realtime safe iff the context is
realtime safe.
PLUGINS THAT VIOLATE THESE RULES MAY CAUSE CRASHES AND MEMORY LEAKS.
@@ -274,7 +282,7 @@ typedef struct {
@param context The calling context. Like event types, this is a mapped
URI, see lv2_context.h. Simple plugin with just a run() method should
pass 0 here (the ID of the 'standard' LV2 run context). The host
- guarantees that this function is realtime safe iff @a context is
+ guarantees that this function is realtime safe iff the context is
realtime safe.
PLUGINS THAT VIOLATE THESE RULES MAY CAUSE CRASHES AND MEMORY LEAKS.
@@ -283,5 +291,14 @@ typedef struct {
LV2_Event* event);
} LV2_Event_Feature;
+LV2_RESTORE_WARNINGS
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
#endif /* LV2_EVENT_H */
+
+/**
+ @}
+*/
diff --git a/lv2/event/event.meta.ttl b/lv2/event/event.meta.ttl
new file mode 100644
index 0000000..80593ce
--- /dev/null
+++ b/lv2/event/event.meta.ttl
@@ -0,0 +1,246 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix ev: <http://lv2plug.in/ns/ext/event#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/event>
+ a doap:Project ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ doap:name "LV2 Event" ;
+ doap:shortdesc "A port-based real-time generic event interface." ;
+ doap:created "2008-00-00" ;
+ doap:developer <http://drobilla.net/drobilla#me> ,
+ <http://lv2plug.in/ns/meta#larsl> ;
+ doap:release [
+ doap:revision "1.12" ;
+ doap:created "2014-08-08" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.10.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Minor documentation improvements."
+ ]
+ ]
+ ] , [
+ doap:revision "1.10" ;
+ doap:created "2013-01-13" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix incorrect return type in lv2_event_get()."
+ ]
+ ]
+ ] , [
+ doap:revision "1.8" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Make event iterator gracefully handle optional ports."
+ ] , [
+ rdfs:label "Remove asserts from event-helper.h."
+ ] , [
+ rdfs:label "Use more precise domain and range for EventPort properties."
+ ] , [
+ rdfs:label "Use consistent label style."
+ ]
+ ]
+ ] , [
+ doap:revision "1.6" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix bug in lv2_event_reserve()."
+ ] , [
+ rdfs:label "Fix incorrect ranges of some properties."
+ ] , [
+ rdfs:label "Merge with unified LV2 package."
+ ]
+ ]
+ ] , [
+ doap:revision "1.4" ;
+ doap:created "2011-11-21" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-event-1.4.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Update packaging."
+ ]
+ ]
+ ] , [
+ doap:revision "1.2" ;
+ doap:created "2011-05-26" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-event-1.2.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add build system (for installation)."
+ ] , [
+ rdfs:label "Convert documentation to HTML and use lv2:documentation."
+ ] , [
+ rdfs:label "Use lv2:Specification to be discovered as an extension."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2010-11-24" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-event-1.0.tar.gz> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+<span class="warning">This extension is deprecated.</span> New implementations
+should use <a href="atom.html">LV2 Atom</a> instead.
+
+This extension defines a generic time-stamped event port type, which can be
+used to create plugins that read and write real-time events, such as MIDI,
+OSC, or any other type of event payload. The type(s) of event supported by
+a port is defined in the data file for a plugin, for example:
+
+ :::turtle
+ &lt;http://example.org/some-plugin&gt;
+ lv2:port [
+ a ev:EventPort, lv2:InputPort ;
+ lv2:index 0 ;
+ ev:supportsEvent &lt;http://lv2plug.in/ns/ext/midi#MidiEvent&gt; ;
+ lv2:symbol "midi_input" ;
+ lv2:name "MIDI input" ;
+ ] .
+
+"""^^lv2:Markdown .
+
+ev:EventPort
+ lv2:documentation """
+
+Ports of this type will be connected to a struct of type LV2_Event_Buffer,
+defined in event.h. These ports contain a sequence of generic events (possibly
+several types mixed in a single stream), the specific types of which are
+defined by some URI in another LV2 extension.
+
+"""^^lv2:Markdown .
+
+ev:Event
+ a rdfs:Class ;
+ rdfs:label "Event" ;
+ lv2:documentation """
+
+An ev:EventPort contains an LV2_Event_Buffer which contains a sequence of these
+events. The binary format of LV2 events is defined by the LV2_Event struct in
+event.h.
+
+Specific event types (such as MIDI or OSC) are defined by extensions, and
+should be rdfs:subClassOf this class.
+
+"""^^lv2:Markdown .
+
+ev:TimeStamp
+ lv2:documentation """
+
+This defines the meaning of the 'frames' and 'subframes' fields of an LV2_Event
+(both unsigned 32-bit integers).
+
+"""^^lv2:Markdown .
+
+ev:FrameStamp
+ lv2:documentation """
+
+The default time stamp unit for an LV2 event: the frames field represents audio
+frames (in the sample rate passed to intantiate), and the subframes field is
+1/UINT32_MAX of a frame.
+
+"""^^lv2:Markdown .
+
+ev:generic
+ lv2:documentation """
+
+Indicates that this port does something meaningful for any event type. This is
+useful for things like event mixers, delays, serialisers, and so on.
+
+If this property is set, hosts should consider the port suitable for any type
+of event. Otherwise, hosts should consider the port 'appropriate' only for the
+specific event types listed with :supportsEvent. Note that plugins must
+gracefully handle unknown event types whether or not this property is present.
+
+"""^^lv2:Markdown .
+
+ev:supportsEvent
+ lv2:documentation """
+
+Indicates that this port supports or "understands" a certain event type.
+
+For input ports, this means the plugin understands and does something useful
+with events of this type. For output ports, this means the plugin may generate
+events of this type. If the plugin never actually generates events of this
+type, but might pass them through from an input, this property should not be
+set (use ev:inheritsEvent for that).
+
+Plugins with event input ports must always gracefully handle any type of event,
+even if it does not 'support' it. This property should always be set for event
+types the plugin understands/generates so hosts can discover plugins
+appropriate for a given scenario (for example, plugins with a MIDI input).
+Hosts are not expected to consider event ports suitable for some type of event
+if the relevant :supportsEvent property is not set, unless the ev:generic
+property for that port is also set.
+
+
+"""^^lv2:Markdown .
+
+ev:inheritsEvent
+ lv2:documentation """
+
+Indicates that this output port might pass through events that arrived at some
+other input port (or generate an event of the same type as events arriving at
+that input). The host must always check the stamp type of all outputs when
+connecting an input, but this property should be set whenever it applies.
+
+
+"""^^lv2:Markdown .
+
+ev:supportsTimeStamp
+ lv2:documentation """
+
+Indicates that this port supports or "understands" a certain time stamp type.
+Meaningful only for input ports, the host must never connect a port to an event
+buffer with a time stamp type that isn't supported by the port.
+
+"""^^lv2:Markdown .
+
+ev:generatesTimeStamp
+ lv2:documentation """
+
+Indicates that this port may output a certain time stamp type, regardless of
+the time stamp type of any input ports.
+
+If the port outputs stamps based on what type inputs are connected to, this
+property should not be set (use the ev:inheritsTimeStamp property for that).
+Hosts MUST check the time_stamp value of any output port buffers after a call
+to connect_port on ANY event input port on the plugin.
+
+If the plugin changes the stamp_type field of an output event buffer during a
+call to run(), the plugin must call the stamp_type_changed function provided by
+the host in the LV2_Event_Feature struct, if it is non-NULL.
+
+"""^^lv2:Markdown .
+
+ev:inheritsTimeStamp
+ lv2:documentation """
+
+Indicates that this port follows the time stamp type of an input port.
+
+This property is not necessary, but it should be set for outputs that base
+their output type on an input port so the host can make more sense of the
+plugin and provide a more sensible interface.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/event/event.ttl b/lv2/event/event.ttl
new file mode 100644
index 0000000..de400d4
--- /dev/null
+++ b/lv2/event/event.ttl
@@ -0,0 +1,86 @@
+@prefix ev: <http://lv2plug.in/ns/ext/event#> .
+@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#> .
+
+<http://lv2plug.in/ns/ext/event>
+ a owl:Ontology ;
+ owl:deprecated true ;
+ rdfs:label "LV2 Event" ;
+ rdfs:comment "A port-based real-time generic event interface." ;
+ rdfs:seeAlso <event.h> ,
+ <event-helpers.h> ,
+ <event.meta.ttl> .
+
+ev:EventPort
+ a rdfs:Class ;
+ rdfs:label "Event Port" ;
+ rdfs:subClassOf lv2:Port ;
+ rdfs:comment "An LV2 event port." .
+
+ev:Event
+ a rdfs:Class ;
+ rdfs:label "Event" ;
+ rdfs:comment "A single generic time-stamped event." .
+
+ev:TimeStamp
+ a rdfs:Class ;
+ rdfs:label "Event Time Stamp" ;
+ rdfs:comment "The time stamp of an Event." .
+
+ev:FrameStamp
+ a rdfs:Class ;
+ rdfs:subClassOf ev:TimeStamp ;
+ rdfs:label "Audio Frame Time Stamp" ;
+ rdfs:comment "The default time stamp unit for an event." .
+
+ev:generic
+ a lv2:PortProperty ;
+ rdfs:label "generic event port" ;
+ rdfs:comment "Port works with generic events." .
+
+ev:supportsEvent
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain ev:EventPort ;
+ rdfs:range rdfs:Class ;
+ rdfs:label "supports event type" ;
+ rdfs:comment "An event type supported by this port." .
+
+ev:inheritsEvent
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain ev:EventPort ,
+ lv2:OutputPort ;
+ rdfs:range lv2:Port ;
+ rdfs:label "inherits event type" ;
+ rdfs:comment "Output port inherits event types from an input port." .
+
+ev:supportsTimeStamp
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain ev:EventPort ,
+ lv2:InputPort ;
+ rdfs:range rdfs:Class ;
+ rdfs:label "supports time stamp type" ;
+ rdfs:comment "A time stamp type suported by this input port." .
+
+ev:generatesTimeStamp
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain ev:EventPort ,
+ lv2:OutputPort ;
+ rdfs:range rdfs:Class ;
+ rdfs:label "generates time stamp type" ;
+ rdfs:comment "A time stamp type generated by this input port." .
+
+ev:inheritsTimeStamp
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain ev:EventPort ,
+ lv2:OutputPort ;
+ rdfs:range lv2:Port ;
+ rdfs:label "inherits time stamp type" ;
+ rdfs:comment "Output port inherits time stamp types from an input port." .
+
diff --git a/lv2/lv2plug.in/ns/ext/event/manifest.ttl b/lv2/event/manifest.ttl
index 7e246f7..0194d71 100644
--- a/lv2/lv2plug.in/ns/ext/event/manifest.ttl
+++ b/lv2/event/manifest.ttl
@@ -1,9 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/event>
a lv2:Specification ;
lv2:minorVersion 1 ;
- lv2:microVersion 10 ;
+ lv2:microVersion 12 ;
rdfs:seeAlso <event.ttl> .
diff --git a/lv2/lv2plug.in/ns/ext/instance-access/instance-access.h b/lv2/instance-access/instance-access.h
index 06d8dde..6a58541 100644
--- a/lv2/lv2plug.in/ns/ext/instance-access/instance-access.h
+++ b/lv2/instance-access/instance-access.h
@@ -1,6 +1,6 @@
/*
LV2 Instance Access Extension
- Copyright 2008-2012 David Robillard <http://drobilla.net>
+ Copyright 2008-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -15,23 +15,23 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-#ifndef LV2_INSTANCE_ACCESS_H
-#define LV2_INSTANCE_ACCESS_H
+/**
+ @defgroup instance-access Instance Access
+ @ingroup lv2
-#define LV2_INSTANCE_ACCESS_URI "http://lv2plug.in/ns/ext/instance-access"
+ Access to the LV2_Handle of a plugin for UIs; see
+ <http://lv2plug.in/ns/ext/instance-access> for details.
-/**
- @file instance-access.h
- C header for the LV2 Instance Access extension
- <http://lv2plug.in/ns/ext/instance-access>.
-
- This extension defines a method for (e.g.) plugin UIs to get a direct
- handle to an LV2 plugin instance (LV2_Handle), if possible.
-
- To support this feature the host must pass an LV2_Feature struct to the
- UI instantiate method with URI "http://lv2plug.in/ns/ext/instance-access"
- and data pointed directly to the LV2_Handle of the plugin instance.
+ @{
*/
+#ifndef LV2_INSTANCE_ACCESS_H
+#define LV2_INSTANCE_ACCESS_H
+
+#define LV2_INSTANCE_ACCESS_URI "http://lv2plug.in/ns/ext/instance-access" ///< http://lv2plug.in/ns/ext/instance-access
+
#endif /* LV2_INSTANCE_ACCESS_H */
+/**
+ @}
+*/
diff --git a/lv2/lv2plug.in/ns/ext/instance-access/lv2-instance-access.doap.ttl b/lv2/instance-access/instance-access.meta.ttl
index 2c7cba8..875e2f8 100644
--- a/lv2/lv2plug.in/ns/ext/instance-access/lv2-instance-access.doap.ttl
+++ b/lv2/instance-access/instance-access.meta.ttl
@@ -1,11 +1,12 @@
@prefix dcs: <http://ontologi.es/doap-changeset#> .
@prefix doap: <http://usefulinc.com/ns/doap#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix ia: <http://lv2plug.in/ns/ext/instance-access#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/instance-access>
a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
doap:license <http://opensource.org/licenses/isc> ;
doap:name "LV2 Instance Access" ;
doap:shortdesc "Provides access to the LV2_Handle of a plugin." ;
@@ -55,4 +56,20 @@
rdfs:label "Initial release."
]
]
- ] .
+ ] ;
+ lv2:documentation """
+
+This extension defines a feature which allows plugin UIs to get a direct handle
+to an LV2 plugin instance (LV2_Handle), if possible.
+
+Note that the use of this extension by UIs violates the important principle of
+UI/plugin separation, and is potentially a source of many problems.
+Accordingly, **use of this extension is highly discouraged**, and plugins
+should not expect hosts to support it, since it is often impossible to do so.
+
+To support this feature the host must pass an LV2_Feature struct to the UI
+instantiate method with URI LV2_INSTANCE_ACCESS_URI and data pointed directly
+to the LV2_Handle of the plugin instance.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/instance-access/instance-access.ttl b/lv2/instance-access/instance-access.ttl
new file mode 100644
index 0000000..085ae37
--- /dev/null
+++ b/lv2/instance-access/instance-access.ttl
@@ -0,0 +1,11 @@
+@prefix ia: <http://lv2plug.in/ns/ext/instance-access#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/instance-access>
+ a lv2:Feature ;
+ rdfs:label "instance access" ;
+ rdfs:comment "A feature that provides access to a plugin instance." ;
+ rdfs:seeAlso <instance-access.h> ,
+ <instance-access.meta.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/ext/instance-access/manifest.ttl b/lv2/instance-access/manifest.ttl
index cee5dbf..e6c8810 100644
--- a/lv2/lv2plug.in/ns/ext/instance-access/manifest.ttl
+++ b/lv2/instance-access/manifest.ttl
@@ -1,4 +1,4 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/instance-access>
diff --git a/lv2/lv2plug.in/ns/ext/log/log.h b/lv2/log/log.h
index 2279fa3..8930fac 100644
--- a/lv2/lv2plug.in/ns/ext/log/log.h
+++ b/lv2/log/log.h
@@ -1,5 +1,5 @@
/*
- Copyright 2012 David Robillard <http://drobilla.net>
+ Copyright 2012-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -15,37 +15,44 @@
*/
/**
- @file log.h C header for the LV2 Log extension
- <http://lv2plug.in/ns/ext/log>.
+ @defgroup log Log
+ @ingroup lv2
+
+ Interface for plugins to log via the host; see
+ <http://lv2plug.in/ns/ext/log> for details.
+
+ @{
*/
#ifndef LV2_LOG_H
#define LV2_LOG_H
-#define LV2_LOG_URI "http://lv2plug.in/ns/ext/log"
-#define LV2_LOG_PREFIX LV2_LOG_URI "#"
+#define LV2_LOG_URI "http://lv2plug.in/ns/ext/log" ///< http://lv2plug.in/ns/ext/log
+#define LV2_LOG_PREFIX LV2_LOG_URI "#" ///< http://lv2plug.in/ns/ext/log#
-#define LV2_LOG__Entry LV2_LOG_PREFIX "Entry"
-#define LV2_LOG__Error LV2_LOG_PREFIX "Error"
-#define LV2_LOG__Note LV2_LOG_PREFIX "Note"
-#define LV2_LOG__Trace LV2_LOG_PREFIX "Trace"
-#define LV2_LOG__Warning LV2_LOG_PREFIX "Warning"
-#define LV2_LOG__log LV2_LOG_PREFIX "log"
+#define LV2_LOG__Entry LV2_LOG_PREFIX "Entry" ///< http://lv2plug.in/ns/ext/log#Entry
+#define LV2_LOG__Error LV2_LOG_PREFIX "Error" ///< http://lv2plug.in/ns/ext/log#Error
+#define LV2_LOG__Note LV2_LOG_PREFIX "Note" ///< http://lv2plug.in/ns/ext/log#Note
+#define LV2_LOG__Trace LV2_LOG_PREFIX "Trace" ///< http://lv2plug.in/ns/ext/log#Trace
+#define LV2_LOG__Warning LV2_LOG_PREFIX "Warning" ///< http://lv2plug.in/ns/ext/log#Warning
+#define LV2_LOG__log LV2_LOG_PREFIX "log" ///< http://lv2plug.in/ns/ext/log#log
-#include <stdarg.h>
+#include "lv2/urid/urid.h"
-#include "lv2/lv2plug.in/ns/ext/urid/urid.h"
+#include <stdarg.h>
#ifdef __cplusplus
extern "C" {
#endif
+/** @cond */
#ifdef __GNUC__
/** Allow type checking of printf-like functions. */
# define LV2_LOG_FUNC(fmt, arg1) __attribute__((format(printf, fmt, arg1)))
#else
# define LV2_LOG_FUNC(fmt, arg1)
#endif
+/** @endcond */
/**
Opaque data to host data for LV2_Log_Log.
@@ -55,7 +62,7 @@ typedef void* LV2_Log_Handle;
/**
Log feature (LV2_LOG__log)
*/
-typedef struct _LV2_Log {
+typedef struct {
/**
Opaque pointer to host data.
@@ -69,7 +76,7 @@ typedef struct _LV2_Log {
The API of this function matches that of the standard C printf function,
except for the addition of the first two parameters. This function may
- be called from any non-realtime context, or from any context if @p type
+ be called from any non-realtime context, or from any context if `type`
is @ref LV2_LOG__Trace.
*/
LV2_LOG_FUNC(3, 4)
@@ -83,7 +90,7 @@ typedef struct _LV2_Log {
The API of this function matches that of the standard C vprintf
function, except for the addition of the first two parameters. This
function may be called from any non-realtime context, or from any
- context if @p type is @ref LV2_LOG__Trace.
+ context if `type` is @ref LV2_LOG__Trace.
*/
LV2_LOG_FUNC(3, 0)
int (*vprintf)(LV2_Log_Handle handle,
@@ -97,3 +104,7 @@ typedef struct _LV2_Log {
#endif
#endif /* LV2_LOG_H */
+
+/**
+ @}
+*/
diff --git a/lv2/log/log.meta.ttl b/lv2/log/log.meta.ttl
new file mode 100644
index 0000000..87cff43
--- /dev/null
+++ b/lv2/log/log.meta.ttl
@@ -0,0 +1,126 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix log: <http://lv2plug.in/ns/ext/log#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/log>
+ a doap:Project ;
+ doap:name "LV2 Log" ;
+ doap:shortdesc "A feature for writing log messages." ;
+ doap:created "2012-01-12" ;
+ doap:developer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "2.4" ;
+ doap:created "2016-07-30" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.14.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add lv2_log_logger_set_map() for changing the URI map of an existing logger."
+ ]
+ ]
+ ] , [
+ doap:revision "2.2" ;
+ doap:created "2014-01-04" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.8.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add missing include string.h to logger.h for memset."
+ ]
+ ]
+ ] , [
+ doap:revision "2.0" ;
+ doap:created "2013-01-08" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add logger convenience API."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+This extension defines a feature, log:log, which allows plugins to print log
+messages with an API similar to the standard C `printf` function. This allows,
+for example, plugin logs to be nicely presented to the user in a graphical user
+interface.
+
+Different log levels are defined by URI and passed as an LV2_URID. This
+extensions defines standard levels which are expected to be understood by all
+implementations and should be sufficient in most cases, but advanced
+implementations may define and use additional levels to suit their needs.
+
+"""^^lv2:Markdown .
+
+log:Entry
+ a rdfs:Class ;
+ rdfs:label "Log Entry" ;
+ lv2:documentation """
+
+Subclasses of this are passed as the `type` parameter to LV2_Log_Log methods to
+describe the nature of the log entry.
+
+"""^^lv2:Markdown .
+
+log:Error
+ lv2:documentation """
+
+An error should only be posted when a serious unexpected error occurs, and
+should be actively shown to the user by the host.
+
+"""^^lv2:Markdown .
+
+log:Note
+ lv2:documentation """
+
+A note records some useful piece of information, but may be ignored. The host
+should provide passive access to note entries to the user.
+
+"""^^lv2:Markdown .
+
+log:Warning
+ lv2:documentation """
+
+A warning should be posted when an unexpected, but non-critical, error occurs.
+The host should provide passive access to warnings entries to the user, but may
+also choose to actively show them.
+
+"""^^lv2:Markdown .
+
+log:Trace
+ lv2:documentation """
+
+A trace should not be displayed during normal operation, but the host may
+implement an option to display them for debugging purposes.
+
+This entry type is special in that one may be posted in a real-time thread. It
+is assumed that if debug tracing is enabled, real-time performance is not a
+concern. However, the host MUST guarantee that posting a trace _is_ real-time
+safe if debug tracing is not enabled (for example, by simply ignoring the call
+as early as possible).
+
+"""^^lv2:Markdown .
+
+log:log
+ lv2:documentation """
+
+A feature which plugins may use to log messages. To support this feature,
+the host must pass an LV2_Feature to LV2_Descriptor::instantiate() with URI
+LV2_LOG__log and data pointed to an instance of LV2_Log_Log.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/log/log.ttl b/lv2/log/log.ttl
new file mode 100644
index 0000000..46cba45
--- /dev/null
+++ b/lv2/log/log.ttl
@@ -0,0 +1,48 @@
+@prefix log: <http://lv2plug.in/ns/ext/log#> .
+@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 xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+<http://lv2plug.in/ns/ext/log>
+ a owl:Ontology ;
+ rdfs:label "LV2 Log" ;
+ rdfs:comment "A feature for writing log messages." ;
+ rdfs:seeAlso <log.h> ,
+ <log.meta.ttl> .
+
+log:Entry
+ a rdfs:Class ;
+ rdfs:label "Entry" ;
+ rdfs:comment "A log entry." .
+
+log:Error
+ a rdfs:Class ;
+ rdfs:label "Error" ;
+ rdfs:subClassOf log:Entry ;
+ rdfs:comment "An error message." .
+
+log:Note
+ a rdfs:Class ;
+ rdfs:label "Note" ;
+ rdfs:subClassOf log:Entry ;
+ rdfs:comment "An informative message." .
+
+log:Warning
+ a rdfs:Class ;
+ rdfs:label "Warning" ;
+ rdfs:subClassOf log:Entry ;
+ rdfs:comment "A warning message." .
+
+log:Trace
+ a rdfs:Class ;
+ rdfs:label "Trace" ;
+ rdfs:subClassOf log:Entry ;
+ rdfs:comment "A debugging trace message." .
+
+log:log
+ a lv2:Feature ;
+ rdfs:label "log" ;
+ rdfs:comment "Logging feature." .
+
diff --git a/lv2/lv2plug.in/ns/ext/log/logger.h b/lv2/log/logger.h
index 88ca0aa..b66a8e4 100644
--- a/lv2/lv2plug.in/ns/ext/log/logger.h
+++ b/lv2/log/logger.h
@@ -1,5 +1,5 @@
/*
- Copyright 2012-2013 David Robillard <http://drobilla.net>
+ Copyright 2012-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -15,23 +15,24 @@
*/
/**
- @file logger.h Convenience API for easy logging in plugin code.
+ @defgroup logger Logger
+ @ingroup log
- This file provides simple wrappers for the most common log operations for
- use in plugin implementations. If host support for logging is not
- available, then these functions will print to stderr instead.
+ Convenience API for easy logging in plugin code. This API provides simple
+ wrappers for logging from a plugin, which automatically fall back to
+ printing to stderr if host support is unavailabe.
- This header is non-normative, it is provided for convenience.
+ @{
*/
#ifndef LV2_ATOM_LOGGER_H
#define LV2_ATOM_LOGGER_H
+#include "lv2/log/log.h"
+
#include <stdio.h>
#include <string.h>
-#include "lv2/lv2plug.in/ns/ext/log/log.h"
-
#ifdef __cplusplus
extern "C" {
#endif
@@ -49,28 +50,41 @@ typedef struct {
} LV2_Log_Logger;
/**
- Initialise @p logger.
+ Set `map` as the URI map for `logger`.
- URIs will be mapped using @p map and stored, a reference to @p map itself is
- not held. Both @p map and @p log may be NULL when unsupported by the host,
- in which case the implementation will fall back to printing to stderr.
+ This affects the message type URIDs (Error, Warning, etc) which are passed
+ to the log's print functions.
*/
static inline void
-lv2_log_logger_init(LV2_Log_Logger* logger,
- LV2_URID_Map* map,
- LV2_Log_Log* log)
+lv2_log_logger_set_map(LV2_Log_Logger* logger, LV2_URID_Map* map)
{
- memset(logger, 0, sizeof(LV2_Log_Logger));
- logger->log = log;
if (map) {
logger->Error = map->map(map->handle, LV2_LOG__Error);
logger->Note = map->map(map->handle, LV2_LOG__Note);
logger->Trace = map->map(map->handle, LV2_LOG__Trace);
logger->Warning = map->map(map->handle, LV2_LOG__Warning);
+ } else {
+ logger->Error = logger->Note = logger->Trace = logger->Warning = 0;
}
}
/**
+ Initialise `logger`.
+
+ URIs will be mapped using `map` and stored, a reference to `map` itself is
+ not held. Both `map` and `log` may be NULL when unsupported by the host,
+ in which case the implementation will fall back to printing to stderr.
+*/
+static inline void
+lv2_log_logger_init(LV2_Log_Logger* logger,
+ LV2_URID_Map* map,
+ LV2_Log_Log* log)
+{
+ logger->log = log;
+ lv2_log_logger_set_map(logger, map);
+}
+
+/**
Log a message to the host, or stderr if support is unavailable.
*/
LV2_LOG_FUNC(3, 0)
@@ -80,11 +94,9 @@ lv2_log_vprintf(LV2_Log_Logger* logger,
const char* fmt,
va_list args)
{
- if (logger->log) {
- return logger->log->vprintf(logger->log->handle, type, fmt, args);
- } else {
- return vfprintf(stderr, fmt, args);
- }
+ return ((logger && logger->log)
+ ? logger->log->vprintf(logger->log->handle, type, fmt, args)
+ : vfprintf(stderr, fmt, args));
}
/** Log an error via lv2_log_vprintf(). */
@@ -135,12 +147,12 @@ lv2_log_warning(LV2_Log_Logger* logger, const char* fmt, ...)
return ret;
}
-/**
- @}
-*/
-
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* LV2_LOG_LOGGER_H */
+
+/**
+ @}
+*/
diff --git a/lv2/lv2plug.in/ns/ext/log/manifest.ttl b/lv2/log/manifest.ttl
index c76008b..bcaeff3 100644
--- a/lv2/lv2plug.in/ns/ext/log/manifest.ttl
+++ b/lv2/log/manifest.ttl
@@ -1,9 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/log>
a lv2:Specification ;
lv2:minorVersion 2 ;
- lv2:microVersion 1 ;
+ lv2:microVersion 4 ;
rdfs:seeAlso <log.ttl> .
diff --git a/lv2/lv2plug.in/ns/ext/atom/atom.ttl b/lv2/lv2plug.in/ns/ext/atom/atom.ttl
deleted file mode 100644
index c222ebf..0000000
--- a/lv2/lv2plug.in/ns/ext/atom/atom.ttl
+++ /dev/null
@@ -1,601 +0,0 @@
-@prefix atom: <http://lv2plug.in/ns/ext/atom#> .
-@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 ui: <http://lv2plug.in/ns/extensions/ui#> .
-@prefix units: <http://lv2plug.in/ns/extensions/units#> .
-@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
-
-<http://lv2plug.in/ns/ext/atom>
- a owl:Ontology ;
- rdfs:seeAlso <atom.h> ,
- <util.h> ,
- <forge.h> ,
- <lv2-atom.doap.ttl> ;
- lv2:documentation """
-<p>This specification defines a simple generic data container, called an
-<q>Atom</q>. An atom:Atom can contain simple primitive types like integers,
-floating point numbers, and strings; as well as structured data like lists and
-dictionary-like <q>Objects</q>. An Atom is, with one exception, Plain Old Data
-(POD), meaning it can be easily copied (e.g. using <code>memcpy</code>) and is
-suitable for use in real-time code.</p>
-
-<p>Atoms are not limited to the types defined here, but allow implementations
-to work with any type of POD data at all. This is possible because Atom types
-are URIs, but mapped to integers using the <a href="../urid/urid.html">LV2
-URID</a> extension for performance reasons.</p>
-
-<p>Since atoms are simple to copy,
-communication of any atom is simple to implement without requiring special code
-for every type of data. For example, plugins that mutually understand a type
-can be used together in a host that does not understand that type, because the
-host is only required to copy atoms, not interpret their contents. Similarly,
-plugins (such as routers, delays, or data structures) can meaningfully process
-atoms of a type unknown to them.</p>
-
-<p>Atoms can and should be used anywhere values of various types must be stored
-or transmitted. The port type atom:AtomPort can be used to transmit atoms via
-ports. An atom:AtomPort that contains an atom:Sequence can be used for sample
-accurate event communication, such as MIDI, and replaces the earlier <a
-href="../event/event.html">LV2 event</a> extension.</p>
-
-<h3>Serialisation</h3>
-
-<p>Each Atom type defines a binary format for use at runtime, but also a
-serialisation that is natural to express in Turtle format. Thus, this
-specification defines a powerful real-time appropriate data model, as well as a
-portable way to serialise any data in that model. This is particularly useful
-for inter-process communication, saving/restoring state, and describing values
-in plugin data files.</p>
-
-<h3>Custom Atom Types</h3>
-
-<p>While it is possible to define new Atom types for any binary format, the
-standard types defined here are powerful enough to describe almost anything.
-Implementations SHOULD build structures out of the types provided here, rather
-than define new binary formats (e.g. use atom:Tuple or atom:Object rather than
-a new C <code>struct</code> type). Current implementations have support for
-serialising all standard types, so new binary formats are an implementation
-burden which harms interoperabilty. In particular, plugins SHOULD NOT expect
-UI communication or state saving with custom Atom types to work. In general,
-new Atom types should only be defined where absolutely necessary due to
-performance reasons and serialisation is not a concern.</p>
-""" .
-
-atom:cType
- a rdf:Property ,
- owl:DatatypeProperty ,
- owl:FunctionalProperty ;
- rdfs:label "C type" ;
- rdfs:domain rdfs:Class ;
- rdfs:range lv2:Symbol ;
- rdfs:comment """
-The identifier for a C type describing the binary representation of an Atom of
-this type.
-""" .
-
-atom:Atom
- a rdfs:Class ;
- rdfs:label "Atom" ;
- atom:cType "LV2_Atom" ;
- lv2:documentation """
-<p>Abstract base class for all atoms. An LV2_Atom has a 32-bit
-<code>size</code> and <code>type</code> followed by a body of <code>size</code>
-bytes. Atoms MUST be 64-bit aligned.</p>
-
-<p>All concrete Atom types (subclasses of this class) MUST define a precise
-binary layout for their body.</p>
-
-<p>The <code>type</code> field is the URI of an Atom type mapped to an integer.
-Implementations SHOULD gracefully pass through, or ignore, atoms with unknown
-types.</p>
-
-<p>All atoms are POD by definition except references, which as a special case
-have <code>type = 0</code>. An Atom MUST NOT contain a Reference. It is safe
-to copy any non-reference Atom with a simple <code>memcpy</code>, even if the
-implementation does not understand <code>type</code>. Though this extension
-reserves the type 0 for references, the details of reference handling are
-currently unspecified. A future revision of this extension, or a different
-extension, may define how to use non-POD data and references. Implementations
-MUST NOT send references to another implementation unless the receiver is
-explicitly known to support references (e.g. by supporting a feature).</p>
-
-<p>The atom with both <code>type</code> <em>and</em> <code>size</code> 0 is
-<q>null</q>, which is not considered a Reference.</p>
-""" .
-
-atom:Chunk
- a rdfs:Class ,
- rdfs:Datatype ;
- rdfs:subClassOf atom:Atom ;
- rdfs:label "Chunk of memory" ;
- owl:onDatatype xsd:base64Binary ;
- lv2:documentation """
-<p>A chunk of memory with undefined contents. This type is used to indicate a
-certain amount of space is available. For example, output ports with a
-variably sized type are connected to a Chunk so the plugin knows the size of
-the buffer available for writing.</p>
-
-<p>The use of a Chunk should be constrained to a local scope, since
-interpreting it is impossible without context. However, if serialised to RDF,
-a Chunk may be represented directly as an xsd:base64Binary string, e.g.:</p>
-
-<pre class="turtle-code">
-[] eg:someChunk "vu/erQ=="^^xsd:base64Binary .
-</pre>
-""" .
-
-atom:Number
- a rdfs:Class ;
- rdfs:subClassOf atom:Atom ;
- rdfs:label "Number" .
-
-atom:Int
- a rdfs:Class ,
- rdfs:Datatype ;
- rdfs:subClassOf atom:Number ;
- rdfs:label "Signed 32-bit integer" ;
- atom:cType "LV2_Atom_Int" ;
- owl:onDatatype xsd:int .
-
-atom:Long
- a rdfs:Class ,
- rdfs:Datatype ;
- rdfs:subClassOf atom:Number ;
- rdfs:label "Signed 64-bit integer" ;
- atom:cType "LV2_Atom_Long" ;
- owl:onDatatype xsd:long .
-
-atom:Float
- a rdfs:Class ,
- rdfs:Datatype ;
- rdfs:subClassOf atom:Number ;
- rdfs:label "32-bit IEEE-754 floating point number" ;
- atom:cType "LV2_Atom_Float" ;
- owl:onDatatype xsd:float .
-
-atom:Double
- a rdfs:Class ,
- rdfs:Datatype ;
- rdfs:subClassOf atom:Number ;
- rdfs:label "64-bit IEEE-754 floating point number" ;
- atom:cType "LV2_Atom_Double" ;
- owl:onDatatype xsd:double .
-
-atom:Bool
- a rdfs:Class ,
- rdfs:Datatype ;
- rdfs:subClassOf atom:Atom ;
- rdfs:label "Boolean" ;
- atom:cType "LV2_Atom_Bool" ;
- owl:onDatatype xsd:boolean ;
- rdfs:comment "An Int where 0 is false and any other value is true." .
-
-atom:String
- a rdfs:Class ,
- rdfs:Datatype ;
- rdfs:subClassOf atom:Atom ;
- rdfs:label "String" ;
- atom:cType "LV2_Atom_String" ;
- owl:onDatatype xsd:string ;
- lv2:documentation """
-<p>A UTF-8 encoded string.</p>
-
-<p>The body of an LV2_Atom_String is a C string in UTF-8 encoding, i.e. an
-array of bytes (<code>uint8_t</code>) terminated with a NULL byte
-(<code>'\\0'</code>).</p>
-
-<p>This type is for free-form strings, but SHOULD NOT be used for typed data or
-text in any language. Use atom:Literal unless translating the string does not
-make sense and the string has no meaningful datatype.</p>
-""" .
-
-atom:Literal
- a rdfs:Class ;
- rdfs:subClassOf atom:Atom ;
- rdfs:label "String Literal" ;
- atom:cType "LV2_Atom_Literal" ;
- lv2:documentation """
-<p>A UTF-8 encoded string literal, with an optional datatype or language.</p>
-
-<p>This type is compatible with rdfs:Literal and is capable of expressing a
-string in any language or a value of any type. A Literal has a
-<code>datatype</code> and <code>lang</code> followed by string data in UTF-8
-encoding. The length of the string data in bytes is <code>size -
-sizeof(LV2_Atom_Literal)</code>, including the terminating NULL character. The
-<code>lang</code> field SHOULD be a URI of the form
-&lt;http://lexvo.org/id/iso639-3/LANG&gt; or
-&lt;http://lexvo.org/id/iso639-1/LANG&gt; where LANG is a 3-character ISO 693-3
-language code, or a 2-character ISO 693-1 language code, respectively.</p>
-
-<p>A Literal may have a <code>datatype</code> OR a <code>lang</code>, but never
-both.</p>
-
-<p>For example, a Literal can be "Hello" in English:</p>
-<pre class="c-code">
-void set_to_hello_in_english(LV2_Atom_Literal* lit) {
- lit->atom.type = map(expand("atom:Literal"));
- lit->atom.size = 14;
- lit->body.datatype = 0;
- lit->body.lang = map("http://lexvo.org/id/iso639-1/en");
- memcpy(LV2_ATOM_CONTENTS(LV2_Atom_Literal, lit),
- "Hello",
- sizeof("Hello")); // Assumes enough space
-}
-</pre>
-
-<p>or a Turtle string:</p>
-<pre class="c-code">
-void set_to_turtle_string(LV2_Atom_Literal* lit, const char* ttl) {
- lit->atom.type = map(expand("atom:Literal"));
- lit->atom.size = 64;
- lit->body.datatype = map("http://www.w3.org/2008/turtle#turtle");
- lit->body.lang = 0;
- memcpy(LV2_ATOM_CONTENTS(LV2_Atom_Literal, lit),
- ttl,
- strlen(ttl) + 1); // Assumes enough space
-}
-</pre>
-""" .
-
-atom:Path
- a rdfs:Class ,
- rdfs:Datatype ;
- rdfs:subClassOf atom:URI ;
- owl:onDatatype atom:URI ;
- rdfs:label "File path string" ;
- lv2:documentation """
-<p>A local file path.</p>
-
-<p>A Path is a URI reference with only a path component: no scheme, authority,
-query, or fragment. In particular, paths to files in the same bundle may be
-cleanly written in Turtle files as a relative URI. However, implementations
-may assume any binary Path (e.g. in an event payload) is a valid file path
-which can passed to system functions like fopen() directly, without any
-character encoding or escape expansion required.</p>
-
-<p>Any implemenation that creates a Path atom to transmit to another is
-responsible for ensuring it is valid. A Path SHOULD always be absolute, unless
-there is some mechanism in place that defines a base path. Since this is not
-the case for plugin instances, effectively any Path sent to or received from a
-plugin instance MUST be absolute.</p>
-""" .
-
-atom:URI
- a rdfs:Class ,
- rdfs:Datatype ;
- rdfs:subClassOf atom:String ;
- owl:onDatatype xsd:anyURI ;
- rdfs:label "URI string" ;
- lv2:documentation """
-<p>A URI string. This is useful when a URI is needed but mapping is
-inappropriate, for example with temporary or relative URIs. Since the ability
-to distinguish URIs from plain strings is often necessary, URIs MUST NOT be
-transmitted as atom:String.</p>
-
-<p>This is not strictly a URI, since UTF-8 is allowed. Escaping and related
-issues are the host's responsibility.</p>
-""" .
-
-atom:URID
- a rdfs:Class ;
- rdfs:subClassOf atom:Atom ;
- rdfs:label "Integer ID mapped from a URI" ;
- atom:cType "LV2_Atom_URID" ;
- lv2:documentation """
-<p>An unsigned 32-bit integer mapped from a URI (e.g. with LV2_URID_Map).</p>
-""" .
-
-atom:Vector
- a rdfs:Class ;
- rdfs:subClassOf atom:Atom ;
- rdfs:label "Vector" ;
- atom:cType "LV2_Atom_Vector" ;
- lv2:documentation """
-<p>A homogeneous series of atom bodies with equivalent type and size.</p>
-
-<p>An LV2_Atom_Vector is a 32-bit <code>child_size</code> and
-<code>child_type</code> followed by <code>size / child_size</code> atom
-bodies.</p>
-
-<p>For example, an atom:Vector containing 42 elements of type atom:Float:</p>
-<pre class="c-code">
-struct VectorOf42Floats {
- uint32_t size; // sizeof(LV2_Atom_Vector_Body) + (42 * sizeof(float);
- uint32_t type; // map(expand("atom:Vector"))
- uint32_t child_size; // sizeof(float)
- uint32_t child_type; // map(expand("atom:Float"))
- float elems[42];
-};
-</pre>
-
-<p>Note that it is possible to construct a valid Atom for each element
-of the vector, even by an implementation which does not understand
-<code>child_type</code>.</p>
-
-<p>If serialised to RDF, a Vector SHOULD have the form:</p>
-
-<pre class="turtle-code">
-eg:someVector
- a atom:Vector ;
- atom:childType atom:Int ;
- rdf:value (
- "1"^^xsd:int
- "2"^^xsd:int
- "3"^^xsd:int
- "4"^^xsd:int
- ) .
-</pre>
-""" .
-
-atom:Tuple
- a rdfs:Class ;
- rdfs:subClassOf atom:Atom ;
- rdfs:label "Tuple" ;
- lv2:documentation """
-<p>A series of Atoms with varying <code>type</code> and <code>size</code>.</p>
-
-<p>The body of a Tuple is simply a series of complete atoms, each aligned to
-64 bits.</p>
-
-<p>If serialised to RDF, a Tuple SHOULD have the form:</p>
-
-<pre class="turtle-code">
-eg:someVector
- a atom:Tuple ;
- rdf:value (
- "1"^^xsd:int
- "3.5"^^xsd:float
- "etc"
- ) .
-</pre>
-
-""" .
-
-atom:Property
- a rdfs:Class ;
- rdfs:subClassOf atom:Atom ;
- rdfs:label "Property" ;
- atom:cType "LV2_Atom_Property" ;
- lv2:documentation """
-<p>A property of an atom:Object. An LV2_Atom_Property has a URID
-<code>key</code> and <code>context</code>, and an Atom <code>value</code>.
-This corresponds to an RDF Property, where the <q>key</q> is the <q>predicate</q>
-and the <q>value</q> is the object.</p>
-
-<p>The <code>context</code> field can be used to specify a different context
-for each property, where this is useful. Otherwise, it may be 0.</p>
-
-<p>Properties generally only exist as part of an atom:Object. Accordingly,
-they will typically be represented directly as properties in RDF (see
-atom:Object). If this is not possible, they may be expressed as partial
-reified statements, e.g.:</p>
-
-<pre class="turtle-code">
-eg:someProperty
- rdf:predicate eg:theKey ;
- rdf:object eg:theValue .
-</pre>
-""" .
-
-atom:Object
- a rdfs:Class ;
- rdfs:subClassOf atom:Atom ;
- rdfs:label "Object" ;
- atom:cType "LV2_Atom_Object" ;
- lv2:documentation """
-<p>An <q>Object</q> is an atom with a set of properties. This corresponds to
-an RDF Resource, and can be thought of as a dictionary with URID keys.</p>
-
-<p>An LV2_Atom_Object has a uint32_t <code>id</code> and uint32_t
-<code>type</code>, followed by a series of atom:Property bodies (without
-headers, i.e. LV2_Atom_Property_Body). The LV2_Atom_Object::type field is
-semantically equivalent to a property with key rdf:type, but is included in the
-structure to allow for fast dispatch.</p>
-
-<p>This is an abstract Atom type, an Object is always either a atom:Resource
-or a atom:Blank.</p>
-
-<p>If serialised to RDF, an Object SHOULD be represented directly as a
-resource, e.g.:</p>
-
-<pre class="turtle-code">
-eg:someObject
- eg:firstPropertyKey "first property value" ;
- eg:secondPropertyKey "first loser" ;
- eg:andSoOn "and so on" .
-</pre>
-""" .
-
-atom:Resource
- a rdfs:Class ;
- rdfs:subClassOf atom:Object ;
- rdfs:label "Resource" ;
- atom:cType "LV2_Atom_Object" ;
- lv2:documentation """
-<p>An atom:Object where the <code>id</code> field is a URID, i.e. an Object
-with a URI.</p>
-""" .
-
-atom:Blank
- a rdfs:Class ;
- rdfs:subClassOf atom:Object ;
- rdfs:label "Blank" ;
- atom:cType "LV2_Atom_Object" ;
- lv2:documentation """
-<p>An atom:Object where the LV2_Atom_Object::id is a blank node ID (NOT a URI).
-The ID of a Blank is valid only within the context the Blank appears in. For
-ports this is the context of the associated run() call, i.e. all ports share
-the same context so outputs can contain IDs that correspond to IDs of blanks in
-the input.</p>
-""" .
-
-atom:Sound
- a rdfs:Class ;
- rdfs:subClassOf atom:Vector ;
- rdfs:label "Sound" ;
- atom:cType "LV2_Atom_Sound" ;
- lv2:documentation """
-<p>An atom:Vector of atom:Float which represents an audio waveform. The format
-is the same as the buffer format for lv2:AudioPort (except the size may be
-arbitrary). An atom:Sound inherently depends on the sample rate, which is
-assumed to be known from context. Because of this, directly serialising an
-atom:Sound is probably a bad idea, use a standard format like WAV instead.</p>
-""" .
-
-atom:frameTime
- a rdf:Property ,
- owl:DatatypeProperty ,
- owl:FunctionalProperty ;
- rdfs:range xsd:decimal ;
- rdfs:label "Frame time" ;
- lv2:documentation """
-<p>Time stamp in audio frames. Typically used for events.</p>
-""" .
-
-atom:beatTime
- a rdf:Property ,
- owl:DatatypeProperty ,
- owl:FunctionalProperty ;
- rdfs:range xsd:decimal ;
- rdfs:label "Beat time" ;
- lv2:documentation """
-<p>Time stamp in beats. Typically used for events.</p>
-""" .
-
-atom:Event
- a rdfs:Class ;
- rdfs:label "Event" ;
- atom:cType "LV2_Atom_Event" ;
- lv2:documentation """
-<p>An atom with a time stamp prefix, typically an element of an atom:Sequence.
-Note this is not an Atom type.</p>
-""" .
-
-atom:Sequence
- a rdfs:Class ;
- rdfs:subClassOf atom:Atom ;
- rdfs:label "Sequence" ;
- atom:cType "LV2_Atom_Sequence" ;
- lv2:documentation """
-<p>A sequence of atom:Event, i.e. a series of time-stamped Atoms.</p>
-
-<p>LV2_Atom_Sequence_Body.unit describes the time unit for the contained atoms.
-If the unit is known from context (e.g. run() stamps are always audio frames),
-this field may be zero. Otherwise, it SHOULD be either units:frame or
-units:beat, in which case ev.time.frames or ev.time.beats is valid,
-respectively.</p>
-
-<p>If serialised to RDF, a Sequence has a similar form to atom:Vector, but for
-brevity the elements may be assumed to be atom:Event, e.g.:</p>
-
-<pre class="turtle-code">
-eg:someSequence
- a atom:Sequence ;
- rdf:value (
- [
- atom:frameTime 1 ;
- rdf:value "901A01"^^midi:MidiEvent
- ] [
- atom:frameTime 3 ;
- rdf:value "902B02"^^midi:MidiEvent
- ]
- ) .
-</pre>
-""" .
-
-atom:AtomPort
- a rdfs:Class ;
- rdfs:subClassOf lv2:Port ;
- rdfs:label "Atom Port" ;
- lv2:documentation """
-<p>A port which contains an atom:Atom. Ports of this type are connected to an
-LV2_Atom with a type specified by atom:bufferType.</p>
-
-<p>Output ports with a variably sized type MUST be initialised by the host
-before every run() to an atom:Chunk with size set to the available space. The
-plugin reads this size to know how much space is available for writing. In all
-cases, the plugin MUST write a complete atom (including header) to outputs.
-However, to be robust, hosts SHOULD initialise output ports to a safe sentinel
-(e.g. the null Atom) before calling run().</p>
-""" .
-
-atom:bufferType
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:domain atom:AtomPort ;
- rdfs:label "buffer type" ;
- lv2:documentation """
-<p>Indicates that an AtomPort may be connected to a certain Atom type. A port
-MAY support several buffer types. The host MUST NOT connect a port to an Atom
-with a type not explicitly listed with this property. The value of this
-property MUST be a sub-class of atom:Atom. For example, an input port that is
-connected directly to an LV2_Atom_Double value is described like so:</p>
-
-<pre class="turtle-code">
-&lt;plugin&gt;
- lv2:port [
- a lv2:InputPort , atom:AtomPort ;
- atom:bufferType atom:Double ;
- ] .
-</pre>
-
-<p>This property only describes the types a port may be <em>directly</em>
-connected to. It says nothing about the expected contents of containers. For
-that, use atom:supports.</p>
-""" .
-
-atom:childType
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:label "child type" ;
- rdfs:comment "The type of a container's children." .
-
-atom:supports
- a rdf:Property ;
- rdfs:label "supports" ;
- lv2:documentation """
-<p>Indicates that a particular Atom type is supported.</p>
-
-<p>This property is defined loosely, it may be used to indicate that anything
-<q>supports</q> an Atom type, wherever that may be useful. It applies
-<q>recursively</q> where collections are involved.</p>
-
-<p>In particular, this property can be used to describe which event types are
-expected by a port. For example, a port that receives MIDI events is described
-like so:</p>
-
-<pre class="turtle-code">
-&lt;plugin&gt;
- lv2:port [
- a lv2:InputPort , atom:AtomPort ;
- atom:bufferType atom:Sequence ;
- atom:supports midi:MidiEvent ;
- ] .
-</pre>
-""" .
-
-atom:eventTransfer
- a ui:PortProtocol ;
- rdfs:label "event transfer" ;
- lv2:documentation """
-<p>Transfer of individual events in a port buffer. Useful as the
-<code>format</code> for a LV2UI_Write_Function.</p>
-
-<p>This protocol applies to ports which contain events, usually in an
-atom:Sequence. The host must transfer each individual event to the recipient.
-The format of the received data is an LV2_Atom, there is no timestamp
-header.</p>
-""" .
-
-atom:atomTransfer
- a ui:PortProtocol ;
- rdfs:label "atom transfer" ;
- lv2:documentation """
-<p>Transfer of the complete atom in a port buffer. Useful as the
-<code>format</code> for a LV2UI_Write_Function.</p>
-
-<p>This protocol applies to atom ports. The host must transfer the complete
-atom contained in the port, including header.</p>
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/atom/lv2-atom.doap.ttl b/lv2/lv2plug.in/ns/ext/atom/lv2-atom.doap.ttl
deleted file mode 100644
index 71b7d95..0000000
--- a/lv2/lv2plug.in/ns/ext/atom/lv2-atom.doap.ttl
+++ /dev/null
@@ -1,68 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/atom>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:name "LV2 Atom" ;
- doap:shortdesc "A generic value container and several data types." ;
- doap:license <http://opensource.org/licenses/isc> ;
- doap:created "2007-00-00" ;
- doap:developer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "1.6" ;
- doap:created "2013-05-26" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.6.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Fix crash in forge.h when pushing atoms to a full buffer."
- ]
- ]
- ] , [
- doap:revision "1.4" ;
- doap:created "2013-01-27" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Fix lv2_atom_sequence_end()."
- ] , [
- rdfs:label "Remove atom:stringType in favour of owl:onDatatype so generic tools can understand and validate atom literals."
- ] , [
- rdfs:label "Improve atom documentation."
- ]
- ]
- ] , [
- doap:revision "1.2" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Fix implicit conversions in forge.h that are invalid in C++11."
- ] , [
- rdfs:label "Fix lv2_atom_object_next() on 32-bit platforms."
- ] , [
- rdfs:label "Add lv2_atom_object_body_get()."
- ] , [
- rdfs:label "Fix outdated documentation in forge.h."
- ] , [
- rdfs:label "Use consistent label style."
- ] , [
- rdfs:label "Add LV2_ATOM_CONTENTS_CONST and LV2_ATOM_BODY_CONST."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl b/lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl
deleted file mode 100644
index 5e2ec76..0000000
--- a/lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl
+++ /dev/null
@@ -1,99 +0,0 @@
-@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: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: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> """ .
diff --git a/lv2/lv2plug.in/ns/ext/buf-size/lv2-buf-size.doap.ttl b/lv2/lv2plug.in/ns/ext/buf-size/lv2-buf-size.doap.ttl
deleted file mode 100644
index a57ebbd..0000000
--- a/lv2/lv2plug.in/ns/ext/buf-size/lv2-buf-size.doap.ttl
+++ /dev/null
@@ -1,33 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/buf-size>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:name "LV2 Buf Size Extension" ;
- doap:shortdesc "Access to, and restrictions on, buffer sizes." ;
- doap:created "2012-08-07" ;
- doap:developer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "1.2" ;
- doap:created "2012-12-21" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Fix typo in bufsz:sequenceSize label."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/data-access/data-access.ttl b/lv2/lv2plug.in/ns/ext/data-access/data-access.ttl
deleted file mode 100644
index 654b714..0000000
--- a/lv2/lv2plug.in/ns/ext/data-access/data-access.ttl
+++ /dev/null
@@ -1,23 +0,0 @@
-@prefix da: <http://lv2plug.in/ns/ext/data-access#> .
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/data-access>
- a lv2:Feature ;
- rdfs:seeAlso <data-access.h> ,
- <lv2-data-access.doap.ttl> ;
- lv2:documentation """
-<p>This extension defines a feature, LV2_Extension_Data_Feature, which provides
-access to LV2_Descriptor::extension_data() for plugin UIs or other potentially
-remote users of a plugin.</p>
-
-<p>Note that the use of this extension by UIs violates the important principle
-of UI/plugin separation, and is potentially a source of many problems.
-Accordingly, <strong>use of this extension is highly discouraged</strong>, and
-plugins should not expect hosts to support it, since it is often impossible to
-do so.</p>
-
-<p>To support this feature the host must pass an LV2_Feature struct to the
-instantiate method with URI LV2_DATA_ACCESS_URI and data pointed to an instance
-of LV2_Extension_Data_Feature.</p>
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.ttl b/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.ttl
deleted file mode 100644
index 3806374..0000000
--- a/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.ttl
+++ /dev/null
@@ -1,90 +0,0 @@
-@prefix dman: <http://lv2plug.in/ns/ext/dynmanifest#> .
-@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 xsd: <http://www.w3.org/2001/XMLSchema#> .
-
-<http://lv2plug.in/ns/ext/dynmanifest>
- a lv2:Specification ;
- rdfs:seeAlso <dynmanifest.h> ;
- lv2:documentation """
-<p>The LV2 API, on its own, cannot be used to write plugin libraries where data
-is dynamically generated at runtime (e.g. API wrappers), since LV2 requires
-needed information to be provided in one or more static data (RDF) files. This
-API addresses this limitation by extending the LV2 API.</p>
-
-<p>To detect that a plugin library implements a dynamic manifest generator,
-the host checks its static manifest for a description like:</p>
-
-<pre class="turtle-code">
-&lt;http://example.org/my-dynamic-manifest&gt;
- a dman:DynManifest ;
- lv2:binary &lt;mydynmanifest.so&gt; .
-</pre>
-
-<p>To load the data, the host loads the library
-(e.g. <code>mydynmanifest.so</code>) as usual and fetches the dynamic Turtle
-data from it using this API.</p>
-
-<p>The host is allowed to request regeneration of the dynamic manifest multiple
-times, and the plugin library is expected to provide updated data if/when
-possible. All data and references provided via this API before the last
-regeneration of the dynamic manifest is to be considered invalid by the host,
-including plugin descriptors whose URIs were discovered using this API.</p>
-
-<h3>Accessing Data</h3>
-
-<p>Whenever a host wants to access data using this API, it could:</p>
-
-<ol>
-<li>Call lv2_dyn_manifest_open().</li>
-<li>Create a FILE for functions to write data to (e.g. using tmpfile()).</li>
-<li>Get a <q>list</q> of exposed subject URIs using
- lv2_dyn_manifest_get_subjects().</li>
-<li>Call lv2_dyn_manifest_get_data() for each URI of interest to
- get the data related to that URI (which can be written to any FILE).</li>
-<li>Call lv2_dyn_manifest_close().</li>
-<li>Parse the content of the FILE(s).</li>
-<li>Free/delete/unlink the FILE(s).</li>
-</ol>
-
-<p>Each call to the above mentioned dynamic manifest functions MUST write a
-complete, valid Turtle document (including all needed prefix definitions) to
-the output FILE.</p>
-
-<p>Each call to lv2_dyn_manifest_open() causes the (re)generation of the
-dynamic manifest data, and invalidates all data fetched before the call.</p>
-
-<p>In case the plugin library uses this same API to access other dynamic
-manifests, it MUST implement some mechanism to avoid potentially endless loops
-(such as A loads B, B loads A, etc.) and, in case such a loop is detected, the
-operation MUST fail. For this purpose, use of a static boolean flag is
-suggested.</p>
-
-<h3>Threading Rules</h3>
-
-<p>All of the functions defined by this specification belong to the Discovery
-class.</p>
-""" .
-
-dman:DynManifest
- a rdfs:Class ;
- rdfs:label "Dynamic Manifest" ;
- rdfs:subClassOf [
- a owl:Restriction ;
- owl:onProperty lv2:binary ;
- owl:minCardinality 1 ;
- rdfs:comment """
-A DynManifest MUST have at least 1 lv2:binary, which MUST implement all the
-functions defined in dynmanifest.h.
-"""
- ] ;
- rdfs:comment """
-The class which represents a dynamic manifest generator.
-
-There MUST NOT be any instances of dman:DynManifest in the generated manifest.
-
-All relative URIs in the generated data MUST be relative to the base path
-that would be used to parse a normal LV2 manifest (the bundle path).
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/dynmanifest/lv2-dynmanifest.doap.ttl b/lv2/lv2plug.in/ns/ext/dynmanifest/lv2-dynmanifest.doap.ttl
deleted file mode 100644
index 0f24f55..0000000
--- a/lv2/lv2plug.in/ns/ext/dynmanifest/lv2-dynmanifest.doap.ttl
+++ /dev/null
@@ -1,54 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/dynmanifest>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:license <http://opensource.org/licenses/isc> ;
- doap:name "LV2 Dynamic Manifest" ;
- doap:homepage <http://naspro.atheme.org> ;
- doap:created "2009-06-13" ;
- doap:shortdesc "Support for dynamic data generation." ;
- doap:programming-language "C" ;
- doap:developer <http://lv2plug.in/ns/meta#daste> ;
- doap:release [
- doap:revision "1.6" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Use consistent label style."
- ]
- ]
- ] , [
- doap:revision "1.4" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Merge with unified LV2 package."
- ]
- ]
- ] , [
- doap:revision "1.2" ;
- doap:created "2011-11-21" ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Improve documentation."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2010-04-10" ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/event/event.ttl b/lv2/lv2plug.in/ns/ext/event/event.ttl
deleted file mode 100644
index 66776f8..0000000
--- a/lv2/lv2plug.in/ns/ext/event/event.ttl
+++ /dev/null
@@ -1,162 +0,0 @@
-@prefix ev: <http://lv2plug.in/ns/ext/event#> .
-@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#> .
-
-<http://lv2plug.in/ns/ext/event>
- a owl:Ontology ;
- owl:deprecated true ;
- rdfs:seeAlso <event.h> ,
- <event-helpers.h> ,
- <lv2-event.doap.ttl> ;
- lv2:documentation """
-<p>This extension defines a generic time-stamped event port type, which can be
-used to create plugins that read and write real-time events, such as MIDI,
-OSC, or any other type of event payload. The type(s) of event supported by
-a port is defined in the data file for a plugin, for example:</p>
-<pre class="turtle-code">
-&lt;http://example.org/some-plugin&gt;
- lv2:port [
- a ev:EventPort, lv2:InputPort ;
- lv2:index 0 ;
- ev:supportsEvent &lt;http://lv2plug.in/ns/ext/midi#MidiEvent&gt; ;
- lv2:symbol "midi_input" ;
- lv2:name "MIDI input" ;
- ] .
-</pre>
-""" .
-
-ev:EventPort
- a rdfs:Class ;
- rdfs:label "Event Port" ;
- rdfs:subClassOf lv2:Port ;
- rdfs:comment """
-Ports of this type will be connected to a struct of type LV2_Event_Buffer,
-defined in event.h. These ports contain a sequence of generic events
-(possibly several types mixed in a single stream), the specific types of
-which are defined by some URI in another LV2 extension.
-""" .
-
-ev:Event
- a rdfs:Class ;
- rdfs:label "Event" ;
- rdfs:comment """
-A single generic time-stamped event.
-
-An ev:EventPort contains an LV2_Event_Buffer which contains a sequence
-of these events. The binary format of LV2 events is defined by the
-LV2_Event struct in event.h.
-
-Specific event types (e.g. MIDI, OSC) are defined by extensions, and should
-be rdfs:subClassOf this class.
-""" .
-
-ev:TimeStamp
- a rdfs:Class ;
- rdfs:label "Event Time Stamp" ;
- rdfs:comment """
-The time stamp of an Event.
-
-This defines the meaning of the 'frames' and 'subframes' fields of an
-LV2_Event (both unsigned 32-bit integers).
-""" .
-
-ev:FrameStamp
- a rdfs:Class ;
- rdfs:subClassOf ev:TimeStamp ;
- rdfs:label "Audio Frame Time Stamp" ;
- rdfs:comment """
-The default time stamp unit for an LV2 event: the frames field represents
-audio frames (in the sample rate passed to intantiate), and the subframes
-field is 1/UINT32_MAX of a frame.
-""" .
-
-ev:generic
- a lv2:PortProperty ;
- rdfs:label "generic event port" ;
- rdfs:comment """
-Indicates that this port does something meaningful for any event type
-(e.g. event mixers, delays, serialisers, etc). If this property is set, hosts
-should consider the port suitable for any type of event. Otherwise, hosts
-should consider the port 'appropriate' only for the specific event types
-listed with :supportsEvent. Note that plugins must gracefully handle unknown
-event types whether or not this property is present.
-""" .
-
-ev:supportsEvent
- a rdf:Property ;
- rdfs:domain ev:EventPort ;
- rdfs:range rdfs:Class ;
- rdfs:label "supports event type" ;
- rdfs:comment """
-Indicates that this port supports or "understands" a certain event type.
-For input ports, this means the plugin understands and does something useful
-with events of this type. For output ports, this means the plugin may generate
-events of this type. If the plugin never actually generates events of this type,
-but might pass them through from an input, this property should not be set (use
-ev:inheritsEvent for that).
-Plugins with event input ports must always gracefully handle any type of event,
-even if it does not 'support' it. This property should always be set for
-event types the plugin understands/generates so hosts can discover plugins
-appropriate for a given scenario (e.g. plugins with a MIDI input).
-Hosts are not expected to consider event ports suitable for some type of
-event if the relevant :supportsEvent property is not set, unless the
-ev:generic property for that port is also set.
-""" .
-
-ev:inheritsEvent
- a rdf:Property ;
- rdfs:domain ev:EventPort ,
- lv2:OutputPort ;
- rdfs:range lv2:Port ;
- rdfs:label "inherits event type" ;
- rdfs:comment """
-Indicates that this output port might pass through events that arrived at some
-other input port (or generate an event of the same type as events arriving at
-that input). The host must always check the stamp type of all outputs when
-connecting an input, but this property should be set whenever it applies.
-""" .
-
-ev:supportsTimeStamp
- a rdf:Property ;
- rdfs:domain ev:EventPort ,
- lv2:InputPort ;
- rdfs:range rdfs:Class ;
- rdfs:label "supports time stamp type" ;
- rdfs:comment """
-Indicates that this port supports or "understands" a certain time stamp type.
-Meaningful only for input ports, the host must never connect a port to an
-event buffer with a time stamp type that isn't supported by the port.
-""" .
-
-ev:generatesTimeStamp
- a rdf:Property ;
- rdfs:domain ev:EventPort ,
- lv2:OutputPort ;
- rdfs:range rdfs:Class ;
- rdfs:label "generates time stamp type" ;
- rdfs:comment """
-Indicates that this port may output a certain time stamp type, regardless of
-the time stamp type of any input ports. If the port outputs stamps based on
-what type inputs are connected to, this property should not be set (use the
-ev:inheritsTimeStamp property for that). Hosts MUST check the time_stamp value
-of any output port buffers after a call to connect_port on ANY event input
-port on the plugin. If the plugin changes the stamp_type field of an output
-event buffer during a call to run(), the plugin must call the
-stamp_type_changed function provided by the host in the LV2_Event_Feature
-struct, if it is non-NULL.
-""" .
-
-ev:inheritsTimeStamp
- a rdf:Property ;
- rdfs:domain ev:EventPort ,
- lv2:OutputPort ;
- rdfs:range lv2:Port ;
- rdfs:label "inherits time stamp type" ;
- rdfs:comment """
-Indicates that this port follows the time stamp type of an input port.
-This property is not necessary, but it should be set for outputs that
-base their output type on an input port so the host can make more sense
-of the plugin and provide a more sensible interface.
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/event/lv2-event.doap.ttl b/lv2/lv2plug.in/ns/ext/event/lv2-event.doap.ttl
deleted file mode 100644
index 64dc567..0000000
--- a/lv2/lv2plug.in/ns/ext/event/lv2-event.doap.ttl
+++ /dev/null
@@ -1,89 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/event>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:license <http://opensource.org/licenses/isc> ;
- doap:name "LV2 Event" ;
- doap:shortdesc "A port-based real-time generic event interface." ;
- doap:created "2008-00-00" ;
- doap:developer <http://drobilla.net/drobilla#me> ,
- <http://lv2plug.in/ns/meta#larsl> ;
- doap:release [
- doap:revision "1.10" ;
- doap:created "2013-01-13" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Fix incorrect return type in lv2_event_get()."
- ]
- ]
- ] , [
- doap:revision "1.8" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Make event iterator gracefully handle optional ports."
- ] , [
- rdfs:label "Remove asserts from event-helper.h."
- ] , [
- rdfs:label "Use more precise domain and range for EventPort properties."
- ] , [
- rdfs:label "Use consistent label style."
- ]
- ]
- ] , [
- doap:revision "1.6" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Fix bug in lv2_event_reserve()."
- ] , [
- rdfs:label "Fix incorrect ranges of some properties."
- ] , [
- rdfs:label "Merge with unified LV2 package."
- ]
- ]
- ] , [
- doap:revision "1.4" ;
- doap:created "2011-11-21" ;
- doap:file-release <http://lv2plug.in/spec/lv2-event-1.4.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Update packaging."
- ]
- ]
- ] , [
- doap:revision "1.2" ;
- doap:created "2011-05-26" ;
- doap:file-release <http://lv2plug.in/spec/lv2-event-1.2.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Add build system (for installation)."
- ] , [
- rdfs:label "Convert documentation to HTML and use lv2:documentation."
- ] , [
- rdfs:label "Use lv2:Specification to be discovered as an extension."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2010-11-24" ;
- doap:file-release <http://lv2plug.in/spec/lv2-event-1.0.tar.gz> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/instance-access/instance-access.ttl b/lv2/lv2plug.in/ns/ext/instance-access/instance-access.ttl
deleted file mode 100644
index 5656345..0000000
--- a/lv2/lv2plug.in/ns/ext/instance-access/instance-access.ttl
+++ /dev/null
@@ -1,22 +0,0 @@
-@prefix ia: <http://lv2plug.in/ns/ext/instance-access#> .
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/instance-access>
- a lv2:Feature ;
- rdfs:seeAlso <instance-access.h> ,
- <lv2-instance-access.doap.ttl> ;
- lv2:documentation """
-<p>This extension defines a feature which allows plugin UIs to get a direct
-handle to an LV2 plugin instance (LV2_Handle), if possible.</p>
-
-<p>Note that the use of this extension by UIs violates the important principle
-of UI/plugin separation, and is potentially a source of many problems.
-Accordingly, <strong>use of this extension is highly discouraged</strong>, and
-plugins should not expect hosts to support it, since it is often impossible to
-do so.</p>
-
-<p>To support this feature the host must pass an LV2_Feature struct to the UI
-instantiate method with URI LV2_INSTANCE_ACCESS_URI and data pointed directly
-to the LV2_Handle of the plugin instance.</p>
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/log/log.ttl b/lv2/lv2plug.in/ns/ext/log/log.ttl
deleted file mode 100644
index 26e18cc..0000000
--- a/lv2/lv2plug.in/ns/ext/log/log.ttl
+++ /dev/null
@@ -1,63 +0,0 @@
-@prefix log: <http://lv2plug.in/ns/ext/log#> .
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@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/log>
- a lv2:Specification ;
- rdfs:seeAlso <log.h> ,
- <lv2-log.doap.ttl> ;
- lv2:documentation """
-<p>This extension defines a feature, log:log, which allows plugins to print log
-messages with an API much like the standard C printf functions. This allows,
-for example, plugin logs to be nicely presented to the user in a graphical user
-interface.</p>
-
-<p>Different log levels (e.g. <q>error</q> or <q>information</q>) are defined
-by URI and passed as an LV2_URID. This document defines the typical levels
-which should be sufficient, but implementations may define and use additional
-levels to suit their needs.</p>
-""" .
-
-log:Entry
- a rdfs:Class ;
- lv2:documentation """
-<p>A log entry. Subclasses of this class can be passed to LV2_Log_Log methods
-to describe the nature of the log message.</p>""" .
-
-log:Error
- a rdfs:Class ;
- rdfs:subClassOf log:Entry ;
- rdfs:comment "An error" .
-
-log:Note
- a rdfs:Class ;
- rdfs:subClassOf log:Entry ;
- rdfs:comment "An informative message" .
-
-log:Warning
- a rdfs:Class ;
- rdfs:subClassOf log:Entry ;
- rdfs:comment "A warning" .
-
-log:Trace
- a rdfs:Class ;
- rdfs:subClassOf log:Entry ;
- lv2:documentation """
-<p>A debugging trace. These entries should not be displayed during normal
-operation, but the host may implement an option to display them for debugging
-purposes.</p>
-
-<p>This entry type is special in that it may be written to in a real-time
-thread. It is assumed that if debug tracing is enabled, real-time
-considerations are not a concern.</p>
-""" .
-
-log:log
- a lv2:Feature ;
- lv2:documentation """
-<p>A feature which plugins may use to log messages. To support this feature,
-the host must pass an LV2_Feature to LV2_Descriptor::instantiate() with URI
-LV2_LOG__log and data pointed to an instance of LV2_Log_Log.</p>
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/log/lv2-log.doap.ttl b/lv2/lv2plug.in/ns/ext/log/lv2-log.doap.ttl
deleted file mode 100644
index 9de67dd..0000000
--- a/lv2/lv2plug.in/ns/ext/log/lv2-log.doap.ttl
+++ /dev/null
@@ -1,42 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/log>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:name "LV2 Log" ;
- doap:shortdesc "A feature for writing log messages." ;
- doap:created "2012-01-12" ;
- doap:developer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "2.1" ;
- doap:created "2013-12-15" ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Add missing include <string.h> to logger.h for memset."
- ]
- ]
- ] , [
- doap:revision "2.0" ;
- doap:created "2013-01-08" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Add logger convenience API."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/morph/lv2-morph.doap.ttl b/lv2/lv2plug.in/ns/ext/morph/lv2-morph.doap.ttl
deleted file mode 100644
index 73abdc2..0000000
--- a/lv2/lv2plug.in/ns/ext/morph/lv2-morph.doap.ttl
+++ /dev/null
@@ -1,23 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/morph>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:name "LV2 Morph Extension" ;
- doap:shortdesc "Ports that can dynamically change type." ;
- doap:created "2012-05-22" ;
- doap:developer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "1.0" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/morph/morph.ttl b/lv2/lv2plug.in/ns/ext/morph/morph.ttl
deleted file mode 100644
index 9457089..0000000
--- a/lv2/lv2plug.in/ns/ext/morph/morph.ttl
+++ /dev/null
@@ -1,86 +0,0 @@
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix morph: <http://lv2plug.in/ns/ext/morph#> .
-@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/morph>
- a owl:Ontology ;
- rdfs:seeAlso <morph.h> ,
- <lv2-morph.doap.ttl> ,
- <../../meta/meta.ttl> ;
- lv2:documentation """
-<p>This extension defines two port types: morph:MorphPort, which has a
-host-configurable type, and morph:AutoMorphPort, which may automatically change
-type when a MorphPort's type is changed. These ports always have a default
-type and work normally work in hosts that are unaware of this extension. Thus,
-this extension provides a backwards compatibility mechanism which allows
-plugins to use new port types but gracefully fall back to a default type in
-hosts that do not support them.</p>
-
-<p>This extension only defines port types and properties for describing morph
-ports. The actual run-time switching is done via the opts:interface API.</p>
-""" .
-
-morph:MorphPort
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Port ;
- rdfs:label "Morph Port" ;
- lv2:documentation """
-<p>Ports of this type MUST have another type which defines the default buffer
-format (e.g. lv2:ControlPort) but can be dynamically changed to a different
-type in hosts that support opts:interface.</p>
-
-<p>The host may change the type of a MorphPort by setting its morph:currentType
-with LV2_Options_Interface::set(). If the plugin has any morph:AutoMorphPort
-ports, the host MUST check their types after changing any port type since they
-may have changed.</p> """ .
-
-morph:AutoMorphPort
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Port ;
- rdfs:label "Auto Morph Port" ;
- lv2:documentation """
-<p>Ports of this type MUST have another type which defines the default buffer
-format (e.g. lv2:ControlPort) but may dynamically change types based on the
-configured types of any morph:MorphPort ports on the same plugin instance.</p>
-
-<p>The type of a port may only change in response to a host call to
-LV2_Options_Interface::set(). Whenever any port type on the instance changes,
-the host MUST check the type of all morph:AutoMorphPort ports with
-LV2_Options_Interface::get() before calling run() again, since they may have
-changed. If the type of any port is zero, it means the current configuration
-is invalid and the plugin may not be run (unless that port is
-lv2:connectionOptional and connected to NULL).</p>
-
-<p>This is mainly useful for outputs whose type depends on the type of
-corresponding inputs.</p>
-""" .
-
-morph:supportsType
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:domain morph:MorphPort ;
- rdfs:label "supports type" ;
- lv2:documentation """
-<p>Indicates that a port supports being switched to a certain type. A
-MorphPort MUST list each type it supports being switched to in the plugin data
-using this property.</p>
-""" .
-
-morph:currentType
- a rdf:Property ,
- opts:Option ,
- owl:ObjectProperty ;
- rdfs:domain morph:MorphPort ;
- rdfs:label "current type" ;
- lv2:documentation """
-<p>The currently active type of the port. This is for dynamic use as an option
-and SHOULD NOT be listed in the static plugin data.</p>
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/options/lv2-options.doap.ttl b/lv2/lv2plug.in/ns/ext/options/lv2-options.doap.ttl
deleted file mode 100644
index 6b99ef3..0000000
--- a/lv2/lv2plug.in/ns/ext/options/lv2-options.doap.ttl
+++ /dev/null
@@ -1,33 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/options>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:name "LV2 Options" ;
- doap:shortdesc "Instantiation time options." ;
- doap:created "2012-08-20" ;
- doap:developer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "1.2" ;
- doap:created "2013-01-10" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Set the range of opts:requiredOption and opts:supportedOption to opts:Option."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/options/options.ttl b/lv2/lv2plug.in/ns/ext/options/options.ttl
deleted file mode 100644
index e4aea32..0000000
--- a/lv2/lv2plug.in/ns/ext/options/options.ttl
+++ /dev/null
@@ -1,105 +0,0 @@
-@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/options>
- a owl:Ontology ;
- rdfs:seeAlso <options.h> ,
- <../../meta/meta.ttl> ,
- <lv2-options.doap.ttl> ;
- lv2:documentation """
-
-<p>This extension defines a facility for <q>options</q>, which are dynamic
-properties that may be changed at run time.</p>
-
-<p>There are two facilities for passing options to an instance: opts:options
-allows passing options at instantiation time, and the opts:interface interface
-allows options to be dynamically set and retrieved after instantiation.</p>
-
-<p>Note that this extension is only for allowing hosts to configure plugins,
-and is not a <q>live</q> control mechanism. For real-time control, use
-event-based control via an atom:AtomPort with an atom:Sequence buffer.</p>
-
-<p>Instances may indicate they <q>require</q> an option with the
-opts:requiredOption property, or that they optionally <q>support</q> an option
-with the opts:supportedOption property.</p>
-""" .
-
-opts:Option
- a rdfs:Class ;
- rdfs:label "Option" ;
- rdfs:subClassOf rdf:Property ;
- lv2:documentation """
-<p>A property intended to be used as a static option for an instance.</p>
-
-<p>It is not required for a property to explicitly be an Option in order to be
-used as such. However, properties which are primarily intended for use as
-options, or are at least particularly useful as options, should be explicitly
-given this type for documentation purposes, and to assist hosts in discovering
-option definitions.</p>
-""" .
-
-opts:interface
- a lv2:ExtensionData ;
- lv2:documentation """
-<p>An interface (LV2_Options_Interface) for dynamically setting and getting
-options. Note this is intended for use by the host for configuring plugins
-only, and and is <em>not</em> a <q>live</q> plugin control mechanism.</p>
-
-<p>The plugin data file should describe this like so:</p>
-<pre class="turtle-code">
-@prefix opts: &lt;http://lv2plug.in/ns/ext/options#&gt; .
-
-&lt;plugin&gt;
- a lv2:Plugin ;
- lv2:extensionData opts:interface .
-</pre>
-""" .
-
-opts:options
- a lv2:Feature ;
- rdfs:label "options" ;
- lv2:documentation """
-<p>The feature used to provide options to an instance.</p>
-
-<p>To implement this feature, hosts MUST pass an LV2_Feature to the appropriate
-instantiate method with this URI and data pointed to an array of
-LV2_Options_Option terminated by an element with both key and value set to
-zero. The instance should cast this data pointer to <code>const
-LV2_Options_Option*</code> and scan the array for any options of interest. The
-instance MUST NOT modify the options array in any way.</p>
-
-<p>Note that requiring this feature may reduce the number of compatible hosts.
-Unless some options are strictly required by the instance, this feature SHOULD
-be listed as a lv2:optionalFeature.</p>
-""" .
-
-opts:requiredOption
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:range opts:Option ;
- rdfs:label "required option" ;
- lv2:documentation """
-<p>An option required by the instance to function at all. The host MUST pass a
-value for the specified option via opts:options in order to create an
-instance.</p>
-
-<p>Note that use of this property may reduce the number of compatible hosts.
-Wherever possible, it is better to list options with opts:supportedOption and
-fall back to a reasonable default value if it is not provided.</p>
-""" .
-
-opts:supportedOption
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:range opts:Option ;
- rdfs:label "supported option" ;
- lv2:documentation """
-<p>An option supported or <q>understood</q> by the instance. The host SHOULD
-provide a value for the specified option if one is known, or provide the user
-an opportunity to specify one if one is Indicates that the instance host MUST
-pass a value for the specified option in order to instantiate the instance.</p>
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/parameters/lv2-parameters.doap.ttl b/lv2/lv2plug.in/ns/ext/parameters/lv2-parameters.doap.ttl
deleted file mode 100644
index 58c61d2..0000000
--- a/lv2/lv2plug.in/ns/ext/parameters/lv2-parameters.doap.ttl
+++ /dev/null
@@ -1,38 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/parameters>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:name "LV2 Parameters" ;
- doap:release [
- doap:revision "1.2" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Use consistent label style."
- ] , [
- rdfs:label "Add param:sampleRate."
- ] , [
- rdfs:label "Add parameters.h of URI defines for convenience."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] ;
- doap:created "2009-00-00" ;
- doap:shortdesc "Common parameters for audio processing." ;
- doap:maintainer <http://drobilla.net/drobilla#me> ;
- doap:developer <http://lv2plug.in/ns/meta#larsl> .
diff --git a/lv2/lv2plug.in/ns/ext/patch/lv2-patch.doap.ttl b/lv2/lv2plug.in/ns/ext/patch/lv2-patch.doap.ttl
deleted file mode 100644
index a2f3e79..0000000
--- a/lv2/lv2plug.in/ns/ext/patch/lv2-patch.doap.ttl
+++ /dev/null
@@ -1,36 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/patch>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:created "2012-02-09" ;
- doap:license <http://opensource.org/licenses/isc> ;
- doap:developer <http://drobilla.net/drobilla#me> ;
- doap:name "LV2 Patch" ;
- doap:shortdesc "Messages for accessing and manipulating properties." ;
- doap:release [
- doap:revision "2.0" ;
- doap:created "2013-01-10" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Make patch:Set a compact message for setting one property."
- ] , [
- rdfs:label "Add patch:readable and patch:writable for describing available properties."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/patch/patch.h b/lv2/lv2plug.in/ns/ext/patch/patch.h
deleted file mode 100644
index 1a7a893..0000000
--- a/lv2/lv2plug.in/ns/ext/patch/patch.h
+++ /dev/null
@@ -1,55 +0,0 @@
-/*
- Copyright 2012 David Robillard <http://drobilla.net>
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-/**
- @file patch.h C header for the LV2 Patch extension
- <http://lv2plug.in/ns/ext/patch>.
-
- The patch extension is purely data, this header merely defines URIs
- for convenience.
-*/
-
-#ifndef LV2_PATCH_H
-#define LV2_PATCH_H
-
-#define LV2_PATCH_URI "http://lv2plug.in/ns/ext/patch"
-#define LV2_PATCH_PREFIX LV2_PATCH_URI "#"
-
-#define LV2_PATCH__Ack LV2_PATCH_PREFIX "Ack"
-#define LV2_PATCH__Delete LV2_PATCH_PREFIX "Delete"
-#define LV2_PATCH__Error LV2_PATCH_PREFIX "Error"
-#define LV2_PATCH__Get LV2_PATCH_PREFIX "Get"
-#define LV2_PATCH__Message LV2_PATCH_PREFIX "Message"
-#define LV2_PATCH__Move LV2_PATCH_PREFIX "Move"
-#define LV2_PATCH__Patch LV2_PATCH_PREFIX "Patch"
-#define LV2_PATCH__Post LV2_PATCH_PREFIX "Post"
-#define LV2_PATCH__Put LV2_PATCH_PREFIX "Put"
-#define LV2_PATCH__Request LV2_PATCH_PREFIX "Request"
-#define LV2_PATCH__Response LV2_PATCH_PREFIX "Response"
-#define LV2_PATCH__Set LV2_PATCH_PREFIX "Set"
-#define LV2_PATCH__add LV2_PATCH_PREFIX "add"
-#define LV2_PATCH__body LV2_PATCH_PREFIX "body"
-#define LV2_PATCH__destination LV2_PATCH_PREFIX "destination"
-#define LV2_PATCH__property LV2_PATCH_PREFIX "property"
-#define LV2_PATCH__readable LV2_PATCH_PREFIX "readable"
-#define LV2_PATCH__remove LV2_PATCH_PREFIX "remove"
-#define LV2_PATCH__request LV2_PATCH_PREFIX "request"
-#define LV2_PATCH__subject LV2_PATCH_PREFIX "subject"
-#define LV2_PATCH__value LV2_PATCH_PREFIX "value"
-#define LV2_PATCH__wildcard LV2_PATCH_PREFIX "wildcard"
-#define LV2_PATCH__writable LV2_PATCH_PREFIX "writable"
-
-#endif /* LV2_PATCH_H */
diff --git a/lv2/lv2plug.in/ns/ext/patch/patch.ttl b/lv2/lv2plug.in/ns/ext/patch/patch.ttl
deleted file mode 100644
index ae1a0e3..0000000
--- a/lv2/lv2plug.in/ns/ext/patch/patch.ttl
+++ /dev/null
@@ -1,367 +0,0 @@
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@prefix patch: <http://lv2plug.in/ns/ext/patch#> .
-@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/patch>
- a owl:Ontology ;
- rdfs:seeAlso <patch.h> ,
- <lv2-patch.doap.ttl> ;
- lv2:documentation """
-<p>This vocabulary defines messages which can be used to access and manipulate
-properties. It is designed to provide a dynamic control interface for LV2
-plugins, but is useful in many contexts.</p>
-
-<p>The main feature of this design is that the messages themselves are
-described in the same format as the data they work with. In particular,
-messages can be serialised as a binary <a
-href="../atom/atom.html#Object">Object</a> or in Turtle (or any other RDF
-serialisation).</p>
-
-<p>The idea behind using a property-based interface for control is to prevent
-an an explosion of message types. Instead of a custom message for each action,
-control is achieved via manipulating properties (which are likely already
-defined for other reasons). Note, however, that this is purely conceptual;
-there is no requirement that the receiver actually implement a store of
-resources with properties.</p>
-
-<p>For example, consider an object that can blink. Rather than define a
-specific interface to control this (e.g. <code>obj.start_blinking();
-obj.stop_blinking()</code>), set a <q>blinking</q> property to true or false
-(e.g. <code>obj.set(blinking, true)</code>) to achieve the desired behaviour.
-One benefit of this approach is that a persistent state model is available
-<q>for free</q>: simply serialise the <q>blinking</q> property.</p>
-
-<p>This specification is strictly metadata and does not define any binary
-mechanism, though it can be completely expressed by standard types in the <a
-href="../atom/atom.html">LV2 Atom</a> extension. Thus, hosts can be expected
-to be capable of transmitting it between plugins, or between a plugin and its
-UI, making it a good choice for advanced plugin control.</p>
-""" .
-
-patch:Ack
- a rdfs:Class ;
- rdfs:subClassOf patch:Response ;
- rdfs:label "Ack" ;
- lv2:documentation """
-<p>An acknowledgement that a request has been successfully processed. This is
-returned as a reply when a specific reply type is not necessary or
-appropriate.</p>
-""" .
-
-patch:Delete
- a rdfs:Class ;
- rdfs:subClassOf patch:Request ;
- rdfs:label "Delete" ;
- lv2:documentation """
-<p>Request the subject(s) be deleted.</p>
-""" .
-
-patch:Error
- a rdfs:Class ;
- rdfs:subClassOf patch:Response ;
- rdfs:label "Error" ;
- lv2:documentation """
-<p>A response indicating an error processing a request.</p>
-""" .
-
-patch:Get
- a rdfs:Class ;
- rdfs:subClassOf patch:Request ;
- rdfs:label "Get" ;
- lv2:documentation """
-<p>Request a description of the subject.</p>
-
-<p>The detail of the response is not specified, it may be a flat description of
-all the properties of the subject, or a more expressive description with
-several subjects. A good choice is a <q><a
-href="http://www.w3.org/Submission/CBD/">concise bounded description</a></q>,
-i.e. a description which recursively includes all properties with blank node
-values.</p>
-
-<p>The response should have the same patch:subject property as the request, and
-a patch:body that is a description of that subject. For example:</p>
-<pre class="turtle-code">
-&lt;get-request&gt;
- a patch:Get ;
- patch:subject &lt;something&gt; .
-</pre>
-
-<p>Could result in:</p>
-<pre class="turtle-code">
-[]
- a patch:Response ;
- patch:request &lt;get-request&gt; ;
- patch:subject &lt;something&gt; ;
- patch:body [
- eg:name "Something" ;
- eg:ratio 1.6180339887 ;
- ] .
-</pre>
-
-<p>Note the use of blank nodes is not required; the value of patch:body may be
-the actual resource node. Depending on the transport and syntax used this may
-be preferable. However, the patch:subject property is required regardless. For
-example, the same response could be written:</p>
-
-<pre class="turtle-code">
-&lt;something&gt;
- eg:name "Something" ;
- eg:ratio 1.6180339887 .
-
-[]
- a patch:Response ;
- patch:request &lt;get-request&gt; ;
- patch:subject &lt;something&gt; ;
- patch:body &lt;something&gt; .
-</pre>
-""" .
-
-patch:Insert
- a rdfs:Class ;
- rdfs:subClassOf patch:Request ;
- rdfs:label "Insert" ;
- rdfs:subClassOf [
- a owl:Restriction ;
- owl:cardinality 1 ;
- owl:onProperty patch:subject
- ] ;
- lv2:documentation """
-<p>Insert the patch:body at patch:subject. If the subject does not exist, it is
-created. If the subject does already exist, it is added to. This request only
-adds properties, it never removes them. The user must take care that multiple
-values are not set for properties which should only have one value.</p>
-""" .
-
-patch:Message
- a rdfs:Class ;
- rdfs:label "Message" .
-
-patch:Move
- a rdfs:Class ;
- rdfs:subClassOf patch:Request ;
- rdfs:label "Move" ;
- rdfs:subClassOf [
- a owl:Restriction ;
- owl:cardinality 1 ;
- owl:onProperty patch:subject
- ] , [
- a owl:Restriction ;
- owl:cardinality 1 ;
- owl:onProperty patch:destination
- ] ;
- lv2:documentation """
-<p>Move the patch:subject to patch:destination. After this, patch:destination has
-the description patch:subject had prior to this request's execution, and
-patch:subject does not exist any more.It is an error if the subject does not
-exist or the destination already exists.</p>
-""" .
-
-patch:Patch
- a rdfs:Class ;
- rdfs:subClassOf patch:Request ,
- [
- a owl:Restriction ;
- owl:minCardinality 1 ;
- owl:onProperty patch:subject
- ] ;
- lv2:documentation """
-<p>A method for modifying the properties of an object.</p>
-
-<p>This method always has at least one patch:subject, and exactly one patch:add
-and patch:remove property. The value of patch:add and patch:remove are nodes
-which have the properties to add or remove from the subject(s), respectively.
-The special value patch:wildcard may be used as the value of a remove property
-to remove all properties with the given predicate. For example:</p>
-
-<pre class="turtle-code">
-[]
- a patch:Patch ;
- patch:subject &lt;something&gt; ;
- patch:add [
- eg:name "New name" ;
- eg:age 42 ;
- ] ;
- patch:remove [
- eg:name "Old name" ;
- eg:age patch:wildcard ; # Remove all old eg:age properties
- ] .
-</pre>
-""" .
-
-patch:Put
- a rdfs:Class ;
- rdfs:subClassOf patch:Request ;
- rdfs:label "Put" ;
- rdfs:subClassOf [
- a owl:Restriction ;
- owl:cardinality 1 ;
- owl:onProperty patch:subject
- ] ;
- lv2:documentation """
-<p>Put the patch:body as the patch:subject. If the subject does not already exist,
-it is created. If the subject does already exist, the patch:body is considered
-an updated version of it, and the previous version is replaced.</p>
-""" .
-
-patch:Request
- a rdfs:Class ;
- rdfs:label "Request" ;
- rdfs:subClassOf patch:Message ;
- lv2:documentation """
-<p>A request. A request may have a patch:subject property, which indicates which
-resource the request applies to. The subject may be omitted in contexts where
-it is implicit (e.g. the recipient is the subject).</p>
-""" .
-
-patch:Response
- a rdfs:Class ;
- rdfs:subClassOf patch:Message ;
- rdfs:label "Response" ;
- lv2:documentation """
-<p>A response to a method.</p>
-""" .
-
-patch:Set
- a rdfs:Class ;
- rdfs:subClassOf patch:Request ,
- [
- a owl:Restriction ;
- owl:cardinality 1 ;
- owl:onProperty patch:property
- ] , [
- a owl:Restriction ;
- owl:cardinality 1 ;
- owl:onProperty patch:value
- ] ;
- lv2:documentation """
-<p>A compact message for setting one property to a specific value.</p>
-
-<p>This is equivalent to a patch:Patch which removes <em>all</em> pre-existing
-values for the property before setting the new value. For example:</p>
-
-<pre class="turtle-code">
-[]
- a patch:Set ;
- patch:subject &lt;something&gt; ;
- patch:property eg:name ;
- patch:value "New name" .
-</pre>
-
-<p>Which is equivalent to:</p>
-<pre class="turtle-code">
-[]
- a patch:Patch ;
- patch:subject &lt;something&gt; ;
- patch:add [
- eg:name "New name" ;
- ] ;
- patch:remove [
- eg:name patch:wildcard ;
- ] .
-</pre>
-""" .
-
-patch:add
- a rdf:Property ,
- owl:ObjectProperty ,
- owl:FunctionalProperty ;
- rdfs:domain patch:Message .
-
-patch:body
- a rdf:Property ,
- owl:ObjectProperty ,
- owl:FunctionalProperty ;
- rdfs:domain patch:Message ;
- lv2:documentation """
-<p>The body of a message.</p>
-
-<p>The details of this property's value depend on the type of message it is a
-part of.</p>
-""" .
-
-patch:destination
- a rdf:Property ,
- owl:ObjectProperty ,
- owl:FunctionalProperty ;
- rdfs:domain patch:Message .
-
-patch:property
- a rdf:Property ;
- rdfs:label "property" ;
- rdfs:range rdf:Property ;
- lv2:documentation """
-<p>The property this message applies to.</p>
-""" .
-
-patch:readable
- a rdf:Property ;
- rdfs:label "readable" ;
- rdfs:range rdf:Property ;
- lv2:documentation """
-<p>Indicates that the subject may have a property that can be read via a
-patch:Get message. See the similar property patch:writable for details.</p>
-""" .
-
-patch:remove
- a rdf:Property ,
- owl:ObjectProperty ,
- owl:FunctionalProperty ;
- rdfs:domain patch:Message .
-
-patch:request
- a rdf:Property ,
- owl:ObjectProperty ,
- owl:FunctionalProperty ;
- rdfs:domain patch:Response ;
- rdfs:range patch:Request ;
- lv2:documentation """
-<p>The request this is a response to.</p>
-""" .
-
-patch:subject
- a rdf:Property ,
- owl:ObjectProperty ,
- owl:FunctionalProperty ;
- rdfs:domain patch:Message .
-
-patch:value
- a rdf:Property ;
- rdfs:label "value" ;
- rdfs:range rdf:Property ;
- lv2:documentation """
-<p>The value of a property in a patch:Set message.</p>
-""" .
-
-patch:wildcard
- a rdfs:Resource ;
- rdfs:comment """
-A wildcard which matches any resource. This makes it possible to describe the removal of all values for a given property.
-""" .
-
-patch:writable
- a rdf:Property ;
- rdfs:label "writable" ;
- rdfs:range rdf:Property ;
- lv2:documentation """
-<p>Indicates that subject may have a property that can be written via a patch
-message. This is used to list supported properties, e.g. so user interfaces
-can present appropriate controls. For example:</p>
-
-<pre class="turtle-code">
-@prefix eg: &lt;http://example.org/&gt; .
-@prefix rdf: &lt;http://www.w3.org/1999/02/22-rdf-syntax-ns#&gt; .
-@prefix rdfs: &lt;http://www.w3.org/2000/01/rdf-schema#&gt; .
-
-eg:title
- a rdf:Property ;
- rdfs:label "title" ;
- rdfs:range xsd:string .
-
-eg:plugin
- patch:writable eg:title .
-</pre>
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/port-groups/lv2-port-groups.doap.ttl b/lv2/lv2plug.in/ns/ext/port-groups/lv2-port-groups.doap.ttl
deleted file mode 100644
index 87a2ee7..0000000
--- a/lv2/lv2plug.in/ns/ext/port-groups/lv2-port-groups.doap.ttl
+++ /dev/null
@@ -1,35 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/port-groups>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:license <http://opensource.org/licenses/isc> ;
- doap:name "LV2 Port Groups" ;
- doap:shortdesc "Multi-channel groups of LV2 ports." ;
- doap:created "2008-00-00" ;
- doap:developer <http://lv2plug.in/ns/meta#larsl> ,
- <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "1.2" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Use consistent label style."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/port-groups/port-groups.h b/lv2/lv2plug.in/ns/ext/port-groups/port-groups.h
deleted file mode 100644
index 4dd8cf4..0000000
--- a/lv2/lv2plug.in/ns/ext/port-groups/port-groups.h
+++ /dev/null
@@ -1,64 +0,0 @@
-/*
- Copyright 2012 David Robillard <http://drobilla.net>
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-/**
- @file port-groups.h
- C definitions for the LV2 Port Groups extension
- <http://lv2plug.in/ns/ext/port-groups>.
-*/
-
-#ifndef LV2_PORT_GROUPS_H
-#define LV2_PORT_GROUPS_H
-
-#define LV2_PORT_GROUPS_URI "http://lv2plug.in/ns/ext/port-groups"
-#define LV2_PORT_GROUPS_PREFIX LV2_PORT_GROUPS_URI "#"
-
-#define LV2_PORT_GROUPS__DiscreteGroup LV2_PORT_GROUPS_PREFIX "DiscreteGroup"
-#define LV2_PORT_GROUPS__Element LV2_PORT_GROUPS_PREFIX "Element"
-#define LV2_PORT_GROUPS__FivePointOneGroup LV2_PORT_GROUPS_PREFIX "FivePointOneGroup"
-#define LV2_PORT_GROUPS__FivePointZeroGroup LV2_PORT_GROUPS_PREFIX "FivePointZeroGroup"
-#define LV2_PORT_GROUPS__FourPointZeroGroup LV2_PORT_GROUPS_PREFIX "FourPointZeroGroup"
-#define LV2_PORT_GROUPS__Group LV2_PORT_GROUPS_PREFIX "Group"
-#define LV2_PORT_GROUPS__InputGroup LV2_PORT_GROUPS_PREFIX "InputGroup"
-#define LV2_PORT_GROUPS__MidSideGroup LV2_PORT_GROUPS_PREFIX "MidSideGroup"
-#define LV2_PORT_GROUPS__MonoGroup LV2_PORT_GROUPS_PREFIX "MonoGroup"
-#define LV2_PORT_GROUPS__OutputGroup LV2_PORT_GROUPS_PREFIX "OutputGroup"
-#define LV2_PORT_GROUPS__SevenPointOneGroup LV2_PORT_GROUPS_PREFIX "SevenPointOneGroup"
-#define LV2_PORT_GROUPS__SevenPointOneWideGroup LV2_PORT_GROUPS_PREFIX "SevenPointOneWideGroup"
-#define LV2_PORT_GROUPS__SixPointOneGroup LV2_PORT_GROUPS_PREFIX "SixPointOneGroup"
-#define LV2_PORT_GROUPS__StereoGroup LV2_PORT_GROUPS_PREFIX "StereoGroup"
-#define LV2_PORT_GROUPS__ThreePointZeroGroup LV2_PORT_GROUPS_PREFIX "ThreePointZeroGroup"
-#define LV2_PORT_GROUPS__center LV2_PORT_GROUPS_PREFIX "center"
-#define LV2_PORT_GROUPS__centerLeft LV2_PORT_GROUPS_PREFIX "centerLeft"
-#define LV2_PORT_GROUPS__centerRight LV2_PORT_GROUPS_PREFIX "centerRight"
-#define LV2_PORT_GROUPS__element LV2_PORT_GROUPS_PREFIX "element"
-#define LV2_PORT_GROUPS__group LV2_PORT_GROUPS_PREFIX "group"
-#define LV2_PORT_GROUPS__left LV2_PORT_GROUPS_PREFIX "left"
-#define LV2_PORT_GROUPS__lowFrequencyEffects LV2_PORT_GROUPS_PREFIX "lowFrequencyEffects"
-#define LV2_PORT_GROUPS__mainInput LV2_PORT_GROUPS_PREFIX "mainInput"
-#define LV2_PORT_GROUPS__mainOutput LV2_PORT_GROUPS_PREFIX "mainOutput"
-#define LV2_PORT_GROUPS__rearCenter LV2_PORT_GROUPS_PREFIX "rearCenter"
-#define LV2_PORT_GROUPS__rearLeft LV2_PORT_GROUPS_PREFIX "rearLeft"
-#define LV2_PORT_GROUPS__rearRight LV2_PORT_GROUPS_PREFIX "rearRight"
-#define LV2_PORT_GROUPS__right LV2_PORT_GROUPS_PREFIX "right"
-#define LV2_PORT_GROUPS__side LV2_PORT_GROUPS_PREFIX "side"
-#define LV2_PORT_GROUPS__sideChainOf LV2_PORT_GROUPS_PREFIX "sideChainOf"
-#define LV2_PORT_GROUPS__sideLeft LV2_PORT_GROUPS_PREFIX "sideLeft"
-#define LV2_PORT_GROUPS__sideRight LV2_PORT_GROUPS_PREFIX "sideRight"
-#define LV2_PORT_GROUPS__source LV2_PORT_GROUPS_PREFIX "source"
-#define LV2_PORT_GROUPS__subGroupOf LV2_PORT_GROUPS_PREFIX "subGroupOf"
-
-#endif /* LV2_PORT_GROUPS_H */
diff --git a/lv2/lv2plug.in/ns/ext/port-groups/port-groups.ttl b/lv2/lv2plug.in/ns/ext/port-groups/port-groups.ttl
deleted file mode 100644
index e02ec7b..0000000
--- a/lv2/lv2plug.in/ns/ext/port-groups/port-groups.ttl
+++ /dev/null
@@ -1,724 +0,0 @@
-@prefix amb: <http://ambisonics.ch/standards/channels/> .
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@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/port-groups>
- a owl:Ontology ;
- rdfs:seeAlso <../../meta/meta.ttl> ,
- <lv2-port-groups.doap.ttl> .
-
-pg:Group
- a rdfs:Class ;
- rdfs:label "Port Group" ;
- rdfs:subClassOf [
- a owl:Restriction ;
- owl:onProperty lv2:symbol ;
- owl:cardinality 1 ;
- rdfs:comment """
-A pg:Group MUST have exactly one string lv2:symbol. This symbol must be
-unique according to the same rules as the lv2:symbol for an lv2:Port, where
-group symbols and port symbols reside in the same namespace. In other words,
-a group on a plugin MUST NOT have the same symbol as another group or a port
-on that plugin. This makes it possible to uniquely reference a port or group
-on a plugin with a single identifier and no context.
-"""
- ] ;
- rdfs:comment """
-A set of ports/channels/controls/etc that are are logically grouped together,
-e.g. two audio ports in a group may form a stereo stream. In order to avoid
-the need to define large numbers of identical group definitions, a group
-definition may be shared. For example, a plugin collection may define a single
-URI for a pg:StereoGroup with the symbol "input" and use it in many plugins.
-""" .
-
-pg:InputGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:Group ;
- rdfs:label "Input Group" ;
- rdfs:comment "A group which contains exclusively inputs." .
-
-pg:OutputGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:Group ;
- rdfs:label "Output Group" ;
- rdfs:comment "A group which contains exclusively outputs." .
-
-pg:Element
- a rdfs:Class ;
- rdfs:label "Element" ;
- rdfs:comment "An ordered element of a group." ;
- rdfs:subClassOf [
- a owl:Restriction ;
- owl:onProperty lv2:designation ;
- owl:cardinality 1 ;
- rdfs:comment "An element MUST have exactly one lv2:designation."
- ] ;
- rdfs:comment """
-An element of a group, which has a designation and an optional index.
-""" .
-
-pg:element
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:range pg:Element ;
- rdfs:label "element" ;
- rdfs:comment """
-Indicates that a group has a certain element (a parameter or channel
-designation with a possible index).
-""" .
-
-pg:sideChainOf
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:label "side-chain of" ;
- rdfs:comment """
-Indicates that this port or group should be considered a "side chain" of
-some other port or group. The precise definition of "side chain" depends
-on the plugin, but in general this group should be considered a modifier to
-some other group, rather than an independent input itself.
-""" .
-
-pg:subGroupOf
- a rdf:Property ,
- owl:ObjectProperty ,
- owl:FunctionalProperty ;
- rdfs:domain pg:Group ;
- rdfs:range pg:Group ;
- rdfs:label "sub-group of" ;
- rdfs:comment """
-Indicates that this group is a child of another group. This property has no
-meaning with respect to plugin execution, but the host may find this
-information useful (e.g. to provide a compact user interface). Note that being
-a sub-group does not relax the restriction that the group MUST have a unique
-symbol with respect to the plugin.
-""" .
-
-pg:source
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:domain pg:OutputGroup ;
- rdfs:range pg:InputGroup ;
- rdfs:label "source" ;
- rdfs:comment """
-Indicates that this port or group should be considered the "result" of
-some other port or group. This property only makes sense on groups with
-outputs when the source is a group with inputs. This can be used to convey
-a relationship between corresponding input and output groups with different
-types, e.g. a mono->stereo plugin.
-""" .
-
-pg:mainInput
- a rdf:Property ,
- owl:ObjectProperty ,
- owl:FunctionalProperty ;
- rdfs:domain lv2:Plugin ;
- rdfs:range pg:InputGroup ;
- rdfs:label "main input" ;
- rdfs:comment """
-Indicates that this group should be considered the "main" input, i.e. the
-primary task is processing the signal in this group. A plugin MUST NOT have
-more than one pg:mainInput property.
-""" .
-
-pg:mainOutput
- a rdf:Property ,
- owl:ObjectProperty ,
- owl:FunctionalProperty ;
- rdfs:domain lv2:Plugin ;
- rdfs:range pg:OutputGroup ;
- rdfs:label "main output" ;
- rdfs:comment """
-Indicates that this group should be considered the "main" output. The main
-output group SHOULD have the main input group as a pg:source.
-""" .
-
-pg:group
- a rdf:Property ,
- owl:ObjectProperty ,
- owl:FunctionalProperty ;
- rdfs:domain lv2:Port ;
- rdfs:range pg:Group ;
- rdfs:label "group" ;
- rdfs:comment """
-Indicates that this port is a part of a group of ports on the plugin. The port
-should also have an lv2:designation property to define its designation within
-that group.
-""" .
-
-pg:DiscreteGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:Group ;
- rdfs:comment """
-"Discrete" channel configurations. These groups are divided into channels
-where each represents a particular speaker location. The position of sound
-in one of these groups depends on a particular speaker configuration.
-""" .
-
-pg:left
- a lv2:Channel ;
- rdfs:label "left" .
-
-pg:right
- a lv2:Channel ;
- rdfs:label "right" .
-
-pg:center
- a lv2:Channel ;
- rdfs:label "center" .
-
-pg:side
- a lv2:Channel ;
- rdfs:label "side" .
-
-pg:centerLeft
- a lv2:Channel ;
- rdfs:label "center left" .
-
-pg:centerRight
- a lv2:Channel ;
- rdfs:label "center right" .
-
-pg:sideLeft
- a lv2:Channel ;
- rdfs:label "side left" .
-
-pg:sideRight
- a lv2:Channel ;
- rdfs:label "side right" .
-
-pg:rearLeft
- a lv2:Channel ;
- rdfs:label "rear left" .
-
-pg:rearRight
- a lv2:Channel ;
- rdfs:label "rear right" .
-
-pg:rearCenter
- a lv2:Channel ;
- rdfs:label "rear center" .
-
-pg:lowFrequencyEffects
- a lv2:Channel ;
- rdfs:label "low-frequency effects" .
-
-pg:MonoGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:DiscreteGroup ;
- rdfs:label "Mono" ;
- pg:element [
- lv2:index 0 ;
- lv2:designation pg:center
- ] .
-
-pg:StereoGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:DiscreteGroup ;
- rdfs:label "Stereo" ;
- pg:element [
- lv2:index 0 ;
- lv2:designation pg:left
- ] , [
- lv2:index 1 ;
- lv2:designation pg:right
- ] .
-
-pg:MidSideGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:DiscreteGroup ;
- rdfs:label "Mid-Side Stereo" ;
- pg:element [
- lv2:index 0 ;
- lv2:designation pg:center
- ] , [
- lv2:index 1 ;
- lv2:designation pg:side
- ] .
-
-pg:ThreePointZeroGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:DiscreteGroup ;
- rdfs:label "3.0 Surround" ;
- pg:element [
- lv2:index 0 ;
- lv2:designation pg:left
- ] , [
- lv2:index 1 ;
- lv2:designation pg:right
- ] , [
- lv2:index 2 ;
- lv2:designation pg:rearCenter
- ] .
-
-pg:FourPointZeroGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:DiscreteGroup ;
- rdfs:label "4.0 Surround (Quadraphonic)" ;
- pg:element [
- lv2:index 0 ;
- lv2:designation pg:left
- ] , [
- lv2:index 1 ;
- lv2:designation pg:center
- ] , [
- lv2:index 2 ;
- lv2:designation pg:right
- ] , [
- lv2:index 3 ;
- lv2:designation pg:rearCenter
- ] .
-
-pg:FivePointZeroGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:DiscreteGroup ;
- rdfs:label "5.0 Surround (3-2 stereo)" ;
- pg:element [
- lv2:index 0 ;
- lv2:designation pg:left
- ] , [
- lv2:index 1 ;
- lv2:designation pg:center
- ] , [
- lv2:index 2 ;
- lv2:designation pg:right
- ] , [
- lv2:index 3 ;
- lv2:designation pg:rearLeft
- ] , [
- lv2:index 4 ;
- lv2:designation pg:rearRight
- ] .
-
-pg:FivePointOneGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:DiscreteGroup ;
- rdfs:label "5.1 Surround (3-2 stereo)" ;
- pg:element [
- lv2:index 0 ;
- lv2:designation pg:left
- ] , [
- lv2:index 1 ;
- lv2:designation pg:center
- ] , [
- lv2:index 2 ;
- lv2:designation pg:right
- ] , [
- lv2:index 3 ;
- lv2:designation pg:rearLeft
- ] , [
- lv2:index 4 ;
- lv2:designation pg:rearRight
- ] , [
- lv2:index 5 ;
- lv2:designation pg:lowFrequencyEffects
- ] .
-
-pg:SixPointOneGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:DiscreteGroup ;
- rdfs:label "6.1 Surround" ;
- pg:element [
- lv2:index 0 ;
- lv2:designation pg:left
- ] , [
- lv2:index 1 ;
- lv2:designation pg:center
- ] , [
- lv2:index 2 ;
- lv2:designation pg:right
- ] , [
- lv2:index 3 ;
- lv2:designation pg:sideLeft
- ] , [
- lv2:index 4 ;
- lv2:designation pg:sideRight
- ] , [
- lv2:index 5 ;
- lv2:designation pg:rearCenter
- ] , [
- lv2:index 6 ;
- lv2:designation pg:lowFrequencyEffects
- ] .
-
-pg:SevenPointOneGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:DiscreteGroup ;
- rdfs:label "7.1 Surround" ;
- pg:element [
- lv2:index 0 ;
- lv2:designation pg:left
- ] , [
- lv2:index 1 ;
- lv2:designation pg:center
- ] , [
- lv2:index 2 ;
- lv2:designation pg:right
- ] , [
- lv2:index 3 ;
- lv2:designation pg:sideLeft
- ] , [
- lv2:index 4 ;
- lv2:designation pg:sideRight
- ] , [
- lv2:index 5 ;
- lv2:designation pg:rearLeft
- ] , [
- lv2:index 6 ;
- lv2:designation pg:rearRight
- ] , [
- lv2:index 7 ;
- lv2:designation pg:lowFrequencyEffects
- ] .
-
-pg:SevenPointOneWideGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:DiscreteGroup ;
- rdfs:label "7.1 Surround (Wide)" ;
- pg:element [
- lv2:index 0 ;
- lv2:designation pg:left
- ] , [
- lv2:index 1 ;
- lv2:designation pg:centerLeft
- ] , [
- lv2:index 2 ;
- lv2:designation pg:center
- ] , [
- lv2:index 3 ;
- lv2:designation pg:centerRight
- ] , [
- lv2:index 4 ;
- lv2:designation pg:right
- ] , [
- lv2:index 5 ;
- lv2:designation pg:rearLeft
- ] , [
- lv2:index 6 ;
- lv2:designation pg:rearRight
- ] , [
- lv2:index 7 ;
- lv2:designation pg:lowFrequencyEffects
- ] .
-
-amb:ACN0
- a lv2:Channel .
-
-amb:ACN1
- a lv2:Channel .
-
-amb:ACN2
- a lv2:Channel .
-
-amb:ACN3
- a lv2:Channel .
-
-amb:ACN4
- a lv2:Channel .
-
-amb:ACN5
- a lv2:Channel .
-
-amb:ACN6
- a lv2:Channel .
-
-amb:ACN7
- a lv2:Channel .
-
-amb:ACN8
- a lv2:Channel .
-
-amb:ACN9
- a lv2:Channel .
-
-amb:ACN10
- a lv2:Channel .
-
-amb:ACN11
- a lv2:Channel .
-
-amb:ACN12
- a lv2:Channel .
-
-amb:ACN13
- a lv2:Channel .
-
-amb:ACN14
- a lv2:Channel .
-
-amb:ACN15
- a lv2:Channel .
-
-pg:AmbisonicGroup
- a rdfs:Class ;
- rdfs:subClassOf pg:Group ;
- rdfs:comment """
-"Ambisonic" channel configurations. These groups are divided into channels
-which together represent a position in an abstract n-dimensional space.
-The position of sound in one of these groups does not depend on a particular
-speaker configuration; a decoder can be used to convert an ambisonic stream
-for any speaker configuration.
-""" .
-
-pg:AmbisonicBH1P0Group
- a rdfs:Class ;
- rdfs:subClassOf pg:AmbisonicGroup ;
- rdfs:label "Ambisonic B stream of horizontal order 1 and peripheral order 0." ;
- pg:element [
- lv2:index 0 ;
- lv2:designation amb:ACN0
- ] , [
- lv2:index 1 ;
- lv2:designation amb:ACN1
- ] , [
- lv2:index 2 ;
- lv2:designation amb:ACN3
- ] .
-
-pg:AmbisonicBH1P1Group
- a rdfs:Class ;
- rdfs:subClassOf pg:AmbisonicGroup ;
- rdfs:label "Ambisonic B stream of horizontal order 1 and peripheral order 1." ;
- pg:element [
- lv2:index 0 ;
- lv2:designation amb:ACN0
- ] , [
- lv2:index 1 ;
- lv2:designation amb:ACN1
- ] , [
- lv2:index 2 ;
- lv2:designation amb:ACN2
- ] , [
- lv2:index 3 ;
- lv2:designation amb:ACN3
- ] .
-
-pg:AmbisonicBH2P0Group
- a rdfs:Class ;
- rdfs:subClassOf pg:AmbisonicGroup ;
- rdfs:label "Ambisonic B stream of horizontal order 2 and peripheral order 0." ;
- pg:element [
- lv2:index 0 ;
- lv2:designation amb:ACN0
- ] , [
- lv2:index 1 ;
- lv2:designation amb:ACN1
- ] , [
- lv2:index 2 ;
- lv2:designation amb:ACN3
- ] , [
- lv2:index 3 ;
- lv2:designation amb:ACN4
- ] , [
- lv2:index 4 ;
- lv2:designation amb:ACN8
- ] .
-
-pg:AmbisonicBH2P1Group
- a rdfs:Class ;
- rdfs:subClassOf pg:AmbisonicGroup ;
- rdfs:label "Ambisonic B stream of horizontal order 2 and peripheral order 1." ;
- pg:element [
- lv2:index 0 ;
- lv2:designation amb:ACN0
- ] , [
- lv2:index 1 ;
- lv2:designation amb:ACN1
- ] , [
- lv2:index 2 ;
- lv2:designation amb:ACN2
- ] , [
- lv2:index 3 ;
- lv2:designation amb:ACN3
- ] , [
- lv2:index 4 ;
- lv2:designation amb:ACN4
- ] , [
- lv2:index 5 ;
- lv2:designation amb:ACN8
- ] .
-
-pg:AmbisonicBH2P2Group
- a rdfs:Class ;
- rdfs:subClassOf pg:AmbisonicGroup ;
- rdfs:label "Ambisonic B stream of horizontal order 2 and peripheral order 2." ;
- pg:element [
- lv2:index 0 ;
- lv2:designation amb:ACN0
- ] , [
- lv2:index 1 ;
- lv2:designation amb:ACN1
- ] , [
- lv2:index 2 ;
- lv2:designation amb:ACN2
- ] , [
- lv2:index 3 ;
- lv2:designation amb:ACN3
- ] , [
- lv2:index 4 ;
- lv2:designation amb:ACN4
- ] , [
- lv2:index 5 ;
- lv2:designation amb:ACN5
- ] , [
- lv2:index 6 ;
- lv2:designation amb:ACN6
- ] , [
- lv2:index 7 ;
- lv2:designation amb:ACN7
- ] , [
- lv2:index 8 ;
- lv2:designation amb:ACN8
- ] .
-
-pg:AmbisonicBH3P0Group
- a rdfs:Class ;
- rdfs:subClassOf pg:AmbisonicGroup ;
- rdfs:label "Ambisonic B stream of horizontal order 3 and peripheral order 0." ;
- pg:element [
- lv2:index 0 ;
- lv2:designation amb:ACN0
- ] , [
- lv2:index 1 ;
- lv2:designation amb:ACN1
- ] , [
- lv2:index 2 ;
- lv2:designation amb:ACN3
- ] , [
- lv2:index 3 ;
- lv2:designation amb:ACN4
- ] , [
- lv2:index 4 ;
- lv2:designation amb:ACN8
- ] , [
- lv2:index 5 ;
- lv2:designation amb:ACN9
- ] , [
- lv2:index 6 ;
- lv2:designation amb:ACN15
- ] .
-
-pg:AmbisonicBH3P1Group
- a rdfs:Class ;
- rdfs:subClassOf pg:AmbisonicGroup ;
- rdfs:label "Ambisonic B stream of horizontal order 3 and peripheral order 1." ;
- pg:element [
- lv2:index 0 ;
- lv2:designation amb:ACN0
- ] , [
- lv2:index 1 ;
- lv2:designation amb:ACN1
- ] , [
- lv2:index 2 ;
- lv2:designation amb:ACN2
- ] , [
- lv2:index 3 ;
- lv2:designation amb:ACN3
- ] , [
- lv2:index 4 ;
- lv2:designation amb:ACN4
- ] , [
- lv2:index 5 ;
- lv2:designation amb:ACN8
- ] , [
- lv2:index 6 ;
- lv2:designation amb:ACN9
- ] , [
- lv2:index 7 ;
- lv2:designation amb:ACN15
- ] .
-
-pg:AmbisonicBH3P2Group
- a rdfs:Class ;
- rdfs:subClassOf pg:AmbisonicGroup ;
- rdfs:label "Ambisonic B stream of horizontal order 3 and peripheral order 2." ;
- pg:element [
- lv2:index 0 ;
- lv2:designation amb:ACN0
- ] , [
- lv2:index 1 ;
- lv2:designation amb:ACN1
- ] , [
- lv2:index 2 ;
- lv2:designation amb:ACN2
- ] , [
- lv2:index 3 ;
- lv2:designation amb:ACN3
- ] , [
- lv2:index 4 ;
- lv2:designation amb:ACN4
- ] , [
- lv2:index 5 ;
- lv2:designation amb:ACN5
- ] , [
- lv2:index 6 ;
- lv2:designation amb:ACN6
- ] , [
- lv2:index 7 ;
- lv2:designation amb:ACN7
- ] , [
- lv2:index 8 ;
- lv2:designation amb:ACN8
- ] , [
- lv2:index 9 ;
- lv2:designation amb:ACN9
- ] , [
- lv2:index 10 ;
- lv2:designation amb:ACN15
- ] .
-
-pg:AmbisonicBH3P3Group
- a rdfs:Class ;
- rdfs:subClassOf pg:AmbisonicGroup ;
- rdfs:label "Ambisonic B stream of horizontal order 3 and peripheral order 3." ;
- pg:element [
- lv2:index 0 ;
- lv2:designation amb:ACN0
- ] , [
- lv2:index 1 ;
- lv2:designation amb:ACN1
- ] , [
- lv2:index 2 ;
- lv2:designation amb:ACN2
- ] , [
- lv2:index 3 ;
- lv2:designation amb:ACN3
- ] , [
- lv2:index 4 ;
- lv2:designation amb:ACN4
- ] , [
- lv2:index 5 ;
- lv2:designation amb:ACN5
- ] , [
- lv2:index 6 ;
- lv2:designation amb:ACN6
- ] , [
- lv2:index 7 ;
- lv2:designation amb:ACN7
- ] , [
- lv2:index 8 ;
- lv2:designation amb:ACN8
- ] , [
- lv2:index 9 ;
- lv2:designation amb:ACN9
- ] , [
- lv2:index 10 ;
- lv2:designation amb:ACN10
- ] , [
- lv2:index 11 ;
- lv2:designation amb:ACN11
- ] , [
- lv2:index 12 ;
- lv2:designation amb:ACN12
- ] , [
- lv2:index 13 ;
- lv2:designation amb:ACN13
- ] , [
- lv2:index 14 ;
- lv2:designation amb:ACN14
- ] , [
- lv2:index 15 ;
- lv2:designation amb:ACN15
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/port-props/lv2-port-props.doap.ttl b/lv2/lv2plug.in/ns/ext/port-props/lv2-port-props.doap.ttl
deleted file mode 100644
index 7188aab..0000000
--- a/lv2/lv2plug.in/ns/ext/port-props/lv2-port-props.doap.ttl
+++ /dev/null
@@ -1,34 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/port-props>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:name "LV2 Port Properties" ;
- doap:created "2009-01-01" ;
- doap:shortdesc "Various port properties." ;
- doap:maintainer <http://drobilla.net/drobilla#me> ;
- doap:developer <http://lv2plug.in/ns/meta#kfoltman> ;
- doap:release [
- doap:revision "1.2" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Use consistent label style."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/presets/lv2-presets.doap.ttl b/lv2/lv2plug.in/ns/ext/presets/lv2-presets.doap.ttl
deleted file mode 100644
index e5bca3a..0000000
--- a/lv2/lv2plug.in/ns/ext/presets/lv2-presets.doap.ttl
+++ /dev/null
@@ -1,60 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/presets>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:license <http://opensource.org/licenses/isc> ;
- doap:name "LV2 Presets" ;
- doap:shortdesc "Presets for LV2 plugins. " ;
- doap:created "2009-00-00" ;
- doap:developer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "2.8" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Use consistent label style."
- ]
- ]
- ] , [
- doap:revision "2.6" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Add pset:preset property for describing the preset currently applied to a plugin instance."
- ] , [
- rdfs:label "Remove pset:appliesTo property, use lv2:appliesTo instead."
- ] , [
- rdfs:label "Merge with unified LV2 package."
- ]
- ]
- ] , [
- doap:revision "2.2" ;
- doap:created "2011-11-21" ;
- doap:file-release <http://lv2plug.in/spec/lv2-presets-2.2.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Update packaging."
- ] , [
- rdfs:label "Improve documentation."
- ]
- ]
- ] , [
- doap:revision "2.0" ;
- doap:created "2010-10-04" ;
- doap:file-release <http://lv2plug.in/spec/lv2-presets-2.0.tar.gz> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/presets/presets.h b/lv2/lv2plug.in/ns/ext/presets/presets.h
deleted file mode 100644
index 4851feb..0000000
--- a/lv2/lv2plug.in/ns/ext/presets/presets.h
+++ /dev/null
@@ -1,34 +0,0 @@
-/*
- Copyright 2012 David Robillard <http://drobilla.net>
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-/**
- @file presets.h
-
- C definitions for the LV2 Presets extension
- <http://lv2plug.in/ns/ext/presets>.
-*/
-
-#ifndef LV2_PRESETS_H
-#define LV2_PRESETS_H
-
-#define LV2_PRESETS_URI "http://lv2plug.in/ns/ext/presets"
-#define LV2_PRESETS_PREFIX LV2_PRESETS_URI "#"
-
-#define LV2_PRESETS__Preset LV2_PRESETS_PREFIX "Preset"
-#define LV2_PRESETS__preset LV2_PRESETS_PREFIX "preset"
-#define LV2_PRESETS__value LV2_PRESETS_PREFIX "value"
-
-#endif /* LV2_PRESETS_H */
diff --git a/lv2/lv2plug.in/ns/ext/presets/presets.ttl b/lv2/lv2plug.in/ns/ext/presets/presets.ttl
deleted file mode 100644
index ef505c8..0000000
--- a/lv2/lv2plug.in/ns/ext/presets/presets.ttl
+++ /dev/null
@@ -1,84 +0,0 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@prefix pset: <http://lv2plug.in/ns/ext/presets#> .
-@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/presets>
- a owl:Ontology ;
- rdfs:seeAlso <lv2-presets.doap.ttl> ;
- lv2:documentation """
-<p>This vocabulary describes a format for presets (i.e. named sets of control
-values and possibly other state) for LV2 plugins. The structure of a
-pset:Preset is deliberately identical to that of an lv2:Plugin, and can be
-thought of as a plugin template or overlay.</p>
-
-<p>Presets may be defined in any bundle, including the plugin's bundle,
-separate third party preset bundles, or user preset bundles saved by hosts.
-Since preset data tends to be large, it is recommended that plugins describe
-presets in a separate file(s) to avoid slowing down hosts. The manifest.ttl of
-a bundle containing presets should list the presets like so:</p>
-
-<pre class="turtle-code">
-eg:mypreset
- a pset:Preset ;
- lv2:appliesTo eg:myplugin ;
- rdfs:seeAlso &lt;mypreset.ttl&gt; .
-</pre>
-""" .
-
-pset:Preset
- a rdfs:Class ;
- rdfs:subClassOf lv2:PluginBase ;
- rdfs:label "LV2 Preset" ;
- rdfs:subClassOf [
- a owl:Restriction ;
- owl:onProperty rdfs:label ;
- owl:someValuesFrom xsd:string ;
- rdfs:comment "A Preset MUST have at least one string rdfs:label."
- ] ;
- lv2:documentation """
-<p>A Preset for an LV2 Plugin. The structure of a Preset deliberately mirrors that
-of a plugin, so existing predicates can be used to describe any data associated with
-the preset. For example:</p>
-
-<pre class="turtle-code">
-@prefix eg: &lt;http://example.org/&gt; .
-
-eg:mypreset
- a pset:Preset ;
- rdfs:label "One louder" ;
- lv2:appliesTo eg:myplugin ;
- lv2:port [
- lv2:symbol "volume1" ;
- pset:value 11.0
- ] , [
- lv2:symbol "volume2" ;
- pset:value 11.0
- ] .
-</pre>
-
-<p>A Preset SHOULD have at least one lv2:appliesTo property. Each Port on a
-Preset MUST have at least a lv2:symbol property and a pset:value property.</p>
-""" .
-
-pset:value
- a rdf:Property ;
- rdfs:domain lv2:Port ;
- rdfs:label "value" ;
- rdfs:comment """
-Specifies the value of a Port on some Preset. This property is used
-in a similar way to e.g. lv2:default.
-""" .
-
-pset:preset
- a rdf:Property ;
- rdfs:domain lv2:PluginBase ;
- rdfs:range pset:Preset ;
- rdfs:label "preset" ;
- lv2:documentation """
-<p>Specifies the preset currently applied to a plugin instance. This property
-may be useful for saving state, or notifying a plugin instance at run-time
-about a preset change.</p>
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/resize-port/lv2-resize-port.doap.ttl b/lv2/lv2plug.in/ns/ext/resize-port/lv2-resize-port.doap.ttl
deleted file mode 100644
index 7617a2c..0000000
--- a/lv2/lv2plug.in/ns/ext/resize-port/lv2-resize-port.doap.ttl
+++ /dev/null
@@ -1,23 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/resize-port>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:name "LV2 Resize Port Extension" ;
- doap:shortdesc "Dynamically sized LV2 port buffers." ;
- doap:created "2007-00-00" ;
- doap:developer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "1.0" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/resize-port/resize-port.ttl b/lv2/lv2plug.in/ns/ext/resize-port/resize-port.ttl
deleted file mode 100644
index 6688f90..0000000
--- a/lv2/lv2plug.in/ns/ext/resize-port/resize-port.ttl
+++ /dev/null
@@ -1,64 +0,0 @@
-@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.
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/state/lv2-state.doap.ttl b/lv2/lv2plug.in/ns/ext/state/lv2-state.doap.ttl
deleted file mode 100644
index 9e699ad..0000000
--- a/lv2/lv2plug.in/ns/ext/state/lv2-state.doap.ttl
+++ /dev/null
@@ -1,46 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/state>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:created "2010-11-09" ;
- doap:name "LV2 State" ;
- doap:shortdesc "An interface for LV2 plugins to save and restore state." ;
- doap:license <http://opensource.org/licenses/isc> ;
- doap:developer <http://lv2plug.in/ns/meta#paniq> ,
- <http://drobilla.net/drobilla#me> ;
- doap:maintainer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "2.0" ;
- doap:created "2013-01-16" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Add state:loadDefaultState feature so plugins can have their default state loaded without hard-coding default state as a special case."
- ]
- ]
- ] , [
- doap:revision "1.2" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Use consistent label style."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/state/state.ttl b/lv2/lv2plug.in/ns/ext/state/state.ttl
deleted file mode 100644
index 699ef45..0000000
--- a/lv2/lv2plug.in/ns/ext/state/state.ttl
+++ /dev/null
@@ -1,349 +0,0 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-@prefix state: <http://lv2plug.in/ns/ext/state#> .
-
-<http://lv2plug.in/ns/ext/state>
- a lv2:Specification ;
- rdfs:seeAlso <state.h> ,
- <../../meta/meta.ttl> ,
- <lv2-state.doap.ttl> ;
- lv2:documentation """
-<p>This extension defines a simple mechanism which allows hosts to save and
-restore a plugin instance's state. The goal is for an instance's state to be
-<em>completely</em> described by port values (as with all LV2 plugins) and a
-simple dictionary.</p>
-
-<p>The <q>state</q> defined here is conceptually a key:value dictionary, with
-URI keys and values of any type. For performance reasons the key and value
-type are actually a <q>URID</q>, a URI mapped to an integer. A single
-key:value pair is called a <q>property</q>.</p>
-
-<p>This state model is simple yet has many benefits:</p>
-<ul>
- <li>Both fast and extensible thanks to URID keys.</li>
- <li>No limitations on possible value types.</li>
- <li>Easy to serialise in almost any format.</li>
- <li>Easy to store in a typical <q>map</q> or <q>dictionary</q> data
- structure.</li>
- <li>Elegantly described in Turtle, so state can be described in LV2 data
- files (including presets).</li>
- <li>Does not impose any file formats, data structures, or file system
- requirements.</li>
- <li>Suitable for portable persistent state as well as fast in-memory
- snapshots.</li>
- <li>Keys <em>may</em> be well-defined and used meaningfully across several
- implementations.</li>
- <li>State <em>may</em> be dynamic, but plugins are not required to have a
- dynamic dictionary data structure available.</li>
-</ul>
-
-<p>To implement state, the plugin provides a state:interface to the host. To
-save or restore, the host calls LV2_State_Interface::save() or
-LV2_State_Interface::restore(), passing a callback to be used for handling a
-single property. The host is free to implement property storage and retrieval
-in any way.</p>
-
-<p>Since value types are defined by URI, any type is possible. However, a set
-of standard types is defined by the <a href="../atom/atom.html">LV2 Atom</a>
-extension. Use of these types is recommended. Hosts MUST implement at least
-<a href="../atom/atom.html#String">atom:String</a>, which is simply a C
-string.</p>
-
-<h3>Referring to Files</h3>
-
-<p>Plugins may need to refer to existing files (e.g. loaded samples) in their
-state. This is done by storing the file's path as a property just like any
-other value. However, there are some rules which MUST be followed when storing
-paths, see state:mapPath for details. Plugins MUST use the type <a
-href="../atom/atom.html#Path">atom:Path</a> for all paths in their state.</p>
-
-<p>Plugins are strongly encouraged to avoid creating files, instead storing all
-state as properties. However, occasionally the ability to create files is
-necessary. To make this possible, the host can provide the feature
-state:makePath which allocates paths for plugin-created files. Plugins MUST
-NOT create files in any other locations.</p>
-
-<h3>Plugin Code Example</h3>
-
-<pre class="c-code">
-
-/* Namespace for this plugin's keys. This SHOULD be something that could be
- published as a document, even if that document does not exist right now.
-*/
-#define NS_MY "http://example.org/myplugin/schema#"
-
-#define DEFAULT_GREETING "Hello"
-
-LV2_Handle
-my_instantiate(...)
-{
- MyPlugin* plugin = ...;
- plugin->uris.atom_String = map_uri(LV2_ATOM__String);
- plugin->uris.my_greeting = map_uri(NS_MY "greeting");
- plugin->state.greeting = strdup(DEFAULT_GREETING);
- return plugin;
-}
-
-LV2_State_Status
-my_save(LV2_Handle instance,
- LV2_State_Store_Function store,
- LV2_State_Handle handle,
- uint32_t flags,
- const LV2_Feature *const * features)
-{
- MyPlugin* plugin = (MyPlugin*)instance;
- const char* greeting = plugin->state.greeting;
-
- store(handle,
- plugin->uris.my_greeting,
- greeting,
- strlen(greeting) + 1, // Careful! Need space for terminator
- plugin->uris.atom_String,
- LV2_STATE_IS_POD | LV2_STATE_IS_PORTABLE);
-
- return LV2_STATE_SUCCESS;
-}
-
-LV2_State_Status
-my_restore(LV2_Handle instance,
- LV2_State_Retrieve_Function retrieve,
- LV2_State_Handle handle,
- uint32_t flags,
- const LV2_Feature *const * features)
-{
- MyPlugin* plugin = (MyPlugin*)instance;
-
- size_t size;
- uint32_t type;
- uint32_t flags;
- const char* greeting = retrieve(
- handle, plugin->uris.my_greeting, &amp;size, &amp;type, &amp;flags);
-
- if (greeting) {
- free(plugin->state->greeting);
- plugin->state->greeting = strdup(greeting);
- } else {
- plugin->state->greeting = strdup(DEFAULT_GREETING);
- }
-
- return LV2_STATE_SUCCESS;
-}
-
-const void*
-my_extension_data(const char* uri)
-{
- static const LV2_State_Interface state_iface = { my_save, my_restore };
- if (!strcmp(uri, LV2_STATE__interface)) {
- return &amp;state_iface;
- }
-}
-</pre>
-
-<h3>Host Code Example</h3>
-
-<pre class="c-code">
-LV2_State_Status
-store_callback(LV2_State_Handle handle,
- uint32_t key,
- const void* value,
- size_t size,
- uint32_t type,
- uint32_t flags)
-{
- if ((flags &amp; LV2_STATE_IS_POD)) {
- /* We only care about POD since we're keeping state in memory only.
- For disk or network use, LV2_STATE_IS_PORTABLE must also be checked.
- */
- Map* state_map = (Map*)handle;
- state_map->insert(key, Value(copy(value), size, type));
- return 0;
- } else {
- return 1; /* Non-POD events are unsupported. */
- }
-}
-
-Map
-get_plugin_state(LV2_Handle instance)
-{
- LV2_State* state = instance.extension_data(LV2_STATE__interface);
- Map state_map;
- /** Request a fast/native/POD save, since we're just copying in memory */
- state.save(instance, store_callback, &amp;state_map,
- LV2_STATE_IS_POD|LV2_STATE_IS_NATIVE);
- return state_map;
-}
-</pre>
-
-<h3>Extensions to this Specification</h3>
-
-<p>It is likely that other interfaces for working with plugin state will be
-developed as needed. This is encouraged, however everything SHOULD work within
-the state <em>model</em> defined here. That is, <strong>do not complicate the
-state model</strong>. Implementations can assume the following:</p>
-
-<ul>
-<li>The current port values and state dictionary completely describe a plugin
-instance, at least well enough that saving and restoring will yield an
-<q>identical</q> instance from the user's perspective.</li>
-<li>Hosts are not expected to save and/or restore any other attributes of a
-plugin instance.</li>
-</ul>
-
-<h3>The <q>Property Principle</q></h3>
-
-<p>The main benefit of this meaningful state model is that it can double as a
-plugin control/query mechanism. For plugins that require more advanced control
-than simple control ports, instead of defining a set of commands, define
-properties whose values can be set appropriately. This provides both a way to
-control and save that state <q>for free</q>, since there is no need to define
-commands <em>and</em> a set of properties for storing their effects. In
-particular, this is a good way for UIs to achieve more advanced control of
-plugins.</p>
-
-<p>This <q>property principle</q> is summed up in the phrase:
-<q>Don't stop; set playing to false</q>.</p>
-
-<p>This extension does not define a dynamic mechanism for state access and
-manipulation. The <a href="../patch/patch.html">LV2 Patch</a> extension
-defines a generic set of messages which can be used to access or manipulate
-properties, and the <a href="../atom/atom.html">LV2 Atom</a> extension defines
-a port type and data container capable of transmitting those messages.</p>
-""" .
-
-state:interface
- a lv2:ExtensionData ;
- lv2:documentation """
-<p>A structure (LV2_State_Interface) which contains functions to be called by
-the host to save and restore state. In order to support this extension, the
-plugin must return a valid LV2_State_Interface from
-LV2_Descriptor::extension_data() when it is called with URI
-LV2_STATE__interface.</p>
-
-<p>The plugin data file should describe this like so:</p>
-<pre class="turtle-code">
-@prefix state: &lt;http://lv2plug.in/ns/ext/state#&gt; .
-
-&lt;plugin&gt;
- a lv2:Plugin ;
- lv2:extensionData state:interface .
-</pre>
-""" .
-
-state:State
- a rdfs:Class ;
- rdfs:label "State" ;
- lv2:documentation """
-<p>A state dictionary. This type should be used wherever instance state is
-described. The properties of a resource with this type correspond directly to
-the properties of the state dictionary (except the property that states it has
-this type).</p>
-""" .
-
-state:loadDefaultState
- a lv2:Feature ;
- lv2:documentation """
-<p>This feature indicates that the plugin has default state listed with the
-state:state property which should be loaded by the host before running the
-plugin. Requiring this feature allows plugins to implement a single state
-loading mechanism which works for initialisation as well as restoration,
-without having to hard-code default state.</p>
-
-<p>To support this feature, the host MUST <q>restore</q> the default state
-after instantiating the plugin but before calling run().</p>
-""" .
-
-state:state
- a rdf:Property ;
- rdfs:label "state" ;
- rdfs:range state:State ;
- lv2:documentation """
-<p>The state of this instance. This property may be used anywhere a state
-needs to be described, for example:</p>
-
-<pre class="turtle-code">
-@prefix eg: &lt;http://example.org/&gt; .
-
-&lt;plugin-instance&gt;
- state:state [
- eg:somekey "some value" ;
- eg:someotherkey "some other value" ;
- eg:favourite-number 2
- ] .
-</pre>
-""" .
-
-state:mapPath
- a lv2:Feature ;
- rdfs:label "map file paths" ;
- lv2:documentation """
-<p>This feature maps absolute paths to/from <q>abstract paths</q> which are
-stored in state. To support this feature a host must pass an LV2_Feature with
-URI LV2_STATE__mapPath and data pointed to an LV2_State_Map_Path to the
-plugin's LV2_State_Interface methods.</p>
-
-<p>The plugin MUST map <em>all</em> paths stored in its state (including those
-inside any files in its state). This is necessary to enable host to handle
-file system references correctly, e.g. for distribution or archival.</p>
-
-<p>For example, a plugin may write a path to a state file like so:</p>
-
-<pre class="c-code">
-void write_path(LV2_State_Map_Path* map_path, FILE* myfile, const char* path)
-{
- char* abstract_path = map_path->abstract_path(map_path->handle, path);
- fprintf(myfile, "%s", abstract_path);
- free(abstract_path);
-}
-</pre>
-
-<p>Then, later reload the path like so:</p>
-
-<pre class="c-code">
-char* read_path(LV2_State_Map_Path* map_path, FILE* myfile)
-{
- /* Obviously this is not production quality code! */
- char abstract_path[1024];
- fscanf(myfile, "%s", abstract_path);
- return map_path->absolute_path(map_path->handle, abstract_path);
-}
-</pre>
-""" .
-
-state:makePath
- a lv2:Feature ;
- rdfs:label "create new file paths" ;
- lv2:documentation """
-<p>This feature allows plugins to create new files and/or directories. To
-support this feature the host passes an LV2_Feature with URI
-LV2_STATE__makePath and data pointed to an LV2_State_Make_Path to the plugin.
-The host may make this feature available only during save by passing it to
-LV2_State_Interface::save(), or available any time by passing it to
-LV2_Descriptor::instantiate(). If passed to LV2_State_Interface::save(), the
-feature MUST NOT be used beyond the scope of that call.</p>
-
-<p>The plugin is guaranteed a hierarchical namespace unique to that plugin
-instance, and may expect the returned path to have the requested path as a
-suffix. There is <em>one</em> such namespace, even if the feature is passed to
-both LV2_Descriptor::instantiate() <em>and</em> LV2_State_Interface::save().
-Beyond this, the plugin MUST NOT make any assumptions about the returned
-paths.</p>
-
-<p>Like any other paths, the plugin MUST map these paths using state:mapPath
-before storing them in state. The plugin MUST NOT assume these paths will be
-available across a save/restore otherwise, i.e. only mapped paths saved to
-state are persistent, any other created paths are temporary.</p>
-
-<p>For example, a plugin may create a file in a subdirectory like so:</p>
-
-<pre class="c-code">
-char* save_myfile(LV2_State_Make_Path* make_path)
-{
- char* path = make_path->path(make_path->handle, "foo/bar/myfile.txt");
- FILE* myfile = fopen(path, 'w');
- fprintf(myfile, "I am some data");
- fclose(myfile);
- return path;
-}
-</pre>
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/time/lv2-time.doap.ttl b/lv2/lv2plug.in/ns/ext/time/lv2-time.doap.ttl
deleted file mode 100644
index 2471415..0000000
--- a/lv2/lv2plug.in/ns/ext/time/lv2-time.doap.ttl
+++ /dev/null
@@ -1,33 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/time>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:name "LV2 Time" ;
- doap:shortdesc "Properties for describing time." ;
- doap:created "2011-10-05" ;
- doap:developer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "1.2" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Use consistent label style."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/time/time.h b/lv2/lv2plug.in/ns/ext/time/time.h
deleted file mode 100644
index 3bb0614..0000000
--- a/lv2/lv2plug.in/ns/ext/time/time.h
+++ /dev/null
@@ -1,49 +0,0 @@
-/*
- Copyright 2011 David Robillard <http://drobilla.net>
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-/**
- @file time.h C header for the LV2 Time extension
- <http://lv2plug.in/ns/ext/time>.
-*/
-
-#ifndef LV2_TIME_H
-#define LV2_TIME_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#define LV2_TIME_URI "http://lv2plug.in/ns/ext/time"
-
-#define LV2_TIME__Time LV2_TIME_URI "#Time"
-#define LV2_TIME__Position LV2_TIME_URI "#Position"
-#define LV2_TIME__Rate LV2_TIME_URI "#Rate"
-#define LV2_TIME__position LV2_TIME_URI "#position"
-#define LV2_TIME__barBeat LV2_TIME_URI "#barBeat"
-#define LV2_TIME__bar LV2_TIME_URI "#bar"
-#define LV2_TIME__beat LV2_TIME_URI "#beat"
-#define LV2_TIME__beatUnit LV2_TIME_URI "#beatUnit"
-#define LV2_TIME__beatsPerBar LV2_TIME_URI "#beatsPerBar"
-#define LV2_TIME__beatsPerMinute LV2_TIME_URI "#beatsPerMinute"
-#define LV2_TIME__frame LV2_TIME_URI "#frame"
-#define LV2_TIME__framesPerSecond LV2_TIME_URI "#framesPerSecond"
-#define LV2_TIME__speed LV2_TIME_URI "#speed"
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
-#endif /* LV2_TIME_H */
diff --git a/lv2/lv2plug.in/ns/ext/uri-map/uri-map.ttl b/lv2/lv2plug.in/ns/ext/uri-map/uri-map.ttl
deleted file mode 100644
index 7f6b0e7..0000000
--- a/lv2/lv2plug.in/ns/ext/uri-map/uri-map.ttl
+++ /dev/null
@@ -1,24 +0,0 @@
-@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 umap: <http://lv2plug.in/ns/ext/uri-map#> .
-
-<http://lv2plug.in/ns/ext/uri-map>
- a lv2:Feature ;
- owl:deprecated true ;
- rdfs:seeAlso <uri-map.h> ,
- <lv2-uri-map.doap.ttl> ;
- lv2:documentation """
-<p><span class="warning">This extension is deprecated.</span> New
-implementations should use <a href="../urid/urid.html">LV2 URID</a>
-instead.</p>
-
-<p>This extension defines a simple mechanism for plugins to map URIs to
-integers, usually for performance reasons (e.g. processing events typed by URIs
-in real time). The expected use case is for plugins to map URIs to integers
-for things they 'understand' at instantiation time, and store those values for
-use in the audio thread without doing any string comparison. This allows the
-extensibility of RDF with the performance of integers (or centrally defined
-enumerations).</p>
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/urid/lv2-urid.doap.ttl b/lv2/lv2plug.in/ns/ext/urid/lv2-urid.doap.ttl
deleted file mode 100644
index 99505e6..0000000
--- a/lv2/lv2plug.in/ns/ext/urid/lv2-urid.doap.ttl
+++ /dev/null
@@ -1,47 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/urid>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:license <http://opensource.org/licenses/isc> ;
- doap:name "LV2 URID" ;
- doap:shortdesc "Features for mapping URIs to and from integers." ;
- doap:created "2011-07-22" ;
- doap:developer <http://lv2plug.in/ns/meta#gabrbedd> ;
- doap:maintainer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "1.4" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Fix typo in urid:unmap documentation."
- ]
- ]
- ] , [
- doap:revision "1.2" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Add feature struct names."
- ] , [
- rdfs:label "Merge with unified LV2 package."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2011-11-21" ;
- doap:file-release <http://lv2plug.in/spec/lv2-urid-1.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/urid/urid.ttl b/lv2/lv2plug.in/ns/ext/urid/urid.ttl
deleted file mode 100644
index 29b196a..0000000
--- a/lv2/lv2plug.in/ns/ext/urid/urid.ttl
+++ /dev/null
@@ -1,39 +0,0 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-@prefix urid: <http://lv2plug.in/ns/ext/urid#> .
-
-<http://lv2plug.in/ns/ext/urid>
- a lv2:Specification ;
- rdfs:seeAlso <urid.h> ,
- <lv2-urid.doap.ttl> ;
- lv2:documentation """
-<p>This extension defines a simple mechanism for plugins to map URIs to and
-from integers, usually for performance reasons (e.g. processing events typed by
-URIs in real time). Typically, plugins map URIs to integers for things they
-"understand" at instantiation time, and store those values for use in the audio
-thread without doing any string comparison. This allows for the extensibility
-of RDF but with the performance of integers.</p>
-
-<p>This extension is intended as an improved and simplified replacement for the
-<a href="../uri-map/uri-map.html">uri-map</a> extension, since the <q>map</q>
-context parameter has been found problematic. This extension is functionally
-equivalent to the uri-map extension with a NULL context. New implementations
-are encouraged to use this extension for URI mapping.</p>
-""" .
-
-urid:map
- a lv2:Feature ;
- lv2:documentation """
-<p>A feature which is used to map URIs to integers. To support this feature,
-the host must pass an LV2_Feature to LV2_Descriptor::instantiate() with URI
-LV2_URID__map and data pointed to an instance of LV2_URID_Map.</p>
-""" .
-
-urid:unmap
- a lv2:Feature ;
- lv2:documentation """
-<p>A feature which is used to unmap URIs previously mapped to integers by
-urid:map. To support this feature, the host must pass an LV2_Feature to
-LV2_Descriptor::instantiate() with URI LV2_URID__unmap and data pointed to
-an instance of LV2_URID_Unmap.</p>
-""" .
diff --git a/lv2/lv2plug.in/ns/ext/worker/lv2-worker.doap.ttl b/lv2/lv2plug.in/ns/ext/worker/lv2-worker.doap.ttl
deleted file mode 100644
index 18acf5f..0000000
--- a/lv2/lv2plug.in/ns/ext/worker/lv2-worker.doap.ttl
+++ /dev/null
@@ -1,23 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/worker>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:name "LV2 Worker" ;
- doap:shortdesc "Support for a non-realtime plugin worker method." ;
- doap:created "2012-03-22" ;
- doap:developer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "1.0" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/ext/worker/worker.ttl b/lv2/lv2plug.in/ns/ext/worker/worker.ttl
deleted file mode 100644
index 8ab330d..0000000
--- a/lv2/lv2plug.in/ns/ext/worker/worker.ttl
+++ /dev/null
@@ -1,57 +0,0 @@
-@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 work: <http://lv2plug.in/ns/ext/worker#> .
-@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
-
-<http://lv2plug.in/ns/ext/worker>
- a owl:Ontology ;
- rdfs:seeAlso <worker.h> ,
- <lv2-worker.doap.ttl> ;
- lv2:documentation """
-<p>This extension allows plugins to have a non-realtime worker method, with
-thread sychronisation and communication issues handled by the host. This
-allows plugins to perform non-realtime actions (such as loading files) using a
-simple and portable API without having to worry about the complexities of
-multi-threading.</p>
-
-<p>Because the worker thread is implemented by the host, many plugins can share
-the same thread and communication buffers, which reduces bloat and fixed
-per-plugin buffer size limitations. The host has the power to implement
-threads in a suitable way, while plugins are simpler and thus less
-error-prone.</p>
-
-<p>This interface is designed to gracefully handle single-threaded synchronous
-execution, in which case the host may simply run all work immediately. This
-makes it possible for the same plugin code to work with sample accuracy for
-offline rendering, or in real-time with non-real-time work taking place in a
-separate thread.</p>
-""" .
-
-work:interface
- a lv2:ExtensionData ;
- lv2:documentation """
-<p>The interface provided by the plugin to implement a worker. To implement
-this extension, the plugin must return a valid LV2_Worker_Interface from
-LV2_Descriptor::extension_data() when it is called with URI
-LV2_WORKER__interface.</p>
-
-<p>The plugin data file should describe this like so:</p>
-<pre class="turtle-code">
-@prefix work: &lt;http://lv2plug.in/ns/ext/worker#&gt; .
-
-&lt;plugin&gt;
- a lv2:Plugin ;
- lv2:extensionData work:interface .
-</pre>
-""" .
-
-work:schedule
- a lv2:Feature ;
- lv2:documentation """
-<p>A feature which provides functions for use by the plugin to implement a
-worker method. To support this feature, the host must pass an LV2_Feature to
-LV2_Descriptor::instantiate() with URI LV2_WORKER__schedule and data pointed to
-an instance of LV2_Worker_Schedule.</p>
-""" .
diff --git a/lv2/lv2plug.in/ns/extensions/ui/lv2-ui.doap.ttl b/lv2/lv2plug.in/ns/extensions/ui/lv2-ui.doap.ttl
deleted file mode 100644
index 094fccc..0000000
--- a/lv2/lv2plug.in/ns/extensions/ui/lv2-ui.doap.ttl
+++ /dev/null
@@ -1,122 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/extensions/ui>
- a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
- doap:license <http://opensource.org/licenses/isc> ;
- doap:name "LV2 UI" ;
- doap:shortdesc "Generic UI interface for LV2 plugins." ;
- doap:created "2006-00-00" ;
- doap:developer <http://lv2plug.in/ns/meta#larsl> ;
- doap:maintainer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "2.15" ;
- doap:created "2013-10-08" ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Fix LV2_UI_INVALID_PORT_INDEX identifier in documentation."
- ]
- ]
- ] , [
- doap:revision "2.14" ;
- doap:created "2013-03-18" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.6.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Add idle interface so native UIs and foreign toolkits can drive their event loops."
- ] , [
- rdfs:label "Add ui:updateRate property."
- ]
- ]
- ] , [
- doap:revision "2.12" ;
- doap:created "2012-12-01" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Fix incorrect linker flag in ui:makeSONameResident documentation."
- ]
- ]
- ] , [
- doap:revision "2.10" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Add types for WindowsUI, CocoaUI, and Gtk3UI."
- ] , [
- rdfs:label "Use consistent label style."
- ] , [
- rdfs:label "Add missing LV2_SYMBOL_EXPORT declaration for lv2ui_descriptor prototype."
- ]
- ]
- ] , [
- doap:revision "2.8" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Add ui:parent and ui:resize."
- ] , [
- rdfs:label "Add support for referring to ports by symbol."
- ] , [
- rdfs:label "Add ui:portMap for accessing ports by symbol, allowing for UIs to be distributed separately from plugins."
- ] , [
- rdfs:label "Add port protocols and a dynamic notification subscription mechanism, for more flexible communication, and audio port metering without control port kludges."
- ] , [
- rdfs:label "Add touch feature to notify the host that the user has grabbed a control."
- ] , [
- rdfs:label "Merge with unified LV2 package."
- ]
- ]
- ] , [
- doap:revision "2.4" ;
- doap:created "2011-11-21" ;
- doap:file-release <http://lv2plug.in/spec/lv2-ui-2.4.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Deprecate ui:makeSONameResident."
- ] , [
- rdfs:label "Add Qt4 and X11 widget types."
- ] , [
- rdfs:label "Install header to URI-based system path."
- ] , [
- rdfs:label "Add pkg-config file."
- ] , [
- rdfs:label "Make ui.ttl a valid OWL 2 DL ontology."
- ]
- ]
- ] , [
- doap:revision "2.2" ;
- doap:created "2011-05-26" ;
- doap:file-release <http://lv2plug.in/spec/lv2-ui-2.2.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Add build system (for installation)."
- ] , [
- rdfs:label "Convert documentation to HTML and use lv2:documentation."
- ] , [
- rdfs:label "Use lv2:Specification to be discovered as an extension."
- ]
- ]
- ] , [
- doap:revision "2.0" ;
- doap:created "2010-10-06" ;
- doap:file-release <http://lv2plug.in/spec/lv2-ui-2.0.tar.gz> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/extensions/ui/ui.h b/lv2/lv2plug.in/ns/extensions/ui/ui.h
deleted file mode 100644
index b816581..0000000
--- a/lv2/lv2plug.in/ns/extensions/ui/ui.h
+++ /dev/null
@@ -1,408 +0,0 @@
-/*
- LV2 UI Extension
- Copyright 2009-2012 David Robillard <d@drobilla.net>
- Copyright 2006-2011 Lars Luthman <lars.luthman@gmail.com>
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-/**
- @file ui.h
- C header for the LV2 UI extension <http://lv2plug.in/ns/extensions/ui>.
-*/
-
-#ifndef LV2_UI_H
-#define LV2_UI_H
-
-#include <stdint.h>
-
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
-
-#define LV2_UI_URI "http://lv2plug.in/ns/extensions/ui"
-#define LV2_UI_PREFIX LV2_UI_URI "#"
-
-#define LV2_UI__CocoaUI LV2_UI_PREFIX "CocoaUI"
-#define LV2_UI__Gtk3UI LV2_UI_PREFIX "Gtk3UI"
-#define LV2_UI__GtkUI LV2_UI_PREFIX "GtkUI"
-#define LV2_UI__PortNotification LV2_UI_PREFIX "PortNotification"
-#define LV2_UI__Qt4UI LV2_UI_PREFIX "Qt4UI"
-#define LV2_UI__UI LV2_UI_PREFIX "UI"
-#define LV2_UI__WindowsUI LV2_UI_PREFIX "WindowsUI"
-#define LV2_UI__X11UI LV2_UI_PREFIX "X11UI"
-#define LV2_UI__binary LV2_UI_PREFIX "binary"
-#define LV2_UI__fixedSize LV2_UI_PREFIX "fixedSize"
-#define LV2_UI__idleInterface LV2_UI_PREFIX "idleInterface"
-#define LV2_UI__noUserResize LV2_UI_PREFIX "noUserResize"
-#define LV2_UI__notifyType LV2_UI_PREFIX "notifyType"
-#define LV2_UI__parent LV2_UI_PREFIX "parent"
-#define LV2_UI__plugin LV2_UI_PREFIX "plugin"
-#define LV2_UI__portIndex LV2_UI_PREFIX "portIndex"
-#define LV2_UI__portMap LV2_UI_PREFIX "portMap"
-#define LV2_UI__portNotification LV2_UI_PREFIX "portNotification"
-#define LV2_UI__portSubscribe LV2_UI_PREFIX "portSubscribe"
-#define LV2_UI__resize LV2_UI_PREFIX "resize"
-#define LV2_UI__touch LV2_UI_PREFIX "touch"
-#define LV2_UI__ui LV2_UI_PREFIX "ui"
-#define LV2_UI__updateRate LV2_UI_PREFIX "updateRate"
-
-/**
- The index returned by LV2_UI_Port_Port::port_index() for unknown ports.
-*/
-#define LV2UI_INVALID_PORT_INDEX ((uint32_t)-1)
-
-#ifdef __cplusplus
-extern "C" {
-#else
-# include <stdbool.h>
-#endif
-
-/**
- A pointer to some widget or other type of UI handle.
-
- The actual type is defined by the type of the UI.
-*/
-typedef void* LV2UI_Widget;
-
-/**
- A pointer to an instance of a UI.
-
- It is valid to compare this to NULL (0 for C++) but otherwise the host MUST
- not attempt to interpret it. The UI plugin may use it to reference internal
- instance data.
-*/
-typedef void* LV2UI_Handle;
-
-/**
- A pointer to a controller provided by the host.
-
- It is valid to compare this to NULL (0 for C++) but otherwise the UI plugin
- MUST NOT attempt to interpret it. The host may use it to reference internal
- instance data.
-*/
-typedef void* LV2UI_Controller;
-
-/**
- A pointer to opaque data for a feature.
-*/
-typedef void* LV2UI_Feature_Handle;
-
-/**
- The type of the host-provided function that the UI can use to
- send data to a plugin's input ports.
-
- The @p buffer parameter must point to a block of data, @c buffer_size bytes
- large. The format of this data and how the host should use it is defined by
- the @p port_protocol. This buffer is owned by the UI and is only valid for
- the duration of this call.
-
- The @p port_protocol parameter should either be 0 or the URID for a
- ui:PortProtocol. If it is 0, the protocol is implicitly ui:floatProtocol,
- the port must be an lv2:ControlPort input, @c buffer must point to a single
- float value, and @c buffer_size must be sizeof(float).
-
- The UI SHOULD NOT use a PortProtocol not supported by the host (i.e. one not
- passed by the host as a feature), but the host MUST gracefully ignore any
- port_protocol it does not understand.
-*/
-typedef void (*LV2UI_Write_Function)(LV2UI_Controller controller,
- uint32_t port_index,
- uint32_t buffer_size,
- uint32_t port_protocol,
- const void* buffer);
-
-/**
- The implementation of a UI.
-
- A pointer to an object of this type is returned by the lv2ui_descriptor()
- function.
-*/
-typedef struct _LV2UI_Descriptor {
- /**
- The URI for this UI (not for the plugin it controls).
- */
- const char* URI;
-
- /**
- Create a new UI object and return a handle to it. This function works
- similarly to the instantiate() member in LV2_Descriptor.
-
- @param descriptor The descriptor for the UI that you want to instantiate.
-
- @param plugin_uri The URI of the plugin that this UI will control.
-
- @param bundle_path The path to the bundle containing the RDF data file
- that references this shared object file, including the trailing '/'.
-
- @param write_function A function provided by the host that the UI can use
- to send data to the plugin's input ports.
-
- @param controller A handle for the plugin instance that should be passed
- as the first parameter of @p write_function.
-
- @param widget A pointer to an LV2UI_Widget. The UI will write a widget
- pointer to this location (what type of widget depends on the RDF class of
- the UI) that will be the main UI widget.
-
- @param features An array of LV2_Feature pointers. The host must pass all
- feature URIs that it and the UI supports and any additional data, just
- like in the LV2 plugin instantiate() function. Note that UI features and
- plugin features are NOT necessarily the same, they just share the same
- data structure - this will probably not be the same array as the one the
- plugin host passes to a plugin.
-
- */
- LV2UI_Handle (*instantiate)(const struct _LV2UI_Descriptor* descriptor,
- const char* plugin_uri,
- const char* bundle_path,
- LV2UI_Write_Function write_function,
- LV2UI_Controller controller,
- LV2UI_Widget* widget,
- const LV2_Feature* const* features);
-
-
- /**
- Destroy the UI object and the associated widget. The host must not try
- to access the widget after calling this function.
- */
- void (*cleanup)(LV2UI_Handle ui);
-
- /**
- Tell the UI that something interesting has happened at a plugin port.
-
- What is interesting and how it is written to the buffer passed to this
- function is defined by the @p format parameter, which has the same
- meaning as in LV2UI_Write_Function. The only exception is ports of the
- class lv2:ControlPort, for which this function should be called when the
- port value changes (it does not have to be called for every single change
- if the host's UI thread has problems keeping up with the thread the
- plugin is running in), @p buffer_size should be 4, the buffer should
- contain a single IEEE-754 float, and @p format should be 0.
-
- By default, the host should only call this function for input ports of
- the lv2:ControlPort class. However, this can be modified by using
- ui:portNotification in the UI data, or the ui:portSubscribe feature.
-
- The @p buffer is only valid during the time of this function call, so if
- the UI wants to keep it for later use it has to copy the contents to an
- internal buffer.
-
- This member may be set to NULL if the UI is not interested in any
- port events.
- */
- void (*port_event)(LV2UI_Handle ui,
- uint32_t port_index,
- uint32_t buffer_size,
- uint32_t format,
- const void* buffer);
-
- /**
- Return a data structure associated with an extension URI, for example
- a struct containing additional function pointers.
-
- Avoid returning function pointers directly since standard C/C++ has no
- valid way of casting a void* to a function pointer. This member may be set
- to NULL if the UI is not interested in supporting any extensions. This is
- similar to the extension_data() member in LV2_Descriptor.
- */
- const void* (*extension_data)(const char* uri);
-} LV2UI_Descriptor;
-
-/**
- UI Resize Feature (LV2_UI__resize)
-
- This structure may be used in two ways: as a feature passed by the host via
- LV2UI_Descriptor::instantiate(), or as extension data provided by a UI via
- LV2UI_Descriptor::extension_data()).
-*/
-typedef struct _LV2UI_Resize {
- /**
- Pointer to opaque data which must be passed to ui_resize().
- */
- LV2UI_Feature_Handle handle;
-
- /**
- Request or advertise a size change.
-
- When this struct is provided by the host, the UI may call this
- function to inform the host about the size of the UI.
-
- When this struct is provided by the UI, the host may call this
- function to notify the UI that it should change its size accordingly.
-
- @return 0 on success.
- */
- int (*ui_resize)(LV2UI_Feature_Handle handle, int width, int height);
-} LV2UI_Resize;
-
-/**
- Port Map Feature (LV2_UI__portMap).
-
- This feature can be used by the UI to get the index for a port with the
- given symbol. This makes it possible to implement and distribute a UI
- separately from the plugin (since symbol is a guaranteed stable port
- identifier while index is not).
-*/
-typedef struct _LV2UI_Port_Map {
- /**
- Pointer to opaque data which must be passed to ui_resize().
- */
- LV2UI_Feature_Handle handle;
-
- /**
- Get the index for the port with the given @p symbol.
-
- @return The index of the port, or LV2UI_INVALID_PORT_INDEX if no such
- port is found.
- */
- uint32_t (*port_index)(LV2UI_Feature_Handle handle, const char* symbol);
-} LV2UI_Port_Map;
-
-/**
- Port subscription feature (LV2_UI__portSubscribe);
-*/
-typedef struct _LV2UI_Port_Subscribe {
- /**
- Pointer to opaque data which must be passed to ui_resize().
- */
- LV2UI_Feature_Handle handle;
-
- /**
- Subscribe to updates for a port.
-
- This means that the host will call the UI's port_event() function when
- the port value changes (as defined by protocol).
-
- Calling this function with the same @p port_index and @p port_protocol
- as an already active subscription has no effect.
-
- @param handle The handle field of this struct.
- @param port_index The index of the port.
- @param port_protocol The URID of the ui:PortProtocol.
- @param features Features for this subscription.
- @return 0 on success.
- */
- uint32_t (*subscribe)(LV2UI_Feature_Handle handle,
- uint32_t port_index,
- uint32_t port_protocol,
- const LV2_Feature* const* features);
-
- /**
- Unsubscribe from updates for a port.
-
- This means that the host will cease calling calling port_event() when
- the port value changes.
-
- Calling this function with a @p port_index and @p port_protocol that
- does not refer to an active port subscription has no effect.
-
- @param handle The handle field of this struct.
- @param port_index The index of the port.
- @param port_protocol The URID of the ui:PortProtocol.
- @param features Features for this subscription.
- @return 0 on success.
- */
- uint32_t (*unsubscribe)(LV2UI_Feature_Handle handle,
- uint32_t port_index,
- uint32_t port_protocol,
- const LV2_Feature* const* features);
-} LV2UI_Port_Subscribe;
-
-/**
- A feature to notify the host the user has grabbed a UI control.
-*/
-typedef struct _LV2UI_Touch {
- /**
- Pointer to opaque data which must be passed to ui_resize().
- */
- LV2UI_Feature_Handle handle;
-
- /**
- Notify the host that a control has been grabbed or released.
-
- @param handle The handle field of this struct.
- @param port_index The index of the port associated with the control.
- @param grabbed If true, the control has been grabbed, otherwise the
- control has been released.
- */
- void (*touch)(LV2UI_Feature_Handle handle,
- uint32_t port_index,
- bool grabbed);
-} LV2UI_Touch;
-
-/**
- UI Idle Feature (LV2_UI__idle)
-
- This feature is an addition to the UI API that provides a callback for the
- host to call rapidly, e.g. to drive the idle callback of a toolkit.
-*/
-typedef struct _LV2UI_Idle_Interface {
- /**
- Run a single iteration of the UI's idle loop.
-
- This will be called "frequently" in the UI thread at a rate appropriate
- for a toolkit main loop. There are no precise timing guarantees.
-
- @return 0 on success, or anything else to stop being called.
- */
- int (*idle)(LV2UI_Handle ui);
-} LV2UI_Idle_Interface;
-
-/**
- Peak data for a slice of time, the update format for ui:peakProtocol.
-*/
-typedef struct _LV2UI_Peak_Data {
- /**
- The start of the measurement period. This is just a running counter
- that is only meaningful in comparison to previous values and must not be
- interpreted as an absolute time.
- */
- uint32_t period_start;
-
- /**
- The size of the measurement period, in the same units as period_start.
- */
- uint32_t period_size;
-
- /**
- The peak value for the measurement period. This should be the maximal
- value for abs(sample) over all the samples in the period.
- */
- float peak;
-} LV2UI_Peak_Data;
-
-/**
- A plugin UI programmer must include a function called "lv2ui_descriptor"
- with the following function prototype within the shared object file. This
- function will have C-style linkage (if you are using C++ this is taken care
- of by the 'extern "C"' clause at the top of the file). This function is
- loaded from the library by the UI host and called to get a
- LV2UI_Descriptor for the wanted plugin.
-
- Just like lv2_descriptor(), this function takes an index parameter. The
- index should only be used for enumeration and not as any sort of ID number -
- the host should just iterate from 0 and upwards until the function returns
- NULL or a descriptor with an URI matching the one the host is looking for.
-*/
-LV2_SYMBOL_EXPORT
-const LV2UI_Descriptor* lv2ui_descriptor(uint32_t index);
-
-/**
- The type of the lv2ui_descriptor() function.
-*/
-typedef const LV2UI_Descriptor* (*LV2UI_DescriptorFunction)(uint32_t index);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* LV2_UI_H */
diff --git a/lv2/lv2plug.in/ns/extensions/ui/ui.ttl b/lv2/lv2plug.in/ns/extensions/ui/ui.ttl
deleted file mode 100644
index 5ab029d..0000000
--- a/lv2/lv2plug.in/ns/extensions/ui/ui.ttl
+++ /dev/null
@@ -1,452 +0,0 @@
-@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 ui: <http://lv2plug.in/ns/extensions/ui#> .
-@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
-
-<http://lv2plug.in/ns/extensions/ui>
- a owl:Ontology ;
- owl:imports <http://lv2plug.in/ns/lv2core> ;
- rdfs:seeAlso <ui.h> ,
- <lv2-ui.doap.ttl> ;
- lv2:documentation """
-<p>This extension defines an interface that can be used in LV2 plugins and
-hosts to create UIs for plugins. The UIs are similar to plugins and reside in
-shared object files in an LV2 bundle. UIs are associated with a plugin in RDF
-using the triples:</p>
-
-<pre class="turtle-code">
-@prefix ui: &lt;http://lv2plug.in/ns/extensions/ui#&gt; .
-
-&lt;http://my.plugin&gt; ui:ui &lt;http://my.pluginui&gt; .
-&lt;http://my.pluginui&gt; a ui:GtkUI ;
- ui:binary &lt;myui.so&gt; .
-</pre>
-
-<p>where &lt;http://my.plugin&gt; is the URI of the plugin,
-&lt;http://my.pluginui&gt; is the URI of the plugin UI and &lt;myui.so&gt; is
-the relative URI to the shared object file.</p>
-
-<p>While it is possible to have the plugin UI and the plugin in the same shared
-object file it is probably a good idea to keep them separate so that hosts that
-don't want UIs don't have to load the UI code. A UI MUST specify its class in
-the RDF data (ui:GtkUI in the above example). The class defines what type the
-UI is, e.g. what graphics toolkit it uses. Any type of UI class can be defined
-separately from this extension.</p>
-
-<p>It is possible to have multiple UIs for the same plugin, or to have the UI
-for a plugin in a different bundle from the actual plugin - this way people
-other than the plugin author can write plugin UIs independently without editing
-the original plugin bundle.</p>
-
-<p>Note that the process that loads the shared object file containing the UI
-code and the process that loads the shared object file containing the actual
-plugin implementation are not necessarily the same process (and not even
-necessarily on the same machine). This means that plugin and UI code MUST NOT
-use singletons and global variables and expect them to refer to the same
-objects in the UI and the actual plugin. The function callback interface
-defined in this header is the only method of communication between UIs and
-plugin instances (extensions may define more, though this is discouraged unless
-absolutely necessary since the significant benefits of network transparency and
-serialisability are lost).</p>
-
-<p>UI functionality may be extended via features, much like plugins:</p>
-
-<pre class="turtle-code">
-&lt;http://my.pluginui&gt; lv2:requiredFeature &lt;http://my.feature&gt; .
-&lt;http://my.pluginui&gt; lv2:optionalFeature &lt;http://my.feature&gt; .
-</pre>
-
-<p>The rules for a UI with a required or optional feature are identical to
-those of lv2:Plugin instances: if a UI declares a feature as required, the host
-is NOT allowed to load it unless it supports that feature; and if it does
-support a feature, it MUST pass an appropriate LV2_Feature struct to the UI's
-instantiate() method. This extension defines several standard features for
-common functionality.</p>
-
-<p>UIs written to this specification do not need to be thread-safe. All
-functions may only be called in the <q>UI thread</q>. There is only one UI
-thread (for toolkits, the one the UI main loop runs in). There is no
-requirement that a <q>UI</q> actually be a graphical widget.</p>
-
-<p>Note that UIs are completely separate from plugins. From the plugin's
-perspective, control from a UI is indistinguishable from any other control, as
-it all occcurs via ports.</p>
-""" .
-
-ui:UI
- a rdfs:Class ,
- owl:Class ;
- rdfs:label "User Interface" ;
- rdfs:comment "A UI for an LV2 plugin" .
-
-ui:GtkUI
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf ui:UI ;
- rdfs:comment """
-A UI where the LV2_Widget is a pointer to a Gtk+ 2.0 compatible GtkWidget,
-and the host guarantees that the Gtk+ library has been initialised and the
-Glib main loop is running before a UI of this type is instantiated.""" .
-
-ui:Gtk3UI
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf ui:UI ;
- rdfs:comment """
-A UI where the LV2_Widget is a pointer to a Gtk+ 3.0 compatible GtkWidget,
-and the host guarantees that the Gtk+ library has been initialised and the
-Glib main loop is running before a UI of this type is instantiated.""" .
-
-ui:Qt4UI
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf ui:UI ;
- rdfs:comment """
-A UI where the LV2_Widget is a pointer to a Qt4 compatible QWidget,
-and the host guarantees that the Qt4 library has been initialised and the
-Qt4 main loop is running before a UI of this type is instantiated.""" .
-
-ui:X11UI
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf ui:UI ;
- rdfs:comment """
-A UI where the LV2_Widget is an X11 window ID. Note this is actually an
-integer, i.e. the LV2_Widget is not a pointer to an X11 window ID, but should
-be itself taken as an integer value. This is the native UI type on most POSIX
-systems.""" .
-
-ui:WindowsUI
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf ui:UI ;
- rdfs:comment """
-A UI where the LV2_Widget is a Windows HWND window ID. Note this is actually
-an unsigned 32-bit integer, i.e. the LV2_Widget is not a pointer to a HWND but
-should be interpreted as an HWND itself. This is the native UI type on
-Microsoft Windows.""" .
-
-ui:CocoaUI
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf ui:UI ;
- rdfs:comment """
-A UI where the LV2_Widget is a pointer to a NSView, the basic view type for the
-Cocoa API (formerly OpenStep). This is the native UI type on Mac OS X.""" .
-
-ui:ui
- a rdf:Property ;
- rdfs:domain lv2:Plugin ;
- rdfs:range ui:UI ;
- rdfs:comment """
-Relates a plugin to a UI that applies to it.
-""" .
-
-ui:binary
- a rdf:Property ;
- owl:sameAs lv2:binary ;
- owl:deprecated "true"^^xsd:boolean ;
- rdfs:comment """
-The shared library a UI resides in. This property is redundant, new UIs SHOULD
-use lv2:binary, however hosts MUST still support ui:binary at this time.
-""" .
-
-ui:makeSONameResident
- a lv2:Feature ;
- owl:deprecated "true"^^xsd:boolean ;
- lv2:documentation """
-<p>DEPRECATED</p>
-
-<p>This feature was intended to support UIs that link against toolkit
-libraries which may not be unloaded during the lifetime of the host.
-This is better achieved by using the appropriate flags when linking the
-UI, e.g. <code>gcc -Wl,-z,nodelete</code>.</p>
-""" .
-
-ui:noUserResize
- a lv2:Feature ;
- lv2:documentation """
-<p>If a UI requires this feature it indicates that it does not make sense
-to let the user resize the main widget, and the host should prevent that.
-This feature may not make sense for all UI types. The data pointer for the
-LV2_Feature for this feature should always be set to NULL.</p>
-""" .
-
-ui:fixedSize
- a lv2:Feature ;
- lv2:documentation """
-<p>If a UI requires this feature it indicates the same thing as
-ui:noUserResize, and additionally it means that the UI will not resize
-the main widget on its own - it will always remain the same size (e.g. a
-pixmap based GUI). This feature may not make sense for all UI types.
-The data pointer for the LV2_Feature for this feature should always be set
-to NULL.</p>
-""" .
-
-ui:parent
- a lv2:Feature ;
- lv2:documentation """
-<p>The parent for the UI.</p>
-
-<p>This feature can be used to pass a parent (e.g. a widget, container, canvas,
-etc.) the UI should be a child of. The format of data pointer of this feature
-is determined by the UI type, and is generally the same type as the LV2_Widget
-the UI would return (e.g. for a GtkUI the data would be a pointer to a
-GtkWidget which is a GtkContainer). This is particularly useful for
-cross-toolkit embedding, where the parent often must be known at construction
-time for embedding to work correctly. UIs should not require this feature
-unless it is absolutely necessary for them to work at all.</p>
-""" .
-
-ui:PortNotification
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf [
- a owl:Restriction ;
- owl:onProperty ui:plugin ;
- owl:someValuesFrom lv2:Plugin ;
- owl:cardinality 1 ;
- rdfs:comment """
-A PortNotification MUST have exactly one ui:plugin which is a lv2:Plugin.
-"""
- ] ;
- lv2:documentation """
-<p>A port notification. This describes which ports the host must send
-notifications to the UI about. The port can be specific by index, using the
-ui:portIndex property, or symbol, using the lv2:symbol property. Since port
-indices are not guaranteed to be stable between different revisions (or even
-instantiations) of a plugin, symbol is recommended, and index may only be used
-by UIs shipped in the same bundle as the plugin.</p>
-
-<p>A ui:PortNotification MUST have either a ui:portIndex or a lv2:symbol to
-indicate which port it refers to.</p>
-""" .
-
-ui:portNotification
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:domain ui:UI ;
- rdfs:range ui:PortNotification ;
- lv2:documentation """
-<p>Indicates that a UI should receive notification (via
-LV2UI_Descriptor::port_event()) when a particular port's value changes.</p>
-
-<p>For example:</p>
-<pre class="turtle-code">
-eg:ui
- a ui:GtkUI ;
- ui:portNotification [
- ui:plugin eg:plugin ;
- lv2:symbol "gain" ;
- ui:protocol ui:floatProtocol
- ] .
-</pre>
-""" .
-
-ui:plugin
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:domain ui:PortNotification ;
- rdfs:range lv2:Plugin ;
- rdfs:comment """
-The plugin a portNotification applies to.
-""" .
-
-ui:portIndex
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:domain ui:PortNotification ;
- rdfs:range xsd:decimal ;
- rdfs:comment """
-The index of the port a portNotification applies to.
-""" .
-
-ui:notifyType
- a rdf:Property ;
- rdfs:domain ui:PortNotification ;
- lv2:documentation """
-<p>Indicates a particular type that the UI should be notified of. In the case
-of ports where several types of data can be present (e.g. event ports), this
-can be used to indicate that only a particular type of data should cause
-notification. This is useful where port traffic is very dense, but only a
-certain small number of events are actually of interest to the UI.</p>
-""" .
-
-ui:resize
- a lv2:Feature ;
- lv2:documentation """
-<p>A feature that allows the UI to notify the host about its current size, or
-request a size change. This feature corresponds to the LV2UI_Resize struct,
-which should be passed with the URI LV2_UI__resize. This struct may also be
-provided by the UI as extension data using the same URI, in which case it is
-used by the host to request that the UI change its size.</p>
-""" .
-
-ui:portMap
- a lv2:Feature ;
- lv2:documentation """
-<p>A feature for accessing the index of a port by symbol. This makes it
-possible to implement and distribute UIs separately from the plugin binaries
-they control. This feature corresponds to the LV2UI_Port_Index struct, which
-should be passed with the URI LV2_UI__portIndex.</p>
-""" .
-
-ui:portSubscribe
- a lv2:Feature ;
- lv2:documentation """
-<p>A feature for dynamically subscribing to updates from a port. This makes it
-possible for a UI to explicitly request a particular style of update from a
-port at run-time, in a more flexible and powerful way than listing
-subscriptions statically allows. This feature corresponds to the
-LV2UI_Port_Subscribe struct, which should be passed with the URI
-LV2_UI__portSubscribe.</p>
-""" .
-
-ui:touch
- a lv2:Feature ;
- lv2:documentation """
-<p>A feature to notify the host that the user has grabbed a particular port
-control. This is useful for automation, so the host can allow the user to take
-control of a port, even if that port would otherwise be automated (much like
-grabbing a physical morotised fader). It can also be used for MIDI learn or in
-any other situation where the host needs to do something with a particular
-control and it would be convenient for the user to select it directly from the
-plugin UI. This feature corresponds to the LV2UI_Touch struct, which
-should be passed with the URI LV2_UI__touch.</p>
-""" .
-
-ui:idleInterface
- a lv2:Feature ,
- lv2:ExtensionData ;
- lv2:documentation """
-<p>A feature that provides a callback for the host to call rapidly to drive the
-UI. To support this feature, the UI should list it as a lv2:optionalFeature or
-lv2:requiredFeature in its data, and also as lv2:extensionData. When the UI's
-extension_data() is called with this URI (LV2_UI__idleInterface), it should
-return a pointer to an LV2_UI_Idle_Interface.</p>
-
-<p>To indicate support, the host should pass a feature to instantiate() with
-this URI, with NULL for data.</p>
-""" .
-
-ui:updateRate
- a rdf:Property ;
- rdfs:range xsd:float ;
- rdfs:comment "The target rate, in Hz, to send updates to the UI." .
-
-ui:protocol
- a rdf:Property ;
- rdfs:domain ui:PortNotification ;
- rdfs:range ui:PortProtocol ;
- rdfs:comment "The protocol to be used for this notification." .
-
-ui:PortProtocol
- a rdfs:Class ;
- rdfs:subClassOf lv2:Feature ;
- rdfs:label "Port Protocol" ;
- lv2:documentation """
-<p>A PortProtocol defines a method to communicate port data between a UI and
-plugin.</p>
-
-<p>Any PortProtocol MUST define:</p>
-<table>
-<tr><th>Port Type</th>
- <td>Which plugin port types the buffer type is valid for.</td></tr>
-<tr><th>Feature Data</th>
- <td>What data (if any) should be passed in the LV2_Feature.</td></tr>
-</table>
-
-<p>Any PortProtocol for an output port MUST define:</p>
-<table>
-<tr><th>Update Frequency</th>
- <td>When the host should call port_event().</td></tr>
-<tr><th>Update Format</th>
- <td>The format of the data in the buffer passed to port_event().</td></tr>
-<tr><th>Options</th>
- <td>The format of the options passed to subscribe() and unsubscribe().</td>
-</tr></table>
-
-<p>Any PortProtocol for an input port MUST define:</p>
-<table>
-<tr><th>Write Format</th>
- <td>The format of the data in the buffer passed to write_port().</td></tr>
-<tr><th>Write Effect</th>
- <td>What happens when the UI calls write_port().</td></tr>
-</table>
-
-<p>For an example, see ui:floatProtocol or ui:peakProtocol.
-</p>
-
-<p>PortProtocol is a subclass of lv2:Feature, so UIs use lv2:optionalFeature and
-lv2:requiredFeature to specify which PortProtocols they want to use.
-</p>
-""" .
-
-ui:floatProtocol
- a ui:PortProtocol ;
- rdfs:label "floating point value" ;
- lv2:documentation """
-
-<p>A protocol for transferring single floating point values. The rules for
-this protocol are:</p>
-<table>
-<tr><th>Port Type</th>
- <td>lv2:ControlPort</td></tr>
-<tr><th>Feature Data</th>
- <td>None.</td></tr>
-<tr><th>Update Frequency</th>
- <td>The host SHOULD call port_event() as soon as possible when the port
- value has changed, but there are no timing guarantees.</td></tr>
-<tr><th>Update Format</th>
- <td>A single <code>float</code>.</td></tr>
-<tr><th>Options</th>
- <td>None.</td></tr>
-<tr><th>Write Format</th>
- <td>A single <code>float</code>.</td></tr>
-<tr><th>Write Effect</th>
- <td>The host SHOULD set the port to the received value as soon as possible,
- but there is no guarantee that run() actually sees this value.</td></tr>
-</table>
-""" .
-
-ui:peakProtocol
- a ui:PortProtocol ;
- rdfs:label "peak measurement for a period of audio" ;
- lv2:documentation """
-<p>This port protocol defines a way for the host to send continuous peak
-measurements of the audio signal at a certain port to the UI. The
-intended use is visualisation, e.g. an animated meter widget that shows
-the level of the audio input or output.</p>
-
-<p>A contiguous sequence of audio samples for which a peak value has been
-computed is called a <em>measurement period</em>.</p>
-
-<p>The rules for this protocol are:</p>
-<table>
-<tr><th>Port Type</th>
- <td>lv2:AudioPort</td></tr>
-<tr><th>Feature Data</th>
- <td>None.</td></tr>
-<tr><th>Update Frequency</th>
- <td>The host SHOULD call port_event() at regular intervals. The
- measurement periods used for calls to port_event() for the same port SHOULD
- be contiguous (i.e. the measurement period for one call should begin right
- after the end of the measurement period for the previous call ends) unless
- the UI has removed and re-added the port subscription between those calls.
- However, UIs MUST NOT depend on either the regularity of the calls or the
- contiguity of the measurement periods; hosts may change the call rate or
- skip calls for performance or other reasons. Measurement periods for
- different calls to port_event() for the same port MUST NOT
- overlap.</td></tr>
-<tr><th>Update Format</th>
- <td>A single LV2UI_Peak_Data object.</td></tr>
-<tr><th>Options</th>
- <td>None.</td></tr>
-<tr><th>Write Format</th>
- <td>None.</td></tr>
-<tr><th>Write Effect</th>
- <td>None.</td></tr>
-</table>
-""" .
diff --git a/lv2/lv2plug.in/ns/extensions/units/units.h b/lv2/lv2plug.in/ns/extensions/units/units.h
deleted file mode 100644
index a40f097..0000000
--- a/lv2/lv2plug.in/ns/extensions/units/units.h
+++ /dev/null
@@ -1,62 +0,0 @@
-/*
- Copyright 2012 David Robillard <http://drobilla.net>
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-/**
- @file units.h
- C definitions for the LV2 Units extension
- <http://lv2plug.in/ns/extensions/units>.
-*/
-
-#ifndef LV2_UNITS_H
-#define LV2_UNITS_H
-
-#define LV2_UNITS_URI "http://lv2plug.in/ns/extensions/units"
-#define LV2_UNITS_PREFIX LV2_UNITS_URI "#"
-
-#define LV2_UNITS__Conversion LV2_UNITS_PREFIX "Conversion"
-#define LV2_UNITS__Unit LV2_UNITS_PREFIX "Unit"
-#define LV2_UNITS__bar LV2_UNITS_PREFIX "bar"
-#define LV2_UNITS__beat LV2_UNITS_PREFIX "beat"
-#define LV2_UNITS__bpm LV2_UNITS_PREFIX "bpm"
-#define LV2_UNITS__cent LV2_UNITS_PREFIX "cent"
-#define LV2_UNITS__cm LV2_UNITS_PREFIX "cm"
-#define LV2_UNITS__coef LV2_UNITS_PREFIX "coef"
-#define LV2_UNITS__conversion LV2_UNITS_PREFIX "conversion"
-#define LV2_UNITS__db LV2_UNITS_PREFIX "db"
-#define LV2_UNITS__degree LV2_UNITS_PREFIX "degree"
-#define LV2_UNITS__frame LV2_UNITS_PREFIX "frame"
-#define LV2_UNITS__hz LV2_UNITS_PREFIX "hz"
-#define LV2_UNITS__inch LV2_UNITS_PREFIX "inch"
-#define LV2_UNITS__khz LV2_UNITS_PREFIX "khz"
-#define LV2_UNITS__km LV2_UNITS_PREFIX "km"
-#define LV2_UNITS__m LV2_UNITS_PREFIX "m"
-#define LV2_UNITS__mhz LV2_UNITS_PREFIX "mhz"
-#define LV2_UNITS__midiNote LV2_UNITS_PREFIX "midiNote"
-#define LV2_UNITS__mile LV2_UNITS_PREFIX "mile"
-#define LV2_UNITS__min LV2_UNITS_PREFIX "min"
-#define LV2_UNITS__mm LV2_UNITS_PREFIX "mm"
-#define LV2_UNITS__ms LV2_UNITS_PREFIX "ms"
-#define LV2_UNITS__name LV2_UNITS_PREFIX "name"
-#define LV2_UNITS__oct LV2_UNITS_PREFIX "oct"
-#define LV2_UNITS__pc LV2_UNITS_PREFIX "pc"
-#define LV2_UNITS__prefixConversion LV2_UNITS_PREFIX "prefixConversion"
-#define LV2_UNITS__render LV2_UNITS_PREFIX "render"
-#define LV2_UNITS__s LV2_UNITS_PREFIX "s"
-#define LV2_UNITS__semitone12TET LV2_UNITS_PREFIX "semitone12TET"
-#define LV2_UNITS__symbol LV2_UNITS_PREFIX "symbol"
-#define LV2_UNITS__unit LV2_UNITS_PREFIX "unit"
-
-#endif /* LV2_UNITS_H */
diff --git a/lv2/lv2plug.in/ns/index.html.in b/lv2/lv2plug.in/ns/index.html.in
deleted file mode 100644
index 2134e44..0000000
--- a/lv2/lv2plug.in/ns/index.html.in
+++ /dev/null
@@ -1,28 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN"
- "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <title>LV2 Specifications</title>
- <meta http-equiv="Content-Type"
- content="application/xhtml+xml;charset=utf-8" />
- <link rel="stylesheet" type="text/css"
- href="../aux/style.css" />
- </head>
- <body>
- <div id="header">
- <h1 id="title">LV2 @LV2_VERSION@ Specifications</h1>
- </div>
- <div class="content">
- <table summary="An index of LV2 specifications">
- <tr>
- <th>Name</th>
- <th>Description</th>
- <th>Version</th>
- <th>Status</th>
- </tr>
-@ROWS@
- </table>
- </div>
- </body>
-</html>
diff --git a/lv2/lv2plug.in/ns/lv2core/README b/lv2/lv2plug.in/ns/lv2core/README
deleted file mode 100644
index f49513f..0000000
--- a/lv2/lv2plug.in/ns/lv2core/README
+++ /dev/null
@@ -1,42 +0,0 @@
-LV2
-===
-
-LV2 gives programmers the ability to write audio processors (or "plugins") in
-C/C++ which can be dynamically loaded into a range of applications (or
-"hosts").
-
-This core specification is deliberately as short and simple as possible, but is
-designed so that extensions can be defined to add more advanced features.
-
-More information about LV2 can be found at <http://lv2plug.in>.
-
-
-Using LV2
----------
-
-Applications that use LV2 plugins should depend on this package. It includes a
-header, LV2 bundle, and a pkg-config file. To compile against LV2, build
-scripts should check for the pkg-config package "lv2core", or simply check for
-the header "lv2/lv2plug.in/ns/lv2core/lv2.h".
-
-The appropriate C include for LV2 specifications is based on their URI, e.g.:
-
- #include "lv2/lv2plug.in/ns/lv2core/lv2.h"
-
-Is how code should include the header "lv2.h" in this bundle, which defines the
-specification with URI "http://lv2plug.in/ns/lv2core". Other specifications
-should follow this convention, e.g. the correct way to include the header
-"foo.h" in the extension "http://example.org/foo" is:
-
- #include "lv2/example.org/foo/foo.h"
-
-
-Packaging
----------
-
-Please package these components in a single package (i.e. do not split the
-headers, data, and program into separate packages). This package, in its
-entirety, is a build and run time dependency of any code that uses LV2.
-Distributions are encouraged to include it with package name "lv2core".
-
- -- David Robillard <d@drobilla.net>
diff --git a/lv2/lv2plug.in/ns/lv2core/lv2core.doap.ttl b/lv2/lv2plug.in/ns/lv2core/lv2core.doap.ttl
deleted file mode 100644
index 0c3df5c..0000000
--- a/lv2/lv2plug.in/ns/lv2core/lv2core.doap.ttl
+++ /dev/null
@@ -1,146 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/lv2core>
- a doap:Project ;
- rdfs:seeAlso <../meta/meta.ttl> ;
- doap:license <http://opensource.org/licenses/isc> ;
- doap:name "LV2" ;
- doap:homepage <http://lv2plug.in> ;
- doap:created "2004-04-21" ;
- doap:shortdesc "An audio plugin interface specification." ;
- doap:programming-language "C" ;
- doap:developer <http://plugin.org.uk/swh.xrdf#me> ,
- <http://drobilla.net/drobilla#me> ;
- doap:maintainer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "10.0" ;
- doap:created "2013-02-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Add lv2:EnvelopePlugin class."
- ] , [
- rdfs:label "Add lv2:control for designating primary event-based control ports."
- ] , [
- rdfs:label "Set range of lv2:designation to lv2:Designation."
- ] , [
- rdfs:label "Make lv2:Parameter rdfs:subClassOf rdf:Property."
- ] , [
- rdfs:label "Reserve minor version 0 for unstable development plugins."
- ]
- ]
- ] , [
- doap:revision "8.2" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Use consistent label style."
- ]
- ]
- ] , [
- doap:revision "8.0" ;
- doap:created "2012-04-17" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Fix LV2_SYMBOL_EXPORT and lv2_descriptor prototype for Windows."
- ] , [
- rdfs:label "Add metadata concept of a designation, a channel or parameter description which can be assigned to ports for more intelligent use by hosts."
- ] , [
- rdfs:label "Add new discovery API which allows libraries to read bundle files during discovery, makes library construction/destruction explicit, and adds extensibility to prevent future breakage."
- ] , [
- rdfs:label "Relax the range of lv2:index so it can be used for things other than ports."
- ] , [
- rdfs:label "Remove lv2:Resource, which turned out to be meaningless."
- ] , [
- rdfs:label "Add lv2:CVPort."
- ] , [
- rdfs:label "Merge with unified LV2 package."
- ]
- ]
- ] , [
- doap:revision "6.0" ;
- doap:created "2011-11-21" ;
- doap:file-release <http://lv2plug.in/spec/lv2core-6.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Rename core.lv2 and lv2.ttl to lv2core.lv2 and lv2core.ttl to adhere to modern conventions."
- ] , [
- rdfs:label "Add lv2:extensionData and lv2:ExtensionData for plugins to indicate that they support some URI for extension_data()."
- ] , [
- rdfs:label "Remove lv2config in favour of the simple convention that specifications install headers to standard URI-based paths."
- ] , [
- rdfs:label "Switch to the ISC license, a simple BSD-style license (with permission of all contributors to lv2.h and its ancestor, ladspa.h)."
- ] , [
- rdfs:label "Make lv2core.ttl a valid OWL 2 DL ontology."
- ] , [
- rdfs:label "Improve documentation."
- ]
- ]
- ] , [
- doap:revision "4.0" ;
- doap:created "2011-03-18" ;
- doap:file-release <http://lv2plug.in/spec/lv2core-4.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Make doap:license suggested, but not required (for wrappers)."
- ] , [
- rdfs:label "Define lv2:binary (MUST be in manifest.ttl)."
- ] , [
- rdfs:label "Define lv2:minorVersion and lv2:microVersion (MUST be in manifest.ttl)."
- ] , [
- rdfs:label "Define lv2:documentation and use it to document lv2core."
- ] , [
- rdfs:label "Add lv2:FunctionPlugin and lv2:ConstantPlugin classes."
- ] , [
- rdfs:label "Move lv2:AmplifierPlugin under lv2:DynamicsPlugin."
- ] , [
- rdfs:label "Loosen domain of lv2:optionalFeature and lv2:requiredFeature (to allow re-use in extensions)."
- ] , [
- rdfs:label "Add generic lv2:Resource and lv2:PluginBase classes."
- ] , [
- rdfs:label "Fix definition of lv2:minimum etc. (used for values, not scale points)."
- ] , [
- rdfs:label "More precisely define properties with OWL."
- ] , [
- rdfs:label "Move project metadata to manifest."
- ] , [
- rdfs:label "Add lv2:enumeration port property."
- ] , [
- rdfs:label "Define run() pre-roll special case (sample_count == 0)."
- ]
- ]
- ] , [
- doap:revision "3.0" ;
- doap:created "2008-11-08" ;
- doap:file-release <http://lv2plug.in/spec/lv2core-3.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Require that serialisations refer to ports by symbol rather than index."
- ] , [
- rdfs:label "Minor stylistic changes to lv2.ttl."
- ] , [
- rdfs:label "No header changes."
- ]
- ]
- ] , [
- doap:revision "2.0" ;
- doap:created "2008-02-10" ;
- doap:file-release <http://lv2plug.in/spec/lv2core-2.0.tar.gz> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] .
diff --git a/lv2/lv2plug.in/ns/lv2core/lv2core.pc.in b/lv2/lv2plug.in/ns/lv2core/lv2core.pc.in
deleted file mode 100644
index 96e5169..0000000
--- a/lv2/lv2plug.in/ns/lv2core/lv2core.pc.in
+++ /dev/null
@@ -1,10 +0,0 @@
-prefix=@PREFIX@
-exec_prefix=@EXEC_PREFIX@
-libdir=@LIBDIR@
-includedir=@INCLUDEDIR@
-
-Name: lv2core
-Version: @LV2CORE_VERSION@
-Description: An audio plugin interface specification.
-Libs:
-Cflags: -I${includedir}
diff --git a/lv2/lv2plug.in/ns/lv2core/lv2core.ttl b/lv2/lv2plug.in/ns/lv2core/lv2core.ttl
deleted file mode 100644
index dba01ca..0000000
--- a/lv2/lv2plug.in/ns/lv2core/lv2core.ttl
+++ /dev/null
@@ -1,1083 +0,0 @@
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@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 xsd: <http://www.w3.org/2001/XMLSchema#> .
-
-lv2:Specification
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf doap:Project ;
- lv2:documentation """
-<p>An LV2 specification (i.e. this specification, or an LV2 extension).</p>
-
-<p>Specification data, like plugin data, is distributed in bundles
-so hosts may discover <em>all</em> present LV2 data.</p>
-""" .
-
-lv2:documentation
- a rdf:Property ,
- owl:AnnotationProperty ;
- rdfs:range rdfs:Literal ;
- rdfs:label "documentation" ;
- rdfs:seeAlso <http://www.w3.org/TR/xhtml-basic/> ;
- lv2:documentation """
-<p>Relates a Resource to documentation markup. The value of this property
-MUST be a string literal which is a valid XHTML Basic 1.1 fragment suitable
-for use as the content of the &lt;body&gt; element. This can be used by
-hosts to provide rich online documentation or by tools to generate external
-documentation pages. The standard language tagging facility of RDF can be
-used to provide multi-lingual documentation.</p>
-<p>XHTML Basic is a W3C Recommendation which defines a basic subset of XHTML
-intended to be reasonable to implement with limited resources (e.g. on embedded
-devices). See <a href="http://www.w3.org/TR/xhtml-basic/#s_xhtmlmodules"
->XHTML Basic, Section 3</a> for a list of legal tags.</p>
-""" .
-
-<http://lv2plug.in/ns/lv2core>
- a owl:Ontology ;
- rdfs:seeAlso <lv2.h> ,
- <lv2core.doap.ttl> ,
- <../meta/meta.ttl> ;
- lv2:documentation """
-<p>LV2 is an interface for writing audio processors, or <q>plugins</q>, in
-C/C++ which can be dynamically loaded into many applications, or <q>hosts</q>.
-This <q>core</q> specification is simple and minimal, but is designed so that
-<q>extensions</q> can be defined to add more advanced features, making it
-possibly to implement nearly any feature imaginable.</p>
-
-<p>LV2 maintains a strong distinction between <q>code</q> and <q>data</q>.
-Plugin code is in a shared library, while data is in a companion data file
-written in <a href="http://www.w3.org/TeamSubmission/turtle/">Turtle</a>.
-Code, data, and any other resources (e.g. waveforms) are shipped together in a
-<q>bundle</q> directory. The code contains only the executable portions of the
-plugin which inherently <em>must</em> be written in code. All other data is
-provided in the data file(s). This makes plugin data flexible and extensible,
-and allows the host to do everything but run the plugin without loading or
-executing any code. Among other advantages, this makes hosts more robust
-(broken plugins can't crash a host during discovery) and allows generic tools
-and non-C programs to work with LV2 data. LV2 itself and extensions are
-distributed in a similar way.</p>
-
-<p>An LV2 plugin library is suitable for dynamic loading (e.g. via
-<code>dlopen()</code>) and provides one or more plugin descriptors via the
-<code>lv2_descriptor()</code> function. These can be instantiated to create
-plugin <q>instances</q>, which can be run directly on data or connected
-together to perform advanced signal processing tasks.</p>
-
-<p>Plugins communicate via <q>ports</q>, which can transmit any type of data.
-Data is processed by first <q>connecting</q> each port to a buffer, then
-repeatedly calling a plugin's <code>run()</code> method to process blocks of
-data.</p>
-
-<p>This core specification defines two types of port, equivalent to those in <a
-href="http://www.ladspa.org/">LADSPA</a>: lv2:ControlPort and lv2:AudioPort.
-Audio ports contain arrays with one <code>float</code> element per sample,
-allowing a block of audio to be processed in a single call to
-<code>run()</code>. Control ports contain single <code>float</code> values,
-which are fixed and valid for the duration of the call to <code>run()</code>.
-Thus the <q>control rate</q> is determined by the block size, which is
-controlled by the host (and not necessarily constant).</p>
-
-<h3>Threading Rules</h3>
-
-<p>To faciliate use in multi-threaded programs, LV2 functions are partitioned
-into several threading classes:</p>
-
-<table>
-<tr><th>Discovery Class</th>
- <th>Instantiation Class</th>
- <th>Audio Class</th></tr>
-<tr><td>lv2_descriptor()</td>
- <td>LV2_Descriptor::instantiate()</td>
- <td>LV2_Descriptor::run()</td></tr>
-<tr><td>LV2_Descriptor::extension_data()</td>
- <td>LV2_Descriptor::cleanup()</td>
- <td>LV2_Descriptor::connect_port()</td></tr>
-<tr><td></td><td>LV2_Descriptor::activate()</td><td></td></tr>
-<tr><td></td><td>LV2_Descriptor::deactivate()</td><td></td></tr>
-</table>
-
-<p>The rules that hosts MUST follow are:</p>
-<ul>
-<li>When any function is running for a plugin instance,
-no other function in the same class may run for that instance.</li>
-<li>When a <em>Discovery</em> function is running,
-no other functions in the same shared object file may run.</li>
-<li>When an <em>Instantiation</em> function is running for a plugin instance,
-no other functions for that instance may run.</li>
-</ul>
-
-<p>Any simultaneous calls that are not explicitly forbidden by these rules are
-allowed. For example, a host may call <code>run()</code> for two different
-plugin instances simultaneously.</p>
-
-<p>Plugin functions in any class MUST NOT manipulate any state which might
-affect other plugin or host code, e.g. by using non-reentrant global
-functions.</p>
-
-<p>Extensions to this specification which add new functions MUST declare in
-which of these classes the functions belong, define new classes for them, or
-otherwise precisely describe their threading rules.</p>
-""" .
-
-lv2:PluginBase
- a rdfs:Class ,
- owl:Class ;
- lv2:documentation """
-<p>An abstract plugin-like resource that MAY not actually be an LV2 plugin
-(e.g. may not actually have a plugin binary).</p>
-
-<p>PluginBase SHOULD be used as a base type for any resource that may have
-ports or otherwise mimic the structure of a Plugin (e.g. a preset), since
-hosts and other tools already <q>understand</q> this structure.</p>
-""" .
-
-lv2:Plugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:PluginBase ;
- rdfs:label "Plugin" ;
- rdfs:subClassOf [
- a owl:Restriction ;
- owl:onProperty doap:name ;
- owl:someValuesFrom rdf:PlainLiteral ;
- rdfs:comment """
-A Plugin MUST have at least one doap:name that is a string
-with no language tag.
-"""
- ] ;
- lv2:documentation """
-<p>The class which represents an LV2 plugin.</p>
-
-<p>To be discovered by hosts, plugins MUST explicitly have rdf:type lv2:Plugin
-listed in their bundle's manifest, e.g.:</p>
-<pre class="turtle-code">
-&lt;http://example.org/my-plugin&gt; a lv2:Plugin .
-</pre>
-
-<p>Plugins SHOULD have a doap:license property whenever possible. The doap:name
-property should be at most a few words in length using title capitalization,
-e.g. <q>Tape Delay Unit</q>. Use doap:shortdesc or doap:description for more
-detailed descriptions.</p>
-""" .
-
-lv2:Port
- a rdfs:Class ,
- owl:Class ;
- rdfs:label "Port" ;
- rdfs:subClassOf [
- a owl:Restriction ;
- owl:onProperty lv2:index ;
- owl:allValuesFrom xsd:unsignedInt ;
- owl:cardinality 1 ;
- rdfs:comment """
-A port MUST have a single lv2:index which is of type xsd:unsignedInt. The
-explicit RDF datatype of the index MAY be something else (typically xsd:integer
-for pretty Turtle numeric literals), but the value itself MUST be a valid
-xsd:unsignedInt (i.e. a non-negative 32-bit integer).
-"""
- ] , [
- a owl:Restriction ;
- owl:onProperty lv2:symbol ;
- owl:allValuesFrom rdf:PlainLiteral ;
- owl:cardinality 1 ;
- rdfs:comment """
-A port MUST have a single lv2:symbol which is of type xsd:string with no
-language tag.
-"""
- ] , [
- a owl:Restriction ;
- owl:onProperty lv2:name ;
- owl:someValuesFrom xsd:string ;
- rdfs:comment """
-A port MUST have at least one lv2:name which is of type xsd:string.
-"""
- ] ;
- lv2:documentation """
-<p>The class which represents an LV2 port.</p>
-
-<p>All LV2 port descriptions MUST have a rdf:type that is one of lv2:Port
-lv2:InputPort or lv2:OutputPort. Additionally there MUST be at least one other
-rdf:type which more precisely describes type of the port
-(e.g. lv2:AudioPort).</p>
-
-<p>Hosts that do not support a specific port class MUST NOT instantiate the
-plugin, unless that port has the connectionOptional property set (in which case
-the host can simply <q>connect</q> that port to NULL). If a host is interested
-in plugins to insert in a certain signal path (e.g. stereo audio), it SHOULD
-consider all the classes of a port to determine which ports are most suitable
-for connection (e.g. by ignoring ports with additional classes the host does
-not recognize).</p>
-
-<p>A port has two identifiers: a (numeric) index, and a (textual) symbol.
-The index can be used as an identifier at run-time, but persistent references
-to ports (e.g. in a saved preset) MUST use the symbol. A symbol is guaranteed
-to refer to the same port on all plugins with a given URI. An index does NOT
-necessarily refer to the same port on all plugins with a given URI (i.e. the
-index for a port may differ between plugin binaries).</p>
-""" .
-
-lv2:InputPort
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Port ;
- rdfs:label "Input Port" ;
- rdfs:comment """
-Ports of this type will be connected to a pointer to some value, which will
-be read by the plugin during their run method.
-""" .
-
-lv2:OutputPort
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Port ;
- rdfs:label "Output Port" ;
- rdfs:comment """
-Ports of this type will be connected to a pointer to some value, which will
-be written to by the plugin during their run method.
-""" .
-
-lv2:ControlPort
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Port ;
- rdfs:label "Control Port" ;
- lv2:documentation """
-<p>Ports of this type will be connected to a pointer to a single value of C
-type <code>float</code>.</p>
-
-""" .
-
-lv2:AudioPort
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Port ;
- rdfs:label "Audio Port" ;
- lv2:documentation """
-<p>Ports of this type will be connected to an array of length sample_count
-with elements of C type <code>float</code>.</p>
-""" .
-
-lv2:CVPort
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Port ;
- rdfs:label "CV Port" ;
- lv2:documentation """
-<p>Ports of this type have the same buffer format as an lv2:AudioPort, except
-the buffer represents audio-rate control data rather than audio. Like an
-lv2:ControlPort, a CVPort SHOULD have properties describing its value
-(e.g. lv2:minimum, lv2:maximum, and lv2:default), and may be presented to the
-user as a control.</p>
-
-<p>It is generally safe to connect an audio output to a CV input, but not vice
-versa. Hosts SHOULD take care to prevent data from a CVPort port from being
-used as audio.</p>
-""" .
-
-lv2:port
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:domain lv2:PluginBase ;
- rdfs:range lv2:Port ;
- rdfs:label "port" ;
- rdfs:comment "Relates a Plugin to the Ports it contains" .
-
-lv2:project
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:range doap:Project ;
- rdfs:label "project" ;
- lv2:documentation """
-<p>The project this is a component of.</p>
-
-<p>This property provides a way to group plugins and/or related resources. A
-project may have useful metadata common to all plugins (such as homepage,
-author, version history) which would be wasteful to list separately for each
-plugin.</p>
-
-<p>Grouping via projects also allows users to find plugins in hosts by project,
-which is often how they are remembered. For this reason, a project that
-contains plugins SHOULD always have a doap:name. It is also a good idea for
-each plugin and the project itself to have an lv2:symbol property, which allows
-nice quasi-global identifiers for plugins, e.g. <q>myproj.superamp</q> which
-can be useful for display or fast user entry.</p>
-""" .
-
-lv2:minorVersion
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:range xsd:nonNegativeInteger ;
- rdfs:label "minor version" ;
- lv2:documentation """
-<p>The minor version of an LV2 Resource. This, along with lv2:microVersion, is
-used to distinguish between different versions of the <q>same</q> resource,
-e.g. to load only the bundle with the most recent version of a plugin. An LV2
-version has a minor and micro number with the usual semantics:</p>
-
-<ul>
-<li>The minor version MUST be incremented when backwards (but not
-forwards) compatible additions are made, e.g. the addition of a port to a
-plugin.</li>
-
-<li>The micro version is incremented for changes which do not affect
-compatibility at all, e.g. bug fixes or documentation updates.</li>
-</ul>
-
-<p>Note there is deliberately no major version; all versions with the same URI
-are compatible by definition. Replacing a resource with a newer version of
-that resource MUST NOT break anything. If a change violates this rule, then
-the URI of the resource (which serves as the major version) MUST be
-changed.</p>
-
-<p>Plugins and extensions MUST adhere to at least the following rules:</p>
-<ul>
-<li>All versions of a plugin with a given URI MUST have the <q>same</q> set of
-mandatory (i.e. not lv2:connectionOptional) ports with respect to lv2:symbol
-and rdf:type. In other words, every port on a particular version is guaranteed
-to exist on a future version with same lv2:symbol and at least those
-rdf:types.</li>
-
-<li>New ports MAY be added without changing the plugin URI if and only if they
-are lv2:connectionOptional and the minor version is incremented.</li>
-
-<li>The minor version MUST be incremented if the index of any port (identified
-by its symbol) is changed.</li>
-
-<li>All versions of a specification MUST be compatible in the sense that an
-implementation of the new version can interoperate with an implementation of
-any previous version.</li>
-</ul>
-
-<p>Anything that depends on a specific version of a plugin (e.g. a
-serialisation that references ports by index) MUST refer to the plugin by both
-URI and version. However, implementations should be tolerant and extensions
-should be designed such that there is no need to do this (e.g. indices should
-only be meaningful for a particular plugin <em>instance</em> at run-time).</p>
-
-<p>When hosts discover several installed versions of a resource, they SHOULD
-warn the user and load only the most recent version.</p>
-
-<p>An odd minor <em>or</em> micro version, or minor version zero, indicates
-that the resource is a development version. Hosts and tools SHOULD clearly
-indicate this wherever appropriate. Minor version zero is a special case for
-pre-release development of plugins, or experimental plugins that are not
-intended for stable use at all. Hosts SHOULD NOT expect such a plugin to
-remain compatible with any future version. If possible, hosts SHOULD hide such
-plugins from users unless an <q>experimental</q> option is enabled.</p>
-""" .
-
-lv2:microVersion
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:range xsd:nonNegativeInteger ;
- rdfs:label "micro version" ;
- lv2:documentation """
-<p>The micro component of a Resource's version.</p>
-
-<p>Releases of plugins and extensions MUST be explicitly versioned. Correct
-version numbers MUST always be maintained for any versioned resource that is
-published. For example, after a release, if a change is made in the development
-version in source control, the micro version MUST be incremented (to an odd
-number) to distinguish this modified version from the previous release.</p>
-
-<p>This property describes half of a resource version. For detailed
-documentation on LV2 resource versioning, see lv2:minorVersion.</p>
-""" .
-
-lv2:binary
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:range owl:Thing ;
- rdfs:label "binary" ;
- lv2:documentation """
-<p>The binary of an LV2 resource. The value of this property must be a URI that
-resolves to a shared library object (the actual type of this library is system
-specific).</p>
-
-<p>This is a required property of a Plugin which MUST be included in the
-bundle's manifest.ttl file. The lv2:binary of an lv2:Plugin is the
-shared object containing the <code>lv2_descriptor()</code> function which can
-be used to access the descriptor for that plugin. This property may be used
-similarly by extensions to relate other resources to their implementations.</p>
-""" .
-
-lv2:appliesTo
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:range lv2:Plugin ;
- rdfs:label "applies to" ;
- lv2:documentation """
-<p>Specifies that a resource is related to a plugin. This is primarily intended
-for discovery purposes: bundles that describe resources that work with
-particular plugins (e.g. presets or user interfaces) SHOULD use this predicate
-in manifest.ttl to relate the resource to the applicable
-plugin(s), e.g.:</p>
-<pre class="turtle-code">
-&lt;thing&gt;
- a ext:Thing ;
- lv2:appliesTo &lt;plugin&gt; ;
- rdfs:seeAlso &lt;thing.ttl&gt; .
-</pre>
-
-<p>Particularly for large amounts of data, this is preferable to
-extending the plugin description with rdfs:seeAlso since the host may choose
-if/when to load the data, knowing that it describes an additional resource and
-not the plugin itself.</p>
-""" .
-
-lv2:index
- a rdf:Property ,
- owl:DatatypeProperty ,
- owl:FunctionalProperty ;
- rdfs:range xsd:unsignedInt ;
- rdfs:label "index" ;
- rdfs:comment "A non-negative zero-based 32-bit index." .
-
-lv2:Symbol
- a rdfs:Datatype ;
- owl:onDatatype xsd:string ;
- owl:withRestrictions (
- [
- xsd:pattern "[_a-zA-Z][_a-zA-Z0-9]*"
- ]
- ) ;
- rdfs:comment """
-A short restricted name used as a machine and human readable identifier.
-
-The first character must be one of _, a-z or A-Z and subsequent characters can
-be from _, a-z, A-Z and 0-9. This is a valid C identifier, and compatible in
-most other contexts with restricted string identifiers (e.g. file paths).
-""" .
-
-lv2:symbol
- a rdf:Property ,
- owl:DatatypeProperty ,
- owl:FunctionalProperty ;
- rdfs:label "symbol" ;
- rdfs:range lv2:Symbol ;
- lv2:documentation """
-<p>The value of this property MUST conform to the rules for lv2:Symbol, and
-MUST NOT have a language tag.</p>
-
-<p>A symbol is a unique identifier with respect to the parent (e.g. a port's
-symbol is a unique identifier with respect to its plugin). The plugin author
-MUST change the plugin URI if a port symbol is changed or removed.</p>
-""" .
-
-lv2:name
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:label "name" ;
- rdfs:comment """
-A display name for labeling in a user interface. Unlike lv2:symbol this is
-unrestricted and may be translated. The lv2:name MUST NOT be used as an
-identifier.
-
-This property is required for Ports, but MUST NOT be used by the host for
-port identification. The plugin author may change the values of this
-property without changing the Plugin URI.
-""" .
-
-lv2:Designation
- a rdfs:Class ,
- owl:Class ;
- rdfs:label "Designation" ;
- lv2:documentation """
-<p>The designation (or <q>assignment</q>) of an input or output. A designation
-is metadata that describes the meaning or role of data. By assigning a
-designation to a port using lv2:designation, the port's content becomes
-meaningful and can be used more intelligently by the host.</p>
-""" .
-
-lv2:Channel
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Designation ;
- rdfs:label "Channel" ;
- lv2:documentation """
-<p>A specific channel, e.g. <q>left</q> or <q>right</q>. A channel may be
-audio, or another type such as a MIDI control stream.</p>
-""" .
-
-lv2:Parameter
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Designation ,
- rdf:Property ;
- rdfs:label "Parameter" ;
- lv2:documentation """
-<p>A parameter, i.e. a recognized property. A parameter is a designation for a
-control.</p>
-
-<p>A parameter defines the <em>meaning</em> of a control (not the
-<em>method</em> of conveying its value). The standard way of exposing a plugin
-parameter is via an lv2:ControlPort, which can be given a parameter designation
-with lv2:designation. Other methods, such as setting dynamic parameters via
-messages, are possible but not defined here.</p>
-""" .
-
-lv2:designation
- a rdf:Property ,
- owl:ObjectProperty ,
- owl:FunctionalProperty ;
- rdfs:range lv2:Designation ;
- rdfs:label "designation" ;
- lv2:documentation """
-<p>Indicates a channel or parameter designation.</p>
-
-<p>This property is used to give the port's contents a well-defined meaning.
-For example, if a port has lv2:designation eg:gain, then the value of that port
-represents the eg:gain of the plugin instance.</p>
-
-<p>Ports should be given designations whenever a well-defined designation
-exists. This allows the host to act more intelligently and/or provide a more
-effective user interface. For example, if the plugin has a BPM parameter, the
-host may automatically set that parameter to the current tempo.</p>
-""" .
-
-lv2:latency
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:label "latency" ;
- lv2:documentation """
-<p>The latency introduced by the plugin (or similar), in frames.</p>
-""" .
-
-lv2:freeWheeling
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:label "free-wheeling" ;
- rdfs:range xsd:boolean ;
- lv2:documentation """
-<p>Whether or not processing is currently free-wheeling. If true, this means
-that all processing is happening as quickly as possible, not in real-time.
-When free-wheeling there is no relationship between the passage of real
-wall-clock time and the passage of time in the data being processed (e.g. audio
-frames).</p>
-""" .
-
-lv2:control
- a lv2:Channel ;
- rdfs:label "control" ;
- lv2:documentation """
-<p>The primary control channel. This should be used as the lv2:designation of
-ports that are used to send commands and receive responses. Typically this
-will be an event port that supports some protocol, e.g. MIDI or LV2 Atoms.</p>
-""" .
-
-lv2:Point
- a rdfs:Class ,
- owl:Class ;
- rdfs:label "Point" ;
- lv2:documentation """
-<p>A Point describes an interesting value in a Port's range (much like a labeled
-<q>notch</q> on a physical knob).</p>
-<ul>
- <li>A Point MUST have at least one rdfs:label which is a string.</li>
- <li>A Point MUST have exactly one rdf:value with a type that is compatible
- with the type of the corresponding Port.</li>
-</ul>
-""" .
-
-lv2:ScalePoint
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Point ;
- rdfs:label "Scale Point" ;
- rdfs:comment "A single float Point (for control inputs)." .
-
-lv2:scalePoint
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:domain lv2:Port ;
- rdfs:range lv2:ScalePoint ;
- rdfs:label "scale point" ;
- rdfs:comment "Relates a Port to its ScalePoints." .
-
-lv2:default
- a rdf:Property ,
- owl:DatatypeProperty ,
- owl:FunctionalProperty ;
- rdfs:domain lv2:Port ;
- rdfs:label "default" ;
- rdfs:comment """
-The default value that the host SHOULD set this port to when there is no
-other information available.
-""" .
-
-lv2:minimum
- a rdf:Property ,
- owl:DatatypeProperty ,
- owl:FunctionalProperty ;
- rdfs:domain lv2:Port ;
- rdfs:label "minimum" ;
- lv2:documentation """
-<p>A hint to the host for the minimum useful value that the port will use. This
-is a <q>soft</q> limit; the plugin is required to gracefully accept all values
-in the range of a port's data type.</p>
-""" .
-
-lv2:maximum
- a rdf:Property ,
- owl:DatatypeProperty ,
- owl:FunctionalProperty ;
- rdfs:domain lv2:Port ;
- rdfs:label "maximum" ;
- lv2:documentation """
-<p>A hint to the host for the maximum useful value that the port will use.
-This is a <q>soft</q> limit; the plugin is required to gracefully accept all
-values in the range of a port's data type.</p>
-""" .
-
-lv2:Feature
- a rdfs:Class ,
- owl:Class ;
- rdfs:label "Feature" ;
- rdfs:comment """
-An additional feature which a plugin or other resource may use or require.
-""" .
-
-lv2:optionalFeature
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:range lv2:Feature ;
- rdfs:label "optional feature" ;
- lv2:documentation """
-<p>Signifies that a plugin or other resource supports a certain feature. If
-the host supports this feature, it MUST pass its URI and any additional data to
-the plugin in LV2_Descriptor::instantiate(). The plugin MUST NOT fail to
-instantiate if an optional feature is not supported by the host.</p>
-""" .
-
-lv2:requiredFeature
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:range lv2:Feature ;
- rdfs:label "required feature" ;
- lv2:documentation """
-<p>Signifies that a plugin or other resource requires a certain feature. If
-the host supports this feature, it MUST pass its URI and any additional data to
-the plugin in LV2_Descriptor::instantiate(). The plugin MUST fail to
-instantiate if a required feature is not present; hosts SHOULD always check
-this before attempting to instantiate a plugin (i.e. discovery by attempting to
-instantiate is strongly discouraged).</p>
-""" .
-
-lv2:ExtensionData
- a rdfs:Class ,
- owl:Class ;
- rdfs:label "Extension Data" ;
- rdfs:comment """
-Additional data and/or functions a plugin may return from
-LV2_Descriptor:extension_data() which can be used to add additional API beyond
-that defined by LV2_Descriptor.
-""" .
-
-lv2:extensionData
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:range lv2:ExtensionData ;
- rdfs:label "extension data" ;
- lv2:documentation """
-<p>Signifies that a plugin provides additional data or functions (as defined by
-some extension) via LV2:Descriptor::instantiate().</p>
-""" .
-
-lv2:isLive
- a lv2:Feature ;
- rdfs:label "is live" ;
- lv2:documentation """
-<p>Indicates that the plugin has a real-time dependency (e.g. queues data from
-a socket) and so its output must not be cached or subject to significant
-latency, and calls to the run method should be done in rapid succession. This
-property is not related to <q>hard real-time</q> execution requirements (see
-lv2:hardRTCapable).</p>
-""" .
-
-lv2:inPlaceBroken
- a lv2:Feature ;
- rdfs:label "in-place broken" ;
- lv2:documentation """
-<p>Indicates that the plugin may cease to work correctly if the host elects to
-use the same data location for both input and output. Plugins that will fail
-to work correctly if ANY input port is connected to the same location as ANY
-output port MUST require this Feature. Doing so should be avoided as it makes
-it impossible for hosts to use the plugin to process data <q>in-place</q>.</p>
-""" .
-
-lv2:hardRTCapable
- a lv2:Feature ;
- rdfs:label "hard real-time capable" ;
- lv2:documentation """
-<p>Indicates that the plugin is capable of running not only in a conventional
-host but also in a <q>hard real-time</q> environment. To qualify for this the
-plugin MUST satisfy all of the following:</p>
-<ol>
-<li>The plugin MUST NOT use malloc(), free() or other heap memory management
- functions within its Audio class functions.</li>
-
-<li>The plugin MUST NOT attempt to make use of any library functions in its
- Audio class functions, unless those functions themselves adhere to these
- rules (i.e. are hard realtime safe). The plugin MAY assume the standard C
- and C math library functions are safe.</li>
-
-<li>The plugin will not access files, devices, pipes, sockets, IPC or any other
- mechanism that might result in process or thread blocking within its Audio
- class functions.</li>
-
-<li>The plugin will take an amount of time to execute a run() call
- approximately of form <code>A + B * sample_count</code> where <code>A</code>
- and <code>B</code> depend on the machine and host in use. This amount of
- time MUST NOT depend on input signals or plugin state.</li>
-</ol>
-<p>Note these rules apply to the connect_port() function as well as run().</p>
-""" .
-
-lv2:PortProperty
- a rdfs:Class ,
- owl:Class ;
- rdfs:label "Port Property" ;
- rdfs:comment """
-A port property - a useful piece of information that allows a host to make more
-sensible decisions (e.g. to provide a better interface).
-""" .
-
-lv2:portProperty
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:domain lv2:Port ;
- rdfs:range lv2:PortProperty ;
- rdfs:label "port property" ;
- rdfs:comment """
-Relates Ports to PortProperties. The PortProperty may be ignored without
-catastrophic effects, though it may be useful e.g. for providing a sensible
-interface for the port.
-""" .
-
-lv2:connectionOptional
- a lv2:PortProperty ;
- rdfs:label "connection optional" ;
- rdfs:comment """
-Indicates that this port does not have to be connected to valid data by the
-host. If it is to be disconnected then the port MUST set to NULL with a call
-to the connectPort method.
-""" .
-
-lv2:reportsLatency
- a lv2:PortProperty ;
- rdfs:label "reports latency" ;
- lv2:documentation """
-<p>Indicates that the port is used to express the processing latency incurred
-by the plugin, expressed in samples. The latency may be affected by the current
-sample rate, plugin settings, or other factors, and may be changed by the
-plugin at any time. Where the latency is frequency dependent the plugin may
-choose any appropriate value. If a plugin introduces latency it MUST provide
-EXACTLY ONE port with this property set which informs the host of the
-<q>correct</q> latency. In <q>fuzzy</q> cases the value output should be the
-most reasonable based on user expectation of input/output alignment
-(eg. musical delay/echo plugins should not report their delay as latency, as it
-is an intentional effect).</p>
-""" .
-
-lv2:toggled
- a lv2:PortProperty ;
- rdfs:label "toggled" ;
- lv2:documentation """
-<p>Indicates that the data item should be considered a Boolean toggle. Data
-less than or equal to zero should be considered <q>off</q> or <q>false</q>, and
-data above zero should be considered <q>on</q> or <q>true</q>.</p>
-""" .
-
-lv2:sampleRate
- a lv2:PortProperty ;
- rdfs:label "sample rate" ;
- rdfs:comment """
-Indicates that any bounds specified should be interpreted as multiples of the
-sample rate. For instance, a frequency range from 0Hz to the Nyquist frequency
-(half the sample rate) could be requested by this property in conjunction with
-lv2:minimum 0.0 and lv2:maximum 0.5.
-Hosts that support bounds at all MUST support this property.
-""" .
-
-lv2:integer
- a lv2:PortProperty ;
- rdfs:label "integer" ;
- rdfs:comment """
-Indicates that a port's reasonable values are integers (eg. a user interface
-would likely wish to provide a stepped control allowing only integer input).
-A plugin MUST operate reasonably even if such a port has a non-integer input.
-""" .
-
-lv2:enumeration
- a lv2:PortProperty ;
- rdfs:label "enumeration" ;
- rdfs:comment """
-Indicates that a port's only reasonable values are the scale points defined for
-that port. A host SHOULD NOT allow a user to set the value of such a port to
-anything other than a scale point. However, a plugin MUST operate reasonably
-even if such a port has an input that is not a scale point, preferably by
-simply choosing the largest enumeration value less than or equal to the actual
-input value (i.e. round the input value down).
-""" .
-
-lv2:GeneratorPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Plugin ;
- rdfs:label "Generator" ;
- rdfs:comment """
-Any plugin that generates sound internally, rather than processing its input.
-""" .
-
-lv2:InstrumentPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:GeneratorPlugin ;
- rdfs:label "Instrument" ;
- rdfs:comment """
-Any plugin that is intended to be played as a musical instrument.
-""" .
-
-lv2:OscillatorPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:GeneratorPlugin ;
- rdfs:label "Oscillator" .
-
-lv2:UtilityPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Plugin ;
- rdfs:label "Utility" ;
- rdfs:comment """
-Includes things like mathematical functions and non-musical delays.
-""" .
-
-lv2:ConverterPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:UtilityPlugin ;
- rdfs:label "Converter" ;
- rdfs:comment """
-Any plugin that converts some form of input into a different form of output.
-""" .
-
-lv2:AnalyserPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:UtilityPlugin ;
- rdfs:label "Analyser" ;
- rdfs:comment """
-Any plugin that analyses input to output some useful information.
-""" .
-
-lv2:MixerPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:UtilityPlugin ;
- rdfs:label "Mixer" ;
- rdfs:comment """
-A plugin which mixes some number of inputs into some number of outputs.
-""" .
-
-lv2:SimulatorPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Plugin ;
- rdfs:label "Simulator" ;
- rdfs:comment """
-Plugins that aim to duplicate the effect of some environmental effect or
-musical equipment.
-""" .
-
-lv2:DelayPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Plugin ;
- rdfs:label "Delay" ;
- rdfs:comment """
-Plugins that intentionally delay their input signal as an effect.
-""" .
-
-lv2:ModulatorPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Plugin ;
- rdfs:label "Modulator" .
-
-lv2:ReverbPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Plugin ,
- lv2:SimulatorPlugin ,
- lv2:DelayPlugin ;
- rdfs:label "Reverb" .
-
-lv2:PhaserPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:ModulatorPlugin ;
- rdfs:label "Phaser" .
-
-lv2:FlangerPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:ModulatorPlugin ;
- rdfs:label "Flanger" .
-
-lv2:ChorusPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:ModulatorPlugin ;
- rdfs:label "Chorus" .
-
-lv2:FilterPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Plugin ;
- rdfs:label "Filter" .
-
-lv2:LowpassPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:FilterPlugin ;
- rdfs:label "Lowpass" .
-
-lv2:BandpassPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:FilterPlugin ;
- rdfs:label "Bandpass" .
-
-lv2:HighpassPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:FilterPlugin ;
- rdfs:label "Highpass" .
-
-lv2:CombPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:FilterPlugin ;
- rdfs:label "Comb" .
-
-lv2:AllpassPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:FilterPlugin ;
- rdfs:label "Allpass" .
-
-lv2:EQPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:FilterPlugin ;
- rdfs:label "Equaliser" .
-
-lv2:ParaEQPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:EQPlugin ;
- rdfs:label "Parametric" .
-
-lv2:MultiEQPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:EQPlugin ;
- rdfs:label "Multiband" .
-
-lv2:SpatialPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Plugin ;
- rdfs:label "Spatial" ;
- rdfs:comment """
-Plugins that manipulate the position of audio in space (e.g. panning,
-stereo width, surround encoding, etc.).
-""" .
-
-lv2:SpectralPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Plugin ;
- rdfs:label "Spectral" ;
- rdfs:comment """
-Plugins that alter the spectral properties (e.g. frequency) of audio.
-""" .
-
-lv2:PitchPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:SpectralPlugin ;
- rdfs:label "Pitch Shifter" .
-
-lv2:AmplifierPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:DynamicsPlugin ;
- rdfs:label "Amplifier" .
-
-lv2:EnvelopePlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:DynamicsPlugin ;
- rdfs:label "Envelope" .
-
-lv2:DistortionPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Plugin ;
- rdfs:label "Distortion" .
-
-lv2:WaveshaperPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:DistortionPlugin ;
- rdfs:label "Waveshaper" .
-
-lv2:DynamicsPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:Plugin ;
- rdfs:label "Dynamics" ;
- rdfs:comment """
-Plugins that alter the envelope or dynamic range of audio.
-""" .
-
-lv2:CompressorPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:DynamicsPlugin ;
- rdfs:label "Compressor" .
-
-lv2:ExpanderPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:DynamicsPlugin ;
- rdfs:label "Expander" .
-
-lv2:LimiterPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:DynamicsPlugin ;
- rdfs:label "Limiter" .
-
-lv2:GatePlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:DynamicsPlugin ;
- rdfs:label "Gate" .
-
-lv2:FunctionPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:UtilityPlugin ;
- rdfs:label "Function" .
-
-lv2:ConstantPlugin
- a rdfs:Class ,
- owl:Class ;
- rdfs:subClassOf lv2:GeneratorPlugin ;
- rdfs:label "Constant" .
diff --git a/lv2/lv2plug.in/ns/lv2core/manifest.ttl b/lv2/lv2plug.in/ns/lv2core/manifest.ttl
deleted file mode 100644
index 9a77f67..0000000
--- a/lv2/lv2plug.in/ns/lv2core/manifest.ttl
+++ /dev/null
@@ -1,9 +0,0 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/lv2core>
- a lv2:Specification ;
- lv2:minorVersion 10 ;
- lv2:microVersion 0 ;
- rdfs:seeAlso <lv2core.ttl> .
diff --git a/lv2/lv2plug.in/ns/lv2core/wscript b/lv2/lv2plug.in/ns/lv2core/wscript
deleted file mode 100644
index 79f8bc2..0000000
--- a/lv2/lv2plug.in/ns/lv2core/wscript
+++ /dev/null
@@ -1,83 +0,0 @@
-#!/usr/bin/env python
-import os
-
-from waflib.extras import autowaf as autowaf
-import waflib.Options as Options
-import glob
-
-# Version of this package (even if built as a child)
-LV2CORE_VERSION = '6.7'
-
-# Variables for 'waf dist'
-APPNAME = 'lv2core'
-VERSION = LV2CORE_VERSION
-
-# Mandatory variables
-top = '.'
-out = 'build'
-
-def options(opt):
- opt.load('compiler_c')
- autowaf.set_options(opt)
- opt.add_option('--bundle-only', action='store_true', default=False,
- dest='bundle_only',
- help="Only install bundle (not header or pkg-config file)")
- opt.add_option('--copy-headers', action='store_true', default=False,
- dest='copy_headers',
- help='Copy headers instead of linking to bundle')
-
-def configure(conf):
- if not hasattr(os.path, 'relpath') and not Options.options.copy_headers:
- conf.fatal(
- 'os.path.relpath missing, get Python 2.6 or use --copy-headers')
-
- conf.load('compiler_c')
- autowaf.configure(conf)
-
- autowaf.display_msg(conf, "LV2 bundle directory", conf.env['LV2DIR'])
- print('')
-
-def build(bld):
- # Header "library"
- bld(export_includes = ['.'],
- name = 'liblv2core',
- target = 'lv2core')
-
- # Bundle (data)
- bld.install_files('${LV2DIR}/lv2core.lv2', bld.path.ant_glob('*.ttl'))
-
- if not Options.options.bundle_only:
- # Header
- bld.install_files('${INCLUDEDIR}', 'lv2.h')
- bld.install_files('${LV2DIR}/lv2core.lv2', 'lv2.h')
-
- # Pkgconfig file
- autowaf.build_pc(bld, 'LV2CORE', LV2CORE_VERSION, '', [])
-
- # URI-like header include
- include_dir = os.path.join(bld.env['INCLUDEDIR'], 'lv2/lv2plug.in/ns')
- bundle_dir = os.path.join(bld.env['LV2DIR'], 'lv2core.lv2')
- if bld.env['COPY_HEADERS']:
- bld.install_files(os.path.join(include_dir, 'lv2core'),
- bld.path.ant_glob('*.h'))
- else:
- bld.symlink_as(os.path.join(include_dir, 'lv2core'),
- os.path.relpath(bundle_dir, include_dir))
-
-def news(ctx):
- path = ctx.path.abspath()
- autowaf.write_news(APPNAME,
- glob.glob(os.path.join(path, '*.ttl')),
- os.path.join(path, 'NEWS'))
-
-def pre_dist(ctx):
- # Write NEWS file in source directory
- news(ctx)
-
-def post_dist(ctx):
- # Delete generated NEWS file
- try:
- os.remove(os.path.join(ctx.path.abspath(), 'NEWS'))
- except:
- pass
-
diff --git a/lv2/lv2plug.in/ns/meta/manifest.ttl b/lv2/lv2plug.in/ns/meta/manifest.ttl
deleted file mode 100644
index 8b2aac6..0000000
--- a/lv2/lv2plug.in/ns/meta/manifest.ttl
+++ /dev/null
@@ -1,8 +0,0 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/meta>
- a lv2:Specification ;
- lv2:minorVersion 1 ;
- lv2:microVersion 0 ;
- rdfs:seeAlso <meta.ttl> .
diff --git a/lv2/lv2plug.in/ns/ext/midi/manifest.ttl b/lv2/midi/manifest.ttl
index 43d4b54..f141936 100644
--- a/lv2/lv2plug.in/ns/ext/midi/manifest.ttl
+++ b/lv2/midi/manifest.ttl
@@ -1,9 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/midi>
a lv2:Specification ;
lv2:minorVersion 1 ;
- lv2:microVersion 8 ;
+ lv2:microVersion 10 ;
rdfs:seeAlso <midi.ttl> .
diff --git a/lv2/lv2plug.in/ns/ext/midi/midi.h b/lv2/midi/midi.h
index 2c53c49..0abfba1 100644
--- a/lv2/lv2plug.in/ns/ext/midi/midi.h
+++ b/lv2/midi/midi.h
@@ -1,5 +1,5 @@
/*
- Copyright 2012 David Robillard <http://drobilla.net>
+ Copyright 2012-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -15,65 +15,69 @@
*/
/**
- @file midi.h
- C definitions for the LV2 MIDI extension <http://lv2plug.in/ns/ext/midi>.
+ @defgroup midi MIDI
+ @ingroup lv2
+
+ Definitions of standard MIDI messages, see <http://lv2plug.in/ns/ext/midi>
+ for details.
+
+ @{
*/
#ifndef LV2_MIDI_H
#define LV2_MIDI_H
+#include <stdbool.h>
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
-#else
-# include <stdbool.h>
#endif
-#define LV2_MIDI_URI "http://lv2plug.in/ns/ext/midi"
-#define LV2_MIDI_PREFIX LV2_MIDI_URI "#"
-
-#define LV2_MIDI__ActiveSense LV2_MIDI_PREFIX "ActiveSense"
-#define LV2_MIDI__Aftertouch LV2_MIDI_PREFIX "Aftertouch"
-#define LV2_MIDI__Bender LV2_MIDI_PREFIX "Bender"
-#define LV2_MIDI__ChannelPressure LV2_MIDI_PREFIX "ChannelPressure"
-#define LV2_MIDI__Chunk LV2_MIDI_PREFIX "Chunk"
-#define LV2_MIDI__Clock LV2_MIDI_PREFIX "Clock"
-#define LV2_MIDI__Continue LV2_MIDI_PREFIX "Continue"
-#define LV2_MIDI__Controller LV2_MIDI_PREFIX "Controller"
-#define LV2_MIDI__MidiEvent LV2_MIDI_PREFIX "MidiEvent"
-#define LV2_MIDI__NoteOff LV2_MIDI_PREFIX "NoteOff"
-#define LV2_MIDI__NoteOn LV2_MIDI_PREFIX "NoteOn"
-#define LV2_MIDI__ProgramChange LV2_MIDI_PREFIX "ProgramChange"
-#define LV2_MIDI__QuarterFrame LV2_MIDI_PREFIX "QuarterFrame"
-#define LV2_MIDI__Reset LV2_MIDI_PREFIX "Reset"
-#define LV2_MIDI__SongPosition LV2_MIDI_PREFIX "SongPosition"
-#define LV2_MIDI__SongSelect LV2_MIDI_PREFIX "SongSelect"
-#define LV2_MIDI__Start LV2_MIDI_PREFIX "Start"
-#define LV2_MIDI__Stop LV2_MIDI_PREFIX "Stop"
-#define LV2_MIDI__SystemCommon LV2_MIDI_PREFIX "SystemCommon"
-#define LV2_MIDI__SystemExclusive LV2_MIDI_PREFIX "SystemExclusive"
-#define LV2_MIDI__SystemMessage LV2_MIDI_PREFIX "SystemMessage"
-#define LV2_MIDI__SystemRealtime LV2_MIDI_PREFIX "SystemRealtime"
-#define LV2_MIDI__Tick LV2_MIDI_PREFIX "Tick"
-#define LV2_MIDI__TuneRequest LV2_MIDI_PREFIX "TuneRequest"
-#define LV2_MIDI__VoiceMessage LV2_MIDI_PREFIX "VoiceMessage"
-#define LV2_MIDI__benderValue LV2_MIDI_PREFIX "benderValue"
-#define LV2_MIDI__binding LV2_MIDI_PREFIX "binding"
-#define LV2_MIDI__byteNumber LV2_MIDI_PREFIX "byteNumber"
-#define LV2_MIDI__channel LV2_MIDI_PREFIX "channel"
-#define LV2_MIDI__chunk LV2_MIDI_PREFIX "chunk"
-#define LV2_MIDI__controllerNumber LV2_MIDI_PREFIX "controllerNumber"
-#define LV2_MIDI__controllerValue LV2_MIDI_PREFIX "controllerValue"
-#define LV2_MIDI__noteNumber LV2_MIDI_PREFIX "noteNumber"
-#define LV2_MIDI__pressure LV2_MIDI_PREFIX "pressure"
-#define LV2_MIDI__programNumber LV2_MIDI_PREFIX "programNumber"
-#define LV2_MIDI__property LV2_MIDI_PREFIX "property"
-#define LV2_MIDI__songNumber LV2_MIDI_PREFIX "songNumber"
-#define LV2_MIDI__songPosition LV2_MIDI_PREFIX "songPosition"
-#define LV2_MIDI__status LV2_MIDI_PREFIX "status"
-#define LV2_MIDI__statusMask LV2_MIDI_PREFIX "statusMask"
-#define LV2_MIDI__velocity LV2_MIDI_PREFIX "velocity"
+#define LV2_MIDI_URI "http://lv2plug.in/ns/ext/midi" ///< http://lv2plug.in/ns/ext/midi
+#define LV2_MIDI_PREFIX LV2_MIDI_URI "#" ///< http://lv2plug.in/ns/ext/midi#
+
+#define LV2_MIDI__ActiveSense LV2_MIDI_PREFIX "ActiveSense" ///< http://lv2plug.in/ns/ext/midi#ActiveSense
+#define LV2_MIDI__Aftertouch LV2_MIDI_PREFIX "Aftertouch" ///< http://lv2plug.in/ns/ext/midi#Aftertouch
+#define LV2_MIDI__Bender LV2_MIDI_PREFIX "Bender" ///< http://lv2plug.in/ns/ext/midi#Bender
+#define LV2_MIDI__ChannelPressure LV2_MIDI_PREFIX "ChannelPressure" ///< http://lv2plug.in/ns/ext/midi#ChannelPressure
+#define LV2_MIDI__Chunk LV2_MIDI_PREFIX "Chunk" ///< http://lv2plug.in/ns/ext/midi#Chunk
+#define LV2_MIDI__Clock LV2_MIDI_PREFIX "Clock" ///< http://lv2plug.in/ns/ext/midi#Clock
+#define LV2_MIDI__Continue LV2_MIDI_PREFIX "Continue" ///< http://lv2plug.in/ns/ext/midi#Continue
+#define LV2_MIDI__Controller LV2_MIDI_PREFIX "Controller" ///< http://lv2plug.in/ns/ext/midi#Controller
+#define LV2_MIDI__MidiEvent LV2_MIDI_PREFIX "MidiEvent" ///< http://lv2plug.in/ns/ext/midi#MidiEvent
+#define LV2_MIDI__NoteOff LV2_MIDI_PREFIX "NoteOff" ///< http://lv2plug.in/ns/ext/midi#NoteOff
+#define LV2_MIDI__NoteOn LV2_MIDI_PREFIX "NoteOn" ///< http://lv2plug.in/ns/ext/midi#NoteOn
+#define LV2_MIDI__ProgramChange LV2_MIDI_PREFIX "ProgramChange" ///< http://lv2plug.in/ns/ext/midi#ProgramChange
+#define LV2_MIDI__QuarterFrame LV2_MIDI_PREFIX "QuarterFrame" ///< http://lv2plug.in/ns/ext/midi#QuarterFrame
+#define LV2_MIDI__Reset LV2_MIDI_PREFIX "Reset" ///< http://lv2plug.in/ns/ext/midi#Reset
+#define LV2_MIDI__SongPosition LV2_MIDI_PREFIX "SongPosition" ///< http://lv2plug.in/ns/ext/midi#SongPosition
+#define LV2_MIDI__SongSelect LV2_MIDI_PREFIX "SongSelect" ///< http://lv2plug.in/ns/ext/midi#SongSelect
+#define LV2_MIDI__Start LV2_MIDI_PREFIX "Start" ///< http://lv2plug.in/ns/ext/midi#Start
+#define LV2_MIDI__Stop LV2_MIDI_PREFIX "Stop" ///< http://lv2plug.in/ns/ext/midi#Stop
+#define LV2_MIDI__SystemCommon LV2_MIDI_PREFIX "SystemCommon" ///< http://lv2plug.in/ns/ext/midi#SystemCommon
+#define LV2_MIDI__SystemExclusive LV2_MIDI_PREFIX "SystemExclusive" ///< http://lv2plug.in/ns/ext/midi#SystemExclusive
+#define LV2_MIDI__SystemMessage LV2_MIDI_PREFIX "SystemMessage" ///< http://lv2plug.in/ns/ext/midi#SystemMessage
+#define LV2_MIDI__SystemRealtime LV2_MIDI_PREFIX "SystemRealtime" ///< http://lv2plug.in/ns/ext/midi#SystemRealtime
+#define LV2_MIDI__Tick LV2_MIDI_PREFIX "Tick" ///< http://lv2plug.in/ns/ext/midi#Tick
+#define LV2_MIDI__TuneRequest LV2_MIDI_PREFIX "TuneRequest" ///< http://lv2plug.in/ns/ext/midi#TuneRequest
+#define LV2_MIDI__VoiceMessage LV2_MIDI_PREFIX "VoiceMessage" ///< http://lv2plug.in/ns/ext/midi#VoiceMessage
+#define LV2_MIDI__benderValue LV2_MIDI_PREFIX "benderValue" ///< http://lv2plug.in/ns/ext/midi#benderValue
+#define LV2_MIDI__binding LV2_MIDI_PREFIX "binding" ///< http://lv2plug.in/ns/ext/midi#binding
+#define LV2_MIDI__byteNumber LV2_MIDI_PREFIX "byteNumber" ///< http://lv2plug.in/ns/ext/midi#byteNumber
+#define LV2_MIDI__channel LV2_MIDI_PREFIX "channel" ///< http://lv2plug.in/ns/ext/midi#channel
+#define LV2_MIDI__chunk LV2_MIDI_PREFIX "chunk" ///< http://lv2plug.in/ns/ext/midi#chunk
+#define LV2_MIDI__controllerNumber LV2_MIDI_PREFIX "controllerNumber" ///< http://lv2plug.in/ns/ext/midi#controllerNumber
+#define LV2_MIDI__controllerValue LV2_MIDI_PREFIX "controllerValue" ///< http://lv2plug.in/ns/ext/midi#controllerValue
+#define LV2_MIDI__noteNumber LV2_MIDI_PREFIX "noteNumber" ///< http://lv2plug.in/ns/ext/midi#noteNumber
+#define LV2_MIDI__pressure LV2_MIDI_PREFIX "pressure" ///< http://lv2plug.in/ns/ext/midi#pressure
+#define LV2_MIDI__programNumber LV2_MIDI_PREFIX "programNumber" ///< http://lv2plug.in/ns/ext/midi#programNumber
+#define LV2_MIDI__property LV2_MIDI_PREFIX "property" ///< http://lv2plug.in/ns/ext/midi#property
+#define LV2_MIDI__songNumber LV2_MIDI_PREFIX "songNumber" ///< http://lv2plug.in/ns/ext/midi#songNumber
+#define LV2_MIDI__songPosition LV2_MIDI_PREFIX "songPosition" ///< http://lv2plug.in/ns/ext/midi#songPosition
+#define LV2_MIDI__status LV2_MIDI_PREFIX "status" ///< http://lv2plug.in/ns/ext/midi#status
+#define LV2_MIDI__statusMask LV2_MIDI_PREFIX "statusMask" ///< http://lv2plug.in/ns/ext/midi#statusMask
+#define LV2_MIDI__velocity LV2_MIDI_PREFIX "velocity" ///< http://lv2plug.in/ns/ext/midi#velocity
/**
MIDI Message Type.
@@ -184,7 +188,7 @@ typedef enum {
} LV2_Midi_Controller;
/**
- Return true iff @p msg is a MIDI voice message (which has a channel).
+ Return true iff `msg` is a MIDI voice message (which has a channel).
*/
static inline bool
lv2_midi_is_voice_message(const uint8_t* msg) {
@@ -192,7 +196,7 @@ lv2_midi_is_voice_message(const uint8_t* msg) {
}
/**
- Return true iff @p msg is a MIDI system message (which has no channel).
+ Return true iff `msg` is a MIDI system message (which has no channel).
*/
static inline bool
lv2_midi_is_system_message(const uint8_t* msg) {
@@ -224,3 +228,7 @@ lv2_midi_message_type(const uint8_t* msg) {
#endif
#endif /* LV2_MIDI_H */
+
+/**
+ @}
+*/
diff --git a/lv2/lv2plug.in/ns/ext/midi/lv2-midi.doap.ttl b/lv2/midi/midi.meta.ttl
index 32ee007..7efdb01 100644
--- a/lv2/lv2plug.in/ns/ext/midi/lv2-midi.doap.ttl
+++ b/lv2/midi/midi.meta.ttl
@@ -1,11 +1,12 @@
@prefix dcs: <http://ontologi.es/doap-changeset#> .
@prefix doap: <http://usefulinc.com/ns/doap#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix midi: <http://lv2plug.in/ns/ext/midi#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/midi>
a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
doap:license <http://opensource.org/licenses/isc> ;
doap:name "LV2 MIDI" ;
doap:shortdesc "A normalised definition of raw MIDI." ;
@@ -14,6 +15,16 @@
doap:developer <http://lv2plug.in/ns/meta#larsl> ,
<http://drobilla.net/drobilla#me> ;
doap:release [
+ doap:revision "1.10" ;
+ doap:created "2019-02-03" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.16.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix incorrect range of midi:chunk."
+ ]
+ ]
+ ] , [
doap:revision "1.8" ;
doap:created "2012-10-14" ;
doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
@@ -81,4 +92,62 @@
rdfs:label "Initial release."
]
]
- ] .
+ ] ;
+ lv2:documentation """
+
+This specification defines a data type for a MIDI message, midi:MidiEvent,
+which is normalised for fast and convenient real-time processing. MIDI is the
+<q>Musical Instrument Digital Interface</q>, a ubiquitous binary standard for
+controlling digital music devices.
+
+For plugins that process MIDI (or other situations where MIDI is sent via a
+generic transport) the main type defined here, midi:MidiEvent, can be mapped to
+an integer and used as the type of an LV2 [Atom](atom.html#Atom) or
+[Event](event.html#Event).
+
+This specification also defines a complete vocabulary for the MIDI standard,
+except for standard controller numbers. These descriptions are detailed enough
+to express any MIDI message as properties.
+
+"""^^lv2:Markdown .
+
+midi:MidiEvent
+ lv2:documentation """
+
+A single raw MIDI message (a sequence of bytes).
+
+This is equivalent to a standard MIDI messages, except with the following
+restrictions to simplify handling:
+
+ * Running status is not allowed, every message must have its own status byte.
+
+ * Note On messages with velocity 0 are not allowed. These messages are
+ equivalent to Note Off in standard MIDI streams, but here only proper Note
+ Off messages are allowed.
+
+ * "Realtime messages" (status bytes 0xF8 to 0xFF) are allowed, but may not
+ occur inside other messages like they can in standard MIDI streams.
+
+ * All messages are complete valid MIDI messages. This means, for example,
+ that only the first byte in each event (the status byte) may have the
+ eighth bit set, that Note On and Note Off events are always 3 bytes long,
+ etc.
+
+Where messages are communicated, the writer is responsible for writing valid
+messages, and the reader may assume that all events are valid.
+
+If a midi:MidiEvent is serialised to a string, the format should be
+xsd:hexBinary, for example:
+
+ :::turtle
+ [] eg:someEvent "901A01"^^midi:MidiEvent .
+
+"""^^lv2:Markdown .
+
+midi:statusMask
+ lv2:documentation """
+
+This is a status byte with the lower nibble set to zero.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/lv2plug.in/ns/ext/midi/midi.ttl b/lv2/midi/midi.ttl
index 483b193..81f3495 100644
--- a/lv2/lv2plug.in/ns/ext/midi/midi.ttl
+++ b/lv2/midi/midi.ttl
@@ -1,44 +1,31 @@
@prefix atom: <http://lv2plug.in/ns/ext/atom#> .
-@prefix ev: <http://lv2plug.in/ns/ext/event#> .
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix ev: <http://lv2plug.in/ns/ext/event#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix midi: <http://lv2plug.in/ns/ext/midi#> .
-@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@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#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
<http://lv2plug.in/ns/ext/midi>
a owl:Ontology ;
+ rdfs:label "LV2 MIDI" ;
+ rdfs:comment "A normalised definition of raw MIDI." ;
rdfs:seeAlso <midi.h> ,
- <lv2-midi.doap.ttl> ;
- lv2:documentation """
-<p>This specification defines a data type for a MIDI message, midi:MidiEvent,
-which is normalised for fast and convenient real-time processing. MIDI is the
-<q>Musical Instrument Digital Interface</q>, a ubiquitous binary standard for
-controlling digital music devices.</p>
-
-<p>For plugins that process MIDI (or other situations where MIDI is sent via a
-generic transport) the main type defined here, midi:MidiEvent, can be mapped to
-an integer and used as the type of an LV2 <a
-href="../atom/atom.html#Atom">Atom</a> or <a
-href="../event/event.html#Event">Event</a>.</p>
-
-<p>This specification also defines a complete human and machine readable
-description of the MIDI standard (except for standard controller numbers).
-These descriptions are detailed enough to express any MIDI message as
-properties.</p>
-""" .
+ <midi.meta.ttl> .
midi:ActiveSense
a rdfs:Class ;
rdfs:subClassOf midi:SystemRealtime ;
- rdfs:label "Active Sense Message" ;
+ rdfs:label "Active Sense" ;
+ rdfs:comment "MIDI active sense message." ;
midi:status "FE"^^xsd:hexBinary .
midi:Aftertouch
a rdfs:Class ;
rdfs:subClassOf midi:VoiceMessage ;
- rdfs:label "Aftertouch Message" ;
+ rdfs:label "Aftertouch" ;
+ rdfs:comment "MIDI aftertouch message." ;
midi:statusMask "A0"^^xsd:hexBinary ;
midi:chunk [
midi:byteNumber 0 ;
@@ -51,7 +38,8 @@ midi:Aftertouch
midi:Bender
a rdfs:Class ;
rdfs:subClassOf midi:VoiceMessage ;
- rdfs:label "Bender Message" ;
+ rdfs:label "Bender" ;
+ rdfs:comment "MIDI bender message." ;
midi:statusMask "E0"^^xsd:hexBinary ;
midi:chunk [
midi:byteNumber 0 ,
@@ -62,7 +50,8 @@ midi:Bender
midi:ChannelPressure
a rdfs:Class ;
rdfs:subClassOf midi:VoiceMessage ;
- rdfs:label "Channel Pressure Message" ;
+ rdfs:label "Channel Pressure" ;
+ rdfs:comment "MIDI channel pressure message." ;
midi:statusMask "D0"^^xsd:hexBinary ;
midi:chunk [
midi:byteNumber 0 ;
@@ -71,24 +60,28 @@ midi:ChannelPressure
midi:Chunk
a rdfs:Class ;
- rdfs:comment "A series of contiguous bytes (usually one) in a message." .
+ rdfs:label "Chunk" ;
+ rdfs:comment "A sequence of contiguous bytes in a MIDI message." .
midi:Clock
a rdfs:Class ;
rdfs:subClassOf midi:SystemRealtime ;
- rdfs:label "Clock Message" ;
+ rdfs:label "Clock" ;
+ rdfs:comment "MIDI clock message." ;
midi:status "F8"^^xsd:hexBinary .
midi:Continue
a rdfs:Class ;
rdfs:subClassOf midi:SystemRealtime ;
- rdfs:label "Continue Message" ;
+ rdfs:label "Continue" ;
+ rdfs:comment "MIDI continue message." ;
midi:status "FB"^^xsd:hexBinary .
midi:Controller
a rdfs:Class ;
rdfs:subClassOf midi:VoiceMessage ;
- rdfs:label "Controller Change Message" ;
+ rdfs:label "Controller" ;
+ rdfs:comment "MIDI controller change message." ;
midi:statusMask "B0"^^xsd:hexBinary ;
midi:chunk [
midi:byteNumber 0 ;
@@ -106,50 +99,23 @@ midi:HexByte
xsd:maxInclusive "FF"
]
) ;
- rdfs:comment "A hexadecimal byte, which is a xsd:hexBinary value <= FF" .
+ rdfs:label "Hex Byte" ;
+ rdfs:comment "A hexadecimal byte, which has a value <= FF." .
midi:MidiEvent
a rdfs:Class ,
rdfs:Datatype ;
- rdfs:label "MIDI Message" ;
rdfs:subClassOf ev:Event ,
atom:Atom ;
owl:onDatatype xsd:hexBinary ;
- lv2:documentation """
-<p>A single raw MIDI message (i.e. a sequence of bytes).</p>
-
-<p>This is equivalent to a standard MIDI messages, except with the following
-restrictions to simplify handling:</p>
-<ul>
- <li>Running status is not allowed, every message must have its own status
- byte.</li>
-
- <li>Note On messages with velocity 0 are not allowed. These messages are
- equivalent to Note Off in standard MIDI streams, but here only proper Note
- Off messages are allowed.</li>
-
- <li>"Realtime messages" (status bytes 0xF8 to 0xFF) are allowed, but may
- not occur inside other messages like they can in standard MIDI streams.</li>
-
- <li>All messages are complete valid MIDI messages. This means, for example,
- that only the first byte in each event (the status byte) may have the eighth
- bit set, that Note On and Note Off events are always 3 bytes long, etc.
- Where messages are communicated, the writer is responsible for writing valid
- messages, and the reader may assume that all events are valid.</li>
-</ul>
-
-<p>If a midi:MidiEvent is serialised to a string, the format should be
-xsd:hexBinary, e.g. (in Turtle notation):</p>
-
-<pre class="turtle-code">
-[] eg:someEvent "901A01"^^midi:MidiEvent .
-</pre>
-""" .
+ rdfs:label "MIDI Message" ;
+ rdfs:comment "A single raw MIDI message." .
midi:NoteOff
a rdfs:Class ;
rdfs:subClassOf midi:VoiceMessage ;
- rdfs:label "Note Off Message" ;
+ rdfs:label "Note Off" ;
+ rdfs:comment "MIDI note off message." ;
midi:statusMask "80"^^xsd:hexBinary ;
midi:chunk [
midi:byteNumber 0 ;
@@ -162,7 +128,8 @@ midi:NoteOff
midi:NoteOn
a rdfs:Class ;
rdfs:subClassOf midi:VoiceMessage ;
- rdfs:label "Note On Message" ;
+ rdfs:label "Note On" ;
+ rdfs:comment "MIDI note on message." ;
midi:statusMask "90"^^xsd:hexBinary ;
midi:chunk [
midi:byteNumber 0 ;
@@ -175,7 +142,8 @@ midi:NoteOn
midi:ProgramChange
a rdfs:Class ;
rdfs:subClassOf midi:VoiceMessage ;
- rdfs:label "Program Change Message" ;
+ rdfs:label "Program Change" ;
+ rdfs:comment "MIDI program change message." ;
midi:statusMask "C0"^^xsd:hexBinary ;
midi:chunk [
midi:byteNumber 0 ;
@@ -185,19 +153,22 @@ midi:ProgramChange
midi:QuarterFrame
a rdfs:Class ;
rdfs:subClassOf midi:SystemCommon ;
- rdfs:label "Quarter Frame Message" ;
+ rdfs:label "Quarter Frame" ;
+ rdfs:comment "MIDI quarter frame message." ;
midi:status "F1"^^xsd:hexBinary .
midi:Reset
a rdfs:Class ;
rdfs:subClassOf midi:SystemRealtime ;
- rdfs:label "Reset Message" ;
+ rdfs:label "Reset" ;
+ rdfs:comment "MIDI reset message." ;
midi:status "FF"^^xsd:hexBinary .
midi:SongPosition
a rdfs:Class ;
rdfs:subClassOf midi:SystemCommon ;
- rdfs:label "Song Position Pointer Message" ;
+ rdfs:label "Song Position" ;
+ rdfs:comment "MIDI song position pointer message." ;
midi:status "F2"^^xsd:hexBinary ;
midi:chunk [
midi:byteNumber 0 ,
@@ -208,83 +179,83 @@ midi:SongPosition
midi:SongSelect
a rdfs:Class ;
rdfs:subClassOf midi:SystemCommon ;
- rdfs:label "Song Select Message" ;
+ rdfs:label "Song Select" ;
+ rdfs:comment "MIDI song select message." ;
midi:status "F3"^^xsd:hexBinary .
midi:Start
a rdfs:Class ;
rdfs:subClassOf midi:SystemRealtime ;
- rdfs:label "Start Message" ;
+ rdfs:label "Start" ;
+ rdfs:comment "MIDI start message." ;
midi:status "FA"^^xsd:hexBinary .
midi:Stop
a rdfs:Class ;
rdfs:subClassOf midi:SystemRealtime ;
- rdfs:label "Stop Message" ;
+ rdfs:label "Stop" ;
+ rdfs:comment "MIDI stop message." ;
midi:status "FC"^^xsd:hexBinary .
midi:SystemCommon
a rdfs:Class ;
rdfs:subClassOf midi:SystemMessage ;
- rdfs:label "System Common Message" .
+ rdfs:label "System Common" ;
+ rdfs:comment "MIDI system common message." .
midi:SystemExclusive
a rdfs:Class ;
rdfs:subClassOf midi:SystemMessage ;
- rdfs:label "System Exclusive Message" ;
+ rdfs:label "System Exclusive" ;
+ rdfs:comment "MIDI system exclusive message." ;
midi:status "F0"^^xsd:hexBinary .
midi:SystemMessage
a rdfs:Class ;
rdfs:subClassOf midi:MidiEvent ;
rdfs:label "System Message" ;
+ rdfs:comment "MIDI system message." ;
midi:statusMask "F0"^^xsd:hexBinary .
midi:SystemRealtime
a rdfs:Class ;
rdfs:subClassOf midi:SystemMessage ;
- rdfs:label "System Realtime Message" .
+ rdfs:label "System Realtime" ;
+ rdfs:comment "MIDI system realtime message." .
midi:TuneRequest
a rdfs:Class ;
rdfs:subClassOf midi:SystemCommon ;
- rdfs:label "Tune Request Message" ;
+ rdfs:label "Tune Request" ;
+ rdfs:comment "MIDI tune request message." ;
midi:status "F6"^^xsd:hexBinary .
midi:VoiceMessage
a rdfs:Class ;
rdfs:subClassOf midi:MidiEvent ;
- rdfs:label "Voice Message;" ;
+ rdfs:label "Voice Message" ;
+ rdfs:comment "MIDI voice message." ;
midi:statusMask "F0"^^xsd:hexBinary .
midi:benderValue
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
+ rdfs:label "bender value" ;
rdfs:range xsd:short ;
- rdfs:comment "The value of a pitch bender (-8192 to 8192)." .
+ rdfs:comment "MIDI pitch bender message (-8192 to 8192)." .
midi:binding
a rdf:Property ,
owl:ObjectProperty ;
rdfs:range midi:MidiEvent ;
- lv2:documentation """
-<p>The MIDI event to bind a parameter to. This describes which MIDI events
-should be used to control a port, parameter, or other object. The binding
-should be a midi:MidiEvent but the property that represents the control value may
-be omitted. For example, to bind to the value of controller 17:</p>
-
-<pre class="turtle-code">
-port midi:binding [
- a midi:Controller ;
- midi:controllerNumber 17
-] .
-</pre>
-""" .
+ rdfs:label "binding" ;
+ rdfs:comment "The MIDI event to bind a parameter to." .
midi:byteNumber
a rdf:Property ,
owl:DatatypeProperty ;
+ rdfs:label "byte number" ;
rdfs:domain midi:Chunk ;
rdfs:range xsd:unsignedByte ;
rdfs:comment "The 0-based index of a byte which is part of this chunk." .
@@ -293,19 +264,22 @@ midi:channel
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
+ rdfs:label "MIDI channel" ;
rdfs:range xsd:unsignedByte ;
rdfs:comment "The channel number of a MIDI message." .
midi:chunk
- a rdf:Property ;
- rdfs:range xsd:byte ,
- xsd:hexBinary ;
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:range midi:Chunk ;
+ rdfs:label "MIDI chunk" ;
rdfs:comment "A chunk of a MIDI message." .
midi:controllerNumber
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
+ rdfs:label "MIDI controller number" ;
rdfs:range xsd:byte ;
rdfs:comment "The numeric ID of a controller (0 to 127)." .
@@ -313,6 +287,7 @@ midi:controllerValue
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
+ rdfs:label "MIDI controller value" ;
rdfs:range xsd:byte ;
rdfs:comment "The value of a controller (0 to 127)." .
@@ -320,6 +295,7 @@ midi:noteNumber
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
+ rdfs:label "note number" ;
rdfs:range xsd:byte ;
rdfs:comment "The numeric ID of a note (0 to 127)." .
@@ -327,6 +303,7 @@ midi:pressure
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
+ rdfs:label "key pressure" ;
rdfs:range xsd:byte ;
rdfs:comment "Key pressure (0 to 127)." .
@@ -334,6 +311,7 @@ midi:programNumber
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
+ rdfs:label "program number" ;
rdfs:range xsd:byte ;
rdfs:comment "The numeric ID of a program (0 to 127)." .
@@ -341,6 +319,7 @@ midi:property
a rdf:Property ,
owl:ObjectProperty ,
owl:FunctionalProperty ;
+ rdfs:label "property" ;
rdfs:domain midi:Chunk ;
rdfs:range rdf:Property ;
rdfs:comment "The property this chunk represents." .
@@ -349,6 +328,7 @@ midi:songNumber
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
+ rdfs:label "song number" ;
rdfs:range xsd:byte ;
rdfs:comment "The numeric ID of a song (0 to 127)." .
@@ -356,6 +336,7 @@ midi:songPosition
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
+ rdfs:label "song position" ;
rdfs:range xsd:short ;
rdfs:comment "Song position in MIDI beats (16th notes) (-8192 to 8192)." .
@@ -363,6 +344,7 @@ midi:status
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
+ rdfs:label "status byte" ;
rdfs:range midi:HexByte ;
rdfs:comment "The exact status byte for a message of this type." .
@@ -370,14 +352,15 @@ midi:statusMask
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
+ rdfs:label "status mask" ;
rdfs:range midi:HexByte ;
- rdfs:comment """
-The status byte for a message of this type on channel 1, i.e. a status byte
-with the lower nibble set to zero.""" .
+ rdfs:comment "The status byte for a message of this type on channel 1." .
midi:velocity
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
+ rdfs:label "velocity" ;
rdfs:range midi:HexByte ;
rdfs:comment "The velocity of a note message (0 to 127)." .
+
diff --git a/lv2/lv2plug.in/ns/ext/morph/manifest.ttl b/lv2/morph/manifest.ttl
index 40b0f2b..7c85cfd 100644
--- a/lv2/lv2plug.in/ns/ext/morph/manifest.ttl
+++ b/lv2/morph/manifest.ttl
@@ -1,4 +1,4 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/morph>
diff --git a/lv2/lv2plug.in/ns/ext/morph/morph.h b/lv2/morph/morph.h
index 6739d39..101df8e 100644
--- a/lv2/lv2plug.in/ns/ext/morph/morph.h
+++ b/lv2/morph/morph.h
@@ -1,5 +1,5 @@
/*
- Copyright 2012 David Robillard <http://drobilla.net>
+ Copyright 2012-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -14,21 +14,30 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-#ifndef LV2_MORPH_H
-#define LV2_MORPH_H
+/**
+ @defgroup morph Morph
+ @ingroup lv2
-#include <stdint.h>
+ Ports that can dynamically change type, see <http://lv2plug.in/ns/ext/morph>
+ for details.
+
+ @{
+*/
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
-#include "lv2/lv2plug.in/ns/ext/urid/urid.h"
+#ifndef LV2_MORPH_H
+#define LV2_MORPH_H
-#define LV2_MORPH_URI "http://lv2plug.in/ns/ext/morph"
-#define LV2_MORPH_PREFIX LV2_MORPH_URI "#"
+#define LV2_MORPH_URI "http://lv2plug.in/ns/ext/morph" ///< http://lv2plug.in/ns/ext/morph
+#define LV2_MORPH_PREFIX LV2_MORPH_URI "#" ///< http://lv2plug.in/ns/ext/morph#
-#define LV2_MORPH__AutoMorphPort LV2_MORPH_PREFIX "AutoMorphPort"
-#define LV2_MORPH__MorphPort LV2_MORPH_PREFIX "MorphPort"
-#define LV2_MORPH__interface LV2_MORPH_PREFIX "interface"
-#define LV2_MORPH__supportsType LV2_MORPH_PREFIX "supportsType"
-#define LV2_MORPH__currentType LV2_MORPH_PREFIX "currentType"
+#define LV2_MORPH__AutoMorphPort LV2_MORPH_PREFIX "AutoMorphPort" ///< http://lv2plug.in/ns/ext/morph#AutoMorphPort
+#define LV2_MORPH__MorphPort LV2_MORPH_PREFIX "MorphPort" ///< http://lv2plug.in/ns/ext/morph#MorphPort
+#define LV2_MORPH__interface LV2_MORPH_PREFIX "interface" ///< http://lv2plug.in/ns/ext/morph#interface
+#define LV2_MORPH__supportsType LV2_MORPH_PREFIX "supportsType" ///< http://lv2plug.in/ns/ext/morph#supportsType
+#define LV2_MORPH__currentType LV2_MORPH_PREFIX "currentType" ///< http://lv2plug.in/ns/ext/morph#currentType
#endif /* LV2_MORPH_H */
+
+/**
+ @}
+*/
diff --git a/lv2/morph/morph.meta.ttl b/lv2/morph/morph.meta.ttl
new file mode 100644
index 0000000..c247783
--- /dev/null
+++ b/lv2/morph/morph.meta.ttl
@@ -0,0 +1,90 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix morph: <http://lv2plug.in/ns/ext/morph#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/morph>
+ a doap:Project ;
+ doap:name "LV2 Morph" ;
+ doap:shortdesc "Ports that can dynamically change type." ;
+ doap:created "2012-05-22" ;
+ doap:developer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "1.0" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+This extension defines two port types: morph:MorphPort, which has a
+host-configurable type, and morph:AutoMorphPort, which may automatically change
+type when a MorphPort's type is changed. These ports always have a default
+type and work normally work in hosts that are unaware of this extension. Thus,
+this extension provides a backwards compatibility mechanism which allows
+plugins to use new port types but gracefully fall back to a default type in
+hosts that do not support them.
+
+This extension only defines port types and properties for describing morph
+ports. The actual run-time switching is done via the opts:interface API.
+
+"""^^lv2:Markdown .
+
+morph:MorphPort
+ lv2:documentation """
+
+Ports of this type MUST have another type which defines the default buffer
+format (for example lv2:ControlPort) but can be dynamically changed to a
+different type in hosts that support opts:interface.
+
+The host may change the type of a MorphPort by setting its morph:currentType
+with LV2_Options_Interface::set(). If the plugin has any morph:AutoMorphPort
+ports, the host MUST check their types after changing any port type since they
+may have changed.
+
+"""^^lv2:Markdown .
+
+morph:AutoMorphPort
+ lv2:documentation """
+
+Ports of this type MUST have another type which defines the default buffer
+format (for example, lv2:ControlPort) but may dynamically change types based on
+the configured types of any morph:MorphPort ports on the same plugin instance.
+
+The type of a port may only change in response to a host call to
+LV2_Options_Interface::set(). Whenever any port type on the instance changes,
+the host MUST check the type of all morph:AutoMorphPort ports with
+LV2_Options_Interface::get() before calling run() again, since they may have
+changed. If the type of any port is zero, it means the current configuration
+is invalid and the plugin may not be run (unless that port is
+lv2:connectionOptional and connected to NULL).
+
+This is mainly useful for outputs whose type depends on the type of
+corresponding inputs.
+
+"""^^lv2:Markdown .
+
+morph:supportsType
+ lv2:documentation """
+
+Indicates that a port supports being switched to a certain type. A MorphPort
+MUST list each type it supports being switched to in the plugin data using this
+property.
+
+"""^^lv2:Markdown .
+
+morph:currentType
+ lv2:documentation """
+
+The currently active type of the port. This is for dynamic use as an option
+and SHOULD NOT be listed in the static plugin data.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/morph/morph.ttl b/lv2/morph/morph.ttl
new file mode 100644
index 0000000..303293d
--- /dev/null
+++ b/lv2/morph/morph.ttl
@@ -0,0 +1,46 @@
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix morph: <http://lv2plug.in/ns/ext/morph#> .
+@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/morph>
+ a owl:Ontology ;
+ rdfs:label "LV2 Morph" ;
+ rdfs:comment "Ports that can dynamically change type." ;
+ rdfs:seeAlso <morph.h> ,
+ <morph.meta.ttl> .
+
+morph:MorphPort
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Port ;
+ rdfs:label "Morph Port" ;
+ rdfs:comment "A port which can be switched to another type." .
+
+morph:AutoMorphPort
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf lv2:Port ;
+ rdfs:label "Auto Morph Port" ;
+ rdfs:comment "A port that can change its type based on that of another." .
+
+morph:supportsType
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain morph:MorphPort ;
+ rdfs:label "supports type" ;
+ rdfs:comment "A type that a port supports being switched to." .
+
+morph:currentType
+ a rdf:Property ,
+ opts:Option ,
+ owl:ObjectProperty ;
+ rdfs:domain morph:MorphPort ;
+ rdfs:label "current type" ;
+ rdfs:comment "The currently active type of the port." .
+
diff --git a/lv2/lv2plug.in/ns/ext/options/manifest.ttl b/lv2/options/manifest.ttl
index c0c3315..18db448 100644
--- a/lv2/lv2plug.in/ns/ext/options/manifest.ttl
+++ b/lv2/options/manifest.ttl
@@ -1,8 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/options>
a lv2:Specification ;
lv2:minorVersion 1 ;
- lv2:microVersion 2 ;
+ lv2:microVersion 4 ;
rdfs:seeAlso <options.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/ext/options/options.h b/lv2/options/options.h
index 1a71a3e..2ed9f8a 100644
--- a/lv2/lv2plug.in/ns/ext/options/options.h
+++ b/lv2/options/options.h
@@ -1,5 +1,5 @@
/*
- Copyright 2012 David Robillard <http://drobilla.net>
+ Copyright 2012-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -14,22 +14,32 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+/**
+ @defgroup options Options
+ @ingroup lv2
+
+ Instantiation time options, see <http://lv2plug.in/ns/ext/options> for
+ details.
+
+ @{
+*/
+
#ifndef LV2_OPTIONS_H
#define LV2_OPTIONS_H
-#include <stdint.h>
+#include "lv2/core/lv2.h"
+#include "lv2/urid/urid.h"
-#include "lv2/lv2plug.in/ns/ext/urid/urid.h"
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
+#include <stdint.h>
-#define LV2_OPTIONS_URI "http://lv2plug.in/ns/ext/options"
-#define LV2_OPTIONS_PREFIX LV2_OPTIONS_URI "#"
+#define LV2_OPTIONS_URI "http://lv2plug.in/ns/ext/options" ///< http://lv2plug.in/ns/ext/options
+#define LV2_OPTIONS_PREFIX LV2_OPTIONS_URI "#" ///< http://lv2plug.in/ns/ext/options#
-#define LV2_OPTIONS__Option LV2_OPTIONS_PREFIX "Option"
-#define LV2_OPTIONS__interface LV2_OPTIONS_PREFIX "interface"
-#define LV2_OPTIONS__options LV2_OPTIONS_PREFIX "options"
-#define LV2_OPTIONS__requiredOption LV2_OPTIONS_PREFIX "requiredOption"
-#define LV2_OPTIONS__supportedOption LV2_OPTIONS_PREFIX "supportedOption"
+#define LV2_OPTIONS__Option LV2_OPTIONS_PREFIX "Option" ///< http://lv2plug.in/ns/ext/options#Option
+#define LV2_OPTIONS__interface LV2_OPTIONS_PREFIX "interface" ///< http://lv2plug.in/ns/ext/options#interface
+#define LV2_OPTIONS__options LV2_OPTIONS_PREFIX "options" ///< http://lv2plug.in/ns/ext/options#options
+#define LV2_OPTIONS__requiredOption LV2_OPTIONS_PREFIX "requiredOption" ///< http://lv2plug.in/ns/ext/options#requiredOption
+#define LV2_OPTIONS__supportedOption LV2_OPTIONS_PREFIX "supportedOption" ///< http://lv2plug.in/ns/ext/options#supportedOption
#ifdef __cplusplus
extern "C" {
@@ -76,7 +86,7 @@ typedef enum {
with data pointed to an array of options terminated by a zeroed option, or
accessed/manipulated using LV2_Options_Interface.
*/
-typedef struct _LV2_Options_Option {
+typedef struct {
LV2_Options_Context context; /**< Context (type of subject). */
uint32_t subject; /**< Subject. */
LV2_URID key; /**< Key (property). */
@@ -97,7 +107,7 @@ typedef enum {
/**
Interface for dynamically setting options (LV2_OPTIONS__interface).
*/
-typedef struct _LV2_Options_Interface {
+typedef struct {
/**
Get the given options.
@@ -130,3 +140,7 @@ typedef struct _LV2_Options_Interface {
#endif
#endif /* LV2_OPTIONS_H */
+
+/**
+ @}
+*/
diff --git a/lv2/options/options.meta.ttl b/lv2/options/options.meta.ttl
new file mode 100644
index 0000000..d545f95
--- /dev/null
+++ b/lv2/options/options.meta.ttl
@@ -0,0 +1,129 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix opts: <http://lv2plug.in/ns/ext/options#> .
+@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/options>
+ a doap:Project ;
+ doap:name "LV2 Options" ;
+ doap:shortdesc "Runtime options for LV2 plugins and UIs." ;
+ doap:created "2012-08-20" ;
+ doap:developer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "1.4" ;
+ doap:created "2019-02-03" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.16.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Relax range of opts:requiredOption and opts:supportedOption"
+ ]
+ ]
+ ] , [
+ doap:revision "1.2" ;
+ doap:created "2013-01-10" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Set the range of opts:requiredOption and opts:supportedOption to opts:Option."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+This extension defines a facility for <q>options</q>, which are values the host
+passes to a plugin or UI at run time.
+
+There are two facilities for passing options to an instance: opts:options
+allows passing options at instantiation time, and the opts:interface interface
+allows options to be dynamically set and retrieved after instantiation.
+
+Note that this extension is only for allowing hosts to configure plugins, and
+is not a <q>live</q> control mechanism. For real-time control, use event-based
+control via an atom:AtomPort with an atom:Sequence buffer.
+
+Instances may indicate they require an option with the opts:requiredOption
+property, or that they optionally support an option with the
+opts:supportedOption property.
+
+"""^^lv2:Markdown .
+
+opts:Option
+ lv2:documentation """
+
+It is not required for a property to explicitly be an Option in order to be
+used as such. However, properties which are primarily intended for use as
+options, or are at least particularly useful as options, should be explicitly
+given this type for documentation purposes, and to assist hosts in discovering
+option definitions.
+
+"""^^lv2:Markdown .
+
+opts:interface
+ lv2:documentation """
+
+An interface (LV2_Options_Interface) for dynamically setting and getting
+options. Note that this is intended for use by the host for configuring
+plugins only, and is not a <q>live</q> plugin control mechanism.
+
+The plugin data file should advertise this interface like so:
+
+ :::turtle
+ @prefix opts: &lt;http://lv2plug.in/ns/ext/options#&gt; .
+
+ &lt;plugin&gt;
+ a lv2:Plugin ;
+ lv2:extensionData opts:interface .
+
+"""^^lv2:Markdown .
+
+opts:options
+ lv2:documentation """
+
+To implement this feature, hosts MUST pass an LV2_Feature to the appropriate
+instantiate method with this URI and data pointed to an array of
+LV2_Options_Option terminated by an element with both key and value set to
+zero. The instance should cast this data pointer to `const
+LV2_Options_Option*` and scan the array for any options of interest. The
+instance MUST NOT modify the options array in any way.
+
+Note that requiring this feature may reduce the number of compatible hosts.
+Unless some options are strictly required by the instance, this feature SHOULD
+be listed as an lv2:optionalFeature.
+
+"""^^lv2:Markdown .
+
+opts:requiredOption
+ lv2:documentation """
+
+The host MUST pass a value for the specified option via opts:options during
+instantiation.
+
+Note that use of this property may reduce the number of compatible hosts.
+Wherever possible, it is better to list options with opts:supportedOption and
+fall back to a reasonable default value if it is not provided.
+
+"""^^lv2:Markdown .
+
+opts:supportedOption
+ lv2:documentation """
+
+The host SHOULD provide a value for the specified option if one is known, or
+provide the user an opportunity to specify one if possible.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/options/options.ttl b/lv2/options/options.ttl
new file mode 100644
index 0000000..f8388da
--- /dev/null
+++ b/lv2/options/options.ttl
@@ -0,0 +1,44 @@
+@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/options>
+ a owl:Ontology ;
+ rdfs:label "LV2 Options" ;
+ rdfs:comment "Runtime options for LV2 plugins and UIs." ;
+ rdfs:seeAlso <options.h> ,
+ <options.meta.ttl> .
+
+opts:Option
+ a rdfs:Class ;
+ rdfs:label "Option" ;
+ rdfs:subClassOf rdf:Property ;
+ rdfs:comment "A value for a static option passed to an instance." .
+
+opts:interface
+ a lv2:ExtensionData ;
+ rdfs:label "interface" ;
+ rdfs:comment "An interface for dynamically setting and getting options." .
+
+opts:options
+ a lv2:Feature ;
+ rdfs:label "options" ;
+ rdfs:comment "The feature used to provide options to an instance." .
+
+opts:requiredOption
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:range rdf:Property ;
+ rdfs:label "required option" ;
+ rdfs:comment "An option required by the instance to function at all." .
+
+opts:supportedOption
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:range rdf:Property ;
+ rdfs:label "supported option" ;
+ rdfs:comment "An option supported or by the instance." .
+
diff --git a/lv2/lv2plug.in/ns/ext/parameters/manifest.ttl b/lv2/parameters/manifest.ttl
index e9b6700..57f5d2e 100644
--- a/lv2/lv2plug.in/ns/ext/parameters/manifest.ttl
+++ b/lv2/parameters/manifest.ttl
@@ -1,8 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/parameters>
a lv2:Specification ;
lv2:minorVersion 1 ;
- lv2:microVersion 2 ;
+ lv2:microVersion 4 ;
rdfs:seeAlso <parameters.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/ext/parameters/parameters.h b/lv2/parameters/parameters.h
index 9c06bab..01c6dde 100644
--- a/lv2/lv2plug.in/ns/ext/parameters/parameters.h
+++ b/lv2/parameters/parameters.h
@@ -1,5 +1,5 @@
/*
- Copyright 2012 David Robillard <http://drobilla.net>
+ Copyright 2012-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -14,36 +14,50 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+/**
+ @defgroup parameters Parameters
+ @ingroup lv2
+
+ Common parameters for audio processing, see
+ <http://lv2plug.in/ns/ext/parameters>.
+
+ @{
+*/
+
#ifndef LV2_PARAMETERS_H
#define LV2_PARAMETERS_H
-#define LV2_PARAMETERS_URI "http://lv2plug.in/ns/ext/parameters"
-#define LV2_PARAMETERS_PREFIX LV2_PARAMETERS_URI "#"
-
-#define LV2_PARAMETERS__CompressorControls LV2_PARAMETERS_PREFIX "CompressorControls"
-#define LV2_PARAMETERS__ControlGroup LV2_PARAMETERS_PREFIX "ControlGroup"
-#define LV2_PARAMETERS__EnvelopeControls LV2_PARAMETERS_PREFIX "EnvelopeControls"
-#define LV2_PARAMETERS__FilterControls LV2_PARAMETERS_PREFIX "FilterControls"
-#define LV2_PARAMETERS__OscillatorControls LV2_PARAMETERS_PREFIX "OscillatorControls"
-#define LV2_PARAMETERS__amplitude LV2_PARAMETERS_PREFIX "amplitude"
-#define LV2_PARAMETERS__attack LV2_PARAMETERS_PREFIX "attack"
-#define LV2_PARAMETERS__bypass LV2_PARAMETERS_PREFIX "bypass"
-#define LV2_PARAMETERS__cutoffFrequency LV2_PARAMETERS_PREFIX "cutoffFrequency"
-#define LV2_PARAMETERS__decay LV2_PARAMETERS_PREFIX "decay"
-#define LV2_PARAMETERS__delay LV2_PARAMETERS_PREFIX "delay"
-#define LV2_PARAMETERS__dryLevel LV2_PARAMETERS_PREFIX "dryLevel"
-#define LV2_PARAMETERS__frequency LV2_PARAMETERS_PREFIX "frequency"
-#define LV2_PARAMETERS__gain LV2_PARAMETERS_PREFIX "gain"
-#define LV2_PARAMETERS__hold LV2_PARAMETERS_PREFIX "hold"
-#define LV2_PARAMETERS__pulseWidth LV2_PARAMETERS_PREFIX "pulseWidth"
-#define LV2_PARAMETERS__ratio LV2_PARAMETERS_PREFIX "ratio"
-#define LV2_PARAMETERS__release LV2_PARAMETERS_PREFIX "release"
-#define LV2_PARAMETERS__resonance LV2_PARAMETERS_PREFIX "resonance"
-#define LV2_PARAMETERS__sampleRate LV2_PARAMETERS_PREFIX "sampleRate"
-#define LV2_PARAMETERS__sustain LV2_PARAMETERS_PREFIX "sustain"
-#define LV2_PARAMETERS__threshold LV2_PARAMETERS_PREFIX "threshold"
-#define LV2_PARAMETERS__waveform LV2_PARAMETERS_PREFIX "waveform"
-#define LV2_PARAMETERS__wetDryRatio LV2_PARAMETERS_PREFIX "wetDryRatio"
-#define LV2_PARAMETERS__wetLevel LV2_PARAMETERS_PREFIX "wetLevel"
+#define LV2_PARAMETERS_URI "http://lv2plug.in/ns/ext/parameters" ///< http://lv2plug.in/ns/ext/parameters
+#define LV2_PARAMETERS_PREFIX LV2_PARAMETERS_URI "#" ///< http://lv2plug.in/ns/ext/parameters#
+
+#define LV2_PARAMETERS__CompressorControls LV2_PARAMETERS_PREFIX "CompressorControls" ///< http://lv2plug.in/ns/ext/parameters#CompressorControls
+#define LV2_PARAMETERS__ControlGroup LV2_PARAMETERS_PREFIX "ControlGroup" ///< http://lv2plug.in/ns/ext/parameters#ControlGroup
+#define LV2_PARAMETERS__EnvelopeControls LV2_PARAMETERS_PREFIX "EnvelopeControls" ///< http://lv2plug.in/ns/ext/parameters#EnvelopeControls
+#define LV2_PARAMETERS__FilterControls LV2_PARAMETERS_PREFIX "FilterControls" ///< http://lv2plug.in/ns/ext/parameters#FilterControls
+#define LV2_PARAMETERS__OscillatorControls LV2_PARAMETERS_PREFIX "OscillatorControls" ///< http://lv2plug.in/ns/ext/parameters#OscillatorControls
+#define LV2_PARAMETERS__amplitude LV2_PARAMETERS_PREFIX "amplitude" ///< http://lv2plug.in/ns/ext/parameters#amplitude
+#define LV2_PARAMETERS__attack LV2_PARAMETERS_PREFIX "attack" ///< http://lv2plug.in/ns/ext/parameters#attack
+#define LV2_PARAMETERS__bypass LV2_PARAMETERS_PREFIX "bypass" ///< http://lv2plug.in/ns/ext/parameters#bypass
+#define LV2_PARAMETERS__cutoffFrequency LV2_PARAMETERS_PREFIX "cutoffFrequency" ///< http://lv2plug.in/ns/ext/parameters#cutoffFrequency
+#define LV2_PARAMETERS__decay LV2_PARAMETERS_PREFIX "decay" ///< http://lv2plug.in/ns/ext/parameters#decay
+#define LV2_PARAMETERS__delay LV2_PARAMETERS_PREFIX "delay" ///< http://lv2plug.in/ns/ext/parameters#delay
+#define LV2_PARAMETERS__dryLevel LV2_PARAMETERS_PREFIX "dryLevel" ///< http://lv2plug.in/ns/ext/parameters#dryLevel
+#define LV2_PARAMETERS__frequency LV2_PARAMETERS_PREFIX "frequency" ///< http://lv2plug.in/ns/ext/parameters#frequency
+#define LV2_PARAMETERS__gain LV2_PARAMETERS_PREFIX "gain" ///< http://lv2plug.in/ns/ext/parameters#gain
+#define LV2_PARAMETERS__hold LV2_PARAMETERS_PREFIX "hold" ///< http://lv2plug.in/ns/ext/parameters#hold
+#define LV2_PARAMETERS__pulseWidth LV2_PARAMETERS_PREFIX "pulseWidth" ///< http://lv2plug.in/ns/ext/parameters#pulseWidth
+#define LV2_PARAMETERS__ratio LV2_PARAMETERS_PREFIX "ratio" ///< http://lv2plug.in/ns/ext/parameters#ratio
+#define LV2_PARAMETERS__release LV2_PARAMETERS_PREFIX "release" ///< http://lv2plug.in/ns/ext/parameters#release
+#define LV2_PARAMETERS__resonance LV2_PARAMETERS_PREFIX "resonance" ///< http://lv2plug.in/ns/ext/parameters#resonance
+#define LV2_PARAMETERS__sampleRate LV2_PARAMETERS_PREFIX "sampleRate" ///< http://lv2plug.in/ns/ext/parameters#sampleRate
+#define LV2_PARAMETERS__sustain LV2_PARAMETERS_PREFIX "sustain" ///< http://lv2plug.in/ns/ext/parameters#sustain
+#define LV2_PARAMETERS__threshold LV2_PARAMETERS_PREFIX "threshold" ///< http://lv2plug.in/ns/ext/parameters#threshold
+#define LV2_PARAMETERS__waveform LV2_PARAMETERS_PREFIX "waveform" ///< http://lv2plug.in/ns/ext/parameters#waveform
+#define LV2_PARAMETERS__wetDryRatio LV2_PARAMETERS_PREFIX "wetDryRatio" ///< http://lv2plug.in/ns/ext/parameters#wetDryRatio
+#define LV2_PARAMETERS__wetLevel LV2_PARAMETERS_PREFIX "wetLevel" ///< http://lv2plug.in/ns/ext/parameters#wetLevel
#endif /* LV2_PARAMETERS_H */
+
+/**
+ @}
+*/
diff --git a/lv2/parameters/parameters.meta.ttl b/lv2/parameters/parameters.meta.ttl
new file mode 100644
index 0000000..9d7c623
--- /dev/null
+++ b/lv2/parameters/parameters.meta.ttl
@@ -0,0 +1,75 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix param: <http://lv2plug.in/ns/ext/parameters#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/parameters>
+ a doap:Project ;
+ doap:name "LV2 Parameters" ;
+ doap:release [
+ doap:revision "1.4" ;
+ doap:created "2015-04-07" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.12.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add range to parameters so hosts know how to control them."
+ ]
+ ]
+ ] , [
+ doap:revision "1.2" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Use consistent label style."
+ ] , [
+ rdfs:label "Add param:sampleRate."
+ ] , [
+ rdfs:label "Add parameters.h of URI defines for convenience."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ doap:created "2009-00-00" ;
+ doap:shortdesc "Common parameters for audio processing." ;
+ doap:maintainer <http://drobilla.net/drobilla#me> ;
+ doap:developer <http://lv2plug.in/ns/meta#larsl> ;
+ lv2:documentation """
+
+This is a vocabulary for parameters that are 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
+(for example, using lv2:designation for ports) so they can be used more
+intelligently or presented to the user more efficiently.
+
+"""^^lv2:Markdown .
+
+param:wetDryRatio
+ a lv2:Parameter ;
+ rdfs:label "wet/dry ratio" ;
+ lv2:documentation """
+
+The ratio between processed and bypass components in output signal. The dry
+and wet percentages can be calculated from the following equations:
+
+ :::c
+ dry = (wetDryRatio.maximum - wetDryRatio.value) / wetDryRatio.maximum
+ wet = wetDryRatio.value / wetDryRatio.maximum
+
+Typically, maximum value of 1 or 100 and minimum value of 0 should be used.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/lv2plug.in/ns/ext/parameters/parameters.ttl b/lv2/parameters/parameters.ttl
index 8f05f74..5c3dadf 100644
--- a/lv2/lv2plug.in/ns/ext/parameters/parameters.ttl
+++ b/lv2/parameters/parameters.ttl
@@ -1,113 +1,122 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix atom: <http://lv2plug.in/ns/ext/atom#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
@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#> .
+@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#> .
+@prefix units: <http://lv2plug.in/ns/extensions/units#> .
<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> """ .
+ a owl:Ontology ;
+ rdfs:label "LV2 Parameters" ;
+ rdfs:comment "Common parameters for audio processing." ;
+ rdfs:seeAlso <parameters.meta.ttl> .
param:ControlGroup
a rdfs:Class ;
rdfs:subClassOf pg:Group ;
- rdfs:comment """
-A group representing a set of associated controls.
-""" .
+ rdfs:label "Control Group" ;
+ rdfs:comment "A group representing a set of associated controls." .
param:amplitude
a lv2:Parameter ;
- rdfs:label "amplitude" .
+ rdfs:range atom:Float ;
+ rdfs:label "amplitude" ;
+ rdfs:comment "An amplitude as a factor, where 0 is silent and 1 is unity." .
param:attack
a lv2:Parameter ;
+ rdfs:range atom:Float ;
rdfs:label "attack" ;
- rdfs:comment "The duration of an envelope's attack stage." .
+ rdfs:comment "The duration of an envelope attack stage." .
param:cutoffFrequency
a lv2:Parameter ;
- rdfs:label "cutoff frequency" .
+ rdfs:range atom:Float ;
+ rdfs:label "cutoff frequency" ;
+ rdfs:comment "The cutoff frequency, typically in Hz, for a filter." .
param:decay
a lv2:Parameter ;
+ rdfs:range atom:Float ;
rdfs:label "decay" ;
- rdfs:comment "The duration of an envelope's decay stage." .
+ rdfs:comment "The duration of an envelope decay stage." .
param:delay
a lv2:Parameter ;
+ rdfs:range atom:Float ;
rdfs:label "delay" ;
- rdfs:comment "The duration of an envelope's delay stage." .
+ rdfs:comment "The duration of an envelope delay stage." .
param:frequency
a lv2:Parameter ;
- rdfs:label "frequency" .
+ rdfs:range atom:Float ;
+ rdfs:label "frequency" ;
+ rdfs:comment "A frequency, typically in Hz." .
param:hold
a lv2:Parameter ;
+ rdfs:range atom:Float ;
rdfs:label "hold" ;
- rdfs:comment "The duration of an envelope's hold stage." .
+ rdfs:comment "The duration of an envelope hold stage." .
param:pulseWidth
a lv2:Parameter ;
+ rdfs:range atom:Float ;
rdfs:label "pulse width" ;
rdfs:comment "The width of a pulse of a rectangular waveform." .
param:ratio
a lv2:Parameter ;
+ rdfs:range atom:Float ;
rdfs:label "ratio" ;
- rdfs:comment "Compression ration." .
+ rdfs:comment "Compression ratio." .
param:release
a lv2:Parameter ;
+ rdfs:range atom:Float ;
rdfs:label "release" ;
- rdfs:comment "The duration of an envelope's release stage." .
+ rdfs:comment "The duration of an envelope release stage." .
param:resonance
a lv2:Parameter ;
+ rdfs:range atom:Float ;
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." .
+ rdfs:range atom:Float ;
+ rdfs:comment "The level of an envelope sustain stage as a factor." .
param:threshold
a lv2:Parameter ;
+ rdfs:range atom:Float ;
rdfs:label "threshold" ;
rdfs:comment "Compression threshold." .
param:waveform
a lv2:Parameter ;
- rdfs:label "waveform" .
+ rdfs:range atom:Float ;
+ rdfs:label "waveform" ;
+ rdfs:comment """The waveform "fader" for oscillators or modulators that have several.""" .
param:gain
a lv2:Parameter ;
+ rdfs:range atom:Float ;
+ lv2:default 0.0 ;
+ lv2:minimum -20.0 ;
+ lv2:maximum 20.0 ;
+ units:unit units:db ;
rdfs:label "gain" ;
- rdfs:comment "A factor which controls an output level." .
+ rdfs:comment "Gain in decibels." .
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>
-""" .
+ rdfs:comment "The ratio between processed and bypassed levels in the output." .
param:wetLevel
a lv2:Parameter ;
@@ -122,7 +131,7 @@ param:dryLevel
param:bypass
a lv2:Parameter ;
rdfs:label "bypass" ;
- rdfs:comment "A boolean parameter that disabled processing if true." .
+ rdfs:comment "A boolean parameter that disables processing if true." .
param:sampleRate
a lv2:Parameter ;
@@ -132,7 +141,8 @@ param:sampleRate
param:EnvelopeControls
a rdfs:Class ;
rdfs:subClassOf param:ControlGroup ;
- rdfs:label "DAHDSR Envelope Controls" ;
+ rdfs:label "Envelope Controls" ;
+ rdfs:comment "Typical controls for a DAHDSR envelope." ;
pg:element [
lv2:index 0 ;
lv2:designation param:delay
@@ -157,6 +167,7 @@ param:OscillatorControls
a rdfs:Class ;
rdfs:subClassOf param:ControlGroup ;
rdfs:label "Oscillator Controls" ;
+ rdfs:comment "Typical controls for an oscillator." ;
pg:element [
lv2:designation param:frequency
] , [
@@ -171,6 +182,7 @@ param:FilterControls
a rdfs:Class ;
rdfs:subClassOf param:ControlGroup ;
rdfs:label "Filter Controls" ;
+ rdfs:comment "Typical controls for a filter." ;
pg:element [
lv2:designation param:cutoffFrequency
] , [
@@ -181,8 +193,10 @@ param:CompressorControls
a rdfs:Class ;
rdfs:subClassOf param:ControlGroup ;
rdfs:label "Compressor Controls" ;
+ rdfs:comment "Typical controls for a compressor." ;
pg:element [
lv2:designation param:threshold
] , [
lv2:designation param:ratio
] .
+
diff --git a/lv2/lv2plug.in/ns/ext/patch/manifest.ttl b/lv2/patch/manifest.ttl
index fcc06be..25150bd 100644
--- a/lv2/lv2plug.in/ns/ext/patch/manifest.ttl
+++ b/lv2/patch/manifest.ttl
@@ -1,8 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/patch>
a lv2:Specification ;
lv2:minorVersion 2 ;
- lv2:microVersion 0 ;
+ lv2:microVersion 8 ;
rdfs:seeAlso <patch.ttl> .
+
diff --git a/lv2/patch/patch.h b/lv2/patch/patch.h
new file mode 100644
index 0000000..a721c5e
--- /dev/null
+++ b/lv2/patch/patch.h
@@ -0,0 +1,68 @@
+/*
+ Copyright 2012-2016 David Robillard <http://drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+/**
+ @defgroup patch Patch
+ @ingroup lv2
+
+ Messages for accessing and manipulating properties, see
+ <http://lv2plug.in/ns/ext/patch> for details.
+
+ Note the patch extension is purely data, this header merely defines URIs for
+ convenience.
+
+ @{
+*/
+
+#ifndef LV2_PATCH_H
+#define LV2_PATCH_H
+
+#define LV2_PATCH_URI "http://lv2plug.in/ns/ext/patch" ///< http://lv2plug.in/ns/ext/patch
+#define LV2_PATCH_PREFIX LV2_PATCH_URI "#" ///< http://lv2plug.in/ns/ext/patch#
+
+#define LV2_PATCH__Ack LV2_PATCH_PREFIX "Ack" ///< http://lv2plug.in/ns/ext/patch#Ack
+#define LV2_PATCH__Delete LV2_PATCH_PREFIX "Delete" ///< http://lv2plug.in/ns/ext/patch#Delete
+#define LV2_PATCH__Copy LV2_PATCH_PREFIX "Copy" ///< http://lv2plug.in/ns/ext/patch#Copy
+#define LV2_PATCH__Error LV2_PATCH_PREFIX "Error" ///< http://lv2plug.in/ns/ext/patch#Error
+#define LV2_PATCH__Get LV2_PATCH_PREFIX "Get" ///< http://lv2plug.in/ns/ext/patch#Get
+#define LV2_PATCH__Message LV2_PATCH_PREFIX "Message" ///< http://lv2plug.in/ns/ext/patch#Message
+#define LV2_PATCH__Move LV2_PATCH_PREFIX "Move" ///< http://lv2plug.in/ns/ext/patch#Move
+#define LV2_PATCH__Patch LV2_PATCH_PREFIX "Patch" ///< http://lv2plug.in/ns/ext/patch#Patch
+#define LV2_PATCH__Post LV2_PATCH_PREFIX "Post" ///< http://lv2plug.in/ns/ext/patch#Post
+#define LV2_PATCH__Put LV2_PATCH_PREFIX "Put" ///< http://lv2plug.in/ns/ext/patch#Put
+#define LV2_PATCH__Request LV2_PATCH_PREFIX "Request" ///< http://lv2plug.in/ns/ext/patch#Request
+#define LV2_PATCH__Response LV2_PATCH_PREFIX "Response" ///< http://lv2plug.in/ns/ext/patch#Response
+#define LV2_PATCH__Set LV2_PATCH_PREFIX "Set" ///< http://lv2plug.in/ns/ext/patch#Set
+#define LV2_PATCH__accept LV2_PATCH_PREFIX "accept" ///< http://lv2plug.in/ns/ext/patch#accept
+#define LV2_PATCH__add LV2_PATCH_PREFIX "add" ///< http://lv2plug.in/ns/ext/patch#add
+#define LV2_PATCH__body LV2_PATCH_PREFIX "body" ///< http://lv2plug.in/ns/ext/patch#body
+#define LV2_PATCH__context LV2_PATCH_PREFIX "context" ///< http://lv2plug.in/ns/ext/patch#context
+#define LV2_PATCH__destination LV2_PATCH_PREFIX "destination" ///< http://lv2plug.in/ns/ext/patch#destination
+#define LV2_PATCH__property LV2_PATCH_PREFIX "property" ///< http://lv2plug.in/ns/ext/patch#property
+#define LV2_PATCH__readable LV2_PATCH_PREFIX "readable" ///< http://lv2plug.in/ns/ext/patch#readable
+#define LV2_PATCH__remove LV2_PATCH_PREFIX "remove" ///< http://lv2plug.in/ns/ext/patch#remove
+#define LV2_PATCH__request LV2_PATCH_PREFIX "request" ///< http://lv2plug.in/ns/ext/patch#request
+#define LV2_PATCH__subject LV2_PATCH_PREFIX "subject" ///< http://lv2plug.in/ns/ext/patch#subject
+#define LV2_PATCH__sequenceNumber LV2_PATCH_PREFIX "sequenceNumber" ///< http://lv2plug.in/ns/ext/patch#sequenceNumber
+#define LV2_PATCH__value LV2_PATCH_PREFIX "value" ///< http://lv2plug.in/ns/ext/patch#value
+#define LV2_PATCH__wildcard LV2_PATCH_PREFIX "wildcard" ///< http://lv2plug.in/ns/ext/patch#wildcard
+#define LV2_PATCH__writable LV2_PATCH_PREFIX "writable" ///< http://lv2plug.in/ns/ext/patch#writable
+
+#endif /* LV2_PATCH_H */
+
+/**
+ @}
+*/
diff --git a/lv2/patch/patch.meta.ttl b/lv2/patch/patch.meta.ttl
new file mode 100644
index 0000000..549757a
--- /dev/null
+++ b/lv2/patch/patch.meta.ttl
@@ -0,0 +1,374 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix patch: <http://lv2plug.in/ns/ext/patch#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/patch>
+ a doap:Project ;
+ doap:created "2012-02-09" ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ doap:developer <http://drobilla.net/drobilla#me> ;
+ doap:name "LV2 Patch" ;
+ doap:shortdesc "A protocol for accessing and manipulating properties." ;
+ doap:release [
+ doap:revision "2.8" ;
+ doap:created "2020-04-26" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.18.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix incorrect type of patch:sequenceNumber."
+ ]
+ ]
+ ] , [
+ doap:revision "2.6" ;
+ doap:created "2019-02-03" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.16.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add patch:accept property."
+ ] , [
+ rdfs:label "Add patch:context property."
+ ]
+ ]
+ ] , [
+ doap:revision "2.4" ;
+ doap:created "2015-04-07" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.12.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Define patch:Get with no subject to implicitly apply to reciever. This can be used by UIs to get an initial description of a plugin."
+ ] , [
+ rdfs:label "Add patch:Copy method."
+ ]
+ ]
+ ] , [
+ doap:revision "2.2" ;
+ doap:created "2014-08-08" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.10.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add patch:sequenceNumber for associating replies with requests."
+ ]
+ ]
+ ] , [
+ doap:revision "2.0" ;
+ doap:created "2013-01-10" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Make patch:Set a compact message for setting one property."
+ ] , [
+ rdfs:label "Add patch:readable and patch:writable for describing available properties."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+This is a vocabulary for messages that access and manipulate properties.
+It can be used as a dynamic control interface for plugins,
+or anything else with a property-based model.
+
+The key underlying concept here is to control things by manipulating arbitrary properties,
+rather than by calling application-specific methods.
+This allows implementations to understand what messages do
+(at least in a mechanical sense),
+which makes things like caching, proxying, or undo relatively straightforward to implement.
+Note, however, that this is only conceptual:
+there is no requirement to implement a general property store.
+Typically, a plugin will understand a fixed set of properties that represent its parameters or other internal state, and ignore everything else.
+
+This protocol is syntax-agnostic,
+and [homoiconic](https://en.wikipedia.org/wiki/Homoiconicity)
+in the sense that the messages use the same format as the data they manipulate.
+In particular, messages can be serialised as a binary [Object](atom.html#Object) for realtime plugin control,
+or as Turtle for saving to a file,
+sending over a network,
+printing for debugging purposes,
+and so on.
+
+This specification only defines a semantic protocol,
+there is no corresponding API.
+It can be used with the [Atom](atom.html) extension to control plugins which support message-based parameters as defined by the [Parameters](parameters.html) extension.
+
+For example, if a plugin defines a `eg:volume` parameter, it can be controlled by the host by sending a patch:Set message to the plugin instance:
+
+ :::turtle
+ [
+ a patch:Set ;
+ patch:property eg:volume ;
+ patch:value 11.0 ;
+ ]
+
+Similarly, the host could get the current value for this parameter by sending a patch:Get message:
+
+ :::turtle
+ [
+ a patch:Get ;
+ patch:property eg:volume ;
+ ]
+
+The plugin would then respond with the same patch:Set message as above.
+In this case, the plugin instance is implicitly the patch:subject,
+but a specific subject can also be given for deeper control.
+
+"""^^lv2:Markdown .
+
+patch:Copy
+ lv2:documentation """
+
+After this, the destination has the same description as the subject,
+and the subject is unchanged.
+
+It is an error if the subject does not exist,
+or if the destination already exists.
+
+Multiple subjects may be given if the destination is a container,
+but the semantics of this case are application-defined.
+
+"""^^lv2:Markdown .
+
+patch:Get
+ lv2:documentation """
+
+If a patch:property is given,
+then the receiver should respond with a patch:Set message that gives only that property.
+
+Otherwise, it should respond with a [concise bounded description](http://www.w3.org/Submission/CBD/) in a patch:Put message,
+that is, a description that recursively includes any blank node values.
+
+If a patch:subject is given, then the response should have the same subject.
+If no subject is given, then the receiver is implicitly the subject.
+
+If a patch:request node or a patch:sequenceNumber is given,
+then the response should be a patch:Response and have the same property.
+If neither is given, then the receiver can respond with a simple patch:Put message.
+For example:
+
+ :::turtle
+ []
+ a patch:Get ;
+ patch:subject eg:something .
+
+Could result in:
+
+ :::turtle
+ []
+ a patch:Put ;
+ patch:subject eg:something ;
+ patch:body [
+ eg:name "Something" ;
+ eg:ratio 1.6180339887 ;
+ ] .
+
+"""^^lv2:Markdown .
+
+patch:Insert
+ lv2:documentation """
+
+If the subject does not exist, it is created. If the subject does already
+exist, it is added to.
+
+This request only adds properties, it never removes them. The user must take
+care that multiple values are not set for properties which should only have
+one.
+
+"""^^lv2:Markdown .
+
+patch:Message
+ lv2:documentation """
+
+This is an abstract base class for all patch messages. Concrete messages are
+either a patch:Request or a patch:Response.
+
+"""^^lv2:Markdown .
+
+patch:Move
+ lv2:documentation """
+
+After this, the destination has the description that the subject had, and the
+subject no longer exists.
+
+It is an error if the subject does not exist, or if the destination already
+exists.
+
+"""^^lv2:Markdown .
+
+patch:Patch
+ lv2:documentation """
+
+This method always has at least one subject, and exactly one patch:add and
+patch:remove property. The value of patch:add and patch:remove are nodes which
+have the properties to add or remove from the subject(s), respectively. The
+special value patch:wildcard may be used as the value of a remove property to
+remove all properties with the given predicate. For example:
+
+ :::turtle
+ []
+ a patch:Patch ;
+ patch:subject &lt;something&gt; ;
+ patch:add [
+ eg:name "New name" ;
+ eg:age 42 ;
+ ] ;
+ patch:remove [
+ eg:name "Old name" ;
+ eg:age patch:wildcard ; # Remove all old eg:age properties
+ ] .
+
+"""^^lv2:Markdown .
+
+patch:Put
+ lv2:documentation """
+
+If the subject does not already exist, it is created. If the subject does
+already exist, the patch:body is considered an updated version of it, and the
+previous version is replaced.
+
+ :::turtle
+ []
+ a patch:Put ;
+ patch:subject &lt;something&gt; ;
+ patch:body [
+ eg:name "New name" ;
+ eg:age 42 ;
+ ] .
+
+"""^^lv2:Markdown .
+
+patch:Request
+ a rdfs:Class ;
+ rdfs:label "Request" ;
+ rdfs:subClassOf patch:Message ;
+ lv2:documentation """
+
+A request may have a patch:subject property, which specifies the resource that
+the request applies to. The subject may be omitted in contexts where it is
+implicit, for example if the recipient is the subject.
+
+"""^^lv2:Markdown .
+
+patch:Set
+ lv2:documentation """
+
+This is equivalent to a patch:Patch which removes _all_ pre-existing values for
+the property before setting the new value. For example:
+
+ :::turtle
+ []
+ a patch:Set ;
+ patch:subject &lt;something&gt; ;
+ patch:property eg:name ;
+ patch:value "New name" .
+
+Which is equivalent to:
+
+ :::turtle
+ []
+ a patch:Patch ;
+ patch:subject &lt;something&gt; ;
+ patch:add [
+ eg:name "New name" ;
+ ] ;
+ patch:remove [
+ eg:name patch:wildcard ;
+ ] .
+
+"""^^lv2:Markdown .
+
+patch:body
+ lv2:documentation """
+
+The details of this property's value depend on the type of message it is a part
+of.
+
+"""^^lv2:Markdown .
+
+patch:context
+ lv2:documentation """
+
+For example, a plugin may have a special context for ephemeral properties which
+are only relevant during the lifetime of the instance and should not be saved
+in state.
+
+The specific uses for contexts are application specific. However, the context
+MUST be a URI, and can be interpreted as the ID of a data model where
+properties should be stored. Implementations MAY have special support for
+contexts, for example by storing in a quad store or serializing to a format
+that supports multiple RDF graphs such as TriG.
+
+"""^^lv2:Markdown .
+
+patch:readable
+ lv2:documentation """
+
+See the similar patch:writable property for details.
+
+"""^^lv2:Markdown .
+
+patch:request
+ lv2:documentation """
+
+This can be used if referring directly to the URI or blank node ID of the
+request is possible. Otherwise, use patch:sequenceNumber.
+
+"""^^lv2:Markdown .
+
+patch:sequenceNumber
+ lv2:documentation """
+
+This property is used to associate replies with requests when it is not
+feasible to refer to request URIs with patch:request. A patch:Response with a
+given sequence number is the reply to the previously send patch:Request with
+the same sequence number.
+
+The special sequence number 0 means that no reply is desired.
+
+"""^^lv2:Markdown .
+
+patch:wildcard
+ lv2:documentation """
+
+This makes it possible to describe the removal of all values for a given
+property.
+
+"""^^lv2:Markdown .
+
+patch:writable
+ lv2:documentation """
+
+This is used to list properties that can be changed, for example to allow user
+interfaces to present appropriate controls. For example:
+
+ :::turtle
+ @prefix eg: &lt;http://example.org/&gt; .
+ @prefix rdf: &lt;http://www.w3.org/1999/02/22-rdf-syntax-ns#&gt; .
+ @prefix rdfs: &lt;http://www.w3.org/2000/01/rdf-schema#&gt; .
+ @prefix xsd: &lt;http://www.w3.org/2001/XMLSchema#&gt; .
+
+ eg:title
+ a rdf:Property ;
+ rdfs:label "title" ;
+ rdfs:range xsd:string .
+
+ eg:plugin
+ patch:writable eg:title .
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/patch/patch.ttl b/lv2/patch/patch.ttl
new file mode 100644
index 0000000..7804009
--- /dev/null
+++ b/lv2/patch/patch.ttl
@@ -0,0 +1,251 @@
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix patch: <http://lv2plug.in/ns/ext/patch#> .
+@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/patch>
+ a owl:Ontology ;
+ rdfs:seeAlso <patch.h> ,
+ <patch.meta.ttl> ;
+ rdfs:label "LV2 Patch" ;
+ rdfs:comment "A protocol for accessing and manipulating properties." .
+
+patch:Ack
+ a rdfs:Class ;
+ rdfs:subClassOf patch:Response ;
+ rdfs:label "Ack" ;
+ rdfs:comment "An acknowledgement that a request was successful." .
+
+patch:Copy
+ a rdfs:Class ;
+ rdfs:subClassOf patch:Request ;
+ rdfs:label "Copy" ;
+ rdfs:subClassOf [
+ a owl:Restriction ;
+ owl:minCardinality 1 ;
+ owl:onProperty patch:subject
+ ] , [
+ a owl:Restriction ;
+ owl:cardinality 1 ;
+ owl:onProperty patch:destination
+ ] ;
+ rdfs:comment "A request to copy the patch:subject to the patch:destination." .
+
+patch:Delete
+ a rdfs:Class ;
+ rdfs:subClassOf patch:Request ;
+ rdfs:label "Delete" ;
+ rdfs:comment "Request that the patch:subject or subjects be deleted." .
+
+patch:Error
+ a rdfs:Class ;
+ rdfs:subClassOf patch:Response ;
+ rdfs:label "Error" ;
+ rdfs:comment "A response indicating an error processing a request." .
+
+patch:Get
+ a rdfs:Class ;
+ rdfs:subClassOf patch:Request ;
+ rdfs:label "Get" ;
+ rdfs:comment "A request for a description of the patch:subject." .
+
+patch:Insert
+ a rdfs:Class ;
+ rdfs:subClassOf patch:Request ;
+ rdfs:label "Insert" ;
+ rdfs:subClassOf [
+ a owl:Restriction ;
+ owl:cardinality 1 ;
+ owl:onProperty patch:subject
+ ] ;
+ rdfs:comment "A request to insert a patch:body into the patch:subject." .
+
+patch:Message
+ a rdfs:Class ;
+ rdfs:label "Patch Message" ;
+ rdfs:comment "A patch message." .
+
+patch:Move
+ a rdfs:Class ;
+ rdfs:subClassOf patch:Request ;
+ rdfs:label "Move" ;
+ rdfs:subClassOf [
+ a owl:Restriction ;
+ owl:cardinality 1 ;
+ owl:onProperty patch:subject
+ ] , [
+ a owl:Restriction ;
+ owl:cardinality 1 ;
+ owl:onProperty patch:destination
+ ] ;
+ rdfs:comment "A request to move the patch:subject to the patch:destination." .
+
+patch:Patch
+ a rdfs:Class ;
+ rdfs:subClassOf patch:Request ,
+ [
+ a owl:Restriction ;
+ owl:minCardinality 1 ;
+ owl:onProperty patch:subject
+ ] , [
+ a owl:Restriction ;
+ owl:cardinality 1 ;
+ owl:onProperty patch:add
+ ] , [
+ a owl:Restriction ;
+ owl:cardinality 1 ;
+ owl:onProperty patch:remove
+ ] ;
+ rdfs:label "Patch" ;
+ rdfs:comment "A request to add and/or remove properties of the patch:subject." .
+
+patch:Put
+ a rdfs:Class ;
+ rdfs:subClassOf patch:Request ;
+ rdfs:label "Put" ;
+ rdfs:subClassOf [
+ a owl:Restriction ;
+ owl:cardinality 1 ;
+ owl:onProperty patch:subject
+ ] ;
+ rdfs:comment "A request to put the patch:body as the patch:subject." .
+
+patch:Request
+ a rdfs:Class ;
+ rdfs:label "Request" ;
+ rdfs:subClassOf patch:Message ;
+ rdfs:comment "A patch request message." .
+
+patch:Response
+ a rdfs:Class ;
+ rdfs:subClassOf patch:Message ;
+ rdfs:label "Response" ;
+ rdfs:comment "A response to a patch:Request." .
+
+patch:Set
+ a rdfs:Class ;
+ rdfs:label "Set" ;
+ rdfs:subClassOf patch:Request ,
+ [
+ a owl:Restriction ;
+ owl:cardinality 1 ;
+ owl:onProperty patch:property
+ ] , [
+ a owl:Restriction ;
+ owl:cardinality 1 ;
+ owl:onProperty patch:value
+ ] ;
+ rdfs:comment "A compact request to set a property to a value." .
+
+patch:accept
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:label "accept" ;
+ rdfs:domain patch:Request ;
+ rdfs:range rdfs:Class ;
+ rdfs:comment "An accepted type for a response." .
+
+patch:add
+ a rdf:Property ,
+ owl:ObjectProperty ,
+ owl:FunctionalProperty ;
+ rdfs:domain patch:Patch ;
+ rdfs:range rdfs:Resource ;
+ rdfs:label "add" ;
+ rdfs:comment "The properties to add to the subject." .
+
+patch:body
+ a rdf:Property ,
+ owl:ObjectProperty ,
+ owl:FunctionalProperty ;
+ rdfs:domain patch:Message ;
+ rdfs:label "body" ;
+ rdfs:comment "The body of a message." .
+
+patch:context
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain patch:Message ;
+ rdfs:label "context" ;
+ rdfs:comment "The context of properties in this message." .
+
+patch:destination
+ a rdf:Property ,
+ owl:ObjectProperty ,
+ owl:FunctionalProperty ;
+ rdfs:domain patch:Message ;
+ rdfs:label "destination" ;
+ rdfs:comment "The destination to move the patch:subject to." .
+
+patch:property
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:label "property" ;
+ rdfs:domain patch:Message ;
+ rdfs:range rdf:Property ;
+ rdfs:comment "The property for a patch:Set or patch:Get message." .
+
+patch:readable
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:label "readable" ;
+ rdfs:range rdf:Property ;
+ rdfs:comment "A property that can be read with a patch:Get message." .
+
+patch:remove
+ a rdf:Property ,
+ owl:ObjectProperty ,
+ owl:FunctionalProperty ;
+ rdfs:label "remove" ;
+ rdfs:domain patch:Patch ;
+ rdfs:range rdfs:Resource ;
+ rdfs:comment "The properties to remove from the subject." .
+
+patch:request
+ a rdf:Property ,
+ owl:ObjectProperty ,
+ owl:FunctionalProperty ;
+ rdfs:label "request" ;
+ rdfs:domain patch:Response ;
+ rdfs:range patch:Request ;
+ rdfs:comment "The request this is a response to." .
+
+patch:sequenceNumber
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ owl:FunctionalProperty ;
+ rdfs:label "sequence number" ;
+ rdfs:domain patch:Message ;
+ rdfs:range xsd:int ;
+ rdfs:comment "The sequence number of a request or response." .
+
+patch:subject
+ a rdf:Property ,
+ owl:ObjectProperty ,
+ owl:FunctionalProperty ;
+ rdfs:domain patch:Message ;
+ rdfs:label "subject" ;
+ rdfs:comment "The subject this message applies to." .
+
+patch:value
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:label "value" ;
+ rdfs:domain patch:Set ;
+ rdfs:range rdf:Property ;
+ rdfs:comment "The value of a property in a patch:Set message." .
+
+patch:wildcard
+ a rdfs:Resource ;
+ rdfs:label "wildcard" ;
+ rdfs:comment "A wildcard that matches any resource." .
+
+patch:writable
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:label "writable" ;
+ rdfs:range rdf:Property ;
+ rdfs:comment "A property that can be set with a patch:Set or patch:Patch message." .
+
diff --git a/lv2/lv2plug.in/ns/ext/port-groups/manifest.ttl b/lv2/port-groups/manifest.ttl
index fa893c6..a887cb0 100644
--- a/lv2/lv2plug.in/ns/ext/port-groups/manifest.ttl
+++ b/lv2/port-groups/manifest.ttl
@@ -1,9 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/port-groups>
a lv2:Specification ;
lv2:minorVersion 1 ;
- lv2:microVersion 2 ;
+ lv2:microVersion 4 ;
rdfs:seeAlso <port-groups.ttl> .
diff --git a/lv2/port-groups/port-groups.h b/lv2/port-groups/port-groups.h
new file mode 100644
index 0000000..4c5699f
--- /dev/null
+++ b/lv2/port-groups/port-groups.h
@@ -0,0 +1,72 @@
+/*
+ Copyright 2012-2016 David Robillard <http://drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+/**
+ @defgroup port-groups Port Groups
+ @ingroup lv2
+
+ Multi-channel groups of LV2 ports, see
+ <http://lv2plug.in/ns/ext/port-groups> for details.
+
+ @{
+*/
+
+#ifndef LV2_PORT_GROUPS_H
+#define LV2_PORT_GROUPS_H
+
+#define LV2_PORT_GROUPS_URI "http://lv2plug.in/ns/ext/port-groups" ///< http://lv2plug.in/ns/ext/port-groups
+#define LV2_PORT_GROUPS_PREFIX LV2_PORT_GROUPS_URI "#" ///< http://lv2plug.in/ns/ext/port-groups#
+
+#define LV2_PORT_GROUPS__DiscreteGroup LV2_PORT_GROUPS_PREFIX "DiscreteGroup" ///< http://lv2plug.in/ns/ext/port-groups#DiscreteGroup
+#define LV2_PORT_GROUPS__Element LV2_PORT_GROUPS_PREFIX "Element" ///< http://lv2plug.in/ns/ext/port-groups#Element
+#define LV2_PORT_GROUPS__FivePointOneGroup LV2_PORT_GROUPS_PREFIX "FivePointOneGroup" ///< http://lv2plug.in/ns/ext/port-groups#FivePointOneGroup
+#define LV2_PORT_GROUPS__FivePointZeroGroup LV2_PORT_GROUPS_PREFIX "FivePointZeroGroup" ///< http://lv2plug.in/ns/ext/port-groups#FivePointZeroGroup
+#define LV2_PORT_GROUPS__FourPointZeroGroup LV2_PORT_GROUPS_PREFIX "FourPointZeroGroup" ///< http://lv2plug.in/ns/ext/port-groups#FourPointZeroGroup
+#define LV2_PORT_GROUPS__Group LV2_PORT_GROUPS_PREFIX "Group" ///< http://lv2plug.in/ns/ext/port-groups#Group
+#define LV2_PORT_GROUPS__InputGroup LV2_PORT_GROUPS_PREFIX "InputGroup" ///< http://lv2plug.in/ns/ext/port-groups#InputGroup
+#define LV2_PORT_GROUPS__MidSideGroup LV2_PORT_GROUPS_PREFIX "MidSideGroup" ///< http://lv2plug.in/ns/ext/port-groups#MidSideGroup
+#define LV2_PORT_GROUPS__MonoGroup LV2_PORT_GROUPS_PREFIX "MonoGroup" ///< http://lv2plug.in/ns/ext/port-groups#MonoGroup
+#define LV2_PORT_GROUPS__OutputGroup LV2_PORT_GROUPS_PREFIX "OutputGroup" ///< http://lv2plug.in/ns/ext/port-groups#OutputGroup
+#define LV2_PORT_GROUPS__SevenPointOneGroup LV2_PORT_GROUPS_PREFIX "SevenPointOneGroup" ///< http://lv2plug.in/ns/ext/port-groups#SevenPointOneGroup
+#define LV2_PORT_GROUPS__SevenPointOneWideGroup LV2_PORT_GROUPS_PREFIX "SevenPointOneWideGroup" ///< http://lv2plug.in/ns/ext/port-groups#SevenPointOneWideGroup
+#define LV2_PORT_GROUPS__SixPointOneGroup LV2_PORT_GROUPS_PREFIX "SixPointOneGroup" ///< http://lv2plug.in/ns/ext/port-groups#SixPointOneGroup
+#define LV2_PORT_GROUPS__StereoGroup LV2_PORT_GROUPS_PREFIX "StereoGroup" ///< http://lv2plug.in/ns/ext/port-groups#StereoGroup
+#define LV2_PORT_GROUPS__ThreePointZeroGroup LV2_PORT_GROUPS_PREFIX "ThreePointZeroGroup" ///< http://lv2plug.in/ns/ext/port-groups#ThreePointZeroGroup
+#define LV2_PORT_GROUPS__center LV2_PORT_GROUPS_PREFIX "center" ///< http://lv2plug.in/ns/ext/port-groups#center
+#define LV2_PORT_GROUPS__centerLeft LV2_PORT_GROUPS_PREFIX "centerLeft" ///< http://lv2plug.in/ns/ext/port-groups#centerLeft
+#define LV2_PORT_GROUPS__centerRight LV2_PORT_GROUPS_PREFIX "centerRight" ///< http://lv2plug.in/ns/ext/port-groups#centerRight
+#define LV2_PORT_GROUPS__element LV2_PORT_GROUPS_PREFIX "element" ///< http://lv2plug.in/ns/ext/port-groups#element
+#define LV2_PORT_GROUPS__group LV2_PORT_GROUPS_PREFIX "group" ///< http://lv2plug.in/ns/ext/port-groups#group
+#define LV2_PORT_GROUPS__left LV2_PORT_GROUPS_PREFIX "left" ///< http://lv2plug.in/ns/ext/port-groups#left
+#define LV2_PORT_GROUPS__lowFrequencyEffects LV2_PORT_GROUPS_PREFIX "lowFrequencyEffects" ///< http://lv2plug.in/ns/ext/port-groups#lowFrequencyEffects
+#define LV2_PORT_GROUPS__mainInput LV2_PORT_GROUPS_PREFIX "mainInput" ///< http://lv2plug.in/ns/ext/port-groups#mainInput
+#define LV2_PORT_GROUPS__mainOutput LV2_PORT_GROUPS_PREFIX "mainOutput" ///< http://lv2plug.in/ns/ext/port-groups#mainOutput
+#define LV2_PORT_GROUPS__rearCenter LV2_PORT_GROUPS_PREFIX "rearCenter" ///< http://lv2plug.in/ns/ext/port-groups#rearCenter
+#define LV2_PORT_GROUPS__rearLeft LV2_PORT_GROUPS_PREFIX "rearLeft" ///< http://lv2plug.in/ns/ext/port-groups#rearLeft
+#define LV2_PORT_GROUPS__rearRight LV2_PORT_GROUPS_PREFIX "rearRight" ///< http://lv2plug.in/ns/ext/port-groups#rearRight
+#define LV2_PORT_GROUPS__right LV2_PORT_GROUPS_PREFIX "right" ///< http://lv2plug.in/ns/ext/port-groups#right
+#define LV2_PORT_GROUPS__side LV2_PORT_GROUPS_PREFIX "side" ///< http://lv2plug.in/ns/ext/port-groups#side
+#define LV2_PORT_GROUPS__sideChainOf LV2_PORT_GROUPS_PREFIX "sideChainOf" ///< http://lv2plug.in/ns/ext/port-groups#sideChainOf
+#define LV2_PORT_GROUPS__sideLeft LV2_PORT_GROUPS_PREFIX "sideLeft" ///< http://lv2plug.in/ns/ext/port-groups#sideLeft
+#define LV2_PORT_GROUPS__sideRight LV2_PORT_GROUPS_PREFIX "sideRight" ///< http://lv2plug.in/ns/ext/port-groups#sideRight
+#define LV2_PORT_GROUPS__source LV2_PORT_GROUPS_PREFIX "source" ///< http://lv2plug.in/ns/ext/port-groups#source
+#define LV2_PORT_GROUPS__subGroupOf LV2_PORT_GROUPS_PREFIX "subGroupOf" ///< http://lv2plug.in/ns/ext/port-groups#subGroupOf
+
+#endif /* LV2_PORT_GROUPS_H */
+
+/**
+ @}
+*/
diff --git a/lv2/port-groups/port-groups.meta.ttl b/lv2/port-groups/port-groups.meta.ttl
new file mode 100644
index 0000000..67408ec
--- /dev/null
+++ b/lv2/port-groups/port-groups.meta.ttl
@@ -0,0 +1,144 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix pg: <http://lv2plug.in/ns/ext/port-groups#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/port-groups>
+ a doap:Project ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ doap:name "LV2 Port Groups" ;
+ doap:shortdesc "Multi-channel groups of LV2 ports." ;
+ doap:created "2008-00-00" ;
+ doap:developer <http://lv2plug.in/ns/meta#larsl> ,
+ <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "1.4" ;
+ doap:created "2020-04-26" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.18.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Replace broken links with detailed Ambisonic channel descriptions."
+ ] , [
+ rdfs:label "Remove incorrect type of pg:letterCode."
+ ]
+ ]
+ ] , [
+ doap:revision "1.2" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Use consistent label style."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] .
+
+pg:Group
+ lv2:documentation """
+
+A group logically combines ports which should be considered part of the same
+stream. For example, two audio ports in a group may form a stereo stream.
+
+Like ports, groups have a lv2:symbol that is unique within the context of the
+plugin, where group symbols and port symbols reside in the same namespace. In
+other words, a group on a plugin MUST NOT have the same symbol as any other
+group or port on that plugin. This makes it possible to uniquely reference a
+port or group on a plugin with a single identifier and no context.
+
+Group definitions may be shared across plugins for brevity. For example, a
+plugin collection may define a single URI for a pg:StereoGroup with the symbol
+"input" and use it in many plugins.
+
+"""^^lv2:Markdown .
+
+pg:sideChainOf
+ lv2:documentation """
+
+Indicates that this port or group should be considered a "side chain" of some
+other port or group. The precise definition of "side chain" depends on the
+plugin, but in general this group should be considered a modifier to some other
+group, rather than an independent input itself.
+
+"""^^lv2:Markdown .
+
+pg:subGroupOf
+ lv2:documentation """
+
+Indicates that this group is a child of another group. This property has no
+meaning with respect to plugin execution, but the host may find this
+information useful to provide a better user interface. Note that being a
+sub-group does not relax the restriction that the group MUST have a unique
+symbol with respect to the plugin.
+
+"""^^lv2:Markdown .
+
+pg:source
+ lv2:documentation """
+
+Indicates that this port or group should be considered the "result" of some
+other port or group. This property only makes sense on groups with outputs
+when the source is a group with inputs. This can be used to convey a
+relationship between corresponding input and output groups with different
+types, for example in a mono to stereo plugin.
+
+"""^^lv2:Markdown .
+
+pg:mainInput
+ lv2:documentation """
+
+Indicates that this group should be considered the "main" input, i.e. the
+primary task is processing the signal in this group. A plugin MUST NOT have
+more than one pg:mainInput property.
+
+"""^^lv2:Markdown .
+
+pg:mainOutput
+ lv2:documentation """
+
+Indicates that this group should be considered the "main" output. The main
+output group SHOULD have the main input group as a pg:source.
+
+"""^^lv2:Markdown .
+
+pg:group
+ lv2:documentation """
+
+Indicates that this port is a part of a group of ports on the plugin. The port
+should also have an lv2:designation property to define its designation within
+that group.
+
+"""^^lv2:Markdown .
+
+pg:DiscreteGroup
+ lv2:documentation """
+
+These groups are divided into channels where each represents a particular
+speaker location. The position of sound in one of these groups depends on a
+particular speaker configuration.
+
+"""^^lv2:Markdown .
+
+pg:AmbisonicGroup
+ lv2:documentation """
+
+These groups are divided into channels which together represent a position in
+an abstract n-dimensional space. The position of sound in one of these groups
+does not depend on a particular speaker configuration; a decoder can be used to
+convert an ambisonic stream for any speaker configuration.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/port-groups/port-groups.ttl b/lv2/port-groups/port-groups.ttl
new file mode 100644
index 0000000..aefe8f8
--- /dev/null
+++ b/lv2/port-groups/port-groups.ttl
@@ -0,0 +1,807 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@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#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+<http://lv2plug.in/ns/ext/port-groups>
+ a owl:Ontology ;
+ rdfs:label "LV2 Port Groups" ;
+ rdfs:comment "Multi-channel groups of LV2 ports." ;
+ rdfs:seeAlso <port-groups.meta.ttl> .
+
+pg:Group
+ a rdfs:Class ;
+ rdfs:label "Port Group" ;
+ rdfs:subClassOf [
+ a owl:Restriction ;
+ owl:onProperty lv2:symbol ;
+ owl:cardinality 1 ;
+ rdfs:comment "A Group MUST have exactly one string lv2:symbol."
+ ] ;
+ rdfs:comment "A set of ports that are logicaly grouped together." .
+
+pg:InputGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:Group ;
+ rdfs:label "Input Group" ;
+ rdfs:comment "A group which contains exclusively inputs." .
+
+pg:OutputGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:Group ;
+ rdfs:label "Output Group" ;
+ rdfs:comment "A group which contains exclusively outputs." .
+
+pg:Element
+ a rdfs:Class ;
+ rdfs:label "Element" ;
+ rdfs:comment "An ordered element of a group." ;
+ rdfs:subClassOf [
+ a owl:Restriction ;
+ owl:onProperty lv2:designation ;
+ owl:cardinality 1 ;
+ rdfs:comment "An element MUST have exactly one lv2:designation."
+ ] ;
+ rdfs:comment "An element of a group, with a designation and optional index." .
+
+pg:element
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:range pg:Element ;
+ rdfs:label "element" ;
+ rdfs:comment "An element within a port group." .
+
+pg:sideChainOf
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:label "side-chain of" ;
+ rdfs:comment "Port or grou is a side chain of another." .
+
+pg:subGroupOf
+ a rdf:Property ,
+ owl:ObjectProperty ,
+ owl:FunctionalProperty ;
+ rdfs:domain pg:Group ;
+ rdfs:range pg:Group ;
+ rdfs:label "sub-group of" ;
+ rdfs:comment "Group is a child of another group." .
+
+pg:source
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain pg:OutputGroup ;
+ rdfs:range pg:InputGroup ;
+ rdfs:label "source" ;
+ rdfs:comment "Port or group that this group is the output of." .
+
+pg:mainInput
+ a rdf:Property ,
+ owl:ObjectProperty ,
+ owl:FunctionalProperty ;
+ rdfs:domain lv2:Plugin ;
+ rdfs:range pg:InputGroup ;
+ rdfs:label "main input" ;
+ rdfs:comment "Input group that is the primary input of the plugin." .
+
+pg:mainOutput
+ a rdf:Property ,
+ owl:ObjectProperty ,
+ owl:FunctionalProperty ;
+ rdfs:domain lv2:Plugin ;
+ rdfs:range pg:OutputGroup ;
+ rdfs:label "main output" ;
+ rdfs:comment "Output group that is the primary output of the plugin." .
+
+pg:group
+ a rdf:Property ,
+ owl:ObjectProperty ,
+ owl:FunctionalProperty ;
+ rdfs:domain lv2:Port ;
+ rdfs:range pg:Group ;
+ rdfs:label "group" ;
+ rdfs:comment "Group that this port is a part of." .
+
+pg:DiscreteGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:Group ;
+ rdfs:label "Discrete Group" ;
+ rdfs:comment "A group of discrete channels." .
+
+pg:left
+ a lv2:Channel ;
+ rdfs:label "left" ;
+ rdfs:comment "The left channel of a stereo audio group." .
+
+pg:right
+ a lv2:Channel ;
+ rdfs:label "right" ;
+ rdfs:comment "The right channel of a stereo audio group." .
+
+pg:center
+ a lv2:Channel ;
+ rdfs:label "center" ;
+ rdfs:comment "The center channel of a discrete audio group." .
+
+pg:side
+ a lv2:Channel ;
+ rdfs:label "side" ;
+ rdfs:comment "The side channel of a mid-side audio group." .
+
+pg:centerLeft
+ a lv2:Channel ;
+ rdfs:label "center left" ;
+ rdfs:comment "The center-left channel of a 7.1 wide surround sound group." .
+
+pg:centerRight
+ a lv2:Channel ;
+ rdfs:label "center right" ;
+ rdfs:comment "The center-right channel of a 7.1 wide surround sound group." .
+
+pg:sideLeft
+ a lv2:Channel ;
+ rdfs:label "side left" ;
+ rdfs:comment "The side-left channel of a 6.1 or 7.1 surround sound group." .
+
+pg:sideRight
+ a lv2:Channel ;
+ rdfs:label "side right" ;
+ rdfs:comment "The side-right channel of a 6.1 or 7.1 surround sound group." .
+
+pg:rearLeft
+ a lv2:Channel ;
+ rdfs:label "rear left" ;
+ rdfs:comment "The rear-left channel of a surround sound group." .
+
+pg:rearRight
+ a lv2:Channel ;
+ rdfs:label "rear right" ;
+ rdfs:comment "The rear-right channel of a surround sound group." .
+
+pg:rearCenter
+ a lv2:Channel ;
+ rdfs:label "rear center" ;
+ rdfs:comment "The rear-center channel of a surround sound group." .
+
+pg:lowFrequencyEffects
+ a lv2:Channel ;
+ rdfs:label "low-frequency effects" ;
+ rdfs:comment "The LFE channel of a *.1 surround sound group." .
+
+pg:MonoGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:DiscreteGroup ;
+ rdfs:label "Mono" ;
+ rdfs:comment "A single channel audio group." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:center
+ ] .
+
+pg:StereoGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:DiscreteGroup ;
+ rdfs:label "Stereo" ;
+ rdfs:comment "A 2-channel discrete stereo audio group." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:left
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:right
+ ] .
+
+pg:MidSideGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:DiscreteGroup ;
+ rdfs:label "Mid-Side Stereo" ;
+ rdfs:comment "A 2-channel mid-side stereo audio group." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:center
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:side
+ ] .
+
+pg:ThreePointZeroGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:DiscreteGroup ;
+ rdfs:label "3.0 Surround" ;
+ rdfs:comment "A 3.0 discrete surround sound group." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:left
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:right
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:rearCenter
+ ] .
+
+pg:FourPointZeroGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:DiscreteGroup ;
+ rdfs:label "4.0 Surround" ;
+ rdfs:comment "A 4.0 (Quadraphonic) discrete surround sound group." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:left
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:center
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:right
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:rearCenter
+ ] .
+
+pg:FivePointZeroGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:DiscreteGroup ;
+ rdfs:label "5.0 Surround" ;
+ rdfs:comment "A 5.0 (3-2 stereo) discrete surround sound group." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:left
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:center
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:right
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:rearLeft
+ ] , [
+ lv2:index 4 ;
+ lv2:designation pg:rearRight
+ ] .
+
+pg:FivePointOneGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:DiscreteGroup ;
+ rdfs:label "5.1 Surround" ;
+ rdfs:comment "A 5.1 (3-2 stereo with sub) discrete surround sound group." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:left
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:center
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:right
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:rearLeft
+ ] , [
+ lv2:index 4 ;
+ lv2:designation pg:rearRight
+ ] , [
+ lv2:index 5 ;
+ lv2:designation pg:lowFrequencyEffects
+ ] .
+
+pg:SixPointOneGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:DiscreteGroup ;
+ rdfs:label "6.1 Surround" ;
+ rdfs:comment "A 6.1 discrete surround sound group." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:left
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:center
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:right
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:sideLeft
+ ] , [
+ lv2:index 4 ;
+ lv2:designation pg:sideRight
+ ] , [
+ lv2:index 5 ;
+ lv2:designation pg:rearCenter
+ ] , [
+ lv2:index 6 ;
+ lv2:designation pg:lowFrequencyEffects
+ ] .
+
+pg:SevenPointOneGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:DiscreteGroup ;
+ rdfs:label "7.1 Surround" ;
+ rdfs:comment "A 7.1 discrete surround sound group." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:left
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:center
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:right
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:sideLeft
+ ] , [
+ lv2:index 4 ;
+ lv2:designation pg:sideRight
+ ] , [
+ lv2:index 5 ;
+ lv2:designation pg:rearLeft
+ ] , [
+ lv2:index 6 ;
+ lv2:designation pg:rearRight
+ ] , [
+ lv2:index 7 ;
+ lv2:designation pg:lowFrequencyEffects
+ ] .
+
+pg:SevenPointOneWideGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:DiscreteGroup ;
+ rdfs:label "7.1 Surround (Wide)" ;
+ rdfs:comment "A 7.1 wide discrete surround sound group." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:left
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:centerLeft
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:center
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:centerRight
+ ] , [
+ lv2:index 4 ;
+ lv2:designation pg:right
+ ] , [
+ lv2:index 5 ;
+ lv2:designation pg:rearLeft
+ ] , [
+ lv2:index 6 ;
+ lv2:designation pg:rearRight
+ ] , [
+ lv2:index 7 ;
+ lv2:designation pg:lowFrequencyEffects
+ ] .
+
+pg:letterCode
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:domain lv2:Channel ;
+ rdfs:range rdf:PlainLiteral ;
+ rdfs:label "ambisonic letter code" ;
+ rdfs:comment "The YuMa letter code for an Ambisonic channel." .
+
+pg:harmonicDegree
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:domain lv2:Channel ;
+ rdfs:range xsd:integer ;
+ rdfs:label "harmonic degree" ;
+ rdfs:comment "The degree coefficient (l) of the spherical harmonic for an Ambisonic channel." .
+
+pg:harmonicIndex
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:domain lv2:Channel ;
+ rdfs:range xsd:integer ;
+ rdfs:label "harmonic index" ;
+ rdfs:comment "The index coefficient (m) of the spherical harmonic for an Ambisonic channel." .
+
+pg:ACN0
+ a lv2:Channel ;
+ pg:letterCode "W" ;
+ pg:harmonicDegree 0 ;
+ pg:harmonicIndex 0 ;
+ rdfs:label "ACN0" ;
+ rdfs:comment "Ambisonic channel 0 (W): degree 0, index 0." .
+
+pg:ACN1
+ a lv2:Channel ;
+ pg:letterCode "Y" ;
+ pg:harmonicDegree 1 ;
+ pg:harmonicIndex -1 ;
+ rdfs:label "ACN1" ;
+ rdfs:comment "Ambisonic channel 1 (Y): degree 1, index -1." .
+
+pg:ACN2
+ a lv2:Channel ;
+ pg:letterCode "Z" ;
+ pg:harmonicDegree 1 ;
+ pg:harmonicIndex 0 ;
+ rdfs:label "ACN2" ;
+ rdfs:comment "Ambisonic channel 2 (Z): degree 1, index 0." .
+
+pg:ACN3
+ a lv2:Channel ;
+ pg:letterCode "X" ;
+ pg:harmonicDegree 1 ;
+ pg:harmonicIndex 1 ;
+ rdfs:label "ACN3" ;
+ rdfs:comment "Ambisonic channel 3 (X): degree 1, index 1." .
+
+pg:ACN4
+ a lv2:Channel ;
+ pg:letterCode "V" ;
+ pg:harmonicDegree 2 ;
+ pg:harmonicIndex -2 ;
+ rdfs:label "ACN4" ;
+ rdfs:comment "Ambisonic channel 4 (V): degree 2, index -2." .
+
+pg:ACN5
+ a lv2:Channel ;
+ pg:letterCode "T" ;
+ pg:harmonicDegree 2 ;
+ pg:harmonicIndex -1 ;
+ rdfs:label "ACN5" ;
+ rdfs:comment "Ambisonic channel 5 (T): degree 2, index -1." .
+
+pg:ACN6
+ a lv2:Channel ;
+ pg:letterCode "R" ;
+ pg:harmonicDegree 2 ;
+ pg:harmonicIndex 0 ;
+ rdfs:label "ACN6" ;
+ rdfs:comment "Ambisonic channel 6 (R): degree 2, index 0." .
+
+pg:ACN7
+ a lv2:Channel ;
+ pg:letterCode "S" ;
+ pg:harmonicDegree 2 ;
+ pg:harmonicIndex 1 ;
+ rdfs:label "ACN7" ;
+ rdfs:comment "Ambisonic channel 7 (S): degree 2, index 1." .
+
+pg:ACN8
+ a lv2:Channel ;
+ pg:letterCode "U" ;
+ pg:harmonicDegree 2 ;
+ pg:harmonicIndex 2 ;
+ rdfs:label "ACN8" ;
+ rdfs:comment "Ambisonic channel 8 (U): degree 2, index 2." .
+
+pg:ACN9
+ a lv2:Channel ;
+ pg:letterCode "Q" ;
+ pg:harmonicDegree 3 ;
+ pg:harmonicIndex -3 ;
+ rdfs:label "ACN9" ;
+ rdfs:comment "Ambisonic channel 9 (Q): degree 3, index -3." .
+
+pg:ACN10
+ a lv2:Channel ;
+ pg:letterCode "O" ;
+ pg:harmonicDegree 3 ;
+ pg:harmonicIndex -2 ;
+ rdfs:label "ACN10" ;
+ rdfs:comment "Ambisonic channel 10 (O): degree 3, index -2." .
+
+pg:ACN11
+ a lv2:Channel ;
+ pg:letterCode "M" ;
+ pg:harmonicDegree 3 ;
+ pg:harmonicIndex -1 ;
+ rdfs:label "ACN11" ;
+ rdfs:comment "Ambisonic channel 11 (M): degree 3, index -1." .
+
+pg:ACN12
+ a lv2:Channel ;
+ pg:letterCode "K" ;
+ pg:harmonicDegree 3 ;
+ pg:harmonicIndex 0 ;
+ rdfs:label "ACN12" ;
+ rdfs:comment "Ambisonic channel 12 (K): degree 3, index 0." .
+
+pg:ACN13
+ a lv2:Channel ;
+ pg:letterCode "L" ;
+ pg:harmonicDegree 3 ;
+ pg:harmonicIndex 1 ;
+ rdfs:label "ACN13" ;
+ rdfs:comment "Ambisonic channel 13 (L): degree 3, index 1." .
+
+pg:ACN14
+ a lv2:Channel ;
+ pg:letterCode "N" ;
+ pg:harmonicDegree 3 ;
+ pg:harmonicIndex 2 ;
+ rdfs:label "ACN14" ;
+ rdfs:comment "Ambisonic channel 14 (N): degree 3, index 2." .
+
+pg:ACN15
+ a lv2:Channel ;
+ pg:letterCode "P" ;
+ pg:harmonicDegree 3 ;
+ pg:harmonicIndex 3 ;
+ rdfs:label "ACN15" ;
+ rdfs:comment "Ambisonic channel 15 (P): degree 3, index 3." .
+
+pg:AmbisonicGroup
+ a rdfs:Class ;
+ rdfs:subClassOf pg:Group ;
+ rdfs:label "Ambisonic Group" ;
+ rdfs:comment "A group of Ambisonic channels." .
+
+pg:AmbisonicBH1P0Group
+ a rdfs:Class ;
+ rdfs:subClassOf pg:AmbisonicGroup ;
+ rdfs:label "Ambisonic BH1P0" ;
+ rdfs:comment "Ambisonic B stream of horizontal order 1 and peripheral order 0." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:ACN0
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:ACN1
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:ACN3
+ ] .
+
+pg:AmbisonicBH1P1Group
+ a rdfs:Class ;
+ rdfs:subClassOf pg:AmbisonicGroup ;
+ rdfs:label "Ambisonic BH1P1" ;
+ rdfs:comment "Ambisonic B stream of horizontal order 1 and peripheral order 1." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:ACN0
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:ACN1
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:ACN2
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:ACN3
+ ] .
+
+pg:AmbisonicBH2P0Group
+ a rdfs:Class ;
+ rdfs:subClassOf pg:AmbisonicGroup ;
+ rdfs:label "Ambisonic BH2P0" ;
+ rdfs:comment "Ambisonic B stream of horizontal order 2 and peripheral order 0." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:ACN0
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:ACN1
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:ACN3
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:ACN4
+ ] , [
+ lv2:index 4 ;
+ lv2:designation pg:ACN8
+ ] .
+
+pg:AmbisonicBH2P1Group
+ a rdfs:Class ;
+ rdfs:subClassOf pg:AmbisonicGroup ;
+ rdfs:label "Ambisonic BH2P1" ;
+ rdfs:comment "Ambisonic B stream of horizontal order 2 and peripheral order 1." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:ACN0
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:ACN1
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:ACN2
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:ACN3
+ ] , [
+ lv2:index 4 ;
+ lv2:designation pg:ACN4
+ ] , [
+ lv2:index 5 ;
+ lv2:designation pg:ACN8
+ ] .
+
+pg:AmbisonicBH2P2Group
+ a rdfs:Class ;
+ rdfs:subClassOf pg:AmbisonicGroup ;
+ rdfs:label "Ambisonic BH2P2" ;
+ rdfs:comment "Ambisonic B stream of horizontal order 2 and peripheral order 2." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:ACN0
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:ACN1
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:ACN2
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:ACN3
+ ] , [
+ lv2:index 4 ;
+ lv2:designation pg:ACN4
+ ] , [
+ lv2:index 5 ;
+ lv2:designation pg:ACN5
+ ] , [
+ lv2:index 6 ;
+ lv2:designation pg:ACN6
+ ] , [
+ lv2:index 7 ;
+ lv2:designation pg:ACN7
+ ] , [
+ lv2:index 8 ;
+ lv2:designation pg:ACN8
+ ] .
+
+pg:AmbisonicBH3P0Group
+ a rdfs:Class ;
+ rdfs:subClassOf pg:AmbisonicGroup ;
+ rdfs:label "Ambisonic BH3P0" ;
+ rdfs:comment "Ambisonic B stream of horizontal order 3 and peripheral order 0." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:ACN0
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:ACN1
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:ACN3
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:ACN4
+ ] , [
+ lv2:index 4 ;
+ lv2:designation pg:ACN8
+ ] , [
+ lv2:index 5 ;
+ lv2:designation pg:ACN9
+ ] , [
+ lv2:index 6 ;
+ lv2:designation pg:ACN15
+ ] .
+
+pg:AmbisonicBH3P1Group
+ a rdfs:Class ;
+ rdfs:subClassOf pg:AmbisonicGroup ;
+ rdfs:label "Ambisonic BH3P1" ;
+ rdfs:comment "Ambisonic B stream of horizontal order 3 and peripheral order 1." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:ACN0
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:ACN1
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:ACN2
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:ACN3
+ ] , [
+ lv2:index 4 ;
+ lv2:designation pg:ACN4
+ ] , [
+ lv2:index 5 ;
+ lv2:designation pg:ACN8
+ ] , [
+ lv2:index 6 ;
+ lv2:designation pg:ACN9
+ ] , [
+ lv2:index 7 ;
+ lv2:designation pg:ACN15
+ ] .
+
+pg:AmbisonicBH3P2Group
+ a rdfs:Class ;
+ rdfs:subClassOf pg:AmbisonicGroup ;
+ rdfs:label "Ambisonic BH3P2" ;
+ rdfs:comment "Ambisonic B stream of horizontal order 3 and peripheral order 2." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:ACN0
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:ACN1
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:ACN2
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:ACN3
+ ] , [
+ lv2:index 4 ;
+ lv2:designation pg:ACN4
+ ] , [
+ lv2:index 5 ;
+ lv2:designation pg:ACN5
+ ] , [
+ lv2:index 6 ;
+ lv2:designation pg:ACN6
+ ] , [
+ lv2:index 7 ;
+ lv2:designation pg:ACN7
+ ] , [
+ lv2:index 8 ;
+ lv2:designation pg:ACN8
+ ] , [
+ lv2:index 9 ;
+ lv2:designation pg:ACN9
+ ] , [
+ lv2:index 10 ;
+ lv2:designation pg:ACN15
+ ] .
+
+pg:AmbisonicBH3P3Group
+ a rdfs:Class ;
+ rdfs:subClassOf pg:AmbisonicGroup ;
+ rdfs:label "Ambisonic BH3P3" ;
+ rdfs:comment "Ambisonic B stream of horizontal order 3 and peripheral order 3." ;
+ pg:element [
+ lv2:index 0 ;
+ lv2:designation pg:ACN0
+ ] , [
+ lv2:index 1 ;
+ lv2:designation pg:ACN1
+ ] , [
+ lv2:index 2 ;
+ lv2:designation pg:ACN2
+ ] , [
+ lv2:index 3 ;
+ lv2:designation pg:ACN3
+ ] , [
+ lv2:index 4 ;
+ lv2:designation pg:ACN4
+ ] , [
+ lv2:index 5 ;
+ lv2:designation pg:ACN5
+ ] , [
+ lv2:index 6 ;
+ lv2:designation pg:ACN6
+ ] , [
+ lv2:index 7 ;
+ lv2:designation pg:ACN7
+ ] , [
+ lv2:index 8 ;
+ lv2:designation pg:ACN8
+ ] , [
+ lv2:index 9 ;
+ lv2:designation pg:ACN9
+ ] , [
+ lv2:index 10 ;
+ lv2:designation pg:ACN10
+ ] , [
+ lv2:index 11 ;
+ lv2:designation pg:ACN11
+ ] , [
+ lv2:index 12 ;
+ lv2:designation pg:ACN12
+ ] , [
+ lv2:index 13 ;
+ lv2:designation pg:ACN13
+ ] , [
+ lv2:index 14 ;
+ lv2:designation pg:ACN14
+ ] , [
+ lv2:index 15 ;
+ lv2:designation pg:ACN15
+ ] .
+
diff --git a/lv2/lv2plug.in/ns/ext/port-props/manifest.ttl b/lv2/port-props/manifest.ttl
index 27f15c9..45f598d 100644
--- a/lv2/lv2plug.in/ns/ext/port-props/manifest.ttl
+++ b/lv2/port-props/manifest.ttl
@@ -1,4 +1,4 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/port-props>
@@ -6,3 +6,4 @@
lv2:minorVersion 1 ;
lv2:microVersion 2 ;
rdfs:seeAlso <port-props.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/ext/port-props/port-props.h b/lv2/port-props/port-props.h
index 11274cc..eb55130 100644
--- a/lv2/lv2plug.in/ns/ext/port-props/port-props.h
+++ b/lv2/port-props/port-props.h
@@ -1,5 +1,5 @@
/*
- Copyright 2012 David Robillard <http://drobilla.net>
+ Copyright 2012-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -15,28 +15,35 @@
*/
/**
- @file port-props.h
- C definitions for the LV2 Port Props extension
- <http://lv2plug.in/ns/ext/port-props>.
+ @defgroup port-props Port Properties
+ @ingroup lv2
+
+ Various port properties.
+
+ @{
*/
#ifndef LV2_PORT_PROPS_H
#define LV2_PORT_PROPS_H
-#define LV2_PORT_PROPS_URI "http://lv2plug.in/ns/ext/port-props"
-#define LV2_PORT_PROPS_PREFIX LV2_PORT_PROPS_URI "#"
-
-#define LV2_PORT_PROPS__causesArtifacts LV2_PORT_PROPS_PREFIX "causesArtifacts"
-#define LV2_PORT_PROPS__continuousCV LV2_PORT_PROPS_PREFIX "continuousCV"
-#define LV2_PORT_PROPS__discreteCV LV2_PORT_PROPS_PREFIX "discreteCV"
-#define LV2_PORT_PROPS__displayPriority LV2_PORT_PROPS_PREFIX "displayPriority"
-#define LV2_PORT_PROPS__expensive LV2_PORT_PROPS_PREFIX "expensive"
-#define LV2_PORT_PROPS__hasStrictBounds LV2_PORT_PROPS_PREFIX "hasStrictBounds"
-#define LV2_PORT_PROPS__logarithmic LV2_PORT_PROPS_PREFIX "logarithmic"
-#define LV2_PORT_PROPS__notAutomatic LV2_PORT_PROPS_PREFIX "notAutomatic"
-#define LV2_PORT_PROPS__notOnGUI LV2_PORT_PROPS_PREFIX "notOnGUI"
-#define LV2_PORT_PROPS__rangeSteps LV2_PORT_PROPS_PREFIX "rangeSteps"
-#define LV2_PORT_PROPS__supportsStrictBounds LV2_PORT_PROPS_PREFIX "supportsStrictBounds"
-#define LV2_PORT_PROPS__trigger LV2_PORT_PROPS_PREFIX "trigger"
+#define LV2_PORT_PROPS_URI "http://lv2plug.in/ns/ext/port-props" ///< http://lv2plug.in/ns/ext/port-props
+#define LV2_PORT_PROPS_PREFIX LV2_PORT_PROPS_URI "#" ///< http://lv2plug.in/ns/ext/port-props#
+
+#define LV2_PORT_PROPS__causesArtifacts LV2_PORT_PROPS_PREFIX "causesArtifacts" ///< http://lv2plug.in/ns/ext/port-props#causesArtifacts
+#define LV2_PORT_PROPS__continuousCV LV2_PORT_PROPS_PREFIX "continuousCV" ///< http://lv2plug.in/ns/ext/port-props#continuousCV
+#define LV2_PORT_PROPS__discreteCV LV2_PORT_PROPS_PREFIX "discreteCV" ///< http://lv2plug.in/ns/ext/port-props#discreteCV
+#define LV2_PORT_PROPS__displayPriority LV2_PORT_PROPS_PREFIX "displayPriority" ///< http://lv2plug.in/ns/ext/port-props#displayPriority
+#define LV2_PORT_PROPS__expensive LV2_PORT_PROPS_PREFIX "expensive" ///< http://lv2plug.in/ns/ext/port-props#expensive
+#define LV2_PORT_PROPS__hasStrictBounds LV2_PORT_PROPS_PREFIX "hasStrictBounds" ///< http://lv2plug.in/ns/ext/port-props#hasStrictBounds
+#define LV2_PORT_PROPS__logarithmic LV2_PORT_PROPS_PREFIX "logarithmic" ///< http://lv2plug.in/ns/ext/port-props#logarithmic
+#define LV2_PORT_PROPS__notAutomatic LV2_PORT_PROPS_PREFIX "notAutomatic" ///< http://lv2plug.in/ns/ext/port-props#notAutomatic
+#define LV2_PORT_PROPS__notOnGUI LV2_PORT_PROPS_PREFIX "notOnGUI" ///< http://lv2plug.in/ns/ext/port-props#notOnGUI
+#define LV2_PORT_PROPS__rangeSteps LV2_PORT_PROPS_PREFIX "rangeSteps" ///< http://lv2plug.in/ns/ext/port-props#rangeSteps
+#define LV2_PORT_PROPS__supportsStrictBounds LV2_PORT_PROPS_PREFIX "supportsStrictBounds" ///< http://lv2plug.in/ns/ext/port-props#supportsStrictBounds
+#define LV2_PORT_PROPS__trigger LV2_PORT_PROPS_PREFIX "trigger" ///< http://lv2plug.in/ns/ext/port-props#trigger
#endif /* LV2_PORT_PROPS_H */
+
+/**
+ @}
+*/
diff --git a/lv2/lv2plug.in/ns/ext/port-props/port-props.ttl b/lv2/port-props/port-props.meta.ttl
index 7eb7e7d..7077e4b 100644
--- a/lv2/lv2plug.in/ns/ext/port-props/port-props.ttl
+++ b/lv2/port-props/port-props.meta.ttl
@@ -1,49 +1,76 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix pprops: <http://lv2plug.in/ns/ext/port-props#> .
-@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#> .
+@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/port-props>
- a owl:Ontology ;
- rdfs:seeAlso <lv2-port-props.doap.ttl> ;
+ a doap:Project ;
+ doap:name "LV2 Port Properties" ;
+ doap:created "2009-01-01" ;
+ doap:shortdesc "Various properties for LV2 plugin ports." ;
+ doap:maintainer <http://drobilla.net/drobilla#me> ;
+ doap:developer <http://lv2plug.in/ns/meta#kfoltman> ;
+ doap:release [
+ doap:revision "1.2" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Use consistent label style."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
lv2:documentation """
-<p>This vocabulary defines various properties for plugin ports, which can be
-used to better describe how a plugin can be controlled. Using this metadata,
-hosts can build better UIs for plugins, and provide more advanced automatic
-functionality.</p>
-""" .
+
+This vocabulary defines various properties for plugin ports, which can be used
+to better describe how a plugin can be controlled. Using this metadata, hosts
+can build better UIs for plugins, and provide more advanced automatic
+functionality.
+
+"""^^lv2:Markdown .
pprops:trigger
- a lv2:PortProperty ;
- rdfs:label "trigger" ;
- rdfs:comment """
+ lv2:documentation """
+
Indicates that the data item corresponds to a momentary event that has been
detected (control output ports) or is to be triggered (control input ports).
For input ports, the port needs to be reset to lv2:default value after run()
-function of the plugin has returned. If the control port is assigned a GUI
+function of the plugin has returned. If the control port is assigned a GUI
widget by the host, the widget should be of auto-off (momentary, one-shot) type
- for example, a push button if the port is also declared as lv2:toggled, or a
series of push button or auto-clear input box with a "Send" button if the port
is also lv2:integer.
-""" .
+
+"""^^lv2:Markdown .
pprops:supportsStrictBounds
- a lv2:Feature ;
- rdfs:label "supports strict bounds" ;
- rdfs:comment """
+ lv2:documentation """
+
Indicates use of host support for pprops:hasStrictBounds port property. A
plugin that specifies it as optional feature can omit value clamping for
hasStrictBounds ports, if the feature is supported by the host. When specified
as required feature, it indicates that the plugin does not do any clamping for
input ports that have a pprops:hasStrictBounds property.
-""" .
+
+"""^^lv2:Markdown .
pprops:hasStrictBounds
- a lv2:PortProperty ;
- rdfs:label "has strict bounds" ;
- rdfs:comment """
+ lv2:documentation """
+
For hosts that support pprops:supportsStrictBounds, this indicates that the
value of the port should never exceed the port's minimum and maximum control
points. For input ports, it moves the responsibility for limiting the range of
@@ -51,127 +78,125 @@ values to host, if it supports pprops:supportsStrictBounds. For output ports,
it indicates that values within specified range are to be expected, and
breaking that should be considered by the host as error in plugin
implementation.
-""" .
+
+"""^^lv2:Markdown .
pprops:expensive
- a lv2:PortProperty ;
- rdfs:label "changes are expensive" ;
- rdfs:comment """
+ lv2:documentation """
+
Input ports only. Indicates that any changes to the port value may trigger
-expensive background calculation (e.g. regenerate some lookup tables in a
-background thread). Any value changes may have not have immediate effect, or
+expensive background calculation (for example, regeneration of lookup tables in
+a background thread). Any value changes may have not have immediate effect, or
may cause silence or diminished-quality version of the output until background
processing is finished. Ports having this property are typically not well
suited for connection to outputs of other plugins, and should not be offered as
connection targets or for automation by default.
-""" .
+
+"""^^lv2:Markdown .
pprops:causesArtifacts
- a lv2:PortProperty ;
- rdfs:label "changes cause artifacts" ;
- rdfs:comment """
+ lv2:documentation """
+
Input ports only. Indicates that any changes to the port value may produce
slight artifacts to produced audio signals (zipper noise and other results of
signal discontinuities). Connecting ports of this type to continuous signals
is not recommended, and when presenting a list of automation targets, those
ports may be marked as artifact-producing.
-""" .
+
+"""^^lv2:Markdown .
pprops:continuousCV
- a lv2:PortProperty ;
- rdfs:label "smooth modulation signal" ;
- rdfs:comment """
+ lv2:documentation """
+
Indicates that the port carries a "smooth" modulation signal. Control input
ports of this type are well-suited for being connected to sources of smooth
signals (knobs with smoothing, modulation rate oscillators, output ports with
continuousCV type, etc.). Typically, the plugin with ports which have this
property will implement appropriate smoothing to avoid audio artifacts. For
output ports, this property suggests the value of the port is likely to change
-frequently, and describes a smooth signal (e.g. successive values may be
+frequently, and describes a smooth signal (so successive values may be
considered points along a curve).
-""" .
+
+"""^^lv2:Markdown .
pprops:discreteCV
- a lv2:PortProperty ;
- rdfs:label "discrete modulation signal" ;
- rdfs:comment """
+ lv2:documentation """
+
Indicates that the port carries a "discrete" modulation signal. Input ports of
this type are well-suited for being connected to sources of discrete signals
(switches, buttons, classifiers, event detectors, etc.). May be combined with
pprops:trigger property. For output ports, this property suggests the value of
the port describe discrete values that should be interpreted as steps (and not
points along a curve).
-""" .
+
+"""^^lv2:Markdown .
pprops:logarithmic
- a lv2:PortProperty ;
- rdfs:label "logarithmic scale" ;
- rdfs:comment """
+ lv2:documentation """
+
Indicates that port value behaviour within specified range (bounds) is a value
using logarithmic scale. The lower and upper bounds must be specified, and
must be of the same sign.
-""" .
+
+"""^^lv2:Markdown .
pprops:notAutomatic
- a lv2:PortProperty ;
- rdfs:label "not intended as a CV input" ;
- rdfs:comment """
+ lv2:documentation """
+
Indicates that the port is not primarily intended to be fed with modulation
signals from external sources (other plugins, etc.). It is merely a UI hint
and hosts may allow the user to override it.
-""" .
+
+"""^^lv2:Markdown .
pprops:notOnGUI
- a lv2:PortProperty ;
- rdfs:label "not on GUI" ;
- rdfs:comment """
+ lv2:documentation """
+
Indicates that the port is not primarily intended to be represented by a
separate control in the user interface window (or any similar mechanism used
for direct, immediate control of control ports). It is merely a UI hint and
hosts may allow the user to override it.
-""" .
+
+"""^^lv2:Markdown .
pprops:displayPriority
- a rdf:Property ;
- rdfs:domain lv2:Port ;
- rdfs:range xsd:nonNegativeInteger ;
- rdfs:label "display priority" ;
- rdfs:comment """
+ lv2:documentation """
+
Indicates how important a port is to controlling the plugin. If a host can
only display some ports of a plugin, it should prefer ports with a higher
display priority. Priorities do not need to be unique, and are only meaningful
when compared to each other.
-""" .
+
+"""^^lv2:Markdown .
pprops:rangeSteps
- a rdf:Property ;
- rdfs:domain lv2:Port ;
- rdfs:range xsd:nonNegativeInteger ;
- rdfs:label "number of value steps" ;
lv2:documentation """
-<p>This value indicates into how many evenly-divided points the (control) port
-range should be divided for step-wise control. This may be used for changing
+
+This value indicates into how many evenly-divided points the (control) port
+range should be divided for step-wise control. This may be used for changing
the value with step-based controllers like arrow keys, mouse wheel, rotary
-encoders, etc.</p>
+encoders, and so on.
+
+Note that when used with a pprops:logarithmic port, the steps are logarithmic
+too, and port value can be calculated as:
+
+ :::c
+ value = lower * pow(upper / lower, step / (steps - 1))
+
+and the step from value is:
+
+ :::c
+ step = (steps - 1) * log(value / lower) / log(upper / lower)
+
+where:
+
+ * `value` is the port value.
-<p>Note that when used with a pprops:logarithmic port, the steps are
-logarithmic too, and port value can be calculated as:</p>
+ * `step` is the step number (0..steps).
-<pre class="c-code">
-value = lower * pow(upper / lower, step / (steps - 1))
-</pre>
+ * `steps` is the number of steps (= value of :rangeSteps property).
-<p>and the step from value is:</p>
+ * `lower` and <code>upper</code> are the bounds.
-<pre class="c-code">
-step = (steps - 1) * log(value / lower) / log(upper / lower)
-</pre>
+"""^^lv2:Markdown .
-<p>where:</p>
-<ul>
-<li><code>value</code> is the port value</li>
-<li><code>step</code> is the step number (0..steps)</li>
-<li><code>steps</code> is the number of steps (= value of :rangeSteps property)</li>
-<li><code>lower</code> and <code>upper</code> are the bounds</li>
-</ul>
-""" .
diff --git a/lv2/port-props/port-props.ttl b/lv2/port-props/port-props.ttl
new file mode 100644
index 0000000..1ddeed0
--- /dev/null
+++ b/lv2/port-props/port-props.ttl
@@ -0,0 +1,79 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix pprops: <http://lv2plug.in/ns/ext/port-props#> .
+@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/port-props>
+ a owl:Ontology ;
+ rdfs:label "LV2 Port Properties" ;
+ rdfs:comment "Various properties for LV2 plugin ports." ;
+ rdfs:seeAlso <port-props.meta.ttl> .
+
+pprops:trigger
+ a lv2:PortProperty ;
+ rdfs:label "trigger" ;
+ rdfs:comment "Port is a momentary trigger." .
+
+pprops:supportsStrictBounds
+ a lv2:Feature ;
+ rdfs:label "supports strict bounds" ;
+ rdfs:comment "A feature indicating plugin support for strict port bounds." .
+
+pprops:hasStrictBounds
+ a lv2:PortProperty ;
+ rdfs:label "has strict bounds" ;
+ rdfs:comment "Port has strict bounds which are not internally clamped." .
+
+pprops:expensive
+ a lv2:PortProperty ;
+ rdfs:label "changes are expensive" ;
+ rdfs:comment "Input port is expensive to change." .
+
+pprops:causesArtifacts
+ a lv2:PortProperty ;
+ rdfs:label "changes cause artifacts" ;
+ rdfs:comment "Input port causes audible artifacts when changed." .
+
+pprops:continuousCV
+ a lv2:PortProperty ;
+ rdfs:label "smooth modulation signal" ;
+ rdfs:comment "Port carries a smooth modulation signal." .
+
+pprops:discreteCV
+ a lv2:PortProperty ;
+ rdfs:label "discrete modulation signal" ;
+ rdfs:comment "Port carries a discrete modulation signal." .
+
+pprops:logarithmic
+ a lv2:PortProperty ;
+ rdfs:label "logarithmic" ;
+ rdfs:comment "Port value is logarithmic." .
+
+pprops:notAutomatic
+ a lv2:PortProperty ;
+ rdfs:label "not automatic" ;
+ rdfs:comment "Port that is not intended to be fed with a modulation signal." .
+
+pprops:notOnGUI
+ a lv2:PortProperty ;
+ rdfs:label "not on GUI" ;
+ rdfs:comment "Port that should not be displayed on a GUI." .
+
+pprops:displayPriority
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:domain lv2:Port ;
+ rdfs:range xsd:nonNegativeInteger ;
+ rdfs:label "display priority" ;
+ rdfs:comment "A priority ranking this port in importance to its plugin." .
+
+pprops:rangeSteps
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:domain lv2:Port ;
+ rdfs:range xsd:nonNegativeInteger ;
+ rdfs:label "range steps" ;
+ rdfs:comment "The number of even steps the range should be divided into." .
+
diff --git a/lv2/lv2plug.in/ns/ext/presets/manifest.ttl b/lv2/presets/manifest.ttl
index d1fc482..b9cacf5 100644
--- a/lv2/lv2plug.in/ns/ext/presets/manifest.ttl
+++ b/lv2/presets/manifest.ttl
@@ -1,4 +1,4 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/presets>
diff --git a/lv2/presets/presets.h b/lv2/presets/presets.h
new file mode 100644
index 0000000..8264a9c
--- /dev/null
+++ b/lv2/presets/presets.h
@@ -0,0 +1,42 @@
+/*
+ Copyright 2012-2016 David Robillard <http://drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+/**
+ @defgroup presets Presets
+ @ingroup lv2
+
+ Presets for plugins, see <http://lv2plug.in/ns/ext/presets> for details.
+
+ @{
+*/
+
+#ifndef LV2_PRESETS_H
+#define LV2_PRESETS_H
+
+#define LV2_PRESETS_URI "http://lv2plug.in/ns/ext/presets" ///< http://lv2plug.in/ns/ext/presets
+#define LV2_PRESETS_PREFIX LV2_PRESETS_URI "#" ///< http://lv2plug.in/ns/ext/presets#
+
+#define LV2_PRESETS__Bank LV2_PRESETS_PREFIX "Bank" ///< http://lv2plug.in/ns/ext/presets#Bank
+#define LV2_PRESETS__Preset LV2_PRESETS_PREFIX "Preset" ///< http://lv2plug.in/ns/ext/presets#Preset
+#define LV2_PRESETS__bank LV2_PRESETS_PREFIX "bank" ///< http://lv2plug.in/ns/ext/presets#bank
+#define LV2_PRESETS__preset LV2_PRESETS_PREFIX "preset" ///< http://lv2plug.in/ns/ext/presets#preset
+#define LV2_PRESETS__value LV2_PRESETS_PREFIX "value" ///< http://lv2plug.in/ns/ext/presets#value
+
+#endif /* LV2_PRESETS_H */
+
+/**
+ @}
+*/
diff --git a/lv2/presets/presets.meta.ttl b/lv2/presets/presets.meta.ttl
new file mode 100644
index 0000000..cc6d33a
--- /dev/null
+++ b/lv2/presets/presets.meta.ttl
@@ -0,0 +1,133 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix pset: <http://lv2plug.in/ns/ext/presets#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/presets>
+ a doap:Project ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ doap:name "LV2 Presets" ;
+ doap:shortdesc "Presets for LV2 plugins." ;
+ doap:created "2009-00-00" ;
+ doap:developer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "2.8" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Use consistent label style."
+ ] , [
+ rdfs:label "Add preset banks."
+ ]
+ ]
+ ] , [
+ doap:revision "2.6" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add pset:preset property for describing the preset currently applied to a plugin instance."
+ ] , [
+ rdfs:label "Remove pset:appliesTo property, use lv2:appliesTo instead."
+ ] , [
+ rdfs:label "Merge with unified LV2 package."
+ ]
+ ]
+ ] , [
+ doap:revision "2.2" ;
+ doap:created "2011-11-21" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-presets-2.2.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Update packaging."
+ ] , [
+ rdfs:label "Improve documentation."
+ ]
+ ]
+ ] , [
+ doap:revision "2.0" ;
+ doap:created "2010-10-04" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-presets-2.0.tar.gz> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+This is a vocabulary for LV2 plugin presets, that is, named sets of control
+values and possibly other state. The structure of a pset:Preset is
+deliberately identical to that of an lv2:Plugin, and can be thought of as a
+plugin template or overlay.
+
+Presets may be defined in any bundle, including the plugin's bundle, separate
+third party preset bundles, or user preset bundles saved by hosts. Since
+preset data tends to be large, it is recommended that plugins describe presets
+in a separate file(s) to avoid slowing down hosts. The `manifest.ttl` of a
+bundle containing presets should list them like so:
+
+ :::turtle
+ eg:mypreset
+ a pset:Preset ;
+ lv2:appliesTo eg:myplugin ;
+ rdfs:seeAlso &lt;mypreset.ttl&gt; .
+
+"""^^lv2:Markdown .
+
+pset:Preset
+ lv2:documentation """
+
+The structure of a Preset deliberately mirrors that of a plugin, so existing
+predicates can be used to describe any data associated with the preset. For
+example:
+
+ :::turtle
+ @prefix eg: &lt;http://example.org/&gt; .
+
+ eg:mypreset
+ a pset:Preset ;
+ rdfs:label "One louder" ;
+ lv2:appliesTo eg:myplugin ;
+ lv2:port [
+ lv2:symbol "volume1" ;
+ pset:value 11.0
+ ] , [
+ lv2:symbol "volume2" ;
+ pset:value 11.0
+ ] .
+
+A Preset SHOULD have at least one lv2:appliesTo property. Each Port on a
+Preset MUST have at least a lv2:symbol property and a pset:value property.
+
+Hosts SHOULD save user presets to a bundle in the user-local LV2 directory (for
+example `~/.lv2`) with a name like
+`&lt;Plugin_Name&gt;_&lt;Preset_Name&gt;.preset.lv2` (for example
+`LV2_Amp_At_Eleven.preset.lv2`), where names are transformed to be valid LV2
+symbols for maximum compatibility.
+
+"""^^lv2:Markdown .
+
+pset:value
+ lv2:documentation """
+
+This property is used in a similar way to lv2:default.
+
+"""^^lv2:Markdown .
+
+pset:preset
+ lv2:documentation """
+
+Specifies the preset currently applied to a plugin instance. This property may
+be useful for saving state, or notifying a plugin instance at run-time about a
+preset change.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/presets/presets.ttl b/lv2/presets/presets.ttl
new file mode 100644
index 0000000..c1caf43
--- /dev/null
+++ b/lv2/presets/presets.ttl
@@ -0,0 +1,60 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix pset: <http://lv2plug.in/ns/ext/presets#> .
+@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/presets>
+ a owl:Ontology ;
+ rdfs:label "LV2 Presets" ;
+ rdfs:comment "Presets for LV2 plugins." ;
+ rdfs:seeAlso <presets.meta.ttl> .
+
+pset:Bank
+ a rdfs:Class ;
+ rdfs:label "Bank" ;
+ rdfs:subClassOf [
+ a owl:Restriction ;
+ owl:onProperty rdfs:label ;
+ owl:someValuesFrom xsd:string ;
+ rdfs:comment "A Bank MUST have at least one string rdfs:label."
+ ] ;
+ rdfs:comment "A bank of presets." .
+
+pset:Preset
+ a rdfs:Class ;
+ rdfs:subClassOf lv2:PluginBase ;
+ rdfs:label "Preset" ;
+ rdfs:comment "A preset for an LV2 plugin." ;
+ rdfs:subClassOf [
+ a owl:Restriction ;
+ owl:onProperty rdfs:label ;
+ owl:someValuesFrom xsd:string ;
+ rdfs:comment "A Preset MUST have at least one string rdfs:label."
+ ] .
+
+pset:bank
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain pset:Preset ;
+ rdfs:range pset:Bank ;
+ rdfs:label "bank" ;
+ rdfs:comment "The bank this preset belongs to." .
+
+pset:value
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ owl:FunctionalProperty ;
+ rdfs:domain lv2:PortBase ;
+ rdfs:label "value" ;
+ rdfs:comment "The value of a port in a preset." .
+
+pset:preset
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain lv2:PluginBase ;
+ rdfs:range pset:Preset ;
+ rdfs:label "preset" ;
+ rdfs:comment "The preset currently applied to a plugin instance." .
+
diff --git a/lv2/lv2plug.in/ns/ext/resize-port/manifest.ttl b/lv2/resize-port/manifest.ttl
index 21569ae..9fae8b8 100644
--- a/lv2/lv2plug.in/ns/ext/resize-port/manifest.ttl
+++ b/lv2/resize-port/manifest.ttl
@@ -1,4 +1,4 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/resize-port>
diff --git a/lv2/lv2plug.in/ns/ext/resize-port/resize-port.h b/lv2/resize-port/resize-port.h
index fa3abd7..a60626d 100644
--- a/lv2/lv2plug.in/ns/ext/resize-port/resize-port.h
+++ b/lv2/resize-port/resize-port.h
@@ -1,5 +1,5 @@
/*
- Copyright 2007-2012 David Robillard <http://drobilla.net>
+ Copyright 2007-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -14,23 +14,31 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+/**
+ @defgroup resize-port Resize Port
+ @ingroup lv2
+
+ Dynamically sized LV2 port buffers.
+
+ @{
+*/
+
#ifndef LV2_RESIZE_PORT_H
#define LV2_RESIZE_PORT_H
+#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
-#define LV2_RESIZE_PORT_URI "http://lv2plug.in/ns/ext/resize-port"
-#define LV2_RESIZE_PORT_PREFIX LV2_RESIZE_PORT_URI "#"
+#define LV2_RESIZE_PORT_URI "http://lv2plug.in/ns/ext/resize-port" ///< http://lv2plug.in/ns/ext/resize-port
+#define LV2_RESIZE_PORT_PREFIX LV2_RESIZE_PORT_URI "#" ///< http://lv2plug.in/ns/ext/resize-port#
-#define LV2_RESIZE_PORT__asLargeAs LV2_RESIZE_PORT_PREFIX "asLargeAs"
-#define LV2_RESIZE_PORT__minimumSize LV2_RESIZE_PORT_PREFIX "minimumSize"
-#define LV2_RESIZE_PORT__resize LV2_RESIZE_PORT_PREFIX "resize"
+#define LV2_RESIZE_PORT__asLargeAs LV2_RESIZE_PORT_PREFIX "asLargeAs" ///< http://lv2plug.in/ns/ext/resize-port#asLargeAs
+#define LV2_RESIZE_PORT__minimumSize LV2_RESIZE_PORT_PREFIX "minimumSize" ///< http://lv2plug.in/ns/ext/resize-port#minimumSize
+#define LV2_RESIZE_PORT__resize LV2_RESIZE_PORT_PREFIX "resize" ///< http://lv2plug.in/ns/ext/resize-port#resize
#ifdef __cplusplus
extern "C" {
-#else
-# include <stdbool.h>
#endif
/** A status code for state functions. */
@@ -40,22 +48,25 @@ typedef enum {
LV2_RESIZE_PORT_ERR_NO_SPACE = 2 /**< Insufficient space. */
} LV2_Resize_Port_Status;
+/** Opaque data for resize method. */
typedef void* LV2_Resize_Port_Feature_Data;
+/** Host feature to allow plugins to resize their port buffers. */
typedef struct {
+ /** Opaque data for resize method. */
LV2_Resize_Port_Feature_Data data;
/**
- Resize a port buffer to at least @a size bytes.
-
+ Resize a port buffer to at least `size` bytes.
+
This function MAY return an error, in which case the port buffer was not
resized and the port is still connected to the same location. Plugins
MUST gracefully handle this situation.
-
+
This function is in the audio threading class.
-
+
The host MUST preserve the contents of the port buffer when resizing.
-
+
Plugins MAY resize a port many times in a single run callback. Hosts
SHOULD make this as inexpensive as possible.
*/
@@ -70,3 +81,6 @@ typedef struct {
#endif /* LV2_RESIZE_PORT_H */
+/**
+ @}
+*/
diff --git a/lv2/resize-port/resize-port.meta.ttl b/lv2/resize-port/resize-port.meta.ttl
new file mode 100644
index 0000000..d44620c
--- /dev/null
+++ b/lv2/resize-port/resize-port.meta.ttl
@@ -0,0 +1,74 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix rsz: <http://lv2plug.in/ns/ext/resize-port#> .
+
+<http://lv2plug.in/ns/ext/resize-port>
+ a doap:Project ;
+ doap:name "LV2 Resize Port" ;
+ doap:shortdesc "Dynamically sized LV2 port buffers." ;
+ doap:created "2007-00-00" ;
+ doap:developer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "1.0" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+This extension defines a feature, rsz:resize, which allows plugins to
+dynamically resize their output port buffers.
+
+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.
+
+"""^^lv2:Markdown .
+
+rsz:resize
+ lv2:documentation """
+
+A feature to resize output port buffers in LV2_Plugin_Descriptor::run().
+
+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.
+
+"""^^lv2:Markdown .
+
+rsz:asLargeAs
+ lv2:documentation """
+
+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).
+
+The host guarantees that whenever an ObjectPort's run method is called, any
+output `O` that is rsz:asLargeAs an input `I` is connected to a buffer large
+enough to copy `I`, or `NULL` if the port is lv2:connectionOptional.
+
+"""^^lv2:Markdown .
+
+rsz:minimumSize
+ lv2:documentation """
+
+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.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/resize-port/resize-port.ttl b/lv2/resize-port/resize-port.ttl
new file mode 100644
index 0000000..29cd18b
--- /dev/null
+++ b/lv2/resize-port/resize-port.ttl
@@ -0,0 +1,36 @@
+@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 owl:Ontology ;
+ rdfs:label "LV2 Resize Port" ;
+ rdfs:comment "Dynamically sized LV2 port buffers." ;
+ rdfs:seeAlso <resize-port.h> ,
+ <resize-port.meta.ttl> .
+
+rsz:resize
+ a lv2:Feature ;
+ rdfs:label "resize" ;
+ rdfs:comment "A feature for resizing output port buffers." .
+
+rsz:asLargeAs
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:domain lv2:Port ;
+ rdfs:range lv2:Symbol ;
+ rdfs:label "as large as" ;
+ rdfs:comment "Port that this port must have at least as much buffer space as." .
+
+rsz:minimumSize
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ owl:FunctionalProperty ;
+ rdfs:domain lv2:Port ;
+ rdfs:range xsd:nonNegativeInteger ;
+ rdfs:label "minimum size" ;
+ rdfs:comment "Minimum buffer size required by a port, in bytes." .
+
diff --git a/lv2/lv2plug.in/ns/ext/state/manifest.ttl b/lv2/state/manifest.ttl
index c2aec02..6d12358 100644
--- a/lv2/lv2plug.in/ns/ext/state/manifest.ttl
+++ b/lv2/state/manifest.ttl
@@ -1,8 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/state>
a lv2:Specification ;
lv2:minorVersion 2 ;
- lv2:microVersion 0 ;
+ lv2:microVersion 6 ;
rdfs:seeAlso <state.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/ext/state/state.h b/lv2/state/state.h
index 6d055f5..2823989 100644
--- a/lv2/lv2plug.in/ns/ext/state/state.h
+++ b/lv2/state/state.h
@@ -1,5 +1,5 @@
/*
- Copyright 2010-2012 David Robillard <http://drobilla.net>
+ Copyright 2010-2016 David Robillard <http://drobilla.net>
Copyright 2010 Leonard Ritter <paniq@paniq.org>
Permission to use, copy, modify, and/or distribute this software for any
@@ -16,37 +16,45 @@
*/
/**
- @file state.h
- C API for the LV2 State extension <http://lv2plug.in/ns/ext/state>.
+ @defgroup state State
+ @ingroup lv2
+
+ An interface for LV2 plugins to save and restore state, see
+ <http://lv2plug.in/ns/ext/state> for details.
+
+ @{
*/
#ifndef LV2_STATE_H
#define LV2_STATE_H
+#include "lv2/core/lv2.h"
+
+#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
+#define LV2_STATE_URI "http://lv2plug.in/ns/ext/state" ///< http://lv2plug.in/ns/ext/state
+#define LV2_STATE_PREFIX LV2_STATE_URI "#" ///< http://lv2plug.in/ns/ext/state#
-#define LV2_STATE_URI "http://lv2plug.in/ns/ext/state"
-#define LV2_STATE_PREFIX LV2_STATE_URI "#"
-
-#define LV2_STATE__State LV2_STATE_PREFIX "State"
-#define LV2_STATE__interface LV2_STATE_PREFIX "interface"
-#define LV2_STATE__loadDefaultState LV2_STATE_PREFIX "loadDefaultState"
-#define LV2_STATE__makePath LV2_STATE_PREFIX "makePath"
-#define LV2_STATE__mapPath LV2_STATE_PREFIX "mapPath"
-#define LV2_STATE__state LV2_STATE_PREFIX "state"
+#define LV2_STATE__State LV2_STATE_PREFIX "State" ///< http://lv2plug.in/ns/ext/state#State
+#define LV2_STATE__interface LV2_STATE_PREFIX "interface" ///< http://lv2plug.in/ns/ext/state#interface
+#define LV2_STATE__loadDefaultState LV2_STATE_PREFIX "loadDefaultState" ///< http://lv2plug.in/ns/ext/state#loadDefaultState
+#define LV2_STATE__freePath LV2_STATE_PREFIX "freePath" ///< http://lv2plug.in/ns/ext/state#freePath
+#define LV2_STATE__makePath LV2_STATE_PREFIX "makePath" ///< http://lv2plug.in/ns/ext/state#makePath
+#define LV2_STATE__mapPath LV2_STATE_PREFIX "mapPath" ///< http://lv2plug.in/ns/ext/state#mapPath
+#define LV2_STATE__state LV2_STATE_PREFIX "state" ///< http://lv2plug.in/ns/ext/state#state
+#define LV2_STATE__threadSafeRestore LV2_STATE_PREFIX "threadSafeRestore" ///< http://lv2plug.in/ns/ext/state#threadSafeRestore
+#define LV2_STATE__StateChanged LV2_STATE_PREFIX "StateChanged" ///< http://lv2plug.in/ns/ext/state#StateChanged
#ifdef __cplusplus
extern "C" {
-#else
-# include <stdbool.h>
#endif
-typedef void* LV2_State_Handle;
-typedef void* LV2_State_Map_Path_Handle;
-typedef void* LV2_State_Make_Path_Handle;
+typedef void* LV2_State_Handle; ///< Opaque handle for state save/restore
+typedef void* LV2_State_Free_Path_Handle; ///< Opaque handle for state:freePath feature
+typedef void* LV2_State_Map_Path_Handle; ///< Opaque handle for state:mapPath feature
+typedef void* LV2_State_Make_Path_Handle; ///< Opaque handle for state:makePath feature
/**
Flags describing value characteristics.
@@ -61,8 +69,8 @@ typedef enum {
Values with this flag contain no pointers or references to other areas
of memory. It is safe to copy POD values with a simple memcpy and store
them for the duration of the process. A POD value is not necessarily
- safe to trasmit between processes or machines (e.g. filenames are POD),
- see LV2_STATE_IS_PORTABLE for details.
+ safe to trasmit between processes or machines (for example, filenames
+ are POD), see LV2_STATE_IS_PORTABLE for details.
Implementations MUST NOT attempt to copy or serialise a non-POD value if
they do not understand its type (and thus know how to correctly do so).
@@ -84,9 +92,9 @@ typedef enum {
Native data.
This flag is used by the host to indicate that the saved data is only
- going to be used locally in the currently running process (e.g. for
- instance duplication or snapshots), so the plugin should use the most
- efficient representation possible and not worry about serialisation
+ going to be used locally in the currently running process (for things
+ like instance duplication or snapshots), so the plugin should use the
+ most efficient representation possible and not worry about serialisation
and portability.
*/
LV2_STATE_IS_NATIVE = 1 << 2
@@ -99,17 +107,18 @@ typedef enum {
LV2_STATE_ERR_BAD_TYPE = 2, /**< Failed due to unsupported type. */
LV2_STATE_ERR_BAD_FLAGS = 3, /**< Failed due to unsupported flags. */
LV2_STATE_ERR_NO_FEATURE = 4, /**< Failed due to missing features. */
- LV2_STATE_ERR_NO_PROPERTY = 5 /**< Failed due to missing property. */
+ LV2_STATE_ERR_NO_PROPERTY = 5, /**< Failed due to missing property. */
+ LV2_STATE_ERR_NO_SPACE = 6 /**< Failed due to insufficient space. */
} LV2_State_Status;
/**
A host-provided function to store a property.
@param handle Must be the handle passed to LV2_State_Interface.save().
- @param key The key to store @p value under (URID).
+ @param key The key to store `value` under (URID).
@param value Pointer to the value to be stored.
- @param size The size of @p value in bytes.
- @param type The type of @p value (URID).
- @param flags LV2_State_Flags for @p value.
+ @param size The size of `value` in bytes.
+ @param type The type of `value` (URID).
+ @param flags LV2_State_Flags for `value`.
@return 0 on success, otherwise a non-zero error code.
The host passes a callback of this type to LV2_State_Interface.save(). This
@@ -119,7 +128,7 @@ typedef enum {
DO NOT INVENT NONSENSE URI SCHEMES FOR THE KEY. Best is to use keys from
existing vocabularies. If nothing appropriate is available, use http URIs
that point to somewhere you can host documents so documentation can be made
- resolvable (e.g. a child of the plugin or project URI). If this is not
+ resolvable (typically a child of the plugin or project URI). If this is not
possible, invent a URN scheme, e.g. urn:myproj:whatever. The plugin MUST
NOT pass an invalid URI key.
@@ -129,8 +138,8 @@ typedef enum {
(http://lv2plug.in/ns/ext/atom) wherever possible. The plugin SHOULD
attempt to fall-back and avoid the error if possible.
- Note that @p size MUST be > 0, and @p value MUST point to a valid region of
- memory @p size bytes long (this is required to make restore unambiguous).
+ Note that `size` MUST be > 0, and `value` MUST point to a valid region of
+ memory `size` bytes long (this is required to make restore unambiguous).
The plugin MUST NOT attempt to use this function outside of the
LV2_State_Interface.restore() context.
@@ -151,7 +160,7 @@ typedef LV2_State_Status (*LV2_State_Store_Function)(
@param type (Output) If non-NULL, set to the type of the restored value.
@param flags (Output) If non-NULL, set to the flags for the restored value.
@return A pointer to the restored value (object), or NULL if no value
- has been stored under @p key.
+ has been stored under `key`.
A callback of this type is passed by the host to
LV2_State_Interface.restore(). This callback is called repeatedly by the
@@ -186,14 +195,14 @@ typedef const void* (*LV2_State_Retrieve_Function)(
authors should consider this possibility, and always store sensible data
with meaningful types to avoid such problems in the future.
*/
-typedef struct _LV2_State_Interface {
+typedef struct {
/**
- Save plugin state using a host-provided @p store callback.
+ Save plugin state using a host-provided `store` callback.
@param instance The instance handle of the plugin.
@param store The host-provided store callback.
@param handle An opaque pointer to host data which MUST be passed as the
- handle parameter to @p store if it is called.
+ handle parameter to `store` if it is called.
@param flags Flags describing desired properties of this save. These
flags may be used to determine the most appropriate values to store.
@param features Extensible parameter for passing any additional
@@ -204,16 +213,16 @@ typedef struct _LV2_State_Interface {
possible, and consider the possibility of state being restored much
later on a different machine.
- The @p handle pointer and @p store function MUST NOT be used
+ The `handle` pointer and `store` function MUST NOT be used
beyond the scope of save().
This function has its own special threading class: it may not be called
concurrently with any "Instantiation" function, but it may be called
concurrently with functions in any other class, unless the definition of
- that class prohibits it (e.g. it may not be called concurrently with a
- "Discovery" function, but it may be called concurrently with an "Audio"
- function. The plugin is responsible for any locking or lock-free
- techniques necessary to make this possible.
+ that class prohibits it (for example, it may not be called concurrently
+ with a "Discovery" function, but it may be called concurrently with an
+ "Audio" function. The plugin is responsible for any locking or
+ lock-free techniques necessary to make this possible.
Note that in the simple case where state is only modified by restore(),
there are no synchronization issues since save() is never called
@@ -230,12 +239,12 @@ typedef struct _LV2_State_Interface {
const LV2_Feature *const * features);
/**
- Restore plugin state using a host-provided @p retrieve callback.
+ Restore plugin state using a host-provided `retrieve` callback.
@param instance The instance handle of the plugin.
@param retrieve The host-provided retrieve callback.
@param handle An opaque pointer to host data which MUST be passed as the
- handle parameter to @p retrieve if it is called.
+ handle parameter to `retrieve` if it is called.
@param flags Currently unused.
@param features Extensible parameter for passing any additional
features to be used for this restore.
@@ -247,7 +256,7 @@ typedef struct _LV2_State_Interface {
not be retrieved. This allows the host to reset the plugin state with
an empty map.
- The @p handle pointer and @p store function MUST NOT be used
+ The `handle` pointer and `store` function MUST NOT be used
beyond the scope of restore().
This function is in the "Instantiation" threading class as defined by
@@ -262,7 +271,7 @@ typedef struct _LV2_State_Interface {
} LV2_State_Interface;
/**
- Feature data for state:mapPath (LV2_STATE__mapPath).
+ Feature data for state:mapPath (@ref LV2_STATE__mapPath).
*/
typedef struct {
/**
@@ -272,38 +281,38 @@ typedef struct {
/**
Map an absolute path to an abstract path for use in plugin state.
- @param handle MUST be the @p handle member of this struct.
+ @param handle MUST be the `handle` member of this struct.
@param absolute_path The absolute path of a file.
@return An abstract path suitable for use in plugin state.
The plugin MUST use this function to map any paths that will be stored
in plugin state. The returned value is an abstract path which MAY not
- be an actual file system path; @ref absolute_path() MUST be used to map
+ be an actual file system path; absolute_path() MUST be used to map
it to an actual path in order to use the file.
Plugins MUST NOT make any assumptions about abstract paths except that
they can be mapped back to the absolute path of the "same" file (though
- not necessarily the same original path) using @ref absolute_path().
+ not necessarily the same original path) using absolute_path().
This function may only be called within the context of
- LV2_State_Interface methods. The caller is responsible for freeing the
- returned value with free().
+ LV2_State_Interface methods. The caller must free the returned value
+ with LV2_State_Free_Path.free_path().
*/
char* (*abstract_path)(LV2_State_Map_Path_Handle handle,
const char* absolute_path);
/**
Map an abstract path from plugin state to an absolute path.
- @param handle MUST be the @p handle member of this struct.
- @param abstract_path An abstract path (e.g. a path from plugin state).
+ @param handle MUST be the `handle` member of this struct.
+ @param abstract_path An abstract path (typically from plugin state).
@return An absolute file system path.
The plugin MUST use this function in order to actually open or otherwise
use any paths loaded from plugin state.
This function may only be called within the context of
- LV2_State_Interface methods. The caller is responsible for freeing the
- returned value with free().
+ LV2_State_Interface methods. The caller must free the returned value
+ with LV2_State_Free_Path.free_path().
*/
char* (*absolute_path)(LV2_State_Map_Path_Handle handle,
const char* abstract_path);
@@ -320,7 +329,7 @@ typedef struct {
/**
Return a path the plugin may use to create a new file.
- @param handle MUST be the @p handle member of this struct.
+ @param handle MUST be the `handle` member of this struct.
@param path The path of the new file within a namespace unique to this
plugin instance.
@return The absolute path to use for the new file.
@@ -331,22 +340,50 @@ typedef struct {
LV2_Descriptor.instantiate()).
The host MUST do whatever is necessary for the plugin to be able to
- create a file at the returned path (e.g. using fopen), including
- creating any leading directories.
+ create a file at the returned path (for example, using fopen()),
+ including creating any leading directories.
If this function is passed to LV2_Descriptor.instantiate(), it may be
called from any non-realtime context. If it is passed to
LV2_State_Interface.save(), it may only be called within the dynamic
scope of that function call.
- The caller is responsible for freeing the returned value with free().
+ The caller must free the returned value with
+ LV2_State_Free_Path.free_path().
*/
char* (*path)(LV2_State_Make_Path_Handle handle,
const char* path);
} LV2_State_Make_Path;
+/**
+ Feature data for state:freePath (@ref LV2_STATE__freePath).
+*/
+typedef struct {
+ /**
+ Opaque host data.
+ */
+ LV2_State_Free_Path_Handle handle;
+
+ /**
+ Free a path returned by a state feature.
+
+ @param handle MUST be the `handle` member of this struct.
+ @param path The path previously returned by a state feature.
+
+ This function can be used by plugins to free paths allocated by the host
+ and returned by state features (LV2_State_Map_Path.abstract_path(),
+ LV2_State_Map_Path.absolute_path(), and LV2_State_Make_Path.path()).
+ */
+ void (*free_path)(LV2_State_Free_Path_Handle handle,
+ char* path);
+} LV2_State_Free_Path;
+
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* LV2_STATE_H */
+
+/**
+ @}
+*/
diff --git a/lv2/state/state.meta.ttl b/lv2/state/state.meta.ttl
new file mode 100644
index 0000000..766ac57
--- /dev/null
+++ b/lv2/state/state.meta.ttl
@@ -0,0 +1,457 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix state: <http://lv2plug.in/ns/ext/state#> .
+
+<http://lv2plug.in/ns/ext/state>
+ a doap:Project ;
+ doap:created "2010-11-09" ;
+ doap:name "LV2 State" ;
+ doap:shortdesc "An interface for LV2 plugins to save and restore state." ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ doap:developer <http://lv2plug.in/ns/meta#paniq> ,
+ <http://drobilla.net/drobilla#me> ;
+ doap:maintainer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "2.6" ;
+ doap:created "2020-04-26" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.18.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add state:freePath feature."
+ ]
+ ]
+ ] , [
+ doap:revision "2.4" ;
+ doap:created "2019-02-03" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.16.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add state:StateChanged for notification events."
+ ]
+ ]
+ ] , [
+ doap:revision "2.2" ;
+ doap:created "2016-07-31" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.14.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add LV2_STATE_ERR_NO_SPACE status flag."
+ ] , [
+ rdfs:label "Add state:threadSafeRestore feature for dropout-free state restoration."
+ ]
+ ]
+ ] , [
+ doap:revision "2.0" ;
+ doap:created "2013-01-16" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add state:loadDefaultState feature so plugins can have their default state loaded without hard-coding default state as a special case."
+ ]
+ ]
+ ] , [
+ doap:revision "1.2" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Use consistent label style."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+This extension defines a simple mechanism that allows hosts to save and restore
+a plugin instance's state. The goal is for an instance's state to be
+completely described by port values and a simple dictionary.
+
+The <q>state</q> defined here is conceptually a key:value dictionary, with URI keys
+and values of any type. For performance reasons the key and value type are
+actually a "URID", a URI mapped to an integer. A single key:value pair is
+called a "property".
+
+This state model is simple yet has many benefits:
+
+ * Both fast and extensible thanks to URID keys.
+
+ * No limitations on possible value types.
+
+ * Easy to serialise in almost any format.
+
+ * Easy to store in a typical "map" or "dictionary" data structure.
+
+ * Elegantly described in Turtle, so state can be described in LV2 data files
+ (including presets).
+
+ * Does not impose any file formats, data structures, or file system
+ requirements.
+
+ * Suitable for portable persistent state as well as fast in-memory snapshots.
+
+ * Keys _may_ be well-defined and used meaningfully across several
+ implementations.
+
+ * State _may_ be dynamic, but plugins are not required to have a dynamic
+ dictionary data structure available.
+
+To implement state, the plugin provides a state:interface to the host. To save
+or restore, the host calls LV2_State_Interface::save() or
+LV2_State_Interface::restore(), passing a callback to be used for handling a
+single property. The host is free to implement property storage and retrieval
+in any way.
+
+Since value types are defined by URI, any type is possible. However, a set of
+standard types is defined by the [LV2 Atom](atom.html) extension. Use of these
+types is recommended. Hosts MUST implement at least
+[atom:String](atom.html#String), which is simply a C string.
+
+### Referring to Files
+
+Plugins may need to refer to existing files (such as loaded samples) in their
+state. This is done by storing the file's path as a property just like any
+other value. However, there are some rules which MUST be followed when storing
+paths, see state:mapPath for details. Plugins MUST use the type
+[atom:Path](atom.html#Path) for all paths in their state.
+
+Plugins are strongly encouraged to avoid creating files, instead storing all
+state as properties. However, occasionally the ability to create files is
+necessary. To make this possible, the host can provide the feature
+state:makePath which allocates paths for plugin-created files. Plugins MUST
+NOT create files in any other locations.
+
+### Plugin Code Example
+
+ :::c
+
+ /* Namespace for this plugin's keys. This SHOULD be something that could be
+ published as a document, even if that document does not exist right now.
+ */
+ #define NS_MY "http://example.org/myplugin/schema#"
+
+ #define DEFAULT_GREETING "Hello"
+
+ LV2_Handle
+ my_instantiate(...)
+ {
+ MyPlugin* plugin = ...;
+ plugin->uris.atom_String = map_uri(LV2_ATOM__String);
+ plugin->uris.my_greeting = map_uri(NS_MY "greeting");
+ plugin->state.greeting = strdup(DEFAULT_GREETING);
+ return plugin;
+ }
+
+ LV2_State_Status
+ my_save(LV2_Handle instance,
+ LV2_State_Store_Function store,
+ LV2_State_Handle handle,
+ uint32_t flags,
+ const LV2_Feature *const * features)
+ {
+ MyPlugin* plugin = (MyPlugin*)instance;
+ const char* greeting = plugin->state.greeting;
+
+ store(handle,
+ plugin->uris.my_greeting,
+ greeting,
+ strlen(greeting) + 1, // Careful! Need space for terminator
+ plugin->uris.atom_String,
+ LV2_STATE_IS_POD | LV2_STATE_IS_PORTABLE);
+
+ return LV2_STATE_SUCCESS;
+ }
+
+ LV2_State_Status
+ my_restore(LV2_Handle instance,
+ LV2_State_Retrieve_Function retrieve,
+ LV2_State_Handle handle,
+ uint32_t flags,
+ const LV2_Feature *const * features)
+ {
+ MyPlugin* plugin = (MyPlugin*)instance;
+
+ size_t size;
+ uint32_t type;
+ uint32_t flags;
+ const char* greeting = retrieve(
+ handle, plugin->uris.my_greeting, &size, &type, &flags);
+
+ if (greeting) {
+ free(plugin->state->greeting);
+ plugin->state->greeting = strdup(greeting);
+ } else {
+ plugin->state->greeting = strdup(DEFAULT_GREETING);
+ }
+
+ return LV2_STATE_SUCCESS;
+ }
+
+ const void*
+ my_extension_data(const char* uri)
+ {
+ static const LV2_State_Interface state_iface = { my_save, my_restore };
+ if (!strcmp(uri, LV2_STATE__interface)) {
+ return &state_iface;
+ }
+ }
+
+### Host Code Example
+
+ :::c
+ LV2_State_Status
+ store_callback(LV2_State_Handle handle,
+ uint32_t key,
+ const void* value,
+ size_t size,
+ uint32_t type,
+ uint32_t flags)
+ {
+ if ((flags & LV2_STATE_IS_POD)) {
+ // We only care about POD since we're keeping state in memory only.
+ // Disk or network use would also require LV2_STATE_IS_PORTABLE.
+ Map* state_map = (Map*)handle;
+ state_map->insert(key, Value(copy(value), size, type));
+ return LV2_STATE_SUCCESS;;
+ } else {
+ return LV2_STATE_ERR_BAD_FLAGS; // Non-POD events are unsupported
+ }
+ }
+
+ Map
+ get_plugin_state(LV2_Handle instance)
+ {
+ LV2_State* state = instance.extension_data(LV2_STATE__interface);
+
+ // Request a fast/native/POD save, since we're just copying in memory
+ Map state_map;
+ state.save(instance, store_callback, &state_map,
+ LV2_STATE_IS_POD|LV2_STATE_IS_NATIVE);
+
+ return state_map;
+ }
+
+### Extensions to this Specification
+
+It is likely that other interfaces for working with plugin state will be
+developed as needed. This is encouraged, however everything SHOULD work within
+the state _model_ defined here. That is, **do not complicate the state
+model**. Implementations can assume the following:
+
+ * The current port values and state dictionary completely describe a plugin
+ instance, at least well enough that saving and restoring will yield an
+ "identical" instance from the user's perspective.
+
+ * Hosts are not expected to save and/or restore any other attributes of a
+ plugin instance.
+
+### The "Property Principle"
+
+The main benefit of this meaningful state model is that it can double as a
+plugin control/query mechanism. For plugins that require more advanced control
+than simple control ports, instead of defining a set of commands, define
+properties whose values can be set appropriately. This provides both a way to
+control and save that state "for free", since there is no need to define
+commands _and_ a set of properties for storing their effects. In particular,
+this is a good way for UIs to achieve more advanced control of plugins.
+
+This "property principle" is summed up in the phrase: "Don't stop; set playing
+to false".
+
+This extension does not define a dynamic mechanism for state access and
+manipulation. The [LV2 Patch](patch.html) extension defines a generic set of
+messages which can be used to access or manipulate properties, and the [LV2
+Atom](atom.html) extension defines a port type and data container capable of
+transmitting those messages.
+
+"""^^lv2:Markdown .
+
+state:interface
+ lv2:documentation """
+
+A structure (LV2_State_Interface) which contains functions to be called by the
+host to save and restore state. In order to support this extension, the plugin
+must return a valid LV2_State_Interface from LV2_Descriptor::extension_data()
+when it is called with URI LV2_STATE__interface.
+
+The plugin data file should describe this like so:
+
+ :::turtle
+ @prefix state: &lt;http://lv2plug.in/ns/ext/state#&gt; .
+
+ &lt;plugin&gt;
+ a lv2:Plugin ;
+ lv2:extensionData state:interface .
+
+"""^^lv2:Markdown .
+
+state:State
+ lv2:documentation """
+
+This type should be used wherever instance state is described. The properties
+of a resource with this type correspond directly to the properties of the state
+dictionary (except the property that states it has this type).
+
+"""^^lv2:Markdown .
+
+state:loadDefaultState
+ lv2:documentation """
+
+This feature indicates that the plugin has default state listed with the
+state:state property which should be loaded by the host before running the
+plugin. Requiring this feature allows plugins to implement a single state
+loading mechanism which works for initialisation as well as restoration,
+without having to hard-code default state.
+
+To support this feature, the host MUST restore the default state after
+instantiating the plugin but before calling run().
+
+"""^^lv2:Markdown .
+
+state:state
+ lv2:documentation """
+
+This property may be used anywhere a state needs to be described, for example:
+
+ :::turtle
+ @prefix eg: &lt;http://example.org/&gt; .
+
+ &lt;plugin-instance&gt;
+ state:state [
+ eg:somekey "some value" ;
+ eg:someotherkey "some other value" ;
+ eg:favourite-number 2
+ ] .
+
+"""^^lv2:Markdown .
+
+state:mapPath
+ lv2:documentation """
+
+This feature maps absolute paths to/from <q>abstract paths</q> which are stored
+in state. To support this feature a host must pass an LV2_Feature with URI
+LV2_STATE__mapPath and data pointed to an LV2_State_Map_Path to the plugin's
+LV2_State_Interface methods.
+
+The plugin MUST map _all_ paths stored in its state (including those inside any
+files). This is necessary so that hosts can handle file system references
+correctly, for example to share common files, or bundle state for distribution
+or archival.
+
+For example, a plugin may write a path to a state file like so:
+
+ :::c
+ void write_path(LV2_State_Map_Path* map_path, FILE* myfile, const char* path)
+ {
+ char* abstract_path = map_path->abstract_path(map_path->handle, path);
+ fprintf(myfile, "%s", abstract_path);
+ free(abstract_path);
+ }
+
+Then, later reload the path like so:
+
+ :::c
+ char* read_path(LV2_State_Map_Path* map_path, FILE* myfile)
+ {
+ /* Obviously this is not production quality code! */
+ char abstract_path[1024];
+ fscanf(myfile, "%s", abstract_path);
+ return map_path->absolute_path(map_path->handle, abstract_path);
+ }
+
+"""^^lv2:Markdown .
+
+state:makePath
+ lv2:documentation """
+
+This feature allows plugins to create new files and/or directories. To support
+this feature the host passes an LV2_Feature with URI LV2_STATE__makePath and
+data pointed to an LV2_State_Make_Path to the plugin. The host may make this
+feature available only during save by passing it to
+LV2_State_Interface::save(), or available any time by passing it to
+LV2_Descriptor::instantiate(). If passed to LV2_State_Interface::save(), the
+feature MUST NOT be used beyond the scope of that call.
+
+The plugin is guaranteed a hierarchical namespace unique to that plugin
+instance, and may expect the returned path to have the requested path as a
+suffix. There is one such namespace, even if the feature is passed to both
+LV2_Descriptor::instantiate() and LV2_State_Interface::save(). Beyond this,
+the plugin MUST NOT make any assumptions about the returned paths.
+
+Like any other paths, the plugin MUST map these paths using state:mapPath
+before storing them in state. The plugin MUST NOT assume these paths will be
+available across a save/restore otherwise, that is, only mapped paths saved to
+state are persistent, any other created paths are temporary.
+
+For example, a plugin may create a file in a subdirectory like so:
+
+ :::c
+ char* save_myfile(LV2_State_Make_Path* make_path)
+ {
+ char* path = make_path->path(make_path->handle, "foo/bar/myfile.txt");
+ FILE* myfile = fopen(path, 'w');
+ fprintf(myfile, "I am some data");
+ fclose(myfile);
+ return path;
+ }
+
+"""^^lv2:Markdown .
+
+state:threadSafeRestore
+ lv2:documentation """
+
+If a plugin supports this feature, its LV2_State_Interface::restore method is
+thread-safe and may be called concurrently with audio class functions.
+
+To support this feature, the host MUST pass a
+[work:schedule](worker.html#schedule) feature to the restore method, which will
+be used to complete the state restoration. The usual mechanics of the worker
+apply: the host will call the plugin's work method, which emits a response
+which is later applied in the audio thread.
+
+The host is not required to block audio processing while restore() and work()
+load the state, so this feature allows state to be restored without dropouts.
+
+"""^^lv2:Markdown .
+
+state:freePath
+ lv2:documentation """
+
+This feature provides a function that can be used by plugins to free paths that
+were allocated by the host via other state features (state:mapPath and
+state:makePath).
+
+"""^^lv2:Markdown .
+
+state:Changed
+ lv2:documentation """
+
+A notification that the internal state of the plugin has been changed in a way
+that the host can not otherwise know about.
+
+This is a one-way notification, intended to be used as the type of an
+[Object](atom.html#Object) sent from plugins when necessary.
+
+Plugins SHOULD emit such an event whenever a change has occurred that would
+result in a different state being saved, but not when the host explicity makes
+a change which it knows is likely to have that effect, such as changing a
+parameter.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/state/state.ttl b/lv2/state/state.ttl
new file mode 100644
index 0000000..704b312
--- /dev/null
+++ b/lv2/state/state.ttl
@@ -0,0 +1,60 @@
+@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 state: <http://lv2plug.in/ns/ext/state#> .
+
+<http://lv2plug.in/ns/ext/state>
+ a owl:Ontology ;
+ rdfs:label "LV2 State" ;
+ rdfs:comment "An interface for LV2 plugins to save and restore state." ;
+ rdfs:seeAlso <state.h> ,
+ <state.meta.ttl> .
+
+state:interface
+ a lv2:ExtensionData ;
+ rdfs:label "interface" ;
+ rdfs:comment "A plugin interface for saving and restoring state." .
+
+state:State
+ a rdfs:Class ;
+ rdfs:label "State" ;
+ rdfs:comment "LV2 plugin state." .
+
+state:loadDefaultState
+ a lv2:Feature ;
+ rdfs:label "load default state" ;
+ rdfs:comment "A feature indicating that the plugin has default state." .
+
+state:state
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:label "state" ;
+ rdfs:range state:State ;
+ rdfs:comment "The state of an LV2 plugin instance." .
+
+state:mapPath
+ a lv2:Feature ;
+ rdfs:label "map path" ;
+ rdfs:comment "A feature for mapping between absolute and abstract file paths." .
+
+state:makePath
+ a lv2:Feature ;
+ rdfs:label "make path" ;
+ rdfs:comment "A feature for creating new files and directories." .
+
+state:threadSafeRestore
+ a lv2:Feature ;
+ rdfs:label "thread-safe restore" ;
+ rdfs:comment "A feature indicating support for thread-safe state restoration." .
+
+state:freePath
+ a lv2:Feature ;
+ rdfs:label "free path" ;
+ rdfs:comment "A feature for freeing paths allocated by the host." .
+
+state:Changed
+ a rdfs:Class ;
+ rdfs:label "Changed" ;
+ rdfs:comment "A notification that the internal state of the plugin has changed." .
+
diff --git a/lv2/lv2plug.in/ns/ext/time/manifest.ttl b/lv2/time/manifest.ttl
index b31ed3b..d80aa75 100644
--- a/lv2/lv2plug.in/ns/ext/time/manifest.ttl
+++ b/lv2/time/manifest.ttl
@@ -1,9 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/time>
a lv2:Specification ;
lv2:minorVersion 1 ;
- lv2:microVersion 2 ;
+ lv2:microVersion 6 ;
rdfs:seeAlso <time.ttl> .
diff --git a/lv2/time/time.h b/lv2/time/time.h
new file mode 100644
index 0000000..912d732
--- /dev/null
+++ b/lv2/time/time.h
@@ -0,0 +1,54 @@
+/*
+ Copyright 2011-2016 David Robillard <http://drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+/**
+ @defgroup time Time
+ @ingroup lv2
+
+ Properties for describing time, see <http://lv2plug.in/ns/ext/time> for
+ details.
+
+ Note the time extension is purely data, this header merely defines URIs for
+ convenience.
+
+ @{
+*/
+
+#ifndef LV2_TIME_H
+#define LV2_TIME_H
+
+#define LV2_TIME_URI "http://lv2plug.in/ns/ext/time" ///< http://lv2plug.in/ns/ext/time
+#define LV2_TIME_PREFIX LV2_TIME_URI "#" ///< http://lv2plug.in/ns/ext/time#
+
+#define LV2_TIME__Time LV2_TIME_PREFIX "Time" ///< http://lv2plug.in/ns/ext/time#Time
+#define LV2_TIME__Position LV2_TIME_PREFIX "Position" ///< http://lv2plug.in/ns/ext/time#Position
+#define LV2_TIME__Rate LV2_TIME_PREFIX "Rate" ///< http://lv2plug.in/ns/ext/time#Rate
+#define LV2_TIME__position LV2_TIME_PREFIX "position" ///< http://lv2plug.in/ns/ext/time#position
+#define LV2_TIME__barBeat LV2_TIME_PREFIX "barBeat" ///< http://lv2plug.in/ns/ext/time#barBeat
+#define LV2_TIME__bar LV2_TIME_PREFIX "bar" ///< http://lv2plug.in/ns/ext/time#bar
+#define LV2_TIME__beat LV2_TIME_PREFIX "beat" ///< http://lv2plug.in/ns/ext/time#beat
+#define LV2_TIME__beatUnit LV2_TIME_PREFIX "beatUnit" ///< http://lv2plug.in/ns/ext/time#beatUnit
+#define LV2_TIME__beatsPerBar LV2_TIME_PREFIX "beatsPerBar" ///< http://lv2plug.in/ns/ext/time#beatsPerBar
+#define LV2_TIME__beatsPerMinute LV2_TIME_PREFIX "beatsPerMinute" ///< http://lv2plug.in/ns/ext/time#beatsPerMinute
+#define LV2_TIME__frame LV2_TIME_PREFIX "frame" ///< http://lv2plug.in/ns/ext/time#frame
+#define LV2_TIME__framesPerSecond LV2_TIME_PREFIX "framesPerSecond" ///< http://lv2plug.in/ns/ext/time#framesPerSecond
+#define LV2_TIME__speed LV2_TIME_PREFIX "speed" ///< http://lv2plug.in/ns/ext/time#speed
+
+/**
+ @}
+*/
+
+#endif /* LV2_TIME_H */
diff --git a/lv2/time/time.meta.ttl b/lv2/time/time.meta.ttl
new file mode 100644
index 0000000..2b99cb7
--- /dev/null
+++ b/lv2/time/time.meta.ttl
@@ -0,0 +1,112 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix time: <http://lv2plug.in/ns/ext/time#> .
+
+<http://lv2plug.in/ns/ext/time>
+ a doap:Project ;
+ doap:name "LV2 Time" ;
+ doap:shortdesc "A vocabulary for describing musical time." ;
+ doap:created "2011-10-05" ;
+ doap:developer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "1.6" ;
+ doap:created "2019-02-03" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.16.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Clarify time:beat origin."
+ ]
+ ]
+ ] , [
+ doap:revision "1.4" ;
+ doap:created "2016-07-31" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.14.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Define LV2_TIME_PREFIX."
+ ]
+ ]
+ ] , [
+ doap:revision "1.2" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Use consistent label style."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+This is a vocabulary for describing a position in time and the speed of time
+passage, in both real and musical terms.
+
+In addition to real time (based on seconds), two units of time are used:
+_frames_ and _beats_. A frame is a numbered quantum of time. Frame time is
+related to real-time by the _frame rate_ or _sample rate_,
+time:framesPerSecond. A beat is a single pulse of musical time. Beat time is
+related to real-time by the _tempo_, time:beatsPerMinute.
+
+Musical time additionally has a _meter_ which describes passage of time in
+terms of musical _bars_. A bar is a higher level grouping of beats. The meter
+describes how many beats are in one bar.
+
+"""^^lv2:Markdown .
+
+time:Position
+ lv2:documentation """
+
+A point in time and/or the speed at which time is passing. A position is both
+a point and a speed, which precisely defines a time within a timeline.
+
+"""^^lv2:Markdown .
+
+time:Rate
+ lv2:documentation """
+
+The rate of passage of time in terms of one unit with respect to another.
+
+"""^^lv2:Markdown .
+
+time:beat
+ lv2:documentation """
+
+This is not the beat within a bar like time:barBeat, but relative to the same
+origin as time:bar and monotonically increases unless the transport is
+repositioned.
+
+"""^^lv2:Markdown .
+
+time:beatUnit
+ lv2:documentation """
+
+Beat unit, the note value that counts as one beat. This is the bottom number
+in a time signature: 2 for half note, 4 for quarter note, and so on.
+
+"""^^lv2:Markdown .
+
+time:speed
+ lv2:documentation """
+
+The rate of the progress of time as a fraction of normal speed. For example, a
+rate of 0.0 is stopped, 1.0 is rolling at normal speed, 0.5 is rolling at half
+speed, -1.0 is reverse, and so on.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/lv2plug.in/ns/ext/time/time.ttl b/lv2/time/time.ttl
index 383cb4d..a4085c6 100644
--- a/lv2/lv2plug.in/ns/ext/time/time.ttl
+++ b/lv2/time/time.ttl
@@ -1,57 +1,43 @@
-@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 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 time: <http://lv2plug.in/ns/ext/time#> .
-@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
<http://lv2plug.in/ns/ext/time>
a owl:Ontology ;
+ rdfs:label "LV2 Time" ;
+ rdfs:comment "A vocabulary for describing musical time." ;
rdfs:seeAlso <time.h> ,
- <lv2-time.doap.ttl> ;
- lv2:documentation """
-<p>This is a vocabulary for precisely describing a position in time and the
-passage of time itself, in both real and musical terms.</p>
-
-<p>In addition to real time (e.g. seconds), two units of time are used:
-<q>frames</q> and <q>beats</q>. A frame is a numbered quantum of time. Frame
-time is related to real-time by the <q>frame rate</q> or <q>sample rate</q>,
-time:framesPerSecond. A beat is a single pulse of musical time. Beat time is
-related to real-time by the <q>tempo</q>, time:beatsPerMinute.</p>
-
-<p>Musical time additionally has a <q>meter</q> which describes passage of time
-in terms of musical <q>bars</q>. A bar is a higher level grouping of beats.
-The meter describes how many beats are in one bar.</p>
-""" .
+ <time.meta.ttl> .
time:Time
- a rdfs:Class ;
+ a rdfs:Class ,
+ owl:Class ;
rdfs:subClassOf time:Position ;
rdfs:label "Time" ;
rdfs:comment "A point in time in some unit/dimension." .
time:Position
- a rdfs:Class ;
+ a rdfs:Class ,
+ owl:Class ;
rdfs:label "Position" ;
- lv2:documentation """
-<p>A point in time and/or the speed at which time is passing. A position is
-both a point and a speed, which precisely defines a time within a timeline.</p>
-""" .
+ rdfs:comment "A point in time and/or the speed at which time is passing." .
time:Rate
- a rdfs:Class ;
+ a rdfs:Class ,
+ owl:Class ;
rdfs:subClassOf time:Position ;
rdfs:label "Rate" ;
- lv2:documentation """
-<p>The rate of passage of time in terms of one unit with respect to
-another.</p> """ .
+ rdfs:comment "The rate of passage of time." .
time:position
a rdf:Property ,
owl:ObjectProperty ,
owl:FunctionalProperty ;
rdfs:range time:Position ;
- rdfs:label "position" .
+ rdfs:label "position" ;
+ rdfs:comment "A musical position." .
time:barBeat
a rdf:Property ,
@@ -60,7 +46,7 @@ time:barBeat
rdfs:domain time:Time ;
rdfs:range xsd:float ;
rdfs:label "beat within bar" ;
- rdfs:comment "The beat number within the bar, from 0 to beatsPerBar." .
+ rdfs:comment "The beat number within the bar, from 0 to time:beatsPerBar." .
time:bar
a rdf:Property ,
@@ -68,7 +54,8 @@ time:bar
owl:FunctionalProperty ;
rdfs:domain time:Time ;
rdfs:range xsd:long ;
- rdfs:label "bar" .
+ rdfs:label "bar" ;
+ rdfs:comment "A musical bar or measure." .
time:beat
a rdf:Property ,
@@ -76,7 +63,8 @@ time:beat
owl:FunctionalProperty ;
rdfs:domain time:Time ;
rdfs:range xsd:double ;
- rdfs:label "beat" .
+ rdfs:label "beat" ;
+ rdfs:comment "The global running beat number." .
time:beatUnit
a rdf:Property ,
@@ -84,10 +72,8 @@ time:beatUnit
owl:FunctionalProperty ;
rdfs:domain time:Rate ;
rdfs:range xsd:nonNegativeInteger ;
- lv2:documentation """
-<p>Beat unit, the note value that counts as one beat. This is the bottom number
-in a time signature: 2 for half note, 4 for quarter note, and so on.</p>
-""" .
+ rdfs:label "beat unit" ;
+ rdfs:comment "The note value that counts as one beat." .
time:beatsPerBar
a rdf:Property ,
@@ -95,7 +81,8 @@ time:beatsPerBar
owl:FunctionalProperty ;
rdfs:domain time:Rate ;
rdfs:range xsd:float ;
- rdfs:label "beats per bar" .
+ rdfs:label "beats per bar" ;
+ rdfs:comment "The number of beats in one bar." .
time:beatsPerMinute
a rdf:Property ,
@@ -112,7 +99,8 @@ time:frame
owl:FunctionalProperty ;
rdfs:domain time:Time ;
rdfs:range xsd:long ;
- rdfs:label "frame" .
+ rdfs:label "frame" ;
+ rdfs:comment "A time stamp in audio frames." .
time:framesPerSecond
a rdf:Property ,
@@ -130,9 +118,5 @@ time:speed
rdfs:domain time:Rate ;
rdfs:range xsd:float ;
rdfs:label "speed" ;
- lv2:documentation """
-<p>The rate of the progress of time as a fraction of normal speed. For
-example, a rate of 0.0 is stopped, 1.0 is rolling at normal speed, 0.5 is
-rolling at half speed, -1.0 is reverse, and so on.
-</p>
-""" .
+ rdfs:comment "The rate of the progress of time as a fraction of normal speed." .
+
diff --git a/lv2/lv2plug.in/ns/extensions/ui/manifest.ttl b/lv2/ui/manifest.ttl
index 1b9d1b7..9f259ad 100644
--- a/lv2/lv2plug.in/ns/extensions/ui/manifest.ttl
+++ b/lv2/ui/manifest.ttl
@@ -1,8 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/extensions/ui>
a lv2:Specification ;
lv2:minorVersion 2 ;
- lv2:microVersion 15 ;
- rdfs:seeAlso <ui.ttl> . \ No newline at end of file
+ lv2:microVersion 22 ;
+ rdfs:seeAlso <ui.ttl> .
+
diff --git a/lv2/ui/ui.h b/lv2/ui/ui.h
new file mode 100644
index 0000000..ce6aa4f
--- /dev/null
+++ b/lv2/ui/ui.h
@@ -0,0 +1,539 @@
+/*
+ LV2 UI Extension
+ Copyright 2009-2016 David Robillard <d@drobilla.net>
+ Copyright 2006-2011 Lars Luthman <lars.luthman@gmail.com>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+/**
+ @defgroup ui User Interfaces
+ @ingroup lv2
+
+ User interfaces of any type for plugins,
+ <http://lv2plug.in/ns/extensions/ui> for details.
+
+ @{
+*/
+
+#ifndef LV2_UI_H
+#define LV2_UI_H
+
+#include "lv2/core/lv2.h"
+#include "lv2/urid/urid.h"
+
+#include <stdbool.h>
+#include <stdint.h>
+
+#define LV2_UI_URI "http://lv2plug.in/ns/extensions/ui" ///< http://lv2plug.in/ns/extensions/ui
+#define LV2_UI_PREFIX LV2_UI_URI "#" ///< http://lv2plug.in/ns/extensions/ui#
+
+#define LV2_UI__CocoaUI LV2_UI_PREFIX "CocoaUI" ///< http://lv2plug.in/ns/extensions/ui#CocoaUI
+#define LV2_UI__Gtk3UI LV2_UI_PREFIX "Gtk3UI" ///< http://lv2plug.in/ns/extensions/ui#Gtk3UI
+#define LV2_UI__GtkUI LV2_UI_PREFIX "GtkUI" ///< http://lv2plug.in/ns/extensions/ui#GtkUI
+#define LV2_UI__PortNotification LV2_UI_PREFIX "PortNotification" ///< http://lv2plug.in/ns/extensions/ui#PortNotification
+#define LV2_UI__PortProtocol LV2_UI_PREFIX "PortProtocol" ///< http://lv2plug.in/ns/extensions/ui#PortProtocol
+#define LV2_UI__Qt4UI LV2_UI_PREFIX "Qt4UI" ///< http://lv2plug.in/ns/extensions/ui#Qt4UI
+#define LV2_UI__Qt5UI LV2_UI_PREFIX "Qt5UI" ///< http://lv2plug.in/ns/extensions/ui#Qt5UI
+#define LV2_UI__UI LV2_UI_PREFIX "UI" ///< http://lv2plug.in/ns/extensions/ui#UI
+#define LV2_UI__WindowsUI LV2_UI_PREFIX "WindowsUI" ///< http://lv2plug.in/ns/extensions/ui#WindowsUI
+#define LV2_UI__X11UI LV2_UI_PREFIX "X11UI" ///< http://lv2plug.in/ns/extensions/ui#X11UI
+#define LV2_UI__binary LV2_UI_PREFIX "binary" ///< http://lv2plug.in/ns/extensions/ui#binary
+#define LV2_UI__fixedSize LV2_UI_PREFIX "fixedSize" ///< http://lv2plug.in/ns/extensions/ui#fixedSize
+#define LV2_UI__idleInterface LV2_UI_PREFIX "idleInterface" ///< http://lv2plug.in/ns/extensions/ui#idleInterface
+#define LV2_UI__noUserResize LV2_UI_PREFIX "noUserResize" ///< http://lv2plug.in/ns/extensions/ui#noUserResize
+#define LV2_UI__notifyType LV2_UI_PREFIX "notifyType" ///< http://lv2plug.in/ns/extensions/ui#notifyType
+#define LV2_UI__parent LV2_UI_PREFIX "parent" ///< http://lv2plug.in/ns/extensions/ui#parent
+#define LV2_UI__plugin LV2_UI_PREFIX "plugin" ///< http://lv2plug.in/ns/extensions/ui#plugin
+#define LV2_UI__portIndex LV2_UI_PREFIX "portIndex" ///< http://lv2plug.in/ns/extensions/ui#portIndex
+#define LV2_UI__portMap LV2_UI_PREFIX "portMap" ///< http://lv2plug.in/ns/extensions/ui#portMap
+#define LV2_UI__portNotification LV2_UI_PREFIX "portNotification" ///< http://lv2plug.in/ns/extensions/ui#portNotification
+#define LV2_UI__portSubscribe LV2_UI_PREFIX "portSubscribe" ///< http://lv2plug.in/ns/extensions/ui#portSubscribe
+#define LV2_UI__protocol LV2_UI_PREFIX "protocol" ///< http://lv2plug.in/ns/extensions/ui#protocol
+#define LV2_UI__requestValue LV2_UI_PREFIX "requestValue" ///< http://lv2plug.in/ns/extensions/ui#requestValue
+#define LV2_UI__floatProtocol LV2_UI_PREFIX "floatProtocol" ///< http://lv2plug.in/ns/extensions/ui#floatProtocol
+#define LV2_UI__peakProtocol LV2_UI_PREFIX "peakProtocol" ///< http://lv2plug.in/ns/extensions/ui#peakProtocol
+#define LV2_UI__resize LV2_UI_PREFIX "resize" ///< http://lv2plug.in/ns/extensions/ui#resize
+#define LV2_UI__showInterface LV2_UI_PREFIX "showInterface" ///< http://lv2plug.in/ns/extensions/ui#showInterface
+#define LV2_UI__touch LV2_UI_PREFIX "touch" ///< http://lv2plug.in/ns/extensions/ui#touch
+#define LV2_UI__ui LV2_UI_PREFIX "ui" ///< http://lv2plug.in/ns/extensions/ui#ui
+#define LV2_UI__updateRate LV2_UI_PREFIX "updateRate" ///< http://lv2plug.in/ns/extensions/ui#updateRate
+#define LV2_UI__windowTitle LV2_UI_PREFIX "windowTitle" ///< http://lv2plug.in/ns/extensions/ui#windowTitle
+#define LV2_UI__scaleFactor LV2_UI_PREFIX "scaleFactor" ///< http://lv2plug.in/ns/extensions/ui#scaleFactor
+#define LV2_UI__foregroundColor LV2_UI_PREFIX "foregroundColor" ///< http://lv2plug.in/ns/extensions/ui#foregroundColor
+#define LV2_UI__backgroundColor LV2_UI_PREFIX "backgroundColor" ///< http://lv2plug.in/ns/extensions/ui#backgroundColor
+
+/**
+ The index returned by LV2UI_Port_Map::port_index() for unknown ports.
+*/
+#define LV2UI_INVALID_PORT_INDEX ((uint32_t)-1)
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ A pointer to some widget or other type of UI handle.
+
+ The actual type is defined by the type of the UI.
+*/
+typedef void* LV2UI_Widget;
+
+/**
+ A pointer to UI instance internals.
+
+ The host may compare this to NULL, but otherwise MUST NOT interpret it.
+*/
+typedef void* LV2UI_Handle;
+
+/**
+ A pointer to a controller provided by the host.
+
+ The UI may compare this to NULL, but otherwise MUST NOT interpret it.
+*/
+typedef void* LV2UI_Controller;
+
+/**
+ A pointer to opaque data for a feature.
+*/
+typedef void* LV2UI_Feature_Handle;
+
+/**
+ A host-provided function that sends data to a plugin's input ports.
+
+ @param controller The opaque controller pointer passed to
+ LV2UI_Descriptor::instantiate().
+
+ @param port_index Index of the port to update.
+
+ @param buffer Buffer containing `buffer_size` bytes of data.
+
+ @param buffer_size Size of `buffer` in bytes.
+
+ @param port_protocol Either 0 or the URID for a ui:PortProtocol. If 0, the
+ protocol is implicitly ui:floatProtocol, the port MUST be an lv2:ControlPort
+ input, `buffer` MUST point to a single float value, and `buffer_size` MUST
+ be sizeof(float). The UI SHOULD NOT use a protocol not supported by the
+ host, but the host MUST gracefully ignore any protocol it does not
+ understand.
+*/
+typedef void (*LV2UI_Write_Function)(LV2UI_Controller controller,
+ uint32_t port_index,
+ uint32_t buffer_size,
+ uint32_t port_protocol,
+ const void* buffer);
+
+/**
+ A plugin UI.
+
+ A pointer to an object of this type is returned by the lv2ui_descriptor()
+ function.
+*/
+typedef struct LV2UI_Descriptor {
+ /**
+ The URI for this UI (not for the plugin it controls).
+ */
+ const char* URI;
+
+ /**
+ Create a new UI and return a handle to it. This function works
+ similarly to LV2_Descriptor::instantiate().
+
+ @param descriptor The descriptor for the UI to instantiate.
+
+ @param plugin_uri The URI of the plugin that this UI will control.
+
+ @param bundle_path The path to the bundle containing this UI, including
+ the trailing directory separator.
+
+ @param write_function A function that the UI can use to send data to the
+ plugin's input ports.
+
+ @param controller A handle for the UI instance to be passed as the
+ first parameter of UI methods.
+
+ @param widget (output) widget pointer. The UI points this at its main
+ widget, which has the type defined by the UI type in the data file.
+
+ @param features An array of LV2_Feature pointers. The host must pass
+ all feature URIs that it and the UI supports and any additional data, as
+ in LV2_Descriptor::instantiate(). Note that UI features and plugin
+ features are not necessarily the same.
+
+ */
+ LV2UI_Handle (*instantiate)(const struct LV2UI_Descriptor* descriptor,
+ const char* plugin_uri,
+ const char* bundle_path,
+ LV2UI_Write_Function write_function,
+ LV2UI_Controller controller,
+ LV2UI_Widget* widget,
+ const LV2_Feature* const* features);
+
+
+ /**
+ Destroy the UI. The host must not try to access the widget after
+ calling this function.
+ */
+ void (*cleanup)(LV2UI_Handle ui);
+
+ /**
+ Tell the UI that something interesting has happened at a plugin port.
+
+ What is "interesting" and how it is written to `buffer` is defined by
+ `format`, which has the same meaning as in LV2UI_Write_Function().
+ Format 0 is a special case for lv2:ControlPort, where this function
+ should be called when the port value changes (but not necessarily for
+ every change), `buffer_size` must be sizeof(float), and `buffer`
+ points to a single IEEE-754 float.
+
+ By default, the host should only call this function for lv2:ControlPort
+ inputs. However, the UI can request updates for other ports statically
+ with ui:portNotification or dynamicaly with ui:portSubscribe.
+
+ The UI MUST NOT retain any reference to `buffer` after this function
+ returns, it is only valid for the duration of the call.
+
+ This member may be NULL if the UI is not interested in any port events.
+ */
+ void (*port_event)(LV2UI_Handle ui,
+ uint32_t port_index,
+ uint32_t buffer_size,
+ uint32_t format,
+ const void* buffer);
+
+ /**
+ Return a data structure associated with an extension URI, typically an
+ interface struct with additional function pointers
+
+ This member may be set to NULL if the UI is not interested in supporting
+ any extensions. This is similar to LV2_Descriptor::extension_data().
+
+ */
+ const void* (*extension_data)(const char* uri);
+} LV2UI_Descriptor;
+
+/**
+ Feature/interface for resizable UIs (LV2_UI__resize).
+
+ This structure is used in two ways: as a feature passed by the host via
+ LV2UI_Descriptor::instantiate(), or as an interface provided by a UI via
+ LV2UI_Descriptor::extension_data()).
+*/
+typedef struct {
+ /**
+ Pointer to opaque data which must be passed to ui_resize().
+ */
+ LV2UI_Feature_Handle handle;
+
+ /**
+ Request/advertise a size change.
+
+ When provided by the host, the UI may call this function to inform the
+ host about the size of the UI.
+
+ When provided by the UI, the host may call this function to notify the
+ UI that it should change its size accordingly. In this case, the host
+ must pass the LV2UI_Handle to provide access to the UI instance.
+
+ @return 0 on success.
+ */
+ int (*ui_resize)(LV2UI_Feature_Handle handle, int width, int height);
+} LV2UI_Resize;
+
+/**
+ Feature to map port symbols to UIs.
+
+ This can be used by the UI to get the index for a port with the given
+ symbol. This makes it possible to implement and distribute a UI separately
+ from the plugin (since symbol, unlike index, is a stable port identifier).
+*/
+typedef struct {
+ /**
+ Pointer to opaque data which must be passed to port_index().
+ */
+ LV2UI_Feature_Handle handle;
+
+ /**
+ Get the index for the port with the given `symbol`.
+
+ @return The index of the port, or LV2UI_INVALID_PORT_INDEX if no such
+ port is found.
+ */
+ uint32_t (*port_index)(LV2UI_Feature_Handle handle, const char* symbol);
+} LV2UI_Port_Map;
+
+/**
+ Feature to subscribe to port updates (LV2_UI__portSubscribe).
+*/
+typedef struct {
+ /**
+ Pointer to opaque data which must be passed to subscribe() and
+ unsubscribe().
+ */
+ LV2UI_Feature_Handle handle;
+
+ /**
+ Subscribe to updates for a port.
+
+ This means that the host will call the UI's port_event() function when
+ the port value changes (as defined by protocol).
+
+ Calling this function with the same `port_index` and `port_protocol`
+ as an already active subscription has no effect.
+
+ @param handle The handle field of this struct.
+ @param port_index The index of the port.
+ @param port_protocol The URID of the ui:PortProtocol.
+ @param features Features for this subscription.
+ @return 0 on success.
+ */
+ uint32_t (*subscribe)(LV2UI_Feature_Handle handle,
+ uint32_t port_index,
+ uint32_t port_protocol,
+ const LV2_Feature* const* features);
+
+ /**
+ Unsubscribe from updates for a port.
+
+ This means that the host will cease calling calling port_event() when
+ the port value changes.
+
+ Calling this function with a `port_index` and `port_protocol` that
+ does not refer to an active port subscription has no effect.
+
+ @param handle The handle field of this struct.
+ @param port_index The index of the port.
+ @param port_protocol The URID of the ui:PortProtocol.
+ @param features Features for this subscription.
+ @return 0 on success.
+ */
+ uint32_t (*unsubscribe)(LV2UI_Feature_Handle handle,
+ uint32_t port_index,
+ uint32_t port_protocol,
+ const LV2_Feature* const* features);
+} LV2UI_Port_Subscribe;
+
+/**
+ A feature to notify the host that the user has grabbed a UI control.
+*/
+typedef struct {
+ /**
+ Pointer to opaque data which must be passed to ui_resize().
+ */
+ LV2UI_Feature_Handle handle;
+
+ /**
+ Notify the host that a control has been grabbed or released.
+
+ The host should cease automating the port or otherwise manipulating the
+ port value until the control has been ungrabbed.
+
+ @param handle The handle field of this struct.
+ @param port_index The index of the port associated with the control.
+ @param grabbed If true, the control has been grabbed, otherwise the
+ control has been released.
+ */
+ void (*touch)(LV2UI_Feature_Handle handle,
+ uint32_t port_index,
+ bool grabbed);
+} LV2UI_Touch;
+
+/**
+ A status code for LV2UI_Request_Value::request().
+*/
+typedef enum {
+ /**
+ Completed successfully.
+
+ The host will set the parameter later if the user choses a new value.
+ */
+ LV2UI_REQUEST_VALUE_SUCCESS,
+
+ /**
+ Parameter already being requested.
+
+ The host is already requesting a parameter from the user (for example, a
+ dialog is visible), or the UI is otherwise busy and can not make this
+ request.
+ */
+ LV2UI_REQUEST_VALUE_BUSY,
+
+ /**
+ Unknown parameter.
+
+ The host is not aware of this parameter, and is not able to set a new
+ value for it.
+ */
+ LV2UI_REQUEST_VALUE_ERR_UNKNOWN,
+
+ /**
+ Unsupported parameter.
+
+ The host knows about this parameter, but does not support requesting a
+ new value for it from the user. This is likely because the host does
+ not have UI support for choosing a value with the appropriate type.
+ */
+ LV2UI_REQUEST_VALUE_ERR_UNSUPPORTED
+} LV2UI_Request_Value_Status;
+
+/**
+ A feature to request a new parameter value from the host.
+*/
+typedef struct {
+ /**
+ Pointer to opaque data which must be passed to request().
+ */
+ LV2UI_Feature_Handle handle;
+
+ /**
+ Request a value for a parameter from the host.
+
+ This is mainly used by UIs to request values for complex parameters that
+ don't change often, such as file paths, but it may be used to request
+ any parameter value.
+
+ This function returns immediately, and the return value indicates
+ whether the host can fulfill the request. The host may notify the
+ plugin about the new parameter value, for example when a file is
+ selected by the user, via the usual mechanism. Typically, the host will
+ send a message to the plugin that sets the new parameter value, and the
+ plugin will notify the UI via a message as usual for any other parameter
+ change.
+
+ To provide an appropriate UI, the host can determine details about the
+ parameter from the plugin data as usual. The additional parameters of
+ this function provide support for more advanced use cases, but in the
+ simple common case, the plugin will simply pass the key of the desired
+ parameter and zero for everything else.
+
+ @param handle The handle field of this struct.
+
+ @param key The URID of the parameter.
+
+ @param type The optional type of the value to request. This can be used
+ to request a specific value type for parameters that support several.
+ If non-zero, it must be the URID of an instance of rdfs:Class or
+ rdfs:Datatype.
+
+ @param features Additional features for this request, or NULL.
+
+ @return A status code which is 0 on success.
+ */
+ LV2UI_Request_Value_Status (*request)(LV2UI_Feature_Handle handle,
+ LV2_URID key,
+ LV2_URID type,
+ const LV2_Feature* const* features);
+
+} LV2UI_Request_Value;
+
+/**
+ UI Idle Interface (LV2_UI__idleInterface)
+
+ UIs can provide this interface to have an idle() callback called by the host
+ rapidly to update the UI.
+*/
+typedef struct {
+ /**
+ Run a single iteration of the UI's idle loop.
+
+ This will be called rapidly in the UI thread at a rate appropriate
+ for a toolkit main loop. There are no precise timing guarantees, but
+ the host should attempt to call idle() at a high enough rate for smooth
+ animation, at least 30Hz.
+
+ @return non-zero if the UI has been closed, in which case the host
+ should stop calling idle(), and can either completely destroy the UI, or
+ re-show it and resume calling idle().
+ */
+ int (*idle)(LV2UI_Handle ui);
+} LV2UI_Idle_Interface;
+
+/**
+ UI Show Interface (LV2_UI__showInterface)
+
+ UIs can provide this interface to show and hide a window, which allows them
+ to function in hosts unable to embed their widget. This allows any UI to
+ provide a fallback for embedding that works in any host.
+
+ If used:
+ - The host MUST use LV2UI_Idle_Interface to drive the UI.
+ - The UI MUST return non-zero from LV2UI_Idle_Interface::idle() when it has been closed.
+ - If idle() returns non-zero, the host MUST call hide() and stop calling
+ idle(). It MAY later call show() then resume calling idle().
+*/
+typedef struct {
+ /**
+ Show a window for this UI.
+
+ The window title MAY have been passed by the host to
+ LV2UI_Descriptor::instantiate() as an LV2_Options_Option with key
+ LV2_UI__windowTitle.
+
+ @return 0 on success, or anything else to stop being called.
+ */
+ int (*show)(LV2UI_Handle ui);
+
+ /**
+ Hide the window for this UI.
+
+ @return 0 on success, or anything else to stop being called.
+ */
+ int (*hide)(LV2UI_Handle ui);
+} LV2UI_Show_Interface;
+
+/**
+ Peak data for a slice of time, the update format for ui:peakProtocol.
+*/
+typedef struct {
+ /**
+ The start of the measurement period. This is just a running counter
+ that is only meaningful in comparison to previous values and must not be
+ interpreted as an absolute time.
+ */
+ uint32_t period_start;
+
+ /**
+ The size of the measurement period, in the same units as period_start.
+ */
+ uint32_t period_size;
+
+ /**
+ The peak value for the measurement period. This should be the maximal
+ value for abs(sample) over all the samples in the period.
+ */
+ float peak;
+} LV2UI_Peak_Data;
+
+/**
+ Prototype for UI accessor function.
+
+ This is the entry point to a UI library, which works in the same way as
+ lv2_descriptor() but for UIs rather than plugins.
+*/
+LV2_SYMBOL_EXPORT
+const LV2UI_Descriptor* lv2ui_descriptor(uint32_t index);
+
+/**
+ The type of the lv2ui_descriptor() function.
+*/
+typedef const LV2UI_Descriptor* (*LV2UI_DescriptorFunction)(uint32_t index);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* LV2_UI_H */
+
+/**
+ @}
+*/
diff --git a/lv2/ui/ui.meta.ttl b/lv2/ui/ui.meta.ttl
new file mode 100644
index 0000000..cb92a86
--- /dev/null
+++ b/lv2/ui/ui.meta.ttl
@@ -0,0 +1,627 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix ui: <http://lv2plug.in/ns/extensions/ui#> .
+
+<http://lv2plug.in/ns/extensions/ui>
+ a doap:Project ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ doap:name "LV2 UI" ;
+ doap:shortdesc "User interfaces for LV2 plugins." ;
+ doap:created "2006-00-00" ;
+ doap:developer <http://lv2plug.in/ns/meta#larsl> ;
+ doap:maintainer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "2.22" ;
+ doap:created "2020-04-26" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.18.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add ui:requestValue feature."
+ ] , [
+ rdfs:label "Add ui:scaleFactor, ui:foregroundColor, and ui:backgroundColor properties."
+ ] , [
+ rdfs:label "Deprecate ui:binary."
+ ]
+ ]
+ ] , [
+ doap:revision "2.20" ;
+ doap:created "2015-07-25" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.14.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Improve documentation."
+ ] , [
+ rdfs:label "Add missing property labels."
+ ]
+ ]
+ ] , [
+ doap:revision "2.18" ;
+ doap:created "2014-08-08" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.10.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add show interface so UIs can gracefully degrade to separate windows if hosts can not use their widget directly."
+ ] , [
+ rdfs:label "Fix identifier typos in documentation."
+ ]
+ ]
+ ] , [
+ doap:revision "2.16" ;
+ doap:created "2014-01-04" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.8.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix LV2_UI_INVALID_PORT_INDEX identifier in documentation."
+ ]
+ ]
+ ] , [
+ doap:revision "2.14" ;
+ doap:created "2013-03-18" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.6.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add idle interface so native UIs and foreign toolkits can drive their event loops."
+ ] , [
+ rdfs:label "Add ui:updateRate property."
+ ]
+ ]
+ ] , [
+ doap:revision "2.12" ;
+ doap:created "2012-12-01" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix incorrect linker flag in ui:makeSONameResident documentation."
+ ]
+ ]
+ ] , [
+ doap:revision "2.10" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add types for WindowsUI, CocoaUI, and Gtk3UI."
+ ] , [
+ rdfs:label "Use consistent label style."
+ ] , [
+ rdfs:label "Add missing LV2_SYMBOL_EXPORT declaration for lv2ui_descriptor prototype."
+ ]
+ ]
+ ] , [
+ doap:revision "2.8" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add ui:parent and ui:resize."
+ ] , [
+ rdfs:label "Add support for referring to ports by symbol."
+ ] , [
+ rdfs:label "Add ui:portMap for accessing ports by symbol, allowing for UIs to be distributed separately from plugins."
+ ] , [
+ rdfs:label "Add port protocols and a dynamic notification subscription mechanism, for more flexible communication, and audio port metering without control port kludges."
+ ] , [
+ rdfs:label "Add touch feature to notify the host that the user has grabbed a control."
+ ] , [
+ rdfs:label "Merge with unified LV2 package."
+ ]
+ ]
+ ] , [
+ doap:revision "2.4" ;
+ doap:created "2011-11-21" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-ui-2.4.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Deprecate ui:makeSONameResident."
+ ] , [
+ rdfs:label "Add Qt4 and X11 widget types."
+ ] , [
+ rdfs:label "Install header to URI-based system path."
+ ] , [
+ rdfs:label "Add pkg-config file."
+ ] , [
+ rdfs:label "Make ui.ttl a valid OWL 2 DL ontology."
+ ]
+ ]
+ ] , [
+ doap:revision "2.2" ;
+ doap:created "2011-05-26" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-ui-2.2.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add build system (for installation)."
+ ] , [
+ rdfs:label "Convert documentation to HTML and use lv2:documentation."
+ ] , [
+ rdfs:label "Use lv2:Specification to be discovered as an extension."
+ ]
+ ]
+ ] , [
+ doap:revision "2.0" ;
+ doap:created "2010-10-06" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-ui-2.0.tar.gz> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+This extension makes it possible to create user interfaces for LV2 plugins.
+
+UIs are implemented as an LV2UI_Descriptor loaded via lv2ui_descriptor() in a
+shared library, and are distributed in bundles just like plugins.
+
+UIs are associated with plugins in data:
+
+ :::turtle
+ @prefix ui: <http://lv2plug.in/ns/extensions/ui#> .
+
+ <http://my.plugin> ui:ui <http://my.pluginui> .
+ <http://my.pluginui> a ui:X11UI ;
+ lv2:binary <myui.so> .
+
+where `http://my.plugin` is the URI of the plugin, `http://my.pluginui` is the
+URI of the plugin UI and `myui.so` is the relative URI to the shared object
+file.
+
+While it is possible to have the plugin UI and the plugin in the same shared
+object file, it is a good idea to keep them separate so that hosts can avoid
+loading the UI code if they do not need it. A UI MUST specify its class in the
+RDF data (`ui:X11UI` in the above example). The class defines what type the UI
+is, for example what graphics toolkit it uses. Any type of UI class can be
+defined separately from this extension.
+
+It is possible to have multiple UIs for the same plugin, or to have the UI for
+a plugin in a different bundle from the actual plugin. This allows plugin UIs
+to be written independently.
+
+Note that the process that loads the shared object file containing the UI code
+and the process that loads the shared object file containing the actual plugin
+implementation are not necessarily the same process (and not even necessarily
+on the same machine). This means that plugin and UI code MUST NOT use
+singletons and global variables and expect them to refer to the same objects in
+the UI and the actual plugin. The function callback interface defined in this
+header is the only method of communication between UIs and plugin instances
+(extensions may define more, though this is discouraged unless absolutely
+necessary since the significant benefits of network transparency and
+serialisability are lost).
+
+UI functionality may be extended via features, much like plugins:
+
+ :::turtle
+ <http://my.pluginui> lv2:requiredFeature <http://my.feature> .
+ <http://my.pluginui> lv2:optionalFeature <http://my.feature> .
+
+The rules for a UI with a required or optional feature are identical to those
+of lv2:Plugin instances: if a UI declares a feature as required, the host is
+NOT allowed to load it unless it supports that feature; and if it does support
+a feature, it MUST pass an appropriate LV2_Feature struct to the UI's
+instantiate() method. This extension defines several standard features for
+common functionality.
+
+UIs written to this specification do not need to be thread-safe. All functions
+may only be called in the <q>UI thread</q>. There is only one UI thread (for
+toolkits, the one the UI main loop runs in). There is no requirement that a
+<q>UI</q> actually be a graphical widget.
+
+Note that UIs are completely separate from plugins. From the plugin's
+perspective, control from a UI is indistinguishable from any other control, as
+it all occcurs via ports.
+
+"""^^lv2:Markdown .
+
+ui:GtkUI
+ lv2:documentation """
+
+The host must guarantee that the Gtk+ 2 library has been initialised and the
+Glib main loop is running before the UI is instantiated. Note that this UI
+type is not suitable for binary distribution since multiple versions of Gtk can
+not be used in the same process.
+
+"""^^lv2:Markdown .
+
+ui:Gtk3UI
+ lv2:documentation """
+
+The host must guarantee that the Gtk+ 3 library has been initialised and the
+Glib main loop is running before the UI is instantiated. Note that this UI
+type is not suitable for binary distribution since multiple versions of Gtk can
+not be used in the same process.
+
+"""^^lv2:Markdown .
+
+ui:Qt4UI
+ lv2:documentation """
+
+The host must guarantee that the Qt4 library has been initialised and the Qt4
+main loop is running before the UI is instantiated. Note that this UI type is
+not suitable for binary distribution since multiple versions of Qt can not be
+used in the same process.
+
+"""^^lv2:Markdown .
+
+ui:Qt5UI
+ lv2:documentation """
+
+The host must guarantee that the Qt5 library has been initialised and the Qt5
+main loop is running before the UI is instantiated. Note that this UI type is
+not suitable for binary distribution since multiple versions of Qt can not be
+used in the same process.
+
+"""^^lv2:Markdown .
+
+ui:X11UI
+ lv2:documentation """
+
+Note that the LV2UI_Widget for this type of UI is not a pointer, but should be
+interpreted directly as an X11 `Window` ID. This is the native UI type on most
+POSIX systems.
+
+"""^^lv2:Markdown .
+
+ui:WindowsUI
+ lv2:documentation """
+
+Note that the LV2UI_Widget for this type of UI is not a pointer, but should be
+interpreted directly as a `HWND`. This is the native UI type on Microsoft
+Windows.
+
+"""^^lv2:Markdown .
+
+ui:CocoaUI
+ lv2:documentation """
+
+This is the native UI type on Mac OS X.
+
+"""^^lv2:Markdown .
+
+ui:binary
+ lv2:documentation """
+
+This property is redundant and deprecated: new UIs should use lv2:binary
+instead, however hosts must still support ui:binary.
+
+"""^^lv2:Markdown .
+
+ui:makeSONameResident
+ lv2:documentation """
+
+This feature was intended to support UIs that link against toolkit libraries
+which may not be unloaded during the lifetime of the host. This is better
+achieved by using the appropriate flags when linking the UI, for example `gcc
+-Wl,-z,nodelete`.
+
+"""^^lv2:Markdown .
+
+ui:noUserResize
+ lv2:documentation """
+
+If a UI has this feature, it indicates that it does not make sense to let the
+user resize the main widget, and the host should prevent that. This feature
+may not make sense for all UI types. The data pointer for this feature should
+always be set to NULL.
+
+"""^^lv2:Markdown .
+
+ui:fixedSize
+ lv2:documentation """
+
+If a UI has this feature, it indicates the same thing as ui:noUserResize, and
+additionally that the UI will not resize itself on its own. That is, the UI
+will always remain the same size. This feature may not make sense for all UI
+types. The data pointer for this feature should always be set to NULL.
+
+"""^^lv2:Markdown .
+
+ui:scaleFactor
+ lv2:documentation """
+
+HiDPI (High Dots Per Inch) displays have a high resolution on a relatively
+small form factor. Many systems use a scale factor to compensate for this, so
+for example, a scale factor of 2 means things are drawn twice as large as
+normal.
+
+Hosts can pass this as an option to UIs to communicate this information, so
+that the UI can draw at an appropriate scale.
+
+"""^^lv2:Markdown .
+
+ui:backgroundColor
+ lv2:documentation """
+
+The background color of the host's UI. The host can pass this as an option so
+that UIs can integrate nicely with the host window around it.
+
+Hosts should pass this as an option to UIs with an integer RGBA32 color value.
+If the value is a 32-bit integer, it is guaranteed to be in RGBA32 format, but
+the UI must check the value type and not assume this, to allow for other types
+of color in the future.
+
+"""^^lv2:Markdown .
+
+ui:foregroundColor
+ lv2:documentation """
+
+The foreground color of the host's UI. The host can pass this as an option so
+that UIs can integrate nicely with the host window around it.
+
+Hosts should pass this as an option to UIs with an integer RGBA32 color value.
+If the value is a 32-bit integer, it is guaranteed to be in RGBA32 format, but
+the UI must check the value type and not assume this, to allow for other types
+of color in the future.
+
+"""^^lv2:Markdown .
+
+ui:parent
+ lv2:documentation """
+
+This feature can be used to pass a parent that the UI should be a child of.
+The format of data pointer of this feature is determined by the UI type, and is
+generally the same type as the LV2UI_Widget that the UI would return. For
+example, for a ui:X11UI, the parent should be a `Window`. This is particularly
+useful for embedding, where the parent often must be known at construction time
+for embedding to work correctly.
+
+UIs should not _require_ this feature unless it is necessary for them to work
+at all, but hosts should provide it whenever possible.
+
+"""^^lv2:Markdown .
+
+ui:PortNotification
+ lv2:documentation """
+
+This describes which ports the host must send notifications to the UI about.
+The port must be specific either by index, using the ui:portIndex property, or
+symbol, using the lv2:symbol property. Since port indices are not guaranteed
+to be stable, using the symbol is recommended, and the inde MUST NOT be used
+except by UIs that are shipped in the same bundle as the corresponding plugin.
+
+"""^^lv2:Markdown .
+
+ui:portNotification
+ lv2:documentation """
+
+Specifies that a UI should receive notifications about changes to a particular
+port's value via LV2UI_Descriptor::port_event().
+
+For example:
+
+ :::turtle
+ eg:ui
+ a ui:X11UI ;
+ ui:portNotification [
+ ui:plugin eg:plugin ;
+ lv2:symbol "gain" ;
+ ui:protocol ui:floatProtocol
+ ] .
+
+"""^^lv2:Markdown .
+
+ui:notifyType
+ lv2:documentation """
+
+Specifies a particular type that the UI should be notified of.
+
+This is useful for message-based ports where several types of data can be
+present, but only some are interesting to the UI. For example, if UI control
+is multiplexed in the same port as MIDI, this property can be used to ensure
+that only the relevant events are forwarded to the UI, and not potentially high
+frequency MIDI data.
+
+"""^^lv2:Markdown .
+
+ui:resize
+ lv2:documentation """
+
+This feature corresponds to the LV2UI_Resize struct, which should be passed
+with the URI LV2_UI__resize. This struct may also be provided by the UI as
+extension data using the same URI, in which case it is used by the host to
+request that the UI change its size.
+
+"""^^lv2:Markdown .
+
+ui:portMap
+ lv2:documentation """
+
+This makes it possible to implement and distribute UIs separately from the
+plugin binaries they control.
+
+This feature corresponds to the LV2UI_Port_Index struct, which should be passed
+with the URI LV2_UI__portIndex.
+
+"""^^lv2:Markdown .
+
+ui:portSubscribe
+ lv2:documentation """
+
+This makes it possible for a UI to explicitly request a particular style of
+update from a port at run-time, in a more flexible and powerful way than
+listing subscriptions statically allows.
+
+This feature corresponds to the LV2UI_Port_Subscribe struct, which should be
+passed with the URI LV2_UI__portSubscribe.
+
+"""^^lv2:Markdown .
+
+ui:touch
+ lv2:documentation """
+
+This is useful for automation, so the host can allow the user to take control
+of a port, even if that port would otherwise be automated (much like grabbing a
+physical motorised fader).
+
+It can also be used for MIDI learn or in any other situation where the host
+needs to do something with a particular control and it would be convenient for
+the user to select it directly from the plugin UI.
+
+This feature corresponds to the LV2UI_Touch struct, which should be passed with
+the URI LV2_UI__touch.
+
+"""^^lv2:Markdown .
+
+ui:requestValue
+ lv2:documentation """
+
+This allows a plugin UI to request a new parameter value using the host's UI,
+for example by showing a dialog or integrating with the host's built-in content
+browser. This should only be used for complex parameter types where the plugin
+UI is not capable of showing the expected native platform or host interface to
+choose a value, such as file path parameters.
+
+This feature corresponds to the LV2UI_Request_Value struct, which should be
+passed with the URI LV2_UI__requestValue.
+
+"""^^lv2:Markdown .
+
+ui:idleInterface
+ lv2:documentation """
+
+To support this feature, the UI should list it as a lv2:optionalFeature or
+lv2:requiredFeature in its data, and also as lv2:extensionData. When the UI's
+extension_data() is called with this URI (LV2_UI__idleInterface), it should
+return a pointer to an LV2UI_Idle_Interface.
+
+To indicate support, the host should pass a feature to instantiate() with this
+URI, with NULL for data.
+
+"""^^lv2:Markdown .
+
+ui:showInterface
+ lv2:documentation """
+
+This allows UIs to gracefully degrade to separate windows when the host is
+unable to embed the UI widget for whatever reason. When the UI's
+extension_data() is called with this URI (LV2_UI__showInterface), it should
+return a pointer to an LV2UI_Show_Interface.
+
+"""^^lv2:Markdown .
+
+ui:PortProtocol
+ lv2:documentation """
+
+A PortProtocol MUST define:
+
+Port Type
+: Which plugin port types the buffer type is valid for.
+
+Feature Data
+: What data (if any) should be passed in the LV2_Feature.
+
+A PortProtocol for an output port MUST define:
+
+Update Frequency
+: When the host should call port_event().
+
+Update Format
+: The format of the data in the buffer passed to port_event().
+
+Options
+: The format of the options passed to subscribe() and unsubscribe().
+
+A PortProtocol for an input port MUST define:
+
+Write Format
+: The format of the data in the buffer passed to write_port().
+
+Write Effect
+: What happens when the UI calls write_port().
+
+For an example, see ui:floatProtocol or ui:peakProtocol.
+
+PortProtocol is a subclass of lv2:Feature, so UIs use lv2:optionalFeature and
+lv2:requiredFeature to specify which PortProtocols they want to use.
+
+"""^^lv2:Markdown .
+
+ui:floatProtocol
+ lv2:documentation """
+
+A protocol for transferring single floating point values. The rules for this
+protocol are:
+
+Port Type
+: lv2:ControlPort
+
+Feature Data
+: None.
+
+Update Frequency
+: The host SHOULD call port_event() as soon as possible when the port value has
+ changed, but there are no timing guarantees.
+
+Update Format
+: A single <code>float</code>.
+
+Options
+: None.
+
+Write Format
+: A single <code>float</code>.
+
+Write Effect
+: The host SHOULD set the port to the received value as soon as possible, but
+ there is no guarantee that run() actually sees this value.
+
+"""^^lv2:Markdown .
+
+ui:peakProtocol
+ lv2:documentation """
+
+This port protocol defines a way for the host to send continuous peak
+measurements of the audio signal at a certain port to the UI. The intended use
+is visualisation, for example an animated meter widget that shows the level of
+the audio input or output.
+
+A contiguous sequence of audio samples for which a peak value has been computed
+is called a _measurement period_.
+
+The rules for this protocol are:
+
+Port Type
+: lv2:AudioPort
+
+Feature Data
+: None.
+
+Update Frequency
+: The host SHOULD call port_event() at regular intervals. The measurement
+ periods used for calls to port_event() for the same port SHOULD be
+ contiguous (i.e. the measurement period for one call should begin right
+ after the end of the measurement period for the previous call ends) unless
+ the UI has removed and re-added the port subscription between those calls.
+ However, UIs MUST NOT depend on either the regularity of the calls or the
+ contiguity of the measurement periods; hosts may change the call rate or
+ skip calls for performance or other reasons. Measurement periods for
+ different calls to port_event() for the same port MUST NOT overlap.
+
+Update Format
+: A single LV2UI_Peak_Data object.
+
+Options
+: None.
+
+Write Format
+: None.
+
+Write Effect
+: None.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/ui/ui.ttl b/lv2/ui/ui.ttl
new file mode 100644
index 0000000..61f8bca
--- /dev/null
+++ b/lv2/ui/ui.ttl
@@ -0,0 +1,248 @@
+@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 ui: <http://lv2plug.in/ns/extensions/ui#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+<http://lv2plug.in/ns/extensions/ui>
+ a owl:Ontology ;
+ rdfs:label "LV2 UI" ;
+ rdfs:comment "User interfaces for LV2 plugins." ;
+ owl:imports <http://lv2plug.in/ns/lv2core> ;
+ rdfs:seeAlso <ui.h> ,
+ <ui.meta.ttl> .
+
+ui:UI
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:label "User Interface" ;
+ rdfs:comment "A UI for an LV2 plugin." .
+
+ui:GtkUI
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf ui:UI ;
+ rdfs:label "GTK2 UI" ;
+ rdfs:comment "A UI where the widget is a pointer to a Gtk+ 2.0 GtkWidget." .
+
+ui:Gtk3UI
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf ui:UI ;
+ rdfs:label "GTK3 UI" ;
+ rdfs:comment "A UI where the widget is a pointer to a Gtk+ 3.0 GtkWidget." .
+
+ui:Qt4UI
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf ui:UI ;
+ rdfs:label "Qt4 UI" ;
+ rdfs:comment "A UI where the widget is a pointer to a Qt4 QWidget." .
+
+ui:Qt5UI
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf ui:UI ;
+ rdfs:label "Qt5 UI" ;
+ rdfs:comment "A UI where the widget is a pointer to a Qt5 QWidget." .
+
+ui:X11UI
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf ui:UI ;
+ rdfs:label "X11 UI" ;
+ rdfs:comment "A UI where the widget is an X11 Window window ID." .
+
+ui:WindowsUI
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf ui:UI ;
+ rdfs:label "Windows UI" ;
+ rdfs:comment "A UI where the widget is a Windows HWND window ID." .
+
+ui:CocoaUI
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf ui:UI ;
+ rdfs:label "Cocoa UI" ;
+ rdfs:comment "A UI where the widget is a pointer to a NSView." .
+
+ui:ui
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain lv2:Plugin ;
+ rdfs:range ui:UI ;
+ rdfs:label "user interface" ;
+ rdfs:comment "Relates a plugin to a UI that applies to it." .
+
+ui:binary
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ owl:sameAs lv2:binary ;
+ owl:deprecated "true"^^xsd:boolean ;
+ rdfs:label "binary" ;
+ rdfs:comment "The shared library that a UI resides in." .
+
+ui:makeSONameResident
+ a lv2:Feature ;
+ owl:deprecated "true"^^xsd:boolean ;
+ rdfs:label "make SO name resident" ;
+ rdfs:comment "UI binary must not be unloaded." .
+
+ui:noUserResize
+ a lv2:Feature ;
+ rdfs:label "no user resize" ;
+ rdfs:comment "Non-resizable UI." .
+
+ui:fixedSize
+ a lv2:Feature ;
+ rdfs:label "fixed size" ;
+ rdfs:comment "Non-resizable UI that will never resize itself." .
+
+ui:scaleFactor
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ opts:Option ;
+ rdfs:range xsd:float ;
+ rdfs:label "scale factor" ;
+ rdfs:comment "Scale factor for high resolution screens." .
+
+ui:backgroundColor
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ opts:Option ;
+ rdfs:label "background color" ;
+ rdfs:comment """The background color of the host's UI.""" .
+
+ui:foregroundColor
+ a rdf:Property ,
+ owl:DatatypeProperty ,
+ opts:Option ;
+ rdfs:label "foreground color" ;
+ rdfs:comment """The foreground color of the host's UI.""" .
+
+ui:parent
+ a lv2:Feature ;
+ rdfs:label "parent" ;
+ rdfs:comment "The parent for a UI." .
+
+ui:PortNotification
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:subClassOf [
+ a owl:Restriction ;
+ owl:onProperty ui:plugin ;
+ owl:cardinality 1 ;
+ rdfs:comment "A PortNotification MUST have exactly one ui:plugin."
+ ] ;
+ rdfs:label "Port Notification" ;
+ rdfs:comment "A description of port updates that a host must send a UI." .
+
+ui:portNotification
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain ui:UI ;
+ rdfs:range ui:PortNotification ;
+ rdfs:label "port notification" ;
+ rdfs:comment "Specifies a port notification that is required by a UI." .
+
+ui:plugin
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain ui:PortNotification ;
+ rdfs:range lv2:Plugin ;
+ rdfs:label "plugin" ;
+ rdfs:comment "The plugin a portNotification applies to." .
+
+ui:portIndex
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:domain ui:PortNotification ;
+ rdfs:range xsd:decimal ;
+ rdfs:label "port index" ;
+ rdfs:comment "The index of the port a portNotification applies to." .
+
+ui:notifyType
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain ui:PortNotification ;
+ rdfs:label "notify type" ;
+ rdfs:comment "A particular type that the UI should be notified of." .
+
+ui:resize
+ a lv2:Feature ,
+ lv2:ExtensionData ;
+ rdfs:label "resize" ;
+ rdfs:comment """A feature that control of, and notifications about, a UI's size.""" .
+
+ui:portMap
+ a lv2:Feature ;
+ rdfs:label "port map" ;
+ rdfs:comment "A feature for accessing the index of a port by symbol." .
+
+ui:portSubscribe
+ a lv2:Feature ;
+ rdfs:label "port subscribe" ;
+ rdfs:comment "A feature for dynamically subscribing to updates from a port." .
+
+ui:touch
+ a lv2:Feature ;
+ rdfs:label "touch" ;
+ rdfs:comment "A feature to notify that the user has grabbed a port control." .
+
+ui:requestValue
+ a lv2:Feature ;
+ rdfs:label "request value" ;
+ rdfs:comment "A feature to request a parameter value from the user via the host." .
+
+ui:idleInterface
+ a lv2:Feature ,
+ lv2:ExtensionData ;
+ rdfs:label "idle interface" ;
+ rdfs:comment "A feature that provides a callback for the host to drive the UI." .
+
+ui:showInterface
+ a lv2:ExtensionData ;
+ rdfs:label "show interface" ;
+ rdfs:comment "An interface for showing and hiding a window for a UI." .
+
+ui:windowTitle
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:range xsd:string ;
+ rdfs:label "window title" ;
+ rdfs:comment "The title for the window shown by LV2UI_Show_Interface." .
+
+ui:updateRate
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:range xsd:float ;
+ rdfs:label "update rate" ;
+ rdfs:comment "The target rate, in Hz, to send updates to the UI." .
+
+ui:protocol
+ a rdf:Property ,
+ owl:ObjectProperty ;
+ rdfs:domain ui:PortNotification ;
+ rdfs:range ui:PortProtocol ;
+ rdfs:label "protocol" ;
+ rdfs:comment "The protocol to be used for this notification." .
+
+ui:PortProtocol
+ a rdfs:Class ;
+ rdfs:subClassOf lv2:Feature ;
+ rdfs:label "Port Protocol" ;
+ rdfs:comment "A method to communicate port data between a UI and plugin." .
+
+ui:floatProtocol
+ a ui:PortProtocol ;
+ rdfs:label "float protocol" ;
+ rdfs:comment "A protocol for transferring single floating point values." .
+
+ui:peakProtocol
+ a ui:PortProtocol ;
+ rdfs:label "peak protocol" ;
+ rdfs:comment "A protocol for sending continuous peak measurements of an audio signal." .
+
diff --git a/lv2/lv2plug.in/ns/extensions/units/manifest.ttl b/lv2/units/manifest.ttl
index d92f4e7..c6c9286 100644
--- a/lv2/lv2plug.in/ns/extensions/units/manifest.ttl
+++ b/lv2/units/manifest.ttl
@@ -1,9 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/extensions/units>
a lv2:Specification ;
lv2:minorVersion 5 ;
- lv2:microVersion 8 ;
+ lv2:microVersion 12 ;
rdfs:seeAlso <units.ttl> .
diff --git a/lv2/units/units.h b/lv2/units/units.h
new file mode 100644
index 0000000..caea38d
--- /dev/null
+++ b/lv2/units/units.h
@@ -0,0 +1,70 @@
+/*
+ Copyright 2012-2016 David Robillard <http://drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+/**
+ @defgroup units Units
+ @ingroup lv2
+
+ Units for LV2 values, see <http://lv2plug.in/ns/extensions/units> for
+ details.
+
+ @{
+*/
+
+#ifndef LV2_UNITS_H
+#define LV2_UNITS_H
+
+#define LV2_UNITS_URI "http://lv2plug.in/ns/extensions/units" ///< http://lv2plug.in/ns/extensions/units
+#define LV2_UNITS_PREFIX LV2_UNITS_URI "#" ///< http://lv2plug.in/ns/extensions/units#
+
+#define LV2_UNITS__Conversion LV2_UNITS_PREFIX "Conversion" ///< http://lv2plug.in/ns/extensions/units#Conversion
+#define LV2_UNITS__Unit LV2_UNITS_PREFIX "Unit" ///< http://lv2plug.in/ns/extensions/units#Unit
+#define LV2_UNITS__bar LV2_UNITS_PREFIX "bar" ///< http://lv2plug.in/ns/extensions/units#bar
+#define LV2_UNITS__beat LV2_UNITS_PREFIX "beat" ///< http://lv2plug.in/ns/extensions/units#beat
+#define LV2_UNITS__bpm LV2_UNITS_PREFIX "bpm" ///< http://lv2plug.in/ns/extensions/units#bpm
+#define LV2_UNITS__cent LV2_UNITS_PREFIX "cent" ///< http://lv2plug.in/ns/extensions/units#cent
+#define LV2_UNITS__cm LV2_UNITS_PREFIX "cm" ///< http://lv2plug.in/ns/extensions/units#cm
+#define LV2_UNITS__coef LV2_UNITS_PREFIX "coef" ///< http://lv2plug.in/ns/extensions/units#coef
+#define LV2_UNITS__conversion LV2_UNITS_PREFIX "conversion" ///< http://lv2plug.in/ns/extensions/units#conversion
+#define LV2_UNITS__db LV2_UNITS_PREFIX "db" ///< http://lv2plug.in/ns/extensions/units#db
+#define LV2_UNITS__degree LV2_UNITS_PREFIX "degree" ///< http://lv2plug.in/ns/extensions/units#degree
+#define LV2_UNITS__frame LV2_UNITS_PREFIX "frame" ///< http://lv2plug.in/ns/extensions/units#frame
+#define LV2_UNITS__hz LV2_UNITS_PREFIX "hz" ///< http://lv2plug.in/ns/extensions/units#hz
+#define LV2_UNITS__inch LV2_UNITS_PREFIX "inch" ///< http://lv2plug.in/ns/extensions/units#inch
+#define LV2_UNITS__khz LV2_UNITS_PREFIX "khz" ///< http://lv2plug.in/ns/extensions/units#khz
+#define LV2_UNITS__km LV2_UNITS_PREFIX "km" ///< http://lv2plug.in/ns/extensions/units#km
+#define LV2_UNITS__m LV2_UNITS_PREFIX "m" ///< http://lv2plug.in/ns/extensions/units#m
+#define LV2_UNITS__mhz LV2_UNITS_PREFIX "mhz" ///< http://lv2plug.in/ns/extensions/units#mhz
+#define LV2_UNITS__midiNote LV2_UNITS_PREFIX "midiNote" ///< http://lv2plug.in/ns/extensions/units#midiNote
+#define LV2_UNITS__mile LV2_UNITS_PREFIX "mile" ///< http://lv2plug.in/ns/extensions/units#mile
+#define LV2_UNITS__min LV2_UNITS_PREFIX "min" ///< http://lv2plug.in/ns/extensions/units#min
+#define LV2_UNITS__mm LV2_UNITS_PREFIX "mm" ///< http://lv2plug.in/ns/extensions/units#mm
+#define LV2_UNITS__ms LV2_UNITS_PREFIX "ms" ///< http://lv2plug.in/ns/extensions/units#ms
+#define LV2_UNITS__name LV2_UNITS_PREFIX "name" ///< http://lv2plug.in/ns/extensions/units#name
+#define LV2_UNITS__oct LV2_UNITS_PREFIX "oct" ///< http://lv2plug.in/ns/extensions/units#oct
+#define LV2_UNITS__pc LV2_UNITS_PREFIX "pc" ///< http://lv2plug.in/ns/extensions/units#pc
+#define LV2_UNITS__prefixConversion LV2_UNITS_PREFIX "prefixConversion" ///< http://lv2plug.in/ns/extensions/units#prefixConversion
+#define LV2_UNITS__render LV2_UNITS_PREFIX "render" ///< http://lv2plug.in/ns/extensions/units#render
+#define LV2_UNITS__s LV2_UNITS_PREFIX "s" ///< http://lv2plug.in/ns/extensions/units#s
+#define LV2_UNITS__semitone12TET LV2_UNITS_PREFIX "semitone12TET" ///< http://lv2plug.in/ns/extensions/units#semitone12TET
+#define LV2_UNITS__symbol LV2_UNITS_PREFIX "symbol" ///< http://lv2plug.in/ns/extensions/units#symbol
+#define LV2_UNITS__unit LV2_UNITS_PREFIX "unit" ///< http://lv2plug.in/ns/extensions/units#unit
+
+#endif /* LV2_UNITS_H */
+
+/**
+ @}
+*/
diff --git a/lv2/lv2plug.in/ns/extensions/units/lv2-units.doap.ttl b/lv2/units/units.meta.ttl
index 3390615..bb40547 100644
--- a/lv2/lv2plug.in/ns/extensions/units/lv2-units.doap.ttl
+++ b/lv2/units/units.meta.ttl
@@ -1,17 +1,42 @@
@prefix dcs: <http://ontologi.es/doap-changeset#> .
@prefix doap: <http://usefulinc.com/ns/doap#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix units: <http://lv2plug.in/ns/extensions/units#> .
<http://lv2plug.in/ns/extensions/units>
a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
doap:name "LV2 Units" ;
doap:shortdesc "Units for LV2 values." ;
doap:created "2007-02-06" ;
doap:homepage <http://lv2plug.in/ns/extensions/units> ;
doap:license <http://opensource.org/licenses/isc> ;
doap:release [
+ doap:revision "5.12" ;
+ doap:created "2019-02-03" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.16.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix outdated port description in documentation."
+ ] , [
+ rdfs:label "Remove overly restrictive domain from units:unit."
+ ]
+ ]
+ ] , [
+ doap:revision "5.10" ;
+ doap:created "2015-04-07" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.12.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix non-existent port type in examples."
+ ] , [
+ rdfs:label "Add lv2:Parameter to domain of units:unit."
+ ]
+ ]
+ ] , [
doap:revision "5.8" ;
doap:created "2012-10-14" ;
doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
@@ -83,4 +108,47 @@
]
] ;
doap:developer <http://plugin.org.uk/swh.xrdf#me> ;
- doap:maintainer <http://drobilla.net/drobilla#me> .
+ doap:maintainer <http://drobilla.net/drobilla#me> ;
+ lv2:documentation """
+
+This is a vocabulary for units typically used for control values in audio
+processing.
+
+For example, to say that a gain control is in decibels:
+
+ :::turtle
+ @prefix units: &lt;http://lv2plug.in/ns/extensions/units#&gt; .
+ @prefix eg: &lt;http://example.org/&gt; .
+
+ eg:plugin lv2:port [
+ a lv2:ControlPort , lv2:InputPort ;
+ lv2:index 0 ;
+ lv2:symbol "gain" ;
+ lv2:name "Gain" ;
+ units:unit units:db
+ ] .
+
+Using the same form, plugins may also specify one-off units inline, to give
+better display hints to hosts:
+
+ :::turtle
+ eg:plugin lv2:port [
+ a lv2:ControlPort , lv2:InputPort ;
+ lv2:index 0 ;
+ lv2:symbol "frob" ;
+ lv2:name "frob level" ;
+ units:unit [
+ a units:Unit ;
+ rdfs:label "frobnication" ;
+ units:symbol "fr" ;
+ units:render "%f f"
+ ]
+ ] .
+
+It is also possible to define conversions between various units, which makes it
+possible for hosts to automatically convert between units where possible. The
+units defined in this extension include conversion definitions where it makes
+sense to do so.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/lv2plug.in/ns/extensions/units/units.ttl b/lv2/units/units.ttl
index e38728b..959c063 100644
--- a/lv2/lv2plug.in/ns/extensions/units/units.ttl
+++ b/lv2/units/units.ttl
@@ -1,84 +1,44 @@
-@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 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 units: <http://lv2plug.in/ns/extensions/units#> .
-@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
<http://lv2plug.in/ns/extensions/units>
a owl:Ontology ;
- owl:imports <http://lv2plug.in/ns/lv2core> ;
+ rdfs:label "LV2 Units" ;
+ rdfs:comment "Units for LV2 values." ;
rdfs:seeAlso <units.h> ,
- <lv2-units.doap.ttl> ;
- lv2:documentation """
-<p>This vocabulary defines a number of units for use in audio processing.</p>
-
-<p>For example, to say that a gain port's value is in decibels (units:db)</p>
-<pre class="turtle-code">
-@prefix units: &lt;http://lv2plug.in/ns/extensions/units#&gt; .
-@prefix eg: &lt;http://example.org/&gt; .
-
-eg:plugin lv2:port [
- a lv2:ControlRateInputPort ;
- lv2:datatype lv2:Float ;
- lv2:index 0 ;
- lv2:symbol "gain" ;
- lv2:name "gain" ;
- units:unit units:db
-] .
-</pre>
-
-<p>Using the same form, plugins may also specify one-off units inline, to give
-better display hints to hosts:</p>
-<pre class="turtle-code">
-eg:plugin lv2:port [
- a lv2:ControlRateInputPort ;
- lv2:datatype lv2:Float ;
- lv2:index 0 ;
- lv2:symbol "frob" ;
- lv2:name "frob level" ;
- units:unit [
- a units:Unit ;
- rdfs:label "frobnication" ;
- units:symbol "fr" ;
- units:render "%f f"
- ]
-] .
-</pre>
-
-<p>It is also possible to define conversions between various units, which makes
-it possible for hosts to automatically and generically convert from a given
-unit to a desired unit. The units defined in this extension include conversion
-definitions where it makes sense to do so.</p>
-""" .
+ <units.meta.ttl> .
units:Unit
a rdfs:Class ,
owl:Class ;
rdfs:label "Unit" ;
- rdfs:comment "A unit for LV2 port data" .
+ rdfs:comment "A unit for a control value." .
units:unit
a rdf:Property ,
owl:ObjectProperty ;
- rdfs:domain lv2:Port ;
rdfs:range units:Unit ;
rdfs:label "unit" ;
- rdfs:comment "Relates a port to the unit of its data" .
+ rdfs:comment "The unit used by the value of a port or parameter." .
units:render
a rdf:Property ,
owl:DatatypeProperty ;
+ rdfs:label "unit format string" ;
rdfs:domain units:Unit ;
rdfs:range xsd:string ;
- rdfs:comment """A printf format string for rendering a value (eg. "%f dB").""" .
+ rdfs:comment """A printf format string for rendering a value (e.g., "%f dB").""" .
units:symbol
a rdf:Property ,
owl:DatatypeProperty ;
+ rdfs:label "unit symbol" ;
rdfs:domain units:Unit ;
rdfs:range xsd:string ;
- rdfs:comment "The abbreviated symbol for the unit (e.g. dB)." .
+ rdfs:comment """The abbreviated symbol for this unit (e.g., "dB").""" .
units:Conversion
a rdfs:Class ,
@@ -107,10 +67,7 @@ units:prefixConversion
rdfs:domain units:Unit ;
rdfs:range units:Conversion ;
rdfs:label "prefix conversion" ;
- rdfs:comment """
-A conversion from this unit to the same unit but with a different SI prefix
-(e.g. Hz to kHz).
-""" .
+ rdfs:comment "A conversion from this unit to another with the same base but a different prefix." .
units:to
a rdf:Property ,
@@ -125,10 +82,7 @@ units:factor
owl:DatatypeProperty ;
rdfs:domain units:Conversion ;
rdfs:label "conversion factor" ;
- rdfs:comment """
-The factor to multiple the source value by in order to convert
-to the target unit.
-""" .
+ rdfs:comment "The factor to multiply the source value by in order to convert to the target unit." .
units:s
a units:Unit ;
@@ -137,6 +91,7 @@ units:s
units:to units:min
] ;
rdfs:label "seconds" ;
+ rdfs:comment "Seconds, the SI base unit for time." ;
units:prefixConversion [
units:factor 1000 ;
units:to units:ms
@@ -147,6 +102,7 @@ units:s
units:ms
a units:Unit ;
rdfs:label "milliseconds" ;
+ rdfs:comment "Milliseconds (thousandths of seconds)." ;
units:prefixConversion [
units:factor 0.001 ;
units:to units:s
@@ -161,24 +117,28 @@ units:min
units:to units:s
] ;
rdfs:label "minutes" ;
+ rdfs:comment "Minutes (60s of seconds and 60ths of an hour)." ;
units:render "%f mins" ;
units:symbol "min" .
units:bar
a units:Unit ;
rdfs:label "bars" ;
+ rdfs:comment "Musical bars or measures." ;
units:render "%f bars" ;
units:symbol "bars" .
units:beat
a units:Unit ;
rdfs:label "beats" ;
+ rdfs:comment "Musical beats." ;
units:render "%f beats" ;
units:symbol "beats" .
units:frame
a units:Unit ;
rdfs:label "audio frames" ;
+ rdfs:comment "Audio frames or samples." ;
units:render "%f frames" ;
units:symbol "frames" .
@@ -189,6 +149,7 @@ units:m
units:to units:inch
] ;
rdfs:label "metres" ;
+ rdfs:comment "Metres, the SI base unit for length." ;
units:prefixConversion [
units:factor 100 ;
units:to units:cm
@@ -209,6 +170,7 @@ units:cm
units:to units:inch
] ;
rdfs:label "centimetres" ;
+ rdfs:comment "Centimetres (hundredths of metres)." ;
units:prefixConversion [
units:factor 0.01 ;
units:to units:m
@@ -229,6 +191,7 @@ units:mm
units:to units:inch
] ;
rdfs:label "millimetres" ;
+ rdfs:comment "Millimetres (thousandths of metres)." ;
units:prefixConversion [
units:factor 0.001 ;
units:to units:m
@@ -249,6 +212,7 @@ units:km
units:to units:mile
] ;
rdfs:label "kilometres" ;
+ rdfs:comment "Kilometres (thousands of metres)." ;
units:prefixConversion [
units:factor 1000 ;
units:to units:m
@@ -265,26 +229,29 @@ units:km
units:inch
a units:Unit ;
units:conversion [
- units:factor 2.54 ;
- units:to units:cm
+ units:factor 0.0254 ;
+ units:to units:m
] ;
rdfs:label "inches" ;
- units:render """%f\"""" ;
+ rdfs:comment "An inch, defined as exactly 0.0254 metres." ;
+ units:render "%f\"" ;
units:symbol "in" .
units:mile
a units:Unit ;
units:conversion [
- units:factor 1.6093 ;
- units:to units:km
+ units:factor 1609.344 ;
+ units:to units:m
] ;
rdfs:label "miles" ;
+ rdfs:comment "A mile, defined as exactly 1609.344 metres." ;
units:render "%f mi" ;
units:symbol "mi" .
units:db
a units:Unit ;
rdfs:label "decibels" ;
+ rdfs:comment "Decibels, a logarithmic relative unit where 0 is unity." ;
units:render "%f dB" ;
units:symbol "dB" .
@@ -295,6 +262,7 @@ units:pc
units:to units:coef
] ;
rdfs:label "percent" ;
+ rdfs:comment "Percentage, a ratio as a fraction of 100." ;
units:render "%f%%" ;
units:symbol "%" .
@@ -305,12 +273,14 @@ units:coef
units:to units:pc
] ;
rdfs:label "coefficient" ;
+ rdfs:comment "A scale coefficient where 1 is unity, or 100 percent." ;
units:render "* %f" ;
units:symbol "" .
units:hz
a units:Unit ;
rdfs:label "hertz" ;
+ rdfs:comment "Hertz, or inverse seconds, the SI derived unit for frequency." ;
units:prefixConversion [
units:factor 0.001 ;
units:to units:khz
@@ -324,6 +294,7 @@ units:hz
units:khz
a units:Unit ;
rdfs:label "kilohertz" ;
+ rdfs:comment "Kilohertz (thousands of Hertz)." ;
units:prefixConversion [
units:factor 1000 ;
units:to units:hz
@@ -337,6 +308,7 @@ units:khz
units:mhz
a units:Unit ;
rdfs:label "megahertz" ;
+ rdfs:comment "Megahertz (millions of Hertz)." ;
units:prefixConversion [
units:factor 1000000 ;
units:to units:hz
@@ -350,6 +322,7 @@ units:mhz
units:bpm
a units:Unit ;
rdfs:label "beats per minute" ;
+ rdfs:comment "Beats Per Minute (BPM), the standard unit for musical tempo." ;
units:prefixConversion [
units:factor 0.0166666666 ;
units:to units:hz
@@ -364,6 +337,7 @@ units:oct
units:to units:semitone12TET
] ;
rdfs:label "octaves" ;
+ rdfs:comment "Octaves, relative musical pitch where +1 octave doubles the frequency." ;
units:render "%f octaves" ;
units:symbol "oct" .
@@ -374,6 +348,7 @@ units:cent
units:to units:semitone12TET
] ;
rdfs:label "cents" ;
+ rdfs:comment "Cents (hundredths of semitones)." ;
units:render "%f ct" ;
units:symbol "ct" .
@@ -384,17 +359,21 @@ units:semitone12TET
units:to units:oct
] ;
rdfs:label "semitones" ;
+ rdfs:comment "A semitone in the 12-tone equal temperament scale." ;
units:render "%f semi" ;
units:symbol "semi" .
units:degree
a units:Unit ;
rdfs:label "degrees" ;
+ rdfs:comment "An angle where 360 degrees is one full rotation." ;
units:render "%f deg" ;
units:symbol "deg" .
units:midiNote
a units:Unit ;
rdfs:label "MIDI note" ;
+ rdfs:comment "A MIDI note number." ;
units:render "MIDI note %d" ;
units:symbol "note" .
+
diff --git a/lv2/lv2plug.in/ns/ext/uri-map/manifest.ttl b/lv2/uri-map/manifest.ttl
index 87087b6..a64e4fb 100644
--- a/lv2/lv2plug.in/ns/ext/uri-map/manifest.ttl
+++ b/lv2/uri-map/manifest.ttl
@@ -1,4 +1,4 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/uri-map>
@@ -6,3 +6,4 @@
lv2:minorVersion 1 ;
lv2:microVersion 6 ;
rdfs:seeAlso <uri-map.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h b/lv2/uri-map/uri-map.h
index d1dc2f7..651c3a8 100644
--- a/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h
+++ b/lv2/uri-map/uri-map.h
@@ -1,5 +1,5 @@
/*
- Copyright 2008-2011 David Robillard <http://drobilla.net>
+ Copyright 2008-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -15,8 +15,10 @@
*/
/**
- @file
- C header for the LV2 URI Map extension <http://lv2plug.in/ns/ext/uri-map>.
+ @defgroup uri-map URI Map
+ @ingroup lv2
+
+ C API for the LV2 URI Map extension <http://lv2plug.in/ns/ext/uri-map>.
This extension defines a simple mechanism for plugins to map URIs to
integers, usually for performance reasons (e.g. processing events typed by
@@ -25,18 +27,30 @@
values for use in the audio thread without doing any string comparison.
This allows the extensibility of RDF with the performance of integers (or
centrally defined enumerations).
+
+ @{
*/
#ifndef LV2_URI_MAP_H
#define LV2_URI_MAP_H
-#define LV2_URI_MAP_URI "http://lv2plug.in/ns/ext/uri-map"
+#define LV2_URI_MAP_URI "http://lv2plug.in/ns/ext/uri-map" ///< http://lv2plug.in/ns/ext/uri-map
+#define LV2_URI_MAP_PREFIX LV2_URI_MAP_URI "#" ///< http://lv2plug.in/ns/ext/uri-map#
+
+#include "lv2/core/attributes.h"
#include <stdint.h>
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+LV2_DISABLE_DEPRECATION_WARNINGS
+
/**
Opaque pointer to host data.
*/
+LV2_DEPRECATED
typedef void* LV2_URI_Map_Callback_Data;
/**
@@ -46,6 +60,7 @@ typedef void* LV2_URI_Map_Callback_Data;
plugin's instantiate method with URI "http://lv2plug.in/ns/ext/uri-map"
and data pointed to an instance of this struct.
*/
+LV2_DEPRECATED
typedef struct {
/**
Opaque pointer to host data.
@@ -87,4 +102,14 @@ typedef struct {
const char* uri);
} LV2_URI_Map_Feature;
+LV2_RESTORE_WARNINGS
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
#endif /* LV2_URI_MAP_H */
+
+/**
+ @}
+*/
diff --git a/lv2/lv2plug.in/ns/ext/uri-map/lv2-uri-map.doap.ttl b/lv2/uri-map/uri-map.meta.ttl
index 504c092..acd1c26 100644
--- a/lv2/lv2plug.in/ns/ext/uri-map/lv2-uri-map.doap.ttl
+++ b/lv2/uri-map/uri-map.meta.ttl
@@ -1,3 +1,4 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix dcs: <http://ontologi.es/doap-changeset#> .
@prefix doap: <http://usefulinc.com/ns/doap#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
@@ -5,7 +6,6 @@
<http://lv2plug.in/ns/ext/uri-map>
a doap:Project ;
- rdfs:seeAlso <../../meta/meta.ttl> ;
doap:maintainer <http://drobilla.net/drobilla#me> ;
doap:created "2008-00-00" ;
doap:developer <http://lv2plug.in/ns/meta#larsl> ,
@@ -27,7 +27,6 @@
doap:revision "1.4" ;
doap:created "2011-11-21" ;
dcs:blame <http://drobilla.net/drobilla#me> ;
- doap:file-release <http://lv2plug.in/spec/lv2-uri-map-1.4.tar.bz2> ;
dcs:changeset [
dcs:item [
rdfs:label "Update packaging."
@@ -39,7 +38,6 @@
doap:revision "1.2" ;
doap:created "2011-05-26" ;
dcs:blame <http://drobilla.net/drobilla#me> ;
- doap:file-release <http://lv2plug.in/spec/lv2-uri-map-1.2.tar.bz2> ;
dcs:changeset [
dcs:item [
rdfs:label "Add build system (for installation)."
@@ -50,11 +48,25 @@
] , [
doap:revision "1.0" ;
doap:created "2010-10-18" ;
- doap:file-release <http://lv2plug.in/spec/lv2-uri-map-1.0.tar.gz> ;
dcs:blame <http://drobilla.net/drobilla#me> ;
dcs:changeset [
dcs:item [
rdfs:label "Initial release."
]
]
- ] .
+ ] ;
+ lv2:documentation """
+
+<span class="warning">This extension is deprecated.</span> New implementations
+should use [LV2 URID](urid.html) instead.
+
+This extension defines a simple mechanism for plugins to map URIs to integers,
+usually for performance reasons (e.g. processing events typed by URIs in real
+time). The expected use case is for plugins to map URIs to integers for things
+they 'understand' at instantiation time, and store those values for use in the
+audio thread without doing any string comparison. This allows the
+extensibility of RDF with the performance of integers (or centrally defined
+enumerations).
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/uri-map/uri-map.ttl b/lv2/uri-map/uri-map.ttl
new file mode 100644
index 0000000..bfb0d0b
--- /dev/null
+++ b/lv2/uri-map/uri-map.ttl
@@ -0,0 +1,14 @@
+@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 umap: <http://lv2plug.in/ns/ext/uri-map#> .
+
+<http://lv2plug.in/ns/ext/uri-map>
+ a lv2:Feature ;
+ owl:deprecated true ;
+ rdfs:label "LV2 URI Map" ;
+ rdfs:comment "A feature for mapping URIs to integers." ;
+ rdfs:seeAlso <uri-map.h> ,
+ <uri-map.meta.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/ext/urid/manifest.ttl b/lv2/urid/manifest.ttl
index 19b5832..772e2b6 100644
--- a/lv2/lv2plug.in/ns/ext/urid/manifest.ttl
+++ b/lv2/urid/manifest.ttl
@@ -1,4 +1,4 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/urid>
@@ -6,3 +6,4 @@
lv2:minorVersion 1 ;
lv2:microVersion 4 ;
rdfs:seeAlso <urid.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/ext/urid/urid.h b/lv2/urid/urid.h
index b4be712..a68bc12 100644
--- a/lv2/lv2plug.in/ns/ext/urid/urid.h
+++ b/lv2/urid/urid.h
@@ -1,5 +1,5 @@
/*
- Copyright 2008-2012 David Robillard <http://drobilla.net>
+ Copyright 2008-2016 David Robillard <http://drobilla.net>
Copyright 2011 Gabriel M. Beddingfield <gabrbedd@gmail.com>
Permission to use, copy, modify, and/or distribute this software for any
@@ -16,25 +16,33 @@
*/
/**
- @file urid.h
- C header for the LV2 URID extension <http://lv2plug.in/ns/ext/urid>
+ @defgroup urid URID
+ @ingroup lv2
+
+ Features for mapping URIs to and from integers, see
+ <http://lv2plug.in/ns/ext/urid> for details.
+
+ @{
*/
#ifndef LV2_URID_H
#define LV2_URID_H
-#define LV2_URID_URI "http://lv2plug.in/ns/ext/urid"
-#define LV2_URID_PREFIX LV2_URID_URI "#"
+#define LV2_URID_URI "http://lv2plug.in/ns/ext/urid" ///< http://lv2plug.in/ns/ext/urid
+#define LV2_URID_PREFIX LV2_URID_URI "#" ///< http://lv2plug.in/ns/ext/urid#
-#define LV2_URID__map LV2_URID_PREFIX "map"
-#define LV2_URID__unmap LV2_URID_PREFIX "unmap"
+#define LV2_URID__map LV2_URID_PREFIX "map" ///< http://lv2plug.in/ns/ext/urid#map
+#define LV2_URID__unmap LV2_URID_PREFIX "unmap" ///< http://lv2plug.in/ns/ext/urid#unmap
-/* Legacy defines */
-#define LV2_URID_MAP_URI LV2_URID__map
-#define LV2_URID_UNMAP_URI LV2_URID__unmap
+#define LV2_URID_MAP_URI LV2_URID__map ///< Legacy
+#define LV2_URID_UNMAP_URI LV2_URID__unmap ///< Legacy
#include <stdint.h>
+#ifdef __cplusplus
+extern "C" {
+#endif
+
/**
Opaque pointer to host data for LV2_URID_Map.
*/
@@ -53,7 +61,7 @@ typedef uint32_t LV2_URID;
/**
URID Map Feature (LV2_URID__map)
*/
-typedef struct _LV2_URID_Map {
+typedef struct {
/**
Opaque pointer to host data.
@@ -90,7 +98,7 @@ typedef struct _LV2_URID_Map {
/**
URI Unmap Feature (LV2_URID__unmap)
*/
-typedef struct _LV2_URID_Unmap {
+typedef struct {
/**
Opaque pointer to host data.
@@ -102,11 +110,11 @@ typedef struct _LV2_URID_Unmap {
/**
Get the URI for a previously mapped numeric ID.
- Returns NULL if @p urid is not yet mapped. Otherwise, the corresponding
+ Returns NULL if `urid` is not yet mapped. Otherwise, the corresponding
URI is returned in a canonical form. This MAY not be the exact same
string that was originally passed to LV2_URID_Map::map(), but it MUST be
an identical URI according to the URI syntax specification (RFC3986). A
- non-NULL return for a given @p urid will always be the same for the life
+ non-NULL return for a given `urid` will always be the same for the life
of the plugin. Plugins that intend to perform string comparison on
unmapped URIs SHOULD first canonicalise URI strings with a call to
map_uri() followed by a call to unmap_uri().
@@ -118,4 +126,12 @@ typedef struct _LV2_URID_Unmap {
LV2_URID urid);
} LV2_URID_Unmap;
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
#endif /* LV2_URID_H */
+
+/**
+ @}
+*/
diff --git a/lv2/urid/urid.meta.ttl b/lv2/urid/urid.meta.ttl
new file mode 100644
index 0000000..b2a74fa
--- /dev/null
+++ b/lv2/urid/urid.meta.ttl
@@ -0,0 +1,84 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix urid: <http://lv2plug.in/ns/ext/urid#> .
+
+<http://lv2plug.in/ns/ext/urid>
+ a doap:Project ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ doap:name "LV2 URID" ;
+ doap:shortdesc "Features for mapping URIs to and from integers." ;
+ doap:created "2011-07-22" ;
+ doap:developer <http://lv2plug.in/ns/meta#gabrbedd> ;
+ doap:maintainer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "1.4" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix typo in urid:unmap documentation."
+ ]
+ ]
+ ] , [
+ doap:revision "1.2" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add feature struct names."
+ ] , [
+ rdfs:label "Merge with unified LV2 package."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2011-11-21" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-urid-1.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+This extension defines a simple mechanism for plugins to map URIs to and from
+integers. This is usually used for performance reasons, for example for
+processing events with URI types in real-time audio code). Typically, plugins
+map URIs to integers for things they "understand" at instantiation time, and
+store those values for use in the audio thread without doing any string
+comparison. This allows for the extensibility of RDF but with the performance
+of integers.
+
+This extension is intended as an improved and simplified replacement for the
+[uri-map](uri-map.html) extension, since the `map` context parameter there has
+proven problematic. This extension is functionally equivalent to the uri-map
+extension with a NULL context. New implementations are encouraged to use this
+extension for URI mapping.
+
+"""^^lv2:Markdown .
+
+urid:map
+ lv2:documentation """
+
+To support this feature, the host must pass an LV2_Feature to
+LV2_Descriptor::instantiate() with URI LV2_URID__map and data pointed to an
+instance of LV2_URID_Map.
+
+"""^^lv2:Markdown .
+
+urid:unmap
+ lv2:documentation """
+
+To support this feature, the host must pass an LV2_Feature to
+LV2_Descriptor::instantiate() with URI LV2_URID__unmap and data pointed to an
+instance of LV2_URID_Unmap.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/urid/urid.ttl b/lv2/urid/urid.ttl
new file mode 100644
index 0000000..2c44b56
--- /dev/null
+++ b/lv2/urid/urid.ttl
@@ -0,0 +1,22 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix urid: <http://lv2plug.in/ns/ext/urid#> .
+
+<http://lv2plug.in/ns/ext/urid>
+ a owl:Ontology ;
+ rdfs:label "LV2 URID" ;
+ rdfs:comment "Features for mapping URIs to and from integers." ;
+ rdfs:seeAlso <urid.h> ,
+ <urid.meta.ttl> .
+
+urid:map
+ a lv2:Feature ;
+ rdfs:label "map" ;
+ rdfs:comment "A feature to map URI strings to integer URIDs." .
+
+urid:unmap
+ a lv2:Feature ;
+ rdfs:label "unmap" ;
+ rdfs:comment "A feature to unmap URIDs back to strings." .
+
diff --git a/lv2/lv2plug.in/ns/ext/worker/manifest.ttl b/lv2/worker/manifest.ttl
index 02cf27f..692720d 100644
--- a/lv2/lv2plug.in/ns/ext/worker/manifest.ttl
+++ b/lv2/worker/manifest.ttl
@@ -1,8 +1,9 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/worker>
a lv2:Specification ;
lv2:minorVersion 1 ;
- lv2:microVersion 0 ;
+ lv2:microVersion 2 ;
rdfs:seeAlso <worker.ttl> .
+
diff --git a/lv2/lv2plug.in/ns/ext/worker/worker.h b/lv2/worker/worker.h
index 74ac45b..69cc1d3 100644
--- a/lv2/lv2plug.in/ns/ext/worker/worker.h
+++ b/lv2/worker/worker.h
@@ -1,5 +1,5 @@
/*
- Copyright 2012 David Robillard <http://drobilla.net>
+ Copyright 2012-2016 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -15,25 +15,34 @@
*/
/**
- @file worker.h C header for the LV2 Worker extension
- <http://lv2plug.in/ns/ext/worker>.
+ @defgroup worker Worker
+ @ingroup lv2
+
+ Support for non-realtime plugin operations, see
+ <http://lv2plug.in/ns/ext/worker> for details.
+
+ @{
*/
#ifndef LV2_WORKER_H
#define LV2_WORKER_H
+#include "lv2/core/lv2.h"
+
#include <stdint.h>
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
+#define LV2_WORKER_URI "http://lv2plug.in/ns/ext/worker" ///< http://lv2plug.in/ns/ext/worker
+#define LV2_WORKER_PREFIX LV2_WORKER_URI "#" ///< http://lv2plug.in/ns/ext/worker#
-#define LV2_WORKER_URI "http://lv2plug.in/ns/ext/worker"
-#define LV2_WORKER_PREFIX LV2_WORKER_URI "#"
+#define LV2_WORKER__interface LV2_WORKER_PREFIX "interface" ///< http://lv2plug.in/ns/ext/worker#interface
+#define LV2_WORKER__schedule LV2_WORKER_PREFIX "schedule" ///< http://lv2plug.in/ns/ext/worker#schedule
-#define LV2_WORKER__interface LV2_WORKER_PREFIX "interface"
-#define LV2_WORKER__schedule LV2_WORKER_PREFIX "schedule"
+#ifdef __cplusplus
+extern "C" {
+#endif
/**
- A status code for worker functions.
+ Status code for worker functions.
*/
typedef enum {
LV2_WORKER_SUCCESS = 0, /**< Completed successfully. */
@@ -41,12 +50,13 @@ typedef enum {
LV2_WORKER_ERR_NO_SPACE = 2 /**< Failed due to lack of space. */
} LV2_Worker_Status;
+/** Opaque handle for LV2_Worker_Interface::work(). */
typedef void* LV2_Worker_Respond_Handle;
/**
A function to respond to run() from the worker method.
- The @p data MUST be safe for the host to copy and later pass to
+ The `data` MUST be safe for the host to copy and later pass to
work_response(), and the host MUST guarantee that it will be eventually
passed to work_response() if this function returns LV2_WORKER_SUCCESS.
*/
@@ -56,25 +66,28 @@ typedef LV2_Worker_Status (*LV2_Worker_Respond_Function)(
const void* data);
/**
- LV2 Plugin Worker Interface.
+ Plugin Worker Interface.
This is the interface provided by the plugin to implement a worker method.
The plugin's extension_data() method should return an LV2_Worker_Interface
when called with LV2_WORKER__interface as its argument.
*/
-typedef struct _LV2_Worker_Interface {
+typedef struct {
/**
The worker method. This is called by the host in a non-realtime context
as requested, possibly with an arbitrary message to handle.
- A response can be sent to run() using @p respond. The plugin MUST NOT
- make any assumptions about which thread calls this method, other than
- the fact that there are no real-time requirements.
+ A response can be sent to run() using `respond`. The plugin MUST NOT
+ make any assumptions about which thread calls this method, except that
+ there are no real-time requirements and only one call may be executed at
+ a time. That is, the host MAY call this method from any non-real-time
+ thread, but MUST NOT make concurrent calls to this method from several
+ threads.
@param instance The LV2 instance this is a method on.
@param respond A function for sending a response to run().
- @param handle Must be passed to @p respond if it is called.
- @param size The size of @p data.
+ @param handle Must be passed to `respond` if it is called.
+ @param size The size of `data`.
@param data Data from run(), or NULL.
*/
LV2_Worker_Status (*work)(LV2_Handle instance,
@@ -88,7 +101,7 @@ typedef struct _LV2_Worker_Interface {
run() context when a response from the worker is ready.
@param instance The LV2 instance this is a method on.
- @param size The size of @p body.
+ @param size The size of `body`.
@param body Message body, or NULL.
*/
LV2_Worker_Status (*work_response)(LV2_Handle instance,
@@ -108,9 +121,16 @@ typedef struct _LV2_Worker_Interface {
LV2_Worker_Status (*end_run)(LV2_Handle instance);
} LV2_Worker_Interface;
+/** Opaque handle for LV2_Worker_Schedule. */
typedef void* LV2_Worker_Schedule_Handle;
-typedef struct _LV2_Worker_Schedule {
+/**
+ Schedule Worker Host Feature.
+
+ The host passes this feature to provide a schedule_work() function, which
+ the plugin can use to schedule a worker call from run().
+*/
+typedef struct {
/**
Opaque host data.
*/
@@ -125,21 +145,21 @@ typedef struct _LV2_Worker_Schedule {
This function is always safe to call from run(), but it is not
guaranteed that the worker is actually called from a different thread.
- In particular, when free-wheeling (e.g. for offline rendering), the
- worker may be executed immediately. This allows single-threaded
- processing with sample accuracy and avoids timing problems when run() is
- executing much faster or slower than real-time.
+ In particular, when free-wheeling (for example, during offline
+ rendering), the worker may be executed immediately. This allows
+ single-threaded processing with sample accuracy and avoids timing
+ problems when run() is executing much faster or slower than real-time.
Plugins SHOULD be written in such a way that if the worker runs
immediately, and responses from the worker are delivered immediately,
the effect of the work takes place immediately with sample accuracy.
- The @p data MUST be safe for the host to copy and later pass to work(),
+ The `data` MUST be safe for the host to copy and later pass to work(),
and the host MUST guarantee that it will be eventually passed to work()
if this function returns LV2_WORKER_SUCCESS.
@param handle The handle field of this struct.
- @param size The size of @p data.
+ @param size The size of `data`.
@param data Message to pass to work(), or NULL.
*/
LV2_Worker_Status (*schedule_work)(LV2_Worker_Schedule_Handle handle,
@@ -147,4 +167,12 @@ typedef struct _LV2_Worker_Schedule {
const void* data);
} LV2_Worker_Schedule;
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
#endif /* LV2_WORKER_H */
+
+/**
+ @}
+*/
diff --git a/lv2/worker/worker.meta.ttl b/lv2/worker/worker.meta.ttl
new file mode 100644
index 0000000..f696d61
--- /dev/null
+++ b/lv2/worker/worker.meta.ttl
@@ -0,0 +1,82 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix work: <http://lv2plug.in/ns/ext/worker#> .
+
+<http://lv2plug.in/ns/ext/worker>
+ a doap:Project ;
+ doap:name "LV2 Worker" ;
+ doap:shortdesc "Support for doing non-realtime work in plugins." ;
+ doap:created "2012-03-22" ;
+ doap:developer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "1.2" ;
+ doap:created "2020-04-26" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.18.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Improve documentation."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+This extension allows plugins to schedule work that must be performed in
+another thread. Plugins can use this interface to safely perform work that is
+not real-time safe, and receive the result in the run context. The details of
+threading are managed by the host, allowing plugins to be simple and portable
+while using resources more efficiently.
+
+This interface is designed to gracefully support single-threaded synchronous
+execution, which allows the same code to work with sample accuracy for offline
+rendering. For example, a sampler plugin may schedule a sample to be loaded
+from disk in another thread. During live execution, the host will call the
+plugin's work method from another thread, and deliver the result to the audio
+thread when it is finished. However, during offline export, the
+<q>scheduled</q> load would be executed immediately in the same thread. This
+enables reproducible offline rendering, where any changes affect the output
+immediately regardless of how long the work takes to execute.
+
+"""^^lv2:Markdown .
+
+work:interface
+ lv2:documentation """
+
+The work interface provided by a plugin, LV2_Worker_Interface.
+
+ :::turtle
+
+ @prefix work: &lt;http://lv2plug.in/ns/ext/worker#&gt; .
+
+ &lt;plugin&gt;
+ a lv2:Plugin ;
+ lv2:extensionData work:interface .
+
+"""^^lv2:Markdown .
+
+work:schedule
+ lv2:documentation """
+
+The work scheduling feature provided by a host, LV2_Worker_Schedule.
+
+If the host passes this feature to LV2_Descriptor::instantiate, the plugin MAY
+use it to schedule work in the audio thread, and MUST NOT call it in any other
+context. Hosts MAY pass this feature to other functions as well, in which case
+the plugin MAY use it to schedule work in the calling context. The plugin MUST
+NOT assume any relationship between different schedule features.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/worker/worker.ttl b/lv2/worker/worker.ttl
new file mode 100644
index 0000000..cb8a81a
--- /dev/null
+++ b/lv2/worker/worker.ttl
@@ -0,0 +1,25 @@
+@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 work: <http://lv2plug.in/ns/ext/worker#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+<http://lv2plug.in/ns/ext/worker>
+ a owl:Ontology ;
+ rdfs:label "LV2 Worker" ;
+ rdfs:comment "Support for doing non-realtime work in plugins." ;
+ owl:imports <http://lv2plug.in/ns/lv2core> ;
+ rdfs:seeAlso <worker.h> ,
+ <worker.meta.ttl> .
+
+work:interface
+ a lv2:ExtensionData ;
+ rdfs:label "work interface" ;
+ rdfs:comment "The work interface provided by a plugin." .
+
+work:schedule
+ a lv2:Feature ;
+ rdfs:label "work schedule" ;
+ rdfs:comment "The work scheduling feature provided by a host." .
+
diff --git a/lv2specgen/DTD/xhtml-datatypes-1.mod.1 b/lv2specgen/DTD/xhtml-datatypes-1.mod.1
new file mode 100644
index 0000000..dde43e8
--- /dev/null
+++ b/lv2specgen/DTD/xhtml-datatypes-1.mod.1
@@ -0,0 +1,103 @@
+<!-- ...................................................................... -->
+<!-- XHTML Datatypes Module .............................................. -->
+<!-- file: xhtml-datatypes-1.mod
+
+ This is XHTML, a reformulation of HTML as a modular XML application.
+ Copyright 1998-2005 W3C (MIT, ERCIM, Keio), All Rights Reserved.
+ Revision: $Id: xhtml-datatypes-1.mod,v 4.1 2001/04/06 19:23:32 altheim Exp $ SMI
+
+ This DTD module is identified by the PUBLIC and SYSTEM identifiers:
+
+ PUBLIC "-//W3C//ENTITIES XHTML Datatypes 1.0//EN"
+ SYSTEM "http://www.w3.org/MarkUp/DTD/xhtml-datatypes-1.mod"
+
+ Revisions:
+ (none)
+ ....................................................................... -->
+
+<!-- Datatypes
+
+ defines containers for the following datatypes, many of
+ these imported from other specifications and standards.
+-->
+
+<!-- Length defined for cellpadding/cellspacing -->
+
+<!-- nn for pixels or nn% for percentage length -->
+<!ENTITY % Length.datatype "CDATA" >
+
+<!-- space-separated list of link types -->
+<!ENTITY % LinkTypes.datatype "NMTOKENS" >
+
+<!-- single or comma-separated list of media descriptors -->
+<!ENTITY % MediaDesc.datatype "CDATA" >
+
+<!-- pixel, percentage, or relative -->
+<!ENTITY % MultiLength.datatype "CDATA" >
+
+<!-- one or more digits (NUMBER) -->
+<!ENTITY % Number.datatype "CDATA" >
+
+<!-- integer representing length in pixels -->
+<!ENTITY % Pixels.datatype "CDATA" >
+
+<!-- script expression -->
+<!ENTITY % Script.datatype "CDATA" >
+
+<!-- textual content -->
+<!ENTITY % Text.datatype "CDATA" >
+
+<!-- Placeholder Compact URI-related types -->
+<!ENTITY % CURIE.datatype "CDATA" >
+<!ENTITY % CURIEs.datatype "CDATA" >
+<!ENTITY % SafeCURIE.datatype "CDATA" >
+<!ENTITY % SafeCURIEs.datatype "CDATA" >
+<!ENTITY % URIorSafeCURIE.datatype "CDATA" >
+<!ENTITY % URIorSafeCURIEs.datatype "CDATA" >
+
+<!-- Imported Datatypes ................................ -->
+
+<!-- a single character from [ISO10646] -->
+<!ENTITY % Character.datatype "CDATA" >
+
+<!-- a character encoding, as per [RFC2045] -->
+<!ENTITY % Charset.datatype "CDATA" >
+
+<!-- a space separated list of character encodings, as per [RFC2045] -->
+<!ENTITY % Charsets.datatype "CDATA" >
+
+<!-- Color specification using color name or sRGB (#RRGGBB) values -->
+<!ENTITY % Color.datatype "CDATA" >
+
+<!-- media type, as per [RFC2045] -->
+<!ENTITY % ContentType.datatype "CDATA" >
+
+<!-- comma-separated list of media types, as per [RFC2045] -->
+<!ENTITY % ContentTypes.datatype "CDATA" >
+
+<!-- date and time information. ISO date format -->
+<!ENTITY % Datetime.datatype "CDATA" >
+
+<!-- formal public identifier, as per [ISO8879] -->
+<!ENTITY % FPI.datatype "CDATA" >
+
+<!-- a language code, as per [RFC3066] or its successor -->
+<!ENTITY % LanguageCode.datatype "CDATA" >
+
+<!-- a comma separated list of language code ranges -->
+<!ENTITY % LanguageCodes.datatype "CDATA" >
+
+<!-- a qualified name , as per [XMLNS] or its successor -->
+<!ENTITY % QName.datatype "CDATA" >
+<!ENTITY % QNames.datatype "CDATA" >
+
+<!-- a Uniform Resource Identifier, see [URI] -->
+<!ENTITY % URI.datatype "CDATA" >
+
+<!-- a space-separated list of Uniform Resource Identifiers, see [URI] -->
+<!ENTITY % URIs.datatype "CDATA" >
+
+<!-- a relative URI reference consisting of an initial '#' and a fragment ID -->
+<!ENTITY % URIREF.datatype "CDATA" >
+
+<!-- end of xhtml-datatypes-1.mod -->
diff --git a/lv2specgen/DTD/xhtml-metaAttributes-1.mod b/lv2specgen/DTD/xhtml-metaAttributes-1.mod
new file mode 100644
index 0000000..b434e39
--- /dev/null
+++ b/lv2specgen/DTD/xhtml-metaAttributes-1.mod
@@ -0,0 +1,154 @@
+<!-- ...................................................................... -->
+<!-- XHTML MetaAttributes Module ......................................... -->
+<!-- file: xhtml-metaAttributes-1.mod
+
+ This is XHTML-RDFa, modules to annotate XHTML family documents.
+ Copyright 2007-2008 W3C (MIT, ERCIM, Keio), All Rights Reserved.
+ Revision: $Id: xhtml-metaAttributes-1.mod,v 1.6 2008/08/01 20:01:00 smccarro Exp $
+
+ This DTD module is identified by the PUBLIC and SYSTEM identifiers:
+
+ PUBLIC "-//W3C//ENTITIES XHTML MetaAttributes 1.0//EN"
+ SYSTEM "http://www.w3.org/MarkUp/DTD/xhtml-metaAttributes-1.mod"
+
+ Revisions:
+ (none)
+ ....................................................................... -->
+
+<!ENTITY % XHTML.global.attrs.prefixed "IGNORE" >
+
+<!-- Placeholder Compact URI-related types -->
+<!ENTITY % CURIE.datatype "CDATA" >
+<!ENTITY % CURIEs.datatype "CDATA" >
+<!ENTITY % SafeCURIE.datatype "CDATA" >
+<!ENTITY % SafeCURIEs.datatype "CDATA" >
+<!ENTITY % URIorSafeCURIE.datatype "CDATA" >
+<!ENTITY % URIorSafeCURIEs.datatype "CDATA" >
+
+<!-- Common Attributes
+
+ This module declares a collection of meta-information related
+ attributes.
+
+ %NS.decl.attrib; is declared in the XHTML Qname module.
+
+ This file also includes declarations of "global" versions of the
+ attributes. The global versions of the attributes are for use on
+ elements in other namespaces.
+-->
+
+<!ENTITY % about.attrib
+ "about %URIorSafeCURIE.datatype; #IMPLIED"
+>
+
+<![%XHTML.global.attrs.prefixed;[
+<!ENTITY % XHTML.global.about.attrib
+ "%XHTML.prefix;:about %URIorSafeCURIE.datatype; #IMPLIED"
+>
+]]>
+
+<!ENTITY % typeof.attrib
+ "typeof %CURIEs.datatype; #IMPLIED"
+>
+
+<![%XHTML.global.attrs.prefixed;[
+<!ENTITY % XHTML.global.typeof.attrib
+ "%XHTML.prefix;:typeof %CURIEs.datatype; #IMPLIED"
+>
+]]>
+
+<!ENTITY % property.attrib
+ "property %CURIEs.datatype; #IMPLIED"
+>
+
+<![%XHTML.global.attrs.prefixed;[
+<!ENTITY % XHTML.global.property.attrib
+ "%XHTML.prefix;:property %CURIEs.datatype; #IMPLIED"
+>
+]]>
+
+<!ENTITY % resource.attrib
+ "resource %URIorSafeCURIE.datatype; #IMPLIED"
+>
+
+<![%XHTML.global.attrs.prefixed;[
+<!ENTITY % XHTML.global.resource.attrib
+ "%XHTML.prefix;:resource %URIorSafeCURIE.datatype; #IMPLIED"
+>
+]]>
+
+<!ENTITY % content.attrib
+ "content CDATA #IMPLIED"
+>
+
+<![%XHTML.global.attrs.prefixed;[
+<!ENTITY % XHTML.global.content.attrib
+ "%XHTML.prefix;:content CDATA #IMPLIED"
+>
+]]>
+
+<!ENTITY % datatype.attrib
+ "datatype %CURIE.datatype; #IMPLIED"
+>
+
+<![%XHTML.global.attrs.prefixed;[
+<!ENTITY % XHTML.global.datatype.attrib
+ "%XHTML.prefix;:datatype %CURIE.datatype; #IMPLIED"
+>
+]]>
+
+<!ENTITY % rel.attrib
+ "rel %CURIEs.datatype; #IMPLIED"
+>
+
+<![%XHTML.global.attrs.prefixed;[
+<!ENTITY % XHTML.global.rel.attrib
+ "%XHTML.prefix;:rel %CURIEs.datatype; #IMPLIED"
+>
+]]>
+
+<!ENTITY % rev.attrib
+ "rev %CURIEs.datatype; #IMPLIED"
+>
+
+<![%XHTML.global.attrs.prefixed;[
+<!ENTITY % XHTML.global.rev.attrib
+ "%XHTML.prefix;:rev %CURIEs.datatype; #IMPLIED"
+>
+]]>
+
+<!ENTITY % Metainformation.extra.attrib "" >
+
+<!ENTITY % Metainformation.attrib
+ "%about.attrib;
+ %content.attrib;
+ %datatype.attrib;
+ %typeof.attrib;
+ %property.attrib;
+ %rel.attrib;
+ %resource.attrib;
+ %rev.attrib;
+ %Metainformation.extra.attrib;"
+>
+
+<!ENTITY % XHTML.global.metainformation.extra.attrib "" >
+
+<![%XHTML.global.attrs.prefixed;[
+
+<!ENTITY % XHTML.global.metainformation.attrib
+ "%XHTML.global.about.attrib;
+ %XHTML.global.content.attrib;
+ %XHTML.global.datatype.attrib;
+ %XHTML.global.typeof.attrib;
+ %XHTML.global.property.attrib;
+ %XHTML.global.rel.attrib;
+ %XHTML.global.resource.attrib;
+ %XHTML.global.rev.attrib;
+ %XHTML.global.metainformation.extra.attrib;"
+>
+]]>
+
+<!ENTITY % XHTML.global.metainformation.attrib "" >
+
+
+<!-- end of xhtml-metaAttributes-1.mod -->
diff --git a/lv2specgen/DTD/xhtml-rdfa-1.dtd b/lv2specgen/DTD/xhtml-rdfa-1.dtd
new file mode 100644
index 0000000..26ed117
--- /dev/null
+++ b/lv2specgen/DTD/xhtml-rdfa-1.dtd
@@ -0,0 +1,472 @@
+<!-- ....................................................................... -->
+<!-- XHTML 1.1 + RDFa DTD ................................................. -->
+<!-- file: xhtml-rdfa-1.dtd
+-->
+
+<!-- XHTML 1.1 + RDFa DTD
+
+ This is an example markup language combining XHTML 1.1 and the RDFa
+ modules.
+
+ XHTML+RDFa
+ Copyright 1998-2008 World Wide Web Consortium
+ (Massachusetts Institute of Technology, European Research Consortium
+ for Informatics and Mathematics, Keio University).
+ All Rights Reserved.
+
+ Permission to use, copy, modify and distribute the XHTML DTD and its
+ accompanying documentation for any purpose and without fee is hereby
+ granted in perpetuity, provided that the above copyright notice and
+ this paragraph appear in all copies. The copyright holders make no
+ representation about the suitability of the DTD for any purpose.
+
+ It is provided "as is" without expressed or implied warranty.
+
+-->
+<!-- This is the driver file for version 1 of the XHTML + RDFa DTD.
+
+ Please use this public identifier to identify it:
+
+ "-//W3C//DTD XHTML+RDFa 1.0//EN"
+-->
+<!ENTITY % XHTML.version "XHTML+RDFa 1.0" >
+
+<!-- Use this URI to identify the default namespace:
+
+ "http://www.w3.org/1999/xhtml"
+
+ See the Qualified Names module for information
+ on the use of namespace prefixes in the DTD.
+
+ Note that XHTML namespace elements are not prefixed by default,
+ but the XHTML namespace prefix is defined as "xhtml" so that
+ other markup languages can extend this one and use the XHTML
+ prefixed global attributes if required.
+
+-->
+<!ENTITY % NS.prefixed "IGNORE" >
+<!ENTITY % XHTML.prefix "xhtml" >
+
+<!-- Be sure to include prefixed global attributes - we don't need
+ them, but languages that extend XHTML 1.1 might.
+-->
+<!ENTITY % XHTML.global.attrs.prefixed "INCLUDE" >
+
+<!-- Reserved for use with the XLink namespace:
+-->
+<!ENTITY % XLINK.xmlns "" >
+<!ENTITY % XLINK.xmlns.attrib "" >
+
+<!-- For example, if you are using XHTML 1.1 directly, use the public
+ identifier in the DOCTYPE declaration, with the namespace declaration
+ on the document element to identify the default namespace:
+
+ <?xml version="1.0"?>
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN"
+ "xhtml-rdfa-1.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml"
+ xml:lang="en">
+ ...
+ </html>
+
+ Revisions:
+ (none)
+-->
+
+<!-- reserved for future use with document profiles -->
+<!ENTITY % XHTML.profile "" >
+
+<!-- ensure XHTML Notations are disabled -->
+<!ENTITY % xhtml-notations.module "IGNORE" >
+
+<!-- Bidirectional Text features
+ This feature-test entity is used to declare elements
+ and attributes used for bidirectional text support.
+-->
+<!ENTITY % XHTML.bidi "INCLUDE" >
+
+<!-- ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
+
+<!-- Pre-Framework Redeclaration placeholder .................... -->
+<!-- this serves as a location to insert markup declarations
+ into the DTD prior to the framework declarations.
+-->
+<!ENTITY % xhtml-prefw-redecl.module "IGNORE" >
+<!ENTITY % xhtml-prefw-redecl.mod "" >
+<![%xhtml-prefw-redecl.module;[
+%xhtml-prefw-redecl.mod;
+<!-- end of xhtml-prefw-redecl.module -->]]>
+
+<!-- we need the datatypes now -->
+<!ENTITY % xhtml-datatypes.module "INCLUDE" >
+<![%xhtml-datatypes.module;[
+<!ENTITY % xhtml-datatypes.mod
+ PUBLIC "-//W3C//ENTITIES XHTML Datatypes 1.0//EN"
+ "xhtml-datatypes-1.mod" >
+%xhtml-datatypes.mod;]]>
+
+<!-- bring in the RDFa attributes cause we need them in Common -->
+<!ENTITY % xhtml-metaAttributes.module "INCLUDE" >
+<![%xhtml-metaAttributes.module;[
+<!ENTITY % xhtml-metaAttributes.mod
+ PUBLIC "-//W3C//ENTITIES XHTML MetaAttributes 1.0//EN"
+ "xhtml-metaAttributes-1.mod" >
+%xhtml-metaAttributes.mod;]]>
+
+<!ENTITY % xhtml-events.module "INCLUDE" >
+
+<!ENTITY % Common.extra.attrib
+ "href %URI.datatype; #IMPLIED
+ %Metainformation.attrib;"
+>
+<!-- adding the lang attribute into the I18N collection -->
+
+<!ENTITY % lang.attrib
+ "xml:lang %LanguageCode.datatype; #IMPLIED
+ lang %LanguageCode.datatype; #IMPLIED"
+>
+
+<!-- Inline Style Module ........................................ -->
+<!ENTITY % xhtml-inlstyle.module "INCLUDE" >
+<![%xhtml-inlstyle.module;[
+<!ENTITY % xhtml-inlstyle.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Inline Style 1.0//EN"
+ "xhtml-inlstyle-1.mod" >
+%xhtml-inlstyle.mod;]]>
+
+<!-- declare Document Model module instantiated in framework
+-->
+<!ENTITY % xhtml-model.mod
+ PUBLIC "-//W3C//ENTITIES XHTML+RDFa Document Model 1.0//EN"
+ "xhtml-rdfa-model-1.mod" >
+
+<!-- Modular Framework Module (required) ......................... -->
+<!ENTITY % xhtml-framework.module "INCLUDE" >
+<![%xhtml-framework.module;[
+<!ENTITY % xhtml-framework.mod
+ PUBLIC "-//W3C//ENTITIES XHTML Modular Framework 1.0//EN"
+ "xhtml-framework-1.mod" >
+%xhtml-framework.mod;]]>
+
+<!-- Post-Framework Redeclaration placeholder ................... -->
+<!-- this serves as a location to insert markup declarations
+ into the DTD following the framework declarations.
+-->
+<!ENTITY % xhtml-postfw-redecl.module "IGNORE" >
+<!ENTITY % xhtml-postfw-redecl.mod "">
+<![%xhtml-postfw-redecl.module;[
+%xhtml-postfw-redecl.mod;
+<!-- end of xhtml-postfw-redecl.module -->]]>
+
+
+
+<!-- Text Module (Required) ..................................... -->
+<!ENTITY % xhtml-text.module "INCLUDE" >
+<![%xhtml-text.module;[
+<!ENTITY % xhtml-text.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Text 1.0//EN"
+ "xhtml-text-1.mod" >
+%xhtml-text.mod;]]>
+
+<!-- Hypertext Module (required) ................................. -->
+<!ENTITY % a.attlist "IGNORE" >
+<!ENTITY % xhtml-hypertext.module "INCLUDE" >
+<![%xhtml-hypertext.module;[
+<!ENTITY % xhtml-hypertext.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Hypertext 1.0//EN"
+ "xhtml-hypertext-1.mod" >
+%xhtml-hypertext.mod;]]>
+<!ATTLIST %a.qname;
+ %Common.attrib;
+ charset %Charset.datatype; #IMPLIED
+ type %ContentType.datatype; #IMPLIED
+ hreflang %LanguageCode.datatype; #IMPLIED
+ accesskey %Character.datatype; #IMPLIED
+ tabindex %Number.datatype; #IMPLIED
+>
+
+<!-- Lists Module (required) .................................... -->
+<!ENTITY % xhtml-list.module "INCLUDE" >
+<![%xhtml-list.module;[
+<!ENTITY % xhtml-list.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Lists 1.0//EN"
+ "xhtml-list-1.mod" >
+%xhtml-list.mod;]]>
+
+<!-- ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
+
+<!-- Edit Module ................................................ -->
+<!ENTITY % xhtml-edit.module "INCLUDE" >
+<![%xhtml-edit.module;[
+<!ENTITY % xhtml-edit.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Editing Elements 1.0//EN"
+ "xhtml-edit-1.mod" >
+%xhtml-edit.mod;]]>
+
+<!-- BIDI Override Module ....................................... -->
+<!ENTITY % xhtml-bdo.module "%XHTML.bidi;" >
+<![%xhtml-bdo.module;[
+<!ENTITY % xhtml-bdo.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML BIDI Override Element 1.0//EN"
+ "xhtml-bdo-1.mod" >
+%xhtml-bdo.mod;]]>
+
+<!-- Ruby Module ................................................ -->
+<!ENTITY % Ruby.common.attlists "INCLUDE" >
+<!ENTITY % Ruby.common.attrib "%Common.attrib;" >
+<!ENTITY % xhtml-ruby.module "INCLUDE" >
+<![%xhtml-ruby.module;[
+<!ENTITY % xhtml-ruby.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Ruby 1.0//EN"
+ "http://www.w3.org/TR/ruby/xhtml-ruby-1.mod" >
+%xhtml-ruby.mod;]]>
+
+<!-- Presentation Module ........................................ -->
+<!ENTITY % xhtml-pres.module "INCLUDE" >
+<![%xhtml-pres.module;[
+<!ENTITY % xhtml-pres.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Presentation 1.0//EN"
+ "xhtml-pres-1.mod" >
+%xhtml-pres.mod;]]>
+
+<!ENTITY % link.attlist "IGNORE" >
+<!-- Link Element Module ........................................ -->
+<!ENTITY % xhtml-link.module "INCLUDE" >
+<![%xhtml-link.module;[
+<!ENTITY % xhtml-link.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Link Element 1.0//EN"
+ "xhtml-link-1.mod" >
+%xhtml-link.mod;]]>
+
+<!ATTLIST %link.qname;
+ %Common.attrib;
+ charset %Charset.datatype; #IMPLIED
+ hreflang %LanguageCode.datatype; #IMPLIED
+ type %ContentType.datatype; #IMPLIED
+ media %MediaDesc.datatype; #IMPLIED
+>
+
+<!-- Document Metainformation Module ............................ -->
+<!ENTITY % meta.attlist "IGNORE" >
+<!ENTITY % xhtml-meta.module "INCLUDE" >
+<![%xhtml-meta.module;[
+<!ENTITY % xhtml-meta.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Metainformation 1.0//EN"
+ "xhtml-meta-1.mod" >
+%xhtml-meta.mod;]]>
+<!ATTLIST %meta.qname;
+ %Common.attrib;
+ http-equiv NMTOKEN #IMPLIED
+ name NMTOKEN #IMPLIED
+ scheme CDATA #IMPLIED
+>
+
+<!-- Base Element Module ........................................ -->
+<!ENTITY % xhtml-base.module "INCLUDE" >
+<![%xhtml-base.module;[
+<!ENTITY % xhtml-base.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Base Element 1.0//EN"
+ "xhtml-base-1.mod" >
+%xhtml-base.mod;]]>
+
+<!-- Scripting Module ........................................... -->
+<!ENTITY % script.attlist "IGNORE" >
+<!ENTITY % xhtml-script.module "INCLUDE" >
+<![%xhtml-script.module;[
+<!ENTITY % xhtml-script.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Scripting 1.0//EN"
+ "xhtml-script-1.mod" >
+%xhtml-script.mod;]]>
+
+<!ATTLIST %script.qname;
+ %XHTML.xmlns.attrib;
+ %id.attrib;
+ %Metainformation.attrib;
+ href %URI.datatype; #IMPLIED
+ xml:space ( preserve ) #FIXED 'preserve'
+ charset %Charset.datatype; #IMPLIED
+ type %ContentType.datatype; #REQUIRED
+ src %URI.datatype; #IMPLIED
+ defer ( defer ) #IMPLIED
+>
+
+<!-- Style Sheets Module ......................................... -->
+<!ENTITY % style.attlist "IGNORE" >
+<!ENTITY % xhtml-style.module "INCLUDE" >
+<![%xhtml-style.module;[
+<!ENTITY % xhtml-style.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Style Sheets 1.0//EN"
+ "xhtml-style-1.mod" >
+%xhtml-style.mod;]]>
+<!ATTLIST %style.qname;
+ %XHTML.xmlns.attrib;
+ %id.attrib;
+ %title.attrib;
+ %I18n.attrib;
+ %Metainformation.attrib;
+ href %URI.datatype; #IMPLIED
+ xml:space ( preserve ) #FIXED 'preserve'
+ type %ContentType.datatype; #REQUIRED
+ media %MediaDesc.datatype; #IMPLIED
+>
+
+<!-- Image Module ............................................... -->
+<!ENTITY % xhtml-image.module "INCLUDE" >
+<![%xhtml-image.module;[
+<!ENTITY % xhtml-image.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Images 1.0//EN"
+ "xhtml-image-1.mod" >
+%xhtml-image.mod;]]>
+
+<!-- Client-side Image Map Module ............................... -->
+<!ENTITY % area.attlist "IGNORE" >
+
+<!ENTITY % xhtml-csismap.module "INCLUDE" >
+<![%xhtml-csismap.module;[
+<!ENTITY % xhtml-csismap.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Client-side Image Maps 1.0//EN"
+ "xhtml-csismap-1.mod" >
+%xhtml-csismap.mod;]]>
+
+<!ATTLIST %area.qname;
+ %Common.attrib;
+ shape %Shape.datatype; 'rect'
+ coords %Coords.datatype; #IMPLIED
+ nohref ( nohref ) #IMPLIED
+ alt %Text.datatype; #REQUIRED
+ tabindex %Number.datatype; #IMPLIED
+ accesskey %Character.datatype; #IMPLIED
+>
+
+<!-- Server-side Image Map Module ............................... -->
+<!ENTITY % xhtml-ssismap.module "INCLUDE" >
+<![%xhtml-ssismap.module;[
+<!ENTITY % xhtml-ssismap.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Server-side Image Maps 1.0//EN"
+ "xhtml-ssismap-1.mod" >
+%xhtml-ssismap.mod;]]>
+
+<!-- Param Element Module ....................................... -->
+<!ENTITY % param.attlist "IGNORE" >
+<!ENTITY % xhtml-param.module "INCLUDE" >
+<![%xhtml-param.module;[
+<!ENTITY % xhtml-param.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Param Element 1.0//EN"
+ "xhtml-param-1.mod" >
+%xhtml-param.mod;]]>
+
+<!ATTLIST %param.qname;
+ %XHTML.xmlns.attrib;
+ %id.attrib;
+ %Metainformation.attrib;
+ href %URI.datatype; #IMPLIED
+ name CDATA #REQUIRED
+ value CDATA #IMPLIED
+ valuetype ( data | ref | object ) 'data'
+ type %ContentType.datatype; #IMPLIED
+>
+<!-- Embedded Object Module ..................................... -->
+<!ENTITY % xhtml-object.module "INCLUDE" >
+<![%xhtml-object.module;[
+<!ENTITY % xhtml-object.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Embedded Object 1.0//EN"
+ "xhtml-object-1.mod" >
+%xhtml-object.mod;]]>
+
+<!-- Tables Module ............................................... -->
+<!ENTITY % xhtml-table.module "INCLUDE" >
+<![%xhtml-table.module;[
+<!ENTITY % xhtml-table.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Tables 1.0//EN"
+ "xhtml-table-1.mod" >
+%xhtml-table.mod;]]>
+
+<!-- Forms Module ............................................... -->
+<!ENTITY % xhtml-form.module "INCLUDE" >
+<![%xhtml-form.module;[
+<!ENTITY % xhtml-form.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Forms 1.0//EN"
+ "xhtml-form-1.mod" >
+%xhtml-form.mod;]]>
+
+<!-- Target Attribute Module .................................... -->
+<!ENTITY % xhtml-target.module "INCLUDE" >
+<![%xhtml-target.module;[
+<!ENTITY % xhtml-target.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Target 1.0//EN"
+ "xhtml-target-1.mod" >
+%xhtml-target.mod;]]>
+
+<!-- Legacy Markup ............................................... -->
+<!ENTITY % xhtml-legacy.module "IGNORE" >
+<![%xhtml-legacy.module;[
+<!ENTITY % xhtml-legacy.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Legacy Markup 1.0//EN"
+ "xhtml-legacy-1.mod" >
+%xhtml-legacy.mod;]]>
+
+<!-- Document Structure Module (required) ....................... -->
+<!ENTITY % html.attlist "IGNORE" >
+<!ENTITY % head.attlist "IGNORE" >
+<!ENTITY % title.attlist "IGNORE" >
+<!ENTITY % xhtml-struct.module "INCLUDE" >
+<![%xhtml-struct.module;[
+<!ENTITY % xhtml-struct.mod
+ PUBLIC "-//W3C//ELEMENTS XHTML Document Structure 1.0//EN"
+ "xhtml-struct-1.mod" >
+%xhtml-struct.mod;]]>
+<!ENTITY % profile.attrib
+ "profile %URI.datatype; '%XHTML.profile;'"
+>
+<!ENTITY % XHTML.version.attrib
+ "version %FPI.datatype; #FIXED '%XHTML.version;'"
+>
+<!ATTLIST %html.qname;
+ %Common.attrib;
+ %XSI.schemaLocation.attrib;
+ %XHTML.version.attrib;
+>
+<!ATTLIST %head.qname;
+ %Common.attrib;
+ %profile.attrib;
+>
+<!ATTLIST %title.qname;
+ %Common.attrib;
+>
+
+<!-- end of XHTML-RDFa DTD ................................................ -->
+<!-- ....................................................................... -->
+
+<!-- Add xmlns attributes to validate lv2specgen output -->
+<!-- This is a pretty dirty hack, but avoids needing to write a bunch of code to
+ mangle DTDs to appease validation -->
+
+<!ATTLIST html xmlns:dc CDATA #IMPLIED>
+<!ATTLIST html xmlns:dct CDATA #IMPLIED>
+<!ATTLIST html xmlns:rdf CDATA #IMPLIED>
+<!ATTLIST html xmlns:rdfs CDATA #IMPLIED>
+
+<!ATTLIST html xmlns:atom CDATA #IMPLIED>
+<!ATTLIST html xmlns:bufsz CDATA #IMPLIED>
+<!ATTLIST html xmlns:da CDATA #IMPLIED>
+<!ATTLIST html xmlns:dman CDATA #IMPLIED>
+<!ATTLIST html xmlns:ev CDATA #IMPLIED>
+<!ATTLIST html xmlns:ia CDATA #IMPLIED>
+<!ATTLIST html xmlns:log CDATA #IMPLIED>
+<!ATTLIST html xmlns:lv2 CDATA #IMPLIED>
+<!ATTLIST html xmlns:midi CDATA #IMPLIED>
+<!ATTLIST html xmlns:morph CDATA #IMPLIED>
+<!ATTLIST html xmlns:opts CDATA #IMPLIED>
+<!ATTLIST html xmlns:param CDATA #IMPLIED>
+<!ATTLIST html xmlns:patch CDATA #IMPLIED>
+<!ATTLIST html xmlns:pg CDATA #IMPLIED>
+<!ATTLIST html xmlns:pprops CDATA #IMPLIED>
+<!ATTLIST html xmlns:pset CDATA #IMPLIED>
+<!ATTLIST html xmlns:rsz CDATA #IMPLIED>
+<!ATTLIST html xmlns:state CDATA #IMPLIED>
+<!ATTLIST html xmlns:time CDATA #IMPLIED>
+<!ATTLIST html xmlns:ui CDATA #IMPLIED>
+<!ATTLIST html xmlns:umap CDATA #IMPLIED>
+<!ATTLIST html xmlns:units CDATA #IMPLIED>
+<!ATTLIST html xmlns:urid CDATA #IMPLIED>
+<!ATTLIST html xmlns:work CDATA #IMPLIED>
diff --git a/lv2specgen/DTD/xhtml-rdfa-model-1.mod b/lv2specgen/DTD/xhtml-rdfa-model-1.mod
new file mode 100644
index 0000000..ad010ee
--- /dev/null
+++ b/lv2specgen/DTD/xhtml-rdfa-model-1.mod
@@ -0,0 +1,249 @@
+<!-- ....................................................................... -->
+<!-- XHTML+RDFa Document Model Module ..................................... -->
+<!-- file: xhtml-rdfa-model-1.mod
+
+ This is XHTML+RDFa.
+ Copyright 1998-2008 W3C (MIT, ERCIM, Keio), All Rights Reserved.
+ Revision: $Id: xhtml-rdfa-model-1.mod,v 1.4 2009/06/26 14:05:13 smccarro Exp $ SMI
+
+ This DTD module is identified by the PUBLIC and SYSTEM identifiers:
+
+ PUBLIC "-//W3C//ENTITIES XHTML+RDFa Document Model 1.0//EN"
+ SYSTEM "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-model-1.mod"
+
+ Revisions:
+ (none)
+ ....................................................................... -->
+
+<!-- XHTML+RDFa Document Model
+
+ This module describes the groupings of elements that make up
+ common content models for XHTML elements.
+
+ XHTML has three basic content models:
+
+ %Inline.mix; character-level elements
+ %Block.mix; block-like elements, eg., paragraphs and lists
+ %Flow.mix; any block or inline elements
+
+ Any parameter entities declared in this module may be used
+ to create element content models, but the above three are
+ considered 'global' (insofar as that term applies here).
+
+ The reserved word '#PCDATA' (indicating a text string) is now
+ included explicitly with each element declaration that is
+ declared as mixed content, as XML requires that this token
+ occur first in a content model specification.
+-->
+<!-- Extending the Model
+
+ While in some cases this module may need to be rewritten to
+ accommodate changes to the document model, minor extensions
+ may be accomplished by redeclaring any of the three *.extra;
+ parameter entities to contain extension element types as follows:
+
+ %Misc.extra; whose parent may be any block or
+ inline element.
+
+ %Inline.extra; whose parent may be any inline element.
+
+ %Block.extra; whose parent may be any block element.
+
+ If used, these parameter entities must be an OR-separated
+ list beginning with an OR separator ("|"), eg., "| a | b | c"
+
+ All block and inline *.class parameter entities not part
+ of the *struct.class classes begin with "| " to allow for
+ exclusion from mixes.
+-->
+
+<!-- .............. Optional Elements in head .................. -->
+
+<!ENTITY % HeadOpts.mix
+ "( %script.qname; | %style.qname; | %meta.qname;
+ | %link.qname; | %object.qname; )*"
+>
+
+<!-- ................. Miscellaneous Elements .................. -->
+
+<!-- ins and del are used to denote editing changes
+-->
+<!ENTITY % Edit.class "| %ins.qname; | %del.qname;" >
+
+<!-- script and noscript are used to contain scripts
+ and alternative content
+-->
+<!ENTITY % Script.class "| %script.qname; | %noscript.qname;" >
+
+<!ENTITY % Misc.extra "" >
+
+<!-- These elements are neither block nor inline, and can
+ essentially be used anywhere in the document body.
+-->
+<!ENTITY % Misc.class
+ "%Edit.class;
+ %Script.class;
+ %Misc.extra;"
+>
+
+<!-- .................... Inline Elements ...................... -->
+
+<!ENTITY % InlStruct.class "%br.qname; | %span.qname;" >
+
+<!ENTITY % InlPhras.class
+ "| %em.qname; | %strong.qname; | %dfn.qname; | %code.qname;
+ | %samp.qname; | %kbd.qname; | %var.qname; | %cite.qname;
+ | %abbr.qname; | %acronym.qname; | %q.qname;" >
+
+<!ENTITY % InlPres.class
+ "| %tt.qname; | %i.qname; | %b.qname; | %big.qname;
+ | %small.qname; | %sub.qname; | %sup.qname;" >
+
+<!ENTITY % I18n.class "| %bdo.qname;" >
+
+<!ENTITY % Anchor.class "| %a.qname;" >
+
+<!ENTITY % InlSpecial.class
+ "| %img.qname; | %map.qname;
+ | %object.qname;" >
+
+<!ENTITY % InlForm.class
+ "| %input.qname; | %select.qname; | %textarea.qname;
+ | %label.qname; | %button.qname;" >
+
+<!ENTITY % Inline.extra "" >
+
+<!ENTITY % Ruby.class "| %ruby.qname;" >
+
+<!-- %Inline.class; includes all inline elements,
+ used as a component in mixes
+-->
+<!ENTITY % Inline.class
+ "%InlStruct.class;
+ %InlPhras.class;
+ %InlPres.class;
+ %I18n.class;
+ %Anchor.class;
+ %InlSpecial.class;
+ %InlForm.class;
+ %Ruby.class;
+ %Inline.extra;"
+>
+
+<!-- %InlNoRuby.class; includes all inline elements
+ except ruby, used as a component in mixes
+-->
+<!ENTITY % InlNoRuby.class
+ "%InlStruct.class;
+ %InlPhras.class;
+ %InlPres.class;
+ %I18n.class;
+ %Anchor.class;
+ %InlSpecial.class;
+ %InlForm.class;
+ %Inline.extra;"
+>
+
+<!-- %NoRuby.content; includes all inlines except ruby
+-->
+<!ENTITY % NoRuby.content
+ "( #PCDATA
+ | %InlNoRuby.class;
+ %Misc.class; )*"
+>
+
+<!-- %InlNoAnchor.class; includes all non-anchor inlines,
+ used as a component in mixes
+-->
+<!ENTITY % InlNoAnchor.class
+ "%InlStruct.class;
+ %InlPhras.class;
+ %InlPres.class;
+ %I18n.class;
+ %InlSpecial.class;
+ %InlForm.class;
+ %Ruby.class;
+ %Inline.extra;"
+>
+
+<!-- %InlNoAnchor.mix; includes all non-anchor inlines
+-->
+<!ENTITY % InlNoAnchor.mix
+ "%InlNoAnchor.class;
+ %Misc.class;"
+>
+
+<!-- %Inline.mix; includes all inline elements, including %Misc.class;
+-->
+<!ENTITY % Inline.mix
+ "%Inline.class;
+ %Misc.class;"
+>
+
+<!-- ..................... Block Elements ...................... -->
+
+<!-- In the HTML 4.0 DTD, heading and list elements were included
+ in the %block; parameter entity. The %Heading.class; and
+ %List.class; parameter entities must now be included explicitly
+ on element declarations where desired.
+-->
+
+<!ENTITY % Heading.class
+ "%h1.qname; | %h2.qname; | %h3.qname;
+ | %h4.qname; | %h5.qname; | %h6.qname;" >
+
+<!ENTITY % List.class "%ul.qname; | %ol.qname; | %dl.qname;" >
+
+<!ENTITY % Table.class "| %table.qname;" >
+
+<!ENTITY % Form.class "| %form.qname;" >
+
+<!ENTITY % Fieldset.class "| %fieldset.qname;" >
+
+<!ENTITY % BlkStruct.class "%p.qname; | %div.qname;" >
+
+<!ENTITY % BlkPhras.class
+ "| %pre.qname; | %blockquote.qname; | %address.qname;" >
+
+<!ENTITY % BlkPres.class "| %hr.qname; " >
+
+<!ENTITY % BlkSpecial.class
+ "%Table.class;
+ %Form.class;
+ %Fieldset.class;"
+>
+
+<!ENTITY % Block.extra "" >
+
+<!-- %Block.class; includes all block elements,
+ used as an component in mixes
+-->
+<!ENTITY % Block.class
+ "%BlkStruct.class;
+ %BlkPhras.class;
+ %BlkPres.class;
+ %BlkSpecial.class;
+ %Block.extra;"
+>
+
+<!-- %Block.mix; includes all block elements plus %Misc.class;
+-->
+<!ENTITY % Block.mix
+ "%Heading.class;
+ | %List.class;
+ | %Block.class;
+ %Misc.class;"
+>
+
+<!-- ................ All Content Elements .................. -->
+
+<!-- %Flow.mix; includes all text content, block and inline
+-->
+<!ENTITY % Flow.mix
+ "%Heading.class;
+ | %List.class;
+ | %Block.class;
+ | %Inline.class;
+ %Misc.class;"
+>
+<!-- end of xhtml-rdfa-model-1.mod -->
diff --git a/lv2specgen/lv2docgen.py b/lv2specgen/lv2docgen.py
index 423659e..23a239d 100755
--- a/lv2specgen/lv2docgen.py
+++ b/lv2specgen/lv2docgen.py
@@ -16,16 +16,16 @@
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+import errno
+import os
+import sys
+
__date__ = '2012-03-27'
__version__ = '0.0.0'
__authors__ = 'David Robillard'
__license__ = 'ISC License <http://www.opensource.org/licenses/isc>'
__contact__ = 'devel@lists.lv2plug.in'
-import errno
-import os
-import sys
-
try:
import rdflib
except ImportError:
@@ -47,7 +47,7 @@ def get_doc(model, subject):
if comment:
return '<p class="content">%s</p>' % comment
return ''
-
+
def port_doc(model, port):
name = model.value(port, lv2.name, None)
comment = model.value(port, rdfs.comment, None)
@@ -131,11 +131,8 @@ if __name__ == '__main__':
pass
else:
raise
-
- print 'Writing <%s> documentation to %s' % (plugin, outpath)
+
+ print('Writing <%s> documentation to %s' % (plugin, outpath))
out = open(outpath, 'w')
out.write(html)
out.close()
-
-
-
diff --git a/lv2specgen/lv2specgen.py b/lv2specgen/lv2specgen.py
index efbf053..8cfa1c7 100755
--- a/lv2specgen/lv2specgen.py
+++ b/lv2specgen/lv2specgen.py
@@ -2,7 +2,7 @@
# -*- coding: utf-8 -*-
#
# lv2specgen, a documentation generator for LV2 specifications.
-# Copyright (c) 2009-2012 David Robillard <d@drobilla.net>
+# Copyright (c) 2009-2014 David Robillard <d@drobilla.net>
#
# Based on SpecGen:
# <http://forge.morfeo-project.org/wiki_en/index.php/SpecGen>
@@ -30,36 +30,41 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
-__date__ = "2011-10-26"
-__version__ = __date__.replace('-', '.')
-__authors__ = """
-Christopher Schmidt,
-Uldis Bojars,
-Sergio Fernández,
-David Robillard"""
-__license__ = "MIT License <http://www.opensource.org/licenses/mit>"
-__contact__ = "devel@lists.lv2plug.in"
-
import datetime
+import markdown
+import markdown.extensions
+import optparse
import os
import re
import sys
+import time
import xml.sax.saxutils
import xml.dom
import xml.dom.minidom
+__date__ = "2011-10-26"
+__version__ = __date__.replace("-", ".")
+__authors__ = """
+Christopher Schmidt,
+Uldis Bojars,
+Sergio Fernández,
+David Robillard"""
+__license__ = "MIT License <http://www.opensource.org/licenses/mit>"
+__contact__ = "devel@lists.lv2plug.in"
+
try:
from lxml import etree
+
have_lxml = True
-except:
+except Exception:
have_lxml = False
try:
import pygments
import pygments.lexers
+ import pygments.lexers.rdf
import pygments.formatters
- from pygments.lexer import RegexLexer, include, bygroups
- from pygments.token import Text, Comment, Operator, Keyword, Name, String, Literal, Punctuation
+
have_pygments = True
except ImportError:
print("Error importing pygments, syntax highlighting disabled")
@@ -78,31 +83,32 @@ spec_url = None
spec_ns_str = None
spec_ns = None
spec_pre = None
+spec_bundle = None
specgendir = None
ns_list = {
- "http://www.w3.org/1999/02/22-rdf-syntax-ns#" : "rdf",
- "http://www.w3.org/2000/01/rdf-schema#" : "rdfs",
- "http://www.w3.org/2002/07/owl#" : "owl",
- "http://www.w3.org/2001/XMLSchema#" : "xsd",
- "http://rdfs.org/sioc/ns#" : "sioc",
- "http://xmlns.com/foaf/0.1/" : "foaf",
- "http://purl.org/dc/elements/1.1/" : "dc",
- "http://purl.org/dc/terms/" : "dct",
- "http://purl.org/rss/1.0/modules/content/" : "content",
- "http://www.w3.org/2003/01/geo/wgs84_pos#" : "geo",
- "http://www.w3.org/2004/02/skos/core#" : "skos",
- "http://lv2plug.in/ns/lv2core#" : "lv2",
- "http://usefulinc.com/ns/doap#" : "doap",
- "http://ontologi.es/doap-changeset#" : "dcs"
- }
-
-rdf = rdflib.Namespace('http://www.w3.org/1999/02/22-rdf-syntax-ns#')
-rdfs = rdflib.Namespace('http://www.w3.org/2000/01/rdf-schema#')
-owl = rdflib.Namespace('http://www.w3.org/2002/07/owl#')
-lv2 = rdflib.Namespace('http://lv2plug.in/ns/lv2core#')
-doap = rdflib.Namespace('http://usefulinc.com/ns/doap#')
-dcs = rdflib.Namespace('http://ontologi.es/doap-changeset#')
-foaf = rdflib.Namespace('http://xmlns.com/foaf/0.1/')
+ "http://www.w3.org/1999/02/22-rdf-syntax-ns#": "rdf",
+ "http://www.w3.org/2000/01/rdf-schema#": "rdfs",
+ "http://www.w3.org/2002/07/owl#": "owl",
+ "http://www.w3.org/2001/XMLSchema#": "xsd",
+ "http://rdfs.org/sioc/ns#": "sioc",
+ "http://xmlns.com/foaf/0.1/": "foaf",
+ "http://purl.org/dc/elements/1.1/": "dc",
+ "http://purl.org/dc/terms/": "dct",
+ "http://purl.org/rss/1.0/modules/content/": "content",
+ "http://www.w3.org/2003/01/geo/wgs84_pos#": "geo",
+ "http://www.w3.org/2004/02/skos/core#": "skos",
+ "http://lv2plug.in/ns/lv2core#": "lv2",
+ "http://usefulinc.com/ns/doap#": "doap",
+ "http://ontologi.es/doap-changeset#": "dcs",
+}
+
+rdf = rdflib.Namespace("http://www.w3.org/1999/02/22-rdf-syntax-ns#")
+rdfs = rdflib.Namespace("http://www.w3.org/2000/01/rdf-schema#")
+owl = rdflib.Namespace("http://www.w3.org/2002/07/owl#")
+lv2 = rdflib.Namespace("http://lv2plug.in/ns/lv2core#")
+doap = rdflib.Namespace("http://usefulinc.com/ns/doap#")
+dcs = rdflib.Namespace("http://ontologi.es/doap-changeset#")
+foaf = rdflib.Namespace("http://xmlns.com/foaf/0.1/")
def findStatements(model, s, p, o):
@@ -110,10 +116,10 @@ def findStatements(model, s, p, o):
def findOne(m, s, p, o):
- l = findStatements(m, s, p, o)
+ triples = findStatements(m, s, p, o)
try:
- return l.next()
- except:
+ return sorted(triples)[0]
+ except Exception:
return None
@@ -146,6 +152,12 @@ def isLiteral(n):
def niceName(uri):
+ global spec_bundle
+ if uri.startswith(spec_ns_str):
+ return uri[len(spec_ns_str) :]
+ elif uri == str(rdfs.seeAlso):
+ return "See also"
+
regexp = re.compile("^(.*[/#])([^/#]+)$")
rez = regexp.search(uri)
if not rez:
@@ -165,148 +177,131 @@ def termName(m, urinode):
def getLabel(m, urinode):
- l = findOne(m, urinode, rdfs.label, None)
- if l:
- return getLiteralString(getObject(l))
+ statement = findOne(m, urinode, rdfs.label, None)
+ if statement:
+ return getLiteralString(getObject(statement))
else:
- return ''
-
-if have_pygments:
- # Based on sw.py by Philip Cooper
- class Notation3Lexer(RegexLexer):
- """
- Lexer for N3 / Turtle / NT
- """
- name = 'N3'
- aliases = ['n3', 'turtle']
- filenames = ['*.n3', '*.ttl', '*.nt']
- mimetypes = ['text/rdf+n3','application/x-turtle','application/n3']
-
- tokens = {
- 'comments': [
- (r'(\s*#.*)', Comment)
- ],
- 'root': [
- include('comments'),
- (r'(\s*@(?:prefix|base|keywords)\s*)(\w*:\s+)?(<[^> ]*>\s*\.\s*)',bygroups(Keyword,Name.Variable,Name.Namespace)),
- (r'\s*(<[^>]*\>)', Name.Class, ('triple','predObj')),
- (r'(\s*[a-zA-Z_:][a-zA-Z0-9\-_:]*\s)', Name.Class, ('triple','predObj')),
- (r'\s*\[\]\s*', Name.Class, ('triple','predObj')),
- ],
- 'triple' : [
- (r'\s*\.\s*', Text, '#pop')
- ],
- 'predObj': [
- include('comments'),
- (r'\s*a\s*', Name.Keyword, 'object'),
- (r'\s*[a-zA-Z_:][a-zA-Z0-9\-_:]*\b\s*', Name.Tag, 'object'),
- (r'\s*(<[^>]*\>)', Name.Tag, 'object'),
- (r'\s*\]\s*', Text, '#pop'),
- (r'(?=\s*\.\s*)', Keyword, '#pop'),
- ],
- 'objList': [
- include('comments'),
- (r'\s*\)', Text, '#pop'),
- include('object')
- ],
- 'object': [
- include('comments'),
- (r'\s*\[', Text, 'predObj'),
- (r'\s*<[^> ]*>', Name.Tag),
- (r'\s*("""(?:.|\n)*?""")(\@[a-z]{2-4}|\^\^<?[a-zA-Z0-9\-\:_#/\.]*>?)?\s*', bygroups(Literal.String,Text)),
- (r'\s*".*?[^\\]"(?:\@[a-z]{2-4}|\^\^<?[a-zA-Z0-9\-\:_#/\.]*>?)?\s*', Literal.String),
- (r'\s*[0-9]+\.[0-9]*\s*\n?', Literal.Number),
- (r'\s*[0-9]+\s*\n?', Literal.Number),
- (r'\s*[a-zA-Z0-9\-_\:]+\s*', Name.Tag),
- (r'\s*\(', Text, 'objList'),
- (r'\s*;\s*\n?', Punctuation, '#pop'),
- (r'\s*,\s*\n?', Punctuation), # Added by drobilla so "," is not an error
- (r'(?=\s*\])', Text, '#pop'),
- (r'(?=\s*\.)', Text, '#pop'),
- ],
- }
-
-def linkify(string):
+ return ""
+
+
+def linkifyCodeIdentifiers(string):
+ "Add links to code documentation for identifiers like LV2_Type"
+
if linkmap == {}:
return string
- "Add links to code documentation for identifiers"
if string in linkmap.keys():
# Exact match for complete string
return linkmap[string]
- rgx = re.compile('([^a-zA-Z0-9_:])(' + \
- '|'.join(map(re.escape, linkmap)) + \
- ')([^a-zA-Z0-9_:])')
+ rgx = re.compile(
+ "([^a-zA-Z0-9_:])("
+ + "|".join(map(re.escape, linkmap))
+ + ")([^a-zA-Z0-9_:])"
+ )
def translateCodeLink(match):
return match.group(1) + linkmap[match.group(2)] + match.group(3)
-
+
return rgx.sub(translateCodeLink, string)
-def getComment(m, urinode, classlist, proplist, instalist):
- c = findOne(m, urinode, lv2.documentation, None)
- if c:
- markup = getLiteralString(getObject(c))
-
- # Syntax highlight all C code
- if have_pygments:
- code_rgx = re.compile('<pre class="c-code">(.*?)</pre>', re.DOTALL)
- while True:
- code = code_rgx.search(markup)
- if not code:
- break
- match_str = xml.sax.saxutils.unescape(code.group(1))
- code_str = pygments.highlight(
- match_str,
- pygments.lexers.CLexer(),
- pygments.formatters.HtmlFormatter())
- markup = code_rgx.sub(code_str, markup, 1)
-
- # Syntax highlight all Turtle code
- if have_pygments:
- code_rgx = re.compile('<pre class="turtle-code">(.*?)</pre>', re.DOTALL)
- while True:
- code = code_rgx.search(markup)
- if not code:
- break
- match_str = xml.sax.saxutils.unescape(code.group(1))
- code_str = pygments.highlight(
- match_str,
- Notation3Lexer(),
- pygments.formatters.HtmlFormatter())
- markup = code_rgx.sub(code_str, markup, 1)
-
- # Add links to code documentation for identifiers
- markup = linkify(markup)
-
- # Transform prefixed names like eg:something into links if possible
- rgx = re.compile('([a-zA-Z0-9_-]+):([a-zA-Z0-9_-]+)')
- namespaces = getNamespaces(m)
- def translateLink(match):
- text = match.group(0)
- prefix = match.group(1)
- name = match.group(2)
- curie = match.group(0)
- uri = rdflib.URIRef(spec_ns + name)
- if prefix == spec_pre:
- if not ((classlist and uri in classlist) or
- (instalist and uri in instalist) or
- (proplist and uri in proplist)):
- print("warning: Link to undefined resource <%s>\n" % text)
- return '<a href="#%s">%s</a>' % (name, curie)
- elif prefix in namespaces:
- return '<a href="%s">%s</a>' % (
- namespaces[match.group(1)] + match.group(2),
- match.group(0))
- else:
- return text
- markup = rgx.sub(translateLink, markup)
-
- if have_lxml:
- try:
- # Parse and validate documentation as XHTML Basic 1.1
- doc = """<?xml version="1.0" encoding="UTF-8"?>
+
+def linkifyVocabIdentifiers(m, string, classlist, proplist, instalist):
+ "Add links to vocabulary documentation for prefixed names like eg:Thing"
+
+ rgx = re.compile("([a-zA-Z0-9_-]+):([a-zA-Z0-9_-]+)")
+ namespaces = getNamespaces(m)
+
+ def translateLink(match):
+ text = match.group(0)
+ prefix = match.group(1)
+ name = match.group(2)
+ uri = rdflib.URIRef(spec_ns + name)
+ if prefix == spec_pre:
+ if not (
+ (classlist and uri in classlist)
+ or (instalist and uri in instalist)
+ or (proplist and uri in proplist)
+ ):
+ print("warning: Link to undefined resource <%s>\n" % text)
+ return '<a href="#%s">%s</a>' % (name, name)
+ elif prefix in namespaces:
+ return '<a href="%s">%s</a>' % (
+ namespaces[match.group(1)] + match.group(2),
+ match.group(0),
+ )
+ else:
+ return text
+
+ return rgx.sub(translateLink, string)
+
+
+def prettifyHtml(m, markup, subject, classlist, proplist, instalist):
+ # Syntax highlight all C code
+ if have_pygments:
+ code_rgx = re.compile('<pre class="c-code">(.*?)</pre>', re.DOTALL)
+ while True:
+ code = code_rgx.search(markup)
+ if not code:
+ break
+ match_str = xml.sax.saxutils.unescape(code.group(1))
+ code_str = pygments.highlight(
+ match_str,
+ pygments.lexers.CLexer(),
+ pygments.formatters.HtmlFormatter(),
+ )
+ markup = code_rgx.sub(code_str, markup, 1)
+
+ # Syntax highlight all Turtle code
+ if have_pygments:
+ code_rgx = re.compile(
+ '<pre class="turtle-code">(.*?)</pre>', re.DOTALL
+ )
+ while True:
+ code = code_rgx.search(markup)
+ if not code:
+ break
+ match_str = xml.sax.saxutils.unescape(code.group(1))
+ code_str = pygments.highlight(
+ match_str,
+ pygments.lexers.rdf.TurtleLexer(),
+ pygments.formatters.HtmlFormatter(),
+ )
+ markup = code_rgx.sub(code_str, markup, 1)
+
+ # Add links to code documentation for identifiers
+ markup = linkifyCodeIdentifiers(markup)
+
+ # Add internal links for known prefixed names
+ markup = linkifyVocabIdentifiers(m, markup, classlist, proplist, instalist)
+
+ # Transform names like #foo into links into this spec if possible
+ rgx = re.compile("([ \t\n\r\f\v^]+)#([a-zA-Z0-9_-]+)")
+
+ def translateLocalLink(match):
+ text = match.group(0)
+ space = match.group(1)
+ name = match.group(2)
+ uri = rdflib.URIRef(spec_ns + name)
+ if (
+ (classlist and uri in classlist)
+ or (instalist and uri in instalist)
+ or (proplist and uri in proplist)
+ ):
+ return '%s<a href="#%s">%s</a>' % (space, name, name)
+ else:
+ print("warning: Link to undefined resource <%s>\n" % name)
+ return text
+
+ markup = rgx.sub(translateLocalLink, markup)
+
+ if not have_lxml:
+ print("warning: No Python lxml module found, output may be invalid")
+ else:
+ try:
+ # Parse and validate documentation as XHTML Basic 1.1
+ doc = (
+ """<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN"
"DTD/xhtml-basic11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
@@ -314,43 +309,108 @@ def getComment(m, urinode, classlist, proplist, instalist):
<title>Validation Skeleton Document</title>
</head>
<body>
-%s
+"""
+ + markup
+ + """
</body>
-</html>
-""" % str(markup.decode())
-
- oldcwd = os.getcwd()
- os.chdir(specgendir)
- parser = etree.XMLParser(dtd_validation=True, no_network=True)
- root = etree.fromstring(doc, parser)
- os.chdir(oldcwd)
- except Exception as e:
- print("Invalid lv2:documentation for %s\n%s" % (urinode, e))
+</html>"""
+ )
+
+ oldcwd = os.getcwd()
+ os.chdir(specgendir)
+ parser = etree.XMLParser(dtd_validation=True, no_network=True)
+ etree.fromstring(doc.encode("utf-8"), parser)
+ except Exception as e:
+ print("Invalid documentation for %s\n%s" % (subject, e))
+ line_num = 1
+ for line in doc.split("\n"):
+ print("%3d: %s" % (line_num, line))
+ line_num += 1
+ finally:
+ os.chdir(oldcwd)
+
+ return markup
+
+
+def formatDoc(m, urinode, literal, classlist, proplist, instalist):
+ string = getLiteralString(literal)
+
+ if literal.datatype == lv2.Markdown:
+ ext = [
+ "markdown.extensions.codehilite",
+ "markdown.extensions.tables",
+ "markdown.extensions.def_list",
+ ]
+
+ doc = markdown.markdown(string, extensions=ext)
+
+ # Hack to make tables valid XHTML Basic 1.1
+ for tag in ["thead", "tbody"]:
+ doc = doc.replace("<%s>\n" % tag, "")
+ doc = doc.replace("</%s>\n" % tag, "")
+
+ return prettifyHtml(m, doc, urinode, classlist, proplist, instalist)
+ else:
+ doc = xml.sax.saxutils.escape(string)
+ doc = linkifyCodeIdentifiers(doc)
+ doc = linkifyVocabIdentifiers(m, doc, classlist, proplist, instalist)
+ return "<p>%s</p>" % doc
- return markup
- c = findOne(m, urinode, rdfs.comment, None)
+def getComment(m, subject, classlist, proplist, instalist):
+ c = findOne(m, subject, rdfs.comment, None)
if c:
- text = getLiteralString(getObject(c))
- return '<p>%s</p>' % xml.sax.saxutils.escape(text)
+ comment = getObject(c)
+ return formatDoc(m, subject, comment, classlist, proplist, instalist)
+
+ return ""
+
- return ''
+def getDetailedDocumentation(m, subject, classlist, proplist, instalist):
+ markup = ""
+
+ d = findOne(m, subject, lv2.documentation, None)
+ if d:
+ doc = getObject(d)
+ if doc.datatype == lv2.Markdown:
+ markup += formatDoc(
+ m, subject, doc, classlist, proplist, instalist
+ )
+ else:
+ html = getLiteralString(doc)
+ markup += prettifyHtml(
+ m, html, subject, classlist, proplist, instalist
+ )
+
+ return markup
+
+
+def getFullDocumentation(m, subject, classlist, proplist, instalist):
+ # Use rdfs:comment for first summary line
+ markup = getComment(m, subject, classlist, proplist, instalist)
+
+ # Use lv2:documentation for further details
+ markup += getDetailedDocumentation(
+ m, subject, classlist, proplist, instalist
+ )
+
+ return markup
def getProperty(val, first=True):
"Return a string representing a property value in a property table"
- doc = ''
+ doc = ""
if not first:
- doc += '<tr><td></td>' # Empty cell in header column
- doc += '<td>%s</td></tr>\n' % val
+ doc += "<tr><th></th>" # Empty cell in header column
+ doc += "<td>%s</td></tr>\n" % val
return doc
def endProperties(first):
if first:
- return '</tr>'
+ return "</tr>"
else:
- return ''
+ return ""
def rdfsPropertyInfo(term, m):
@@ -358,54 +418,64 @@ def rdfsPropertyInfo(term, m):
global classranges
global classdomains
doc = ""
- range = ""
- domain = ""
+
+ label = getLabel(m, term)
+ if label != "":
+ doc += "<tr><th>Label</th><td>%s</td></tr>" % label
# Find subPropertyOf information
- rlist = ''
+ rlist = ""
first = True
for st in findStatements(m, term, rdfs.subPropertyOf, None):
k = getTermLink(getObject(st), term, rdfs.subPropertyOf)
rlist += getProperty(k, first)
first = False
- if rlist != '':
- doc += '<tr><th>Sub-property of</th>' + rlist
+ if rlist != "":
+ doc += "<tr><th>Sub-property of</th>" + rlist
# Domain stuff
domains = findStatements(m, term, rdfs.domain, None)
domainsdoc = ""
first = True
- for d in domains:
+ for d in sorted(domains):
union = findOne(m, getObject(d), owl.unionOf, None)
if union:
uris = parseCollection(m, getObject(union))
for uri in uris:
- domainsdoc += getProperty(getTermLink(uri, term, rdfs.domain), first)
+ domainsdoc += getProperty(
+ getTermLink(uri, term, rdfs.domain), first
+ )
add(classdomains, uri, term)
else:
if not isBlank(getObject(d)):
- domainsdoc += getProperty(getTermLink(getObject(d), term, rdfs.domain), first)
+ domainsdoc += getProperty(
+ getTermLink(getObject(d), term, rdfs.domain), first
+ )
first = False
- if (len(domainsdoc) > 0):
+ if len(domainsdoc) > 0:
doc += "<tr><th>Domain</th>%s" % domainsdoc
# Range stuff
ranges = findStatements(m, term, rdfs.range, None)
rangesdoc = ""
first = True
- for r in ranges:
+ for r in sorted(ranges):
union = findOne(m, getObject(r), owl.unionOf, None)
if union:
uris = parseCollection(m, getObject(union))
for uri in uris:
- rangesdoc += getProperty(getTermLink(uri, term, rdfs.range), first)
+ rangesdoc += getProperty(
+ getTermLink(uri, term, rdfs.range), first
+ )
add(classranges, uri, term)
first = False
else:
if not isBlank(getObject(r)):
- rangesdoc += getProperty(getTermLink(getObject(r), term, rdfs.range), first)
+ rangesdoc += getProperty(
+ getTermLink(getObject(r), term, rdfs.range), first
+ )
first = False
- if (len(rangesdoc) > 0):
+ if len(rangesdoc) > 0:
doc += "<tr><th>Range</th>%s" % rangesdoc
return doc
@@ -416,10 +486,10 @@ def parseCollection(model, node):
while node:
first = findOne(model, node, rdf.first, None)
- rest = findOne(model, node, rdf.rest, None)
+ rest = findOne(model, node, rdf.rest, None)
if not first or not rest:
- break;
-
+ break
+
uris.append(getObject(first))
node = getObject(rest)
@@ -428,41 +498,36 @@ def parseCollection(model, node):
def getTermLink(uri, subject=None, predicate=None):
uri = str(uri)
- extra = ''
- if subject != None and predicate != None:
- extra = 'about="%s" rel="%s" resource="%s"' % (str(subject), niceName(str(predicate)), uri)
- if (uri.startswith(spec_ns_str)):
- return '<a href="#%s" %s>%s</a>' % (uri.replace(spec_ns_str, ""), extra, niceName(uri))
+ extra = ""
+ if subject is not None and predicate is not None:
+ extra = 'about="%s" rel="%s" resource="%s"' % (
+ str(subject),
+ niceName(str(predicate)),
+ uri,
+ )
+ if uri.startswith(spec_ns_str):
+ return '<a href="#%s" %s>%s</a>' % (
+ uri.replace(spec_ns_str, ""),
+ extra,
+ niceName(uri),
+ )
else:
return '<a href="%s" %s>%s</a>' % (uri, extra, niceName(uri))
-def rdfsClassInfo(term, m):
- """Generate rdfs-type information for Classes: ranges, and domains."""
- global classranges
- global classdomains
- doc = ""
-
- # Find subClassOf information
+def owlRestrictionInfo(term, m):
+ """Generate OWL restriction information for Classes"""
restrictions = []
- superclasses = []
- for st in findStatements(m, term, rdfs.subClassOf, None):
- if not isBlank(getObject(st)):
- uri = getObject(st)
- if not uri in superclasses:
- superclasses.append(uri)
- else:
- meta_type = findOne(m, getObject(st), rdf.type, None)
- restrictions.append(getSubject(meta_type))
-
- if len(superclasses) > 0:
- doc += "\n<tr><th>Sub-class of</th>"
- first = True
- for superclass in superclasses:
- doc += getProperty(getTermLink(superclass), first)
- first = False
+ for s in findStatements(m, term, rdfs.subClassOf, None):
+ if findOne(m, getObject(s), rdf.type, owl.Restriction):
+ restrictions.append(getObject(s))
+
+ if not restrictions:
+ return ""
+
+ doc = "<dl>"
- for r in restrictions:
+ for r in sorted(restrictions):
props = findStatements(m, r, None, None)
onProp = None
comment = None
@@ -471,46 +536,82 @@ def rdfsClassInfo(term, m):
onProp = getObject(p)
elif getPredicate(p) == rdfs.comment:
comment = getObject(p)
- if onProp != None:
- doc += '<tr><th>Restriction on %s</th><td>' % getTermLink(onProp)
+ if onProp is not None:
+ doc += "<dt>Restriction on %s</dt>\n" % getTermLink(onProp)
- prop_str = ''
- last_pred = None
- first = True
+ prop_str = ""
for p in findStatements(m, r, None, None):
- if (getPredicate(p) == owl.onProperty
+ if (
+ getPredicate(p) == owl.onProperty
or getPredicate(p) == rdfs.comment
- or (getPredicate(p) == rdf.type and getObject(p) == owl.Restriction)
- or getPredicate(p) == lv2.documentation):
- last_pred = None
+ or (
+ getPredicate(p) == rdf.type
+ and getObject(p) == owl.Restriction
+ )
+ or getPredicate(p) == lv2.documentation
+ ):
continue
- if getPredicate(p) != last_pred:
- prop_str += '<tr><th>%s</th>\n' % getTermLink(getPredicate(p))
- first = True
+ prop_str += getTermLink(getPredicate(p))
+
if isResource(getObject(p)):
- prop_str += getProperty(getTermLink(getObject(p)), first)
- first = False
+ prop_str += " " + getTermLink(getObject(p))
elif isLiteral(getObject(p)):
- prop_str += getProperty(getLiteralString(getObject(p)), first)
- first = False
+ prop_str += " " + getLiteralString(getObject(p))
+
+ if comment is not None:
+ prop_str += "\n<div>%s</div>\n" % getLiteralString(comment)
- last_pred = getPredicate(p)
+ doc += "<dd>%s</dd>" % prop_str if prop_str else ""
- prop_str += endProperties(first)
+ doc += "</dl>"
+ return doc
- if prop_str != '':
- doc += '<table class=\"restriction\">%s</table>\n' % prop_str
- if comment != None:
- doc += "<span>%s</span>\n" % getLiteralString(comment)
- doc += '</td></tr>'
+
+def rdfsClassInfo(term, m):
+ """Generate rdfs-type information for Classes: ranges, and domains."""
+ global classranges
+ global classdomains
+ doc = ""
+
+ label = getLabel(m, term)
+ if label != "":
+ doc += "<tr><th>Label</th><td>%s</td></tr>" % label
+
+ # Find superclasses
+ superclasses = set()
+ for st in findStatements(m, term, rdfs.subClassOf, None):
+ if not isBlank(getObject(st)):
+ uri = getObject(st)
+ superclasses |= set([uri])
+
+ if len(superclasses) > 0:
+ doc += "\n<tr><th>Subclass of</th>"
+ first = True
+ for superclass in sorted(superclasses):
+ doc += getProperty(getTermLink(superclass), first)
+ first = False
+
+ # Find subclasses
+ subclasses = set()
+ for st in findStatements(m, None, rdfs.subClassOf, term):
+ if not isBlank(getObject(st)):
+ uri = getSubject(st)
+ subclasses |= set([uri])
+
+ if len(subclasses) > 0:
+ doc += "\n<tr><th>Superclass of</th>"
+ first = True
+ for superclass in sorted(subclasses):
+ doc += getProperty(getTermLink(superclass), first)
+ first = False
# Find out about properties which have rdfs:domain of t
d = classdomains.get(str(term), "")
if d:
- dlist = ''
+ dlist = ""
first = True
- for k in d:
+ for k in sorted(d):
dlist += getProperty(getTermLink(k), first)
first = False
doc += "<tr><th>In domain of</th>%s" % dlist
@@ -518,9 +619,9 @@ def rdfsClassInfo(term, m):
# Find out about properties which have rdfs:range of t
r = classranges.get(str(term), "")
if r:
- rlist = ''
+ rlist = ""
first = True
- for k in r:
+ for k in sorted(r):
rlist += getProperty(getTermLink(k), first)
first = False
doc += "<tr><th>In range of</th>%s" % rlist
@@ -529,30 +630,45 @@ def rdfsClassInfo(term, m):
def isSpecial(pred):
- """Return True if the predicate is "special" and shouldn't be emitted generically"""
- return pred in [rdf.type, rdfs.range, rdfs.domain, rdfs.label, rdfs.comment, rdfs.subClassOf, rdfs.subPropertyOf, lv2.documentation]
+ """Return True if `pred` shouldn't be documented generically"""
+ return pred in [
+ rdf.type,
+ rdfs.range,
+ rdfs.domain,
+ rdfs.label,
+ rdfs.comment,
+ rdfs.subClassOf,
+ rdfs.subPropertyOf,
+ lv2.documentation,
+ owl.withRestrictions,
+ ]
def blankNodeDesc(node, m):
properties = findStatements(m, node, None, None)
- doc = ''
- last_pred = ''
- for p in properties:
+ doc = ""
+ for p in sorted(properties):
if isSpecial(getPredicate(p)):
continue
- doc += '<tr>'
+ doc += "<tr>"
doc += '<td class="blankterm">%s</td>\n' % getTermLink(getPredicate(p))
if isResource(getObject(p)):
doc += '<td class="blankdef">%s</td>\n' % getTermLink(getObject(p))
# getTermLink(str(getObject(p)), node, getPredicate(p))
elif isLiteral(getObject(p)):
- doc += '<td class="blankdef">%s</td>\n' % getLiteralString(getObject(p))
+ doc += '<td class="blankdef">%s</td>\n' % getLiteralString(
+ getObject(p)
+ )
elif isBlank(getObject(p)):
- doc += '<td class="blankdef">' + blankNodeDesc(getObject(p), m) + '</td>\n'
+ doc += (
+ '<td class="blankdef">'
+ + blankNodeDesc(getObject(p), m)
+ + "</td>\n"
+ )
else:
doc += '<td class="blankdef">?</td>\n'
- doc += '</tr>'
- if doc != '':
+ doc += "</tr>"
+ if doc != "":
doc = '<table class="blankdesc">\n%s\n</table>\n' % doc
return doc
@@ -561,27 +677,25 @@ def extraInfo(term, m):
"""Generate information about misc. properties of a term"""
doc = ""
properties = findStatements(m, term, None, None)
- last_pred = None
first = True
- for p in properties:
+ for p in sorted(properties):
if isSpecial(getPredicate(p)):
- last_pred = None
continue
- if getPredicate(p) != last_pred:
- doc += '<tr><th>%s</th>\n' % getTermLink(getPredicate(p))
- first = True
+ doc += "<tr><th>%s</th>\n" % getTermLink(getPredicate(p))
if isResource(getObject(p)):
- doc += getProperty(getTermLink(getObject(p), term, getPredicate(p)), first)
+ doc += getProperty(
+ getTermLink(getObject(p), term, getPredicate(p)), first
+ )
elif isLiteral(getObject(p)):
- doc += getProperty(linkify(str(getObject(p))), first)
+ doc += getProperty(
+ linkifyCodeIdentifiers(str(getObject(p))), first
+ )
elif isBlank(getObject(p)):
doc += getProperty(str(blankNodeDesc(getObject(p), m)), first)
else:
- doc += getProperty('?', first)
- first = False
- last_pred = getPredicate(p)
+ doc += getProperty("?", first)
- #doc += endProperties(first)
+ # doc += endProperties(first)
return doc
@@ -590,16 +704,20 @@ def rdfsInstanceInfo(term, m):
"""Generate rdfs-type information for instances"""
doc = ""
+ label = getLabel(m, term)
+ if label != "":
+ doc += "<tr><th>Label</th><td>%s</td></tr>" % label
+
first = True
- for match in findStatements(m, term, rdf.type, None):
- doc += getProperty(getTermLink(getObject(match),
- term,
- rdf.type),
- first)
+ types = ""
+ for match in sorted(findStatements(m, term, rdf.type, None)):
+ types += getProperty(
+ getTermLink(getObject(match), term, rdf.type), first
+ )
first = False
- if doc != "":
- doc = "<tr><th>Type</th>" + doc
+ if types != "":
+ doc += "<tr><th>Type</th>" + types
doc += endProperties(first)
@@ -608,7 +726,7 @@ def rdfsInstanceInfo(term, m):
def owlInfo(term, m):
"""Returns an extra information that is defined about a term using OWL."""
- res = ''
+ res = ""
# Inverse properties ( owl:inverseOf )
first = True
@@ -621,78 +739,81 @@ def owlInfo(term, m):
def owlTypeInfo(term, propertyType, name):
if findOne(m, term, rdf.type, propertyType):
- return "<tr><th>OWL Type</th><td>%s</td></tr>\n" % name
+ return "<tr><th>Type</th><td>%s</td></tr>\n" % name
else:
return ""
res += owlTypeInfo(term, owl.DatatypeProperty, "Datatype Property")
res += owlTypeInfo(term, owl.ObjectProperty, "Object Property")
res += owlTypeInfo(term, owl.AnnotationProperty, "Annotation Property")
- res += owlTypeInfo(term, owl.InverseFunctionalProperty, "Inverse Functional Property")
+ res += owlTypeInfo(
+ term, owl.InverseFunctionalProperty, "Inverse Functional Property"
+ )
res += owlTypeInfo(term, owl.SymmetricProperty, "Symmetric Property")
return res
+def isDeprecated(m, subject):
+ deprecated = findOne(m, subject, owl.deprecated, None)
+ return deprecated and (str(deprecated[2]).find("true") >= 0)
+
+
def docTerms(category, list, m, classlist, proplist, instalist):
"""
A wrapper class for listing all the terms in a specific class (either
Properties, or Classes. Category is 'Property' or 'Class', list is a
- list of term names (strings), return value is a chunk of HTML.
+ list of term URI strings, return value is a chunk of HTML.
"""
doc = ""
- nspre = spec_pre
- for item in list:
- t = termName(m, item)
- if (t.startswith(spec_ns_str)) and (
- len(t[len(spec_ns_str):].split("/")) < 2):
- term = t
- t = t.split(spec_ns_str[-1])[1]
- curie = "%s:%s" % (nspre, t)
- else:
- if t.startswith("http://"):
- term = t
- curie = getShortName(t)
- t = getAnchor(t)
- else:
- term = spec_ns[t]
- curie = "%s:%s" % (nspre, t)
-
- term_uri = term
+ for term in list:
+ if not term.startswith(spec_ns_str):
+ sys.stderr.write("warning: Skipping external term `%s'" % term)
+ continue
- doc += """<div class="specterm" id="%s" about="%s">\n<h3>%s <a href="#%s">%s</a></h3>\n""" % (t, term_uri, category, getAnchor(str(term_uri)), curie)
+ t = termName(m, term)
+ curie = term.split(spec_ns_str[-1])[1]
+ doc += '<div class="specterm" id="%s" about="%s">' % (t, term)
+ doc += '<h3><a href="#%s">%s</a></h3>' % (getAnchor(term), curie)
+ doc += '<span class="spectermtype">%s</span>' % category
- label = getLabel(m, term)
- comment = getComment(m, term, classlist, proplist, instalist)
+ comment = getFullDocumentation(m, term, classlist, proplist, instalist)
+ is_deprecated = isDeprecated(m, term)
doc += '<div class="spectermbody">'
- if label != '' or comment != '':
- doc += '<div class="description">'
-
- if label != '':
- doc += "<div property=\"rdfs:label\" class=\"label\">%s</div>" % label
-
- if comment != '':
- doc += "<div property=\"rdfs:comment\">%s</div>" % comment
-
- if label != '' or comment != '':
- doc += "</div>"
terminfo = ""
- if category == 'Property':
- terminfo += owlInfo(term, m)
+ extrainfo = ""
+ if category == "Property":
terminfo += rdfsPropertyInfo(term, m)
- if category == 'Class':
+ terminfo += owlInfo(term, m)
+ if category == "Class":
terminfo += rdfsClassInfo(term, m)
- if category == 'Instance':
+ extrainfo += owlRestrictionInfo(term, m)
+ if category == "Instance":
terminfo += rdfsInstanceInfo(term, m)
terminfo += extraInfo(term, m)
- if (len(terminfo) > 0): # to prevent empty list (bug #882)
+ if len(terminfo) > 0: # to prevent empty list (bug #882)
doc += '\n<table class="terminfo">%s</table>\n' % terminfo
- doc += '</div>'
+ doc += '<div class="description">'
+
+ if is_deprecated:
+ doc += '<div class="warning">Deprecated</div>'
+
+ if comment != "":
+ doc += (
+ '<div class="comment" property="rdfs:comment">%s</div>'
+ % comment
+ )
+
+ doc += extrainfo
+
+ doc += "</div>"
+
+ doc += "</div>"
doc += "\n</div>\n\n"
return doc
@@ -700,7 +821,7 @@ def docTerms(category, list, m, classlist, proplist, instalist):
def getShortName(uri):
uri = str(uri)
- if ("#" in uri):
+ if "#" in uri:
return uri.split("#")[-1]
else:
return uri.split("/")[-1]
@@ -708,29 +829,31 @@ def getShortName(uri):
def getAnchor(uri):
uri = str(uri)
- if (uri.startswith(spec_ns_str)):
- return uri[len(spec_ns_str):].replace("/", "_")
+ if uri.startswith(spec_ns_str):
+ return uri[len(spec_ns_str) :].replace("/", "_")
else:
return getShortName(uri)
def buildIndex(m, classlist, proplist, instalist=None):
- """
- Builds the A-Z list of terms. Args are a list of classes (strings) and
- a list of props (strings)
- """
+ if not (classlist or proplist or instalist):
+ return ""
- if len(classlist) == 0 and len(proplist) == 0 and (
- not instalist or len(instalist) == 0):
- return ''
+ head = ""
+ body = ""
- azlist = '<dl class="index">'
+ def termLink(m, t):
+ if str(t).startswith(spec_ns_str):
+ name = termName(m, t)
+ return '<a href="#%s">%s</a>' % (name, name)
+ else:
+ return '<a href="%s">%s</a>' % (str(t), str(t))
- if (len(classlist) > 0):
- azlist += "<dt>Classes</dt><dd><ul>"
- classlist.sort()
+ if len(classlist) > 0:
+ head += '<th><a href="#ref-classes" />Classes</th>'
+ body += "<td><ul>"
shown = {}
- for c in classlist:
+ for c in sorted(classlist):
if c in shown:
continue
@@ -738,65 +861,66 @@ def buildIndex(m, classlist, proplist, instalist=None):
local_subclass = False
for p in findStatements(m, c, rdfs.subClassOf, None):
parent = str(p[2])
- if parent[0:len(spec_ns_str)] == spec_ns_str:
+ if parent[0 : len(spec_ns_str)] == spec_ns_str:
local_subclass = True
if local_subclass:
continue
shown[c] = True
- name = termName(m, c)
- if name.startswith(spec_ns_str):
- name = name.split(spec_ns_str[-1])[1]
- azlist += '<li><a href="#%s">%s</a>' % (name, name)
+ body += "<li>" + termLink(m, c)
+
def class_tree(c):
- tree = ''
+ tree = ""
shown[c] = True
subclasses = []
for s in findStatements(m, None, rdfs.subClassOf, c):
subclasses += [getSubject(s)]
- subclasses.sort()
- for s in subclasses:
- s_name = termName(m, s)
- tree += '<li><a href="#%s">%s</a>\n' % (s_name, s_name)
+ for s in sorted(subclasses):
+ tree += "<li>" + termLink(m, s)
tree += class_tree(s)
- tree += '</li>'
- if tree != '':
- tree = '<ul>' + tree + '</ul>'
+ tree += "</li>"
+ if tree != "":
+ tree = "<ul>" + tree + "</ul>"
return tree
- azlist += class_tree(c)
- azlist += '</li>'
- azlist += '</ul></dd>\n'
-
- if (len(proplist) > 0):
- azlist += "<dt>Properties</dt><dd>"
- proplist.sort()
- props = []
- for p in proplist:
- name = termName(m, p)
- if name.startswith(spec_ns_str):
- name = name.split(spec_ns_str[-1])[1]
- props += ['<a href="#%s">%s</a>' % (name, name)]
- azlist += ', '.join(props) + '</dd>\n'
-
- if (instalist != None and len(instalist) > 0):
- azlist += "<dt>Instances</dt><dd>"
- instas = []
- for i in instalist:
+
+ body += class_tree(c)
+ body += "</li>"
+ body += "</ul></td>\n"
+
+ if len(proplist) > 0:
+ head += '<th><a href="#ref-properties" />Properties</th>'
+ body += "<td><ul>"
+ for p in sorted(proplist):
+ body += "<li>%s</li>" % termLink(m, p)
+ body += "</ul></td>\n"
+
+ if instalist is not None and len(instalist) > 0:
+ head += '<th><a href="#ref-instances" />Instances</th>'
+ body += "<td><ul>"
+ for i in sorted(instalist):
p = getShortName(i)
anchor = getAnchor(i)
- instas += ['<a href="#%s">%s</a>' % (anchor, p)]
- azlist += ', '.join(instas) + '</dd>\n'
+ body += '<li><a href="#%s">%s</a></li>' % (anchor, p)
+ body += "</ul></td>\n"
+
+ if head and body:
+ return """<table class="index">
+<thead><tr>%s</tr></thead>
+<tbody><tr>%s</tr></tbody></table>
+""" % (
+ head,
+ body,
+ )
- azlist += '\n</dl>'
- return azlist
+ return ""
def add(where, key, value):
- if not key in where:
+ if key not in where:
where[key] = []
- if not value in where[key]:
+ if value not in where[key]:
where[key].append(value)
@@ -814,23 +938,36 @@ def specInformation(m, ns):
classlist = []
for onetype in classtypes:
for classStatement in findStatements(m, None, rdf.type, onetype):
- for range in findStatements(m, None, rdfs.range, getSubject(classStatement)):
+ for range in findStatements(
+ m, None, rdfs.range, getSubject(classStatement)
+ ):
if not isBlank(getSubject(classStatement)):
- add(classranges,
+ add(
+ classranges,
str(getSubject(classStatement)),
- str(getSubject(range)))
- for domain in findStatements(m, None, rdfs.domain, getSubject(classStatement)):
+ str(getSubject(range)),
+ )
+ for domain in findStatements(
+ m, None, rdfs.domain, getSubject(classStatement)
+ ):
if not isBlank(getSubject(classStatement)):
- add(classdomains,
+ add(
+ classdomains,
str(getSubject(classStatement)),
- str(getSubject(domain)))
+ str(getSubject(domain)),
+ )
if not isBlank(getSubject(classStatement)):
klass = getSubject(classStatement)
if klass not in classlist and str(klass).startswith(ns):
classlist.append(klass)
# Create a list of properties in the schema.
- proptypes = [rdf.Property, owl.ObjectProperty, owl.DatatypeProperty, owl.AnnotationProperty]
+ proptypes = [
+ rdf.Property,
+ owl.ObjectProperty,
+ owl.DatatypeProperty,
+ owl.AnnotationProperty,
+ ]
proplist = []
for onetype in proptypes:
for propertyStatement in findStatements(m, None, rdf.type, onetype):
@@ -845,7 +982,7 @@ def specProperty(m, subject, predicate):
"Return a property of the spec."
for c in findStatements(m, subject, predicate, None):
return getLiteralString(getObject(c))
- return ''
+ return ""
def specProperties(m, subject, predicate):
@@ -858,94 +995,136 @@ def specProperties(m, subject, predicate):
def specAuthors(m, subject):
"Return an HTML description of the authors of the spec."
+
+ subjects = [subject]
+ p = findOne(m, subject, lv2.project, None)
+ if p:
+ subjects += [getObject(p)]
+
dev = set()
- for i in findStatements(m, subject, doap.developer, None):
- for j in findStatements(m, getObject(i), foaf.name, None):
- dev.add(getLiteralString(getObject(j)))
+ for s in subjects:
+ for i in findStatements(m, s, doap.developer, None):
+ for j in findStatements(m, getObject(i), foaf.name, None):
+ dev.add(getLiteralString(getObject(j)))
maint = set()
- for i in findStatements(m, subject, doap.maintainer, None):
- for j in findStatements(m, getObject(i), foaf.name, None):
- maint.add(getLiteralString(getObject(j)))
+ for s in subjects:
+ for i in findStatements(m, s, doap.maintainer, None):
+ for j in findStatements(m, getObject(i), foaf.name, None):
+ maint.add(getLiteralString(getObject(j)))
- doc = ''
+ doc = ""
- devdoc = ''
+ devdoc = ""
first = True
- for d in dev:
+ for d in sorted(dev):
if not first:
- devdoc += ', '
- devdoc += '<span class="author" property="doap:developer">%s</span>' % d
+ devdoc += ", "
+ devdoc += (
+ '<span class="author" property="doap:developer">%s</span>' % d
+ )
first = False
if len(dev) == 1:
- doc += '<tr><th class="metahead">Developer</th><td>%s</td></tr>' % devdoc
+ doc += (
+ '<tr><th class="metahead">Developer</th><td>%s</td></tr>' % devdoc
+ )
elif len(dev) > 0:
- doc += '<tr><th class="metahead">Developers</th><td>%s</td></tr>' % devdoc
+ doc += (
+ '<tr><th class="metahead">Developers</th><td>%s</td></tr>' % devdoc
+ )
- maintdoc = ''
+ maintdoc = ""
first = True
- for m in maint:
+ for m in sorted(maint):
if not first:
- maintdoc += ', '
- maintdoc += '<span class="author" property="doap:maintainer">%s</span>' % m
+ maintdoc += ", "
+ maintdoc += (
+ '<span class="author" property="doap:maintainer">%s</span>' % m
+ )
first = False
if len(maint) == 1:
- doc += '<tr><th class="metahead">Maintainer</th><td>%s</td></tr>' % maintdoc
+ doc += (
+ '<tr><th class="metahead">Maintainer</th><td>%s</td></tr>'
+ % maintdoc
+ )
elif len(maint) > 0:
- doc += '<tr><th class="metahead">Maintainers</th><td>%s</td></tr>' % maintdoc
+ doc += (
+ '<tr><th class="metahead">Maintainers</th><td>%s</td></tr>'
+ % maintdoc
+ )
return doc
-def specHistory(m, subject):
- entries = {}
+def releaseChangeset(m, release, prefix=""):
+ changeset = findOne(m, release, dcs.changeset, None)
+ if changeset is None:
+ return ""
+
+ entry = ""
+ # entry = '<dd><ul>\n'
+ for i in sorted(findStatements(m, getObject(changeset), dcs.item, None)):
+ item = getObject(i)
+ label = findOne(m, item, rdfs.label, None)
+ if not label:
+ print("error: dcs:item has no rdfs:label")
+ continue
+
+ text = getLiteralString(getObject(label))
+ if prefix:
+ text = prefix + ": " + text
+
+ entry += "<li>%s</li>\n" % text
+
+ # entry += '</ul></dd>\n'
+ return entry
+
+
+def specHistoryEntries(m, subject, entries):
for r in findStatements(m, subject, doap.release, None):
release = getObject(r)
revNode = findOne(m, release, doap.revision, None)
if not revNode:
- print "error: doap:release has no doap:revision"
+ print("error: doap:release has no doap:revision")
continue
rev = getLiteralString(getObject(revNode))
created = findOne(m, release, doap.created, None)
- dist = findOne(m, release, doap['file-release'], None)
+ dist = findOne(m, release, doap["file-release"], None)
if dist:
entry = '<dt><a href="%s">Version %s</a>' % (getObject(dist), rev)
else:
- entry = '<dt>Version %s' % rev
- #print "warning: doap:release has no doap:file-release"
+ entry = "<dt>Version %s" % rev
+ # print("warning: doap:release has no doap:file-release")
if created:
- entry += ' (%s)</dt>' % getLiteralString(getObject(created))
+ entry += " (%s)</dt>\n" % getLiteralString(getObject(created))
else:
entry += ' (<span class="warning">EXPERIMENTAL</span>)</dt>'
- changeset = findOne(m, release, dcs.changeset, None)
- if changeset:
- entry += '<dd><ul>'
- for i in findStatements(m, getObject(changeset), dcs.item, None):
- item = getObject(i)
- label = findOne(m, item, rdfs.label, None)
- if not label:
- print "error: dcs:item has no rdfs:label"
- continue
+ entry += "<dd><ul>\n%s" % releaseChangeset(m, release)
- entry += '<li>%s</li>' % getLiteralString(getObject(label))
+ if dist is not None:
+ entries[(getObject(created), getObject(dist))] = entry
- entry += '</ul></dd>\n'
+ return entries
- entries[rev] = entry
+def specHistoryMarkup(entries):
if len(entries) > 0:
- history = '<dl>'
+ history = "<dl>\n"
for e in sorted(entries.keys(), reverse=True):
- history += entries[e]
- history += '</dl>'
+ history += entries[e] + "</ul></dd>"
+ history += "</dl>\n"
return history
else:
- return ''
+ return ""
+
+
+def specHistory(m, subject):
+ return specHistoryMarkup(specHistoryEntries(m, subject, {}))
def specVersion(m, subject):
@@ -962,7 +1141,7 @@ def specVersion(m, subject):
latest_doap_revision = revision
latest_doap_release = getObject(i)
date = ""
- if latest_doap_release != None:
+ if latest_doap_release is not None:
for i in findStatements(m, latest_doap_release, doap.created, None):
date = getLiteralString(getObject(i))
@@ -990,16 +1169,19 @@ def getInstances(model, classes, properties):
if inst not in instances and str(inst) != spec_url:
instances.append(inst)
for i in findStatements(model, None, rdf.type, None):
- if ((not isResource(getSubject(i)))
+ if (
+ (not isResource(getSubject(i)))
or (getSubject(i) in classes)
or (getSubject(i) in instances)
- or (getSubject(i) in properties)):
+ or (getSubject(i) in properties)
+ ):
continue
full_uri = str(getSubject(i))
- if (full_uri.startswith(spec_ns_str)):
+ if full_uri.startswith(spec_ns_str):
instances.append(getSubject(i))
return instances
+
def load_tags(path, docdir):
"Build a (symbol => URI) map from a Doxygen tag file."
@@ -1009,45 +1191,175 @@ def load_tags(path, docdir):
def getChildText(elt, tagname):
"Return the content of the first child node with a certain tag name."
for e in elt.childNodes:
- if e.nodeType == xml.dom.Node.ELEMENT_NODE and e.tagName == tagname:
+ if (
+ e.nodeType == xml.dom.Node.ELEMENT_NODE
+ and e.tagName == tagname
+ ):
return e.firstChild.nodeValue
- return ''
-
- def linkTo(sym, url):
- return '<span><a href="%s/%s">%s</a></span>' % (docdir, url, sym)
-
- tagdoc = xml.dom.minidom.parse(path)
- root = tagdoc.documentElement
+ return ""
+
+ def linkTo(filename, anchor, sym):
+ if anchor:
+ return '<span><a href="%s/%s#%s">%s</a></span>' % (
+ docdir,
+ filename,
+ anchor,
+ sym,
+ )
+ else:
+ return '<span><a href="%s/%s">%s</a></span>' % (
+ docdir,
+ filename,
+ sym,
+ )
+
+ tagdoc = xml.dom.minidom.parse(path)
+ root = tagdoc.documentElement
linkmap = {}
for cn in root.childNodes:
- if (cn.nodeType == xml.dom.Node.ELEMENT_NODE
- and cn.tagName == 'compound'
- and cn.getAttribute('kind') != 'page'):
+ if (
+ cn.nodeType == xml.dom.Node.ELEMENT_NODE
+ and cn.tagName == "compound"
+ and cn.getAttribute("kind") != "page"
+ ):
+
+ name = getChildText(cn, "name")
+ filename = getChildText(cn, "filename")
+ anchor = getChildText(cn, "anchor")
+ if not filename.endswith(".html"):
+ filename += ".html"
+
+ if cn.getAttribute("kind") != "group":
+ linkmap[name] = linkTo(filename, anchor, name)
+
+ prefix = ""
+ if cn.getAttribute("kind") == "struct":
+ prefix = name + "::"
+
+ members = cn.getElementsByTagName("member")
+ for m in members:
+ mname = prefix + getChildText(m, "name")
+ mafile = getChildText(m, "anchorfile")
+ manchor = getChildText(m, "anchor")
+ linkmap[mname] = linkTo(mafile, manchor, mname)
- name = getChildText(cn, 'name')
- filename = getChildText(cn, 'filename')
- if not filename.endswith('.html'):
- filename += '.html'
+ return linkmap
- linkmap[name] = linkTo(name, filename)
- prefix = ''
- if cn.getAttribute('kind') != 'file':
- prefix = name + '::'
+def writeIndex(model, specloc, index_path, root_path, root_uri):
+ # Get extension URI
+ ext_node = model.value(None, rdf.type, lv2.Specification)
+ if not ext_node:
+ ext_node = model.value(None, rdf.type, owl.Ontology)
+ if not ext_node:
+ print("no extension found in %s" % bundle)
+ sys.exit(1)
- members = cn.getElementsByTagName('member')
- for m in members:
- mname = prefix + getChildText(m, 'name')
- mafile = getChildText(m, 'anchorfile')
- manchor = getChildText(m, 'anchor')
- linkmap[mname] = linkTo(
- mname, '%s#%s' % (mafile, manchor))
+ ext = str(ext_node)
- return linkmap
+ # Get version
+ minor = 0
+ micro = 0
+ try:
+ minor = int(model.value(ext_node, lv2.minorVersion, None))
+ micro = int(model.value(ext_node, lv2.microVersion, None))
+ except Exception:
+ print("warning: %s: failed to find version for %s" % (bundle, ext))
+
+ # Get date
+ date = None
+ for r in model.triples([ext_node, doap.release, None]):
+ revision = model.value(r[2], doap.revision, None)
+ if str(revision) == ("%d.%d" % (minor, micro)):
+ date = model.value(r[2], doap.created, None)
+ break
+
+ # Verify that this date is the latest
+ for r in model.triples([ext_node, doap.release, None]):
+ this_date = model.value(r[2], doap.created, None)
+ if this_date > date:
+ print(
+ "warning: %s revision %d.%d (%s) is not the latest release"
+ % (ext_node, minor, micro, date)
+ )
+ break
+
+ # Get name and short description
+ name = model.value(ext_node, doap.name, None)
+ shortdesc = model.value(ext_node, doap.shortdesc, None)
+
+ # Chop 'LV2' prefix from name for cleaner index
+ if name.startswith("LV2 "):
+ name = name[4:]
+
+ # Find relative link target
+ if root_uri and ext_node.startswith(root_uri):
+ target = ext_node[len(root_uri) :] + ".html"
+ else:
+ target = os.path.relpath(ext_node, root_path) + ".html"
+
+ stem = os.path.splitext(os.path.basename(target))[0]
+
+ # Specification (comment is to act as a sort key)
+ row = '<tr><!-- %s --><td><a rel="rdfs:seeAlso" href="%s">%s</a></td>' % (
+ b,
+ target,
+ name,
+ )
+
+ # API
+ row += "<td>"
+ row += '<a rel="rdfs:seeAlso" href="../doc/html/group__%s.html">%s</a>' % (
+ stem,
+ name,
+ )
+ row += "</td>"
+
+ # Description
+ if shortdesc:
+ row += "<td>" + str(shortdesc) + "</td>"
+ else:
+ row += "<td></td>"
-def specgen(specloc, indir, style_uri, docdir, tags, instances=False, offline=False):
+ # Version
+ version_str = "%s.%s" % (minor, micro)
+ if minor == 0 or (micro % 2 != 0):
+ row += '<td><span style="color: red">' + version_str + "</span></td>"
+ else:
+ row += "<td>" + version_str + "</td>"
+
+ # Status
+ deprecated = model.value(ext_node, owl.deprecated, None)
+ if minor == 0:
+ row += '<td><span class="error">Experimental</span></td>'
+ elif deprecated and str(deprecated[2]) != "false":
+ row += '<td><span class="warning">Deprecated</span></td>'
+ elif micro % 2 == 0:
+ row += '<td><span class="success">Stable</span></td>'
+
+ row += "</tr>"
+
+ index = open(index_path, "w")
+ index.write(row)
+ index.close()
+
+
+def specgen(
+ specloc,
+ indir,
+ style_uri,
+ docdir,
+ tags,
+ opts,
+ instances=False,
+ root_link=None,
+ index_path=None,
+ root_path=None,
+ root_uri=None,
+):
"""The meat and potatoes: Everything starts here."""
+ global spec_bundle
global spec_url
global spec_ns_str
global spec_ns
@@ -1056,6 +1368,7 @@ def specgen(specloc, indir, style_uri, docdir, tags, instances=False, offline=Fa
global specgendir
global linkmap
+ spec_bundle = "file://%s/" % os.path.abspath(os.path.dirname(specloc))
specgendir = os.path.abspath(indir)
# Template
@@ -1063,53 +1376,62 @@ def specgen(specloc, indir, style_uri, docdir, tags, instances=False, offline=Fa
template = None
f = open(temploc, "r")
template = f.read()
+ f.close()
# Load code documentation link map from tags file
linkmap = load_tags(tags, docdir)
m = rdflib.ConjunctiveGraph()
- manifest_path = os.path.join(os.path.dirname(specloc), 'manifest.ttl')
+ manifest_path = os.path.join(os.path.dirname(specloc), "manifest.ttl")
if os.path.exists(manifest_path):
- m.parse(manifest_path, format='n3')
- m.parse(specloc, format='n3')
+ m.parse(manifest_path, format="n3")
+ m.parse(specloc, format="n3")
- bundle_path = os.path.split(specloc[specloc.find(':') + 1:])[0]
- abs_bundle_path = os.path.abspath(bundle_path)
spec_url = getOntologyNS(m)
spec = rdflib.URIRef(spec_url)
- # Parse all seeAlso files in the bundle
- for uri in specProperties(m, spec, rdfs.seeAlso):
- if uri[:7] == 'file://':
- path = uri[7:]
- if (path != os.path.abspath(specloc)
- and path.endswith('.ttl')):
- m.parse(path, format='n3')
+ # Load all seeAlso files recursively
+ seeAlso = set()
+ done = False
+ while not done:
+ done = True
+ for uri in specProperties(m, spec, rdfs.seeAlso):
+ if uri[:7] == "file://":
+ path = uri[7:]
+ if (
+ path != os.path.abspath(specloc)
+ and path.endswith("ttl")
+ and path not in seeAlso
+ ):
+ seeAlso.add(path)
+ m.parse(path, format="n3")
+ done = False
spec_ns_str = spec_url
- if (spec_ns_str[-1] != "/" and spec_ns_str[-1] != "#"):
+ if spec_ns_str[-1] != "/" and spec_ns_str[-1] != "#":
spec_ns_str += "#"
spec_ns = rdflib.Namespace(spec_ns_str)
namespaces = getNamespaces(m)
- keys = namespaces.keys()
- keys.sort()
+ keys = sorted(namespaces.keys())
prefixes_html = "<span>"
for i in keys:
uri = namespaces[i]
- if uri.startswith('file:'):
- continue;
+ if uri.startswith("file:"):
+ continue
ns_list[str(uri)] = i
- if (str(uri) == spec_url + '#' or
- str(uri) == spec_url + '/' or
- str(uri) == spec_url):
+ if (
+ str(uri) == spec_url + "#"
+ or str(uri) == spec_url + "/"
+ or str(uri) == spec_url
+ ):
spec_pre = i
prefixes_html += '<a href="%s">%s</a> ' % (uri, i)
prefixes_html += "</span>"
if spec_pre is None:
- print('No namespace prefix for %s defined' % specloc)
+ print("No namespace prefix for %s defined" % specloc)
sys.exit(1)
ns_list[spec_ns_str] = spec_pre
@@ -1120,94 +1442,134 @@ def specgen(specloc, indir, style_uri, docdir, tags, instances=False, offline=Fa
instalist = None
if instances:
- instalist = getInstances(m, classlist, proplist)
- instalist.sort(lambda x, y: cmp(getShortName(x).lower(), getShortName(y).lower()))
+ instalist = sorted(
+ getInstances(m, classlist, proplist),
+ key=lambda x: getShortName(x).lower(),
+ )
azlist = buildIndex(m, classlist, proplist, instalist)
# Generate Term HTML
- termlist = docTerms('Property', proplist, m, classlist, proplist, instalist)
- termlist = docTerms('Class', classlist, m, classlist, proplist, instalist) + termlist
+ classlist = docTerms("Class", classlist, m, classlist, proplist, instalist)
+ proplist = docTerms(
+ "Property", proplist, m, classlist, proplist, instalist
+ )
if instances:
- termlist += docTerms('Instance', instalist, m, classlist, proplist, instalist)
-
- template = template.replace('@NAME@', specProperty(m, spec, doap.name))
- template = template.replace('@SUBTITLE@', specProperty(m, spec, doap.shortdesc))
- template = template.replace('@URI@', spec)
- template = template.replace('@PREFIX@', spec_pre)
- if spec_pre == 'lv2':
- template = template.replace('@XMLNS@', '')
+ instlist = docTerms(
+ "Instance", instalist, m, classlist, proplist, instalist
+ )
+
+ termlist = ""
+ if classlist:
+ termlist += '<div class="section">'
+ termlist += '<h2><a id="ref-classes" />Classes</h2>' + classlist
+ termlist += "</div>"
+
+ if proplist:
+ termlist += '<div class="section">'
+ termlist += '<h2><a id="ref-properties" />Properties</h2>' + proplist
+ termlist += "</div>"
+
+ if instlist:
+ termlist += '<div class="section">'
+ termlist += '<h2><a id="ref-instances" />Instances</h2>' + instlist
+ termlist += "</div>"
+
+ name = specProperty(m, spec, doap.name)
+ title = name
+ if root_link:
+ name = '<a href="%s">%s</a>' % (root_link, name)
+
+ template = template.replace("@TITLE@", title)
+ template = template.replace("@NAME@", name)
+ template = template.replace(
+ "@SHORT_DESC@", specProperty(m, spec, doap.shortdesc)
+ )
+ template = template.replace("@URI@", spec)
+ template = template.replace("@PREFIX@", spec_pre)
+ if spec_pre == "lv2":
+ template = template.replace("@XMLNS@", "")
else:
- template = template.replace('@XMLNS@', ' xmlns:%s="%s"' % (spec_pre, spec_ns_str))
+ template = template.replace(
+ "@XMLNS@", ' xmlns:%s="%s"' % (spec_pre, spec_ns_str)
+ )
filename = os.path.basename(specloc)
- basename = filename[0:filename.rfind('.')]
-
- template = template.replace('@STYLE_URI@', style_uri)
- template = template.replace('@PREFIXES@', str(prefixes_html))
- template = template.replace('@BASE@', spec_ns_str)
- template = template.replace('@AUTHORS@', specAuthors(m, spec))
- template = template.replace('@INDEX@', azlist)
- template = template.replace('@REFERENCE@', termlist)
- template = template.replace('@FILENAME@', filename)
- template = template.replace('@HEADER@', basename + '.h')
- template = template.replace('@MAIL@', 'devel@lists.lv2plug.in')
- template = template.replace('@HISTORY@', specHistory(m, spec))
+ basename = filename[0 : filename.rfind(".")]
+
+ template = template.replace("@STYLE_URI@", style_uri)
+ template = template.replace("@PREFIXES@", str(prefixes_html))
+ template = template.replace("@BASE@", spec_ns_str)
+ template = template.replace("@AUTHORS@", specAuthors(m, spec))
+ template = template.replace("@INDEX@", azlist)
+ template = template.replace("@REFERENCE@", termlist)
+ template = template.replace("@FILENAME@", filename)
+ template = template.replace("@HEADER@", basename + ".h")
+ template = template.replace("@HISTORY@", specHistory(m, spec))
+
+ mail_row = ""
+ if "list_email" in opts:
+ mail_row = '<tr><th>Discuss</th><td><a href="mailto:%s">%s</a>' % (
+ opts["list_email"],
+ opts["list_email"],
+ )
+ if "list_page" in opts:
+ mail_row += ' <a href="%s">(subscribe)</a>' % opts["list_page"]
+ mail_row += "</td></tr>"
+ template = template.replace("@MAIL@", mail_row)
version = specVersion(m, spec) # (minor, micro, date)
date_string = version[2]
if date_string == "":
date_string = "Undated"
- version_string = "%s.%s (%s)" % (version[0], version[1], date_string)
- experimental = (version[0] == 0 or version[1] % 2 == 1)
+ version_string = "%s.%s" % (version[0], version[1])
+ experimental = version[0] == 0 or version[1] % 2 == 1
if experimental:
version_string += ' <span class="warning">EXPERIMENTAL</span>'
- deprecated = findOne(m, rdflib.URIRef(spec_url), owl.deprecated, None)
- if deprecated and str(deprecated[2]).find("true") > 0:
+ if isDeprecated(m, rdflib.URIRef(spec_url)):
version_string += ' <span class="warning">DEPRECATED</span>'
- template = template.replace('@REVISION@', version_string)
+ template = template.replace("@VERSION@", version_string)
- file_list = ''
- see_also_files = specProperties(m, spec, rdfs.seeAlso)
- see_also_files.sort()
- for f in see_also_files:
- uri = str(f)
- if uri[:7] == 'file://':
- uri = uri[7:]
- if uri[:len(abs_bundle_path)] == abs_bundle_path:
- uri = uri[len(abs_bundle_path) + 1:]
- else:
- continue # Skip seeAlso file outside bundle
+ content_links = ""
+ if docdir is not None:
+ content_links = '<li><a href="%s">API</a></li>' % os.path.join(
+ docdir, "group__%s.html" % basename
+ )
+ template = template.replace("@CONTENT_LINKS@", content_links)
- if offline:
- entry = uri
- else:
- entry = '<a href="%s">%s</a>' % (uri, uri)
- if uri.endswith('.h') or uri.endswith('.hpp'):
- name = os.path.basename(uri)
- entry += ' - <a href="%s">Documentation</a> ' % (
- docdir + '/' + name.replace('.', '_8') + '.html')
- file_list += '<li>%s</li>' % entry
- else:
- file_list += '<li>%s</li>' % entry
+ docs = getDetailedDocumentation(
+ m, rdflib.URIRef(spec_url), classlist, proplist, instalist
+ )
+ template = template.replace("@DESCRIPTION@", docs)
- files = ''
- if file_list:
- files += '<li>Files<ul>%s</ul></li>' % file_list
+ now = int(os.environ.get("SOURCE_DATE_EPOCH", time.time()))
+ build_date = datetime.datetime.utcfromtimestamp(now)
+ template = template.replace("@DATE@", build_date.strftime("%F"))
+ template = template.replace("@TIME@", build_date.strftime("%F %H:%M UTC"))
- template = template.replace('@FILES@', files)
+ # Write index row
+ if index_path is not None:
+ writeIndex(m, specloc, index_path, root_path, root_uri)
- comment = getComment(m, rdflib.URIRef(spec_url), classlist, proplist, instalist)
- if comment != '':
- template = template.replace('@COMMENT@', comment)
- else:
- template = template.replace('@COMMENT@', '')
-
- template = template.replace('@TIME@', datetime.datetime.utcnow().strftime('%F %H:%M UTC'))
+ # Validate complete output page
+ try:
+ oldcwd = os.getcwd()
+ os.chdir(specgendir)
+ etree.fromstring(
+ template.replace(
+ '"http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd"',
+ '"DTD/xhtml-rdfa-1.dtd"',
+ ).encode("utf-8"),
+ etree.XMLParser(dtd_validation=True, no_network=True),
+ )
+ except Exception as e:
+ sys.stderr.write("error: Validation failed for %s: %s" % (specloc, e))
+ finally:
+ os.chdir(oldcwd)
return template
@@ -1215,7 +1577,7 @@ def specgen(specloc, indir, style_uri, docdir, tags, instances=False, offline=Fa
def save(path, text):
try:
f = open(path, "w")
- f.write(text.encode("utf-8"))
+ f.write(text)
f.flush()
f.close()
except Exception:
@@ -1227,7 +1589,7 @@ def getNamespaces(m):
"""Return a prefix:URI dictionary of all namespaces seen during parsing"""
nspaces = {}
for prefix, uri in m.namespaces():
- if not re.match('default[0-9]*', prefix) and not prefix == 'xml':
+ if not re.match("default[0-9]*", prefix) and not prefix == "xml":
# Skip silly default namespaces added by rdflib
nspaces[prefix] = uri
return nspaces
@@ -1242,7 +1604,7 @@ def getOntologyNS(m):
if not isBlank(getSubject(s)):
ns = str(getSubject(s))
- if (ns == None):
+ if ns is None:
sys.exit("Impossible to get ontology's namespace")
else:
return ns
@@ -1250,53 +1612,157 @@ def getOntologyNS(m):
def usage():
script = os.path.basename(sys.argv[0])
- print("""Usage: %s ONTOLOGY INDIR STYLE OUTPUT [DOCDIR TAGS] [FLAGS]
-
- ONTOLOGY : Path to ontology file
- INDIR : Input directory containing template.html and style.css
- STYLE : Stylesheet URI
- OUTPUT : HTML output path
- DOCDIR : Doxygen HTML directory
- TAGS : Doxygen tags file
-
- Optional flags:
- -i : Document class/property instances (disabled by default)
- -p PREFIX : Set ontology namespace prefix from command line
-
-Example:
- %s lv2_foos.ttl template.html style.css lv2_foos.html ../doc -i -p foos
-""" % (script, script))
- sys.exit(-1)
+ return "Usage: %s ONTOLOGY_TTL OUTPUT_HTML [OPTION]..." % script
if __name__ == "__main__":
"""Ontology specification generator tool"""
- args = sys.argv[1:]
- if (len(args) < 3):
- usage()
- else:
- ontology = "file:" + str(args[0])
- indir = args[1]
- style = args[2]
- output = args[3]
- docdir = None
- tags = None
- if len(args) > 5:
- docdir = args[4]
- tags = args[5]
-
- # Flags
- instances = False
- if len(args) > 6:
- flags = args[6:]
- i = 0
- while i < len(flags):
- if flags[i] == '-i':
- instances = True
- elif flags[i] == '-p':
- spec_pre = flags[i + 1]
- i += 1
- i += 1
-
- save(output, specgen(ontology, indir, style, docdir, tags, instances=instances))
+ indir = os.path.abspath(os.path.dirname(sys.argv[0]))
+ if not os.path.exists(os.path.join(indir, "template.html")):
+ indir = os.path.join(os.path.dirname(indir), "share", "lv2specgen")
+
+ opt = optparse.OptionParser(
+ usage=usage(),
+ description="Write HTML documentation for an RDF ontology.",
+ )
+ opt.add_option(
+ "--list-email",
+ type="string",
+ dest="list_email",
+ help="Mailing list email address",
+ )
+ opt.add_option(
+ "--list-page",
+ type="string",
+ dest="list_page",
+ help="Mailing list info page address",
+ )
+ opt.add_option(
+ "--template-dir",
+ type="string",
+ dest="template_dir",
+ default=indir,
+ help="Template directory",
+ )
+ opt.add_option(
+ "--style-uri",
+ type="string",
+ dest="style_uri",
+ default="style.css",
+ help="Stylesheet URI",
+ )
+ opt.add_option(
+ "--docdir",
+ type="string",
+ dest="docdir",
+ default=None,
+ help="Doxygen output directory",
+ )
+ opt.add_option(
+ "--index",
+ type="string",
+ dest="index_path",
+ default=None,
+ help="Index row output file",
+ )
+ opt.add_option(
+ "--tags",
+ type="string",
+ dest="tags",
+ default=None,
+ help="Doxygen tags file",
+ )
+ opt.add_option(
+ "-r",
+ "--root-path",
+ type="string",
+ dest="root_path",
+ default="",
+ help="Root path",
+ )
+ opt.add_option(
+ "-R",
+ "--root-uri",
+ type="string",
+ dest="root_uri",
+ default="",
+ help="Root URI",
+ )
+ opt.add_option(
+ "-p",
+ "--prefix",
+ type="string",
+ dest="prefix",
+ help="Specification Turtle prefix",
+ )
+ opt.add_option(
+ "-i",
+ "--instances",
+ action="store_true",
+ dest="instances",
+ help="Document instances",
+ )
+ opt.add_option(
+ "--copy-style",
+ action="store_true",
+ dest="copy_style",
+ help="Copy style from template directory to output directory",
+ )
+
+ (options, args) = opt.parse_args()
+ opts = vars(options)
+
+ if len(args) < 2:
+ opt.print_help()
+ sys.exit(-1)
+
+ spec_pre = options.prefix
+ ontology = "file:" + str(args[0])
+ output = args[1]
+ index_path = options.index_path
+ docdir = options.docdir
+ tags = options.tags
+
+ out = "."
+ spec = args[0]
+ path = os.path.dirname(spec)
+ outdir = os.path.abspath(os.path.join(out, path))
+
+ bundle = str(outdir)
+ b = os.path.basename(outdir)
+
+ if not os.access(os.path.abspath(spec), os.R_OK):
+ print("warning: extension %s has no %s.ttl file" % (b, b))
+ sys.exit(1)
+
+ # Root link
+ root_path = opts["root_path"]
+ root_uri = opts["root_uri"]
+ root_link = os.path.join(root_path, "index.html")
+
+ # Generate spec documentation
+ specdoc = specgen(
+ spec,
+ indir,
+ opts["style_uri"],
+ docdir,
+ tags,
+ opts,
+ instances=True,
+ root_link=root_link,
+ index_path=index_path,
+ root_path=root_path,
+ root_uri=root_uri,
+ )
+
+ # Save to HTML output file
+ save(output, specdoc)
+
+ if opts["copy_style"]:
+ import shutil
+
+ shutil.copyfile(
+ os.path.join(indir, "style.css"),
+ os.path.join(os.path.dirname(output), "style.css"),
+ )
diff --git a/lv2specgen/template.html b/lv2specgen/template.html
index 691f6fd..ed9d6fb 100644
--- a/lv2specgen/template.html
+++ b/lv2specgen/template.html
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">
<html about="@URI@"
xmlns="http://www.w3.org/1999/xhtml"
@@ -9,85 +10,86 @@
@XMLNS@
xml:lang="en">
<head>
- <title>@NAME@</title>
+ <title>@TITLE@</title>
<meta http-equiv="content-type" content="text/xhtml+xml; charset=utf-8" />
<meta name="generator" content="lv2specgen" />
<link href="@STYLE_URI@" rel="stylesheet" type="text/css" />
</head>
<body>
- <!-- HEADER -->
- <div id="header">
- <h1 id="title">@NAME@</h1>
- <span id="subtitle">@SUBTITLE@</span>
- <table id="meta">
- <tr><th>URI</th><td><a href="@URI@">@URI@</a></td></tr>
- <tr><th>Version</th><td>@REVISION@</td></tr>
- <tr><th>Prefixes</th><td>@PREFIXES@</td></tr>
- <tr><th>Discuss</th><td>
- <a href="mailto:@MAIL@">@MAIL@</a>
- (<a href="http://lists.lv2plug.in/listinfo.cgi/devel-lv2plug.in">subscribe</a>)
- </td></tr>
- @AUTHORS@
- </table>
- </div>
+ <!-- HEADER -->
+ <div id="topbar">
+ <div id="header">
+ <div id="titlebox">
+ <h1 id="title">@NAME@</h1>
+ <div id="shortdesc">@SHORT_DESC@</div>
+ </div>
+ <div id="metabox">
+ <table id="meta">
+ <tr><th>ID</th><td><a href="@URI@">@URI@</a></td></tr>
+ <tr><th>Version</th><td>@VERSION@</td></tr>
+ <tr><th>Date</th><td>@DATE@</td></tr>
+ @MAIL@
+ @AUTHORS@
+ </table>
+ </div>
+ </div>
+ </div>
- <h2 class="sec">Contents</h2>
- <div class="content">
- <ul>
- <li><a href="#sec-description">Description</a></li>
- <li><a href="#sec-index">Index</a></li>
- <li><a href="#sec-documentation">Documentation</a></li>
- <li><a href="#sec-releases">Releases</a></li>
- @FILES@
- </ul>
- </div>
+ <div id="content">
+ <div id="contentsbox">
+ <!-- Contents: -->
+ <ul id="contents">
+ <!-- <li><a href="#sec-description">Description</a></li> -->
+ <li><a href="#sec-index">Index</a></li>
+ <li><a href="#sec-history">History</a></li>
+ @CONTENT_LINKS@
+ </ul>
+ </div>
- <!-- DESCRIPTION -->
- <h2 class="sec" id="sec-description">Description</h2>
- <div class="content">@COMMENT@</div>
+ <!-- DESCRIPTION -->
+ <div class="section">@DESCRIPTION@</div>
- <!-- INDEX -->
- <h2 class="sec" id="sec-index">Index</h2>
- <div class="content">
- @INDEX@
- </div>
+ <!-- INDEX -->
+ <h2 id="sec-index">Index</h2>
+ <div class="section">
+ @INDEX@
+ </div>
- <!-- DOCUMENTATION -->
- <h2 class="sec" id="sec-documentation">Documentation</h2>
- <div class="content">
- @REFERENCE@
- </div>
+ <!-- REFERENCE -->
+ <div class="section">
+ @REFERENCE@
+ </div>
- <!-- RELEASES -->
- <h2 class="sec" id="sec-releases">Releases</h2>
- <div class="content">
- @HISTORY@
- </div>
+ <!-- HISTORY -->
+ <h2 id="sec-history">History</h2>
+ <div class="section">
+ @HISTORY@
+ </div>
- <!-- FOOTER -->
- <div id="footer">
- <div>
- This document is available under the
- <a about="" rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
- Creative Commons Attribution-ShareAlike License
- </a>
- </div>
- <div>
- Valid
- <a about="" rel="dct:conformsTo" resource="http://www.w3.org/TR/rdfa-syntax"
- href="http://validator.w3.org/check?uri=referer">
- XHTML+RDFa
- </a>
- and
- <a about="" rel="dct:conformsTo" resource="http://www.w3.org/TR/CSS2"
- href="http://jigsaw.w3.org/css-validator/check/referer">
- CSS
- </a>
- generated from @FILENAME@ by <a href="http://drobilla.net/software/lv2specgen">lv2specgen</a>
- </div>
- </div>
+ <!-- FOOTER -->
+ <div id="footer">
+ <div>
+ This document is available under the
+ <a about="" rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
+ Creative Commons Attribution-ShareAlike License
+ </a>
+ </div>
+ <div>
+ Valid
+ <a about="" rel="dct:conformsTo" resource="http://www.w3.org/TR/rdfa-syntax"
+ href="http://validator.w3.org/check?uri=referer">
+ XHTML+RDFa
+ </a>
+ and
+ <a about="" rel="dct:conformsTo" resource="http://www.w3.org/TR/CSS2"
+ href="http://jigsaw.w3.org/css-validator/check/referer">
+ CSS
+ </a>
+ generated from @FILENAME@ by lv2specgen
+ </div>
+ </div>
+ </div>
</body>
</html>
-
diff --git a/plugins/README.txt b/plugins/README.txt
index 7eb25d8..361460d 100644
--- a/plugins/README.txt
+++ b/plugins/README.txt
@@ -23,4 +23,4 @@ the first plugin describes the basics in detail.
This book is compiled from plugin source code into a single document for pleasant reading and ease of reference.
Each chapter corresponds to executable plugin code which can be found in the +plugins+ directory of the LV2 distribution.
-If you prefer to read actual source code, all the content here is also available there, where the book text is included in comments.
+If you prefer to read actual source code, all the content here is also available in the source code as comments.
diff --git a/plugins/eg01-amp.lv2/README.txt b/plugins/eg-amp.lv2/README.txt
index f024a4d..41683d3 100644
--- a/plugins/eg01-amp.lv2/README.txt
+++ b/plugins/eg-amp.lv2/README.txt
@@ -2,20 +2,18 @@
This plugin is a simple example of a basic LV2 plugin with no additional features.
It has audio ports which contain an array of `float`,
-and a control port which contain a single `float`.
+and a control port which contains a single `float`.
LV2 plugins are defined in two parts: code and data.
The code is written in C, or any C compatible language such as C++.
Static data is described separately in the human and machine friendly http://www.w3.org/TeamSubmission/turtle/[Turtle] syntax.
-Turtle is a syntax for the RDF data model,
-but familiarity with RDF is not required to understand this documentation.
-Generally, code is kept minimal,
-and all static information is described in the data.
+Generally, the goal is to keep code minimal,
+and describe as much as possible in the static data.
There are several advantages to this approach:
- * Hosts can discover and inspect plugins without loading or executing any plugin code
- * It is simple to work with plugin data using scripting languages, command line tools, etc.
- * The standard format allow the use of existing vocabularies to describe plugins and related information
- * The data inherently integrates with the web, databases, etc.
- * Labels and documentation are translatable, and available to hosts for display in user interfaces
+ * Hosts can discover and inspect plugins without loading or executing any plugin code.
+ * Plugin data can be used from a wide range of generic tools like scripting languages and command line utilities.
+ * The standard data model allows the use of existing vocabularies to describe plugins and related information.
+ * The language is extensible, so authors may describe any data without requiring changes to the LV2 specification.
+ * Labels and documentation are translatable, and available to hosts for display in user interfaces.
diff --git a/plugins/eg01-amp.lv2/amp.c b/plugins/eg-amp.lv2/amp.c
index dd302c3..c3ba279 100644
--- a/plugins/eg01-amp.lv2/amp.c
+++ b/plugins/eg-amp.lv2/amp.c
@@ -1,5 +1,5 @@
/*
- Copyright 2006-2011 David Robillard <d@drobilla.net>
+ Copyright 2006-2016 David Robillard <d@drobilla.net>
Copyright 2006 Steve Harris <steve@plugin.org.uk>
Permission to use, copy, modify, and/or distribute this software for any
@@ -15,10 +15,6 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-/** Include standard C headers */
-#include <math.h>
-#include <stdlib.h>
-
/**
LV2 headers are based on the URI of the specification they come from, so a
consistent convention can be used even for unofficial extensions. The URI
@@ -26,7 +22,12 @@
replacing `http:/` with `lv2` any header in the specification bundle can be
included, in this case `lv2.h`.
*/
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
+#include "lv2/core/lv2.h"
+
+/** Include standard C headers */
+#include <math.h>
+#include <stdint.h>
+#include <stdlib.h>
/**
The URI is the identifier for a plugin, and how the host associates this
@@ -61,7 +62,7 @@ typedef struct {
} Amp;
/**
- The instantiate() function is called by the host to create a new plugin
+ The `instantiate()` function is called by the host to create a new plugin
instance. The host passes the plugin descriptor, sample rate, and bundle
path for plugins that need to load additional resources (e.g. waveforms).
The features parameter contains host-provided features defined in LV2
@@ -76,15 +77,15 @@ instantiate(const LV2_Descriptor* descriptor,
const char* bundle_path,
const LV2_Feature* const* features)
{
- Amp* amp = (Amp*)malloc(sizeof(Amp));
+ Amp* amp = (Amp*)calloc(1, sizeof(Amp));
return (LV2_Handle)amp;
}
/**
- The connect_port() method is called by the host to connect a particular port
- to a buffer. The plugin must store the data location, but data may not be
- accessed except in run().
+ The `connect_port()` method is called by the host to connect a particular
+ port to a buffer. The plugin must store the data location, but data may not
+ be accessed except in run().
This method is in the ``audio'' threading class, and is called in the same
context as run().
@@ -110,9 +111,9 @@ connect_port(LV2_Handle instance,
}
/**
- The activate() method is called by the host to initialise and prepare the
+ The `activate()` method is called by the host to initialise and prepare the
plugin instance for running. The plugin must reset all internal state
- except for buffer locations set by connect_port(). Since this plugin has
+ except for buffer locations set by `connect_port()`. Since this plugin has
no other internal state, this method does nothing.
This method is in the ``instantiation'' threading class, so no other
@@ -123,10 +124,15 @@ activate(LV2_Handle instance)
{
}
-/** Define a macro for converting a gain in dB to a coefficient */
+/** Define a macro for converting a gain in dB to a coefficient. */
#define DB_CO(g) ((g) > -90.0f ? powf(10.0f, (g) * 0.05f) : 0.0f)
-/** Process a block of audio (audio thread, must be RT safe). */
+/**
+ The `run()` method is the main process function of the plugin. It processes
+ a block of audio in the audio context. Since this plugin is
+ `lv2:hardRTCapable`, `run()` must be real-time safe, so blocking (e.g. with
+ a mutex) or memory allocation are not allowed.
+*/
static void
run(LV2_Handle instance, uint32_t n_samples)
{
@@ -144,11 +150,11 @@ run(LV2_Handle instance, uint32_t n_samples)
}
/**
- The deactivate() method is the counterpart to activate() called by the host
- after running the plugin. It indicates that the host will not call run()
- again until another call to activate() and is mainly useful for more
+ The `deactivate()` method is the counterpart to `activate()`, and is called by
+ the host after running the plugin. It indicates that the host will not call
+ `run()` again until another call to `activate()` and is mainly useful for more
advanced plugins with ``live'' characteristics such as those with auxiliary
- processing threads. As with activate(), this plugin has no use for this
+ processing threads. As with `activate()`, this plugin has no use for this
information so this method does nothing.
This method is in the ``instantiation'' threading class, so no other
@@ -160,7 +166,7 @@ deactivate(LV2_Handle instance)
}
/**
- Destroy a plugin instance (counterpart to instantiate()).
+ Destroy a plugin instance (counterpart to `instantiate()`).
This method is in the ``instantiation'' threading class, so no other
methods on this instance will be called concurrently with it.
@@ -172,7 +178,7 @@ cleanup(LV2_Handle instance)
}
/**
- The extension_data function returns any extension data supported by the
+ The `extension_data()` function returns any extension data supported by the
plugin. Note that this is not an instance method, but a function on the
plugin descriptor. It is usually used by plugins to implement additional
interfaces. This plugin does not have any extension data, so this function
@@ -188,9 +194,9 @@ extension_data(const char* uri)
}
/**
- Define the LV2_Descriptor for this plugin. It is best to define descriptors
- statically to avoid leaking memory and non-portable shared library
- constructors and destructors to clean up properly.
+ Every plugin must define an `LV2_Descriptor`. It is best to define
+ descriptors statically to avoid leaking memory and non-portable shared
+ library constructors and destructors to clean up properly.
*/
static const LV2_Descriptor descriptor = {
AMP_URI,
@@ -204,12 +210,12 @@ static const LV2_Descriptor descriptor = {
};
/**
- The lv2_descriptor() function is the entry point to the plugin library. The
+ The `lv2_descriptor()` function is the entry point to the plugin library. The
host will load the library and call this function repeatedly with increasing
indices to find all the plugins defined in the library. The index is not an
indentifier, the URI of the returned descriptor is used to determine the
identify of the plugin.
-
+
This method is in the ``discovery'' threading class, so no other functions
or methods in this plugin library will be called concurrently with it.
*/
@@ -218,9 +224,7 @@ const LV2_Descriptor*
lv2_descriptor(uint32_t index)
{
switch (index) {
- case 0:
- return &descriptor;
- default:
- return NULL;
+ case 0: return &descriptor;
+ default: return NULL;
}
}
diff --git a/plugins/eg01-amp.lv2/amp.ttl b/plugins/eg-amp.lv2/amp.ttl
index f4a87f2..9f522a1 100644
--- a/plugins/eg01-amp.lv2/amp.ttl
+++ b/plugins/eg-amp.lv2/amp.ttl
@@ -2,10 +2,11 @@
# `manifest.ttl`. This is done so the host only needs to scan the relatively
# small `manifest.ttl` files to quickly discover all plugins.
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix units: <http://lv2plug.in/ns/extensions/units#> .
# First the type of the plugin is described. All plugins must explicitly list
# `lv2:Plugin` as a type. A more specific type should also be given, where
@@ -25,9 +26,9 @@
# Translations to various languages can be added by putting a language tag
# after strings as shown.
doap:name "Simple Amplifier" ,
- "简单放大器"@ch ,
+ "简单放大器"@zh ,
"Einfacher Verstärker"@de ,
- "Simple Amp"@en-gb ,
+ "Simple Amplifier"@en-gb ,
"Amplificador Simple"@es ,
"Amplificateur de Base"@fr ,
"Amplificatore Semplice"@it ,
@@ -44,8 +45,8 @@
lv2:index 0 ;
lv2:symbol "gain" ;
lv2:name "Gain" ,
- "收益"@ch ,
- "Gewinn"@de ,
+ "收益"@zh ,
+ "Verstärkung"@de ,
"Gain"@en-gb ,
"Aumento"@es ,
"Gain"@fr ,
@@ -58,6 +59,9 @@
lv2:default 0.0 ;
lv2:minimum -90.0 ;
lv2:maximum 24.0 ;
+# Ports can describe units and control detents to allow better UI generation
+# and host automation.
+ units:unit units:db ;
lv2:scalePoint [
rdfs:label "+5" ;
rdf:value 5.0
diff --git a/plugins/eg-amp.lv2/manifest.ttl.in b/plugins/eg-amp.lv2/manifest.ttl.in
new file mode 100644
index 0000000..4a22f95
--- /dev/null
+++ b/plugins/eg-amp.lv2/manifest.ttl.in
@@ -0,0 +1,68 @@
+# LV2 plugins are installed in a ``bundle'', a directory with a standard
+# structure. Each bundle has a Turtle file named `manifest.ttl` which lists
+# the contents of the bundle.
+#
+# Hosts typically read the manifest of every installed bundle to discover
+# plugins on start-up, so it should be as small as possible for performance
+# reasons. Details that are only useful if the host chooses to load the plugin
+# are stored in other files and linked to from `manifest.ttl`.
+#
+# ==== URIs ====
+#
+# LV2 makes use of URIs as globally-unique identifiers for resources. For
+# example, the ID of the plugin described here is
+# `<http://lv2plug.in/plugins/eg-amp>`. Note that URIs are only used as
+# identifiers and don't necessarily imply that something can be accessed at
+# that address on the web (though that may be the case).
+#
+# ==== Namespace Prefixes ====
+#
+# Turtle files contain many URIs, but prefixes can be defined to improve
+# readability. For example, with the `lv2:` prefix below, `lv2:Plugin` can be
+# written instead of `<http://lv2plug.in/ns/lv2core#Plugin>`.
+
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+# ==== Describing a Plugin ====
+
+# Turtle files contain a set of ``statements'' which describe resources.
+# This file contains 3 statements:
+# [options="header"]
+# |================================================================
+# | Subject | Predicate | Object
+# | <http://lv2plug.in/plugins/eg-amp> | a | lv2:Plugin
+# | <http://lv2plug.in/plugins/eg-amp> | lv2:binary | <amp.so>
+# | <http://lv2plug.in/plugins/eg-amp> | rdfs:seeAlso | <amp.ttl>
+# |================================================================
+
+# Firstly, `<http://lv2plug.in/plugins/eg-amp>` is an LV2 plugin:
+<http://lv2plug.in/plugins/eg-amp> a lv2:Plugin .
+
+# The predicate ```a`'' is a Turtle shorthand for `rdf:type`.
+
+# The binary of that plugin can be found at `<amp.ext>`:
+<http://lv2plug.in/plugins/eg-amp> lv2:binary <amp@LIB_EXT@> .
+
+# This file is a template; the token `@LIB_EXT@` is replaced by the build
+# system with the appropriate extension for the current platform before
+# installation. For example, in the output `manifest.ttl`, the binary would be
+# listed as `<amp.so>`. Relative URIs in manifests are relative to the bundle
+# directory, so this refers to a binary with the given name in the same
+# directory as this manifest.
+
+# Finally, more information about this plugin can be found in `<amp.ttl>`:
+<http://lv2plug.in/plugins/eg-amp> rdfs:seeAlso <amp.ttl> .
+
+# ==== Abbreviation ====
+#
+# This file shows these statements individually for instructive purposes, but
+# the subject `<http://lv2plug.in/plugins/eg-amp>` is repetitive. Turtle
+# allows the semicolon to be used as a delimiter that repeats the previous
+# subject. For example, this manifest would more realistically be written like
+# so:
+
+<http://lv2plug.in/plugins/eg-amp>
+ a lv2:Plugin ;
+ lv2:binary <amp@LIB_EXT@> ;
+ rdfs:seeAlso <amp.ttl> .
diff --git a/plugins/eg01-amp.lv2/waf b/plugins/eg-amp.lv2/waf
index 59a1ac9..59a1ac9 120000
--- a/plugins/eg01-amp.lv2/waf
+++ b/plugins/eg-amp.lv2/waf
diff --git a/plugins/eg-amp.lv2/wscript b/plugins/eg-amp.lv2/wscript
new file mode 100644
index 0000000..822825d
--- /dev/null
+++ b/plugins/eg-amp.lv2/wscript
@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+from waflib.extras import autowaf as autowaf
+import re
+
+# Variables for 'waf dist'
+APPNAME = 'eg-amp.lv2'
+VERSION = '1.0.0'
+
+# Mandatory variables
+top = '.'
+out = 'build'
+
+def options(opt):
+ opt.load('compiler_c')
+ opt.load('lv2')
+ autowaf.set_options(opt)
+
+def configure(conf):
+ conf.load('compiler_c', cache=True)
+ conf.load('lv2', cache=True)
+ conf.load('autowaf', cache=True)
+
+ conf.check_pkg('lv2', uselib_store='LV2')
+
+ conf.check(features='c cshlib', lib='m', uselib_store='M', mandatory=False)
+
+def build(bld):
+ bundle = 'eg-amp.lv2'
+
+ # Build manifest.ttl by substitution (for portable lib extension)
+ bld(features = 'subst',
+ source = 'manifest.ttl.in',
+ target = 'lv2/%s/%s' % (bundle, 'manifest.ttl'),
+ install_path = '${LV2DIR}/%s' % bundle,
+ LIB_EXT = bld.env.LV2_LIB_EXT)
+
+ # Copy other data files to build bundle (build/eg-amp.lv2)
+ for i in ['amp.ttl']:
+ bld(features = 'subst',
+ is_copy = True,
+ source = i,
+ target = 'lv2/%s/%s' % (bundle, i),
+ install_path = '${LV2DIR}/%s' % bundle)
+
+ # Build plugin library
+ obj = bld(features = 'c cshlib lv2lib',
+ source = 'amp.c',
+ name = 'amp',
+ target = 'lv2/%s/amp' % bundle,
+ install_path = '${LV2DIR}/%s' % bundle,
+ uselib = 'M LV2')
diff --git a/plugins/eg-fifths.lv2/README.txt b/plugins/eg-fifths.lv2/README.txt
new file mode 100644
index 0000000..2154321
--- /dev/null
+++ b/plugins/eg-fifths.lv2/README.txt
@@ -0,0 +1,3 @@
+== Fifths ==
+
+This plugin demonstrates simple MIDI event reading and writing.
diff --git a/plugins/eg-fifths.lv2/fifths.c b/plugins/eg-fifths.lv2/fifths.c
new file mode 100644
index 0000000..5782417
--- /dev/null
+++ b/plugins/eg-fifths.lv2/fifths.c
@@ -0,0 +1,193 @@
+/*
+ LV2 Fifths Example Plugin
+ Copyright 2014-2016 David Robillard <d@drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#include "./uris.h"
+
+#include "lv2/atom/atom.h"
+#include "lv2/atom/util.h"
+#include "lv2/core/lv2.h"
+#include "lv2/core/lv2_util.h"
+#include "lv2/log/log.h"
+#include "lv2/log/logger.h"
+#include "lv2/midi/midi.h"
+#include "lv2/urid/urid.h"
+
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+enum {
+ FIFTHS_IN = 0,
+ FIFTHS_OUT = 1
+};
+
+typedef struct {
+ // Features
+ LV2_URID_Map* map;
+ LV2_Log_Logger logger;
+
+ // Ports
+ const LV2_Atom_Sequence* in_port;
+ LV2_Atom_Sequence* out_port;
+
+ // URIs
+ FifthsURIs uris;
+} Fifths;
+
+static void
+connect_port(LV2_Handle instance,
+ uint32_t port,
+ void* data)
+{
+ Fifths* self = (Fifths*)instance;
+ switch (port) {
+ case FIFTHS_IN:
+ self->in_port = (const LV2_Atom_Sequence*)data;
+ break;
+ case FIFTHS_OUT:
+ self->out_port = (LV2_Atom_Sequence*)data;
+ break;
+ default:
+ break;
+ }
+}
+
+static LV2_Handle
+instantiate(const LV2_Descriptor* descriptor,
+ double rate,
+ const char* path,
+ const LV2_Feature* const* features)
+{
+ // Allocate and initialise instance structure.
+ Fifths* self = (Fifths*)calloc(1, sizeof(Fifths));
+ if (!self) {
+ return NULL;
+ }
+
+ // Scan host features for URID map
+ const char* missing = lv2_features_query(
+ features,
+ LV2_LOG__log, &self->logger.log, false,
+ LV2_URID__map, &self->map, true,
+ NULL);
+ lv2_log_logger_set_map(&self->logger, self->map);
+ if (missing) {
+ lv2_log_error(&self->logger, "Missing feature <%s>\n", missing);
+ free(self);
+ return NULL;
+ }
+
+ map_fifths_uris(self->map, &self->uris);
+
+ return (LV2_Handle)self;
+}
+
+static void
+cleanup(LV2_Handle instance)
+{
+ free(instance);
+}
+
+static void
+run(LV2_Handle instance,
+ uint32_t sample_count)
+{
+ Fifths* self = (Fifths*)instance;
+ FifthsURIs* uris = &self->uris;
+
+ // Struct for a 3 byte MIDI event, used for writing notes
+ typedef struct {
+ LV2_Atom_Event event;
+ uint8_t msg[3];
+ } MIDINoteEvent;
+
+ // Initially self->out_port contains a Chunk with size set to capacity
+
+ // Get the capacity
+ const uint32_t out_capacity = self->out_port->atom.size;
+
+ // Write an empty Sequence header to the output
+ lv2_atom_sequence_clear(self->out_port);
+ self->out_port->atom.type = self->in_port->atom.type;
+
+ // Read incoming events
+ LV2_ATOM_SEQUENCE_FOREACH(self->in_port, ev) {
+ if (ev->body.type == uris->midi_Event) {
+ const uint8_t* const msg = (const uint8_t*)LV2_ATOM_BODY_CONST(ev);
+ switch (lv2_midi_message_type(msg)) {
+ case LV2_MIDI_MSG_NOTE_ON:
+ case LV2_MIDI_MSG_NOTE_OFF:
+ // Forward note to output
+ lv2_atom_sequence_append_event(
+ self->out_port, out_capacity, ev);
+
+ if (msg[1] <= 127 - 7) {
+ // Make a note one 5th (7 semitones) higher than input
+ MIDINoteEvent fifth;
+
+ // Could simply do fifth.event = *ev here instead...
+ fifth.event.time.frames = ev->time.frames; // Same time
+ fifth.event.body.type = ev->body.type; // Same type
+ fifth.event.body.size = ev->body.size; // Same size
+
+ fifth.msg[0] = msg[0]; // Same status
+ fifth.msg[1] = msg[1] + 7; // Pitch up 7 semitones
+ fifth.msg[2] = msg[2]; // Same velocity
+
+ // Write 5th event
+ lv2_atom_sequence_append_event(
+ self->out_port, out_capacity, &fifth.event);
+ }
+ break;
+ default:
+ // Forward all other MIDI events directly
+ lv2_atom_sequence_append_event(
+ self->out_port, out_capacity, ev);
+ break;
+ }
+ }
+ }
+}
+
+static const void*
+extension_data(const char* uri)
+{
+ return NULL;
+}
+
+static const LV2_Descriptor descriptor = {
+ EG_FIFTHS_URI,
+ instantiate,
+ connect_port,
+ NULL, // activate,
+ run,
+ NULL, // deactivate,
+ cleanup,
+ extension_data
+};
+
+LV2_SYMBOL_EXPORT
+const LV2_Descriptor* lv2_descriptor(uint32_t index)
+{
+ switch (index) {
+ case 0:
+ return &descriptor;
+ default:
+ return NULL;
+ }
+}
diff --git a/plugins/eg-fifths.lv2/fifths.ttl b/plugins/eg-fifths.lv2/fifths.ttl
new file mode 100644
index 0000000..7f58a33
--- /dev/null
+++ b/plugins/eg-fifths.lv2/fifths.ttl
@@ -0,0 +1,30 @@
+@prefix atom: <http://lv2plug.in/ns/ext/atom#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix urid: <http://lv2plug.in/ns/ext/urid#> .
+@prefix midi: <http://lv2plug.in/ns/ext/midi#> .
+
+<http://lv2plug.in/plugins/eg-fifths>
+ a lv2:Plugin ;
+ doap:name "Example Fifths" ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ lv2:project <http://lv2plug.in/ns/lv2> ;
+ lv2:requiredFeature urid:map ;
+ lv2:optionalFeature lv2:hardRTCapable ;
+ lv2:port [
+ a lv2:InputPort ,
+ atom:AtomPort ;
+ atom:bufferType atom:Sequence ;
+ atom:supports midi:MidiEvent ;
+ lv2:index 0 ;
+ lv2:symbol "in" ;
+ lv2:name "In"
+ ] , [
+ a lv2:OutputPort ,
+ atom:AtomPort ;
+ atom:bufferType atom:Sequence ;
+ atom:supports midi:MidiEvent ;
+ lv2:index 1 ;
+ lv2:symbol "out" ;
+ lv2:name "Out"
+ ] .
diff --git a/plugins/eg-fifths.lv2/manifest.ttl.in b/plugins/eg-fifths.lv2/manifest.ttl.in
new file mode 100644
index 0000000..f87f2c1
--- /dev/null
+++ b/plugins/eg-fifths.lv2/manifest.ttl.in
@@ -0,0 +1,8 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix ui: <http://lv2plug.in/ns/extensions/ui#> .
+
+<http://lv2plug.in/plugins/eg-fifths>
+ a lv2:Plugin ;
+ lv2:binary <fifths@LIB_EXT@> ;
+ rdfs:seeAlso <fifths.ttl> .
diff --git a/plugins/eg-fifths.lv2/uris.h b/plugins/eg-fifths.lv2/uris.h
new file mode 100644
index 0000000..04b09f6
--- /dev/null
+++ b/plugins/eg-fifths.lv2/uris.h
@@ -0,0 +1,55 @@
+/*
+ LV2 Fifths Example Plugin
+ Copyright 2014-2015 David Robillard <d@drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#ifndef FIFTHS_URIS_H
+#define FIFTHS_URIS_H
+
+#include "lv2/atom/atom.h"
+#include "lv2/log/log.h"
+#include "lv2/midi/midi.h"
+#include "lv2/patch/patch.h"
+#include "lv2/state/state.h"
+
+#define EG_FIFTHS_URI "http://lv2plug.in/plugins/eg-fifths"
+
+typedef struct {
+ LV2_URID atom_Path;
+ LV2_URID atom_Resource;
+ LV2_URID atom_Sequence;
+ LV2_URID atom_URID;
+ LV2_URID atom_eventTransfer;
+ LV2_URID midi_Event;
+ LV2_URID patch_Set;
+ LV2_URID patch_property;
+ LV2_URID patch_value;
+} FifthsURIs;
+
+static inline void
+map_fifths_uris(LV2_URID_Map* map, FifthsURIs* uris)
+{
+ uris->atom_Path = map->map(map->handle, LV2_ATOM__Path);
+ uris->atom_Resource = map->map(map->handle, LV2_ATOM__Resource);
+ uris->atom_Sequence = map->map(map->handle, LV2_ATOM__Sequence);
+ uris->atom_URID = map->map(map->handle, LV2_ATOM__URID);
+ uris->atom_eventTransfer = map->map(map->handle, LV2_ATOM__eventTransfer);
+ uris->midi_Event = map->map(map->handle, LV2_MIDI__MidiEvent);
+ uris->patch_Set = map->map(map->handle, LV2_PATCH__Set);
+ uris->patch_property = map->map(map->handle, LV2_PATCH__property);
+ uris->patch_value = map->map(map->handle, LV2_PATCH__value);
+}
+
+#endif /* FIFTHS_URIS_H */
diff --git a/plugins/eg02-midigate.lv2/waf b/plugins/eg-fifths.lv2/waf
index 59a1ac9..59a1ac9 120000
--- a/plugins/eg02-midigate.lv2/waf
+++ b/plugins/eg-fifths.lv2/waf
diff --git a/plugins/eg-fifths.lv2/wscript b/plugins/eg-fifths.lv2/wscript
new file mode 100644
index 0000000..8b2991b
--- /dev/null
+++ b/plugins/eg-fifths.lv2/wscript
@@ -0,0 +1,49 @@
+#!/usr/bin/env python
+from waflib.extras import autowaf as autowaf
+import re
+
+# Variables for 'waf dist'
+APPNAME = 'eg-fifths.lv2'
+VERSION = '1.0.0'
+
+# Mandatory variables
+top = '.'
+out = 'build'
+
+def options(opt):
+ opt.load('compiler_c')
+ opt.load('lv2')
+ autowaf.set_options(opt)
+
+def configure(conf):
+ conf.load('compiler_c', cache=True)
+ conf.load('lv2', cache=True)
+ conf.load('autowaf', cache=True)
+
+ conf.check_pkg('lv2 >= 1.2.1', uselib_store='LV2')
+
+def build(bld):
+ bundle = 'eg-fifths.lv2'
+
+ # Build manifest.ttl by substitution (for portable lib extension)
+ bld(features = 'subst',
+ source = 'manifest.ttl.in',
+ target = 'lv2/%s/%s' % (bundle, 'manifest.ttl'),
+ install_path = '${LV2DIR}/%s' % bundle,
+ LIB_EXT = bld.env.LV2_LIB_EXT)
+
+ # Copy other data files to build bundle (build/eg-fifths.lv2)
+ for i in ['fifths.ttl']:
+ bld(features = 'subst',
+ is_copy = True,
+ source = i,
+ target = 'lv2/%s/%s' % (bundle, i),
+ install_path = '${LV2DIR}/%s' % bundle)
+
+ # Build plugin library
+ obj = bld(features = 'c cshlib lv2lib',
+ source = 'fifths.c',
+ name = 'fifths',
+ target = 'lv2/%s/fifths' % bundle,
+ install_path = '${LV2DIR}/%s' % bundle,
+ use = 'LV2')
diff --git a/plugins/eg03-metro.lv2/README.txt b/plugins/eg-metro.lv2/README.txt
index 5e9a84a..5e9a84a 100644
--- a/plugins/eg03-metro.lv2/README.txt
+++ b/plugins/eg-metro.lv2/README.txt
diff --git a/plugins/eg03-metro.lv2/manifest.ttl.in b/plugins/eg-metro.lv2/manifest.ttl.in
index bd93f66..bd93f66 100644
--- a/plugins/eg03-metro.lv2/manifest.ttl.in
+++ b/plugins/eg-metro.lv2/manifest.ttl.in
diff --git a/plugins/eg03-metro.lv2/metro.c b/plugins/eg-metro.lv2/metro.c
index 51125af..a7231d2 100644
--- a/plugins/eg03-metro.lv2/metro.c
+++ b/plugins/eg-metro.lv2/metro.c
@@ -1,6 +1,6 @@
/*
LV2 Metronome Example Plugin
- Copyright 2012 David Robillard <d@drobilla.net>
+ Copyright 2012-2016 David Robillard <d@drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -15,19 +15,21 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+#include "lv2/atom/atom.h"
+#include "lv2/atom/util.h"
+#include "lv2/core/lv2.h"
+#include "lv2/core/lv2_util.h"
+#include "lv2/log/log.h"
+#include "lv2/log/logger.h"
+#include "lv2/time/time.h"
+#include "lv2/urid/urid.h"
+
#include <math.h>
+#include <stdbool.h>
+#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
-#ifndef __cplusplus
-# include <stdbool.h>
-#endif
-
-#include "lv2/lv2plug.in/ns/ext/atom/atom.h"
-#include "lv2/lv2plug.in/ns/ext/atom/util.h"
-#include "lv2/lv2plug.in/ns/ext/time/time.h"
-#include "lv2/lv2plug.in/ns/ext/urid/urid.h"
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
#ifndef M_PI
# define M_PI 3.14159265
@@ -38,6 +40,7 @@
typedef struct {
LV2_URID atom_Blank;
LV2_URID atom_Float;
+ LV2_URID atom_Object;
LV2_URID atom_Path;
LV2_URID atom_Resource;
LV2_URID atom_Sequence;
@@ -68,14 +71,15 @@ typedef enum {
wave which is conceptually played continuously. The 'tick' is generated by
enveloping the amplitude so there is a short attack/decay peak around a
tick, and silence the rest of the time.
-
+
This example uses a simple AD envelope with fixed parameters. A more
sophisticated implementation might use a more advanced envelope and allow
the user to modify these parameters, the frequency of the wave, and so on.
- */
+*/
typedef struct {
- LV2_URID_Map* map; // URID map feature
- MetroURIs uris; // Cache of mapped URIDs
+ LV2_URID_Map* map; // URID map feature
+ LV2_Log_Logger logger; // Logger API
+ MetroURIs uris; // Cache of mapped URIDs
struct {
LV2_Atom_Sequence* control;
@@ -151,23 +155,24 @@ instantiate(const LV2_Descriptor* descriptor,
}
// Scan host features for URID map
- LV2_URID_Map* map = NULL;
- for (int i = 0; features[i]; ++i) {
- if (!strcmp(features[i]->URI, LV2_URID_URI "#map")) {
- map = (LV2_URID_Map*)features[i]->data;
- }
- }
- if (!map) {
- fprintf(stderr, "Host does not support urid:map.\n");
+ const char* missing = lv2_features_query(
+ features,
+ LV2_LOG__log, &self->logger.log, false,
+ LV2_URID__map, &self->map, true,
+ NULL);
+ lv2_log_logger_set_map(&self->logger, self->map);
+ if (missing) {
+ lv2_log_error(&self->logger, "Missing feature <%s>\n", missing);
free(self);
return NULL;
}
// Map URIS
- MetroURIs* const uris = &self->uris;
- self->map = map;
+ MetroURIs* const uris = &self->uris;
+ LV2_URID_Map* const map = self->map;
uris->atom_Blank = map->map(map->handle, LV2_ATOM__Blank);
uris->atom_Float = map->map(map->handle, LV2_ATOM__Float);
+ uris->atom_Object = map->map(map->handle, LV2_ATOM__Object);
uris->atom_Path = map->map(map->handle, LV2_ATOM__Path);
uris->atom_Resource = map->map(map->handle, LV2_ATOM__Resource);
uris->atom_Sequence = map->map(map->handle, LV2_ATOM__Sequence);
@@ -179,17 +184,17 @@ instantiate(const LV2_Descriptor* descriptor,
// Initialise instance fields
self->rate = rate;
self->bpm = 120.0f;
- self->attack_len = attack_s * rate;
- self->decay_len = decay_s * rate;
+ self->attack_len = (uint32_t)(attack_s * rate);
+ self->decay_len = (uint32_t)(decay_s * rate);
self->state = STATE_OFF;
// Generate one cycle of a sine wave at the desired frequency
const double freq = 440.0 * 2.0;
const double amp = 0.5;
- self->wave_len = rate / freq;
+ self->wave_len = (uint32_t)(rate / freq);
self->wave = (float*)malloc(self->wave_len * sizeof(float));
for (uint32_t i = 0; i < self->wave_len; ++i) {
- self->wave[i] = sin(i * 2 * M_PI * freq / rate) * amp;
+ self->wave[i] = (float)(sin(i * 2 * M_PI * freq / rate) * amp);
}
return (LV2_Handle)self;
@@ -301,15 +306,18 @@ run(LV2_Handle instance, uint32_t sample_count)
// Work forwards in time frame by frame, handling events as we go
const LV2_Atom_Sequence* in = self->ports.control;
uint32_t last_t = 0;
- for (LV2_Atom_Event* ev = lv2_atom_sequence_begin(&in->body);
+ for (const LV2_Atom_Event* ev = lv2_atom_sequence_begin(&in->body);
!lv2_atom_sequence_is_end(&in->body, in->atom.size, ev);
ev = lv2_atom_sequence_next(ev)) {
// Play the click for the time slice from last_t until now
play(self, last_t, ev->time.frames);
- if (ev->body.type == uris->atom_Blank) {
- const LV2_Atom_Object* obj = (LV2_Atom_Object*)&ev->body;
+ // Check if this event is an Object
+ // (or deprecated Blank to tolerate old hosts)
+ if (ev->body.type == uris->atom_Object ||
+ ev->body.type == uris->atom_Blank) {
+ const LV2_Atom_Object* obj = (const LV2_Atom_Object*)&ev->body;
if (obj->body.otype == uris->time_Position) {
// Received position information, update
update_position(self, obj);
diff --git a/plugins/eg03-metro.lv2/metro.ttl b/plugins/eg-metro.lv2/metro.ttl
index 8b4af3d..8b4af3d 100644
--- a/plugins/eg03-metro.lv2/metro.ttl
+++ b/plugins/eg-metro.lv2/metro.ttl
diff --git a/plugins/eg03-metro.lv2/waf b/plugins/eg-metro.lv2/waf
index 59a1ac9..59a1ac9 120000
--- a/plugins/eg03-metro.lv2/waf
+++ b/plugins/eg-metro.lv2/waf
diff --git a/plugins/eg-metro.lv2/wscript b/plugins/eg-metro.lv2/wscript
new file mode 100644
index 0000000..5fb0d07
--- /dev/null
+++ b/plugins/eg-metro.lv2/wscript
@@ -0,0 +1,50 @@
+#!/usr/bin/env python
+from waflib.extras import autowaf as autowaf
+import re
+
+# Variables for 'waf dist'
+APPNAME = 'eg-metro.lv2'
+VERSION = '1.0.0'
+
+# Mandatory variables
+top = '.'
+out = 'build'
+
+def options(opt):
+ opt.load('compiler_c')
+ opt.load('lv2')
+ autowaf.set_options(opt)
+
+def configure(conf):
+ conf.load('compiler_c', cache=True)
+ conf.load('lv2', cache=True)
+ conf.load('autowaf', cache=True)
+
+ conf.check_pkg('lv2 >= 0.2.0', uselib_store='LV2')
+
+ conf.check(features='c cshlib', lib='m', uselib_store='M', mandatory=False)
+
+def build(bld):
+ bundle = 'eg-metro.lv2'
+
+ # Build manifest.ttl by substitution (for portable lib extension)
+ bld(features = 'subst',
+ source = 'manifest.ttl.in',
+ target = 'lv2/%s/%s' % (bundle, 'manifest.ttl'),
+ install_path = '${LV2DIR}/%s' % bundle,
+ LIB_EXT = bld.env.LV2_LIB_EXT)
+
+ # Copy other data files to build bundle (build/eg-metro.lv2)
+ bld(features = 'subst',
+ is_copy = True,
+ source = 'metro.ttl',
+ target = 'lv2/%s/metro.ttl' % bundle,
+ install_path = '${LV2DIR}/%s' % bundle)
+
+ # Build plugin library
+ obj = bld(features = 'c cshlib lv2lib',
+ source = 'metro.c',
+ name = 'metro',
+ target = 'lv2/%s/metro' % bundle,
+ install_path = '${LV2DIR}/%s' % bundle,
+ use = ['M', 'LV2'])
diff --git a/plugins/eg02-midigate.lv2/README.txt b/plugins/eg-midigate.lv2/README.txt
index 8f4a0f0..8f4a0f0 100644
--- a/plugins/eg02-midigate.lv2/README.txt
+++ b/plugins/eg-midigate.lv2/README.txt
diff --git a/plugins/eg02-midigate.lv2/manifest.ttl.in b/plugins/eg-midigate.lv2/manifest.ttl.in
index d32f1dc..d32f1dc 100644
--- a/plugins/eg02-midigate.lv2/manifest.ttl.in
+++ b/plugins/eg-midigate.lv2/manifest.ttl.in
diff --git a/plugins/eg02-midigate.lv2/midigate.c b/plugins/eg-midigate.lv2/midigate.c
index 3ed6fbf..6c77828 100644
--- a/plugins/eg02-midigate.lv2/midigate.c
+++ b/plugins/eg-midigate.lv2/midigate.c
@@ -1,5 +1,5 @@
/*
- Copyright 2013 David Robillard <d@drobilla.net>
+ Copyright 2013-2016 David Robillard <d@drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -14,16 +14,20 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+#include "lv2/atom/atom.h"
+#include "lv2/atom/util.h"
+#include "lv2/core/lv2.h"
+#include "lv2/core/lv2_util.h"
+#include "lv2/log/log.h"
+#include "lv2/log/logger.h"
+#include "lv2/midi/midi.h"
+#include "lv2/urid/urid.h"
+
+#include <stdbool.h>
+#include <stdint.h>
#include <stdio.h>
-
-#include <math.h>
#include <stdlib.h>
-
-#include "lv2/lv2plug.in/ns/ext/atom/atom.h"
-#include "lv2/lv2plug.in/ns/ext/atom/util.h"
-#include "lv2/lv2plug.in/ns/ext/midi/midi.h"
-#include "lv2/lv2plug.in/ns/ext/urid/urid.h"
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
+#include <string.h>
#define MIDIGATE_URI "http://lv2plug.in/plugins/eg-midigate"
@@ -40,7 +44,8 @@ typedef struct {
float* out;
// Features
- LV2_URID_Map* map;
+ LV2_URID_Map* map;
+ LV2_Log_Logger logger;
struct {
LV2_URID midi_MidiEvent;
@@ -56,25 +61,26 @@ instantiate(const LV2_Descriptor* descriptor,
const char* bundle_path,
const LV2_Feature* const* features)
{
- /** Scan features array for the URID feature we need. */
- LV2_URID_Map* map = NULL;
- for (int i = 0; features[i]; ++i) {
- if (!strcmp(features[i]->URI, LV2_URID__map)) {
- map = (LV2_URID_Map*)features[i]->data;
- break;
- }
+ Midigate* self = (Midigate*)calloc(1, sizeof(Midigate));
+ if (!self) {
+ return NULL;
}
- if (!map) {
- /**
- No URID feature given. This is a host bug since we require this
- feature, but should be handled gracefully anyway.
- */
+
+ // Scan host features for URID map
+ const char* missing = lv2_features_query(
+ features,
+ LV2_LOG__log, &self->logger.log, false,
+ LV2_URID__map, &self->map, true,
+ NULL);
+ lv2_log_logger_set_map(&self->logger, self->map);
+ if (missing) {
+ lv2_log_error(&self->logger, "Missing feature <%s>\n", missing);
+ free(self);
return NULL;
}
- Midigate* self = (Midigate*)calloc(1, sizeof(Midigate));
- self->map = map;
- self->uris.midi_MidiEvent = map->map(map->handle, LV2_MIDI__MidiEvent);
+ self->uris.midi_MidiEvent = self->map->map(
+ self->map->handle, LV2_MIDI__MidiEvent);
return (LV2_Handle)self;
}
@@ -155,13 +161,20 @@ run(LV2_Handle instance, uint32_t sample_count)
LV2_ATOM_SEQUENCE_FOREACH(self->control, ev) {
if (ev->body.type == self->uris.midi_MidiEvent) {
- const uint8_t* const msg = (const uint8_t*)(ev + 1);
+ const uint8_t* const msg = (const uint8_t*)LV2_ATOM_BODY_CONST(ev);
switch (lv2_midi_message_type(msg)) {
case LV2_MIDI_MSG_NOTE_ON:
++self->n_active_notes;
break;
case LV2_MIDI_MSG_NOTE_OFF:
- --self->n_active_notes;
+ if (self->n_active_notes > 0) {
+ --self->n_active_notes;
+ }
+ break;
+ case LV2_MIDI_MSG_CONTROLLER:
+ if (msg[1] == LV2_MIDI_CTL_ALL_NOTES_OFF) {
+ self->n_active_notes = 0;
+ }
break;
case LV2_MIDI_MSG_PGM_CHANGE:
if (msg[1] == 0 || msg[1] == 1) {
@@ -173,7 +186,7 @@ run(LV2_Handle instance, uint32_t sample_count)
}
write_output(self, offset, ev->time.frames - offset);
- offset = ev->time.frames;
+ offset = (uint32_t)ev->time.frames;
}
write_output(self, offset, sample_count - offset);
diff --git a/plugins/eg02-midigate.lv2/midigate.ttl b/plugins/eg-midigate.lv2/midigate.ttl
index e14a329..e14a329 100644
--- a/plugins/eg02-midigate.lv2/midigate.ttl
+++ b/plugins/eg-midigate.lv2/midigate.ttl
diff --git a/plugins/eg04-sampler.lv2/waf b/plugins/eg-midigate.lv2/waf
index 59a1ac9..59a1ac9 120000
--- a/plugins/eg04-sampler.lv2/waf
+++ b/plugins/eg-midigate.lv2/waf
diff --git a/plugins/eg-midigate.lv2/wscript b/plugins/eg-midigate.lv2/wscript
new file mode 100644
index 0000000..5862721
--- /dev/null
+++ b/plugins/eg-midigate.lv2/wscript
@@ -0,0 +1,49 @@
+#!/usr/bin/env python
+from waflib.extras import autowaf as autowaf
+import re
+
+# Variables for 'waf dist'
+APPNAME = 'eg-midigate.lv2'
+VERSION = '1.0.0'
+
+# Mandatory variables
+top = '.'
+out = 'build'
+
+def options(opt):
+ opt.load('compiler_c')
+ opt.load('lv2')
+ autowaf.set_options(opt)
+
+def configure(conf):
+ conf.load('compiler_c', cache=True)
+ conf.load('lv2', cache=True)
+ conf.load('autowaf', cache=True)
+
+ conf.check_pkg('lv2', uselib_store='LV2')
+
+def build(bld):
+ bundle = 'eg-midigate.lv2'
+
+ # Build manifest.ttl by substitution (for portable lib extension)
+ bld(features = 'subst',
+ source = 'manifest.ttl.in',
+ target = 'lv2/%s/%s' % (bundle, 'manifest.ttl'),
+ install_path = '${LV2DIR}/%s' % bundle,
+ LIB_EXT = bld.env.LV2_LIB_EXT)
+
+ # Copy other data files to build bundle (build/eg-midigate.lv2)
+ for i in ['midigate.ttl']:
+ bld(features = 'subst',
+ is_copy = True,
+ source = i,
+ target = 'lv2/%s/%s' % (bundle, i),
+ install_path = '${LV2DIR}/%s' % bundle)
+
+ # Build plugin library
+ obj = bld(features = 'c cshlib lv2lib',
+ source = 'midigate.c',
+ name = 'midigate',
+ target = 'lv2/%s/midigate' % bundle,
+ install_path = '${LV2DIR}/%s' % bundle,
+ uselib = 'LV2')
diff --git a/plugins/eg-params.lv2/README.txt b/plugins/eg-params.lv2/README.txt
new file mode 100644
index 0000000..acf90c1
--- /dev/null
+++ b/plugins/eg-params.lv2/README.txt
@@ -0,0 +1,21 @@
+== Params ==
+
+The basic LV2 mechanism for controls is
+http://lv2plug.in/ns/lv2core#ControlPort[lv2:ControlPort], inherited from
+LADSPA. Control ports are problematic because they are not sample accurate,
+support only one type (`float`), and require that plugins poll to know when a
+control has changed.
+
+Parameters can be used instead to address these issues. Parameters can be
+thought of as properties of a plugin instance; they are identified by URI and
+have a value of any type. This deliberately meshes with the concept of plugin
+state defined by the http://lv2plug.in/ns/ext/state[LV2 state extension].
+The state extension allows plugins to save and restore their parameters (along
+with other internal state information, if necessary).
+
+Parameters are accessed and manipulated using messages sent via a sequence
+port. The http://lv2plug.in/ns/ext/patch[LV2 patch extension] defines the
+standard messages for working with parameters. Typically, only two are used
+for simple plugins: http://lv2plug.in/ns/ext/patch#Set[patch:Set] sets a
+parameter to some value, and http://lv2plug.in/ns/ext/patch#Get[patch:Get]
+requests that the plugin send a description of its parameters.
diff --git a/plugins/eg-params.lv2/manifest.ttl.in b/plugins/eg-params.lv2/manifest.ttl.in
new file mode 100644
index 0000000..913de7c
--- /dev/null
+++ b/plugins/eg-params.lv2/manifest.ttl.in
@@ -0,0 +1,7 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/plugins/eg-params>
+ a lv2:Plugin ;
+ lv2:binary <params@LIB_EXT@> ;
+ rdfs:seeAlso <params.ttl> .
diff --git a/plugins/eg-params.lv2/params.c b/plugins/eg-params.lv2/params.c
new file mode 100644
index 0000000..94d34a5
--- /dev/null
+++ b/plugins/eg-params.lv2/params.c
@@ -0,0 +1,526 @@
+/*
+ LV2 Parameter Example Plugin
+ Copyright 2014-2016 David Robillard <d@drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#include "state_map.h"
+
+#include "lv2/atom/atom.h"
+#include "lv2/atom/forge.h"
+#include "lv2/atom/util.h"
+#include "lv2/core/lv2.h"
+#include "lv2/core/lv2_util.h"
+#include "lv2/log/log.h"
+#include "lv2/log/logger.h"
+#include "lv2/midi/midi.h"
+#include "lv2/patch/patch.h"
+#include "lv2/state/state.h"
+#include "lv2/urid/urid.h"
+
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#define MAX_STRING 1024
+
+#define EG_PARAMS_URI "http://lv2plug.in/plugins/eg-params"
+
+#define N_PROPS 9
+
+typedef struct {
+ LV2_URID plugin;
+ LV2_URID atom_Path;
+ LV2_URID atom_Sequence;
+ LV2_URID atom_URID;
+ LV2_URID atom_eventTransfer;
+ LV2_URID eg_spring;
+ LV2_URID midi_Event;
+ LV2_URID patch_Get;
+ LV2_URID patch_Set;
+ LV2_URID patch_Put;
+ LV2_URID patch_body;
+ LV2_URID patch_subject;
+ LV2_URID patch_property;
+ LV2_URID patch_value;
+} URIs;
+
+typedef struct {
+ LV2_Atom_Int aint;
+ LV2_Atom_Long along;
+ LV2_Atom_Float afloat;
+ LV2_Atom_Double adouble;
+ LV2_Atom_Bool abool;
+ LV2_Atom astring;
+ char string[MAX_STRING];
+ LV2_Atom apath;
+ char path[MAX_STRING];
+ LV2_Atom_Float lfo;
+ LV2_Atom_Float spring;
+} State;
+
+static inline void
+map_uris(LV2_URID_Map* map, URIs* uris)
+{
+ uris->plugin = map->map(map->handle, EG_PARAMS_URI);
+
+ uris->atom_Path = map->map(map->handle, LV2_ATOM__Path);
+ uris->atom_Sequence = map->map(map->handle, LV2_ATOM__Sequence);
+ uris->atom_URID = map->map(map->handle, LV2_ATOM__URID);
+ uris->atom_eventTransfer = map->map(map->handle, LV2_ATOM__eventTransfer);
+ uris->eg_spring = map->map(map->handle, EG_PARAMS_URI "#spring");
+ uris->midi_Event = map->map(map->handle, LV2_MIDI__MidiEvent);
+ uris->patch_Get = map->map(map->handle, LV2_PATCH__Get);
+ uris->patch_Set = map->map(map->handle, LV2_PATCH__Set);
+ uris->patch_Put = map->map(map->handle, LV2_PATCH__Put);
+ uris->patch_body = map->map(map->handle, LV2_PATCH__body);
+ uris->patch_subject = map->map(map->handle, LV2_PATCH__subject);
+ uris->patch_property = map->map(map->handle, LV2_PATCH__property);
+ uris->patch_value = map->map(map->handle, LV2_PATCH__value);
+}
+
+enum {
+ PARAMS_IN = 0,
+ PARAMS_OUT = 1
+};
+
+typedef struct {
+ // Features
+ LV2_URID_Map* map;
+ LV2_URID_Unmap* unmap;
+ LV2_Log_Logger log;
+
+ // Forge for creating atoms
+ LV2_Atom_Forge forge;
+
+ // Ports
+ const LV2_Atom_Sequence* in_port;
+ LV2_Atom_Sequence* out_port;
+
+ // URIs
+ URIs uris;
+
+ // Plugin state
+ StateMapItem props[N_PROPS];
+ State state;
+
+ // Buffer for making strings from URIDs if unmap is not provided
+ char urid_buf[12];
+} Params;
+
+static void
+connect_port(LV2_Handle instance,
+ uint32_t port,
+ void* data)
+{
+ Params* self = (Params*)instance;
+ switch (port) {
+ case PARAMS_IN:
+ self->in_port = (const LV2_Atom_Sequence*)data;
+ break;
+ case PARAMS_OUT:
+ self->out_port = (LV2_Atom_Sequence*)data;
+ break;
+ default:
+ break;
+ }
+}
+
+static LV2_Handle
+instantiate(const LV2_Descriptor* descriptor,
+ double rate,
+ const char* path,
+ const LV2_Feature* const* features)
+{
+ // Allocate instance
+ Params* self = (Params*)calloc(1, sizeof(Params));
+ if (!self) {
+ return NULL;
+ }
+
+ // Get host features
+ const char* missing = lv2_features_query(
+ features,
+ LV2_LOG__log, &self->log.log, false,
+ LV2_URID__map, &self->map, true,
+ LV2_URID__unmap, &self->unmap, false,
+ NULL);
+ lv2_log_logger_set_map(&self->log, self->map);
+ if (missing) {
+ lv2_log_error(&self->log, "Missing feature <%s>\n", missing);
+ free(self);
+ return NULL;
+ }
+
+ // Map URIs and initialise forge
+ map_uris(self->map, &self->uris);
+ lv2_atom_forge_init(&self->forge, self->map);
+
+ // Initialise state dictionary
+ State* state = &self->state;
+ state_map_init(
+ self->props, self->map, self->map->handle,
+ EG_PARAMS_URI "#int", STATE_MAP_INIT(Int, &state->aint),
+ EG_PARAMS_URI "#long", STATE_MAP_INIT(Long, &state->along),
+ EG_PARAMS_URI "#float", STATE_MAP_INIT(Float, &state->afloat),
+ EG_PARAMS_URI "#double", STATE_MAP_INIT(Double, &state->adouble),
+ EG_PARAMS_URI "#bool", STATE_MAP_INIT(Bool, &state->abool),
+ EG_PARAMS_URI "#string", STATE_MAP_INIT(String, &state->astring),
+ EG_PARAMS_URI "#path", STATE_MAP_INIT(Path, &state->apath),
+ EG_PARAMS_URI "#lfo", STATE_MAP_INIT(Float, &state->lfo),
+ EG_PARAMS_URI "#spring", STATE_MAP_INIT(Float, &state->spring),
+ NULL);
+
+ return (LV2_Handle)self;
+}
+
+static void
+cleanup(LV2_Handle instance)
+{
+ free(instance);
+}
+
+/** Helper function to unmap a URID if possible. */
+static const char*
+unmap(Params* self, LV2_URID urid)
+{
+ if (self->unmap) {
+ return self->unmap->unmap(self->unmap->handle, urid);
+ } else {
+ snprintf(self->urid_buf, sizeof(self->urid_buf), "%u", urid);
+ return self->urid_buf;
+ }
+}
+
+static LV2_State_Status
+check_type(Params* self,
+ LV2_URID key,
+ LV2_URID type,
+ LV2_URID required_type)
+{
+ if (type != required_type) {
+ lv2_log_trace(
+ &self->log, "Bad type <%s> for <%s> (needs <%s>)\n",
+ unmap(self, type),
+ unmap(self, key),
+ unmap(self, required_type));
+ return LV2_STATE_ERR_BAD_TYPE;
+ }
+ return LV2_STATE_SUCCESS;
+}
+
+static LV2_State_Status
+set_parameter(Params* self,
+ LV2_URID key,
+ uint32_t size,
+ LV2_URID type,
+ const void* body,
+ bool from_state)
+{
+ // Look up property in state dictionary
+ const StateMapItem* entry = state_map_find(self->props, N_PROPS, key);
+ if (!entry) {
+ lv2_log_trace(&self->log, "Unknown parameter <%s>\n", unmap(self, key));
+ return LV2_STATE_ERR_NO_PROPERTY;
+ }
+
+ // Ensure given type matches property's type
+ if (check_type(self, key, type, entry->value->type)) {
+ return LV2_STATE_ERR_BAD_TYPE;
+ }
+
+ // Set property value in state dictionary
+ lv2_log_trace(&self->log, "Set <%s>\n", entry->uri);
+ memcpy(entry->value + 1, body, size);
+ entry->value->size = size;
+ return LV2_STATE_SUCCESS;
+}
+
+static const LV2_Atom*
+get_parameter(Params* self, LV2_URID key)
+{
+ const StateMapItem* entry = state_map_find(self->props, N_PROPS, key);
+ if (entry) {
+ lv2_log_trace(&self->log, "Get <%s>\n", entry->uri);
+ return entry->value;
+ }
+
+ lv2_log_trace(&self->log, "Unknown parameter <%s>\n", unmap(self, key));
+ return NULL;
+}
+
+static LV2_State_Status
+write_param_to_forge(LV2_State_Handle handle,
+ uint32_t key,
+ const void* value,
+ size_t size,
+ uint32_t type,
+ uint32_t flags)
+{
+ LV2_Atom_Forge* forge = (LV2_Atom_Forge*)handle;
+
+ if (!lv2_atom_forge_key(forge, key) ||
+ !lv2_atom_forge_atom(forge, size, type) ||
+ !lv2_atom_forge_write(forge, value, size)) {
+ return LV2_STATE_ERR_UNKNOWN;
+ }
+
+ return LV2_STATE_SUCCESS;
+}
+
+static void
+store_prop(Params* self,
+ LV2_State_Map_Path* map_path,
+ LV2_State_Status* save_status,
+ LV2_State_Store_Function store,
+ LV2_State_Handle handle,
+ LV2_URID key,
+ const LV2_Atom* value)
+{
+ LV2_State_Status st;
+ if (map_path && value->type == self->uris.atom_Path) {
+ // Map path to abstract path for portable storage
+ const char* path = (const char*)(value + 1);
+ char* apath = map_path->abstract_path(map_path->handle, path);
+ st = store(handle,
+ key,
+ apath,
+ strlen(apath) + 1,
+ self->uris.atom_Path,
+ LV2_STATE_IS_POD | LV2_STATE_IS_PORTABLE);
+ free(apath);
+ } else {
+ // Store simple property
+ st = store(handle,
+ key,
+ value + 1,
+ value->size,
+ value->type,
+ LV2_STATE_IS_POD | LV2_STATE_IS_PORTABLE);
+ }
+
+ if (save_status && !*save_status) {
+ *save_status = st;
+ }
+}
+
+/**
+ State save method.
+
+ This is used in the usual way when called by the host to save plugin state,
+ but also internally for writing messages in the audio thread by passing a
+ "store" function which actually writes the description to the forge.
+*/
+static LV2_State_Status
+save(LV2_Handle instance,
+ LV2_State_Store_Function store,
+ LV2_State_Handle handle,
+ uint32_t flags,
+ const LV2_Feature* const* features)
+{
+ Params* self = (Params*)instance;
+ LV2_State_Map_Path* map_path = (LV2_State_Map_Path*)lv2_features_data(
+ features, LV2_STATE__mapPath);
+
+ LV2_State_Status st = LV2_STATE_SUCCESS;
+ for (unsigned i = 0; i < N_PROPS; ++i) {
+ StateMapItem* prop = &self->props[i];
+ store_prop(self, map_path, &st, store, handle, prop->urid, prop->value);
+ }
+
+ return st;
+}
+
+static void
+retrieve_prop(Params* self,
+ LV2_State_Status* restore_status,
+ LV2_State_Retrieve_Function retrieve,
+ LV2_State_Handle handle,
+ LV2_URID key)
+{
+ // Retrieve value from saved state
+ size_t vsize;
+ uint32_t vtype;
+ uint32_t vflags;
+ const void* value = retrieve(handle, key, &vsize, &vtype, &vflags);
+
+ // Set plugin instance state
+ const LV2_State_Status st = value
+ ? set_parameter(self, key, vsize, vtype, value, true)
+ : LV2_STATE_ERR_NO_PROPERTY;
+
+ if (!*restore_status) {
+ *restore_status = st; // Set status if there has been no error yet
+ }
+}
+
+/** State restore method. */
+static LV2_State_Status
+restore(LV2_Handle instance,
+ LV2_State_Retrieve_Function retrieve,
+ LV2_State_Handle handle,
+ uint32_t flags,
+ const LV2_Feature* const* features)
+{
+ Params* self = (Params*)instance;
+ LV2_State_Status st = LV2_STATE_SUCCESS;
+
+ for (unsigned i = 0; i < N_PROPS; ++i) {
+ retrieve_prop(self, &st, retrieve, handle, self->props[i].urid);
+ }
+
+ return st;
+}
+
+static inline bool
+subject_is_plugin(Params* self, const LV2_Atom_URID* subject)
+{
+ // This simple plugin only supports one subject: itself
+ return (!subject || (subject->atom.type == self->uris.atom_URID &&
+ subject->body == self->uris.plugin));
+}
+
+static void
+run(LV2_Handle instance, uint32_t sample_count)
+{
+ Params* self = (Params*)instance;
+ URIs* uris = &self->uris;
+
+ // Initially, self->out_port contains a Chunk with size set to capacity
+ // Set up forge to write directly to output port
+ const uint32_t out_capacity = self->out_port->atom.size;
+ lv2_atom_forge_set_buffer(&self->forge,
+ (uint8_t*)self->out_port,
+ out_capacity);
+
+ // Start a sequence in the output port
+ LV2_Atom_Forge_Frame out_frame;
+ lv2_atom_forge_sequence_head(&self->forge, &out_frame, 0);
+
+ // Read incoming events
+ LV2_ATOM_SEQUENCE_FOREACH(self->in_port, ev) {
+ const LV2_Atom_Object* obj = (const LV2_Atom_Object*)&ev->body;
+ if (obj->body.otype == uris->patch_Set) {
+ // Get the property and value of the set message
+ const LV2_Atom_URID* subject = NULL;
+ const LV2_Atom_URID* property = NULL;
+ const LV2_Atom* value = NULL;
+ lv2_atom_object_get(obj,
+ uris->patch_subject, (const LV2_Atom**)&subject,
+ uris->patch_property, (const LV2_Atom**)&property,
+ uris->patch_value, &value,
+ 0);
+ if (!subject_is_plugin(self, subject)) {
+ lv2_log_error(&self->log, "Set for unknown subject\n");
+ } else if (!property) {
+ lv2_log_error(&self->log, "Set with no property\n");
+ } else if (property->atom.type != uris->atom_URID) {
+ lv2_log_error(&self->log, "Set property is not a URID\n");
+ } else {
+ // Set property to the given value
+ const LV2_URID key = property->body;
+ set_parameter(self, key, value->size, value->type, value + 1, false);
+ }
+ } else if (obj->body.otype == uris->patch_Get) {
+ // Get the property of the get message
+ const LV2_Atom_URID* subject = NULL;
+ const LV2_Atom_URID* property = NULL;
+ lv2_atom_object_get(obj,
+ uris->patch_subject, (const LV2_Atom**)&subject,
+ uris->patch_property, (const LV2_Atom**)&property,
+ 0);
+ if (!subject_is_plugin(self, subject)) {
+ lv2_log_error(&self->log, "Get with unknown subject\n");
+ } else if (!property) {
+ // Get with no property, emit complete state
+ lv2_atom_forge_frame_time(&self->forge, ev->time.frames);
+ LV2_Atom_Forge_Frame pframe;
+ lv2_atom_forge_object(&self->forge, &pframe, 0, uris->patch_Put);
+ lv2_atom_forge_key(&self->forge, uris->patch_body);
+
+ LV2_Atom_Forge_Frame bframe;
+ lv2_atom_forge_object(&self->forge, &bframe, 0, 0);
+ save(self, write_param_to_forge, &self->forge, 0, NULL);
+
+ lv2_atom_forge_pop(&self->forge, &bframe);
+ lv2_atom_forge_pop(&self->forge, &pframe);
+ } else if (property->atom.type != uris->atom_URID) {
+ lv2_log_error(&self->log, "Get property is not a URID\n");
+ } else {
+ // Get for a specific property
+ const LV2_URID key = property->body;
+ const LV2_Atom* value = get_parameter(self, key);
+ if (value) {
+ lv2_atom_forge_frame_time(&self->forge, ev->time.frames);
+ LV2_Atom_Forge_Frame frame;
+ lv2_atom_forge_object(&self->forge, &frame, 0, uris->patch_Set);
+ lv2_atom_forge_key(&self->forge, uris->patch_property);
+ lv2_atom_forge_urid(&self->forge, property->body);
+ store_prop(self, NULL, NULL, write_param_to_forge, &self->forge,
+ uris->patch_value, value);
+ lv2_atom_forge_pop(&self->forge, &frame);
+ }
+ }
+ } else {
+ lv2_log_trace(&self->log, "Unknown object type <%s>\n",
+ unmap(self, obj->body.otype));
+ }
+ }
+
+ if (self->state.spring.body > 0.0f) {
+ const float spring = self->state.spring.body;
+ self->state.spring.body = (spring >= 0.001) ? spring - 0.001 : 0.0;
+ lv2_atom_forge_frame_time(&self->forge, 0);
+ LV2_Atom_Forge_Frame frame;
+ lv2_atom_forge_object(&self->forge, &frame, 0, uris->patch_Set);
+
+ lv2_atom_forge_key(&self->forge, uris->patch_property);
+ lv2_atom_forge_urid(&self->forge, uris->eg_spring);
+ lv2_atom_forge_key(&self->forge, uris->patch_value);
+ lv2_atom_forge_float(&self->forge, self->state.spring.body);
+
+ lv2_atom_forge_pop(&self->forge, &frame);
+ }
+
+ lv2_atom_forge_pop(&self->forge, &out_frame);
+}
+
+static const void*
+extension_data(const char* uri)
+{
+ static const LV2_State_Interface state = { save, restore };
+ if (!strcmp(uri, LV2_STATE__interface)) {
+ return &state;
+ }
+ return NULL;
+}
+
+static const LV2_Descriptor descriptor = {
+ EG_PARAMS_URI,
+ instantiate,
+ connect_port,
+ NULL, // activate,
+ run,
+ NULL, // deactivate,
+ cleanup,
+ extension_data
+};
+
+LV2_SYMBOL_EXPORT const LV2_Descriptor*
+lv2_descriptor(uint32_t index)
+{
+ return (index == 0) ? &descriptor : NULL;
+}
diff --git a/plugins/eg-params.lv2/params.ttl b/plugins/eg-params.lv2/params.ttl
new file mode 100644
index 0000000..931c826
--- /dev/null
+++ b/plugins/eg-params.lv2/params.ttl
@@ -0,0 +1,126 @@
+@prefix atom: <http://lv2plug.in/ns/ext/atom#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix param: <http://lv2plug.in/ns/ext/parameters#> .
+@prefix patch: <http://lv2plug.in/ns/ext/patch#> .
+@prefix plug: <http://lv2plug.in/plugins/eg-params#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix state: <http://lv2plug.in/ns/ext/state#> .
+@prefix urid: <http://lv2plug.in/ns/ext/urid#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+# An existing parameter or RDF property can be used as a parameter. The LV2
+# parameters extension <http://lv2plug.in/ns/ext/parameters> defines many
+# common audio parameters. Where possible, existing parameters should be used
+# so hosts can intelligently control plugins.
+
+# If no suitable parameter exists, one can be defined for the plugin like so:
+
+plug:int
+ a lv2:Parameter ;
+ rdfs:label "int" ;
+ rdfs:range atom:Int .
+
+plug:long
+ a lv2:Parameter ;
+ rdfs:label "long" ;
+ rdfs:range atom:Long .
+
+plug:float
+ a lv2:Parameter ;
+ rdfs:label "float" ;
+ rdfs:range atom:Float .
+
+plug:double
+ a lv2:Parameter ;
+ rdfs:label "double" ;
+ rdfs:range atom:Double .
+
+plug:bool
+ a lv2:Parameter ;
+ rdfs:label "bool" ;
+ rdfs:range atom:Bool .
+
+plug:string
+ a lv2:Parameter ;
+ rdfs:label "string" ;
+ rdfs:range atom:String .
+
+plug:path
+ a lv2:Parameter ;
+ rdfs:label "path" ;
+ rdfs:range atom:Path .
+
+plug:lfo
+ a lv2:Parameter ;
+ rdfs:label "LFO" ;
+ rdfs:range atom:Float ;
+ lv2:minimum -1.0 ;
+ lv2:maximum 1.0 .
+
+plug:spring
+ a lv2:Parameter ;
+ rdfs:label "spring" ;
+ rdfs:range atom:Float .
+
+# Most of the plugin description is similar to the others we have seen, but
+# this plugin has only two ports, for receiving and sending messages used to
+# manipulate and access parameters.
+<http://lv2plug.in/plugins/eg-params>
+ a lv2:Plugin ,
+ lv2:UtilityPlugin ;
+ doap:name "Example Parameters" ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ lv2:project <http://lv2plug.in/ns/lv2> ;
+ lv2:requiredFeature urid:map ;
+ lv2:optionalFeature lv2:hardRTCapable ,
+ state:loadDefaultState ;
+ lv2:extensionData state:interface ;
+ lv2:port [
+ a lv2:InputPort ,
+ atom:AtomPort ;
+ atom:bufferType atom:Sequence ;
+ atom:supports patch:Message ;
+ lv2:designation lv2:control ;
+ lv2:index 0 ;
+ lv2:symbol "in" ;
+ lv2:name "In"
+ ] , [
+ a lv2:OutputPort ,
+ atom:AtomPort ;
+ atom:bufferType atom:Sequence ;
+ atom:supports patch:Message ;
+ lv2:designation lv2:control ;
+ lv2:index 1 ;
+ lv2:symbol "out" ;
+ lv2:name "Out"
+ ] ;
+# The plugin must list all parameters that can be written (e.g. changed by the
+# user) as patch:writable:
+ patch:writable plug:int ,
+ plug:long ,
+ plug:float ,
+ plug:double ,
+ plug:bool ,
+ plug:string ,
+ plug:path ,
+ plug:spring ;
+# Similarly, parameters that may change internally must be listed as patch:readable,
+# meaning to host should watch for changes to the parameter's value:
+ patch:readable plug:lfo ,
+ plug:spring ;
+# Parameters map directly to properties of the plugin's state. So, we can
+# specify initial parameter values with the state:state property. The
+# state:loadDefaultState feature (required above) requires that the host loads
+# the default state after instantiation but before running the plugin.
+ state:state [
+ plug:int 0 ;
+ plug:long "0"^^xsd:long ;
+ plug:float "0.1234"^^xsd:float ;
+ plug:double "0e0"^^xsd:double ;
+ plug:bool false ;
+ plug:string "Hello, world" ;
+ plug:path <params.ttl> ;
+ plug:spring "0.0"^^xsd:float ;
+ plug:lfo "0.0"^^xsd:float
+ ] .
diff --git a/plugins/eg-params.lv2/state_map.h b/plugins/eg-params.lv2/state_map.h
new file mode 100644
index 0000000..c80d4a2
--- /dev/null
+++ b/plugins/eg-params.lv2/state_map.h
@@ -0,0 +1,114 @@
+/*
+ LV2 State Map
+ Copyright 2016 David Robillard <d@drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#include "lv2/atom/atom.h"
+#include "lv2/urid/urid.h"
+
+#include <stdarg.h>
+#include <stdlib.h>
+
+/** Entry in an array that serves as a dictionary of properties. */
+typedef struct {
+ const char* uri;
+ LV2_URID urid;
+ LV2_Atom* value;
+} StateMapItem;
+
+/** Comparator for StateMapItems sorted by URID. */
+static int
+state_map_cmp(const void* a, const void* b)
+{
+ const StateMapItem* ka = (const StateMapItem*)a;
+ const StateMapItem* kb = (const StateMapItem*)b;
+ if (ka->urid < kb->urid) {
+ return -1;
+ } else if (kb->urid < ka->urid) {
+ return 1;
+ }
+ return 0;
+}
+
+/** Helper macro for terse state map initialisation. */
+#define STATE_MAP_INIT(type, ptr) \
+ (LV2_ATOM__ ## type), \
+ (sizeof(*ptr) - sizeof(LV2_Atom)), \
+ (ptr)
+
+/**
+ Initialise a state map.
+
+ The variable parameters list must be NULL terminated, and is a sequence of
+ const char* uri, const char* type, uint32_t size, LV2_Atom* value. The
+ value must point to a valid atom that resides elsewhere, the state map is
+ only an index and does not contain actual state values. The macro
+ STATE_MAP_INIT can be used to make simpler code when state is composed of
+ standard atom types, for example:
+
+ struct Plugin {
+ LV2_URID_Map* map;
+ StateMapItem props[3];
+ // ...
+ };
+
+ state_map_init(
+ self->props, self->map, self->map->handle,
+ PLUG_URI "#gain", STATE_MAP_INIT(Float, &state->gain),
+ PLUG_URI "#offset", STATE_MAP_INIT(Int, &state->offset),
+ PLUG_URI "#file", STATE_MAP_INIT(Path, &state->file),
+ NULL);
+*/
+static void
+state_map_init(StateMapItem dict[],
+ LV2_URID_Map* map,
+ LV2_URID_Map_Handle handle,
+ /* const char* uri, const char* type, uint32_t size, LV2_Atom* value */ ...)
+{
+ // Set dict entries from parameters
+ unsigned i = 0;
+ va_list args;
+ va_start(args, handle);
+ for (const char* uri; (uri = va_arg(args, const char*)); ++i) {
+ const char* type = va_arg(args, const char*);
+ const uint32_t size = va_arg(args, uint32_t);
+ LV2_Atom* const value = va_arg(args, LV2_Atom*);
+ dict[i].uri = uri;
+ dict[i].urid = map->map(map->handle, uri);
+ dict[i].value = value;
+ dict[i].value->size = size;
+ dict[i].value->type = map->map(map->handle, type);
+ }
+ va_end(args);
+
+ // Sort for fast lookup by URID by state_map_find()
+ qsort(dict, i, sizeof(StateMapItem), state_map_cmp);
+}
+
+/**
+ Retrieve an item from a state map by URID.
+
+ This takes O(lg(n)) time, and is useful for implementing generic property
+ access with little code, for example to respond to patch:Get messages for a
+ specific property.
+*/
+static StateMapItem*
+state_map_find(StateMapItem dict[], uint32_t n_entries, LV2_URID urid)
+{
+ const StateMapItem key = { NULL, urid, NULL };
+ return (StateMapItem*)bsearch(
+ &key, dict, n_entries, sizeof(StateMapItem), state_map_cmp);
+}
+
diff --git a/plugins/eg-params.lv2/wscript b/plugins/eg-params.lv2/wscript
new file mode 100644
index 0000000..503e8db
--- /dev/null
+++ b/plugins/eg-params.lv2/wscript
@@ -0,0 +1,49 @@
+#!/usr/bin/env python
+from waflib.extras import autowaf as autowaf
+import re
+
+# Variables for 'waf dist'
+APPNAME = 'eg-params.lv2'
+VERSION = '1.0.0'
+
+# Mandatory variables
+top = '.'
+out = 'build'
+
+def options(opt):
+ opt.load('compiler_c')
+ opt.load('lv2')
+ autowaf.set_options(opt)
+
+def configure(conf):
+ conf.load('compiler_c', cache=True)
+ conf.load('lv2', cache=True)
+ conf.load('autowaf', cache=True)
+
+ conf.check_pkg('lv2 >= 1.12.1', uselib_store='LV2')
+
+def build(bld):
+ bundle = 'eg-params.lv2'
+
+ # Build manifest.ttl by substitution (for portable lib extension)
+ bld(features = 'subst',
+ source = 'manifest.ttl.in',
+ target = 'lv2/%s/%s' % (bundle, 'manifest.ttl'),
+ install_path = '${LV2DIR}/%s' % bundle,
+ LIB_EXT = bld.env.LV2_LIB_EXT)
+
+ # Copy other data files to build bundle (build/eg-params.lv2)
+ for i in ['params.ttl']:
+ bld(features = 'subst',
+ is_copy = True,
+ source = i,
+ target = 'lv2/%s/%s' % (bundle, i),
+ install_path = '${LV2DIR}/%s' % bundle)
+
+ # Build plugin library
+ obj = bld(features = 'c cshlib lv2lib',
+ source = 'params.c',
+ name = 'params',
+ target = 'lv2/%s/params' % bundle,
+ install_path = '${LV2DIR}/%s' % bundle,
+ use = 'LV2')
diff --git a/plugins/eg04-sampler.lv2/README.txt b/plugins/eg-sampler.lv2/README.txt
index 4eed9e6..8d136fa 100644
--- a/plugins/eg04-sampler.lv2/README.txt
+++ b/plugins/eg-sampler.lv2/README.txt
@@ -11,3 +11,4 @@ This plugin illustrates:
- Use of the log extension to print log messages via the host
- Saving plugin state via the state extension
- Dynamic plugin control via the same properties saved to state
+- Network-transparent waveform display with incremental peak transmission
diff --git a/plugins/eg-sampler.lv2/atom_sink.h b/plugins/eg-sampler.lv2/atom_sink.h
new file mode 100644
index 0000000..b84ca55
--- /dev/null
+++ b/plugins/eg-sampler.lv2/atom_sink.h
@@ -0,0 +1,42 @@
+/*
+ Copyright 2016 David Robillard <d@drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#include "lv2/atom/forge.h"
+
+/**
+ A forge sink that writes to an atom buffer.
+
+ It is assumed that the handle points to an LV2_Atom large enough to store
+ the forge output. The forged result is in the body of the buffer atom.
+*/
+static LV2_Atom_Forge_Ref
+atom_sink(LV2_Atom_Forge_Sink_Handle handle, const void* buf, uint32_t size)
+{
+ LV2_Atom* atom = (LV2_Atom*)handle;
+ const uint32_t offset = lv2_atom_total_size(atom);
+ memcpy((char*)atom + offset, buf, size);
+ atom->size += size;
+ return offset;
+}
+
+/**
+ Dereference counterpart to atom_sink().
+*/
+static LV2_Atom*
+atom_sink_deref(LV2_Atom_Forge_Sink_Handle handle, LV2_Atom_Forge_Ref ref)
+{
+ return (LV2_Atom*)((char*)handle + ref);
+}
diff --git a/plugins/eg04-sampler.lv2/click.wav b/plugins/eg-sampler.lv2/click.wav
index 520a18c..520a18c 100644
--- a/plugins/eg04-sampler.lv2/click.wav
+++ b/plugins/eg-sampler.lv2/click.wav
Binary files differ
diff --git a/plugins/eg04-sampler.lv2/manifest.ttl.in b/plugins/eg-sampler.lv2/manifest.ttl.in
index 8a01428..8a01428 100644
--- a/plugins/eg04-sampler.lv2/manifest.ttl.in
+++ b/plugins/eg-sampler.lv2/manifest.ttl.in
diff --git a/plugins/eg-sampler.lv2/peaks.h b/plugins/eg-sampler.lv2/peaks.h
new file mode 100644
index 0000000..45d3465
--- /dev/null
+++ b/plugins/eg-sampler.lv2/peaks.h
@@ -0,0 +1,271 @@
+/*
+ LV2 audio peaks utilities
+ Copyright 2016 David Robillard <d@drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+/**
+ This file defines utilities for sending and receiving audio peaks for
+ waveform display. The functionality is divided into two objects:
+ PeaksSender, for sending peaks updates from the plugin, and PeaksReceiver,
+ for receiving such updates and caching the peaks.
+
+ This allows peaks for a waveform of any size at any resolution to be
+ requested, with reasonably sized incremental updates sent over plugin ports.
+*/
+
+#ifndef PEAKS_H_INCLUDED
+#define PEAKS_H_INCLUDED
+
+#include "lv2/atom/forge.h"
+
+#include <math.h>
+#include <stdlib.h>
+
+#define PEAKS_URI "http://lv2plug.in/ns/peaks#"
+#define PEAKS__PeakUpdate PEAKS_URI "PeakUpdate"
+#define PEAKS__magnitudes PEAKS_URI "magnitudes"
+#define PEAKS__offset PEAKS_URI "offset"
+#define PEAKS__total PEAKS_URI "total"
+
+#ifndef MIN
+# define MIN(a, b) (((a) < (b)) ? (a) : (b))
+#endif
+#ifndef MAX
+# define MAX(a, b) (((a) > (b)) ? (a) : (b))
+#endif
+
+typedef struct {
+ LV2_URID atom_Float;
+ LV2_URID atom_Int;
+ LV2_URID atom_Vector;
+ LV2_URID peaks_PeakUpdate;
+ LV2_URID peaks_magnitudes;
+ LV2_URID peaks_offset;
+ LV2_URID peaks_total;
+} PeaksURIs;
+
+typedef struct {
+ PeaksURIs uris; ///< URIDs used in protocol
+ const float* samples; ///< Sample data
+ uint32_t n_samples; ///< Total number of samples
+ uint32_t n_peaks; ///< Total number of peaks
+ uint32_t current_offset; ///< Current peak offset
+ bool sending; ///< True iff currently sending
+} PeaksSender;
+
+typedef struct {
+ PeaksURIs uris; ///< URIDs used in protocol
+ float* peaks; ///< Received peaks, or zeroes
+ uint32_t n_peaks; ///< Total number of peaks
+} PeaksReceiver;
+
+/**
+ Map URIs used in the peaks protocol.
+*/
+static inline void
+peaks_map_uris(PeaksURIs* uris, LV2_URID_Map* map)
+{
+ uris->atom_Float = map->map(map->handle, LV2_ATOM__Float);
+ uris->atom_Int = map->map(map->handle, LV2_ATOM__Int);
+ uris->atom_Vector = map->map(map->handle, LV2_ATOM__Vector);
+ uris->peaks_PeakUpdate = map->map(map->handle, PEAKS__PeakUpdate);
+ uris->peaks_magnitudes = map->map(map->handle, PEAKS__magnitudes);
+ uris->peaks_offset = map->map(map->handle, PEAKS__offset);
+ uris->peaks_total = map->map(map->handle, PEAKS__total);
+}
+
+/**
+ Initialise peaks sender. The new sender is inactive and will do nothing
+ when `peaks_sender_send()` is called, until a transmission is started with
+ `peaks_sender_start()`.
+*/
+static inline PeaksSender*
+peaks_sender_init(PeaksSender* sender, LV2_URID_Map* map)
+{
+ memset(sender, 0, sizeof(*sender));
+ peaks_map_uris(&sender->uris, map);
+ return sender;
+}
+
+/**
+ Prepare to start a new peaks transmission. After this is called, the peaks
+ can be sent with successive calls to `peaks_sender_send()`.
+*/
+static inline void
+peaks_sender_start(PeaksSender* sender,
+ const float* samples,
+ uint32_t n_samples,
+ uint32_t n_peaks)
+{
+ sender->samples = samples;
+ sender->n_samples = n_samples;
+ sender->n_peaks = n_peaks;
+ sender->current_offset = 0;
+ sender->sending = true;
+}
+
+/**
+ Forge a message which sends a range of peaks. Writes a peaks:PeakUpdate
+ object to `forge`, like:
+
+ [source,turtle]
+ ----
+ []
+ a peaks:PeakUpdate ;
+ peaks:offset 256 ;
+ peaks:total 1024 ;
+ peaks:magnitudes [ 0.2f, 0.3f, ... ] .
+ ----
+*/
+static inline bool
+peaks_sender_send(PeaksSender* sender,
+ LV2_Atom_Forge* forge,
+ uint32_t n_frames,
+ uint32_t offset)
+{
+ const PeaksURIs* uris = &sender->uris;
+ if (!sender->sending || sender->current_offset >= sender->n_peaks) {
+ return sender->sending = false;
+ }
+
+ // Start PeakUpdate object
+ lv2_atom_forge_frame_time(forge, offset);
+ LV2_Atom_Forge_Frame frame;
+ lv2_atom_forge_object(forge, &frame, 0, uris->peaks_PeakUpdate);
+
+ // eg:offset = OFFSET
+ lv2_atom_forge_key(forge, uris->peaks_offset);
+ lv2_atom_forge_int(forge, sender->current_offset);
+
+ // eg:total = TOTAL
+ lv2_atom_forge_key(forge, uris->peaks_total);
+ lv2_atom_forge_int(forge, sender->n_peaks);
+
+ // eg:magnitudes = Vector<Float>(PEAK, PEAK, ...)
+ lv2_atom_forge_key(forge, uris->peaks_magnitudes);
+ LV2_Atom_Forge_Frame vec_frame;
+ lv2_atom_forge_vector_head(
+ forge, &vec_frame, sizeof(float), uris->atom_Float);
+
+ // Calculate how many peaks to send this update
+ const int chunk_size = MAX(1, sender->n_samples / sender->n_peaks);
+ const uint32_t space = forge->size - forge->offset;
+ const uint32_t remaining = sender->n_peaks - sender->current_offset;
+ const int n_update = MIN(remaining,
+ MIN(n_frames / 4, space / sizeof(float)));
+
+ // Calculate peak (maximum magnitude) for each chunk
+ for (int i = 0; i < n_update; ++i) {
+ const int start = (sender->current_offset + i) * chunk_size;
+ float peak = 0.0f;
+ for (int j = 0; j < chunk_size; ++j) {
+ peak = fmaxf(peak, fabsf(sender->samples[start + j]));
+ }
+ lv2_atom_forge_float(forge, peak);
+ }
+
+ // Finish message
+ lv2_atom_forge_pop(forge, &vec_frame);
+ lv2_atom_forge_pop(forge, &frame);
+
+ sender->current_offset += n_update;
+ return true;
+}
+
+/**
+ Initialise a peaks receiver. The receiver stores an array of all peaks,
+ which is updated incrementally with peaks_receiver_receive().
+*/
+static inline PeaksReceiver*
+peaks_receiver_init(PeaksReceiver* receiver, LV2_URID_Map* map)
+{
+ memset(receiver, 0, sizeof(*receiver));
+ peaks_map_uris(&receiver->uris, map);
+ return receiver;
+}
+
+/**
+ Clear stored peaks and free all memory. This should be called when the
+ peaks are to be updated with a different audio source.
+*/
+static inline void
+peaks_receiver_clear(PeaksReceiver* receiver)
+{
+ free(receiver->peaks);
+ receiver->peaks = NULL;
+ receiver->n_peaks = 0;
+}
+
+/**
+ Handle PeakUpdate message.
+
+ The stored peaks array is updated with the slice of peaks in `update`,
+ resizing if necessary while preserving contents.
+
+ Returns 0 if peaks have been updated, negative on error.
+*/
+static inline int
+peaks_receiver_receive(PeaksReceiver* receiver, const LV2_Atom_Object* update)
+{
+ const PeaksURIs* uris = &receiver->uris;
+
+ // Get properties of interest from update
+ const LV2_Atom_Int* offset = NULL;
+ const LV2_Atom_Int* total = NULL;
+ const LV2_Atom_Vector* peaks = NULL;
+ lv2_atom_object_get_typed(update,
+ uris->peaks_offset, &offset, uris->atom_Int,
+ uris->peaks_total, &total, uris->atom_Int,
+ uris->peaks_magnitudes, &peaks, uris->atom_Vector,
+ 0);
+
+ if (!offset || !total || !peaks ||
+ peaks->body.child_type != uris->atom_Float) {
+ return -1; // Invalid update
+ }
+
+ const uint32_t n = (uint32_t)total->body;
+ if (receiver->n_peaks != n) {
+ // Update is for a different total number of peaks, resize
+ receiver->peaks = (float*)realloc(receiver->peaks, n * sizeof(float));
+ if (receiver->n_peaks > 0 && receiver->n_peaks < n) {
+ /* The peaks array is being expanded. Copy the old peaks,
+ duplicating each as necessary to fill the new peaks buffer.
+ This preserves the current peaks so that the peaks array can be
+ reasonably drawn at any time, but the resolution will increase
+ as new updates arrive. */
+ const int n_per = n / receiver->n_peaks;
+ for (int i = n - 1; i >= 0; --i) {
+ receiver->peaks[i] = receiver->peaks[i / n_per];
+ }
+ } else if (receiver->n_peaks > 0) {
+ /* The peak array is being shrunk. Similar to the above. */
+ const int n_per = receiver->n_peaks / n;
+ for (int i = n - 1; i >= 0; --i) {
+ receiver->peaks[i] = receiver->peaks[i * n_per];
+ }
+ }
+ receiver->n_peaks = n;
+ }
+
+ // Copy vector contents to corresponding range in peaks array
+ memcpy(receiver->peaks + offset->body,
+ peaks + 1,
+ peaks->atom.size - sizeof(LV2_Atom_Vector_Body));
+
+ return 0;
+}
+
+#endif // PEAKS_H_INCLUDED
diff --git a/plugins/eg-sampler.lv2/sampler.c b/plugins/eg-sampler.lv2/sampler.c
new file mode 100644
index 0000000..ed49903
--- /dev/null
+++ b/plugins/eg-sampler.lv2/sampler.c
@@ -0,0 +1,603 @@
+/*
+ LV2 Sampler Example Plugin
+ Copyright 2011-2016 David Robillard <d@drobilla.net>
+ Copyright 2011 Gabriel M. Beddingfield <gabriel@teuton.org>
+ Copyright 2011 James Morris <jwm.art.net@gmail.com>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#include "atom_sink.h"
+#include "peaks.h"
+#include "uris.h"
+
+#include "lv2/atom/atom.h"
+#include "lv2/atom/forge.h"
+#include "lv2/atom/util.h"
+#include "lv2/core/lv2.h"
+#include "lv2/core/lv2_util.h"
+#include "lv2/log/log.h"
+#include "lv2/log/logger.h"
+#include "lv2/midi/midi.h"
+#include "lv2/state/state.h"
+#include "lv2/urid/urid.h"
+#include "lv2/worker/worker.h"
+
+#include <sndfile.h>
+
+#include <math.h>
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+enum {
+ SAMPLER_CONTROL = 0,
+ SAMPLER_NOTIFY = 1,
+ SAMPLER_OUT = 2
+};
+
+typedef struct {
+ SF_INFO info; // Info about sample from sndfile
+ float* data; // Sample data in float
+ char* path; // Path of file
+ uint32_t path_len; // Length of path
+} Sample;
+
+typedef struct {
+ // Features
+ LV2_URID_Map* map;
+ LV2_Worker_Schedule* schedule;
+ LV2_Log_Logger logger;
+
+ // Ports
+ const LV2_Atom_Sequence* control_port;
+ LV2_Atom_Sequence* notify_port;
+ float* output_port;
+
+ // Communication utilities
+ LV2_Atom_Forge_Frame notify_frame; ///< Cached for worker replies
+ LV2_Atom_Forge forge; ///< Forge for writing atoms in run thread
+ PeaksSender psend; ///< Audio peaks sender
+
+ // URIs
+ SamplerURIs uris;
+
+ // Playback state
+ Sample* sample;
+ uint32_t frame_offset;
+ float gain;
+ sf_count_t frame;
+ bool play;
+ bool activated;
+ bool sample_changed;
+} Sampler;
+
+/**
+ An atom-like message used internally to apply/free samples.
+
+ This is only used internally to communicate with the worker, it is never
+ sent to the outside world via a port since it is not POD. It is convenient
+ to use an Atom header so actual atoms can be easily sent through the same
+ ringbuffer.
+*/
+typedef struct {
+ LV2_Atom atom;
+ Sample* sample;
+} SampleMessage;
+
+/**
+ Load a new sample and return it.
+
+ Since this is of course not a real-time safe action, this is called in the
+ worker thread only. The sample is loaded and returned only, plugin state is
+ not modified.
+*/
+static Sample*
+load_sample(LV2_Log_Logger* logger, const char* path)
+{
+ lv2_log_trace(logger, "Loading %s\n", path);
+
+ const size_t path_len = strlen(path);
+ Sample* const sample = (Sample*)calloc(1, sizeof(Sample));
+ SF_INFO* const info = &sample->info;
+ SNDFILE* const sndfile = sf_open(path, SFM_READ, info);
+ float* data = NULL;
+ bool error = true;
+ if (!sndfile || !info->frames) {
+ lv2_log_error(logger, "Failed to open %s\n", path);
+ } else if (info->channels != 1) {
+ lv2_log_error(logger, "%s has %d channels\n", path, info->channels);
+ } else if (!(data = (float*)malloc(sizeof(float) * info->frames))) {
+ lv2_log_error(logger, "Failed to allocate memory for sample\n");
+ } else {
+ error = false;
+ }
+
+ if (error) {
+ free(sample);
+ free(data);
+ sf_close(sndfile);
+ return NULL;
+ }
+
+ sf_seek(sndfile, 0ul, SEEK_SET);
+ sf_read_float(sndfile, data, info->frames);
+ sf_close(sndfile);
+
+ // Fill sample struct and return it
+ sample->data = data;
+ sample->path = (char*)malloc(path_len + 1);
+ sample->path_len = (uint32_t)path_len;
+ memcpy(sample->path, path, path_len + 1);
+
+ return sample;
+}
+
+static void
+free_sample(Sampler* self, Sample* sample)
+{
+ if (sample) {
+ lv2_log_trace(&self->logger, "Freeing %s\n", sample->path);
+ free(sample->path);
+ free(sample->data);
+ free(sample);
+ }
+}
+
+/**
+ Do work in a non-realtime thread.
+
+ This is called for every piece of work scheduled in the audio thread using
+ self->schedule->schedule_work(). A reply can be sent back to the audio
+ thread using the provided `respond` function.
+*/
+static LV2_Worker_Status
+work(LV2_Handle instance,
+ LV2_Worker_Respond_Function respond,
+ LV2_Worker_Respond_Handle handle,
+ uint32_t size,
+ const void* data)
+{
+ Sampler* self = (Sampler*)instance;
+ const LV2_Atom* atom = (const LV2_Atom*)data;
+ if (atom->type == self->uris.eg_freeSample) {
+ // Free old sample
+ const SampleMessage* msg = (const SampleMessage*)data;
+ free_sample(self, msg->sample);
+ } else if (atom->type == self->forge.Object) {
+ // Handle set message (load sample).
+ const LV2_Atom_Object* obj = (const LV2_Atom_Object*)data;
+ const char* path = read_set_file(&self->uris, obj);
+ if (!path) {
+ lv2_log_error(&self->logger, "Malformed set file request\n");
+ return LV2_WORKER_ERR_UNKNOWN;
+ }
+
+ // Load sample.
+ Sample* sample = load_sample(&self->logger, path);
+ if (sample) {
+ // Send new sample to run() to be applied
+ respond(handle, sizeof(sample), &sample);
+ }
+ }
+
+ return LV2_WORKER_SUCCESS;
+}
+
+/**
+ Handle a response from work() in the audio thread.
+
+ When running normally, this will be called by the host after run(). When
+ freewheeling, this will be called immediately at the point the work was
+ scheduled.
+*/
+static LV2_Worker_Status
+work_response(LV2_Handle instance,
+ uint32_t size,
+ const void* data)
+{
+ Sampler* self = (Sampler*)instance;
+ Sample* old_sample = self->sample;
+ Sample* new_sample = *(Sample*const*)data;
+
+ // Install the new sample
+ self->sample = *(Sample*const*)data;
+
+ // Schedule work to free the old sample
+ SampleMessage msg = { { sizeof(Sample*), self->uris.eg_freeSample },
+ old_sample };
+ self->schedule->schedule_work(self->schedule->handle, sizeof(msg), &msg);
+
+ // Send a notification that we're using a new sample
+ lv2_atom_forge_frame_time(&self->forge, self->frame_offset);
+ write_set_file(&self->forge, &self->uris,
+ new_sample->path,
+ new_sample->path_len);
+
+ return LV2_WORKER_SUCCESS;
+}
+
+static void
+connect_port(LV2_Handle instance,
+ uint32_t port,
+ void* data)
+{
+ Sampler* self = (Sampler*)instance;
+ switch (port) {
+ case SAMPLER_CONTROL:
+ self->control_port = (const LV2_Atom_Sequence*)data;
+ break;
+ case SAMPLER_NOTIFY:
+ self->notify_port = (LV2_Atom_Sequence*)data;
+ break;
+ case SAMPLER_OUT:
+ self->output_port = (float*)data;
+ break;
+ default:
+ break;
+ }
+}
+
+static LV2_Handle
+instantiate(const LV2_Descriptor* descriptor,
+ double rate,
+ const char* path,
+ const LV2_Feature* const* features)
+{
+ // Allocate and initialise instance structure.
+ Sampler* self = (Sampler*)calloc(1, sizeof(Sampler));
+ if (!self) {
+ return NULL;
+ }
+
+ // Get host features
+ const char* missing = lv2_features_query(
+ features,
+ LV2_LOG__log, &self->logger.log, false,
+ LV2_URID__map, &self->map, true,
+ LV2_WORKER__schedule, &self->schedule, true,
+ NULL);
+ lv2_log_logger_set_map(&self->logger, self->map);
+ if (missing) {
+ lv2_log_error(&self->logger, "Missing feature <%s>\n", missing);
+ free(self);
+ return NULL;
+ }
+
+ // Map URIs and initialise forge
+ map_sampler_uris(self->map, &self->uris);
+ lv2_atom_forge_init(&self->forge, self->map);
+ peaks_sender_init(&self->psend, self->map);
+
+ self->gain = 1.0;
+
+ return (LV2_Handle)self;
+}
+
+static void
+cleanup(LV2_Handle instance)
+{
+ Sampler* self = (Sampler*)instance;
+ free_sample(self, self->sample);
+ free(self);
+}
+
+static void
+activate(LV2_Handle instance)
+{
+ ((Sampler*)instance)->activated = true;
+}
+
+static void
+deactivate(LV2_Handle instance)
+{
+ ((Sampler*)instance)->activated = false;
+}
+
+/** Define a macro for converting a gain in dB to a coefficient. */
+#define DB_CO(g) ((g) > -90.0f ? powf(10.0f, (g) * 0.05f) : 0.0f)
+
+/**
+ Handle an incoming event in the audio thread.
+
+ This performs any actions triggered by an event, such as the start of sample
+ playback, a sample change, or responding to requests from the UI.
+*/
+static void
+handle_event(Sampler* self, LV2_Atom_Event* ev)
+{
+ SamplerURIs* uris = &self->uris;
+ PeaksURIs* peaks_uris = &self->psend.uris;
+
+ if (ev->body.type == uris->midi_Event) {
+ const uint8_t* const msg = (const uint8_t*)LV2_ATOM_BODY_CONST(ev);
+ switch (lv2_midi_message_type(msg)) {
+ case LV2_MIDI_MSG_NOTE_ON:
+ self->frame = 0;
+ self->play = true;
+ break;
+ default:
+ break;
+ }
+ } else if (lv2_atom_forge_is_object_type(&self->forge, ev->body.type)) {
+ const LV2_Atom_Object* obj = (const LV2_Atom_Object*)&ev->body;
+ if (obj->body.otype == uris->patch_Set) {
+ // Get the property and value of the set message
+ const LV2_Atom* property = NULL;
+ const LV2_Atom* value = NULL;
+ lv2_atom_object_get(obj,
+ uris->patch_property, &property,
+ uris->patch_value, &value,
+ 0);
+ if (!property) {
+ lv2_log_error(&self->logger, "Set message with no property\n");
+ return;
+ } else if (property->type != uris->atom_URID) {
+ lv2_log_error(&self->logger, "Set property is not a URID\n");
+ return;
+ }
+
+ const uint32_t key = ((const LV2_Atom_URID*)property)->body;
+ if (key == uris->eg_sample) {
+ // Sample change, send it to the worker.
+ lv2_log_trace(&self->logger, "Scheduling sample change\n");
+ self->schedule->schedule_work(self->schedule->handle,
+ lv2_atom_total_size(&ev->body),
+ &ev->body);
+ } else if (key == uris->param_gain) {
+ // Gain change
+ if (value->type == uris->atom_Float) {
+ self->gain = DB_CO(((LV2_Atom_Float*)value)->body);
+ }
+ }
+ } else if (obj->body.otype == uris->patch_Get && self->sample) {
+ const LV2_Atom_URID* accept = NULL;
+ const LV2_Atom_Int* n_peaks = NULL;
+ lv2_atom_object_get_typed(
+ obj,
+ uris->patch_accept, &accept, uris->atom_URID,
+ peaks_uris->peaks_total, &n_peaks, peaks_uris->atom_Int, 0);
+ if (accept && accept->body == peaks_uris->peaks_PeakUpdate) {
+ // Received a request for peaks, prepare for transmission
+ peaks_sender_start(&self->psend,
+ self->sample->data,
+ self->sample->info.frames,
+ n_peaks->body);
+ } else {
+ // Received a get message, emit our state (probably to UI)
+ lv2_atom_forge_frame_time(&self->forge, self->frame_offset);
+ write_set_file(&self->forge, &self->uris,
+ self->sample->path,
+ self->sample->path_len);
+ }
+ } else {
+ lv2_log_trace(&self->logger,
+ "Unknown object type %d\n", obj->body.otype);
+ }
+ } else {
+ lv2_log_trace(&self->logger,
+ "Unknown event type %d\n", ev->body.type);
+ }
+
+}
+
+/**
+ Output audio for a slice of the current cycle.
+*/
+static void
+render(Sampler* self, uint32_t start, uint32_t end)
+{
+ float* output = self->output_port;
+
+ if (self->play && self->sample) {
+ // Start/continue writing sample to output
+ for (; start < end; ++start) {
+ output[start] = self->sample->data[self->frame] * self->gain;
+ if (++self->frame == self->sample->info.frames) {
+ self->play = false; // Reached end of sample
+ break;
+ }
+ }
+ }
+
+ // Write silence to remaining buffer
+ for (; start < end; ++start) {
+ output[start] = 0.0f;
+ }
+}
+
+static void
+run(LV2_Handle instance, uint32_t sample_count)
+{
+ Sampler* self = (Sampler*)instance;
+
+ // Set up forge to write directly to notify output port.
+ const uint32_t notify_capacity = self->notify_port->atom.size;
+ lv2_atom_forge_set_buffer(&self->forge,
+ (uint8_t*)self->notify_port,
+ notify_capacity);
+
+ // Start a sequence in the notify output port.
+ lv2_atom_forge_sequence_head(&self->forge, &self->notify_frame, 0);
+
+ // Send update to UI if sample has changed due to state restore
+ if (self->sample_changed) {
+ lv2_atom_forge_frame_time(&self->forge, 0);
+ write_set_file(&self->forge, &self->uris,
+ self->sample->path,
+ self->sample->path_len);
+ self->sample_changed = false;
+ }
+
+ // Iterate over incoming events, emitting audio along the way
+ self->frame_offset = 0;
+ LV2_ATOM_SEQUENCE_FOREACH(self->control_port, ev) {
+ // Render output up to the time of this event
+ render(self, self->frame_offset, ev->time.frames);
+
+ /* Update current frame offset to this event's time. This is stored in
+ the instance because it is used for sychronous worker event
+ execution. This allows a sample load event to be executed with
+ sample accuracy when running in a non-realtime context (such as
+ exporting a session). */
+ self->frame_offset = ev->time.frames;
+
+ // Process this event
+ handle_event(self, ev);
+ }
+
+ // Use available space after any emitted events to send peaks
+ peaks_sender_send(&self->psend, &self->forge, sample_count, self->frame_offset);
+
+ // Render output for the rest of the cycle past the last event
+ render(self, self->frame_offset, sample_count);
+}
+
+static LV2_State_Status
+save(LV2_Handle instance,
+ LV2_State_Store_Function store,
+ LV2_State_Handle handle,
+ uint32_t flags,
+ const LV2_Feature* const* features)
+{
+ Sampler* self = (Sampler*)instance;
+ if (!self->sample) {
+ return LV2_STATE_SUCCESS;
+ }
+
+ LV2_State_Map_Path* map_path = (LV2_State_Map_Path*)lv2_features_data(
+ features, LV2_STATE__mapPath);
+ if (!map_path) {
+ return LV2_STATE_ERR_NO_FEATURE;
+ }
+
+ // Map absolute sample path to an abstract state path
+ char* apath = map_path->abstract_path(map_path->handle, self->sample->path);
+
+ // Store eg:sample = abstract path
+ store(handle,
+ self->uris.eg_sample,
+ apath,
+ strlen(apath) + 1,
+ self->uris.atom_Path,
+ LV2_STATE_IS_POD | LV2_STATE_IS_PORTABLE);
+
+ free(apath);
+ return LV2_STATE_SUCCESS;
+}
+
+static LV2_State_Status
+restore(LV2_Handle instance,
+ LV2_State_Retrieve_Function retrieve,
+ LV2_State_Handle handle,
+ uint32_t flags,
+ const LV2_Feature* const* features)
+{
+ Sampler* self = (Sampler*)instance;
+
+ // Get host features
+ LV2_Worker_Schedule* schedule = NULL;
+ LV2_State_Map_Path* paths = NULL;
+ const char* missing = lv2_features_query(
+ features,
+ LV2_STATE__mapPath, &paths, true,
+ LV2_WORKER__schedule, &schedule, false,
+ NULL);
+ if (missing) {
+ lv2_log_error(&self->logger, "Missing feature <%s>\n", missing);
+ return LV2_STATE_ERR_NO_FEATURE;
+ }
+
+ // Get eg:sample from state
+ size_t size;
+ uint32_t type;
+ uint32_t valflags;
+ const void* value = retrieve(handle, self->uris.eg_sample,
+ &size, &type, &valflags);
+ if (!value) {
+ lv2_log_error(&self->logger, "Missing eg:sample\n");
+ return LV2_STATE_ERR_NO_PROPERTY;
+ } else if (type != self->uris.atom_Path) {
+ lv2_log_error(&self->logger, "Non-path eg:sample\n");
+ return LV2_STATE_ERR_BAD_TYPE;
+ }
+
+ // Map abstract state path to absolute path
+ const char* apath = (const char*)value;
+ char* path = paths->absolute_path(paths->handle, apath);
+
+ // Replace current sample with the new one
+ if (!self->activated || !schedule) {
+ // No scheduling available, load sample immediately
+ lv2_log_trace(&self->logger, "Synchronous restore\n");
+ Sample* sample = load_sample(&self->logger, path);
+ if (sample) {
+ free_sample(self, self->sample);
+ self->sample = sample;
+ self->sample_changed = true;
+ }
+ } else {
+ // Schedule sample to be loaded by the provided worker
+ lv2_log_trace(&self->logger, "Scheduling restore\n");
+ LV2_Atom_Forge forge;
+ LV2_Atom* buf = (LV2_Atom*)calloc(1, strlen(path) + 128);
+ lv2_atom_forge_init(&forge, self->map);
+ lv2_atom_forge_set_sink(&forge, atom_sink, atom_sink_deref, buf);
+ write_set_file(&forge, &self->uris, path, strlen(path));
+
+ const uint32_t msg_size = lv2_atom_pad_size(buf->size);
+ schedule->schedule_work(self->schedule->handle, msg_size, buf + 1);
+ free(buf);
+ }
+
+ free(path);
+
+ return LV2_STATE_SUCCESS;
+}
+
+static const void*
+extension_data(const char* uri)
+{
+ static const LV2_State_Interface state = { save, restore };
+ static const LV2_Worker_Interface worker = { work, work_response, NULL };
+ if (!strcmp(uri, LV2_STATE__interface)) {
+ return &state;
+ } else if (!strcmp(uri, LV2_WORKER__interface)) {
+ return &worker;
+ }
+ return NULL;
+}
+
+static const LV2_Descriptor descriptor = {
+ EG_SAMPLER_URI,
+ instantiate,
+ connect_port,
+ activate,
+ run,
+ deactivate,
+ cleanup,
+ extension_data
+};
+
+LV2_SYMBOL_EXPORT
+const LV2_Descriptor* lv2_descriptor(uint32_t index)
+{
+ switch (index) {
+ case 0:
+ return &descriptor;
+ default:
+ return NULL;
+ }
+}
diff --git a/plugins/eg04-sampler.lv2/sampler.ttl b/plugins/eg-sampler.lv2/sampler.ttl
index f705dd1..f5088f3 100644
--- a/plugins/eg04-sampler.lv2/sampler.ttl
+++ b/plugins/eg-sampler.lv2/sampler.ttl
@@ -1,12 +1,14 @@
@prefix atom: <http://lv2plug.in/ns/ext/atom#> .
@prefix doap: <http://usefulinc.com/ns/doap#> .
@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix param: <http://lv2plug.in/ns/ext/parameters#> .
@prefix patch: <http://lv2plug.in/ns/ext/patch#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix state: <http://lv2plug.in/ns/ext/state#> .
@prefix ui: <http://lv2plug.in/ns/extensions/ui#> .
@prefix urid: <http://lv2plug.in/ns/ext/urid#> .
@prefix work: <http://lv2plug.in/ns/ext/worker#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
<http://lv2plug.in/plugins/eg-sampler#sample>
a lv2:Parameter ;
@@ -15,17 +17,19 @@
<http://lv2plug.in/plugins/eg-sampler>
a lv2:Plugin ;
- doap:name "Example Sampler" ;
+ doap:name "Exampler" ;
doap:license <http://opensource.org/licenses/isc> ;
lv2:project <http://lv2plug.in/ns/lv2> ;
- lv2:requiredFeature urid:map ,
+ lv2:requiredFeature state:loadDefaultState ,
+ urid:map ,
work:schedule ;
lv2:optionalFeature lv2:hardRTCapable ,
- state:loadDefaultState ;
+ state:threadSafeRestore ;
lv2:extensionData state:interface ,
work:interface ;
ui:ui <http://lv2plug.in/plugins/eg-sampler#ui> ;
- patch:writable <http://lv2plug.in/plugins/eg-sampler#sample> ;
+ patch:writable <http://lv2plug.in/plugins/eg-sampler#sample> ,
+ param:gain ;
lv2:port [
a lv2:InputPort ,
atom:AtomPort ;
@@ -53,12 +57,15 @@
lv2:name "Out"
] ;
state:state [
- <http://lv2plug.in/plugins/eg-sampler#sample> <click.wav>
+ <http://lv2plug.in/plugins/eg-sampler#sample> <click.wav> ;
+ param:gain "1.0"^^xsd:float
] .
<http://lv2plug.in/plugins/eg-sampler#ui>
a ui:GtkUI ;
lv2:requiredFeature urid:map ;
+ lv2:optionalFeature ui:requestValue ;
+ lv2:extensionData ui:showInterface ;
ui:portNotification [
ui:plugin <http://lv2plug.in/plugins/eg-sampler> ;
lv2:symbol "notify" ;
diff --git a/plugins/eg-sampler.lv2/sampler_ui.c b/plugins/eg-sampler.lv2/sampler_ui.c
new file mode 100644
index 0000000..b5e40db
--- /dev/null
+++ b/plugins/eg-sampler.lv2/sampler_ui.c
@@ -0,0 +1,465 @@
+/*
+ LV2 Sampler Example Plugin UI
+ Copyright 2011-2016 David Robillard <d@drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#include "peaks.h"
+#include "uris.h"
+
+#include "lv2/atom/atom.h"
+#include "lv2/atom/forge.h"
+#include "lv2/atom/util.h"
+#include "lv2/core/lv2.h"
+#include "lv2/core/lv2_util.h"
+#include "lv2/log/log.h"
+#include "lv2/log/logger.h"
+#include "lv2/midi/midi.h"
+#include "lv2/ui/ui.h"
+#include "lv2/urid/urid.h"
+
+#include <cairo.h>
+#include <gdk/gdk.h>
+#include <glib-object.h>
+#include <glib.h>
+#include <gobject/gclosure.h>
+#include <gtk/gtk.h>
+
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include <string.h>
+
+#define SAMPLER_UI_URI "http://lv2plug.in/plugins/eg-sampler#ui"
+
+#define MIN_CANVAS_W 128
+#define MIN_CANVAS_H 80
+
+typedef struct {
+ LV2_Atom_Forge forge;
+ LV2_URID_Map* map;
+ LV2UI_Request_Value* request_value;
+ LV2_Log_Logger logger;
+ SamplerURIs uris;
+ PeaksReceiver precv;
+
+ LV2UI_Write_Function write;
+ LV2UI_Controller controller;
+
+ GtkWidget* box;
+ GtkWidget* play_button;
+ GtkWidget* file_button;
+ GtkWidget* request_file_button;
+ GtkWidget* button_box;
+ GtkWidget* canvas;
+
+ uint32_t width;
+ uint32_t requested_n_peaks;
+ char* filename;
+
+ uint8_t forge_buf[1024];
+
+ // Optional show/hide interface
+ GtkWidget* window;
+ bool did_init;
+} SamplerUI;
+
+static void
+on_file_set(GtkFileChooserButton* widget, void* handle)
+{
+ SamplerUI* ui = (SamplerUI*)handle;
+
+ // Get the filename from the file chooser
+ char* filename = gtk_file_chooser_get_filename(GTK_FILE_CHOOSER(widget));
+
+ // Write a set message to the plugin to load new file
+ lv2_atom_forge_set_buffer(&ui->forge, ui->forge_buf, sizeof(ui->forge_buf));
+ LV2_Atom* msg = (LV2_Atom*)write_set_file(&ui->forge, &ui->uris,
+ filename, strlen(filename));
+
+ ui->write(ui->controller, 0, lv2_atom_total_size(msg),
+ ui->uris.atom_eventTransfer,
+ msg);
+
+ g_free(filename);
+}
+
+static void
+on_request_file(GtkButton* widget, void* handle)
+{
+ SamplerUI* ui = (SamplerUI*)handle;
+
+ ui->request_value->request(ui->request_value->handle,
+ ui->uris.eg_sample,
+ 0,
+ NULL);
+}
+
+static void
+on_play_clicked(GtkFileChooserButton* widget, void* handle)
+{
+ SamplerUI* ui = (SamplerUI*)handle;
+ struct {
+ LV2_Atom atom;
+ uint8_t msg[3];
+ } note_on;
+
+ note_on.atom.type = ui->uris.midi_Event;
+ note_on.atom.size = 3;
+ note_on.msg[0] = LV2_MIDI_MSG_NOTE_ON;
+ note_on.msg[1] = 60;
+ note_on.msg[2] = 60;
+ ui->write(ui->controller, 0, sizeof(note_on),
+ ui->uris.atom_eventTransfer,
+ &note_on);
+}
+
+static void
+request_peaks(SamplerUI* ui, uint32_t n_peaks)
+{
+ if (n_peaks == ui->requested_n_peaks) {
+ return;
+ }
+
+ lv2_atom_forge_set_buffer(&ui->forge, ui->forge_buf, sizeof(ui->forge_buf));
+
+ LV2_Atom_Forge_Frame frame;
+ lv2_atom_forge_object(&ui->forge, &frame, 0, ui->uris.patch_Get);
+ lv2_atom_forge_key(&ui->forge, ui->uris.patch_accept);
+ lv2_atom_forge_urid(&ui->forge, ui->precv.uris.peaks_PeakUpdate);
+ lv2_atom_forge_key(&ui->forge, ui->precv.uris.peaks_total);
+ lv2_atom_forge_int(&ui->forge, n_peaks);
+ lv2_atom_forge_pop(&ui->forge, &frame);
+
+ LV2_Atom* msg = lv2_atom_forge_deref(&ui->forge, frame.ref);
+ ui->write(ui->controller, 0, lv2_atom_total_size(msg),
+ ui->uris.atom_eventTransfer,
+ msg);
+
+ ui->requested_n_peaks = n_peaks;
+}
+
+/** Set Cairo color to a GDK color (to follow Gtk theme). */
+static void
+cairo_set_source_gdk(cairo_t* cr, const GdkColor* color)
+{
+ cairo_set_source_rgb(
+ cr, color->red / 65535.0, color->green / 65535.0, color->blue / 65535.0);
+
+}
+
+static gboolean
+on_canvas_expose(GtkWidget* widget, GdkEventExpose* event, gpointer data)
+{
+ SamplerUI* ui = (SamplerUI*)data;
+
+ GtkAllocation size;
+ gtk_widget_get_allocation(widget, &size);
+
+ ui->width = size.width;
+ if ((uint32_t)ui->width > 2 * ui->requested_n_peaks) {
+ request_peaks(ui, 2 * ui->requested_n_peaks);
+ }
+
+ cairo_t* cr = gdk_cairo_create(gtk_widget_get_window(widget));
+
+ cairo_set_line_width(cr, 1.0);
+ cairo_translate(cr, 0.5, 0.5);
+
+ const int mid_y = size.height / 2;
+
+ const float* const peaks = ui->precv.peaks;
+ const int32_t n_peaks = ui->precv.n_peaks;
+ if (peaks) {
+ // Draw waveform
+ const double scale = size.width / ((double)n_peaks - 1.0f);
+
+ // Start at left origin
+ cairo_move_to(cr, 0, mid_y);
+
+ // Draw line through top peaks
+ for (int i = 0; i < n_peaks; ++i) {
+ const float peak = peaks[i];
+ cairo_line_to(cr, i * scale, mid_y + (peak / 2.0f) * size.height);
+ }
+
+ // Continue through bottom peaks
+ for (int i = n_peaks - 1; i >= 0; --i) {
+ const float peak = peaks[i];
+ cairo_line_to(cr, i * scale, mid_y - (peak / 2.0f) * size.height);
+ }
+
+ // Close shape
+ cairo_line_to(cr, 0, mid_y);
+
+ cairo_set_source_gdk(cr, widget->style->mid);
+ cairo_fill_preserve(cr);
+
+ cairo_set_source_gdk(cr, widget->style->fg);
+ cairo_stroke(cr);
+ }
+
+ cairo_destroy(cr);
+ return TRUE;
+}
+
+static void
+destroy_window(SamplerUI* ui)
+{
+ if (ui->window) {
+ gtk_container_remove(GTK_CONTAINER(ui->window), ui->box);
+ gtk_widget_destroy(ui->window);
+ ui->window = NULL;
+ }
+}
+
+static gboolean
+on_window_closed(GtkWidget* widget, GdkEvent* event, gpointer data)
+{
+ SamplerUI* ui = (SamplerUI*)data;
+
+ // Remove widget so Gtk doesn't delete it when the window is closed
+ gtk_container_remove(GTK_CONTAINER(ui->window), ui->box);
+ ui->window = NULL;
+
+ return FALSE;
+}
+
+static LV2UI_Handle
+instantiate(const LV2UI_Descriptor* descriptor,
+ const char* plugin_uri,
+ const char* bundle_path,
+ LV2UI_Write_Function write_function,
+ LV2UI_Controller controller,
+ LV2UI_Widget* widget,
+ const LV2_Feature* const* features)
+{
+ SamplerUI* ui = (SamplerUI*)calloc(1, sizeof(SamplerUI));
+ if (!ui) {
+ return NULL;
+ }
+
+ ui->write = write_function;
+ ui->controller = controller;
+ ui->width = MIN_CANVAS_W;
+ *widget = NULL;
+ ui->window = NULL;
+ ui->did_init = false;
+
+ // Get host features
+ const char* missing = lv2_features_query(
+ features,
+ LV2_LOG__log, &ui->logger.log , false,
+ LV2_URID__map, &ui->map, true,
+ LV2_UI__requestValue, &ui->request_value, false,
+ NULL);
+ lv2_log_logger_set_map(&ui->logger, ui->map);
+ if (missing) {
+ lv2_log_error(&ui->logger, "Missing feature <%s>\n", missing);
+ free(ui);
+ return NULL;
+ }
+
+ // Map URIs and initialise forge
+ map_sampler_uris(ui->map, &ui->uris);
+ lv2_atom_forge_init(&ui->forge, ui->map);
+ peaks_receiver_init(&ui->precv, ui->map);
+
+ // Construct Gtk UI
+ ui->box = gtk_vbox_new(FALSE, 4);
+ ui->play_button = gtk_button_new_with_label("▶");
+ ui->canvas = gtk_drawing_area_new();
+ ui->button_box = gtk_hbox_new(FALSE, 4);
+ ui->file_button = gtk_file_chooser_button_new(
+ "Load Sample", GTK_FILE_CHOOSER_ACTION_OPEN);
+ ui->request_file_button = gtk_button_new_with_label("Request Sample");
+ gtk_widget_set_size_request(ui->canvas, MIN_CANVAS_W, MIN_CANVAS_H);
+ gtk_container_set_border_width(GTK_CONTAINER(ui->box), 4);
+ gtk_box_pack_start(GTK_BOX(ui->box), ui->canvas, TRUE, TRUE, 0);
+ gtk_box_pack_start(GTK_BOX(ui->box), ui->button_box, FALSE, TRUE, 0);
+ gtk_box_pack_start(GTK_BOX(ui->button_box), ui->play_button, FALSE, FALSE, 0);
+ gtk_box_pack_start(GTK_BOX(ui->button_box), ui->request_file_button, FALSE, FALSE, 0);
+ gtk_box_pack_start(GTK_BOX(ui->button_box), ui->file_button, TRUE, TRUE, 0);
+
+ g_signal_connect(ui->file_button, "file-set",
+ G_CALLBACK(on_file_set), ui);
+
+ g_signal_connect(ui->request_file_button, "clicked",
+ G_CALLBACK(on_request_file), ui);
+
+ g_signal_connect(ui->play_button, "clicked",
+ G_CALLBACK(on_play_clicked), ui);
+
+ g_signal_connect(G_OBJECT(ui->canvas), "expose_event",
+ G_CALLBACK(on_canvas_expose), ui);
+
+ // Request state (filename) from plugin
+ lv2_atom_forge_set_buffer(&ui->forge, ui->forge_buf, sizeof(ui->forge_buf));
+ LV2_Atom_Forge_Frame frame;
+ LV2_Atom* msg = (LV2_Atom*)lv2_atom_forge_object(
+ &ui->forge, &frame, 0, ui->uris.patch_Get);
+ lv2_atom_forge_pop(&ui->forge, &frame);
+
+ ui->write(ui->controller, 0, lv2_atom_total_size(msg),
+ ui->uris.atom_eventTransfer,
+ msg);
+
+ *widget = ui->box;
+
+ return ui;
+}
+
+static void
+cleanup(LV2UI_Handle handle)
+{
+ SamplerUI* ui = (SamplerUI*)handle;
+
+ if (ui->window) {
+ destroy_window(ui);
+ }
+
+ gtk_widget_destroy(ui->canvas);
+ gtk_widget_destroy(ui->play_button);
+ gtk_widget_destroy(ui->file_button);
+ gtk_widget_destroy(ui->request_file_button);
+ gtk_widget_destroy(ui->button_box);
+ gtk_widget_destroy(ui->box);
+ free(ui);
+}
+
+static void
+port_event(LV2UI_Handle handle,
+ uint32_t port_index,
+ uint32_t buffer_size,
+ uint32_t format,
+ const void* buffer)
+{
+ SamplerUI* ui = (SamplerUI*)handle;
+ if (format == ui->uris.atom_eventTransfer) {
+ const LV2_Atom* atom = (const LV2_Atom*)buffer;
+ if (lv2_atom_forge_is_object_type(&ui->forge, atom->type)) {
+ const LV2_Atom_Object* obj = (const LV2_Atom_Object*)atom;
+ if (obj->body.otype == ui->uris.patch_Set) {
+ const char* path = read_set_file(&ui->uris, obj);
+ if (path && (!ui->filename || strcmp(path, ui->filename))) {
+ g_free(ui->filename);
+ ui->filename = g_strdup(path);
+ gtk_file_chooser_set_filename(
+ GTK_FILE_CHOOSER(ui->file_button), path);
+ peaks_receiver_clear(&ui->precv);
+ ui->requested_n_peaks = 0;
+ request_peaks(ui, ui->width / 2 * 2);
+ } else if (!path) {
+ lv2_log_warning(&ui->logger, "Set message has no path\n");
+ }
+ } else if (obj->body.otype == ui->precv.uris.peaks_PeakUpdate) {
+ if (!peaks_receiver_receive(&ui->precv, obj)) {
+ gtk_widget_queue_draw(ui->canvas);
+ }
+ }
+ } else {
+ lv2_log_error(&ui->logger, "Unknown message type\n");
+ }
+ } else {
+ lv2_log_warning(&ui->logger, "Unknown port event format\n");
+ }
+}
+
+/* Optional non-embedded UI show interface. */
+static int
+ui_show(LV2UI_Handle handle)
+{
+ SamplerUI* ui = (SamplerUI*)handle;
+
+ if (ui->window) {
+ return 0;
+ }
+
+ if (!ui->did_init) {
+ int argc = 0;
+ gtk_init_check(&argc, NULL);
+ g_object_ref(ui->box);
+ ui->did_init = true;
+ }
+
+ ui->window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
+ gtk_container_add(GTK_CONTAINER(ui->window), ui->box);
+
+ g_signal_connect(G_OBJECT(ui->window),
+ "delete-event",
+ G_CALLBACK(on_window_closed),
+ handle);
+
+ gtk_widget_show_all(ui->window);
+ gtk_window_present(GTK_WINDOW(ui->window));
+
+ return 0;
+}
+
+/* Optional non-embedded UI hide interface. */
+static int
+ui_hide(LV2UI_Handle handle)
+{
+ SamplerUI* ui = (SamplerUI*)handle;
+
+ if (ui->window) {
+ destroy_window(ui);
+ }
+
+ return 0;
+}
+
+/* Idle interface for optional non-embedded UI. */
+static int
+ui_idle(LV2UI_Handle handle)
+{
+ SamplerUI* ui = (SamplerUI*)handle;
+ if (ui->window) {
+ gtk_main_iteration_do(false);
+ }
+ return 0;
+}
+
+static const void*
+extension_data(const char* uri)
+{
+ static const LV2UI_Show_Interface show = { ui_show, ui_hide };
+ static const LV2UI_Idle_Interface idle = { ui_idle };
+ if (!strcmp(uri, LV2_UI__showInterface)) {
+ return &show;
+ } else if (!strcmp(uri, LV2_UI__idleInterface)) {
+ return &idle;
+ }
+ return NULL;
+}
+
+static const LV2UI_Descriptor descriptor = {
+ SAMPLER_UI_URI,
+ instantiate,
+ cleanup,
+ port_event,
+ extension_data
+};
+
+LV2_SYMBOL_EXPORT
+const LV2UI_Descriptor*
+lv2ui_descriptor(uint32_t index)
+{
+ switch (index) {
+ case 0:
+ return &descriptor;
+ default:
+ return NULL;
+ }
+}
diff --git a/plugins/eg04-sampler.lv2/uris.h b/plugins/eg-sampler.lv2/uris.h
index e2ec6d0..1609db7 100644
--- a/plugins/eg04-sampler.lv2/uris.h
+++ b/plugins/eg-sampler.lv2/uris.h
@@ -1,6 +1,6 @@
/*
LV2 Sampler Example Plugin
- Copyright 2011-2012 David Robillard <d@drobilla.net>
+ Copyright 2011-2016 David Robillard <d@drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -18,27 +18,34 @@
#ifndef SAMPLER_URIS_H
#define SAMPLER_URIS_H
-#include "lv2/lv2plug.in/ns/ext/log/log.h"
-#include "lv2/lv2plug.in/ns/ext/midi/midi.h"
-#include "lv2/lv2plug.in/ns/ext/state/state.h"
+#include "lv2/log/log.h"
+#include "lv2/midi/midi.h"
+#include "lv2/parameters/parameters.h"
+#include "lv2/patch/patch.h"
+#include "lv2/state/state.h"
+
+#include <stdio.h>
#define EG_SAMPLER_URI "http://lv2plug.in/plugins/eg-sampler"
-#define EG_SAMPLER__sample EG_SAMPLER_URI "#sample"
#define EG_SAMPLER__applySample EG_SAMPLER_URI "#applySample"
#define EG_SAMPLER__freeSample EG_SAMPLER_URI "#freeSample"
+#define EG_SAMPLER__sample EG_SAMPLER_URI "#sample"
typedef struct {
- LV2_URID atom_Blank;
+ LV2_URID atom_Float;
LV2_URID atom_Path;
LV2_URID atom_Resource;
LV2_URID atom_Sequence;
LV2_URID atom_URID;
LV2_URID atom_eventTransfer;
LV2_URID eg_applySample;
- LV2_URID eg_sample;
LV2_URID eg_freeSample;
+ LV2_URID eg_sample;
LV2_URID midi_Event;
+ LV2_URID param_gain;
+ LV2_URID patch_Get;
LV2_URID patch_Set;
+ LV2_URID patch_accept;
LV2_URID patch_property;
LV2_URID patch_value;
} SamplerURIs;
@@ -46,7 +53,7 @@ typedef struct {
static inline void
map_sampler_uris(LV2_URID_Map* map, SamplerURIs* uris)
{
- uris->atom_Blank = map->map(map->handle, LV2_ATOM__Blank);
+ uris->atom_Float = map->map(map->handle, LV2_ATOM__Float);
uris->atom_Path = map->map(map->handle, LV2_ATOM__Path);
uris->atom_Resource = map->map(map->handle, LV2_ATOM__Resource);
uris->atom_Sequence = map->map(map->handle, LV2_ATOM__Sequence);
@@ -56,53 +63,54 @@ map_sampler_uris(LV2_URID_Map* map, SamplerURIs* uris)
uris->eg_freeSample = map->map(map->handle, EG_SAMPLER__freeSample);
uris->eg_sample = map->map(map->handle, EG_SAMPLER__sample);
uris->midi_Event = map->map(map->handle, LV2_MIDI__MidiEvent);
+ uris->param_gain = map->map(map->handle, LV2_PARAMETERS__gain);
+ uris->patch_Get = map->map(map->handle, LV2_PATCH__Get);
uris->patch_Set = map->map(map->handle, LV2_PATCH__Set);
+ uris->patch_accept = map->map(map->handle, LV2_PATCH__accept);
uris->patch_property = map->map(map->handle, LV2_PATCH__property);
uris->patch_value = map->map(map->handle, LV2_PATCH__value);
}
-static inline bool
-is_object_type(const SamplerURIs* uris, LV2_URID type)
-{
- return type == uris->atom_Resource
- || type == uris->atom_Blank;
-}
-
/**
- * Write a message like the following to @p forge:
- * []
- * a patch:Set ;
- * patch:property eg:sample ;
- * patch:value </home/me/foo.wav> .
- */
-static inline LV2_Atom*
+ Write a message like the following to `forge`:
+ [source,turtle]
+ ----
+ []
+ a patch:Set ;
+ patch:property eg:sample ;
+ patch:value </home/me/foo.wav> .
+ ----
+*/
+static inline LV2_Atom_Forge_Ref
write_set_file(LV2_Atom_Forge* forge,
const SamplerURIs* uris,
const char* filename,
- const size_t filename_len)
+ const uint32_t filename_len)
{
LV2_Atom_Forge_Frame frame;
- LV2_Atom* set = (LV2_Atom*)lv2_atom_forge_blank(
- forge, &frame, 1, uris->patch_Set);
+ LV2_Atom_Forge_Ref set = lv2_atom_forge_object(
+ forge, &frame, 0, uris->patch_Set);
- lv2_atom_forge_property_head(forge, uris->patch_property, 0);
+ lv2_atom_forge_key(forge, uris->patch_property);
lv2_atom_forge_urid(forge, uris->eg_sample);
- lv2_atom_forge_property_head(forge, uris->patch_value, 0);
+ lv2_atom_forge_key(forge, uris->patch_value);
lv2_atom_forge_path(forge, filename, filename_len);
lv2_atom_forge_pop(forge, &frame);
-
return set;
}
/**
- * Get the file path from a message like:
- * []
- * a patch:Set ;
- * patch:property eg:sample ;
- * patch:value </home/me/foo.wav> .
- */
-static inline const LV2_Atom*
+ Get the file path from `obj` which is a message like:
+ [source,turtle]
+ ----
+ []
+ a patch:Set ;
+ patch:property eg:sample ;
+ patch:value </home/me/foo.wav> .
+ ----
+*/
+static inline const char*
read_set_file(const SamplerURIs* uris,
const LV2_Atom_Object* obj)
{
@@ -120,23 +128,23 @@ read_set_file(const SamplerURIs* uris,
} else if (property->type != uris->atom_URID) {
fprintf(stderr, "Malformed set message has non-URID property.\n");
return NULL;
- } else if (((LV2_Atom_URID*)property)->body != uris->eg_sample) {
+ } else if (((const LV2_Atom_URID*)property)->body != uris->eg_sample) {
fprintf(stderr, "Set message for unknown property.\n");
return NULL;
}
/* Get value. */
- const LV2_Atom* file_path = NULL;
- lv2_atom_object_get(obj, uris->patch_value, &file_path, 0);
- if (!file_path) {
+ const LV2_Atom* value = NULL;
+ lv2_atom_object_get(obj, uris->patch_value, &value, 0);
+ if (!value) {
fprintf(stderr, "Malformed set message has no value.\n");
return NULL;
- } else if (file_path->type != uris->atom_Path) {
+ } else if (value->type != uris->atom_Path) {
fprintf(stderr, "Set message value is not a Path.\n");
return NULL;
}
- return file_path;
+ return (const char*)LV2_ATOM_BODY_CONST(value);
}
#endif /* SAMPLER_URIS_H */
diff --git a/plugins/eg-sampler.lv2/waf b/plugins/eg-sampler.lv2/waf
new file mode 120000
index 0000000..59a1ac9
--- /dev/null
+++ b/plugins/eg-sampler.lv2/waf
@@ -0,0 +1 @@
+../../waf \ No newline at end of file
diff --git a/plugins/eg-sampler.lv2/wscript b/plugins/eg-sampler.lv2/wscript
new file mode 100644
index 0000000..8c640c1
--- /dev/null
+++ b/plugins/eg-sampler.lv2/wscript
@@ -0,0 +1,64 @@
+#!/usr/bin/env python
+from waflib.extras import autowaf as autowaf
+import re
+
+# Variables for 'waf dist'
+APPNAME = 'eg-sampler.lv2'
+VERSION = '1.0.0'
+
+# Mandatory variables
+top = '.'
+out = 'build'
+
+def options(opt):
+ opt.load('compiler_c')
+ opt.load('lv2')
+ autowaf.set_options(opt)
+
+def configure(conf):
+ conf.load('compiler_c', cache=True)
+ conf.load('lv2', cache=True)
+ conf.load('autowaf', cache=True)
+
+ conf.check_pkg('lv2 >= 1.2.1', uselib_store='LV2')
+ conf.check_pkg('sndfile >= 1.0.0', uselib_store='SNDFILE')
+ conf.check_pkg('gtk+-2.0 >= 2.18.0',
+ uselib_store='GTK2',
+ system=True,
+ mandatory=False)
+ conf.check(features='c cshlib', lib='m', uselib_store='M', mandatory=False)
+
+def build(bld):
+ bundle = 'eg-sampler.lv2'
+
+ # Build manifest.ttl by substitution (for portable lib extension)
+ bld(features = 'subst',
+ source = 'manifest.ttl.in',
+ target = 'lv2/%s/%s' % (bundle, 'manifest.ttl'),
+ install_path = '${LV2DIR}/%s' % bundle,
+ LIB_EXT = bld.env.LV2_LIB_EXT)
+
+ # Copy other data files to build bundle (build/eg-sampler.lv2)
+ for i in ['sampler.ttl', 'click.wav']:
+ bld(features = 'subst',
+ is_copy = True,
+ source = i,
+ target = 'lv2/%s/%s' % (bundle, i),
+ install_path = '${LV2DIR}/%s' % bundle)
+
+ # Build plugin library
+ obj = bld(features = 'c cshlib lv2lib',
+ source = 'sampler.c',
+ name = 'sampler',
+ target = 'lv2/%s/sampler' % bundle,
+ install_path = '${LV2DIR}/%s' % bundle,
+ use = ['M', 'SNDFILE', 'LV2'])
+
+ # Build UI library
+ if bld.env.HAVE_GTK2:
+ obj = bld(features = 'c cshlib lv2lib',
+ source = 'sampler_ui.c',
+ name = 'sampler_ui',
+ target = 'lv2/%s/sampler_ui' % bundle,
+ install_path = '${LV2DIR}/%s' % bundle,
+ use = ['GTK2', 'LV2'])
diff --git a/plugins/eg05-scope.lv2/README.txt b/plugins/eg-scope.lv2/README.txt
index ec3578b..122794c 100644
--- a/plugins/eg05-scope.lv2/README.txt
+++ b/plugins/eg-scope.lv2/README.txt
@@ -1,17 +1,19 @@
== Simple Oscilloscope ==
-This plugin displays the wave-form of an incoming audio-signal using a simple
+This plugin displays the waveform of an incoming audio signal using a simple
GTK+Cairo GUI.
This plugin illustrates:
-- UI <==> Plugin communication via LV2 atom events
-- LV2 Atom vector usage and resize-port extension
+- UI <==> Plugin communication via http://lv2plug.in/ns/ext/atom/[LV2 Atom] events
+- Atom vector usage and resize-port extension
- Save/Restore UI state by communicating state to backend
+- Saving simple key/value state via the http://lv2plug.in/ns/ext/state/[LV2 State] extension
- Cairo drawing and partial exposure
This plugin intends to outline the basics for building visualization plugins
-that rely on Atom communication. The UI looks likean oscilloscope, but is not a real oscilloscope implementation:
+that rely on atom communication. The UI looks like an oscilloscope, but is not
+a real oscilloscope implementation:
- There is no display synchronisation, results will depend on LV2 host.
- It displays raw audio samples, which a proper scope must not do.
diff --git a/plugins/eg05-scope.lv2/examploscope.c b/plugins/eg-scope.lv2/examploscope.c
index 13281ab..a4f5f3f 100644
--- a/plugins/eg05-scope.lv2/examploscope.c
+++ b/plugins/eg-scope.lv2/examploscope.c
@@ -1,4 +1,5 @@
/*
+ Copyright 2016 David Robillard <d@drobilla.net>
Copyright 2013 Robin Gareus <robin@gareus.org>
Permission to use, copy, modify, and/or distribute this software for any
@@ -14,18 +15,32 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+#include "./uris.h"
+
+#include "lv2/atom/atom.h"
+#include "lv2/atom/forge.h"
+#include "lv2/atom/util.h"
+#include "lv2/core/lv2.h"
+#include "lv2/core/lv2_util.h"
+#include "lv2/log/log.h"
+#include "lv2/log/logger.h"
+#include "lv2/state/state.h"
+#include "lv2/urid/urid.h"
+
+#include <stdbool.h>
+#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
-#include <stdint.h>
-
-#include "lv2/lv2plug.in/ns/ext/log/log.h"
-#include "lv2/lv2plug.in/ns/ext/log/logger.h"
-#include "lv2/lv2plug.in/ns/ext/state/state.h"
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
+#include <string.h>
-#include "./uris.h"
+/**
+ ==== Private Plugin Instance Structure ====
-/** Private plugin instance structure. */
+ In addition to the usual port buffers and features, this plugin stores the
+ state of the UI here, so it can be opened and closed without losing the
+ current settings. The UI state is communicated between the plugin and the
+ UI using atom messages via a sequence port, similarly to MIDI I/O.
+*/
typedef struct {
// Port buffers
float* input[2];
@@ -40,34 +55,30 @@ typedef struct {
LV2_Atom_Forge_Frame frame;
// Log feature and convenience API
- LV2_Log_Log* log;
LV2_Log_Logger logger;
// Instantiation settings
uint32_t n_channels;
double rate;
- /* The state of the UI is stored here, so that the GUI can be displayed and
- closed without losing the current settings. It is communicated to the
- UI using atom messages.
- */
+ // UI state
bool ui_active;
bool send_settings_to_ui;
float ui_amp;
uint32_t ui_spp;
} EgScope;
-/** Port indices. */
+/** ==== Port Indices ==== */
typedef enum {
- SCO_CONTROL = 0,
- SCO_NOTIFY = 1,
- SCO_INPUT0 = 2,
- SCO_OUTPUT0 = 3,
- SCO_INPUT1 = 4,
- SCO_OUTPUT1 = 5,
+ SCO_CONTROL = 0, // Event input
+ SCO_NOTIFY = 1, // Event output
+ SCO_INPUT0 = 2, // Audio input 0
+ SCO_OUTPUT0 = 3, // Audio output 0
+ SCO_INPUT1 = 4, // Audio input 1 (stereo variant)
+ SCO_OUTPUT1 = 5, // Audio input 2 (stereo variant)
} PortIndex;
-/** Create plugin instance. */
+/** ==== Instantiate Method ==== */
static LV2_Handle
instantiate(const LV2_Descriptor* descriptor,
double rate,
@@ -84,16 +95,14 @@ instantiate(const LV2_Descriptor* descriptor,
}
// Get host features
- for (int i = 0; features[i]; ++i) {
- if (!strcmp(features[i]->URI, LV2_URID__map)) {
- self->map = (LV2_URID_Map*)features[i]->data;
- } else if (!strcmp(features[i]->URI, LV2_LOG__log)) {
- self->log = (LV2_Log_Log*)features[i]->data;
- }
- }
-
- if (!self->map) {
- fprintf(stderr, "EgScope.lv2 error: Host does not support urid:map\n");
+ const char* missing = lv2_features_query(
+ features,
+ LV2_LOG__log, &self->logger.log, false,
+ LV2_URID__map, &self->map, true,
+ NULL);
+ lv2_log_logger_set_map(&self->logger, self->map);
+ if (missing) {
+ lv2_log_error(&self->logger, "Missing feature <%s>\n", missing);
free(self);
return NULL;
}
@@ -120,12 +129,11 @@ instantiate(const LV2_Descriptor* descriptor,
// Map URIs and initialise forge/logger
map_sco_uris(self->map, &self->uris);
lv2_atom_forge_init(&self->forge, self->map);
- lv2_log_logger_init(&self->logger, self->map, self->log);
return (LV2_Handle)self;
}
-/** Connect a port to a buffer. */
+/** ==== Connect Port Method ==== */
static void
connect_port(LV2_Handle handle,
uint32_t port,
@@ -156,41 +164,49 @@ connect_port(LV2_Handle handle,
}
/**
- Forge vector of raw data.
-
- @param forge Forge to use.
- @param uris Mapped URI identifiers.
- @param channel Channel ID to transmit.
- @param n_samples Number of audio samples to transmit.
- @param data Actual audio data.
+ ==== Utility Function: `tx_rawaudio` ====
+
+ This function forges a message for sending a vector of raw data. The object
+ is a http://lv2plug.in/ns/ext/atom#Blank[Blank] with a few properties, like:
+ [source,turtle]
+ --------
+ []
+ a sco:RawAudio ;
+ sco:channelID 0 ;
+ sco:audioData [ 0.0, 0.0, ... ] .
+ --------
+
+ where the value of the `sco:audioData` property, `[ 0.0, 0.0, ... ]`, is a
+ http://lv2plug.in/ns/ext/atom#Vector[Vector] of
+ http://lv2plug.in/ns/ext/atom#Float[Float].
*/
static void
tx_rawaudio(LV2_Atom_Forge* forge,
ScoLV2URIs* uris,
const int32_t channel,
const size_t n_samples,
- void* data)
+ const float* data)
{
LV2_Atom_Forge_Frame frame;
- // Forge container object of type 'rawaudio'
+ // Forge container object of type 'RawAudio'
lv2_atom_forge_frame_time(forge, 0);
- lv2_atom_forge_blank(forge, &frame, 1, uris->RawAudio);
+ lv2_atom_forge_object(forge, &frame, 0, uris->RawAudio);
- // Add integer attribute 'channelid'
- lv2_atom_forge_property_head(forge, uris->channelID, 0);
+ // Add integer 'channelID' property
+ lv2_atom_forge_key(forge, uris->channelID);
lv2_atom_forge_int(forge, channel);
- // Add vector of floats raw 'audiodata'
- lv2_atom_forge_property_head(forge, uris->audioData, 0);
+ // Add vector of floats 'audioData' property
+ lv2_atom_forge_key(forge, uris->audioData);
lv2_atom_forge_vector(
forge, sizeof(float), uris->atom_Float, n_samples, data);
- // Close off atom-object
+ // Close off object
lv2_atom_forge_pop(forge, &frame);
}
-/** Process a block of audio */
+/** ==== Run Method ==== */
static void
run(LV2_Handle handle, uint32_t n_samples)
{
@@ -228,27 +244,28 @@ run(LV2_Handle handle, uint32_t n_samples)
// Forge container object of type 'ui_state'
LV2_Atom_Forge_Frame frame;
lv2_atom_forge_frame_time(&self->forge, 0);
- lv2_atom_forge_blank(&self->forge, &frame, 1, self->uris.ui_State);
+ lv2_atom_forge_object(&self->forge, &frame, 0, self->uris.ui_State);
// Add UI state as properties
- lv2_atom_forge_property_head(&self->forge, self->uris.ui_spp, 0);
+ lv2_atom_forge_key(&self->forge, self->uris.ui_spp);
lv2_atom_forge_int(&self->forge, self->ui_spp);
- lv2_atom_forge_property_head(&self->forge, self->uris.ui_amp, 0);
+ lv2_atom_forge_key(&self->forge, self->uris.ui_amp);
lv2_atom_forge_float(&self->forge, self->ui_amp);
- lv2_atom_forge_property_head(&self->forge, self->uris.param_sampleRate, 0);
+ lv2_atom_forge_key(&self->forge, self->uris.param_sampleRate);
lv2_atom_forge_float(&self->forge, self->rate);
lv2_atom_forge_pop(&self->forge, &frame);
}
// Process incoming events from GUI
if (self->control) {
- LV2_Atom_Event* ev = lv2_atom_sequence_begin(&(self->control)->body);
+ const LV2_Atom_Event* ev = lv2_atom_sequence_begin(
+ &(self->control)->body);
// For each incoming message...
while (!lv2_atom_sequence_is_end(
&self->control->body, self->control->atom.size, ev)) {
// If the event is an atom:Blank object
- if (ev->body.type == self->uris.atom_Blank) {
- const LV2_Atom_Object* obj = (LV2_Atom_Object*)&ev->body;
+ if (lv2_atom_forge_is_object_type(&self->forge, ev->body.type)) {
+ const LV2_Atom_Object* obj = (const LV2_Atom_Object*)&ev->body;
if (obj->body.otype == self->uris.ui_On) {
// If the object is a ui-on, the UI was activated
self->ui_active = true;
@@ -264,10 +281,10 @@ run(LV2_Handle handle, uint32_t n_samples)
self->uris.ui_amp, &amp,
0);
if (spp) {
- self->ui_spp = ((LV2_Atom_Int*)spp)->body;
+ self->ui_spp = ((const LV2_Atom_Int*)spp)->body;
}
if (amp) {
- self->ui_amp = ((LV2_Atom_Float*)amp)->body;
+ self->ui_amp = ((const LV2_Atom_Float*)amp)->body;
}
}
}
@@ -297,6 +314,16 @@ cleanup(LV2_Handle handle)
free(handle);
}
+
+/**
+ ==== State Methods ====
+
+ This plugin's state consists of two basic properties: one `int` and one
+ `float`. No files are used. Note these values are POD, but not portable,
+ since different machines may have a different integer endianness or floating
+ point format. However, since standard Atom types are used, a good host will
+ be able to save them portably as text anyway.
+*/
static LV2_State_Status
state_save(LV2_Handle instance,
LV2_State_Store_Function store,
@@ -309,11 +336,6 @@ state_save(LV2_Handle instance,
return LV2_STATE_SUCCESS;
}
- /* Store state values. Note these values are POD, but not portable, since
- different machines may have a different integer endianness or floating
- point format. However, since standard Atom types are used, a good host
- will be able to save them portably as text anyway. */
-
store(handle, self->uris.ui_spp,
(void*)&self->ui_spp, sizeof(uint32_t),
self->uris.atom_Int,
@@ -343,14 +365,14 @@ state_restore(LV2_Handle instance,
const void* spp = retrieve(
handle, self->uris.ui_spp, &size, &type, &valflags);
if (spp && size == sizeof(uint32_t) && type == self->uris.atom_Int) {
- self->ui_spp = *((uint32_t*)spp);
+ self->ui_spp = *((const uint32_t*)spp);
self->send_settings_to_ui = true;
}
const void* amp = retrieve(
handle, self->uris.ui_amp, &size, &type, &valflags);
if (amp && size == sizeof(float) && type == self->uris.atom_Float) {
- self->ui_amp = *((float*)amp);
+ self->ui_amp = *((const float*)amp);
self->send_settings_to_ui = true;
}
@@ -367,6 +389,7 @@ extension_data(const char* uri)
return NULL;
}
+/** ==== Plugin Descriptors ==== */
static const LV2_Descriptor descriptor_mono = {
SCO_URI "#Mono",
instantiate,
diff --git a/plugins/eg05-scope.lv2/examploscope.ttl.in b/plugins/eg-scope.lv2/examploscope.ttl.in
index 0b76962..0b76962 100644
--- a/plugins/eg05-scope.lv2/examploscope.ttl.in
+++ b/plugins/eg-scope.lv2/examploscope.ttl.in
diff --git a/plugins/eg05-scope.lv2/examploscope_ui.c b/plugins/eg-scope.lv2/examploscope_ui.c
index ffbe573..ce0000c 100644
--- a/plugins/eg05-scope.lv2/examploscope_ui.c
+++ b/plugins/eg-scope.lv2/examploscope_ui.c
@@ -14,14 +14,28 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-#include <stdio.h>
-#include <stdlib.h>
+#include "./uris.h"
+
+#include "lv2/atom/atom.h"
+#include "lv2/atom/forge.h"
+#include "lv2/atom/util.h"
+#include "lv2/core/lv2.h"
+#include "lv2/ui/ui.h"
+#include "lv2/urid/urid.h"
#include <cairo.h>
+#include <gdk/gdk.h>
+#include <glib-object.h>
+#include <glib.h>
+#include <gobject/gclosure.h>
#include <gtk/gtk.h>
-#include "lv2/lv2plug.in/ns/extensions/ui/ui.h"
-#include "./uris.h"
+#include <assert.h>
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
// Drawing area size
#define DAWIDTH (640)
@@ -71,6 +85,7 @@ typedef struct {
uint32_t n_channels;
bool paused;
float rate;
+ bool updating;
} EgScopeUI;
@@ -85,18 +100,20 @@ send_ui_state(LV2UI_Handle handle)
uint8_t obj_buf[1024];
lv2_atom_forge_set_buffer(&ui->forge, obj_buf, sizeof(obj_buf));
- // Event body is a ui_state object
+ // Start a ui:State object
LV2_Atom_Forge_Frame frame;
- LV2_Atom* msg = (LV2_Atom*)lv2_atom_forge_blank(
- &ui->forge, &frame, 1, ui->uris.ui_State);
+ LV2_Atom* msg = (LV2_Atom*)lv2_atom_forge_object(
+ &ui->forge, &frame, 0, ui->uris.ui_State);
// msg[samples-per-pixel] = integer
- lv2_atom_forge_property_head(&ui->forge, ui->uris.ui_spp, 0);
+ lv2_atom_forge_key(&ui->forge, ui->uris.ui_spp);
lv2_atom_forge_int(&ui->forge, ui->stride);
+
// msg[amplitude] = float
- lv2_atom_forge_property_head(&ui->forge, ui->uris.ui_amp, 0);
+ lv2_atom_forge_key(&ui->forge, ui->uris.ui_amp);
lv2_atom_forge_float(&ui->forge, gain);
- // Close off forged data
+
+ // Finish ui:State object
lv2_atom_forge_pop(&ui->forge, &frame);
// Send message to plugin port '0'
@@ -118,8 +135,8 @@ send_ui_disable(LV2UI_Handle handle)
lv2_atom_forge_set_buffer(&ui->forge, obj_buf, sizeof(obj_buf));
LV2_Atom_Forge_Frame frame;
- LV2_Atom* msg = (LV2_Atom*)lv2_atom_forge_blank(
- &ui->forge, &frame, 1, ui->uris.ui_Off);
+ LV2_Atom* msg = (LV2_Atom*)lv2_atom_forge_object(
+ &ui->forge, &frame, 0, ui->uris.ui_Off);
lv2_atom_forge_pop(&ui->forge, &frame);
ui->write(ui->controller,
0,
@@ -142,8 +159,8 @@ send_ui_enable(LV2UI_Handle handle)
lv2_atom_forge_set_buffer(&ui->forge, obj_buf, sizeof(obj_buf));
LV2_Atom_Forge_Frame frame;
- LV2_Atom* msg = (LV2_Atom*)lv2_atom_forge_blank(
- &ui->forge, &frame, 1, ui->uris.ui_On);
+ LV2_Atom* msg = (LV2_Atom*)lv2_atom_forge_object(
+ &ui->forge, &frame, 0, ui->uris.ui_On);
lv2_atom_forge_pop(&ui->forge, &frame);
ui->write(ui->controller,
0,
@@ -156,7 +173,11 @@ send_ui_enable(LV2UI_Handle handle)
static gboolean
on_cfg_changed(GtkWidget* widget, gpointer data)
{
- send_ui_state(data);
+ EgScopeUI* ui = (EgScopeUI*)data;
+ if (!ui->updating) {
+ // Only send UI state if the change is from user interaction
+ send_ui_state(data);
+ }
return TRUE;
}
@@ -294,17 +315,17 @@ on_expose_event(GtkWidget* widget, GdkEventExpose* ev, gpointer data)
/**
Parse raw audio data and prepare for later drawing.
-
+
Note this is a toy example, which is really a waveform display, not an
oscilloscope. A serious scope would not display samples as is.
-
+
Signals above ~ 1/10 of the sampling-rate will not yield a useful visual
display and result in a rather unintuitive representation of the actual
waveform.
-
+
Ideally the audio-data would be buffered and upsampled here and after that
written in a display buffer for later use.
-
+
For more information, see
https://wiki.xiph.org/Videos/Digital_Show_and_Tell
http://lac.linuxaudio.org/2013/papers/36.pdf
@@ -412,7 +433,7 @@ instantiate(const LV2UI_Descriptor* descriptor,
LV2UI_Widget* widget,
const LV2_Feature* const* features)
{
- EgScopeUI* ui = (EgScopeUI*)malloc(sizeof(EgScopeUI));
+ EgScopeUI* ui = (EgScopeUI*)calloc(1, sizeof(EgScopeUI));
if (!ui) {
fprintf(stderr, "EgScope.lv2 UI: out of memory\n");
@@ -527,10 +548,10 @@ cleanup(LV2UI_Handle handle)
}
static int
-recv_raw_audio(EgScopeUI* ui, LV2_Atom_Object* obj)
+recv_raw_audio(EgScopeUI* ui, const LV2_Atom_Object* obj)
{
- LV2_Atom* chan_val = NULL;
- LV2_Atom* data_val = NULL;
+ const LV2_Atom* chan_val = NULL;
+ const LV2_Atom* data_val = NULL;
const int n_props = lv2_atom_object_get(
obj,
ui->uris.channelID, &chan_val,
@@ -546,18 +567,18 @@ recv_raw_audio(EgScopeUI* ui, LV2_Atom_Object* obj)
}
// Get the values we need from the body of the property value atoms
- const int32_t chn = ((LV2_Atom_Int*)chan_val)->body;
- LV2_Atom_Vector* vec = (LV2_Atom_Vector*)data_val;
+ const int32_t chn = ((const LV2_Atom_Int*)chan_val)->body;
+ const LV2_Atom_Vector* vec = (const LV2_Atom_Vector*)data_val;
if (vec->body.child_type != ui->uris.atom_Float) {
return 1; // Vector has incorrect element type
}
// Number of elements = (total size - header size) / element size
- const size_t n_elem = ((data_val->size - sizeof(LV2_Atom_Vector))
+ const size_t n_elem = ((data_val->size - sizeof(LV2_Atom_Vector_Body))
/ sizeof(float));
// Float elements immediately follow the vector body header
- const float* data = (float*)(&vec->body + 1);
+ const float* data = (const float*)(&vec->body + 1);
// Update display
update_scope(ui, chn, n_elem, data);
@@ -565,11 +586,11 @@ recv_raw_audio(EgScopeUI* ui, LV2_Atom_Object* obj)
}
static int
-recv_ui_state(EgScopeUI* ui, LV2_Atom_Object* obj)
+recv_ui_state(EgScopeUI* ui, const LV2_Atom_Object* obj)
{
- LV2_Atom* spp_val = NULL;
- LV2_Atom* amp_val = NULL;
- LV2_Atom* rate_val = NULL;
+ const LV2_Atom* spp_val = NULL;
+ const LV2_Atom* amp_val = NULL;
+ const LV2_Atom* rate_val = NULL;
const int n_props = lv2_atom_object_get(
obj,
ui->uris.ui_spp, &spp_val,
@@ -585,15 +606,17 @@ recv_ui_state(EgScopeUI* ui, LV2_Atom_Object* obj)
fprintf(stderr, "eg-scope.lv2 UI error: Corrupt state message\n");
return 1;
}
-
+
// Get the values we need from the body of the property value atoms
- const int32_t spp = ((LV2_Atom_Int*)spp_val)->body;
- const float amp = ((LV2_Atom_Float*)amp_val)->body;
- const float rate = ((LV2_Atom_Float*)rate_val)->body;
+ const int32_t spp = ((const LV2_Atom_Int*)spp_val)->body;
+ const float amp = ((const LV2_Atom_Float*)amp_val)->body;
+ const float rate = ((const LV2_Atom_Float*)rate_val)->body;
- // Update UI
+ // Disable transmission and update UI
+ ui->updating = true;
gtk_spin_button_set_value(GTK_SPIN_BUTTON(ui->spb_speed), spp);
gtk_spin_button_set_value(GTK_SPIN_BUTTON(ui->spb_amp), amp);
+ ui->updating = false;
ui->rate = rate;
return 0;
@@ -601,7 +624,7 @@ recv_ui_state(EgScopeUI* ui, LV2_Atom_Object* obj)
/**
Receive data from the DSP-backend.
-
+
This is called by the host, typically at a rate of around 25 FPS.
Ideally this happens regularly and with relatively low latency, but there
@@ -614,16 +637,16 @@ port_event(LV2UI_Handle handle,
uint32_t format,
const void* buffer)
{
- EgScopeUI* ui = (EgScopeUI*)handle;
- LV2_Atom* atom = (LV2_Atom*)buffer;
+ EgScopeUI* ui = (EgScopeUI*)handle;
+ const LV2_Atom* atom = (const LV2_Atom*)buffer;
/* Check type of data received
* - format == 0: Control port event (float)
* - format > 0: Message (atom)
*/
if (format == ui->uris.atom_eventTransfer &&
- atom->type == ui->uris.atom_Blank) {
- LV2_Atom_Object* obj = (LV2_Atom_Object*)atom;
+ lv2_atom_forge_is_object_type(&ui->forge, atom->type)) {
+ const LV2_Atom_Object* obj = (const LV2_Atom_Object*)atom;
if (obj->body.otype == ui->uris.RawAudio) {
recv_raw_audio(ui, obj);
} else if (obj->body.otype == ui->uris.ui_State) {
diff --git a/plugins/eg05-scope.lv2/manifest.ttl.in b/plugins/eg-scope.lv2/manifest.ttl.in
index 028a673..a64aff1 100644
--- a/plugins/eg05-scope.lv2/manifest.ttl.in
+++ b/plugins/eg-scope.lv2/manifest.ttl.in
@@ -2,16 +2,19 @@
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix ui: <http://lv2plug.in/ns/extensions/ui#> .
+# ==== Mono plugin variant ====
<http://lv2plug.in/plugins/eg-scope#Mono>
a lv2:Plugin ;
lv2:binary <examploscope@LIB_EXT@> ;
rdfs:seeAlso <examploscope.ttl> .
+# ==== Stereo plugin variant ====
<http://lv2plug.in/plugins/eg-scope#Stereo>
a lv2:Plugin ;
lv2:binary <examploscope@LIB_EXT@> ;
rdfs:seeAlso <examploscope.ttl> .
+# ==== Gtk 2.0 UI ====
<http://lv2plug.in/plugins/eg-scope#ui>
a ui:GtkUI ;
ui:binary <examploscope_ui@LIB_EXT@> ;
diff --git a/plugins/eg05-scope.lv2/uris.h b/plugins/eg-scope.lv2/uris.h
index bd57551..2ebaf4e 100644
--- a/plugins/eg05-scope.lv2/uris.h
+++ b/plugins/eg-scope.lv2/uris.h
@@ -17,16 +17,15 @@
#ifndef SCO_URIS_H
#define SCO_URIS_H
-#include "lv2/lv2plug.in/ns/ext/atom/atom.h"
-#include "lv2/lv2plug.in/ns/ext/atom/forge.h"
-#include "lv2/lv2plug.in/ns/ext/parameters/parameters.h"
-#include "lv2/lv2plug.in/ns/ext/urid/urid.h"
+#include "lv2/atom/atom.h"
+#include "lv2/atom/forge.h"
+#include "lv2/parameters/parameters.h"
+#include "lv2/urid/urid.h"
#define SCO_URI "http://lv2plug.in/plugins/eg-scope"
typedef struct {
// URIs defined in LV2 specifications
- LV2_URID atom_Blank;
LV2_URID atom_Vector;
LV2_URID atom_Float;
LV2_URID atom_Int;
@@ -50,7 +49,6 @@ typedef struct {
static inline void
map_sco_uris(LV2_URID_Map* map, ScoLV2URIs* uris)
{
- uris->atom_Blank = map->map(map->handle, LV2_ATOM__Blank);
uris->atom_Vector = map->map(map->handle, LV2_ATOM__Vector);
uris->atom_Float = map->map(map->handle, LV2_ATOM__Float);
uris->atom_Int = map->map(map->handle, LV2_ATOM__Int);
diff --git a/plugins/eg-scope.lv2/wscript b/plugins/eg-scope.lv2/wscript
new file mode 100644
index 0000000..4333502
--- /dev/null
+++ b/plugins/eg-scope.lv2/wscript
@@ -0,0 +1,56 @@
+#!/usr/bin/env python
+from waflib.extras import autowaf as autowaf
+import re
+
+# Variables for 'waf dist'
+APPNAME = 'eg-scope.lv2'
+VERSION = '1.0.0'
+
+# Mandatory variables
+top = '.'
+out = 'build'
+
+def options(opt):
+ opt.load('compiler_c')
+ opt.load('lv2')
+ autowaf.set_options(opt)
+
+def configure(conf):
+ conf.load('compiler_c', cache=True)
+ conf.load('lv2', cache=True)
+ conf.load('autowaf', cache=True)
+
+ conf.check_pkg('lv2 >= 1.2.1', uselib_store='LV2')
+ conf.check_pkg('cairo >= 1.8.10', uselib_store='CAIRO')
+ conf.check_pkg('gtk+-2.0 >= 2.18.0',
+ uselib_store='GTK2',
+ system=True,
+ mandatory=False)
+
+def build(bld):
+ bundle = 'eg-scope.lv2'
+
+ # Build manifest.ttl by substitution (for portable lib extension)
+ for i in ['manifest.ttl', 'examploscope.ttl']:
+ bld(features = 'subst',
+ source = i + '.in',
+ target = 'lv2/%s/%s' % (bundle, i),
+ install_path = '${LV2DIR}/%s' % bundle,
+ LIB_EXT = bld.env.LV2_LIB_EXT)
+
+ # Build plugin library
+ obj = bld(features = 'c cshlib lv2lib',
+ source = 'examploscope.c',
+ name = 'examploscope',
+ target = 'lv2/%s/examploscope' % bundle,
+ install_path = '${LV2DIR}/%s' % bundle,
+ use = 'LV2')
+
+ # Build UI library
+ if bld.env.HAVE_GTK2:
+ obj = bld(features = 'c cshlib lv2lib',
+ source = 'examploscope_ui.c',
+ name = 'examploscope_ui',
+ target = 'lv2/%s/examploscope_ui' % bundle,
+ install_path = '${LV2DIR}/%s' % bundle,
+ use = 'GTK2 CAIRO LV2')
diff --git a/plugins/eg01-amp.lv2/manifest.ttl.in b/plugins/eg01-amp.lv2/manifest.ttl.in
deleted file mode 100644
index 0da78b0..0000000
--- a/plugins/eg01-amp.lv2/manifest.ttl.in
+++ /dev/null
@@ -1,101 +0,0 @@
-# LV2 Bundle Manifest
-#
-# All LV2 plugins are installed as "bundles", a directory with a particular
-# format. Inside the bundle, the entry point is a file called "manifest.ttl".
-# This file lists what plugins are in this bundle, and which files are (.so,
-# .ttl, etc.) are associated with those plugins.
-#
-# Hosts read bundles' manifest.ttl to discover what plugins (and other
-# resources) are available. Manifest files should be as small as possible for
-# performance reasons.
-#
-#
-# ==== Namespace Prefixes ====
-#
-# Turtle files contain many URIs. To make this more readable, prefixes
-# can be defined. For example, with the `lv2:` prefix below, instead of
-# <http://lv2plug.in/ns/lv2core#Plugin> the shorter form `lv2:Plugin` can be
-# used. This is just a shorthand for URIs within a file, the prefixes are not
-# significant otherwise.
-
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-# ==== Data ====
-
-<http://lv2plug.in/plugins/eg-amp>
- a lv2:Plugin ;
- lv2:binary <amp@LIB_EXT@> ;
- rdfs:seeAlso <amp.ttl> .
-
-# The token `@LIB_EXT@` above is replaced by the build system with the
-# appropriate extension for the current platform (e.g. .so, .dylib, .dll).
-# This file is called called `manifest.ttl.in` rather than `manifest.ttl`
-# to indicate that it is not the final file to be installed.
-# This is not necessary, but is a good idea for portable plugins.
-# For reability, the following text will assume `.so` is the extension used.
-#
-# In short, this declares that the resource with URI
-# "http://lv2plug.in/plugins/eg-amp" is an LV2 plugin, with executable code in
-# the file "amp.so" and a full description in "amp.ttl". These paths are
-# relative to the bundle directory.
-#
-# There are 3 statements in this description:
-# |================================================================
-# | Subject | Predicate | Object
-# | <http://lv2plug.in/plugins/eg-amp> | a | lv2:Plugin
-# | <http://lv2plug.in/plugins/eg-amp> | lv2:binary | <amp.so>
-# | <http://lv2plug.in/plugins/eg-amp> | rdfs:seeAlso | <amp.ttl>
-# |================================================================
-#
-# The semicolon is used to continue the previous subject; an equivalent
-# but more verbose syntax for the same data is:
-
-<http://lv2plug.in/plugins/eg-amp> a lv2:Plugin .
-<http://lv2plug.in/plugins/eg-amp> lv2:binary <amp.so> .
-<http://lv2plug.in/plugins/eg-amp> rdfs:seeAlso <amp.ttl> .
-
-# (Since this data is equivalent, it is safe, if pointless, to list it twice)
-#
-# Note that the documentation for a URI can often be found by visiting that URI
-# in a web browser, e.g. the documentation for lv2:binary can be found at
-# <http://lv2plug.in/ns/lv2core#binary>. If you encounter a URI in some data
-# which you do not understand, try this first.
-#
-# Note the URI of a plugin does NOT need to be an actual web address, it's just
-# a global identifier. It is, however, a good idea to use an actual web
-# address if possible, since it can be used to easily access documentation,
-# downloads, etc. Note there are compatibility rules for when the URI of a
-# plugin must be changed, see the http://lv2plug.in/ns/lv2core[LV2 specification]
-# for details.
-#
-# AUTHORS MUST NOT CREATE URIS AT DOMAINS THEY DO NOT CONTROL WITHOUT
-# PERMISSION, AND *ESPECIALLY* MUST NOT CREATE SYNTACTICALLY INVALID URIS,
-# E.G. WHERE THE PORTION FOLLOWING "http://" IS NOT AN ACTUAL DOMAIN NAME. If
-# you need an example URI, the domain http://example.org/ is reserved for this
-# purpose. It is best to use web URIs, e.g. at the domain where plugins are
-# hosted for download, even if no actual documents are currently hosted there.
-# If this is truly impossible, use a URN, e.g. urn:myplugs:superamp.
-#
-# A detailed explanation of each statement follows.
-
-<http://lv2plug.in/plugins/eg-amp> a lv2:Plugin .
-
-# The `a`, as in ``is a'', is a Turtle shortcut for `rdf:type`.
-# `lv2:Plugin` expands to <http://lv2plug.in/ns/lv2core#Plugin> (using the
-# `lv2:` prefix above) which is the type of all LV2 plugins.
-# This statement means ``<http://lv2plug.in/plugins/eg-amp> is an LV2 plugin''.
-
-<http://lv2plug.in/plugins/eg-amp> lv2:binary <amp@LIB_EXT@> .
-
-# This says "this plugin has executable code ("binary") in the file
-# named "amp.so", which is located in this bundle. The LV2 specification
-# defines that all relative URIs in manifest files are relative to the bundle
-# directory, so this refers to the file amp.so in the same directory as this
-# manifest.ttl file.
-
-<http://lv2plug.in/plugins/eg-amp> rdfs:seeAlso <amp.ttl> .
-
-# This says ``there is more information about this plugin located in the file
-# `amp.ttl`''. The host will look at all such files when it needs to actually
-# use or investigate the plugin.
diff --git a/plugins/eg01-amp.lv2/wscript b/plugins/eg01-amp.lv2/wscript
deleted file mode 100644
index d4295ff..0000000
--- a/plugins/eg01-amp.lv2/wscript
+++ /dev/null
@@ -1,67 +0,0 @@
-#!/usr/bin/env python
-from waflib.extras import autowaf as autowaf
-import re
-
-# Variables for 'waf dist'
-APPNAME = 'eg-amp.lv2'
-VERSION = '1.0.0'
-
-# Mandatory variables
-top = '.'
-out = 'build'
-
-def options(opt):
- opt.load('compiler_c')
- autowaf.set_options(opt)
-
-def configure(conf):
- conf.load('compiler_c')
- autowaf.configure(conf)
- autowaf.set_c99_mode(conf)
- autowaf.display_header('Amp Configuration')
-
- if not autowaf.is_child():
- autowaf.check_pkg(conf, 'lv2', uselib_store='LV2')
-
- conf.check(features='c cprogram', lib='m', uselib_store='M', mandatory=False)
-
- autowaf.display_msg(conf, 'LV2 bundle directory', conf.env.LV2DIR)
- print('')
-
-def build(bld):
- bundle = 'eg-amp.lv2'
-
- # Make a pattern for shared objects without the 'lib' prefix
- module_pat = re.sub('^lib', '', bld.env.cshlib_PATTERN)
- module_ext = module_pat[module_pat.rfind('.'):]
-
- # Build manifest.ttl by substitution (for portable lib extension)
- bld(features = 'subst',
- source = 'manifest.ttl.in',
- target = '%s/%s' % (bundle, 'manifest.ttl'),
- install_path = '${LV2DIR}/%s' % bundle,
- LIB_EXT = module_ext)
-
- # Copy other data files to build bundle (build/eg-amp.lv2)
- for i in ['amp.ttl']:
- bld(features = 'subst',
- is_copy = True,
- source = i,
- target = '%s/%s' % (bundle, i),
- install_path = '${LV2DIR}/%s' % bundle)
-
- # Use LV2 headers from parent directory if building as a sub-project
- includes = None
- if autowaf.is_child:
- includes = '../..'
-
- # Build plugin library
- obj = bld(features = 'c cshlib',
- source = 'amp.c',
- name = 'amp',
- target = '%s/amp' % bundle,
- install_path = '${LV2DIR}/%s' % bundle,
- uselib = 'M LV2',
- includes = includes)
- obj.env.cshlib_PATTERN = module_pat
-
diff --git a/plugins/eg02-midigate.lv2/wscript b/plugins/eg02-midigate.lv2/wscript
deleted file mode 100644
index 44336af..0000000
--- a/plugins/eg02-midigate.lv2/wscript
+++ /dev/null
@@ -1,65 +0,0 @@
-#!/usr/bin/env python
-from waflib.extras import autowaf as autowaf
-import re
-
-# Variables for 'waf dist'
-APPNAME = 'eg-midigate.lv2'
-VERSION = '1.0.0'
-
-# Mandatory variables
-top = '.'
-out = 'build'
-
-def options(opt):
- opt.load('compiler_c')
- autowaf.set_options(opt)
-
-def configure(conf):
- conf.load('compiler_c')
- autowaf.configure(conf)
- autowaf.set_c99_mode(conf)
- autowaf.display_header('Midigate Configuration')
-
- if not autowaf.is_child():
- autowaf.check_pkg(conf, 'lv2', uselib_store='LV2')
-
- autowaf.display_msg(conf, 'LV2 bundle directory', conf.env.LV2DIR)
- print('')
-
-def build(bld):
- bundle = 'eg-midigate.lv2'
-
- # Make a pattern for shared objects without the 'lib' prefix
- module_pat = re.sub('^lib', '', bld.env.cshlib_PATTERN)
- module_ext = module_pat[module_pat.rfind('.'):]
-
- # Build manifest.ttl by substitution (for portable lib extension)
- bld(features = 'subst',
- source = 'manifest.ttl.in',
- target = '%s/%s' % (bundle, 'manifest.ttl'),
- install_path = '${LV2DIR}/%s' % bundle,
- LIB_EXT = module_ext)
-
- # Copy other data files to build bundle (build/eg-midigate.lv2)
- for i in ['midigate.ttl']:
- bld(features = 'subst',
- is_copy = True,
- source = i,
- target = '%s/%s' % (bundle, i),
- install_path = '${LV2DIR}/%s' % bundle)
-
- # Use LV2 headers from parent directory if building as a sub-project
- includes = None
- if autowaf.is_child:
- includes = '../..'
-
- # Build plugin library
- obj = bld(features = 'c cshlib',
- source = 'midigate.c',
- name = 'midigate',
- target = '%s/midigate' % bundle,
- install_path = '${LV2DIR}/%s' % bundle,
- uselib = 'LV2',
- includes = includes)
- obj.env.cshlib_PATTERN = module_pat
-
diff --git a/plugins/eg03-metro.lv2/wscript b/plugins/eg03-metro.lv2/wscript
deleted file mode 100644
index 40642b6..0000000
--- a/plugins/eg03-metro.lv2/wscript
+++ /dev/null
@@ -1,64 +0,0 @@
-#!/usr/bin/env python
-from waflib.extras import autowaf as autowaf
-import re
-
-# Variables for 'waf dist'
-APPNAME = 'eg-metro.lv2'
-VERSION = '1.0.0'
-
-# Mandatory variables
-top = '.'
-out = 'build'
-
-def options(opt):
- opt.load('compiler_c')
- autowaf.set_options(opt)
-
-def configure(conf):
- conf.load('compiler_c')
- autowaf.configure(conf)
- autowaf.set_c99_mode(conf)
- autowaf.display_header('Metro Configuration')
-
- if not autowaf.is_child():
- autowaf.check_pkg(conf, 'lv2', atleast_version='0.2.0', uselib_store='LV2')
-
- autowaf.display_msg(conf, 'LV2 bundle directory', conf.env.LV2DIR)
- print('')
-
-def build(bld):
- bundle = 'eg-metro.lv2'
-
- # Make a pattern for shared objects without the 'lib' prefix
- module_pat = re.sub('^lib', '', bld.env.cshlib_PATTERN)
- module_ext = module_pat[module_pat.rfind('.'):]
-
- # Build manifest.ttl by substitution (for portable lib extension)
- bld(features = 'subst',
- source = 'manifest.ttl.in',
- target = '%s/%s' % (bundle, 'manifest.ttl'),
- install_path = '${LV2DIR}/%s' % bundle,
- LIB_EXT = module_ext)
-
- # Copy other data files to build bundle (build/eg-metro.lv2)
- bld(features = 'subst',
- is_copy = True,
- source = 'metro.ttl',
- target = '%s/metro.ttl' % bundle,
- install_path = '${LV2DIR}/%s' % bundle)
-
- # Use LV2 headers from parent directory if building as a sub-project
- includes = ['.']
- if autowaf.is_child:
- includes += ['../..']
-
- # Build plugin library
- obj = bld(features = 'c cshlib',
- source = 'metro.c',
- name = 'metro',
- target = '%s/metro' % bundle,
- install_path = '${LV2DIR}/%s' % bundle,
- use = 'LV2',
- includes = includes)
- obj.env.cshlib_PATTERN = module_pat
-
diff --git a/plugins/eg04-sampler.lv2/sampler.c b/plugins/eg04-sampler.lv2/sampler.c
deleted file mode 100644
index 9353d48..0000000
--- a/plugins/eg04-sampler.lv2/sampler.c
+++ /dev/null
@@ -1,483 +0,0 @@
-/*
- LV2 Sampler Example Plugin
- Copyright 2011-2012 David Robillard <d@drobilla.net>
- Copyright 2011 Gabriel M. Beddingfield <gabriel@teuton.org>
- Copyright 2011 James Morris <jwm.art.net@gmail.com>
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-#include <math.h>
-#include <stdlib.h>
-#include <string.h>
-#ifndef __cplusplus
-# include <stdbool.h>
-#endif
-
-#include <sndfile.h>
-
-#include "lv2/lv2plug.in/ns/ext/atom/forge.h"
-#include "lv2/lv2plug.in/ns/ext/atom/util.h"
-#include "lv2/lv2plug.in/ns/ext/log/log.h"
-#include "lv2/lv2plug.in/ns/ext/log/logger.h"
-#include "lv2/lv2plug.in/ns/ext/midi/midi.h"
-#include "lv2/lv2plug.in/ns/ext/patch/patch.h"
-#include "lv2/lv2plug.in/ns/ext/state/state.h"
-#include "lv2/lv2plug.in/ns/ext/urid/urid.h"
-#include "lv2/lv2plug.in/ns/ext/worker/worker.h"
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
-
-#include "./uris.h"
-
-enum {
- SAMPLER_CONTROL = 0,
- SAMPLER_NOTIFY = 1,
- SAMPLER_OUT = 2
-};
-
-static const char* default_sample_file = "click.wav";
-
-typedef struct {
- SF_INFO info; // Info about sample from sndfile
- float* data; // Sample data in float
- char* path; // Path of file
- size_t path_len; // Length of path
-} Sample;
-
-typedef struct {
- // Features
- LV2_URID_Map* map;
- LV2_Worker_Schedule* schedule;
- LV2_Log_Log* log;
-
- // Forge for creating atoms
- LV2_Atom_Forge forge;
-
- // Logger convenience API
- LV2_Log_Logger logger;
-
- // Sample
- Sample* sample;
-
- // Ports
- const LV2_Atom_Sequence* control_port;
- LV2_Atom_Sequence* notify_port;
- float* output_port;
-
- // Forge frame for notify port (for writing worker replies)
- LV2_Atom_Forge_Frame notify_frame;
-
- // URIs
- SamplerURIs uris;
-
- // Current position in run()
- uint32_t frame_offset;
-
- // Playback state
- sf_count_t frame;
- bool play;
-} Sampler;
-
-/**
- An atom-like message used internally to apply/free samples.
-
- This is only used internally to communicate with the worker, it is never
- sent to the outside world via a port since it is not POD. It is convenient
- to use an Atom header so actual atoms can be easily sent through the same
- ringbuffer.
-*/
-typedef struct {
- LV2_Atom atom;
- Sample* sample;
-} SampleMessage;
-
-/**
- Load a new sample and return it.
-
- Since this is of course not a real-time safe action, this is called in the
- worker thread only. The sample is loaded and returned only, plugin state is
- not modified.
-*/
-static Sample*
-load_sample(Sampler* self, const char* path)
-{
- const size_t path_len = strlen(path);
-
- lv2_log_trace(&self->logger, "Loading sample %s\n", path);
-
- Sample* const sample = (Sample*)malloc(sizeof(Sample));
- SF_INFO* const info = &sample->info;
- SNDFILE* const sndfile = sf_open(path, SFM_READ, info);
-
- if (!sndfile || !info->frames || (info->channels != 1)) {
- lv2_log_error(&self->logger, "Failed to open sample '%s'\n", path);
- free(sample);
- return NULL;
- }
-
- // Read data
- float* const data = malloc(sizeof(float) * info->frames);
- if (!data) {
- lv2_log_error(&self->logger, "Failed to allocate memory for sample\n");
- return NULL;
- }
- sf_seek(sndfile, 0ul, SEEK_SET);
- sf_read_float(sndfile, data, info->frames);
- sf_close(sndfile);
-
- // Fill sample struct and return it
- sample->data = data;
- sample->path = (char*)malloc(path_len + 1);
- sample->path_len = path_len;
- memcpy(sample->path, path, path_len + 1);
-
- return sample;
-}
-
-static void
-free_sample(Sampler* self, Sample* sample)
-{
- if (sample) {
- lv2_log_trace(&self->logger, "Freeing %s\n", sample->path);
- free(sample->path);
- free(sample->data);
- free(sample);
- }
-}
-
-/**
- Do work in a non-realtime thread.
-
- This is called for every piece of work scheduled in the audio thread using
- self->schedule->schedule_work(). A reply can be sent back to the audio
- thread using the provided respond function.
-*/
-static LV2_Worker_Status
-work(LV2_Handle instance,
- LV2_Worker_Respond_Function respond,
- LV2_Worker_Respond_Handle handle,
- uint32_t size,
- const void* data)
-{
- Sampler* self = (Sampler*)instance;
- const LV2_Atom* atom = (const LV2_Atom*)data;
- if (atom->type == self->uris.eg_freeSample) {
- // Free old sample
- const SampleMessage* msg = (const SampleMessage*)data;
- free_sample(self, msg->sample);
- } else {
- // Handle set message (load sample).
- const LV2_Atom_Object* obj = (const LV2_Atom_Object*)data;
-
- // Get file path from message
- const LV2_Atom* file_path = read_set_file(&self->uris, obj);
- if (!file_path) {
- return LV2_WORKER_ERR_UNKNOWN;
- }
-
- // Load sample.
- Sample* sample = load_sample(self, LV2_ATOM_BODY_CONST(file_path));
- if (sample) {
- // Loaded sample, send it to run() to be applied.
- respond(handle, sizeof(sample), &sample);
- }
- }
-
- return LV2_WORKER_SUCCESS;
-}
-
-/**
- Handle a response from work() in the audio thread.
-
- When running normally, this will be called by the host after run(). When
- freewheeling, this will be called immediately at the point the work was
- scheduled.
-*/
-static LV2_Worker_Status
-work_response(LV2_Handle instance,
- uint32_t size,
- const void* data)
-{
- Sampler* self = (Sampler*)instance;
-
- SampleMessage msg = { { sizeof(Sample*), self->uris.eg_freeSample },
- self->sample };
-
- // Send a message to the worker to free the current sample
- self->schedule->schedule_work(self->schedule->handle, sizeof(msg), &msg);
-
- // Install the new sample
- self->sample = *(Sample*const*)data;
-
- // Send a notification that we're using a new sample.
- lv2_atom_forge_frame_time(&self->forge, self->frame_offset);
- write_set_file(&self->forge, &self->uris,
- self->sample->path,
- self->sample->path_len);
-
- return LV2_WORKER_SUCCESS;
-}
-
-static void
-connect_port(LV2_Handle instance,
- uint32_t port,
- void* data)
-{
- Sampler* self = (Sampler*)instance;
- switch (port) {
- case SAMPLER_CONTROL:
- self->control_port = (const LV2_Atom_Sequence*)data;
- break;
- case SAMPLER_NOTIFY:
- self->notify_port = (LV2_Atom_Sequence*)data;
- break;
- case SAMPLER_OUT:
- self->output_port = (float*)data;
- break;
- default:
- break;
- }
-}
-
-static LV2_Handle
-instantiate(const LV2_Descriptor* descriptor,
- double rate,
- const char* path,
- const LV2_Feature* const* features)
-{
- // Allocate and initialise instance structure.
- Sampler* self = (Sampler*)malloc(sizeof(Sampler));
- if (!self) {
- return NULL;
- }
- memset(self, 0, sizeof(Sampler));
-
- // Get host features
- for (int i = 0; features[i]; ++i) {
- if (!strcmp(features[i]->URI, LV2_URID__map)) {
- self->map = (LV2_URID_Map*)features[i]->data;
- } else if (!strcmp(features[i]->URI, LV2_WORKER__schedule)) {
- self->schedule = (LV2_Worker_Schedule*)features[i]->data;
- } else if (!strcmp(features[i]->URI, LV2_LOG__log)) {
- self->log = (LV2_Log_Log*)features[i]->data;
- }
- }
- if (!self->map) {
- lv2_log_error(&self->logger, "Missing feature urid:map\n");
- goto fail;
- } else if (!self->schedule) {
- lv2_log_error(&self->logger, "Missing feature work:schedule\n");
- goto fail;
- }
-
- // Map URIs and initialise forge/logger
- map_sampler_uris(self->map, &self->uris);
- lv2_atom_forge_init(&self->forge, self->map);
- lv2_log_logger_init(&self->logger, self->map, self->log);
-
- // Load the default sample file
- const size_t path_len = strlen(path);
- const size_t file_len = strlen(default_sample_file);
- const size_t len = path_len + file_len;
- char* sample_path = (char*)malloc(len + 1);
- snprintf(sample_path, len + 1, "%s%s", path, default_sample_file);
- self->sample = load_sample(self, sample_path);
- free(sample_path);
-
- return (LV2_Handle)self;
-
-fail:
- free(self);
- return 0;
-}
-
-static void
-cleanup(LV2_Handle instance)
-{
- Sampler* self = (Sampler*)instance;
- free_sample(self, self->sample);
- free(self);
-}
-
-static void
-run(LV2_Handle instance,
- uint32_t sample_count)
-{
- Sampler* self = (Sampler*)instance;
- SamplerURIs* uris = &self->uris;
- sf_count_t start_frame = 0;
- sf_count_t pos = 0;
- float* output = self->output_port;
-
- // Set up forge to write directly to notify output port.
- const uint32_t notify_capacity = self->notify_port->atom.size;
- lv2_atom_forge_set_buffer(&self->forge,
- (uint8_t*)self->notify_port,
- notify_capacity);
-
- // Start a sequence in the notify output port.
- lv2_atom_forge_sequence_head(&self->forge, &self->notify_frame, 0);
-
- // Read incoming events
- LV2_ATOM_SEQUENCE_FOREACH(self->control_port, ev) {
- self->frame_offset = ev->time.frames;
- if (ev->body.type == uris->midi_Event) {
- const uint8_t* const msg = (const uint8_t*)(ev + 1);
- switch (lv2_midi_message_type(msg)) {
- case LV2_MIDI_MSG_NOTE_ON:
- start_frame = ev->time.frames;
- self->frame = 0;
- self->play = true;
- break;
- default:
- break;
- }
- } else if (is_object_type(uris, ev->body.type)) {
- const LV2_Atom_Object* obj = (LV2_Atom_Object*)&ev->body;
- if (obj->body.otype == uris->patch_Set) {
- // Received a set message, send it to the worker.
- lv2_log_trace(&self->logger, "Queueing set message\n");
- self->schedule->schedule_work(self->schedule->handle,
- lv2_atom_total_size(&ev->body),
- &ev->body);
- } else {
- lv2_log_trace(&self->logger,
- "Unknown object type %d\n", obj->body.otype);
- }
- } else {
- lv2_log_trace(&self->logger,
- "Unknown event type %d\n", ev->body.type);
- }
- }
-
- // Render the sample (possibly already in progress)
- if (self->play) {
- uint32_t f = self->frame;
- const uint32_t lf = self->sample->info.frames;
-
- for (pos = 0; pos < start_frame; ++pos) {
- output[pos] = 0;
- }
-
- for (; pos < sample_count && f < lf; ++pos, ++f) {
- output[pos] = self->sample->data[f];
- }
-
- self->frame = f;
-
- if (f == lf) {
- self->play = false;
- }
- }
-
- // Add zeros to end if sample not long enough (or not playing)
- for (; pos < sample_count; ++pos) {
- output[pos] = 0.0f;
- }
-}
-
-static LV2_State_Status
-save(LV2_Handle instance,
- LV2_State_Store_Function store,
- LV2_State_Handle handle,
- uint32_t flags,
- const LV2_Feature* const* features)
-{
- Sampler* self = (Sampler*)instance;
- if (!self->sample) {
- return LV2_STATE_SUCCESS;
- }
-
- LV2_State_Map_Path* map_path = NULL;
- for (int i = 0; features[i]; ++i) {
- if (!strcmp(features[i]->URI, LV2_STATE__mapPath)) {
- map_path = (LV2_State_Map_Path*)features[i]->data;
- }
- }
-
- char* apath = map_path->abstract_path(map_path->handle, self->sample->path);
-
- store(handle,
- self->uris.eg_sample,
- apath,
- strlen(self->sample->path) + 1,
- self->uris.atom_Path,
- LV2_STATE_IS_POD | LV2_STATE_IS_PORTABLE);
-
- free(apath);
-
- return LV2_STATE_SUCCESS;
-}
-
-static LV2_State_Status
-restore(LV2_Handle instance,
- LV2_State_Retrieve_Function retrieve,
- LV2_State_Handle handle,
- uint32_t flags,
- const LV2_Feature* const* features)
-{
- Sampler* self = (Sampler*)instance;
-
- size_t size;
- uint32_t type;
- uint32_t valflags;
-
- const void* value = retrieve(
- handle,
- self->uris.eg_sample,
- &size, &type, &valflags);
-
- if (value) {
- const char* path = (const char*)value;
- lv2_log_trace(&self->logger, "Restoring file %s\n", path);
- free_sample(self, self->sample);
- self->sample = load_sample(self, path);
- }
-
- return LV2_STATE_SUCCESS;
-}
-
-static const void*
-extension_data(const char* uri)
-{
- static const LV2_State_Interface state = { save, restore };
- static const LV2_Worker_Interface worker = { work, work_response, NULL };
- if (!strcmp(uri, LV2_STATE__interface)) {
- return &state;
- } else if (!strcmp(uri, LV2_WORKER__interface)) {
- return &worker;
- }
- return NULL;
-}
-
-static const LV2_Descriptor descriptor = {
- EG_SAMPLER_URI,
- instantiate,
- connect_port,
- NULL, // activate,
- run,
- NULL, // deactivate,
- cleanup,
- extension_data
-};
-
-LV2_SYMBOL_EXPORT
-const LV2_Descriptor* lv2_descriptor(uint32_t index)
-{
- switch (index) {
- case 0:
- return &descriptor;
- default:
- return NULL;
- }
-}
diff --git a/plugins/eg04-sampler.lv2/sampler_ui.c b/plugins/eg04-sampler.lv2/sampler_ui.c
deleted file mode 100644
index 40922ae..0000000
--- a/plugins/eg04-sampler.lv2/sampler_ui.c
+++ /dev/null
@@ -1,201 +0,0 @@
-/*
- LV2 Sampler Example Plugin UI
- Copyright 2011-2012 David Robillard <d@drobilla.net>
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-/**
- @file ui.c Sampler Plugin UI
-*/
-
-#include <stdlib.h>
-
-#include <gtk/gtk.h>
-
-#include "lv2/lv2plug.in/ns/ext/atom/atom.h"
-#include "lv2/lv2plug.in/ns/ext/atom/forge.h"
-#include "lv2/lv2plug.in/ns/ext/atom/util.h"
-#include "lv2/lv2plug.in/ns/ext/patch/patch.h"
-#include "lv2/lv2plug.in/ns/ext/urid/urid.h"
-#include "lv2/lv2plug.in/ns/extensions/ui/ui.h"
-
-#include "./uris.h"
-
-#define SAMPLER_UI_URI "http://lv2plug.in/plugins/eg-sampler#ui"
-
-typedef struct {
- LV2_Atom_Forge forge;
-
- LV2_URID_Map* map;
- SamplerURIs uris;
-
- LV2UI_Write_Function write;
- LV2UI_Controller controller;
-
- GtkWidget* box;
- GtkWidget* button;
- GtkWidget* label;
-} SamplerUI;
-
-static void
-on_load_clicked(GtkWidget* widget,
- void* handle)
-{
- SamplerUI* ui = (SamplerUI*)handle;
-
- /* Create a dialog to select a sample file. */
- GtkWidget* dialog = gtk_file_chooser_dialog_new(
- "Load Sample",
- NULL,
- GTK_FILE_CHOOSER_ACTION_OPEN,
- GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
- GTK_STOCK_OPEN, GTK_RESPONSE_ACCEPT,
- NULL);
-
- /* Run the dialog, and return if it is cancelled. */
- if (gtk_dialog_run(GTK_DIALOG(dialog)) != GTK_RESPONSE_ACCEPT) {
- gtk_widget_destroy(dialog);
- return;
- }
-
- /* Get the file path from the dialog. */
- char* filename = gtk_file_chooser_get_filename(GTK_FILE_CHOOSER(dialog));
-
- /* Got what we need, destroy the dialog. */
- gtk_widget_destroy(dialog);
-
-#define OBJ_BUF_SIZE 1024
- uint8_t obj_buf[OBJ_BUF_SIZE];
- lv2_atom_forge_set_buffer(&ui->forge, obj_buf, OBJ_BUF_SIZE);
-
- LV2_Atom* msg = write_set_file(&ui->forge, &ui->uris,
- filename, strlen(filename));
-
- ui->write(ui->controller, 0, lv2_atom_total_size(msg),
- ui->uris.atom_eventTransfer,
- msg);
-
- g_free(filename);
-}
-
-static LV2UI_Handle
-instantiate(const LV2UI_Descriptor* descriptor,
- const char* plugin_uri,
- const char* bundle_path,
- LV2UI_Write_Function write_function,
- LV2UI_Controller controller,
- LV2UI_Widget* widget,
- const LV2_Feature* const* features)
-{
- SamplerUI* ui = (SamplerUI*)malloc(sizeof(SamplerUI));
- ui->map = NULL;
- ui->write = write_function;
- ui->controller = controller;
- ui->box = NULL;
- ui->button = NULL;
- ui->label = NULL;
-
- *widget = NULL;
-
- for (int i = 0; features[i]; ++i) {
- if (!strcmp(features[i]->URI, LV2_URID_URI "#map")) {
- ui->map = (LV2_URID_Map*)features[i]->data;
- }
- }
-
- if (!ui->map) {
- fprintf(stderr, "sampler_ui: Host does not support urid:Map\n");
- free(ui);
- return NULL;
- }
-
- map_sampler_uris(ui->map, &ui->uris);
-
- lv2_atom_forge_init(&ui->forge, ui->map);
-
- ui->box = gtk_vbox_new(FALSE, 4);
- ui->label = gtk_label_new("?");
- ui->button = gtk_button_new_with_label("Load Sample");
- gtk_box_pack_start(GTK_BOX(ui->box), ui->label, TRUE, TRUE, 4);
- gtk_box_pack_start(GTK_BOX(ui->box), ui->button, FALSE, FALSE, 4);
- g_signal_connect(ui->button, "clicked",
- G_CALLBACK(on_load_clicked),
- ui);
-
- *widget = ui->box;
-
- return ui;
-}
-
-static void
-cleanup(LV2UI_Handle handle)
-{
- SamplerUI* ui = (SamplerUI*)handle;
- gtk_widget_destroy(ui->button);
- free(ui);
-}
-
-static void
-port_event(LV2UI_Handle handle,
- uint32_t port_index,
- uint32_t buffer_size,
- uint32_t format,
- const void* buffer)
-{
- SamplerUI* ui = (SamplerUI*)handle;
- if (format == ui->uris.atom_eventTransfer) {
- LV2_Atom* atom = (LV2_Atom*)buffer;
- if (atom->type == ui->uris.atom_Blank) {
- LV2_Atom_Object* obj = (LV2_Atom_Object*)atom;
- const LV2_Atom* file_uri = read_set_file(&ui->uris, obj);
- if (!file_uri) {
- fprintf(stderr, "Unknown message sent to UI.\n");
- return;
- }
-
- const char* uri = (const char*)LV2_ATOM_BODY(file_uri);
- gtk_label_set_text(GTK_LABEL(ui->label), uri);
- } else {
- fprintf(stderr, "Unknown message type.\n");
- }
- } else {
- fprintf(stderr, "Unknown format.\n");
- }
-}
-
-static const void*
-extension_data(const char* uri)
-{
- return NULL;
-}
-
-static const LV2UI_Descriptor descriptor = {
- SAMPLER_UI_URI,
- instantiate,
- cleanup,
- port_event,
- extension_data
-};
-
-LV2_SYMBOL_EXPORT
-const LV2UI_Descriptor*
-lv2ui_descriptor(uint32_t index)
-{
- switch (index) {
- case 0:
- return &descriptor;
- default:
- return NULL;
- }
-}
diff --git a/plugins/eg04-sampler.lv2/wscript b/plugins/eg04-sampler.lv2/wscript
deleted file mode 100644
index 732c904..0000000
--- a/plugins/eg04-sampler.lv2/wscript
+++ /dev/null
@@ -1,80 +0,0 @@
-#!/usr/bin/env python
-from waflib.extras import autowaf as autowaf
-import re
-
-# Variables for 'waf dist'
-APPNAME = 'eg-sampler.lv2'
-VERSION = '1.0.0'
-
-# Mandatory variables
-top = '.'
-out = 'build'
-
-def options(opt):
- opt.load('compiler_c')
- autowaf.set_options(opt)
-
-def configure(conf):
- conf.load('compiler_c')
- autowaf.configure(conf)
- autowaf.set_c99_mode(conf)
- autowaf.display_header('Sampler Configuration')
-
- if not autowaf.is_child():
- autowaf.check_pkg(conf, 'lv2', atleast_version='1.2.1', uselib_store='LV2')
-
- autowaf.check_pkg(conf, 'sndfile', uselib_store='SNDFILE',
- atleast_version='1.0.0', mandatory=True)
- autowaf.check_pkg(conf, 'gtk+-2.0', uselib_store='GTK2',
- atleast_version='2.18.0', mandatory=False)
-
- autowaf.display_msg(conf, 'LV2 bundle directory', conf.env.LV2DIR)
- print('')
-
-def build(bld):
- bundle = 'eg-sampler.lv2'
-
- # Make a pattern for shared objects without the 'lib' prefix
- module_pat = re.sub('^lib', '', bld.env.cshlib_PATTERN)
- module_ext = module_pat[module_pat.rfind('.'):]
-
- # Build manifest.ttl by substitution (for portable lib extension)
- bld(features = 'subst',
- source = 'manifest.ttl.in',
- target = '%s/%s' % (bundle, 'manifest.ttl'),
- install_path = '${LV2DIR}/%s' % bundle,
- LIB_EXT = module_ext)
-
- # Copy other data files to build bundle (build/eg-sampler.lv2)
- for i in ['sampler.ttl', 'click.wav']:
- bld(features = 'subst',
- is_copy = True,
- source = i,
- target = '%s/%s' % (bundle, i),
- install_path = '${LV2DIR}/%s' % bundle)
-
- # Use LV2 headers from parent directory if building as a sub-project
- includes = ['.']
- if autowaf.is_child:
- includes += ['../..']
-
- # Build plugin library
- obj = bld(features = 'c cshlib',
- source = 'sampler.c',
- name = 'sampler',
- target = '%s/sampler' % bundle,
- install_path = '${LV2DIR}/%s' % bundle,
- use = 'SNDFILE LV2',
- includes = includes)
- obj.env.cshlib_PATTERN = module_pat
-
- # Build UI library
- if bld.is_defined('HAVE_GTK2'):
- obj = bld(features = 'c cshlib',
- source = 'sampler_ui.c',
- name = 'sampler_ui',
- target = '%s/sampler_ui' % bundle,
- install_path = '${LV2DIR}/%s' % bundle,
- use = 'GTK2 LV2',
- includes = includes)
- obj.env.cshlib_PATTERN = module_pat
diff --git a/plugins/eg05-scope.lv2/wscript b/plugins/eg05-scope.lv2/wscript
deleted file mode 100644
index 807d15d..0000000
--- a/plugins/eg05-scope.lv2/wscript
+++ /dev/null
@@ -1,73 +0,0 @@
-#!/usr/bin/env python
-from waflib.extras import autowaf as autowaf
-import re
-
-# Variables for 'waf dist'
-APPNAME = 'eg-scope.lv2'
-VERSION = '1.0.0'
-
-# Mandatory variables
-top = '.'
-out = 'build'
-
-def options(opt):
- opt.load('compiler_c')
- autowaf.set_options(opt)
-
-def configure(conf):
- conf.load('compiler_c')
- autowaf.configure(conf)
- autowaf.set_c99_mode(conf)
- autowaf.display_header('Scope Configuration')
-
- if not autowaf.is_child():
- autowaf.check_pkg(conf, 'lv2', atleast_version='1.2.1', uselib_store='LV2')
-
- autowaf.check_pkg(conf, 'cairo', uselib_store='CAIRO',
- atleast_version='1.8.10', mandatory=True)
- autowaf.check_pkg(conf, 'gtk+-2.0', uselib_store='GTK2',
- atleast_version='2.18.0', mandatory=False)
-
- autowaf.display_msg(conf, 'LV2 bundle directory', conf.env.LV2DIR)
- print('')
-
-def build(bld):
- bundle = 'eg-scope.lv2'
-
- # Make a pattern for shared objects without the 'lib' prefix
- module_pat = re.sub('^lib', '', bld.env.cshlib_PATTERN)
- module_ext = module_pat[module_pat.rfind('.'):]
-
- # Build manifest.ttl by substitution (for portable lib extension)
- for i in ['manifest.ttl', 'examploscope.ttl']:
- bld(features = 'subst',
- source = i + '.in',
- target = '%s/%s' % (bundle, i),
- install_path = '${LV2DIR}/%s' % bundle,
- LIB_EXT = module_ext)
-
- # Use LV2 headers from parent directory if building as a sub-project
- includes = ['.']
- if autowaf.is_child:
- includes += ['../..']
-
- # Build plugin library
- obj = bld(features = 'c cshlib',
- source = 'examploscope.c',
- name = 'examploscope',
- target = '%s/examploscope' % bundle,
- install_path = '${LV2DIR}/%s' % bundle,
- use = 'LV2',
- includes = includes)
- obj.env.cshlib_PATTERN = module_pat
-
- # Build UI library
- if bld.is_defined('HAVE_GTK2'):
- obj = bld(features = 'c cshlib',
- source = 'examploscope_ui.c',
- name = 'examploscope_ui',
- target = '%s/examploscope_ui' % bundle,
- install_path = '${LV2DIR}/%s' % bundle,
- use = 'GTK2 CAIRO LV2',
- includes = includes)
- obj.env.cshlib_PATTERN = module_pat
diff --git a/plugins/literasc.py b/plugins/literasc.py
index b7b65cd..0bcd8f2 100755
--- a/plugins/literasc.py
+++ b/plugins/literasc.py
@@ -20,7 +20,7 @@ def format_text(text):
def format_code(lang, code):
if code.strip() == '':
return code
-
+
head = '[source,%s]' % lang
sep = '-' * len(head) + '\n'
return head + '\n' + sep + code.strip('\n') + '\n' + sep
@@ -36,16 +36,30 @@ def format_c_source(filename, file):
for line in file:
code += line
+ # Skip initial license comment
+ if code[0:2] == '/*':
+ code = code[code.find('*/') + 2:]
+
for c in code:
if prev_c == '/' and c == '*':
- output += format_code('c', chunk[0:len(chunk)-1])
- in_comment = True
in_comment_start = True
n_stars = 1
- chunk = ''
+ elif in_comment_start:
+ if c == '*':
+ n_stars += 1
+ else:
+ if n_stars > 1:
+ output += format_code('c', chunk[0:len(chunk) - 1])
+ chunk = ''
+ in_comment = True
+ else:
+ chunk += '*' + c
+ in_comment_start = False
elif in_comment and prev_c == '*' and c == '/':
- if n_stars > 2:
- output += format_text(chunk[0:len(chunk)-1])
+ if n_stars > 1:
+ output += format_text(chunk[0:len(chunk) - 1])
+ else:
+ output += format_code('c', '/* ' + chunk[0:len(chunk) - 1] + '*/')
in_comment = False
in_comment_start = False
chunk = ''
@@ -73,7 +87,7 @@ def format_ttl_source(filename, file):
chunk = line
else:
if is_comment:
- output += format_code('txt', chunk)
+ output += format_code('turtle', chunk)
in_comment = True
chunk = line.strip().lstrip('# ') + ' \n'
else:
@@ -82,7 +96,7 @@ def format_ttl_source(filename, file):
if in_comment:
return output + format_text(chunk)
else:
- return output + format_code('txt', chunk)
+ return output + format_code('turtle', chunk)
def gen(out, filenames):
for filename in filenames:
@@ -91,7 +105,7 @@ def gen(out, filenames):
sys.stderr.write('Failed to open file %s\n' % filename)
continue
- if filename.endswith('.c'):
+ if filename.endswith('.c') or filename.endswith('.h'):
out.write(format_c_source(filename, file))
elif filename.endswith('.ttl') or filename.endswith('.ttl.in'):
out.write(format_ttl_source(filename, file))
@@ -101,10 +115,10 @@ def gen(out, filenames):
out.write('\n')
else:
sys.stderr.write("Unknown source format `%s'" % (
- filename[filename.find('.'):]))
+ filename[filename.find('.'):]))
file.close()
-
+
if __name__ == "__main__":
if len(sys.argv) < 2:
sys.stderr.write('Usage: %s FILENAME...\n' % sys.argv[1])
diff --git a/plugins/wscript b/plugins/wscript
index 63d01ae..f5f6571 100644
--- a/plugins/wscript
+++ b/plugins/wscript
@@ -15,20 +15,31 @@ def bld_book_src(task):
filenames += [i.abspath()]
literasc.gen(open(task.outputs[0].abspath(), 'w'), filenames)
-
+
def build(bld):
files = [bld.path.find_node('README.txt')]
- for i in bld.path.ant_glob('*', src=False, dir=True):
+ for i in ['eg-amp.lv2',
+ 'eg-midigate.lv2',
+ 'eg-fifths.lv2',
+ 'eg-metro.lv2',
+ 'eg-sampler.lv2',
+ 'eg-scope.lv2',
+ 'eg-params.lv2']:
files += bld.path.ant_glob('%s/*.txt' % i)
files += bld.path.ant_glob('%s/manifest.ttl*' % i)
files += bld.path.ant_glob('%s/*.ttl' % i)
files += bld.path.ant_glob('%s/*.c' % i)
+ files += bld.path.ant_glob('%s/*.h' % i)
+ # Compile book sources into book.txt asciidoc source
bld(rule = bld_book_src,
source = files,
target = 'book.txt')
- bld(rule = 'asciidoc -b html -o ${TGT} ${SRC}',
+ # Run asciidoc to generate book.html
+ stylesdir = bld.path.find_node('../doc/').abspath()
+ pygments_style = bld.path.find_node('../doc/style.css').abspath()
+ bld(rule = 'asciidoc -a stylesdir=%s -a source-highlighter=pygments -a pygments-style=%s -b html -o ${TGT} ${SRC}' % (
+ stylesdir, pygments_style),
source = 'book.txt',
target = 'book.html')
-
diff --git a/schemas/README b/schemas.lv2/README
index f603937..1395251 100644
--- a/schemas/README
+++ b/schemas.lv2/README
@@ -2,8 +2,8 @@ This directory contains third-party vocabularies used in these LV2
specifications. They are occasionally very slightly modified for validity, but
are otherwise equivalent to their original versions.
-These are included here mainly to make validation without web fetching
-possible, e.g. via sord_validate.
+These are included with LV2 and installed as a bundle to support validation and
+more intelligent use of data by hosts.
The XML schema description in xsd.ttl is an exception, it was mostly
hand-crafted since a good description of XSD in RDF did not seem to exist. The
diff --git a/schemas/dcs.ttl b/schemas.lv2/dcs.ttl
index 6abda11..37b1e10 100644
--- a/schemas/dcs.ttl
+++ b/schemas.lv2/dcs.ttl
@@ -7,31 +7,32 @@
@prefix dbug: <http://ontologi.es/doap-bugs#> .
# Stock imports.
-@prefix cc: <http://creativecommons.org/ns#> .
-@prefix dc: <http://purl.org/dc/terms/> .
-@prefix dcmitype: <http://purl.org/dc/dcmitype/> .
+@prefix dct: <http://purl.org/dc/terms/> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix link: <http://www.w3.org/2006/link#> .
@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 skos: <http://www.w3.org/2004/02/skos/core#> .
-@prefix xhv: <http://www.w3.org/1999/xhtml/vocab#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
-## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
+## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
<http://tobyinkster.co.uk/#i> a foaf:Person .
dcs:
a owl:Ontology ;
rdfs:label "DOAP Change Sets"@en ;
- dc:created "2010-01-08"^^xsd:date ;
- dc:issued "2010-01-08"^^xsd:date ;
- dc:modified "2010-01-08"^^xsd:date ,
+ dct:description "An ontology that extends DOAP to describe changesets."@en ;
+ dct:created "2010-01-08"^^xsd:date ;
+ dct:issued "2010-01-08"^^xsd:date ;
+ dct:modified "2010-01-08"^^xsd:date ,
"2010-01-27"^^xsd:date ,
- "2011-02-15"^^xsd:date ; # dcs:Documentation, dcs:Packaging, dcs:SecurityFix, dcs:SecurityRegression.
- dc:creator <http://tobyinkster.co.uk/#i> .
+ "2011-02-15"^^xsd:date , # dcs:Documentation, dcs:Packaging, dcs:SecurityFix, dcs:SecurityRegression
+ "2012-04-25"^^xsd:date , # dcs:thanks
+ "2012-06-20"^^xsd:date , # dcs:released-by
+ "2013-09-03"^^xsd:date , # dcs:Tests, dcs:BackCompat
+ "2015-01-15"^^xsd:date , # Syntax errors, add description
+ "2015-04-05"^^xsd:date ; # use dcterms, trim imports (drobilla, for LV2)
+ dct:creator <http://tobyinkster.co.uk/#i> .
<>
a foaf:Document ;
@@ -77,7 +78,7 @@ dcs:Removal
rdfs:label "Addition"@en ;
rdfs:comment "A change that removed a feature."@en ;
rdfs:subClassOf dcs:Change .
-
+
dcs:Bugfix
a owl:Class ;
rdfs:isDefinedBy dcs: ;
@@ -125,6 +126,20 @@ dcs:SecurityRegression
rdfs:comment "A change that created or worsened a security problem."@en ;
rdfs:subClassOf dcs:Change , dcs:Regression .
+dcs:Tests
+ a owl:Class ;
+ rdfs:isDefinedBy dcs: ;
+ rdfs:label "Tests"@en ;
+ rdfs:comment "A change to the test suite."@en ;
+ rdfs:subClassOf dcs:Change.
+
+dcs:BackCompat
+ a owl:Class ;
+ rdfs:isDefinedBy dcs: ;
+ rdfs:label "Backwards Compatibility"@en ;
+ rdfs:comment "A change that breaks backwards compatibility, changing documented or tested behaviour."@en ;
+ rdfs:subClassOf dcs:Change.
+
_:FutureChangeSet
a owl:Class ;
rdfs:subClassOf rdf:Bag , dcs:ChangeSet .
@@ -193,7 +208,14 @@ dcs:restores
dcs:blame
a owl:ObjectProperty ;
rdfs:isDefinedBy dcs: ;
- rdfs:label "blame"@en ;
+ rdfs:subPropertyOf dcs:thanks ;
+ rdfs:label "blame"@en .
+
+dcs:thanks
+ a owl:ObjectProperty ;
+ rdfs:isDefinedBy dcs: ;
+ rdfs:label "thanks"@en ;
+ rdfs:comment "More general than dcs:blame - could be used e.g. to indicate who financially sponsored a new feature."@en ;
rdfs:domain dcs:Change ;
rdfs:range foaf:Agent .
@@ -241,3 +263,10 @@ dcs:timescale
rdfs:comment "Human-readable description of the approximate time a change/feature should be complete by."@en ;
rdfs:domain dcs:Change ;
rdfs:range xsd:string .
+
+dcs:released-by
+ a owl:ObjectProperty ;
+ rdfs:isDefinedBy dcs: ;
+ rdfs:label "released by"@en ;
+ rdfs:domain doap:Version ;
+ rdfs:range foaf:Person .
diff --git a/schemas.lv2/dct.ttl b/schemas.lv2/dct.ttl
new file mode 100644
index 0000000..5cdd504
--- /dev/null
+++ b/schemas.lv2/dct.ttl
@@ -0,0 +1,340 @@
+@prefix dcterms: <http://purl.org/dc/terms/> .
+@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#> .
+
+dcterms:
+ a owl:Ontology ;
+ dcterms:modified "2010-10-11" ;
+ dcterms:title "DCMI Metadata Terms"@en-us ;
+ rdfs:comment "This version of the DCMI Terms vocabulary has been heavily trimmed for LV2." .
+
+dcterms:Agent
+ a dcterms:AgentClass ,
+ rdfs:Class ;
+ dcterms:description "Examples of Agent include person, organization, and software agent."@en-us ;
+ rdfs:comment "A resource that acts or has the power to act."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "Agent"@en-us .
+
+dcterms:AgentClass
+ a rdfs:Class ;
+ dcterms:description "Examples of Agent Class include groups seen as classes, such as students, women, charities, lecturers."@en-us ;
+ rdfs:comment "A group of agents."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "Agent Class"@en-us ;
+ rdfs:subClassOf dcterms:AgentClass .
+
+dcterms:LicenseDocument
+ a rdfs:Class ;
+ rdfs:comment "A legal document giving official permission to do something with a Resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "License Document"@en-us ;
+ rdfs:subClassOf dcterms:RightsStatement .
+
+dcterms:LinguisticSystem
+ a rdfs:Class ;
+ dcterms:description "Examples include written, spoken, sign, and computer languages."@en-us ;
+ rdfs:comment "A system of signs, symbols, sounds, gestures, or rules used in communication."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "Linguistic System"@en-us .
+
+dcterms:MediaType
+ a rdfs:Class ;
+ rdfs:comment "A file format or physical medium."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "Media Type"@en-us ;
+ rdfs:subClassOf dcterms:MediaTypeOrExtent .
+
+dcterms:MediaTypeOrExtent
+ a rdfs:Class ;
+ rdfs:comment "A media type or extent."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "Media Type or Extent"@en-us .
+
+dcterms:RightsStatement
+ a rdfs:Class ;
+ rdfs:comment "A statement about the intellectual property rights (IPR) held in or over a Resource, a legal document giving official permission to do something with a resource, or a statement about access rights."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "Rights Statement"@en-us .
+
+dcterms:Standard
+ a rdfs:Class ;
+ rdfs:comment "A basis for comparison; a reference point against which other things can be evaluated."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "Standard"@en-us .
+
+dcterms:URI
+ a rdfs:Datatype ;
+ rdfs:comment "The set of identifiers constructed according to the generic syntax for Uniform Resource Identifiers as specified by the Internet Engineering Task Force."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "URI"@en-us ;
+ rdfs:seeAlso <http://www.ietf.org/rfc/rfc3986.txt> .
+
+dcterms:W3CDTF
+ a rdfs:Datatype ;
+ rdfs:comment "The set of dates and times constructed according to the W3C Date and Time Formats Specification."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "W3C-DTF"@en-us ;
+ rdfs:seeAlso <http://www.w3.org/TR/NOTE-datetime> .
+
+dcterms:abstract
+ a rdf:Property ;
+ rdfs:comment "A summary of the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "Abstract"@en-us ;
+ rdfs:subPropertyOf dcterms:description .
+
+dcterms:alternative
+ a rdf:Property ;
+ dcterms:description "The distinction between titles and alternative titles is application-specific."@en-us ;
+ rdfs:comment "An alternative name for the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "alternative title"@en-us ;
+ rdfs:range rdfs:Literal ;
+ rdfs:subPropertyOf dcterms:title .
+
+dcterms:available
+ a rdf:Property ;
+ rdfs:comment "Date (often a range) that the resource became or will become available."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "date available"@en-us ;
+ rdfs:range rdfs:Literal ;
+ rdfs:subPropertyOf dcterms:date .
+
+dcterms:conformsTo
+ a rdf:Property ;
+ rdfs:comment "An established standard to which the described resource conforms."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "conforms to"@en-us ;
+ rdfs:range dcterms:Standard ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:contributor
+ a rdf:Property ;
+ dcterms:description "Examples of a Contributor include a person, an organization, or a service."@en-us ;
+ rdfs:comment "An entity responsible for making contributions to the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "contributor"@en-us ;
+ rdfs:range dcterms:Agent .
+
+dcterms:created
+ a rdf:Property ;
+ rdfs:comment "Date of creation of the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "date created"@en-us ;
+ rdfs:range rdfs:Literal ;
+ rdfs:subPropertyOf dcterms:date .
+
+dcterms:creator
+ a rdf:Property ;
+ dcterms:description "Examples of a Creator include a person, an organization, or a service."@en-us ;
+ rdfs:comment "An entity primarily responsible for making the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "creator"@en-us ;
+ rdfs:range dcterms:Agent ;
+ rdfs:subPropertyOf dcterms:contributor ;
+ owl:equivalentProperty <http://xmlns.com/foaf/0.1/maker> .
+
+dcterms:date
+ a rdf:Property ;
+ dcterms:description "Date may be used to express temporal information at any level of granularity. Recommended best practice is to use an encoding scheme, such as the W3CDTF profile of ISO 8601 [W3CDTF]."@en-us ;
+ rdfs:comment "A point or period of time associated with an event in the lifecycle of the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "date"@en-us ;
+ rdfs:range rdfs:Literal .
+
+dcterms:dateAccepted
+ a rdf:Property ;
+ dcterms:description "Examples of resources to which a Date Accepted may be relevant are a thesis (accepted by a university department) or an article (accepted by a journal)."@en-us ;
+ rdfs:comment "Date of acceptance of the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "date accepted"@en-us ;
+ rdfs:range rdfs:Literal ;
+ rdfs:subPropertyOf dcterms:date .
+
+dcterms:dateCopyrighted
+ a rdf:Property ;
+ rdfs:comment "Date of copyright."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "date copyrighted"@en-us ;
+ rdfs:range rdfs:Literal ;
+ rdfs:subPropertyOf dcterms:date .
+
+dcterms:dateSubmitted
+ a rdf:Property ;
+ dcterms:description "Examples of resources to which a Date Submitted may be relevant are a thesis (submitted to a university department) or an article (submitted to a journal)."@en-us ;
+ rdfs:comment "Date of submission of the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "date submitted"@en-us ;
+ rdfs:range rdfs:Literal ;
+ rdfs:subPropertyOf dcterms:date .
+
+dcterms:description
+ a rdf:Property ;
+ dcterms:description "Description may include but is not limited to: an abstract, a table of contents, a graphical representation, or a free-text account of the resource."@en-us ;
+ rdfs:comment "An account of the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "description"@en-us .
+
+dcterms:format
+ a rdf:Property ;
+ dcterms:description "Examples of dimensions include size and duration. Recommended best practice is to use a controlled vocabulary such as the list of Internet Media Types [MIME]."@en-us ;
+ rdfs:comment "The file format, physical medium, or dimensions of the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "format"@en-us ;
+ rdfs:range dcterms:MediaTypeOrExtent .
+
+dcterms:hasFormat
+ a rdf:Property ;
+ rdfs:comment "A related resource that is substantially the same as the pre-existing described resource, but in another format."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "has format"@en-us ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:hasPart
+ a rdf:Property ;
+ rdfs:comment "A related resource that is included either physically or logically in the described resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "has part"@en-us ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:hasVersion
+ a rdf:Property ;
+ rdfs:comment "A related resource that is a version, edition, or adaptation of the described resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "has version"@en-us ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:isFormatOf
+ a rdf:Property ;
+ rdfs:comment "A related resource that is substantially the same as the described resource, but in another format."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "is format of"@en-us ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:isPartOf
+ a rdf:Property ;
+ rdfs:comment "A related resource in which the described resource is physically or logically included."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "is part of"@en-us ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:isReferencedBy
+ a rdf:Property ;
+ rdfs:comment "A related resource that references, cites, or otherwise points to the described resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "is referenced by"@en-us ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:isReplacedBy
+ a rdf:Property ;
+ rdfs:comment "A related resource that supplants, displaces, or supersedes the described resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "is replaced by"@en-us ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:isRequiredBy
+ a rdf:Property ;
+ rdfs:comment "A related resource that requires the described resource to support its function, delivery, or coherence."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "is required by"@en-us ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:isVersionOf
+ a rdf:Property ;
+ dcterms:description "Changes in version imply substantive changes in content rather than differences in format."@en-us ;
+ rdfs:comment "A related resource of which the described resource is a version, edition, or adaptation."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "is version of"@en-us ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:issued
+ a rdf:Property ;
+ rdfs:comment "Date of formal issuance (e.g., publication) of the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "date issued"@en-us ;
+ rdfs:range rdfs:Literal ;
+ rdfs:subPropertyOf dcterms:date .
+
+dcterms:language
+ a rdf:Property ;
+ dcterms:description "Recommended best practice is to use a controlled vocabulary such as RFC 4646."@en-us ;
+ rdfs:comment "A language of the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "language"@en-us ;
+ rdfs:range dcterms:LinguisticSystem .
+
+dcterms:license
+ a rdf:Property ;
+ rdfs:comment "A legal document giving official permission to do something with the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "license"@en-us ;
+ rdfs:range dcterms:LicenseDocument ;
+ rdfs:subPropertyOf dcterms:rights .
+
+dcterms:modified
+ a rdf:Property ;
+ rdfs:comment "Date on which the resource was changed."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "date modified"@en-us ;
+ rdfs:range rdfs:Literal ;
+ rdfs:subPropertyOf dcterms:date .
+
+dcterms:publisher
+ a rdf:Property ;
+ dcterms:description "Examples of a Publisher include a person, an organization, or a service."@en-us ;
+ rdfs:comment "An entity responsible for making the resource available."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "publisher"@en-us ;
+ rdfs:range dcterms:Agent .
+
+dcterms:references
+ a rdf:Property ;
+ rdfs:comment "A related resource that is referenced, cited, or otherwise pointed to by the described resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "references"@en-us ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:relation
+ a rdf:Property ;
+ dcterms:description "Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system. "@en-us ;
+ rdfs:comment "A related resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "relation"@en-us .
+
+dcterms:replaces
+ a rdf:Property ;
+ rdfs:comment "A related resource that is supplanted, displaced, or superseded by the described resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "replaces"@en-us ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:requires
+ a rdf:Property ;
+ rdfs:comment "A related resource that is required by the described resource to support its function, delivery, or coherence."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "requires"@en-us ;
+ rdfs:subPropertyOf dcterms:relation .
+
+dcterms:rights
+ a rdf:Property ;
+ dcterms:description "Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights."@en-us ;
+ rdfs:comment "Information about rights held in and over the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "rights"@en-us ;
+ rdfs:range dcterms:RightsStatement .
+
+dcterms:rightsHolder
+ a rdf:Property ;
+ rdfs:comment "A person or organization owning or managing rights over the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "rights holder"@en-us ;
+ rdfs:range dcterms:Agent .
+
+dcterms:title
+ a rdf:Property ;
+ rdfs:comment "A name given to the resource."@en-us ;
+ rdfs:isDefinedBy dcterms: ;
+ rdfs:label "title"@en-us ;
+ rdfs:range rdfs:Literal .
diff --git a/schemas.lv2/doap.ttl b/schemas.lv2/doap.ttl
new file mode 100644
index 0000000..9067da5
--- /dev/null
+++ b/schemas.lv2/doap.ttl
@@ -0,0 +1,707 @@
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix vs: <http://www.w3.org/2003/06/sw-vocab-status/ns#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix dct: <http://purl.org/dc/terms/> .
+
+# dct:rights "Copyright © 2004-2009 Edd Dumbill"
+
+doap:
+ a owl:Ontology ;
+ dct:description "Das Vokabular \"Description of a Project (DOAP)\", beschrieben durch W3C RDF Schema and the Web Ontology Language."@de ,
+ """El vocabulario Description of a Project (DOAP, Descripción de un Proyecto), descrito usando RDF Schema de W3C
+ y Web Ontology Language."""@es ,
+ """Le vocabulaire Description Of A Project (DOAP, Description D'Un Projet),
+ décrit en utilisant RDF Schema du W3C et OWL."""@fr ,
+ "Slovník Description of a Project (DOAP, Popis projektu), popsaný použitím W3C RDF Schema a Web Ontology Language."@cs ,
+ "The Description of a Project (DOAP) vocabulary, described using W3C RDF Schema and the Web Ontology Language." ;
+ dct:title "Description of a Project (DOAP) vocabulary" ;
+ owl:imports foaf: ;
+ foaf:maker [
+ a foaf:Person ;
+ foaf:mbox <mailto:edd@usefulinc.com> ;
+ foaf:name "Edd Dumbill"
+ ] .
+
+doap:ArchRepository
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:comment "Dépôt GNU Arch du code source."@fr ,
+ "GNU Arch Quellcode-Versionierungssystem."@de ,
+ "GNU Arch source code repository."@en ,
+ "Repositorio GNU Arch del código fuente."@es ,
+ "Úložiště zdrojových kódů GNU Arch."@cs ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Dépôt GNU Arch"@fr ,
+ "GNU Arch repository"@de ,
+ "GNU Arch repository"@en ,
+ "Repositorio GNU Arch"@es ,
+ "Úložiště GNU Arch"@cs ;
+ rdfs:subClassOf doap:Repository .
+
+doap:BKRepository
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:comment "BitKeeper Quellcode-Versionierungssystem."@de ,
+ "BitKeeper source code repository."@en ,
+ "Dépôt BitKeeper du code source."@fr ,
+ "Repositorio BitKeeper del código fuente."@es ,
+ "Úložiště zdrojových kódů BitKeeper."@cs ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "BitKeeper Repository"@de ,
+ "BitKeeper Repository"@en ,
+ "Dépôt BitKeeper"@fr ,
+ "Repositorio BitKeeper"@es ,
+ "Úložiště BitKeeper"@cs ;
+ rdfs:subClassOf doap:Repository .
+
+doap:BazaarBranch
+ a rdfs:Class ;
+ rdfs:comment "Bazaar source code branch."@en ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Bazaar Branch"@en ;
+ rdfs:subClassOf doap:Repository .
+
+doap:CVSRepository
+ a rdfs:Class ,
+ owl:Class ;
+ rdfs:comment "CVS Quellcode-Versionierungssystem."@de ,
+ "CVS source code repository."@en ,
+ "Dépôt CVS du code source."@fr ,
+ "Repositorio CVS del código fuente."@es ,
+ "Úložiště zdrojových kódů CVS."@cs ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "CVS Repository"@de ,
+ "CVS Repository"@en ,
+ "Dépôt CVS"@fr ,
+ "Repositorio CVS"@es ,
+ "Úložiště CVS"@cs ;
+ rdfs:subClassOf doap:Repository .
+
+doap:DarcsRepository
+ a rdfs:Class ;
+ rdfs:comment "Dépôt darcs du code source."@fr ,
+ "Repositorio darcs del código fuente."@es ,
+ "darcs source code repository."@en ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Dépôt darcs"@fr ,
+ "Repositorio darcs"@es ,
+ "darcs Repository"@en ;
+ rdfs:subClassOf doap:Repository .
+
+doap:GitBranch
+ a rdfs:Class ;
+ rdfs:comment "Git source code branch."@en ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Git Branch"@en ;
+ rdfs:subClassOf doap:Repository .
+
+doap:HgRepository
+ a rdfs:Class ;
+ rdfs:comment "Mercurial source code repository."@en ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Mercurial Repository"@en ;
+ rdfs:subClassOf doap:Repository .
+
+doap:Project
+ a rdfs:Class ;
+ rdfs:comment "A project."@en ,
+ "Ein Projekt."@de ,
+ "Projekt."@cs ,
+ "Un projet."@fr ,
+ "Un proyecto."@es ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Prijekt"@de ,
+ "Project"@en ,
+ "Projekt"@cs ,
+ "Projet"@fr ,
+ "Proyecto"@es ;
+ rdfs:subClassOf foaf:Project .
+
+doap:Repository
+ a rdfs:Class ;
+ rdfs:comment "Dépôt du code source."@fr ,
+ "Quellcode-Versionierungssystem."@de ,
+ "Repositorio del código fuente."@es ,
+ "Source code repository."@en ,
+ "Úložiště zdrojových kódů."@cs ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Dépôt"@fr ,
+ "Repositorio"@es ,
+ "Repository"@de ,
+ "Repository"@en ,
+ "Úložiště"@cs .
+
+doap:SVNRepository
+ a rdfs:Class ;
+ rdfs:comment "Dépôt Subversion du code source."@fr ,
+ "Repositorio Subversion del código fuente."@es ,
+ "Subversion Quellcode-Versionierungssystem."@de ,
+ "Subversion source code repository."@en ,
+ "Úložiště zdrojových kódů Subversion."@cs ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Dépôt Subversion"@fr ,
+ "Repositorio Subversion"@es ,
+ "Subversion Repository"@de ,
+ "Subversion Repository"@en ,
+ "Úložiště Subversion"@cs ;
+ rdfs:subClassOf doap:Repository .
+
+doap:Specification
+ a rdfs:Class ;
+ rdfs:comment """A specification of a system's aspects, technical or otherwise."""@en ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Specification"@en ;
+ rdfs:subClassOf rdfs:Resource .
+
+doap:Version
+ a rdfs:Class ;
+ rdfs:comment """Détails sur une version d'une realease d'un projet."""@fr ,
+ "Informace o uvolněné verzi projektu."@cs ,
+ "Información sobre la versión de un release del proyecto."@es ,
+ "Version information of a project release."@en ,
+ "Versionsinformation eines Projekt Releases."@de ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Version"@de ,
+ "Version"@en ,
+ "Version"@fr ,
+ "Versión"@es ,
+ "Verze"@cs .
+
+doap:anon-root
+ a rdf:Property ;
+ rdfs:comment "Dépôt pour accès anonyme."@fr ,
+ "Repositorio para acceso anónimo."@es ,
+ "Repository for anonymous access."@en ,
+ "Repository für anonymen Zugriff"@de ,
+ "Úložiště pro anonymní přístup."@cs ;
+ rdfs:domain doap:Repository ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Anonymes Root"@de ,
+ "anonymní kořen"@cs ,
+ "anonymous root"@en ,
+ "racine anonyme"@fr ,
+ "raíz anónima"@es ;
+ rdfs:range rdfs:Literal .
+
+doap:audience
+ a rdf:Property ;
+ rdfs:comment "Description of target user base"@en ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "audience"@en ;
+ rdfs:range rdfs:Literal .
+
+doap:blog
+ a rdf:Property ;
+ rdfs:comment "URI of a blog related to a project"@en ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "blog"@en ;
+ rdfs:range rdfs:Resource .
+
+doap:browse
+ a rdf:Property ;
+ rdfs:comment "Interface web au dépôt."@fr ,
+ "Interface web del repositorio."@es ,
+ "Web browser interface to repository."@en ,
+ "Web-Browser Interface für das Repository."@de ,
+ "Webové rozhraní pro prohlížení úložiště."@cs ;
+ rdfs:domain doap:Repository ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "browse"@de ,
+ "browse"@en ,
+ "navegar"@es ,
+ "prohlížeč"@cs ,
+ "visualiser"@fr .
+
+doap:bug-database
+ a rdf:Property ;
+ rdfs:comment "Bug tracker for a project."@en ,
+ "Bug tracker para un proyecto."@es ,
+ "Fehlerdatenbank eines Projektes."@de ,
+ "Správa chyb projektu."@cs ,
+ "Suivi des bugs pour un projet."@fr ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Fehlerdatenbank"@de ,
+ "base de datos de bugs"@es ,
+ "bug database"@en ,
+ "databáze chyb"@cs ,
+ "suivi des bugs"@fr .
+
+doap:category
+ a rdf:Property ;
+ rdfs:comment "A category of project."@en ,
+ "Eine Kategorie eines Projektes."@de ,
+ "Kategorie projektu."@cs ,
+ "Una categoría de proyecto."@es ,
+ "Une catégorie de projet."@fr ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Kategorie"@de ,
+ "category"@en ,
+ "categoría"@es ,
+ "catégorie"@fr ,
+ "kategorie"@cs .
+
+doap:created
+ a rdf:Property ;
+ rdfs:comment "Date when something was created, in YYYY-MM-DD form. e.g. 2004-04-05"@en ,
+ "Date à laquelle a été créé quelque chose, au format AAAA-MM-JJ (par ex. 2004-04-05)"@fr ,
+ "Datum, kdy bylo něco vytvořeno ve formátu RRRR-MM-DD, např. 2004-04-05"@cs ,
+ "Erstellungsdatum von Irgendwas, angegeben im YYYY-MM-DD Format, z.B. 2004-04-05."@de ,
+ "Fecha en la que algo fue creado, en formato AAAA-MM-DD. e.g. 2004-04-05"@es ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "creado"@es ,
+ "created"@en ,
+ "créé"@fr ,
+ "erstellt"@de ,
+ "vytvořeno"@cs ;
+ rdfs:range rdfs:Literal .
+
+doap:description
+ a rdf:Property ;
+ rdfs:comment "Beschreibung eines Projekts als einfacher Text mit der Länge von 2 bis 4 Sätzen."@de ,
+ "Descripción en texto plano de un proyecto, de 2 a 4 enunciados de longitud."@es ,
+ "Plain text description of a project, of 2-4 sentences in length."@en ,
+ """Texte descriptif d'un projet, long de 2 à 4 phrases."""@fr ,
+ "Čistě textový, 2 až 4 věty dlouhý popis projektu."@cs ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Beschreibung"@de ,
+ "descripción"@es ,
+ "description"@en ,
+ "description"@fr ,
+ "popis"@cs ;
+ rdfs:range rdfs:Literal .
+
+doap:developer
+ a rdf:Property ;
+ rdfs:comment "Desarrollador de software para el proyecto."@es ,
+ "Developer of software for the project."@en ,
+ "Développeur pour le projet."@fr ,
+ "Software-Entwickler für eine Projekt."@de ,
+ "Vývojář softwaru projektu."@cs ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Entwickler"@de ,
+ "desarrollador"@es ,
+ "developer"@en ,
+ "développeur"@fr ,
+ "vývojář"@cs ;
+ rdfs:range foaf:Person .
+
+doap:documenter
+ a rdf:Property ;
+ rdfs:comment "Collaborateur à la documentation du projet."@fr ,
+ "Contributor of documentation to the project."@en ,
+ "Mitarbeiter an der Dokumentation eines Projektes."@de ,
+ "Proveedor de documentación para el proyecto."@es ,
+ "Spoluautor dokumentace projektu."@cs ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Dokumentator"@de ,
+ "documenter"@en ,
+ "dokumentarista"@cs ,
+ "escritor de ayuda"@es ,
+ """rédacteur de l'aide"""@fr ;
+ rdfs:range foaf:Person .
+
+doap:download-mirror
+ a rdf:Property ;
+ rdfs:comment "Miroir de la page de téléchargement du programme."@fr ,
+ "Mirror de la página web de descarga."@es ,
+ "Mirror of software download web page."@en ,
+ "Spiegel der Seite von die Projekt-Software heruntergeladen werden kann."@de ,
+ "Zrcadlo stránky pro stažení softwaru."@cs ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Spiegel der Seite zum Herunterladen"@de ,
+ "download mirror"@en ,
+ "miroir pour le téléchargement"@fr ,
+ "mirror de descarga"@es ,
+ "zrcadlo stránky pro stažení"@cs .
+
+doap:download-page
+ a rdf:Property ;
+ rdfs:comment "Page web à partir de laquelle on peut télécharger le programme."@fr ,
+ "Página web de la cuál se puede bajar el software."@es ,
+ "Web page from which the project software can be downloaded."@en ,
+ "Web-Seite von der die Projekt-Software heruntergeladen werden kann."@de ,
+ "Webová stránka, na které lze stáhnout projektový software."@cs ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Seite zum Herunterladen"@de ,
+ "download page"@en ,
+ "page de téléchargement"@fr ,
+ "página de descarga"@es ,
+ "stránka pro stažení"@cs .
+
+doap:file-release
+ a rdf:Property ;
+ rdfs:comment "URI adresa stažení asociované s revizí."@cs ,
+ "URI of download associated with this release."@en ;
+ rdfs:domain doap:Version ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "file-release"@en ,
+ "soubor revize"@cs .
+
+doap:helper
+ a rdf:Property ;
+ rdfs:comment "Colaborador del proyecto."@es ,
+ "Collaborateur au projet."@fr ,
+ "Project contributor."@en ,
+ "Projekt-Mitarbeiter."@de ,
+ "Spoluautor projektu."@cs ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Helfer"@de ,
+ "colaborador"@es ,
+ "collaborateur"@fr ,
+ "helper"@en ,
+ "spoluautor"@cs ;
+ rdfs:range foaf:Person .
+
+doap:homepage
+ a rdf:Property ,
+ owl:InverseFunctionalProperty ;
+ rdfs:comment """El URL de la página de un proyecto,
+ asociada con exactamente un proyecto."""@es ,
+ """L'URL de la page web d'un projet,
+ associée avec un unique projet."""@fr ,
+ "URL adresa domovské stránky projektu asociované s právě jedním projektem."@cs ,
+ """URL der Projekt-Homepage,
+ verbunden mit genau einem Projekt."""@de ,
+ """URL of a project's homepage,
+ associated with exactly one project."""@en ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Homepage"@de ,
+ "domovská stránka"@cs ,
+ "homepage"@en ,
+ "page web"@fr ,
+ "página web"@es ;
+ rdfs:subPropertyOf foaf:homepage .
+
+doap:implements
+ a rdf:Property ;
+ rdfs:comment "A specification that a project implements. Could be a standard, API or legally defined level of conformance."@en ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Implements specification"@en ;
+ rdfs:range doap:Specification .
+
+doap:language
+ a rdf:Property ;
+ rdfs:comment "ISO language code a project has been translated into"@en ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "language"@en ;
+ rdfs:range rdfs:Literal .
+
+doap:license
+ a rdf:Property ;
+ rdfs:comment "Die URI einer RDF-Beschreibung einer Lizenz unter der die Software herausgegeben wird."@de ,
+ "El URI de una descripción RDF de la licencia bajo la cuál se distribuye el software."@es ,
+ """L'URI d'une description RDF de la licence sous laquelle le programme est distribué."""@fr ,
+ "The URI of an RDF description of the license the software is distributed under."@en ,
+ "URI adresa RDF popisu licence, pod kterou je software distribuován."@cs ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Lizenz"@de ,
+ "licence"@cs ,
+ "licence"@fr ,
+ "licencia"@es ,
+ "license"@en .
+
+doap:location
+ a rdf:Property ;
+ rdfs:comment """Emplacement d'un dépôt."""@fr ,
+ "Location of a repository."@en ,
+ "Lokation eines Repositorys."@de ,
+ "Umístění úložiště."@cs ,
+ "lugar de un repositorio."@es ;
+ rdfs:domain doap:Repository ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Repository Lokation"@de ,
+ "emplacement du dépôt"@fr ,
+ "lugar del respositorio"@es ,
+ "repository location"@en ,
+ "umístění úložiště"@cs .
+
+doap:mailing-list
+ a rdf:Property ;
+ rdfs:comment "Domovská stránka nebo e–mailová adresa e–mailové diskuse."@cs ,
+ "Homepage der Mailing Liste oder E-Mail Adresse."@de ,
+ "Mailing list home page or email address."@en ,
+ "Page web de la liste de diffusion, ou adresse de courriel."@fr ,
+ "Página web de la lista de correo o dirección de correo."@es ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Mailing Liste"@de ,
+ "e–mailová diskuse"@cs ,
+ "lista de correo"@es ,
+ "liste de diffusion"@fr ,
+ "mailing list"@en .
+
+doap:maintainer
+ a rdf:Property ;
+ rdfs:comment "Desarrollador principal de un proyecto, un líder de proyecto."@es ,
+ """Développeur principal d'un projet, un meneur du projet."""@fr ,
+ "Hauptentwickler eines Projektes, der Projektleiter"@de ,
+ "Maintainer of a project, a project leader."@en ,
+ "Správce projektu, vedoucí projektu."@cs ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Projektverantwortlicher"@de ,
+ "desarrollador principal"@es ,
+ "développeur principal"@fr ,
+ "maintainer"@en ,
+ "správce"@cs ;
+ rdfs:range foaf:Person .
+
+doap:module
+ a rdf:Property ;
+ rdfs:comment "Jméno modulu v CVS, BitKeeper nebo Arch úložišti."@cs ,
+ "Modul-Name eines Subversion, CVS, BitKeeper oder Arch Repositorys."@de ,
+ "Module name of a Subversion, CVS, BitKeeper or Arch repository."@en ,
+ """Nom du module d'un dépôt Subversion, CVS, BitKeeper ou Arch."""@fr ,
+ "Nombre del módulo de un repositorio Subversion, CVS, BitKeeper o Arch."@es ;
+ rdfs:domain [
+ a owl:Class ;
+ owl:unionOf (
+ doap:CVSRepository
+ doap:ArchRepository
+ doap:BKRepository
+ )
+ ] ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Modul"@de ,
+ "modul"@cs ,
+ "module"@en ,
+ "module"@fr ,
+ "módulo"@es .
+
+doap:name
+ a rdf:Property ;
+ rdfs:comment "A name of something."@en ,
+ "Der Name von Irgendwas"@de ,
+ "El nombre de algo."@es ,
+ "Jméno něčeho."@cs ,
+ "Le nom de quelque chose."@fr ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Name"@de ,
+ "jméno"@cs ,
+ "name"@en ,
+ "nom"@fr ,
+ "nombre"@es ;
+ rdfs:range rdfs:Literal ;
+ rdfs:subPropertyOf rdfs:label .
+
+doap:old-homepage
+ a rdf:Property ,
+ owl:InverseFunctionalProperty ;
+ rdfs:comment """El URL de la antigua página de un proyecto,
+ asociada con exactamente un proyecto."""@es ,
+ """L'URL d'une ancienne page web d'un
+ projet, associée avec un unique projet."""@fr ,
+ "URL adresa předešlé domovské stránky projektu asociované s právě jedním projektem."@cs ,
+ """URL der letzten Projekt-Homepage,
+ verbunden mit genau einem Projekt."""@de ,
+ """URL of a project's past homepage,
+ associated with exactly one project."""@en ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Alte Homepage"@de ,
+ "ancienne page web"@fr ,
+ "old homepage"@en ,
+ "página web antigua"@es ,
+ "stará domovská stránka"@cs ;
+ rdfs:subPropertyOf foaf:homepage .
+
+doap:os
+ a rdf:Property ;
+ rdfs:comment "Betriebssystem auf dem das Projekt eingesetzt werden kann. Diese Eigenschaft kann ausgelassen werden, wenn das Projekt nicht BS-spezifisch ist."@de ,
+ "Operating system that a project is limited to. Omit this property if the project is not OS-specific."@en ,
+ "Operační systém, na jehož použití je projekt limitován. Vynechejte tuto vlastnost, pokud je projekt nezávislý na operačním systému."@cs ,
+ """Sistema opertivo al cuál está limitado el proyecto. Omita esta propiedad si el proyecto no es específico
+ de un sistema opertaivo en particular."""@es ,
+ """Système d'exploitation auquel est limité le projet. Omettez cette propriété si le
+ projet n'est pas limité à un système d'exploitation."""@fr ;
+ rdfs:domain doap:Project ,
+ doap:Version ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Betriebssystem"@de ,
+ "operating system"@en ,
+ "operační systém"@cs ,
+ "sistema operativo"@es ,
+ """système d'exploitation"""@fr ;
+ rdfs:range rdfs:Literal .
+
+doap:platform
+ a rdf:Property ;
+ rdfs:comment "Indicator of software platform (non-OS specific), e.g. Java, Firefox, ECMA CLR"@en ;
+ rdfs:domain doap:Project ,
+ doap:Version ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "platform"@en ;
+ rdfs:range rdfs:Literal .
+
+doap:programming-language
+ a rdf:Property ;
+ rdfs:comment """Langage de programmation avec lequel un projet est implémenté,
+ ou avec lequel il est prévu de l'utiliser."""@fr ,
+ "Lenguaje de programación en el que un proyecto es implementado o con el cuál pretende usarse."@es ,
+ "Programmiersprache in der ein Projekt implementiert ist oder intendiert wird zu benutzen."@de ,
+ "Programming language a project is implemented in or intended for use with."@en ,
+ "Programovací jazyk, ve kterém je projekt implementován nebo pro který je zamýšlen k použití."@cs ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Programmiersprache"@de ,
+ "langage de programmation"@fr ,
+ "lenguaje de programación"@es ,
+ "programming language"@en ,
+ "programovací jazyk"@cs ;
+ rdfs:range rdfs:Literal .
+
+doap:release
+ a rdf:Property ;
+ rdfs:comment "A project release."@en ,
+ "Ein Release (Version) eines Projekts."@de ,
+ "Relase (verze) projektu."@cs ,
+ "Un release (versión) de un proyecto."@es ,
+ """Une release (révision) d'un projet."""@fr ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Release"@de ,
+ "release"@cs ,
+ "release"@en ,
+ "release"@es ,
+ "release"@fr ;
+ rdfs:range doap:Version .
+
+doap:repository
+ a rdf:Property ;
+ rdfs:comment "Dépôt du code source."@fr ,
+ "Quellcode-Versionierungssystem."@de ,
+ "Repositorio del código fuente."@es ,
+ "Source code repository."@en ,
+ "Úložiště zdrojových kódů."@cs ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Repository"@de ,
+ "dépôt"@fr ,
+ "repositorio"@es ,
+ "repository"@en ,
+ "úložiště"@cs ;
+ rdfs:range doap:Repository .
+
+doap:revision
+ a rdf:Property ;
+ rdfs:comment """Identifiant de révision d'une release du programme."""@fr ,
+ "Identifikátor zpřístupněné revize softwaru."@cs ,
+ "Indentificador de la versión de un release de software."@es ,
+ "Revision identifier of a software release."@en ,
+ "Versionsidentifikator eines Software-Releases."@de ;
+ rdfs:domain doap:Version ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Version"@de ,
+ "revision"@en ,
+ "révision"@fr ,
+ "versión"@es ,
+ "verze"@cs ;
+ rdfs:range rdfs:Literal .
+
+doap:screenshots
+ a rdf:Property ;
+ rdfs:comment """Page web avec des captures d'écran du projet."""@fr ,
+ "Página web con capturas de pantalla del proyecto."@es ,
+ "Web page with screenshots of project."@en ,
+ "Web-Seite mit Screenshots eines Projektes."@de ,
+ "Webová stránka projektu se snímky obrazovky."@cs ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Screenshots"@de ,
+ "capturas de pantalla"@es ,
+ """captures d'écran"""@fr ,
+ "screenshots"@en ,
+ "snímek obrazovky"@cs .
+
+doap:service-endpoint
+ a rdf:Property ;
+ rdfs:comment "The URI of a web service endpoint where software as a service may be accessed"@en ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "service endpoint"@en ;
+ rdfs:range rdfs:Resource .
+
+doap:shortdesc
+ a rdf:Property ;
+ rdfs:comment "Descripción corta (8 o 9 palabras) en texto plano de un proyecto."@es ,
+ "Krátký (8 nebo 9 slov) čistě textový popis projektu."@cs ,
+ "Kurzbeschreibung (8 oder 9 Wörter) eines Projects als einfacher Text."@de ,
+ "Short (8 or 9 words) plain text description of a project."@en ,
+ """Texte descriptif concis (8 ou 9 mots) d'un projet."""@fr ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Kurzbeschreibung"@de ,
+ "descripción corta"@es ,
+ "description courte"@fr ,
+ "krátký popis"@cs ,
+ "short description"@en ;
+ rdfs:range rdfs:Literal .
+
+doap:tester
+ a rdf:Property ;
+ rdfs:comment "A tester or other quality control contributor."@en ,
+ "Ein Tester oder anderer Mitarbeiter der Qualitätskontrolle."@de ,
+ "Tester nebo jiný spoluautor kontrolující kvalitu."@cs ,
+ "Un tester u otro proveedor de control de calidad."@es ,
+ "Un testeur ou un collaborateur au contrôle qualité."@fr ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Tester"@de ,
+ "tester"@cs ,
+ "tester"@en ,
+ "tester"@es ,
+ "testeur"@fr ;
+ rdfs:range foaf:Person .
+
+doap:translator
+ a rdf:Property ;
+ rdfs:comment "Collaborateur à la traduction du projet."@fr ,
+ "Contributor of translations to the project."@en ,
+ "Mitarbeiter an den Übersetzungen eines Projektes."@de ,
+ "Proveedor de traducciones al proyecto."@es ,
+ "Spoluautor překladu projektu."@cs ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "překladatel"@cs ,
+ "traducteur"@fr ,
+ "traductor"@es ,
+ "translator"@en ,
+ "Übersetzer"@de ;
+ rdfs:range foaf:Person .
+
+doap:vendor
+ a rdf:Property ;
+ rdfs:comment "Vendor organization: commercial, free or otherwise"@en ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "vendor"@en ;
+ rdfs:range foaf:Organization .
+
+doap:wiki
+ a rdf:Property ;
+ rdfs:comment """L'URL du Wiki pour la discussion collaborative sur le projet."""@fr ,
+ "URL adresa wiki projektu pro společné diskuse."@cs ,
+ "URL del Wiki para discusión colaborativa del proyecto."@es ,
+ "URL of Wiki for collaborative discussion of project."@en ,
+ "Wiki-URL für die kollaborative Dikussion eines Projektes."@de ;
+ rdfs:domain doap:Project ;
+ rdfs:isDefinedBy doap: ;
+ rdfs:label "Wiki"@de ,
+ "wiki"@cs ,
+ "wiki"@en ,
+ "wiki"@es ,
+ "wiki"@fr .
diff --git a/schemas/foaf.ttl b/schemas.lv2/foaf.ttl
index 884266f..1ae75aa 100644
--- a/schemas/foaf.ttl
+++ b/schemas.lv2/foaf.ttl
@@ -2,39 +2,13 @@
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix wot: <http://xmlns.com/wot/0.1/> .
-@prefix dc: <http://purl.org/dc/elements/1.1/> .
-
-dc:date
- a owl:AnnotationProperty .
-
-dc:description
- a owl:AnnotationProperty .
-
-dc:title
- a owl:AnnotationProperty .
-
-rdfs:Class
- a owl:Class .
-
-<http://www.w3.org/2000/10/swap/pim/contact#Person>
- a owl:Class ;
- rdfs:label "Person" .
-
-owl:Thing
- rdfs:label "Thing" .
-
-<http://www.w3.org/2003/01/geo/wgs84_pos#SpatialThing>
- a owl:Class ;
- rdfs:label "Spatial Thing" .
-
-<http://www.w3.org/2004/02/skos/core#Concept>
- rdfs:label "Concept" .
+@prefix dct: <http://purl.org/dc/terms/> .
<http://xmlns.com/foaf/0.1/>
- dc:description "The Friend of a Friend (FOAF) RDF vocabulary, described using W3C RDF Schema and the Web Ontology Language." ;
- dc:title "Friend of a Friend (FOAF) vocabulary" ;
- a owl:Ontology .
+ a owl:Ontology ;
+ dct:description "The Friend of a Friend (FOAF) RDF vocabulary, described using W3C RDF Schema and the Web Ontology Language." ;
+ dct:title "Friend of a Friend (FOAF) vocabulary" ;
+ rdfs:comment "This version of the FOAF vocabulary has been slightly trimmed for LV2." .
foaf:Agent
a rdfs:Class, owl:Class ;
@@ -109,7 +83,7 @@ foaf:Person
rdfs:comment "A person." ;
rdfs:isDefinedBy <http://xmlns.com/foaf/0.1/> ;
rdfs:label "Person" ;
- rdfs:subClassOf <http://www.w3.org/2000/10/swap/pim/contact#Person>, <http://www.w3.org/2003/01/geo/wgs84_pos#SpatialThing>, foaf:Agent ;
+ rdfs:subClassOf foaf:Agent ;
owl:disjointWith foaf:Organization, foaf:Project .
foaf:PersonalProfileDocument
@@ -166,14 +140,6 @@ foaf:aimChatID
rdfs:range rdfs:Literal ;
rdfs:subPropertyOf foaf:nick .
-foaf:based_near
- a rdf:Property, owl:ObjectProperty ;
- rdfs:comment "A location that something is based near, for some broadly human notion of near." ;
- rdfs:domain <http://www.w3.org/2003/01/geo/wgs84_pos#SpatialThing> ;
- rdfs:isDefinedBy <http://xmlns.com/foaf/0.1/> ;
- rdfs:label "based near" ;
- rdfs:range <http://www.w3.org/2003/01/geo/wgs84_pos#SpatialThing> .
-
foaf:birthday
a rdf:Property, owl:DatatypeProperty, owl:FunctionalProperty ;
rdfs:comment "The birthday of this Agent, represented in mm-dd string form, eg. '12-31'." ;
@@ -223,14 +189,6 @@ foaf:familyName
rdfs:label "familyName" ;
rdfs:range rdfs:Literal .
-foaf:family_name
- a rdf:Property, owl:DatatypeProperty ;
- rdfs:comment "The family name of some person." ;
- rdfs:domain foaf:Person ;
- rdfs:isDefinedBy <http://xmlns.com/foaf/0.1/> ;
- rdfs:label "family_name" ;
- rdfs:range rdfs:Literal .
-
foaf:firstName
a rdf:Property, owl:DatatypeProperty ;
rdfs:comment "The first name of a person." ;
@@ -239,14 +197,6 @@ foaf:firstName
rdfs:label "firstName" ;
rdfs:range rdfs:Literal .
-foaf:focus
- a rdf:Property, owl:ObjectProperty ;
- rdfs:comment "The underlying or 'focal' entity associated with some SKOS-described concept." ;
- rdfs:domain <http://www.w3.org/2004/02/skos/core#Concept> ;
- rdfs:isDefinedBy <http://xmlns.com/foaf/0.1/> ;
- rdfs:label "focus" ;
- rdfs:range owl:Thing .
-
foaf:fundedBy
a rdf:Property, owl:ObjectProperty ;
rdfs:comment "An organization funding a project or person." ;
@@ -627,10 +577,3 @@ foaf:yahooChatID
rdfs:label "Yahoo chat ID" ;
rdfs:range rdfs:Literal ;
rdfs:subPropertyOf foaf:nick .
-
-wot:assurance
- a owl:AnnotationProperty .
-
-wot:src_assurance
- a owl:AnnotationProperty .
-
diff --git a/schemas.lv2/manifest.ttl b/schemas.lv2/manifest.ttl
new file mode 100644
index 0000000..2dbcbd4
--- /dev/null
+++ b/schemas.lv2/manifest.ttl
@@ -0,0 +1,34 @@
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://ontologi.es/doap-changeset#>
+ a owl:Ontology ;
+ rdfs:seeAlso <dcs.ttl> .
+
+<http://purl.org/dc/terms/>
+ a owl:Ontology ;
+ rdfs:seeAlso <dct.ttl> .
+
+<http://usefulinc.com/ns/doap#>
+ a owl:Ontology ;
+ rdfs:seeAlso <doap.ttl> .
+
+<http://xmlns.com/foaf/0.1/>
+ a owl:Ontology ;
+ rdfs:seeAlso <foaf.ttl> .
+
+<http://www.w3.org/2002/07/owl>
+ a owl:Ontology ;
+ rdfs:seeAlso <owl.ttl> .
+
+<http://www.w3.org/2000/01/rdf-schema#>
+ a owl:Ontology ;
+ rdfs:seeAlso <rdfs.ttl> .
+
+<http://www.w3.org/1999/02/22-rdf-syntax-ns#>
+ a owl:Ontology ;
+ rdfs:seeAlso <rdf.ttl> .
+
+<http://www.w3.org/2001/XMLSchema#>
+ a owl:Ontology ;
+ rdfs:seeAlso <xsd.ttl> .
diff --git a/schemas/owl.ttl b/schemas.lv2/owl.ttl
index 35d5b37..3f1c86e 100644
--- a/schemas/owl.ttl
+++ b/schemas.lv2/owl.ttl
@@ -2,10 +2,10 @@
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@prefix dc: <http://purl.org/dc/elements/1.1/> .
+@prefix dct: <http://purl.org/dc/terms/> .
<http://www.w3.org/2002/07/owl>
- dc:title "The OWL 2 Schema vocabulary (OWL 2)" ;
+ dct:title "The OWL 2 Schema vocabulary (OWL 2)" ;
a owl:Ontology ;
rdfs:comment """
This ontology partially describes the built-in classes and
@@ -87,13 +87,6 @@ owl:Class
rdfs:label "Class" ;
rdfs:subClassOf rdfs:Class .
-owl:DataRange
- a rdfs:Class ;
- rdfs:comment "The class of OWL data ranges, which are special kinds of datatypes. Note: The use of the IRI owl:DataRange has been deprecated as of OWL 2. The IRI rdfs:Datatype SHOULD be used instead." ;
- rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "DataRange" ;
- rdfs:subClassOf rdfs:Datatype .
-
owl:DatatypeProperty
a rdfs:Class ;
rdfs:comment "The class of data properties." ;
@@ -217,7 +210,7 @@ owl:allValuesFrom
rdfs:comment "The property that determines the class that a universal property restriction refers to." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "allValuesFrom" ;
+ rdfs:label "all values from" ;
rdfs:range rdfs:Class .
owl:annotatedProperty
@@ -225,7 +218,7 @@ owl:annotatedProperty
rdfs:comment "The property that determines the predicate of an annotated axiom or annotated annotation." ;
rdfs:domain rdfs:Resource ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "annotatedProperty" ;
+ rdfs:label "annotated property" ;
rdfs:range rdfs:Resource .
owl:annotatedSource
@@ -233,7 +226,7 @@ owl:annotatedSource
rdfs:comment "The property that determines the subject of an annotated axiom or annotated annotation." ;
rdfs:domain rdfs:Resource ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "annotatedSource" ;
+ rdfs:label "annotated source" ;
rdfs:range rdfs:Resource .
owl:annotatedTarget
@@ -241,7 +234,7 @@ owl:annotatedTarget
rdfs:comment "The property that determines the object of an annotated axiom or annotated annotation." ;
rdfs:domain rdfs:Resource ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "annotatedTarget" ;
+ rdfs:label "annotated target" ;
rdfs:range rdfs:Resource .
owl:assertionProperty
@@ -249,7 +242,7 @@ owl:assertionProperty
rdfs:comment "The property that determines the predicate of a negative property assertion." ;
rdfs:domain owl:NegativePropertyAssertion ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "assertionProperty" ;
+ rdfs:label "assertion property" ;
rdfs:range rdf:Property .
owl:backwardCompatibleWith
@@ -257,7 +250,7 @@ owl:backwardCompatibleWith
rdfs:comment "The annotation property that indicates that a given ontology is backward compatible with another ontology." ;
rdfs:domain owl:Ontology ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "backwardCompatibleWith" ;
+ rdfs:label "backward compatible with" ;
rdfs:range owl:Ontology .
owl:bottomDataProperty
@@ -265,7 +258,7 @@ owl:bottomDataProperty
rdfs:comment "The data property that does not relate any individual to any data value." ;
rdfs:domain owl:Thing ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "bottomDataProperty" ;
+ rdfs:label "bottom data property" ;
rdfs:range rdfs:Literal .
owl:bottomObjectProperty
@@ -273,7 +266,7 @@ owl:bottomObjectProperty
rdfs:comment "The object property that does not relate any two individuals." ;
rdfs:domain owl:Thing ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "bottomObjectProperty" ;
+ rdfs:label "bottom object property" ;
rdfs:range owl:Thing .
owl:cardinality
@@ -289,7 +282,7 @@ owl:complementOf
rdfs:comment "The property that determines that a given class is the complement of another class." ;
rdfs:domain owl:Class ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "complementOf" ;
+ rdfs:label "complement of" ;
rdfs:range owl:Class .
owl:datatypeComplementOf
@@ -297,7 +290,7 @@ owl:datatypeComplementOf
rdfs:comment "The property that determines that a given data range is the complement of another data range with respect to the data domain." ;
rdfs:domain rdfs:Datatype ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "datatypeComplementOf" ;
+ rdfs:label "datatype complement of" ;
rdfs:range rdfs:Datatype .
owl:deprecated
@@ -313,7 +306,7 @@ owl:differentFrom
rdfs:comment "The property that determines that two given individuals are different." ;
rdfs:domain owl:Thing ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "differentFrom" ;
+ rdfs:label "different from" ;
rdfs:range owl:Thing .
owl:disjointUnionOf
@@ -321,7 +314,7 @@ owl:disjointUnionOf
rdfs:comment "The property that determines that a given class is equivalent to the disjoint union of a collection of other classes." ;
rdfs:domain owl:Class ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "disjointUnionOf" ;
+ rdfs:label "disjoint union of" ;
rdfs:range rdf:List .
owl:disjointWith
@@ -329,7 +322,7 @@ owl:disjointWith
rdfs:comment "The property that determines that two given classes are disjoint." ;
rdfs:domain owl:Class ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "disjointWith" ;
+ rdfs:label "disjoint with" ;
rdfs:range owl:Class .
owl:distinctMembers
@@ -337,7 +330,7 @@ owl:distinctMembers
rdfs:comment "The property that determines the collection of pairwise different individuals in a owl:AllDifferent axiom." ;
rdfs:domain owl:AllDifferent ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "distinctMembers" ;
+ rdfs:label "distinct members" ;
rdfs:range rdf:List .
owl:equivalentClass
@@ -345,7 +338,7 @@ owl:equivalentClass
rdfs:comment "The property that determines that two given classes are equivalent, and that is used to specify datatype definitions." ;
rdfs:domain rdfs:Class ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "equivalentClass" ;
+ rdfs:label "equivalent class" ;
rdfs:range rdfs:Class .
owl:equivalentProperty
@@ -353,7 +346,7 @@ owl:equivalentProperty
rdfs:comment "The property that determines that two given properties are equivalent." ;
rdfs:domain rdf:Property ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "equivalentProperty" ;
+ rdfs:label "equivalent property" ;
rdfs:range rdf:Property .
owl:hasKey
@@ -361,7 +354,7 @@ owl:hasKey
rdfs:comment "The property that determines the collection of properties that jointly build a key." ;
rdfs:domain owl:Class ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "hasKey" ;
+ rdfs:label "has key" ;
rdfs:range rdf:List .
owl:hasSelf
@@ -369,7 +362,7 @@ owl:hasSelf
rdfs:comment "The property that determines the property that a self restriction refers to." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "hasSelf" ;
+ rdfs:label "has self" ;
rdfs:range rdfs:Resource .
owl:hasValue
@@ -377,7 +370,7 @@ owl:hasValue
rdfs:comment "The property that determines the individual that a has-value restriction refers to." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "hasValue" ;
+ rdfs:label "has value" ;
rdfs:range rdfs:Resource .
owl:imports
@@ -393,7 +386,7 @@ owl:incompatibleWith
rdfs:comment "The annotation property that indicates that a given ontology is incompatible with another ontology." ;
rdfs:domain owl:Ontology ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "incompatibleWith" ;
+ rdfs:label "incompatible with" ;
rdfs:range owl:Ontology .
owl:intersectionOf
@@ -401,7 +394,7 @@ owl:intersectionOf
rdfs:comment "The property that determines the collection of classes or data ranges that build an intersection." ;
rdfs:domain rdfs:Class ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "intersectionOf" ;
+ rdfs:label "intersection of" ;
rdfs:range rdf:List .
owl:inverseOf
@@ -409,7 +402,7 @@ owl:inverseOf
rdfs:comment "The property that determines that two given properties are inverse." ;
rdfs:domain owl:ObjectProperty ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "inverseOf" ;
+ rdfs:label "inverse of" ;
rdfs:range owl:ObjectProperty .
owl:maxCardinality
@@ -417,7 +410,7 @@ owl:maxCardinality
rdfs:comment "The property that determines the cardinality of a maximum cardinality restriction." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "maxCardinality" ;
+ rdfs:label "max cardinality" ;
rdfs:range xsd:nonNegativeInteger .
owl:maxQualifiedCardinality
@@ -425,7 +418,7 @@ owl:maxQualifiedCardinality
rdfs:comment "The property that determines the cardinality of a maximum qualified cardinality restriction." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "maxQualifiedCardinality" ;
+ rdfs:label "max qualified cardinality" ;
rdfs:range xsd:nonNegativeInteger .
owl:members
@@ -441,7 +434,7 @@ owl:minCardinality
rdfs:comment "The property that determines the cardinality of a minimum cardinality restriction." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "minCardinality" ;
+ rdfs:label "min cardinality" ;
rdfs:range xsd:nonNegativeInteger .
owl:minQualifiedCardinality
@@ -449,7 +442,7 @@ owl:minQualifiedCardinality
rdfs:comment "The property that determines the cardinality of a minimum qualified cardinality restriction." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "minQualifiedCardinality" ;
+ rdfs:label "min qualified cardinality" ;
rdfs:range xsd:nonNegativeInteger .
owl:onClass
@@ -457,7 +450,7 @@ owl:onClass
rdfs:comment "The property that determines the class that a qualified object cardinality restriction refers to." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "onClass" ;
+ rdfs:label "on class" ;
rdfs:range owl:Class .
owl:onDataRange
@@ -465,7 +458,7 @@ owl:onDataRange
rdfs:comment "The property that determines the data range that a qualified data cardinality restriction refers to." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "onDataRange" ;
+ rdfs:label "on data range" ;
rdfs:range rdfs:Datatype .
owl:onDatatype
@@ -473,7 +466,7 @@ owl:onDatatype
rdfs:comment "The property that determines the datatype that a datatype restriction refers to." ;
rdfs:domain rdfs:Datatype ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "onDatatype" ;
+ rdfs:label "on datatype" ;
rdfs:range rdfs:Datatype .
owl:onProperties
@@ -481,7 +474,7 @@ owl:onProperties
rdfs:comment "The property that determines the n-tuple of properties that a property restriction on an n-ary data range refers to." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "onProperties" ;
+ rdfs:label "on properties" ;
rdfs:range rdf:List .
owl:onProperty
@@ -489,7 +482,7 @@ owl:onProperty
rdfs:comment "The property that determines the property that a property restriction refers to." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "onProperty" ;
+ rdfs:label "on property" ;
rdfs:range rdf:Property .
owl:oneOf
@@ -497,7 +490,7 @@ owl:oneOf
rdfs:comment "The property that determines the collection of individuals or data values that build an enumeration." ;
rdfs:domain rdfs:Class ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "oneOf" ;
+ rdfs:label "one of" ;
rdfs:range rdf:List .
owl:priorVersion
@@ -505,7 +498,7 @@ owl:priorVersion
rdfs:comment "The annotation property that indicates the predecessor ontology of a given ontology." ;
rdfs:domain owl:Ontology ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "priorVersion" ;
+ rdfs:label "prior version" ;
rdfs:range owl:Ontology .
owl:propertyChainAxiom
@@ -513,7 +506,7 @@ owl:propertyChainAxiom
rdfs:comment "The property that determines the n-tuple of properties that build a sub property chain of a given property." ;
rdfs:domain owl:ObjectProperty ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "propertyChainAxiom" ;
+ rdfs:label "property chain axiom" ;
rdfs:range rdf:List .
owl:propertyDisjointWith
@@ -521,7 +514,7 @@ owl:propertyDisjointWith
rdfs:comment "The property that determines that two given properties are disjoint." ;
rdfs:domain rdf:Property ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "propertyDisjointWith" ;
+ rdfs:label "property disjoint with" ;
rdfs:range rdf:Property .
owl:qualifiedCardinality
@@ -529,7 +522,7 @@ owl:qualifiedCardinality
rdfs:comment "The property that determines the cardinality of an exact qualified cardinality restriction." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "qualifiedCardinality" ;
+ rdfs:label "qualified cardinality" ;
rdfs:range xsd:nonNegativeInteger .
owl:sameAs
@@ -537,7 +530,7 @@ owl:sameAs
rdfs:comment "The property that determines that two given individuals are equal." ;
rdfs:domain owl:Thing ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "sameAs" ;
+ rdfs:label "same as" ;
rdfs:range owl:Thing .
owl:someValuesFrom
@@ -545,7 +538,7 @@ owl:someValuesFrom
rdfs:comment "The property that determines the class that an existential property restriction refers to." ;
rdfs:domain owl:Restriction ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "someValuesFrom" ;
+ rdfs:label "some values from" ;
rdfs:range rdfs:Class .
owl:sourceIndividual
@@ -553,7 +546,7 @@ owl:sourceIndividual
rdfs:comment "The property that determines the subject of a negative property assertion." ;
rdfs:domain owl:NegativePropertyAssertion ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "sourceIndividual" ;
+ rdfs:label "source individual" ;
rdfs:range owl:Thing .
owl:targetIndividual
@@ -561,7 +554,7 @@ owl:targetIndividual
rdfs:comment "The property that determines the object of a negative object property assertion." ;
rdfs:domain owl:NegativePropertyAssertion ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "targetIndividual" ;
+ rdfs:label "target individual" ;
rdfs:range owl:Thing .
owl:targetValue
@@ -569,7 +562,7 @@ owl:targetValue
rdfs:comment "The property that determines the value of a negative data property assertion." ;
rdfs:domain owl:NegativePropertyAssertion ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "targetValue" ;
+ rdfs:label "target value" ;
rdfs:range rdfs:Literal .
owl:topDataProperty
@@ -577,7 +570,7 @@ owl:topDataProperty
rdfs:comment "The data property that relates every individual to every data value." ;
rdfs:domain owl:Thing ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "topDataProperty" ;
+ rdfs:label "top data property" ;
rdfs:range rdfs:Literal .
owl:topObjectProperty
@@ -585,7 +578,7 @@ owl:topObjectProperty
rdfs:comment "The object property that relates every two individuals." ;
rdfs:domain owl:Thing ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "topObjectProperty" ;
+ rdfs:label "top object property" ;
rdfs:range owl:Thing .
owl:unionOf
@@ -593,7 +586,7 @@ owl:unionOf
rdfs:comment "The property that determines the collection of classes or data ranges that build a union." ;
rdfs:domain rdfs:Class ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "unionOf" ;
+ rdfs:label "union of" ;
rdfs:range rdf:List .
owl:versionIRI
@@ -601,7 +594,7 @@ owl:versionIRI
rdfs:comment "The property that identifies the version IRI of an ontology." ;
rdfs:domain owl:Ontology ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "versionIRI" ;
+ rdfs:label "version IRI" ;
rdfs:range owl:Ontology .
owl:versionInfo
@@ -609,7 +602,7 @@ owl:versionInfo
rdfs:comment "The annotation property that provides version information for an ontology or another OWL construct." ;
rdfs:domain rdfs:Resource ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "versionInfo" ;
+ rdfs:label "version info" ;
rdfs:range rdfs:Resource .
owl:withRestrictions
@@ -617,6 +610,6 @@ owl:withRestrictions
rdfs:comment "The property that determines the collection of facet-value pairs that define a datatype restriction." ;
rdfs:domain rdfs:Datatype ;
rdfs:isDefinedBy <http://www.w3.org/2002/07/owl#> ;
- rdfs:label "withRestrictions" ;
+ rdfs:label "with restrictions" ;
rdfs:range rdf:List .
diff --git a/schemas/rdf.ttl b/schemas.lv2/rdf.ttl
index b3a2d69..a4dd8ef 100644
--- a/schemas/rdf.ttl
+++ b/schemas.lv2/rdf.ttl
@@ -1,11 +1,11 @@
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@prefix dc: <http://purl.org/dc/elements/1.1/> .
+@prefix dct: <http://purl.org/dc/terms/> .
<http://www.w3.org/1999/02/22-rdf-syntax-ns#>
- dc:description "This is the RDF Schema for the RDF vocabulary defined in the RDF namespace." ;
- dc:title "The RDF Vocabulary (RDF)" ;
+ dct:description "This is the RDF Schema for the RDF vocabulary defined in the RDF namespace." ;
+ dct:title "The RDF Vocabulary (RDF)" ;
a owl:Ontology ;
rdfs:seeAlso <http://www.w3.org/2000/01/rdf-schema-more> .
@@ -34,7 +34,7 @@ rdf:PlainLiteral
a rdfs:Datatype ;
rdfs:comment "The class of plain (i.e. untyped) literal values." ;
rdfs:isDefinedBy <http://www.w3.org/TR/rdf-plain-literal/> ;
- rdfs:label "PlainLiteral" ;
+ rdfs:label "Plain Literal" ;
rdfs:subClassOf rdfs:Literal .
rdf:Property
@@ -62,7 +62,7 @@ rdf:XMLLiteral
a rdfs:Datatype ;
rdfs:comment "The class of XML literal values." ;
rdfs:isDefinedBy <http://www.w3.org/1999/02/22-rdf-syntax-ns#> ;
- rdfs:label "XMLLiteral" ;
+ rdfs:label "XML Literal" ;
rdfs:subClassOf rdfs:Literal .
rdf:first
diff --git a/schemas/rdfs.ttl b/schemas.lv2/rdfs.ttl
index e269860..078d7c8 100644
--- a/schemas/rdfs.ttl
+++ b/schemas.lv2/rdfs.ttl
@@ -1,10 +1,10 @@
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@prefix dc: <http://purl.org/dc/elements/1.1/> .
+@prefix dct: <http://purl.org/dc/terms/> .
<http://www.w3.org/2000/01/rdf-schema#>
- dc:title "The RDF Schema vocabulary (RDFS)" ;
+ dct:title "The RDF Schema vocabulary (RDFS)" ;
a owl:Ontology ;
rdfs:seeAlso <http://www.w3.org/2000/01/rdf-schema-more> .
@@ -24,10 +24,9 @@ rdfs:Container
rdfs:ContainerMembershipProperty
a rdfs:Class ;
- rdfs:comment """The class of container membership properties, rdf:_1, rdf:_2, ...,
- all of which are sub-properties of 'member'.""" ;
+ rdfs:comment "The class of container membership properties, rdf:_1, rdf:_2, ..., all of which are sub-properties of 'member'." ;
rdfs:isDefinedBy <http://www.w3.org/2000/01/rdf-schema#> ;
- rdfs:label "ContainerMembershipProperty" ;
+ rdfs:label "Container Membership Property" ;
rdfs:subClassOf rdf:Property .
rdfs:Datatype
@@ -71,7 +70,7 @@ rdfs:isDefinedBy
rdfs:comment "The defininition of the subject resource." ;
rdfs:domain rdfs:Resource ;
rdfs:isDefinedBy <http://www.w3.org/2000/01/rdf-schema#> ;
- rdfs:label "isDefinedBy" ;
+ rdfs:label "is defined by" ;
rdfs:range rdfs:Resource ;
rdfs:subPropertyOf rdfs:seeAlso .
@@ -104,7 +103,7 @@ rdfs:seeAlso
rdfs:comment "Further information about the subject resource." ;
rdfs:domain rdfs:Resource ;
rdfs:isDefinedBy <http://www.w3.org/2000/01/rdf-schema#> ;
- rdfs:label "seeAlso" ;
+ rdfs:label "see also" ;
rdfs:range rdfs:Resource .
rdfs:subClassOf
@@ -112,7 +111,7 @@ rdfs:subClassOf
rdfs:comment "The subject is a subclass of a class." ;
rdfs:domain rdfs:Class ;
rdfs:isDefinedBy <http://www.w3.org/2000/01/rdf-schema#> ;
- rdfs:label "subClassOf" ;
+ rdfs:label "sub-class of" ;
rdfs:range rdfs:Class .
rdfs:subPropertyOf
@@ -120,6 +119,6 @@ rdfs:subPropertyOf
rdfs:comment "The subject is a subproperty of a property." ;
rdfs:domain rdf:Property ;
rdfs:isDefinedBy <http://www.w3.org/2000/01/rdf-schema#> ;
- rdfs:label "subPropertyOf" ;
+ rdfs:label "sub-property of" ;
rdfs:range rdf:Property .
diff --git a/schemas/xsd.ttl b/schemas.lv2/xsd.ttl
index aa67f2b..54d3ad8 100644
--- a/schemas/xsd.ttl
+++ b/schemas.lv2/xsd.ttl
@@ -3,19 +3,22 @@
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
-<>
+xsd:
a owl:Ontology ;
rdfs:comment "XML Schema Datatypes" .
-xsd:ID
+xsd:anySimpleType
+ a rdfs:Datatype .
+
+xsd:ENTITY
a rdfs:Datatype ;
owl:onDatatype xsd:NCName .
-xsd:IDREF
+xsd:ID
a rdfs:Datatype ;
owl:onDatatype xsd:NCName .
-xsd:ENTITY
+xsd:IDREF
a rdfs:Datatype ;
owl:onDatatype xsd:NCName .
@@ -31,155 +34,216 @@ xsd:Name
a rdfs:Datatype ;
owl:onDatatype xsd:token .
-xsd:totalDigits
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:range xsd:positiveInteger ;
- rdfs:comment "The maximum number of decimal digits required to represent a value." .
-
-xsd:fractionDigits
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:range xsd:nonNegativeInteger ;
- rdfs:comment "The total number of digits to the right of the decimal point required to represent a value." .
-
-xsd:pattern
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:comment "A regular expression that matches complete valid literals." .
-
-xsd:maxInclusive
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:comment "The inclusive upper bound of an ordered datatype." .
-
-xsd:maxExclusive
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:comment "The exclusive upper bound of an ordered datatype." .
-
-xsd:minInclusive
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:comment "The inclusive lower bound of an ordered datatype." .
-
-xsd:minExclusive
- a rdf:Property ,
- owl:DatatypeProperty ;
- rdfs:comment "The exclusive lower bound of an ordered datatype." .
-
xsd:QName
a rdfs:Datatype ;
- rdfs:comment "XML qualified names." .
+ rdfs:label "XML qualified name" ;
+ owl:onDatatype xsd:anySimpleType ;
+ owl:withRestrictions (
+ [
+ xsd:whiteSpace "collapse"
+ ]
+ ) .
xsd:anyURI
a rdfs:Datatype ;
- rdfs:comment "URI reference." .
+ rdfs:label "URI reference" ;
+ owl:onDatatype xsd:anySimpleType ;
+ owl:withRestrictions (
+ [
+ xsd:whiteSpace "collapse"
+ ]
+ ) .
xsd:base64Binary
a rdfs:Datatype ;
rdfs:comment "Base64-encoded arbitrary binary data." ;
+ rdfs:label "base64 binary" ;
+ owl:onDatatype xsd:anySimpleType ;
owl:withRestrictions (
[
xsd:pattern "(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?"
+ ] [
+ xsd:whiteSpace "collapse"
]
) .
xsd:boolean
a rdfs:Datatype ;
+ rdfs:label "boolean" ;
+ owl:onDatatype xsd:anySimpleType ;
owl:withRestrictions (
[
xsd:pattern "(true|false)"
+ ] [
+ xsd:whiteSpace "collapse"
]
) .
xsd:byte
a rdfs:Datatype ;
+ rdfs:label "byte" ;
owl:onDatatype xsd:short ;
owl:withRestrictions (
[
- xsd:pattern "[0-9A-F][0-9A-F]"
+ xsd:minInclusive -128
] [
xsd:maxInclusive 127
- ] [
- xsd:minInclusive -128
]
) .
xsd:date
a rdfs:Datatype ;
+ rdfs:label "date" ;
+ owl:onDatatype xsd:anySimpleType ;
owl:withRestrictions (
[
- xsd:pattern "-?[0-9][0-9][0-9][0-9]([0-9]*)?-(0[1-9]|1[0-1])-([0-3][1-9])([+-][0-1][0-9]:[0-6][0-9])?"
+ xsd:pattern "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?"
+ ] [
+ xsd:whiteSpace "collapse"
]
) .
xsd:dateTime
- a rdfs:Datatype .
+ a rdfs:Datatype ;
+ rdfs:label "date time" ;
+ owl:onDatatype xsd:anySimpleType ;
+ owl:withRestrictions (
+ [
+ xsd:pattern "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?"
+ ] [
+ xsd:whiteSpace "collapse"
+ ]
+ ) .
xsd:decimal
a rdfs:Datatype ;
rdfs:comment "A subset of the real numbers, which can be represented by decimal numerals." ;
+ rdfs:label "decimal" ;
+ owl:onDatatype xsd:anySimpleType ;
owl:withRestrictions (
[
xsd:pattern "[+-]?[0-9]*\\.?[0-9]*"
+ ] [
+ xsd:whiteSpace "collapse"
]
) .
xsd:double
a rdfs:Datatype ;
rdfs:comment "IEEE double-precision 64-bit floating point." ;
+ rdfs:label "double" ;
+ owl:onDatatype xsd:anySimpleType ;
owl:withRestrictions (
[
- xsd:pattern "[+-]?[0-9]*\\.?[0-9]*([eE][-+]?[0-9]+)"
+ xsd:pattern "[+-]?[0-9]*\\.?[0-9]*([eE][-+]?[0-9]+)?"
+ ] [
+ xsd:whiteSpace "collapse"
]
) .
xsd:duration
- a rdfs:Datatype .
+ a rdfs:Datatype ;
+ rdfs:label "duration" ;
+ owl:onDatatype xsd:anySimpleType ;
+ owl:withRestrictions (
+ [
+ xsd:whiteSpace "collapse"
+ ]
+ ) .
xsd:float
a rdfs:Datatype ;
rdfs:comment "IEEE single-precision 32-bit floating point." ;
- owl:onDatatype xsd:double .
+ rdfs:label "float" ;
+ owl:onDatatype xsd:anySimpleType ;
+ owl:withRestrictions (
+ [
+ xsd:pattern "[+-]?[0-9]*\\.?[0-9]*([eE][-+]?[0-9]+)?"
+ ] [
+ xsd:whiteSpace "collapse"
+ ]
+ ) .
+
+xsd:fractionDigits
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:comment "The total number of digits to the right of the decimal point required to represent a value." ;
+ rdfs:label "fraction digits" ;
+ rdfs:range xsd:nonNegativeInteger .
xsd:gDay
- a rdfs:Datatype .
+ a rdfs:Datatype ;
+ owl:onDatatype xsd:anySimpleType ;
+ owl:withRestrictions (
+ [
+ xsd:whiteSpace "collapse"
+ ]
+ ) .
xsd:gMonth
- a rdfs:Datatype .
+ a rdfs:Datatype ;
+ owl:onDatatype xsd:anySimpleType ;
+ owl:withRestrictions (
+ [
+ xsd:whiteSpace "collapse"
+ ]
+ ) .
xsd:gMonthDay
- a rdfs:Datatype .
+ a rdfs:Datatype ;
+ owl:onDatatype xsd:anySimpleType ;
+ owl:withRestrictions (
+ [
+ xsd:whiteSpace "collapse"
+ ]
+ ) .
xsd:gYear
- a rdfs:Datatype .
+ a rdfs:Datatype ;
+ owl:onDatatype xsd:anySimpleType ;
+ owl:withRestrictions (
+ [
+ xsd:whiteSpace "collapse"
+ ]
+ ) .
xsd:gYearMonth
- a rdfs:Datatype .
+ a rdfs:Datatype ;
+ owl:onDatatype xsd:anySimpleType ;
+ owl:withRestrictions (
+ [
+ xsd:whiteSpace "collapse"
+ ]
+ ) .
xsd:hexBinary
a rdfs:Datatype ;
rdfs:comment "Hex-encoded arbitrary binary data." ;
+ rdfs:label "hex binary" ;
+ owl:onDatatype xsd:anySimpleType ;
owl:withRestrictions (
[
xsd:pattern "[0-9A-F]*"
+ ] [
+ xsd:whiteSpace "collapse"
]
) .
xsd:int
a rdfs:Datatype ;
+ rdfs:label "int" ;
owl:onDatatype xsd:long ;
owl:withRestrictions (
[
- xsd:maxInclusive 2147483647
- ] [
xsd:minInclusive -2147483648
+ ] [
+ xsd:maxInclusive 2147483647
]
) .
xsd:integer
a rdfs:Datatype ;
+ rdfs:label "integer" ;
owl:onDatatype xsd:decimal ;
owl:withRestrictions (
[
@@ -191,6 +255,7 @@ xsd:integer
xsd:language
a rdfs:Datatype ;
+ rdfs:label "language" ;
owl:onDatatype xsd:token ;
owl:withRestrictions (
[
@@ -200,17 +265,43 @@ xsd:language
xsd:long
a rdfs:Datatype ;
+ rdfs:label "long" ;
owl:onDatatype xsd:integer ;
owl:withRestrictions (
[
- xsd:maxInclusive 9223372036854775807
- ] [
xsd:minInclusive -9223372036854775808
+ ] [
+ xsd:maxInclusive 9223372036854775807
]
) .
+xsd:maxExclusive
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:comment "The exclusive upper bound of an ordered datatype." ;
+ rdfs:label "max exclusive" .
+
+xsd:maxInclusive
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:comment "The inclusive upper bound of an ordered datatype." ;
+ rdfs:label "max inclusive" .
+
+xsd:minExclusive
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:comment "The exclusive lower bound of an ordered datatype." ;
+ rdfs:label "min exclusive" .
+
+xsd:minInclusive
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:comment "The inclusive lower bound of an ordered datatype." ;
+ rdfs:label "min inclusive" .
+
xsd:negativeInteger
a rdfs:Datatype ;
+ rdfs:label "negative integer" ;
owl:onDatatype xsd:nonPositiveInteger ;
owl:withRestrictions (
[
@@ -220,6 +311,7 @@ xsd:negativeInteger
xsd:nonNegativeInteger
a rdfs:Datatype ;
+ rdfs:label "non-negative integer" ;
owl:onDatatype xsd:integer ;
owl:withRestrictions (
[
@@ -231,6 +323,7 @@ xsd:nonNegativeInteger
xsd:nonPositiveInteger
a rdfs:Datatype ;
+ rdfs:label "non-positive integer" ;
owl:onDatatype xsd:integer ;
owl:withRestrictions (
[
@@ -242,11 +335,39 @@ xsd:nonPositiveInteger
xsd:normalizedString
a rdfs:Datatype ;
+ rdfs:comment "The set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters." ;
+ rdfs:label "normalized string" ;
owl:onDatatype xsd:string ;
- rdfs:comment "The set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters." .
+ owl:withRestrictions (
+ [
+ xsd:whiteSpace "replace"
+ ]
+ ) .
+
+xsd:pattern
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:comment "A regular expression that matches complete valid literals." ;
+ rdfs:label "pattern" .
+
+xsd:whiteSpace
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:comment "A string that describes whitespace normalization for a string type." ;
+ rdfs:label "white space" ;
+ rdfs:range [
+ a rdfs:Datatype ;
+ owl:onDatatype xsd:string ;
+ owl:withRestrictions (
+ [
+ xsd:pattern "(preserve|replace|collapse)"
+ ]
+ )
+ ] .
xsd:positiveInteger
a rdfs:Datatype ;
+ rdfs:label "positive integer" ;
owl:onDatatype xsd:nonNegativeInteger ;
owl:withRestrictions (
[
@@ -258,34 +379,60 @@ xsd:positiveInteger
xsd:short
a rdfs:Datatype ;
+ rdfs:label "short" ;
owl:onDatatype xsd:int ;
owl:withRestrictions (
[
- xsd:maxInclusive 32767
- ] [
xsd:minInclusive -32768
+ ] [
+ xsd:maxInclusive 32767
]
) .
xsd:string
a rdfs:Datatype ;
- rdfs:comment "A character string." .
+ rdfs:comment "A character string." ;
+ rdfs:label "string" ;
+ owl:onDatatype xsd:anySimpleType ;
+ owl:withRestrictions (
+ [
+ xsd:whiteSpace "preserve"
+ ]
+ ) .
xsd:time
a rdfs:Datatype ;
+ rdfs:label "time" ;
+ owl:onDatatype xsd:anySimpleType ;
owl:withRestrictions (
[
xsd:pattern "[1-2][0-9]:[0-5][0-9]:[0-5][0-9].[0-9][0-9][0-9]"
+ ] [
+ xsd:whiteSpace "collapse"
]
) .
xsd:token
a rdfs:Datatype ;
+ rdfs:comment "The set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters, that have no leading or trailing spaces (#x20) and that have no internal sequences of two or more spaces." ;
+ rdfs:label "token" ;
owl:onDatatype xsd:normalizedString ;
- rdfs:comment "The set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters, that have no leading or trailing spaces (#x20) and that have no internal sequences of two or more spaces." .
+ owl:withRestrictions (
+ [
+ xsd:whiteSpace "collapse"
+ ]
+ ) .
+
+xsd:totalDigits
+ a rdf:Property ,
+ owl:DatatypeProperty ;
+ rdfs:comment "The maximum number of decimal digits required to represent a value." ;
+ rdfs:label "total digits" ;
+ rdfs:range xsd:positiveInteger .
xsd:unsignedByte
a rdfs:Datatype ;
+ rdfs:label "unsigned byte" ;
owl:onDatatype xsd:unsignedShort ;
owl:withRestrictions (
[
@@ -295,6 +442,7 @@ xsd:unsignedByte
xsd:unsignedInt
a rdfs:Datatype ;
+ rdfs:label "unsigned int" ;
owl:onDatatype xsd:unsignedLong ;
owl:withRestrictions (
[
@@ -304,6 +452,7 @@ xsd:unsignedInt
xsd:unsignedLong
a rdfs:Datatype ;
+ rdfs:label "unsigned long" ;
owl:onDatatype xsd:nonNegativeInteger ;
owl:withRestrictions (
[
@@ -313,9 +462,11 @@ xsd:unsignedLong
xsd:unsignedShort
a rdfs:Datatype ;
+ rdfs:label "unsigned short" ;
owl:onDatatype xsd:unsignedInt ;
owl:withRestrictions (
[
xsd:maxInclusive 65535
]
) .
+
diff --git a/schemas/aboutdcmi.ttl b/schemas/aboutdcmi.ttl
deleted file mode 100644
index b8c09b4..0000000
--- a/schemas/aboutdcmi.ttl
+++ /dev/null
@@ -1,15 +0,0 @@
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-@prefix dct: <http://purl.org/dc/terms/> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-
-<http://purl.org/dc/aboutdcmi#DCMI>
- dct:created "1995-01-03" ;
- dct:description "The Dublin Core Metadata Initiative is an open forum engaged in the development of interoperable online metadata standards that support a broad range of purposes and business models. DCMI's activities include consensus-driven working groups, global conferences and workshops, standards liaison, and educational efforts to promote widespread acceptance of metadata standards and practices." ;
- dct:subject <http://id.loc.gov/authorities/sh96000740#concept>, <http://id.loc.gov/authorities/sh98002267#concept> ;
- a foaf:Organization , dct:Agent ;
- rdfs:seeAlso <http://purl.org/dc/aboutdcmi> ;
- foaf:homepage <http://dublincore.org/> ;
- foaf:name "Dublin Core Metadata Initiative" ;
- foaf:nick "DCMI" .
-
diff --git a/schemas/dc.ttl b/schemas/dc.ttl
deleted file mode 100644
index ca99ea9..0000000
--- a/schemas/dc.ttl
+++ /dev/null
@@ -1,176 +0,0 @@
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-@prefix skos: <http://www.w3.org/2004/02/skos/core#> .
-@prefix dcam: <http://purl.org/dc/dcam/> .
-@prefix dcterms: <http://purl.org/dc/terms/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://purl.org/dc/elements/1.1/>
- dcterms:modified "2010-10-11" ;
- dcterms:publisher <http://purl.org/dc/aboutdcmi#DCMI> ;
- dcterms:title "Dublin Core Metadata Element Set, Version 1.1"@en-us .
-
-<http://purl.org/dc/elements/1.1/contributor>
- dcterms:description "Examples of a Contributor include a person, an organization, or a service. Typically, the name of a Contributor should be used to indicate the entity."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#contributor-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "An entity responsible for making contributions to the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Contributor"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/coverage>
- dcterms:description "Spatial topic and spatial applicability may be a named place or a location specified by its geographic coordinates. Temporal topic may be a named period, date, or date range. A jurisdiction may be a named administrative entity or a geographic place to which the resource applies. Recommended best practice is to use a controlled vocabulary such as the Thesaurus of Geographic Names [TGN]. Where appropriate, named places or time periods can be used in preference to numeric identifiers such as sets of coordinates or date ranges."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#coverage-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "The spatial or temporal topic of the resource, the spatial applicability of the resource, or the jurisdiction under which the resource is relevant."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Coverage"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/creator>
- dcterms:description "Examples of a Creator include a person, an organization, or a service. Typically, the name of a Creator should be used to indicate the entity."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#creator-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "An entity primarily responsible for making the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Creator"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/date>
- dcterms:description "Date may be used to express temporal information at any level of granularity. Recommended best practice is to use an encoding scheme, such as the W3CDTF profile of ISO 8601 [W3CDTF]."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#date-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A point or period of time associated with an event in the lifecycle of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Date"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/description>
- dcterms:description "Description may include but is not limited to: an abstract, a table of contents, a graphical representation, or a free-text account of the resource."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#description-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "An account of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Description"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/format>
- dcterms:description "Examples of dimensions include size and duration. Recommended best practice is to use a controlled vocabulary such as the list of Internet Media Types [MIME]."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#format-007> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "The file format, physical medium, or dimensions of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Format"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/identifier>
- dcterms:description "Recommended best practice is to identify the resource by means of a string conforming to a formal identification system. "@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#identifier-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "An unambiguous reference to the resource within a given context."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Identifier"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/language>
- dcterms:description "Recommended best practice is to use a controlled vocabulary such as RFC 4646 [RFC4646]."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#language-007> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A language of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Language"@en-us ;
- rdfs:seeAlso <http://www.ietf.org/rfc/rfc4646.txt> ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/publisher>
- dcterms:description "Examples of a Publisher include a person, an organization, or a service. Typically, the name of a Publisher should be used to indicate the entity."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#publisher-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "An entity responsible for making the resource available."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Publisher"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/relation>
- dcterms:description "Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system. "@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#relation-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Relation"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/rights>
- dcterms:description "Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#rights-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Information about rights held in and over the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Rights"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/source>
- dcterms:description "The described resource may be derived from the related resource in whole or in part. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#source-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource from which the described resource is derived."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Source"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/subject>
- dcterms:description "Typically, the subject will be represented using keywords, key phrases, or classification codes. Recommended best practice is to use a controlled vocabulary. To describe the spatial or temporal topic of the resource, use the Coverage element."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#subject-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "The topic of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Subject"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/title>
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#title-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A name given to the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Title"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
-<http://purl.org/dc/elements/1.1/type>
- dcterms:description "Recommended best practice is to use a controlled vocabulary such as the DCMI Type Vocabulary [DCMITYPE]. To describe the file format, physical medium, or dimensions of the resource, use the Format element."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#type-006> ;
- dcterms:issued "1999-07-02" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "The nature or genre of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/elements/1.1/> ;
- rdfs:label "Type"@en-us ;
- skos:note "A second property with the same name as this property has been declared in the dcterms: namespace (http://purl.org/dc/terms/). See the Introduction to the document \"DCMI Metadata Terms\" (http://dublincore.org/documents/dcmi-terms/) for an explanation."@en-us .
-
diff --git a/schemas/dcam.ttl b/schemas/dcam.ttl
deleted file mode 100644
index 6ef5a5e..0000000
--- a/schemas/dcam.ttl
+++ /dev/null
@@ -1,31 +0,0 @@
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-@prefix skos: <http://www.w3.org/2004/02/skos/core#> .
-@prefix dcam: <http://purl.org/dc/dcam/> .
-@prefix dcterms: <http://purl.org/dc/terms/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://purl.org/dc/dcam/>
- dcterms:modified "2010-10-11" ;
- dcterms:publisher <http://purl.org/dc/aboutdcmi#DCMI> ;
- dcterms:title "Metadata terms related to the DCMI Abstract Model"@en-us .
-
-dcam:VocabularyEncodingScheme
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#VocabularyEncodingScheme-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "An enumerated set of resources."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcam/> ;
- rdfs:label "Vocabulary Encoding Scheme"@en-us ;
- rdfs:seeAlso <http://dublincore.org/documents/2007/06/04/abstract-model/> .
-
-dcam:memberOf
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#memberOf-002> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2010-10-11" ;
- a rdf:Property ;
- rdfs:comment "A relationship between a resource and a vocabulary encoding scheme which indicates that the resource is a member of a set."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcam/> ;
- rdfs:label "Member Of"@en-us ;
- rdfs:range dcam:VocabularyEncodingScheme ;
- rdfs:seeAlso <http://dublincore.org/documents/2007/06/04/abstract-model/> .
-
diff --git a/schemas/dct.ttl b/schemas/dct.ttl
deleted file mode 100644
index bf5e2d6..0000000
--- a/schemas/dct.ttl
+++ /dev/null
@@ -1,1036 +0,0 @@
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@prefix skos: <http://www.w3.org/2004/02/skos/core#> .
-@prefix dcam: <http://purl.org/dc/dcam/> .
-@prefix dcterms: <http://purl.org/dc/terms/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://purl.org/dc/terms/>
- dcterms:modified "2010-10-11" ;
- dcterms:publisher <http://purl.org/dc/aboutdcmi#DCMI> ;
- dcterms:title "DCMI Metadata Terms in the /terms/ namespace"@en-us .
-
-dcterms:Agent
- dcterms:description "Examples of Agent include person, organization, and software agent."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Agent-001> ;
- dcterms:issued "2008-01-14" ;
- a dcterms:AgentClass, rdfs:Class ;
- rdfs:comment "A resource that acts or has the power to act."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Agent"@en-us .
-
-dcterms:AgentClass
- dcterms:description "Examples of Agent Class include groups seen as classes, such as students, women, charities, lecturers."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#AgentClass-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A group of agents."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Agent Class"@en-us ;
- rdfs:subClassOf dcterms:AgentClass .
-
-dcterms:BibliographicResource
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#BibliographicResource-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A book, article, or other documentary resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Bibliographic Resource"@en-us .
-
-dcterms:Box
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Box-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Datatype ;
- rdfs:comment "The set of regions in space defined by their geographic coordinates according to the DCMI Box Encoding Scheme."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "DCMI Box"@en-us ;
- rdfs:seeAlso <http://dublincore.org/documents/dcmi-box/> .
-
-dcterms:DCMIType
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#DCMIType-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2010-10-11" ;
- a dcam:VocabularyEncodingScheme ;
- rdfs:comment "The set of classes specified by the DCMI Type Vocabulary, used to categorize the nature or genre of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "DCMI Type Vocabulary"@en-us ;
- rdfs:seeAlso <http://dublincore.org/documents/dcmi-type-vocabulary/>, <http://purl.org/dc/dcmitype/> .
-
-dcterms:DDC
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#DDC-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a dcam:VocabularyEncodingScheme ;
- rdfs:comment "The set of conceptual resources specified by the Dewey Decimal Classification."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "DDC"@en-us ;
- rdfs:seeAlso <http://www.oclc.org/dewey/> .
-
-dcterms:FileFormat
- dcterms:description "Examples include the formats defined by the list of Internet Media Types."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#FileFormat-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A digital resource format."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "File Format"@en-us ;
- rdfs:subClassOf dcterms:MediaType .
-
-dcterms:Frequency
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Frequency-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A rate at which something recurs."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Frequency"@en-us .
-
-dcterms:IMT
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#IMT-004> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a dcam:VocabularyEncodingScheme ;
- rdfs:comment "The set of media types specified by the Internet Assigned Numbers Authority."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "IMT"@en-us ;
- rdfs:seeAlso <http://www.iana.org/assignments/media-types/> .
-
-dcterms:ISO3166
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#ISO3166-004> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Datatype ;
- rdfs:comment "The set of codes listed in ISO 3166-1 for the representation of names of countries."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "ISO 3166"@en-us ;
- rdfs:seeAlso <http://www.iso.org/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html> .
-
-dcterms:ISO639-2
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#ISO639-2-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Datatype ;
- rdfs:comment "The three-letter alphabetic codes listed in ISO639-2 for the representation of names of languages."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "ISO 639-2"@en-us ;
- rdfs:seeAlso <http://lcweb.loc.gov/standards/iso639-2/langhome.html> .
-
-dcterms:ISO639-3
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#ISO639-3-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Datatype ;
- rdfs:comment "The set of three-letter codes listed in ISO 639-3 for the representation of names of languages."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "ISO 639-3"@en-us ;
- rdfs:seeAlso <http://www.sil.org/iso639-3/> .
-
-dcterms:Jurisdiction
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Jurisdiction-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "The extent or range of judicial, law enforcement, or other authority."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Jurisdiction"@en-us ;
- rdfs:subClassOf dcterms:LocationPeriodOrJurisdiction .
-
-dcterms:LCC
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#LCC-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a dcam:VocabularyEncodingScheme ;
- rdfs:comment "The set of conceptual resources specified by the Library of Congress Classification."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "LCC"@en-us ;
- rdfs:seeAlso <http://lcweb.loc.gov/catdir/cpso/lcco/lcco.html> .
-
-dcterms:LCSH
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#LCSH-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a dcam:VocabularyEncodingScheme ;
- rdfs:comment "The set of labeled concepts specified by the Library of Congress Subject Headings."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "LCSH"@en-us .
-
-dcterms:LicenseDocument
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#LicenseDocument-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A legal document giving official permission to do something with a Resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "License Document"@en-us ;
- rdfs:subClassOf dcterms:RightsStatement .
-
-dcterms:LinguisticSystem
- dcterms:description "Examples include written, spoken, sign, and computer languages."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#LinguisticSystem-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A system of signs, symbols, sounds, gestures, or rules used in communication."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Linguistic System"@en-us .
-
-dcterms:Location
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Location-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A spatial region or named place."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Location"@en-us ;
- rdfs:subClassOf dcterms:LocationPeriodOrJurisdiction .
-
-dcterms:LocationPeriodOrJurisdiction
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#LocationPeriodOrJurisdiction-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A location, period of time, or jurisdiction."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Location, Period, or Jurisdiction"@en-us .
-
-dcterms:MESH
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#MESH-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a dcam:VocabularyEncodingScheme ;
- rdfs:comment "The set of labeled concepts specified by the Medical Subject Headings."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "MeSH"@en-us ;
- rdfs:seeAlso <http://www.nlm.nih.gov/mesh/meshhome.html> .
-
-dcterms:MediaType
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#MediaType-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A file format or physical medium."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Media Type"@en-us ;
- rdfs:subClassOf dcterms:MediaTypeOrExtent .
-
-dcterms:MediaTypeOrExtent
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#MediaTypeOrExtent-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A media type or extent."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Media Type or Extent"@en-us .
-
-dcterms:MethodOfAccrual
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#MethodOfAccrual-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A method by which resources are added to a collection."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Method of Accrual"@en-us .
-
-dcterms:MethodOfInstruction
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#MethodOfInstruction-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A process that is used to engender knowledge, attitudes, and skills."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Method of Instruction"@en-us .
-
-dcterms:NLM
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#NLM-002> ;
- dcterms:issued "2005-06-13" ;
- dcterms:modified "2008-01-14" ;
- a dcam:VocabularyEncodingScheme ;
- rdfs:comment "The set of conceptual resources specified by the National Library of Medicine Classification."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "NLM"@en-us ;
- rdfs:seeAlso <http://wwwcf.nlm.nih.gov/class/> .
-
-dcterms:Period
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Period-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Datatype ;
- rdfs:comment "The set of time intervals defined by their limits according to the DCMI Period Encoding Scheme."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "DCMI Period"@en-us ;
- rdfs:seeAlso <http://dublincore.org/documents/dcmi-period/> .
-
-dcterms:PeriodOfTime
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#PeriodOfTime-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "An interval of time that is named or defined by its start and end dates."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Period of Time"@en-us ;
- rdfs:subClassOf dcterms:LocationPeriodOrJurisdiction .
-
-dcterms:PhysicalMedium
- dcterms:description "Examples include paper, canvas, or DVD."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#PhysicalMedium-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A physical material or carrier."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Physical Medium"@en-us ;
- rdfs:subClassOf dcterms:MediaType .
-
-dcterms:PhysicalResource
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#PhysicalResource-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A material thing."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Physical Resource"@en-us .
-
-dcterms:Point
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Point-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Datatype ;
- rdfs:comment "The set of points in space defined by their geographic coordinates according to the DCMI Point Encoding Scheme."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "DCMI Point"@en-us ;
- rdfs:seeAlso <http://dublincore.org/documents/dcmi-point/> .
-
-dcterms:Policy
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Policy-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A plan or course of action by an authority, intended to influence and determine decisions, actions, and other matters."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Policy"@en-us .
-
-dcterms:ProvenanceStatement
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#ProvenanceStatement-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A statement of any changes in ownership and custody of a resource since its creation that are significant for its authenticity, integrity, and interpretation."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Provenance Statement"@en-us .
-
-dcterms:RFC1766
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#RFC1766-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Datatype ;
- rdfs:comment "The set of tags, constructed according to RFC 1766, for the identification of languages."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "RFC 1766"@en-us ;
- rdfs:seeAlso <http://www.ietf.org/rfc/rfc1766.txt> .
-
-dcterms:RFC3066
- dcterms:description "RFC 3066 has been obsoleted by RFC 4646."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#RFC3066-002> ;
- dcterms:issued "2002-07-13" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Datatype ;
- rdfs:comment "The set of tags constructed according to RFC 3066 for the identification of languages."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "RFC 3066"@en-us ;
- rdfs:seeAlso <http://www.ietf.org/rfc/rfc3066.txt> .
-
-dcterms:RFC4646
- dcterms:description "RFC 4646 obsoletes RFC 3066."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#RFC4646-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Datatype ;
- rdfs:comment "The set of tags constructed according to RFC 4646 for the identification of languages."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "RFC 4646"@en-us ;
- rdfs:seeAlso <http://www.ietf.org/rfc/rfc4646.txt> .
-
-dcterms:RFC5646
- dcterms:description "RFC 5646 obsoletes RFC 4646."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#RFC5646-001> ;
- dcterms:issued "2010-10-11" ;
- a rdfs:Datatype ;
- rdfs:comment "The set of tags constructed according to RFC 5646 for the identification of languages."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "RFC 5646"@en-us ;
- rdfs:seeAlso <http://www.ietf.org/rfc/rfc5646.txt> .
-
-dcterms:RightsStatement
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#RightsStatement-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A statement about the intellectual property rights (IPR) held in or over a Resource, a legal document giving official permission to do something with a resource, or a statement about access rights."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Rights Statement"@en-us .
-
-dcterms:SizeOrDuration
- dcterms:description "Examples include a number of pages, a specification of length, width, and breadth, or a period in hours, minutes, and seconds."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#SizeOrDuration-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A dimension or extent, or a time taken to play or execute."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Size or Duration"@en-us ;
- rdfs:subClassOf dcterms:MediaTypeOrExtent .
-
-dcterms:Standard
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Standard-001> ;
- dcterms:issued "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A basis for comparison; a reference point against which other things can be evaluated."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Standard"@en-us .
-
-dcterms:TGN
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#TGN-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a dcam:VocabularyEncodingScheme ;
- rdfs:comment "The set of places specified by the Getty Thesaurus of Geographic Names."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "TGN"@en-us ;
- rdfs:seeAlso <http://www.getty.edu/research/tools/vocabulary/tgn/index.html> .
-
-dcterms:UDC
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#UDC-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a dcam:VocabularyEncodingScheme ;
- rdfs:comment "The set of conceptual resources specified by the Universal Decimal Classification."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "UDC"@en-us ;
- rdfs:seeAlso <http://www.udcc.org/> .
-
-dcterms:URI
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#URI-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Datatype ;
- rdfs:comment "The set of identifiers constructed according to the generic syntax for Uniform Resource Identifiers as specified by the Internet Engineering Task Force."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "URI"@en-us ;
- rdfs:seeAlso <http://www.ietf.org/rfc/rfc3986.txt> .
-
-dcterms:W3CDTF
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#W3CDTF-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Datatype ;
- rdfs:comment "The set of dates and times constructed according to the W3C Date and Time Formats Specification."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "W3C-DTF"@en-us ;
- rdfs:seeAlso <http://www.w3.org/TR/NOTE-datetime> .
-
-dcterms:abstract
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#abstract-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A summary of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Abstract"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/description>, dcterms:description .
-
-dcterms:accessRights
- dcterms:description "Access Rights may include information regarding access or restrictions based on privacy, security, or other policies."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#accessRights-002> ;
- dcterms:issued "2003-02-15" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Information about who can access the resource or an indication of its security status."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Access Rights"@en-us ;
- rdfs:range dcterms:RightsStatement ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/rights>, dcterms:rights .
-
-dcterms:accrualMethod
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#accrualMethod-003> ;
- dcterms:issued "2005-06-13" ;
- dcterms:modified "2010-10-11" ;
- a rdf:Property ;
- rdfs:comment "The method by which items are added to a collection."@en-us ;
- rdfs:domain <http://purl.org/dc/dcmitype/Collection> ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Accrual Method"@en-us ;
- rdfs:range dcterms:MethodOfAccrual .
-
-dcterms:accrualPeriodicity
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#accrualPeriodicity-003> ;
- dcterms:issued "2005-06-13" ;
- dcterms:modified "2010-10-11" ;
- a rdf:Property ;
- rdfs:comment "The frequency with which items are added to a collection."@en-us ;
- rdfs:domain <http://purl.org/dc/dcmitype/Collection> ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Accrual Periodicity"@en-us ;
- rdfs:range dcterms:Frequency .
-
-dcterms:accrualPolicy
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#accrualPolicy-003> ;
- dcterms:issued "2005-06-13" ;
- dcterms:modified "2010-10-11" ;
- a rdf:Property ;
- rdfs:comment "The policy governing the addition of items to a collection."@en-us ;
- rdfs:domain <http://purl.org/dc/dcmitype/Collection> ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Accrual Policy"@en-us ;
- rdfs:range dcterms:Policy .
-
-dcterms:alternative
- dcterms:description "The distinction between titles and alternative titles is application-specific."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#alternative-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2010-10-11" ;
- a rdf:Property ;
- rdfs:comment "An alternative name for the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Alternative Title"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/title>, dcterms:title .
-
-dcterms:audience
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#audience-003> ;
- dcterms:issued "2001-05-21" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A class of entity for whom the resource is intended or useful."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Audience"@en-us ;
- rdfs:range dcterms:AgentClass .
-
-dcterms:available
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#available-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Date (often a range) that the resource became or will become available."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Date Available"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/date>, dcterms:date .
-
-dcterms:bibliographicCitation
- dcterms:description "Recommended practice is to include sufficient bibliographic detail to identify the resource as unambiguously as possible."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#bibliographicCitation-002> ;
- dcterms:issued "2003-02-15" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A bibliographic reference for the resource."@en-us ;
- rdfs:domain dcterms:BibliographicResource ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Bibliographic Citation"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/identifier>, dcterms:identifier .
-
-dcterms:conformsTo
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#conformsTo-003> ;
- dcterms:issued "2001-05-21" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "An established standard to which the described resource conforms."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Conforms To"@en-us ;
- rdfs:range dcterms:Standard ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation .
-
-dcterms:contributor
- dcterms:description "Examples of a Contributor include a person, an organization, or a service."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#contributorT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2010-10-11" ;
- a rdf:Property ;
- rdfs:comment "An entity responsible for making contributions to the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Contributor"@en-us ;
- rdfs:range dcterms:Agent ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/contributor> .
-
-dcterms:coverage
- dcterms:description "Spatial topic and spatial applicability may be a named place or a location specified by its geographic coordinates. Temporal topic may be a named period, date, or date range. A jurisdiction may be a named administrative entity or a geographic place to which the resource applies. Recommended best practice is to use a controlled vocabulary such as the Thesaurus of Geographic Names [TGN]. Where appropriate, named places or time periods can be used in preference to numeric identifiers such as sets of coordinates or date ranges."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#coverageT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "The spatial or temporal topic of the resource, the spatial applicability of the resource, or the jurisdiction under which the resource is relevant."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Coverage"@en-us ;
- rdfs:range dcterms:LocationPeriodOrJurisdiction ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/coverage> .
-
-dcterms:created
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#created-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Date of creation of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Date Created"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/date>, dcterms:date .
-
-dcterms:creator
- dcterms:description "Examples of a Creator include a person, an organization, or a service."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#creatorT-002> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2010-10-11" ;
- a rdf:Property ;
- rdfs:comment "An entity primarily responsible for making the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Creator"@en-us ;
- rdfs:range dcterms:Agent ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/creator>, dcterms:contributor ;
- owl:equivalentProperty <http://xmlns.com/foaf/0.1/maker> .
-
-dcterms:date
- dcterms:description "Date may be used to express temporal information at any level of granularity. Recommended best practice is to use an encoding scheme, such as the W3CDTF profile of ISO 8601 [W3CDTF]."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#dateT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A point or period of time associated with an event in the lifecycle of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Date"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/date> .
-
-dcterms:dateAccepted
- dcterms:description "Examples of resources to which a Date Accepted may be relevant are a thesis (accepted by a university department) or an article (accepted by a journal)."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#dateAccepted-002> ;
- dcterms:issued "2002-07-13" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Date of acceptance of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Date Accepted"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/date>, dcterms:date .
-
-dcterms:dateCopyrighted
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#dateCopyrighted-002> ;
- dcterms:issued "2002-07-13" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Date of copyright."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Date Copyrighted"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/date>, dcterms:date .
-
-dcterms:dateSubmitted
- dcterms:description "Examples of resources to which a Date Submitted may be relevant are a thesis (submitted to a university department) or an article (submitted to a journal)."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#dateSubmitted-002> ;
- dcterms:issued "2002-07-13" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Date of submission of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Date Submitted"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/date>, dcterms:date .
-
-dcterms:description
- dcterms:description "Description may include but is not limited to: an abstract, a table of contents, a graphical representation, or a free-text account of the resource."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#descriptionT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "An account of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Description"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/description> .
-
-dcterms:educationLevel
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#educationLevel-002> ;
- dcterms:issued "2002-07-13" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A class of entity, defined in terms of progression through an educational or training context, for which the described resource is intended."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Audience Education Level"@en-us ;
- rdfs:range dcterms:AgentClass ;
- rdfs:subPropertyOf dcterms:audience .
-
-dcterms:extent
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#extent-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "The size or duration of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Extent"@en-us ;
- rdfs:range dcterms:SizeOrDuration ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/format>, dcterms:format .
-
-dcterms:format
- dcterms:description "Examples of dimensions include size and duration. Recommended best practice is to use a controlled vocabulary such as the list of Internet Media Types [MIME]."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#formatT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "The file format, physical medium, or dimensions of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Format"@en-us ;
- rdfs:range dcterms:MediaTypeOrExtent ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/format> .
-
-dcterms:hasFormat
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#hasFormat-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource that is substantially the same as the pre-existing described resource, but in another format."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Has Format"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:hasPart
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#hasPart-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource that is included either physically or logically in the described resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Has Part"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:hasVersion
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#hasVersion-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource that is a version, edition, or adaptation of the described resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Has Version"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:identifier
- dcterms:description "Recommended best practice is to identify the resource by means of a string conforming to a formal identification system. "@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#identifierT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "An unambiguous reference to the resource within a given context."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Identifier"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/identifier> .
-
-dcterms:instructionalMethod
- dcterms:description "Instructional Method will typically include ways of presenting instructional materials or conducting instructional activities, patterns of learner-to-learner and learner-to-instructor interactions, and mechanisms by which group and individual levels of learning are measured. Instructional methods include all aspects of the instruction and learning processes from planning and implementation through evaluation and feedback."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#instructionalMethod-002> ;
- dcterms:issued "2005-06-13" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A process, used to engender knowledge, attitudes and skills, that the described resource is designed to support."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Instructional Method"@en-us ;
- rdfs:range dcterms:MethodOfInstruction .
-
-dcterms:isFormatOf
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#isFormatOf-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource that is substantially the same as the described resource, but in another format."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Is Format Of"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:isPartOf
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#isPartOf-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource in which the described resource is physically or logically included."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Is Part Of"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:isReferencedBy
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#isReferencedBy-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource that references, cites, or otherwise points to the described resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Is Referenced By"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:isReplacedBy
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#isReplacedBy-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource that supplants, displaces, or supersedes the described resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Is Replaced By"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:isRequiredBy
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#isRequiredBy-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource that requires the described resource to support its function, delivery, or coherence."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Is Required By"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:isVersionOf
- dcterms:description "Changes in version imply substantive changes in content rather than differences in format."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#isVersionOf-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource of which the described resource is a version, edition, or adaptation."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Is Version Of"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:issued
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#issued-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Date of formal issuance (e.g., publication) of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Date Issued"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/date>, dcterms:date .
-
-dcterms:language
- dcterms:description "Recommended best practice is to use a controlled vocabulary such as RFC 4646 [RFC4646]."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#languageT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A language of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Language"@en-us ;
- rdfs:range dcterms:LinguisticSystem ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/language> .
-
-dcterms:license
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#license-002> ;
- dcterms:issued "2004-06-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A legal document giving official permission to do something with the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "License"@en-us ;
- rdfs:range dcterms:LicenseDocument ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/rights>, dcterms:rights .
-
-dcterms:mediator
- dcterms:description "In an educational context, a mediator might be a parent, teacher, teaching assistant, or care-giver."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#mediator-003> ;
- dcterms:issued "2001-05-21" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "An entity that mediates access to the resource and for whom the resource is intended or useful."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Mediator"@en-us ;
- rdfs:range dcterms:AgentClass ;
- rdfs:subPropertyOf dcterms:audience .
-
-dcterms:medium
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#medium-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "The material or physical carrier of the resource."@en-us ;
- rdfs:domain dcterms:PhysicalResource ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Medium"@en-us ;
- rdfs:range dcterms:PhysicalMedium ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/format>, dcterms:format .
-
-dcterms:modified
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#modified-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Date on which the resource was changed."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Date Modified"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/date>, dcterms:date .
-
-dcterms:provenance
- dcterms:description "The statement may include a description of any changes successive custodians made to the resource."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#provenance-002> ;
- dcterms:issued "2004-09-20" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Provenance"@en-us ;
- rdfs:range dcterms:ProvenanceStatement .
-
-dcterms:publisher
- dcterms:description "Examples of a Publisher include a person, an organization, or a service."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#publisherT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2010-10-11" ;
- a rdf:Property ;
- rdfs:comment "An entity responsible for making the resource available."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Publisher"@en-us ;
- rdfs:range dcterms:Agent ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/publisher> .
-
-dcterms:references
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#references-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource that is referenced, cited, or otherwise pointed to by the described resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "References"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:relation
- dcterms:description "Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system. "@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#relationT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Relation"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation> ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:replaces
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#replaces-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource that is supplanted, displaced, or superseded by the described resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Replaces"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:requires
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#requires-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource that is required by the described resource to support its function, delivery, or coherence."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Requires"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/relation>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:rights
- dcterms:description "Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#rightsT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Information about rights held in and over the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Rights"@en-us ;
- rdfs:range dcterms:RightsStatement ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/rights> .
-
-dcterms:rightsHolder
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#rightsHolder-002> ;
- dcterms:issued "2004-06-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A person or organization owning or managing rights over the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Rights Holder"@en-us ;
- rdfs:range dcterms:Agent .
-
-dcterms:source
- dcterms:description "The described resource may be derived from the related resource in whole or in part. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#sourceT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A related resource from which the described resource is derived."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Source"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/source>, dcterms:relation ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:spatial
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#spatial-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Spatial characteristics of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Spatial Coverage"@en-us ;
- rdfs:range dcterms:Location ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/coverage>, dcterms:coverage .
-
-dcterms:subject
- dcterms:description "Typically, the subject will be represented using keywords, key phrases, or classification codes. Recommended best practice is to use a controlled vocabulary. To describe the spatial or temporal topic of the resource, use the Coverage element."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#subjectT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "The topic of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Subject"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/subject> ;
- skos:note "This term is intended to be used with non-literal values as defined in the DCMI Abstract Model (http://dublincore.org/documents/abstract-model/). As of December 2007, the DCMI Usage Board is seeking a way to express this intention with a formal range declaration."@en-us .
-
-dcterms:tableOfContents
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#tableOfContents-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "A list of subunits of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Table Of Contents"@en-us ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/description>, dcterms:description .
-
-dcterms:temporal
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#temporal-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Temporal characteristics of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Temporal Coverage"@en-us ;
- rdfs:range dcterms:PeriodOfTime ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/coverage>, dcterms:coverage .
-
-dcterms:title
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#titleT-002> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2010-10-11" ;
- a rdf:Property ;
- rdfs:comment "A name given to the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Title"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/title> .
-
-dcterms:type
- dcterms:description "Recommended best practice is to use a controlled vocabulary such as the DCMI Type Vocabulary [DCMITYPE]. To describe the file format, physical medium, or dimensions of the resource, use the Format element."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#typeT-001> ;
- dcterms:issued "2008-01-14" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "The nature or genre of the resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Type"@en-us ;
- rdfs:range rdfs:Class ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/type> .
-
-dcterms:valid
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#valid-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdf:Property ;
- rdfs:comment "Date (often a range) of validity of a resource."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/terms/> ;
- rdfs:label "Date Valid"@en-us ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf <http://purl.org/dc/elements/1.1/date>, dcterms:date .
-
diff --git a/schemas/dctype.ttl b/schemas/dctype.ttl
deleted file mode 100644
index 4facf59..0000000
--- a/schemas/dctype.ttl
+++ /dev/null
@@ -1,145 +0,0 @@
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-@prefix skos: <http://www.w3.org/2004/02/skos/core#> .
-@prefix dcam: <http://purl.org/dc/dcam/> .
-@prefix dcterms: <http://purl.org/dc/terms/> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://purl.org/dc/dcmitype/>
- dcterms:modified "2010-10-11" ;
- dcterms:publisher <http://purl.org/dc/aboutdcmi#DCMI> ;
- dcterms:title "DCMI Type Vocabulary"@en-us .
-
-<http://purl.org/dc/dcmitype/Collection>
- dcam:memberOf dcterms:DCMIType ;
- dcterms:description "A collection is described as a group; its parts may also be separately described."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Collection-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "An aggregation of resources."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcmitype/> ;
- rdfs:label "Collection"@en-us .
-
-<http://purl.org/dc/dcmitype/Dataset>
- dcam:memberOf dcterms:DCMIType ;
- dcterms:description "Examples include lists, tables, and databases. A dataset may be useful for direct machine processing."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Dataset-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "Data encoded in a defined structure."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcmitype/> ;
- rdfs:label "Dataset"@en-us .
-
-<http://purl.org/dc/dcmitype/Event>
- dcam:memberOf dcterms:DCMIType ;
- dcterms:description "Metadata for an event provides descriptive information that is the basis for discovery of the purpose, location, duration, and responsible agents associated with an event. Examples include an exhibition, webcast, conference, workshop, open day, performance, battle, trial, wedding, tea party, conflagration."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Event-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A non-persistent, time-based occurrence."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcmitype/> ;
- rdfs:label "Event"@en-us .
-
-<http://purl.org/dc/dcmitype/Image>
- dcam:memberOf dcterms:DCMIType ;
- dcterms:description "Examples include images and photographs of physical objects, paintings, prints, drawings, other images and graphics, animations and moving pictures, film, diagrams, maps, musical notation. Note that Image may include both electronic and physical representations."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Image-004> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A visual representation other than text."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcmitype/> ;
- rdfs:label "Image"@en-us .
-
-<http://purl.org/dc/dcmitype/InteractiveResource>
- dcam:memberOf dcterms:DCMIType ;
- dcterms:description "Examples include forms on Web pages, applets, multimedia learning objects, chat services, or virtual reality environments."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#InteractiveResource-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A resource requiring interaction from the user to be understood, executed, or experienced."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcmitype/> ;
- rdfs:label "Interactive Resource"@en-us .
-
-<http://purl.org/dc/dcmitype/MovingImage>
- dcam:memberOf dcterms:DCMIType ;
- dcterms:description "Examples include animations, movies, television programs, videos, zoetropes, or visual output from a simulation. Instances of the type Moving Image must also be describable as instances of the broader type Image."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#MovingImage-003> ;
- dcterms:issued "2003-11-18" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A series of visual representations imparting an impression of motion when shown in succession."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcmitype/> ;
- rdfs:label "Moving Image"@en-us ;
- rdfs:subClassOf <http://purl.org/dc/dcmitype/Image> .
-
-<http://purl.org/dc/dcmitype/PhysicalObject>
- dcam:memberOf dcterms:DCMIType ;
- dcterms:description "Note that digital representations of, or surrogates for, these objects should use Image, Text or one of the other types."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#PhysicalObject-003> ;
- dcterms:issued "2002-07-13" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "An inanimate, three-dimensional object or substance."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcmitype/> ;
- rdfs:label "Physical Object"@en-us .
-
-<http://purl.org/dc/dcmitype/Service>
- dcam:memberOf dcterms:DCMIType ;
- dcterms:description "Examples include a photocopying service, a banking service, an authentication service, interlibrary loans, a Z39.50 or Web server."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Service-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A system that provides one or more functions."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcmitype/> ;
- rdfs:label "Service"@en-us .
-
-<http://purl.org/dc/dcmitype/Software>
- dcam:memberOf dcterms:DCMIType ;
- dcterms:description "Examples include a C source file, MS-Windows .exe executable, or Perl script."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Software-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A computer program in source or compiled form."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcmitype/> ;
- rdfs:label "Software"@en-us .
-
-<http://purl.org/dc/dcmitype/Sound>
- dcam:memberOf dcterms:DCMIType ;
- dcterms:description "Examples include a music playback file format, an audio compact disc, and recorded speech or sounds."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Sound-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A resource primarily intended to be heard."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcmitype/> ;
- rdfs:label "Sound"@en-us .
-
-<http://purl.org/dc/dcmitype/StillImage>
- dcam:memberOf dcterms:DCMIType ;
- dcterms:description "Examples include paintings, drawings, graphic designs, plans and maps. Recommended best practice is to assign the type Text to images of textual materials. Instances of the type Still Image must also be describable as instances of the broader type Image."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#StillImage-003> ;
- dcterms:issued "2003-11-18" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A static visual representation."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcmitype/> ;
- rdfs:label "Still Image"@en-us ;
- rdfs:subClassOf <http://purl.org/dc/dcmitype/Image> .
-
-<http://purl.org/dc/dcmitype/Text>
- dcam:memberOf dcterms:DCMIType ;
- dcterms:description "Examples include books, letters, dissertations, poems, newspapers, articles, archives of mailing lists. Note that facsimiles or images of texts are still of the genre Text."@en-us ;
- dcterms:hasVersion <http://dublincore.org/usage/terms/history/#Text-003> ;
- dcterms:issued "2000-07-11" ;
- dcterms:modified "2008-01-14" ;
- a rdfs:Class ;
- rdfs:comment "A resource consisting primarily of words for reading."@en-us ;
- rdfs:isDefinedBy <http://purl.org/dc/dcmitype/> ;
- rdfs:label "Text"@en-us .
-
diff --git a/schemas/doap.ttl b/schemas/doap.ttl
deleted file mode 100644
index 8a196df..0000000
--- a/schemas/doap.ttl
+++ /dev/null
@@ -1,403 +0,0 @@
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@prefix vs: <http://www.w3.org/2003/06/sw-vocab-status/ns#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix dc: <http://purl.org/dc/elements/1.1/> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-
-<http://usefulinc.com/ns/doap#>
- dc:creator "Edd Dumbill" ;
- dc:description "Das Vokabular \"Description of a Project (DOAP)\", beschrieben durch W3C RDF Schema and the Web Ontology Language."@de, """El vocabulario Description of a Project (DOAP, Descripción de un Proyecto), descrito usando RDF Schema de W3C
- y Web Ontology Language."""@es, """Le vocabulaire Description Of A Project (DOAP, Description D'Un Projet),
- décrit en utilisant RDF Schema du W3C et OWL."""@fr, "Slovník Description of a Project (DOAP, Popis projektu), popsaný použitím W3C RDF Schema a Web Ontology Language."@cs, "The Description of a Project (DOAP) vocabulary, described using W3C RDF Schema and the Web Ontology Language." ;
- dc:format "application/rdf+xml" ;
- dc:rights "Copyright © 2004-2009 Edd Dumbill" ;
- dc:title "Description of a Project (DOAP) vocabulary" ;
- a owl:Ontology ;
- owl:imports <http://xmlns.com/foaf/0.1/> ;
- foaf:maker [
- a foaf:Person ;
- foaf:mbox <mailto:edd@usefulinc.com> ;
- foaf:name "Edd Dumbill"
- ] .
-
-doap:ArchRepository
- a rdfs:Class, owl:Class ;
- rdfs:comment "Dépôt GNU Arch du code source."@fr, "GNU Arch Quellcode-Versionierungssystem."@de, "GNU Arch source code repository."@en, "Repositorio GNU Arch del código fuente."@es, "Úložiště zdrojových kódů GNU Arch."@cs ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Dépôt GNU Arch"@fr, "GNU Arch repository"@de, "GNU Arch repository"@en, "Repositorio GNU Arch"@es, "Úložiště GNU Arch"@cs ;
- rdfs:subClassOf doap:Repository .
-
-doap:BKRepository
- a rdfs:Class, owl:Class ;
- rdfs:comment "BitKeeper Quellcode-Versionierungssystem."@de, "BitKeeper source code repository."@en, "Dépôt BitKeeper du code source."@fr, "Repositorio BitKeeper del código fuente."@es, "Úložiště zdrojových kódů BitKeeper."@cs ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "BitKeeper Repository"@de, "BitKeeper Repository"@en, "Dépôt BitKeeper"@fr, "Repositorio BitKeeper"@es, "Úložiště BitKeeper"@cs ;
- rdfs:subClassOf doap:Repository .
-
-doap:BazaarBranch
- a rdfs:Class ;
- rdfs:comment "Bazaar source code branch."@en ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Bazaar Branch"@en ;
- rdfs:subClassOf doap:Repository .
-
-doap:CVSRepository
- a rdfs:Class, owl:Class ;
- rdfs:comment "CVS Quellcode-Versionierungssystem."@de, "CVS source code repository."@en, "Dépôt CVS du code source."@fr, "Repositorio CVS del código fuente."@es, "Úložiště zdrojových kódů CVS."@cs ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "CVS Repository"@de, "CVS Repository"@en, "Dépôt CVS"@fr, "Repositorio CVS"@es, "Úložiště CVS"@cs ;
- rdfs:subClassOf doap:Repository .
-
-doap:DarcsRepository
- a rdfs:Class ;
- rdfs:comment "Dépôt darcs du code source."@fr, "Repositorio darcs del código fuente."@es, "darcs source code repository."@en ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Dépôt darcs"@fr, "Repositorio darcs"@es, "darcs Repository"@en ;
- rdfs:subClassOf doap:Repository .
-
-doap:GitBranch
- a rdfs:Class ;
- rdfs:comment "Git source code branch."@en ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Git Branch"@en ;
- rdfs:subClassOf doap:Repository .
-
-doap:HgRepository
- a rdfs:Class ;
- rdfs:comment "Mercurial source code repository."@en ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Mercurial Repository"@en ;
- rdfs:subClassOf doap:Repository .
-
-doap:Project
- a rdfs:Class ;
- rdfs:comment "A project."@en, "Ein Projekt."@de, "Projekt."@cs, "Un projet."@fr, "Un proyecto."@es ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Prijekt"@de, "Project"@en, "Projekt"@cs, "Projet"@fr, "Proyecto"@es ;
- rdfs:subClassOf foaf:Project .
-
-doap:Repository
- a rdfs:Class ;
- rdfs:comment "Dépôt du code source."@fr, "Quellcode-Versionierungssystem."@de, "Repositorio del código fuente."@es, "Source code repository."@en, "Úložiště zdrojových kódů."@cs ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Dépôt"@fr, "Repositorio"@es, "Repository"@de, "Repository"@en, "Úložiště"@cs .
-
-doap:SVNRepository
- a rdfs:Class ;
- rdfs:comment "Dépôt Subversion du code source."@fr, "Repositorio Subversion del código fuente."@es, "Subversion Quellcode-Versionierungssystem."@de, "Subversion source code repository."@en, "Úložiště zdrojových kódů Subversion."@cs ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Dépôt Subversion"@fr, "Repositorio Subversion"@es, "Subversion Repository"@de, "Subversion Repository"@en, "Úložiště Subversion"@cs ;
- rdfs:subClassOf doap:Repository .
-
-doap:Specification
- a rdfs:Class ;
- rdfs:comment "A specification of a system's aspects, technical or otherwise."@en ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Specification"@en ;
- rdfs:subClassOf rdfs:Resource .
-
-doap:Version
- a rdfs:Class ;
- rdfs:comment "Détails sur une version d'une realease d'un projet."@fr, "Informace o uvolněné verzi projektu."@cs, "Información sobre la versión de un release del proyecto."@es, "Version information of a project release."@en, "Versionsinformation eines Projekt Releases."@de ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Version"@de, "Version"@en, "Version"@fr, "Versión"@es, "Verze"@cs .
-
-doap:anon-root
- a rdf:Property ;
- rdfs:comment "Dépôt pour accès anonyme."@fr, "Repositorio para acceso anónimo."@es, "Repository for anonymous access."@en, "Repository für anonymen Zugriff"@de, "Úložiště pro anonymní přístup."@cs ;
- rdfs:domain doap:Repository ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Anonymes Root"@de, "anonymní kořen"@cs, "anonymous root"@en, "racine anonyme"@fr, "raíz anónima"@es ;
- rdfs:range rdfs:Literal .
-
-doap:audience
- a rdf:Property ;
- rdfs:comment "Description of target user base"@en ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "audience"@en ;
- rdfs:range rdfs:Literal .
-
-doap:blog
- a rdf:Property ;
- rdfs:comment "URI of a blog related to a project"@en ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "blog"@en ;
- rdfs:range rdfs:Resource .
-
-doap:browse
- a rdf:Property ;
- rdfs:comment "Interface web au dépôt."@fr, "Interface web del repositorio."@es, "Web browser interface to repository."@en, "Web-Browser Interface für das Repository."@de, "Webové rozhraní pro prohlížení úložiště."@cs ;
- rdfs:domain doap:Repository ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "browse"@de, "browse"@en, "navegar"@es, "prohlížeč"@cs, "visualiser"@fr .
-
-doap:bug-database
- a rdf:Property ;
- rdfs:comment "Bug tracker for a project."@en, "Bug tracker para un proyecto."@es, "Fehlerdatenbank eines Projektes."@de, "Správa chyb projektu."@cs, "Suivi des bugs pour un projet."@fr ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Fehlerdatenbank"@de, "base de datos de bugs"@es, "bug database"@en, "databáze chyb"@cs, "suivi des bugs"@fr .
-
-doap:category
- a rdf:Property ;
- rdfs:comment "A category of project."@en, "Eine Kategorie eines Projektes."@de, "Kategorie projektu."@cs, "Una categoría de proyecto."@es, "Une catégorie de projet."@fr ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Kategorie"@de, "category"@en, "categoría"@es, "catégorie"@fr, "kategorie"@cs .
-
-doap:created
- a rdf:Property ;
- rdfs:comment "Date when something was created, in YYYY-MM-DD form. e.g. 2004-04-05"@en, "Date à laquelle a été créé quelque chose, au format AAAA-MM-JJ (par ex. 2004-04-05)"@fr, "Datum, kdy bylo něco vytvořeno ve formátu RRRR-MM-DD, např. 2004-04-05"@cs, "Erstellungsdatum von Irgendwas, angegeben im YYYY-MM-DD Format, z.B. 2004-04-05."@de, "Fecha en la que algo fue creado, en formato AAAA-MM-DD. e.g. 2004-04-05"@es ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "creado"@es, "created"@en, "créé"@fr, "erstellt"@de, "vytvořeno"@cs ;
- rdfs:range rdfs:Literal .
-
-doap:description
- a rdf:Property ;
- rdfs:comment "Beschreibung eines Projekts als einfacher Text mit der Länge von 2 bis 4 Sätzen."@de, "Descripción en texto plano de un proyecto, de 2 a 4 enunciados de longitud."@es, "Plain text description of a project, of 2-4 sentences in length."@en, "Texte descriptif d'un projet, long de 2 à 4 phrases."@fr, "Čistě textový, 2 až 4 věty dlouhý popis projektu."@cs ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Beschreibung"@de, "descripción"@es, "description"@en, "description"@fr, "popis"@cs ;
- rdfs:range rdfs:Literal .
-
-doap:developer
- a rdf:Property ;
- rdfs:comment "Desarrollador de software para el proyecto."@es, "Developer of software for the project."@en, "Développeur pour le projet."@fr, "Software-Entwickler für eine Projekt."@de, "Vývojář softwaru projektu."@cs ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Entwickler"@de, "desarrollador"@es, "developer"@en, "développeur"@fr, "vývojář"@cs ;
- rdfs:range foaf:Person .
-
-doap:documenter
- a rdf:Property ;
- rdfs:comment "Collaborateur à la documentation du projet."@fr, "Contributor of documentation to the project."@en, "Mitarbeiter an der Dokumentation eines Projektes."@de, "Proveedor de documentación para el proyecto."@es, "Spoluautor dokumentace projektu."@cs ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Dokumentator"@de, "documenter"@en, "dokumentarista"@cs, "escritor de ayuda"@es, "rédacteur de l'aide"@fr ;
- rdfs:range foaf:Person .
-
-doap:download-mirror
- a rdf:Property ;
- rdfs:comment "Miroir de la page de téléchargement du programme."@fr, "Mirror de la página web de descarga."@es, "Mirror of software download web page."@en, "Spiegel der Seite von die Projekt-Software heruntergeladen werden kann."@de, "Zrcadlo stránky pro stažení softwaru."@cs ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Spiegel der Seite zum Herunterladen"@de, "download mirror"@en, "miroir pour le téléchargement"@fr, "mirror de descarga"@es, "zrcadlo stránky pro stažení"@cs .
-
-doap:download-page
- a rdf:Property ;
- rdfs:comment "Page web à partir de laquelle on peut télécharger le programme."@fr, "Página web de la cuál se puede bajar el software."@es, "Web page from which the project software can be downloaded."@en, "Web-Seite von der die Projekt-Software heruntergeladen werden kann."@de, "Webová stránka, na které lze stáhnout projektový software."@cs ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Seite zum Herunterladen"@de, "download page"@en, "page de téléchargement"@fr, "página de descarga"@es, "stránka pro stažení"@cs .
-
-doap:file-release
- a rdf:Property ;
- rdfs:comment "URI adresa stažení asociované s revizí."@cs, "URI of download associated with this release."@en ;
- rdfs:domain doap:Version ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "file-release"@en, "soubor revize"@cs .
-
-doap:helper
- a rdf:Property ;
- rdfs:comment "Colaborador del proyecto."@es, "Collaborateur au projet."@fr, "Project contributor."@en, "Projekt-Mitarbeiter."@de, "Spoluautor projektu."@cs ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Helfer"@de, "colaborador"@es, "collaborateur"@fr, "helper"@en, "spoluautor"@cs ;
- rdfs:range foaf:Person .
-
-doap:homepage
- a rdf:Property, owl:InverseFunctionalProperty ;
- rdfs:comment """El URL de la página de un proyecto,
- asociada con exactamente un proyecto."""@es, """L'URL de la page web d'un projet,
- associée avec un unique projet."""@fr, "URL adresa domovské stránky projektu asociované s právě jedním projektem."@cs, """URL der Projekt-Homepage,
- verbunden mit genau einem Projekt."""@de, """URL of a project's homepage,
- associated with exactly one project."""@en ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Homepage"@de, "domovská stránka"@cs, "homepage"@en, "page web"@fr, "página web"@es ;
- rdfs:subPropertyOf foaf:homepage .
-
-doap:implements
- a rdf:Property ;
- rdfs:comment "A specification that a project implements. Could be a standard, API or legally defined level of conformance."@en ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Implements specification"@en ;
- rdfs:range doap:Specification .
-
-doap:language
- a rdf:Property ;
- rdfs:comment "ISO language code a project has been translated into"@en ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "language"@en ;
- rdfs:range rdfs:Literal .
-
-doap:license
- a rdf:Property ;
- rdfs:comment "Die URI einer RDF-Beschreibung einer Lizenz unter der die Software herausgegeben wird."@de, "El URI de una descripción RDF de la licencia bajo la cuál se distribuye el software."@es, "L'URI d'une description RDF de la licence sous laquelle le programme est distribué."@fr, "The URI of an RDF description of the license the software is distributed under."@en, "URI adresa RDF popisu licence, pod kterou je software distribuován."@cs ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Lizenz"@de, "licence"@cs, "licence"@fr, "licencia"@es, "license"@en .
-
-doap:location
- a rdf:Property ;
- rdfs:comment "Emplacement d'un dépôt."@fr, "Location of a repository."@en, "Lokation eines Repositorys."@de, "Umístění úložiště."@cs, "lugar de un repositorio."@es ;
- rdfs:domain doap:Repository ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Repository Lokation"@de, "emplacement du dépôt"@fr, "lugar del respositorio"@es, "repository location"@en, "umístění úložiště"@cs .
-
-doap:mailing-list
- a rdf:Property ;
- rdfs:comment "Domovská stránka nebo e–mailová adresa e–mailové diskuse."@cs, "Homepage der Mailing Liste oder E-Mail Adresse."@de, "Mailing list home page or email address."@en, "Page web de la liste de diffusion, ou adresse de courriel."@fr, "Página web de la lista de correo o dirección de correo."@es ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Mailing Liste"@de, "e–mailová diskuse"@cs, "lista de correo"@es, "liste de diffusion"@fr, "mailing list"@en .
-
-doap:maintainer
- a rdf:Property ;
- rdfs:comment "Desarrollador principal de un proyecto, un líder de proyecto."@es, "Développeur principal d'un projet, un meneur du projet."@fr, "Hauptentwickler eines Projektes, der Projektleiter"@de, "Maintainer of a project, a project leader."@en, "Správce projektu, vedoucí projektu."@cs ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Projektverantwortlicher"@de, "desarrollador principal"@es, "développeur principal"@fr, "maintainer"@en, "správce"@cs ;
- rdfs:range foaf:Person .
-
-doap:module
- a rdf:Property ;
- rdfs:comment "Jméno modulu v CVS, BitKeeper nebo Arch úložišti."@cs, "Modul-Name eines Subversion, CVS, BitKeeper oder Arch Repositorys."@de, "Module name of a Subversion, CVS, BitKeeper or Arch repository."@en, "Nom du module d'un dépôt Subversion, CVS, BitKeeper ou Arch."@fr, "Nombre del módulo de un repositorio Subversion, CVS, BitKeeper o Arch."@es ;
- rdfs:domain [
- a owl:Class ;
- owl:unionOf (doap:CVSRepository
- doap:ArchRepository
- doap:BKRepository
- )
- ] ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Modul"@de, "modul"@cs, "module"@en, "module"@fr, "módulo"@es .
-
-doap:name
- a rdf:Property ;
- rdfs:comment "A name of something."@en, "Der Name von Irgendwas"@de, "El nombre de algo."@es, "Jméno něčeho."@cs, "Le nom de quelque chose."@fr ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Name"@de, "jméno"@cs, "name"@en, "nom"@fr, "nombre"@es ;
- rdfs:range rdfs:Literal ;
- rdfs:subPropertyOf rdfs:label .
-
-doap:old-homepage
- a rdf:Property, owl:InverseFunctionalProperty ;
- rdfs:comment """El URL de la antigua página de un proyecto,
- asociada con exactamente un proyecto."""@es, """L'URL d'une ancienne page web d'un
- projet, associée avec un unique projet."""@fr, "URL adresa předešlé domovské stránky projektu asociované s právě jedním projektem."@cs, """URL der letzten Projekt-Homepage,
- verbunden mit genau einem Projekt."""@de, """URL of a project's past homepage,
- associated with exactly one project."""@en ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Alte Homepage"@de, "ancienne page web"@fr, "old homepage"@en, "página web antigua"@es, "stará domovská stránka"@cs ;
- rdfs:subPropertyOf foaf:homepage .
-
-doap:os
- a rdf:Property ;
- rdfs:comment "Betriebssystem auf dem das Projekt eingesetzt werden kann. Diese Eigenschaft kann ausgelassen werden, wenn das Projekt nicht BS-spezifisch ist."@de, "Operating system that a project is limited to. Omit this property if the project is not OS-specific."@en, "Operační systém, na jehož použití je projekt limitován. Vynechejte tuto vlastnost, pokud je projekt nezávislý na operačním systému."@cs, """Sistema opertivo al cuál está limitado el proyecto. Omita esta propiedad si el proyecto no es específico
- de un sistema opertaivo en particular."""@es, """Système d'exploitation auquel est limité le projet. Omettez cette propriété si le
- projet n'est pas limité à un système d'exploitation."""@fr ;
- rdfs:domain doap:Project, doap:Version ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Betriebssystem"@de, "operating system"@en, "operační systém"@cs, "sistema operativo"@es, "système d'exploitation"@fr ;
- rdfs:range rdfs:Literal .
-
-doap:platform
- a rdf:Property ;
- rdfs:comment "Indicator of software platform (non-OS specific), e.g. Java, Firefox, ECMA CLR"@en ;
- rdfs:domain doap:Project, doap:Version ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "platform"@en ;
- rdfs:range rdfs:Literal .
-
-doap:programming-language
- a rdf:Property ;
- rdfs:comment """Langage de programmation avec lequel un projet est implémenté,
- ou avec lequel il est prévu de l'utiliser."""@fr, "Lenguaje de programación en el que un proyecto es implementado o con el cuál pretende usarse."@es, "Programmiersprache in der ein Projekt implementiert ist oder intendiert wird zu benutzen."@de, "Programming language a project is implemented in or intended for use with."@en, "Programovací jazyk, ve kterém je projekt implementován nebo pro který je zamýšlen k použití."@cs ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Programmiersprache"@de, "langage de programmation"@fr, "lenguaje de programación"@es, "programming language"@en, "programovací jazyk"@cs ;
- rdfs:range rdfs:Literal .
-
-doap:release
- a rdf:Property ;
- rdfs:comment "A project release."@en, "Ein Release (Version) eines Projekts."@de, "Relase (verze) projektu."@cs, "Un release (versión) de un proyecto."@es, "Une release (révision) d'un projet."@fr ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Release"@de, "release"@cs, "release"@en, "release"@es, "release"@fr ;
- rdfs:range doap:Version .
-
-doap:repository
- a rdf:Property ;
- rdfs:comment "Dépôt du code source."@fr, "Quellcode-Versionierungssystem."@de, "Repositorio del código fuente."@es, "Source code repository."@en, "Úložiště zdrojových kódů."@cs ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Repository"@de, "dépôt"@fr, "repositorio"@es, "repository"@en, "úložiště"@cs ;
- rdfs:range doap:Repository .
-
-doap:revision
- a rdf:Property ;
- rdfs:comment "Identifiant de révision d'une release du programme."@fr, "Identifikátor zpřístupněné revize softwaru."@cs, "Indentificador de la versión de un release de software."@es, "Revision identifier of a software release."@en, "Versionsidentifikator eines Software-Releases."@de ;
- rdfs:domain doap:Version ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Version"@de, "revision"@en, "révision"@fr, "versión"@es, "verze"@cs ;
- rdfs:range rdfs:Literal .
-
-doap:screenshots
- a rdf:Property ;
- rdfs:comment "Page web avec des captures d'écran du projet."@fr, "Página web con capturas de pantalla del proyecto."@es, "Web page with screenshots of project."@en, "Web-Seite mit Screenshots eines Projektes."@de, "Webová stránka projektu se snímky obrazovky."@cs ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Screenshots"@de, "capturas de pantalla"@es, "captures d'écran"@fr, "screenshots"@en, "snímek obrazovky"@cs .
-
-doap:service-endpoint
- a rdf:Property ;
- rdfs:comment "The URI of a web service endpoint where software as a service may be accessed"@en ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "service endpoint"@en ;
- rdfs:range rdfs:Resource .
-
-doap:shortdesc
- a rdf:Property ;
- rdfs:comment "Descripción corta (8 o 9 palabras) en texto plano de un proyecto."@es, "Krátký (8 nebo 9 slov) čistě textový popis projektu."@cs, "Kurzbeschreibung (8 oder 9 Wörter) eines Projects als einfacher Text."@de, "Short (8 or 9 words) plain text description of a project."@en, "Texte descriptif concis (8 ou 9 mots) d'un projet."@fr ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Kurzbeschreibung"@de, "descripción corta"@es, "description courte"@fr, "krátký popis"@cs, "short description"@en ;
- rdfs:range rdfs:Literal .
-
-doap:tester
- a rdf:Property ;
- rdfs:comment "A tester or other quality control contributor."@en, "Ein Tester oder anderer Mitarbeiter der Qualitätskontrolle."@de, "Tester nebo jiný spoluautor kontrolující kvalitu."@cs, "Un tester u otro proveedor de control de calidad."@es, "Un testeur ou un collaborateur au contrôle qualité."@fr ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Tester"@de, "tester"@cs, "tester"@en, "tester"@es, "testeur"@fr ;
- rdfs:range foaf:Person .
-
-doap:translator
- a rdf:Property ;
- rdfs:comment "Collaborateur à la traduction du projet."@fr, "Contributor of translations to the project."@en, "Mitarbeiter an den Übersetzungen eines Projektes."@de, "Proveedor de traducciones al proyecto."@es, "Spoluautor překladu projektu."@cs ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "překladatel"@cs, "traducteur"@fr, "traductor"@es, "translator"@en, "Übersetzer"@de ;
- rdfs:range foaf:Person .
-
-doap:vendor
- a rdf:Property ;
- rdfs:comment "Vendor organization: commercial, free or otherwise"@en ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "vendor"@en ;
- rdfs:range foaf:Organization .
-
-doap:wiki
- a rdf:Property ;
- rdfs:comment "L'URL du Wiki pour la discussion collaborative sur le projet."@fr, "URL adresa wiki projektu pro společné diskuse."@cs, "URL del Wiki para discusión colaborativa del proyecto."@es, "URL of Wiki for collaborative discussion of project."@en, "Wiki-URL für die kollaborative Dikussion eines Projektes."@de ;
- rdfs:domain doap:Project ;
- rdfs:isDefinedBy <http://usefulinc.com/ns/doap#> ;
- rdfs:label "Wiki"@de, "wiki"@cs, "wiki"@en, "wiki"@es, "wiki"@fr .
-
diff --git a/schemas/skos.ttl b/schemas/skos.ttl
deleted file mode 100644
index dde50c4..0000000
--- a/schemas/skos.ttl
+++ /dev/null
@@ -1,278 +0,0 @@
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-@prefix dct: <http://purl.org/dc/terms/> .
-@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-@prefix skos: <http://www.w3.org/2004/02/skos/core#> .
-
-<http://www.w3.org/2004/02/skos/core>
- dct:contributor "Dave Beckett", "Nikki Rogers", "Participants in W3C's Semantic Web Deployment Working Group." ;
- dct:creator "Alistair Miles", "Sean Bechhofer" ;
- dct:description "An RDF vocabulary for describing the basic structure and content of concept schemes such as thesauri, classification schemes, subject heading lists, taxonomies, 'folksonomies', other types of controlled vocabulary, and also concept schemes embedded in glossaries and terminologies."@en ;
- dct:title "SKOS Vocabulary"@en ;
- a owl:Ontology ;
- rdfs:seeAlso <http://www.w3.org/TR/skos-reference/> .
-
-skos:Collection
- a owl:Class ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "Collection"@en ;
- owl:disjointWith skos:Concept, skos:ConceptScheme ;
- skos:definition "A meaningful collection of concepts."@en ;
- skos:scopeNote "Labelled collections can be used where you would like a set of concepts to be displayed under a 'node label' in the hierarchy."@en .
-
-skos:Concept
- a owl:Class ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "Concept"@en ;
- skos:definition "An idea or notion; a unit of thought."@en .
-
-skos:ConceptScheme
- a owl:Class ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "Concept Scheme"@en ;
- owl:disjointWith skos:Concept ;
- skos:definition "A set of concepts, optionally including statements about semantic relationships between those concepts."@en ;
- skos:example "Thesauri, classification schemes, subject heading lists, taxonomies, 'folksonomies', and other types of controlled vocabulary are all examples of concept schemes. Concept schemes are also embedded in glossaries and terminologies."@en ;
- skos:scopeNote "A concept scheme may be defined to include concepts from different sources."@en .
-
-skos:OrderedCollection
- a owl:Class ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "Ordered Collection"@en ;
- rdfs:subClassOf skos:Collection ;
- skos:definition "An ordered collection of concepts, where both the grouping and the ordering are meaningful."@en ;
- skos:scopeNote "Ordered collections can be used where you would like a set of concepts to be displayed in a specific order, and optionally under a 'node label'."@en .
-
-skos:altLabel
- a rdf:Property, owl:AnnotationProperty ;
- rdfs:comment "The range of skos:altLabel is the class of RDF plain literals."@en, "skos:prefLabel, skos:altLabel and skos:hiddenLabel are pairwise disjoint properties."@en ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "alternative label"@en ;
- rdfs:subPropertyOf rdfs:label ;
- skos:definition "An alternative lexical label for a resource."@en ;
- skos:example "Acronyms, abbreviations, spelling variants, and irregular plural/singular forms may be included among the alternative labels for a concept. Mis-spelled terms are normally included as hidden labels (see skos:hiddenLabel)."@en .
-
-skos:broadMatch
- a rdf:Property, owl:ObjectProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has broader match"@en ;
- rdfs:subPropertyOf skos:broader, skos:mappingRelation ;
- owl:inverseOf skos:narrowMatch ;
- skos:definition "skos:broadMatch is used to state a hierarchical mapping link between two conceptual resources in different concept schemes."@en .
-
-skos:broader
- a rdf:Property, owl:ObjectProperty ;
- rdfs:comment "Broader concepts are typically rendered as parents in a concept hierarchy (tree)."@en ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has broader"@en ;
- rdfs:subPropertyOf skos:broaderTransitive ;
- owl:inverseOf skos:narrower ;
- skos:definition "Relates a concept to a concept that is more general in meaning."@en ;
- skos:scopeNote "By convention, skos:broader is only used to assert an immediate (i.e. direct) hierarchical link between two conceptual resources."@en .
-
-skos:broaderTransitive
- a rdf:Property, owl:ObjectProperty, owl:TransitiveProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has broader transitive"@en ;
- rdfs:subPropertyOf skos:semanticRelation ;
- owl:inverseOf skos:narrowerTransitive ;
- skos:definition "skos:broaderTransitive is a transitive superproperty of skos:broader." ;
- skos:scopeNote "By convention, skos:broaderTransitive is not used to make assertions. Rather, the properties can be used to draw inferences about the transitive closure of the hierarchical relation, which is useful e.g. when implementing a simple query expansion algorithm in a search application."@en .
-
-skos:changeNote
- a rdf:Property, owl:AnnotationProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "change note"@en ;
- rdfs:subPropertyOf skos:note ;
- skos:definition "A note about a modification to a concept."@en .
-
-skos:closeMatch
- a rdf:Property, owl:ObjectProperty, owl:SymmetricProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has close match"@en ;
- rdfs:subPropertyOf skos:mappingRelation ;
- skos:definition "skos:closeMatch is used to link two concepts that are sufficiently similar that they can be used interchangeably in some information retrieval applications. In order to avoid the possibility of \"compound errors\" when combining mappings across more than two concept schemes, skos:closeMatch is not declared to be a transitive property."@en .
-
-skos:definition
- a rdf:Property, owl:AnnotationProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "definition"@en ;
- rdfs:subPropertyOf skos:note ;
- skos:definition "A statement or formal explanation of the meaning of a concept."@en .
-
-skos:editorialNote
- a rdf:Property, owl:AnnotationProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "editorial note"@en ;
- rdfs:subPropertyOf skos:note ;
- skos:definition "A note for an editor, translator or maintainer of the vocabulary."@en .
-
-skos:exactMatch
- a rdf:Property, owl:ObjectProperty, owl:SymmetricProperty, owl:TransitiveProperty ;
- rdfs:comment "skos:exactMatch is disjoint with each of the properties skos:broadMatch and skos:relatedMatch."@en ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has exact match"@en ;
- rdfs:subPropertyOf skos:closeMatch ;
- skos:definition "skos:exactMatch is used to link two concepts, indicating a high degree of confidence that the concepts can be used interchangeably across a wide range of information retrieval applications. skos:exactMatch is a transitive property, and is a sub-property of skos:closeMatch."@en .
-
-skos:example
- a rdf:Property, owl:AnnotationProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "example"@en ;
- rdfs:subPropertyOf skos:note ;
- skos:definition "An example of the use of a concept."@en .
-
-skos:hasTopConcept
- a rdf:Property, owl:ObjectProperty ;
- rdfs:domain skos:ConceptScheme ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has top concept"@en ;
- rdfs:range skos:Concept ;
- owl:inverseOf skos:topConceptOf ;
- skos:definition "Relates, by convention, a concept scheme to a concept which is topmost in the broader/narrower concept hierarchies for that scheme, providing an entry point to these hierarchies."@en .
-
-skos:hiddenLabel
- a rdf:Property, owl:AnnotationProperty ;
- rdfs:comment "The range of skos:hiddenLabel is the class of RDF plain literals."@en, "skos:prefLabel, skos:altLabel and skos:hiddenLabel are pairwise disjoint properties."@en ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "hidden label"@en ;
- rdfs:subPropertyOf rdfs:label ;
- skos:definition "A lexical label for a resource that should be hidden when generating visual displays of the resource, but should still be accessible to free text search operations."@en .
-
-skos:historyNote
- a rdf:Property, owl:AnnotationProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "history note"@en ;
- rdfs:subPropertyOf skos:note ;
- skos:definition "A note about the past state/use/meaning of a concept."@en .
-
-skos:inScheme
- a rdf:Property, owl:ObjectProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "is in scheme"@en ;
- rdfs:range skos:ConceptScheme ;
- skos:definition "Relates a resource (for example a concept) to a concept scheme in which it is included."@en ;
- skos:scopeNote "A concept may be a member of more than one concept scheme."@en .
-
-skos:mappingRelation
- a rdf:Property, owl:ObjectProperty ;
- rdfs:comment "These concept mapping relations mirror semantic relations, and the data model defined below is similar (with the exception of skos:exactMatch) to the data model defined for semantic relations. A distinct vocabulary is provided for concept mapping relations, to provide a convenient way to differentiate links within a concept scheme from links between concept schemes. However, this pattern of usage is not a formal requirement of the SKOS data model, and relies on informal definitions of best practice."@en ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "is in mapping relation with"@en ;
- rdfs:subPropertyOf skos:semanticRelation ;
- skos:definition "Relates two concepts coming, by convention, from different schemes, and that have comparable meanings"@en .
-
-skos:member
- a rdf:Property, owl:ObjectProperty ;
- rdfs:domain skos:Collection ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has member"@en ;
- rdfs:range [
- a owl:Class ;
- owl:unionOf (skos:Concept
- skos:Collection
- )
- ] ;
- skos:definition "Relates a collection to one of its members."@en .
-
-skos:memberList
- a rdf:Property, owl:FunctionalProperty, owl:ObjectProperty ;
- rdfs:comment """For any resource, every item in the list given as the value of the
- skos:memberList property is also a value of the skos:member property."""@en ;
- rdfs:domain skos:OrderedCollection ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has member list"@en ;
- rdfs:range rdf:List ;
- skos:definition "Relates an ordered collection to the RDF list containing its members."@en .
-
-skos:narrowMatch
- a rdf:Property, owl:ObjectProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has narrower match"@en ;
- rdfs:subPropertyOf skos:mappingRelation, skos:narrower ;
- owl:inverseOf skos:broadMatch ;
- skos:definition "skos:narrowMatch is used to state a hierarchical mapping link between two conceptual resources in different concept schemes."@en .
-
-skos:narrower
- a rdf:Property, owl:ObjectProperty ;
- rdfs:comment "Narrower concepts are typically rendered as children in a concept hierarchy (tree)."@en ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has narrower"@en ;
- rdfs:subPropertyOf skos:narrowerTransitive ;
- owl:inverseOf skos:broader ;
- skos:definition "Relates a concept to a concept that is more specific in meaning."@en ;
- skos:scopeNote "By convention, skos:broader is only used to assert an immediate (i.e. direct) hierarchical link between two conceptual resources."@en .
-
-skos:narrowerTransitive
- a rdf:Property, owl:ObjectProperty, owl:TransitiveProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has narrower transitive"@en ;
- rdfs:subPropertyOf skos:semanticRelation ;
- owl:inverseOf skos:broaderTransitive ;
- skos:definition "skos:narrowerTransitive is a transitive superproperty of skos:narrower." ;
- skos:scopeNote "By convention, skos:narrowerTransitive is not used to make assertions. Rather, the properties can be used to draw inferences about the transitive closure of the hierarchical relation, which is useful e.g. when implementing a simple query expansion algorithm in a search application."@en .
-
-skos:notation
- a rdf:Property, owl:DatatypeProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "notation"@en ;
- skos:definition "A notation, also known as classification code, is a string of characters such as \"T58.5\" or \"303.4833\" used to uniquely identify a concept within the scope of a given concept scheme."@en ;
- skos:scopeNote "By convention, skos:notation is used with a typed literal in the object position of the triple."@en .
-
-skos:note
- a rdf:Property, owl:AnnotationProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "note"@en ;
- skos:definition "A general note, for any purpose."@en ;
- skos:scopeNote "This property may be used directly, or as a super-property for more specific note types."@en .
-
-skos:prefLabel
- a rdf:Property, owl:AnnotationProperty ;
- rdfs:comment "A resource has no more than one value of skos:prefLabel per language tag, and no more than one value of skos:prefLabel without language tag."@en, "The range of skos:prefLabel is the class of RDF plain literals."@en, """skos:prefLabel, skos:altLabel and skos:hiddenLabel are pairwise
- disjoint properties."""@en ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "preferred label"@en ;
- rdfs:subPropertyOf rdfs:label ;
- skos:definition "The preferred lexical label for a resource, in a given language."@en .
-
-skos:related
- a rdf:Property, owl:ObjectProperty, owl:SymmetricProperty ;
- rdfs:comment "skos:related is disjoint with skos:broaderTransitive"@en ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has related"@en ;
- rdfs:subPropertyOf skos:semanticRelation ;
- skos:definition "Relates a concept to a concept with which there is an associative semantic relationship."@en .
-
-skos:relatedMatch
- a rdf:Property, owl:ObjectProperty, owl:SymmetricProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "has related match"@en ;
- rdfs:subPropertyOf skos:mappingRelation, skos:related ;
- skos:definition "skos:relatedMatch is used to state an associative mapping link between two conceptual resources in different concept schemes."@en .
-
-skos:scopeNote
- a rdf:Property, owl:AnnotationProperty ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "scope note"@en ;
- rdfs:subPropertyOf skos:note ;
- skos:definition "A note that helps to clarify the meaning and/or the use of a concept."@en .
-
-skos:semanticRelation
- a rdf:Property, owl:ObjectProperty ;
- rdfs:domain skos:Concept ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "is in semantic relation with"@en ;
- rdfs:range skos:Concept ;
- skos:definition "Links a concept to a concept related by meaning."@en ;
- skos:scopeNote "This property should not be used directly, but as a super-property for all properties denoting a relationship of meaning between concepts."@en .
-
-skos:topConceptOf
- a rdf:Property, owl:ObjectProperty ;
- rdfs:domain skos:Concept ;
- rdfs:isDefinedBy <http://www.w3.org/2004/02/skos/core> ;
- rdfs:label "is top concept in scheme"@en ;
- rdfs:range skos:ConceptScheme ;
- rdfs:subPropertyOf skos:inScheme ;
- owl:inverseOf skos:hasTopConcept ;
- skos:definition "Relates a concept to the concept scheme that it is a top level concept of."@en .
-
diff --git a/util/lv2_validate.in b/util/lv2_validate.in
new file mode 100755
index 0000000..d30cd85
--- /dev/null
+++ b/util/lv2_validate.in
@@ -0,0 +1,111 @@
+#!/bin/sh
+
+LV2DIR="@LV2DIR@"
+
+if [ "$#" -eq "0" ]; then
+ echo "lv2_validate: missing operand" 1>&2;
+ echo "" 1>&2;
+ echo "Usage: lv2_validate [FILE]..." 1>&2;
+ echo "Validate the given ttl files against the installed LV2 spec" 1>&2;
+ exit 1
+fi
+
+sord_validate \
+ "$LV2DIR/patch.lv2/manifest.ttl" \
+ "$LV2DIR/patch.lv2/patch.meta.ttl" \
+ "$LV2DIR/patch.lv2/patch.ttl" \
+ "$LV2DIR/eg-amp.lv2/manifest.ttl" \
+ "$LV2DIR/eg-amp.lv2/amp.ttl" \
+ "$LV2DIR/eg-fifths.lv2/manifest.ttl" \
+ "$LV2DIR/eg-fifths.lv2/fifths.ttl" \
+ "$LV2DIR/port-props.lv2/manifest.ttl" \
+ "$LV2DIR/port-props.lv2/port-props.meta.ttl" \
+ "$LV2DIR/port-props.lv2/port-props.ttl" \
+ "$LV2DIR/eg-midigate.lv2/manifest.ttl" \
+ "$LV2DIR/eg-midigate.lv2/midigate.ttl" \
+ "$LV2DIR/worker.lv2/worker.meta.ttl" \
+ "$LV2DIR/worker.lv2/manifest.ttl" \
+ "$LV2DIR/worker.lv2/worker.ttl" \
+ "$LV2DIR/buf-size.lv2/manifest.ttl" \
+ "$LV2DIR/buf-size.lv2/buf-size.meta.ttl" \
+ "$LV2DIR/buf-size.lv2/buf-size.ttl" \
+ "$LV2DIR/eg-scope.lv2/manifest.ttl" \
+ "$LV2DIR/eg-scope.lv2/examploscope.ttl" \
+ "$LV2DIR/midi.lv2/midi.meta.ttl" \
+ "$LV2DIR/midi.lv2/manifest.ttl" \
+ "$LV2DIR/midi.lv2/midi.ttl" \
+ "$LV2DIR/atom.lv2/manifest.ttl" \
+ "$LV2DIR/atom.lv2/atom.ttl" \
+ "$LV2DIR/atom.lv2/atom.meta.ttl" \
+ "$LV2DIR/dynmanifest.lv2/dynmanifest.meta.ttl" \
+ "$LV2DIR/dynmanifest.lv2/manifest.ttl" \
+ "$LV2DIR/dynmanifest.lv2/dynmanifest.ttl" \
+ "$LV2DIR/options.lv2/manifest.ttl" \
+ "$LV2DIR/options.lv2/options.meta.ttl" \
+ "$LV2DIR/options.lv2/options.ttl" \
+ "$LV2DIR/parameters.lv2/manifest.ttl" \
+ "$LV2DIR/parameters.lv2/parameters.ttl" \
+ "$LV2DIR/parameters.lv2/parameters.meta.ttl" \
+ "$LV2DIR/instance-access.lv2/instance-access.ttl" \
+ "$LV2DIR/instance-access.lv2/manifest.ttl" \
+ "$LV2DIR/instance-access.lv2/instance-access.meta.ttl" \
+ "$LV2DIR/state.lv2/manifest.ttl" \
+ "$LV2DIR/state.lv2/state.meta.ttl" \
+ "$LV2DIR/state.lv2/state.ttl" \
+ "$LV2DIR/port-groups.lv2/manifest.ttl" \
+ "$LV2DIR/port-groups.lv2/port-groups.ttl" \
+ "$LV2DIR/port-groups.lv2/port-groups.meta.ttl" \
+ "$LV2DIR/eg-sampler.lv2/manifest.ttl" \
+ "$LV2DIR/eg-sampler.lv2/sampler.ttl" \
+ "$LV2DIR/ui.lv2/manifest.ttl" \
+ "$LV2DIR/ui.lv2/ui.ttl" \
+ "$LV2DIR/ui.lv2/ui.meta.ttl" \
+ "$LV2DIR/morph.lv2/manifest.ttl" \
+ "$LV2DIR/morph.lv2/morph.ttl" \
+ "$LV2DIR/morph.lv2/morph.meta.ttl" \
+ "$LV2DIR/event.lv2/manifest.ttl" \
+ "$LV2DIR/event.lv2/event.meta.ttl" \
+ "$LV2DIR/event.lv2/event.ttl" \
+ "$LV2DIR/resize-port.lv2/manifest.ttl" \
+ "$LV2DIR/resize-port.lv2/resize-port.ttl" \
+ "$LV2DIR/resize-port.lv2/resize-port.meta.ttl" \
+ "$LV2DIR/log.lv2/log.ttl" \
+ "$LV2DIR/log.lv2/manifest.ttl" \
+ "$LV2DIR/log.lv2/log.meta.ttl" \
+ "$LV2DIR/core.lv2/manifest.ttl" \
+ "$LV2DIR/core.lv2/lv2core.ttl" \
+ "$LV2DIR/core.lv2/lv2core.doap.ttl" \
+ "$LV2DIR/core.lv2/meta.ttl" \
+ "$LV2DIR/core.lv2/people.ttl" \
+ "$LV2DIR/eg-metro.lv2/manifest.ttl" \
+ "$LV2DIR/eg-metro.lv2/metro.ttl" \
+ "$LV2DIR/presets.lv2/manifest.ttl" \
+ "$LV2DIR/presets.lv2/presets.ttl" \
+ "$LV2DIR/presets.lv2/presets.meta.ttl" \
+ "$LV2DIR/eg-params.lv2/manifest.ttl" \
+ "$LV2DIR/eg-params.lv2/params.ttl" \
+ "$LV2DIR/urid.lv2/manifest.ttl" \
+ "$LV2DIR/urid.lv2/urid.ttl" \
+ "$LV2DIR/urid.lv2/urid.meta.ttl" \
+ "$LV2DIR/time.lv2/time.meta.ttl" \
+ "$LV2DIR/time.lv2/manifest.ttl" \
+ "$LV2DIR/time.lv2/time.ttl" \
+ "$LV2DIR/data-access.lv2/manifest.ttl" \
+ "$LV2DIR/data-access.lv2/data-access.meta.ttl" \
+ "$LV2DIR/data-access.lv2/data-access.ttl" \
+ "$LV2DIR/units.lv2/manifest.ttl" \
+ "$LV2DIR/units.lv2/units.ttl" \
+ "$LV2DIR/units.lv2/units.meta.ttl" \
+ "$LV2DIR/schemas.lv2/xsd.ttl" \
+ "$LV2DIR/schemas.lv2/manifest.ttl" \
+ "$LV2DIR/schemas.lv2/rdf.ttl" \
+ "$LV2DIR/schemas.lv2/dct.ttl" \
+ "$LV2DIR/schemas.lv2/doap.ttl" \
+ "$LV2DIR/schemas.lv2/rdfs.ttl" \
+ "$LV2DIR/schemas.lv2/dcs.ttl" \
+ "$LV2DIR/schemas.lv2/foaf.ttl" \
+ "$LV2DIR/schemas.lv2/owl.ttl" \
+ "$LV2DIR/uri-map.lv2/manifest.ttl" \
+ "$LV2DIR/uri-map.lv2/uri-map.ttl" \
+ "$LV2DIR/uri-map.lv2/uri-map.meta.ttl" \
+ $@
diff --git a/waf b/waf
index c825c3b..58d14c3 100755
--- a/waf
+++ b/waf
Binary files differ
diff --git a/waflib b/waflib
new file mode 160000
+Subproject 878bdba53979f11fa582088e47997df129e56d1
diff --git a/wscript b/wscript
index 08803e1..7c7161f 100644
--- a/wscript
+++ b/wscript
@@ -1,52 +1,86 @@
#!/usr/bin/env python
-import glob
+
import os
import re
-import shutil
-import subprocess
import sys
+from waflib import Context, Logs, Options, Scripting, Utils
from waflib.extras import autowaf as autowaf
-import waflib.Context as Context
-import waflib.Logs as Logs
-import waflib.Options as Options
-import waflib.Scripting as Scripting
-
-# Variables for 'waf dist'
-APPNAME = 'lv2'
-VERSION = '1.6.1'
-
-# Mandatory variables
-top = '.'
-out = 'build'
-
-def options(opt):
- opt.load('compiler_c')
- autowaf.set_options(opt)
- opt.add_option('--test', action='store_true', dest='build_tests',
- help='Build unit tests')
- opt.add_option('--online-docs', action='store_true', dest='online_docs',
- help='Build documentation for web hosting')
- opt.add_option('--no-plugins', action='store_true', dest='no_plugins',
- help='Do not build example plugins')
- opt.add_option('--copy-headers', action='store_true', dest='copy_headers',
- help='Copy headers instead of linking to bundle')
- opt.recurse('lv2/lv2plug.in/ns/lv2core')
+
+# Mandatory waf variables
+APPNAME = 'lv2' # Package name for waf dist
+VERSION = '1.18.0' # Package version for waf dist
+top = '.' # Source directory
+out = 'build' # Build directory
+
+# Release variables
+title = 'LV2'
+uri = 'http://lv2plug.in/ns/lv2'
+dist_pattern = 'http://lv2plug.in/spec/lv2-%d.%d.%d.tar.bz2'
+post_tags = []
+
+# Map of specification base name to old URI-style include path
+spec_map = {
+ 'atom' : 'lv2/lv2plug.in/ns/ext/atom',
+ 'buf-size' : 'lv2/lv2plug.in/ns/ext/buf-size',
+ 'core' : 'lv2/lv2plug.in/ns/lv2core',
+ 'data-access' : 'lv2/lv2plug.in/ns/ext/data-access',
+ 'dynmanifest' : 'lv2/lv2plug.in/ns/ext/dynmanifest',
+ 'event' : 'lv2/lv2plug.in/ns/ext/event',
+ 'instance-access' : 'lv2/lv2plug.in/ns/ext/instance-access',
+ 'log' : 'lv2/lv2plug.in/ns/ext/log',
+ 'midi' : 'lv2/lv2plug.in/ns/ext/midi',
+ 'morph' : 'lv2/lv2plug.in/ns/ext/morph',
+ 'options' : 'lv2/lv2plug.in/ns/ext/options',
+ 'parameters' : 'lv2/lv2plug.in/ns/ext/parameters',
+ 'patch' : 'lv2/lv2plug.in/ns/ext/patch',
+ 'port-groups' : 'lv2/lv2plug.in/ns/ext/port-groups',
+ 'port-props' : 'lv2/lv2plug.in/ns/ext/port-props',
+ 'presets' : 'lv2/lv2plug.in/ns/ext/presets',
+ 'resize-port' : 'lv2/lv2plug.in/ns/ext/resize-port',
+ 'state' : 'lv2/lv2plug.in/ns/ext/state',
+ 'time' : 'lv2/lv2plug.in/ns/ext/time',
+ 'ui' : 'lv2/lv2plug.in/ns/extensions/ui',
+ 'units' : 'lv2/lv2plug.in/ns/extensions/units',
+ 'uri-map' : 'lv2/lv2plug.in/ns/ext/uri-map',
+ 'urid' : 'lv2/lv2plug.in/ns/ext/urid',
+ 'worker' : 'lv2/lv2plug.in/ns/ext/worker'}
+
+def options(ctx):
+ ctx.load('compiler_c')
+ ctx.load('compiler_cxx')
+ ctx.load('lv2')
+ ctx.add_flags(
+ ctx.configuration_options(),
+ {'no-coverage': 'Do not use gcov for code coverage',
+ 'online-docs': 'Build documentation for web hosting',
+ 'no-check-links': 'Do not check documentation for broken links',
+ 'no-plugins': 'Do not build example plugins',
+ 'copy-headers': 'Copy headers instead of linking to bundle'})
def configure(conf):
try:
- conf.load('compiler_c')
+ conf.load('compiler_c', cache=True)
except:
Options.options.build_tests = False
Options.options.no_plugins = True
+ try:
+ conf.load('compiler_cxx', cache=True)
+ except Exception:
+ pass
+
if Options.options.online_docs:
Options.options.docs = True
- autowaf.configure(conf)
- autowaf.set_c99_mode(conf)
+ conf.load('lv2', cache=True)
+ conf.load('autowaf', cache=True)
+ autowaf.set_c_lang(conf, 'c99')
- if Options.platform == 'win32' or not hasattr(os.path, 'relpath'):
+ if Options.options.ultra_strict and not conf.env.MSVC_COMPILER:
+ conf.env.append_value('CFLAGS', ['-Wconversion'])
+
+ if conf.env.DEST_OS == 'win32' or not hasattr(os.path, 'relpath'):
Logs.warn('System does not support linking headers, copying')
Options.options.copy_headers = True
@@ -62,153 +96,55 @@ def configure(conf):
except:
Logs.warn('Asciidoc not found, book will not be built')
+ if not Options.options.no_check_links:
+ if not conf.find_program('linkchecker',
+ var='LINKCHECKER', mandatory=False):
+ Logs.warn('Documentation will not be checked for broken links')
+
# Check for gcov library (for test coverage)
- if conf.env.BUILD_TESTS and not conf.is_defined('HAVE_GCOV'):
+ if (conf.env.BUILD_TESTS
+ and not Options.options.no_coverage
+ and not conf.is_defined('HAVE_GCOV')):
conf.check_cc(lib='gcov', define_name='HAVE_GCOV', mandatory=False)
- autowaf.set_recursive()
+ if conf.env.BUILD_TESTS:
+ conf.find_program('serdi', mandatory=False)
+ conf.find_program('sord_validate', mandatory=False)
+
+ autowaf.set_lib_env(conf, 'lv2', VERSION, has_objects=False)
+ autowaf.set_local_lib(conf, 'lv2', has_objects=False)
- conf.recurse('lv2/lv2plug.in/ns/lv2core')
+ conf.run_env.append_unique('LV2_PATH',
+ [os.path.join(conf.path.abspath(), 'lv2')])
- conf.env.LV2_BUILD = ['lv2/lv2plug.in/ns/lv2core']
if conf.env.BUILD_PLUGINS:
- for i in conf.path.ant_glob('plugins/*', src=False, dir=True):
+ for i in ['eg-amp.lv2',
+ 'eg-fifths.lv2',
+ 'eg-metro.lv2',
+ 'eg-midigate.lv2',
+ 'eg-params.lv2',
+ 'eg-sampler.lv2',
+ 'eg-scope.lv2']:
try:
- conf.recurse(i.srcpath())
- conf.env.LV2_BUILD += [i.srcpath()]
- except:
- Logs.warn('Configuration failed, %s will not be built\n' % i)
-
- autowaf.configure(conf)
- autowaf.display_header('LV2 Configuration')
- autowaf.display_msg(conf, 'Bundle directory', conf.env.LV2DIR)
- autowaf.display_msg(conf, 'Copy (not link) headers', conf.env.COPY_HEADERS)
- autowaf.display_msg(conf, 'Version', VERSION)
+ path = os.path.join('plugins', i)
+ conf.recurse(path)
+ conf.env.LV2_BUILD += [path]
+ conf.run_env.append_unique(
+ 'LV2_PATH', [conf.build_path('plugins/%s/lv2' % i)])
+ except Exception as e:
+ Logs.warn('Configuration failed, not building %s (%s)' % (i, e))
+
+ autowaf.display_summary(
+ conf,
+ {'Bundle directory': conf.env.LV2DIR,
+ 'Copy (not link) headers': bool(conf.env.COPY_HEADERS),
+ 'Version': VERSION})
def chop_lv2_prefix(s):
if s.startswith('lv2/lv2plug.in/'):
return s[len('lv2/lv2plug.in/'):]
return s
-# Rule for calling lv2specgen on a spec bundle
-def specgen(task):
- import rdflib
- doap = rdflib.Namespace('http://usefulinc.com/ns/doap#')
- lv2 = rdflib.Namespace('http://lv2plug.in/ns/lv2core#')
- owl = rdflib.Namespace('http://www.w3.org/2002/07/owl#')
- rdf = rdflib.Namespace('http://www.w3.org/1999/02/22-rdf-syntax-ns#')
-
- sys.path.append('./lv2specgen')
- import lv2specgen
-
- spec = task.inputs[0]
- path = os.path.dirname(spec.srcpath())
- outdir = os.path.abspath(os.path.join(out, chop_lv2_prefix(path)))
-
- bundle = str(outdir)
- b = os.path.basename(outdir)
-
- if not os.access(spec.abspath(), os.R_OK):
- print('warning: extension %s has no %s.ttl file' % (b, b))
- return
-
- try:
- model = rdflib.ConjunctiveGraph()
- for i in glob.glob('%s/*.ttl' % bundle):
- model.parse(i, format='n3')
- except:
- e = sys.exc_info()[1]
- print('error parsing %s: %s' % (bundle, str(e)))
- return
-
- # Get extension URI
- ext_node = model.value(None, rdf.type, lv2.Specification)
- if not ext_node:
- print('no extension found in %s' % bundle)
- return
-
- ext = str(ext_node)
-
- # Get version
- minor = 0
- micro = 0
- try:
- minor = int(model.value(ext_node, lv2.minorVersion, None))
- micro = int(model.value(ext_node, lv2.microVersion, None))
- except:
- e = sys.exc_info()[1]
- print('warning: %s: failed to find version for %s' % (bundle, ext))
-
- # Get date
- date = None
- for r in model.triples([ext_node, doap.release, None]):
- revision = model.value(r[2], doap.revision, None)
- if revision == ('%d.%d' % (minor, micro)):
- date = model.value(r[2], doap.created, None)
- break
-
- # Verify that this date is the latest
- for r in model.triples([ext_node, doap.release, None]):
- revision = model.value(r[2], doap.revision, None)
- this_date = model.value(r[2], doap.created, None)
- if this_date > date:
- print('warning: %s revision %d.%d (%s) is not the latest release' % (
- ext_node, minor, micro, date))
- break
-
- # Get short description
- shortdesc = model.value(ext_node, doap.shortdesc, None)
-
- SPECGENDIR = 'lv2specgen'
- STYLEPATH = 'build/aux/style.css'
- TAGFILE = 'build/tags'
-
- specdoc = lv2specgen.specgen(
- spec.abspath(),
- SPECGENDIR,
- os.path.relpath(STYLEPATH, bundle),
- os.path.relpath('build/doc/html', bundle),
- TAGFILE,
- instances=True,
- offline=(not task.env.ONLINE_DOCS))
-
- lv2specgen.save(task.outputs[0].abspath(), specdoc)
-
- # Name (comment is to act as a sort key)
- target = path[len('lv2/lv2plug.in/ns/'):]
- if not task.env.ONLINE_DOCS:
- target += '/%s.html' % b
- row = '<tr><!-- %s --><td><a rel="rdfs:seeAlso" href="%s">%s</a></td>' % (
- b, target, b)
-
- # Description
- if shortdesc:
- row += '<td>' + str(shortdesc) + '</td>'
- else:
- row += '<td></td>'
-
- # Version
- version_str = '%s.%s' % (minor, micro)
- if minor == 0 or (micro % 2 != 0):
- row += '<td><span style="color: red">' + version_str + '</span></td>'
- else:
- row += '<td>' + version_str + '</td>'
-
- # Status
- deprecated = model.value(ext_node, owl.deprecated, None)
- if minor == 0:
- row += '<td><span class="error">Experimental</span></td>'
- elif deprecated and str(deprecated[2]) != "false":
- row += '<td><span class="warning">Deprecated</span></td>'
- elif micro % 2 == 0:
- row += '<td><span class="success">Stable</span></td>'
-
- row += '</tr>'
-
- index = open(os.path.join('build', 'index_rows', b), 'w')
- index.write(row)
- index.close()
-
def subst_file(template, output, dict):
i = open(template, 'r')
o = open(output, 'w')
@@ -219,9 +155,54 @@ def subst_file(template, output, dict):
i.close()
o.close()
+def specdirs(path):
+ return (path.ant_glob('lv2/*', dir=True) +
+ path.ant_glob('plugins/*.lv2', dir=True))
+
+def ttl_files(path, specdir):
+ def abspath(node):
+ return node.abspath()
+
+ return map(abspath,
+ path.ant_glob(specdir.path_from(path) + '/*.ttl'))
+
+def load_ttl(files, exclude = []):
+ import rdflib
+ model = rdflib.ConjunctiveGraph()
+ for f in files:
+ if f not in exclude:
+ model.parse(f, format='n3')
+ return model
+
# Task to build extension index
def build_index(task):
- global index_lines
+ src_dir = task.inputs[0].parent.parent
+ sys.path.append(str(src_dir.find_node('lv2specgen')))
+ import rdflib
+ import lv2specgen
+
+ doap = rdflib.Namespace('http://usefulinc.com/ns/doap#')
+ rdf = rdflib.Namespace('http://www.w3.org/1999/02/22-rdf-syntax-ns#')
+
+ model = load_ttl([str(src_dir.find_node('lv2/core/meta.ttl')),
+ str(src_dir.find_node('lv2/core/people.ttl'))])
+
+ # Get date for this version, and list of all LV2 distributions
+ proj = rdflib.URIRef('http://lv2plug.in/ns/lv2')
+ date = None
+ dists = []
+ for r in model.triples([proj, doap.release, None]):
+ revision = model.value(r[2], doap.revision, None)
+ created = model.value(r[2], doap.created, None)
+ if str(revision) == VERSION:
+ date = created
+
+ dist = model.value(r[2], doap['file-release'], None)
+ if dist and created:
+ dists += [(created, dist)]
+ else:
+ print('warning: %s has no file release\n' % proj)
+
rows = []
for f in task.inputs:
if not f.abspath().endswith('index.html.in'):
@@ -229,50 +210,44 @@ def build_index(task):
rows += rowfile.readlines()
rowfile.close()
- subst_file(task.inputs[0].abspath(), task.outputs[0].abspath(),
- { '@ROWS@': ''.join(rows),
- '@LV2_VERSION@': VERSION})
-
-# Task for making a link in the build directory to a source file
-def link(task):
- if hasattr(os, 'symlink'):
- func = os.symlink
- else:
- func = shutil.copy # Symlinks unavailable, make a copy
-
- try:
- os.remove(task.outputs[0].abspath()) # Remove old target
- except:
- pass # No old target, whatever
-
- func(task.inputs[0].abspath(), task.outputs[0].abspath())
+ if date is None:
+ import datetime
+ import time
+ now = int(os.environ.get('SOURCE_DATE_EPOCH', time.time()))
+ date = datetime.datetime.utcfromtimestamp(now).strftime('%F')
-def build_ext(bld, path):
- name = os.path.basename(path)
- bundle_dir = os.path.join(bld.env.LV2DIR, name + '.lv2')
- include_dir = os.path.join(bld.env.INCLUDEDIR, path)
+ subst_file(task.inputs[0].abspath(), task.outputs[0].abspath(),
+ {'@ROWS@': ''.join(rows),
+ '@LV2_VERSION@': VERSION,
+ '@DATE@': date})
- # Copy headers to URI-style include paths in build directory
- for i in bld.path.ant_glob(path + '/*.h'):
- bld(rule = link,
- source = i,
- target = bld.path.get_bld().make_node('%s/%s' % (path, i)))
+def build_spec(bld, path):
+ name = os.path.basename(path)
+ bundle_dir = os.path.join(bld.env.LV2DIR, name + '.lv2')
+ include_dir = os.path.join(bld.env.INCLUDEDIR, path)
+ old_include_dir = os.path.join(bld.env.INCLUDEDIR, spec_map[name])
# Build test program if applicable
- if bld.env.BUILD_TESTS and bld.path.find_node(path + '/%s-test.c' % name):
- test_lib = []
- test_cflags = ['']
+ for test in bld.path.ant_glob(os.path.join(path, '*-test.c')):
+ test_lib = []
+ test_cflags = ['']
+ test_linkflags = ['']
if bld.is_defined('HAVE_GCOV'):
- test_lib += ['gcov']
- test_cflags += ['-fprofile-arcs', '-ftest-coverage']
+ test_lib += ['gcov']
+ test_cflags += ['--coverage']
+ test_linkflags += ['--coverage']
+ if bld.env.DEST_OS not in ['darwin', 'win32']:
+ test_lib += ['rt']
# Unit test program
bld(features = 'c cprogram',
- source = path + '/%s-test.c' % name,
+ source = test,
lib = test_lib,
- target = path + '/%s-test' % name,
+ uselib = 'LV2',
+ target = os.path.splitext(str(test.get_bld()))[0],
install_path = None,
- cflags = test_cflags)
+ cflags = test_cflags,
+ linkflags = test_linkflags)
# Install bundle
bld.install_files(bundle_dir,
@@ -281,22 +256,22 @@ def build_ext(bld, path):
# Install URI-like includes
headers = bld.path.ant_glob(path + '/*.h')
if headers:
- if bld.env.COPY_HEADERS:
- bld.install_files(include_dir, headers)
- else:
- bld.symlink_as(include_dir,
- os.path.relpath(bundle_dir,
- os.path.dirname(include_dir)))
+ for d in [include_dir, old_include_dir]:
+ if bld.env.COPY_HEADERS:
+ bld.install_files(d, headers)
+ else:
+ bld.symlink_as(d,
+ os.path.relpath(bundle_dir, os.path.dirname(d)))
def build(bld):
- exts = (bld.path.ant_glob('lv2/lv2plug.in/ns/ext/*', dir=True) +
- bld.path.ant_glob('lv2/lv2plug.in/ns/extensions/*', dir=True))
+ specs = (bld.path.ant_glob('lv2/*', dir=True))
- # Copy lv2.h to URI-style include path in build directory
- lv2_h_path = 'lv2/lv2plug.in/ns/lv2core/lv2.h'
- bld(rule = link,
- source = bld.path.find_node(lv2_h_path),
- target = bld.path.get_bld().make_node(lv2_h_path))
+ # Copy lv2.h to include directory for backwards compatibility
+ old_lv2_h_path = os.path.join(bld.env.INCLUDEDIR, 'lv2.h')
+ if bld.env.COPY_HEADERS:
+ bld.install_files(os.path.dirname(old_lv2_h_path), 'lv2/core/lv2.h')
+ else:
+ bld.symlink_as(old_lv2_h_path, 'lv2/core/lv2.h')
# LV2 pkgconfig file
bld(features = 'subst',
@@ -307,96 +282,138 @@ def build(bld):
INCLUDEDIR = bld.env.INCLUDEDIR,
VERSION = VERSION)
+ # Validator
+ bld(features = 'subst',
+ source = 'util/lv2_validate.in',
+ target = 'lv2_validate',
+ chmod = Utils.O755,
+ install_path = '${BINDIR}',
+ LV2DIR = bld.env.LV2DIR)
+
# Build extensions
- for i in exts:
- build_ext(bld, i.srcpath())
+ for spec in specs:
+ build_spec(bld, spec.path_from(bld.path))
# Build plugins
- for i in bld.env.LV2_BUILD:
- bld.recurse(i)
-
- if bld.env.BUILD_BOOK:
- bld.recurse('plugins')
+ for plugin in bld.env.LV2_BUILD:
+ bld.recurse(plugin)
+
+ # Install lv2specgen
+ bld.install_files('${DATADIR}/lv2specgen/',
+ ['lv2specgen/style.css',
+ 'lv2specgen/template.html'])
+ bld.install_files('${DATADIR}/lv2specgen/DTD/',
+ bld.path.ant_glob('lv2specgen/DTD/*'))
+ bld.install_files('${BINDIR}', 'lv2specgen/lv2specgen.py',
+ chmod=Utils.O755)
+
+ # Install schema bundle
+ bld.install_files('${LV2DIR}/schemas.lv2/',
+ bld.path.ant_glob('schemas.lv2/*.ttl'))
+
+ if bld.env.ONLINE_DOCS:
+ # Generate .htaccess files
+ for d in ('ns', 'ns/ext', 'ns/extensions'):
+ path = os.path.join(str(bld.path.get_bld()), d)
+ bld(features = 'subst',
+ source = 'doc/htaccess.in',
+ target = os.path.join(path, '.htaccess'),
+ install_path = None,
+ BASE = '/' + d)
if bld.env.DOCS or bld.env.ONLINE_DOCS:
- # Build Doxygen documentation (and tags file)
- autowaf.build_dox(bld, 'LV2', VERSION, top, out, 'lv2plug.in/doc', False)
+ # Copy spec files to build dir
+ for spec in specs:
+ srcpath = spec.path_from(bld.path)
+ basename = os.path.basename(srcpath)
+ full_path = spec_map[basename]
+ name = 'lv2core' if basename == 'core' else basename
+ path = chop_lv2_prefix(full_path)
+ spec_path = os.path.join(path[3:], name + '.ttl')
+
+ bld(features = 'subst',
+ is_copy = True,
+ source = os.path.join(srcpath, name + '.ttl'),
+ target = path + '.ttl')
+
+ # Copy stylesheets to build directory
+ for i in ['style.css', 'pygments.css']:
+ bld(features = 'subst',
+ is_copy = True,
+ name = 'copy',
+ source = 'doc/%s' % i,
+ target = 'aux/%s' % i)
- # Copy stylesheet to build directory
- bld(features = 'subst',
- is_copy = True,
- name = 'copy',
- source = 'doc/style.css',
- target = 'aux/style.css')
+ # Build Doxygen documentation (and tags file)
+ autowaf.build_dox(bld, 'LV2', VERSION, top, out, 'doc', False)
+ bld.add_group()
index_files = []
-
- # Prepare spec output directories
- specs = exts + [bld.path.find_node('lv2/lv2plug.in/ns/lv2core')]
- for i in specs:
- # Copy spec files to build dir
- for f in bld.path.ant_glob(i.srcpath() + '/*.*'):
- bld(features = 'subst',
- is_copy = True,
- name = 'copy',
- source = f,
- target = chop_lv2_prefix(f.srcpath()))
-
- base = i.srcpath()[len('lv2/lv2plug.in'):]
- name = os.path.basename(i.srcpath())
-
- # Generate .htaccess file
- if bld.env.ONLINE_DOCS:
- bld(features = 'subst',
- source = 'doc/htaccess.in',
- target = os.path.join(base, '.htaccess'),
- install_path = None,
- NAME = name,
- BASE = base)
-
- # Call lv2specgen for each spec
- for i in specs:
- name = os.path.basename(i.srcpath())
- index_file = os.path.join('index_rows', name)
- index_files += [index_file]
-
- bld.add_group() # Barrier (don't call lv2specgen in parallel)
-
+ for spec in specs:
# Call lv2specgen to generate spec docs
- bld(rule = specgen,
- name = 'specgen',
- source = os.path.join(i.srcpath(), name + '.ttl'),
- target = ['%s/%s.html' % (chop_lv2_prefix(i.srcpath()), name),
- index_file])
+ srcpath = spec.path_from(bld.path)
+ basename = os.path.basename(srcpath)
+ full_path = spec_map[basename]
+ name = 'lv2core' if basename == 'core' else basename
+ ttl_name = name + '.ttl'
+ index_file = bld.path.get_bld().make_node('index_rows/' + name)
+ index_files += [index_file]
+ chopped_path = chop_lv2_prefix(full_path)
+
+ assert chopped_path.startswith('ns/')
+ root_path = os.path.relpath('/', os.path.dirname(chopped_path[2:]))
+ html_path = '%s.html' % chopped_path
+ out_dir = os.path.dirname(html_path)
+
+ cmd = (str(bld.path.find_node('lv2specgen/lv2specgen.py')) +
+ ' --root-uri=http://lv2plug.in/ns/ --root-path=' + root_path +
+ ' --list-email=devel@lists.lv2plug.in'
+ ' --list-page=http://lists.lv2plug.in/listinfo.cgi/devel-lv2plug.in'
+ ' --style-uri=' + os.path.relpath('aux/style.css', out_dir) +
+ ' --docdir=' + os.path.relpath('doc/html', out_dir) +
+ ' --tags=%s' % bld.path.get_bld().make_node('doc/tags') +
+ ' --index=' + str(index_file) +
+ ' ${SRC} ${TGT}')
+
+ bld(rule = cmd,
+ source = os.path.join(srcpath, ttl_name),
+ target = [html_path, index_file],
+ shell = False)
# Install documentation
- if not bld.env.ONLINE_DOCS:
- base = chop_lv2_prefix(i.srcpath())
- bld.install_files('${DOCDIR}/' + i.srcpath(),
- bld.path.get_bld().ant_glob(base + '/*.html'))
+ base = chop_lv2_prefix(srcpath)
+ bld.install_files(os.path.join('${DOCDIR}', 'lv2', os.path.dirname(html_path)),
+ html_path)
- index_files.sort()
- bld.add_group() # Barrier (wait for lv2specgen to build index)
+ index_files.sort(key=lambda x: x.path_from(bld.path))
+ bld.add_group()
# Build extension index
bld(rule = build_index,
name = 'index',
- source = ['lv2/lv2plug.in/ns/index.html.in'] + index_files,
+ source = ['doc/index.html.in'] + index_files,
target = 'ns/index.html')
# Install main documentation files
- if not bld.env.ONLINE_DOCS:
- bld.install_files('${DOCDIR}/lv2/lv2plug.in/aux/', 'aux/style.css')
- bld.install_files('${DOCDIR}/lv2/lv2plug.in/ns/', 'ns/index.html')
+ bld.install_files('${DOCDIR}/lv2/aux/', 'aux/style.css')
+ bld.install_files('${DOCDIR}/lv2/ns/', 'ns/index.html')
+
+ def check_links(ctx):
+ import subprocess
+ if ctx.env.LINKCHECKER:
+ if subprocess.call([ctx.env.LINKCHECKER[0], '--no-status', out]):
+ ctx.fatal('Documentation contains broken links')
+
+ if bld.cmd == 'build':
+ bld.add_post_fun(check_links)
if bld.env.BUILD_TESTS:
- # Generate a compile test .c file that includes all headers
+ # Generate a compile test file that includes all headers
def gen_build_test(task):
- out = open(task.outputs[0].abspath(), 'w')
- for i in task.inputs:
- out.write('#include "%s"\n' % i.bldpath())
- out.write('int main(void) { return 0; }\n')
- out.close()
+ with open(task.outputs[0].abspath(), 'w') as out:
+ for i in task.inputs:
+ out.write('#include "%s"\n' % i.bldpath())
+ out.write('int main(void) { return 0; }\n')
bld(rule = gen_build_test,
source = bld.path.ant_glob('lv2/**/*.h'),
@@ -406,20 +423,180 @@ def build(bld):
bld(features = 'c cprogram',
source = bld.path.get_bld().make_node('build-test.c'),
target = 'build-test',
+ includes = '.',
+ uselib = 'LV2',
install_path = None)
+ if 'COMPILER_CXX' in bld.env:
+ bld(rule = gen_build_test,
+ source = bld.path.ant_glob('lv2/**/*.h'),
+ target = 'build-test.cpp',
+ install_path = None)
+
+ bld(features = 'cxx cxxprogram',
+ source = bld.path.get_bld().make_node('build-test.cpp'),
+ target = 'build-test-cpp',
+ includes = '.',
+ uselib = 'LV2',
+ install_path = None)
+
+ if bld.env.BUILD_BOOK:
+ # Build "Programming LV2 Plugins" book from plugin examples
+ bld.recurse('plugins')
+
def lint(ctx):
- for i in ctx.path.ant_glob('lv2/**/*.h'):
- subprocess.call('cpplint.py --filter=+whitespace/comments,-whitespace/tab,-whitespace/braces,-whitespace/labels,-build/header_guard,-readability/casting,-build/include,-runtime/sizeof ' + i.abspath(), shell=True)
-
-def test(ctx):
- autowaf.pre_test(ctx, APPNAME, dirs=['.'])
- for i in ctx.path.ant_glob('**/*-test'):
- name = os.path.basename(i.abspath())
- os.environ['PATH'] = '.' + os.pathsep + os.getenv('PATH')
- autowaf.run_tests(
- ctx, name, [i.path_from(ctx.path.find_node('build'))], dirs=['.'])
- autowaf.post_test(ctx, APPNAME, dirs=['.'])
+ "checks code for style issues"
+ import subprocess
+
+ subprocess.call("flake8 --ignore E203,E221,W503,W504,E302,E305,E251,E241,E722 "
+ "wscript lv2specgen/lv2docgen.py lv2specgen/lv2specgen.py "
+ "plugins/literasc.py",
+ shell=True)
+
+ cmd = ("clang-tidy -p=. -header-filter=.* -checks=\"*," +
+ "-hicpp-signed-bitwise," +
+ "-llvm-header-guard," +
+ "-misc-unused-parameters," +
+ "-readability-else-after-return\" " +
+ "build-test.c")
+ subprocess.call(cmd, cwd='build', shell=True)
+
+
+def test_vocabularies(check, specs, files):
+ import rdflib
+
+ foaf = rdflib.Namespace('http://xmlns.com/foaf/0.1/')
+ lv2 = rdflib.Namespace('http://lv2plug.in/ns/lv2core#')
+ owl = rdflib.Namespace('http://www.w3.org/2002/07/owl#')
+ rdf = rdflib.Namespace('http://www.w3.org/1999/02/22-rdf-syntax-ns#')
+ rdfs = rdflib.Namespace('http://www.w3.org/2000/01/rdf-schema#')
+
+ # Check if this is a stable LV2 release to enable additional tests
+ version_tuple = tuple(map(int, VERSION.split(".")))
+ is_stable = version_tuple[1] % 2 == 0 and version_tuple[2] % 2 == 0
+
+ # Check that extended documentation is not in main specification file
+ for spec in specs:
+ path = str(spec.abspath())
+ name = os.path.basename(path)
+ name = 'lv2core' if name == 'core' else name
+ vocab = os.path.join(path, name + '.ttl')
+
+ spec_model = rdflib.ConjunctiveGraph()
+ spec_model.parse(vocab, format='n3')
+
+ def has_statement(s, p, o):
+ for t in spec_model.triples([s, p, o]):
+ return True
+
+ return False
+
+ check(lambda: not has_statement(None, lv2.documentation, None),
+ name = name + ".ttl does not contain lv2:documentation")
+
+ # Check specification manifests
+ for spec in specs:
+ path = str(spec.abspath())
+ manifest_path = os.path.join(path, 'manifest.ttl')
+ manifest_model = rdflib.ConjunctiveGraph()
+ manifest_model.parse(manifest_path, format='n3')
+
+ uri = manifest_model.value(None, rdf.type, lv2.Specification)
+ minor = manifest_model.value(uri, lv2.minorVersion, None)
+ micro = manifest_model.value(uri, lv2.microVersion, None)
+ check(lambda: uri is not None,
+ name = manifest_path + " has a lv2:Specification")
+ check(lambda: minor is not None,
+ name = manifest_path + " has a lv2:minorVersion")
+ check(lambda: micro is not None,
+ name = manifest_path + " has a lv2:microVersion")
+
+ if is_stable:
+ check(lambda: int(minor) > 0,
+ name = manifest_path + " has even non-zero minor version")
+ check(lambda: int(micro) % 2 == 0,
+ name = manifest_path + " has even micro version")
+
+ # Load everything into one big model
+ model = rdflib.ConjunctiveGraph()
+ for f in files:
+ model.parse(f, format='n3')
+
+ # Check that all named and typed resources have labels and comments
+ for r in sorted(model.triples([None, rdf.type, None])):
+ subject = r[0]
+ if (type(subject) == rdflib.term.BNode or
+ foaf.Person in model.objects(subject, rdf.type)):
+ continue
+
+ def has_property(subject, prop):
+ return model.value(subject, prop, None) is not None
+
+ check(lambda: has_property(subject, rdfs.label),
+ name = '%s has rdfs:label' % subject)
+
+ if check(lambda: has_property(subject, rdfs.comment),
+ name = '%s has rdfs:comment' % subject):
+ comment = str(model.value(subject, rdfs.comment, None))
+
+ check(lambda: comment.endswith('.'),
+ name = "%s comment ends in '.'" % subject)
+ check(lambda: comment.find('\n') == -1,
+ name = "%s comment contains no newlines" % subject)
+ check(lambda: comment == comment.strip(),
+ name = "%s comment has stripped whitespace" % subject)
+
+ # Check that lv2:documentation, if present, is proper Markdown
+ documentation = model.value(subject, lv2.documentation, None)
+ if documentation is not None:
+ check(lambda: documentation.datatype == lv2.Markdown,
+ name = "%s documentation is explicitly Markdown" % subject)
+ check(lambda: str(documentation).startswith('\n\n'),
+ name = "%s documentation starts with blank line" % subject)
+ check(lambda: str(documentation).endswith('\n\n'),
+ name = "%s documentation ends with blank line" % subject)
+
+ # Check that all properties are either datatype or object properties
+ for r in sorted(model.triples([None, rdf.type, rdf.Property])):
+ subject = r[0]
+
+ check(lambda: ((owl.DatatypeProperty in model.objects(subject, rdf.type)) or
+ (owl.ObjectProperty in model.objects(subject, rdf.type)) or
+ (owl.AnnotationProperty in model.objects(subject, rdf.type))),
+ name = "%s is a Datatype/Object/Annotation property" % subject)
+
+
+def test(tst):
+ import tempfile
+
+ with tst.group("Data") as check:
+ specs = (tst.path.ant_glob('lv2/*', dir=True))
+ schemas = list(map(str, tst.path.ant_glob("schemas.lv2/*.ttl")))
+ spec_files = list(map(str, tst.path.ant_glob("lv2/**/*.ttl")))
+ plugin_files = list(map(str, tst.path.ant_glob("plugins/**/*.ttl")))
+ bld_files = list(map(str, tst.path.get_bld().ant_glob("**/*.ttl")))
+
+ if "SERDI" in tst.env and sys.platform != 'win32':
+ for f in spec_files:
+ with tempfile.NamedTemporaryFile(mode="w") as tmp:
+ base_dir = os.path.dirname(f)
+ cmd = tst.env.SERDI + ["-o", "turtle", f, base_dir]
+ check(cmd, stdout=tmp.name)
+ check.file_equals(f, tmp.name)
+
+ if "SORD_VALIDATE" in tst.env:
+ all_files = schemas + spec_files + plugin_files + bld_files
+ check(tst.env.SORD_VALIDATE + all_files)
+
+ try:
+ test_vocabularies(check, specs, spec_files)
+ except ImportError as e:
+ Logs.warn('Not running vocabulary tests (%s)' % e)
+
+ with tst.group('Unit') as check:
+ pattern = tst.env.cprogram_PATTERN % '**/*-test'
+ for test in tst.path.get_bld().ant_glob(pattern):
+ check([str(test)])
class Dist(Scripting.Dist):
def execute(self):
@@ -434,42 +611,82 @@ class DistCheck(Dist, Scripting.DistCheck):
def execute(self):
Dist.execute(self)
self.check()
-
+
def archive(self):
Dist.archive(self)
+def _get_news_entries(ctx):
+ from waflib.extras import autoship
+
+ # Get project-level news entries
+ lv2_entries = autoship.read_ttl_news('lv2',
+ ['lv2/core/meta.ttl',
+ 'lv2/core/people.ttl'],
+ dist_pattern = dist_pattern)
+
+ release_pattern = r'http://lv2plug.in/spec/lv2-([0-9\.]*).tar.bz2'
+ current_version = sorted(lv2_entries.keys(), reverse=True)[0]
+
+ # Add items from every specification
+ for specdir in specdirs(ctx.path):
+ name = os.path.basename(specdir.abspath())
+ files = list(ttl_files(ctx.path, specdir))
+ if name == "core":
+ files = [f for f in files if (not f.endswith('/meta.ttl') and
+ not f.endswith('/people.ttl') and
+ not f.endswith('/manifest.ttl'))]
+
+ entries = autoship.read_ttl_news(name, files)
+
+ def add_items(lv2_version, name, items):
+ for item in items:
+ lv2_entries[lv2_version]["items"] += ["%s: %s" % (name, item)]
+
+ if entries:
+ latest_revision = sorted(entries.keys(), reverse=True)[0]
+ for revision, entry in entries.items():
+ if "dist" in entry:
+ match = re.match(release_pattern, entry["dist"])
+ if match:
+ # Append news items to corresponding LV2 version
+ version = tuple(map(int, match.group(1).split('.')))
+ add_items(version, name, entry["items"])
+
+ elif revision == latest_revision:
+ # Dev version that isn't in a release yet, append to current
+ add_items(current_version, name, entry["items"])
+
+ # Sort news items in each versions
+ for revision, entry in lv2_entries.items():
+ entry["items"].sort()
+
+ return lv2_entries
+
+def posts(ctx):
+ "generates news posts in Pelican Markdown format"
+
+ from waflib.extras import autoship
+
+ try:
+ os.mkdir(os.path.join(out, 'posts'))
+ except:
+ pass
+
+ autoship.write_posts(_get_news_entries(ctx),
+ os.path.join(out, 'posts'),
+ {'Author': 'drobilla'})
+
+def news(ctx):
+ """write an amalgamated NEWS file to the source directory"""
+
+ from waflib.extras import autoship
+
+ autoship.write_news(_get_news_entries(ctx), 'NEWS')
+
def dist(ctx):
- subdirs = ([ctx.path.find_node('lv2/lv2plug.in/ns/lv2core')] +
- ctx.path.ant_glob('plugins/*', dir=True) +
- ctx.path.ant_glob('lv2/lv2plug.in/ns/ext/*', dir=True) +
- ctx.path.ant_glob('lv2/lv2plug.in/ns/extensions/*', dir=True))
-
- # Write NEWS files in source directory
- top_entries = {}
- for i in subdirs:
- def abspath(node):
- return node.abspath()
- in_files = map(abspath,
- ctx.path.ant_glob(i.path_from(ctx.path) + '/*.ttl'))
- autowaf.write_news(os.path.basename(i.abspath()),
- in_files,
- i.abspath() + '/NEWS',
- top_entries)
-
- # Write top level amalgamated NEWS file
- autowaf.write_news('lv2',
- ['lv2/lv2plug.in/ns/meta/meta.ttl'],
- 'NEWS',
- None,
- top_entries)
-
- # Build archive
+ news(ctx)
ctx.archive()
- # Delete generated NEWS files from source directory
- for i in subdirs + [ctx.path]:
- try:
- os.remove(os.path.join(i.abspath(), 'NEWS'))
- except:
- pass
-
+def distcheck(ctx):
+ news(ctx)
+ ctx.archive()