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 std::string& /*title*/) { return true; }
  94         virtual void on_window_hide() {}
  95
  96         virtual void forward_key_event (GdkEventKey*) {}
  97         virtual bool non_gtk_gui() const { return false; }
  98
  99         sigc::signal<void,bool> KeyboardFocused;
 100
 101   protected:
 102         boost::shared_ptr<ARDOUR::PluginInsert> insert;
 103         boost::shared_ptr<ARDOUR::Plugin> plugin;
 104         Gtk::ComboBoxText preset_combo;
 105         Gtk::Button add_button;
 106         Gtk::Button save_button;
 107         Gtk::Button delete_button;
 108         Gtk::ToggleButton bypass_button;
 109         Gtk::EventBox focus_button;
 110
 111         Gtk::Label latency_label;
 112         Gtk::Button latency_button;
 113         void set_latency_label ();
 114
 115         LatencyGUI* latency_gui;
 116         ArdourDialog* latency_dialog;
 117
 118         Gtk::Expander plugin_analysis_expander;
 119
 120         Gtk::Image* focus_out_image;
 121         Gtk::Image* focus_in_image;
 122         bool no_load_preset;
 123
 124         virtual void setting_selected ();
 125         void add_plugin_setting ();
 126         void save_plugin_setting ();
 127         void delete_plugin_setting ();
 128         bool focus_toggled(GdkEventButton*);
 129         void bypass_toggled();
 130         void toggle_plugin_analysis ();
 131         void processor_active_changed (boost::weak_ptr<ARDOUR::Processor> p);
 132         void plugin_going_away ();
 133         void update_sensitivity ();
 134
 135         PBD::ScopedConnection death_connection;
 136         PBD::ScopedConnection active_connection;
 137         PBD::ScopedConnection preset_added_connection;
 138         PBD::ScopedConnection preset_removed_connection;
 139         PBD::ScopedConnectionList control_connections;
 140 };
 141
 142 class GenericPluginUI : public PlugUIBase, public Gtk::VBox
 143 {
 144   public:
 145         GenericPluginUI (boost::shared_ptr<ARDOUR::PluginInsert> plug, bool scrollable=false);
 146         ~GenericPluginUI ();
 147
 148         gint get_preferred_height () { return prefheight; }
 149         gint get_preferred_width () { return -1; }
 150
 151         bool start_updating(GdkEventAny*);
 152         bool stop_updating(GdkEventAny*);
 153
 154   private:
 155         Gtk::VBox main_contents;
 156
 157         Gtk::HBox settings_box;
 158         Gtk::HBox hpacker;
 159
 160         Gtk::Table button_table;
 161         Gtk::Table output_table;
 162
 163         Gtk::ScrolledWindow scroller;
 164         Gtk::Adjustment hAdjustment;
 165         Gtk::Adjustment vAdjustment;
 166         Gtk::Viewport scroller_view;
 167         Gtk::Menu* automation_menu;
 168
 169         gint prefheight;
 170         bool is_scrollable;
 171
 172         struct MeterInfo {
 173                 Gtkmm2ext::FastMeter *meter;
 174
 175                 float           min;
 176                 float           max;
 177                 bool            min_unbound;
 178                 bool            max_unbound;
 179                 bool packed;
 180
 181                 MeterInfo (int /*i*/) {
 182                         meter = 0;
 183                         packed = false;
 184                         min = 1.0e10;
 185                         max = -1.0e10;
 186                         min_unbound = false;
 187                         max_unbound = false;
 188                 }
 189         };
 190
 191         static const int32_t initial_button_rows = 12;
 192         static const int32_t initial_button_cols = 1;
 193         static const int32_t initial_output_rows = 1;
 194         static const int32_t initial_output_cols = 4;
 195
 196         /* FIXME: Unify with AutomationController */
 197         struct ControlUI : public Gtk::HBox {
 198
 199                 boost::shared_ptr<ARDOUR::AutomationControl> control;
 200
 201                 Evoral::Parameter parameter() { return control->parameter(); }
 202
 203             /* input */
 204
 205             Gtk::ComboBoxText*                      combo;
 206             std::map<std::string, float>*           combo_map;
 207             Gtk::ToggleButton*                      button;
 208             boost::shared_ptr<AutomationController> controller;
 209             Gtkmm2ext::ClickBox*                    clickbox;
 210             Gtk::Label                              label;
 211             bool                                    logarithmic;
 212             bool                                    update_pending;
 213             char                                    ignore_change;
 214             Gtk::Button                             automate_button;
 215
 216             /* output */
 217
 218             Gtk::EventBox *display;
 219             Gtk::Label*    display_label;
 220
 221                 Gtk::HBox  *    hbox;
 222                 Gtk::VBox  *    vbox;
 223             MeterInfo  *    meterinfo;
 224
 225             ControlUI ();
 226             ~ControlUI();
 227         };
 228
 229         std::vector<ControlUI*>   input_controls;
 230         std::vector<ControlUI*>   output_controls;
 231         sigc::connection screen_update_connection;
 232         void output_update();
 233
 234         void build ();
 235         ControlUI* build_control_ui (guint32 port_index, boost::shared_ptr<ARDOUR::AutomationControl>);
 236         std::vector<std::string> setup_scale_values(guint32 port_index, ControlUI* cui);
 237         void parameter_changed (ControlUI* cui);
 238         void toggle_parameter_changed (ControlUI* cui);
 239         void update_control_display (ControlUI* cui);
 240         void control_port_toggled (ControlUI* cui);
 241         void control_combo_changed (ControlUI* cui);
 242
 243         void processor_active_changed (boost::weak_ptr<ARDOUR::Processor>);
 244
 245         void astate_clicked (ControlUI*, uint32_t parameter);
 246         void automation_state_changed (ControlUI*);
 247         void set_automation_state (ARDOUR::AutoState state, ControlUI* cui);
 248         void start_touch (ControlUI*);
 249         void stop_touch (ControlUI*);
 250
 251         void print_parameter (char *buf, uint32_t len, uint32_t param);
 252 };
 253
 254 class PluginUIWindow : public Gtk::Window
 255 {
 256   public:
 257         PluginUIWindow (Gtk::Window*, boost::shared_ptr<ARDOUR::PluginInsert> insert, bool scrollable=false);
 258         ~PluginUIWindow ();
 259
 260         PlugUIBase& pluginui() { return *_pluginui; }
 261
 262         void resize_preferred();
 263         void set_parent (Gtk::Window*);
 264         void set_title(const std::string& title);
 265
 266
 267         bool on_enter_notify_event (GdkEventCrossing*);
 268         bool on_leave_notify_event (GdkEventCrossing*);
 269         bool on_focus_in_event (GdkEventFocus*);
 270         bool on_focus_out_event (GdkEventFocus*);
 271         bool on_key_press_event (GdkEventKey*);
 272         bool on_key_release_event (GdkEventKey*);
 273         void on_show ();
 274         void on_hide ();
 275         void on_map ();
 276
 277   private:
 278         std::string _title;
 279         PlugUIBase* _pluginui;
 280         PBD::ScopedConnection death_connection;
 281         Gtk::Window* parent;
 282         Gtk::VBox vbox;
 283         bool was_visible;
 284         bool _keyboard_focused;
 285         void keyboard_focused (bool yn);
 286
 287         void app_activated (bool);
 288         void plugin_going_away ();
 289
 290         bool create_vst_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
 291         bool create_audiounit_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
 292         bool create_lv2_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
 293 };
 294
 295 #ifdef AUDIOUNITS
 296 /* this function has to be in a .mm file */
 297 extern PlugUIBase* create_au_gui (boost::shared_ptr<ARDOUR::PluginInsert>, Gtk::VBox**);
 298 #endif
 299
 300 #endif /* __ardour_plugin_ui_h__ */