Merge branch 'master' into windows
[ardour.git] / gtk2_ardour / plugin_ui.cc
index 1e54344a83bdeb64e03f9890aa0fede1c283dd08..4423e3905dced33d360825f931aa25ab712c9e6b 100644 (file)
 #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"
 #include "ardour/ladspa_plugin.h"
-#ifdef VST_SUPPORT
-#include "ardour/vst_plugin.h"
-#include "vst_pluginui.h"
+#ifdef WINDOWS_VST_SUPPORT
+#include "ardour/windows_vst_plugin.h"
+#include "windows_vst_plugin_ui.h"
+#endif
+#ifdef LXVST_SUPPORT
+#include "ardour/lxvst_plugin.h"
+#include "lxvst_plugin_ui.h"
 #endif
 #ifdef LV2_SUPPORT
 #include "ardour/lv2_plugin.h"
 #include "lv2_plugin_ui.h"
 #endif
 
-#include <lrdf.h>
-
-#include "ardour_dialog.h"
+#include "ardour_window.h"
 #include "ardour_ui.h"
 #include "prompter.h"
 #include "plugin_ui.h"
@@ -78,25 +78,30 @@ 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
+        , pre_deactivate_x (-1)
+        , pre_deactivate_y (-1)
+#endif
+
 {
        bool have_gui = false;
-
        Label* label = manage (new Label());
        label->set_markup ("<b>THIS IS THE PLUGIN UI</b>");
 
-       std::cout << "SHOW UI " << insert->plugin()->unique_id()
-                 << " editor: " << editor << std::endl;
        if (editor && insert->plugin()->has_editor()) {
                switch (insert->type()) {
-               case ARDOUR::VST:
-                       have_gui = create_vst_editor (insert);
+               case ARDOUR::Windows_VST:
+                       have_gui = create_windows_vst_editor (insert);
+                       break;
+                       
+               case ARDOUR::LXVST:
+                       have_gui = create_lxvst_editor (insert);
                        break;
 
                case ARDOUR::AudioUnit:
@@ -112,8 +117,8 @@ PluginUIWindow::PluginUIWindow (
                        break;
 
                default:
-#ifndef VST_SUPPORT
-                       error << _("unknown type of editor-supplying plugin (note: no VST support in this version of ardour)")
+#ifndef WINDOWS_VST_SUPPORT
+                       error << string_compose (_("unknown type of editor-supplying plugin (note: no VST support in this version of %1)"), PROGRAM_NAME)
                              << endmsg;
 #else
                        error << _("unknown type of editor-supplying plugin")
@@ -136,11 +141,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 ();
@@ -148,64 +151,18 @@ PluginUIWindow::PluginUIWindow (
 
        if (scrollable) {
                if (h > 600) h = 600;
-               if (w > 600) w = 600;
-
-               if (w < 0) {
-                       w = 450;
-               }
        }
 
        set_default_size (w, h);
+       set_resizable (_pluginui->resizable());
 }
 
 PluginUIWindow::~PluginUIWindow ()
 {
+       cerr << "PluginWindow deleted for " << this << endl;
        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 ()
 {
@@ -217,19 +174,25 @@ PluginUIWindow::on_show ()
        }
 
        if (_pluginui) {
+#if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
+                if (pre_deactivate_x >= 0) {                                                                             
+                        move (pre_deactivate_x, pre_deactivate_y);
+                }                                                      
+#endif
+
                if (_pluginui->on_window_show (_title)) {
                        Window::on_show ();
                }
        }
-
-       if (parent) {
-               // set_transient_for (*parent);
-       }
 }
 
 void
 PluginUIWindow::on_hide ()
 {
+#if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
+        get_position (pre_deactivate_x, pre_deactivate_y);                                                               
+#endif
+
        Window::on_hide ();
 
        if (_pluginui) {
@@ -245,24 +208,24 @@ PluginUIWindow::set_title(const std::string& title)
 }
 
 bool
-#ifdef VST_SUPPORT
-PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert> insert)
+#ifdef WINDOWS_VST_SUPPORT
+PluginUIWindow::create_windows_vst_editor(boost::shared_ptr<PluginInsert> insert)
 #else
-PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert>)
+PluginUIWindow::create_windows_vst_editor(boost::shared_ptr<PluginInsert>)
 #endif
 {
-#ifndef VST_SUPPORT
+#ifndef WINDOWS_VST_SUPPORT
        return false;
 #else
 
-       boost::shared_ptr<VSTPlugin> vp;
+       boost::shared_ptr<WindowsVSTPlugin> 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;
+       if ((vp = boost::dynamic_pointer_cast<WindowsVSTPlugin> (insert->plugin())) == 0) {
+               error << string_compose (_("unknown type of editor-supplying plugin (note: no VST support in this version of %1)"), PROGRAM_NAME)
+                     << endmsg;
                throw failed_constructor ();
        } else {
-               VSTPluginUI* vpu = new VSTPluginUI (insert, vp);
+               WindowsVSTPluginUI* vpu = new WindowsVSTPluginUI (insert, vp);
 
                _pluginui = vpu;
                _pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
@@ -275,13 +238,43 @@ PluginUIWindow::create_vst_editor(boost::shared_ptr<PluginInsert>)
 }
 
 bool
-#ifdef GTKOSX
+#ifdef LXVST_SUPPORT
+PluginUIWindow::create_lxvst_editor(boost::shared_ptr<PluginInsert> insert)
+#else
+PluginUIWindow::create_lxvst_editor(boost::shared_ptr<PluginInsert>)
+#endif
+{
+#ifndef LXVST_SUPPORT
+       return false;
+#else
+
+       boost::shared_ptr<LXVSTPlugin> lxvp;
+
+       if ((lxvp = boost::dynamic_pointer_cast<LXVSTPlugin> (insert->plugin())) == 0) {
+               error << string_compose (_("unknown type of editor-supplying plugin (note: no linuxVST support in this version of %1)"), PROGRAM_NAME)
+                     << endmsg;
+               throw failed_constructor ();
+       } else {
+               LXVSTPluginUI* lxvpu = new LXVSTPluginUI (insert, lxvp);
+
+               _pluginui = lxvpu;
+               _pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
+               add (*lxvpu);
+               lxvpu->package (*this);
+       }
+
+       return true;
+#endif
+}
+
+bool
+#ifdef AUDIOUNIT_SUPPORT
 PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert> insert)
 #else
 PluginUIWindow::create_audiounit_editor (boost::shared_ptr<PluginInsert>)
 #endif
 {
-#ifndef GTKOSX
+#ifndef AUDIOUNIT_SUPPORT
        return false;
 #else
        VBox* box;
@@ -302,16 +295,20 @@ PluginUIWindow::app_activated (bool yn)
 PluginUIWindow::app_activated (bool)
 #endif
 {
-#ifdef GTKOSX
+#ifdef AUDIOUNIT_SUPPORT
        if (_pluginui) {
                if (yn) {
                        if (was_visible) {
                                _pluginui->activate ();
+                                if (pre_deactivate_x >= 0) {
+                                        move (pre_deactivate_x, pre_deactivate_y);
+                                }
                                present ();
                                was_visible = true;
                        }
                } else {
                        was_visible = is_visible();
+                        get_position (pre_deactivate_x, pre_deactivate_y);
                        hide ();
                        _pluginui->deactivate ();
                }
@@ -322,7 +319,7 @@ PluginUIWindow::app_activated (bool)
 bool
 PluginUIWindow::create_lv2_editor(boost::shared_ptr<PluginInsert> insert)
 {
-#if defined(HAVE_SLV2) || defined(HAVE_SUIL)
+#ifdef HAVE_SUIL
        boost::shared_ptr<LV2Plugin> vp;
 
        if ((vp = boost::dynamic_pointer_cast<LV2Plugin> (insert->plugin())) == 0) {
@@ -353,7 +350,7 @@ PluginUIWindow::on_key_press_event (GdkEventKey* event)
        if (_keyboard_focused) {
                if (_pluginui) {
                        if (_pluginui->non_gtk_gui()) {
-                               _pluginui->forward_key_event (event); 
+                               _pluginui->forward_key_event (event);
                        } else {
                                return relay_key_press (event, this);
                        }
@@ -388,7 +385,7 @@ PluginUIWindow::on_key_release_event (GdkEventKey *event)
                if (_pluginui) {
                        if (_pluginui->non_gtk_gui()) {
                                _pluginui->forward_key_event (event);
-                       } 
+                       }
                        return true;
                }
                return false;
@@ -407,8 +404,6 @@ PluginUIWindow::plugin_going_away ()
        }
 
        death_connection.disconnect ();
-
-       delete_when_idle (this);
 }
 
 PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
@@ -417,23 +412,25 @@ PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
        , add_button (_("Add"))
        , save_button (_("Save"))
        , delete_button (_("Delete"))
-       , bypass_button (_("Bypass"))
+       , bypass_button (ArdourButton::led_default_elements)
+       , description_expander (_("Description"))
+       , plugin_analysis_expander (_("Plugin analysis"))
        , latency_gui (0)
        , latency_dialog (0)
-       , plugin_analysis_expander (_("Plugin analysis"))
        , eqgui (0)
 {
-       _preset_combo.set_size_request (100, -1);
        _preset_modified.set_size_request (16, -1);
        _preset_combo.signal_changed().connect(sigc::mem_fun(*this, &PlugUIBase::preset_selected));
+       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 (bypass_button, _("Disable signal processing by the plugin"));
        _no_load_preset = 0;
 
-       _preset_box.pack_start (_preset_combo);
-       _preset_box.pack_start (_preset_modified);
-
        update_preset_list ();
        update_preset ();
-       
+
        add_button.set_name ("PluginAddButton");
        add_button.signal_clicked().connect (sigc::mem_fun (*this, &PlugUIBase::add_plugin_setting));
 
@@ -445,10 +442,10 @@ PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
 
        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.set_name ("PluginBypassButton");
-       bypass_button.signal_toggled().connect (sigc::mem_fun(*this, &PlugUIBase::bypass_toggled));
+       bypass_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PlugUIBase::bypass_button_release));
        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));
@@ -464,13 +461,16 @@ PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
        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"));
 
+       description_expander.property_expanded().signal_changed().connect( sigc::mem_fun(*this, &PlugUIBase::toggle_description));
+       description_expander.set_expanded(false);
+
        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());
 
        plugin->PresetAdded.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::preset_added_or_removed, this), gui_context ());
-       plugin->PresetRemoved.connect (*this, invalidator (*this), boost::bind (&PlugUIBase::preset_added_or_removed, this), gui_context ());   
+       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 ());
 }
