Fix problems with summary when the session start marker is not at zero (#2924)
[ardour.git] / gtk2_ardour / route_ui.cc
1 /*
2     Copyright (C) 2002-2006 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 #include <gtkmm2ext/gtk_ui.h>
21 #include <gtkmm2ext/stop_signal.h>
22 #include <gtkmm2ext/choice.h>
23 #include <gtkmm2ext/doi.h>
24 #include <gtkmm2ext/bindable_button.h>
25 #include <gtkmm2ext/barcontroller.h>
26 #include <gtkmm2ext/gtk_ui.h>
27
28 #include "ardour/route_group.h"
29 #include "ardour/dB.h"
30 #include "pbd/memento_command.h"
31 #include "pbd/stacktrace.h"
32 #include "pbd/shiva.h"
33 #include "pbd/controllable.h"
34 #include "pbd/enumwriter.h"
35
36 #include "ardour_ui.h"
37 #include "editor.h"
38 #include "route_ui.h"
39 #include "keyboard.h"
40 #include "utils.h"
41 #include "prompter.h"
42 #include "gui_thread.h"
43 #include "ardour_dialog.h"
44 #include "latency_gui.h"
45 #include "mixer_strip.h"
46 #include "automation_time_axis.h"
47 #include "route_time_axis.h"
48
49 #include "ardour/route.h"
50 #include "ardour/event_type_map.h"
51 #include "ardour/session.h"
52 #include "ardour/audioengine.h"
53 #include "ardour/audio_track.h"
54 #include "ardour/audio_diskstream.h"
55 #include "ardour/midi_track.h"
56 #include "ardour/midi_diskstream.h"
57 #include "ardour/template_utils.h"
58 #include "ardour/filename_extensions.h"
59 #include "ardour/directory_names.h"
60 #include "ardour/profile.h"
61
62 #include "i18n.h"
63 using namespace sigc;
64 using namespace Gtk;
65 using namespace Gtkmm2ext;
66 using namespace ARDOUR;
67 using namespace PBD;
68
69 RouteUI::RouteUI (ARDOUR::Session& sess)
70         : AxisView(sess)
71 {
72         init ();
73 }
74
75 RouteUI::RouteUI (boost::shared_ptr<ARDOUR::Route> rt, ARDOUR::Session& sess)
76         : AxisView(sess)
77 {
78         init ();
79         set_route (rt);
80 }
81
82 RouteUI::~RouteUI()
83 {
84        /* derived classes should emit GoingAway so that they receive the signal
85           when the object is still a legal derived instance.
86        */
87
88         delete solo_menu;
89         delete mute_menu;
90         delete sends_menu;
91 }
92
93 void
94 RouteUI::init ()
95 {
96         self_destruct = true;
97         xml_node = 0;
98         mute_menu = 0;
99         solo_menu = 0;
100         sends_menu = 0;
101         pre_fader_mute_check = 0;
102         post_fader_mute_check = 0;
103         listen_mute_check = 0;
104         main_mute_check = 0;
105         ignore_toggle = false;
106         wait_for_release = false;
107         route_active_menu_item = 0;
108         polarity_menu_item = 0;
109         denormal_menu_item = 0;
110         multiple_mute_change = false;
111         multiple_solo_change = false;
112
113         mute_button = manage (new BindableToggleButton ());
114         mute_button->set_self_managed (true);
115         mute_button->set_name ("MuteButton");
116         mute_button->add (mute_button_label);
117         mute_button_label.show ();
118         UI::instance()->set_tip (mute_button, _("Mute this track"), "");
119
120         solo_button = manage (new BindableToggleButton ());
121         solo_button->set_self_managed (true);
122         solo_button->set_name ("SoloButton");
123         solo_button->add (solo_button_label);
124         solo_button_label.show ();
125         UI::instance()->set_tip (solo_button, _("Mute other (non-soloed) tracks"), "");
126         solo_button->set_no_show_all (true);
127
128         rec_enable_button = manage (new BindableToggleButton ());
129         rec_enable_button->set_name ("RecordEnableButton");
130         rec_enable_button->set_self_managed (true);
131         rec_enable_button->add (rec_enable_button_label);
132         rec_enable_button_label.show ();
133         UI::instance()->set_tip (rec_enable_button, _("Enable recording on this track"), "");
134
135         show_sends_button = manage (new BindableToggleButton (""));
136         show_sends_button->set_name ("SendAlert");
137         show_sends_button->set_self_managed (true);
138         UI::instance()->set_tip (show_sends_button, _("make mixer strips show sends to this bus"), "");
139
140         _session.SoloChanged.connect (mem_fun(*this, &RouteUI::solo_changed_so_update_mute));
141         _session.TransportStateChange.connect (mem_fun (*this, &RouteUI::check_rec_enable_sensitivity));
142
143         Config->ParameterChanged.connect (mem_fun (*this, &RouteUI::parameter_changed));
144 }
145
146 void
147 RouteUI::reset ()
148 {
149         //Remove route connections associated with us.
150         for (vector<sigc::connection>::iterator it = connections.begin(); it!=connections.end(); ++it) {
151             (*it).disconnect();
152         }
153
154         connections.clear ();
155
156         delete solo_menu;
157         solo_menu = 0;
158
159         delete mute_menu;
160         mute_menu = 0;
161
162         if (xml_node) {
163                 /* do not delete the node - its owned by the route */
164                 xml_node = 0;
165         }
166
167         route_active_menu_item = 0;
168         polarity_menu_item = 0;
169         denormal_menu_item = 0;
170 }
171
172 void
173 RouteUI::set_route (boost::shared_ptr<Route> rp)
174 {
175         reset ();
176
177         _route = rp;
178
179         if (set_color_from_route()) {
180                 set_color (unique_random_color());
181         }
182
183         /* no, there is no memory leak here. This object cleans itself (and other stuff)
184            up when the route is destroyed.
185         */
186
187         if (self_destruct) {
188                 new PairedShiva<Route,RouteUI> (*_route, *this);
189         }
190
191         mute_button->set_controllable (_route->mute_control());
192         solo_button->set_controllable (_route->solo_control());
193
194         connections.push_back (_route->active_changed.connect (mem_fun (*this, &RouteUI::route_active_changed)));
195         connections.push_back (_route->mute_changed.connect (mem_fun(*this, &RouteUI::mute_changed)));
196         connections.push_back (_route->solo_changed.connect (mem_fun(*this, &RouteUI::solo_changed)));
197         connections.push_back (_route->listen_changed.connect (mem_fun(*this, &RouteUI::listen_changed)));
198         connections.push_back (_route->solo_isolated_changed.connect (mem_fun(*this, &RouteUI::solo_changed)));
199
200         if (_session.writable() && is_track()) {
201                 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(_route);
202
203                 connections.push_back (t->diskstream()->RecordEnableChanged.connect (mem_fun (*this, &RouteUI::route_rec_enable_changed)));
204                 connections.push_back (_session.RecordStateChanged.connect (mem_fun (*this, &RouteUI::session_rec_enable_changed)));
205
206                 rec_enable_button->show();
207                 rec_enable_button->set_controllable (t->rec_enable_control());
208
209                 update_rec_display ();
210         }
211
212         mute_button->unset_flags (Gtk::CAN_FOCUS);
213         solo_button->unset_flags (Gtk::CAN_FOCUS);
214
215         mute_button->show();
216
217         if (_route->is_control()) {
218                 solo_button->hide ();
219         } else {
220                 solo_button->show();
221         }
222
223         /* map the current state */
224
225         mute_changed (0);
226         solo_changed (0);
227
228         map_frozen ();
229 }
230
231 bool
232 RouteUI::mute_press(GdkEventButton* ev)
233 {
234         if (ev->type == GDK_2BUTTON_PRESS || ev->type == GDK_3BUTTON_PRESS ) {
235                 return true;
236         }
237         multiple_mute_change = false;
238         if (!ignore_toggle) {
239
240                 if (Keyboard::is_context_menu_event (ev)) {
241
242                         if (mute_menu == 0){
243                                 build_mute_menu();
244                         }
245
246                         mute_menu->popup(0,ev->time);
247
248                 } else {
249
250                         if (Keyboard::is_button2_event (ev)) {
251                                 // Primary-button2 click is the midi binding click
252                                 // button2-click is "momentary"
253
254                                 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier))) {
255                                         wait_for_release = true;
256                                 } else {
257                                         return false;
258                                 }
259                         }
260
261                         if (ev->button == 1 || Keyboard::is_button2_event (ev)) {
262
263                                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
264
265                                         /* Primary-Tertiary-click applies change to all routes */
266
267                                         _session.begin_reversible_command (_("mute change"));
268                                         Session::GlobalMuteStateCommand *cmd = new Session::GlobalMuteStateCommand(_session, this);
269                                         _session.set_all_mute (!_route->muted());
270                                         cmd->mark();
271                                         _session.add_command(cmd);
272                                         _session.commit_reversible_command ();
273                                         multiple_mute_change = true;
274
275                                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
276
277                                         /* Primary-button1 applies change to the mix group.
278                                            NOTE: Primary-button2 is MIDI learn.
279                                         */
280
281                                         if (ev->button == 1) {
282                                                 set_route_group_mute (_route, !_route->muted());
283                                         }
284
285                                 } else {
286
287                                         /* plain click applies change to this route */
288                                         if (wait_for_release) {
289                                                 _route->set_mute (!_route->muted(), this);
290                                         } else {
291                                                 reversibly_apply_route_boolean ("mute change", &Route::set_mute, !_route->muted(), this);
292                                         }
293                                 }
294                         }
295                 }
296
297         }
298
299         return true;
300 }
301
302 bool
303 RouteUI::mute_release(GdkEventButton*)
304 {
305         if (!ignore_toggle) {
306                 if (wait_for_release){
307                         wait_for_release = false;
308                         if (multiple_mute_change) {
309                                 multiple_mute_change = false;
310                                 // undo the last op
311                                 // because the press was the last undoable thing we did
312                                 _session.undo (1U);
313                         } else {
314                                 _route->set_mute (!_route->muted(), this);
315                         }
316                 }
317         }
318         return true;
319 }
320
321 bool
322 RouteUI::solo_press(GdkEventButton* ev)
323 {
324         /* ignore double/triple clicks */
325
326         if (ev->type == GDK_2BUTTON_PRESS || ev->type == GDK_3BUTTON_PRESS ) {
327                 return true;
328         }
329
330         if (Config->get_solo_control_is_listen_control()) {
331
332                 _route->set_listen (!_route->listening(), this);
333
334         } else {
335
336                 multiple_solo_change = false;
337                 if (!ignore_toggle) {
338
339                         if (Keyboard::is_context_menu_event (ev)) {
340
341                                 if (solo_menu == 0) {
342                                         build_solo_menu ();
343                                 }
344
345                                 solo_menu->popup (1, ev->time);
346
347                         } else {
348
349                                 if (Keyboard::is_button2_event (ev)) {
350
351                                         // Primary-button2 click is the midi binding click
352                                         // button2-click is "momentary"
353
354                                         if (!Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier))) {
355                                                 wait_for_release = true;
356                                         } else {
357                                                 return false;
358                                         }
359                                 }
360
361                                 if (ev->button == 1 || Keyboard::is_button2_event (ev)) {
362
363                                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
364
365                                                 /* Primary-Tertiary-click applies change to all routes */
366                                                 bool was_not_latched = false;
367                                                 if (!Config->get_solo_latched ()) {
368                                                         was_not_latched = true;
369                                                         /*
370                                                           XXX it makes no sense to solo all tracks if we're
371                                                           not in latched mode, but doing nothing feels like a bug,
372                                                           so do it anyway
373                                                         */
374                                                         Config->set_solo_latched (true);
375                                                 }
376                                                 _session.begin_reversible_command (_("solo change"));
377                                                 Session::GlobalSoloStateCommand *cmd = new Session::GlobalSoloStateCommand(_session, this);
378                                                 _session.set_all_solo (!_route->soloed());
379                                                 cmd->mark();
380                                                 _session.add_command (cmd);
381                                                 _session.commit_reversible_command ();
382                                                 multiple_solo_change = true;
383                                                 if (was_not_latched) {
384                                                         Config->set_solo_latched (false);
385                                                 }
386
387                                         } else if (Keyboard::modifier_state_contains (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::SecondaryModifier))) {
388
389                                                 // Primary-Secondary-click: exclusively solo this track, not a toggle */
390
391                                                 _session.begin_reversible_command (_("solo change"));
392                                                 Session::GlobalSoloStateCommand *cmd = new Session::GlobalSoloStateCommand (_session, this);
393                                                 _session.set_all_solo (false);
394                                                 _route->set_solo (true, this);
395                                                 cmd->mark();
396                                                 _session.add_command(cmd);
397                                                 _session.commit_reversible_command ();
398
399                                         } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
400
401                                                 // shift-click: toggle solo isolated status
402
403                                                 _route->set_solo_isolated (!_route->solo_isolated(), this);
404                                                 wait_for_release = false;
405
406                                         } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
407
408                                                 /* Primary-button1: solo mix group.
409                                                    NOTE: Primary-button2 is MIDI learn.
410                                                 */
411
412                                                 if (ev->button == 1) {
413                                                         set_route_group_solo (_route, !_route->soloed());
414                                                 }
415
416                                         } else {
417
418                                                 /* click: solo this route */
419                                                 if (wait_for_release) {
420                                                         _route->set_solo (!_route->soloed(), this);
421                                                 } else {
422                                                         reversibly_apply_route_boolean ("solo change", &Route::set_solo, !_route->soloed(), this);
423                                                 }
424                                         }
425                                 }
426                         }
427                 }
428         }
429
430         return true;
431 }
432
433 bool
434 RouteUI::solo_release(GdkEventButton*)
435 {
436         if (!ignore_toggle) {
437                 if (wait_for_release) {
438                         wait_for_release = false;
439                         if (multiple_solo_change) {
440                                 multiple_solo_change = false;
441                                 // undo the last op
442                                 // because the press was the last undoable thing we did
443                                 _session.undo (1U);
444                         } else {
445                                 // we don't use "undo the last op"
446                                 // here because its expensive for the GUI
447                                 _route->set_solo (!_route->soloed(), this);
448                         }
449                 }
450         }
451
452         return true;
453 }
454
455 bool
456 RouteUI::rec_enable_press(GdkEventButton* ev)
457 {
458         if (ev->type == GDK_2BUTTON_PRESS || ev->type == GDK_3BUTTON_PRESS ) {
459                 return true;
460         }
461
462         if (!_session.engine().connected()) {
463                 MessageDialog msg (_("Not connected to JACK - cannot engage record"));
464                 msg.run ();
465                 return true;
466         }
467
468         if (!ignore_toggle && is_track() && rec_enable_button) {
469
470                 if (Keyboard::is_button2_event (ev) && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
471
472                         // do nothing on midi bind event
473                         return false;
474
475                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
476
477                         _session.begin_reversible_command (_("rec-enable change"));
478                         Session::GlobalRecordEnableStateCommand *cmd = new Session::GlobalRecordEnableStateCommand(_session, this);
479
480                         if (rec_enable_button->get_active()) {
481                                 _session.record_disenable_all ();
482                         } else {
483                                 _session.record_enable_all ();
484                                 check_rec_enable_sensitivity ();
485                         }
486
487                         cmd->mark();
488                         _session.add_command(cmd);
489                         _session.commit_reversible_command ();
490
491                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
492
493                         /* Primary-button1 applies change to the mix group.
494                            NOTE: Primary-button2 is MIDI learn.
495                         */
496
497                         set_route_group_rec_enable (_route, !_route->record_enabled());
498
499                 } else if (Keyboard::is_context_menu_event (ev)) {
500
501                         /* do this on release */
502
503                 } else {
504                         reversibly_apply_track_boolean ("rec-enable change", &Track::set_record_enable, !track()->record_enabled(), this);
505                         check_rec_enable_sensitivity ();
506                 }
507         }
508
509         return true;
510 }
511
512 bool
513 RouteUI::rec_enable_release (GdkEventButton*)
514 {
515         return true;
516 }
517
518 void
519 RouteUI::build_sends_menu ()
520 {
521         using namespace Menu_Helpers;
522
523         sends_menu = new Menu;
524         sends_menu->set_name ("ArdourContextMenu");
525         MenuList& items = sends_menu->items();
526
527         items.push_back (MenuElem(_("Assign all tracks (prefader)"), bind (mem_fun (*this, &RouteUI::create_sends), PreFader)));
528         items.push_back (MenuElem(_("Assign all tracks (postfader)"), bind (mem_fun (*this, &RouteUI::create_sends), PostFader)));
529         items.push_back (MenuElem(_("Assign selected tracks (prefader)"), bind (mem_fun (*this, &RouteUI::create_selected_sends), PreFader)));
530         items.push_back (MenuElem(_("Assign selected tracks (postfader)"), bind (mem_fun (*this, &RouteUI::create_selected_sends), PostFader)));
531         items.push_back (MenuElem(_("Copy track gains to sends"), mem_fun (*this, &RouteUI::set_sends_gain_from_track)));
532         items.push_back (MenuElem(_("Set sends gain to -inf"), mem_fun (*this, &RouteUI::set_sends_gain_to_zero)));
533         items.push_back (MenuElem(_("Set sends gain to 0dB"), mem_fun (*this, &RouteUI::set_sends_gain_to_unity)));
534
535 }
536
537 void
538 RouteUI::create_sends (Placement p)
539 {
540         _session.globally_add_internal_sends (_route, p);
541 }
542
543 void
544 RouteUI::create_selected_sends (Placement p)
545 {
546         boost::shared_ptr<RouteList> rlist (new RouteList);
547         TrackSelection& selected_tracks (ARDOUR_UI::instance()->the_editor().get_selection().tracks);
548
549         for (TrackSelection::iterator i = selected_tracks.begin(); i != selected_tracks.end(); ++i) {
550                 RouteTimeAxisView* rtv;
551                 RouteUI* rui;
552                 if ((rtv = dynamic_cast<RouteTimeAxisView*>(*i)) != 0) {
553                         if ((rui = dynamic_cast<RouteUI*>(rtv)) != 0) {
554                                 if (boost::dynamic_pointer_cast<AudioTrack>(rui->route())) {
555                                         rlist->push_back (rui->route());
556                                 }
557                         }
558                 }
559         }
560         
561         _session.add_internal_sends (_route, p, rlist);
562 }
563
564 void
565 RouteUI::set_sends_gain_from_track ()
566 {
567         _session.globally_set_send_gains_from_track (_route);
568 }
569
570 void
571 RouteUI::set_sends_gain_to_zero ()
572 {
573         _session.globally_set_send_gains_to_zero (_route);
574 }
575
576 void
577 RouteUI::set_sends_gain_to_unity ()
578 {
579         _session.globally_set_send_gains_to_unity (_route);
580 }
581
582 bool
583 RouteUI::show_sends_press(GdkEventButton* ev)
584 {
585         if (ev->type == GDK_2BUTTON_PRESS || ev->type == GDK_3BUTTON_PRESS ) {
586                 return true;
587         }
588
589         if (!ignore_toggle && !is_track() && show_sends_button) {
590
591                 if (Keyboard::is_button2_event (ev) && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
592
593                         // do nothing on midi bind event
594                         return false;
595
596                 } else if (Keyboard::is_context_menu_event (ev)) {
597
598                         if (sends_menu == 0) {
599                                 build_sends_menu ();
600                         }
601
602                         sends_menu->popup (0, ev->time);
603
604                 } else {
605
606                         /* change button state */
607
608                         show_sends_button->set_active (!show_sends_button->get_active());
609
610                         /* start blinking */
611
612                         if (show_sends_button->get_active()) {
613                                 /* show sends to this bus */
614                                 MixerStrip::SwitchIO (_route);
615                                 send_blink_connection = ARDOUR_UI::instance()->Blink.connect (mem_fun(*this, &RouteUI::send_blink));
616                         } else {
617                                 /* everybody back to normal */
618                                 send_blink_connection.disconnect ();
619                                 MixerStrip::SwitchIO (boost::shared_ptr<Route>());
620                         }
621
622                 }
623         }
624
625         return true;
626 }
627
628 bool
629 RouteUI::show_sends_release (GdkEventButton*)
630 {
631         return true;
632 }
633
634 void
635 RouteUI::send_blink (bool onoff)
636 {
637         if (!show_sends_button) {
638                 return;
639         }
640
641         if (onoff) {
642                 show_sends_button->set_state (STATE_ACTIVE);
643         } else {
644                 show_sends_button->set_state (STATE_NORMAL);
645         }
646 }
647
648 void
649 RouteUI::solo_changed(void* /*src*/)
650 {
651         Gtkmm2ext::UI::instance()->call_slot (mem_fun (*this, &RouteUI::update_solo_display));
652 }
653
654
655 void
656 RouteUI::listen_changed(void* /*src*/)
657 {
658         Gtkmm2ext::UI::instance()->call_slot (mem_fun (*this, &RouteUI::update_solo_display));
659 }
660
661 void
662 RouteUI::update_solo_display ()
663 {
664         bool x;
665
666         if (Config->get_solo_control_is_listen_control()) {
667
668                 if (solo_button->get_active() != (x = _route->listening())) {
669                         ignore_toggle = true;
670                         solo_button->set_active(x);
671                         ignore_toggle = false;
672                 }
673
674                 if (x) {
675                         solo_button->set_visual_state (1);
676                 } else {
677                         solo_button->set_visual_state (0);
678                 }
679
680
681         } else {
682
683                 if (solo_button->get_active() != (x = _route->soloed())){
684                         ignore_toggle = true;
685                         solo_button->set_active (x);
686                         ignore_toggle = false;
687                 }
688
689                 if (_route->solo_isolated()) {
690                         solo_button->set_visual_state (2);
691                 } else if (x) {
692                         solo_button->set_visual_state (1);
693                 } else {
694                         solo_button->set_visual_state (0);
695                 }
696         }
697 }
698
699 void
700 RouteUI::solo_changed_so_update_mute ()
701 {
702         Gtkmm2ext::UI::instance()->call_slot (mem_fun (*this, &RouteUI::update_mute_display));
703 }
704
705 void
706 RouteUI::mute_changed(void* /*src*/)
707 {
708         Gtkmm2ext::UI::instance()->call_slot (mem_fun (*this, &RouteUI::update_mute_display));
709 }
710
711 void
712 RouteUI::update_mute_display ()
713 {
714         bool model = _route->muted();
715         bool view = mute_button->get_active();
716
717         /* first make sure the button's "depressed" visual
718            is correct.
719         */
720
721         if (model != view) {
722                 ignore_toggle = true;
723                 mute_button->set_active (model);
724                 ignore_toggle = false;
725         }
726
727         /* now attend to visual state */
728
729         if (Config->get_show_solo_mutes()) {
730                 if (_route->muted()) {
731                         /* full mute */
732                         mute_button->set_visual_state (2);
733                 } else if (_session.soloing() && !_route->soloed() && !_route->solo_isolated()) {
734                         /* mute-because-not-soloed */
735                         mute_button->set_visual_state (1);
736                 } else {
737                         /* no mute at all */
738                         mute_button->set_visual_state (0);
739                 }
740         } else {
741                 if (_route->muted()) {
742                         /* full mute */
743                         mute_button->set_visual_state (2);
744                 } else {
745                         /* no mute at all */
746                         mute_button->set_visual_state (0);
747                 }
748         }
749
750 }
751
752 void
753 RouteUI::route_rec_enable_changed ()
754 {
755         Gtkmm2ext::UI::instance()->call_slot (mem_fun (*this, &RouteUI::update_rec_display));
756 }
757
758 void
759 RouteUI::session_rec_enable_changed ()
760 {
761         Gtkmm2ext::UI::instance()->call_slot (mem_fun (*this, &RouteUI::update_rec_display));
762 }
763
764 void
765 RouteUI::update_rec_display ()
766 {
767         bool model = _route->record_enabled();
768         bool view = rec_enable_button->get_active();
769
770         /* first make sure the button's "depressed" visual
771            is correct.
772         */
773
774         if (model != view) {
775                 ignore_toggle = true;
776                 rec_enable_button->set_active (model);
777                 ignore_toggle = false;
778         }
779         else {
780                 return;
781         }
782
783         /* now make sure its color state is correct */
784
785         if (model) {
786
787                 switch (_session.record_status ()) {
788                 case Session::Recording:
789                         rec_enable_button->set_visual_state (1);
790                         break;
791
792                 case Session::Disabled:
793                 case Session::Enabled:
794                         rec_enable_button->set_visual_state (2);
795                         break;
796
797                 }
798
799         } else {
800                 rec_enable_button->set_visual_state (0);
801         }
802 }
803
804 void
805 RouteUI::build_solo_menu (void)
806 {
807         using namespace Menu_Helpers;
808
809         solo_menu = new Menu;
810         solo_menu->set_name ("ArdourContextMenu");
811         MenuList& items = solo_menu->items();
812         CheckMenuItem* check;
813
814         check = new CheckMenuItem(_("Solo Isolate"));
815         check->set_active (_route->solo_isolated());
816         check->signal_toggled().connect (bind (mem_fun (*this, &RouteUI::toggle_solo_isolated), check));
817         _route->solo_isolated_changed.connect(bind (mem_fun (*this, &RouteUI::solo_isolated_toggle), check));
818         items.push_back (CheckMenuElem(*check));
819         check->show_all();
820
821         check = new CheckMenuItem(_("Solo Safe"));
822         check->set_active (_route->solo_safe());
823         check->signal_toggled().connect (bind (mem_fun (*this, &RouteUI::toggle_solo_safe), check));
824         _route->solo_safe_changed.connect(bind (mem_fun (*this, &RouteUI::solo_safe_toggle), check));
825         items.push_back (CheckMenuElem(*check));
826         check->show_all();
827
828         //items.push_back (SeparatorElem());
829         // items.push_back (MenuElem (_("MIDI Bind"), mem_fun (*mute_button, &BindableToggleButton::midi_learn)));
830
831 }
832
833 void
834 RouteUI::build_mute_menu(void)
835 {
836         using namespace Menu_Helpers;
837
838         mute_menu = new Menu;
839         mute_menu->set_name ("ArdourContextMenu");
840
841         MenuList& items = mute_menu->items();
842
843         pre_fader_mute_check = manage (new CheckMenuItem(_("Pre Fader")));
844         init_mute_menu(MuteMaster::PreFader, pre_fader_mute_check);
845         pre_fader_mute_check->signal_toggled().connect(bind (mem_fun (*this, &RouteUI::toggle_mute_menu), MuteMaster::PreFader, pre_fader_mute_check));
846         items.push_back (CheckMenuElem(*pre_fader_mute_check));
847         pre_fader_mute_check->show_all();
848
849         post_fader_mute_check = manage (new CheckMenuItem(_("Post Fader")));
850         init_mute_menu(MuteMaster::PostFader, post_fader_mute_check);
851         post_fader_mute_check->signal_toggled().connect(bind (mem_fun (*this, &RouteUI::toggle_mute_menu), MuteMaster::PostFader, post_fader_mute_check));
852         items.push_back (CheckMenuElem(*post_fader_mute_check));
853         post_fader_mute_check->show_all();
854
855         listen_mute_check = manage (new CheckMenuItem(_("Control Outs")));
856         init_mute_menu(MuteMaster::Listen, listen_mute_check);
857         listen_mute_check->signal_toggled().connect(bind (mem_fun (*this, &RouteUI::toggle_mute_menu), MuteMaster::Listen, listen_mute_check));
858         items.push_back (CheckMenuElem(*listen_mute_check));
859         listen_mute_check->show_all();
860
861         main_mute_check = manage (new CheckMenuItem(_("Main Outs")));
862         init_mute_menu(MuteMaster::Main, main_mute_check);
863         main_mute_check->signal_toggled().connect(bind (mem_fun (*this, &RouteUI::toggle_mute_menu), MuteMaster::Main, main_mute_check));
864         items.push_back (CheckMenuElem(*main_mute_check));
865         main_mute_check->show_all();
866
867         //items.push_back (SeparatorElem());
868         // items.push_back (MenuElem (_("MIDI Bind"), mem_fun (*mute_button, &BindableToggleButton::midi_learn)));
869
870         _route->mute_points_changed.connect (mem_fun (*this, &RouteUI::muting_change));
871 }
872
873 void
874 RouteUI::init_mute_menu(MuteMaster::MutePoint mp, CheckMenuItem* check)
875 {
876         check->set_active (_route->mute_points() & mp);
877 }
878
879 void
880 RouteUI::toggle_mute_menu(MuteMaster::MutePoint mp, Gtk::CheckMenuItem* check)
881 {
882         if (check->get_active()) {
883                 _route->set_mute_points (MuteMaster::MutePoint (_route->mute_points() | mp));
884         } else {
885                 _route->set_mute_points (MuteMaster::MutePoint (_route->mute_points() & ~mp));
886         }
887 }
888
889 void
890 RouteUI::muting_change ()
891 {
892         ENSURE_GUI_THREAD(mem_fun (*this, &RouteUI::muting_change));
893
894         bool yn;
895         MuteMaster::MutePoint current = _route->mute_points ();
896
897         yn = (current & MuteMaster::PreFader);
898
899         if (pre_fader_mute_check->get_active() != yn) {
900                 pre_fader_mute_check->set_active (yn);
901         }
902
903         yn = (current & MuteMaster::PostFader);
904
905         if (post_fader_mute_check->get_active() != yn) {
906                 post_fader_mute_check->set_active (yn);
907         }
908
909         yn = (current & MuteMaster::Listen);
910
911         if (listen_mute_check->get_active() != yn) {
912                 listen_mute_check->set_active (yn);
913         }
914
915         yn = (current & MuteMaster::Main);
916
917         if (main_mute_check->get_active() != yn) {
918                 main_mute_check->set_active (yn);
919         }
920 }
921
922 void
923 RouteUI::toggle_solo_isolated (Gtk::CheckMenuItem* check)
924 {
925         _route->set_solo_isolated (check->get_active(), this);
926 }
927
928 void
929 RouteUI::toggle_solo_safe (Gtk::CheckMenuItem* check)
930 {
931         _route->set_solo_safe (check->get_active(), this);
932 }
933
934 void
935 RouteUI::set_route_group_solo(boost::shared_ptr<Route> route, bool yn)
936 {
937         RouteGroup* route_group;
938
939         if((route_group = route->route_group()) != 0){
940                 _session.begin_reversible_command (_("mix group solo  change"));
941                 Session::GlobalSoloStateCommand *cmd = new Session::GlobalSoloStateCommand(_session, this);
942                 route_group->apply(&Route::set_solo, yn, this);
943                 cmd->mark();
944                 _session.add_command (cmd);
945                 _session.commit_reversible_command ();
946         } else {
947                 reversibly_apply_route_boolean ("solo change", &Route::set_solo, !route->soloed(), this);
948         }
949 }
950
951 void
952 RouteUI::reversibly_apply_route_boolean (string name, void (Route::*func)(bool, void *), bool yn, void *arg)
953 {
954         _session.begin_reversible_command (name);
955         XMLNode &before = _route->get_state();
956         bind(mem_fun(*_route, func), yn, arg)();
957         XMLNode &after = _route->get_state();
958         _session.add_command (new MementoCommand<Route>(*_route, &before, &after));
959         _session.commit_reversible_command ();
960 }
961
962 void
963 RouteUI::reversibly_apply_track_boolean (string name, void (Track::*func)(bool, void *), bool yn, void *arg)
964 {
965         _session.begin_reversible_command (name);
966         XMLNode &before = track()->get_state();
967         bind (mem_fun (*track(), func), yn, arg)();
968         XMLNode &after = track()->get_state();
969         _session.add_command (new MementoCommand<Track>(*track(), &before, &after));
970         _session.commit_reversible_command ();
971 }
972
973 void
974 RouteUI::set_route_group_mute(boost::shared_ptr<Route> route, bool yn)
975 {
976         RouteGroup* route_group;
977
978         if((route_group = route->route_group()) != 0){
979                 _session.begin_reversible_command (_("mix group mute change"));
980                 Session::GlobalMuteStateCommand *cmd = new Session::GlobalMuteStateCommand (_session, this);
981                 route_group->apply(&Route::set_mute, yn, this);
982                 cmd->mark();
983                 _session.add_command(cmd);
984                 _session.commit_reversible_command ();
985         } else {
986                 reversibly_apply_route_boolean ("mute change", &Route::set_mute, !route->muted(), this);
987         }
988 }
989
990 void
991 RouteUI::set_route_group_rec_enable(boost::shared_ptr<Route> route, bool yn)
992 {
993         RouteGroup* route_group;
994
995         if((route_group = route->route_group()) != 0){
996                 _session.begin_reversible_command (_("mix group rec-enable change"));
997                 Session::GlobalRecordEnableStateCommand *cmd = new Session::GlobalRecordEnableStateCommand(_session, this);
998                 route_group->apply (&Route::set_record_enable, yn, this);
999                 cmd->mark();
1000                 _session.add_command(cmd);
1001                 _session.commit_reversible_command ();
1002         } else {
1003                 reversibly_apply_route_boolean ("rec-enable change", &Route::set_record_enable, !_route->record_enabled(), this);
1004         }
1005 }
1006
1007
1008 bool
1009 RouteUI::choose_color()
1010 {
1011         bool picked;
1012         Gdk::Color color;
1013
1014         color = Gtkmm2ext::UI::instance()->get_color (_("ardour: color selection"), picked, &_color);
1015
1016         if (picked) {
1017                 set_color (color);
1018         }
1019
1020         return picked;
1021 }
1022
1023 void
1024 RouteUI::set_color (const Gdk::Color & c)
1025 {
1026         char buf[64];
1027
1028         _color = c;
1029
1030         ensure_xml_node ();
1031         snprintf (buf, sizeof (buf), "%d:%d:%d", c.get_red(), c.get_green(), c.get_blue());
1032         xml_node->add_property ("color", buf);
1033
1034         _route->gui_changed ("color", (void *) 0); /* EMIT_SIGNAL */
1035 }
1036
1037
1038 void
1039 RouteUI::ensure_xml_node ()
1040 {
1041         if (xml_node == 0) {
1042                 if ((xml_node = _route->extra_xml ("GUI")) == 0) {
1043                         xml_node = new XMLNode ("GUI");
1044                         _route->add_extra_xml (*xml_node);
1045                 }
1046         }
1047 }
1048
1049 XMLNode*
1050 RouteUI::get_automation_child_xml_node (Evoral::Parameter param)
1051 {
1052         ensure_xml_node ();
1053
1054         XMLNodeList kids = xml_node->children();
1055         XMLNodeConstIterator iter;
1056
1057         const string sym = ARDOUR::EventTypeMap::instance().to_symbol(param);
1058
1059         for (iter = kids.begin(); iter != kids.end(); ++iter) {
1060                 if ((*iter)->name() == AutomationTimeAxisView::state_node_name) {
1061                         XMLProperty* type = (*iter)->property("automation-id");
1062                         if (type && type->value() == sym)
1063                                 return *iter;
1064                 }
1065         }
1066
1067         // Didn't find it, make a new one
1068         XMLNode* child = new XMLNode (AutomationTimeAxisView::state_node_name);
1069         child->add_property("automation-id", sym);
1070         xml_node->add_child_nocopy (*child);
1071
1072         return child;
1073 }
1074
1075 int
1076 RouteUI::set_color_from_route ()
1077 {
1078         XMLProperty *prop;
1079
1080         RouteUI::ensure_xml_node ();
1081
1082         if ((prop = xml_node->property ("color")) != 0) {
1083                 int r, g, b;
1084                 sscanf (prop->value().c_str(), "%d:%d:%d", &r, &g, &b);
1085                 _color.set_red(r);
1086                 _color.set_green(g);
1087                 _color.set_blue(b);
1088                 return 0;
1089         }
1090         return 1;
1091 }
1092
1093 void
1094 RouteUI::remove_this_route ()
1095 {
1096         vector<string> choices;
1097         string prompt;
1098
1099         if (is_track()) {
1100                 prompt  = string_compose (_("Do you really want to remove track \"%1\" ?\n\nYou may also lose the playlist used by this track.\n(cannot be undone)"), _route->name());
1101         } else {
1102                 prompt  = string_compose (_("Do you really want to remove bus \"%1\" ?\n(cannot be undone)"), _route->name());
1103         }
1104
1105         choices.push_back (_("No, do nothing."));
1106         choices.push_back (_("Yes, remove it."));
1107
1108         Choice prompter (prompt, choices);
1109
1110         if (prompter.run () == 1) {
1111                 Glib::signal_idle().connect (bind (sigc::ptr_fun (&RouteUI::idle_remove_this_route), this));
1112         }
1113 }
1114
1115 gint
1116 RouteUI::idle_remove_this_route (RouteUI *rui)
1117 {
1118         rui->_session.remove_route (rui->_route);
1119         return false;
1120 }
1121
1122 void
1123 RouteUI::route_rename ()
1124 {
1125         ArdourPrompter name_prompter (true);
1126         string result;
1127         name_prompter.set_prompt (_("New Name: "));
1128         name_prompter.set_initial_text (_route->name());
1129         name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
1130         name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
1131         name_prompter.show_all ();
1132
1133         switch (name_prompter.run ()) {
1134
1135         case Gtk::RESPONSE_ACCEPT:
1136         name_prompter.get_result (result);
1137         if (result.length()) {
1138                         _route->set_name (result);
1139                 }
1140                 break;
1141         }
1142
1143         return;
1144
1145 }
1146
1147 void
1148 RouteUI::name_changed ()
1149 {
1150         ENSURE_GUI_THREAD(sigc::mem_fun(*this, &RouteUI::name_changed));
1151
1152         name_label.set_text (_route->name());
1153 }
1154
1155 void
1156 RouteUI::toggle_route_active ()
1157 {
1158         bool yn;
1159
1160         if (route_active_menu_item) {
1161                 if (route_active_menu_item->get_active() != (yn = _route->active())) {
1162                         _route->set_active (!yn);
1163                 }
1164         }
1165 }
1166
1167 void
1168 RouteUI::route_active_changed ()
1169 {
1170         if (route_active_menu_item) {
1171                 Gtkmm2ext::UI::instance()->call_slot (bind (mem_fun (*route_active_menu_item, &CheckMenuItem::set_active), _route->active()));
1172         }
1173 }
1174
1175 void
1176 RouteUI::toggle_polarity ()
1177 {
1178         if (polarity_menu_item) {
1179
1180                 bool x;
1181
1182                 ENSURE_GUI_THREAD(mem_fun (*this, &RouteUI::toggle_polarity));
1183
1184                 if ((x = polarity_menu_item->get_active()) != _route->phase_invert()) {
1185                         _route->set_phase_invert (x);
1186                         if (x) {
1187                                 name_label.set_text (X_("Ø ") + name_label.get_text());
1188                         } else {
1189                                 name_label.set_text (_route->name());
1190                         }
1191                 }
1192         }
1193 }
1194
1195 void
1196 RouteUI::polarity_changed ()
1197 {
1198         if (_route->phase_invert()) {
1199                 name_label.set_text (X_("Ø ") + name_label.get_text());
1200         } else {
1201                 name_label.set_text (_route->name());
1202         }
1203 }
1204
1205 void
1206 RouteUI::toggle_denormal_protection ()
1207 {
1208         if (denormal_menu_item) {
1209
1210                 bool x;
1211
1212                 ENSURE_GUI_THREAD(mem_fun (*this, &RouteUI::toggle_denormal_protection));
1213
1214                 if ((x = denormal_menu_item->get_active()) != _route->denormal_protection()) {
1215                         _route->set_denormal_protection (x);
1216                 }
1217         }
1218 }
1219
1220 void
1221 RouteUI::denormal_protection_changed ()
1222 {
1223         if (denormal_menu_item) {
1224                 denormal_menu_item->set_active (_route->denormal_protection());
1225         }
1226 }
1227
1228 void
1229 RouteUI::solo_isolated_toggle(void* /*src*/, Gtk::CheckMenuItem* check)
1230 {
1231         bool yn = _route->solo_isolated ();
1232
1233         if (check->get_active() != yn) {
1234                 check->set_active (yn);
1235         }
1236 }
1237
1238
1239 void
1240 RouteUI::solo_safe_toggle(void* /*src*/, Gtk::CheckMenuItem* check)
1241 {
1242         bool yn = _route->solo_safe ();
1243
1244         if (check->get_active() != yn) {
1245                 check->set_active (yn);
1246         }
1247 }
1248
1249 void
1250 RouteUI::disconnect_input ()
1251 {
1252         _route->input()->disconnect (this);
1253 }
1254
1255 void
1256 RouteUI::disconnect_output ()
1257 {
1258         _route->output()->disconnect (this);
1259 }
1260
1261 bool
1262 RouteUI::is_track () const
1263 {
1264         return boost::dynamic_pointer_cast<Track>(_route) != 0;
1265 }
1266
1267 boost::shared_ptr<Track>
1268 RouteUI::track() const
1269 {
1270         return boost::dynamic_pointer_cast<Track>(_route);
1271 }
1272
1273 bool
1274 RouteUI::is_audio_track () const
1275 {
1276         return boost::dynamic_pointer_cast<AudioTrack>(_route) != 0;
1277 }
1278
1279 boost::shared_ptr<AudioTrack>
1280 RouteUI::audio_track() const
1281 {
1282         return boost::dynamic_pointer_cast<AudioTrack>(_route);
1283 }
1284
1285 bool
1286 RouteUI::is_midi_track () const
1287 {
1288         return boost::dynamic_pointer_cast<MidiTrack>(_route) != 0;
1289 }
1290
1291 boost::shared_ptr<MidiTrack>
1292 RouteUI::midi_track() const
1293 {
1294         return boost::dynamic_pointer_cast<MidiTrack>(_route);
1295 }
1296
1297 boost::shared_ptr<Diskstream>
1298 RouteUI::get_diskstream () const
1299 {
1300         boost::shared_ptr<Track> t;
1301
1302         if ((t = boost::dynamic_pointer_cast<Track>(_route)) != 0) {
1303                 return t->diskstream();
1304         } else {
1305                 return boost::shared_ptr<Diskstream> ((Diskstream*) 0);
1306         }
1307 }
1308
1309 string
1310 RouteUI::name() const
1311 {
1312         return _route->name();
1313 }
1314
1315 void
1316 RouteUI::map_frozen ()
1317 {
1318         ENSURE_GUI_THREAD (mem_fun (*this, &RouteUI::map_frozen));
1319
1320         AudioTrack* at = dynamic_cast<AudioTrack*>(_route.get());
1321
1322         if (at) {
1323                 switch (at->freeze_state()) {
1324                 case AudioTrack::Frozen:
1325                         rec_enable_button->set_sensitive (false);
1326                         break;
1327                 default:
1328                         rec_enable_button->set_sensitive (true);
1329                         break;
1330                 }
1331         }
1332 }
1333
1334 void
1335 RouteUI::adjust_latency ()
1336 {
1337         LatencyDialog dialog (_route->name() + _(" latency"), *(_route->output()), _session.frame_rate(), _session.engine().frames_per_cycle());
1338 }
1339
1340 void
1341 RouteUI::save_as_template ()
1342 {
1343         sys::path path;
1344         Glib::ustring safe_name;
1345         string name;
1346
1347         path = ARDOUR::user_route_template_directory ();
1348
1349         if (g_mkdir_with_parents (path.to_string().c_str(), 0755)) {
1350                 error << string_compose (_("Cannot create route template directory %1"), path.to_string()) << endmsg;
1351                 return;
1352         }
1353
1354         Prompter p (true); // modal
1355
1356         p.set_prompt (_("Template name:"));
1357         switch (p.run()) {
1358         case RESPONSE_ACCEPT:
1359                 break;
1360         default:
1361                 return;
1362         }
1363
1364         p.hide ();
1365         p.get_result (name, true);
1366
1367         safe_name = legalize_for_path (name);
1368         safe_name += template_suffix;
1369
1370         path /= safe_name;
1371
1372         _route->save_as_template (path.to_string(), name);
1373 }
1374
1375 void
1376 RouteUI::check_rec_enable_sensitivity ()
1377 {
1378         if (_session.transport_rolling() && rec_enable_button->get_active() && Config->get_disable_disarm_during_roll()) {
1379                 rec_enable_button->set_sensitive (false);
1380         } else {
1381                 rec_enable_button->set_sensitive (true);
1382         }
1383 }
1384
1385 void
1386 RouteUI::parameter_changed (string const & p)
1387 {
1388         ENSURE_GUI_THREAD (bind (mem_fun (*this, &RouteUI::parameter_changed), p));
1389
1390         if (p == "disable-disarm-during-roll") {
1391                 check_rec_enable_sensitivity ();
1392         } else if (p == "solo-control-is-listen-control") {
1393                 set_button_names ();
1394         } else if (p == "listen-position") {
1395                 set_button_names ();
1396         }
1397 }
1398
1399 void
1400 RouteUI::step_gain_up ()
1401 {
1402         _route->set_gain (dB_to_coefficient (accurate_coefficient_to_dB (_route->gain_control()->get_value()) + 0.1), this);
1403 }
1404
1405 void
1406 RouteUI::page_gain_up ()
1407 {
1408         _route->set_gain (dB_to_coefficient (accurate_coefficient_to_dB (_route->gain_control()->get_value()) + 0.5), this);
1409 }
1410
1411 void
1412 RouteUI::step_gain_down ()
1413 {
1414         _route->set_gain (dB_to_coefficient (accurate_coefficient_to_dB (_route->gain_control()->get_value()) - 0.1), this);
1415 }
1416
1417 void
1418 RouteUI::page_gain_down ()
1419 {
1420         _route->set_gain (dB_to_coefficient (accurate_coefficient_to_dB (_route->gain_control()->get_value()) - 0.5), this);
1421 }
1422
1423 void
1424 RouteUI::open_remote_control_id_dialog ()
1425 {
1426         ArdourDialog dialog (_("Remote Control ID"));
1427
1428         uint32_t const limit = _session.ntracks() + _session.nbusses () + 4;
1429
1430         HBox* hbox = manage (new HBox);
1431         hbox->set_spacing (6);
1432         hbox->pack_start (*manage (new Label (_("Remote control ID:"))));
1433         SpinButton* spin = manage (new SpinButton);
1434         spin->set_digits (0);
1435         spin->set_increments (1, 10);
1436         spin->set_range (0, limit);
1437         spin->set_value (_route->remote_control_id());
1438         hbox->pack_start (*spin);
1439         dialog.get_vbox()->pack_start (*hbox);
1440
1441         dialog.add_button (Stock::CANCEL, RESPONSE_CANCEL);
1442         dialog.add_button (Stock::APPLY, RESPONSE_ACCEPT);
1443
1444         dialog.show_all ();
1445         int const r = dialog.run ();
1446
1447         if (r == RESPONSE_ACCEPT) {
1448                 _route->set_remote_control_id (spin->get_value_as_int ());
1449         }
1450 }