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;
66 class PatchChangeGridDialog;
67 class SaveTemplateDialog;
69 class RoutePinWindowProxy : public WM::ProxyBase
72 RoutePinWindowProxy (std::string const &, boost::shared_ptr<ARDOUR::Route>);
73 ~RoutePinWindowProxy();
75 Gtk::Window* get (bool create = false);
76 ARDOUR::SessionHandlePtr* session_handle();
79 boost::weak_ptr<ARDOUR::Route> _route;
81 void route_going_away ();
82 PBD::ScopedConnection going_away_connection;
85 class RouteUI : public virtual Selectable, public virtual ARDOUR::SessionHandlePtr, public virtual PBD::ScopedConnectionList, public virtual sigc::trackable
88 RouteUI (ARDOUR::Session*);
92 boost::shared_ptr<ARDOUR::Stripable> stripable() const;
94 virtual void set_route (boost::shared_ptr<ARDOUR::Route>);
95 virtual void set_button_names () = 0;
97 bool is_track() const;
98 bool is_audio_track() const;
99 bool is_midi_track() const;
100 bool has_audio_outputs () const;
102 boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
103 ARDOUR::RouteGroup* route_group() const;
105 boost::shared_ptr<ARDOUR::Track> track() const;
106 boost::shared_ptr<ARDOUR::AudioTrack> audio_track() const;
107 boost::shared_ptr<ARDOUR::MidiTrack> midi_track() const;
109 // protected: XXX sigh this should be here
111 boost::shared_ptr<ARDOUR::Route> _route;
113 virtual void set_color (uint32_t c);
114 Gdk::Color route_color () const;
115 void choose_color ();
117 void select_midi_patch ();
120 bool wait_for_release;
121 bool multiple_mute_change;
122 bool multiple_solo_change;
124 Gtk::HBox _invert_button_box;
125 ArdourWidgets::ArdourButton* mute_button;
126 ArdourWidgets::ArdourButton* solo_button;
127 ArdourWidgets::ArdourButton* rec_enable_button; /* audio tracks */
128 ArdourWidgets::ArdourButton* show_sends_button; /* busses */
129 ArdourWidgets::ArdourButton* monitor_input_button;
130 ArdourWidgets::ArdourButton* monitor_disk_button;
132 Glib::RefPtr<Gdk::Pixbuf> solo_safe_pixbuf;
134 ArdourWidgets::ArdourButton* solo_safe_led;
135 ArdourWidgets::ArdourButton* solo_isolated_led;
138 Gtk::Label monitor_input_button_label;
139 Gtk::Label monitor_disk_button_label;
141 void send_blink (bool);
142 sigc::connection send_blink_connection;
144 sigc::connection rec_blink_connection;
146 Gtk::Menu* mute_menu;
147 Gtk::Menu* solo_menu;
148 Gtk::Menu* sends_menu;
150 boost::shared_ptr<ARDOUR::Delivery> _current_delivery;
152 bool mute_press(GdkEventButton*);
153 bool mute_release(GdkEventButton*);
154 bool solo_press(GdkEventButton*);
155 bool solo_release(GdkEventButton*);
156 bool rec_enable_press(GdkEventButton*);
157 bool rec_enable_release(GdkEventButton*);
158 bool show_sends_press(GdkEventButton*);
159 bool show_sends_release(GdkEventButton*);
161 bool monitor_release(GdkEventButton*, ARDOUR::MonitorChoice);
162 bool monitor_input_press(GdkEventButton*);
163 bool monitor_input_release(GdkEventButton*);
164 bool monitor_disk_press(GdkEventButton*);
165 bool monitor_disk_release(GdkEventButton*);
166 void update_monitoring_display ();
168 void edit_input_configuration ();
169 void edit_output_configuration ();
171 void build_sends_menu ();
172 void set_sends_gain_from_track ();
173 void set_sends_gain_to_zero ();
174 void set_sends_gain_to_unity ();
175 void create_sends (ARDOUR::Placement, bool);
176 void create_selected_sends (ARDOUR::Placement, bool);
178 void solo_changed(bool, void*);
179 void solo_changed_so_update_mute ();
180 void listen_changed(void*);
181 virtual void processors_changed (ARDOUR::RouteProcessorChange) {}
182 void route_rec_enable_changed();
183 void session_rec_enable_changed();
185 void build_solo_menu ();
187 void solo_isolated_toggle (void*, Gtk::CheckMenuItem*);
188 void toggle_solo_isolated (Gtk::CheckMenuItem*);
190 bool solo_isolate_button_release (GdkEventButton*);
191 bool solo_safe_button_release (GdkEventButton*);
193 void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
194 void toggle_solo_safe (Gtk::CheckMenuItem*);
196 Gtk::CheckMenuItem* pre_fader_mute_check;
197 Gtk::CheckMenuItem* post_fader_mute_check;
198 Gtk::CheckMenuItem* listen_mute_check;
199 Gtk::CheckMenuItem* main_mute_check;
200 Gtk::CheckMenuItem* solo_safe_check;
201 Gtk::CheckMenuItem* solo_isolated_check;
203 void toggle_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
204 void muting_change ();
205 void build_mute_menu(void);
206 void init_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
208 int set_color_from_route ();
213 void maybe_add_route_print_mgr ();
214 void fan_out (bool to_busses = true, bool group = true);
216 virtual void route_property_changed (const PBD::PropertyChange&) = 0;
217 void route_removed ();
219 virtual void route_active_changed () {}
220 void set_route_active (bool, bool);
221 void duplicate_selected_routes ();
223 Gtk::Menu* record_menu;
224 void build_record_menu ();
226 Gtk::CheckMenuItem *step_edit_item;
227 void toggle_step_edit ();
228 virtual void step_edit_changed (bool);
230 Gtk::CheckMenuItem *rec_safe_item;
231 void toggle_rec_safe ();
233 virtual void polarity_changed ();
235 Gtk::CheckMenuItem *denormal_menu_item;
236 void toggle_denormal_protection();
237 virtual void denormal_protection_changed ();
239 void disconnect_input ();
240 void disconnect_output ();
242 virtual void blink_rec_display (bool onoff);
243 void update_mute_display ();
245 void update_solo_display ();
247 virtual void map_frozen ();
249 void adjust_latency ();
250 void save_as_template_dialog_response (int response, SaveTemplateDialog* d);
251 void save_as_template ();
253 static Gtkmm2ext::ActiveState solo_active_state (boost::shared_ptr<ARDOUR::Stripable>);
254 static Gtkmm2ext::ActiveState solo_isolate_active_state (boost::shared_ptr<ARDOUR::Stripable>);
255 static Gtkmm2ext::ActiveState solo_safe_active_state (boost::shared_ptr<ARDOUR::Stripable>);
256 static Gtkmm2ext::ActiveState mute_active_state (ARDOUR::Session*, boost::shared_ptr<ARDOUR::Stripable>);
258 /** Emitted when a bus has been set or unset from `display sends to this bus' mode
259 * by a click on the `Sends' button. The parameter is the route that the sends are
260 * to, or 0 if no route is now in this mode.
262 static PBD::Signal1<void, boost::shared_ptr<ARDOUR::Route> > BusSendDisplayChanged;
264 void comment_editor_done_editing ();
265 void setup_comment_editor ();
266 void open_comment_editor ();
267 void toggle_comment_editor ();
269 gint comment_key_release_handler (GdkEventKey*);
270 void comment_changed ();
271 void comment_edited ();
272 bool ignore_comment_edit;
274 void set_disk_io_point (ARDOUR::DiskIOPoint);
278 ArdourWindow* comment_window;
279 Gtk::TextView* comment_area;
280 IOSelectorWindow *input_selector;
281 IOSelectorWindow *output_selector;
283 PBD::ScopedConnectionList route_connections;
290 virtual void start_step_editing () {}
291 virtual void stop_step_editing() {}
293 void set_invert_sensitive (bool);
294 bool verify_new_route_name (const std::string& name);
296 void route_gui_changed (PBD::PropertyChange const&);
297 virtual void route_color_changed () {}
299 void check_rec_enable_sensitivity ();
301 virtual void bus_send_display_changed (boost::shared_ptr<ARDOUR::Route>);
303 static std::string program_port_prefix;
305 bool mark_hidden (bool yn);
307 PatchChangeGridDialog* patch_change_dialog () const;
310 void parameter_changed (std::string const&);
311 void relabel_solo_button ();
312 void track_mode_changed ();
313 void delete_patch_change_dialog ();
315 std::string route_state_id () const;
318 struct SoloMuteRelease {
319 SoloMuteRelease (bool was_active)
320 : active (was_active)
324 boost::shared_ptr<ARDOUR::RouteList> routes;
325 boost::shared_ptr<ARDOUR::RouteList> routes_on;
326 boost::shared_ptr<ARDOUR::RouteList> routes_off;
327 boost::shared_ptr<ARDOUR::Route> route;
332 SoloMuteRelease* _solo_release;
333 SoloMuteRelease* _mute_release;
338 void setup_invert_buttons ();
339 void set_invert_button_state ();
340 void invert_menu_toggled (uint32_t);
341 bool invert_press (GdkEventButton *);
342 bool invert_release (GdkEventButton *, uint32_t i);
344 int _i_am_the_modifier;
345 std::vector<ArdourWidgets::ArdourButton*> _invert_buttons;
346 Gtk::Menu* _invert_menu;
348 StripableColorDialog _color_picker;
350 static void set_showing_sends_to (boost::shared_ptr<ARDOUR::Route>);
351 static boost::weak_ptr<ARDOUR::Route> _showing_sends_to;
353 static uint32_t _max_invert_buttons;
356 #endif /* __ardour_route_ui__ */