gtk2_ardour/plugin_ui.h

   1 /*
   2     Copyright (C) 2000-2006 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_plugin_ui_h__
  21 #define __ardour_plugin_ui_h__
  22
  23 #ifdef WAF_BUILD
  24 #include "gtk2ardour-config.h"
  25 #endif
  26
  27 #include <vector>
  28 #include <map>
  29 #include <list>
  30
  31 #include <sigc++/signal.h>
  32
  33 #include <gtkmm/button.h>
  34 #include <gtkmm/box.h>
  35 #include <gtkmm/table.h>
  36 #include <gtkmm/eventbox.h>
  37 #include <gtkmm/viewport.h>
  38 #include <gtkmm/scrolledwindow.h>
  39 #include <gtkmm/label.h>
  40 #include <gtkmm/menu.h>
  41 #include <gtkmm/image.h>
  42 #include <gtkmm/adjustment.h>
  43 #include <gtkmm/togglebutton.h>
  44 #include <gtkmm/socket.h>
  45 #include <gtkmm/comboboxtext.h>
  46 #include <gtkmm/socket.h>
  47
  48 #include "ardour/types.h"
  49
  50 #include "automation_controller.h"
  51
  52 namespace ARDOUR {
  53         class PluginInsert;
  54         class Plugin;
  55         class VSTPlugin;
  56         class IOProcessor;
  57         class AUPlugin;
  58 }
  59
  60 namespace PBD {
  61         class Controllable;
  62 }
  63
  64 namespace Gtkmm2ext {
  65         class HSliderController;
  66         class BarController;
  67         class ClickBox;
  68         class FastMeter;
  69         class PixmapButton;
  70 }
  71
  72 class LatencyGUI;
  73 class ArdourDialog;
  74
  75 class PlugUIBase : public virtual sigc::trackable
  76 {
  77   public:
  78         PlugUIBase (boost::shared_ptr<ARDOUR::PluginInsert>);
  79         virtual ~PlugUIBase();
  80
  81         virtual gint get_preferred_height () = 0;
  82         virtual gint get_preferred_width () = 0;
  83         virtual bool start_updating(GdkEventAny*) = 0;
  84         virtual bool stop_updating(GdkEventAny*) = 0;
  85
  86         virtual void activate () {}
  87         virtual void deactivate () {}
  88
  89         virtual void update_presets ();
  90
  91         void latency_button_clicked ();
  92
  93         virtual bool on_window_show(const Glib::ustring& /*title*/) { return true; }
  94         virtual void on_window_hide() {}
  95
  96   protected:
  97         boost::shared_ptr<ARDOUR::PluginInsert> insert;
  98         boost::shared_ptr<ARDOUR::Plugin> plugin;
  99         Gtk::ComboBoxText preset_combo;
 100         Gtk::Button save_button;
 101         Gtk::ToggleButton bypass_button;
 102         Gtk::EventBox focus_button;
 103
 104         Gtk::Label latency_label;
 105         Gtk::Button latency_button;
 106         void set_latency_label ();
 107
 108         LatencyGUI* latency_gui;
 109         ArdourDialog* latency_dialog;
 110
 111         Gtk::Expander plugin_analysis_expander;
 112
 113         Gtk::Image* focus_out_image;
 114         Gtk::Image* focus_in_image;
 115         bool no_load_preset;
 116
 117         void setting_selected();
 118         void save_plugin_setting (void);
 119         bool focus_toggled(GdkEventButton*);
 120         void bypass_toggled();
 121         void toggle_plugin_analysis ();
 122         void processor_active_changed (boost::weak_ptr<ARDOUR::Processor> p);
 123         void plugin_going_away ();
 124 };
 125
 126 class GenericPluginUI : public PlugUIBase, public Gtk::VBox
 127 {
 128   public:
 129         GenericPluginUI (boost::shared_ptr<ARDOUR::PluginInsert> plug, bool scrollable=false);
 130         ~GenericPluginUI ();
 131
 132         gint get_preferred_height () { return prefheight; }
 133         gint get_preferred_width () { return -1; }
 134
 135         bool start_updating(GdkEventAny*);
 136         bool stop_updating(GdkEventAny*);
 137
 138   private:
 139         Gtk::VBox main_contents;
 140
 141         Gtk::HBox settings_box;
 142         Gtk::HBox hpacker;
 143
 144         Gtk::Table button_table;
 145         Gtk::Table output_table;
 146
 147         Gtk::ScrolledWindow scroller;
 148         Gtk::Adjustment hAdjustment;
 149         Gtk::Adjustment vAdjustment;
 150         Gtk::Viewport scroller_view;
 151         Gtk::Menu* automation_menu;
 152
 153         gint prefheight;
 154         bool is_scrollable;
 155
 156         struct MeterInfo {
 157                 Gtkmm2ext::FastMeter *meter;
 158
 159                 float           min;
 160                 float           max;
 161                 bool            min_unbound;
 162                 bool            max_unbound;
 163                 bool packed;
 164
 165                 MeterInfo (int /*i*/) {
 166                         meter = 0;
 167                         packed = false;
 168                         min = 1.0e10;
 169                         max = -1.0e10;
 170                         min_unbound = false;
 171                         max_unbound = false;
 172                 }
 173         };
 174
 175         static const int32_t initial_button_rows = 6;
 176         static const int32_t initial_button_cols = 1;
 177         static const int32_t initial_output_rows = 1;
 178         static const int32_t initial_output_cols = 4;
 179
 180         /* FIXME: Unify with AutomationController */
 181         struct ControlUI : public Gtk::HBox {
 182
 183                 boost::shared_ptr<ARDOUR::AutomationControl> control;
 184
 185                 Evoral::Parameter parameter() { return control->parameter(); }
 186
 187             /* input */
 188
 189             Gtk::ComboBoxText*                      combo;
 190             std::map<std::string, float>*           combo_map;
 191             Gtk::ToggleButton*                      button;
 192             boost::shared_ptr<AutomationController> controller;
 193             Gtkmm2ext::ClickBox*                    clickbox;
 194             Gtk::Label                              label;
 195             bool                                    logarithmic;
 196             bool                                    update_pending;
 197             char                                    ignore_change;
 198             Gtk::Button                             automate_button;
 199
 200             /* output */
 201
 202             Gtk::EventBox *display;
 203             Gtk::Label*    display_label;
 204
 205                 Gtk::HBox  *    hbox;
 206                 Gtk::VBox  *    vbox;
 207             MeterInfo  *    meterinfo;
 208
 209             ControlUI ();
 210             ~ControlUI();
 211         };
 212
 213         std::vector<ControlUI*>   output_controls;
 214         sigc::connection screen_update_connection;
 215         void output_update();
 216
 217         void build ();
 218         ControlUI* build_control_ui (guint32 port_index, boost::shared_ptr<ARDOUR::AutomationControl>);
 219         std::vector<std::string> setup_scale_values(guint32 port_index, ControlUI* cui);
 220         void parameter_changed (ControlUI* cui);
 221         void toggle_parameter_changed (ControlUI* cui);
 222         void update_control_display (ControlUI* cui);
 223         void control_port_toggled (ControlUI* cui);
 224         void control_combo_changed (ControlUI* cui);
 225
 226         void processor_active_changed (boost::weak_ptr<ARDOUR::Processor>);
 227
 228         void astate_clicked (ControlUI*, uint32_t parameter);
 229         void automation_state_changed (ControlUI*);
 230         void set_automation_state (ARDOUR::AutoState state, ControlUI* cui);
 231         void start_touch (ControlUI*);
 232         void stop_touch (ControlUI*);
 233
 234         void print_parameter (char *buf, uint32_t len, uint32_t param);
 235 };
 236
 237 class PluginUIWindow : public Gtk::Window
 238 {
 239   public:
 240         PluginUIWindow (Gtk::Window*, boost::shared_ptr<ARDOUR::PluginInsert> insert, bool scrollable=false);
 241         ~PluginUIWindow ();
 242
 243         PlugUIBase& pluginui() { return *_pluginui; }
 244
 245         void resize_preferred();
 246         void set_parent (Gtk::Window*);
 247         void set_title(const Glib::ustring& title);
 248
 249
 250         bool on_enter_notify_event (GdkEventCrossing*);
 251         bool on_leave_notify_event (GdkEventCrossing*);
 252         bool on_focus_in_event (GdkEventFocus*);
 253         bool on_focus_out_event (GdkEventFocus*);
 254         bool on_key_press_event (GdkEventKey*);
 255         bool on_key_release_event (GdkEventKey*);
 256         void on_show ();
 257         void on_hide ();
 258         void on_map ();
 259
 260   private:
 261         Glib::ustring _title;
 262         PlugUIBase* _pluginui;
 263         sigc::connection death_connection;
 264         Gtk::Window* parent;
 265         Gtk::VBox vbox;
 266         bool non_gtk_gui;
 267         bool was_visible;
 268
 269         void app_activated (bool);
 270         void plugin_going_away ();
 271
 272         bool create_vst_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
 273         bool create_audiounit_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
 274         bool create_lv2_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
 275 };
 276
 277 #ifdef VST_SUPPORT
 278 class VSTPluginUI : public PlugUIBase, public Gtk::VBox
 279 {
 280   public:
 281         VSTPluginUI (boost::shared_ptr<ARDOUR::PluginInsert>, boost::shared_ptr<ARDOUR::VSTPlugin>);
 282         ~VSTPluginUI ();
 283
 284         gint get_preferred_height ();
 285         gint get_preferred_width ();
 286         bool start_updating(GdkEventAny*) {return false;}
 287         bool stop_updating(GdkEventAny*) {return false;}
 288
 289         int package (Gtk::Window&);
 290
 291   private:
 292         boost::shared_ptr<ARDOUR::VSTPlugin>  vst;
 293         Gtk::Socket socket;
 294         Gtk::HBox   preset_box;
 295         Gtk::VBox   vpacker;
 296
 297         bool configure_handler (GdkEventConfigure*, Gtk::Socket*);
 298         void save_plugin_setting ();
 299 };
 300 #endif // VST_SUPPORT
 301
 302 #ifdef HAVE_AUDIOUNITS
 303 /* this function has to be in a .mm file */
 304 extern PlugUIBase* create_au_gui (boost::shared_ptr<ARDOUR::PluginInsert>, Gtk::VBox**);
 305 #endif
 306
 307 #endif /* __ardour_plugin_ui_h__ */