Separate Ardour UI widgets into dedicated library
[ardour.git] / gtk2_ardour / mixer_strip.h
1 /*
2     Copyright (C) 2000-2006 Paul Davis
3
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.
8
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.
13
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.
17 */
18
19 #ifndef __ardour_mixer_strip__
20 #define __ardour_mixer_strip__
21
22 #include <vector>
23
24 #include <cmath>
25
26 #include <gtkmm/eventbox.h>
27 #include <gtkmm/button.h>
28 #include <gtkmm/box.h>
29 #include <gtkmm/frame.h>
30 #include <gtkmm/button.h>
31 #include <gtkmm/label.h>
32 #include <gtkmm/togglebutton.h>
33 #include <gtkmm/menu.h>
34 #include <gtkmm/textview.h>
35 #include <gtkmm/adjustment.h>
36
37 #include "gtkmm2ext/auto_spin.h"
38 #include "gtkmm2ext/click_box.h"
39 #include "gtkmm2ext/bindable_button.h"
40 #include "gtkmm2ext/stateful_button.h"
41
42 #include "pbd/stateful.h"
43
44 #include "ardour/types.h"
45 #include "ardour/ardour.h"
46 #include "ardour/processor.h"
47
48 #include "pbd/fastlog.h"
49
50 #include "widgets/ardour_button.h"
51 #include "widgets/ardour_knob.h"
52
53 #include "axis_view.h"
54 #include "control_slave_ui.h"
55 #include "route_ui.h"
56 #include "gain_meter.h"
57 #include "panner_ui.h"
58 #include "enums.h"
59 #include "processor_box.h"
60 #include "visibility_group.h"
61
62 namespace ARDOUR {
63         class Route;
64         class Send;
65         class Processor;
66         class Session;
67         class PortInsert;
68         class Bundle;
69         class Plugin;
70 }
71 namespace Gtk {
72         class Window;
73         class Style;
74 }
75
76 class Mixer_UI;
77 class MotionController;
78 class RouteGroupMenu;
79 class ArdourWindow;
80
81 class MixerStrip : public AxisView, public RouteUI, public Gtk::EventBox
82 {
83 public:
84         MixerStrip (Mixer_UI&, ARDOUR::Session*, boost::shared_ptr<ARDOUR::Route>, bool in_mixer = true);
85         MixerStrip (Mixer_UI&, ARDOUR::Session*, bool in_mixer = true);
86         ~MixerStrip ();
87
88         std::string name()  const;
89         Gdk::Color color () const;
90         bool marked_for_display () const;
91         bool set_marked_for_display (bool);
92
93         boost::shared_ptr<ARDOUR::Stripable> stripable() const { return RouteUI::stripable(); }
94
95         void set_width_enum (Width, void* owner);
96         Width get_width_enum () const { return _width; }
97         void* width_owner () const { return _width_owner; }
98
99         GainMeter&      gain_meter()      { return gpm; }
100         PannerUI&       panner_ui()       { return panners; }
101         PluginSelector* plugin_selector();
102
103         void fast_update ();
104         void set_embedded (bool);
105
106         void set_route (boost::shared_ptr<ARDOUR::Route>);
107         void set_button_names ();
108         void show_send (boost::shared_ptr<ARDOUR::Send>);
109         void revert_to_default_display ();
110
111         /** @return the delivery that is being edited using our fader; it will be the
112          *  last send passed to ::show_send, or our route's main out delivery.
113          */
114         boost::shared_ptr<ARDOUR::Delivery> current_delivery () const {
115                 return _current_delivery;
116         }
117
118         bool mixer_owned () const {
119                 return _mixer_owned;
120         }
121
122         void hide_things ();
123
124         sigc::signal<void> WidthChanged;
125
126         /** The delivery that we are handling the level for with our fader has changed */
127         PBD::Signal1<void, boost::weak_ptr<ARDOUR::Delivery> > DeliveryChanged;
128
129         static PBD::Signal1<void,MixerStrip*> CatchDeletion;
130
131         std::string state_id() const;
132
133         void parameter_changed (std::string);
134         void route_active_changed ();
135
136         void copy_processors ();
137         void cut_processors ();
138         void paste_processors ();
139         void select_all_processors ();
140         void deselect_all_processors ();
141         bool delete_processors ();  //note: returns false if nothing was deleted
142         void toggle_processors ();
143         void ab_plugins ();
144
145         void set_selected (bool yn);
146
147         static MixerStrip* entered_mixer_strip() { return _entered_mixer_strip; }
148
149 protected:
150         friend class Mixer_UI;
151         void set_packed (bool yn);
152         bool packed () { return _packed; }
153
154         void set_stuff_from_route ();
155
156 private:
157         Mixer_UI& _mixer;
158
159         void init ();
160
161         bool  _embedded;
162         bool  _packed;
163         bool  _mixer_owned;
164         Width _width;
165         void*  _width_owner;
166
167         ArdourWidgets::ArdourButton hide_button;
168         ArdourWidgets::ArdourButton width_button;
169         ArdourWidgets::ArdourButton number_label;
170         Gtk::HBox                   width_hide_box;
171         Gtk::EventBox               spacer;
172
173         void hide_clicked();
174         bool width_button_pressed (GdkEventButton *);
175
176         Gtk::Frame          global_frame;
177         Gtk::VBox           global_vpacker;
178
179         ProcessorBox processor_box;
180         GainMeter    gpm;
181         PannerUI     panners;
182
183         Glib::RefPtr<Gtk::SizeGroup> button_size_group;
184
185         Gtk::Table rec_mon_table;
186         Gtk::Table solo_iso_table;
187         Gtk::Table mute_solo_table;
188         Gtk::Table bottom_button_table;
189
190         void vca_assign (boost::shared_ptr<ARDOUR::VCA>);
191         void vca_unassign (boost::shared_ptr<ARDOUR::VCA>);
192
193         void meter_changed ();
194         void monitor_changed ();
195
196         ArdourWidgets::ArdourButton input_button;
197         ArdourWidgets::ArdourButton output_button;
198
199         ArdourWidgets::ArdourButton* monitor_section_button;
200
201         void input_button_resized (Gtk::Allocation&);
202         void output_button_resized (Gtk::Allocation&);
203         void comment_button_resized (Gtk::Allocation&);
204
205         ArdourWidgets::ArdourButton* midi_input_enable_button;
206         Gtk::HBox input_button_box;
207
208         std::string longest_label;
209
210         void midi_input_status_changed ();
211         bool input_active_button_press (GdkEventButton*);
212         bool input_active_button_release (GdkEventButton*);
213
214         void help_count_plugins (boost::weak_ptr<ARDOUR::Processor>);
215         uint32_t _plugin_insert_cnt;
216
217         gint    mark_update_safe ();
218         guint32 mode_switch_in_progress;
219
220         ArdourWidgets::ArdourButton name_button;
221         ArdourWidgets::ArdourButton _comment_button;
222         ArdourWidgets::ArdourKnob   trim_control;
223
224         void setup_comment_button ();
225
226         ArdourWidgets::ArdourButton group_button;
227         RouteGroupMenu*             group_menu;
228
229         gint input_press (GdkEventButton *);
230         gint input_release (GdkEventButton *);
231
232         gint output_press (GdkEventButton *);
233         gint output_release (GdkEventButton *);
234
235         Gtk::Menu input_menu;
236         std::list<boost::shared_ptr<ARDOUR::Bundle> > input_menu_bundles;
237         void maybe_add_bundle_to_input_menu (boost::shared_ptr<ARDOUR::Bundle>, ARDOUR::BundleList const &);
238
239         Gtk::Menu output_menu;
240         std::list<boost::shared_ptr<ARDOUR::Bundle> > output_menu_bundles;
241         void maybe_add_bundle_to_output_menu (boost::shared_ptr<ARDOUR::Bundle>, ARDOUR::BundleList const &);
242
243         void bundle_input_chosen (boost::shared_ptr<ARDOUR::Bundle>);
244         void bundle_output_chosen (boost::shared_ptr<ARDOUR::Bundle>);
245
246         void diskstream_changed ();
247         void io_changed_proxy ();
248
249         Gtk::Menu *send_action_menu;
250         void build_send_action_menu ();
251
252         PBD::ScopedConnection panstate_connection;
253         PBD::ScopedConnection panstyle_connection;
254         void connect_to_pan ();
255         void update_panner_choices ();
256         void update_trim_control ();
257
258         void update_diskstream_display ();
259         void update_input_display ();
260         void update_output_display ();
261
262         void set_automated_controls_sensitivity (bool yn);
263
264         Gtk::Menu* route_ops_menu;
265         void build_route_ops_menu ();
266         gboolean name_button_button_press (GdkEventButton*);
267         gboolean number_button_button_press (GdkEventButton*);
268         void list_route_operations ();
269
270         bool select_route_group (GdkEventButton *);
271         void route_group_changed ();
272
273         Gtk::Style *passthru_style;
274
275         void route_color_changed ();
276         void show_passthru_color ();
277
278         void route_property_changed (const PBD::PropertyChange&);
279         void name_button_resized (Gtk::Allocation&);
280         void name_changed ();
281         void update_speed_display ();
282         void map_frozen ();
283         void hide_processor_editor (boost::weak_ptr<ARDOUR::Processor> processor);
284         void hide_redirect_editors ();
285
286         bool ignore_speed_adjustment;
287
288         static MixerStrip* _entered_mixer_strip;
289
290         void engine_running();
291         void engine_stopped();
292
293         virtual void bus_send_display_changed (boost::shared_ptr<ARDOUR::Route>);
294
295         void set_current_delivery (boost::shared_ptr<ARDOUR::Delivery>);
296
297         void drop_send ();
298         PBD::ScopedConnection send_gone_connection;
299
300         void reset_strip_style ();
301
302         void update_io_button (boost::shared_ptr<ARDOUR::Route> route, Width width, bool input_button);
303         void port_connected_or_disconnected (boost::weak_ptr<ARDOUR::Port>, boost::weak_ptr<ARDOUR::Port>);
304
305         bool mixer_strip_enter_event ( GdkEventCrossing * );
306         bool mixer_strip_leave_event ( GdkEventCrossing * );
307
308         /** A VisibilityGroup to manage the visibility of some of our controls.
309          *  We fill it with the controls that are being managed, using the same names
310          *  as those used with _mixer_strip_visibility in RCOptionEditor.  Then
311          *  this VisibilityGroup is configured by changes to the RC variable
312          *  mixer-element-visibility, which happen when the user makes changes in
313          *  the RC option editor.
314          */
315         VisibilityGroup _visibility;
316         boost::optional<bool> override_solo_visibility () const;
317
318         PBD::ScopedConnectionList _config_connection;
319
320         void add_input_port (ARDOUR::DataType);
321         void add_output_port (ARDOUR::DataType);
322
323         bool _suspend_menu_callbacks;
324         bool level_meter_button_press (GdkEventButton *);
325         void popup_level_meter_menu (GdkEventButton *);
326         void add_level_meter_item_point (Gtk::Menu_Helpers::MenuList &, Gtk::RadioMenuItem::Group &, std::string const &, ARDOUR::MeterPoint);
327         void add_level_meter_item_type (Gtk::Menu_Helpers::MenuList &, Gtk::RadioMenuItem::Group &, std::string const &, ARDOUR::MeterType);
328         void set_meter_point (ARDOUR::MeterPoint);
329         void set_meter_type (ARDOUR::MeterType);
330         PBD::ScopedConnection _level_meter_connection;
331
332         std::string meter_point_string (ARDOUR::MeterPoint);
333
334         void update_track_number_visibility ();
335
336         ControlSlaveUI control_slave_ui;
337 };
338
339 #endif /* __ardour_mixer_strip__ */