gtk2_ardour/route_ui.cc

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