7164d15e632ed22175acf74bc1892524aab5e6ec
[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         /* used for screenshots */
118         void hide_master_spacer (bool);
119
120         void hide_things ();
121
122         sigc::signal<void> WidthChanged;
123
124         /** The delivery that we are handling the level for with our fader has changed */
125         PBD::Signal1<void, boost::weak_ptr<ARDOUR::Delivery> > DeliveryChanged;
126
127         static PBD::Signal1<void,MixerStrip*> CatchDeletion;
128
129         std::string state_id() const;
130
131         void parameter_changed (std::string);
132         void route_active_changed ();
133
134         void copy_processors ();
135         void cut_processors ();
136         void paste_processors ();
137         void select_all_processors ();
138         void deselect_all_processors ();
139         bool delete_processors ();  //note: returns false if nothing was deleted
140         void toggle_processors ();
141         void ab_plugins ();
142
143         void set_selected (bool yn);
144
145         static MixerStrip* entered_mixer_strip() { return _entered_mixer_strip; }
146
147 protected:
148         friend class Mixer_UI;
149         void set_packed (bool yn);
150         bool packed () { return _packed; }
151
152         void set_stuff_from_route ();
153
154 private:
155         Mixer_UI& _mixer;
156
157         void init ();
158
159         bool  _embedded;
160         bool  _packed;
161         bool  _mixer_owned;
162         Width _width;
163         void*  _width_owner;
164
165         ArdourWidgets::ArdourButton hide_button;
166         ArdourWidgets::ArdourButton width_button;
167         ArdourWidgets::ArdourButton number_label;
168         Gtk::HBox                   width_hide_box;
169         Gtk::EventBox               spacer;
170
171         void hide_clicked();
172         bool width_button_pressed (GdkEventButton *);
173
174         Gtk::Frame          global_frame;
175         Gtk::VBox           global_vpacker;
176
177         ProcessorBox processor_box;
178         GainMeter    gpm;
179         PannerUI     panners;
180
181         Glib::RefPtr<Gtk::SizeGroup> button_size_group;
182
183         Gtk::Table rec_mon_table;
184         Gtk::Table solo_iso_table;
185         Gtk::Table mute_solo_table;
186         Gtk::Table bottom_button_table;
187
188         void vca_assign (boost::shared_ptr<ARDOUR::VCA>);
189         void vca_unassign (boost::shared_ptr<ARDOUR::VCA>);
190
191         void meter_changed ();
192         void monitor_changed ();
193         void monitor_section_added_or_removed ();
194
195         ArdourWidgets::ArdourButton input_button;
196         ArdourWidgets::ArdourButton output_button;
197
198         ArdourWidgets::ArdourButton* monitor_section_button;
199
200         void input_button_resized (Gtk::Allocation&);
201         void output_button_resized (Gtk::Allocation&);
202         void comment_button_resized (Gtk::Allocation&);
203
204         ArdourWidgets::ArdourButton* midi_input_enable_button;
205         Gtk::HBox input_button_box;
206
207         std::string longest_label;
208
209         void midi_input_status_changed ();
210         bool input_active_button_press (GdkEventButton*);
211         bool input_active_button_release (GdkEventButton*);
212
213         void help_count_plugins (boost::weak_ptr<ARDOUR::Processor>);
214         uint32_t _plugin_insert_cnt;
215
216         gint    mark_update_safe ();
217         guint32 mode_switch_in_progress;
218
219         ArdourWidgets::ArdourButton name_button;
220         ArdourWidgets::ArdourButton _comment_button;
221         ArdourWidgets::ArdourKnob   trim_control;
222
223         void trim_start_touch ();
224         void trim_end_touch ();
225
226         void setup_comment_button ();
227
228         ArdourWidgets::ArdourButton group_button;
229         RouteGroupMenu*             group_menu;
230
231         gint input_press (GdkEventButton *);
232         gint input_release (GdkEventButton *);
233
234         gint output_press (GdkEventButton *);
235         gint output_release (GdkEventButton *);
236
237         Gtk::Menu input_menu;
238         std::list<boost::shared_ptr<ARDOUR::Bundle> > input_menu_bundles;
239         void maybe_add_bundle_to_input_menu (boost::shared_ptr<ARDOUR::Bundle>, ARDOUR::BundleList const &);
240
241         Gtk::Menu output_menu;
242         std::list<boost::shared_ptr<ARDOUR::Bundle> > output_menu_bundles;
243         void maybe_add_bundle_to_output_menu (boost::shared_ptr<ARDOUR::Bundle>, ARDOUR::BundleList const &,
244                                               ARDOUR::DataType type = ARDOUR::DataType::NIL);
245
246         void bundle_input_chosen (boost::shared_ptr<ARDOUR::Bundle>);
247         void bundle_output_chosen (boost::shared_ptr<ARDOUR::Bundle>);
248
249         void diskstream_changed ();
250         void io_changed_proxy ();
251
252         Gtk::Menu *send_action_menu;
253         void build_send_action_menu ();
254
255         PBD::ScopedConnection panstate_connection;
256         PBD::ScopedConnection panstyle_connection;
257         void connect_to_pan ();
258         void update_panner_choices ();
259         void update_trim_control ();
260
261         void update_diskstream_display ();
262         void update_input_display ();
263         void update_output_display ();
264
265         void set_automated_controls_sensitivity (bool yn);
266
267         Gtk::Menu* route_ops_menu;
268         void build_route_ops_menu ();
269         gboolean name_button_button_press (GdkEventButton*);
270         gboolean number_button_button_press (GdkEventButton*);
271         void list_route_operations ();
272
273         bool select_route_group (GdkEventButton *);
274         void route_group_changed ();
275
276         Gtk::Style *passthru_style;
277
278         void route_color_changed ();
279         void show_passthru_color ();
280
281         void route_property_changed (const PBD::PropertyChange&);
282         void name_button_resized (Gtk::Allocation&);
283         void name_changed ();
284         void update_speed_display ();
285         void map_frozen ();
286         void hide_processor_editor (boost::weak_ptr<ARDOUR::Processor> processor);
287         void hide_redirect_editors ();
288
289         bool ignore_speed_adjustment;
290
291         static MixerStrip* _entered_mixer_strip;
292
293         void engine_running();
294         void engine_stopped();
295
296         virtual void bus_send_display_changed (boost::shared_ptr<ARDOUR::Route>);
297
298         void set_current_delivery (boost::shared_ptr<ARDOUR::Delivery>);
299
300         void drop_send ();
301         PBD::ScopedConnection send_gone_connection;
302
303         void reset_strip_style ();
304
305         ARDOUR::DataType guess_main_type(bool for_input, bool favor_connected = true) const;
306
307         void update_io_button (bool input_button);
308         void port_connected_or_disconnected (boost::weak_ptr<ARDOUR::Port>, boost::weak_ptr<ARDOUR::Port>);
309
310         bool mixer_strip_enter_event ( GdkEventCrossing * );
311         bool mixer_strip_leave_event ( GdkEventCrossing * );
312
313         /** A VisibilityGroup to manage the visibility of some of our controls.
314          *  We fill it with the controls that are being managed, using the same names
315          *  as those used with _mixer_strip_visibility in RCOptionEditor.  Then
316          *  this VisibilityGroup is configured by changes to the RC variable
317          *  mixer-element-visibility, which happen when the user makes changes in
318          *  the RC option editor.
319          */
320         VisibilityGroup _visibility;
321         boost::optional<bool> override_solo_visibility () const;
322
323         PBD::ScopedConnectionList _config_connection;
324
325         void add_input_port (ARDOUR::DataType);
326         void add_output_port (ARDOUR::DataType);
327
328         bool _suspend_menu_callbacks;
329         bool level_meter_button_press (GdkEventButton *);
330         void popup_level_meter_menu (GdkEventButton *);
331         void add_level_meter_item_point (Gtk::Menu_Helpers::MenuList &, Gtk::RadioMenuItem::Group &, std::string const &, ARDOUR::MeterPoint);
332         void add_level_meter_item_type (Gtk::Menu_Helpers::MenuList &, Gtk::RadioMenuItem::Group &, std::string const &, ARDOUR::MeterType);
333         void set_meter_point (ARDOUR::MeterPoint);
334         void set_meter_type (ARDOUR::MeterType);
335         PBD::ScopedConnection _level_meter_connection;
336
337         std::string meter_point_string (ARDOUR::MeterPoint);
338
339         void update_track_number_visibility ();
340
341         ControlSlaveUI control_slave_ui;
342 };
343
344 #endif /* __ardour_mixer_strip__ */