fix up colons in track names before they are used for JACK port names; catch most...
[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 request_redraw ();
81
82         virtual void set_color (const Gdk::Color & c);
83         void choose_color ();
84
85         bool ignore_toggle;
86         bool wait_for_release;
87         bool multiple_mute_change;
88         bool multiple_solo_change;
89
90         Gtk::HBox _invert_button_box;
91         BindableToggleButton* mute_button;
92         BindableToggleButton* solo_button;
93         BindableToggleButton* rec_enable_button; /* audio tracks */
94         BindableToggleButton* show_sends_button; /* busses */
95
96         LED* solo_safe_led;
97         LED* solo_isolated_led;
98
99         Gtk::Label solo_button_label;
100         Gtk::Label mute_button_label;
101         Gtk::Label rec_enable_button_label;
102
103         void send_blink (bool);
104         sigc::connection send_blink_connection;
105
106         virtual std::string solo_button_name () const { return "SoloButton"; }
107         virtual std::string safe_solo_button_name () const { return "SafeSoloButton"; }
108
109         Gtk::Menu* mute_menu;
110         Gtk::Menu* solo_menu;
111         Gtk::Menu* sends_menu;
112
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, bool);
132         void create_selected_sends (ARDOUR::Placement, bool);
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         bool solo_isolate_button_release (GdkEventButton*);
148         bool solo_safe_button_release (GdkEventButton*);
149
150         void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
151         void toggle_solo_safe (Gtk::CheckMenuItem*);
152
153         Gtk::CheckMenuItem* pre_fader_mute_check;
154         Gtk::CheckMenuItem* post_fader_mute_check;
155         Gtk::CheckMenuItem* listen_mute_check;
156         Gtk::CheckMenuItem* main_mute_check;
157         Gtk::CheckMenuItem* solo_safe_check;
158         Gtk::CheckMenuItem* solo_isolated_check;
159
160         void toggle_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
161         void muting_change ();
162         void build_mute_menu(void);
163         void init_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
164
165         int  set_color_from_route ();
166
167         void remove_this_route (bool apply_to_selection = false);
168         static gint idle_remove_this_route (RouteUI *);
169
170         void route_rename();
171
172         virtual void property_changed (const PBD::PropertyChange&);
173         void route_removed ();
174
175         virtual void route_active_changed () {}
176         void set_route_active (bool, bool);
177
178         Gtk::Menu* record_menu;
179         void build_record_menu ();
180
181         Gtk::CheckMenuItem *step_edit_item;
182         void toggle_step_edit ();
183         virtual void step_edit_changed (bool);
184
185         virtual void polarity_changed ();
186
187         Gtk::CheckMenuItem *denormal_menu_item;
188         void toggle_denormal_protection();
189         virtual void denormal_protection_changed ();
190
191         void disconnect_input ();
192         void disconnect_output ();
193
194         virtual void update_rec_display ();
195         void update_mute_display ();
196
197         void update_solo_display ();
198
199         virtual void map_frozen ();
200
201         void adjust_latency ();
202         void save_as_template ();
203         void open_remote_control_id_dialog ();
204
205         static int solo_visual_state (boost::shared_ptr<ARDOUR::Route>);
206         static int solo_visual_state_with_isolate (boost::shared_ptr<ARDOUR::Route>);
207         static int solo_isolate_visual_state (boost::shared_ptr<ARDOUR::Route>);
208         static int solo_safe_visual_state (boost::shared_ptr<ARDOUR::Route>);
209         static int mute_visual_state (ARDOUR::Session*, boost::shared_ptr<ARDOUR::Route>);
210
211    protected:
212         PBD::ScopedConnectionList route_connections;
213         bool self_destruct;
214
215         void init ();
216         void reset ();
217
218         void self_delete ();
219         virtual void start_step_editing () {}
220         virtual void stop_step_editing() {}
221
222         void set_invert_sensitive (bool);
223         bool verify_new_route_name (const std::string& name);
224
225   private:
226         void check_rec_enable_sensitivity ();
227         void parameter_changed (std::string const &);
228         void relabel_solo_button ();
229
230         struct SoloMuteRelease {
231             SoloMuteRelease (bool was_active)
232             : active (was_active)
233             , exclusive (false) {}
234
235             boost::shared_ptr<ARDOUR::RouteList> routes;
236             boost::shared_ptr<ARDOUR::RouteList> routes_on;
237             boost::shared_ptr<ARDOUR::RouteList> routes_off;
238             boost::shared_ptr<ARDOUR::Route> route;
239             bool active;
240             bool exclusive;
241         };
242
243         SoloMuteRelease* _solo_release;
244         SoloMuteRelease* _mute_release;
245
246         void setup_invert_buttons ();
247         void set_invert_button_state ();
248         void invert_toggled (uint32_t, BindableToggleButton *);
249         void invert_menu_toggled (uint32_t);
250         bool invert_press (GdkEventButton *);
251
252         int _i_am_the_modifier;
253         std::list<BindableToggleButton*> _invert_buttons;
254         Gtk::Menu* _invert_menu;
255
256         static uint32_t _max_invert_buttons;
257 };
258
259 #endif /* __ardour_route_ui__ */