Add GPL boilerplate.
[ardour.git] / gtk2_ardour / plugin_ui.cc
index 0f2eedb080e4f7be254183b3eb78b94bb04c1355..c575a3053ea6118d36dbb78982991f1c2726ccd2 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000 Paul Davis 
+    Copyright (C) 2000 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
+#ifdef WAF_BUILD
+#include "gtk2ardour-config.h"
+#endif
+
 #include <climits>
 #include <cerrno>
 #include <cmath>
 #include <string>
 
-#include <pbd/stl_delete.h>
-#include <pbd/xml++.h>
-#include <pbd/failed_constructor.h>
+#include "pbd/stl_delete.h"
+#include "pbd/xml++.h"
+#include "pbd/failed_constructor.h"
 
 #include <gtkmm/widget.h>
+#include <gtkmm/box.h>
 #include <gtkmm2ext/click_box.h>
 #include <gtkmm2ext/fastmeter.h>
 #include <gtkmm2ext/barcontroller.h>
 #include <gtkmm2ext/doi.h>
 #include <gtkmm2ext/slider_controller.h>
 
-#include <midi++/manager.h>
+#include "midi++/manager.h"
 
-#include <ardour/plugin.h>
-#include <ardour/plugin_insert.h>
-#include <ardour/ladspa_plugin.h>
+#include "ardour/session.h"
+#include "ardour/plugin.h"
+#include "ardour/plugin_insert.h"
+#include "ardour/ladspa_plugin.h"
 #ifdef VST_SUPPORT
-#include <ardour/vst_plugin.h>
+#include "ardour/vst_plugin.h"
+#endif
+#ifdef HAVE_SLV2
+#include "ardour/lv2_plugin.h"
+#include "lv2_plugin_ui.h"
 #endif
 
 #include <lrdf.h>
 
+#include "ardour_dialog.h"
 #include "ardour_ui.h"
 #include "prompter.h"
 #include "plugin_ui.h"
 #include "utils.h"
 #include "gui_thread.h"
 #include "public_editor.h"
+#include "keyboard.h"
+#include "latency_gui.h"
+#include "plugin_eq_gui.h"
 
 #include "i18n.h"
 
@@ -59,13 +73,16 @@ using namespace ARDOUR;
 using namespace PBD;
 using namespace Gtkmm2ext;
 using namespace Gtk;
-using namespace sigc;
 
-PluginUIWindow::PluginUIWindow (boost::shared_ptr<PluginInsert> insert, nframes64_t sr, nframes64_t period, bool scrollable)
-       : ArdourDialog ("plugin ui")
+PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert> insert, bool scrollable)
+       : parent (win)
 {
        bool have_gui = false;
        non_gtk_gui = false;
+       was_visible = false;
+
+       Label* label = manage (new Label());
+       label->set_markup ("<b>THIS IS THE PLUGIN UI</b>");
 
        if (insert->plugin()->has_editor()) {
                switch (insert->type()) {
@@ -76,38 +93,56 @@ PluginUIWindow::PluginUIWindow (boost::shared_ptr<PluginInsert> insert, nframes6
                case ARDOUR::AudioUnit:
                        have_gui = create_audiounit_editor (insert);
                        break;
-                       
+
                case ARDOUR::LADSPA:
                        error << _("Eh? LADSPA plugins don't have editors!") << endmsg;
                        break;
 
+               case ARDOUR::LV2:
+                       have_gui = create_lv2_editor (insert);
+                       break;
+
                default:
+#ifndef VST_SUPPORT
                        error << _("unknown type of editor-supplying plugin (note: no VST support in this version of ardour)")
                              << endmsg;
+#else
+                       error << _("unknown type of editor-supplying plugin")
+                             << endmsg;
+#endif
                        throw failed_constructor ();
                }
 
-       } 
+       }
 
        if (!have_gui) {
 
                GenericPluginUI*  pu  = new GenericPluginUI (insert, scrollable);
-               
+
                _pluginui = pu;
-               get_vbox()->add (*pu);
-               
+               add (*pu);
+
+               /*
+               Gtk::HBox *hbox = new Gtk::HBox();
+               hbox->pack_start( *pu);
+               // TODO: this should be nicer
+               hbox->pack_start( eqgui_bin );
+
+               add (*manage(hbox));
+               */
+
                set_wmclass (X_("ardour_plugin_editor"), "Ardour");
 
-               signal_map_event().connect (mem_fun (*pu, &GenericPluginUI::start_updating));
-               signal_unmap_event().connect (mem_fun (*pu, &GenericPluginUI::stop_updating));
+               signal_map_event().connect (sigc::mem_fun (*pu, &GenericPluginUI::start_updating));
+               signal_unmap_event().connect (sigc::mem_fun (*pu, &GenericPluginUI::stop_updating));
        }
 
-       set_position (Gtk::WIN_POS_MOUSE);
+       // set_position (Gtk::WIN_POS_MOUSE);
        set_name ("PluginEditor");
        add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK|Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
 
-       signal_delete_event().connect (bind (sigc::ptr_fun (just_hide_it), reinterpret_cast<Window*> (this)));
-       insert->GoingAway.connect (mem_fun(*this, &PluginUIWindow::plugin_going_away));
+       signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), reinterpret_cast<Window*> (this)), false);
+       insert->DropReferences.connect (death_connection, invalidator (*this), boost::bind (&PluginUIWindow::plugin_going_away, this), gui_context());
 
        gint h = _pluginui->get_preferred_height ();
        gint w = _pluginui->get_preferred_width ();
