start of tracking monitor state correctly
[ardour.git] / gtk2_ardour / route_ui.h
1 /*
2     Copyright (C) 2002 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
20 #ifndef __ardour_route_ui__
21 #define __ardour_route_ui__
22
23 #include <list>
24
25 #include "pbd/xml++.h"
26 #include "pbd/signals.h"
27
28 #include "ardour/ardour.h"
29 #include "ardour/mute_master.h"
30 #include "ardour/session_event.h"
31 #include "ardour/session.h"
32 #include "ardour/route.h"
33 #include "ardour/route_group.h"
34 #include "ardour/track.h"
35
36 #include "axis_view.h"
37
38 namespace ARDOUR {
39         class AudioTrack;
40         class MidiTrack;
41 }
42
43 namespace Gtk {
44         class Menu;
45         class CheckMenuItem;
46         class Widget;
47 }
48
49 class BindableToggleButton;
50 class LED;
51
52 class RouteUI : public virtual AxisView
53 {
54   public:
55         RouteUI(ARDOUR::Session*);
56         RouteUI(boost::shared_ptr<ARDOUR::Route>, ARDOUR::Session*);
57
58         virtual ~RouteUI();
59
60         Gdk::Color color () const;
61
62         virtual void set_route (boost::shared_ptr<ARDOUR::Route>);
63         virtual void set_button_names () = 0;
64
65         bool is_track() const;
66         bool is_audio_track() const;
67         bool is_midi_track() const;
68         bool has_audio_outputs () const;
69
70         boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
71
72         boost::shared_ptr<ARDOUR::Track>      track() const;
73         boost::shared_ptr<ARDOUR::AudioTrack> audio_track() const;
74         boost::shared_ptr<ARDOUR::MidiTrack>  midi_track() const;
75
76         std::string name() const;
77
78         // protected: XXX sigh this should be here
79
80         boost::shared_ptr<ARDOUR::Route> _route;
81
82         void request_redraw ();
83
84         virtual void set_color (const Gdk::Color & c);
85         void choose_color ();
86
87         bool ignore_toggle;
88         bool wait_for_release;
89         bool multiple_mute_change;
90         bool multiple_solo_change;
91
92         Gtk::HBox _invert_button_box;
93         BindableToggleButton* mute_button;
94         BindableToggleButton* solo_button;
95         BindableToggleButton* rec_enable_button; /* audio tracks */
96         BindableToggleButton* show_sends_button; /* busses */
97         BindableToggleButton* monitor_input_button;
98         BindableToggleButton* monitor_disk_button;
99
100         LED* solo_safe_led;
101         LED* solo_isolated_led;
102
103         Gtk::Label solo_button_label;
104         Gtk::Label mute_button_label;
105         Gtk::Label rec_enable_button_label;
106         Gtk::Label monitor_input_button_label;
107         Gtk::Label monitor_disk_button_label;
108
109         void send_blink (bool);
110         sigc::connection send_blink_connection;
111
112         virtual std::string solo_button_name () const { return "SoloButton"; }
113         virtual std::string safe_solo_button_name () const { return "SafeSoloButton"; }
114
115         Gtk::Menu* mute_menu;
116         Gtk::Menu* solo_menu;
117         Gtk::Menu* sends_menu;
118
119         bool mute_press(GdkEventButton*);
120         bool mute_release(GdkEventButton*);
121         bool solo_press(GdkEventButton*);
122         bool solo_release(GdkEventButton*);
123         bool rec_enable_press(GdkEventButton*);
124         bool rec_enable_release(GdkEventButton*);
125         bool show_sends_press(GdkEventButton*);
126         bool show_sends_release(GdkEventButton*);
127
128         bool monitor_release(GdkEventButton*, ARDOUR::MonitorChoice);
129         bool monitor_input_press(GdkEventButton*);
130         bool monitor_input_release(GdkEventButton*);
131         bool monitor_disk_press(GdkEventButton*);
132         bool monitor_disk_release(GdkEventButton*);
133         void monitoring_changed ();
134         void update_monitoring_display ();
135
136         void step_gain_up ();
137         void step_gain_down ();
138         void page_gain_up ();
139         void page_gain_down ();
140
141         void build_sends_menu ();
142         void set_sends_gain_from_track ();
143         void set_sends_gain_to_zero ();
144         void set_sends_gain_to_unity ();
145         void create_sends (ARDOUR::Placement, bool);
146         void create_selected_sends (ARDOUR::Placement, bool);
147
148         void solo_changed(bool, void*);
149         void solo_changed_so_update_mute ();
150         void mute_changed(void*);
151         void listen_changed(void*);
152         virtual void processors_changed (ARDOUR::RouteProcessorChange) {}
153         void route_rec_enable_changed();
154         void session_rec_enable_changed();
155
156         void build_solo_menu ();
157
158         void solo_isolated_toggle (void*, Gtk::CheckMenuItem*);
159         void toggle_solo_isolated (Gtk::CheckMenuItem*);
160
161         bool solo_isolate_button_release (GdkEventButton*);
162         bool solo_safe_button_release (GdkEventButton*);
163
164         void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
165         void toggle_solo_safe (Gtk::CheckMenuItem*);
166
167         Gtk::CheckMenuItem* pre_fader_mute_check;
168         Gtk::CheckMenuItem* post_fader_mute_check;
169         Gtk::CheckMenuItem* listen_mute_check;
170         Gtk::CheckMenuItem* main_mute_check;
171         Gtk::CheckMenuItem* solo_safe_check;
172         Gtk::CheckMenuItem* solo_isolated_check;
173
174         void toggle_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
175         void muting_change ();
176         void build_mute_menu(void);
177         void init_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
178
179         int  set_color_from_route ();
180
181         void remove_this_route (bool apply_to_selection = false);
182         static gint idle_remove_this_route (RouteUI *);
183
184         void route_rename();
185
186         virtual void property_changed (const PBD::PropertyChange&);
187         void route_removed ();
188
189         virtual void route_active_changed () {}
190         void set_route_active (bool, bool);
191
192         Gtk::Menu* record_menu;
193         void build_record_menu ();
194
195         Gtk::CheckMenuItem *step_edit_item;
196         void toggle_step_edit ();
197         virtual void step_edit_changed (bool);
198
199         virtual void polarity_changed ();
200
201         Gtk::CheckMenuItem *denormal_menu_item;
202         void toggle_denormal_protection();
203         virtual void denormal_protection_changed ();
204
205         void disconnect_input ();
206         void disconnect_output ();
207
208         virtual void update_rec_display ();
209         void update_mute_display ();
210
211         void update_solo_display ();
212
213         virtual void map_frozen ();
214
215         void adjust_latency ();
216         void save_as_template ();
217         void open_remote_control_id_dialog ();
218
219         static int solo_visual_state (boost::shared_ptr<ARDOUR::Route>);
220         static int solo_visual_state_with_isolate (boost::shared_ptr<ARDOUR::Route>);
221         static int solo_isolate_visual_state (boost::shared_ptr<ARDOUR::Route>);
222         static int solo_safe_visual_state (boost::shared_ptr<ARDOUR::Route>);
223         static int mute_visual_state (ARDOUR::Session*, boost::shared_ptr<ARDOUR::Route>);
224
225    protected:
226         PBD::ScopedConnectionList route_connections;
227         bool self_destruct;
228
229         void init ();
230         void reset ();
231
232         void self_delete ();
233         virtual void start_step_editing () {}
234         virtual void stop_step_editing() {}
235
236         void set_invert_sensitive (bool);
237         bool verify_new_route_name (const std::string& name);
238
239         void route_gui_changed (std::string);
240         virtual void route_color_changed () {}
241
242   private:
243         void check_rec_enable_sensitivity ();
244         void parameter_changed (std::string const &);
245         void relabel_solo_button ();
246
247         std::string route_state_id () const;
248
249         struct SoloMuteRelease {
250             SoloMuteRelease (bool was_active)
251             : active (was_active)
252             , exclusive (false) {}
253
254             boost::shared_ptr<ARDOUR::RouteList> routes;
255             boost::shared_ptr<ARDOUR::RouteList> routes_on;
256             boost::shared_ptr<ARDOUR::RouteList> routes_off;
257             boost::shared_ptr<ARDOUR::Route> route;
258             bool active;
259             bool exclusive;
260         };
261
262         SoloMuteRelease* _solo_release;
263         SoloMuteRelease* _mute_release;
264
265         void setup_invert_buttons ();
266         void set_invert_button_state ();
267         void invert_toggled (uint32_t, BindableToggleButton *);
268         void invert_menu_toggled (uint32_t);
269         bool invert_press (GdkEventButton *);
270
271         int _i_am_the_modifier;
272         std::list<BindableToggleButton*> _invert_buttons;
273         Gtk::Menu* _invert_menu;
274
275         static uint32_t _max_invert_buttons;
276 };
277
278 #endif /* __ardour_route_ui__ */