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/choice.h>
  22 #include <gtkmm2ext/doi.h>
  23 #include <gtkmm2ext/bindable_button.h>
  24 #include <gtkmm2ext/barcontroller.h>
  25 #include <gtkmm2ext/gtk_ui.h>
  26
  27 #include "ardour/route_group.h"
  28 #include "ardour/dB.h"
  29 #include "pbd/memento_command.h"
  30 #include "pbd/stacktrace.h"
  31 #include "pbd/controllable.h"
  32 #include "pbd/enumwriter.h"
  33
  34 #include "ardour_ui.h"
  35 #include "editor.h"
  36 #include "route_ui.h"
  37 #include "led.h"
  38 #include "keyboard.h"
  39 #include "utils.h"
  40 #include "prompter.h"
  41 #include "gui_thread.h"
  42 #include "ardour_dialog.h"
  43 #include "latency_gui.h"
  44 #include "mixer_strip.h"
  45 #include "automation_time_axis.h"
  46 #include "route_time_axis.h"
  47
  48 #include "ardour/route.h"
  49 #include "ardour/event_type_map.h"
  50 #include "ardour/session.h"
  51 #include "ardour/audioengine.h"
  52 #include "ardour/audio_track.h"
  53 #include "ardour/midi_track.h"
  54 #include "ardour/template_utils.h"
  55 #include "ardour/filename_extensions.h"
  56 #include "ardour/directory_names.h"
  57 #include "ardour/profile.h"
  58
  59 #include "i18n.h"
  60 using namespace Gtk;
  61 using namespace Gtkmm2ext;
  62 using namespace ARDOUR;
  63 using namespace PBD;
  64
  65 uint32_t RouteUI::_max_invert_buttons = 3;
  66
  67 RouteUI::RouteUI (ARDOUR::Session* sess)
  68         : AxisView(sess)
  69 {
  70         init ();
  71 }
  72
  73 RouteUI::RouteUI (boost::shared_ptr<ARDOUR::Route> rt, ARDOUR::Session* sess)
  74         : AxisView(sess)
  75 {
  76         init ();
  77         set_route (rt);
  78 }
  79
  80 RouteUI::~RouteUI()
  81 {
  82         _route.reset (); /* drop reference to route, so that it can be cleaned up */
  83         route_connections.drop_connections ();
  84
  85         delete solo_menu;
  86         delete mute_menu;
  87         delete sends_menu;
  88         delete record_menu;
  89         delete _invert_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         record_menu = 0;
 101         _invert_menu = 0;
 102         pre_fader_mute_check = 0;
 103         post_fader_mute_check = 0;
 104         listen_mute_check = 0;
 105         main_mute_check = 0;
 106         solo_safe_check = 0;
 107         solo_isolated_check = 0;
 108         solo_isolated_led = 0;
 109         solo_safe_led = 0;
 110         _solo_release = 0;
 111         _mute_release = 0;
 112         route_active_menu_item = 0;
 113         denormal_menu_item = 0;
 114         step_edit_item = 0;
 115         multiple_mute_change = false;
 116         multiple_solo_change = false;
 117         _i_am_the_modifier = 0;
 118
 119         setup_invert_buttons ();
 120
 121         mute_button = manage (new BindableToggleButton ());
 122         // mute_button->set_self_managed (true);
 123         mute_button->set_name ("MuteButton");
 124         mute_button->add (mute_button_label);
 125         mute_button_label.show ();
 126         UI::instance()->set_tip (mute_button, _("Mute this track"), "");
 127
 128         solo_button = manage (new BindableToggleButton ());
 129         // solo_button->set_self_managed (true);
 130         solo_button->set_name ("SoloButton");
 131         solo_button->add (solo_button_label);
 132         solo_button_label.show ();
 133         UI::instance()->set_tip (solo_button, _("Mute other (non-soloed) tracks"), "");
 134         solo_button->set_no_show_all (true);
 135
 136         rec_enable_button = manage (new BindableToggleButton ());
 137         rec_enable_button->set_name ("RecordEnableButton");
 138         // rec_enable_button->set_self_managed (true);
 139         rec_enable_button->add (rec_enable_button_label);
 140         rec_enable_button_label.show ();
 141         UI::instance()->set_tip (rec_enable_button, _("Enable recording on this track"), "");
 142
 143         show_sends_button = manage (new BindableToggleButton (""));
 144         show_sends_button->set_name ("SendAlert");
 145         // show_sends_button->set_self_managed (true);
 146         UI::instance()->set_tip (show_sends_button, _("make mixer strips show sends to this bus"), "");
 147
 148         _session->SoloChanged.connect (_session_connections, invalidator (*this), boost::bind (&RouteUI::solo_changed_so_update_mute, this), gui_context());
 149         _session->TransportStateChange.connect (_session_connections, invalidator (*this), boost::bind (&RouteUI::check_rec_enable_sensitivity, this), gui_context());
 150         _session->RecordStateChanged.connect (_session_connections, invalidator (*this), boost::bind (&RouteUI::session_rec_enable_changed, this), gui_context());
 151
 152         Config->ParameterChanged.connect (*this, invalidator (*this), ui_bind (&RouteUI::parameter_changed, this, _1), gui_context());
 153
 154         rec_enable_button->signal_button_press_event().connect (sigc::mem_fun(*this, &RouteUI::rec_enable_press), false);
 155         rec_enable_button->signal_button_release_event().connect (sigc::mem_fun(*this, &RouteUI::rec_enable_release), false);
 156
 157         show_sends_button->signal_button_press_event().connect (sigc::mem_fun(*this, &RouteUI::show_sends_press), false);
 158         show_sends_button->signal_button_release_event().connect (sigc::mem_fun(*this, &RouteUI::show_sends_release));
 159
 160         solo_button->signal_button_press_event().connect (sigc::mem_fun(*this, &RouteUI::solo_press), false);
 161         solo_button->signal_button_release_event().connect (sigc::mem_fun(*this, &RouteUI::solo_release), false);
 162         mute_button->signal_button_press_event().connect (sigc::mem_fun(*this, &RouteUI::mute_press), false);
 163         mute_button->signal_button_release_event().connect (sigc::mem_fun(*this, &RouteUI::mute_release), false);
 164 }
 165
 166 void
 167 RouteUI::reset ()
 168 {
 169         route_connections.drop_connections ();
 170
 171         delete solo_menu;
 172         solo_menu = 0;
 173
 174         delete mute_menu;
 175         mute_menu = 0;
 176
 177         if (xml_node) {
 178                 /* do not delete the node - its owned by the route */
 179                 xml_node = 0;
 180         }
 181
 182         route_active_menu_item = 0;
 183         denormal_menu_item = 0;
 184 }
 185
 186 void
 187 RouteUI::self_delete ()
 188 {
 189         /* This may be called from a non-GUI thread. Keep it safe */
 190
 191         delete_when_idle (this);
 192 }
 193
 194 void
 195 RouteUI::set_route (boost::shared_ptr<Route> rp)
 196 {
 197         reset ();
 198
 199         _route = rp;
 200
 201         if (set_color_from_route()) {
 202                 set_color (unique_random_color());
 203         }
 204
 205         if (self_destruct) {
 206                 rp->DropReferences.connect (route_connections, invalidator (*this), boost::bind (&RouteUI::self_delete, this), gui_context());
 207         }
 208
 209         mute_button->set_controllable (_route->mute_control());
 210         solo_button->set_controllable (_route->solo_control());
 211
 212         _route->active_changed.connect (route_connections, invalidator (*this), boost::bind (&RouteUI::route_active_changed, this), gui_context());
 213         _route->mute_changed.connect (route_connections, invalidator (*this), ui_bind (&RouteUI::mute_changed, this, _1), gui_context());
 214
 215         _route->solo_changed.connect (route_connections, invalidator (*this), boost::bind (&RouteUI::update_solo_display, this), gui_context());
 216         _route->solo_safe_changed.connect (route_connections, invalidator (*this), boost::bind (&RouteUI::update_solo_display, this), gui_context());
 217         _route->listen_changed.connect (route_connections, invalidator (*this), boost::bind (&RouteUI::update_solo_display, this), gui_context());
 218         _route->solo_isolated_changed.connect (route_connections, invalidator (*this), boost::bind (&RouteUI::update_solo_display, this), gui_context());
 219
 220         _route->phase_invert_changed.connect (route_connections, invalidator (*this), boost::bind (&RouteUI::polarity_changed, this), gui_context());
 221         _route->PropertyChanged.connect (route_connections, invalidator (*this), ui_bind (&RouteUI::property_changed, this, _1), gui_context());
 222
 223         _route->io_changed.connect (route_connections, invalidator (*this), ui_bind (&RouteUI::setup_invert_buttons, this), gui_context ());
 224
 225         if (_session->writable() && is_track()) {
 226                 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(_route);
 227
 228                 t->RecordEnableChanged.connect (route_connections, invalidator (*this), boost::bind (&RouteUI::route_rec_enable_changed, this), gui_context());
 229
 230                 rec_enable_button->show();
 231                 rec_enable_button->set_controllable (t->rec_enable_control());
 232
 233                 update_rec_display ();
 234
 235                 if (is_midi_track()) {
 236                         midi_track()->StepEditStatusChange.connect (route_connections, invalidator (*this),
 237                                                                     ui_bind (&RouteUI::step_edit_changed, this, _1), gui_context());
 238                 }
 239
 240         }
 241
 242         mute_button->unset_flags (Gtk::CAN_FOCUS);
 243         solo_button->unset_flags (Gtk::CAN_FOCUS);
 244
 245         mute_button->show();
 246
 247         if (_route->is_monitor()) {
 248                 solo_button->hide ();
 249         } else {
 250                 solo_button->show();
 251         }
 252
 253         map_frozen ();
 254
 255         setup_invert_buttons ();
 256         set_invert_button_state ();
 257 }
 258
 259 void
 260 RouteUI::polarity_changed ()
 261 {
 262         if (!_route) {
 263                 return;
 264         }
 265
 266         set_invert_button_state ();
 267 }
 268
 269 bool
 270 RouteUI::mute_press (GdkEventButton* ev)
 271 {
 272         if (ev->type == GDK_2BUTTON_PRESS || ev->type == GDK_3BUTTON_PRESS ) {
 273                 return true;
 274         }
 275
 276         multiple_mute_change = false;
 277
 278         if (!_i_am_the_modifier) {
 279
 280                 if (Keyboard::is_context_menu_event (ev)) {
 281
 282                         if (mute_menu == 0){
 283                                 build_mute_menu();
 284                         }
 285
 286                         mute_menu->popup(0,ev->time);
 287
 288                 } else {
 289
 290                         if (Keyboard::is_button2_event (ev)) {
 291                                 // Primary-button2 click is the midi binding click
 292                                 // button2-click is "momentary"
 293
 294
 295                                 if (mute_button->on_button_press_event (ev)) {
 296                                         return true;
 297                                 }
 298
 299                                 _mute_release = new SoloMuteRelease (_route->muted ());
 300                         }
 301
 302                         if (ev->button == 1 || Keyboard::is_button2_event (ev)) {
 303
 304                                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
 305
 306                                         if (_mute_release) {
 307                                                 _mute_release->routes = _session->get_routes ();
 308                                         }
 309
 310                                         _session->set_mute (_session->get_routes(), !_route->muted());
 311
 312                                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 313
 314                                         /* Primary-button1 applies change to the mix group even if it is not active
 315                                            NOTE: Primary-button2 is MIDI learn.
 316                                         */
 317
 318                                         if (ev->button == 1 && _route->route_group()) {
 319                                                 if (_mute_release) {
 320                                                         _mute_release->routes = _session->get_routes ();
 321                                                 }
 322
 323                                                 _session->set_mute (_session->get_routes(), !_route->muted(), Session::rt_cleanup, true);
 324                                         }
 325
 326                                 } else {
 327
 328                                         /* plain click applies change to this route */
 329
 330                                         boost::shared_ptr<RouteList> rl (new RouteList);
 331                                         rl->push_back (_route);
 332
 333                                         if (_mute_release) {
 334                                                 _mute_release->routes = rl;
 335                                         }
 336
 337                                         _session->set_mute (rl, !_route->muted());
 338
 339                                 }
 340                         }
 341                 }
 342
 343         }
 344
 345         return true;
 346 }
 347
 348 bool
 349 RouteUI::mute_release (GdkEventButton*)
 350 {
 351         if (!_i_am_the_modifier) {
 352                 if (_mute_release){
 353                         _session->set_mute (_mute_release->routes, _mute_release->active, Session::rt_cleanup, true);
 354                         delete _mute_release;
 355                         _mute_release = 0;
 356                 }
 357         }
 358
 359         return true;
 360 }
 361
 362 bool
 363 RouteUI::solo_press(GdkEventButton* ev)
 364 {
 365         /* ignore double/triple clicks */
 366
 367         if (ev->type == GDK_2BUTTON_PRESS || ev->type == GDK_3BUTTON_PRESS ) {
 368                 return true;
 369         }
 370
 371         multiple_solo_change = false;
 372
 373         if (!_i_am_the_modifier) {
 374
 375                 if (Keyboard::is_context_menu_event (ev)) {
 376
 377                         if (!solo_isolated_led) {
 378
 379                                 if (solo_menu == 0) {
 380                                         build_solo_menu ();
 381                                 }
 382
 383                                 solo_menu->popup (1, ev->time);
 384                         }
 385
 386                 } else {
 387
 388                         if (Keyboard::is_button2_event (ev)) {
 389
 390                                 // Primary-button2 click is the midi binding click
 391                                 // button2-click is "momentary"
 392
 393                                 if (solo_button->on_button_press_event (ev)) {
 394                                         return true;
 395                                 }
 396
 397                                 _solo_release = new SoloMuteRelease (_route->self_soloed());
 398                         }
 399
 400                         if (ev->button == 1 || Keyboard::is_button2_event (ev)) {
 401
 402                                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
 403
 404                                         /* Primary-Tertiary-click applies change to all routes */
 405
 406                                         if (_solo_release) {
 407                                                 _solo_release->routes = _session->get_routes ();
 408                                         }
 409
 410                                         if (Config->get_solo_control_is_listen_control()) {
 411                                                 _session->set_listen (_session->get_routes(), !_route->listening_via_monitor(),  Session::rt_cleanup, true);
 412                                         } else {
 413                                                 _session->set_solo (_session->get_routes(), !_route->self_soloed(),  Session::rt_cleanup, true);
 414                                         }
 415
 416                                 } else if (Keyboard::modifier_state_contains (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::SecondaryModifier))) {
 417
 418                                         // Primary-Secondary-click: exclusively solo this track
 419
 420                                         if (_solo_release) {
 421                                                 _solo_release->exclusive = true;
 422
 423                                                 boost::shared_ptr<RouteList> routes = _session->get_routes();
 424
 425                                                 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 426                                                         if ((*i)->soloed ()) {
 427                                                                 _solo_release->routes_on->push_back (*i);
 428                                                         } else {
 429                                                                 _solo_release->routes_off->push_back (*i);
 430                                                         }
 431                                                 }
 432                                         }
 433
 434                                         if (Config->get_solo_control_is_listen_control()) {
 435                                                 /* ??? we need a just_one_listen() method */
 436                                         } else {
 437                                                 _session->set_just_one_solo (_route, true);
 438                                         }
 439
 440                                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
 441
 442                                         // shift-click: toggle solo isolated status
 443
 444                                         _route->set_solo_isolated (!_route->solo_isolated(), this);
 445                                         delete _solo_release;
 446                                         _solo_release = 0;
 447
 448                                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 449
 450                                         /* Primary-button1: solo mix group.
 451                                            NOTE: Primary-button2 is MIDI learn.
 452                                         */
 453
 454                                         if (ev->button == 1 && _route->route_group()) {
 455
 456                                                 if (_solo_release) {
 457                                                         _solo_release->routes = _route->route_group()->route_list();
 458                                                 }
 459
 460                                                 if (Config->get_solo_control_is_listen_control()) {
 461                                                         _session->set_listen (_route->route_group()->route_list(), !_route->listening_via_monitor(),  Session::rt_cleanup, true);
 462                                                 } else {
 463                                                         _session->set_solo (_route->route_group()->route_list(), !_route->self_soloed(),  Session::rt_cleanup, true);
 464                                                 }
 465                                         }
 466
 467                                 } else {
 468
 469                                         /* click: solo this route */
 470
 471                                         boost::shared_ptr<RouteList> rl (new RouteList);
 472                                         rl->push_back (route());
 473
 474                                         if (_solo_release) {
 475                                                 _solo_release->routes = rl;
 476                                         }
 477
 478                                         if (Config->get_solo_control_is_listen_control()) {
 479                                                 _session->set_listen (rl, !_route->listening_via_monitor());
 480                                         } else {
 481                                                 _session->set_solo (rl, !_route->self_soloed());
 482                                         }
 483                                 }
 484                         }
 485                 }
 486         }
 487
 488         return true;
 489 }
 490
 491 bool
 492 RouteUI::solo_release (GdkEventButton*)
 493 {
 494         if (!_i_am_the_modifier) {
 495
 496                 if (_solo_release) {
 497
 498                         if (_solo_release->exclusive) {
 499
 500                         } else {
 501                                 if (Config->get_solo_control_is_listen_control()) {
 502                                         _session->set_listen (_solo_release->routes, _solo_release->active, Session::rt_cleanup, true);
 503                                 } else {
 504                                         _session->set_solo (_solo_release->routes, _solo_release->active, Session::rt_cleanup, true);
 505                                 }
 506                         }
 507
 508                         delete _solo_release;
 509                         _solo_release = 0;
 510                 }
 511         }
 512
 513         return true;
 514 }
 515
 516 bool
 517 RouteUI::rec_enable_press(GdkEventButton* ev)
 518 {
 519         if (ev->type == GDK_2BUTTON_PRESS || ev->type == GDK_3BUTTON_PRESS ) {
 520                 return true;
 521         }
 522
 523         if (!_session->engine().connected()) {
 524                 MessageDialog msg (_("Not connected to JACK - cannot engage record"));
 525                 msg.run ();
 526                 return true;
 527         }
 528
 529         if (is_midi_track()) {
 530
 531                 /* cannot rec-enable while step-editing */
 532
 533                 if (midi_track()->step_editing()) {
 534                         return true;
 535                 }
 536         }
 537
 538         if (!_i_am_the_modifier && is_track() && rec_enable_button) {
 539
 540                 if (Keyboard::is_button2_event (ev)) {
 541
 542                         // do nothing on midi sigc::bind event
 543                         return rec_enable_button->on_button_press_event (ev);
 544
 545                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
 546
 547                         _session->set_record_enabled (_session->get_routes(), !rec_enable_button->get_active());
 548
 549                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 550
 551                         /* Primary-button1 applies change to the route group (even if it is not active)
 552                            NOTE: Primary-button2 is MIDI learn.
 553                         */
 554                         if (ev->button == 1 && _route->route_group()) {
 555                                 _session->set_record_enabled (_route->route_group()->route_list(), !rec_enable_button->get_active(), Session::rt_cleanup, true);
 556                         }
 557
 558                 } else if (Keyboard::is_context_menu_event (ev)) {
 559
 560                         /* do this on release */
 561
 562                 } else {
 563
 564                         boost::shared_ptr<RouteList> rl (new RouteList);
 565                         rl->push_back (route());
 566                         _session->set_record_enabled (rl, !rec_enable_button->get_active());
 567                 }
 568         }
 569
 570         return true;
 571 }
 572
 573 void
 574 RouteUI::build_record_menu ()
 575 {
 576         if (record_menu) {
 577                 return;
 578         }
 579
 580         /* no rec-button context menu for non-MIDI tracks
 581          */
 582
 583         if (is_midi_track()) {
 584                 record_menu = new Menu;
 585                 record_menu->set_name ("ArdourContextMenu");
 586
 587                 using namespace Menu_Helpers;
 588                 MenuList& items = record_menu->items();
 589
 590                 items.push_back (CheckMenuElem (_("Step Entry"), sigc::mem_fun (*this, &RouteUI::toggle_step_edit)));
 591                 step_edit_item = dynamic_cast<CheckMenuItem*> (&items.back());
 592
 593                 if (_route->record_enabled()) {
 594                         step_edit_item->set_sensitive (false);
 595                 }
 596
 597                 step_edit_item->set_active (midi_track()->step_editing());
 598         }
 599 }
 600
 601 void
 602 RouteUI::toggle_step_edit ()
 603 {
 604         if (!is_midi_track() || _route->record_enabled()) {
 605                 return;
 606         }
 607
 608         midi_track()->set_step_editing (step_edit_item->get_active());
 609 }
 610
 611 void
 612 RouteUI::step_edit_changed (bool yn)
 613 {
 614         if (yn) {
 615                 if (rec_enable_button) {
 616                         rec_enable_button->set_visual_state (3);
 617                 }
 618
 619                 start_step_editing ();
 620
 621                 if (step_edit_item) {
 622                         step_edit_item->set_active (true);
 623                 }
 624
 625         } else {
 626
 627                 if (rec_enable_button) {
 628                         rec_enable_button->set_visual_state (0);
 629                 }
 630
 631                 stop_step_editing ();
 632
 633                 if (step_edit_item) {
 634                         step_edit_item->set_active (false);
 635                 }
 636         }
 637 }
 638
 639 bool
 640 RouteUI::rec_enable_release (GdkEventButton* ev)
 641 {
 642         if (Keyboard::is_context_menu_event (ev)) {
 643                 build_record_menu ();
 644                 if (record_menu) {
 645                         record_menu->popup (1, ev->time);
 646                 }
 647                 return true;
 648         }
 649
 650         return true;
 651 }
 652
 653 void
 654 RouteUI::build_sends_menu ()
 655 {
 656         using namespace Menu_Helpers;
 657
 658         sends_menu = new Menu;
 659         sends_menu->set_name ("ArdourContextMenu");
 660         MenuList& items = sends_menu->items();
 661
 662         items.push_back (
 663                 MenuElem(_("Assign all tracks (prefader)"), sigc::bind (sigc::mem_fun (*this, &RouteUI::create_sends), PreFader, false))
 664                 );
 665
 666         items.push_back (
 667                 MenuElem(_("Assign all tracks and buses (prefader)"), sigc::bind (sigc::mem_fun (*this, &RouteUI::create_sends), PreFader, true))
 668                 );
 669
 670         items.push_back (
 671                 MenuElem(_("Assign all tracks (postfader)"), sigc::bind (sigc::mem_fun (*this, &RouteUI::create_sends), PostFader, false))
 672                 );
 673
 674         items.push_back (
 675                 MenuElem(_("Assign all tracks and buses (postfader)"), sigc::bind (sigc::mem_fun (*this, &RouteUI::create_sends), PostFader, true))
 676                 );
 677
 678         items.push_back (
 679                 MenuElem(_("Assign selected tracks (prefader)"), sigc::bind (sigc::mem_fun (*this, &RouteUI::create_selected_sends), PreFader, false))
 680                 );
 681
 682         items.push_back (
 683                 MenuElem(_("Assign selected tracks and buses (prefader)"), sigc::bind (sigc::mem_fun (*this, &RouteUI::create_selected_sends), PreFader, true)));
 684
 685         items.push_back (
 686                 MenuElem(_("Assign selected tracks (postfader)"), sigc::bind (sigc::mem_fun (*this, &RouteUI::create_selected_sends), PostFader, false))
 687                 );
 688
 689         items.push_back (
 690                 MenuElem(_("Assign selected tracks and buses (postfader)"), sigc::bind (sigc::mem_fun (*this, &RouteUI::create_selected_sends), PostFader, true))
 691                 );
 692
 693         items.push_back (MenuElem(_("Copy track/bus gains to sends"), sigc::mem_fun (*this, &RouteUI::set_sends_gain_from_track)));
 694         items.push_back (MenuElem(_("Set sends gain to -inf"), sigc::mem_fun (*this, &RouteUI::set_sends_gain_to_zero)));
 695         items.push_back (MenuElem(_("Set sends gain to 0dB"), sigc::mem_fun (*this, &RouteUI::set_sends_gain_to_unity)));
 696
 697 }
 698
 699 void
 700 RouteUI::create_sends (Placement p, bool include_buses)
 701 {
 702         _session->globally_add_internal_sends (_route, p, include_buses);
 703 }
 704
 705 void
 706 RouteUI::create_selected_sends (Placement p, bool include_buses)
 707 {
 708         boost::shared_ptr<RouteList> rlist (new RouteList);
 709         TrackSelection& selected_tracks (ARDOUR_UI::instance()->the_editor().get_selection().tracks);
 710
 711         for (TrackSelection::iterator i = selected_tracks.begin(); i != selected_tracks.end(); ++i) {
 712                 RouteTimeAxisView* rtv;
 713                 RouteUI* rui;
 714                 if ((rtv = dynamic_cast<RouteTimeAxisView*>(*i)) != 0) {
 715                         if ((rui = dynamic_cast<RouteUI*>(rtv)) != 0) {
 716                                 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(rui->route())) {
 717                                         rlist->push_back (rui->route());
 718                                 }
 719                         }
 720                 }
 721         }
 722
 723         _session->add_internal_sends (_route, p, rlist);
 724 }
 725
 726 void
 727 RouteUI::set_sends_gain_from_track ()
 728 {
 729         _session->globally_set_send_gains_from_track (_route);
 730 }
 731
 732 void
 733 RouteUI::set_sends_gain_to_zero ()
 734 {
 735         _session->globally_set_send_gains_to_zero (_route);
 736 }
 737
 738 void
 739 RouteUI::set_sends_gain_to_unity ()
 740 {
 741         _session->globally_set_send_gains_to_unity (_route);
 742 }
 743
 744 bool
 745 RouteUI::show_sends_press(GdkEventButton* ev)
 746 {
 747         if (ev->type == GDK_2BUTTON_PRESS || ev->type == GDK_3BUTTON_PRESS ) {
 748                 return true;
 749         }
 750
 751         if (!_i_am_the_modifier && !is_track() && show_sends_button) {
 752
 753                 if (Keyboard::is_button2_event (ev) && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 754
 755                         // do nothing on midi sigc::bind event
 756                         return false;
 757
 758                 } else if (Keyboard::is_context_menu_event (ev)) {
 759
 760                         if (sends_menu == 0) {
 761                                 build_sends_menu ();
 762                         }
 763
 764                         sends_menu->popup (0, ev->time);
 765
 766                 } else {
 767
 768                         /* change button state */
 769
 770                         show_sends_button->set_active (!show_sends_button->get_active());
 771
 772                         /* start blinking */
 773
 774                         if (show_sends_button->get_active()) {
 775                                 /* show sends to this bus */
 776                                 MixerStrip::SwitchIO (_route);
 777                                 send_blink_connection = ARDOUR_UI::instance()->Blink.connect (sigc::mem_fun(*this, &RouteUI::send_blink));
 778                         } else {
 779                                 /* everybody back to normal */
 780                                 send_blink_connection.disconnect ();
 781                                 MixerStrip::SwitchIO (boost::shared_ptr<Route>());
 782                         }
 783
 784                 }
 785         }
 786
 787         return true;
 788 }
 789
 790 bool
 791 RouteUI::show_sends_release (GdkEventButton*)
 792 {
 793         return true;
 794 }
 795
 796 void
 797 RouteUI::send_blink (bool onoff)
 798 {
 799         if (!show_sends_button) {
 800                 return;
 801         }
 802
 803         if (onoff) {
 804                 show_sends_button->set_state (STATE_ACTIVE);
 805         } else {
 806                 show_sends_button->set_state (STATE_NORMAL);
 807         }
 808 }
 809
 810 int
 811 RouteUI::solo_visual_state (boost::shared_ptr<Route> r)
 812 {
 813         if (r->is_master() || r->is_monitor()) {
 814                 return 0;
 815         }
 816
 817         if (Config->get_solo_control_is_listen_control()) {
 818
 819                 if (r->listening_via_monitor()) {
 820                         return 1;
 821                 } else {
 822                         return 0;
 823                 }
 824
 825         }
 826
 827         if (r->soloed()) {
 828                 if (!r->self_soloed()) {
 829                         return 3;
 830                 } else {
 831                         return 1;
 832                 }
 833         } else {
 834                 return 0;
 835         }
 836 }
 837
 838 int
 839 RouteUI::solo_visual_state_with_isolate (boost::shared_ptr<Route> r)
 840 {
 841         if (r->is_master() || r->is_monitor()) {
 842                 return 0;
 843         }
 844
 845         if (Config->get_solo_control_is_listen_control()) {
 846
 847                 if (r->listening_via_monitor()) {
 848                         return 1;
 849                 } else {
 850                         return 0;
 851                 }
 852
 853         }
 854
 855         if (r->solo_isolated()) {
 856                 return 2;
 857         } else if (r->soloed()) {
 858                 if (!r->self_soloed()) {
 859                         return 3;
 860                 } else {
 861                         return 1;
 862                 }
 863         } else {
 864                 return 0;
 865         }
 866 }
 867
 868 int
 869 RouteUI::solo_isolate_visual_state (boost::shared_ptr<Route> r)
 870 {
 871         if (r->is_master() || r->is_monitor()) {
 872                 return 0;
 873         }
 874
 875         if (r->solo_isolated()) {
 876                 return 1;
 877         } else {
 878                 return 0;
 879         }
 880 }
 881
 882 int
 883 RouteUI::solo_safe_visual_state (boost::shared_ptr<Route> r)
 884 {
 885         if (r->is_master() || r->is_monitor()) {
 886                 return 0;
 887         }
 888
 889         if (r->solo_safe()) {
 890                 return 1;
 891         } else {
 892                 return 0;
 893         }
 894 }
 895
 896 void
 897 RouteUI::update_solo_display ()
 898 {
 899         bool x;
 900
 901         if (Config->get_solo_control_is_listen_control()) {
 902
 903                 if (solo_button->get_active() != (x = _route->listening_via_monitor())) {
 904                         ++_i_am_the_modifier;
 905                         solo_button->set_active(x);
 906                         --_i_am_the_modifier;
 907                 }
 908
 909         } else {
 910
 911                 if (solo_button->get_active() != (x = _route->soloed())) {
 912                         ++_i_am_the_modifier;
 913                         solo_button->set_active (x);
 914                         --_i_am_the_modifier;
 915                 }
 916
 917         }
 918
 919         bool yn = _route->solo_safe ();
 920
 921         if (solo_safe_check && solo_safe_check->get_active() != yn) {
 922                 solo_safe_check->set_active (yn);
 923         }
 924
 925         yn = _route->solo_isolated ();
 926
 927         if (solo_isolated_check && solo_isolated_check->get_active() != yn) {
 928                 solo_isolated_check->set_active (yn);
 929         }
 930
 931         set_button_names ();
 932
 933         if (solo_isolated_led) {
 934                 solo_isolated_led->set_visual_state (_route->solo_isolated() ? 1 : 0);
 935         }
 936
 937         if (solo_safe_led) {
 938                 solo_safe_led->set_visual_state (_route->solo_safe() ? 1 : 0);
 939         }
 940
 941         solo_button->set_visual_state (solo_visual_state (_route));
 942
 943         /* some changes to solo status can affect mute display, so catch up
 944          */
 945
 946         update_mute_display ();
 947 }
 948
 949 void
 950 RouteUI::solo_changed_so_update_mute ()
 951 {
 952         update_mute_display ();
 953 }
 954
 955 void
 956 RouteUI::mute_changed(void* /*src*/)
 957 {
 958         update_mute_display ();
 959 }
 960
 961 int
 962 RouteUI::mute_visual_state (Session* s, boost::shared_ptr<Route> r)
 963 {
 964         if (r->is_master() || r->is_monitor()) {
 965                 return 0;
 966         }
 967
 968
 969         if (Config->get_show_solo_mutes() && !Config->get_solo_control_is_listen_control ()) {
 970
 971                 if (r->muted ()) {
 972                         /* full mute */
 973                         return 2;
 974                 } else if (s->soloing() && !r->soloed() && !r->solo_isolated()) {
 975                         return 1;
 976                 } else {
 977                         /* no mute at all */
 978                         return 0;
 979                 }
 980
 981         } else {
 982
 983                 if (r->muted()) {
 984                         /* full mute */
 985                         return 2;
 986                 } else {
 987                         /* no mute at all */
 988                         return 0;
 989                 }
 990         }
 991
 992         return 0;
 993 }
 994
 995 void
 996 RouteUI::update_mute_display ()
 997 {
 998         if (!_route) {
 999                 return;
1000         }
1001
1002         bool model = _route->muted();
1003         bool view = mute_button->get_active();
1004
1005         /* first make sure the button's "depressed" visual
1006            is correct.
1007         */
1008
1009         if (model != view) {
1010                 ++_i_am_the_modifier;
1011                 mute_button->set_active (model);
1012                 --_i_am_the_modifier;
1013         }
1014
1015         mute_button->set_visual_state (mute_visual_state (_session, _route));
1016 }
1017
1018 void
1019 RouteUI::route_rec_enable_changed ()
1020 {
1021         update_rec_display ();
1022 }
1023
1024 void
1025 RouteUI::session_rec_enable_changed ()
1026 {
1027         update_rec_display ();
1028 }
1029
1030 void
1031 RouteUI::update_rec_display ()
1032 {
1033         if (!rec_enable_button || !_route) {
1034                 return;
1035         }
1036
1037         bool model = _route->record_enabled();
1038         bool view = rec_enable_button->get_active();
1039
1040         /* first make sure the button's "depressed" visual
1041            is correct.
1042         */
1043
1044         if (model != view) {
1045                 ++_i_am_the_modifier;
1046                 rec_enable_button->set_active (model);
1047                 --_i_am_the_modifier;
1048         }
1049
1050         /* now make sure its color state is correct */
1051
1052         if (model) {
1053                 switch (_session->record_status ()) {
1054                 case Session::Recording:
1055                         rec_enable_button->set_visual_state (1);
1056                         break;
1057
1058                 case Session::Disabled:
1059                 case Session::Enabled:
1060                         rec_enable_button->set_visual_state (2);
1061                         break;
1062
1063                 }
1064
1065                 if (step_edit_item) {
1066                         step_edit_item->set_sensitive (false);
1067                 }
1068
1069         } else {
1070                 rec_enable_button->set_visual_state (0);
1071
1072                 if (step_edit_item) {
1073                         step_edit_item->set_sensitive (true);
1074                 }
1075         }
1076
1077
1078         check_rec_enable_sensitivity ();
1079 }
1080
1081 void
1082 RouteUI::build_solo_menu (void)
1083 {
1084         using namespace Menu_Helpers;
1085
1086         solo_menu = new Menu;
1087         solo_menu->set_name ("ArdourContextMenu");
1088         MenuList& items = solo_menu->items();
1089         CheckMenuItem* check;
1090
1091         check = new CheckMenuItem(_("Solo Isolate"));
1092         check->set_active (_route->solo_isolated());
1093         check->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &RouteUI::toggle_solo_isolated), check));
1094         items.push_back (CheckMenuElem(*check));
1095         solo_isolated_check = dynamic_cast<CheckMenuItem*>(&items.back());
1096         check->show_all();
1097
1098         check = new CheckMenuItem(_("Solo Safe"));
1099         check->set_active (_route->solo_safe());
1100         check->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &RouteUI::toggle_solo_safe), check));
1101         items.push_back (CheckMenuElem(*check));
1102         solo_safe_check = dynamic_cast<CheckMenuItem*>(&items.back());
1103         check->show_all();
1104
1105         //items.push_back (SeparatorElem());
1106         // items.push_back (MenuElem (_("MIDI Bind"), sigc::mem_fun (*mute_button, &BindableToggleButton::midi_learn)));
1107
1108 }
1109
1110 void
1111 RouteUI::build_mute_menu(void)
1112 {
1113         using namespace Menu_Helpers;
1114
1115         mute_menu = new Menu;
1116         mute_menu->set_name ("ArdourContextMenu");
1117
1118         MenuList& items = mute_menu->items();
1119
1120         pre_fader_mute_check = manage (new CheckMenuItem(_("Pre Fader")));
1121         init_mute_menu(MuteMaster::PreFader, pre_fader_mute_check);
1122         pre_fader_mute_check->signal_toggled().connect(sigc::bind (sigc::mem_fun (*this, &RouteUI::toggle_mute_menu), MuteMaster::PreFader, pre_fader_mute_check));
1123         items.push_back (CheckMenuElem(*pre_fader_mute_check));
1124         pre_fader_mute_check->show_all();
1125
1126         post_fader_mute_check = manage (new CheckMenuItem(_("Post Fader")));
1127         init_mute_menu(MuteMaster::PostFader, post_fader_mute_check);
1128         post_fader_mute_check->signal_toggled().connect(sigc::bind (sigc::mem_fun (*this, &RouteUI::toggle_mute_menu), MuteMaster::PostFader, post_fader_mute_check));
1129         items.push_back (CheckMenuElem(*post_fader_mute_check));
1130         post_fader_mute_check->show_all();
1131
1132         listen_mute_check = manage (new CheckMenuItem(_("Control Outs")));
1133         init_mute_menu(MuteMaster::Listen, listen_mute_check);
1134         listen_mute_check->signal_toggled().connect(sigc::bind (sigc::mem_fun (*this, &RouteUI::toggle_mute_menu), MuteMaster::Listen, listen_mute_check));
1135         items.push_back (CheckMenuElem(*listen_mute_check));
1136         listen_mute_check->show_all();
1137
1138         main_mute_check = manage (new CheckMenuItem(_("Main Outs")));
1139         init_mute_menu(MuteMaster::Main, main_mute_check);
1140         main_mute_check->signal_toggled().connect(sigc::bind (sigc::mem_fun (*this, &RouteUI::toggle_mute_menu), MuteMaster::Main, main_mute_check));
1141         items.push_back (CheckMenuElem(*main_mute_check));
1142         main_mute_check->show_all();
1143
1144         //items.push_back (SeparatorElem());
1145         // items.push_back (MenuElem (_("MIDI Bind"), sigc::mem_fun (*mute_button, &BindableToggleButton::midi_learn)));
1146
1147         _route->mute_points_changed.connect (route_connections, invalidator (*this), boost::bind (&RouteUI::muting_change, this), gui_context());
1148 }
1149
1150 void
1151 RouteUI::init_mute_menu(MuteMaster::MutePoint mp, CheckMenuItem* check)
1152 {
1153         check->set_active (_route->mute_points() & mp);
1154 }
1155
1156 void
1157 RouteUI::toggle_mute_menu(MuteMaster::MutePoint mp, Gtk::CheckMenuItem* check)
1158 {
1159         if (check->get_active()) {
1160                 _route->set_mute_points (MuteMaster::MutePoint (_route->mute_points() | mp));
1161         } else {
1162                 _route->set_mute_points (MuteMaster::MutePoint (_route->mute_points() & ~mp));
1163         }
1164 }
1165
1166 void
1167 RouteUI::muting_change ()
1168 {
1169         ENSURE_GUI_THREAD (*this, &RouteUI::muting_change)
1170
1171         bool yn;
1172         MuteMaster::MutePoint current = _route->mute_points ();
1173
1174         yn = (current & MuteMaster::PreFader);
1175
1176         if (pre_fader_mute_check->get_active() != yn) {
1177                 pre_fader_mute_check->set_active (yn);
1178         }
1179
1180         yn = (current & MuteMaster::PostFader);
1181
1182         if (post_fader_mute_check->get_active() != yn) {
1183                 post_fader_mute_check->set_active (yn);
1184         }
1185
1186         yn = (current & MuteMaster::Listen);
1187
1188         if (listen_mute_check->get_active() != yn) {
1189                 listen_mute_check->set_active (yn);
1190         }
1191
1192         yn = (current & MuteMaster::Main);
1193
1194         if (main_mute_check->get_active() != yn) {
1195                 main_mute_check->set_active (yn);
1196         }
1197 }
1198
1199 bool
1200 RouteUI::solo_isolate_button_release (GdkEventButton* ev)
1201 {
1202         if (ev->type == GDK_2BUTTON_PRESS || ev->type == GDK_3BUTTON_PRESS) {
1203                 return true;
1204         }
1205
1206         bool view = (solo_isolated_led->visual_state() != 0);
1207         bool model = _route->solo_isolated();
1208
1209         /* called BEFORE the view has changed */
1210
1211         if (ev->button == 1) {
1212                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
1213
1214                         if (model) {
1215                                 /* disable isolate for all routes */
1216                                 _session->set_solo_isolated (_session->get_routes(), false, Session::rt_cleanup, true);
1217                         }
1218
1219                 } else {
1220                         if (model == view) {
1221
1222                                 /* flip just this route */
1223
1224                                 boost::shared_ptr<RouteList> rl (new RouteList);
1225                                 rl->push_back (_route);
1226                                 _session->set_solo_isolated (rl, !view, Session::rt_cleanup, true);
1227                         }
1228                 }
1229         }
1230
1231         return true;
1232 }
1233
1234 bool
1235 RouteUI::solo_safe_button_release (GdkEventButton*)
1236 {
1237         _route->set_solo_safe (!(solo_safe_led->visual_state() > 0), this);
1238         return true;
1239 }
1240
1241 void
1242 RouteUI::toggle_solo_isolated (Gtk::CheckMenuItem* check)
1243 {
1244         bool view = check->get_active();
1245         bool model = _route->solo_isolated();
1246
1247         /* called AFTER the view has changed */
1248
1249         if (model != view) {
1250                 _route->set_solo_isolated (view, this);
1251         }
1252 }
1253
1254 void
1255 RouteUI::toggle_solo_safe (Gtk::CheckMenuItem* check)
1256 {
1257         _route->set_solo_safe (check->get_active(), this);
1258 }
1259
1260 /** Ask the user to choose a colour, and then set all selected tracks
1261  *  to that colour.
1262  */
1263 void
1264 RouteUI::choose_color ()
1265 {
1266         bool picked;
1267         Gdk::Color const color = Gtkmm2ext::UI::instance()->get_color (_("Color Selection"), picked, &_color);
1268
1269         if (picked) {
1270                 ARDOUR_UI::instance()->the_editor().get_selection().tracks.foreach_route_ui (
1271                         boost::bind (&RouteUI::set_color, _1, color)
1272                         );
1273         }
1274 }
1275
1276 void
1277 RouteUI::set_color (const Gdk::Color & c)
1278 {
1279         char buf[64];
1280
1281         _color = c;
1282
1283         ensure_xml_node ();
1284         snprintf (buf, sizeof (buf), "%d:%d:%d", c.get_red(), c.get_green(), c.get_blue());
1285         xml_node->add_property ("color", buf);
1286
1287         _route->gui_changed ("color", (void *) 0); /* EMIT_SIGNAL */
1288 }
1289
1290
1291 void
1292 RouteUI::ensure_xml_node ()
1293 {
1294         if (xml_node == 0) {
1295                 if ((xml_node = _route->extra_xml ("GUI")) == 0) {
1296                         xml_node = new XMLNode ("GUI");
1297                         _route->add_extra_xml (*xml_node);
1298                 } else {
1299                         /* the Route has one; it may have been loaded */
1300                         if (Stateful::loading_state_version != 0 && Stateful::loading_state_version < 3000) {
1301                                 /* the GUI extra XML is in 2.X format; we must convert it to the new
1302                                    format to avoid problems later
1303                                 */
1304
1305                                 XMLNode* new_xml_node = new XMLNode (X_("GUI"));
1306                                 XMLPropertyList old_gui_props = xml_node->properties ();
1307                                 for (XMLPropertyIterator i = old_gui_props.begin(); i != old_gui_props.end(); ++i) {
1308                                         new_xml_node->add_property ((*i)->name().c_str (), (*i)->value().c_str ());
1309                                 }
1310
1311                                 XMLNodeList old_children = xml_node->children ();
1312                                 for (XMLNodeConstIterator i = old_children.begin(); i != old_children.end(); ++i) {
1313                                         XMLNode* new_child = new XMLNode (AutomationTimeAxisView::state_node_name);
1314                                         new_child->add_property (X_("automation-id"), (*i)->name());
1315
1316                                         XMLPropertyList old_props = (*i)->properties ();
1317                                         for (XMLPropertyIterator j = old_props.begin(); j != old_props.end(); ++j) {
1318                                                 new_child->add_property ((*j)->name().c_str (), (*j)->value().c_str ());
1319                                         }
1320
1321                                         new_xml_node->add_child_nocopy (*new_child);
1322                                 }
1323
1324                                 _route->add_extra_xml (*new_xml_node);
1325                                 xml_node = new_xml_node;
1326                         }
1327                 }
1328         }
1329 }
1330
1331 XMLNode*
1332 RouteUI::get_automation_child_xml_node (Evoral::Parameter param)
1333 {
1334         ensure_xml_node ();
1335
1336         XMLNodeList kids = xml_node->children();
1337         XMLNodeConstIterator iter;
1338
1339         const string sym = ARDOUR::EventTypeMap::instance().to_symbol(param);
1340
1341         for (iter = kids.begin(); iter != kids.end(); ++iter) {
1342
1343                 if ((*iter)->name() == AutomationTimeAxisView::state_node_name) {
1344                         XMLProperty* type = (*iter)->property("automation-id");
1345                         if (type && type->value() == sym) {
1346                                 return *iter;
1347                         }
1348                 }
1349         }
1350
1351         // Didn't find it, make a new one
1352         XMLNode* child = new XMLNode (AutomationTimeAxisView::state_node_name);
1353         child->add_property("automation-id", sym);
1354         xml_node->add_child_nocopy (*child);
1355
1356         return child;
1357 }
1358
1359 int
1360 RouteUI::set_color_from_route ()
1361 {
1362         XMLProperty *prop;
1363
1364         RouteUI::ensure_xml_node ();
1365
1366         if ((prop = xml_node->property ("color")) != 0) {
1367                 int r, g, b;
1368                 sscanf (prop->value().c_str(), "%d:%d:%d", &r, &g, &b);
1369                 _color.set_red(r);
1370                 _color.set_green(g);
1371                 _color.set_blue(b);
1372                 return 0;
1373         }
1374         return 1;
1375 }
1376
1377 void
1378 RouteUI::remove_this_route ()
1379 {
1380         if ((route()->is_master() || route()->is_monitor()) &&
1381             !Config->get_allow_special_bus_removal()) {
1382                 MessageDialog msg (_("That would be bad news ...."),
1383                                    false,
1384                                    Gtk::MESSAGE_INFO,
1385                                    Gtk::BUTTONS_OK);
1386                 msg.set_secondary_text (string_compose (_(
1387 "Removing the master or monitor bus is such a bad idea\n\
1388 that %1 is not going to allow it.\n\
1389 \n\
1390 If you really want to do this sort of thing\n\
1391 edit your ardour.rc file to set the\n\
1392 \"allow-special-bus-removal\" option to be \"yes\""), PROGRAM_NAME));
1393
1394                 msg.present ();
1395                 msg.run ();
1396                 return;
1397         }
1398
1399         vector<string> choices;
1400         string prompt;
1401
1402         if (is_track()) {
1403                 prompt  = string_compose (_("Do you really want to remove track \"%1\" ?\n\nYou may also lose the playlist used by this track.\n\n(This action cannot be undone, and the session file will be overwritten)"), _route->name());
1404         } else {
1405                 prompt  = string_compose (_("Do you really want to remove bus \"%1\" ?\n\nYou may also lose the playlist used by this track.\n\n(This action cannot be undone, and the session file will be overwritten)"), _route->name());
1406         }
1407
1408         choices.push_back (_("No, do nothing."));
1409         choices.push_back (_("Yes, remove it."));
1410
1411         string title;
1412         if (is_track()) {
1413                 title = _("Remove track");
1414         } else {
1415                 title = _("Remove bus");
1416         }
1417
1418         Choice prompter (title, prompt, choices);
1419
1420         if (prompter.run () == 1) {
1421                 Glib::signal_idle().connect (sigc::bind (sigc::ptr_fun (&RouteUI::idle_remove_this_route), this));
1422         }
1423 }
1424
1425 gint
1426 RouteUI::idle_remove_this_route (RouteUI *rui)
1427 {
1428         rui->_session->remove_route (rui->route());
1429         return false;
1430 }
1431
1432 void
1433 RouteUI::route_rename ()
1434 {
1435         ArdourPrompter name_prompter (true);
1436         string result;
1437         if (is_track()) {
1438                 name_prompter.set_title (_("Rename Track"));
1439         } else {
1440                 name_prompter.set_title (_("Rename Bus"));
1441         }
1442         name_prompter.set_prompt (_("New name:"));
1443         name_prompter.set_initial_text (_route->name());
1444         name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
1445         name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
1446         name_prompter.show_all ();
1447
1448         switch (name_prompter.run ()) {
1449         case Gtk::RESPONSE_ACCEPT:
1450                 name_prompter.get_result (result);
1451                 if (result.length()) {
1452                         _route->set_name (result);
1453                 }
1454                 break;
1455         }
1456
1457         return;
1458
1459 }
1460
1461 void
1462 RouteUI::property_changed (const PropertyChange& what_changed)
1463 {
1464         if (what_changed.contains (ARDOUR::Properties::name)) {
1465                 name_label.set_text (_route->name());
1466         }
1467 }
1468
1469 void
1470 RouteUI::toggle_route_active ()
1471 {
1472         bool yn;
1473
1474         if (route_active_menu_item) {
1475                 if (route_active_menu_item->get_active() != (yn = _route->active())) {
1476                         _route->set_active (!yn, this);
1477                 }
1478         }
1479 }
1480
1481 void
1482 RouteUI::route_active_changed ()
1483 {
1484         if (route_active_menu_item) {
1485                 Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&CheckMenuItem::set_active, route_active_menu_item, _route->active()));
1486         }
1487 }
1488
1489
1490 void
1491 RouteUI::toggle_denormal_protection ()
1492 {
1493         if (denormal_menu_item) {
1494
1495                 bool x;
1496
1497                 ENSURE_GUI_THREAD (*this, &RouteUI::toggle_denormal_protection)
1498
1499                 if ((x = denormal_menu_item->get_active()) != _route->denormal_protection()) {
1500                         _route->set_denormal_protection (x);
1501                 }
1502         }
1503 }
1504
1505 void
1506 RouteUI::denormal_protection_changed ()
1507 {
1508         if (denormal_menu_item) {
1509                 denormal_menu_item->set_active (_route->denormal_protection());
1510         }
1511 }
1512
1513 void
1514 RouteUI::disconnect_input ()
1515 {
1516         _route->input()->disconnect (this);
1517 }
1518
1519 void
1520 RouteUI::disconnect_output ()
1521 {
1522         _route->output()->disconnect (this);
1523 }
1524
1525 bool
1526 RouteUI::is_track () const
1527 {
1528         return boost::dynamic_pointer_cast<Track>(_route) != 0;
1529 }
1530
1531 boost::shared_ptr<Track>
1532 RouteUI::track() const
1533 {
1534         return boost::dynamic_pointer_cast<Track>(_route);
1535 }
1536
1537 bool
1538 RouteUI::is_audio_track () const
1539 {
1540         return boost::dynamic_pointer_cast<AudioTrack>(_route) != 0;
1541 }
1542
1543 boost::shared_ptr<AudioTrack>
1544 RouteUI::audio_track() const
1545 {
1546         return boost::dynamic_pointer_cast<AudioTrack>(_route);
1547 }
1548
1549 bool
1550 RouteUI::is_midi_track () const
1551 {
1552         return boost::dynamic_pointer_cast<MidiTrack>(_route) != 0;
1553 }
1554
1555 boost::shared_ptr<MidiTrack>
1556 RouteUI::midi_track() const
1557 {
1558         return boost::dynamic_pointer_cast<MidiTrack>(_route);
1559 }
1560
1561 bool
1562 RouteUI::has_audio_outputs () const
1563 {
1564         return (_route->n_outputs().n_audio() > 0);
1565 }
1566
1567 string
1568 RouteUI::name() const
1569 {
1570         return _route->name();
1571 }
1572
1573 void
1574 RouteUI::map_frozen ()
1575 {
1576         ENSURE_GUI_THREAD (*this, &RouteUI::map_frozen)
1577
1578         AudioTrack* at = dynamic_cast<AudioTrack*>(_route.get());
1579
1580         if (at) {
1581                 switch (at->freeze_state()) {
1582                 case AudioTrack::Frozen:
1583                         rec_enable_button->set_sensitive (false);
1584                         break;
1585                 default:
1586                         rec_enable_button->set_sensitive (true);
1587                         break;
1588                 }
1589         }
1590 }
1591
1592 void
1593 RouteUI::adjust_latency ()
1594 {
1595         LatencyDialog dialog (_route->name() + _(" latency"), *(_route->output()), _session->frame_rate(), _session->engine().frames_per_cycle());
1596 }
1597
1598 void
1599 RouteUI::save_as_template ()
1600 {
1601         sys::path path;
1602         std::string safe_name;
1603         string name;
1604
1605         path = ARDOUR::user_route_template_directory ();
1606
1607         if (g_mkdir_with_parents (path.to_string().c_str(), 0755)) {
1608                 error << string_compose (_("Cannot create route template directory %1"), path.to_string()) << endmsg;
1609                 return;
1610         }
1611
1612         Prompter p (true); // modal
1613
1614         p.set_title (_("Save As Template"));
1615         p.set_prompt (_("Template name:"));
1616         p.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
1617         switch (p.run()) {
1618         case RESPONSE_ACCEPT:
1619                 break;
1620         default:
1621                 return;
1622         }
1623
1624         p.hide ();
1625         p.get_result (name, true);
1626
1627         safe_name = legalize_for_path (name);
1628         safe_name += template_suffix;
1629
1630         path /= safe_name;
1631
1632         _route->save_as_template (path.to_string(), name);
1633 }
1634
1635 void
1636 RouteUI::check_rec_enable_sensitivity ()
1637 {
1638         if (_session->transport_rolling() && rec_enable_button->get_active() && Config->get_disable_disarm_during_roll()) {
1639                 rec_enable_button->set_sensitive (false);
1640         } else {
1641                 rec_enable_button->set_sensitive (true);
1642         }
1643 }
1644
1645 void
1646 RouteUI::parameter_changed (string const & p)
1647 {
1648         if (p == "disable-disarm-during-roll") {
1649                 check_rec_enable_sensitivity ();
1650         } else if (p == "use-monitor-bus" || p == "solo-control-is-listen-control" || p == "listen-position") {
1651                 set_button_names ();
1652         }
1653 }
1654
1655 void
1656 RouteUI::step_gain_up ()
1657 {
1658         _route->set_gain (dB_to_coefficient (accurate_coefficient_to_dB (_route->gain_control()->get_value()) + 0.1), this);
1659 }
1660
1661 void
1662 RouteUI::page_gain_up ()
1663 {
1664         _route->set_gain (dB_to_coefficient (accurate_coefficient_to_dB (_route->gain_control()->get_value()) + 0.5), this);
1665 }
1666
1667 void
1668 RouteUI::step_gain_down ()
1669 {
1670         _route->set_gain (dB_to_coefficient (accurate_coefficient_to_dB (_route->gain_control()->get_value()) - 0.1), this);
1671 }
1672
1673 void
1674 RouteUI::page_gain_down ()
1675 {
1676         _route->set_gain (dB_to_coefficient (accurate_coefficient_to_dB (_route->gain_control()->get_value()) - 0.5), this);
1677 }
1678
1679 void
1680 RouteUI::open_remote_control_id_dialog ()
1681 {
1682         ArdourDialog dialog (_("Remote Control ID"));
1683
1684         uint32_t const limit = _session->ntracks() + _session->nbusses () + 4;
1685
1686         HBox* hbox = manage (new HBox);
1687         hbox->set_spacing (6);
1688         hbox->pack_start (*manage (new Label (_("Remote control ID:"))));
1689         SpinButton* spin = manage (new SpinButton);
1690         spin->set_digits (0);
1691         spin->set_increments (1, 10);
1692         spin->set_range (0, limit);
1693         spin->set_value (_route->remote_control_id());
1694         hbox->pack_start (*spin);
1695         dialog.get_vbox()->pack_start (*hbox);
1696
1697         dialog.add_button (Stock::CANCEL, RESPONSE_CANCEL);
1698         dialog.add_button (Stock::APPLY, RESPONSE_ACCEPT);
1699
1700         dialog.show_all ();
1701         int const r = dialog.run ();
1702
1703         if (r == RESPONSE_ACCEPT) {
1704                 _route->set_remote_control_id (spin->get_value_as_int ());
1705         }
1706 }
1707
1708 void
1709 RouteUI::setup_invert_buttons ()
1710 {
1711         /* remove old invert buttons */
1712         for (list<BindableToggleButton*>::iterator i = _invert_buttons.begin(); i != _invert_buttons.end(); ++i) {
1713                 _invert_button_box.remove (**i);
1714         }
1715
1716         _invert_buttons.clear ();
1717
1718         if (!_route || !_route->input()) {
1719                 return;
1720         }
1721
1722         uint32_t const N = _route->input()->n_ports().n_audio ();
1723
1724         uint32_t const to_add = (N <= _max_invert_buttons) ? N : 1;
1725
1726         for (uint32_t i = 0; i < to_add; ++i) {
1727                 BindableToggleButton* b = manage (new BindableToggleButton);
1728                 b->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &RouteUI::invert_toggled), i, b));
1729                 b->signal_button_press_event().connect (sigc::mem_fun (*this, &RouteUI::invert_press));
1730
1731                 b->set_name (X_("MixerInvertButton"));
1732                 if (to_add == 1) {
1733                         b->add (*manage (new Label (X_("Ø"))));
1734                 } else {
1735                         b->add (*manage (new Label (string_compose (X_("Ø%1"), i + 1))));
1736                 }
1737
1738                 if (N <= 4) {
1739                         UI::instance()->set_tip (*b, string_compose (_("Left-click to invert (phase reverse) channel %1 of this track.  Right-click to show menu."), i + 1));
1740                 } else {
1741                         UI::instance()->set_tip (*b, string_compose (_("Left-click to invert (phase reverse) all channels of this track.  Right-click to show menu."), i + 1));
1742                 }
1743
1744                 _invert_buttons.push_back (b);
1745                 _invert_button_box.pack_start (*b);
1746         }
1747
1748         _invert_button_box.show_all ();
1749 }
1750
1751 void
1752 RouteUI::set_invert_button_state ()
1753 {
1754         ++_i_am_the_modifier;
1755
1756         uint32_t const N = _route->input()->n_ports().n_audio();
1757         if (N > _max_invert_buttons) {
1758                 _invert_buttons.front()->set_active (_route->phase_invert().any());
1759                 --_i_am_the_modifier;
1760                 return;
1761         }
1762
1763         int j = 0;
1764         for (list<BindableToggleButton*>::iterator i = _invert_buttons.begin(); i != _invert_buttons.end(); ++i, ++j) {
1765                 (*i)->set_active (_route->phase_invert (j));
1766         }
1767
1768         --_i_am_the_modifier;
1769 }
1770
1771 void
1772 RouteUI::invert_toggled (uint32_t i, BindableToggleButton* b)
1773 {
1774         if (_i_am_the_modifier) {
1775                 return;
1776         }
1777
1778         uint32_t const N = _route->input()->n_ports().n_audio();
1779         if (N <= _max_invert_buttons) {
1780                 _route->set_phase_invert (i, b->get_active ());
1781         } else {
1782                 boost::dynamic_bitset<> p (N);
1783                 if (b->get_active ()) {
1784                         p.set ();
1785                 }
1786                 _route->set_phase_invert (p);
1787         }
1788 }
1789
1790 bool
1791 RouteUI::invert_press (GdkEventButton* ev)
1792 {
1793         using namespace Menu_Helpers;
1794
1795         if (ev->button != 3) {
1796                 return true;
1797         }
1798
1799         delete _invert_menu;
1800         _invert_menu = new Menu;
1801         _invert_menu->set_name ("ArdourContextMenu");
1802         MenuList& items = _invert_menu->items ();
1803
1804         uint32_t const N = _route->input()->n_ports().n_audio();
1805         for (uint32_t i = 0; i < N; ++i) {
1806                 items.push_back (CheckMenuElem (string_compose (X_("Ø%1"), i + 1), sigc::bind (sigc::mem_fun (*this, &RouteUI::invert_menu_toggled), i)));
1807                 CheckMenuItem* e = dynamic_cast<CheckMenuItem*> (&items.back ());
1808                 ++_i_am_the_modifier;
1809                 e->set_active (_route->phase_invert (i));
1810                 --_i_am_the_modifier;
1811         }
1812
1813         _invert_menu->popup (0, ev->time);
1814
1815         return false;
1816 }
1817
1818 void
1819 RouteUI::invert_menu_toggled (uint32_t c)
1820 {
1821         if (_i_am_the_modifier) {
1822                 return;
1823         }
1824
1825         _route->set_phase_invert (c, !_route->phase_invert (c));
1826 }
1827
1828 void
1829 RouteUI::set_invert_sensitive (bool yn)
1830 {
1831         for (list<BindableToggleButton*>::iterator b = _invert_buttons.begin(); b != _invert_buttons.end(); ++b) {
1832                 (*b)->set_sensitive (yn);
1833         }
1834 }