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 "ardour_button.h"
53 #include "ardour_dropdown.h"
54 #include "ardour_spinner.h"
55 #include "ardour_window.h"
56 #include "automation_controller.h"
61 class WindowsVSTPlugin;
73 class HSliderController;
84 class PlugUIBase : public virtual sigc::trackable, public PBD::ScopedConnectionList
87 PlugUIBase (boost::shared_ptr<ARDOUR::PluginInsert>);
88 virtual ~PlugUIBase();
90 virtual gint get_preferred_height () = 0;
91 virtual gint get_preferred_width () = 0;
92 virtual bool resizable () { return true; }
93 virtual bool start_updating(GdkEventAny*) = 0;
94 virtual bool stop_updating(GdkEventAny*) = 0;
96 virtual void activate () {}
97 virtual void deactivate () {}
99 void update_preset_list ();
100 void update_preset ();
102 void latency_button_clicked ();
104 virtual bool on_window_show(const std::string& /*title*/) { return true; }
105 virtual void on_window_hide() {}
107 virtual void forward_key_event (GdkEventKey*) {}
108 virtual void grab_focus () {}
109 virtual bool non_gtk_gui() const { return false; }
111 sigc::signal<void,bool> KeyboardFocused;
114 boost::shared_ptr<ARDOUR::PluginInsert> insert;
115 boost::shared_ptr<ARDOUR::Plugin> plugin;
117 /* UI elements that can subclasses can add to their widgets */
119 /** a ComboBoxText which lists presets and manages their selection */
120 ArdourDropdown _preset_combo;
121 /** a label which has a * in if the current settings are different from the preset being shown */
122 Gtk::Label _preset_modified;
123 /** a button to add a preset */
124 ArdourButton add_button;
125 /** a button to save the current settings as a new user preset */
126 ArdourButton save_button;
127 /** a button to delete the current preset (if it is a user one) */
128 ArdourButton delete_button;
129 /** a button to delete the reset the plugin params */
130 ArdourButton reset_button;
131 /** a button to bypass the plugin */
132 ArdourButton bypass_button;
133 /** a button to acquire keyboard focus */
134 Gtk::EventBox focus_button;
135 /** an expander containing the plugin description */
136 Gtk::Expander description_expander;
137 /** an expander containing the plugin analysis graph */
138 Gtk::Expander plugin_analysis_expander;
139 /** a button which, when clicked, opens the latency GUI */
140 ArdourButton latency_button;
141 /** a button which sets all controls' automation setting to Manual */
142 ArdourButton automation_manual_all_button;
143 /** a button which sets all controls' automation setting to Play */
144 ArdourButton automation_play_all_button;
145 /** a button which sets all controls' automation setting to Write */
146 ArdourButton automation_write_all_button;
147 /** a button which sets all controls' automation setting to Touch */
148 ArdourButton automation_touch_all_button;
150 void set_latency_label ();
152 LatencyGUI* latency_gui;
153 ArdourWindow* latency_dialog;
157 Gtk::Image* focus_out_image;
158 Gtk::Image* focus_in_image;
161 virtual void preset_selected (ARDOUR::Plugin::PresetRecord preset);
162 void add_plugin_setting ();
163 void save_plugin_setting ();
164 void delete_plugin_setting ();
165 void reset_plugin_parameters ();
166 bool focus_toggled(GdkEventButton*);
167 bool bypass_button_release(GdkEventButton*);
168 void toggle_description ();
169 void toggle_plugin_analysis ();
170 void processor_active_changed (boost::weak_ptr<ARDOUR::Processor> p);
171 void plugin_going_away ();
172 void automation_state_changed ();
173 void preset_added_or_removed ();
174 void update_preset_modified ();
176 PBD::ScopedConnection death_connection;
177 PBD::ScopedConnection active_connection;
178 PBD::ScopedConnection preset_added_connection;
179 PBD::ScopedConnection preset_removed_connection;
180 PBD::ScopedConnectionList control_connections;
183 class GenericPluginUI : public PlugUIBase, public Gtk::VBox
186 GenericPluginUI (boost::shared_ptr<ARDOUR::PluginInsert> plug, bool scrollable=false);
189 gint get_preferred_height () { return prefheight; }
190 gint get_preferred_width () { return -1; }
192 bool start_updating(GdkEventAny*);
193 bool stop_updating(GdkEventAny*);
196 Gtk::VBox main_contents;
197 Gtk::HBox settings_box;
199 Gtk::Menu* automation_menu;
205 Gtkmm2ext::FastMeter *meter;
223 /* FIXME: Unify with AutomationController */
224 struct ControlUI : public Gtk::HBox {
226 const Evoral::Parameter parameter() const { return param; }
228 Evoral::Parameter param;
229 boost::shared_ptr<ARDOUR::AutomationControl> control;
233 boost::shared_ptr<ARDOUR::ScalePoints> scale_points;
234 boost::shared_ptr<AutomationController> controller;
236 ArdourButton automate_button;
238 Gtk::ComboBoxText* combo;
239 Gtkmm2ext::ClickBox* clickbox;
240 Gtk::FileChooserButton* file_button;
241 ArdourSpinner* spin_box;
249 Gtk::EventBox* display;
250 Gtk::Label* display_label;
254 MeterInfo* meterinfo;
256 ControlUI (const Evoral::Parameter& param);
260 Gtk::Table* knobtable;
264 std::vector<ControlUI*> input_controls;
265 std::vector<ControlUI*> input_controls_with_automation;
266 std::vector<ControlUI*> output_controls;
267 sigc::connection screen_update_connection;
268 void output_update();
271 void automatic_layout (const std::vector<ControlUI *>& control_uis);
272 void custom_layout (const std::vector<ControlUI *>& control_uis);
274 ControlUI* build_control_ui (const Evoral::Parameter& param,
275 const ARDOUR::ParameterDescriptor& desc,
276 boost::shared_ptr<ARDOUR::AutomationControl> mcontrol,
279 bool use_knob = false);
281 void ui_parameter_changed (ControlUI* cui);
282 void update_control_display (ControlUI* cui);
283 void control_combo_changed (ControlUI* cui);
285 void astate_clicked (ControlUI*);
286 void automation_state_changed (ControlUI*);
287 void set_automation_state (ARDOUR::AutoState state, ControlUI* cui);
288 void set_all_automation (ARDOUR::AutoState state);
291 void print_parameter (char *buf, uint32_t len, uint32_t param);
292 bool integer_printer (char* buf, Gtk::Adjustment &, ControlUI *);
293 bool midinote_printer(char* buf, Gtk::Adjustment &, ControlUI *);
295 void set_property (const ARDOUR::ParameterDescriptor& desc,
296 Gtk::FileChooserButton* widget);
297 void property_changed (uint32_t key, const ARDOUR::Variant& value);
299 typedef std::map<uint32_t, Gtk::FileChooserButton*> PropertyControls;
300 PropertyControls _property_controls;
303 class PluginUIWindow : public ArdourWindow
306 PluginUIWindow (boost::shared_ptr<ARDOUR::PluginInsert> insert,
307 bool scrollable=false,
311 PlugUIBase& pluginui() { return *_pluginui; }
313 void resize_preferred();
314 void set_parent (Gtk::Window*);
315 void set_title(const std::string& title);
318 bool on_key_press_event (GdkEventKey*);
319 bool on_key_release_event (GdkEventKey*);
325 PlugUIBase* _pluginui;
326 PBD::ScopedConnection death_connection;
330 bool _keyboard_focused;
331 #ifdef AUDIOUNIT_SUPPORT
332 int pre_deactivate_x;
333 int pre_deactivate_y;
336 void keyboard_focused (bool yn);
338 void app_activated (bool);
339 void plugin_going_away ();
341 bool create_windows_vst_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
342 bool create_lxvst_editor(boost::shared_ptr<ARDOUR::PluginInsert>);
343 bool create_audiounit_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
344 bool create_lv2_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
347 #ifdef AUDIOUNIT_SUPPORT
348 /* this function has to be in a .mm file */
349 extern PlugUIBase* create_au_gui (boost::shared_ptr<ARDOUR::PluginInsert>, Gtk::VBox**);
352 #endif /* __ardour_plugin_ui_h__ */