LV2 external UI patch from nedko (#2777)

git-svn-id: svn://localhost/ardour2/branches/2.0-ongoing@5697 d708f5d6-7413-0410-9779-e7cbd77b26cf

diff --git a/gtk2_ardour/lv2_plugin_ui.cc b/gtk2_ardour/lv2_plugin_ui.cc
index 26a70743860e263b2f9cb3ffe25527a87c37a2bd..7fb2c87b055b1befd6b05ad942237d2f83391fa9 100644 (file)
--- a/gtk2_ardour/lv2_plugin_ui.cc
+++ b/gtk2_ardour/lv2_plugin_ui.cc
@@ -28,6 +28,22 @@ using namespace Gtk;
 using namespace ARDOUR;
 using namespace PBD;
 
+std::vector<struct lv2_external_ui*> g_external_uis;
+
+void close_external_ui_windows()
+{
+       struct lv2_external_ui* external_ui_ptr;
+
+       //cout << "close_external_ui_windows" << endl;
+
+       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();
+       }
+}
+
 void
 LV2PluginUI::lv2_ui_write(LV2UI_Controller controller,
              uint32_t         port_index,
@@ -35,14 +51,36 @@ LV2PluginUI::lv2_ui_write(LV2UI_Controller controller,
              uint32_t         format,
              const void*      buffer)
 {
+       //cout << "lv2_ui_write" << endl;
        LV2PluginUI* me = (LV2PluginUI*)controller;
-       if (*(float*)buffer != me->_values[port_index])
+       if (*(float*)buffer != me->_values[port_index]) {
+               //cout << "set_parameter " << port_index << ":"  << *(float*)buffer << endl;
                me->_lv2->set_parameter(port_index, *(float*)buffer);
+  }
+}
+
+void LV2PluginUI::on_external_ui_closed(LV2UI_Controller controller)
+{
+       //cout << "on_external_ui_closed" << endl;
+
+       LV2PluginUI* me = (LV2PluginUI*)controller;
+       me->_screen_update_connection.disconnect();
+       //me->insert->set_gui(0);
+
+       for (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);
+               }
+       }
+
+       //slv2_ui_instance_get_descriptor(me->_inst)->cleanup(me->_inst);
+       me->_external_ui_ptr = NULL;
 }
 
 void
 LV2PluginUI::parameter_changed (uint32_t port_index, float val)
 {
+       //cout << "parameter_changed" << endl;
        if (val != _values[port_index]) {
                parameter_update(port_index, val);
        }
@@ -51,16 +89,24 @@ LV2PluginUI::parameter_changed (uint32_t port_index, float val)
 void
 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)
+       if (ui_desc->port_event) {
+               //cout << "port_event " << port_index << ":" << val << endl;
                ui_desc->port_event(ui_handle, port_index, 4, 0, &val);
+  }
        _values[port_index] = val;
 }
 
 bool
 LV2PluginUI::start_updating(GdkEventAny* event)
 {
+       //cout << "start_updating" << endl;
+
        if (!_output_ports.empty()) {
                _screen_update_connection.disconnect();
                _screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect 
@@ -72,7 +118,10 @@ LV2PluginUI::start_updating(GdkEventAny* event)
 bool
 LV2PluginUI::stop_updating(GdkEventAny* event)
 {
-       if (!_output_ports.empty()) {
+       //cout << "stop_updating" << endl;
+
+       if (//!_external_ui_ptr &&
+                       !_output_ports.empty()) {
                _screen_update_connection.disconnect();
        }
        return false;
@@ -81,6 +130,11 @@ 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) {
@@ -93,30 +147,84 @@ LV2PluginUI::output_update()
 LV2PluginUI::LV2PluginUI (boost::shared_ptr<PluginInsert> pi, boost::shared_ptr<LV2Plugin> lv2p)
        : PlugUIBase (pi)
        , _lv2(lv2p)
+       , _inst(NULL)
+       , _values(NULL)
+       , _external_ui_ptr(NULL)
+{
+       if (!_lv2->is_external_ui()) {
+               lv2ui_instantiate("gtk2gui");
+       }
+}
+
+void
+LV2PluginUI::lv2ui_instantiate(const Glib::ustring& 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();
+
+       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();
+       }
+
        _inst = slv2_ui_instantiate(
                        _lv2->slv2_plugin(), _lv2->slv2_ui(), LV2PluginUI::lv2_ui_write, this,
-                       _lv2->features());
+                       features_dst);
+
+       if (is_external_ui) {
+               free(features_dst);
+       }
                        
-       uint32_t num_ports = slv2_plugin_get_num_ports(lv2p->slv2_plugin());
+       uint32_t num_ports = slv2_plugin_get_num_ports(_lv2->slv2_plugin());
        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) {
+                       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);
+               } else {
+                       _external_ui_ptr = (struct lv2_external_ui *)slv2_ui_instance_get_widget(_inst);
+                       g_external_uis.push_back(_external_ui_ptr);
+               }
+       }
        
        _values = new float[num_ports];
        for (uint32_t i = 0; i < num_ports; ++i) {
                bool ok;
-               uint32_t port = lv2p->nth_parameter(i, 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);
+                       if (_lv2->parameter_is_control(port) && _lv2->parameter_is_input(port)) {
                                parameter_update(port, _values[port]);
                        }
                }
