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 #include <vector>
  24 #include <map>
  25 #include <list>
  26
  27 #include <sigc++/signal.h>
  28
  29 #include <gtkmm/button.h>
  30 #include <gtkmm/box.h>
  31 #include <gtkmm/table.h>
  32 #include <gtkmm/eventbox.h>
  33 #include <gtkmm/viewport.h>
  34 #include <gtkmm/scrolledwindow.h>
  35 #include <gtkmm/label.h>
  36 #include <gtkmm/menu.h>
  37 #include <gtkmm/adjustment.h>
  38 #include <gtkmm/togglebutton.h>
  39 #include <gtkmm/socket.h>
  40 #include <gtkmm/comboboxtext.h>
  41 #include <gtkmm/socket.h>
  42
  43 #include <ardour_dialog.h>
  44 #include <ardour/types.h>
  45
  46 #include "latency_gui.h"
  47
  48 namespace ARDOUR {
  49         class PluginInsert;
  50         class Plugin;
  51         class VSTPlugin;
  52         class IOProcessor;
  53         class AUPlugin;
  54 }
  55
  56 namespace PBD {
  57         class Controllable;
  58 }
  59
  60 namespace Gtkmm2ext {
  61         class HSliderController;
  62         class BarController;
  63         class ClickBox;
  64         class FastMeter;
  65         class PixmapButton;
  66 }
  67
  68 class PlugUIBase : public virtual sigc::trackable
  69 {
  70   public:
  71         PlugUIBase (boost::shared_ptr<ARDOUR::PluginInsert>, nframes64_t sample_rate, nframes64_t period_size);
  72         virtual ~PlugUIBase() {}
  73
  74         virtual gint get_preferred_height () = 0;
  75         virtual bool start_updating(GdkEventAny*) = 0;
  76         virtual bool stop_updating(GdkEventAny*) = 0;
  77
  78   protected:
  79         boost::shared_ptr<ARDOUR::PluginInsert> insert;
  80         boost::shared_ptr<ARDOUR::Plugin> plugin;
  81         Gtk::ComboBoxText combo;
  82         Gtk::Button save_button;
  83         Gtk::ToggleButton bypass_button;
  84         LatencyGUI latency_gui;
  85
  86         void setting_selected();
  87         void save_plugin_setting (void);
  88         void bypass_toggled();
  89 };
  90
  91 class LadspaPluginUI : public PlugUIBase, public Gtk::VBox
  92 {
  93   public:
  94         LadspaPluginUI (boost::shared_ptr<ARDOUR::PluginInsert> plug, nframes64_t sample_rate, nframes64_t period_size, bool scrollable = false);
  95         ~LadspaPluginUI ();
  96
  97         gint get_preferred_height () { return prefheight; }
  98
  99         bool start_updating(GdkEventAny*);
 100         bool stop_updating(GdkEventAny*);
 101
 102   private:
 103         Gtk::HBox settings_box;
 104         Gtk::HBox hpacker;
 105
 106         Gtk::Table button_table;
 107         Gtk::Table output_table;
 108
 109         Gtk::ScrolledWindow scroller;
 110         Gtk::Adjustment hAdjustment;
 111         Gtk::Adjustment vAdjustment;
 112         Gtk::Viewport scroller_view;
 113         Gtk::Menu* automation_menu;
 114
 115         gint prefheight;
 116         bool is_scrollable;
 117
 118         struct MeterInfo {
 119                 Gtkmm2ext::FastMeter *meter;
 120
 121                 float           min;
 122                 float           max;
 123                 bool            min_unbound;
 124                 bool            max_unbound;
 125                 bool packed;
 126
 127                 MeterInfo(int i) {
 128                         meter = 0;
 129                         packed = false;
 130                         min = 1.0e10;
 131                         max = -1.0e10;
 132                         min_unbound = false;
 133                         max_unbound = false;
 134                 }
 135         };
 136
 137         static const int32_t initial_button_rows = 6;
 138         static const int32_t initial_button_cols = 1;
 139         static const int32_t initial_output_rows = 1;
 140         static const int32_t initial_output_cols = 4;
 141
 142         /* TODO: pull this out of PluginUI and make it generic.
 143          * Sticking this in the track controls of an automation track would
 144          * make a handy touch controller for anything.
 145          */
 146         struct ControlUI : public Gtk::HBox {
 147
 148             uint32_t      port_index;
 149
 150             /* input */
 151
 152             Gtk::Adjustment*          adjustment;
 153             Gtk::ComboBoxText*        combo;
 154             std::map<string, float>*  combo_map;
 155             Gtk::ToggleButton*        button;
 156             Gtkmm2ext::BarController*  control;
 157             Gtkmm2ext::ClickBox*       clickbox;
 158             Gtk::Label         label;
 159             bool               logarithmic;
 160             bool               update_pending;
 161             char               ignore_change;
 162             Gtk::Button        automate_button;
 163
 164             /* output */
 165
 166             Gtk::EventBox *display;
 167             Gtk::Label*    display_label;
 168
 169                 Gtk::HBox  *    hbox;
 170                 Gtk::VBox  *    vbox;
 171             MeterInfo  *    meterinfo;
 172
 173             ControlUI ();
 174             ~ControlUI();
 175         };
 176
 177         std::vector<ControlUI*>   output_controls;
 178         sigc::connection screen_update_connection;
 179         void output_update();
 180
 181         void build ();
 182         ControlUI* build_control_ui (guint32 port_index, PBD::Controllable *);
 183         std::vector<string> setup_scale_values(guint32 port_index, ControlUI* cui);
 184         void control_adjustment_changed (ControlUI* cui);
 185         void parameter_changed (uint32_t, float, ControlUI* cui);
 186         void update_control_display (ControlUI* cui);
 187         void control_port_toggled (ControlUI* cui);
 188         void control_combo_changed (ControlUI* cui);
 189
 190         void processor_active_changed (boost::weak_ptr<ARDOUR::Processor>);
 191
 192         void astate_clicked (ControlUI*, uint32_t parameter);
 193         void automation_state_changed (ControlUI*);
 194         void set_automation_state (ARDOUR::AutoState state, ControlUI* cui);
 195         void start_touch (ControlUI*);
 196         void stop_touch (ControlUI*);
 197
 198         void print_parameter (char *buf, uint32_t len, uint32_t param);
 199 };
 200
 201 class PluginUIWindow : public ArdourDialog
 202 {
 203   public:
 204         PluginUIWindow (boost::shared_ptr<ARDOUR::PluginInsert> insert, nframes64_t sample_rate, nframes64_t period_size, bool scrollable = false);
 205         ~PluginUIWindow ();
 206
 207         PlugUIBase& pluginui() { return *_pluginui; }
 208
 209         void resize_preferred();
 210
 211         virtual bool on_key_press_event (GdkEventKey*);
 212         virtual bool on_key_release_event (GdkEventKey*);
 213
 214   private:
 215         PlugUIBase* _pluginui;
 216         void plugin_going_away ();
 217 };
 218
 219 #ifdef VST_SUPPORT
 220 class VSTPluginUI : public PlugUIBase, public Gtk::VBox
 221 {
 222   public:
 223         VSTPluginUI (boost::shared_ptr<ARDOUR::PluginInsert>, boost::shared_ptr<ARDOUR::VSTPlugin>, nframes64_t sample_rate, nframes64_t period_size);
 224         ~VSTPluginUI ();
 225
 226         gint get_preferred_height ();
 227         bool start_updating(GdkEventAny*) {return false;}
 228         bool stop_updating(GdkEventAny*) {return false;}
 229
 230         int package (Gtk::Window&);
 231
 232   private:
 233         boost::shared_ptr<ARDOUR::VSTPlugin>  vst;
 234         Gtk::Socket socket;
 235         Gtk::HBox   preset_box;
 236         Gtk::VBox   vpacker;
 237
 238         bool configure_handler (GdkEventConfigure*, Gtk::Socket*);
 239         void save_plugin_setting ();
 240 };
 241 #endif // VST_SUPPORT
 242
 243 #endif /* __ardour_plugin_ui_h__ */