Add options to add ports to input/output menus on mixer strips.
[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 "route_ui.h"
51 #include "gain_meter.h"
52 #include "panner_ui.h"
53 #include "enums.h"
54 #include "processor_box.h"
55 #include "ardour_dialog.h"
56 #include "visibility_group.h"
57
58 namespace ARDOUR {
59         class Route;
60         class Send;
61         class Processor;
62         class Session;
63         class PortInsert;
64         class Bundle;
65         class Plugin;
66 }
67 namespace Gtk {
68         class Window;
69         class Style;
70 }
71
72 class Mixer_UI;
73 class IOSelectorWindow;
74 class MotionController;
75 class RouteGroupMenu;
76
77 class MixerStrip : public RouteUI, public Gtk::EventBox
78 {
79   public:
80         MixerStrip (Mixer_UI&, ARDOUR::Session*, boost::shared_ptr<ARDOUR::Route>, bool in_mixer = true);
81         MixerStrip (Mixer_UI&, ARDOUR::Session*, bool in_mixer = true);
82         ~MixerStrip ();
83
84         void set_width_enum (Width, void* owner);
85         Width get_width_enum () const { return _width; }
86         void* width_owner () const { return _width_owner; }
87
88         GainMeter&      gain_meter()      { return gpm; }
89         PannerUI&       panner_ui()       { return panners; }
90         PluginSelector* plugin_selector();
91
92         void fast_update ();
93         void set_embedded (bool);
94
95         ARDOUR::RouteGroup* route_group() const;
96         void set_route (boost::shared_ptr<ARDOUR::Route>);
97         void set_button_names ();
98         void show_send (boost::shared_ptr<ARDOUR::Send>);
99         void revert_to_default_display ();
100
101         /** @return the delivery that is being edited using our fader; it will be the
102          *  last send passed to ::show_send, or our route's main out delivery.
103          */
104         boost::shared_ptr<ARDOUR::Delivery> current_delivery () const {
105                 return _current_delivery;
106         }
107
108         bool mixer_owned () const {
109                 return _mixer_owned;
110         }
111
112         void hide_things ();
113
114         sigc::signal<void> WidthChanged;
115
116         /** The delivery that we are handling the level for with our fader has changed */
117         PBD::Signal1<void, boost::weak_ptr<ARDOUR::Delivery> > DeliveryChanged;
118
119         static PBD::Signal1<void,MixerStrip*> CatchDeletion;
120
121         std::string state_id() const;
122
123         void parameter_changed (std::string);
124
125   protected:
126         friend class Mixer_UI;
127         void set_packed (bool yn);
128         bool packed () { return _packed; }
129
130         void set_selected(bool yn);
131         void set_stuff_from_route ();
132
133         bool on_leave_notify_event (GdkEventCrossing* ev);
134         bool on_enter_notify_event (GdkEventCrossing* ev);
135         bool on_key_press_event (GdkEventKey* ev);
136         bool on_key_release_event (GdkEventKey* ev);
137
138   private:
139         Mixer_UI& _mixer;
140
141         void init ();
142
143         bool  _embedded;
144         bool  _packed;
145         bool  _mixer_owned;
146         Width _width;
147         void*  _width_owner;
148
149         Gtk::Button         hide_button;
150         Gtk::Button         width_button;
151         Gtk::HBox           width_hide_box;
152         Gtk::VBox           whvbox;
153         Gtk::EventBox       top_event_box;
154         Gtk::EventBox*      spacer;
155
156         void hide_clicked();
157         void width_clicked ();
158
159         Gtk::Frame          global_frame;
160         Gtk::VBox           global_vpacker;
161
162         ProcessorBox processor_box;
163         GainMeter    gpm;
164         PannerUI     panners;
165
166         Gtk::Table button_table;
167         Gtk::Table rec_solo_table;
168         Gtk::Table top_button_table;
169         Gtk::Table middle_button_table;
170         Gtk::Table bottom_button_table;
171
172         Gtk::Button                  gain_unit_button;
173         Gtk::Label                   gain_unit_label;
174         Gtk::Button                  meter_point_button;
175         Gtk::Label                   meter_point_label;
176
177         void meter_changed ();
178
179         Gtk::Button diskstream_button;
180         Gtk::Label  diskstream_label;
181
182         Gtk::Button input_button;
183         Gtkmm2ext::StatefulToggleButton* midi_input_enable_button;
184         Gtk::HBox   input_button_box;
185         Gtk::Label  input_label;
186         Gtk::Button output_button;
187         Gtk::Label  output_label;
188
189         std::string longest_label;
190
191         void midi_input_status_changed ();
192         bool input_active_button_press (GdkEventButton*);
193         bool input_active_button_release (GdkEventButton*);
194
195         gint    mark_update_safe ();
196         guint32 mode_switch_in_progress;
197
198         Gtk::Button   name_button;
199
200         ArdourDialog*  comment_window;
201         Gtk::TextView* comment_area;
202         Gtk::Button   _comment_button;
203
204         void comment_editor_done_editing ();
205         void setup_comment_editor ();
206         void toggle_comment ();
207         void setup_comment_button ();
208
209         Gtk::Button   group_button;
210         Gtk::Label    group_label;
211         RouteGroupMenu *group_menu;
212
213         gint input_press (GdkEventButton *);
214         gint output_press (GdkEventButton *);
215
216         Gtk::Menu input_menu;
217         std::list<boost::shared_ptr<ARDOUR::Bundle> > input_menu_bundles;
218         void maybe_add_bundle_to_input_menu (boost::shared_ptr<ARDOUR::Bundle>, ARDOUR::BundleList const &);
219
220         Gtk::Menu output_menu;
221         std::list<boost::shared_ptr<ARDOUR::Bundle> > output_menu_bundles;
222         void maybe_add_bundle_to_output_menu (boost::shared_ptr<ARDOUR::Bundle>, ARDOUR::BundleList const &);
223
224         void bundle_input_toggled (boost::shared_ptr<ARDOUR::Bundle>);
225         void bundle_output_toggled (boost::shared_ptr<ARDOUR::Bundle>);
226
227         void edit_input_configuration ();
228         void edit_output_configuration ();
229
230         void diskstream_changed ();
231
232         Gtk::Menu *send_action_menu;
233         Gtk::MenuItem* rename_menu_item;
234         void build_send_action_menu ();
235
236         void new_send ();
237         void show_send_controls ();
238
239         PBD::ScopedConnection panstate_connection;
240         PBD::ScopedConnection panstyle_connection;
241         void connect_to_pan ();
242
243         void update_diskstream_display ();
244         void update_input_display ();
245         void update_output_display ();
246
247         void set_automated_controls_sensitivity (bool yn);
248
249         Gtk::Menu* route_ops_menu;
250         void build_route_ops_menu ();
251         gboolean name_button_button_press (GdkEventButton*);
252         void list_route_operations ();
253
254         gint comment_key_release_handler (GdkEventKey*);
255         void comment_changed (void *src);
256         void comment_edited ();
257         bool ignore_comment_edit;
258
259         bool select_route_group (GdkEventButton *);
260         void route_group_changed ();
261
262         IOSelectorWindow *input_selector;
263         IOSelectorWindow *output_selector;
264
265         Gtk::Style *passthru_style;
266
267         void route_color_changed ();
268         void show_passthru_color ();
269
270         void name_changed ();
271         void update_speed_display ();
272         void map_frozen ();
273         void hide_processor_editor (boost::weak_ptr<ARDOUR::Processor> processor);
274         void hide_redirect_editors ();
275
276         bool ignore_speed_adjustment;
277
278         void engine_running();
279         void engine_stopped();
280
281         virtual void bus_send_display_changed (boost::shared_ptr<ARDOUR::Route>);
282
283         void set_current_delivery (boost::shared_ptr<ARDOUR::Delivery>);
284         boost::shared_ptr<ARDOUR::Delivery> _current_delivery;
285
286         void drop_send ();
287         PBD::ScopedConnection send_gone_connection;
288
289         void reset_strip_style ();
290
291         static int scrollbar_height;
292
293         void update_io_button (boost::shared_ptr<ARDOUR::Route> route, Width width, bool input_button);
294         void port_connected_or_disconnected (boost::weak_ptr<ARDOUR::Port>, boost::weak_ptr<ARDOUR::Port>);
295
296         /** A VisibilityGroup to manage the visibility of some of our controls.
297          *  We fill it with the controls that are being managed, using the same names
298          *  as those used with _mixer_strip_visibility in RCOptionEditor.  Then
299          *  this VisibilityGroup is configured by changes to the RC variable
300          *  mixer-strip-visibility, which happen when the user makes changes in
301          *  the RC option editor.
302          */
303         VisibilityGroup _visibility;
304         boost::optional<bool> override_solo_visibility () const;
305
306         PBD::ScopedConnection _config_connection;
307
308         void add_input_port (ARDOUR::DataType);
309         void add_output_port (ARDOUR::DataType);
310
311         static std::string meter_point_string (ARDOUR::MeterPoint);
312 };
313
314 #endif /* __ardour_mixer_strip__ */