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