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/adjustment.h>
  34 #include <gtkmm/box.h>
  35 #include <gtkmm/button.h>
  36 #include <gtkmm/eventbox.h>
  37 #include <gtkmm/expander.h>
  38 #include <gtkmm/filechooserbutton.h>
  39 #include <gtkmm/image.h>
  40 #include <gtkmm/label.h>
  41 #include <gtkmm/menu.h>
  42 #include <gtkmm/scrolledwindow.h>
  43 #include <gtkmm/socket.h>
  44 #include <gtkmm/table.h>
  45 #include <gtkmm/togglebutton.h>
  46 #include <gtkmm/viewport.h>
  47
  48 #include "ardour/types.h"
  49 #include "ardour/plugin.h"
  50 #include "ardour/variant.h"
  51
  52 #include "widgets/ardour_button.h"
  53 #include "widgets/ardour_dropdown.h"
  54 #include "widgets/ardour_spinner.h"
  55
  56 #include "ardour_window.h"
  57 #include "automation_controller.h"
  58
  59 namespace ARDOUR {
  60         class PluginInsert;
  61         class Plugin;
  62         class WindowsVSTPlugin;
  63         class LXVSTPlugin;
  64         class IOProcessor;
  65         class AUPlugin;
  66         class Processor;
  67 }
  68
  69 namespace PBD {
  70         class Controllable;
  71 }
  72
  73 namespace ArdourWidgets {
  74         class ClickBox;
  75         class FastMeter;
  76 }
  77
  78 class LatencyGUI;
  79 class ArdourWindow;
  80 class PluginEqGui;
  81 class VSTPluginUI;
  82
  83 class PlugUIBase : public virtual sigc::trackable, public PBD::ScopedConnectionList
  84 {
  85 public:
  86         PlugUIBase (boost::shared_ptr<ARDOUR::PluginInsert>);
  87         virtual ~PlugUIBase();
  88
  89         virtual gint get_preferred_height () = 0;
  90         virtual gint get_preferred_width () = 0;
  91         virtual bool resizable () { return true; }
  92         virtual bool start_updating(GdkEventAny*) = 0;
  93         virtual bool stop_updating(GdkEventAny*) = 0;
  94
  95         virtual void activate () {}
  96         virtual void deactivate () {}
  97
  98         void update_preset_list ();
  99         void update_preset ();
 100
 101         void latency_button_clicked ();
 102
 103         virtual bool on_window_show(const std::string& /*title*/) { return true; }
 104         virtual void on_window_hide() {}
 105
 106         virtual void forward_key_event (GdkEventKey*) {}
 107         virtual void grab_focus () {}
 108         virtual bool non_gtk_gui() const { return false; }
 109
 110         sigc::signal<void,bool> KeyboardFocused;
 111
 112 protected:
 113         boost::shared_ptr<ARDOUR::PluginInsert> insert;
 114         boost::shared_ptr<ARDOUR::Plugin> plugin;
 115
 116         /* UI elements that can subclasses can add to their widgets */
 117
 118         /** a ComboBoxText which lists presets and manages their selection */
 119         ArdourWidgets::ArdourDropdown _preset_combo;
 120         /** a label which has a * in if the current settings are different from the preset being shown */
 121         Gtk::Label _preset_modified;
 122         /** a button to add a preset */
 123         ArdourWidgets::ArdourButton add_button;
 124         /** a button to save the current settings as a new user preset */
 125         ArdourWidgets::ArdourButton save_button;
 126         /** a button to delete the current preset (if it is a user one) */
 127         ArdourWidgets::ArdourButton delete_button;
 128         /** a button to delete the reset the plugin params */
 129         ArdourWidgets::ArdourButton reset_button;
 130         /** a button to bypass the plugin */
 131         ArdourWidgets::ArdourButton bypass_button;
 132         /** and self-explaining button :) */
 133         ArdourWidgets::ArdourButton pin_management_button;
 134         /** a button to acquire keyboard focus */
 135         Gtk::EventBox focus_button;
 136         /** an expander containing the plugin description */
 137         Gtk::Expander description_expander;
 138         /** an expander containing the plugin analysis graph */
 139         Gtk::Expander plugin_analysis_expander;
 140         /** a button which, when clicked, opens the latency GUI */
 141         ArdourWidgets::ArdourButton latency_button;
 142         /** a button which sets all controls' automation setting to Manual */
 143         ArdourWidgets::ArdourButton automation_manual_all_button;
 144         /** a button which sets all controls' automation setting to Play */
 145         ArdourWidgets::ArdourButton automation_play_all_button;
 146         /** a button which sets all controls' automation setting to Write */
 147         ArdourWidgets::ArdourButton automation_write_all_button;
 148         /** a button which sets all controls' automation setting to Touch */
 149         ArdourWidgets::ArdourButton automation_touch_all_button;
 150
 151         void set_latency_label ();
 152
 153         LatencyGUI* latency_gui;
 154         ArdourWindow* latency_dialog;
 155
 156         PluginEqGui* eqgui;
 157
 158         Gtk::Image* focus_out_image;
 159         Gtk::Image* focus_in_image;
 160         int _no_load_preset;
 161
 162         virtual void preset_selected (ARDOUR::Plugin::PresetRecord preset);
 163         void add_plugin_setting ();
 164         void save_plugin_setting ();
 165         void delete_plugin_setting ();
 166         void reset_plugin_parameters ();
 167         void manage_pins ();
 168         bool focus_toggled(GdkEventButton*);
 169         bool bypass_button_release(GdkEventButton*);
 170         void toggle_description ();
 171         void toggle_plugin_analysis ();
 172         void processor_active_changed (boost::weak_ptr<ARDOUR::Processor> p);
 173         void plugin_going_away ();
 174         void automation_state_changed ();
 175         void preset_added_or_removed ();
 176         void update_preset_modified ();
 177
 178         PBD::ScopedConnection death_connection;
 179         PBD::ScopedConnection active_connection;
 180         PBD::ScopedConnection preset_added_connection;
 181         PBD::ScopedConnection preset_removed_connection;
 182         PBD::ScopedConnectionList control_connections;
 183 };
 184
 185 class GenericPluginUI : public PlugUIBase, public Gtk::VBox
 186 {
 187 public:
 188         GenericPluginUI (boost::shared_ptr<ARDOUR::PluginInsert> plug, bool scrollable=false);
 189         ~GenericPluginUI ();
 190
 191         gint get_preferred_height () { return prefheight; }
 192         gint get_preferred_width () { return -1; }
 193
 194         bool start_updating(GdkEventAny*);
 195         bool stop_updating(GdkEventAny*);
 196
 197 private:
 198         Gtk::VBox main_contents;
 199         Gtk::HBox settings_box;
 200         Gtk::HBox hpacker;
 201         Gtk::Menu* automation_menu;
 202
 203         gint prefheight;
 204         bool is_scrollable;
 205
 206         struct MeterInfo {
 207                 ArdourWidgets::FastMeter* meter;
 208                 bool packed;
 209
 210                 MeterInfo () {
 211                         meter = 0;
 212                         packed = false;
 213                 }
 214         };
 215
 216         /* FIXME: Unify with AutomationController */
 217         struct ControlUI : public Gtk::HBox {
 218
 219                 const Evoral::Parameter parameter() const { return param; }
 220
 221                 Evoral::Parameter                            param;
 222                 boost::shared_ptr<ARDOUR::AutomationControl> control;
 223
 224                 /* input */
 225
 226                 boost::shared_ptr<ARDOUR::ScalePoints>  scale_points;
 227                 boost::shared_ptr<AutomationController> controller;
 228
 229                 ArdourWidgets::ArdourButton             automate_button;
 230                 Gtk::Label                              label;
 231                 ArdourWidgets::ArdourDropdown*          combo;
 232                 ArdourWidgets::ClickBox*                clickbox;
 233                 Gtk::FileChooserButton*                 file_button;
 234                 ArdourWidgets::ArdourSpinner*           spin_box;
 235
 236                 bool                                    button;
 237                 bool                                    update_pending;
 238                 bool                                    ignore_change;
 239
 240
 241                 /* output */
 242
 243                 Gtk::EventBox* display;
 244                 Gtk::Label*    display_label;
 245
 246                 Gtk::HBox*     hbox;
 247                 Gtk::VBox*     vbox;
 248                 MeterInfo*     meterinfo;
 249
 250                 ControlUI (const Evoral::Parameter& param);
 251                 ~ControlUI ();
 252
 253                 /* layout */
 254                 Gtk::Table* knobtable;
 255                 int x0, x1, y0, y1;
 256
 257                 bool short_autostate; // modify with set_short_autostate below
 258         };
 259
 260         void set_short_autostate(ControlUI* cui, bool value);
 261
 262         std::vector<ControlUI*>   input_controls; // workaround for preset load
 263         std::vector<ControlUI*>   input_controls_with_automation;
 264         std::vector<ControlUI*>   output_controls;
 265
 266         sigc::connection screen_update_connection;
 267
 268         void output_update();
 269
 270         void build ();
 271         void automatic_layout (const std::vector<ControlUI *>& control_uis);
 272         void custom_layout (const std::vector<ControlUI *>& control_uis);
 273
 274         ControlUI* build_control_ui (const Evoral::Parameter&                     param,
 275                                      const ARDOUR::ParameterDescriptor&           desc,
 276                                      boost::shared_ptr<ARDOUR::AutomationControl> mcontrol,
 277                                      float                                        value,
 278                                      bool                                         is_input,
 279                                      bool                                         use_knob = false);
 280
 281         void ui_parameter_changed (ControlUI* cui);
 282         void update_control_display (ControlUI* cui);
 283         void update_input_displays (); // workaround for preset load
 284         void control_combo_changed (ControlUI* cui, float value);
 285
 286         bool astate_button_event (GdkEventButton* ev, ControlUI*);
 287         void automation_state_changed (ControlUI*);
 288         void set_automation_state (ARDOUR::AutoState state, ControlUI* cui);
 289         void set_all_automation (ARDOUR::AutoState state);
 290
 291         void knob_size_request(Gtk::Requisition* req, ControlUI* cui);
 292
 293         /* XXX: remove */
 294         void print_parameter (char *buf, uint32_t len, uint32_t param);
 295         bool integer_printer (char* buf, Gtk::Adjustment &, ControlUI *);
 296         bool midinote_printer(char* buf, Gtk::Adjustment &, ControlUI *);
 297
 298         typedef std::map<uint32_t, Gtk::FileChooserButton*> FilePathControls;
 299         FilePathControls _filepath_controls;
 300         void set_path_property (const ARDOUR::ParameterDescriptor& desc,
 301                                 Gtk::FileChooserButton*            widget);
 302         void path_property_changed (uint32_t key, const ARDOUR::Variant& value);
 303
 304 };
 305
 306 class PluginUIWindow : public ArdourWindow
 307 {
 308 public:
 309         PluginUIWindow (boost::shared_ptr<ARDOUR::PluginInsert> insert,
 310                         bool scrollable=false,
 311                         bool editor=true);
 312         ~PluginUIWindow ();
 313
 314         PlugUIBase& pluginui() { return *_pluginui; }
 315
 316         void resize_preferred();
 317         void set_parent (Gtk::Window*);
 318         void set_title(const std::string& title);
 319
 320
 321         bool on_key_press_event (GdkEventKey*);
 322         bool on_key_release_event (GdkEventKey*);
 323         void on_show ();
 324         void on_hide ();
 325
 326 private:
 327         std::string _title;
 328         PlugUIBase* _pluginui;
 329         PBD::ScopedConnection death_connection;
 330         Gtk::Window* parent;
 331         Gtk::VBox vbox;
 332         bool was_visible;
 333         bool _keyboard_focused;
 334 #ifdef AUDIOUNIT_SUPPORT
 335         int pre_deactivate_x;
 336         int pre_deactivate_y;
 337 #endif
 338
 339         void keyboard_focused (bool yn);
 340
 341         void app_activated (bool);
 342         void plugin_going_away ();
 343
 344         bool create_windows_vst_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
 345         bool create_lxvst_editor(boost::shared_ptr<ARDOUR::PluginInsert>);
 346         bool create_mac_vst_editor(boost::shared_ptr<ARDOUR::PluginInsert>);
 347         bool create_audiounit_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
 348         bool create_lv2_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
 349 };
 350
 351 #ifdef MACVST_SUPPORT
 352 /* this function has to be in a .mm file
 353  * because MacVSTPluginUI has Cocoa members
 354  */
 355 extern VSTPluginUI* create_mac_vst_gui (boost::shared_ptr<ARDOUR::PluginInsert>);
 356 #endif
 357
 358 #ifdef AUDIOUNIT_SUPPORT
 359 /* this function has to be in a .mm file */
 360 extern PlugUIBase* create_au_gui (boost::shared_ptr<ARDOUR::PluginInsert>, Gtk::VBox**);
 361 #endif
 362
 363 #endif /* __ardour_plugin_ui_h__ */