Restore comments button, but optionally visible.
[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 sigc::signal<void,boost::shared_ptr<ARDOUR::Route> > SwitchIO;
120         static PBD::Signal1<void,MixerStrip*> CatchDeletion;
121
122         std::string state_id() const;
123
124         void parameter_changed (std::string);
125
126   protected:
127         friend class Mixer_UI;
128         void set_packed (bool yn);
129         bool packed () { return _packed; }
130
131         void set_selected(bool yn);
132         void set_stuff_from_route ();
133
134         bool on_leave_notify_event (GdkEventCrossing* ev);
135         bool on_enter_notify_event (GdkEventCrossing* ev);
136         bool on_key_press_event (GdkEventKey* ev);
137         bool on_key_release_event (GdkEventKey* ev);
138
139   private:
140         Mixer_UI& _mixer;
141
142         void init ();
143
144         bool  _embedded;
145         bool  _packed;
146         bool  _mixer_owned;
147         Width _width;
148         void*  _width_owner;
149
150         Gtk::Button         hide_button;
151         Gtk::Button         width_button;
152         Gtk::HBox           width_hide_box;
153         Gtk::VBox           whvbox;
154         Gtk::EventBox       top_event_box;
155         Gtk::EventBox*      spacer;
156
157         void hide_clicked();
158         void width_clicked ();
159
160         Gtk::Frame          global_frame;
161         Gtk::VBox           global_vpacker;
162
163         ProcessorBox processor_box;
164         GainMeter    gpm;
165         PannerUI     panners;
166
167         Gtk::Table button_table;
168         Gtk::Table rec_solo_table;
169         Gtk::Table top_button_table;
170         Gtk::Table middle_button_table;
171         Gtk::Table bottom_button_table;
172
173         Gtk::Button                  gain_unit_button;
174         Gtk::Label                   gain_unit_label;
175         Gtk::Button                  meter_point_button;
176         Gtk::Label                   meter_point_label;
177
178         void meter_changed ();
179
180         Gtk::Button diskstream_button;
181         Gtk::Label  diskstream_label;
182
183         Gtk::Button input_button;
184         Gtkmm2ext::StatefulToggleButton* midi_input_enable_button;
185         Gtk::HBox   input_button_box;
186         Gtk::Label  input_label;
187         Gtk::Button output_button;
188         Gtk::Label  output_label;
189
190         std::string longest_label;
191
192         void midi_input_status_changed ();
193         bool input_active_button_press (GdkEventButton*);
194         bool input_active_button_release (GdkEventButton*);
195
196         gint    mark_update_safe ();
197         guint32 mode_switch_in_progress;
198
199         Gtk::Button   name_button;
200
201         ArdourDialog*  comment_window;
202         Gtk::TextView* comment_area;
203         Gtk::Button   _comment_button;
204
205         void comment_editor_done_editing ();
206         void setup_comment_editor ();
207         void toggle_comment ();
208         void setup_comment_button ();
209
210         Gtk::Button   group_button;
211         Gtk::Label    group_label;
212         RouteGroupMenu *group_menu;
213
214         gint input_press (GdkEventButton *);
215         gint output_press (GdkEventButton *);
216
217         Gtk::Menu input_menu;
218         std::list<boost::shared_ptr<ARDOUR::Bundle> > input_menu_bundles;
219         void maybe_add_bundle_to_input_menu (boost::shared_ptr<ARDOUR::Bundle>, ARDOUR::BundleList const &);
220
221         Gtk::Menu output_menu;
222         std::list<boost::shared_ptr<ARDOUR::Bundle> > output_menu_bundles;
223         void maybe_add_bundle_to_output_menu (boost::shared_ptr<ARDOUR::Bundle>, ARDOUR::BundleList const &);
224
225         void bundle_input_toggled (boost::shared_ptr<ARDOUR::Bundle>);
226         void bundle_output_toggled (boost::shared_ptr<ARDOUR::Bundle>);
227
228         void edit_input_configuration ();
229         void edit_output_configuration ();
230
231         void diskstream_changed ();
232
233         Gtk::Menu *send_action_menu;
234         Gtk::MenuItem* rename_menu_item;
235         void build_send_action_menu ();
236
237         void new_send ();
238         void show_send_controls ();
239
240         PBD::ScopedConnection panstate_connection;
241         PBD::ScopedConnection panstyle_connection;
242         void connect_to_pan ();
243
244         void update_diskstream_display ();
245         void update_input_display ();
246         void update_output_display ();
247
248         void set_automated_controls_sensitivity (bool yn);
249
250         Gtk::Menu* route_ops_menu;
251         void build_route_ops_menu ();
252         gboolean name_button_button_press (GdkEventButton*);
253         void list_route_operations ();
254
255         gint comment_key_release_handler (GdkEventKey*);
256         void comment_changed (void *src);
257         void comment_edited ();
258         bool ignore_comment_edit;
259
260         bool select_route_group (GdkEventButton *);
261         void route_group_changed ();
262
263         IOSelectorWindow *input_selector;
264         IOSelectorWindow *output_selector;
265
266         Gtk::Style *passthru_style;
267
268         void route_color_changed ();
269         void show_passthru_color ();
270
271         void name_changed ();
272         void update_speed_display ();
273         void map_frozen ();
274         void hide_processor_editor (boost::weak_ptr<ARDOUR::Processor> processor);
275         void hide_redirect_editors ();
276
277         bool ignore_speed_adjustment;
278
279         void engine_running();
280         void engine_stopped();
281
282         void switch_io (boost::shared_ptr<ARDOUR::Route>);
283
284         void set_current_delivery (boost::shared_ptr<ARDOUR::Delivery>);
285         boost::shared_ptr<ARDOUR::Delivery> _current_delivery;
286
287         void drop_send ();
288         PBD::ScopedConnection send_gone_connection;
289
290         void reset_strip_style ();
291
292         static int scrollbar_height;
293
294         void update_io_button (boost::shared_ptr<ARDOUR::Route> route, Width width, bool input_button);
295         void port_connected_or_disconnected (boost::weak_ptr<ARDOUR::Port>, boost::weak_ptr<ARDOUR::Port>);
296
297         /** A VisibilityGroup to manage the visibility of some of our controls.
298          *  We fill it with the controls that are being managed, using the same names
299          *  as those used with _mixer_strip_visibility in RCOptionEditor.  Then
300          *  this VisibilityGroup is configured by changes to the RC variable
301          *  mixer-strip-visibility, which happen when the user makes changes in
302          *  the RC option editor.
303          */
304         VisibilityGroup _visibility;
305
306         PBD::ScopedConnection _config_connection;
307
308         static std::string meter_point_string (ARDOUR::MeterPoint);
309 };
310
311 #endif /* __ardour_mixer_strip__ */