Use a button in the processor box for toggle parameters.
[ardour.git] / gtk2_ardour / lv2_plugin_ui.cc
index f83ff7384cab6cffd2f0b4543235c22de2bbe607..785a6b9721a87d32b2f042a3ffa0a48c9beb5b5f 100644 (file)
@@ -1,6 +1,6 @@
 /*
-    Copyright (C) 2008 Paul Davis 
-    Author: Dave Robillard
+    Copyright (C) 2008-2011 Paul Davis
+    Author: David Robillard
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#include "ardour/processor.h"
 #include "ardour/lv2_plugin.h"
+#include "ardour/plugin_manager.h"
+#include "ardour/processor.h"
 
 #include "ardour_ui.h"
+#include "gui_thread.h"
 #include "lv2_plugin_ui.h"
 
+#include "lv2_ui.h"
+
+#include <lilv/lilv.h>
+#include <suil/suil.h>
+
 using namespace Gtk;
 using namespace ARDOUR;
 using namespace PBD;
 
+#define NS_UI "http://lv2plug.in/ns/extensions/ui#"
+
+static SuilHost* ui_host = NULL;
+
 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;
-       if (*(float*)buffer != me->_values[port_index])
-               me->_lv2->set_parameter(port_index, *(float*)buffer);
+       boost::shared_ptr<AutomationControl> ac = me->_controllables[port_index];
+
+       if (ac) {
+               ac->set_value(*(float*)buffer);
+       }
 }
 
 void
-LV2PluginUI::parameter_changed (uint32_t port_index, float val)
+LV2PluginUI::on_external_ui_closed(void* controller)
 {
+       LV2PluginUI* me = (LV2PluginUI*)controller;
+       me->_screen_update_connection.disconnect();
+       me->_external_ui_ptr = NULL;
+}
+
+void
+LV2PluginUI::parameter_changed(uint32_t port_index, float val)
+{
+       PlugUIBase::parameter_changed(port_index, val);
+
        if (val != _values[port_index]) {
                parameter_update(port_index, val);
        }
 }
 
 void
-LV2PluginUI::parameter_update (uint32_t port_index, float val)
+LV2PluginUI::parameter_update(uint32_t port_index, float val)
 {
-       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);
+       if (!_inst) {
+               return;
+       }
+
+       suil_instance_port_event((SuilInstance*)_inst, port_index, 4, 0, &val);
        _values[port_index] = val;
 }
 
 bool
-LV2PluginUI::start_updating(GdkEventAny* event)
+LV2PluginUI::start_updating(GdkEventAny*)
 {
        if (!_output_ports.empty()) {
                _screen_update_connection.disconnect();
-               _screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect 
-                       (mem_fun(*this, &LV2PluginUI::output_update));
+               _screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
+                       (sigc::mem_fun(*this, &LV2PluginUI::output_update));
        }
        return false;
 }
 
 bool
-LV2PluginUI::stop_updating(GdkEventAny* event)
+LV2PluginUI::stop_updating(GdkEventAny*)
 {
+       //cout << "stop_updating" << endl;
+
        if (!_output_ports.empty()) {
                _screen_update_connection.disconnect();
        }
@@ -82,90 +108,259 @@ LV2PluginUI::stop_updating(GdkEventAny* event)
 void
 LV2PluginUI::output_update()
 {
+       //cout << "output_update" << endl;
+       if (_external_ui_ptr) {
+               LV2_EXTERNAL_UI_RUN(_external_ui_ptr);
+       }
+
        /* FIXME only works with control output ports (which is all we support now anyway) */
        uint32_t nports = _output_ports.size();
        for (uint32_t i = 0; i < nports; ++i) {
                uint32_t index = _output_ports[i];
                parameter_changed(index, _lv2->get_parameter(index));
        }
-       
+
 }
 
-LV2PluginUI::LV2PluginUI (boost::shared_ptr<PluginInsert> pi, boost::shared_ptr<LV2Plugin> lv2p)
-       : PlugUIBase (pi)
+LV2PluginUI::LV2PluginUI(boost::shared_ptr<PluginInsert> pi,
+                         boost::shared_ptr<LV2Plugin>    lv2p)
+       : PlugUIBase(pi)
        , _lv2(lv2p)
+       , _gui_widget(NULL)
+       , _values(NULL)
+       , _external_ui_ptr(NULL)
+       , _inst(NULL)
+{
+}
+
+void
+LV2PluginUI::lv2ui_instantiate(const std::string& title)
 {
-       _inst = slv2_ui_instantiate(
-                       _lv2->slv2_plugin(), _lv2->slv2_ui(), LV2PluginUI::lv2_ui_write, this,
-                       _lv2->features());
-                       
-       uint32_t num_ports = slv2_plugin_get_num_ports(lv2p->slv2_plugin());
+       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();
+
+       if (is_external_ui) {
+               _external_ui_host.ui_closed       = LV2PluginUI::on_external_ui_closed;
+               _external_ui_host.plugin_human_id = strdup(title.c_str());
+
+               _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++;
+               }
+       } else {
+               features_dst = (LV2_Feature**)_lv2->features();
+       }
+
+       if (!ui_host) {
+               ui_host = suil_host_new(LV2PluginUI::lv2_ui_write, NULL, NULL, NULL);
+       }
+       const char* container_type = (is_external_ui)
+               ? NS_UI "external"
+               : NS_UI "GtkUI";
+
+       LilvUI* ui = (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_dst);
+
+       if (is_external_ui) {
+               free(features_dst);
+       }
+
+#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 (lv2p->parameter_is_output(i) && lv2p->parameter_is_control(i) && is_update_wanted(i)) {
+               if (_lv2->parameter_is_output(i)
+                   && _lv2->parameter_is_control(i)
+                   && is_update_wanted(i)) {
                        _output_ports.push_back(i);
                }
        }