@@ -487,7 +487,6 @@ PlugUIBase::plugin_going_away ()
        /* drop references to the plugin/insert */
        insert.reset ();
        plugin.reset ();
-       death_connection.disconnect ();
 }
 
 void
@@ -499,7 +498,7 @@ PlugUIBase::set_latency_label ()
        string t;
 
        if (l < sr / 1000) {
-               t = string_compose (_("latency (%1 samples)"), l);
+               t = string_compose (P_("latency (%1 sample)", "latency (%1 samples)", l), l);
        } else {
                t = string_compose (_("latency (%1 ms)"), (float) l / ((float) sr / 1000.0f));
        }
@@ -512,8 +511,16 @@ 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 = new ArdourWindow (_("Edit Latency"));
+               /* use both keep-above and transient for to try cover as many
+                  different WM's as possible.
+               */
+               latency_dialog->set_keep_above (true);
+               Window* win = dynamic_cast<Window*> (bypass_button.get_toplevel ());
+               if (win) {
+                       latency_dialog->set_transient_for (*win);
+               }
+               latency_dialog->add (*latency_gui);
                latency_dialog->signal_hide().connect (sigc::mem_fun (*this, &PlugUIBase::set_latency_label));
        }
 
@@ -523,8 +530,9 @@ PlugUIBase::latency_button_clicked ()
 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);
