Bring back contrained drag modifier with preference setting.
[ardour.git] / gtk2_ardour / plugin_ui.cc
index 5b281f33ab9bde78c1690ea4a503391888822620..2483cb35fae694a9f6ed39267236264357b96d59 100644 (file)
@@ -40,8 +40,6 @@
 #include <gtkmm2ext/slider_controller.h>
 #include <gtkmm2ext/application.h>
 
-#include "midi++/manager.h"
-
 #include "ardour/session.h"
 #include "ardour/plugin.h"
 #include "ardour/plugin_insert.h"
@@ -59,8 +57,6 @@
 #include "lv2_plugin_ui.h"
 #endif
 
-#include <lrdf.h>
-
 #include "ardour_window.h"
 #include "ardour_ui.h"
 #include "prompter.h"
 
 using namespace std;
 using namespace ARDOUR;
+using namespace ARDOUR_UI_UTILS;
 using namespace PBD;
 using namespace Gtkmm2ext;
 using namespace Gtk;
 
 PluginUIWindow::PluginUIWindow (
-       Gtk::Window*                    win,
        boost::shared_ptr<PluginInsert> insert,
        bool                            scrollable,
        bool                            editor)
-       : parent (win)
+       : ArdourWindow (string())
        , was_visible (false)
        , _keyboard_focused (false)
 #ifdef AUDIOUNIT_SUPPORT
@@ -96,7 +92,6 @@ PluginUIWindow::PluginUIWindow (
 
 {
        bool have_gui = false;
-
        Label* label = manage (new Label());
        label->set_markup ("<b>THIS IS THE PLUGIN UI</b>");
 
@@ -147,11 +142,9 @@ PluginUIWindow::PluginUIWindow (
                signal_unmap_event().connect (sigc::mem_fun (*pu, &GenericPluginUI::stop_updating));
        }
 
-       // 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 (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 ();
@@ -167,54 +160,12 @@ PluginUIWindow::PluginUIWindow (
 
 PluginUIWindow::~PluginUIWindow ()
 {
+#ifndef NDEBUG
+       cerr << "PluginWindow deleted for " << this << endl;
+#endif
        delete _pluginui;
 }
 
-void
-PluginUIWindow::set_parent (Gtk::Window* win)
-{
-       parent = win;
-}
-
-void
-PluginUIWindow::on_map ()
-{
-       Window::on_map ();
-#ifdef __APPLE__
-       set_keep_above (true);
-#endif // __APPLE__
-}
-
-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 ()
 {
@@ -236,10 +187,6 @@ PluginUIWindow::on_show ()
                        Window::on_show ();
                }
        }
-
-       if (parent) {
-               // set_transient_for (*parent);
-       }
 }
 
 void
@@ -281,7 +228,7 @@ PluginUIWindow::create_windows_vst_editor(boost::shared_ptr<PluginInsert>)
                      << endmsg;
                throw failed_constructor ();
        } else {
-               WindowsVSTPluginUI* vpu = new WindowsVSTPluginUI (insert, vp);
+               WindowsVSTPluginUI* vpu = new WindowsVSTPluginUI (insert, vp, GTK_WIDGET(this->gobj()));
 
                _pluginui = vpu;
                _pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
@@ -386,6 +333,7 @@ PluginUIWindow::create_lv2_editor(boost::shared_ptr<PluginInsert> insert)
                _pluginui = lpu;
                add (*lpu);
                lpu->package (*this);
+               _pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
        }
 
        return true;