-       
-       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);
-       
+
+       _external_ui_ptr = NULL;
+       if (_inst) {
+               if (!is_external_ui) {
+                       Gtk::HBox* box = manage (new Gtk::HBox);
+                       box->set_spacing (6);
+                       box->set_border_width (6);
+                       box->pack_end (focus_button, false, false);
+                       box->pack_end (bypass_button, false, false, 10);
+                       box->pack_end (delete_button, false, false);
+                       box->pack_end (save_button, false, false);
+                       box->pack_end (add_button, false, false);
+                       box->pack_end (_preset_combo, false, false);
+                       box->show_all();
+                       pack_start(*box, false, false);
+
+                       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*)GET_WIDGET(_inst);
+               }
+       }
+
        _values = new float[num_ports];
+       _controllables.resize(num_ports);
        for (uint32_t i = 0; i < num_ports; ++i) {
-               bool ok;
-               uint32_t port = lv2p->nth_parameter(i, ok);
+               bool     ok;
+               uint32_t port = _lv2->nth_parameter(i, ok);
                if (ok) {
-                       _values[port] = lv2p->get_parameter(port);
-                       if (lv2p->parameter_is_control(port) && lv2p->parameter_is_input(port)) {
+                       _values[port]        = _lv2->get_parameter(port);
+                       _controllables[port] = boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (
+                               insert->control(Evoral::Parameter(PluginAutomation, 0, port)));
+
+                       if (_lv2->parameter_is_control(port) && _lv2->parameter_is_input(port)) {
                                parameter_update(port, _values[port]);
                        }
                }
        }
-               
-       _lv2->ParameterChanged.connect(mem_fun(*this, &LV2PluginUI::parameter_changed));
+}
+
+void
+LV2PluginUI::lv2ui_free()
+{
+       stop_updating (0);
+
+       if (_gui_widget) {
+               remove (*_gui_widget);
+       }
+
+       suil_instance_free((SuilInstance*)_inst);
+
+       _inst = NULL;
+       _gui_widget = NULL;
 }
 
 LV2PluginUI::~LV2PluginUI ()
 {
-       delete[] _values;
-       // plugin destructor destroys the GUI
+       if (_values) {
+               delete[] _values;
+       }
+
+       /* Close and delete GUI. */
+       lv2ui_free();
+
+       _screen_update_connection.disconnect();
+
+       if (_lv2->is_external_ui()) {
+               /* External UI is no longer valid.
+                  on_window_hide() will not try to use it if is NULL.
+               */
+               _external_ui_ptr = NULL;
+       }
 }
 
 int
-LV2PluginUI::get_preferred_height ()
+LV2PluginUI::get_preferred_height()
 {
        Gtk::Requisition r = size_request();
        return r.height;
 }
 
 int
-LV2PluginUI::get_preferred_width ()
+LV2PluginUI::get_preferred_width()
 {
        Gtk::Requisition r = size_request();
        return r.width;
 }
 
 int
-LV2PluginUI::package (Gtk::Window& win)
+LV2PluginUI::package(Gtk::Window& win)
 {
-       /* forward configure events to plugin window */
-       win.signal_configure_event().connect (mem_fun (*this, &LV2PluginUI::configure_handler));
-       win.signal_map_event().connect (mem_fun (*this, &LV2PluginUI::start_updating));
-       win.signal_unmap_event().connect (mem_fun (*this, &LV2PluginUI::stop_updating));
+       if (_external_ui_ptr) {
+               _win_ptr = &win;
+       } else {
+               /* forward configure events to plugin window */
+               win.signal_configure_event().connect(
+                       sigc::mem_fun(*this, &LV2PluginUI::configure_handler));
+               win.signal_map_event().connect(
+                       sigc::mem_fun(*this, &LV2PluginUI::start_updating));
+               win.signal_unmap_event().connect(
+                       sigc::mem_fun(*this, &LV2PluginUI::stop_updating));
+       }
        return 0;
 }
 
 bool
-LV2PluginUI::configure_handler (GdkEventConfigure* ev)
+LV2PluginUI::configure_handler(GdkEventConfigure*)
 {
-       cout << "CONFIGURE" << endl;
+       std::cout << "CONFIGURE" << std::endl;
        return false;
 }
 
 bool
-LV2PluginUI::is_update_wanted(uint32_t index)
+LV2PluginUI::is_update_wanted(uint32_t /*index*/)
 {
-       /* FIXME this should check the port notification properties, which nobody sets now anyway :) */
+       /* FIXME: use port notification properties
+          and/or new UI extension subscription methods
+       */
        return true;
 }
+
+bool
+LV2PluginUI::on_window_show(const std::string& title)
+{
+       //cout << "on_window_show - " << title << endl; flush(cout);
+
+       if (_lv2->is_external_ui()) {
+               if (_external_ui_ptr) {
+                       LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
+                       return false;
+               }
+               lv2ui_instantiate(title);
+               if (!_external_ui_ptr) {
+                       return false;
+               }
+
+               LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
+               _screen_update_connection.disconnect();
+               _screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
+                       (sigc::mem_fun(*this, &LV2PluginUI::output_update));
+               return false;
+       } else {
+               lv2ui_instantiate("gtk2gui");
+       }
+
+       return true;
+}
+
+void
+LV2PluginUI::on_window_hide()
+{
+       //cout << "on_window_hide" << endl; flush(cout);
+
+       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();
+       } else {
+               lv2ui_free();
+       }
+}