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