commit ef609eb708f418597549b932fa152596ea073711 Author: falkTX Date: Fri Jul 3 10:50:17 2015 +0200 Add initial external ui diff --git a/kx-external-ui.lv2/external-ui.doap.ttl b/kx-external-ui.lv2/external-ui.doap.ttl new file mode 100644 index 0000000..c011d2c --- /dev/null +++ b/kx-external-ui.lv2/external-ui.doap.ttl @@ -0,0 +1,25 @@ +@prefix dcs: . +@prefix doap: . +@prefix foaf: . +@prefix rdfs: . + + + a doap:Project ; + rdfs:seeAlso <../kx-meta/meta.ttl> ; + doap:license ; + doap:name "External UI" ; + doap:homepage ; + doap:created "2015-07-03" ; + doap:shortdesc "LV2 extension for implementing external UIs." ; + doap:developer ; + doap:maintainer ; + doap:release [ + doap:revision "1.0" ; + doap:created "2015-07-03" ; + doap:file-release ; + dcs:changeset [ + dcs:item [ + rdfs:label "First stable release." + ] + ] + ] . diff --git a/kx-external-ui.lv2/external-ui.h b/kx-external-ui.lv2/external-ui.h new file mode 100755 index 0000000..2c9e6ee --- /dev/null +++ b/kx-external-ui.lv2/external-ui.h @@ -0,0 +1,109 @@ +/* + LV2 External UI extension + This work is in public domain. + + This file is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + + If you have questions, contact Filipe Coelho (aka falkTX) + or ask in #lad channel, FreeNode IRC network. +*/ + +/** + @file lv2_external_ui.h + C header for the LV2 External UI extension . +*/ + +#ifndef LV2_EXTERNAL_UI_H +#define LV2_EXTERNAL_UI_H + +#include "lv2/lv2plug.in/ns/extensions/ui/ui.h" + +#define LV2_EXTERNAL_UI_URI "http://kxstudio.sf.net/ns/lv2ext/external-ui" +#define LV2_EXTERNAL_UI_PREFIX LV2_EXTERNAL_UI_URI "#" + +#define LV2_EXTERNAL_UI__Host LV2_EXTERNAL_UI_PREFIX "Host" +#define LV2_EXTERNAL_UI__Widget LV2_EXTERNAL_UI_PREFIX "Widget" + +/** This extension used to be defined by a lv2plug.in URI */ +#define LV2_EXTERNAL_UI_DEPRECATED_URI "http://lv2plug.in/ns/extensions/ui#external" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * When LV2_EXTERNAL_UI__Widget UI is instantiated, the returned + * LV2UI_Widget handle must be cast to pointer to LV2_External_UI_Widget. + * UI is created in invisible state. + */ +typedef struct _LV2_External_UI_Widget { + /** + * Host calls this function regulary. UI library implementing the + * callback may do IPC or redraw the UI. + * + * @param _this_ the UI context + */ + void (*run)(struct _LV2_External_UI_Widget * _this_); + + /** + * Host calls this function to make the plugin UI visible. + * + * @param _this_ the UI context + */ + void (*show)(struct _LV2_External_UI_Widget * _this_); + + /** + * Host calls this function to make the plugin UI invisible again. + * + * @param _this_ the UI context + */ + void (*hide)(struct _LV2_External_UI_Widget * _this_); + +} LV2_External_UI_Widget; + +#define LV2_EXTERNAL_UI_RUN(ptr) (ptr)->run(ptr) +#define LV2_EXTERNAL_UI_SHOW(ptr) (ptr)->show(ptr) +#define LV2_EXTERNAL_UI_HIDE(ptr) (ptr)->hide(ptr) + +/** + * On UI instantiation, host must supply LV2_EXTERNAL_UI__Host feature. + * LV2_Feature::data must be pointer to LV2_External_UI_Host. + */ +typedef struct _LV2_External_UI_Host { + /** + * Callback that plugin UI will call when UI (GUI window) is closed by user. + * This callback will be called during execution of LV2_External_UI_Widget::run() + * (i.e. not from background thread). + * + * After this callback is called, UI is defunct. Host must call LV2UI_Descriptor::cleanup(). + * If host wants to make the UI visible again, the UI must be reinstantiated. + * + * @note When using the depreated URI LV2_EXTERNAL_UI_DEPRECATED_URI, + * some hosts will not call LV2UI_Descriptor::cleanup() as they should, + * and may call show() again without re-initialization. + * + * @param controller Host context associated with plugin UI, as + * supplied to LV2UI_Descriptor::instantiate(). + */ + void (*ui_closed)(LV2UI_Controller controller); + + /** + * Optional (may be NULL) "user friendly" identifier which the UI + * may display to allow a user to easily associate this particular + * UI instance with the correct plugin instance as it is represented + * by the host (e.g. "track 1" or "channel 4"). + * + * If supplied by host, the string will be referenced only during + * LV2UI_Descriptor::instantiate() + */ + const char * plugin_human_id; + +} LV2_External_UI_Host; + +#ifdef __cplusplus +} /* extern "C" */ +#endif + +#endif /* LV2_EXTERNAL_UI_H */ diff --git a/kx-external-ui.lv2/external-ui.ttl b/kx-external-ui.lv2/external-ui.ttl new file mode 100644 index 0000000..6a0139f --- /dev/null +++ b/kx-external-ui.lv2/external-ui.ttl @@ -0,0 +1,112 @@ +@prefix lv2: . +@prefix extui: . +@prefix owl: . +@prefix rdf: . +@prefix rdfs: . +@prefix xsd: . + + + a owl:Ontology ; + rdfs:seeAlso , + , + <../kx-meta/meta.ttl> ; + lv2:documentation """ +