+       ENSURE_GUI_THREAD (*this, &PlugUIBase::processor_active_changed, weak_p);
+       boost::shared_ptr<Processor> p (weak_p.lock());
+
        if (p) {
                bypass_button.set_active (!p->active());
        }
@@ -545,12 +553,20 @@ PlugUIBase::preset_selected ()
                        warning << string_compose(_("Plugin preset %1 not found"),
                                                  _preset_combo.get_active_text()) << endmsg;
                }
+       } else {
+               // blank selected = no preset
+               plugin->clear_preset();
        }
 }
 
+#ifdef NO_PLUGIN_STATE
+static bool seen_saving_message = false;
+#endif
+
 void
 PlugUIBase::add_plugin_setting ()
 {
+#ifndef NO_PLUGIN_STATE
        NewPluginPresetDialog d (plugin);
 
        switch (d.run ()) {
@@ -569,37 +585,65 @@ PlugUIBase::add_plugin_setting ()
                }
                break;
        }
+#else 
+       if (!seen_saving_message) {
+               info << string_compose (_("Plugin presets are not supported in this build of %1. Consider paying for a full version"),
+                                       PROGRAM_NAME)
+                    << endmsg;
+               seen_saving_message = true;
+       }
+#endif
 }
 
 void
 PlugUIBase::save_plugin_setting ()
 {
+#ifndef NO_PLUGIN_STATE
        string const name = _preset_combo.get_active_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) {
+               info << string_compose (_("Plugin presets are not supported in this build of %1. Consider paying for a newer version"),
+                                       PROGRAM_NAME)
+                    << endmsg;
+               seen_saving_message = true;
+       }
+#endif
 }
 
 void
 PlugUIBase::delete_plugin_setting ()
 {
+#ifndef NO_PLUGIN_STATE
        plugin->remove_preset (_preset_combo.get_active_text ());
+#else
+       if (!seen_saving_message) {
+               info << string_compose (_("Plugin presets are not supported in this build of %1. Consider paying for a newer version"),
+                                       PROGRAM_NAME)
+                    << endmsg;
+               seen_saving_message = true;
+       }
+#endif
 }
 
