Numerical sort patch from mantis #2654
[ardour.git] / gtk2_ardour / plugin_ui.cc
index f9db649737b9f931a954b33f5f6cc569bbaea14f..8c32028d71c5789e4c9bfa213fb63e953364e850 100644 (file)
@@ -15,7 +15,6 @@
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #include <climits>
 
 #include <midi++/manager.h>
 
-#include <ardour/audioengine.h>
 #include <ardour/plugin.h>
 #include <ardour/insert.h>
 #include <ardour/ladspa_plugin.h>
 #ifdef VST_SUPPORT
 #include <ardour/vst_plugin.h>
 #endif
+#ifdef HAVE_LV2
+#include <ardour/lv2_plugin.h>
+#include "lv2_plugin_ui.h"
+#endif
 
 #include <lrdf.h>
 
@@ -53,6 +55,7 @@
 #include "utils.h"
 #include "gui_thread.h"
 #include "public_editor.h"
+#include "keyboard.h"
 
 #include "i18n.h"
 
@@ -63,111 +66,326 @@ using namespace Gtkmm2ext;
 using namespace Gtk;
 using namespace sigc;
 
-PluginUIWindow::PluginUIWindow (AudioEngine &engine, boost::shared_ptr<PluginInsert> insert, bool scrollable)
-       : ArdourDialog ("plugin ui")
+PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert> insert, bool scrollable)
+       : parent (win)
 {
-       if (insert->plugin()->has_editor()) {
+       bool have_gui = false;
+       non_gtk_gui = false;
+       was_visible = false;
 
-#ifdef VST_SUPPORT
+       if (insert->plugin()->has_editor()) {
+               switch (insert->type()) {
+               case ARDOUR::VST:
+                       have_gui = create_vst_editor (insert);
+                       break;
+
+               case ARDOUR::AudioUnit:
+                       have_gui = create_audiounit_editor (insert);
+                       break;
+                       
+               case ARDOUR::LADSPA:
+                       error << _("Eh? LADSPA plugins don't have editors!") << endmsg;
+                       break;
 
-               boost::shared_ptr<VSTPlugin> vp;
+               case ARDOUR::LV2:
+                       have_gui = create_lv2_editor (insert);
+                       break;
 
-               if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (insert->plugin())) != 0) {
-                       
-                       
-                       VSTPluginUI* vpu = new VSTPluginUI (insert, vp);
-                       
-                       _pluginui = vpu;
-                       get_vbox()->add (*vpu);
-                       vpu->package (*this);
-                       
-               } else {
-#endif
+               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 ();
-#ifdef VST_SUPPORT
                }
-#endif
 
-       } else {
+       } 
+
+       if (!have_gui) {
 
-               LadspaPluginUI*  pu  = new LadspaPluginUI (engine, insert, scrollable);
+               GenericPluginUI*  pu  = new GenericPluginUI (insert, scrollable);
                
                _pluginui = pu;
-               get_vbox()->add (*pu);
+               add (*pu);
                
-               signal_map_event().connect (mem_fun (*pu, &LadspaPluginUI::start_updating));
-               signal_unmap_event().connect (mem_fun (*pu, &LadspaPluginUI::stop_updating));
+               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));
        }
 
-       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 (bind (sigc::ptr_fun (just_hide_it), reinterpret_cast<Window*> (this)), false);
+       death_connection = insert->GoingAway.connect (mem_fun(*this, &PluginUIWindow::plugin_going_away));
+
+       gint h = _pluginui->get_preferred_height ();
+       gint w = _pluginui->get_preferred_width ();
 
        if (scrollable) {
-               gint h = _pluginui->get_preferred_height ();
                if (h > 600) h = 600;
-               set_default_size (450, h); 
+               if (w > 600) w = 600;
+
+               if (w < 0) {
+                       w = 450;
+               }
        }
 
