Small cleanups to port matrix context menu.
[ardour.git] / gtk2_ardour / plugin_ui.cc
index dbb5f3969e1c8e4faa98b57c66f8134fdd4d50aa..b6326392e2ff1760996528ce580904c183baa582 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/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_LV2
-#include <ardour/lv2_plugin.h>
+#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"
@@ -57,6 +63,8 @@
 #include "gui_thread.h"
 #include "public_editor.h"
 #include "keyboard.h"
+#include "latency_gui.h"
+#include "plugin_eq_gui.h"
 
 #include "i18n.h"
 
@@ -86,7 +94,7 @@ PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert
                case ARDOUR::AudioUnit:
                        have_gui = create_audiounit_editor (insert);
                        break;
-                       
+
                case ARDOUR::LADSPA:
                        error << _("Eh? LADSPA plugins don't have editors!") << endmsg;
                        break;
@@ -106,12 +114,12 @@ PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert
                        throw failed_constructor ();
                }
 
-       } 
+       }
 
        if (!have_gui) {
 
                GenericPluginUI*  pu  = new GenericPluginUI (insert, scrollable);
-               
+
                _pluginui = pu;
                add( *pu );
 
@@ -120,7 +128,7 @@ PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert
                hbox->pack_start( *pu);
                // TODO: this should be nicer
                hbox->pack_start( eqgui_bin );
-               
+
                add (*manage(hbox));
                */
 
@@ -135,7 +143,7 @@ PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert
        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)), false);
-       insert->GoingAway.connect (mem_fun(*this, &PluginUIWindow::plugin_going_away));
+       death_connection = insert->GoingAway.connect (mem_fun(*this, &PluginUIWindow::plugin_going_away));
 
        gint h = _pluginui->get_preferred_height ();
        gint w = _pluginui->get_preferred_width ();
@@ -149,11 +157,12 @@ PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert
                }
        }
 
-       set_default_size (w, h); 
+       set_default_size (w, h);
 }
 
 PluginUIWindow::~PluginUIWindow ()
 {
+       delete _pluginui;
 }
 
 void
@@ -202,11 +211,17 @@ PluginUIWindow::on_focus_out_event (GdkEventFocus *ev)
 void
 PluginUIWindow::on_show ()
 {
+       set_role("plugin_ui");
+
        if (_pluginui) {
                _pluginui->update_presets ();
        }
 
-       Window::on_show ();
+       if (_pluginui) {
+               if (_pluginui->on_window_show (_title)) {
+                       Window::on_show ();
+               }
+       }
 
        if (parent) {
                // set_transient_for (*parent);
@@ -217,10 +232,26 @@ 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;
@@ -234,7 +265,7 @@ PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert> insert)
                throw failed_constructor ();
        } else {
                VSTPluginUI* vpu = new VSTPluginUI (insert, vp);
-       
+
                _pluginui = vpu;
                add (*vpu);
                vpu->package (*this);
@@ -246,7 +277,11 @@ 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;
@@ -264,7 +299,11 @@ PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert> insert)
 }
 
 void
+#if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
 PluginUIWindow::app_activated (bool yn)
+#else
+PluginUIWindow::app_activated (bool)
+#endif
 {
 #if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
        cerr << "APP activated ? " << yn << endl;
@@ -280,19 +319,19 @@ PluginUIWindow::app_activated (bool yn)
                        hide ();
                        _pluginui->deactivate ();
                }
