VKeybd: Pass on primary (Ctrl/Cmd) shortcuts
[ardour.git] / gtk2_ardour / plugin_ui.h
index 042a2404a263aef45efa177ad10ee0299d1fc88d..6e7b41afec830a79c39cd0acc381f3c84d685999 100644 (file)
@@ -1,21 +1,26 @@
 /*
-    Copyright (C) 2000-2006 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
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-*/
+ * Copyright (C) 2005-2006 Taybin Rutkin <taybin@taybin.com>
+ * Copyright (C) 2005-2015 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2006-2009 Sampo Savolainen <v2@iki.fi>
+ * Copyright (C) 2007-2015 David Robillard <d@drobilla.net>
+ * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
+ * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
+ * Copyright (C) 2016-2017 Julien "_FrnchFrgg_" RIVAUD <frnchfrgg@free.fr>
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
 
 #ifndef __ardour_plugin_ui_h__
 #define __ardour_plugin_ui_h__
 
 #include <sigc++/signal.h>
 
-#include <gtkmm/button.h>
+#include <gtkmm/adjustment.h>
 #include <gtkmm/box.h>
-#include <gtkmm/table.h>
+#include <gtkmm/button.h>
 #include <gtkmm/eventbox.h>
-#include <gtkmm/viewport.h>
-#include <gtkmm/scrolledwindow.h>
+#include <gtkmm/expander.h>
+#include <gtkmm/filechooserbutton.h>
+#include <gtkmm/image.h>
 #include <gtkmm/label.h>
 #include <gtkmm/menu.h>
-#include <gtkmm/image.h>
-#include <gtkmm/adjustment.h>
-#include <gtkmm/togglebutton.h>
-#include <gtkmm/socket.h>
+#include <gtkmm/scrolledwindow.h>
 #include <gtkmm/socket.h>
+#include <gtkmm/table.h>
+#include <gtkmm/togglebutton.h>
+#include <gtkmm/viewport.h>
 
 #include "ardour/types.h"
 #include "ardour/plugin.h"
 #include "ardour/variant.h"
 
-#include "ardour_button.h"
-#include "ardour_dropdown.h"
-#include "ardour_spinner.h"
+#include "widgets/ardour_button.h"
+#include "widgets/ardour_dropdown.h"
+#include "widgets/ardour_spinner.h"
+
 #include "ardour_window.h"
 #include "automation_controller.h"
