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