-       } 
+       }
 #endif
 }
 
 bool
 PluginUIWindow::create_lv2_editor(boost::shared_ptr<PluginInsert> insert)
 {
-#ifndef HAVE_LV2
+#ifndef HAVE_SLV2
        return false;
 #else
 
        boost::shared_ptr<LV2Plugin> vp;
-       
+
        if ((vp = boost::dynamic_pointer_cast<LV2Plugin> (insert->plugin())) == 0) {
                error << _("create_lv2_editor called on non-LV2 plugin") << endmsg;
                throw failed_constructor ();
@@ -311,15 +350,11 @@ PluginUIWindow::create_lv2_editor(boost::shared_ptr<PluginInsert> insert)
 bool
 PluginUIWindow::on_key_press_event (GdkEventKey* event)
 {
-       if (!key_press_focus_accelerator_handler (*this, event)) {
-               return PublicEditor::instance().on_key_press_event(event);
-       } else {
-               return true;
-       }
+       return relay_key_press (event, this);
 }
 
 bool
-PluginUIWindow::on_key_release_event (GdkEventKey* event)
+PluginUIWindow::on_key_release_event (GdkEventKey *)
 {
        return true;
 }
@@ -328,10 +363,13 @@ void
 PluginUIWindow::plugin_going_away ()
 {
        ENSURE_GUI_THREAD(mem_fun(*this, &PluginUIWindow::plugin_going_away));
-       
+
        if (_pluginui) {
                _pluginui->stop_updating(0);
        }
+
+       death_connection.disconnect ();
+
        delete_when_idle (this);
 }
 
@@ -340,10 +378,11 @@ 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"))
 {
-        //preset_combo.set_use_arrows_always(true);
-       set_popdown_strings (preset_combo, plugin->get_presets());
+       //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(mem_fun(*this, &PlugUIBase::setting_selected));
@@ -354,7 +393,7 @@ PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
        insert->ActiveChanged.connect (bind(
                        mem_fun(*this, &PlugUIBase::processor_active_changed),
                        boost::weak_ptr<Processor>(insert)));
-       
+
        bypass_button.set_active (!pi->active());
 
        bypass_button.set_name ("PluginBypassButton");
@@ -368,11 +407,58 @@ PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
 
        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, _("Click to focus all keyboard events on this plugin window"), "");
+       ARDOUR_UI::instance()->set_tip (&focus_button, _("Click to allow the plugin to receive keyboard events that Ardour would normally use as a shortcut"), "");
        ARDOUR_UI::instance()->set_tip (&bypass_button, _("Click to enable/disable this plugin"), "");
+
+       plugin_analysis_expander.property_expanded().signal_changed().connect( mem_fun(*this, &PlugUIBase::toggle_plugin_analysis));
+       plugin_analysis_expander.set_expanded(false);
+
+       insert->GoingAway.connect (mem_fun (*this, &PlugUIBase::plugin_going_away));
+}
+
+PlugUIBase::~PlugUIBase()
+{
+       delete latency_gui;
+}
+
+void
+PlugUIBase::plugin_going_away ()
+{
+       /* drop references to the plugin/insert */
+       insert.reset ();
+       plugin.reset ();
+}
+
+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 (mem_fun (*this, &PlugUIBase::set_latency_label));
+       }
+
+       latency_dialog->show_all ();
 }
 
 void
@@ -389,8 +475,12 @@ void
 PlugUIBase::setting_selected()
 {
        if (preset_combo.get_active_text().length() > 0) {
-               if (!plugin->load_preset(preset_combo.get_active_text())) {
-                       warning << string_compose(_("Plugin preset %1 not found"), preset_combo.get_active_text()) << endmsg;
+               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;
                }
        }
 }
@@ -405,17 +495,15 @@ PlugUIBase::save_plugin_setting ()
        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 (preset_combo, plugin->get_presets());
+                       if (plugin->save_preset(name)) {
+                               update_presets();
                                preset_combo.set_active_text (name);
                        }
                }
@@ -429,32 +517,81 @@ 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* ev)
+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, _("Click to focus all keyboard events on this plugin window"), "");
+               ARDOUR_UI::instance()->set_tip (&focus_button, _("Click to allow the plugin to receive keyboard events that Ardour would normally use as a shortcut"), "");
        } 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, _("Click to remove keyboard focus from this plugin window"), "");
+               ARDOUR_UI::instance()->set_tip (&focus_button, _("Click to allow normal use of Ardour keyboard shortcuts"), "");
        }
 
        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 ()
 {
-       set_popdown_strings (preset_combo, plugin->get_presets());
+       vector<string> preset_labels;
+       vector<ARDOUR::Plugin::PresetRecord> presets = plugin->get_presets();
+       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);
 }