+       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 ()
+{
+       if (_pluginui) {
+               _pluginui->update_presets ();
+       }
+
+       Window::on_show ();
+
+       if (parent) {
+               // set_transient_for (*parent);
+       }
+}
+
+void
+PluginUIWindow::on_hide ()
+{
+       Window::on_hide ();
+}
+
+bool
+PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert> insert)
+{
+#ifndef VST_SUPPORT
+       return false;
+#else
+
+       boost::shared_ptr<VSTPlugin> vp;
+
+       if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (insert->plugin())) == 0) {
+               error << _("unknown type of editor-supplying plugin (note: no VST support in this version of ardour)")
+                             << endmsg;
+               throw failed_constructor ();
+       } else {
+               VSTPluginUI* vpu = new VSTPluginUI (insert, vp);
+       
+               _pluginui = vpu;
+               add (*vpu);
+               vpu->package (*this);
+       }
+
+       non_gtk_gui = true;
+       return true;
+#endif
+}
+
+bool
+PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert> insert)
+{
+#if !defined(HAVE_AUDIOUNITS) || !defined(GTKOSX)
+       return false;
+#else
+       VBox* box;
+       _pluginui = create_au_gui (insert, &box);
+       add (*box);
+       non_gtk_gui = true;
+
+       extern sigc::signal<void,bool> ApplicationActivationChanged;
+       ApplicationActivationChanged.connect (mem_fun (*this, &PluginUIWindow::app_activated));
+
+       return true;
+#endif
+}
+
+void
+PluginUIWindow::app_activated (bool yn)
+{
+#if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
+       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 ();
+               }
+       } 
+#endif
+}
+
+bool
+PluginUIWindow::create_lv2_editor(boost::shared_ptr<PluginInsert> insert)
+{
+#ifndef HAVE_LV2
+       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 ();
+       } else {
+               LV2PluginUI* lpu = new LV2PluginUI (insert, vp);
+               _pluginui = lpu;
+               add (*lpu);
+               lpu->package (*this);
+       }
+
+       non_gtk_gui = false;
+       return true;
+#endif
+}
+
 bool
 PluginUIWindow::on_key_press_event (GdkEventKey* event)
 {
-       return PublicEditor::instance().on_key_press_event(event);
+       if (!key_press_focus_accelerator_handler (*this, event)) {
+               return PublicEditor::instance().on_key_press_event(event);
+       } else {
+               return true;
+       }
 }
 
 bool
 PluginUIWindow::on_key_release_event (GdkEventKey* event)
 {
-       return PublicEditor::instance().on_key_release_event(event);
+       return true;
 }
 
 void
-PluginUIWindow::plugin_going_away (ARDOUR::Redirect* ignored)
+PluginUIWindow::plugin_going_away ()
 {
-       ENSURE_GUI_THREAD(bind (mem_fun(*this, &PluginUIWindow::plugin_going_away), ignored));
+       ENSURE_GUI_THREAD(mem_fun(*this, &PluginUIWindow::plugin_going_away));
+
+       if (_pluginui) {
+               _pluginui->stop_updating(0);
+       }
        
-       _pluginui->stop_updating(0);
+       death_connection.disconnect ();
+
        delete_when_idle (this);
 }
 
 PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
        : insert (pi),
          plugin (insert->plugin()),
-         save_button(_("Add")),
+         save_button(_("Save")),
          bypass_button (_("Bypass"))
 {
-        //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);
+       preset_combo.set_size_request (100, -1);
+       update_presets ();
+
+       preset_combo.signal_changed().connect(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));
 
+       insert->active_changed.connect (mem_fun(*this, &PlugUIBase::redirect_active_changed));
+       bypass_button.set_active (!pi->active());
+
        bypass_button.set_name ("PluginBypassButton");
        bypass_button.signal_toggled().connect (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 (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, _("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"), "");
+}
+
+PlugUIBase::~PlugUIBase ()
+{
+}
+
+void
+PlugUIBase::redirect_active_changed (Redirect* r, void* src)
+{
+       ENSURE_GUI_THREAD(bind (mem_fun(*this, &PlugUIBase::redirect_active_changed), r, src));
+       bypass_button.set_active (!r->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) {
+               if (!plugin->load_preset(preset_combo.get_active_text())) {
+                       warning << string_compose(_("Plugin preset %1 not found"), preset_combo.get_active_text()) << endmsg;
                }
        }
-
 }
 
 void
@@ -177,8 +395,10 @@ 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:
@@ -188,9 +408,16 @@ PlugUIBase::save_plugin_setting ()
                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)) {
+
+                               /* a rather inefficient way to add the newly saved preset
+                                  to the list.
+                               */
+
+                               set_popdown_strings (preset_combo, plugin->get_presets());
+                               no_load_preset = true;
+                               preset_combo.set_active_text (name);
+                               no_load_preset = false;
                        }
                }
                break;
@@ -206,3 +433,40 @@ PlugUIBase::bypass_toggled ()
                insert->set_active (!x, this);
        }
 }
+
+bool
+PlugUIBase::focus_toggled (GdkEventButton* ev)
+{
+       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 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 allow normal use of Ardour keyboard shortcuts"), "");
+       }
+
+       return true;
+}
+
+void
+PlugUIBase::update_presets ()
+{
+       vector<string> presets = plugin->get_presets();
+       set_popdown_strings (preset_combo, plugin->get_presets());
+
+       string current_preset = plugin->current_preset();
+
+       if (!current_preset.empty()) {
+               for (vector<string>::iterator p = presets.begin(); p != presets.end(); ++p) {
+                       if (*p == current_preset) {
+                               preset_combo.set_active_text (current_preset);
+                       }
+               }
+       }
+}