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 std::string& /*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::Button edit_button;
107 Gtk::ToggleButton bypass_button;
108 Gtk::EventBox focus_button;
110 Gtk::Label latency_label;
111 Gtk::Button latency_button;
112 void set_latency_label ();
114 LatencyGUI* latency_gui;
115 ArdourDialog* latency_dialog;
117 Gtk::Expander plugin_analysis_expander;
119 Gtk::Image* focus_out_image;
120 Gtk::Image* focus_in_image;
123 void setting_selected();
124 void save_plugin_setting ();
125 void edit_plugin_settings ();
126 bool focus_toggled(GdkEventButton*);
127 void bypass_toggled();
128 void toggle_plugin_analysis ();
129 void processor_active_changed (boost::weak_ptr<ARDOUR::Processor> p);
130 void plugin_going_away ();
132 PBD::ScopedConnection death_connection;
133 PBD::ScopedConnection active_connection;
134 PBD::ScopedConnection preset_added_connection;
135 PBD::ScopedConnection preset_removed_connection;
136 PBD::ScopedConnectionList control_connections;
139 class GenericPluginUI : public PlugUIBase, public Gtk::VBox
142 GenericPluginUI (boost::shared_ptr<ARDOUR::PluginInsert> plug, bool scrollable=false);
145 gint get_preferred_height () { return prefheight; }
146 gint get_preferred_width () { return -1; }
148 bool start_updating(GdkEventAny*);
149 bool stop_updating(GdkEventAny*);
152 Gtk::VBox main_contents;
154 Gtk::HBox settings_box;
157 Gtk::Table button_table;
158 Gtk::Table output_table;
160 Gtk::ScrolledWindow scroller;
161 Gtk::Adjustment hAdjustment;
162 Gtk::Adjustment vAdjustment;
163 Gtk::Viewport scroller_view;
164 Gtk::Menu* automation_menu;
170 Gtkmm2ext::FastMeter *meter;
178 MeterInfo (int /*i*/) {
188 static const int32_t initial_button_rows = 12;
189 static const int32_t initial_button_cols = 1;
190 static const int32_t initial_output_rows = 1;
191 static const int32_t initial_output_cols = 4;
193 /* FIXME: Unify with AutomationController */
194 struct ControlUI : public Gtk::HBox {
196 boost::shared_ptr<ARDOUR::AutomationControl> control;
198 Evoral::Parameter parameter() { return control->parameter(); }
202 Gtk::ComboBoxText* combo;
203 std::map<std::string, float>* combo_map;
204 Gtk::ToggleButton* button;
205 boost::shared_ptr<AutomationController> controller;
206 Gtkmm2ext::ClickBox* clickbox;
211 Gtk::Button automate_button;
215 Gtk::EventBox *display;
216 Gtk::Label* display_label;
220 MeterInfo * meterinfo;
226 std::vector<ControlUI*> input_controls;
227 std::vector<ControlUI*> output_controls;
228 sigc::connection screen_update_connection;
229 void output_update();
232 ControlUI* build_control_ui (guint32 port_index, boost::shared_ptr<ARDOUR::AutomationControl>);
233 std::vector<std::string> setup_scale_values(guint32 port_index, ControlUI* cui);
234 void parameter_changed (ControlUI* cui);
235 void toggle_parameter_changed (ControlUI* cui);
236 void update_control_display (ControlUI* cui);
237 void control_port_toggled (ControlUI* cui);
238 void control_combo_changed (ControlUI* cui);
240 void processor_active_changed (boost::weak_ptr<ARDOUR::Processor>);
242 void astate_clicked (ControlUI*, uint32_t parameter);
243 void automation_state_changed (ControlUI*);
244 void set_automation_state (ARDOUR::AutoState state, ControlUI* cui);
245 void start_touch (ControlUI*);
246 void stop_touch (ControlUI*);
248 void print_parameter (char *buf, uint32_t len, uint32_t param);
251 class PluginUIWindow : public Gtk::Window
254 PluginUIWindow (Gtk::Window*, boost::shared_ptr<ARDOUR::PluginInsert> insert, bool scrollable=false);
257 PlugUIBase& pluginui() { return *_pluginui; }
259 void resize_preferred();
260 void set_parent (Gtk::Window*);
261 void set_title(const std::string& title);
264 bool on_enter_notify_event (GdkEventCrossing*);
265 bool on_leave_notify_event (GdkEventCrossing*);
266 bool on_focus_in_event (GdkEventFocus*);
267 bool on_focus_out_event (GdkEventFocus*);
268 bool on_key_press_event (GdkEventKey*);
269 bool on_key_release_event (GdkEventKey*);
276 PlugUIBase* _pluginui;
277 PBD::ScopedConnection death_connection;
281 bool _keyboard_focused;
282 void keyboard_focused (bool yn);
284 void app_activated (bool);
285 void plugin_going_away ();
287 bool create_vst_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
288 bool create_audiounit_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
289 bool create_lv2_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
293 class VSTPluginUI : public PlugUIBase, public Gtk::VBox
296 VSTPluginUI (boost::shared_ptr<ARDOUR::PluginInsert>, boost::shared_ptr<ARDOUR::VSTPlugin>);
299 gint get_preferred_height ();
300 gint get_preferred_width ();
301 bool start_updating(GdkEventAny*) {return false;}
302 bool stop_updating(GdkEventAny*) {return false;}
304 int package (Gtk::Window&);
307 boost::shared_ptr<ARDOUR::VSTPlugin> vst;
309 Gtk::HBox preset_box;
311 Gtk::ComboBox vst_preset_combo;
312 Glib::RefPtr<Gtk::ListStore> preset_model;
314 struct PresetModelColumns : public Gtk::TreeModel::ColumnRecord {
315 PresetModelColumns() {
319 Gtk::TreeModelColumn<std::string> name;
320 Gtk::TreeModelColumn<int> number;
323 PresetModelColumns preset_columns;
325 bool configure_handler (GdkEventConfigure*, Gtk::Socket*);
326 void save_plugin_setting ();
327 void create_preset_store ();
328 void preset_chosen ();
330 #endif // VST_SUPPORT
333 /* this function has to be in a .mm file */
334 extern PlugUIBase* create_au_gui (boost::shared_ptr<ARDOUR::PluginInsert>, Gtk::VBox**);
337 #endif /* __ardour_plugin_ui_h__ */