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__
27 #include <sigc++/signal.h>
29 #include <gtkmm/button.h>
30 #include <gtkmm/box.h>
31 #include <gtkmm/table.h>
32 #include <gtkmm/eventbox.h>
33 #include <gtkmm/viewport.h>
34 #include <gtkmm/scrolledwindow.h>
35 #include <gtkmm/label.h>
36 #include <gtkmm/menu.h>
37 #include <gtkmm/image.h>
38 #include <gtkmm/adjustment.h>
39 #include <gtkmm/togglebutton.h>
40 #include <gtkmm/socket.h>
41 #include <gtkmm/combobox.h>
42 #include <gtkmm/liststore.h>
43 #include <gtkmm/comboboxtext.h>
44 #include <gtkmm/socket.h>
46 #include <ardour_dialog.h>
47 #include <ardour/types.h>
62 class HSliderController
;
69 class PlugUIBase
: public virtual sigc::trackable
72 PlugUIBase (boost::shared_ptr
<ARDOUR::PluginInsert
>);
73 virtual ~PlugUIBase();
75 virtual gint
get_preferred_height () = 0;
76 virtual gint
get_preferred_width () = 0;
77 virtual bool start_updating(GdkEventAny
*) = 0;
78 virtual bool stop_updating(GdkEventAny
*) = 0;
80 virtual void activate () {}
81 virtual void deactivate () {}
83 virtual void update_presets ();
85 virtual bool on_window_show(const Glib::ustring
& title
) { return true; }
86 virtual void on_window_hide() {}
89 boost::shared_ptr
<ARDOUR::PluginInsert
> insert
;
90 boost::shared_ptr
<ARDOUR::Plugin
> plugin
;
91 Gtk::ComboBoxText preset_combo
;
92 Gtk::Button save_button
;
93 Gtk::ToggleButton bypass_button
;
94 Gtk::EventBox focus_button
;
96 Gtk::Image
* focus_out_image
;
97 Gtk::Image
* focus_in_image
;
100 void setting_selected();
101 void save_plugin_setting (void);
102 bool focus_toggled(GdkEventButton
*);
103 void bypass_toggled();
104 void redirect_active_changed (ARDOUR::Redirect
* r
, void* src
);
106 void plugin_going_away ();
109 class GenericPluginUI
: public PlugUIBase
, public Gtk::VBox
112 GenericPluginUI (boost::shared_ptr
<ARDOUR::PluginInsert
> plug
, bool scrollable
=false);
115 gint
get_preferred_height () { return prefheight
; }
116 gint
get_preferred_width () { return -1; }
118 bool start_updating(GdkEventAny
*);
119 bool stop_updating(GdkEventAny
*);
122 Gtk::HBox settings_box
;
125 Gtk::Table button_table
;
126 Gtk::Table output_table
;
128 Gtk::ScrolledWindow scroller
;
129 Gtk::Adjustment hAdjustment
;
130 Gtk::Adjustment vAdjustment
;
131 Gtk::Viewport scroller_view
;
132 Gtk::Menu
* automation_menu
;
138 Gtkmm2ext::FastMeter
*meter
;
156 static const int32_t initial_button_rows
= 12;
157 static const int32_t initial_button_cols
= 1;
158 static const int32_t initial_output_rows
= 1;
159 static const int32_t initial_output_cols
= 4;
161 struct ControlUI
: public Gtk::HBox
{
167 Gtk::Adjustment
* adjustment
;
168 Gtk::ComboBoxText
* combo
;
169 std::map
<string
, float>* combo_map
;
170 Gtk::ToggleButton
* button
;
171 Gtkmm2ext::BarController
* control
;
172 Gtkmm2ext::ClickBox
* clickbox
;
177 Gtk::Button automate_button
;
181 Gtk::EventBox
*display
;
182 Gtk::Label
* display_label
;
186 MeterInfo
* meterinfo
;
192 std::vector
<ControlUI
*> output_controls
;
193 sigc::connection screen_update_connection
;
194 void output_update();
197 ControlUI
* build_control_ui (guint32 port_index
, PBD::Controllable
*);
198 std::vector
<string
> setup_scale_values(guint32 port_index
, ControlUI
* cui
);
199 void control_adjustment_changed (ControlUI
* cui
);
200 void parameter_changed (uint32_t, float, ControlUI
* cui
);
201 void toggle_parameter_changed (uint32_t, float, ControlUI
* cui
);
202 void update_control_display (ControlUI
* cui
);
203 void control_port_toggled (ControlUI
* cui
);
204 void control_combo_changed (ControlUI
* cui
);
206 void astate_clicked (ControlUI
*, uint32_t parameter
);
207 void automation_state_changed (ControlUI
*);
208 void set_automation_state (ARDOUR::AutoState state
, ControlUI
* cui
);
209 void start_touch (ControlUI
*);
210 void stop_touch (ControlUI
*);
212 void print_parameter (char *buf
, uint32_t len
, uint32_t param
);
215 class PluginUIWindow
: public Gtk::Window
218 PluginUIWindow (Gtk::Window
*, boost::shared_ptr
<ARDOUR::PluginInsert
> insert
, bool scrollable
=false);
221 PlugUIBase
& pluginui() { return *_pluginui
; }
223 void resize_preferred();
224 void set_parent (Gtk::Window
*);
226 bool on_enter_notify_event (GdkEventCrossing
*);
227 bool on_leave_notify_event (GdkEventCrossing
*);
228 bool on_focus_in_event (GdkEventFocus
*);
229 bool on_focus_out_event (GdkEventFocus
*);
230 bool on_key_press_event (GdkEventKey
*);
231 bool on_key_release_event (GdkEventKey
*);
236 void set_title(const Glib::ustring
& title
);
239 Glib::ustring _title
;
240 PlugUIBase
* _pluginui
;
241 sigc::connection death_connection
;
247 void app_activated (bool);
248 void plugin_going_away ();
250 bool create_vst_editor (boost::shared_ptr
<ARDOUR::PluginInsert
>);
251 bool create_audiounit_editor (boost::shared_ptr
<ARDOUR::PluginInsert
>);
252 bool create_lv2_editor (boost::shared_ptr
<ARDOUR::PluginInsert
>);
256 class VSTPluginUI
: public PlugUIBase
, public Gtk::VBox
259 VSTPluginUI (boost::shared_ptr
<ARDOUR::PluginInsert
>, boost::shared_ptr
<ARDOUR::VSTPlugin
>);
262 gint
get_preferred_height ();
263 gint
get_preferred_width ();
264 bool start_updating(GdkEventAny
*) {return false;}
265 bool stop_updating(GdkEventAny
*) {return false;}
267 int package (Gtk::Window
&);
270 boost::shared_ptr
<ARDOUR::VSTPlugin
> vst
;
272 Gtk::HBox preset_box
;
275 bool configure_handler (GdkEventConfigure
*, Gtk::Socket
*);
276 void save_plugin_setting ();
278 struct PresetModelColumns
: public Gtk::TreeModel::ColumnRecord
{
279 PresetModelColumns() {
283 Gtk::TreeModelColumn
<Glib::ustring
> name
;
284 Gtk::TreeModelColumn
<int> number
;
287 PresetModelColumns preset_columns
;
288 Glib::RefPtr
<Gtk::ListStore
> preset_model
;
289 Gtk::ComboBox vst_preset_combo
;
291 void create_preset_store ();
292 void preset_chosen ();
294 #endif // VST_SUPPORT
296 #ifdef HAVE_AUDIOUNITS
297 /* this function has to be in a .mm file */
298 extern PlugUIBase
* create_au_gui (boost::shared_ptr
<ARDOUR::PluginInsert
>, Gtk::VBox
**);
301 #endif /* __ardour_plugin_ui_h__ */