diff options
Diffstat (limited to 'lv2/ns/extensions')
| l--------- | lv2/ns/extensions/ui/ext.pc.in | 1 | ||||
| -rw-r--r-- | lv2/ns/extensions/ui/lv2-ui.doap.ttl | 62 | ||||
| -rw-r--r-- | lv2/ns/extensions/ui/manifest.ttl | 9 | ||||
| -rw-r--r-- | lv2/ns/extensions/ui/ui.h | 247 | ||||
| -rw-r--r-- | lv2/ns/extensions/ui/ui.ttl | 220 | ||||
| l--------- | lv2/ns/extensions/ui/waf | 1 | ||||
| l--------- | lv2/ns/extensions/ui/wscript | 1 | ||||
| l--------- | lv2/ns/extensions/units/ext.pc.in | 1 | ||||
| -rw-r--r-- | lv2/ns/extensions/units/manifest.ttl | 9 | ||||
| -rw-r--r-- | lv2/ns/extensions/units/units.ttl | 414 | ||||
| l--------- | lv2/ns/extensions/units/waf | 1 | ||||
| l--------- | lv2/ns/extensions/units/wscript | 1 |
12 files changed, 967 insertions, 0 deletions
diff --git a/lv2/ns/extensions/ui/ext.pc.in b/lv2/ns/extensions/ui/ext.pc.in new file mode 120000 index 0000000..82b50df --- /dev/null +++ b/lv2/ns/extensions/ui/ext.pc.in @@ -0,0 +1 @@ +../../../../ext.pc.in
\ No newline at end of file diff --git a/lv2/ns/extensions/ui/lv2-ui.doap.ttl b/lv2/ns/extensions/ui/lv2-ui.doap.ttl new file mode 100644 index 0000000..44b135d --- /dev/null +++ b/lv2/ns/extensions/ui/lv2-ui.doap.ttl @@ -0,0 +1,62 @@ +@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://drobilla.net/drobilla#me> + a foaf:Person ; + foaf:name "David Robillard" ; + foaf:homepage <http://drobilla.net/> ; + foaf:mbox <mailto:d@drobilla.net> ; + rdfs:seeAlso <http://drobilla.net/drobilla> . + +<http://lv2plug.in/ns/extensions/ui> + a doap:Project ; + doap:license <http://opensource.org/licenses/isc-license> ; + doap:name "LV2 UI" ; + doap:shortdesc "Generic UI interface for LV2 plugins." ; + doap:developer [ + a foaf:Person ; + foaf:name "Lars Luthman" ; + foaf:mbox <mailto:lars.luthman@gmail.com> + ] ; + doap:maintainer <http://drobilla.net/drobilla#me> ; + doap:release [ + doap:revision "2.3" ; + 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 "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/ns/extensions/ui/manifest.ttl b/lv2/ns/extensions/ui/manifest.ttl new file mode 100644 index 0000000..febbaad --- /dev/null +++ b/lv2/ns/extensions/ui/manifest.ttl @@ -0,0 +1,9 @@ +@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 3 ; + rdfs:seeAlso <ui.ttl> , + <lv2-ui.doap.ttl> . diff --git a/lv2/ns/extensions/ui/ui.h b/lv2/ns/extensions/ui/ui.h new file mode 100644 index 0000000..6d64a0d --- /dev/null +++ b/lv2/ns/extensions/ui/ui.h @@ -0,0 +1,247 @@ +/* + LV2 UI Extension + Copyright 2009-2011 David Robillard <d@drobilla.net> + Copyright 2006-2008 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 + * C header for the LV2 UI extension <http://lv2plug.in/ns/extensions/ui>. + */ + +#ifndef LV2_UI_H +#define LV2_UI_H + +#include "lv2/lv2plug.in/ns/lv2core/lv2.h" + +#define LV2_UI_URI "http://lv2plug.in/ns/extensions/ui" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + A pointer to some widget or other type of UI handle. + + The actual type is defined by the type URI of the UI. All the functionality + provided by this extension is toolkit independent, the host only needs to + pass the necessary callbacks and display the widget, if possible. Plugins + may have several UIs, in various toolkits. +*/ +typedef void* LV2UI_Widget; + +/** + A pointer to a particular 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 particular plugin 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; + +/** + The type of the host-provided function that the UI can use to + send data to a plugin's input ports. + + The @c buffer parameter must point to a block of data, @c buffer_size bytes + large. The contents of this buffer and what the host should do with it + depends on the value of the @c format parameter. + + The @c format parameter should either be 0 or a numeric ID for a "Transfer + mechanism". Transfer mechanisms are Features and may be defined in + meta-extensions. They specify how to translate the data buffers passed to + this function to input data for the plugin ports. If a UI wishes to write + data to an input port, it must list a transfer mechanism Feature for that + port's class as an optional or required feature (depending on whether the UI + will work without being able to write to that port or not). The only + exception is when the UI wants to write single float values to input ports + of the class lv2:ControlPort, in which case @c buffer_size should always be + 4, the buffer should always contain a single IEEE-754 float, and @c format + should be 0. + + The numeric IDs for the transfer mechanisms are provided by a URI-to-integer + mapping function provided by the host, using the URI Map feature + <http://lv2plug.in/ns/ext/uri-map> with the map URI + "http://lv2plug.in/ns/extensions/ui". Thus a UI that requires transfer + mechanism features also requires the URI Map feature, but this is implicit - + the UI does not have to list the URI map feature as a required or optional + feature in it's RDF data. + + An UI MUST NOT pass a @c format parameter value (except 0) that has not been + returned by the host-provided URI mapping function for a host-supported + transfer mechanism feature URI. + + The UI MUST NOT try to write to a port for which there is no specified + transfer mechanism, or to an output port. The UI is responsible for + allocating the buffer and deallocating it after the call. +*/ +typedef void (*LV2UI_Write_Function)(LV2UI_Controller controller, + uint32_t port_index, + uint32_t buffer_size, + uint32_t format, + 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 @c 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 @c 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), @c buffer_size should be 4, the buffer should contain a + single IEEE-754 float, and @c format should be 0. + + By default, the host should only call this function for input ports of the + lv2:ControlPort class. However, the default setting can be modified by + using the following URIs in the UI's RDF data: + <pre> + uiext:portNotification + uiext:noPortNotification + uiext:plugin + uiext:portIndex + </pre> + For example, if you want the UI with uri + <code><http://my.pluginui></code> for the plugin with URI + <code><http://my.plugin></code> to get notified when the value of the + output control port with index 4 changes, you would use the following + in the RDF for your UI: + <pre> + <http://my.pluginui> uiext:portNotification [ uiext:plugin <http://my.plugin> ; + uiext:portIndex 4 ] . + </pre> + and similarly with <code>uiext:noPortNotification</code> if you wanted + to prevent notifications for a port for which it would be on by default + otherwise. The UI is not allowed to request notifications for ports of + types for which no transfer mechanism is specified, if it does it should + be considered broken and the host should not load it. + + The @c 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; + +/** + 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 will + be accessed by the UI host using the @c dlsym() function and called to get a + LV2UI_UIDescriptor 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. +*/ +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/ns/extensions/ui/ui.ttl b/lv2/ns/extensions/ui/ui.ttl new file mode 100644 index 0000000..f62569a --- /dev/null +++ b/lv2/ns/extensions/ui/ui.ttl @@ -0,0 +1,220 @@ +# LV2 UI Extension +# Copyright 2009-2011 David Robillard <d@drobilla.net> +# Copyright 2006-2008 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. + +@prefix doap: <http://usefulinc.com/ns/doap#> . +@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 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> ; + 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: <http://lv2plug.in/ns/extensions/ui#> . + +<http://my.plugin> ui:ui <http://my.pluginui> . +<http://my.pluginui> a ui:GtkUI ; + ui:binary <myui.so> . +</pre> + +<p>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.</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 can +<strong>not</strong> 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>Since the LV2 specification itself allows for extensions that may add new +functionality that could be useful to control with a UI, this extension allows +for meta-extensions that can extend the interface between the UI and the +host. These extensions mirror the extensions used for plugins - there are +required and optional "features" that you declare in the RDF data for the +UI:</p> + +<pre class="turtle-code"> +<http://my.pluginui> lv2:requiredFeature <http://my.feature> . +<http://my.pluginui> lv2:optionalFeature <http://my.feature> . +</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. These features may be used to specify how to pass +specific types of data between the UI and the plugin port buffers (see +LV2UI_Write_Function for details).</p> + +<p>UIs written to this specification do not need to be threadsafe - the +functions defined below may only be called in the same thread the UI main loop +is running in.</p> + +<p>Note that this UI extension is NOT a lv2:Feature. There is no way for a +plugin to know whether the host that loads it supports UIs or not, and the +plugin must always work without the UI (although it may be rather useless +unless it has been configured using the UI in a previous session). From the +plugin perspective, control from a UI is the same as control from anywhere else +(e.g. the host, the user): via ports.</p> + +<p>A UI does not have to be a graphical widget, it could just as well be a +server listening for OSC input or an interface to some sort of hardware device, +depending on the RDF class of the UI.</p> +""" . + +ui:UI + a rdfs:Class , + owl:Class ; + rdfs:subClassOf lv2:Resource ; + rdfs:label "LV2 UI" ; + 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: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.""" . + +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,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: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. +""" + ] , [ + a owl:Restriction ; + owl:onProperty ui:portIndex ; + owl:someValuesFrom xsd:decimal ; + owl:cardinality 1 ; + rdfs:comment """ +A PortNotification MUST have exactly one ui:portIndex which is an xsd:decimal. +""" + ] ; + rdfs:comment "Port Notification" . + +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> +""" . + +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. +""" . diff --git a/lv2/ns/extensions/ui/waf b/lv2/ns/extensions/ui/waf new file mode 120000 index 0000000..b955110 --- /dev/null +++ b/lv2/ns/extensions/ui/waf @@ -0,0 +1 @@ +../../../../waf
\ No newline at end of file diff --git a/lv2/ns/extensions/ui/wscript b/lv2/ns/extensions/ui/wscript new file mode 120000 index 0000000..ec20a77 --- /dev/null +++ b/lv2/ns/extensions/ui/wscript @@ -0,0 +1 @@ +../../../../ext.wscript
\ No newline at end of file diff --git a/lv2/ns/extensions/units/ext.pc.in b/lv2/ns/extensions/units/ext.pc.in new file mode 120000 index 0000000..82b50df --- /dev/null +++ b/lv2/ns/extensions/units/ext.pc.in @@ -0,0 +1 @@ +../../../../ext.pc.in
\ No newline at end of file diff --git a/lv2/ns/extensions/units/manifest.ttl b/lv2/ns/extensions/units/manifest.ttl new file mode 100644 index 0000000..fb5e949 --- /dev/null +++ b/lv2/ns/extensions/units/manifest.ttl @@ -0,0 +1,9 @@ +@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 4 ; + rdfs:seeAlso <units.ttl> . + diff --git a/lv2/ns/extensions/units/units.ttl b/lv2/ns/extensions/units/units.ttl new file mode 100644 index 0000000..ab33723 --- /dev/null +++ b/lv2/ns/extensions/units/units.ttl @@ -0,0 +1,414 @@ +# LV2 Units Extension +# Copyright 2009-2011 David Robillard +# Copyright 2007 Steve Harris +# +# 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. + +@prefix units: <http://lv2plug.in/ns/extensions/units#> . +@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 foaf: <http://xmlns.com/foaf/0.1/> . +@prefix xsd: <http://www.w3.org/2001/XMLSchema#> . +@prefix dcs: <http://ontologi.es/doap-changeset#> . + +<http://plugin.org.uk/swh.xrdf#me> + a foaf:Person ; + foaf:name "Steve Harris" ; + foaf:homepage <http://plugin.org.uk/> ; + rdfs:seeAlso <http://plugin.org.uk/swh.xrdf> . + +<http://drobilla.net/drobilla#me> + a foaf:Person ; + foaf:name "David Robillard" ; + foaf:homepage <http://drobilla.net/> ; + foaf:mbox <mailto:d@drobilla.net> ; + rdfs:seeAlso <http://drobilla.net/drobilla> . + +<http://lv2plug.in/ns/extensions/units> + a lv2:Specification ; + 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-license> ; + doap:release [ + doap:revision "5.4" ; + doap:created "2011-11-20" ; + dcs:blame <http://drobilla.net/drobilla#me> ; + dcs:changeset [ + dcs:item [ + rdfs:label "Define used but undefined resources (units:name, units:render, units:symbol, units:Conversion, units:conversion, units:prefixConversion, units:to, and units:factor)." + ] , [ + rdfs:label "Update packaging." + ] , [ + rdfs:label "Improve documentation." + ] + ] + ] ; + doap:maintainer [ + a foaf:Person ; + rdfs:seeAlso <http://plugin.org.uk/swh.xrdf> ; + foaf:homepage <http://plugin.org.uk/> ; + foaf:mbox_sha1sum "44bc4fed584a2d1ac8fc55206db67656165d67fd" ; + foaf:name "Steve Harris" + ], [ + a foaf:Person ; + rdfs:seeAlso <http://drobilla.net/drobilla.rdf> ; + foaf:homepage <http://drobilla.net/> ; + foaf:name "David Robillard" + ] ; + lv2:documentation """ +<p>This extension 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: <http://lv2plug.in/ns/extensions/units#> . +@prefix eg: <http://example.org/> . + +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 ; + units:name "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:Unit a rdfs:Class ; + rdfs:comment "A unit for LV2 port data" . + +units:unit + a rdf:Property ; + rdfs:domain lv2:Port ; + rdfs:range units:Unit ; + rdfs:comment "Relates a port to the unit of its data" . + +units:name + a rdf:Property ; + rdfs:domain units:Unit ; + rdfs:range xsd:string ; + rdfs:comment "A display name for the unit (e.g. decibels)." . + +units:render + a rdf:Property ; + rdfs:domain units:Unit ; + rdfs:range xsd:string ; + rdfs:comment "A printf format string for rendering a value (eg. \"%f dB\")." . + +units:symbol + a rdf:Property ; + rdfs:domain units:Unit ; + rdfs:range xsd:string ; + rdfs:comment "The abbreviated symbol for the unit (e.g. dB)." . + +units:Conversion + a rdfs:Class ; + rdfs:comment "A conversion from one unit to another." . + +units:conversion + a rdf:Property ; + rdfs:domain units:Unit ; + rdfs:range units:Conversion ; + rdfs:comment "A conversion from this unit to another." . + +units:prefixConversion + a rdf:Property ; + rdfs:subPropertyOf units:conversion ; + rdfs:domain units:Unit ; + rdfs:range units:Conversion ; + rdfs:comment """ +A conversion from this unit to the same unit but with a different SI prefix +(e.g. Hz to kHz). +""" . + +units:to + a rdf:Property ; + rdfs:domain units:Conversion ; + rdfs:range units:Unit ; + rdfs:comment "The target unit this conversion converts to." . + +units:factor + a rdf:Property ; + rdfs:domain units:Conversion ; + rdfs:range units:Unit ; + rdfs:comment """ +The factor to multiple the source value by in order to convert +to the target unit. +""" . + +units:s a units:Unit ; + units:conversion [ + units:factor 0.0166666666 ; + units:to units:min + ] ; + units:name "second" ; + units:prefixConversion [ + units:factor 1000 ; + units:to units:ms + ] ; + units:render "%f s" ; + units:symbol "s" . + +units:ms a units:Unit ; + units:name "millisecond" ; + units:prefixConversion [ + units:factor 0.001 ; + units:to units:s + ] ; + units:render "%f ms" ; + units:symbol "ms" . + +units:min a units:Unit ; + units:conversion [ + units:factor 60.0 ; + units:to units:s + ] ; + units:name "minute" ; + units:render "%f mins" ; + units:symbol "min" . + +units:bar a units:Unit ; + units:name "bar" ; + units:render "%f bars" ; + units:symbol "bars" . + +units:beat a units:Unit ; + units:name "beat" ; + units:render "%f beats" ; + units:symbol "beats" . + +units:m a units:Unit ; + units:conversion [ + units:factor 39.37 ; + units:to units:inch + ] ; + units:name "metre" ; + units:prefixConversion [ + units:factor 100 ; + units:to units:cm + ], [ + units:factor 1000 ; + units:to units:mm + ], [ + units:factor 0.001 ; + units:to units:km + ] ; + units:render "%f m" ; + units:symbol "m" . + +units:cm a units:Unit ; + units:conversion [ + units:factor 0.3937 ; + units:to units:inch + ] ; + units:name "centimetre" ; + units:prefixConversion [ + units:factor 0.01 ; + units:to units:m + ], [ + units:factor 10 ; + units:to units:mm + ], [ + units:factor 0.00001 ; + units:to units:km + ] ; + units:render "%f cm" ; + units:symbol "cm" . + +units:mm a units:Unit ; + units:conversion [ + units:factor 0.03937 ; + units:to units:inch + ] ; + units:name "millimetre" ; + units:prefixConversion [ + units:factor 0.001 ; + units:to units:m + ], [ + units:factor 0.1 ; + units:to units:cm + ], [ + units:factor 0.000001 ; + units:to units:km + ] ; + units:render "%f mm" ; + units:symbol "mm" . + +units:km a units:Unit ; + units:conversion [ + units:factor 0.62138818 ; + units:to units:mile + ] ; + units:name "kilometre" ; + units:prefixConversion [ + units:factor 1000 ; + units:to units:m + ], [ + units:factor 100000 ; + units:to units:cm + ], [ + units:factor 1000000 ; + units:to units:mm + ] ; + units:render "%f km" ; + units:symbol "km" . + +units:inch a units:Unit ; + units:conversion [ + units:factor 2.54 ; + units:to units:cm + ] ; + units:name "inch" ; + units:render "%f\"" ; + units:symbol "in" . + +units:mile a units:Unit ; + units:conversion [ + units:factor 1.6093 ; + units:to units:km + ] ; + units:name "mile" ; + units:render "%f mi" ; + units:symbol "mi" . + +units:db a units:Unit ; + units:name "decibel" ; + units:render "%f dB" ; + units:symbol "dB" . + +units:pc a units:Unit ; + units:conversion [ + units:factor 0.01 ; + units:to units:coef + ] ; + units:name "percent" ; + units:render "%f%%" ; + units:symbol "%" . + +units:coef a units:Unit ; + units:conversion [ + units:factor 100 ; + units:to units:pc + ] ; + units:name "coefficient" ; + units:render "* %f" ; + units:symbol "" . + +units:hz a units:Unit ; + units:name "hertz" ; + units:prefixConversion [ + units:factor 0.001 ; + units:to units:khz + ], [ + units:factor 0.000001 ; + units:to units:mhz + ] ; + units:render "%f Hz" ; + units:symbol "Hz" . + +units:khz a units:Unit ; + units:name "kilohertz" ; + units:prefixConversion [ + units:factor 1000 ; + units:to units:hz + ], [ + units:factor 0.001 ; + units:to units:mhz + ] ; + units:render "%f kHz" ; + units:symbol "kHz" . + +units:mhz a units:Unit ; + units:name "megahertz" ; + units:prefixConversion [ + units:factor 1000000 ; + units:to units:hz + ], [ + units:factor 0.001 ; + units:to units:khz + ] ; + units:render "%f MHz" ; + units:symbol "MHz" . + +units:bpm a units:Unit ; + units:name "beats per minute" ; + units:prefixConversion [ + units:factor 0.0166666666 ; + units:to units:hz + ] ; + units:render "%f BPM" ; + units:symbol "BPM" . + +units:oct a units:Unit ; + units:conversion [ + units:factor 12.0 ; + units:to units:semitone12TET + ] ; + units:name "octaves" ; + units:render "%f octaves" ; + units:symbol "oct" . + +units:cent a units:Unit ; + units:conversion [ + units:factor 0.01 ; + units:to units:semitone12TET + ] ; + units:name "cent" ; + units:render "%f ct" ; + units:symbol "ct" . + +units:semitone12TET a units:Unit ; + units:conversion [ + units:factor 0.083333333 ; + units:to units:oct + ] ; + units:name "semitone" ; + units:render "%f semi" ; + units:symbol "semi" . + +units:degree a units:Unit ; + units:name "degree" ; + units:render "%f deg" ; + units:symbol "deg" . + +units:midiNote a units:Unit ; + units:name "MIDI note" ; + units:render "MIDI note %d" ; + units:symbol "note" . diff --git a/lv2/ns/extensions/units/waf b/lv2/ns/extensions/units/waf new file mode 120000 index 0000000..b955110 --- /dev/null +++ b/lv2/ns/extensions/units/waf @@ -0,0 +1 @@ +../../../../waf
\ No newline at end of file diff --git a/lv2/ns/extensions/units/wscript b/lv2/ns/extensions/units/wscript new file mode 120000 index 0000000..ec20a77 --- /dev/null +++ b/lv2/ns/extensions/units/wscript @@ -0,0 +1 @@ +../../../../ext.wscript
\ No newline at end of file |