add LV2 support for kx:external-ui#
[ardour.git] / gtk2_ardour / lv2_plugin_ui.cc
index ead7440b3a91fd4a9f8d60cf70d413ff6cd343c1..168f2d6798e12021a98cb70dc632c38346dffa9b 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2008-2011 Paul Davis
+    Copyright (C) 2008-2012 Paul Davis
     Author: David Robillard
 
     This program is free software; you can redistribute it and/or modify
     You should have received a copy of the GNU General Public License
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
 */
 
 #include "ardour/lv2_plugin.h"
-#include "ardour/plugin_manager.h"
-#include "ardour/processor.h"
+#include "ardour/session.h"
+#include "pbd/error.h"
 
 #include "ardour_ui.h"
-#include "gui_thread.h"
 #include "lv2_plugin_ui.h"
 
-using namespace Gtk;
+#include "lv2/lv2plug.in/ns/extensions/ui/ui.h"
+
+#include <lilv/lilv.h>
+#include <suil/suil.h>
+
+#include "i18n.h"
+
 using namespace ARDOUR;
+using namespace Gtk;
 using namespace PBD;
 
-#ifdef HAVE_NEW_SLV2
-SLV2UIHost LV2PluginUI::ui_host  = NULL;
-SLV2Value  LV2PluginUI::ui_GtkUI = NULL;
-#endif
+#define NS_UI "http://lv2plug.in/ns/extensions/ui#"
+
+static SuilHost* ui_host = NULL;
+
+void
+LV2PluginUI::write_from_ui(void*       controller,
+                           uint32_t    port_index,
+                           uint32_t    buffer_size,
+                           uint32_t    format,
+                           const void* buffer)
+{
+       LV2PluginUI* me = (LV2PluginUI*)controller;
+       if (format == 0) {
+               if (port_index >= me->_controllables.size()) {
+                       return;
+               }
+
+               boost::shared_ptr<AutomationControl> ac = me->_controllables[port_index];
+               if (ac) {
+                       ac->set_value(*(const float*)buffer);
+               }
+       } else if (format == me->_lv2->urids.atom_eventTransfer) {
+
+               const int cnt = me->_pi->get_count();
+               for (int i=0; i < cnt; i++ ) {
+                       boost::shared_ptr<LV2Plugin> lv2i = boost::dynamic_pointer_cast<LV2Plugin> (me->_pi->plugin(i));
+                       lv2i->write_from_ui(port_index, format, buffer_size, (const uint8_t*)buffer);
+               }
+       }
+}
+
+void
+LV2PluginUI::write_to_ui(void*       controller,
+                         uint32_t    port_index,
+                         uint32_t    buffer_size,
+                         uint32_t    format,
+                         const void* buffer)
+{
+       LV2PluginUI* me = (LV2PluginUI*)controller;
+       if (me->_inst) {
+               suil_instance_port_event((SuilInstance*)me->_inst,
+                                        port_index, buffer_size, format, buffer);
+       }
+}
+
+uint32_t
+LV2PluginUI::port_index(void* controller, const char* symbol)
+{
+       return ((LV2PluginUI*)controller)->_lv2->port_index(symbol);
+}
 
 void
-LV2PluginUI::lv2_ui_write(LV2UI_Controller controller,
-                          uint32_t         port_index,
-                          uint32_t         /*buffer_size*/,
-                          uint32_t         /*format*/,
-                          const void*      buffer)
+LV2PluginUI::touch(void*    controller,
+                   uint32_t port_index,
+                   bool     grabbed)
 {
        LV2PluginUI* me = (LV2PluginUI*)controller;
-       me->_controllables[port_index]->set_value(*(float*)buffer);
+       if (port_index >= me->_controllables.size()) {
+               return;
+       }
+
+       ControllableRef control = me->_controllables[port_index];
+       if (grabbed) {
+               control->start_touch(control->session().transport_frame());
+       } else {
+               control->stop_touch(false, control->session().transport_frame());
+       }
+}
+
+void
+LV2PluginUI::update_timeout()
+{
+       _lv2->emit_to_ui(this, &LV2PluginUI::write_to_ui);
 }
 
 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();
        me->_external_ui_ptr = NULL;
