From eb43c8896480114b224755e824fae2e2f7485256 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Mon, 21 Nov 2011 01:36:00 +0000 Subject: Move ns to lv2/ns so repository top level can be used as an include dir directly. --- ns/extensions/ui/ext.pc.in | 1 - ns/extensions/ui/lv2-ui.doap.ttl | 62 ---------- ns/extensions/ui/manifest.ttl | 9 -- ns/extensions/ui/ui.h | 247 --------------------------------------- ns/extensions/ui/ui.ttl | 220 ---------------------------------- ns/extensions/ui/waf | 1 - ns/extensions/ui/wscript | 1 - 7 files changed, 541 deletions(-) delete mode 120000 ns/extensions/ui/ext.pc.in delete mode 100644 ns/extensions/ui/lv2-ui.doap.ttl delete mode 100644 ns/extensions/ui/manifest.ttl delete mode 100644 ns/extensions/ui/ui.h delete mode 100644 ns/extensions/ui/ui.ttl delete mode 120000 ns/extensions/ui/waf delete mode 120000 ns/extensions/ui/wscript (limited to 'ns/extensions/ui') diff --git a/ns/extensions/ui/ext.pc.in b/ns/extensions/ui/ext.pc.in deleted file mode 120000 index 1cdad2a..0000000 --- a/ns/extensions/ui/ext.pc.in +++ /dev/null @@ -1 +0,0 @@ -../../../ext.pc.in \ No newline at end of file diff --git a/ns/extensions/ui/lv2-ui.doap.ttl b/ns/extensions/ui/lv2-ui.doap.ttl deleted file mode 100644 index 44b135d..0000000 --- a/ns/extensions/ui/lv2-ui.doap.ttl +++ /dev/null @@ -1,62 +0,0 @@ -@prefix dcs: . -@prefix doap: . -@prefix foaf: . -@prefix rdfs: . - - - a foaf:Person ; - foaf:name "David Robillard" ; - foaf:homepage ; - foaf:mbox ; - rdfs:seeAlso . - - - a doap:Project ; - doap:license ; - doap:name "LV2 UI" ; - doap:shortdesc "Generic UI interface for LV2 plugins." ; - doap:developer [ - a foaf:Person ; - foaf:name "Lars Luthman" ; - foaf:mbox - ] ; - doap:maintainer ; - doap:release [ - doap:revision "2.3" ; - dcs:blame ; - 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 ; - dcs:blame ; - 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 ; - dcs:blame ; - dcs:changeset [ - dcs:item [ - rdfs:label "Initial release." - ] - ] - ] . diff --git a/ns/extensions/ui/manifest.ttl b/ns/extensions/ui/manifest.ttl deleted file mode 100644 index febbaad..0000000 --- a/ns/extensions/ui/manifest.ttl +++ /dev/null @@ -1,9 +0,0 @@ -@prefix lv2: . -@prefix rdfs: . - - - a lv2:Specification ; - lv2:minorVersion 2 ; - lv2:microVersion 3 ; - rdfs:seeAlso , - . diff --git a/ns/extensions/ui/ui.h b/ns/extensions/ui/ui.h deleted file mode 100644 index 6d64a0d..0000000 --- a/ns/extensions/ui/ui.h +++ /dev/null @@ -1,247 +0,0 @@ -/* - LV2 UI Extension - Copyright 2009-2011 David Robillard - Copyright 2006-2008 Lars Luthman - - 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 . - */ - -#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 - 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: - 
-     uiext:portNotification
-     uiext:noPortNotification
-     uiext:plugin
-     uiext:portIndex
-
- For example, if you want the UI with uri - for the plugin with URI - 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: - 
-      uiext:portNotification [ uiext:plugin  ;
-     uiext:portIndex 4 ] .
-
- and similarly with uiext:noPortNotification 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/ns/extensions/ui/ui.ttl b/ns/extensions/ui/ui.ttl deleted file mode 100644 index f62569a..0000000 --- a/ns/extensions/ui/ui.ttl +++ /dev/null @@ -1,220 +0,0 @@ -# LV2 UI Extension -# Copyright 2009-2011 David Robillard -# Copyright 2006-2008 Lars Luthman -# -# 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: . -@prefix foaf: . -@prefix lv2: . -@prefix owl: . -@prefix rdf: . -@prefix rdfs: . -@prefix ui: . -@prefix xsd: . - - - a owl:Ontology ; - owl:imports ; - lv2:documentation """ -

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:

- -
-@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> .
-
- -

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 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.

- -

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.

- -

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 -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).

- -

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:

- -
-<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. 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).

- -

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.

- -

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.

- -

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.

-""" . - -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 """ -

DEPRECATED

- -

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. gcc -Wl,nodelete.

-""" . - -ui:noUserResize - a lv2:Feature ; - lv2:documentation """ -

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.

-""" . - -ui:fixedSize - a lv2:Feature ; - lv2:documentation """ -

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.

-""" . - -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 """ -

Indicates that a UI should receive notification (via -LV2UI_Descriptor::port_event()) when a particular port's value changes.

-""" . - -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/ns/extensions/ui/waf b/ns/extensions/ui/waf deleted file mode 120000 index 917d5c5..0000000 --- a/ns/extensions/ui/waf +++ /dev/null @@ -1 +0,0 @@ -../../../waf \ No newline at end of file diff --git a/ns/extensions/ui/wscript b/ns/extensions/ui/wscript deleted file mode 120000 index cf8cbae..0000000 --- a/ns/extensions/ui/wscript +++ /dev/null @@ -1 +0,0 @@ -../../../ext.wscript \ No newline at end of file -- cgit v1.2.1