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