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