@@ -121,15 +156,101 @@ PluginUIWindow::PluginUIWindow (boost::shared_ptr<PluginInsert> insert, nframes6
                }
        }
 
-       set_default_size (w, h); 
+       set_default_size (w, h);
 }
 
 PluginUIWindow::~PluginUIWindow ()
 {
+       delete _pluginui;
+}
+
+void
+PluginUIWindow::set_parent (Gtk::Window* win)
+{
+       parent = win;
+}
+
+void
+PluginUIWindow::on_map ()
+{
+       Window::on_map ();
+       set_keep_above (true);
 }
 
 bool
+PluginUIWindow::on_enter_notify_event (GdkEventCrossing *ev)
+{
+       Keyboard::the_keyboard().enter_window (ev, this);
+       return false;
+}
+
+bool
+PluginUIWindow::on_leave_notify_event (GdkEventCrossing *ev)
+{
+       Keyboard::the_keyboard().leave_window (ev, this);
+       return false;
+}
+
+bool
+PluginUIWindow::on_focus_in_event (GdkEventFocus *ev)
+{
+       Window::on_focus_in_event (ev);
+       //Keyboard::the_keyboard().magic_widget_grab_focus ();
+       return false;
+}
+
+bool
+PluginUIWindow::on_focus_out_event (GdkEventFocus *ev)
+{
+       Window::on_focus_out_event (ev);
+       //Keyboard::the_keyboard().magic_widget_drop_focus ();
+       return false;
+}
+
+void
+PluginUIWindow::on_show ()
+{
+       set_role("plugin_ui");
+
+       if (_pluginui) {
+               _pluginui->update_presets ();
+       }
+
+       if (_pluginui) {
+               if (_pluginui->on_window_show (_title)) {
+                       Window::on_show ();
+               }
+       }
+
+       if (parent) {
+               // set_transient_for (*parent);
+       }
+}
+
+void
+PluginUIWindow::on_hide ()
+{
+       Window::on_hide ();
+
+       if (_pluginui) {
+               _pluginui->on_window_hide ();
+       }
+}
+
+void
+PluginUIWindow::set_title(const Glib::ustring& title)
+{
+       //cout << "PluginUIWindow::set_title(\"" << title << "\"" << endl;
+       Gtk::Window::set_title(title);
+       _title = title;
+}
+
+bool
+#ifdef VST_SUPPORT
 PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert> insert)
+#else
+PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert>)
+#endif
 {
 #ifndef VST_SUPPORT
        return false;
@@ -143,9 +264,9 @@ PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert> insert)
                throw failed_constructor ();
        } else {
                VSTPluginUI* vpu = new VSTPluginUI (insert, vp);
-       
+
                _pluginui = vpu;
-               get_vbox()->add (*vpu);
+               add (*vpu);
                vpu->package (*this);
        }
 
