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 "ardour_ui.h"
  25 #include "lv2_plugin_ui.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 == me->_lv2->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         LV2PluginUI* me = (LV2PluginUI*)controller;
 117         me->_screen_update_connection.disconnect();
 118         me->_external_ui_ptr = NULL;
 119 }
 120
 121 void
 122 LV2PluginUI::parameter_changed(uint32_t port_index, float val)
 123 {
 124         PlugUIBase::parameter_changed(port_index, val);
 125
 126         if (val != _values[port_index]) {
 127                 parameter_update(port_index, val);
 128         }
 129 }
 130
 131 void
 132 LV2PluginUI::parameter_update(uint32_t port_index, float val)
 133 {
 134         if (!_inst) {
 135                 return;
 136         }
 137
 138         suil_instance_port_event((SuilInstance*)_inst, port_index, 4, 0, &val);
 139         _values[port_index] = val;
 140 }
 141
 142 bool
 143 LV2PluginUI::start_updating(GdkEventAny*)
 144 {
 145         if (!_output_ports.empty()) {
 146                 _screen_update_connection.disconnect();
 147                 _screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect
 148                         (sigc::mem_fun(*this, &LV2PluginUI::output_update));
 149         }
 150         return false;
 151 }
 152
 153 bool
 154 LV2PluginUI::stop_updating(GdkEventAny*)
 155 {
 156         //cout << "stop_updating" << endl;
 157
 158         if (!_output_ports.empty()) {
 159                 _screen_update_connection.disconnect();
 160         }
 161         return false;
 162 }
 163
 164 void
 165 LV2PluginUI::output_update()
 166 {
 167         //cout << "output_update" << endl;
 168         if (_external_ui_ptr) {
 169                 LV2_EXTERNAL_UI_RUN(_external_ui_ptr);
 170         }
 171
 172         /* FIXME only works with control output ports (which is all we support now anyway) */
 173         uint32_t nports = _output_ports.size();
 174         for (uint32_t i = 0; i < nports; ++i) {
 175                 uint32_t index = _output_ports[i];
 176                 parameter_changed(index, _lv2->get_parameter(index));
 177         }
 178
 179 }
 180
 181 LV2PluginUI::LV2PluginUI(boost::shared_ptr<PluginInsert> pi,
 182                          boost::shared_ptr<LV2Plugin>    lv2p)
 183         : PlugUIBase(pi)
 184         , _pi(pi)
 185         , _lv2(lv2p)
 186         , _gui_widget(NULL)
 187         , _values(NULL)
 188         , _external_ui_ptr(NULL)
 189         , _inst(NULL)
 190 {
 191         _ardour_buttons_box.set_spacing (6);
 192         _ardour_buttons_box.set_border_width (6);
 193         _ardour_buttons_box.pack_end (focus_button, false, false);
 194         _ardour_buttons_box.pack_end (bypass_button, false, false, 10);
 195         _ardour_buttons_box.pack_end (delete_button, false, false);
 196         _ardour_buttons_box.pack_end (save_button, false, false);
 197         _ardour_buttons_box.pack_end (add_button, false, false);
 198         _ardour_buttons_box.pack_end (_preset_combo, false, false);
 199         _ardour_buttons_box.pack_end (_preset_modified, false, false);
 200 }
 201
 202 void
 203 LV2PluginUI::lv2ui_instantiate(const std::string& title)
 204 {
 205         bool          is_external_ui = _lv2->is_external_ui();
 206         LV2_Feature** features_src   = const_cast<LV2_Feature**>(_lv2->features());
 207         LV2_Feature** features       = const_cast<LV2_Feature**>(_lv2->features());
 208         size_t        features_count = 0;
 209         while (*features++) {
 210                 features_count++;
 211         }
 212
 213         Gtk::Alignment* container = NULL;
 214         if (is_external_ui) {
 215                 _external_ui_host.ui_closed       = LV2PluginUI::on_external_ui_closed;
 216                 _external_ui_host.plugin_human_id = strdup(title.c_str());
 217
 218                 _external_ui_feature.URI  = LV2_EXTERNAL_UI_URI;
 219                 _external_ui_feature.data = &_external_ui_host;
 220
 221                 ++features_count;
 222                 features = (LV2_Feature**)malloc(
 223                         sizeof(LV2_Feature*) * (features_count + 1));
 224                 for (size_t i = 0; i < features_count - 1; ++i) {
 225                         features[i] = features_src[i];
 226                 }
 227                 features[features_count - 1] = &_external_ui_feature;
 228                 features[features_count]     = NULL;
 229         } else {
 230                 if (_ardour_buttons_box.get_parent()) {
 231                         _ardour_buttons_box.get_parent()->remove(_ardour_buttons_box);
 232                 }
 233                 pack_start(_ardour_buttons_box, false, false);
 234                 _ardour_buttons_box.show_all();
 235
 236                 _gui_widget = Gtk::manage((container = new Gtk::Alignment()));
 237                 pack_start(*_gui_widget, true, true);
 238                 _gui_widget->show();
 239
 240                 _parent_feature.URI  = LV2_UI__parent;
 241                 _parent_feature.data = _gui_widget->gobj();
 242
 243                 ++features_count;
 244                 features = (LV2_Feature**)malloc(
 245                         sizeof(LV2_Feature*) * (features_count + 1));
 246                 for (size_t i = 0; i < features_count - 1; ++i) {
 247                         features[i] = features_src[i];
 248                 }
 249                 features[features_count - 1] = &_parent_feature;
 250                 features[features_count]     = NULL;
 251         }
 252
 253         if (!ui_host) {
 254                 ui_host = suil_host_new(LV2PluginUI::write_from_ui,
 255                                         LV2PluginUI::port_index,
 256                                         NULL, NULL);
 257                 suil_host_set_touch_func(ui_host, LV2PluginUI::touch);
 258         }
 259         const char* container_type = (is_external_ui)
 260                 ? NS_UI "external"
 261                 : NS_UI "GtkUI";
 262
 263         const LilvUI* ui = (const LilvUI*)_lv2->c_ui();
 264         _inst = suil_instance_new(
 265                 ui_host,
 266                 this,
 267                 container_type,
 268                 _lv2->uri(),
 269                 lilv_node_as_uri(lilv_ui_get_uri(ui)),
 270                 lilv_node_as_uri((const LilvNode*)_lv2->c_ui_type()),
 271                 lilv_uri_to_path(lilv_node_as_uri(lilv_ui_get_bundle_uri(ui))),
 272                 lilv_uri_to_path(lilv_node_as_uri(lilv_ui_get_binary_uri(ui))),
 273                 features);
 274
 275         free(features);
 276
 277 #define GET_WIDGET(inst) suil_instance_get_widget((SuilInstance*)inst);
 278
 279         const uint32_t num_ports = _lv2->num_ports();
 280         for (uint32_t i = 0; i < num_ports; ++i) {
 281                 if (_lv2->parameter_is_output(i)
 282                     && _lv2->parameter_is_control(i)
 283                     && is_update_wanted(i)) {
 284                         _output_ports.push_back(i);
 285                 }
 286         }
 287
 288         _external_ui_ptr = NULL;
 289         if (_inst) {
 290                 if (!is_external_ui) {
 291                         GtkWidget* c_widget = (GtkWidget*)GET_WIDGET(_inst);
 292                         if (!c_widget) {
 293                                 error << _("failed to get LV2 UI widget") << endmsg;
 294                                 suil_instance_free((SuilInstance*)_inst);
 295                                 _inst = NULL;
 296                                 return;
 297                         }
 298                         if (!container->get_child()) {
 299                                 // Suil didn't add the UI to the container for us, so do it now
 300                                 container->add(*Gtk::manage(Glib::wrap(c_widget)));
 301                         }
 302                         container->show_all();
 303                 } else {
 304                         _external_ui_ptr = (struct lv2_external_ui*)GET_WIDGET(_inst);
 305                 }
 306         }
 307
 308         _values = new float[num_ports];
 309         _controllables.resize(num_ports);
 310         for (uint32_t i = 0; i < num_ports; ++i) {
 311                 bool     ok;
 312                 uint32_t port = _lv2->nth_parameter(i, ok);
 313                 if (ok) {
 314                         _values[port]        = _lv2->get_parameter(port);
 315                         _controllables[port] = boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (
 316                                 insert->control(Evoral::Parameter(PluginAutomation, 0, port)));
 317
 318                         if (_lv2->parameter_is_control(port) && _lv2->parameter_is_input(port)) {
 319                                 parameter_update(port, _values[port]);
 320                         }
 321                 }
 322         }
 323
 324         if (_lv2->has_message_output()) {
 325                 _lv2->enable_ui_emmission();
 326                 ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect(
 327                         sigc::mem_fun(*this, &LV2PluginUI::update_timeout));
 328         }
 329 }
 330
 331 void
 332 LV2PluginUI::lv2ui_free()
 333 {
 334         stop_updating (0);
 335
 336         if (_gui_widget) {
 337                 remove (*_gui_widget);
 338                 _gui_widget = NULL;
 339         }
 340
 341         if (_inst) {
 342                 suil_instance_free((SuilInstance*)_inst);
 343                 _inst = NULL;
 344         }
 345 }
 346
 347 LV2PluginUI::~LV2PluginUI ()
 348 {
 349         if (_values) {
 350                 delete[] _values;
 351         }
 352
 353         /* Close and delete GUI. */
 354         lv2ui_free();
 355
 356         _screen_update_connection.disconnect();
 357
 358         if (_lv2->is_external_ui()) {
 359                 /* External UI is no longer valid.
 360                    on_window_hide() will not try to use it if is NULL.
 361                 */
 362                 _external_ui_ptr = NULL;
 363         }
 364 }
 365
 366 int
 367 LV2PluginUI::get_preferred_height()
 368 {
 369         Gtk::Requisition r = size_request();
 370         return r.height;
 371 }
 372
 373 int
 374 LV2PluginUI::get_preferred_width()
 375 {
 376         Gtk::Requisition r = size_request();
 377         return r.width;
 378 }
 379
 380 bool
 381 LV2PluginUI::resizable()
 382 {
 383         return _lv2->ui_is_resizable();
 384 }
 385
 386 int
 387 LV2PluginUI::package(Gtk::Window& win)
 388 {
 389         if (_external_ui_ptr) {
 390                 _win_ptr = &win;
 391         } else {
 392                 /* forward configure events to plugin window */
 393                 win.signal_configure_event().connect(
 394                         sigc::mem_fun(*this, &LV2PluginUI::configure_handler));
 395                 win.signal_map_event().connect(
 396                         sigc::mem_fun(*this, &LV2PluginUI::start_updating));
 397                 win.signal_unmap_event().connect(
 398                         sigc::mem_fun(*this, &LV2PluginUI::stop_updating));
 399         }
 400         return 0;
 401 }
 402
 403 bool
 404 LV2PluginUI::configure_handler(GdkEventConfigure*)
 405 {
 406         std::cout << "CONFIGURE" << std::endl;
 407         return false;
 408 }
 409
 410 bool
 411 LV2PluginUI::is_update_wanted(uint32_t /*index*/)
 412 {
 413         /* FIXME: use port notification properties
 414            and/or new UI extension subscription methods
 415         */
 416         return true;
 417 }
 418
 419 bool
 420 LV2PluginUI::on_window_show(const std::string& title)
 421 {
 422         //cout << "on_window_show - " << title << endl; flush(cout);
 423
 424         if (_lv2->is_external_ui()) {
 425                 if (_external_ui_ptr) {
 426                         LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
 427                         return false;
 428                 }
 429                 lv2ui_instantiate(title);
 430                 if (!_external_ui_ptr) {
 431                         return false;
 432                 }
 433
 434                 LV2_EXTERNAL_UI_SHOW(_external_ui_ptr);
 435                 _screen_update_connection.disconnect();
 436                 _screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect
 437                         (sigc::mem_fun(*this, &LV2PluginUI::output_update));
 438                 return false;
 439         } else {
 440                 lv2ui_instantiate("gtk2gui");
 441         }
 442
 443         return true;
 444 }
 445
 446 void
 447 LV2PluginUI::on_window_hide()
 448 {
 449         //cout << "on_window_hide" << endl; flush(cout);
 450
 451         if (_external_ui_ptr) {
 452                 LV2_EXTERNAL_UI_HIDE(_external_ui_ptr);
 453                 //slv2_ui_instance_get_descriptor(_inst)->cleanup(_inst);
 454                 //_external_ui_ptr = NULL;
 455                 //_screen_update_connection.disconnect();
 456         } else {
 457                 lv2ui_free();
 458         }
 459 }