Add "Description" pane to generic plugin UI for LV2 plugins with documentation (rdfs...
[ardour.git] / gtk2_ardour / plugin_ui.cc
index 7d9323995205e965800c081b8ea5b2a83a27747b..9357fc7136ce5bb919fcce785e3ceb72b5afd3ba 100644 (file)
 #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"
@@ -57,7 +61,7 @@
 
 #include <lrdf.h>
 
-#include "ardour_dialog.h"
+#include "ardour_window.h"
 #include "ardour_ui.h"
 #include "prompter.h"
 #include "plugin_ui.h"
@@ -77,20 +81,30 @@ using namespace PBD;
 using namespace Gtkmm2ext;
 using namespace Gtk;
 
-PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert> insert, bool scrollable)
+PluginUIWindow::PluginUIWindow (
+       Gtk::Window*                    win,
+       boost::shared_ptr<PluginInsert> insert,
+       bool                            scrollable,
+       bool                            editor)
        : parent (win)
-        , was_visible (false)
-        , _keyboard_focused (false)
+       , was_visible (false)
+       , _keyboard_focused (false)
 {
        bool have_gui = false;
 
        Label* label = manage (new Label());
        label->set_markup ("<b>THIS IS THE PLUGIN UI</b>");
 
-       if (insert->plugin()->has_editor()) {
+       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:
@@ -106,7 +120,7 @@ PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert
                        break;
 
                default:
-#ifndef VST_SUPPORT
+#ifndef WINDOWS_VST_SUPPORT
                        error << _("unknown type of editor-supplying plugin (note: no VST support in this version of ardour)")
                              << endmsg;
 #else
@@ -119,8 +133,7 @@ PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert
        }
 
        if (!have_gui) {
-
-               GenericPluginUI*  pu  = new GenericPluginUI (insert, scrollable);
+               GenericPluginUI* pu = new GenericPluginUI (insert, scrollable);
 
                _pluginui = pu;
                _pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
@@ -143,14 +156,10 @@ PluginUIWindow::PluginUIWindow (Gtk::Window* win, boost::shared_ptr<PluginInsert
 
        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 ()
@@ -240,24 +249,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) {
+       if ((vp = boost::dynamic_pointer_cast<WindowsVSTPlugin> (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);
+               WindowsVSTPluginUI* vpu = new WindowsVSTPluginUI (insert, vp);
 
                _pluginui = vpu;
                _pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
@@ -270,18 +279,48 @@ 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 << _("unknown type of editor-supplying plugin (note: no linuxVST support in this version of ardour)")
+                             << 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;
        _pluginui = create_au_gui (insert, &box);
-        _pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
+       _pluginui->KeyboardFocused.connect (sigc::mem_fun (*this, &PluginUIWindow::keyboard_focused));
        add (*box);
 
        Application::instance()->ActivationChanged.connect (mem_fun (*this, &PluginUIWindow::app_activated));
@@ -297,7 +336,7 @@ PluginUIWindow::app_activated (bool yn)
 PluginUIWindow::app_activated (bool)
 #endif
 {
-#ifdef GTKOSX
+#ifdef AUDIOUNIT_SUPPORT
        if (_pluginui) {
                if (yn) {
                        if (was_visible) {
@@ -317,10 +356,7 @@ PluginUIWindow::app_activated (bool)
 bool
 PluginUIWindow::create_lv2_editor(boost::shared_ptr<PluginInsert> insert)
 {
-#ifndef LV2_SUPPORT
-       return false;
-#else
-
+#ifdef HAVE_SUIL
        boost::shared_ptr<LV2Plugin> vp;
 
        if ((vp = boost::dynamic_pointer_cast<LV2Plugin> (insert->plugin())) == 0) {
@@ -334,6 +370,8 @@ PluginUIWindow::create_lv2_editor(boost::shared_ptr<PluginInsert> insert)
        }
 
        return true;
+#else
+       return false;
 #endif
 }
 
@@ -348,32 +386,32 @@ PluginUIWindow::on_key_press_event (GdkEventKey* event)
 {
        if (_keyboard_focused) {
                if (_pluginui) {
-                        if (_pluginui->non_gtk_gui()) {
-                                _pluginui->forward_key_event (event); 
-                        } else {
-                                return relay_key_press (event, this);
-                        }
+                       if (_pluginui->non_gtk_gui()) {
+                               _pluginui->forward_key_event (event);
+                       } else {
+                               return relay_key_press (event, this);
+                       }
                }
                return true;
        } else {
-                /* for us to be getting key press events, there really
-                   MUST be a _pluginui, but just to be safe, check ...
-                */
-
-                if (_pluginui) {
-                        if (_pluginui->non_gtk_gui()) {
-                                /* pass editor window as the window for the event
-                                   to be handled in, not this one, because there are
-                                   no widgets in this window that we want to have
-                                   key focus.
-                                */
-                                return relay_key_press (event, &PublicEditor::instance());
-                        } else {
-                                return relay_key_press (event, this);
-                        }
-                } else {
-                        return false;
-                }
+               /* for us to be getting key press events, there really
+                  MUST be a _pluginui, but just to be safe, check ...
+               */
+
+               if (_pluginui) {
+                       if (_pluginui->non_gtk_gui()) {
+                               /* pass editor window as the window for the event
+                                  to be handled in, not this one, because there are
+                                  no widgets in this window that we want to have
+                                  key focus.
+                               */
+                               return relay_key_press (event, &PublicEditor::instance());
+                       } else {
+                               return relay_key_press (event, this);
+                       }
+               } else {
+                       return false;
+               }
        }
 }
 
@@ -382,10 +420,10 @@ PluginUIWindow::on_key_release_event (GdkEventKey *event)
 {
        if (_keyboard_focused) {
                if (_pluginui) {
-                        if (_pluginui->non_gtk_gui()) {
-                                _pluginui->forward_key_event (event);
-                        } 
-                        return true;
+                       if (_pluginui->non_gtk_gui()) {
+                               _pluginui->forward_key_event (event);
+                       }
+                       return true;
                }
                return false;
        } else {
@@ -413,23 +451,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));
 
@@ -441,10 +481,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));
@@ -460,13 +500,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 ());
 }
@@ -508,8 +551,8 @@ 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"));
+               latency_dialog->add (*latency_gui);
                latency_dialog->signal_hide().connect (sigc::mem_fun (*this, &PlugUIBase::set_latency_label));
        }
 
@@ -519,8 +562,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());
        }
@@ -584,18 +628,20 @@ PlugUIBase::delete_plugin_setting ()
        plugin->remove_preset (_preset_combo.get_active_text ());
 }
 
-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
@@ -620,11 +666,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);
@@ -642,7 +711,6 @@ PlugUIBase::toggle_plugin_analysis()
        }
 
        if (!plugin_analysis_expander.get_expanded()) {
-
                // Hide & remove from expander
 
                eqgui->hide ();
@@ -670,7 +738,7 @@ PlugUIBase::update_preset_list ()
        }
 
        set_popdown_strings (_preset_combo, preset_labels);
-       
+
        --_no_load_preset;
 }
 
@@ -696,7 +764,7 @@ PlugUIBase::update_preset_modified ()
                _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 ? "*" : "");