Add initial external ui

kx-external-ui.lv2/external-ui.doap.ttl

@@ -0,0 +1,25 @@
+@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://kxstudio.sf.net/ns/lv2ext/external-ui>
+    a doap:Project ;
+    rdfs:seeAlso <../kx-meta/meta.ttl> ;
+    doap:license <http://opensource.org/licenses/isc> ;
+    doap:name "External UI" ;
+    doap:homepage <http://kxstudio.sf.net/ns/lv2ext/external-ui> ;
+    doap:created "2015-07-03" ;
+    doap:shortdesc "LV2 extension for implementing external UIs." ;
+    doap:developer <http://falktx.com/myself.html> ;
+    doap:maintainer <http://falktx.com/myself.html> ;
+    doap:release [
+        doap:revision "1.0" ;
+        doap:created "2015-07-03" ;
+        doap:file-release <http://kxstudio.sf.net/ns/lv2ext/kx-extensions-1.0.tar.bz2> ;
+        dcs:changeset [
+            dcs:item [
+                rdfs:label "First stable release."
+            ]
+        ]
+    ] .

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) <falktx@falktx.com>
+  or ask in #lad channel, FreeNode IRC network.
+*/
+
+/**
+   @file lv2_external_ui.h
+   C header for the LV2 External UI extension <http://kxstudio.sf.net/ns/lv2ext/external-ui>.
+*/
+
+#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 */

kx-external-ui.lv2/external-ui.ttl

@@ -0,0 +1,112 @@
+@prefix lv2:   <http://lv2plug.in/ns/lv2core#> .
+@prefix extui: <http://kxstudio.sf.net/ns/lv2ext/external-ui#> .
+@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://kxstudio.sf.net/ns/lv2ext/external-ui>
+    a owl:Ontology ;
+    rdfs:seeAlso <external-ui.h> ,
+        <external-ui.doap.ttl> ,
+        <../kx-meta/meta.ttl> ;
+    lv2:documentation """
+<p>
+    LV2 External UI extension is an <a href="http://lv2plug.in/ns/extensions/ui" target="_blank">LV2 UI</a> extension,
+    subclass of <a href="http://lv2plug.in/ns/extensions/ui/#UI" target="_blank">http://lv2plug.in/ns/extensions/ui/#UI</a>
+    just like <a href="http://lv2plug.in/ns/extensions/ui/#GtkUI" target="_blank">http://lv2plug.in/ns/extensions/ui/#GtkUI</a> is.<br/>
+    It defines LV2UI_Widget pointer/handle as a pointer to LV2_External_UI_Widget, defined in the lv2_external_ui.h header (see below).<br/>
+</p>
+<p>
+    This extension used to be available under the <b style="text-decoration: line-through;">http://lv2plug.in/ns/extensions/ui#external</b> URI,
+    and later <b style="text-decoration: line-through;">http://nedko.arnaudov.name/lv2/external_ui/</b>.<br/>
+    These old URIs are deprecated and the extension is available under the new <b>http://kxstudio.sf.net/ns/lv2ext/external-ui</b> URI.<br/>
+    Or if you prefer, the old extensions are deprecated and a new one with exactly same semantics but different URI is available.<br/>
+    <br/>
+    NOTE: The old <b style="text-decoration: line-through;">http://nedko.arnaudov.name/lv2/external_ui/</b> URI has been removed from the header file,
+    since there were no plugins using it.
+</p>
+<hr/>
+
+<p>
+    List of plugins that use this extension:
+    <ul>
+        <li><a href="http://distrho.sourceforge.net/" target="_blank">DISTRHO Plugins and Ports</a></li>
+        <li><a href="http://www.drumgizmo.org/" target="_blank">DrumGizmo</a></li>
+        <li><a href="http://drumkv1.sourceforge.net/" target="_blank">drumkv1</a></li>
+        <li><a href="http://www.linuxdsp.co.uk/" target="_blank">linuxDSP</a></li>
+        <li><a href="https://github.com/x42/meters.lv2" target="_blank">meters.lv2</a></li>
+        <li><a href="https://www.pianoteq.com/pianoteq4" target="_blank">Pianoteq</a></li>
+        <li><a href="http://samplv1.sourceforge.net/" target="_blank">samplv1</a></li>
+        <li><a href="https://github.com/x42/sisco.lv2" target="_blank">sisco.lv2</a></li>
+        <li><a href="http://synthv1.sourceforge.net/" target="_blank">synthv1</a></li>
+        <li><a href="https://github.com/x42/tuna.lv2" target="_blank">tuna.lv2</a></li>
+    </ul>
+</p>
+
+<p>
+    List of hosts that use this extension:
+    <ul>
+        <li><a href="http://ardour.org" target="_blank">Ardour</a></li>
+        <li><a href="<?php echo $ROOT; ?>/Applications:Carla" target="_blank">Carla</a></i></li>
+        <li><a href="http://drobilla.net/software/jalv/" target="_blank">Jalv</a> (using <a href="jalv_extui_svn5273b.diff" target="_blank">this patch</a>)</li>
+        <li><a href="http://qtractor.sourceforge.net" target="_blank">Qtractor</a></li>
+    </ul>
+</p>
+""" .
+
+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 """
+<p>
+Indicates that the plugin is not suitable for use in the MOD Stompbox mode.<br/>
+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.
+</p>
+""" .

kx-external-ui.lv2/manifest.ttl

@@ -0,0 +1,8 @@
+@prefix lv2:  <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://kxstudio.sf.net/ns/lv2ext/external-ui>
+    a lv2:Specification ;
+    lv2:minorVersion 1 ;
+    lv2:microVersion 0 ;
+    rdfs:seeAlso <external-ui.ttl> .