@@ -155,50 +276,84 @@ PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert> insert)
 }
 
 bool
+#if defined (HAVE_AUDIOUNITS) && defined (GTKOSX)
 PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert> insert)
+#else
+PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert>)
+#endif
 {
 #if !defined(HAVE_AUDIOUNITS) || !defined(GTKOSX)
        return false;
 #else
        VBox* box;
        _pluginui = create_au_gui (insert, &box);
-       get_vbox()->add (*box);
+       add (*box);
        non_gtk_gui = true;
 
        extern sigc::signal<void,bool> ApplicationActivationChanged;
-       ApplicationActivationChanged.connect (mem_fun (*this, &PluginUIWindow::app_activated));
+       ApplicationActivationChanged.connect (sigc::mem_fun (*this, &PluginUIWindow::app_activated));
 
        return true;
 #endif
 }
 
 void
+#if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
 PluginUIWindow::app_activated (bool yn)
+#else
+PluginUIWindow::app_activated (bool)
+#endif
 {
 #if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
-       if (yn) {
-               _pluginui->activate ();
+       cerr << "APP activated ? " << yn << endl;
+       if (_pluginui) {
+               if (yn) {
+                       if (was_visible) {
+                               _pluginui->activate ();
+                               present ();
+                               was_visible = true;
+                       }
+               } else {
+                       was_visible = is_visible();
+                       hide ();
+                       _pluginui->deactivate ();
+               }
        }
-       cerr << "activated ? " << yn << endl;
 #endif
 }
 
 bool
-PluginUIWindow::on_key_press_event (GdkEventKey* event)
+PluginUIWindow::create_lv2_editor(boost::shared_ptr<PluginInsert> insert)
 {
-       if (non_gtk_gui) {
-               return false;
-       }
+#ifndef HAVE_SLV2
+       return false;
+#else
+
+       boost::shared_ptr<LV2Plugin> vp;
 
-       if (!key_press_focus_accelerator_handler (*this, event)) {
-               return PublicEditor::instance().on_key_press_event(event);
+       if ((vp = boost::dynamic_pointer_cast<LV2Plugin> (insert->plugin())) == 0) {
+               error << _("create_lv2_editor called on non-LV2 plugin") << endmsg;
+               throw failed_constructor ();
        } else {
-               return true;
+               LV2PluginUI* lpu = new LV2PluginUI (insert, vp);
+               _pluginui = lpu;
+               add (*lpu);
+               lpu->package (*this);
        }
+
+       non_gtk_gui = false;
+       return true;
+#endif
 }
 
 bool
-PluginUIWindow::on_key_release_event (GdkEventKey* event)
+PluginUIWindow::on_key_press_event (GdkEventKey* event)
+{
+       return relay_key_press (event, this);
+}
+
+bool
+PluginUIWindow::on_key_release_event (GdkEventKey *)
 {
        return true;
 }
@@ -206,9 +361,14 @@ PluginUIWindow::on_key_release_event (GdkEventKey* event)
 void
 PluginUIWindow::plugin_going_away ()
 {
-       ENSURE_GUI_THREAD(mem_fun(*this, &PluginUIWindow::plugin_going_away));
-       
-       _pluginui->stop_updating(0);
+       ENSURE_GUI_THREAD (*this, &PluginUIWindow::plugin_going_away)
+
+       if (_pluginui) {
+               _pluginui->stop_updating(0);
+       }
+
+       death_connection.disconnect ();
+
        delete_when_idle (this);
 }
 
@@ -217,30 +377,115 @@ PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
          plugin (insert->plugin()),
          save_button(_("Add")),
          bypass_button (_("Bypass")),
-         latency_gui (*pi, pi->session().frame_rate(), pi->session().get_block_size())
+         latency_gui (0),
+         plugin_analysis_expander (_("Plugin analysis"))
 {
-        //combo.set_use_arrows_always(true);
-       set_popdown_strings (combo, plugin->get_presets());
-       combo.set_size_request (100, -1);
-       combo.set_active_text ("");
-       combo.signal_changed().connect(mem_fun(*this, &PlugUIBase::setting_selected));
+       //preset_combo.set_use_arrows_always(true);
+       update_presets();
+       preset_combo.set_size_request (100, -1);
+       preset_combo.set_active_text ("");
+       preset_combo.signal_changed().connect(sigc::mem_fun(*this, &PlugUIBase::setting_selected));
+       no_load_preset = false;
 
        save_button.set_name ("PluginSaveButton");
-       save_button.signal_clicked().connect(mem_fun(*this, &PlugUIBase::save_plugin_setting));
+       save_button.signal_clicked().connect(sigc::mem_fun(*this, &PlugUIBase::save_plugin_setting));
+
+       insert->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&PlugUIBase::processor_active_changed, this,  boost::weak_ptr<Processor>(insert)), gui_context());
+
+       bypass_button.set_active (!pi->active());
 
        bypass_button.set_name ("PluginBypassButton");
-       bypass_button.signal_toggled().connect (mem_fun(*this, &PlugUIBase::bypass_toggled));
+       bypass_button.signal_toggled().connect (sigc::mem_fun(*this, &PlugUIBase::bypass_toggled));
+       focus_button.add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK);
+
+       focus_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PlugUIBase::focus_toggled));
+       focus_button.add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK);
+
+       /* these images are not managed, so that we can remove them at will */
+
+       focus_out_image = new Image (get_icon (X_("computer_keyboard")));
+       focus_in_image = new Image (get_icon (X_("computer_keyboard_active")));
+
+       focus_button.add (*focus_out_image);
+
+       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));
+       ARDOUR_UI::instance()->set_tip (bypass_button, _("Click to enable/disable this plugin"));
+
+       plugin_analysis_expander.property_expanded().signal_changed().connect( sigc::mem_fun(*this, &PlugUIBase::toggle_plugin_analysis));
+       plugin_analysis_expander.set_expanded(false);
+       
+       insert->DropReferences.connect (death_connection, invalidator (*this), boost::bind (&PlugUIBase::plugin_going_away, this), gui_context());
+}
+
+PlugUIBase::~PlugUIBase()
+{
+       delete latency_gui;
+}
+
+void
+PlugUIBase::plugin_going_away ()
+{
+       /* drop references to the plugin/insert */
+       insert.reset ();
+       plugin.reset ();
+       death_connection.disconnect ();
+}
+
+void
+PlugUIBase::set_latency_label ()
+{
+       char buf[64];
+       nframes_t l = insert->effective_latency ();
+       nframes_t sr = insert->session().frame_rate();
+
+       if (l < sr / 1000) {
+               snprintf (buf, sizeof (buf), "latency (%d samples)", l);
+       } else {
+               snprintf (buf, sizeof (buf), "latency (%.2f msecs)", (float) l / ((float) sr / 1000.0f));
+       }
+
+       latency_label.set_text (buf);
+}
+
+void
+PlugUIBase::latency_button_clicked ()
+{
+       if (!latency_gui) {
+               latency_gui = new LatencyGUI (*(insert.get()), insert->session().frame_rate(), insert->session().get_block_size());
+               latency_dialog = new ArdourDialog ("Edit Latency", false, false);
+               latency_dialog->get_vbox()->pack_start (*latency_gui);
+               latency_dialog->signal_hide().connect (sigc::mem_fun (*this, &PlugUIBase::set_latency_label));
+       }
+
+       latency_dialog->show_all ();
+}
+
+void
+PlugUIBase::processor_active_changed (boost::weak_ptr<Processor> weak_p)
+{
+       ENSURE_GUI_THREAD (*this, &PlugUIBase::processor_active_changed, weak_p)
+       boost::shared_ptr<Processor> p (weak_p);
+       if (p) {
+               bypass_button.set_active (!p->active());
+       }
 }
 
 void
 PlugUIBase::setting_selected()
 {
-       if (combo.get_active_text().length() > 0) {
-               if (!plugin->load_preset(combo.get_active_text())) {
-                       warning << string_compose(_("Plugin preset %1 not found"), combo.get_active_text()) << endmsg;
-               }
+       if (no_load_preset) {
+               return;
        }
 
+       if (preset_combo.get_active_text().length() > 0) {
+               const Plugin::PresetRecord* pr = plugin->preset_by_label(preset_combo.get_active_text());
+               if (pr) {
+                       plugin->load_preset(pr->uri);
+               } else {
+                       warning << string_compose(_("Plugin preset %1 not found"),
+                                       preset_combo.get_active_text()) << endmsg;
+               }
+       }
 }
 
 void
@@ -250,20 +495,21 @@ PlugUIBase::save_plugin_setting ()
        prompter.set_prompt(_("Name of New Preset:"));
        prompter.add_button (Gtk::Stock::ADD, Gtk::RESPONSE_ACCEPT);
        prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
+       prompter.set_type_hint (Gdk::WINDOW_TYPE_HINT_UTILITY);
 
        prompter.show_all();
+       prompter.present ();
 
        switch (prompter.run ()) {
        case Gtk::RESPONSE_ACCEPT:
-
                string name;
-
                prompter.get_result(name);
-
                if (name.length()) {
-                       if(plugin->save_preset(name)){
-                               set_popdown_strings (combo, plugin->get_presets());
-                               combo.set_active_text (name);
+                       if (plugin->save_preset(name)) {
+                               update_presets();
+                               no_load_preset = true;
+                               preset_combo.set_active_text (name);
+                               no_load_preset = false;
                        }
                }
                break;
@@ -276,6 +522,86 @@ PlugUIBase::bypass_toggled ()
        bool x;
 
        if ((x = bypass_button.get_active()) == insert->active()) {
-               insert->set_active (!x);
+               if (x) {
+                       insert->deactivate ();
+               } else {
+                       insert->activate ();
+               }
+       }
+}
+
+bool
+PlugUIBase::focus_toggled (GdkEventButton*)
+{
+       if (Keyboard::the_keyboard().some_magic_widget_has_focus()) {
+               Keyboard::the_keyboard().magic_widget_drop_focus();
+               focus_button.remove ();
+               focus_button.add (*focus_out_image);
+               focus_out_image->show ();
+               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));
+       } else {
+               Keyboard::the_keyboard().magic_widget_grab_focus();
+               focus_button.remove ();
+               focus_button.add (*focus_in_image);
+               focus_in_image->show ();
+               ARDOUR_UI::instance()->set_tip (focus_button, string_compose (_("Click to allow normal use of %1 keyboard shortcuts"), PROGRAM_NAME));
+       }
+
+       return true;
+}
+
+void
+PlugUIBase::toggle_plugin_analysis()
+{
+       if (plugin_analysis_expander.get_expanded() &&
+            !plugin_analysis_expander.get_child()) {
+               // Create the GUI
+               PluginEqGui *foo = new PluginEqGui(insert);
+               plugin_analysis_expander.add( *foo );
+               plugin_analysis_expander.show_all();
        }
+
+       Gtk::Widget *gui;
+
+       if (!plugin_analysis_expander.get_expanded() &&
+            (gui = plugin_analysis_expander.get_child())) {
+               // Hide & remove
+               gui->hide();
+               //plugin_analysis_expander.remove(*gui);
+               plugin_analysis_expander.remove();
+
+               delete gui;
+
+               Gtk::Widget *toplevel = plugin_analysis_expander.get_toplevel();
+               if (!toplevel) {
+                       std::cerr << "No toplevel widget?!?!" << std::endl;
+                       return;
+               }
+
+               Gtk::Container *cont = dynamic_cast<Gtk::Container *>(toplevel);
+               if (!cont) {
+                       std::cerr << "Toplevel widget is not a container?!?" << std::endl;
+                       return;
+               }
+
+               Gtk::Allocation alloc(0, 0, 50, 50); // Just make it small
+               toplevel->size_allocate(alloc);
+       }
+}
+
+void
+PlugUIBase::update_presets ()
+{
+       vector<string> preset_labels;
+       vector<ARDOUR::Plugin::PresetRecord> presets = plugin->get_presets();
+
+       no_load_preset = true;
+
+       for (vector<ARDOUR::Plugin::PresetRecord>::const_iterator i = presets.begin(); i != presets.end(); ++i) {
+               preset_labels.push_back(i->label);
+       }
+
+       set_popdown_strings (preset_combo, preset_labels);
+       
+       no_load_preset = false;
 }