@@ -405,10 +353,11 @@ PluginUIWindow::on_key_press_event (GdkEventKey* event)
 {
        if (_keyboard_focused) {
                if (_pluginui) {
+                       _pluginui->grab_focus();
                        if (_pluginui->non_gtk_gui()) {
                                _pluginui->forward_key_event (event);
                        } else {
-                               return relay_key_press (event, this);
+                                       return relay_key_press (event, this);
                        }
                }
                return true;
@@ -418,6 +367,7 @@ PluginUIWindow::on_key_press_event (GdkEventKey* event)
                */
 
                if (_pluginui) {
+                       _pluginui->grab_focus();
                        if (_pluginui->non_gtk_gui()) {
                                /* pass editor window as the window for the event
                                   to be handled in, not this one, because there are
@@ -460,8 +410,6 @@ PluginUIWindow::plugin_going_away ()
        }
 
        death_connection.disconnect ();
-
-       delete_when_idle (this);
 }
 
 PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
@@ -470,6 +418,7 @@ PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
        , add_button (_("Add"))
        , save_button (_("Save"))
        , delete_button (_("Delete"))
+       , reset_button (_("Reset"))
        , bypass_button (ArdourButton::led_default_elements)
        , description_expander (_("Description"))
        , plugin_analysis_expander (_("Plugin analysis"))
@@ -478,32 +427,37 @@ PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
        , eqgui (0)
 {
        _preset_modified.set_size_request (16, -1);
-       _preset_combo.signal_changed().connect(sigc::mem_fun(*this, &PlugUIBase::preset_selected));
+       _preset_combo.set_text("(default)");
        ARDOUR_UI::instance()->set_tip (_preset_combo, _("Presets (if any) for this plugin\n(Both factory and user-created)"));
        ARDOUR_UI::instance()->set_tip (add_button, _("Save a new preset"));
        ARDOUR_UI::instance()->set_tip (save_button, _("Save the current preset"));
        ARDOUR_UI::instance()->set_tip (delete_button, _("Delete the current preset"));
+       ARDOUR_UI::instance()->set_tip (reset_button, _("Reset parameters to default (if no parameters are in automation play mode)"));
        ARDOUR_UI::instance()->set_tip (bypass_button, _("Disable signal processing by the plugin"));
        _no_load_preset = 0;
 
        update_preset_list ();
        update_preset ();
 
-       add_button.set_name ("PluginAddButton");
-       add_button.signal_clicked().connect (sigc::mem_fun (*this, &PlugUIBase::add_plugin_setting));
+       add_button.set_name ("generic button");
+       add_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::add_plugin_setting));
+
+       save_button.set_name ("generic button");
+       save_button.signal_clicked.connect(sigc::mem_fun(*this, &PlugUIBase::save_plugin_setting));
+
+       delete_button.set_name ("generic button");
+       delete_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::delete_plugin_setting));
 
-       save_button.set_name ("PluginSaveButton");
-       save_button.signal_clicked().connect(sigc::mem_fun(*this, &PlugUIBase::save_plugin_setting));
+       reset_button.set_name ("generic button");
+       reset_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::reset_plugin_parameters));
 
-       delete_button.set_name ("PluginDeleteButton");
-       delete_button.signal_clicked().connect (sigc::mem_fun (*this, &PlugUIBase::delete_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_name ("plugin bypass button");
        bypass_button.set_text (_("Bypass"));
        bypass_button.set_active (!pi->active());
-       bypass_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PlugUIBase::bypass_button_release));
+       bypass_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PlugUIBase::bypass_button_release), false);
        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));
@@ -531,6 +485,10 @@ PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
        plugin->PresetRemoved.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::preset_added_or_removed, this), gui_context ());
        plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::update_preset, this), gui_context ());
        plugin->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::parameter_changed, this, _1, _2), gui_context ());
+
+       insert->AutomationStateChanged.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::automation_state_changed, this), gui_context());
+
+       automation_state_changed();
 }
 
 PlugUIBase::~PlugUIBase()
@@ -561,7 +519,7 @@ PlugUIBase::set_latency_label ()
                t = string_compose (_("latency (%1 ms)"), (float) l / ((float) sr / 1000.0f));
        }
 
-       latency_label.set_text (t);
+       latency_button.set_text (t);
 }
 
 void
@@ -570,7 +528,6 @@ 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 ArdourWindow (_("Edit Latency"));
-               latency_dialog->set_position (WIN_POS_MOUSE);
                /* use both keep-above and transient for to try cover as many
                   different WM's as possible.
                */
@@ -598,29 +555,40 @@ PlugUIBase::processor_active_changed (boost::weak_ptr<Processor> weak_p)
 }
 
 void
-PlugUIBase::preset_selected ()
+PlugUIBase::preset_selected (Plugin::PresetRecord preset)
 {
        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);
-               } else {
-                       warning << string_compose(_("Plugin preset %1 not found"),
-                                                 _preset_combo.get_active_text()) << endmsg;
-               }
+       if (!preset.label.empty()) {
+               plugin->load_preset (preset);
        } else {
                // blank selected = no preset
                plugin->clear_preset();
        }
 }
 
+#ifdef NO_PLUGIN_STATE
+static bool seen_saving_message = false;
+
+static void show_no_plugin_message()
+{
+       info << string_compose (_("Plugin presets are not supported in this build of %1. Consider paying for a full version"),
+                       PROGRAM_NAME)
+            << endmsg;
+       info << _("To get full access to updates without this limitation\n"
+                 "consider becoming a subscriber for a low cost every month.")
+            << endmsg;
+       info << X_("https://community.ardour.org/s/subscribe")
+            << endmsg;
+       ARDOUR_UI::instance()->popup_error(_("Plugin presets are not supported in this build, see the Log window for more information."));
+}
+#endif
+
 void
 PlugUIBase::add_plugin_setting ()
 {
+#ifndef NO_PLUGIN_STATE
        NewPluginPresetDialog d (plugin);
 
        switch (d.run ()) {
@@ -639,23 +607,55 @@ PlugUIBase::add_plugin_setting ()
                }
                break;
        }
+#else 
+       if (!seen_saving_message) {
+               seen_saving_message = true;
+               show_no_plugin_message();
+       }
+#endif
 }
 
 void
 PlugUIBase::save_plugin_setting ()
 {
-       string const name = _preset_combo.get_active_text ();
+#ifndef NO_PLUGIN_STATE
+       string const name = _preset_combo.get_text ();
        plugin->remove_preset (name);
        Plugin::PresetRecord const r = plugin->save_preset (name);
        if (!r.uri.empty ()) {
                plugin->load_preset (r);
        }
+#else 
+       if (!seen_saving_message) {
+               seen_saving_message = true;
+               show_no_plugin_message();
+       }
+#endif
 }
 
 void
 PlugUIBase::delete_plugin_setting ()
 {
-       plugin->remove_preset (_preset_combo.get_active_text ());
+#ifndef NO_PLUGIN_STATE
+       plugin->remove_preset (_preset_combo.get_text ());
+#else
+       if (!seen_saving_message) {
+               seen_saving_message = true;
+               show_no_plugin_message();
+       }
+#endif
+}
+
+void
+PlugUIBase::automation_state_changed ()
+{
+       reset_button.set_sensitive (insert->can_reset_all_parameters());
+}
+
+void
+PlugUIBase::reset_plugin_parameters ()
+{
+       insert->reset_parameters_to_default ();
 }
 
 bool
