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"
49 #include "ardour/plugin.h"
50 #include "ardour/variant.h"
52 #include "automation_controller.h"
53 #include "ardour_button.h"
54 #include "ardour_window.h"
59 class WindowsVSTPlugin;
71 class HSliderController;
82 class PlugUIBase : public virtual sigc::trackable, public PBD::ScopedConnectionList
85 PlugUIBase (boost::shared_ptr<ARDOUR::PluginInsert>);
86 virtual ~PlugUIBase();
88 virtual gint get_preferred_height () = 0;
89 virtual gint get_preferred_width () = 0;
90 virtual bool resizable () { return true; }
91 virtual bool start_updating(GdkEventAny*) = 0;
92 virtual bool stop_updating(GdkEventAny*) = 0;
94 virtual void activate () {}
95 virtual void deactivate () {}
97 void update_preset_list ();
98 void update_preset ();
100 void latency_button_clicked ();
102 virtual bool on_window_show(const std::string& /*title*/) { return true; }
103 virtual void on_window_hide() {}
105 virtual void forward_key_event (GdkEventKey*) {}
106 virtual bool non_gtk_gui() const { return false; }
108 sigc::signal<void,bool> KeyboardFocused;
111 boost::shared_ptr<ARDOUR::PluginInsert> insert;
112 boost::shared_ptr<ARDOUR::Plugin> plugin;
114 /* UI elements that can subclasses can add to their widgets */
116 /** a ComboBoxText which lists presets and manages their selection */
117 Gtk::ComboBoxText _preset_combo;
118 /** a label which has a * in if the current settings are different from the preset being shown */
119 Gtk::Label _preset_modified;
120 /** a button to add a preset */
121 Gtk::Button add_button;
122 /** a button to save the current settings as a new user preset */
123 Gtk::Button save_button;
124 /** a button to delete the current preset (if it is a user one) */
125 Gtk::Button delete_button;
126 /** a button to bypass the plugin */
127 ArdourButton bypass_button;
128 /** a button to acquire keyboard focus */
129 Gtk::EventBox focus_button;
130 /** an expander containing the plugin description */
131 Gtk::Expander description_expander;
132 /** an expander containing the plugin analysis graph */
133 Gtk::Expander plugin_analysis_expander;
134 /** a label indicating the plugin latency */
135 Gtk::Label latency_label;
136 /** a button which, when clicked, opens the latency GUI */
137 Gtk::Button latency_button;
139 void set_latency_label ();
141 LatencyGUI* latency_gui;
142 ArdourWindow* latency_dialog;
145 Gtk::Requisition pre_eq_size;
147 Gtk::Image* focus_out_image;
148 Gtk::Image* focus_in_image;
151 virtual void preset_selected ();
152 void add_plugin_setting ();
153 void save_plugin_setting ();
154 void delete_plugin_setting ();
155 bool focus_toggled(GdkEventButton*);
156 bool bypass_button_release(GdkEventButton*);
157 void toggle_description ();
158 void toggle_plugin_analysis ();
159 void processor_active_changed (boost::weak_ptr<ARDOUR::Processor> p);
160 void plugin_going_away ();
161 virtual void parameter_changed (uint32_t, float);
162 void preset_added_or_removed ();
163 void update_preset_modified ();
165 PBD::ScopedConnection death_connection;
166 PBD::ScopedConnection active_connection;
167 PBD::ScopedConnection preset_added_connection;
168 PBD::ScopedConnection preset_removed_connection;
169 PBD::ScopedConnectionList control_connections;
172 class GenericPluginUI : public PlugUIBase, public Gtk::VBox
175 GenericPluginUI (boost::shared_ptr<ARDOUR::PluginInsert> plug, bool scrollable=false);
178 gint get_preferred_height () { return prefheight; }
179 gint get_preferred_width () { return -1; }
181 bool start_updating(GdkEventAny*);
182 bool stop_updating(GdkEventAny*);
185 Gtk::VBox main_contents;
187 Gtk::HBox settings_box;
190 Gtk::Table button_table;
191 Gtk::Table output_table;
193 Gtk::ScrolledWindow scroller;
194 Gtk::Adjustment hAdjustment;
195 Gtk::Adjustment vAdjustment;
196 Gtk::Viewport scroller_view;
197 Gtk::Menu* automation_menu;
203 Gtkmm2ext::FastMeter *meter;
221 static const int32_t initial_button_rows = 12;
222 static const int32_t initial_button_cols = 1;
223 static const int32_t initial_output_rows = 1;
224 static const int32_t initial_output_cols = 4;
226 /* FIXME: Unify with AutomationController */
227 struct ControlUI : public Gtk::HBox {
229 const Evoral::Parameter parameter() const { return param; }
231 Evoral::Parameter param;
232 boost::shared_ptr<ARDOUR::AutomationControl> control;
236 Gtk::ComboBoxText* combo;
237 boost::shared_ptr<ARDOUR::ScalePoints> scale_points;
238 Gtk::ToggleButton* button;
239 boost::shared_ptr<AutomationController> controller;
240 Gtkmm2ext::ClickBox* clickbox;
244 Gtk::Button automate_button;
245 Gtk::FileChooserButton* file_button;
249 Gtk::EventBox* display;
250 Gtk::Label* display_label;
254 MeterInfo* meterinfo;
256 ControlUI (const Evoral::Parameter& param);
260 std::vector<ControlUI*> input_controls;
261 std::vector<ControlUI*> output_controls;
262 sigc::connection screen_update_connection;
263 void output_update();
266 ControlUI* build_control_ui (const Evoral::Parameter& param,
267 const ARDOUR::ParameterDescriptor& desc,
268 boost::shared_ptr<ARDOUR::AutomationControl> mcontrol,
272 void ui_parameter_changed (ControlUI* cui);
273 void toggle_parameter_changed (ControlUI* cui);
274 void update_control_display (ControlUI* cui);
275 void control_port_toggled (ControlUI* cui);
276 void control_combo_changed (ControlUI* cui);
278 void astate_clicked (ControlUI*);
279 void automation_state_changed (ControlUI*);
280 void set_automation_state (ARDOUR::AutoState state, ControlUI* cui);
281 void start_touch (ControlUI*);
282 void stop_touch (ControlUI*);
285 void print_parameter (char *buf, uint32_t len, uint32_t param);
286 bool integer_printer (char* buf, Gtk::Adjustment &, ControlUI *);
287 bool midinote_printer(char* buf, Gtk::Adjustment &, ControlUI *);
289 void set_property (const ARDOUR::ParameterDescriptor& desc,
290 Gtk::FileChooserButton* widget);
291 void property_changed (uint32_t key, const ARDOUR::Variant& value);
293 typedef std::map<uint32_t, Gtk::FileChooserButton*> PropertyControls;
294 PropertyControls _property_controls;
297 class PluginUIWindow : public ArdourWindow
300 PluginUIWindow (boost::shared_ptr<ARDOUR::PluginInsert> insert,
301 bool scrollable=false,
305 PlugUIBase& pluginui() { return *_pluginui; }
307 void resize_preferred();
308 void set_parent (Gtk::Window*);
309 void set_title(const std::string& title);
312 bool on_key_press_event (GdkEventKey*);
313 bool on_key_release_event (GdkEventKey*);
319 PlugUIBase* _pluginui;
320 PBD::ScopedConnection death_connection;
324 bool _keyboard_focused;
325 #ifdef AUDIOUNIT_SUPPORT
326 int pre_deactivate_x;
327 int pre_deactivate_y;
330 void keyboard_focused (bool yn);
332 void app_activated (bool);
333 void plugin_going_away ();
335 bool create_windows_vst_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
336 bool create_lxvst_editor(boost::shared_ptr<ARDOUR::PluginInsert>);
337 bool create_audiounit_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
338 bool create_lv2_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
341 #ifdef AUDIOUNIT_SUPPORT
342 /* this function has to be in a .mm file */
343 extern PlugUIBase* create_au_gui (boost::shared_ptr<ARDOUR::PluginInsert>, Gtk::VBox**);
346 #endif /* __ardour_plugin_ui_h__ */