+#include "pianokeyboard.h"
 
 namespace ARDOUR {
        class PluginInsert;
@@ -68,22 +76,20 @@ namespace PBD {
        class Controllable;
 }
 
-namespace Gtkmm2ext {
-       class HSliderController;
-       class BarController;
-       class ClickBox;
+namespace ArdourWidgets {
        class FastMeter;
-       class PixmapButton;
 }
 
 class LatencyGUI;
 class ArdourWindow;
 class PluginEqGui;
+class PluginLoadStatsGui;
+class PluginPresetsUI;
 class VSTPluginUI;
 
 class PlugUIBase : public virtual sigc::trackable, public PBD::ScopedConnectionList
 {
-  public:
+public:
        PlugUIBase (boost::shared_ptr<ARDOUR::PluginInsert>);
        virtual ~PlugUIBase();
 
@@ -106,55 +112,63 @@ class PlugUIBase : public virtual sigc::trackable, public PBD::ScopedConnectionL
 
        virtual void forward_key_event (GdkEventKey*) {}
        virtual void grab_focus () {}
-  virtual bool non_gtk_gui() const { return false; }
+       virtual bool non_gtk_gui() const { return false; }
 
        sigc::signal<void,bool> KeyboardFocused;
 
-  protected:
+protected:
        boost::shared_ptr<ARDOUR::PluginInsert> insert;
        boost::shared_ptr<ARDOUR::Plugin> plugin;
 
        /* UI elements that can subclasses can add to their widgets */
 
        /** a ComboBoxText which lists presets and manages their selection */
-       ArdourDropdown _preset_combo;
+       ArdourWidgets::ArdourDropdown _preset_combo;
        /** a label which has a * in if the current settings are different from the preset being shown */
        Gtk::Label _preset_modified;
        /** a button to add a preset */
-       ArdourButton add_button;
+       ArdourWidgets::ArdourButton add_button;
        /** a button to save the current settings as a new user preset */
-       ArdourButton save_button;
+       ArdourWidgets::ArdourButton save_button;
        /** a button to delete the current preset (if it is a user one) */
-       ArdourButton delete_button;
+       ArdourWidgets::ArdourButton delete_button;
+       /** a button to show a preset browser */
+       ArdourWidgets::ArdourButton preset_browser_button;
        /** a button to delete the reset the plugin params */
-       ArdourButton reset_button;
+       ArdourWidgets::ArdourButton reset_button;
        /** a button to bypass the plugin */
-       ArdourButton bypass_button;
+       ArdourWidgets::ArdourButton bypass_button;
        /** and self-explaining button :) */
-       ArdourButton pin_management_button;
+       ArdourWidgets::ArdourButton pin_management_button;
        /** a button to acquire keyboard focus */
        Gtk::EventBox focus_button;
        /** an expander containing the plugin description */
        Gtk::Expander description_expander;
        /** an expander containing the plugin analysis graph */
        Gtk::Expander plugin_analysis_expander;
+       /** an expander containing the plugin cpu profile */
+       Gtk::Expander cpuload_expander;
        /** a button which, when clicked, opens the latency GUI */
-       ArdourButton latency_button;
+       ArdourWidgets::ArdourButton latency_button;
        /** a button which sets all controls' automation setting to Manual */
-       ArdourButton automation_manual_all_button;
+       ArdourWidgets::ArdourButton automation_manual_all_button;
        /** a button which sets all controls' automation setting to Play */
-       ArdourButton automation_play_all_button;
+       ArdourWidgets::ArdourButton automation_play_all_button;
        /** a button which sets all controls' automation setting to Write */
-       ArdourButton automation_write_all_button;
+       ArdourWidgets::ArdourButton automation_write_all_button;
        /** a button which sets all controls' automation setting to Touch */
-       ArdourButton automation_touch_all_button;
+       ArdourWidgets::ArdourButton automation_touch_all_button;
+       /** a button which sets all controls' automation setting to Latch */
+       ArdourWidgets::ArdourButton automation_latch_all_button;
 
        void set_latency_label ();
-
        LatencyGUI* latency_gui;
        ArdourWindow* latency_dialog;
 
        PluginEqGui* eqgui;
+       PluginLoadStatsGui* stats_gui;
+       PluginPresetsUI* preset_gui;
+       ArdourWindow* preset_dialog;
 
        Gtk::Image* focus_out_image;
        Gtk::Image* focus_in_image;
@@ -165,17 +179,21 @@ class PlugUIBase : public virtual sigc::trackable, public PBD::ScopedConnectionL
        void save_plugin_setting ();
        void delete_plugin_setting ();
        void reset_plugin_parameters ();
+       void browse_presets ();
        void manage_pins ();
        bool focus_toggled(GdkEventButton*);
        bool bypass_button_release(GdkEventButton*);
        void toggle_description ();
        void toggle_plugin_analysis ();
+       void toggle_cpuload_display ();
        void processor_active_changed (boost::weak_ptr<ARDOUR::Processor> p);
        void plugin_going_away ();
        void automation_state_changed ();
        void preset_added_or_removed ();
        void update_preset_modified ();
 
+       bool has_descriptive_presets () const;
+
        PBD::ScopedConnection death_connection;
        PBD::ScopedConnection active_connection;
        PBD::ScopedConnection preset_added_connection;
@@ -185,7 +203,7 @@ class PlugUIBase : public virtual sigc::trackable, public PBD::ScopedConnectionL
 
 class GenericPluginUI : public PlugUIBase, public Gtk::VBox
 {
-  public:
+public:
        GenericPluginUI (boost::shared_ptr<ARDOUR::PluginInsert> plug, bool scrollable=false);
        ~GenericPluginUI ();
 
@@ -195,7 +213,7 @@ class GenericPluginUI : public PlugUIBase, public Gtk::VBox
        bool start_updating(GdkEventAny*);
        bool stop_updating(GdkEventAny*);
 
-  private:
+private:
        Gtk::VBox main_contents;
        Gtk::HBox settings_box;
        Gtk::HBox hpacker;
@@ -205,7 +223,7 @@ class GenericPluginUI : public PlugUIBase, public Gtk::VBox
        bool is_scrollable;
 
        struct MeterInfo {
-               Gtkmm2ext::FastMeter *meter;
+               ArdourWidgets::FastMeter* meter;
                bool packed;
 
                MeterInfo () {
@@ -227,17 +245,17 @@ class GenericPluginUI : public PlugUIBase, public Gtk::VBox
                boost::shared_ptr<ARDOUR::ScalePoints>  scale_points;
                boost::shared_ptr<AutomationController> controller;
 
-               ArdourButton                            automate_button;
+               ArdourWidgets::ArdourButton             automate_button;
                Gtk::Label                              label;
-               ArdourDropdown*                         combo;
-               Gtkmm2ext::ClickBox*                    clickbox;
+               ArdourWidgets::ArdourDropdown*          combo;
                Gtk::FileChooserButton*                 file_button;
-               ArdourSpinner*                          spin_box;
+               ArdourWidgets::ArdourSpinner*           spin_box;
 
                bool                                    button;
                bool                                    update_pending;
                bool                                    ignore_change;
 
+
                /* output */
 
                Gtk::EventBox* display;
@@ -253,8 +271,12 @@ class GenericPluginUI : public PlugUIBase, public Gtk::VBox
                /* layout */
                Gtk::Table* knobtable;
                int x0, x1, y0, y1;
+
+               bool short_autostate; // modify with set_short_autostate below
        };
 
+       void set_short_autostate(ControlUI* cui, bool value);
+
        std::vector<ControlUI*>   input_controls; // workaround for preset load
        std::vector<ControlUI*>   input_controls_with_automation;
        std::vector<ControlUI*>   output_controls;
@@ -286,22 +308,37 @@ class GenericPluginUI : public PlugUIBase, public Gtk::VBox
 
        void knob_size_request(Gtk::Requisition* req, ControlUI* cui);
 
-       /* XXX: remove */
-       void print_parameter (char *buf, uint32_t len, uint32_t param);
-       bool integer_printer (char* buf, Gtk::Adjustment &, ControlUI *);
-       bool midinote_printer(char* buf, Gtk::Adjustment &, ControlUI *);
-
        typedef std::map<uint32_t, Gtk::FileChooserButton*> FilePathControls;
        FilePathControls _filepath_controls;
        void set_path_property (const ARDOUR::ParameterDescriptor& desc,
                                Gtk::FileChooserButton*            widget);
        void path_property_changed (uint32_t key, const ARDOUR::Variant& value);
 
+       void scroller_size_request (Gtk::Requisition*);
+       Gtk::ScrolledWindow scroller;
+
+       Gtk::Expander   _plugin_pianokeyboard_expander;
+       APianoKeyboard* _piano;
+       Gtk::VBox       _pianobox;
+       Gtk::SpinButton _piano_velocity;
+       Gtk::SpinButton _piano_channel;
+
+       void note_on_event_handler (int, int);
+       void note_off_event_handler (int);
+
+       void toggle_pianokeyboard ();
+       void build_midi_table ();
+       void midi_refill_patches ();
+       void midi_bank_patch_change (uint8_t chn);
+       void midi_bank_patch_select (uint8_t chn, uint32_t bankpgm);
+       std::vector<ArdourWidgets::ArdourDropdown*> midi_pgmsel;
+       PBD::ScopedConnectionList midi_connections;
+       std::map<uint32_t, std::string> pgm_names;
 };
 
 class PluginUIWindow : public ArdourWindow
 {
-  public:
+public:
        PluginUIWindow (boost::shared_ptr<ARDOUR::PluginInsert> insert,
                        bool scrollable=false,
                        bool editor=true);
@@ -319,7 +356,7 @@ class PluginUIWindow : public ArdourWindow
        void on_show ();
        void on_hide ();
 
-  private:
+private:
        std::string _title;
        PlugUIBase* _pluginui;
        PBD::ScopedConnection death_connection;