+#if 1
+       suil_instance_free((SuilInstance*)me->_inst);
+       me->_inst = NULL;
+#endif
 }
 
 void
@@ -71,15 +139,7 @@ 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);
-#else
-       const LV2UI_Descriptor* ui_desc   = slv2_ui_instance_get_descriptor(_inst);
-       LV2UI_Handle            ui_handle = slv2_ui_instance_get_handle(_inst);
-       if (ui_desc->port_event) {
-               ui_desc->port_event(ui_handle, port_index, 4, 0, &val);
-       }
-#endif
+       suil_instance_port_event((SuilInstance*)_inst, port_index, 4, 0, &val);
        _values[port_index] = val;
 }
 
@@ -88,7 +148,7 @@ LV2PluginUI::start_updating(GdkEventAny*)
 {
        if (!_output_ports.empty()) {
                _screen_update_connection.disconnect();
-               _screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
+               _screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect
                        (sigc::mem_fun(*this, &LV2PluginUI::output_update));
        }
        return false;
@@ -99,8 +159,7 @@ LV2PluginUI::stop_updating(GdkEventAny*)
 {
        //cout << "stop_updating" << endl;
 
-       if ( //!_external_ui_ptr &&
-           !_output_ports.empty()) {
+       if (!_output_ports.empty()) {
                _screen_update_connection.disconnect();
        }
        return false;
@@ -112,6 +171,7 @@ LV2PluginUI::output_update()
        //cout << "output_update" << endl;
        if (_external_ui_ptr) {
                LV2_EXTERNAL_UI_RUN(_external_ui_ptr);
+               if (!_external_ui_ptr) return; // ui was closed here
        }
 
        /* FIXME only works with control output ports (which is all we support now anyway) */
@@ -126,27 +186,36 @@ LV2PluginUI::output_update()
 LV2PluginUI::LV2PluginUI(boost::shared_ptr<PluginInsert> pi,
                          boost::shared_ptr<LV2Plugin>    lv2p)
        : PlugUIBase(pi)
+       , _pi(pi)
        , _lv2(lv2p)
-       , _inst(NULL)
+       , _gui_widget(NULL)
        , _values(NULL)
        , _external_ui_ptr(NULL)
+       , _inst(NULL)
 {
-       if (!_lv2->is_external_ui()) {
-               lv2ui_instantiate("gtk2gui");
-       }
+       _ardour_buttons_box.set_spacing (6);
+       _ardour_buttons_box.set_border_width (6);
+       _ardour_buttons_box.pack_end (focus_button, false, false);
+       _ardour_buttons_box.pack_end (bypass_button, false, false, 10);
+       _ardour_buttons_box.pack_end (delete_button, false, false);
+       _ardour_buttons_box.pack_end (save_button, false, false);
+       _ardour_buttons_box.pack_end (add_button, false, false);
+       _ardour_buttons_box.pack_end (_preset_combo, false, false);
+       _ardour_buttons_box.pack_end (_preset_modified, false, false);
 }
 
 void
 LV2PluginUI::lv2ui_instantiate(const std::string& title)
 {
-       LV2_Feature** features;
-       LV2_Feature** features_src;
-       LV2_Feature** features_dst;
-       size_t        features_count;
-       bool          is_external_ui;
-
-       is_external_ui = _lv2->is_external_ui();
+       bool          is_external_ui = _lv2->is_external_ui();
+       LV2_Feature** features_src   = const_cast<LV2_Feature**>(_lv2->features());
+       LV2_Feature** features       = const_cast<LV2_Feature**>(_lv2->features());
+       size_t        features_count = 0;
+       while (*features++) {
+               features_count++;
+       }
 
+       Gtk::Alignment* container = NULL;
        if (is_external_ui) {
                _external_ui_host.ui_closed       = LV2PluginUI::on_external_ui_closed;
                _external_ui_host.plugin_human_id = strdup(title.c_str());
@@ -154,43 +223,69 @@ LV2PluginUI::lv2ui_instantiate(const std::string& title)
                _external_ui_feature.URI  = LV2_EXTERNAL_UI_URI;
                _external_ui_feature.data = &_external_ui_host;
 
-               features_src = features = (LV2_Feature**)_lv2->features();
-               features_count = 2;
-               while (*features++) {
-                       features_count++;
-               }
-               features_dst = features = (LV2_Feature**)malloc(
-                       sizeof(LV2_Feature*) * features_count);
-               features_dst[--features_count] = NULL;
-               features_dst[--features_count] = &_external_ui_feature;
-               while (features_count--) {
-                       *features++ = *features_src++;
+               _external_kxui_feature.URI  = LV2_EXTERNAL_UI_KX__Host;
+               _external_kxui_feature.data = &_external_ui_host;
+
+               ++features_count;
+               features = (LV2_Feature**)malloc(
+                       sizeof(LV2_Feature*) * (features_count + 2));
+               for (size_t i = 0; i < features_count - 2; ++i) {
+                       features[i] = features_src[i];
                }
+               features[features_count - 2] = &_external_kxui_feature;
+               features[features_count - 1] = &_external_ui_feature;
+               features[features_count]     = NULL;
        } else {
-               features_dst = (LV2_Feature**)_lv2->features();
-       }
+               if (_ardour_buttons_box.get_parent()) {
+                       _ardour_buttons_box.get_parent()->remove(_ardour_buttons_box);
+               }
+               pack_start(_ardour_buttons_box, false, false);
+               _ardour_buttons_box.show_all();
 
-#ifdef HAVE_NEW_SLV2
-       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::lv2_ui_write, NULL, NULL, NULL);
-       }
-       _inst = slv2_ui_instance_new(
-               _lv2->slv2_plugin(), _lv2->slv2_ui(), ui_GtkUI, ui_host, this, features_dst);
-#else
-       _inst = slv2_ui_instantiate(
-               _lv2->slv2_plugin(), _lv2->slv2_ui(), LV2PluginUI::lv2_ui_write, this,
-               features_dst);
-#endif
+               _gui_widget = Gtk::manage((container = new Gtk::Alignment()));
+               pack_start(*_gui_widget, true, true);
+               _gui_widget->show();
 
-       if (is_external_ui) {
-               free(features_dst);
+               _parent_feature.URI  = LV2_UI__parent;
+               _parent_feature.data = _gui_widget->gobj();
+
+               ++features_count;
+               features = (LV2_Feature**)malloc(
+                       sizeof(LV2_Feature*) * (features_count + 1));
+               for (size_t i = 0; i < features_count - 1; ++i) {
+                       features[i] = features_src[i];
+               }
+               features[features_count - 1] = &_parent_feature;
+               features[features_count]     = NULL;
        }
 
-       uint32_t num_ports = slv2_plugin_get_num_ports(_lv2->slv2_plugin());
+       if (!ui_host) {
+               ui_host = suil_host_new(LV2PluginUI::write_from_ui,
+                                       LV2PluginUI::port_index,
+                                       NULL, NULL);
+               suil_host_set_touch_func(ui_host, LV2PluginUI::touch);
+       }
+       const char* container_type = (is_external_ui)
+               ? NS_UI "external"
+               : NS_UI "GtkUI";
+
+       const LilvUI* ui = (const LilvUI*)_lv2->c_ui();
+       _inst = suil_instance_new(
+               ui_host,
+               this,
+               container_type,
+               _lv2->uri(),
+               lilv_node_as_uri(lilv_ui_get_uri(ui)),
+               lilv_node_as_uri((const LilvNode*)_lv2->c_ui_type()),
+               lilv_uri_to_path(lilv_node_as_uri(lilv_ui_get_bundle_uri(ui))),
+               lilv_uri_to_path(lilv_node_as_uri(lilv_ui_get_binary_uri(ui))),
+               features);
+
+       free(features);
+
+#define GET_WIDGET(inst) suil_instance_get_widget((SuilInstance*)inst);
+
+       const uint32_t num_ports = _lv2->num_ports();
        for (uint32_t i = 0; i < num_ports; ++i) {
                if (_lv2->parameter_is_output(i)
                    && _lv2->parameter_is_control(i)
@@ -202,12 +297,20 @@ 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);
-                       _gui_widget = Glib::wrap(c_widget);
-                       _gui_widget->show_all();
-                       pack_start(*_gui_widget, true, true);
+                       GtkWidget* c_widget = (GtkWidget*)GET_WIDGET(_inst);
+                       if (!c_widget) {
+                               error << _("failed to get LV2 UI widget") << endmsg;
+                               suil_instance_free((SuilInstance*)_inst);
+                               _inst = NULL;
+                               return;
+                       }
+                       if (!container->get_child()) {
+                               // Suil didn't add the UI to the container for us, so do it now
+                               container->add(*Gtk::manage(Glib::wrap(c_widget)));
+                       }
+                       container->show_all();
                } else {
-                       _external_ui_ptr = (struct lv2_external_ui*)slv2_ui_instance_get_widget(_inst);
+                       _external_ui_ptr = (struct lv2_external_ui*)GET_WIDGET(_inst);
                }
        }
 
@@ -226,27 +329,38 @@ LV2PluginUI::lv2ui_instantiate(const std::string& title)
                        }
                }
        }
