Remove over 500 unnecessary includes (including 54 of session.h).
[ardour.git] / gtk2_ardour / lv2_plugin_ui.cc
index f6718940b38fd225f0f79b54ab079f9b5bc00387..e2120e112a784fa1ea9b4023c74618c5bb0dd91e 100644 (file)
@@ -1,6 +1,6 @@
 /*
-    Copyright (C) 2008 Paul Davis
-    Author: Dave Robillard
+    Copyright (C) 2008-2012 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
     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/processor.h"
 #include "ardour/lv2_plugin.h"
+#include "ardour/session.h"
+#include "pbd/error.h"
 
 #include "ardour_ui.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;
 
-std::vector<struct lv2_external_ui*> g_external_uis;
+#define NS_UI "http://lv2plug.in/ns/extensions/ui#"
 
-void close_external_ui_windows()
-{
-       struct lv2_external_ui* external_ui_ptr;
+static SuilHost* ui_host = NULL;
 
-       //cout << "close_external_ui_windows" << endl;
+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;
+               }
 
-       while (!g_external_uis.empty()) {
-               //cout << "pop" << endl;
-               external_ui_ptr = g_external_uis.back();
-               LV2_EXTERNAL_UI_HIDE(external_ui_ptr);
-               g_external_uis.pop_back();
+               boost::shared_ptr<AutomationControl> ac = me->_controllables[port_index];
+               if (ac) {
+                       ac->set_value(*(float*)buffer);
+               }
+       } else if (format == me->_lv2->atom_eventTransfer()) {
+               me->_lv2->write_from_ui(port_index, format, buffer_size, (uint8_t*)buffer);
        }
 }
 
 void
-LV2PluginUI::lv2_ui_write(
-               LV2UI_Controller controller,
-               uint32_t         port_index,
-               uint32_t         /*buffer_size*/,
-               uint32_t         /*format*/,
-               const void*      buffer)
+LV2PluginUI::write_to_ui(void*       controller,
+                         uint32_t    port_index,
+                         uint32_t    buffer_size,
+                         uint32_t    format,
+                         const void* buffer)
 {
-       //cout << "lv2_ui_write" << endl;
        LV2PluginUI* me = (LV2PluginUI*)controller;
-       if (*(float*)buffer != me->_values[port_index]) {
-               //cout << "set_parameter " << port_index << ":"  << *(float*)buffer << endl;
-               me->_lv2->set_parameter(port_index, *(float*)buffer);
-  }
+       if (me->_inst) {
+               suil_instance_port_event((SuilInstance*)me->_inst,
+                                        port_index, buffer_size, format, buffer);
+       }
 }
 
-void LV2PluginUI::on_external_ui_closed(LV2UI_Controller controller)
+uint32_t
+LV2PluginUI::port_index(void* controller, const char* symbol)
 {
-       //cout << "on_external_ui_closed" << endl;
+       return ((LV2PluginUI*)controller)->_lv2->port_index(symbol);
+}
 
+void
+LV2PluginUI::touch(void*    controller,
+                   uint32_t port_index,
+                   bool     grabbed)
+{
        LV2PluginUI* me = (LV2PluginUI*)controller;
-       me->_screen_update_connection.disconnect();
-       //me->insert->set_gui(0);
+       if (port_index >= me->_controllables.size()) {
+               return;
+       }
 
-       for (std::vector<struct lv2_external_ui*>::iterator it = g_external_uis.begin() ; it < g_external_uis.end(); it++) {
-               if (*it == me->_external_ui_ptr) {
-                       g_external_uis.erase(it);
-               }
+       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);
+}
 
-       //slv2_ui_instance_get_descriptor(me->_inst)->cleanup(me->_inst);
+void
+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)
+LV2PluginUI::parameter_changed(uint32_t port_index, float val)
 {
-       //cout << "parameter_changed" << endl;
+       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)
 {
        if (!_inst) {
                return;
        }
 
-       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);
+       suil_instance_port_event((SuilInstance*)_inst, port_index, 4, 0, &val);
        _values[port_index] = val;
 }
 
@@ -107,7 +140,7 @@ 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));
+                       (sigc::mem_fun(*this, &LV2PluginUI::output_update));
        }
        return false;
 }