+ LV2 External UI extension is an LV2 UI extension, + subclass of http://lv2plug.in/ns/extensions/ui/#UI + just like http://lv2plug.in/ns/extensions/ui/#GtkUI is.
+ It defines LV2UI_Widget pointer/handle as a pointer to LV2_External_UI_Widget, defined in the lv2_external_ui.h header (see below).
+

+

+ This extension used to be available under the http://lv2plug.in/ns/extensions/ui#external URI, + and later http://nedko.arnaudov.name/lv2/external_ui/.
+ These old URIs are deprecated and the extension is available under the new http://kxstudio.sf.net/ns/lv2ext/external-ui URI.
+ Or if you prefer, the old extensions are deprecated and a new one with exactly same semantics but different URI is available.
+
+ NOTE: The old http://nedko.arnaudov.name/lv2/external_ui/ URI has been removed from the header file, + since there were no plugins using it. +

+
+ +

+ List of plugins that use this extension: +

+

+ +

+ List of hosts that use this extension: +

+

+""" . + +extui:brand + a rdf:Property , + owl:DatatypeProperty ; + rdfs:label "brand" ; + rdfs:range xsd:string ; + rdfs:comment "TODO, maximum 10 characters" . + +extui:label + a rdf:Property , + owl:DatatypeProperty ; + rdfs:label "label" ; + rdfs:range xsd:string ; + rdfs:comment "TODO, maximum 16 characters" . + +extui:default + a rdf:Property , + owl:DatatypeProperty , + owl:FunctionalProperty ; + rdfs:label "default" ; + rdfs:seeAlso lv2:default ; + rdfs:comment "A custom default value specific to MOD devices, used in place of lv2:default." . + +extui:minimum + a rdf:Property , + owl:DatatypeProperty , + owl:FunctionalProperty ; + rdfs:label "minimum" ; + rdfs:seeAlso lv2:minimum ; + rdfs:comment "A custom minimum value specific to MOD devices, used in place of lv2:minimum." . + +extui:maximum + a rdf:Property , + owl:DatatypeProperty , + owl:FunctionalProperty ; + rdfs:label "maximum" ; + rdfs:seeAlso lv2:maximum ; + rdfs:comment "A custom maximum value specific to MOD devices, used in place of lv2:maximum." . + +extui:rangeSteps + a rdf:Property ; + rdfs:domain lv2:Port ; + rdfs:range xsd:nonNegativeInteger ; + rdfs:label "number of value steps" ; + rdfs:seeAlso pprops:rangeSteps ; + rdfs:comment "A custom rangeSteps value specific to MOD devices, used in place of pprops:rangeSteps." . + +extui:notStompboxCapable + a lv2:Feature ; + rdfs:label "not stompbox capable" ; + lv2:documentation """ +

+Indicates that the plugin is not suitable for use in the MOD Stompbox mode.
+Plugins are assumed to be suitable for Stompbox mode by default, and MUST provide this as an optional feature in case that's not true. +

+""" . diff --git a/kx-external-ui.lv2/manifest.ttl b/kx-external-ui.lv2/manifest.ttl new file mode 100644 index 0000000..5c7dc8b --- /dev/null +++ b/kx-external-ui.lv2/manifest.ttl @@ -0,0 +1,8 @@ +@prefix lv2: . +@prefix rdfs: . + + + a lv2:Specification ; + lv2:minorVersion 1 ; + lv2:microVersion 0 ; + rdfs:seeAlso .