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