Use new Suil and SLV2 APIs for LV2 plugin UIs.

Add lv2_ui.h (required by lv2_external_ui.h).


git-svn-id: svn://localhost/ardour2/branches/3.0@9406 d708f5d6-7413-0410-9779-e7cbd77b26cf

4 files changed, 297 insertions, 32 deletions

diff --git a/gtk2_ardour/lv2_external_ui.h b/gtk2_ardour/lv2_external_ui.h
index 242271ecc4..2cb4bae3a8 100644
--- a/gtk2_ardour/lv2_external_ui.h
+++ b/gtk2_ardour/lv2_external_ui.h
@@ -77,7 +77,7 @@ struct lv2_external_ui_host
    * @param controller Host context associated with plugin UI, as
    * supplied to LV2UI_Descriptor::instantiate()
    */
-  void (* ui_closed)(LV2UI_Controller controller);
+  void (* ui_closed)(void* controller);
 
   /**
    * Optional (may be NULL) "user friendly" identifier which the UI
diff --git a/gtk2_ardour/lv2_plugin_ui.cc b/gtk2_ardour/lv2_plugin_ui.cc
index 3bd6ab1bc6..bc11d31cce 100644
--- a/gtk2_ardour/lv2_plugin_ui.cc
+++ b/gtk2_ardour/lv2_plugin_ui.cc
@@ -26,21 +26,23 @@
 #include "gui_thread.h"
 #include "lv2_plugin_ui.h"
 
+#include "lv2_ui.h"
+
 using namespace Gtk;
 using namespace ARDOUR;
 using namespace PBD;
 
-#ifdef HAVE_NEW_SLV2
-SLV2UIHost LV2PluginUI::ui_host  = NULL;
-SLV2Value  LV2PluginUI::ui_GtkUI = NULL;
+#if defined(HAVE_NEW_SLV2) && defined(HAVE_SUIL)
+SuilHost  LV2PluginUI::ui_host  = NULL;
+SLV2Value LV2PluginUI::ui_GtkUI = NULL;
 #endif
 
 void
-LV2PluginUI::lv2_ui_write(LV2UI_Controller controller,
-                          uint32_t         port_index,
-                          uint32_t         /*buffer_size*/,
-                          uint32_t         /*format*/,
-                          const void*      buffer)
+LV2PluginUI::lv2_ui_write(void*       controller,
+                          uint32_t    port_index,
+                          uint32_t    /*buffer_size*/,
+                          uint32_t    /*format*/,
+                          const void* buffer)
 {
 	LV2PluginUI* me = (LV2PluginUI*)controller;
 	boost::shared_ptr<AutomationControl> ac = me->_controllables[port_index];
@@ -51,7 +53,7 @@ LV2PluginUI::lv2_ui_write(LV2UI_Controller controller,
 }
 
 void
-LV2PluginUI::on_external_ui_closed(LV2UI_Controller controller)
+LV2PluginUI::on_external_ui_closed(void* controller)
 {
 	LV2PluginUI* me = (LV2PluginUI*)controller;
 	me->_screen_update_connection.disconnect();
@@ -75,8 +77,8 @@ LV2PluginUI::parameter_update(uint32_t port_index, float val)
 		return;
 	}
 
-#ifdef HAVE_NEW_SLV2
-	slv2_ui_instance_port_event(_inst, port_index, 4, 0, &val);
+#ifdef HAVE_SUIL
+	suil_instance_port_event(_inst, port_index, 4, 0, &val);
 #else
 	const LV2UI_Descriptor* ui_desc   = slv2_ui_instance_get_descriptor(_inst);
 	LV2UI_Handle            ui_handle = slv2_ui_instance_get_handle(_inst);
@@ -131,9 +133,9 @@ LV2PluginUI::LV2PluginUI(boost::shared_ptr<PluginInsert> pi,
                          boost::shared_ptr<LV2Plugin>    lv2p)
 	: PlugUIBase(pi)
 	, _lv2(lv2p)
-	, _inst(NULL)
 	, _values(NULL)
 	, _external_ui_ptr(NULL)
+	, _inst(NULL)
 {
 	if (!_lv2->is_external_ui()) {
 		lv2ui_instantiate("gtk2gui");
@@ -174,16 +176,25 @@ LV2PluginUI::lv2ui_instantiate(const std::string& title)
 		features_dst = (LV2_Feature**)_lv2->features();
 	}
 
-#ifdef HAVE_NEW_SLV2
+#if defined(HAVE_NEW_SLV2) && defined(HAVE_SUIL)
 	if (!LV2PluginUI::ui_host) {
 		LV2PluginUI::ui_GtkUI = slv2_value_new_uri(
 			ARDOUR::PluginManager::the_manager()->lv2_world()->world,
 			"http://lv2plug.in/ns/extensions/ui#GtkUI");
-		LV2PluginUI::ui_host = slv2_ui_host_new(
+		LV2PluginUI::ui_host = suil_host_new(
 	        LV2PluginUI::lv2_ui_write, NULL, NULL, NULL);
 	}
-	_inst = slv2_ui_instance_new(
-		_lv2->slv2_plugin(), _lv2->slv2_ui(), ui_GtkUI, ui_host, this, features_dst);
+	SLV2UI ui = _lv2->slv2_ui();
+	_inst = suil_instance_new(
+		LV2PluginUI::ui_host,
+		this,
+		slv2_value_as_uri(ui_GtkUI),
+		slv2_value_as_uri(slv2_plugin_get_uri(_lv2->slv2_plugin())),
+		slv2_value_as_uri(slv2_ui_get_uri(ui)),
+		slv2_value_as_uri(_lv2->ui_type()),
+		slv2_uri_to_path(slv2_value_as_uri(slv2_ui_get_bundle_uri(ui))),
+		slv2_uri_to_path(slv2_value_as_uri(slv2_ui_get_binary_uri(ui))),
+		features_dst);
 #else
 	_inst = slv2_ui_instantiate(
 	        _lv2->slv2_plugin(), _lv2->slv2_ui(), LV2PluginUI::lv2_ui_write, this,
@@ -194,6 +205,12 @@ LV2PluginUI::lv2ui_instantiate(const std::string& title)
 		free(features_dst);
 	}
 
+#if defined(HAVE_NEW_SLV2) && defined(HAVE_SUIL)
+#define GET_WIDGET(inst) suil_instance_get_widget(inst);
+#else
+#define GET_WIDGET(inst) slv2_ui_instance_get_widget(inst);
+#endif
+
 	uint32_t num_ports = slv2_plugin_get_num_ports(_lv2->slv2_plugin());
 	for (uint32_t i = 0; i < num_ports; ++i) {
 		if (_lv2->parameter_is_output(i)
@@ -206,12 +223,12 @@ LV2PluginUI::lv2ui_instantiate(const std::string& title)
 	_external_ui_ptr = NULL;
 	if (_inst) {
 		if (!is_external_ui) {
-			GtkWidget* c_widget = (GtkWidget*)slv2_ui_instance_get_widget(_inst);
+			GtkWidget* c_widget = (GtkWidget*)GET_WIDGET(_inst);
 			_gui_widget = Glib::wrap(c_widget);
 			_gui_widget->show_all();
 			pack_start(*_gui_widget, true, true);
 		} else {
-			_external_ui_ptr = (struct lv2_external_ui*)slv2_ui_instance_get_widget(_inst);
+			_external_ui_ptr = (struct lv2_external_ui*)GET_WIDGET(_inst);
 		}
 	}
 
@@ -241,8 +258,8 @@ LV2PluginUI::~LV2PluginUI ()
 	}
 
 	/* Close and delete GUI. */
-#ifdef HAVE_NEW_SLV2
-	slv2_ui_instance_free(_inst);
+#if defined(HAVE_NEW_SLV2) && defined(HAVE_SUIL)
+	suil_instance_free(_inst);
 #else
 	const LV2UI_Descriptor* ui_desc   = slv2_ui_instance_get_descriptor(_inst);
 	LV2UI_Handle            ui_handle = slv2_ui_instance_get_handle(_inst);
diff --git a/gtk2_ardour/lv2_plugin_ui.h b/gtk2_ardour/lv2_plugin_ui.h
index 158c7cb2e0..7a784e2d67 100644
--- a/gtk2_ardour/lv2_plugin_ui.h
+++ b/gtk2_ardour/lv2_plugin_ui.h
@@ -40,6 +40,10 @@
 
 #include "lv2_external_ui.h"
 
+#if defined(HAVE_NEW_SLV2) && defined(HAVE_SUIL)
+#include <suil/suil.h>
+#endif
+
 namespace ARDOUR {
 	class PluginInsert;
 	class LV2Plugin;
@@ -66,9 +70,8 @@ class LV2PluginUI : public PlugUIBase, public Gtk::VBox
 	std::vector<int> _output_ports;
 	sigc::connection _screen_update_connection;
 
-	Gtk::Widget*   _gui_widget;
-	SLV2UIInstance _inst;
-	float*         _values;
+	Gtk::Widget* _gui_widget;
+	float*       _values;
 	std::vector<boost::shared_ptr<ARDOUR::AutomationControl> > _controllables;
 
 	struct lv2_external_ui_host _external_ui_host;
@@ -76,19 +79,23 @@ class LV2PluginUI : public PlugUIBase, public Gtk::VBox
 	struct lv2_external_ui* _external_ui_ptr;
 	Gtk::Window* _win_ptr;
 
-	static void on_external_ui_closed(LV2UI_Controller controller);
+	static void on_external_ui_closed(void* controller);
 
-#ifdef HAVE_NEW_SLV2
-	static SLV2UIHost ui_host;
+#if defined(HAVE_NEW_SLV2) && defined(HAVE_SUIL)
+	static SuilHost   ui_host;
 	static SLV2Value  ui_GtkUI;
+
+	SuilInstance _inst;
+#else
+	SLV2UIInstance _inst;
 #endif
 
 	static void lv2_ui_write(
-			LV2UI_Controller controller,
-			uint32_t         port_index,
-			uint32_t         buffer_size,
-			uint32_t         format,
-			const void*      buffer);
+			void*       controller,
+			uint32_t    port_index,
+			uint32_t    buffer_size,
+			uint32_t    format,
+			const void* buffer);
 
 	void lv2ui_instantiate(const std::string& title);
 
diff --git a/gtk2_ardour/lv2_ui.h b/gtk2_ardour/lv2_ui.h
new file mode 100644
index 0000000000..fa0a711cf4
--- /dev/null
+++ b/gtk2_ardour/lv2_ui.h
@@ -0,0 +1,241 @@
+/* LV2 UI Extension
+ * Copyright (C) 2006-2008 Lars Luthman <lars.luthman@gmail.com>
+ * Copyright (C) 2009-2010 David Robillard <d@drobilla.net>
+ *
+ * Based on lv2.h, which was
+ * Copyright (C) 2000-2002 Richard W.E. Furse, Paul Barton-Davis,
+ *                         Stefan Westerfeld
+ * Copyright (C) 2006 Steve Harris, David Robillard.
+ *
+ * This header is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published
+ * by the Free Software Foundation; either version 2.1 of the License,
+ * or (at your option) any later version.
+ *
+ * This header 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. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
+ * USA.
+ *
+ */
+
+/** @file
+ * C header for the LV2 UI extension <http://lv2plug.in/ns/extensions/ui>.
+ */
+
+#ifndef LV2_UI_H
+#define LV2_UI_H
+
+#include "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);
+
+
+/** This struct contains 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);
+
+  /** Returns 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);
+
+
+/** This is the type of the lv2ui_descriptor() function. */
+typedef const LV2UI_Descriptor* (*LV2UI_DescriptorFunction)(uint32_t index);
+
+
+
+#ifdef __cplusplus
+}
+#endif
+
+
+#endif