gtk2_ardour/lv2_plugin_ui.cc

   1 /*
   2     Copyright (C) 2008-2012 Paul Davis
   3     Author: David Robillard
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #include "ardour/lv2_plugin.h"
  21 #include "ardour/session.h"
  22 #include "pbd/error.h"
  23 #include "pbd/stacktrace.h"
  24
  25 #include "gui_thread.h"
  26 #include "lv2_plugin_ui.h"
  27 #include "timers.h"
  28
  29 #include "lv2/lv2plug.in/ns/extensions/ui/ui.h"
  30
  31 #include <lilv/lilv.h>
  32 #include <suil/suil.h>
  33
  34 #include "i18n.h"
  35
  36 using namespace ARDOUR;
  37 using namespace Gtk;
  38 using namespace PBD;
  39
  40 #define NS_UI "http://lv2plug.in/ns/extensions/ui#"
  41
  42 static SuilHost* ui_host = NULL;
  43
  44 void
  45 LV2PluginUI::write_from_ui(void*       controller,
  46                            uint32_t    port_index,
  47                            uint32_t    buffer_size,
  48                            uint32_t    format,
  49                            const void* buffer)
  50 {
  51         LV2PluginUI* me = (LV2PluginUI*)controller;
  52         if (format == 0) {
  53                 if (port_index >= me->_controllables.size()) {
  54                         return;
  55                 }
  56
  57                 boost::shared_ptr<AutomationControl> ac = me->_controllables[port_index];
  58                 /* Cache our local copy of the last value received from the GUI */
  59                 me->_values[port_index] = *(const float*) buffer;
  60                 /* Now update the control itself */
  61                 if (ac) {
  62                         ac->set_value(*(const float*)buffer);
  63                 }
  64         } else if (format == URIMap::instance().urids.atom_eventTransfer) {
  65
  66                 const int cnt = me->_pi->get_count();
  67                 for (int i=0; i < cnt; i++ ) {
  68                         boost::shared_ptr<LV2Plugin> lv2i = boost::dynamic_pointer_cast<LV2Plugin> (me->_pi->plugin(i));
  69                         lv2i->write_from_ui(port_index, format, buffer_size, (const uint8_t*)buffer);
  70                 }
  71         }
  72 }
  73
  74 void
  75 LV2PluginUI::write_to_ui(void*       controller,
  76                          uint32_t    port_index,
  77                          uint32_t    buffer_size,
  78                          uint32_t    format,
  79                          const void* buffer)
  80 {
  81         LV2PluginUI* me = (LV2PluginUI*)controller;
  82         if (me->_inst) {
  83                 suil_instance_port_event((SuilInstance*)me->_inst,
  84                                          port_index, buffer_size, format, buffer);
  85         }
  86 }
  87
  88 uint32_t
  89 LV2PluginUI::port_index(void* controller, const char* symbol)
  90 {
  91         return ((LV2PluginUI*)controller)->_lv2->port_index(symbol);
  92 }
  93
  94 void
  95 LV2PluginUI::touch(void*    controller,
  96                    uint32_t port_index,
  97                    bool     grabbed)
  98 {
  99         LV2PluginUI* me = (LV2PluginUI*)controller;
 100         if (port_index >= me->_controllables.size()) {
 101                 return;
 102         }
 103
 104         ControllableRef control = me->_controllables[port_index];
 105         if (grabbed) {
 106                 control->start_touch(control->session().transport_frame());
 107         } else {
 108                 control->stop_touch(false, control->session().transport_frame());
 109         }
 110 }
 111
 112 void
 113 LV2PluginUI::update_timeout()
 114 {
 115         _lv2->emit_to_ui(this, &LV2PluginUI::write_to_ui);
 116 }
 117
 118 void
 119 LV2PluginUI::on_external_ui_closed(void* controller)
 120 {
 121         //printf("LV2PluginUI::on_external_ui_closed\n");
 122         LV2PluginUI* me = (LV2PluginUI*)controller;
 123         me->_screen_update_connection.disconnect();
 124         me->_external_ui_ptr = NULL;
 125 }
 126
 127 void
 128 LV2PluginUI::control_changed (uint32_t port_index)
 129 {
 130         /* Must run in GUI thread because we modify _updates with no lock */
 131         if (_lv2->get_parameter (port_index) != _values[port_index]) {
 132                 /* current plugin parameter does not match last value received
 133                    from GUI, so queue an update to push it to the GUI during
 134                    our regular timeout.
 135                 */
 136                 _updates.insert (port_index);
 137         }
 138 }
 139
 140 bool
 141 LV2PluginUI::start_updating(GdkEventAny*)
 142 {
 143         if (!_output_ports.empty()) {
 144                 _screen_update_connection.disconnect();
 145                 _screen_update_connection = Timers::super_rapid_connect
 146                         (sigc::mem_fun(*this, &LV2PluginUI::output_update));
 147         }
 148         return false;
 149 }
 150
 151 bool
 152 LV2PluginUI::stop_updating(GdkEventAny*)
 153 {
 154         //cout << "stop_updating" << endl;
 155
 156         if (!_output_ports.empty()) {
 157                 _screen_update_connection.disconnect();
 158         }
 159         return false;
 160 }
 161
 162 void
 163 LV2PluginUI::output_update()
 164 {
 165         //cout << "output_update" << endl;
 166         if (_external_ui_ptr) {
 167                 LV2_EXTERNAL_UI_RUN(_external_ui_ptr);
 168                 if (_lv2->is_external_kx() && !_external_ui_ptr) {
 169                         // clean up external UI if it closes itself via
 170                         // on_external_ui_closed() during run()
 171                         //printf("LV2PluginUI::output_update -- UI was closed\n");
 172                         //_screen_update_connection.disconnect();
 173                         _message_update_connection.disconnect();
 174                         if (_inst) {
 175                                 suil_instance_free((SuilInstance*)_inst);
 176                         }
 177                         _inst = NULL;
 178                         _external_ui_ptr = NULL;
 179                         return;
 180                 }
 181         }
 182
 183         if (_inst) {
 184                 for (Updates::iterator i = _updates.begin(); i != _updates.end(); ++i) {
 185                         float val = _lv2->get_parameter (*i);
 186                         /* push current value to the GUI */
 187                         suil_instance_port_event ((SuilInstance*)_inst, (*i), 4, 0, &val);
 188                 }
 189                 _updates.clear ();
 190         }
 191 }
 192
 193 LV2PluginUI::LV2PluginUI(boost::shared_ptr<PluginInsert> pi,
 194                          boost::shared_ptr<LV2Plugin>    lv2p)
 195         : PlugUIBase(pi)
 196         , _pi(pi)
 197         , _lv2(lv2p)
 198         , _gui_widget(NULL)
 199         , _values(NULL)
 200         , _external_ui_ptr(NULL)
 201         , _inst(NULL)
 202 {
 203         _ardour_buttons_box.set_spacing (6);
 204         _ardour_buttons_box.set_border_width (6);
 205         _ardour_buttons_box.pack_end (focus_button, false, false);
 206         _ardour_buttons_box.pack_end (bypass_button, false, false, 4);
 207         _ardour_buttons_box.pack_end (reset_button, false, false, 4);
 208         _ardour_buttons_box.pack_end (delete_button, false, false);
 209         _ardour_buttons_box.pack_end (save_button, false, false);
 210         _ardour_buttons_box.pack_end (add_button, false, false);
 211         _ardour_buttons_box.pack_end (_preset_combo, false, false);
 212         _ardour_buttons_box.pack_end (_preset_modified, false, false);
 213 }
 214
 215 void
 216 LV2PluginUI::lv2ui_instantiate(const std::string& title)
 217 {
 218         bool          is_external_ui = _lv2->is_external_ui();
 219         LV2_Feature** features_src   = const_cast<LV2_Feature**>(_lv2->features());
 220         LV2_Feature** features       = const_cast<LV2_Feature**>(_lv2->features());
 221         size_t        features_count = 0;
 222         while (*features++) {
 223                 features_count++;
 224         }
 225
 226         Gtk::Alignment* container = NULL;
 227         if (is_external_ui) {
 228                 _external_ui_host.ui_closed       = LV2PluginUI::on_external_ui_closed;
 229                 _external_ui_host.plugin_human_id = strdup(title.c_str());
 230
 231                 _external_ui_feature.URI  = LV2_EXTERNAL_UI_URI;
 232                 _external_ui_feature.data = &_external_ui_host;
 233
 234                 _external_kxui_feature.URI  = LV2_EXTERNAL_UI_KX__Host;
 235                 _external_kxui_feature.data = &_external_ui_host;
 236
 237                 ++features_count;
 238                 features = (LV2_Feature**)malloc(
 239                         sizeof(LV2_Feature*) * (features_count + 2));
 240                 for (size_t i = 0; i < features_count - 2; ++i) {
 241                         features[i] = features_src[i];
 242                 }
 243                 features[features_count - 2] = &_external_kxui_feature;
 244                 features[features_count - 1] = &_external_ui_feature;
 245                 features[features_count]     = NULL;
 246         } else {
 247                 if (_ardour_buttons_box.get_parent()) {
 248                         _ardour_buttons_box.get_parent()->remove(_ardour_buttons_box);
 249                 }
 250                 pack_start(_ardour_buttons_box, false, false);
 251                 _ardour_buttons_box.show_all();
 252
 253                 _gui_widget = Gtk::manage((container = new Gtk::Alignment()));
 254                 pack_start(*_gui_widget, true, true);
 255                 _gui_widget->show();
 256
 257                 _parent_feature.URI  = LV2_UI__parent;
 258                 _parent_feature.data = _gui_widget->gobj();
 259
 260                 ++features_count;
 261                 features = (LV2_Feature**)malloc(
 262                         sizeof(LV2_Feature*) * (features_count + 1));
 263                 for (size_t i = 0; i < features_count - 1; ++i) {
 264                         features[i] = features_src[i];
 265                 }
 266                 features[features_count - 1] = &_parent_feature;
 267                 features[features_count]     = NULL;
 268         }
 269
 270         if (!ui_host) {
 271                 ui_host = suil_host_new(LV2PluginUI::write_from_ui,
 272                                         LV2PluginUI::port_index,
 273                                         NULL, NULL);
 274                 suil_host_set_touch_func(ui_host, LV2PluginUI::touch);
 275         }
 276         const char* container_type = (is_external_ui)
 277                 ? NS_UI "external"
 278                 : NS_UI "GtkUI";
 279
 280         if (_lv2->has_message_output()) {
 281                 _lv2->enable_ui_emission();
 282         }
 283
 284         const LilvUI*   ui     = (const LilvUI*)_lv2->c_ui();
 285         const LilvNode* bundle = lilv_ui_get_bundle_uri(ui);
 286         const LilvNode* binary = lilv_ui_get_binary_uri(ui);
 287 #ifdef HAVE_LILV_0_21_3
 288         char* ui_bundle_path = lilv_file_uri_parse(lilv_node_as_uri(bundle), NULL);
 289         char* ui_binary_path = lilv_file_uri_parse(lilv_node_as_uri(binary), NULL);
 290 #else
 291         char* ui_bundle_path = strdup(lilv_uri_to_path(lilv_node_as_uri(bundle)));
 292         char* ui_binary_path = strdup(lilv_uri_to_path(lilv_node_as_uri(binary)));
 293 #endif
 294         if (!ui_bundle_path || !ui_binary_path) {
 295                 error << _("failed to get path for UI bindle or binary") << endmsg;
 296                 free(ui_bundle_path);
 297                 free(ui_binary_path);
 298                 free(features);
 299                 return;
 300         }
 301
 302         _inst = suil_instance_new(
 303                 ui_host,
 304                 this,
 305                 container_type,
 306                 _lv2->uri(),
 307                 lilv_node_as_uri(lilv_ui_get_uri(ui)),
 308                 lilv_node_as_uri((const LilvNode*)_lv2->c_ui_type()),
 309                 ui_bundle_path,
 310                 ui_binary_path,
 311                 features);
 312
 313         free(ui_bundle_path);
 314         free(ui_binary_path);
 315         free(features);
 316
 317         if (!_inst) {
 318                 error << _("failed to instantiate LV2 GUI") << endmsg;
 319                 return;
 320         }
 321
 322 #define GET_WIDGET(inst) suil_instance_get_widget((SuilInstance*)inst);
 323
 324         const uint32_t num_ports = _lv2->num_ports();
 325         for (uint32_t i = 0; i < num_ports; ++i) {
 326                 if (_lv2->parameter_is_output(i)
 327                     && _lv2->parameter_is_control(i)
 328                     && is_update_wanted(i)) {
 329                         _output_ports.push_back(i);
 330                 }
 331         }
 332
 333         _external_ui_ptr = NULL;
 334         if (!is_external_ui) {
 335                 GtkWidget* c_widget = (GtkWidget*)GET_WIDGET(_inst);
 336                 if (!c_widget) {
 337                         error << _("failed to get LV2 UI widget") << endmsg;
 338                         suil_instance_free((SuilInstance*)_inst);
 339                         _inst = NULL;
 340                         return;
 341                 }
 342                 if (!container->get_child()) {
 343                         // Suil didn't add the UI to the container for us, so do it now
 344                         container->add(*Gtk::manage(Glib::wrap(c_widget)));
 345                 }
 346                 container->show_all();
 347                 gtk_widget_set_can_focus(c_widget, true);
 348                 gtk_widget_grab_focus(c_widget);
 349         } else {
 350                 _external_ui_ptr = (struct lv2_external_ui*)GET_WIDGET(_inst);
 351         }
 352
 353         _values = new float[num_ports];
 354         _controllables.resize(num_ports);
 355         for (uint32_t i = 0; i < num_ports; ++i) {
 356                 bool     ok;
 357                 uint32_t port = _lv2->nth_parameter(i, ok);
 358                 if (ok) {
 359                         _controllables[port] = boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (
 360                                 insert->control(Evoral::Parameter(PluginAutomation, 0, port)));
 361
 362                         /* FIXME only works with control output ports (which is all we support now anyway) */
 363                         if (_controllables[port] && _lv2->parameter_is_control(port) && _lv2->parameter_is_input(port)) {
 364                                 _controllables[port]->Changed.connect (control_connections, invalidator (*this), boost::bind (&LV2PluginUI::control_changed, this, port), gui_context());
 365                                 /* queue for first update ("push") to GUI */
 366                                 _updates.insert (port);
 367                         }
 368                 }
 369         }
 370
 371         if (_lv2->has_message_output()) {
 372                 _message_update_connection = Timers::super_rapid_connect (
 373                         sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
 374         }
 375 }
 376
 377 void
 378 LV2PluginUI::grab_focus()
 379 {
 380         if (_inst && !_lv2->is_external_ui()) {
 381                 GtkWidget* c_widget = (GtkWidget*)GET_WIDGET(_inst);
 382                 gtk_widget_grab_focus(c_widget);
 383         }
 384 }
 385
 386 void
 387 LV2PluginUI::lv2ui_free()
 388 {
 389         stop_updating (0);
 390
 391         if (_gui_widget) {
 392                 remove (*_gui_widget);
 393                 _gui_widget = NULL;
 394         }
 395
 396         if (_inst) {
 397                 suil_instance_free((SuilInstance*)_inst);
 398                 _inst = NULL;
 399         }
 400 }
 401
 402 LV2PluginUI::~LV2PluginUI ()
 403 {
 404         delete [] _values;
 405
 406         _message_update_connection.disconnect();
 407         _screen_update_connection.disconnect();
 408
 409         if (_external_ui_ptr && _lv2->is_external_kx()) {
 410                 LV2_EXTERNAL_UI_HIDE(_external_ui_ptr);
 411         }
 412         lv2ui_free();
 413         _external_ui_ptr = NULL;
 414 }
 415
 416 int
 417 LV2PluginUI::get_preferred_height()
 418 {
 419         Gtk::Requisition r = size_request();
 420         return r.height;
 421 }
 422
 423 int
 424 LV2PluginUI::get_preferred_width()
 425 {
 426         Gtk::Requisition r = size_request();
 427         return r.width;
 428 }
 429
 430 bool
 431 LV2PluginUI::resizable()
 432 {
 433         return _lv2->ui_is_resizable();
 434 }
 435
 436 int
 437 LV2PluginUI::package(Gtk::Window& win)
 438 {
 439         if (_external_ui_ptr) {
 440                 _win_ptr = &win;
 441         } else {
 442                 /* forward configure events to plugin window */
 443                 win.signal_configure_event().connect(
 444                         sigc::mem_fun(*this, &LV2PluginUI::configure_handler));
 445                 win.signal_map_event().connect(
 446                         sigc::mem_fun(*this, &LV2PluginUI::start_updating));
 447                 win.signal_unmap_event().connect(
 448                         sigc::mem_fun(*this, &LV2PluginUI::stop_updating));
 449         }
 450         return 0;
 451 }
 452
 453 bool
 454 LV2PluginUI::configure_handler(GdkEventConfigure*)
 455 {
 456         std::cout << "CONFIGURE" << std::endl;
 457         return false;
 458 }
 459
 460 bool
 461 LV2PluginUI::is_update_wanted(uint32_t /*index*/)
 462 {
 463         /* FIXME: use port notification properties
 464            and/or new UI extension subscription methods
 465         */
 466         return true;
 467 }
 468
 469 bool
 470 LV2PluginUI::on_window_show(const std::string& title)
 471 {
 472         //cout << "on_window_show - " << title << endl; flush(cout);
 473
 474         if (_lv2->is_external_ui()) {
 475                 if (_external_ui_ptr) {
 476                         _screen_update_connection.disconnect();
 477                         _message_update_connection.disconnect();
 478                         LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
 479                         _screen_update_connection = Timers::super_rapid_connect
 480                         (sigc::mem_fun(*this, &LV2PluginUI::output_update));
 481                         if (_lv2->has_message_output()) {
 482                                 _message_update_connection = Timers::super_rapid_connect (
 483                                         sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
 484                         }
 485                         return false;
 486                 }
 487                 lv2ui_instantiate(title);
 488                 if (!_external_ui_ptr) {
 489                         return false;
 490                 }
 491
 492                 _screen_update_connection.disconnect();
 493                 _message_update_connection.disconnect();
 494                 LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
 495                 _screen_update_connection = Timers::super_rapid_connect
 496                         (sigc::mem_fun(*this, &LV2PluginUI::output_update));
 497                 if (_lv2->has_message_output()) {
 498                         _message_update_connection = Timers::super_rapid_connect (
 499                                 sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
 500                 }
 501                 return false;
 502         } else {
 503                 lv2ui_instantiate("gtk2gui");
 504         }
 505
 506         return _inst ? true : false;
 507 }
 508
 509 void
 510 LV2PluginUI::on_window_hide()
 511 {
 512         //printf("LV2PluginUI::on_window_hide\n");
 513
 514         if (_lv2->is_external_ui()) {
 515                 if (!_external_ui_ptr) { return; }
 516                 LV2_EXTERNAL_UI_HIDE(_external_ui_ptr);
 517                 if (!_lv2->is_external_kx()) { return ; }
 518                 _message_update_connection.disconnect();
 519                 _screen_update_connection.disconnect();
 520                 _external_ui_ptr = NULL;
 521                 suil_instance_free((SuilInstance*)_inst);
 522                 _inst = NULL;
 523         } else {
 524                 lv2ui_free();
 525         }
 526 }