@@ -758,18 +758,23 @@ PlugUIBase::toggle_plugin_analysis()
 void
 PlugUIBase::update_preset_list ()
 {
-       vector<string> preset_labels;
+       using namespace Menu_Helpers;
+
        vector<ARDOUR::Plugin::PresetRecord> presets = plugin->get_presets();
 
        ++_no_load_preset;
 
+       // Add a menu entry for each preset
+       _preset_combo.clear_items();
        for (vector<ARDOUR::Plugin::PresetRecord>::const_iterator i = presets.begin(); i != presets.end(); ++i) {
-               preset_labels.push_back (i->label);
+               _preset_combo.AddMenuElem(
+                       MenuElem(i->label, sigc::bind(sigc::mem_fun(*this, &PlugUIBase::preset_selected), *i)));
        }
 
-       preset_labels.push_back("");
-
-       set_popdown_strings (_preset_combo, preset_labels);
+       // Add an empty entry for un-setting current preset (see preset_selected)
+       Plugin::PresetRecord no_preset;
+       _preset_combo.AddMenuElem(
+               MenuElem("", sigc::bind(sigc::mem_fun(*this, &PlugUIBase::preset_selected), no_preset)));
 
        --_no_load_preset;
 }
@@ -780,7 +785,11 @@ PlugUIBase::update_preset ()
        Plugin::PresetRecord p = plugin->last_preset();
 
        ++_no_load_preset;
-       _preset_combo.set_active_text (p.label);
+       if (p.uri.empty()) {
+               _preset_combo.set_text (_("(none)"));
+       } else {
+               _preset_combo.set_text (p.label);
+       }
        --_no_load_preset;
 
        save_button.set_sensitive (!p.uri.empty() && p.user);