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>
29 #include <gtkmm/colorselection.h>
31 #include "gtkmm2ext/widget_state.h"
33 #include "ardour/ardour.h"
34 #include "ardour/mute_master.h"
35 #include "ardour/session.h"
36 #include "ardour/session_event.h"
37 #include "ardour/session_handle.h"
38 #include "ardour/route.h"
39 #include "ardour/route_group.h"
40 #include "ardour/track.h"
42 #include "axis_view.h"
43 #include "selectable.h"
44 #include "stripable_colorpicker.h"
45 #include "window_manager.h"
58 namespace ArdourWidgets {
64 class IOSelectorWindow;
67 class RoutePinWindowProxy : public WM::ProxyBase
70 RoutePinWindowProxy (std::string const &, boost::shared_ptr<ARDOUR::Route>);
71 ~RoutePinWindowProxy();
73 Gtk::Window* get (bool create = false);
74 ARDOUR::SessionHandlePtr* session_handle();
77 boost::weak_ptr<ARDOUR::Route> _route;
79 void route_going_away ();
80 PBD::ScopedConnection going_away_connection;
83 class RouteUI : public virtual Selectable, public virtual ARDOUR::SessionHandlePtr, public virtual PBD::ScopedConnectionList, public virtual sigc::trackable
86 RouteUI (ARDOUR::Session*);
90 boost::shared_ptr<ARDOUR::Stripable> stripable() const;
92 virtual void set_route (boost::shared_ptr<ARDOUR::Route>);
93 virtual void set_button_names () = 0;
95 bool is_track() const;
96 bool is_audio_track() const;
97 bool is_midi_track() const;
98 bool has_audio_outputs () const;
100 boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
101 ARDOUR::RouteGroup* route_group() const;
103 boost::shared_ptr<ARDOUR::Track> track() const;
104 boost::shared_ptr<ARDOUR::AudioTrack> audio_track() const;
105 boost::shared_ptr<ARDOUR::MidiTrack> midi_track() const;
107 // protected: XXX sigh this should be here
109 boost::shared_ptr<ARDOUR::Route> _route;
111 virtual void set_color (uint32_t c);
112 Gdk::Color route_color () const;
113 void choose_color ();
116 bool wait_for_release;
117 bool multiple_mute_change;
118 bool multiple_solo_change;
120 Gtk::HBox _invert_button_box;
121 ArdourWidgets::ArdourButton* mute_button;
122 ArdourWidgets::ArdourButton* solo_button;
123 ArdourWidgets::ArdourButton* rec_enable_button; /* audio tracks */
124 ArdourWidgets::ArdourButton* show_sends_button; /* busses */
125 ArdourWidgets::ArdourButton* monitor_input_button;
126 ArdourWidgets::ArdourButton* monitor_disk_button;
128 Glib::RefPtr<Gdk::Pixbuf> solo_safe_pixbuf;
130 ArdourWidgets::ArdourButton* solo_safe_led;
131 ArdourWidgets::ArdourButton* solo_isolated_led;
134 Gtk::Label monitor_input_button_label;
135 Gtk::Label monitor_disk_button_label;
137 void send_blink (bool);
138 sigc::connection send_blink_connection;
140 sigc::connection rec_blink_connection;
142 Gtk::Menu* mute_menu;
143 Gtk::Menu* solo_menu;
144 Gtk::Menu* sends_menu;
146 boost::shared_ptr<ARDOUR::Delivery> _current_delivery;
148 bool mute_press(GdkEventButton*);
149 bool mute_release(GdkEventButton*);
150 bool solo_press(GdkEventButton*);
151 bool solo_release(GdkEventButton*);
152 bool rec_enable_press(GdkEventButton*);
153 bool rec_enable_release(GdkEventButton*);
154 bool show_sends_press(GdkEventButton*);
155 bool show_sends_release(GdkEventButton*);
157 bool monitor_release(GdkEventButton*, ARDOUR::MonitorChoice);
158 bool monitor_input_press(GdkEventButton*);
159 bool monitor_input_release(GdkEventButton*);
160 bool monitor_disk_press(GdkEventButton*);
161 bool monitor_disk_release(GdkEventButton*);
162 void update_monitoring_display ();
164 void edit_input_configuration ();
165 void edit_output_configuration ();
167 void build_sends_menu ();
168 void set_sends_gain_from_track ();
169 void set_sends_gain_to_zero ();
170 void set_sends_gain_to_unity ();
171 void create_sends (ARDOUR::Placement, bool);
172 void create_selected_sends (ARDOUR::Placement, bool);
174 void solo_changed(bool, void*);
175 void solo_changed_so_update_mute ();
176 void listen_changed(void*);
177 virtual void processors_changed (ARDOUR::RouteProcessorChange) {}
178 void route_rec_enable_changed();
179 void session_rec_enable_changed();
181 void build_solo_menu ();
183 void solo_isolated_toggle (void*, Gtk::CheckMenuItem*);
184 void toggle_solo_isolated (Gtk::CheckMenuItem*);
186 bool solo_isolate_button_release (GdkEventButton*);
187 bool solo_safe_button_release (GdkEventButton*);
189 void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
190 void toggle_solo_safe (Gtk::CheckMenuItem*);
192 Gtk::CheckMenuItem* pre_fader_mute_check;
193 Gtk::CheckMenuItem* post_fader_mute_check;
194 Gtk::CheckMenuItem* listen_mute_check;
195 Gtk::CheckMenuItem* main_mute_check;
196 Gtk::CheckMenuItem* solo_safe_check;
197 Gtk::CheckMenuItem* solo_isolated_check;
199 void toggle_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
200 void muting_change ();
201 void build_mute_menu(void);
202 void init_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
204 int set_color_from_route ();
209 void maybe_add_route_print_mgr ();
210 void fan_out (bool to_busses = true, bool group = true);
212 virtual void route_property_changed (const PBD::PropertyChange&) = 0;
213 void route_removed ();
215 virtual void route_active_changed () {}
216 void set_route_active (bool, bool);
217 void duplicate_selected_routes ();
219 Gtk::Menu* record_menu;
220 void build_record_menu ();
222 Gtk::CheckMenuItem *step_edit_item;
223 void toggle_step_edit ();
224 virtual void step_edit_changed (bool);
226 Gtk::CheckMenuItem *rec_safe_item;
227 void toggle_rec_safe ();
229 virtual void polarity_changed ();
231 Gtk::CheckMenuItem *denormal_menu_item;
232 void toggle_denormal_protection();
233 virtual void denormal_protection_changed ();
235 void disconnect_input ();
236 void disconnect_output ();
238 virtual void blink_rec_display (bool onoff);
239 void update_mute_display ();
241 void update_solo_display ();
243 virtual void map_frozen ();
245 void adjust_latency ();
246 bool process_save_template_prompter (ArdourWidgets::Prompter& prompter, const std::string& dir);
247 void save_as_template ();
249 static Gtkmm2ext::ActiveState solo_active_state (boost::shared_ptr<ARDOUR::Stripable>);
250 static Gtkmm2ext::ActiveState solo_isolate_active_state (boost::shared_ptr<ARDOUR::Stripable>);
251 static Gtkmm2ext::ActiveState solo_safe_active_state (boost::shared_ptr<ARDOUR::Stripable>);
252 static Gtkmm2ext::ActiveState mute_active_state (ARDOUR::Session*, boost::shared_ptr<ARDOUR::Stripable>);
254 /** Emitted when a bus has been set or unset from `display sends to this bus' mode
255 * by a click on the `Sends' button. The parameter is the route that the sends are
256 * to, or 0 if no route is now in this mode.
258 static PBD::Signal1<void, boost::shared_ptr<ARDOUR::Route> > BusSendDisplayChanged;
260 void comment_editor_done_editing ();
261 void setup_comment_editor ();
262 void open_comment_editor ();
263 void toggle_comment_editor ();
265 gint comment_key_release_handler (GdkEventKey*);
266 void comment_changed ();
267 void comment_edited ();
268 bool ignore_comment_edit;
272 ArdourWindow* comment_window;
273 Gtk::TextView* comment_area;
274 IOSelectorWindow *input_selector;
275 IOSelectorWindow *output_selector;
277 PBD::ScopedConnectionList route_connections;
284 virtual void start_step_editing () {}
285 virtual void stop_step_editing() {}
287 void set_invert_sensitive (bool);
288 bool verify_new_route_name (const std::string& name);
290 void route_gui_changed (PBD::PropertyChange const&);
291 virtual void route_color_changed () {}
293 void check_rec_enable_sensitivity ();
295 virtual void bus_send_display_changed (boost::shared_ptr<ARDOUR::Route>);
297 static std::string program_port_prefix;
299 bool mark_hidden (bool yn);
302 void parameter_changed (std::string const&);
303 void relabel_solo_button ();
304 void track_mode_changed ();
306 std::string route_state_id () const;
309 struct SoloMuteRelease {
310 SoloMuteRelease (bool was_active)
311 : active (was_active)
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<ArdourWidgets::ArdourButton*> _invert_buttons;
337 Gtk::Menu* _invert_menu;
339 StripableColorDialog _color_picker;
341 static void set_showing_sends_to (boost::shared_ptr<ARDOUR::Route>);
342 static boost::weak_ptr<ARDOUR::Route> _showing_sends_to;
344 static uint32_t _max_invert_buttons;
347 #endif /* __ardour_route_ui__ */