more changes to wscript files to catch up with waf 1.6 and fix OS X issues
[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
98         LED* solo_safe_led;
99         LED* solo_isolated_led;
100
101         Gtk::Label solo_button_label;
102         Gtk::Label mute_button_label;
103         Gtk::Label rec_enable_button_label;
104
105         void send_blink (bool);
106         sigc::connection send_blink_connection;
107
108         virtual std::string solo_button_name () const { return "SoloButton"; }
109         virtual std::string safe_solo_button_name () const { return "SafeSoloButton"; }
110
111         Gtk::Menu* mute_menu;
112         Gtk::Menu* solo_menu;
113         Gtk::Menu* sends_menu;
114
115         bool mute_press(GdkEventButton*);
116         bool mute_release(GdkEventButton*);
117         bool solo_press(GdkEventButton*);
118         bool solo_release(GdkEventButton*);
119         bool rec_enable_press(GdkEventButton*);
120         bool rec_enable_release(GdkEventButton*);
121         bool show_sends_press(GdkEventButton*);
122         bool show_sends_release(GdkEventButton*);
123
124         void step_gain_up ();
125         void step_gain_down ();
126         void page_gain_up ();
127         void page_gain_down ();
128
129         void build_sends_menu ();
130         void set_sends_gain_from_track ();
131         void set_sends_gain_to_zero ();
132         void set_sends_gain_to_unity ();
133         void create_sends (ARDOUR::Placement, bool);
134         void create_selected_sends (ARDOUR::Placement, bool);
135
136         void solo_changed(bool, void*);
137         void solo_changed_so_update_mute ();
138         void mute_changed(void*);
139         void listen_changed(void*);
140         virtual void processors_changed (ARDOUR::RouteProcessorChange) {}
141         void route_rec_enable_changed();
142         void session_rec_enable_changed();
143
144         void build_solo_menu ();
145
146         void solo_isolated_toggle (void*, Gtk::CheckMenuItem*);
147         void toggle_solo_isolated (Gtk::CheckMenuItem*);
148
149         bool solo_isolate_button_release (GdkEventButton*);
150         bool solo_safe_button_release (GdkEventButton*);
151
152         void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
153         void toggle_solo_safe (Gtk::CheckMenuItem*);
154
155         Gtk::CheckMenuItem* pre_fader_mute_check;
156         Gtk::CheckMenuItem* post_fader_mute_check;
157         Gtk::CheckMenuItem* listen_mute_check;
158         Gtk::CheckMenuItem* main_mute_check;
159         Gtk::CheckMenuItem* solo_safe_check;
160         Gtk::CheckMenuItem* solo_isolated_check;
161
162         void toggle_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
163         void muting_change ();
164         void build_mute_menu(void);
165         void init_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
166
167         int  set_color_from_route ();
168
169         void remove_this_route (bool apply_to_selection = false);
170         static gint idle_remove_this_route (RouteUI *);
171
172         void route_rename();
173
174         virtual void property_changed (const PBD::PropertyChange&);
175         void route_removed ();
176
177         virtual void route_active_changed () {}
178         void set_route_active (bool, bool);
179
180         Gtk::Menu* record_menu;
181         void build_record_menu ();
182
183         Gtk::CheckMenuItem *step_edit_item;
184         void toggle_step_edit ();
185         virtual void step_edit_changed (bool);
186
187         virtual void polarity_changed ();
188
189         Gtk::CheckMenuItem *denormal_menu_item;
190         void toggle_denormal_protection();
191         virtual void denormal_protection_changed ();
192
193         void disconnect_input ();
194         void disconnect_output ();
195
196         virtual void update_rec_display ();
197         void update_mute_display ();
198
199         void update_solo_display ();
200
201         virtual void map_frozen ();
202
203         void adjust_latency ();
204         void save_as_template ();
205         void open_remote_control_id_dialog ();
206
207         static int solo_visual_state (boost::shared_ptr<ARDOUR::Route>);
208         static int solo_visual_state_with_isolate (boost::shared_ptr<ARDOUR::Route>);
209         static int solo_isolate_visual_state (boost::shared_ptr<ARDOUR::Route>);
210         static int solo_safe_visual_state (boost::shared_ptr<ARDOUR::Route>);
211         static int mute_visual_state (ARDOUR::Session*, boost::shared_ptr<ARDOUR::Route>);
212
213    protected:
214         PBD::ScopedConnectionList route_connections;
215         bool self_destruct;
216
217         void init ();
218         void reset ();
219
220         void self_delete ();
221         virtual void start_step_editing () {}
222         virtual void stop_step_editing() {}
223
224         void set_invert_sensitive (bool);
225         bool verify_new_route_name (const std::string& name);
226
227         void route_gui_changed (std::string);
228         virtual void route_color_changed () {}
229
230   private:
231         void check_rec_enable_sensitivity ();
232         void parameter_changed (std::string const &);
233         void relabel_solo_button ();
234
235         std::string route_state_id () const;
236
237         struct SoloMuteRelease {
238             SoloMuteRelease (bool was_active)
239             : active (was_active)
240             , exclusive (false) {}
241
242             boost::shared_ptr<ARDOUR::RouteList> routes;
243             boost::shared_ptr<ARDOUR::RouteList> routes_on;
244             boost::shared_ptr<ARDOUR::RouteList> routes_off;
245             boost::shared_ptr<ARDOUR::Route> route;
246             bool active;
247             bool exclusive;
248         };
249
250         SoloMuteRelease* _solo_release;
251         SoloMuteRelease* _mute_release;
252
253         void setup_invert_buttons ();
254         void set_invert_button_state ();
255         void invert_toggled (uint32_t, BindableToggleButton *);
256         void invert_menu_toggled (uint32_t);
257         bool invert_press (GdkEventButton *);
258
259         int _i_am_the_modifier;
260         std::list<BindableToggleButton*> _invert_buttons;
261         Gtk::Menu* _invert_menu;
262
263         static uint32_t _max_invert_buttons;
264 };
265
266 #endif /* __ardour_route_ui__ */