2 Copyright (C) 2000-2006 Paul Davis
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.
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.
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.
20 #ifndef __ardour_plugin_ui_h__
21 #define __ardour_plugin_ui_h__
24 #include "gtk2ardour-config.h"
31 #include <sigc++/signal.h>
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>
48 #include "ardour/types.h"
50 #include "automation_controller.h"
65 class HSliderController;
75 class PlugUIBase : public virtual sigc::trackable
78 PlugUIBase (boost::shared_ptr<ARDOUR::PluginInsert>);
79 virtual ~PlugUIBase();
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;
86 virtual void activate () {}
87 virtual void deactivate () {}
89 virtual void update_presets ();
91 void latency_button_clicked ();
93 virtual bool on_window_show(const Glib::ustring& /*title*/) { return true; }
94 virtual void on_window_hide() {}
96 virtual void forward_key_event (GdkEventKey*) {}
97 virtual bool non_gtk_gui() const { return false; }
99 sigc::signal<void,bool> KeyboardFocused;
102 boost::shared_ptr<ARDOUR::PluginInsert> insert;
103 boost::shared_ptr<ARDOUR::Plugin> plugin;
104 Gtk::ComboBoxText preset_combo;
105 Gtk::Button save_button;
106 Gtk::ToggleButton bypass_button;
107 Gtk::EventBox focus_button;
109 Gtk::Label latency_label;
110 Gtk::Button latency_button;
111 void set_latency_label ();
113 LatencyGUI* latency_gui;
114 ArdourDialog* latency_dialog;
116 Gtk::Expander plugin_analysis_expander;
118 Gtk::Image* focus_out_image;
119 Gtk::Image* focus_in_image;
122 void setting_selected();
123 void save_plugin_setting (void);
124 bool focus_toggled(GdkEventButton*);
125 void bypass_toggled();
126 void toggle_plugin_analysis ();
127 void processor_active_changed (boost::weak_ptr<ARDOUR::Processor> p);
128 void plugin_going_away ();
130 PBD::ScopedConnection death_connection;
131 PBD::ScopedConnection active_connection;
132 PBD::ScopedConnectionList control_connections;
135 class GenericPluginUI : public PlugUIBase, public Gtk::VBox
138 GenericPluginUI (boost::shared_ptr<ARDOUR::PluginInsert> plug, bool scrollable=false);
141 gint get_preferred_height () { return prefheight; }
142 gint get_preferred_width () { return -1; }
144 bool start_updating(GdkEventAny*);
145 bool stop_updating(GdkEventAny*);
148 Gtk::VBox main_contents;
150 Gtk::HBox settings_box;
153 Gtk::Table button_table;
154 Gtk::Table output_table;
156 Gtk::ScrolledWindow scroller;
157 Gtk::Adjustment hAdjustment;
158 Gtk::Adjustment vAdjustment;
159 Gtk::Viewport scroller_view;
160 Gtk::Menu* automation_menu;
166 Gtkmm2ext::FastMeter *meter;
174 MeterInfo (int /*i*/) {
184 static const int32_t initial_button_rows = 12;
185 static const int32_t initial_button_cols = 1;
186 static const int32_t initial_output_rows = 1;
187 static const int32_t initial_output_cols = 4;
189 /* FIXME: Unify with AutomationController */
190 struct ControlUI : public Gtk::HBox {
192 boost::shared_ptr<ARDOUR::AutomationControl> control;
194 Evoral::Parameter parameter() { return control->parameter(); }
198 Gtk::ComboBoxText* combo;
199 std::map<std::string, float>* combo_map;
200 Gtk::ToggleButton* button;
201 boost::shared_ptr<AutomationController> controller;
202 Gtkmm2ext::ClickBox* clickbox;
207 Gtk::Button automate_button;
211 Gtk::EventBox *display;
212 Gtk::Label* display_label;
216 MeterInfo * meterinfo;
222 std::vector<ControlUI*> input_controls;
223 std::vector<ControlUI*> output_controls;
224 sigc::connection screen_update_connection;
225 void output_update();
228 ControlUI* build_control_ui (guint32 port_index, boost::shared_ptr<ARDOUR::AutomationControl>);
229 std::vector<std::string> setup_scale_values(guint32 port_index, ControlUI* cui);
230 void parameter_changed (ControlUI* cui);
231 void toggle_parameter_changed (ControlUI* cui);
232 void update_control_display (ControlUI* cui);
233 void control_port_toggled (ControlUI* cui);
234 void control_combo_changed (ControlUI* cui);
236 void processor_active_changed (boost::weak_ptr<ARDOUR::Processor>);
238 void astate_clicked (ControlUI*, uint32_t parameter);
239 void automation_state_changed (ControlUI*);
240 void set_automation_state (ARDOUR::AutoState state, ControlUI* cui);
241 void start_touch (ControlUI*);
242 void stop_touch (ControlUI*);
244 void print_parameter (char *buf, uint32_t len, uint32_t param);
247 class PluginUIWindow : public Gtk::Window
250 PluginUIWindow (Gtk::Window*, boost::shared_ptr<ARDOUR::PluginInsert> insert, bool scrollable=false);
253 PlugUIBase& pluginui() { return *_pluginui; }
255 void resize_preferred();
256 void set_parent (Gtk::Window*);
257 void set_title(const Glib::ustring& title);
260 bool on_enter_notify_event (GdkEventCrossing*);
261 bool on_leave_notify_event (GdkEventCrossing*);
262 bool on_focus_in_event (GdkEventFocus*);
263 bool on_focus_out_event (GdkEventFocus*);
264 bool on_key_press_event (GdkEventKey*);
265 bool on_key_release_event (GdkEventKey*);
271 Glib::ustring _title;
272 PlugUIBase* _pluginui;
273 PBD::ScopedConnection death_connection;
277 bool _keyboard_focused;
278 void keyboard_focused (bool yn);
280 void app_activated (bool);
281 void plugin_going_away ();
283 bool create_vst_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
284 bool create_audiounit_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
285 bool create_lv2_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
289 class VSTPluginUI : public PlugUIBase, public Gtk::VBox
292 VSTPluginUI (boost::shared_ptr<ARDOUR::PluginInsert>, boost::shared_ptr<ARDOUR::VSTPlugin>);
295 gint get_preferred_height ();
296 gint get_preferred_width ();
297 bool start_updating(GdkEventAny*) {return false;}
298 bool stop_updating(GdkEventAny*) {return false;}
300 int package (Gtk::Window&);
303 boost::shared_ptr<ARDOUR::VSTPlugin> vst;
305 Gtk::HBox preset_box;
307 Gtk::ComboBoxText vst_preset_combo;
308 Glib::RefPtr<Gtk::ListStore> preset_model;
310 struct PresetModelColumns : public Gtk::TreeModel::ColumnRecord {
311 PresetModelColumns() {
315 Gtk::TreeModelColumn<Glib::ustring> name;
316 Gtk::TreeModelColumn<int> number;
319 PresetModelColumns preset_columns;
321 bool configure_handler (GdkEventConfigure*, Gtk::Socket*);
322 void save_plugin_setting ();
323 void create_preset_store ();
324 void preset_chosen ();
326 #endif // VST_SUPPORT
328 #ifdef HAVE_AUDIOUNITS
329 /* this function has to be in a .mm file */
330 extern PlugUIBase* create_au_gui (boost::shared_ptr<ARDOUR::PluginInsert>, Gtk::VBox**);
333 #endif /* __ardour_plugin_ui_h__ */