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/plugin.h"
45 #include "ardour/plugin_insert.h"
46 #include "ardour/ladspa_plugin.h"
48 #include "ardour/vst_plugin.h"
51 #include "ardour/lv2_plugin.h"
52 #include "lv2_plugin_ui.h"
57 #include "ardour_dialog.h"
58 #include "ardour_ui.h"
60 #include "plugin_ui.h"
62 #include "gui_thread.h"
63 #include "public_editor.h"
65 #include "latency_gui.h"
66 #include "plugin_eq_gui.h"
71 using namespace ARDOUR;
73 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"), "Ardour");
136 signal_map_event().connect (mem_fun (*pu, &GenericPluginUI::start_updating));
137 signal_unmap_event().connect (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 (bind (sigc::ptr_fun (just_hide_it), reinterpret_cast<Window*> (this)), false);
145 death_connection = insert->GoingAway.connect (mem_fun(*this, &PluginUIWindow::plugin_going_away));
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 (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(mem_fun(*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(mem_fun(*this, &PlugUIBase::setting_selected));
389 save_button.set_name ("PluginSaveButton");
390 save_button.signal_clicked().connect(mem_fun(*this, &PlugUIBase::save_plugin_setting));
392 insert->ActiveChanged.connect (bind(
393 mem_fun(*this, &PlugUIBase::processor_active_changed),
394 boost::weak_ptr<Processor>(insert)));
396 bypass_button.set_active (!pi->active());
398 bypass_button.set_name ("PluginBypassButton");
399 bypass_button.signal_toggled().connect (mem_fun(*this, &PlugUIBase::bypass_toggled));
400 focus_button.add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK);
402 focus_button.signal_button_release_event().connect (mem_fun(*this, &PlugUIBase::focus_toggled));
403 focus_button.add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK);
405 /* these images are not managed, so that we can remove them at will */
407 focus_out_image = new Image (get_icon (X_("computer_keyboard")));
408 focus_in_image = new Image (get_icon (X_("computer_keyboard_active")));
410 focus_button.add (*focus_out_image);
412 ARDOUR_UI::instance()->set_tip (&focus_button, _("Click to allow the plugin to receive keyboard events that Ardour would normally use as a shortcut"), "");
413 ARDOUR_UI::instance()->set_tip (&bypass_button, _("Click to enable/disable this plugin"), "");
415 plugin_analysis_expander.property_expanded().signal_changed().connect( mem_fun(*this, &PlugUIBase::toggle_plugin_analysis));
416 plugin_analysis_expander.set_expanded(false);
418 insert->GoingAway.connect (mem_fun (*this, &PlugUIBase::plugin_going_away));
421 PlugUIBase::~PlugUIBase()
427 PlugUIBase::plugin_going_away ()
429 /* drop references to the plugin/insert */
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 (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(bind (mem_fun(*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 (preset_combo.get_active_text().length() > 0) {
477 const Plugin::PresetRecord* pr = plugin->preset_by_label(preset_combo.get_active_text());
479 plugin->load_preset(pr->uri);
481 warning << string_compose(_("Plugin preset %1 not found"),
482 preset_combo.get_active_text()) << endmsg;
488 PlugUIBase::save_plugin_setting ()
490 ArdourPrompter prompter (true);
491 prompter.set_prompt(_("Name of New Preset:"));
492 prompter.add_button (Gtk::Stock::ADD, Gtk::RESPONSE_ACCEPT);
493 prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
494 prompter.set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
499 switch (prompter.run ()) {
500 case Gtk::RESPONSE_ACCEPT:
502 prompter.get_result(name);
504 if (plugin->save_preset(name)) {
506 preset_combo.set_active_text (name);
514 PlugUIBase::bypass_toggled ()
518 if ((x = bypass_button.get_active()) == insert->active()) {
520 insert->deactivate ();
528 PlugUIBase::focus_toggled (GdkEventButton*)
530 if (Keyboard::the_keyboard().some_magic_widget_has_focus()) {
531 Keyboard::the_keyboard().magic_widget_drop_focus();
532 focus_button.remove ();
533 focus_button.add (*focus_out_image);
534 focus_out_image->show ();
535 ARDOUR_UI::instance()->set_tip (&focus_button, _("Click to allow the plugin to receive keyboard events that Ardour would normally use as a shortcut"), "");
537 Keyboard::the_keyboard().magic_widget_grab_focus();
538 focus_button.remove ();
539 focus_button.add (*focus_in_image);
540 focus_in_image->show ();
541 ARDOUR_UI::instance()->set_tip (&focus_button, _("Click to allow normal use of Ardour keyboard shortcuts"), "");
548 PlugUIBase::toggle_plugin_analysis()
550 if (plugin_analysis_expander.get_expanded() &&
551 !plugin_analysis_expander.get_child()) {
553 PluginEqGui *foo = new PluginEqGui(insert);
554 plugin_analysis_expander.add( *foo );
555 plugin_analysis_expander.show_all();
560 if (!plugin_analysis_expander.get_expanded() &&
561 (gui = plugin_analysis_expander.get_child())) {
564 //plugin_analysis_expander.remove(*gui);
565 plugin_analysis_expander.remove();
569 Gtk::Widget *toplevel = plugin_analysis_expander.get_toplevel();
571 std::cerr << "No toplevel widget?!?!" << std::endl;
575 Gtk::Container *cont = dynamic_cast<Gtk::Container *>(toplevel);
577 std::cerr << "Toplevel widget is not a container?!?" << std::endl;
581 Gtk::Allocation alloc(0, 0, 50, 50); // Just make it small
582 toplevel->size_allocate(alloc);
587 PlugUIBase::update_presets ()
589 vector<string> preset_labels;
590 vector<ARDOUR::Plugin::PresetRecord> presets = plugin->get_presets();
591 for (vector<ARDOUR::Plugin::PresetRecord>::const_iterator i = presets.begin();
592 i != presets.end(); ++i) {
593 preset_labels.push_back(i->label);
595 set_popdown_strings (preset_combo, preset_labels);