2 Copyright (C) 2002 Paul Davis
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.
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.
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.
20 #ifndef __ardour_route_ui__
21 #define __ardour_route_ui__
25 #include "pbd/xml++.h"
26 #include "pbd/signals.h"
28 #include <gtkmm/textview.h>
30 #include "gtkmm2ext/widget_state.h"
32 #include "ardour/ardour.h"
33 #include "ardour/mute_master.h"
34 #include "ardour/session.h"
35 #include "ardour/session_event.h"
36 #include "ardour/session_handle.h"
37 #include "ardour/route.h"
38 #include "ardour/route_group.h"
39 #include "ardour/track.h"
41 #include "axis_view.h"
42 #include "selectable.h"
43 #include "window_manager.h"
58 class IOSelectorWindow;
61 class RoutePinWindowProxy : public WM::ProxyBase
64 RoutePinWindowProxy (std::string const &, boost::shared_ptr<ARDOUR::Route>);
65 ~RoutePinWindowProxy();
67 Gtk::Window* get (bool create = false);
68 ARDOUR::SessionHandlePtr* session_handle();
71 boost::weak_ptr<ARDOUR::Route> _route;
73 void route_going_away ();
74 PBD::ScopedConnection going_away_connection;
77 class RouteUI : public virtual ARDOUR::SessionHandlePtr, public virtual PBD::ScopedConnectionList, public virtual Selectable, public virtual sigc::trackable
80 RouteUI (ARDOUR::Session*);
84 boost::shared_ptr<ARDOUR::Stripable> stripable() const;
86 virtual void set_route (boost::shared_ptr<ARDOUR::Route>);
87 virtual void set_button_names () = 0;
89 bool is_track() const;
90 bool is_audio_track() const;
91 bool is_midi_track() const;
92 bool has_audio_outputs () const;
94 boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
95 ARDOUR::RouteGroup* route_group() const;
97 boost::shared_ptr<ARDOUR::Track> track() const;
98 boost::shared_ptr<ARDOUR::AudioTrack> audio_track() const;
99 boost::shared_ptr<ARDOUR::MidiTrack> midi_track() const;
101 // protected: XXX sigh this should be here
103 boost::shared_ptr<ARDOUR::Route> _route;
105 void request_redraw ();
107 virtual void set_color (uint32_t c);
108 Gdk::Color route_color () const;
109 void choose_color ();
112 bool wait_for_release;
113 bool multiple_mute_change;
114 bool multiple_solo_change;
116 Gtk::HBox _invert_button_box;
117 ArdourButton* mute_button;
118 ArdourButton* solo_button;
119 ArdourButton* rec_enable_button; /* audio tracks */
120 ArdourButton* show_sends_button; /* busses */
121 ArdourButton* monitor_input_button;
122 ArdourButton* monitor_disk_button;
124 Glib::RefPtr<Gdk::Pixbuf> solo_safe_pixbuf;
126 ArdourButton* solo_safe_led;
127 ArdourButton* solo_isolated_led;
130 Gtk::Label monitor_input_button_label;
131 Gtk::Label monitor_disk_button_label;
133 void send_blink (bool);
134 sigc::connection send_blink_connection;
136 sigc::connection rec_blink_connection;
138 Gtk::Menu* mute_menu;
139 Gtk::Menu* solo_menu;
140 Gtk::Menu* sends_menu;
142 boost::shared_ptr<ARDOUR::Delivery> _current_delivery;
144 bool mute_press(GdkEventButton*);
145 bool mute_release(GdkEventButton*);
146 bool solo_press(GdkEventButton*);
147 bool solo_release(GdkEventButton*);
148 bool rec_enable_press(GdkEventButton*);
149 bool rec_enable_release(GdkEventButton*);
150 bool show_sends_press(GdkEventButton*);
151 bool show_sends_release(GdkEventButton*);
153 bool monitor_release(GdkEventButton*, ARDOUR::MonitorChoice);
154 bool monitor_input_press(GdkEventButton*);
155 bool monitor_input_release(GdkEventButton*);
156 bool monitor_disk_press(GdkEventButton*);
157 bool monitor_disk_release(GdkEventButton*);
158 void update_monitoring_display ();
160 void edit_input_configuration ();
161 void edit_output_configuration ();
163 void step_gain_up ();
164 void step_gain_down ();
165 void page_gain_up ();
166 void page_gain_down ();
168 void build_sends_menu ();
169 void set_sends_gain_from_track ();
170 void set_sends_gain_to_zero ();
171 void set_sends_gain_to_unity ();
172 void create_sends (ARDOUR::Placement, bool);
173 void create_selected_sends (ARDOUR::Placement, bool);
175 void solo_changed(bool, void*);
176 void solo_changed_so_update_mute ();
177 void listen_changed(void*);
178 virtual void processors_changed (ARDOUR::RouteProcessorChange) {}
179 void route_rec_enable_changed();
180 void session_rec_enable_changed();
182 void build_solo_menu ();
184 void solo_isolated_toggle (void*, Gtk::CheckMenuItem*);
185 void toggle_solo_isolated (Gtk::CheckMenuItem*);
187 bool solo_isolate_button_release (GdkEventButton*);
188 bool solo_safe_button_release (GdkEventButton*);
190 void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
191 void toggle_solo_safe (Gtk::CheckMenuItem*);
193 Gtk::CheckMenuItem* pre_fader_mute_check;
194 Gtk::CheckMenuItem* post_fader_mute_check;
195 Gtk::CheckMenuItem* listen_mute_check;
196 Gtk::CheckMenuItem* main_mute_check;
197 Gtk::CheckMenuItem* solo_safe_check;
198 Gtk::CheckMenuItem* solo_isolated_check;
200 void toggle_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
201 void muting_change ();
202 void build_mute_menu(void);
203 void init_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
205 int set_color_from_route ();
210 void maybe_add_route_print_mgr ();
211 void fan_out (bool to_busses = true, bool group = true);
213 virtual void route_property_changed (const PBD::PropertyChange&) = 0;
214 void route_removed ();
216 virtual void route_active_changed () {}
217 void set_route_active (bool, bool);
218 void duplicate_selected_routes ();
220 Gtk::Menu* record_menu;
221 void build_record_menu ();
223 Gtk::CheckMenuItem *step_edit_item;
224 void toggle_step_edit ();
225 virtual void step_edit_changed (bool);
227 Gtk::CheckMenuItem *rec_safe_item;
228 void toggle_rec_safe ();
230 virtual void polarity_changed ();
232 Gtk::CheckMenuItem *denormal_menu_item;
233 void toggle_denormal_protection();
234 virtual void denormal_protection_changed ();
236 void disconnect_input ();
237 void disconnect_output ();
239 virtual void blink_rec_display (bool onoff);
240 void update_mute_display ();
242 void update_solo_display ();
244 virtual void map_frozen ();
246 void adjust_latency ();
247 bool process_save_template_prompter (ArdourPrompter& prompter, const std::string& dir);
248 void save_as_template ();
250 static Gtkmm2ext::ActiveState solo_active_state (boost::shared_ptr<ARDOUR::Stripable>);
251 static Gtkmm2ext::ActiveState solo_isolate_active_state (boost::shared_ptr<ARDOUR::Stripable>);
252 static Gtkmm2ext::ActiveState solo_safe_active_state (boost::shared_ptr<ARDOUR::Stripable>);
253 static Gtkmm2ext::ActiveState mute_active_state (ARDOUR::Session*, boost::shared_ptr<ARDOUR::Stripable>);
255 /** Emitted when a bus has been set or unset from `display sends to this bus' mode
256 * by a click on the `Sends' button. The parameter is the route that the sends are
257 * to, or 0 if no route is now in this mode.
259 static PBD::Signal1<void, boost::shared_ptr<ARDOUR::Route> > BusSendDisplayChanged;
261 void comment_editor_done_editing ();
262 void setup_comment_editor ();
263 void open_comment_editor ();
264 void toggle_comment_editor ();
266 gint comment_key_release_handler (GdkEventKey*);
267 void comment_changed ();
268 void comment_edited ();
269 bool ignore_comment_edit;
273 ArdourWindow* comment_window;
274 Gtk::TextView* comment_area;
275 IOSelectorWindow *input_selector;
276 IOSelectorWindow *output_selector;
278 PBD::ScopedConnectionList route_connections;
285 virtual void start_step_editing () {}
286 virtual void stop_step_editing() {}
288 void set_invert_sensitive (bool);
289 bool verify_new_route_name (const std::string& name);
291 void route_gui_changed (PBD::PropertyChange const&);
292 virtual void route_color_changed () {}
294 void check_rec_enable_sensitivity ();
296 virtual void bus_send_display_changed (boost::shared_ptr<ARDOUR::Route>);
298 static std::string program_port_prefix;
300 bool mark_hidden (bool yn);
303 void parameter_changed (std::string const &);
304 void relabel_solo_button ();
305 void track_mode_changed ();
307 std::string route_state_id () const;
310 struct SoloMuteRelease {
311 SoloMuteRelease (bool was_active)
312 : active (was_active)
313 , exclusive (false) {}
315 boost::shared_ptr<ARDOUR::RouteList> routes;
316 boost::shared_ptr<ARDOUR::RouteList> routes_on;
317 boost::shared_ptr<ARDOUR::RouteList> routes_off;
318 boost::shared_ptr<ARDOUR::Route> route;
323 SoloMuteRelease* _solo_release;
324 SoloMuteRelease* _mute_release;
329 void setup_invert_buttons ();
330 void set_invert_button_state ();
331 void invert_menu_toggled (uint32_t);
332 bool invert_press (GdkEventButton *);
333 bool invert_release (GdkEventButton *, uint32_t i);
335 int _i_am_the_modifier;
336 std::vector<ArdourButton*> _invert_buttons;
337 Gtk::Menu* _invert_menu;
339 static void set_showing_sends_to (boost::shared_ptr<ARDOUR::Route>);
340 static boost::weak_ptr<ARDOUR::Route> _showing_sends_to;
342 static uint32_t _max_invert_buttons;
345 #endif /* __ardour_route_ui__ */