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;
76 class PlugUIBase : public virtual sigc::trackable, public PBD::ScopedConnectionList
79 PlugUIBase (boost::shared_ptr<ARDOUR::PluginInsert>);
80 virtual ~PlugUIBase();
82 virtual gint get_preferred_height () = 0;
83 virtual gint get_preferred_width () = 0;
84 virtual bool start_updating(GdkEventAny*) = 0;
85 virtual bool stop_updating(GdkEventAny*) = 0;
87 virtual void activate () {}
88 virtual void deactivate () {}
90 void update_preset_list ();
91 void update_preset ();
93 void latency_button_clicked ();
95 virtual bool on_window_show(const std::string& /*title*/) { return true; }
96 virtual void on_window_hide() {}
98 virtual void forward_key_event (GdkEventKey*) {}
99 virtual bool non_gtk_gui() const { return false; }
101 sigc::signal<void,bool> KeyboardFocused;
104 boost::shared_ptr<ARDOUR::PluginInsert> insert;
105 boost::shared_ptr<ARDOUR::Plugin> plugin;
106 Gtk::HBox _preset_box;
107 Gtk::ComboBoxText _preset_combo;
108 Gtk::Label _preset_modified;
109 Gtk::Button add_button;
110 Gtk::Button save_button;
111 Gtk::Button delete_button;
112 Gtk::ToggleButton bypass_button;
113 Gtk::EventBox focus_button;
115 Gtk::Label latency_label;
116 Gtk::Button latency_button;
117 void set_latency_label ();
119 LatencyGUI* latency_gui;
120 ArdourDialog* latency_dialog;
122 Gtk::Expander plugin_analysis_expander;
124 Gtk::Requisition pre_eq_size;
126 Gtk::Image* focus_out_image;
127 Gtk::Image* focus_in_image;
130 virtual void preset_selected ();
131 void add_plugin_setting ();
132 void save_plugin_setting ();
133 void delete_plugin_setting ();
134 bool focus_toggled(GdkEventButton*);
135 void bypass_toggled();
136 void toggle_plugin_analysis ();
137 void processor_active_changed (boost::weak_ptr<ARDOUR::Processor> p);
138 void plugin_going_away ();
139 virtual void parameter_changed (uint32_t, float);
140 void preset_added_or_removed ();
141 void update_preset_modified ();
143 PBD::ScopedConnection death_connection;
144 PBD::ScopedConnection active_connection;
145 PBD::ScopedConnection preset_added_connection;
146 PBD::ScopedConnection preset_removed_connection;
147 PBD::ScopedConnectionList control_connections;
150 class GenericPluginUI : public PlugUIBase, public Gtk::VBox
153 GenericPluginUI (boost::shared_ptr<ARDOUR::PluginInsert> plug, bool scrollable=false);
156 gint get_preferred_height () { return prefheight; }
157 gint get_preferred_width () { return -1; }
159 bool start_updating(GdkEventAny*);
160 bool stop_updating(GdkEventAny*);
163 Gtk::VBox main_contents;
165 Gtk::HBox settings_box;
168 Gtk::Table button_table;
169 Gtk::Table output_table;
171 Gtk::ScrolledWindow scroller;
172 Gtk::Adjustment hAdjustment;
173 Gtk::Adjustment vAdjustment;
174 Gtk::Viewport scroller_view;
175 Gtk::Menu* automation_menu;
181 Gtkmm2ext::FastMeter *meter;
189 MeterInfo (int /*i*/) {
199 static const int32_t initial_button_rows = 12;
200 static const int32_t initial_button_cols = 1;
201 static const int32_t initial_output_rows = 1;
202 static const int32_t initial_output_cols = 4;
204 /* FIXME: Unify with AutomationController */
205 struct ControlUI : public Gtk::HBox {
208 boost::shared_ptr<ARDOUR::AutomationControl> control;
210 Evoral::Parameter parameter() { return control->parameter(); }
214 Gtk::ComboBoxText* combo;
215 std::map<std::string, float>* combo_map;
216 Gtk::ToggleButton* button;
217 boost::shared_ptr<AutomationController> controller;
218 Gtkmm2ext::ClickBox* clickbox;
222 Gtk::Button automate_button;
226 Gtk::EventBox* display;
227 Gtk::Label* display_label;
231 MeterInfo* meterinfo;
237 std::vector<ControlUI*> input_controls;
238 std::vector<ControlUI*> output_controls;
239 sigc::connection screen_update_connection;
240 void output_update();
243 ControlUI* build_control_ui (guint32 port_index, boost::shared_ptr<ARDOUR::AutomationControl>);
244 void ui_parameter_changed (ControlUI* cui);
245 void toggle_parameter_changed (ControlUI* cui);
246 void update_control_display (ControlUI* cui);
247 void control_port_toggled (ControlUI* cui);
248 void control_combo_changed (ControlUI* cui);
250 void processor_active_changed (boost::weak_ptr<ARDOUR::Processor>);
252 void astate_clicked (ControlUI*, uint32_t parameter);
253 void automation_state_changed (ControlUI*);
254 void set_automation_state (ARDOUR::AutoState state, ControlUI* cui);
255 void start_touch (ControlUI*);
256 void stop_touch (ControlUI*);
258 void print_parameter (char *buf, uint32_t len, uint32_t param);
261 class PluginUIWindow : public Gtk::Window
264 PluginUIWindow (Gtk::Window*,
265 boost::shared_ptr<ARDOUR::PluginInsert> insert,
266 bool scrollable=false,
270 PlugUIBase& pluginui() { return *_pluginui; }
272 void resize_preferred();
273 void set_parent (Gtk::Window*);
274 void set_title(const std::string& title);
277 bool on_enter_notify_event (GdkEventCrossing*);
278 bool on_leave_notify_event (GdkEventCrossing*);
279 bool on_focus_in_event (GdkEventFocus*);
280 bool on_focus_out_event (GdkEventFocus*);
281 bool on_key_press_event (GdkEventKey*);
282 bool on_key_release_event (GdkEventKey*);
289 PlugUIBase* _pluginui;
290 PBD::ScopedConnection death_connection;
294 bool _keyboard_focused;
295 void keyboard_focused (bool yn);
297 void app_activated (bool);
298 void plugin_going_away ();
300 bool create_vst_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
301 bool create_audiounit_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
302 bool create_lv2_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
306 /* this function has to be in a .mm file */
307 extern PlugUIBase* create_au_gui (boost::shared_ptr<ARDOUR::PluginInsert>, Gtk::VBox**);
310 #endif /* __ardour_plugin_ui_h__ */