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 "pbd/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
  59                 me->_updates.insert (port_index);
  60
  61                 if (ac) {
  62                         ac->set_value(*(const float*)buffer, Controllable::NoGroup);
  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_last_sent_to_ui[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         _screen_update_connection.disconnect();
 144         _screen_update_connection = Timers::super_rapid_connect
 145                 (sigc::mem_fun(*this, &LV2PluginUI::output_update));
 146         return false;
 147 }
 148
 149 bool
 150 LV2PluginUI::stop_updating(GdkEventAny*)
 151 {
 152         //cout << "stop_updating" << endl;
 153         _screen_update_connection.disconnect();
 154         return false;
 155 }
 156
 157 void
 158 LV2PluginUI::queue_port_update()
 159 {
 160         const uint32_t num_ports = _lv2->num_ports();
 161         for (uint32_t i = 0; i < num_ports; ++i) {
 162                 bool     ok;
 163                 uint32_t port = _lv2->nth_parameter(i, ok);
 164                 if (ok) {
 165                         _updates.insert (port);
 166                 }
 167         }
 168 }
 169
 170 void
 171 LV2PluginUI::output_update()
 172 {
 173         //cout << "output_update" << endl;
 174         if (_external_ui_ptr) {
 175                 LV2_EXTERNAL_UI_RUN(_external_ui_ptr);
 176                 if (_lv2->is_external_kx() && !_external_ui_ptr) {
 177                         // clean up external UI if it closes itself via
 178                         // on_external_ui_closed() during run()
 179                         //printf("LV2PluginUI::output_update -- UI was closed\n");
 180                         //_screen_update_connection.disconnect();
 181                         _message_update_connection.disconnect();
 182                         if (_inst) {
 183                                 suil_instance_free((SuilInstance*)_inst);
 184                         }
 185                         _inst = NULL;
 186                         _external_ui_ptr = NULL;
 187                         return;
 188                 }
 189         }
 190
 191         if (!_inst) {
 192                 return;
 193         }
 194
 195         /* output ports (values set by DSP) need propagating to GUI */
 196
 197         uint32_t nports = _output_ports.size();
 198         for (uint32_t i = 0; i < nports; ++i) {
 199                 uint32_t index = _output_ports[i];
 200                 float val = _lv2->get_parameter (index);
 201
 202                 if (val != _values_last_sent_to_ui[index]) {
 203                         /* Send to GUI */
 204                         suil_instance_port_event ((SuilInstance*)_inst, index, 4, 0, &val);
 205                         /* Cache current value */
 206                         _values_last_sent_to_ui[index] = val;
 207                 }
 208         }
 209
 210         /* Input ports marked for update because the control value changed
 211            since the last redisplay.
 212         */
 213
 214         for (Updates::iterator i = _updates.begin(); i != _updates.end(); ++i) {
 215                 float val = _lv2->get_parameter (*i);
 216                 /* push current value to the GUI */
 217                 suil_instance_port_event ((SuilInstance*)_inst, (*i), 4, 0, &val);
 218                 _values_last_sent_to_ui[(*i)] = val;
 219         }
 220
 221         _updates.clear ();
 222 }
 223
 224 LV2PluginUI::LV2PluginUI(boost::shared_ptr<PluginInsert> pi,
 225                          boost::shared_ptr<LV2Plugin>    lv2p)
 226         : PlugUIBase(pi)
 227         , _pi(pi)
 228         , _lv2(lv2p)
 229         , _gui_widget(NULL)
 230         , _values_last_sent_to_ui(NULL)
 231         , _external_ui_ptr(NULL)
 232         , _inst(NULL)
 233 {
 234         _ardour_buttons_box.set_spacing (6);
 235         _ardour_buttons_box.set_border_width (6);
 236         _ardour_buttons_box.pack_end (focus_button, false, false);
 237         _ardour_buttons_box.pack_end (bypass_button, false, false, 4);
 238         _ardour_buttons_box.pack_end (reset_button, false, false, 4);
 239         _ardour_buttons_box.pack_end (delete_button, false, false);
 240         _ardour_buttons_box.pack_end (save_button, false, false);
 241         _ardour_buttons_box.pack_end (add_button, false, false);
 242         _ardour_buttons_box.pack_end (_preset_combo, false, false);
 243         _ardour_buttons_box.pack_end (_preset_modified, false, false);
 244         _ardour_buttons_box.pack_end (pin_management_button, false, false);
 245
 246         plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&LV2PluginUI::queue_port_update, this), gui_context ());
 247 }
 248
 249 void
 250 LV2PluginUI::lv2ui_instantiate(const std::string& title)
 251 {
 252         bool          is_external_ui = _lv2->is_external_ui();
 253         LV2_Feature** features_src   = const_cast<LV2_Feature**>(_lv2->features());
 254         LV2_Feature** features       = const_cast<LV2_Feature**>(_lv2->features());
 255         size_t        features_count = 0;
 256         while (*features++) {
 257                 features_count++;
 258         }
 259
 260         Gtk::Alignment* container = NULL;
 261         if (is_external_ui) {
 262                 _external_ui_host.ui_closed       = LV2PluginUI::on_external_ui_closed;
 263                 _external_ui_host.plugin_human_id = strdup(title.c_str());
 264
 265                 _external_ui_feature.URI  = LV2_EXTERNAL_UI_URI;
 266                 _external_ui_feature.data = &_external_ui_host;
 267
 268                 _external_kxui_feature.URI  = LV2_EXTERNAL_UI_KX__Host;
 269                 _external_kxui_feature.data = &_external_ui_host;
 270
 271                 ++features_count;
 272                 features = (LV2_Feature**)malloc(
 273                         sizeof(LV2_Feature*) * (features_count + 2));
 274                 for (size_t i = 0; i < features_count - 2; ++i) {
 275                         features[i] = features_src[i];
 276                 }
 277                 features[features_count - 2] = &_external_kxui_feature;
 278                 features[features_count - 1] = &_external_ui_feature;
 279                 features[features_count]     = NULL;
 280         } else {
 281                 if (_ardour_buttons_box.get_parent()) {
 282                         _ardour_buttons_box.get_parent()->remove(_ardour_buttons_box);
 283                 }
 284                 pack_start(_ardour_buttons_box, false, false);
 285                 _ardour_buttons_box.show_all();
 286
 287                 _gui_widget = Gtk::manage((container = new Gtk::Alignment()));
 288                 pack_start(*_gui_widget, true, true);
 289                 _gui_widget->show();
 290
 291                 _parent_feature.URI  = LV2_UI__parent;
 292                 _parent_feature.data = _gui_widget->gobj();
 293
 294                 ++features_count;
 295                 features = (LV2_Feature**)malloc(
 296                         sizeof(LV2_Feature*) * (features_count + 1));
 297                 for (size_t i = 0; i < features_count - 1; ++i) {
 298                         features[i] = features_src[i];
 299                 }
 300                 features[features_count - 1] = &_parent_feature;
 301                 features[features_count]     = NULL;
 302         }
 303
 304         if (!ui_host) {
 305                 ui_host = suil_host_new(LV2PluginUI::write_from_ui,
 306                                         LV2PluginUI::port_index,
 307                                         NULL, NULL);
 308                 suil_host_set_touch_func(ui_host, LV2PluginUI::touch);
 309         }
 310         const char* container_type = (is_external_ui)
 311                 ? NS_UI "external"
 312                 : NS_UI "GtkUI";
 313
 314         if (_lv2->has_message_output()) {
 315                 _lv2->enable_ui_emission();
 316         }
 317
 318         const LilvUI*   ui     = (const LilvUI*)_lv2->c_ui();
 319         const LilvNode* bundle = lilv_ui_get_bundle_uri(ui);
 320         const LilvNode* binary = lilv_ui_get_binary_uri(ui);
 321 #ifdef HAVE_LILV_0_21_3
 322         char* ui_bundle_path = lilv_file_uri_parse(lilv_node_as_uri(bundle), NULL);
 323         char* ui_binary_path = lilv_file_uri_parse(lilv_node_as_uri(binary), NULL);
 324 #else
 325         char* ui_bundle_path = strdup(lilv_uri_to_path(lilv_node_as_uri(bundle)));
 326         char* ui_binary_path = strdup(lilv_uri_to_path(lilv_node_as_uri(binary)));
 327 #endif
 328         if (!ui_bundle_path || !ui_binary_path) {
 329                 error << _("failed to get path for UI bindle or binary") << endmsg;
 330                 free(ui_bundle_path);
 331                 free(ui_binary_path);
 332                 free(features);
 333                 return;
 334         }
 335
 336         _inst = suil_instance_new(
 337                 ui_host,
 338                 this,
 339                 container_type,
 340                 _lv2->uri(),
 341                 lilv_node_as_uri(lilv_ui_get_uri(ui)),
 342                 lilv_node_as_uri((const LilvNode*)_lv2->c_ui_type()),
 343                 ui_bundle_path,
 344                 ui_binary_path,
 345                 features);
 346
 347         free(ui_bundle_path);
 348         free(ui_binary_path);
 349         free(features);
 350
 351         if (!_inst) {
 352                 error << _("failed to instantiate LV2 GUI") << endmsg;
 353                 return;
 354         }
 355
 356 #define GET_WIDGET(inst) suil_instance_get_widget((SuilInstance*)inst);
 357
 358         const uint32_t num_ports = _lv2->num_ports();
 359         for (uint32_t i = 0; i < num_ports; ++i) {
 360                 if (_lv2->parameter_is_output(i)
 361                     && _lv2->parameter_is_control(i)
 362                     && is_update_wanted(i)) {
 363                         _output_ports.push_back(i);
 364                 }
 365         }
 366
 367         _external_ui_ptr = NULL;
 368         if (!is_external_ui) {
 369                 GtkWidget* c_widget = (GtkWidget*)GET_WIDGET(_inst);
 370                 if (!c_widget) {
 371                         error << _("failed to get LV2 UI widget") << endmsg;
 372                         suil_instance_free((SuilInstance*)_inst);
 373                         _inst = NULL;
 374                         return;
 375                 }
 376                 if (!container->get_child()) {
 377                         // Suil didn't add the UI to the container for us, so do it now
 378                         container->add(*Gtk::manage(Glib::wrap(c_widget)));
 379                 }
 380                 container->show_all();
 381                 gtk_widget_set_can_focus(c_widget, true);
 382                 gtk_widget_grab_focus(c_widget);
 383         } else {
 384                 _external_ui_ptr = (struct lv2_external_ui*)GET_WIDGET(_inst);
 385         }
 386
 387         _values_last_sent_to_ui = new float[num_ports];
 388         _controllables.resize(num_ports);
 389
 390         for (uint32_t i = 0; i < num_ports; ++i) {
 391                 bool     ok;
 392                 uint32_t port = _lv2->nth_parameter(i, ok);
 393                 if (ok) {
 394                         /* Cache initial value of the parameter, regardless of
 395                            whether it is input or output
 396                         */
 397
 398                         _values_last_sent_to_ui[port]        = _lv2->get_parameter(port);
 399                         _controllables[port] = boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (
 400                                 insert->control(Evoral::Parameter(PluginAutomation, 0, port)));
 401
 402                         if (_lv2->parameter_is_control(port) && _lv2->parameter_is_input(port)) {
 403                                 if (_controllables[port]) {
 404                                         _controllables[port]->Changed.connect (control_connections, invalidator (*this), boost::bind (&LV2PluginUI::control_changed, this, port), gui_context());
 405                                 }
 406                         }
 407
 408                         /* queue for first update ("push") to GUI */
 409                         _updates.insert (port);
 410                 }
 411         }
 412
 413         if (_lv2->has_message_output()) {
 414                 _message_update_connection = Timers::super_rapid_connect (
 415                         sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
 416         }
 417 }
 418
 419 void
 420 LV2PluginUI::grab_focus()
 421 {
 422         if (_inst && !_lv2->is_external_ui()) {
 423                 GtkWidget* c_widget = (GtkWidget*)GET_WIDGET(_inst);
 424                 gtk_widget_grab_focus(c_widget);
 425         }
 426 }
 427
 428 void
 429 LV2PluginUI::lv2ui_free()
 430 {
 431         stop_updating (0);
 432
 433         if (_gui_widget) {
 434                 remove (*_gui_widget);
 435                 _gui_widget = NULL;
 436         }
 437
 438         if (_inst) {
 439                 suil_instance_free((SuilInstance*)_inst);
 440                 _inst = NULL;
 441         }
 442 }
 443
 444 LV2PluginUI::~LV2PluginUI ()
 445 {
 446         delete [] _values_last_sent_to_ui;
 447
 448         _message_update_connection.disconnect();
 449         _screen_update_connection.disconnect();
 450
 451         if (_external_ui_ptr && _lv2->is_external_kx()) {
 452                 LV2_EXTERNAL_UI_HIDE(_external_ui_ptr);
 453         }
 454         lv2ui_free();
 455         _external_ui_ptr = NULL;
 456 }
 457
 458 int
 459 LV2PluginUI::get_preferred_height()
 460 {
 461         Gtk::Requisition r = size_request();
 462         return r.height;
 463 }
 464
 465 int
 466 LV2PluginUI::get_preferred_width()
 467 {
 468         Gtk::Requisition r = size_request();
 469         return r.width;
 470 }
 471
 472 bool
 473 LV2PluginUI::resizable()
 474 {
 475         return _lv2->ui_is_resizable();
 476 }
 477
 478 int
 479 LV2PluginUI::package(Gtk::Window& win)
 480 {
 481         if (_external_ui_ptr) {
 482                 _win_ptr = &win;
 483         } else {
 484                 /* forward configure events to plugin window */
 485                 win.signal_configure_event().connect(
 486                         sigc::mem_fun(*this, &LV2PluginUI::configure_handler));
 487                 win.signal_map_event().connect(
 488                         sigc::mem_fun(*this, &LV2PluginUI::start_updating));
 489                 win.signal_unmap_event().connect(
 490                         sigc::mem_fun(*this, &LV2PluginUI::stop_updating));
 491         }
 492         return 0;
 493 }
 494
 495 bool
 496 LV2PluginUI::configure_handler(GdkEventConfigure*)
 497 {
 498         std::cout << "CONFIGURE" << std::endl;
 499         return false;
 500 }
 501
 502 bool
 503 LV2PluginUI::is_update_wanted(uint32_t /*index*/)
 504 {
 505         /* FIXME: use port notification properties
 506            and/or new UI extension subscription methods
 507         */
 508         return true;
 509 }
 510
 511 bool
 512 LV2PluginUI::on_window_show(const std::string& title)
 513 {
 514         //cout << "on_window_show - " << title << endl; flush(cout);
 515
 516         if (_lv2->is_external_ui()) {
 517                 if (_external_ui_ptr) {
 518                         _screen_update_connection.disconnect();
 519                         _message_update_connection.disconnect();
 520                         LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
 521                         _screen_update_connection = Timers::super_rapid_connect
 522                         (sigc::mem_fun(*this, &LV2PluginUI::output_update));
 523                         if (_lv2->has_message_output()) {
 524                                 _message_update_connection = Timers::super_rapid_connect (
 525                                         sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
 526                         }
 527                         return false;
 528                 }
 529                 lv2ui_instantiate(title);
 530                 if (!_external_ui_ptr) {
 531                         return false;
 532                 }
 533
 534                 _screen_update_connection.disconnect();
 535                 _message_update_connection.disconnect();
 536                 LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
 537                 _screen_update_connection = Timers::super_rapid_connect
 538                         (sigc::mem_fun(*this, &LV2PluginUI::output_update));
 539                 if (_lv2->has_message_output()) {
 540                         _message_update_connection = Timers::super_rapid_connect (
 541                                 sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
 542                 }
 543                 return false;
 544         } else {
 545                 lv2ui_instantiate("gtk2gui");
 546         }
 547
 548         return _inst ? true : false;
 549 }
 550
 551 void
 552 LV2PluginUI::on_window_hide()
 553 {
 554         //printf("LV2PluginUI::on_window_hide\n");
 555
 556         if (_lv2->is_external_ui()) {
 557                 if (!_external_ui_ptr) { return; }
 558                 LV2_EXTERNAL_UI_HIDE(_external_ui_ptr);
 559                 if (!_lv2->is_external_kx()) { return ; }
 560                 _message_update_connection.disconnect();
 561                 _screen_update_connection.disconnect();
 562                 _external_ui_ptr = NULL;
 563                 suil_instance_free((SuilInstance*)_inst);
 564                 _inst = NULL;
 565         } else {
 566                 lv2ui_free();
 567         }
 568 }