2 Copyright (C) 2000 Paul Davis
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.
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.
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.
21 #include "gtk2ardour-config.h"
29 #include "pbd/stl_delete.h"
30 #include "pbd/xml++.h"
31 #include "pbd/failed_constructor.h"
33 #include <gtkmm/widget.h>
34 #include <gtkmm/box.h>
35 #include <gtkmm2ext/click_box.h>
36 #include <gtkmm2ext/fastmeter.h>
37 #include <gtkmm2ext/barcontroller.h>
38 #include <gtkmm2ext/utils.h>
39 #include <gtkmm2ext/doi.h>
40 #include <gtkmm2ext/slider_controller.h>
42 #include "midi++/manager.h"
44 #include "ardour/session.h"
45 #include "ardour/plugin.h"
46 #include "ardour/plugin_insert.h"
47 #include "ardour/ladspa_plugin.h"
49 #include "ardour/vst_plugin.h"
52 #include "ardour/lv2_plugin.h"
53 #include "lv2_plugin_ui.h"
58 #include "ardour_dialog.h"
59 #include "ardour_ui.h"
61 #include "plugin_ui.h"
63 #include "gui_thread.h"
64 #include "public_editor.h"
66 #include "latency_gui.h"
67 #include "plugin_eq_gui.h"
72 using namespace ARDOUR;
74 using namespace Gtkmm2ext;
77 PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert> insert, bool scrollable)
80 bool have_gui = false;
84 Label* label = manage (new Label());
85 label->set_markup ("<b>THIS IS THE PLUGIN UI</b>");
87 if (insert->plugin()->has_editor()) {
88 switch (insert->type()) {
90 have_gui = create_vst_editor (insert);
93 case ARDOUR::AudioUnit:
94 have_gui = create_audiounit_editor (insert);
98 error << _("Eh? LADSPA plugins don't have editors!") << endmsg;
102 have_gui = create_lv2_editor (insert);
107 error << _("unknown type of editor-supplying plugin (note: no VST support in this version of ardour)")
110 error << _("unknown type of editor-supplying plugin")
113 throw failed_constructor ();
120 GenericPluginUI* pu = new GenericPluginUI (insert, scrollable);
126 Gtk::HBox *hbox = new Gtk::HBox();
127 hbox->pack_start( *pu);
128 // TODO: this should be nicer
129 hbox->pack_start( eqgui_bin );
134 set_wmclass (X_("ardour_plugin_editor"), PROGRAM_NAME);
136 signal_map_event().connect (sigc::mem_fun (*pu, &GenericPluginUI::start_updating));
137 signal_unmap_event().connect (sigc::mem_fun (*pu, &GenericPluginUI::stop_updating));
140 // set_position (Gtk::WIN_POS_MOUSE);
141 set_name ("PluginEditor");
142 add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK|Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
144 signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), reinterpret_cast<Window*> (this)), false);
145 insert->DropReferences.connect (death_connection, invalidator (*this), boost::bind (&PluginUIWindow::plugin_going_away, this), gui_context());
147 gint h = _pluginui->get_preferred_height ();
148 gint w = _pluginui->get_preferred_width ();
151 if (h > 600) h = 600;
152 if (w > 600) w = 600;
159 set_default_size (w, h);
162 PluginUIWindow::~PluginUIWindow ()
168 PluginUIWindow::set_parent (Gtk::Window* win)
174 PluginUIWindow::on_map ()
177 set_keep_above (true);
181 PluginUIWindow::on_enter_notify_event (GdkEventCrossing *ev)
183 Keyboard::the_keyboard().enter_window (ev, this);
188 PluginUIWindow::on_leave_notify_event (GdkEventCrossing *ev)
190 Keyboard::the_keyboard().leave_window (ev, this);
195 PluginUIWindow::on_focus_in_event (GdkEventFocus *ev)
197 Window::on_focus_in_event (ev);
198 //Keyboard::the_keyboard().magic_widget_grab_focus ();
203 PluginUIWindow::on_focus_out_event (GdkEventFocus *ev)
205 Window::on_focus_out_event (ev);
206 //Keyboard::the_keyboard().magic_widget_drop_focus ();
211 PluginUIWindow::on_show ()
213 set_role("plugin_ui");
216 _pluginui->update_presets ();
220 if (_pluginui->on_window_show (_title)) {
226 // set_transient_for (*parent);
231 PluginUIWindow::on_hide ()
236 _pluginui->on_window_hide ();
241 PluginUIWindow::set_title(const Glib::ustring& title)
243 //cout << "PluginUIWindow::set_title(\"" << title << "\"" << endl;
244 Gtk::Window::set_title(title);
250 PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert> insert)
252 PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert>)
259 boost::shared_ptr<VSTPlugin> vp;
261 if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (insert->plugin())) == 0) {
262 error << _("unknown type of editor-supplying plugin (note: no VST support in this version of ardour)")
264 throw failed_constructor ();
266 VSTPluginUI* vpu = new VSTPluginUI (insert, vp);
270 vpu->package (*this);
279 #if defined (HAVE_AUDIOUNITS) && defined (GTKOSX)
280 PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert> insert)
282 PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert>)
285 #if !defined(HAVE_AUDIOUNITS) || !defined(GTKOSX)
289 _pluginui = create_au_gui (insert, &box);
293 extern sigc::signal<void,bool> ApplicationActivationChanged;
294 ApplicationActivationChanged.connect (sigc::mem_fun (*this, &PluginUIWindow::app_activated));
301 #if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
302 PluginUIWindow::app_activated (bool yn)
304 PluginUIWindow::app_activated (bool)
307 #if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
308 cerr << "APP activated ? " << yn << endl;
312 _pluginui->activate ();
317 was_visible = is_visible();
319 _pluginui->deactivate ();
326 PluginUIWindow::create_lv2_editor(boost::shared_ptr<PluginInsert> insert)
332 boost::shared_ptr<LV2Plugin> vp;
334 if ((vp = boost::dynamic_pointer_cast<LV2Plugin> (insert->plugin())) == 0) {
335 error << _("create_lv2_editor called on non-LV2 plugin") << endmsg;
336 throw failed_constructor ();
338 LV2PluginUI* lpu = new LV2PluginUI (insert, vp);
341 lpu->package (*this);
350 PluginUIWindow::on_key_press_event (GdkEventKey* event)
352 return relay_key_press (event, this);
356 PluginUIWindow::on_key_release_event (GdkEventKey *)
362 PluginUIWindow::plugin_going_away ()
364 ENSURE_GUI_THREAD (*this, &PluginUIWindow::plugin_going_away)
367 _pluginui->stop_updating(0);
370 death_connection.disconnect ();
372 delete_when_idle (this);
375 PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
377 plugin (insert->plugin()),
378 save_button(_("Add")),
379 bypass_button (_("Bypass")),
381 plugin_analysis_expander (_("Plugin analysis"))
383 //preset_combo.set_use_arrows_always(true);
385 preset_combo.set_size_request (100, -1);
386 preset_combo.set_active_text ("");
387 preset_combo.signal_changed().connect(sigc::mem_fun(*this, &PlugUIBase::setting_selected));
388 no_load_preset = false;
390 save_button.set_name ("PluginSaveButton");
391 save_button.signal_clicked().connect(sigc::mem_fun(*this, &PlugUIBase::save_plugin_setting));
393 insert->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&PlugUIBase::processor_active_changed, this, boost::weak_ptr<Processor>(insert)), gui_context());
395 bypass_button.set_active (!pi->active());
397 bypass_button.set_name ("PluginBypassButton");
398 bypass_button.signal_toggled().connect (sigc::mem_fun(*this, &PlugUIBase::bypass_toggled));
399 focus_button.add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK);
401 focus_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PlugUIBase::focus_toggled));
402 focus_button.add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK);
404 /* these images are not managed, so that we can remove them at will */
406 focus_out_image = new Image (get_icon (X_("computer_keyboard")));
407 focus_in_image = new Image (get_icon (X_("computer_keyboard_active")));
409 focus_button.add (*focus_out_image);
411 ARDOUR_UI::instance()->set_tip (focus_button, string_compose (_("Click to allow the plugin to receive keyboard events that %1 would normally use as a shortcut"), PROGRAM_NAME));
412 ARDOUR_UI::instance()->set_tip (bypass_button, _("Click to enable/disable this plugin"));
414 plugin_analysis_expander.property_expanded().signal_changed().connect( sigc::mem_fun(*this, &PlugUIBase::toggle_plugin_analysis));
415 plugin_analysis_expander.set_expanded(false);
417 insert->DropReferences.connect (death_connection, invalidator (*this), boost::bind (&PlugUIBase::plugin_going_away, this), gui_context());
420 PlugUIBase::~PlugUIBase()
426 PlugUIBase::plugin_going_away ()
428 /* drop references to the plugin/insert */
431 death_connection.disconnect ();
435 PlugUIBase::set_latency_label ()
438 nframes_t l = insert->effective_latency ();
439 nframes_t sr = insert->session().frame_rate();
442 snprintf (buf, sizeof (buf), "latency (%d samples)", l);
444 snprintf (buf, sizeof (buf), "latency (%.2f msecs)", (float) l / ((float) sr / 1000.0f));
447 latency_label.set_text (buf);
451 PlugUIBase::latency_button_clicked ()
454 latency_gui = new LatencyGUI (*(insert.get()), insert->session().frame_rate(), insert->session().get_block_size());
455 latency_dialog = new ArdourDialog ("Edit Latency", false, false);
456 latency_dialog->get_vbox()->pack_start (*latency_gui);
457 latency_dialog->signal_hide().connect (sigc::mem_fun (*this, &PlugUIBase::set_latency_label));
460 latency_dialog->show_all ();
464 PlugUIBase::processor_active_changed (boost::weak_ptr<Processor> weak_p)
466 ENSURE_GUI_THREAD (*this, &PlugUIBase::processor_active_changed, weak_p)
467 boost::shared_ptr<Processor> p (weak_p);
469 bypass_button.set_active (!p->active());
474 PlugUIBase::setting_selected()
476 if (no_load_preset) {
480 if (preset_combo.get_active_text().length() > 0) {
481 const Plugin::PresetRecord* pr = plugin->preset_by_label(preset_combo.get_active_text());
483 plugin->load_preset(pr->uri);
485 warning << string_compose(_("Plugin preset %1 not found"),
486 preset_combo.get_active_text()) << endmsg;
492 PlugUIBase::save_plugin_setting ()
494 ArdourPrompter prompter (true);
495 prompter.set_prompt(_("Name of New Preset:"));
496 prompter.add_button (Gtk::Stock::ADD, Gtk::RESPONSE_ACCEPT);
497 prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
498 prompter.set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
503 switch (prompter.run ()) {
504 case Gtk::RESPONSE_ACCEPT:
506 prompter.get_result(name);
508 if (plugin->save_preset(name)) {
510 no_load_preset = true;
511 preset_combo.set_active_text (name);
512 no_load_preset = false;
520 PlugUIBase::bypass_toggled ()
524 if ((x = bypass_button.get_active()) == insert->active()) {
526 insert->deactivate ();
534 PlugUIBase::focus_toggled (GdkEventButton*)
536 if (Keyboard::the_keyboard().some_magic_widget_has_focus()) {
537 Keyboard::the_keyboard().magic_widget_drop_focus();
538 focus_button.remove ();
539 focus_button.add (*focus_out_image);
540 focus_out_image->show ();
541 ARDOUR_UI::instance()->set_tip (focus_button, string_compose (_("Click to allow the plugin to receive keyboard events that %1 would normally use as a shortcut"), PROGRAM_NAME));
543 Keyboard::the_keyboard().magic_widget_grab_focus();
544 focus_button.remove ();
545 focus_button.add (*focus_in_image);
546 focus_in_image->show ();
547 ARDOUR_UI::instance()->set_tip (focus_button, string_compose (_("Click to allow normal use of %1 keyboard shortcuts"), PROGRAM_NAME));
554 PlugUIBase::toggle_plugin_analysis()
556 if (plugin_analysis_expander.get_expanded() &&
557 !plugin_analysis_expander.get_child()) {
559 PluginEqGui *foo = new PluginEqGui(insert);
560 plugin_analysis_expander.add( *foo );
561 plugin_analysis_expander.show_all();
566 if (!plugin_analysis_expander.get_expanded() &&
567 (gui = plugin_analysis_expander.get_child())) {
570 //plugin_analysis_expander.remove(*gui);
571 plugin_analysis_expander.remove();
575 Gtk::Widget *toplevel = plugin_analysis_expander.get_toplevel();
577 std::cerr << "No toplevel widget?!?!" << std::endl;
581 Gtk::Container *cont = dynamic_cast<Gtk::Container *>(toplevel);
583 std::cerr << "Toplevel widget is not a container?!?" << std::endl;
587 Gtk::Allocation alloc(0, 0, 50, 50); // Just make it small
588 toplevel->size_allocate(alloc);
593 PlugUIBase::update_presets ()
595 vector<string> preset_labels;
596 vector<ARDOUR::Plugin::PresetRecord> presets = plugin->get_presets();
598 no_load_preset = true;
600 for (vector<ARDOUR::Plugin::PresetRecord>::const_iterator i = presets.begin(); i != presets.end(); ++i) {
601 preset_labels.push_back(i->label);
604 set_popdown_strings (preset_combo, preset_labels);
606 no_load_preset = false;