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