gtk2_ardour/plugin_ui.cc

   1 /*
   2     Copyright (C) 2000 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <climits>
  21 #include <cerrno>
  22 #include <cmath>
  23 #include <string>
  24
  25 #include <pbd/stl_delete.h>
  26 #include <pbd/xml++.h>
  27 #include <pbd/failed_constructor.h>
  28
  29 #include <gtkmm/widget.h>
  30 #include <gtkmm2ext/click_box.h>
  31 #include <gtkmm2ext/fastmeter.h>
  32 #include <gtkmm2ext/barcontroller.h>
  33 #include <gtkmm2ext/utils.h>
  34 #include <gtkmm2ext/doi.h>
  35 #include <gtkmm2ext/slider_controller.h>
  36 #include <gtkmm2ext/application.h>
  37
  38 #include <midi++/manager.h>
  39
  40 #include <ardour/plugin.h>
  41 #include <ardour/insert.h>
  42 #include <ardour/ladspa_plugin.h>
  43 #ifdef VST_SUPPORT
  44 #include <ardour/vst_plugin.h>
  45 #endif
  46 #ifdef HAVE_LV2
  47 #include <ardour/lv2_plugin.h>
  48 #include "lv2_plugin_ui.h"
  49 #endif
  50
  51 #include <lrdf.h>
  52
  53 #include "ardour_ui.h"
  54 #include "prompter.h"
  55 #include "plugin_ui.h"
  56 #include "utils.h"
  57 #include "gui_thread.h"
  58 #include "public_editor.h"
  59 #include "keyboard.h"
  60
  61 #include "i18n.h"
  62
  63 using namespace std;
  64 using namespace ARDOUR;
  65 using namespace PBD;
  66 using namespace Gtkmm2ext;
  67 using namespace Gtk;
  68 using namespace sigc;
  69
  70 PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert> insert, bool scrollable)
  71         : parent (win)
  72 {
  73         bool have_gui = false;
  74         non_gtk_gui = false;
  75         was_visible = false;
  76
  77         if (insert->plugin()->has_editor()) {
  78                 switch (insert->type()) {
  79                 case ARDOUR::VST:
  80                         have_gui = create_vst_editor (insert);
  81                         break;
  82
  83                 case ARDOUR::AudioUnit:
  84                         have_gui = create_audiounit_editor (insert);
  85                         break;
  86
  87                 case ARDOUR::LADSPA:
  88                         error << _("Eh? LADSPA plugins don't have editors!") << endmsg;
  89                         break;
  90
  91                 case ARDOUR::LV2:
  92                         have_gui = create_lv2_editor (insert);
  93                         break;
  94
  95                 default:
  96 #ifndef VST_SUPPORT
  97                         error << _("unknown type of editor-supplying plugin (note: no VST support in this version of ardour)")
  98                               << endmsg;
  99 #else
 100                         error << _("unknown type of editor-supplying plugin")
 101                               << endmsg;
 102 #endif
 103                         throw failed_constructor ();
 104                 }
 105
 106         }
 107
 108         if (!have_gui) {
 109
 110                 GenericPluginUI*  pu  = new GenericPluginUI (insert, scrollable);
 111
 112                 _pluginui = pu;
 113                 add (*pu);
 114
 115                 set_wmclass (X_("ardour_plugin_editor"), "Ardour");
 116
 117                 signal_map_event().connect (mem_fun (*pu, &GenericPluginUI::start_updating));
 118                 signal_unmap_event().connect (mem_fun (*pu, &GenericPluginUI::stop_updating));
 119         }
 120
 121         // set_position (Gtk::WIN_POS_MOUSE);
 122         set_name ("PluginEditor");
 123         add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK|Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
 124
 125         signal_delete_event().connect (bind (sigc::ptr_fun (just_hide_it), reinterpret_cast<Window*> (this)), false);
 126         death_connection = insert->GoingAway.connect (mem_fun(*this, &PluginUIWindow::plugin_going_away));
 127
 128         gint h = _pluginui->get_preferred_height ();
 129         gint w = _pluginui->get_preferred_width ();
 130
 131         if (scrollable) {
 132                 if (h > 600) h = 600;
 133                 if (w > 600) w = 600;
 134
 135                 if (w < 0) {
 136                         w = 450;
 137                 }
 138         }
 139
 140         set_default_size (w, h);
 141 }
 142
 143 PluginUIWindow::~PluginUIWindow ()
 144 {
 145         delete _pluginui;
 146 }
 147
 148 void
 149 PluginUIWindow::set_parent (Gtk::Window* win)
 150 {
 151         parent = win;
 152 }
 153
 154 void
 155 PluginUIWindow::on_map ()
 156 {
 157         Window::on_map ();
 158         set_keep_above (true);
 159 }
 160
 161 bool
 162 PluginUIWindow::on_enter_notify_event (GdkEventCrossing *ev)
 163 {
 164         Keyboard::the_keyboard().enter_window (ev, this);
 165         return false;
 166 }
 167
 168 bool
 169 PluginUIWindow::on_leave_notify_event (GdkEventCrossing *ev)
 170 {
 171         Keyboard::the_keyboard().leave_window (ev, this);
 172         return false;
 173 }
 174
 175 bool
 176 PluginUIWindow::on_focus_in_event (GdkEventFocus *ev)
 177 {
 178         Window::on_focus_in_event (ev);
 179         //Keyboard::the_keyboard().magic_widget_grab_focus ();
 180         return false;
 181 }
 182
 183 bool
 184 PluginUIWindow::on_focus_out_event (GdkEventFocus *ev)
 185 {
 186         Window::on_focus_out_event (ev);
 187         //Keyboard::the_keyboard().magic_widget_drop_focus ();
 188         return false;
 189 }
 190
 191 void
 192 PluginUIWindow::on_show ()
 193 {
 194         set_role("plugin_ui");
 195
 196         if (_pluginui) {
 197                 _pluginui->update_presets ();
 198         }
 199
 200         if (_pluginui) {
 201                 if (_pluginui->on_window_show (_title)) {
 202                         Window::on_show ();
 203                 }
 204         }
 205
 206         if (parent) {
 207                 // set_transient_for (*parent);
 208         }
 209 }
 210
 211 void
 212 PluginUIWindow::on_hide ()
 213 {
 214         Window::on_hide ();
 215
 216         if (_pluginui) {
 217                 _pluginui->on_window_hide ();
 218         }
 219 }
 220
 221 void
 222 PluginUIWindow::set_title(const Glib::ustring& title)
 223 {
 224         //cout << "PluginUIWindow::set_title(\"" << title << "\"" << endl;
 225         Gtk::Window::set_title(title);
 226         _title = title;
 227 }
 228
 229 bool
 230 PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert> insert)
 231 {
 232 #ifndef VST_SUPPORT
 233         return false;
 234 #else
 235
 236         boost::shared_ptr<VSTPlugin> vp;
 237
 238         if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (insert->plugin())) == 0) {
 239                 error << _("unknown type of editor-supplying plugin (note: no VST support in this version of ardour)")
 240                               << endmsg;
 241                 throw failed_constructor ();
 242         } else {
 243                 VSTPluginUI* vpu = new VSTPluginUI (insert, vp);
 244
 245                 _pluginui = vpu;
 246                 add (*vpu);
 247                 vpu->package (*this);
 248         }
 249
 250         non_gtk_gui = true;
 251         return true;
 252 #endif
 253 }
 254
 255 bool
 256 PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert> insert)
 257 {
 258 #if !defined(HAVE_AUDIOUNITS) || !defined(GTKOSX)
 259         return false;
 260 #else
 261         VBox* box;
 262         _pluginui = create_au_gui (insert, &box);
 263         add (*box);
 264         non_gtk_gui = true;
 265
 266         Application::instance()->ActivationChanged.connect (mem_fun (*this, &PluginUIWindow::app_activated));
 267
 268         return true;
 269 #endif
 270 }
 271
 272 void
 273 PluginUIWindow::app_activated (bool yn)
 274 {
 275 #if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
 276         if (_pluginui) {
 277                 if (yn) {
 278                         if (was_visible) {
 279                                 _pluginui->activate ();
 280                                 // present ();
 281                                 show ();
 282                                 was_visible = true;
 283                         }
 284                 } else {
 285                         was_visible = is_visible();
 286                         hide ();
 287                         _pluginui->deactivate ();
 288                 }
 289         }
 290 #endif
 291 }
 292
 293 bool
 294 PluginUIWindow::create_lv2_editor(boost::shared_ptr<PluginInsert> insert)
 295 {
 296 #ifndef HAVE_LV2
 297         return false;
 298 #else
 299
 300         boost::shared_ptr<LV2Plugin> vp;
 301
 302         if ((vp = boost::dynamic_pointer_cast<LV2Plugin> (insert->plugin())) == 0) {
 303                 error << _("create_lv2_editor called on non-LV2 plugin") << endmsg;
 304                 throw failed_constructor ();
 305         } else {
 306                 LV2PluginUI* lpu = new LV2PluginUI (insert, vp);
 307                 _pluginui = lpu;
 308                 add (*lpu);
 309                 lpu->package (*this);
 310         }
 311
 312         non_gtk_gui = false;
 313         return true;
 314 #endif
 315 }
 316
 317 bool
 318 PluginUIWindow::on_key_press_event (GdkEventKey* event)
 319 {
 320         return relay_key_press (event, this);
 321 }
 322
 323 bool
 324 PluginUIWindow::on_key_release_event (GdkEventKey* event)
 325 {
 326         return true;
 327 }
 328
 329 void
 330 PluginUIWindow::plugin_going_away ()
 331 {
 332         ENSURE_GUI_THREAD(mem_fun(*this, &PluginUIWindow::plugin_going_away));
 333
 334         if (_pluginui) {
 335                 _pluginui->stop_updating(0);
 336         }
 337
 338         death_connection.disconnect ();
 339         delete_when_idle (this);
 340 }
 341
 342 PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
 343         : insert (pi),
 344           plugin (insert->plugin()),
 345           save_button(_("Save")),
 346           bypass_button (_("Bypass"))
 347 {
 348         //preset_combo.set_use_arrows_always(true);
 349         preset_combo.set_size_request (100, -1);
 350         update_presets ();
 351
 352         preset_combo.signal_changed().connect(mem_fun(*this, &PlugUIBase::setting_selected));
 353         no_load_preset = false;
 354
 355         save_button.set_name ("PluginSaveButton");
 356         save_button.signal_clicked().connect(mem_fun(*this, &PlugUIBase::save_plugin_setting));
 357
 358         insert->active_changed.connect (mem_fun(*this, &PlugUIBase::redirect_active_changed));
 359         bypass_button.set_active (!pi->active());
 360
 361         bypass_button.set_name ("PluginBypassButton");
 362         bypass_button.signal_toggled().connect (mem_fun(*this, &PlugUIBase::bypass_toggled));
 363         focus_button.add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK);
 364
 365         focus_button.signal_button_release_event().connect (mem_fun(*this, &PlugUIBase::focus_toggled));
 366         focus_button.add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK);
 367
 368         /* these images are not managed, so that we can remove them at will */
 369
 370         focus_out_image = new Image (get_icon (X_("computer_keyboard")));
 371         focus_in_image = new Image (get_icon (X_("computer_keyboard_active")));
 372
 373         focus_button.add (*focus_out_image);
 374
 375         ARDOUR_UI::instance()->set_tip (&focus_button, _("Click to allow the plugin to receive keyboard events that Ardour would normally use as a shortcut"), "");
 376         ARDOUR_UI::instance()->set_tip (&bypass_button, _("Click to enable/disable this plugin"), "");
 377
 378         insert->GoingAway.connect (mem_fun (*this, &PlugUIBase::plugin_going_away));
 379 }
 380
 381 PlugUIBase::~PlugUIBase ()
 382 {
 383 }
 384
 385 void
 386 PlugUIBase::plugin_going_away ()
 387 {
 388         /* drop references to the plugin/insert */
 389         insert.reset ();
 390         plugin.reset ();
 391 }
 392
 393 void
 394 PlugUIBase::redirect_active_changed (Redirect* r, void* src)
 395 {
 396         ENSURE_GUI_THREAD(bind (mem_fun(*this, &PlugUIBase::redirect_active_changed), r, src));
 397         bypass_button.set_active (!r->active());
 398 }
 399
 400 void
 401 PlugUIBase::setting_selected()
 402 {
 403         if (no_load_preset) {
 404                 return;
 405         }
 406
 407         if (preset_combo.get_active_text().length() > 0) {
 408                 if (!plugin->load_preset(preset_combo.get_active_text())) {
 409                         warning << string_compose(_("Plugin preset %1 not found"), preset_combo.get_active_text()) << endmsg;
 410                 }
 411         }
 412 }
 413
 414 void
 415 PlugUIBase::save_plugin_setting ()
 416 {
 417         ArdourPrompter prompter (true);
 418         prompter.set_prompt(_("Name of New Preset:"));
 419         prompter.add_button (Gtk::Stock::ADD, Gtk::RESPONSE_ACCEPT);
 420         prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
 421         prompter.set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
 422
 423         prompter.show_all();
 424         prompter.present ();
 425
 426         switch (prompter.run ()) {
 427         case Gtk::RESPONSE_ACCEPT:
 428
 429                 string name;
 430
 431                 prompter.get_result(name);
 432
 433                 if (name.length()) {
 434                         if (plugin->save_preset(name)) {
 435
 436                                 /* a rather inefficient way to add the newly saved preset
 437                                    to the list.
 438                                 */
 439
 440                                 no_load_preset = true;
 441                                 set_popdown_strings (preset_combo, plugin->get_presets());
 442                                 preset_combo.set_active_text (name);
 443                                 no_load_preset = false;
 444                         }
 445                 }
 446                 break;
 447         }
 448 }
 449
 450 void
 451 PlugUIBase::bypass_toggled ()
 452 {
 453         bool x;
 454
 455         if ((x = bypass_button.get_active()) == insert->active()) {
 456                 insert->set_active (!x, this);
 457         }
 458 }
 459
 460 bool
 461 PlugUIBase::focus_toggled (GdkEventButton* ev)
 462 {
 463         if (Keyboard::the_keyboard().some_magic_widget_has_focus()) {
 464                 Keyboard::the_keyboard().magic_widget_drop_focus();
 465                 focus_button.remove ();
 466                 focus_button.add (*focus_out_image);
 467                 focus_out_image->show ();
 468                 ARDOUR_UI::instance()->set_tip (&focus_button, _("Click to allow the plugin to receive keyboard events that Ardour would normally use as a shortcut"), "");
 469         } else {
 470                 Keyboard::the_keyboard().magic_widget_grab_focus();
 471                 focus_button.remove ();
 472                 focus_button.add (*focus_in_image);
 473                 focus_in_image->show ();
 474                 ARDOUR_UI::instance()->set_tip (&focus_button, _("Click to allow normal use of Ardour keyboard shortcuts"), "");
 475         }
 476
 477         return true;
 478 }
 479
 480 void
 481 PlugUIBase::update_presets ()
 482 {
 483         vector<string> presets = plugin->get_presets();
 484         no_load_preset = true;
 485
 486         set_popdown_strings (preset_combo, plugin->get_presets());
 487
 488         string current_preset = plugin->current_preset();
 489
 490         if (!current_preset.empty()) {
 491                 for (vector<string>::iterator p = presets.begin(); p != presets.end(); ++p) {
 492                         if (*p == current_preset) {
 493                                 preset_combo.set_active_text (current_preset);
 494                         }
 495                 }
 496         }
 497
 498         no_load_preset = false;
 499 }