Give mixer strips panners and a mono button based on the type of its outputs, not...
[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         virtual void set_route (boost::shared_ptr<ARDOUR::Route>);
61         virtual void set_button_names () = 0;
62
63         bool is_track() const;
64         bool is_audio_track() const;
65         bool is_midi_track() const;
66         bool has_audio_outputs () const;
67
68         boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
69
70         boost::shared_ptr<ARDOUR::Track>      track() const;
71         boost::shared_ptr<ARDOUR::AudioTrack> audio_track() const;
72         boost::shared_ptr<ARDOUR::MidiTrack>  midi_track() const;
73
74         std::string name() const;
75
76         // protected: XXX sigh this should be here
77
78         boost::shared_ptr<ARDOUR::Route> _route;
79
80         void set_color (const Gdk::Color & c);
81         bool choose_color ();
82
83         bool ignore_toggle;
84         bool wait_for_release;
85         bool multiple_mute_change;
86         bool multiple_solo_change;
87
88         BindableToggleButton* invert_button;
89         BindableToggleButton* mute_button;
90         BindableToggleButton* solo_button;
91         BindableToggleButton* rec_enable_button; /* audio tracks */
92         BindableToggleButton* show_sends_button; /* busses */
93
94         LED* solo_safe_led;
95         LED* solo_isolated_led;
96
97         Gtk::Label solo_button_label;
98         Gtk::Label mute_button_label;
99         Gtk::Label invert_button_label;
100         Gtk::Label rec_enable_button_label;
101
102         void send_blink (bool);
103         sigc::connection send_blink_connection;
104
105         virtual std::string solo_button_name () const { return "SoloButton"; }
106         virtual std::string safe_solo_button_name () const { return "SafeSoloButton"; }
107
108         Gtk::Menu* mute_menu;
109         Gtk::Menu* solo_menu;
110         Gtk::Menu* sends_menu;
111
112         XMLNode *xml_node;
113         void ensure_xml_node ();
114
115         virtual XMLNode* get_automation_child_xml_node (Evoral::Parameter param);
116
117         void invert_toggled();
118         bool mute_press(GdkEventButton*);
119         bool mute_release(GdkEventButton*);
120         bool solo_press(GdkEventButton*);
121         bool solo_release(GdkEventButton*);
122         bool rec_enable_press(GdkEventButton*);
123         bool rec_enable_release(GdkEventButton*);
124         bool show_sends_press(GdkEventButton*);
125         bool show_sends_release(GdkEventButton*);
126
127         void step_gain_up ();
128         void step_gain_down ();
129         void page_gain_up ();
130         void page_gain_down ();
131
132         void build_sends_menu ();
133         void set_sends_gain_from_track ();
134         void set_sends_gain_to_zero ();
135         void set_sends_gain_to_unity ();
136         void create_sends (ARDOUR::Placement);
137         void create_selected_sends (ARDOUR::Placement);
138
139         void solo_changed(bool, void*);
140         void solo_changed_so_update_mute ();
141         void mute_changed(void*);
142         void listen_changed(void*);
143         virtual void processors_changed (ARDOUR::RouteProcessorChange) {}
144         void route_rec_enable_changed();
145         void session_rec_enable_changed();
146
147         void build_solo_menu ();
148
149         void solo_isolated_toggle (void*, Gtk::CheckMenuItem*);
150         void toggle_solo_isolated (Gtk::CheckMenuItem*);
151
152         bool solo_isolate_button_release (GdkEventButton*);
153         bool solo_safe_button_release (GdkEventButton*);
154
155         void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
156         void toggle_solo_safe (Gtk::CheckMenuItem*);
157
158         Gtk::CheckMenuItem* pre_fader_mute_check;
159         Gtk::CheckMenuItem* post_fader_mute_check;
160         Gtk::CheckMenuItem* listen_mute_check;
161         Gtk::CheckMenuItem* main_mute_check;
162         Gtk::CheckMenuItem* solo_safe_check;
163         Gtk::CheckMenuItem* solo_isolated_check;
164
165         void toggle_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
166         void muting_change ();
167         void build_mute_menu(void);
168         void init_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
169
170         int  set_color_from_route ();
171
172         void remove_this_route ();
173         static gint idle_remove_this_route (RouteUI *);
174
175         void route_rename();
176
177         virtual void property_changed (const PBD::PropertyChange&);
178         void route_removed ();
179
180         Gtk::CheckMenuItem *route_active_menu_item;
181         void toggle_route_active ();
182         virtual void route_active_changed ();
183
184         Gtk::Menu* record_menu;
185         void build_record_menu ();
186
187         Gtk::CheckMenuItem *step_edit_item;
188         void toggle_step_edit ();
189         virtual void step_edit_changed (bool);
190         
191         virtual void polarity_changed ();
192
193         Gtk::CheckMenuItem *denormal_menu_item;
194         void toggle_denormal_protection();
195         virtual void denormal_protection_changed ();
196
197         void disconnect_input ();
198         void disconnect_output ();
199
200         virtual void update_rec_display ();
201         void update_mute_display ();
202
203         void update_solo_display ();
204
205         virtual void map_frozen ();
206
207         void adjust_latency ();
208         void save_as_template ();
209         void open_remote_control_id_dialog ();
210
211         static int solo_visual_state (boost::shared_ptr<ARDOUR::Route>);
212         static int solo_visual_state_with_isolate (boost::shared_ptr<ARDOUR::Route>);
213         static int solo_isolate_visual_state (boost::shared_ptr<ARDOUR::Route>);
214         static int solo_safe_visual_state (boost::shared_ptr<ARDOUR::Route>);
215         static int mute_visual_state (ARDOUR::Session*, boost::shared_ptr<ARDOUR::Route>);
216
217    protected:
218         PBD::ScopedConnectionList route_connections;
219         bool self_destruct;
220
221         void init ();
222         void reset ();
223
224         void self_delete ();
225         virtual void start_step_editing () {}
226         virtual void stop_step_editing() {}
227
228   private:
229         void check_rec_enable_sensitivity ();
230         void parameter_changed (std::string const &);
231         void relabel_solo_button ();
232
233         struct SoloMuteRelease {
234             SoloMuteRelease (bool was_active) 
235             : active (was_active)
236             , exclusive (false) {}
237             
238             boost::shared_ptr<ARDOUR::RouteList> routes;
239             boost::shared_ptr<ARDOUR::RouteList> routes_on;
240             boost::shared_ptr<ARDOUR::RouteList> routes_off;
241             boost::shared_ptr<ARDOUR::Route> route;
242             bool active;
243             bool exclusive;
244         };
245
246         SoloMuteRelease* _solo_release;
247         SoloMuteRelease* _mute_release;
248
249 };
250
251 #endif /* __ardour_route_ui__ */