+
+       if (_lv2->has_message_output()) {
+               _lv2->enable_ui_emmission();
+               ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect(
+                       sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
+       }
 }
 
-LV2PluginUI::~LV2PluginUI ()
+void
+LV2PluginUI::lv2ui_free()
 {
-       //cout << "LV2PluginUI destructor called" << endl;
+       stop_updating (0);
 
+       if (_gui_widget) {
+               remove (*_gui_widget);
+               _gui_widget = NULL;
+       }
+
+       if (_inst) {
+               suil_instance_free((SuilInstance*)_inst);
+               _inst = NULL;
+       }
+}
+
+LV2PluginUI::~LV2PluginUI ()
+{
        if (_values) {
                delete[] _values;
        }
 
        /* Close and delete GUI. */
-#ifdef HAVE_NEW_SLV2
-       slv2_ui_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);
-
-       if (ui_desc) {
-               ui_desc->cleanup(ui_handle);
-       }
-#endif
+       lv2ui_free();
 
        _screen_update_connection.disconnect();
 
@@ -272,6 +386,12 @@ LV2PluginUI::get_preferred_width()
        return r.width;
 }
 
+bool
+LV2PluginUI::resizable()
+{
+       return _lv2->ui_is_resizable();
+}
+
 int
 LV2PluginUI::package(Gtk::Window& win)
 {
@@ -322,9 +442,11 @@ LV2PluginUI::on_window_show(const std::string& title)
 
                LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
                _screen_update_connection.disconnect();
-               _screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
+               _screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect
                        (sigc::mem_fun(*this, &LV2PluginUI::output_update));
                return false;
+       } else {
+               lv2ui_instantiate("gtk2gui");
        }
 
        return true;
@@ -337,8 +459,13 @@ LV2PluginUI::on_window_hide()
 
        if (_external_ui_ptr) {
                LV2_EXTERNAL_UI_HIDE(_external_ui_ptr);
-               //slv2_ui_instance_get_descriptor(_inst)->cleanup(_inst);
-               //_external_ui_ptr = NULL;
-               //_screen_update_connection.disconnect();
+               _screen_update_connection.disconnect();
+               _external_ui_ptr = NULL;
+#if 1
+               suil_instance_free((SuilInstance*)_inst);
+               _inst = NULL;
+#endif
+       } else {
+               lv2ui_free();
        }
 }