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/adjustment.h>
34 #include <gtkmm/box.h>
35 #include <gtkmm/button.h>
36 #include <gtkmm/eventbox.h>
37 #include <gtkmm/expander.h>
38 #include <gtkmm/filechooserbutton.h>
39 #include <gtkmm/image.h>
40 #include <gtkmm/label.h>
41 #include <gtkmm/menu.h>
42 #include <gtkmm/scrolledwindow.h>
43 #include <gtkmm/socket.h>
44 #include <gtkmm/table.h>
45 #include <gtkmm/togglebutton.h>
46 #include <gtkmm/viewport.h>
48 #include "ardour/types.h"
49 #include "ardour/plugin.h"
50 #include "ardour/variant.h"
52 #include "widgets/ardour_button.h"
53 #include "widgets/ardour_dropdown.h"
54 #include "widgets/ardour_spinner.h"
56 #include "ardour_window.h"
57 #include "automation_controller.h"
58 #include "gtk_pianokeyboard.h"
63 class WindowsVSTPlugin;
74 namespace ArdourWidgets {
83 class PlugUIBase : public virtual sigc::trackable, public PBD::ScopedConnectionList
86 PlugUIBase (boost::shared_ptr<ARDOUR::PluginInsert>);
87 virtual ~PlugUIBase();
89 virtual gint get_preferred_height () = 0;
90 virtual gint get_preferred_width () = 0;
91 virtual bool resizable () { return true; }
92 virtual bool start_updating(GdkEventAny*) = 0;
93 virtual bool stop_updating(GdkEventAny*) = 0;
95 virtual void activate () {}
96 virtual void deactivate () {}
98 void update_preset_list ();
99 void update_preset ();
101 void latency_button_clicked ();
103 virtual bool on_window_show(const std::string& /*title*/) { return true; }
104 virtual void on_window_hide() {}
106 virtual void forward_key_event (GdkEventKey*) {}
107 virtual void grab_focus () {}
108 virtual bool non_gtk_gui() const { return false; }
110 sigc::signal<void,bool> KeyboardFocused;
113 boost::shared_ptr<ARDOUR::PluginInsert> insert;
114 boost::shared_ptr<ARDOUR::Plugin> plugin;
116 /* UI elements that can subclasses can add to their widgets */
118 /** a ComboBoxText which lists presets and manages their selection */
119 ArdourWidgets::ArdourDropdown _preset_combo;
120 /** a label which has a * in if the current settings are different from the preset being shown */
121 Gtk::Label _preset_modified;
122 /** a button to add a preset */
123 ArdourWidgets::ArdourButton add_button;
124 /** a button to save the current settings as a new user preset */
125 ArdourWidgets::ArdourButton save_button;
126 /** a button to delete the current preset (if it is a user one) */
127 ArdourWidgets::ArdourButton delete_button;
128 /** a button to delete the reset the plugin params */
129 ArdourWidgets::ArdourButton reset_button;
130 /** a button to bypass the plugin */
131 ArdourWidgets::ArdourButton bypass_button;
132 /** and self-explaining button :) */
133 ArdourWidgets::ArdourButton pin_management_button;
134 /** a button to acquire keyboard focus */
135 Gtk::EventBox focus_button;
136 /** an expander containing the plugin description */
137 Gtk::Expander description_expander;
138 /** an expander containing the plugin analysis graph */
139 Gtk::Expander plugin_analysis_expander;
140 /** an expander containing the plugin cpu profile */
141 Gtk::Expander cpuload_expander;
142 /** a button which, when clicked, opens the latency GUI */
143 ArdourWidgets::ArdourButton latency_button;
144 /** a button which sets all controls' automation setting to Manual */
145 ArdourWidgets::ArdourButton automation_manual_all_button;
146 /** a button which sets all controls' automation setting to Play */
147 ArdourWidgets::ArdourButton automation_play_all_button;
148 /** a button which sets all controls' automation setting to Write */
149 ArdourWidgets::ArdourButton automation_write_all_button;
150 /** a button which sets all controls' automation setting to Touch */
151 ArdourWidgets::ArdourButton automation_touch_all_button;
152 /** a button which sets all controls' automation setting to Latch */
153 ArdourWidgets::ArdourButton automation_latch_all_button;
155 Gtk::Label cpuload_label;
157 void set_latency_label ();
158 void update_cpu_label ();
159 sigc::connection update_cpu_label_connection;
161 LatencyGUI* latency_gui;
162 ArdourWindow* latency_dialog;
166 Gtk::Image* focus_out_image;
167 Gtk::Image* focus_in_image;
170 virtual void preset_selected (ARDOUR::Plugin::PresetRecord preset);
171 void add_plugin_setting ();
172 void save_plugin_setting ();
173 void delete_plugin_setting ();
174 void reset_plugin_parameters ();
176 bool focus_toggled(GdkEventButton*);
177 bool bypass_button_release(GdkEventButton*);
178 void toggle_description ();
179 void toggle_plugin_analysis ();
180 void toggle_cpuload_display ();
181 void processor_active_changed (boost::weak_ptr<ARDOUR::Processor> p);
182 void plugin_going_away ();
183 void automation_state_changed ();
184 void preset_added_or_removed ();
185 void update_preset_modified ();
187 PBD::ScopedConnection death_connection;
188 PBD::ScopedConnection active_connection;
189 PBD::ScopedConnection preset_added_connection;
190 PBD::ScopedConnection preset_removed_connection;
191 PBD::ScopedConnectionList control_connections;
194 class GenericPluginUI : public PlugUIBase, public Gtk::VBox
197 GenericPluginUI (boost::shared_ptr<ARDOUR::PluginInsert> plug, bool scrollable=false);
200 gint get_preferred_height () { return prefheight; }
201 gint get_preferred_width () { return -1; }
203 bool start_updating(GdkEventAny*);
204 bool stop_updating(GdkEventAny*);
207 Gtk::VBox main_contents;
208 Gtk::HBox settings_box;
210 Gtk::Menu* automation_menu;
216 ArdourWidgets::FastMeter* meter;
225 /* FIXME: Unify with AutomationController */
226 struct ControlUI : public Gtk::HBox {
228 const Evoral::Parameter parameter() const { return param; }
230 Evoral::Parameter param;
231 boost::shared_ptr<ARDOUR::AutomationControl> control;
235 boost::shared_ptr<ARDOUR::ScalePoints> scale_points;
236 boost::shared_ptr<AutomationController> controller;
238 ArdourWidgets::ArdourButton automate_button;
240 ArdourWidgets::ArdourDropdown* combo;
241 Gtk::FileChooserButton* file_button;
242 ArdourWidgets::ArdourSpinner* spin_box;
251 Gtk::EventBox* display;
252 Gtk::Label* display_label;
256 MeterInfo* meterinfo;
258 ControlUI (const Evoral::Parameter& param);
262 Gtk::Table* knobtable;
265 bool short_autostate; // modify with set_short_autostate below
268 void set_short_autostate(ControlUI* cui, bool value);
270 std::vector<ControlUI*> input_controls; // workaround for preset load
271 std::vector<ControlUI*> input_controls_with_automation;
272 std::vector<ControlUI*> output_controls;
274 sigc::connection screen_update_connection;
276 void output_update();
279 void automatic_layout (const std::vector<ControlUI *>& control_uis);
280 void custom_layout (const std::vector<ControlUI *>& control_uis);
282 ControlUI* build_control_ui (const Evoral::Parameter& param,
283 const ARDOUR::ParameterDescriptor& desc,
284 boost::shared_ptr<ARDOUR::AutomationControl> mcontrol,
287 bool use_knob = false);
289 void ui_parameter_changed (ControlUI* cui);
290 void update_control_display (ControlUI* cui);
291 void update_input_displays (); // workaround for preset load
292 void control_combo_changed (ControlUI* cui, float value);
294 bool astate_button_event (GdkEventButton* ev, ControlUI*);
295 void automation_state_changed (ControlUI*);
296 void set_automation_state (ARDOUR::AutoState state, ControlUI* cui);
297 void set_all_automation (ARDOUR::AutoState state);
299 void knob_size_request(Gtk::Requisition* req, ControlUI* cui);
302 void print_parameter (char *buf, uint32_t len, uint32_t param);
303 bool integer_printer (char* buf, Gtk::Adjustment &, ControlUI *);
304 bool midinote_printer(char* buf, Gtk::Adjustment &, ControlUI *);
306 typedef std::map<uint32_t, Gtk::FileChooserButton*> FilePathControls;
307 FilePathControls _filepath_controls;
308 void set_path_property (const ARDOUR::ParameterDescriptor& desc,
309 Gtk::FileChooserButton* widget);
310 void path_property_changed (uint32_t key, const ARDOUR::Variant& value);
312 void scroller_size_request (Gtk::Requisition*);
313 Gtk::ScrolledWindow scroller;
315 Gtk::Expander _plugin_pianokeyboard_expander;
316 PianoKeyboard* _piano;
317 Gtk::Widget* _pianomm;
319 Gtk::SpinButton _piano_velocity;
320 Gtk::SpinButton _piano_channel;
322 static void _note_on_event_handler (GtkWidget*, int, gpointer);
323 static void _note_off_event_handler (GtkWidget*, int, gpointer);
324 void note_on_event_handler (int);
325 void note_off_event_handler (int);
327 void toggle_pianokeyboard ();
328 void build_midi_table ();
329 void midi_refill_patches ();
330 void midi_bank_patch_change (uint8_t chn);
331 void midi_bank_patch_select (uint8_t chn, uint32_t bankpgm);
332 std::vector<ArdourWidgets::ArdourDropdown*> midi_pgmsel;
333 PBD::ScopedConnectionList midi_connections;
334 std::map<uint32_t, std::string> pgm_names;
337 class PluginUIWindow : public ArdourWindow
340 PluginUIWindow (boost::shared_ptr<ARDOUR::PluginInsert> insert,
341 bool scrollable=false,
345 PlugUIBase& pluginui() { return *_pluginui; }
347 void resize_preferred();
348 void set_parent (Gtk::Window*);
349 void set_title(const std::string& title);
352 bool on_key_press_event (GdkEventKey*);
353 bool on_key_release_event (GdkEventKey*);
359 PlugUIBase* _pluginui;
360 PBD::ScopedConnection death_connection;
364 bool _keyboard_focused;
365 #ifdef AUDIOUNIT_SUPPORT
366 int pre_deactivate_x;
367 int pre_deactivate_y;
370 void keyboard_focused (bool yn);
372 void app_activated (bool);
373 void plugin_going_away ();
375 bool create_windows_vst_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
376 bool create_lxvst_editor(boost::shared_ptr<ARDOUR::PluginInsert>);
377 bool create_mac_vst_editor(boost::shared_ptr<ARDOUR::PluginInsert>);
378 bool create_audiounit_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
379 bool create_lv2_editor (boost::shared_ptr<ARDOUR::PluginInsert>);
382 #ifdef MACVST_SUPPORT
383 /* this function has to be in a .mm file
384 * because MacVSTPluginUI has Cocoa members
386 extern VSTPluginUI* create_mac_vst_gui (boost::shared_ptr<ARDOUR::PluginInsert>);
389 #ifdef AUDIOUNIT_SUPPORT
390 /* this function has to be in a .mm file */
391 extern PlugUIBase* create_au_gui (boost::shared_ptr<ARDOUR::PluginInsert>, Gtk::VBox**);
394 #endif /* __ardour_plugin_ui_h__ */