@@ -127,8 +235,12 @@ LV2PluginUI::LV2PluginUI (boost::shared_ptr<PluginInsert> pi, boost::shared_ptr<
 
 LV2PluginUI::~LV2PluginUI ()
 {
-       delete[] _values;
-       // plugin destructor destroys the GUI
+       //cout << "LV2PluginUI destructor called" << endl;
+
+       if (_values) {
+               delete[] _values;
+       }
+       // plugin destructor destroys the GTK GUI
 }
 
 int
@@ -148,10 +260,15 @@ LV2PluginUI::get_preferred_width ()
 int
 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));
+       //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));
+       }
        return 0;
 }
 
@@ -168,3 +285,41 @@ LV2PluginUI::is_update_wanted(uint32_t index)
        /* FIXME this should check the port notification properties, which nobody sets now anyway :) */
        return true;
 }
+
+bool
+LV2PluginUI::on_window_show(const Glib::ustring& 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 
+                       (mem_fun(*this, &LV2PluginUI::output_update));
+               return false;
+       }
+
+       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();
+       }
+}

diff --git a/gtk2_ardour/lv2_plugin_ui.h b/gtk2_ardour/lv2_plugin_ui.h
index fe8dd85cd227c6a85bf6daa96dda2bfed8b09d56..9bb1fe60aedf36189311144431c4aea99135e598 100644 (file)
--- a/gtk2_ardour/lv2_plugin_ui.h
+++ b/gtk2_ardour/lv2_plugin_ui.h
@@ -34,6 +34,8 @@
 
 #ifdef HAVE_LV2
 
+#include "lv2_external_ui.h"
+
 namespace ARDOUR {
        class PluginInsert;
        class LV2Plugin;
@@ -60,6 +62,13 @@ class LV2PluginUI : public PlugUIBase, public Gtk::VBox
        Gtk::Widget*   _gui_widget;
        SLV2UIInstance _inst;
        float*         _values;
+
+       struct lv2_external_ui_host _external_ui_host;
+       LV2_Feature _external_ui_feature;
+       struct lv2_external_ui* _external_ui_ptr;
+       Gtk::Window* _win_ptr;
+
+       static void on_external_ui_closed(LV2UI_Controller controller);
        
        static void lv2_ui_write(
                        LV2UI_Controller controller,
@@ -68,12 +77,17 @@ class LV2PluginUI : public PlugUIBase, public Gtk::VBox
                        uint32_t         format,
                        const void*      buffer);
        
+       void lv2ui_instantiate(const Glib::ustring& title);
+
        void parameter_changed(uint32_t, float);
        void parameter_update(uint32_t, float);
        bool configure_handler (GdkEventConfigure*);
        void save_plugin_setting ();
        void output_update();
        bool is_update_wanted(uint32_t index);
+
+       virtual bool on_window_show(const Glib::ustring& title);
+       virtual void on_window_hide();
 };
 #endif // HAVE_LV2
 

diff --git a/gtk2_ardour/main.cc b/gtk2_ardour/main.cc
index e0df2eadcfa7b59e168e2f4599758c5489f656a4..5e92112cff6ef9b51739a9f1ca67c3e9cd0d8d3a 100644 (file)
--- a/gtk2_ardour/main.cc
+++ b/gtk2_ardour/main.cc
@@ -285,6 +285,10 @@ sigpipe_handler (int sig)
        }
 }
 
+#ifdef HAVE_LV2
+void close_external_ui_windows();
+#endif
+
 #ifdef VST_SUPPORT
 
 extern int gui_init (int* argc, char** argv[]);
@@ -386,6 +390,9 @@ int main (int argc, char* argv[])
 
        ARDOUR::cleanup ();
        pthread_cancel_all ();
+#ifdef HAVE_LV2
+       close_external_ui_windows();
+#endif
        return 0;
 }
 #ifdef VST_SUPPORT