-void
-PlugUIBase::bypass_toggled ()
+bool
+PlugUIBase::bypass_button_release (GdkEventButton*)
 {
-       bool x;
-
-       if ((x = bypass_button.get_active()) == insert->active()) {
-               if (x) {
-                       insert->deactivate ();
-               } else {
+       bool view_says_bypassed = (bypass_button.active_state() != 0);
+       
+       if (view_says_bypassed != insert->active()) {
+               if (view_says_bypassed) {
                        insert->activate ();
+               } else {
+                       insert->deactivate ();
                }
        }
+
+       return false;
 }
 
 bool
@@ -624,11 +668,34 @@ PlugUIBase::focus_toggled (GdkEventButton*)
        return true;
 }
 
+void
+PlugUIBase::toggle_description()
+{
+       if (description_expander.get_expanded() &&
+           !description_expander.get_child()) {
+               const std::string text = plugin->get_docs();
+               if (text.empty()) {
+                       return;
+               }
+
+               Gtk::Label* label = manage(new Gtk::Label(text));
+               label->set_line_wrap(true);
+               label->set_line_wrap_mode(Pango::WRAP_WORD);
+               description_expander.add(*label);
+               description_expander.show_all();
+       }
+       
+       if (!description_expander.get_expanded()) {
+               description_expander.remove();
+       }
+}
+
+
 void
 PlugUIBase::toggle_plugin_analysis()
 {
        if (plugin_analysis_expander.get_expanded() &&
-            !plugin_analysis_expander.get_child()) {
+           !plugin_analysis_expander.get_child()) {
                // Create the GUI
                if (eqgui == 0) {
                        eqgui = new PluginEqGui (insert);
@@ -646,7 +713,6 @@ PlugUIBase::toggle_plugin_analysis()
        }
 
        if (!plugin_analysis_expander.get_expanded()) {
-
                // Hide & remove from expander
 
                eqgui->hide ();
@@ -673,8 +739,10 @@ PlugUIBase::update_preset_list ()
                preset_labels.push_back (i->label);
        }
 
+       preset_labels.push_back("");
+
        set_popdown_strings (_preset_combo, preset_labels);
-       
+
        --_no_load_preset;
 }
 
@@ -696,11 +764,12 @@ PlugUIBase::update_preset ()
 void
 PlugUIBase::update_preset_modified ()
 {
+
        if (plugin->last_preset().uri.empty()) {
                _preset_modified.set_text ("");
                return;
        }
-       
+
        bool const c = plugin->parameter_changed_since_last_preset ();
        if (_preset_modified.get_text().empty() == c) {
                _preset_modified.set_text (c ? "*" : "");
@@ -720,3 +789,4 @@ PlugUIBase::preset_added_or_removed ()
        update_preset_list ();
        update_preset ();
 }
+