@@ -117,8 +150,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;
@@ -141,34 +173,34 @@ LV2PluginUI::output_update()
 
 }
 
-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)
-       , _inst(NULL)
+       , _gui_widget(NULL)
+       , _ardour_buttons_box(NULL)
        , _values(NULL)
        , _external_ui_ptr(NULL)
+       , _inst(NULL)
 {
-       if (!_lv2->is_external_ui()) {
-               lv2ui_instantiate("gtk2gui");
-       }
 }
 
 void
-LV2PluginUI::lv2ui_instantiate(const Glib::ustring& title)
+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;
+       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.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.URI  = LV2_EXTERNAL_UI_URI;
                _external_ui_feature.data = &_external_ui_host;
 
                features_src = features = (LV2_Feature**)_lv2->features();
@@ -176,8 +208,8 @@ LV2PluginUI::lv2ui_instantiate(const Glib::ustring& title)
                while (*features++) {
                        features_count++;
                }
-
-               features_dst = features = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * 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--) {
@@ -187,17 +219,39 @@ LV2PluginUI::lv2ui_instantiate(const Glib::ustring& title)
                features_dst = (LV2_Feature**)_lv2->features();
        }
 
-       _inst = slv2_ui_instantiate(
-                       _lv2->slv2_plugin(), _lv2->slv2_ui(), LV2PluginUI::lv2_ui_write, this,
-                       features_dst);
+       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";
+
+       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);
        }
 
-       uint32_t num_ports = slv2_plugin_get_num_ports(_lv2->slv2_plugin());
+#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) && is_update_wanted(i)) {
+               if (_lv2->parameter_is_output(i)
+                   && _lv2->parameter_is_control(i)
+                   && is_update_wanted(i)) {
                        _output_ports.push_back(i);
                }
        }
@@ -205,72 +259,130 @@ LV2PluginUI::lv2ui_instantiate(const Glib::ustring& 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);
+                       _ardour_buttons_box = manage (new Gtk::HBox);
+                       _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->show_all();
+                       pack_start(*_ardour_buttons_box, false, false);
+
+                       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;
+                       }
+                       _gui_widget = Gtk::manage(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);
-                       g_external_uis.push_back(_external_ui_ptr);
+                       _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;
+               bool     ok;
                uint32_t port = _lv2->nth_parameter(i, ok);
                if (ok) {
-                       _values[port] = _lv2->get_parameter(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));
+       if (_lv2->has_message_output()) {
+               _lv2->enable_ui_emmission();
+               ARDOUR_UI::instance()->RapidScreenUpdate.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;
        }
-       // plugin destructor destroys the GTK GUI
+
+       /* 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;
 }
 
+bool
+LV2PluginUI::resizable()
+{
+       return _lv2->ui_is_resizable();
+}
+
 int
-LV2PluginUI::package (Gtk::Window& win)
+LV2PluginUI::package(Gtk::Window& win)
 {
-       //cout << "package" << endl;
        if (_external_ui_ptr) {
                _win_ptr = &win;
        } else {
                /* 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));
+               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*)
+LV2PluginUI::configure_handler(GdkEventConfigure*)
 {
        std::cout << "CONFIGURE" << std::endl;
        return false;
@@ -279,12 +391,14 @@ LV2PluginUI::configure_handler (GdkEventConfigure*)
 bool
 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 Glib::ustring& title)
+LV2PluginUI::on_window_show(const std::string& title)
 {
        //cout << "on_window_show - " << title << endl; flush(cout);
 
@@ -301,8 +415,10 @@ LV2PluginUI::on_window_show(const Glib::ustring& title)
                LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
                _screen_update_connection.disconnect();
                _screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
-                       (mem_fun(*this, &LV2PluginUI::output_update));
+                       (sigc::mem_fun(*this, &LV2PluginUI::output_update));
                return false;
+       } else {
+               lv2ui_instantiate("gtk2gui");
        }
 
        return true;
@@ -318,5 +434,7 @@ LV2PluginUI::on_window_hide()
                //slv2_ui_instance_get_descriptor(_inst)->cleanup(_inst);
                //_external_ui_ptr = NULL;
                //_screen_update_connection.disconnect();
+       } else {
+               lv2ui_free();
        }
 }