diff --git a/gtk2_ardour/plugin_ui.cc b/gtk2_ardour/plugin_ui.cc
index 6954e2296b73872f4c79d5b320716b96ad3b5147..17c806f915f3627baaaea69d2d0fb5a88c53d70b 100644 (file)
--- a/gtk2_ardour/plugin_ui.cc
+++ b/gtk2_ardour/plugin_ui.cc
@@ -190,11 +190,17 @@ PluginUIWindow::on_focus_out_event (GdkEventFocus *ev)
 void
 PluginUIWindow::on_show ()
 {
+       set_role("plugin_ui");
+
        if (_pluginui) {
                _pluginui->update_presets ();
        }
 
-       Window::on_show ();
+       if (_pluginui) {
+               if (_pluginui->on_window_show (_title)) {
+                       Window::on_show ();
+               }
+       }
 
        if (parent) {
                // set_transient_for (*parent);
@@ -205,6 +211,18 @@ void
 PluginUIWindow::on_hide ()
 {
        Window::on_hide ();
+
+       if (_pluginui) {
+               _pluginui->on_window_hide ();
+       }
+}
+
+void
+PluginUIWindow::set_title(const Glib::ustring& title)
+{
+       //cout << "PluginUIWindow::set_title(\"" << title << "\"" << endl;
+       Gtk::Window::set_title(title);
+       _title = title;
 }
 
 bool

diff --git a/gtk2_ardour/plugin_ui.h b/gtk2_ardour/plugin_ui.h
index 3e027b620ede2c2e253d49cd762091347c5659ec..887bd6ccc14a5bdb5a95af894efdeda954e1959c 100644 (file)
--- a/gtk2_ardour/plugin_ui.h
+++ b/gtk2_ardour/plugin_ui.h
@@ -82,6 +82,9 @@ class PlugUIBase : public virtual sigc::trackable
 
        virtual void update_presets ();
 
+       virtual bool on_window_show(const Glib::ustring& title) { return true; }
+       virtual void on_window_hide() {}
+
   protected:
        boost::shared_ptr<ARDOUR::PluginInsert> insert;
        boost::shared_ptr<ARDOUR::Plugin> plugin;
@@ -230,8 +233,10 @@ class PluginUIWindow : public Gtk::Window
        void on_hide ();
        void on_map ();
 
+       void set_title(const Glib::ustring& title);
 
   private:
+       Glib::ustring _title;
        PlugUIBase* _pluginui;
        sigc::connection death_connection;
        Gtk::Window* parent;

diff --git a/libs/ardour/ardour/lv2_plugin.h b/libs/ardour/ardour/lv2_plugin.h
index de8eb616a12d9be954ce946b7b48a684ca4acaaa..29f3465f8bdb68438564b4c642da886e3dd9dc90 100644 (file)
--- a/libs/ardour/ardour/lv2_plugin.h
+++ b/libs/ardour/ardour/lv2_plugin.h
@@ -64,6 +64,7 @@ class LV2Plugin : public ARDOUR::Plugin
 
        SLV2Plugin slv2_plugin()         { return _plugin; }
        SLV2UI     slv2_ui()             { return _ui; }
+       bool       is_external_ui() const;
        SLV2Port   slv2_port(uint32_t i) { return slv2_plugin_get_port_by_index(_plugin, i); }
 
        const char* port_symbol(uint32_t port);
@@ -159,6 +160,7 @@ struct LV2World {
        SLV2Value toggled;
        SLV2Value srate;
        SLV2Value gtk_gui;
+       SLV2Value external_gui;
 };
 
 

diff --git a/libs/ardour/lv2_plugin.cc b/libs/ardour/lv2_plugin.cc
index 1c850ea2293da9aac8e08159065d01f585ebf042..d948c721405b9ecc220d3bc2887a7dfc7fc455da 100644 (file)
--- a/libs/ardour/lv2_plugin.cc
+++ b/libs/ardour/lv2_plugin.cc
@@ -149,6 +149,17 @@ LV2Plugin::init (LV2World& world, SLV2Plugin plugin, nframes_t rate)
                                break;
                        }
                }
+
+               // if gtk gui is not available, try to find external gui
+               if (!_ui) {
+                       for (unsigned i=0; i < slv2_uis_size(uis); ++i) {
+                               SLV2UI ui = slv2_uis_get_at(uis, i);
+                               if (slv2_ui_is_a(ui, _world.external_gui)) {
+                                       _ui = ui;
+                                       break;
+                               }
+                       }
+               }
        }
 
        Plugin::setup_controls ();
@@ -176,6 +187,12 @@ LV2Plugin::~LV2Plugin ()
        }
 }
 
+bool
+LV2Plugin::is_external_ui() const
+{
+       return slv2_ui_is_a(_ui, _world.external_gui);
+}
+
 string
 LV2Plugin::unique_id() const
 {
@@ -552,6 +569,7 @@ LV2World::LV2World()
        toggled = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
        srate = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
        gtk_gui = slv2_value_new_uri(world, "http://lv2plug.in/ns/extensions/ui#GtkUI");
+       external_gui = slv2_value_new_uri(world, "http://lv2plug.in/ns/extensions/ui#external");
 }
 
 LV2World::~LV2World()