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