major design changes: use glib event loop for MIDI thread/UI; rework design of BaseUI...
[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 "ardour/ardour.h"
27 #include "ardour/mute_master.h"
28 #include "ardour/session_event.h"
29 #include "ardour/session.h"
30 #include "ardour/route.h"
31 #include "ardour/route_group.h"
32 #include "ardour/track.h"
33
34 #include "axis_view.h"
35
36 namespace ARDOUR {
37         class AudioTrack;
38         class MidiTrack;
39 }
40
41 namespace Gtk {
42         class Menu;
43         class CheckMenuItem;
44         class Widget;
45 }
46
47 class BindableToggleButton;
48
49 class RouteUI : public virtual AxisView
50 {
51   public:
52         RouteUI(ARDOUR::Session&);
53         RouteUI(boost::shared_ptr<ARDOUR::Route>, ARDOUR::Session&);
54
55         virtual ~RouteUI();
56
57         virtual void set_route (boost::shared_ptr<ARDOUR::Route>);
58         virtual void set_button_names () = 0;
59
60         bool is_track() const;
61         bool is_audio_track() const;
62         bool is_midi_track() const;
63
64         boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
65
66         boost::shared_ptr<ARDOUR::Track>      track() const;
67         boost::shared_ptr<ARDOUR::AudioTrack> audio_track() const;
68         boost::shared_ptr<ARDOUR::MidiTrack>  midi_track() const;
69
70         boost::shared_ptr<ARDOUR::Diskstream> get_diskstream() 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* mute_button;
87         BindableToggleButton* solo_button;
88         BindableToggleButton* rec_enable_button; /* audio tracks */
89         BindableToggleButton* show_sends_button; /* busses */
90
91         Gtk::Label solo_button_label;
92         Gtk::Label mute_button_label;
93         Gtk::Label rec_enable_button_label;
94
95         void send_blink (bool);
96         sigc::connection send_blink_connection;
97
98         virtual std::string solo_button_name () const { return "SoloButton"; }
99         virtual std::string safe_solo_button_name () const { return "SafeSoloButton"; }
100
101         Gtk::Menu* mute_menu;
102         Gtk::Menu* solo_menu;
103         Gtk::Menu* sends_menu;
104
105
106         XMLNode *xml_node;
107         void ensure_xml_node ();
108
109         virtual XMLNode* get_automation_child_xml_node (Evoral::Parameter param);
110
111         bool mute_press(GdkEventButton*);
112         bool mute_release(GdkEventButton*);
113         bool solo_press(GdkEventButton*);
114         bool solo_release(GdkEventButton*);
115         bool rec_enable_press(GdkEventButton*);
116         bool rec_enable_release(GdkEventButton*);
117         bool show_sends_press(GdkEventButton*);
118         bool show_sends_release(GdkEventButton*);
119
120         void step_gain_up ();
121         void step_gain_down ();
122         void page_gain_up ();
123         void page_gain_down ();
124
125         void build_sends_menu ();
126         void set_sends_gain_from_track ();
127         void set_sends_gain_to_zero ();
128         void set_sends_gain_to_unity ();
129         void create_sends (ARDOUR::Placement);
130         void create_selected_sends (ARDOUR::Placement);
131
132         void solo_changed(void*);
133         void solo_changed_so_update_mute ();
134         void mute_changed(void*);
135         void listen_changed(void*);
136         virtual void processors_changed (ARDOUR::RouteProcessorChange) {}
137         void route_rec_enable_changed();
138         void session_rec_enable_changed();
139
140         void build_solo_menu ();
141
142         void solo_isolated_toggle (void*, Gtk::CheckMenuItem*);
143         void toggle_solo_isolated (Gtk::CheckMenuItem*);
144
145         void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
146         void toggle_solo_safe (Gtk::CheckMenuItem*);
147
148         Gtk::CheckMenuItem* pre_fader_mute_check;
149         Gtk::CheckMenuItem* post_fader_mute_check;
150         Gtk::CheckMenuItem* listen_mute_check;
151         Gtk::CheckMenuItem* main_mute_check;
152
153         void toggle_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
154         void muting_change ();
155         void build_mute_menu(void);
156         void init_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
157
158         void set_route_group_solo (boost::shared_ptr<ARDOUR::Route>, bool);
159         void set_route_group_mute (boost::shared_ptr<ARDOUR::Route>, bool);
160         void set_route_group_rec_enable (boost::shared_ptr<ARDOUR::Route>, bool);
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 name_changed ();
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         Gtk::CheckMenuItem *polarity_menu_item;
177         void toggle_polarity ();
178         virtual void polarity_changed ();
179
180         Gtk::CheckMenuItem *denormal_menu_item;
181         void toggle_denormal_protection();
182         virtual void denormal_protection_changed ();
183
184         void disconnect_input ();
185         void disconnect_output ();
186
187         virtual void update_rec_display ();
188         void update_mute_display ();
189
190         void update_solo_display ();
191
192         virtual void map_frozen ();
193
194         void reversibly_apply_route_boolean (std::string name, void (ARDOUR::Route::*func)(bool, void*), bool, void *);
195         void reversibly_apply_track_boolean (std::string name, void (ARDOUR::Track::*func)(bool, void*), bool, void *);
196
197         void adjust_latency ();
198         void save_as_template ();
199         void open_remote_control_id_dialog ();
200
201         static int solo_visual_state (boost::shared_ptr<ARDOUR::Route>);
202         static int mute_visual_state (ARDOUR::Session &, boost::shared_ptr<ARDOUR::Route>);
203
204    protected:
205         std::vector<sigc::connection> connections;
206         bool self_destruct;
207
208         void init ();
209         void reset ();
210
211         void queue_route_group_op (ARDOUR::RouteGroup::Property prop, void (ARDOUR::Session::*session_method)(boost::shared_ptr<ARDOUR::RouteList>, bool), bool yn);
212
213   private:
214         void check_rec_enable_sensitivity ();
215         void parameter_changed (std::string const &);
216         void relabel_solo_button ();
217
218         void post_rtop_cleanup (ARDOUR::SessionEvent* ev);
219         void post_group_rtop_cleanup (ARDOUR::SessionEvent* ev, ARDOUR::RouteGroup*, ARDOUR::RouteGroup::Property);
220         void post_solo_cleanup (ARDOUR::SessionEvent* ev, bool was_not_latched);
221 };
222
223 #endif /* __ardour_route_ui__ */