libs/ardour/route.cc

   1 /*
   2     Copyright (C) 2000 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 #ifdef WAF_BUILD
  21 #include "libardour-config.h"
  22 #endif
  23
  24 #include <cmath>
  25 #include <fstream>
  26 #include <cassert>
  27 #include <algorithm>
  28
  29 #include "pbd/xml++.h"
  30 #include "pbd/enumwriter.h"
  31 #include "pbd/memento_command.h"
  32 #include "pbd/stacktrace.h"
  33 #include "pbd/convert.h"
  34 #include "pbd/boost_debug.h"
  35
  36 #include "evoral/Curve.hpp"
  37
  38 #include "ardour/amp.h"
  39 #include "ardour/audio_port.h"
  40 #include "ardour/audioengine.h"
  41 #include "ardour/buffer.h"
  42 #include "ardour/buffer_set.h"
  43 #include "ardour/configuration.h"
  44 #include "ardour/cycle_timer.h"
  45 #include "ardour/debug.h"
  46 #include "ardour/delivery.h"
  47 #include "ardour/dB.h"
  48 #include "ardour/internal_send.h"
  49 #include "ardour/internal_return.h"
  50 #include "ardour/ladspa_plugin.h"
  51 #include "ardour/meter.h"
  52 #include "ardour/mix.h"
  53 #include "ardour/monitor_processor.h"
  54 #include "ardour/pannable.h"
  55 #include "ardour/panner.h"
  56 #include "ardour/panner_shell.h"
  57 #include "ardour/plugin_insert.h"
  58 #include "ardour/port.h"
  59 #include "ardour/port_insert.h"
  60 #include "ardour/processor.h"
  61 #include "ardour/profile.h"
  62 #include "ardour/route.h"
  63 #include "ardour/route_group.h"
  64 #include "ardour/send.h"
  65 #include "ardour/session.h"
  66 #include "ardour/timestamps.h"
  67 #include "ardour/utils.h"
  68 #include "ardour/graph.h"
  69 #include "ardour/unknown_processor.h"
  70 #include "ardour/capturing_processor.h"
  71
  72 #include "i18n.h"
  73
  74 using namespace std;
  75 using namespace ARDOUR;
  76 using namespace PBD;
  77
  78 uint32_t Route::order_key_cnt = 0;
  79 PBD::Signal1<void,string const&> Route::SyncOrderKeys;
  80 PBD::Signal0<void> Route::RemoteControlIDChange;
  81
  82 Route::Route (Session& sess, string name, Flag flg, DataType default_type)
  83         : SessionObject (sess, name)
  84         , Automatable (sess)
  85         , GraphNode( sess.route_graph )
  86         , _active (true)
  87         , _signal_latency (0)
  88         , _initial_delay (0)
  89         , _roll_delay (0)
  90         , _flags (flg)
  91         , _pending_declick (true)
  92         , _meter_point (MeterPostFader)
  93         , _self_solo (false)
  94         , _soloed_by_others_upstream (0)
  95         , _soloed_by_others_downstream (0)
  96         , _solo_isolated (0)
  97         , _denormal_protection (false)
  98         , _recordable (true)
  99         , _silent (false)
 100         , _declickable (false)
 101         , _mute_master (new MuteMaster (sess, name))
 102         , _have_internal_generator (false)
 103         , _solo_safe (false)
 104         , _default_type (default_type)
 105         , _remote_control_id (0)
 106         , _in_configure_processors (false)
 107 {
 108         processor_max_streams.reset();
 109         order_keys[N_("signal")] = order_key_cnt++;
 110 }
 111
 112 int
 113 Route::init ()
 114 {
 115         /* add standard controls */
 116
 117         _solo_control.reset (new SoloControllable (X_("solo"), shared_from_this ()));
 118         _mute_control.reset (new MuteControllable (X_("mute"), shared_from_this ()));
 119
 120         _solo_control->set_flags (Controllable::Flag (_solo_control->flags() | Controllable::Toggle));
 121         _mute_control->set_flags (Controllable::Flag (_mute_control->flags() | Controllable::Toggle));
 122
 123         add_control (_solo_control);
 124         add_control (_mute_control);
 125
 126         /* panning */
 127
 128         if (!(_flags & Route::MonitorOut)) {
 129                 Pannable* p = new Pannable (_session);
 130 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
 131                 boost_debug_shared_ptr_mark_interesting (p, "Pannable");
 132 #endif
 133                 _pannable.reset (p);
 134         }
 135
 136         /* input and output objects */
 137
 138         _input.reset (new IO (_session, _name, IO::Input, _default_type));
 139         _output.reset (new IO (_session, _name, IO::Output, _default_type));
 140
 141         _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
 142         _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
 143
 144         /* add amp processor  */
 145
 146         _amp.reset (new Amp (_session));
 147         add_processor (_amp, PostFader);
 148
 149         /* create standard processors: meter, main outs, monitor out;
 150            they will be added to _processors by setup_invisible_processors ()
 151         */
 152
 153         _meter.reset (new PeakMeter (_session));
 154         _meter->set_display_to_user (false);
 155         _meter->activate ();
 156
 157         _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
 158         _main_outs->activate ();
 159
 160         if (is_monitor()) {
 161                 /* where we listen to tracks */
 162                 _intreturn.reset (new InternalReturn (_session));
 163                 _intreturn->activate ();
 164
 165                 /* the thing that provides proper control over a control/monitor/listen bus
 166                    (such as per-channel cut, dim, solo, invert, etc).
 167                 */
 168                 _monitor_control.reset (new MonitorProcessor (_session));
 169                 _monitor_control->activate ();
 170         }
 171
 172         if (is_master() || is_monitor() || is_hidden()) {
 173                 _mute_master->set_solo_ignore (true);
 174         }
 175
 176         /* now that we have _meter, its safe to connect to this */
 177
 178         Metering::Meter.connect_same_thread (*this, (boost::bind (&Route::meter, this)));
 179
 180         {
 181                 /* run a configure so that the invisible processors get set up */
 182                 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
 183                 configure_processors (0);
 184         }
 185
 186         return 0;
 187 }
 188
 189 Route::~Route ()
 190 {
 191         DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
 192
 193         /* do this early so that we don't get incoming signals as we are going through destruction
 194          */
 195
 196         drop_connections ();
 197
 198         /* don't use clear_processors here, as it depends on the session which may
 199            be half-destroyed by now
 200         */
 201
 202         Glib::RWLock::WriterLock lm (_processor_lock);
 203         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
 204                 (*i)->drop_references ();
 205         }
 206
 207         _processors.clear ();
 208 }
 209
 210 void
 211 Route::set_remote_control_id (uint32_t id, bool notify_class_listeners)
 212 {
 213         if (id != _remote_control_id) {
 214                 _remote_control_id = id;
 215                 RemoteControlIDChanged ();
 216                 if (notify_class_listeners) {
 217                         RemoteControlIDChange ();
 218                 }
 219         }
 220 }
 221
 222 uint32_t
 223 Route::remote_control_id() const
 224 {
 225         return _remote_control_id;
 226 }
 227
 228 int32_t
 229 Route::order_key (std::string const & name) const
 230 {
 231         OrderKeys::const_iterator i = order_keys.find (name);
 232         if (i == order_keys.end()) {
 233                 return -1;
 234         }
 235
 236         return i->second;
 237 }
 238
 239 void
 240 Route::set_order_key (std::string const & name, int32_t n)
 241 {
 242         bool changed = false;
 243
 244         /* This method looks more complicated than it should, but
 245            it's important that we don't emit order_key_changed unless
 246            it actually has, as expensive things happen on receipt of that
 247            signal.
 248         */
 249
 250         if (order_keys.find(name) == order_keys.end() || order_keys[name] != n) {
 251                 order_keys[name] = n;
 252                 changed = true;
 253         }
 254
 255         if (Config->get_sync_all_route_ordering()) {
 256                 for (OrderKeys::iterator x = order_keys.begin(); x != order_keys.end(); ++x) {
 257                         if (x->second != n) {
 258                                 x->second = n;
 259                                 changed = true;
 260                         }
 261                 }
 262         }
 263
 264         if (changed) {
 265                 order_key_changed (); /* EMIT SIGNAL */
 266                 _session.set_dirty ();
 267         }
 268 }
 269
 270 /** Set all order keys to be the same as that for `base', if such a key
 271  *  exists in this route.
 272  *  @param base Base key.
 273  */
 274 void
 275 Route::sync_order_keys (std::string const & base)
 276 {
 277         if (order_keys.empty()) {
 278                 return;
 279         }
 280
 281         OrderKeys::iterator i;
 282         int32_t key;
 283
 284         if ((i = order_keys.find (base)) == order_keys.end()) {
 285                 /* key doesn't exist, use the first existing key (during session initialization) */
 286                 i = order_keys.begin();
 287                 key = i->second;
 288                 ++i;
 289         } else {
 290                 /* key exists - use it and reset all others (actually, itself included) */
 291                 key = i->second;
 292                 i = order_keys.begin();
 293         }
 294
 295         bool changed = false;
 296
 297         for (; i != order_keys.end(); ++i) {
 298                 if (i->second != key) {
 299                         i->second = key;
 300                         changed = true;
 301                 }
 302         }
 303
 304         if (changed) {
 305                 order_key_changed (); /* EMIT SIGNAL */
 306         }
 307 }
 308
 309 string
 310 Route::ensure_track_or_route_name(string name, Session &session)
 311 {
 312         string newname = name;
 313
 314         while (!session.io_name_is_legal (newname)) {
 315                 newname = bump_name_once (newname, '.');
 316         }
 317
 318         return newname;
 319 }
 320
 321
 322 void
 323 Route::inc_gain (gain_t fraction, void *src)
 324 {
 325         _amp->inc_gain (fraction, src);
 326 }
 327
 328 void
 329 Route::set_gain (gain_t val, void *src)
 330 {
 331         if (src != 0 && _route_group && src != _route_group && _route_group->is_active() && _route_group->is_gain()) {
 332
 333                 if (_route_group->is_relative()) {
 334
 335                         gain_t usable_gain = _amp->gain();
 336                         if (usable_gain < 0.000001f) {
 337                                 usable_gain = 0.000001f;
 338                         }
 339
 340                         gain_t delta = val;
 341                         if (delta < 0.000001f) {
 342                                 delta = 0.000001f;
 343                         }
 344
 345                         delta -= usable_gain;
 346
 347                         if (delta == 0.0f)
 348                                 return;
 349
 350                         gain_t factor = delta / usable_gain;
 351
 352                         if (factor > 0.0f) {
 353                                 factor = _route_group->get_max_factor(factor);
 354                                 if (factor == 0.0f) {
 355                                         _amp->gain_control()->Changed(); /* EMIT SIGNAL */
 356                                         return;
 357                                 }
 358                         } else {
 359                                 factor = _route_group->get_min_factor(factor);
 360                                 if (factor == 0.0f) {
 361                                         _amp->gain_control()->Changed(); /* EMIT SIGNAL */
 362                                         return;
 363                                 }
 364                         }
 365
 366                         _route_group->foreach_route (boost::bind (&Route::inc_gain, _1, factor, _route_group));
 367
 368                 } else {
 369
 370                         _route_group->foreach_route (boost::bind (&Route::set_gain, _1, val, _route_group));
 371                 }
 372
 373                 return;
 374         }
 375
 376         if (val == _amp->gain()) {
 377                 return;
 378         }
 379
 380         _amp->set_gain (val, src);
 381 }
 382
 383 void
 384 Route::maybe_declick (BufferSet&, framecnt_t, int)
 385 {
 386         /* this is the "bus" implementation and they never declick.
 387          */
 388         return;
 389 }
 390
 391 /** Process this route for one (sub) cycle (process thread)
 392  *
 393  * @param bufs Scratch buffers to use for the signal path
 394  * @param start_frame Initial transport frame
 395  * @param end_frame Final transport frame
 396  * @param nframes Number of frames to output (to ports)
 397  *
 398  * Note that (end_frame - start_frame) may not be equal to nframes when the
 399  * transport speed isn't 1.0 (eg varispeed).
 400  */
 401 void
 402 Route::process_output_buffers (BufferSet& bufs,
 403                                framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
 404                                bool /*with_processors*/, int declick,
 405                                bool gain_automation_ok)
 406 {
 407         bool monitor = should_monitor ();
 408
 409         bufs.is_silent (false);
 410
 411         /* figure out if we're going to use gain automation */
 412         if (gain_automation_ok) {
 413                 _amp->setup_gain_automation (start_frame, end_frame, nframes);
 414         } else {
 415                 _amp->apply_gain_automation (false);
 416         }
 417
 418         /* tell main outs what to do about monitoring */
 419         _main_outs->no_outs_cuz_we_no_monitor (!monitor);
 420
 421
 422         /* -------------------------------------------------------------------------------------------
 423            GLOBAL DECLICK (for transport changes etc.)
 424            ----------------------------------------------------------------------------------------- */
 425
 426         maybe_declick (bufs, nframes, declick);
 427         _pending_declick = 0;
 428
 429         /* -------------------------------------------------------------------------------------------
 430            DENORMAL CONTROL/PHASE INVERT
 431            ----------------------------------------------------------------------------------------- */
 432
 433         if (_phase_invert.any ()) {
 434
 435                 int chn = 0;
 436
 437                 if (_denormal_protection || Config->get_denormal_protection()) {
 438
 439                         for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
 440                                 Sample* const sp = i->data();
 441
 442                                 if (_phase_invert[chn]) {
 443                                         for (pframes_t nx = 0; nx < nframes; ++nx) {
 444                                                 sp[nx]  = -sp[nx];
 445                                                 sp[nx] += 1.0e-27f;
 446                                         }
 447                                 } else {
 448                                         for (pframes_t nx = 0; nx < nframes; ++nx) {
 449                                                 sp[nx] += 1.0e-27f;
 450                                         }
 451                                 }
 452                         }
 453
 454                 } else {
 455
 456                         for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
 457                                 Sample* const sp = i->data();
 458
 459                                 if (_phase_invert[chn]) {
 460                                         for (pframes_t nx = 0; nx < nframes; ++nx) {
 461                                                 sp[nx] = -sp[nx];
 462                                         }
 463                                 }
 464                         }
 465                 }
 466
 467         } else {
 468
 469                 if (_denormal_protection || Config->get_denormal_protection()) {
 470
 471                         for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
 472                                 Sample* const sp = i->data();
 473                                 for (pframes_t nx = 0; nx < nframes; ++nx) {
 474                                         sp[nx] += 1.0e-27f;
 475                                 }
 476                         }
 477
 478                 }
 479         }
 480
 481         /* -------------------------------------------------------------------------------------------
 482            and go ....
 483            ----------------------------------------------------------------------------------------- */
 484
 485         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
 486
 487                 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i)) {
 488                         break;
 489                 }
 490
 491 #ifndef NDEBUG
 492                 /* if it has any inputs, make sure they match */
 493                 if ((*i)->input_streams() != ChanCount::ZERO) {
 494                         if (bufs.count() != (*i)->input_streams()) {
 495                                 cerr << _name << " bufs = " << bufs.count()
 496                                      << " input for " << (*i)->name() << " = " << (*i)->input_streams()
 497                                      << endl;
 498                                 abort ();
 499                         }
 500                 }
 501 #endif
 502                 /* should we NOT run plugins here if the route is inactive?
 503                    do we catch route != active somewhere higher?
 504                 */
 505
 506                 (*i)->run (bufs, start_frame, end_frame, nframes, *i != _processors.back());
 507                 bufs.set_count ((*i)->output_streams());
 508         }
 509 }
 510
 511 ChanCount
 512 Route::n_process_buffers ()
 513 {
 514         return max (_input->n_ports(), processor_max_streams);
 515 }
 516
 517 void
 518 Route::passthru (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
 519 {
 520         BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
 521
 522         _silent = false;
 523
 524         assert (bufs.available() >= input_streams());
 525
 526         if (_input->n_ports() == ChanCount::ZERO) {
 527                 silence_unlocked (nframes);
 528         }
 529
 530         bufs.set_count (input_streams());
 531
 532         if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
 533
 534                 /* control/monitor bus ignores input ports when something is
 535                    feeding the listen "stream". data will "arrive" into the
 536                    route from the intreturn processor element.
 537                 */
 538                 bufs.silence (nframes, 0);
 539
 540         } else {
 541
 542                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 543
 544                         BufferSet::iterator o = bufs.begin(*t);
 545                         PortSet& ports (_input->ports());
 546
 547                         for (PortSet::iterator i = ports.begin(*t); i != ports.end(*t); ++i, ++o) {
 548                                 o->read_from (i->get_buffer(nframes), nframes);
 549                         }
 550                 }
 551         }
 552
 553         write_out_of_band_data (bufs, start_frame, end_frame, nframes);
 554         process_output_buffers (bufs, start_frame, end_frame, nframes, true, declick, true);
 555 }
 556
 557 void
 558 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
 559 {
 560         BufferSet& bufs (_session.get_silent_buffers (n_process_buffers()));
 561         bufs.set_count (_input->n_ports());
 562         write_out_of_band_data (bufs, start_frame, end_frame, nframes);
 563         process_output_buffers (bufs, start_frame, end_frame, nframes, true, declick, false);
 564 }
 565
 566 void
 567 Route::set_listen (bool yn, void* src)
 568 {
 569         if (_solo_safe) {
 570                 return;
 571         }
 572
 573         if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
 574                 _route_group->foreach_route (boost::bind (&Route::set_listen, _1, yn, _route_group));
 575                 return;
 576         }
 577
 578         if (_monitor_send) {
 579                 if (yn != _monitor_send->active()) {
 580                         if (yn) {
 581                                 _monitor_send->activate ();
 582                                 _mute_master->set_soloed (true);
 583                         } else {
 584                                 _monitor_send->deactivate ();
 585                                 _mute_master->set_soloed (false);
 586                         }
 587
 588                         listen_changed (src); /* EMIT SIGNAL */
 589                 }
 590         }
 591 }
 592
 593 bool
 594 Route::listening_via_monitor () const
 595 {
 596         if (_monitor_send) {
 597                 return _monitor_send->active ();
 598         } else {
 599                 return false;
 600         }
 601 }
 602
 603 void
 604 Route::set_solo_safe (bool yn, void *src)
 605 {
 606         if (_solo_safe != yn) {
 607                 _solo_safe = yn;
 608                 solo_safe_changed (src);
 609         }
 610 }
 611
 612 bool
 613 Route::solo_safe() const
 614 {
 615         return _solo_safe;
 616 }
 617
 618 void
 619 Route::set_solo (bool yn, void *src)
 620 {
 621         if (_solo_safe) {
 622                 return;
 623         }
 624
 625         if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
 626                 _route_group->foreach_route (boost::bind (&Route::set_solo, _1, yn, _route_group));
 627                 return;
 628         }
 629
 630         if (self_soloed() != yn) {
 631                 set_self_solo (yn);
 632                 set_mute_master_solo ();
 633                 solo_changed (true, src); /* EMIT SIGNAL */
 634                 _solo_control->Changed (); /* EMIT SIGNAL */
 635         }
 636 }
 637
 638 void
 639 Route::set_self_solo (bool yn)
 640 {
 641         _self_solo = yn;
 642 }
 643
 644 void
 645 Route::mod_solo_by_others_upstream (int32_t delta)
 646 {
 647         if (_solo_safe) {
 648                 return;
 649         }
 650
 651         uint32_t old_sbu = _soloed_by_others_upstream;
 652
 653         if (delta < 0) {
 654                 if (_soloed_by_others_upstream >= (uint32_t) abs (delta)) {
 655                         _soloed_by_others_upstream += delta;
 656                 } else {
 657                         _soloed_by_others_upstream = 0;
 658                 }
 659         } else {
 660                 _soloed_by_others_upstream += delta;
 661         }
 662
 663         DEBUG_TRACE (DEBUG::Solo, string_compose (
 664                              "%1 SbU delta %2 = %3 old = %4 sbd %5 ss %6 exclusive %7\n",
 665                              name(), delta, _soloed_by_others_upstream, old_sbu,
 666                              _soloed_by_others_downstream, _self_solo, Config->get_exclusive_solo()));
 667
 668         /* push the inverse solo change to everything that feeds us.
 669
 670            This is important for solo-within-group. When we solo 1 track out of N that
 671            feed a bus, that track will cause mod_solo_by_upstream (+1) to be called
 672            on the bus. The bus then needs to call mod_solo_by_downstream (-1) on all
 673            tracks that feed it. This will silence them if they were audible because
 674            of a bus solo, but the newly soloed track will still be audible (because
 675            it is self-soloed).
 676
 677            but .. do this only when we are being told to solo-by-upstream (i.e delta = +1),
 678            not in reverse.
 679         */
 680
 681         if ((_self_solo || _soloed_by_others_downstream) &&
 682             ((old_sbu == 0 && _soloed_by_others_upstream > 0) ||
 683              (old_sbu > 0 && _soloed_by_others_upstream == 0))) {
 684
 685                 if (delta > 0 || !Config->get_exclusive_solo()) {
 686                         DEBUG_TRACE (DEBUG::Solo, "\t ... INVERT push\n");
 687                         for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
 688                                 boost::shared_ptr<Route> sr = i->r.lock();
 689                                 if (sr) {
 690                                         sr->mod_solo_by_others_downstream (-delta);
 691                                 }
 692                         }
 693                 }
 694         }
 695
 696         set_mute_master_solo ();
 697         solo_changed (false, this);
 698 }
 699
 700 void
 701 Route::mod_solo_by_others_downstream (int32_t delta)
 702 {
 703         if (_solo_safe) {
 704                 return;
 705         }
 706
 707         if (delta < 0) {
 708                 if (_soloed_by_others_downstream >= (uint32_t) abs (delta)) {
 709                         _soloed_by_others_downstream += delta;
 710                 } else {
 711                         _soloed_by_others_downstream = 0;
 712                 }
 713         } else {
 714                 _soloed_by_others_downstream += delta;
 715         }
 716
 717         DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 SbD delta %2 = %3\n", name(), delta, _soloed_by_others_downstream));
 718
 719         set_mute_master_solo ();
 720         solo_changed (false, this);
 721 }
 722
 723 void
 724 Route::set_mute_master_solo ()
 725 {
 726         _mute_master->set_soloed (self_soloed() || soloed_by_others_downstream() || soloed_by_others_upstream());
 727 }
 728
 729 void
 730 Route::set_solo_isolated (bool yn, void *src)
 731 {
 732         if (is_master() || is_monitor() || is_hidden()) {
 733                 return;
 734         }
 735
 736         if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
 737                 _route_group->foreach_route (boost::bind (&Route::set_solo_isolated, _1, yn, _route_group));
 738                 return;
 739         }
 740
 741         /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
 742
 743         boost::shared_ptr<RouteList> routes = _session.get_routes ();
 744         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 745
 746                 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_hidden()) {
 747                         continue;
 748                 }
 749
 750                 bool sends_only;
 751                 bool does_feed = direct_feeds (*i, &sends_only); // we will recurse anyway, so don't use ::feeds()
 752
 753                 if (does_feed && !sends_only) {
 754                         (*i)->set_solo_isolated (yn, (*i)->route_group());
 755                 }
 756         }
 757
 758         /* XXX should we back-propagate as well? (April 2010: myself and chris goddard think not) */
 759
 760         bool changed = false;
 761
 762         if (yn) {
 763                 if (_solo_isolated == 0) {
 764                         _mute_master->set_solo_ignore (true);
 765                         changed = true;
 766                 }
 767                 _solo_isolated++;
 768         } else {
 769                 if (_solo_isolated > 0) {
 770                         _solo_isolated--;
 771                         if (_solo_isolated == 0) {
 772                                 _mute_master->set_solo_ignore (false);
 773                                 changed = true;
 774                         }
 775                 }
 776         }
 777
 778         if (changed) {
 779                 solo_isolated_changed (src);
 780         }
 781 }
 782
 783 bool
 784 Route::solo_isolated () const
 785 {
 786         return _solo_isolated > 0;
 787 }
 788
 789 void
 790 Route::set_mute_points (MuteMaster::MutePoint mp)
 791 {
 792         _mute_master->set_mute_points (mp);
 793         mute_points_changed (); /* EMIT SIGNAL */
 794
 795         if (_mute_master->muted_by_self()) {
 796                 mute_changed (this); /* EMIT SIGNAL */
 797                 _mute_control->Changed (); /* EMIT SIGNAL */
 798         }
 799 }
 800
 801 void
 802 Route::set_mute (bool yn, void *src)
 803 {
 804         if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_mute()) {
 805                 _route_group->foreach_route (boost::bind (&Route::set_mute, _1, yn, _route_group));
 806                 return;
 807         }
 808
 809         if (muted() != yn) {
 810                 _mute_master->set_muted_by_self (yn);
 811                 mute_changed (src); /* EMIT SIGNAL */
 812                 _mute_control->Changed (); /* EMIT SIGNAL */
 813         }
 814 }
 815
 816 bool
 817 Route::muted () const
 818 {
 819         return _mute_master->muted_by_self();
 820 }
 821
 822 #if 0
 823 static void
 824 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
 825 {
 826         cerr << name << " {" << endl;
 827         for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
 828                         p != procs.end(); ++p) {
 829                 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
 830         }
 831         cerr << "}" << endl;
 832 }
 833 #endif
 834
 835 int
 836 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
 837 {
 838         ProcessorList::iterator loc;
 839
 840         /* XXX this is not thread safe - we don't hold the lock across determining the iter
 841            to add before and actually doing the insertion. dammit.
 842         */
 843
 844         if (placement == PreFader) {
 845                 /* generic pre-fader: insert immediately before the amp */
 846                 loc = find (_processors.begin(), _processors.end(), _amp);
 847         } else {
 848                 /* generic post-fader: insert right before the main outs */
 849                 loc = find (_processors.begin(), _processors.end(), _main_outs);
 850         }
 851
 852         return add_processor (processor, loc, err, activation_allowed);
 853 }
 854
 855
 856 /** Add a processor to a route such that it ends up with a given index into the visible processors.
 857  *  @param index Index to add the processor at, or -1 to add at the end of the list.
 858  */
 859
 860 int
 861 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
 862 {
 863         /* XXX this is not thread safe - we don't hold the lock across determining the iter
 864            to add before and actually doing the insertion. dammit.
 865         */
 866
 867         if (index == -1) {
 868                 return add_processor (processor, _processors.end(), err, activation_allowed);
 869         }
 870
 871         ProcessorList::iterator i = _processors.begin ();
 872         int j = 0;
 873         while (i != _processors.end() && j < index) {
 874                 if ((*i)->display_to_user()) {
 875                         ++j;
 876                 }
 877
 878                 ++i;
 879         }
 880
 881         return add_processor (processor, i, err, activation_allowed);
 882 }
 883
 884 /** Add a processor to the route.
 885  *  @param iter an iterator in _processors; the new processor will be inserted immediately before this location.
 886  */
 887 int
 888 Route::add_processor (boost::shared_ptr<Processor> processor, ProcessorList::iterator iter, ProcessorStreams* err, bool activation_allowed)
 889 {
 890         assert (processor != _meter);
 891         assert (processor != _main_outs);
 892
 893         DEBUG_TRACE (DEBUG::Processors, string_compose (
 894                              "%1 adding processor %2\n", name(), processor->name()));
 895
 896         if (!_session.engine().connected() || !processor) {
 897                 return 1;
 898         }
 899
 900         {
 901                 Glib::RWLock::WriterLock lm (_processor_lock);
 902                 ProcessorState pstate (this);
 903
 904                 boost::shared_ptr<PluginInsert> pi;
 905                 boost::shared_ptr<PortInsert> porti;
 906
 907                 ProcessorList::iterator loc = find(_processors.begin(), _processors.end(), processor);
 908
 909                 if (processor == _amp) {
 910                         // Ensure only one amp is in the list at any time
 911                         if (loc != _processors.end()) {
 912                                 if (iter == loc) { // Already in place, do nothing
 913                                         return 0;
 914                                 } else { // New position given, relocate
 915                                         _processors.erase (loc);
 916                                 }
 917                         }
 918
 919                 } else {
 920                         if (loc != _processors.end()) {
 921                                 cerr << "ERROR: Processor added to route twice!" << endl;
 922                                 return 1;
 923                         }
 924
 925                         loc = iter;
 926                 }
 927
 928                 _processors.insert (loc, processor);
 929
 930                 // Set up processor list channels.  This will set processor->[input|output]_streams(),
 931                 // configure redirect ports properly, etc.
 932
 933                 {
 934                         Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
 935
 936                         if (configure_processors_unlocked (err)) {
 937                                 pstate.restore ();
 938                                 configure_processors_unlocked (0); // it worked before we tried to add it ...
 939                                 return -1;
 940                         }
 941                 }
 942
 943                 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(processor)) != 0) {
 944
 945                         if (pi->has_no_inputs ()) {
 946                                 /* generator plugin */
 947                                 _have_internal_generator = true;
 948                         }
 949
 950                 }
 951
 952                 if (activation_allowed) {
 953                         processor->activate ();
 954                 }
 955
 956                 processor->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
 957
 958                 _output->set_user_latency (0);
 959         }
 960
 961         processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
 962         set_processor_positions ();
 963
 964         return 0;
 965 }
 966
 967 bool
 968 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
 969 {
 970         const XMLProperty *prop;
 971
 972         try {
 973                 boost::shared_ptr<Processor> processor;
 974
 975                 /* bit of a hack: get the `placement' property from the <Redirect> tag here
 976                    so that we can add the processor in the right place (pre/post-fader)
 977                 */
 978
 979                 XMLNodeList const & children = node.children ();
 980                 XMLNodeList::const_iterator i = children.begin ();
 981
 982                 while (i != children.end() && (*i)->name() != X_("Redirect")) {
 983                         ++i;
 984                 }
 985
 986                 Placement placement = PreFader;
 987
 988                 if (i != children.end()) {
 989                         if ((prop = (*i)->property (X_("placement"))) != 0) {
 990                                 placement = Placement (string_2_enum (prop->value(), placement));
 991                         }
 992                 }
 993
 994                 if (node.name() == "Insert") {
 995
 996                         if ((prop = node.property ("type")) != 0) {
 997
 998                                 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
 999                                                 prop->value() == "lv2" ||
1000                                                 prop->value() == "vst" ||
1001                                                 prop->value() == "lxvst" ||
1002                                                 prop->value() == "audiounit") {
1003
1004                                         processor.reset (new PluginInsert (_session));
1005
1006                                 } else {
1007
1008                                         processor.reset (new PortInsert (_session, _pannable, _mute_master));
1009                                 }
1010
1011                         }
1012
1013                 } else if (node.name() == "Send") {
1014
1015                         processor.reset (new Send (_session, _pannable, _mute_master));
1016
1017                 } else {
1018
1019                         error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
1020                         return false;
1021                 }
1022
1023                 if (processor->set_state (node, version)) {
1024                         return false;
1025                 }
1026
1027                 return (add_processor (processor, placement) == 0);
1028         }
1029
1030         catch (failed_constructor &err) {
1031                 warning << _("processor could not be created. Ignored.") << endmsg;
1032                 return false;
1033         }
1034 }
1035
1036 int
1037 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
1038 {
1039         /* NOTE: this is intended to be used ONLY when copying
1040            processors from another Route. Hence the subtle
1041            differences between this and ::add_processor()
1042         */
1043
1044         ProcessorList::iterator loc;
1045
1046         if (before) {
1047                 loc = find(_processors.begin(), _processors.end(), before);
1048         } else {
1049                 /* nothing specified - at end */
1050                 loc = _processors.end ();
1051         }
1052
1053         if (!_session.engine().connected()) {
1054                 return 1;
1055         }
1056
1057         if (others.empty()) {
1058                 return 0;
1059         }
1060
1061         {
1062                 Glib::RWLock::WriterLock lm (_processor_lock);
1063                 ProcessorState pstate (this);
1064
1065                 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1066
1067                         if (*i == _meter) {
1068                                 continue;
1069                         }
1070
1071                         boost::shared_ptr<PluginInsert> pi;
1072
1073                         if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1074                                 pi->set_count (1);
1075                         }
1076
1077                         _processors.insert (loc, *i);
1078
1079                         if ((*i)->active()) {
1080                                 (*i)->activate ();
1081                         }
1082
1083                         {
1084                                 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1085                                 if (configure_processors_unlocked (err)) {
1086                                         pstate.restore ();
1087                                         configure_processors_unlocked (0); // it worked before we tried to add it ...
1088                                         return -1;
1089                                 }
1090                         }
1091
1092                         (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1093                 }
1094
1095                 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1096                         boost::shared_ptr<PluginInsert> pi;
1097
1098                         if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1099                                 if (pi->has_no_inputs ()) {
1100                                         _have_internal_generator = true;
1101                                         break;
1102                                 }
1103                         }
1104                 }
1105
1106                 _output->set_user_latency (0);
1107         }
1108
1109         processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1110         set_processor_positions ();
1111
1112         return 0;
1113 }
1114
1115 void
1116 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1117 {
1118         if (p == PreFader) {
1119                 start = _processors.begin();
1120                 end = find(_processors.begin(), _processors.end(), _amp);
1121         } else {
1122                 start = find(_processors.begin(), _processors.end(), _amp);
1123                 ++start;
1124                 end = _processors.end();
1125         }
1126 }
1127
1128 /** Turn off all processors with a given placement
1129  * @param p Placement of processors to disable
1130  */
1131 void
1132 Route::disable_processors (Placement p)
1133 {
1134         Glib::RWLock::ReaderLock lm (_processor_lock);
1135
1136         ProcessorList::iterator start, end;
1137         placement_range(p, start, end);
1138
1139         for (ProcessorList::iterator i = start; i != end; ++i) {
1140                 (*i)->deactivate ();
1141         }
1142
1143         _session.set_dirty ();
1144 }
1145
1146 /** Turn off all redirects
1147  */
1148 void
1149 Route::disable_processors ()
1150 {
1151         Glib::RWLock::ReaderLock lm (_processor_lock);
1152
1153         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1154                 (*i)->deactivate ();
1155         }
1156
1157         _session.set_dirty ();
1158 }
1159
1160 /** Turn off all redirects with a given placement
1161  * @param p Placement of redirects to disable
1162  */
1163 void
1164 Route::disable_plugins (Placement p)
1165 {
1166         Glib::RWLock::ReaderLock lm (_processor_lock);
1167
1168         ProcessorList::iterator start, end;
1169         placement_range(p, start, end);
1170
1171         for (ProcessorList::iterator i = start; i != end; ++i) {
1172                 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1173                         (*i)->deactivate ();
1174                 }
1175         }
1176
1177         _session.set_dirty ();
1178 }
1179
1180 /** Turn off all plugins
1181  */
1182 void
1183 Route::disable_plugins ()
1184 {
1185         Glib::RWLock::ReaderLock lm (_processor_lock);
1186
1187         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1188                 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1189                         (*i)->deactivate ();
1190                 }
1191         }
1192
1193         _session.set_dirty ();
1194 }
1195
1196
1197 void
1198 Route::ab_plugins (bool forward)
1199 {
1200         Glib::RWLock::ReaderLock lm (_processor_lock);
1201
1202         if (forward) {
1203
1204                 /* forward = turn off all active redirects, and mark them so that the next time
1205                    we go the other way, we will revert them
1206                 */
1207
1208                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1209                         if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1210                                 continue;
1211                         }
1212
1213                         if ((*i)->active()) {
1214                                 (*i)->deactivate ();
1215                                 (*i)->set_next_ab_is_active (true);
1216                         } else {
1217                                 (*i)->set_next_ab_is_active (false);
1218                         }
1219                 }
1220
1221         } else {
1222
1223                 /* backward = if the redirect was marked to go active on the next ab, do so */
1224
1225                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1226
1227                         if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1228                                 continue;
1229                         }
1230
1231                         if ((*i)->get_next_ab_is_active()) {
1232                                 (*i)->activate ();
1233                         } else {
1234                                 (*i)->deactivate ();
1235                         }
1236                 }
1237         }
1238
1239         _session.set_dirty ();
1240 }
1241
1242
1243 /** Remove processors with a given placement.
1244  * @param p Placement of processors to remove.
1245  */
1246 void
1247 Route::clear_processors (Placement p)
1248 {
1249         if (!_session.engine().connected()) {
1250                 return;
1251         }
1252
1253         bool already_deleting = _session.deletion_in_progress();
1254         if (!already_deleting) {
1255                 _session.set_deletion_in_progress();
1256         }
1257
1258         {
1259                 Glib::RWLock::WriterLock lm (_processor_lock);
1260                 ProcessorList new_list;
1261                 ProcessorStreams err;
1262                 bool seen_amp = false;
1263
1264                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1265
1266                         if (*i == _amp) {
1267                                 seen_amp = true;
1268                         }
1269
1270                         if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs) {
1271
1272                                 /* you can't remove these */
1273
1274                                 new_list.push_back (*i);
1275
1276                         } else {
1277                                 if (seen_amp) {
1278
1279                                         switch (p) {
1280                                         case PreFader:
1281                                                 new_list.push_back (*i);
1282                                                 break;
1283                                         case PostFader:
1284                                                 (*i)->drop_references ();
1285                                                 break;
1286                                         }
1287
1288                                 } else {
1289
1290                                         switch (p) {
1291                                         case PreFader:
1292                                                 (*i)->drop_references ();
1293                                                 break;
1294                                         case PostFader:
1295                                                 new_list.push_back (*i);
1296                                                 break;
1297                                         }
1298                                 }
1299                         }
1300                 }
1301
1302                 _processors = new_list;
1303
1304                 {
1305                         Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1306                         configure_processors_unlocked (&err); // this can't fail
1307                 }
1308         }
1309
1310         processor_max_streams.reset();
1311         _have_internal_generator = false;
1312         processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1313         set_processor_positions ();
1314
1315         if (!already_deleting) {
1316                 _session.clear_deletion_in_progress();
1317         }
1318 }
1319
1320 int
1321 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err)
1322 {
1323         /* these can never be removed */
1324
1325         if (processor == _amp || processor == _meter || processor == _main_outs) {
1326                 return 0;
1327         }
1328
1329         if (!_session.engine().connected()) {
1330                 return 1;
1331         }
1332
1333         processor_max_streams.reset();
1334
1335         {
1336                 Glib::RWLock::WriterLock lm (_processor_lock);
1337                 ProcessorState pstate (this);
1338
1339                 ProcessorList::iterator i;
1340                 bool removed = false;
1341
1342                 for (i = _processors.begin(); i != _processors.end(); ) {
1343                         if (*i == processor) {
1344
1345                                 /* move along, see failure case for configure_processors()
1346                                    where we may need to reconfigure the processor.
1347                                 */
1348
1349                                 /* stop redirects that send signals to JACK ports
1350                                    from causing noise as a result of no longer being
1351                                    run.
1352                                 */
1353
1354                                 boost::shared_ptr<IOProcessor> iop;
1355
1356                                 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (*i)) != 0) {
1357                                         if (iop->input()) {
1358                                                 iop->input()->disconnect (this);
1359                                         }
1360                                         if (iop->output()) {
1361                                                 iop->output()->disconnect (this);
1362                                         }
1363                                 }
1364
1365                                 i = _processors.erase (i);
1366                                 removed = true;
1367                                 break;
1368
1369                         } else {
1370                                 ++i;
1371                         }
1372
1373                         _output->set_user_latency (0);
1374                 }
1375
1376                 if (!removed) {
1377                         /* what? */
1378                         return 1;
1379                 }
1380
1381                 {
1382                         Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1383
1384                         if (configure_processors_unlocked (err)) {
1385                                 pstate.restore ();
1386                                 /* we know this will work, because it worked before :) */
1387                                 configure_processors_unlocked (0);
1388                                 return -1;
1389                         }
1390                 }
1391
1392                 _have_internal_generator = false;
1393
1394                 for (i = _processors.begin(); i != _processors.end(); ++i) {
1395                         boost::shared_ptr<PluginInsert> pi;
1396
1397                         if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1398                                 if (pi->has_no_inputs ()) {
1399                                         _have_internal_generator = true;
1400                                         break;
1401                                 }
1402                         }
1403                 }
1404         }
1405
1406         processor->drop_references ();
1407         processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1408         set_processor_positions ();
1409
1410         return 0;
1411 }
1412
1413 int
1414 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1415 {
1416         ProcessorList deleted;
1417
1418         if (!_session.engine().connected()) {
1419                 return 1;
1420         }
1421
1422         processor_max_streams.reset();
1423
1424         {
1425                 Glib::RWLock::WriterLock lm (_processor_lock);
1426                 ProcessorState pstate (this);
1427
1428                 ProcessorList::iterator i;
1429                 boost::shared_ptr<Processor> processor;
1430
1431                 for (i = _processors.begin(); i != _processors.end(); ) {
1432
1433                         processor = *i;
1434
1435                         /* these can never be removed */
1436
1437                         if (processor == _amp || processor == _meter || processor == _main_outs) {
1438                                 ++i;
1439                                 continue;
1440                         }
1441
1442                         /* see if its in the list of processors to delete */
1443
1444                         if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1445                                 ++i;
1446                                 continue;
1447                         }
1448
1449                         /* stop IOProcessors that send to JACK ports
1450                            from causing noise as a result of no longer being
1451                            run.
1452                         */
1453
1454                         boost::shared_ptr<IOProcessor> iop;
1455
1456                         if ((iop = boost::dynamic_pointer_cast<IOProcessor> (processor)) != 0) {
1457                                 iop->disconnect ();
1458                         }
1459
1460                         deleted.push_back (processor);
1461                         i = _processors.erase (i);
1462                 }
1463
1464                 if (deleted.empty()) {
1465                         /* none of those in the requested list were found */
1466                         return 0;
1467                 }
1468
1469                 _output->set_user_latency (0);
1470
1471                 {
1472                         Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1473
1474                         if (configure_processors_unlocked (err)) {
1475                                 pstate.restore ();
1476                                 /* we know this will work, because it worked before :) */
1477                                 configure_processors_unlocked (0);
1478                                 return -1;
1479                         }
1480                 }
1481
1482                 _have_internal_generator = false;
1483
1484                 for (i = _processors.begin(); i != _processors.end(); ++i) {
1485                         boost::shared_ptr<PluginInsert> pi;
1486
1487                         if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1488                                 if (pi->has_no_inputs ()) {
1489                                         _have_internal_generator = true;
1490                                         break;
1491                                 }
1492                         }
1493                 }
1494         }
1495
1496         /* now try to do what we need to so that those that were removed will be deleted */
1497
1498         for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1499                 (*i)->drop_references ();
1500         }
1501
1502         processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1503         set_processor_positions ();
1504
1505         return 0;
1506 }
1507
1508 /** Caller must hold process lock */
1509 int
1510 Route::configure_processors (ProcessorStreams* err)
1511 {
1512         assert (!AudioEngine::instance()->process_lock().trylock());
1513
1514         if (!_in_configure_processors) {
1515                 Glib::RWLock::WriterLock lm (_processor_lock);
1516                 return configure_processors_unlocked (err);
1517         }
1518
1519         return 0;
1520 }
1521
1522 ChanCount
1523 Route::input_streams () const
1524 {
1525         return _input->n_ports ();
1526 }
1527
1528 list<pair<ChanCount, ChanCount> >
1529 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1530 {
1531         Glib::RWLock::ReaderLock lm (_processor_lock);
1532
1533         return try_configure_processors_unlocked (in, err);
1534 }
1535
1536 list<pair<ChanCount, ChanCount> >
1537 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1538 {
1539         // Check each processor in order to see if we can configure as requested
1540         ChanCount out;
1541         list<pair<ChanCount, ChanCount> > configuration;
1542         uint32_t index = 0;
1543
1544         DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1545         DEBUG_TRACE (DEBUG::Processors, "{\n");
1546
1547         for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1548
1549                 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1550                         DEBUG_TRACE (DEBUG::Processors, "--- CONFIGURE ABORTED due to unknown processor.\n");
1551                         break;
1552                 }
1553
1554                 if ((*p)->can_support_io_configuration(in, out)) {
1555                         DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1556                         configuration.push_back(make_pair(in, out));
1557                         in = out;
1558                 } else {
1559                         if (err) {
1560                                 err->index = index;
1561                                 err->count = in;
1562                         }
1563                         DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1564                         DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1565                         DEBUG_TRACE (DEBUG::Processors, "}\n");
1566                         return list<pair<ChanCount, ChanCount> > ();
1567                 }
1568         }
1569
1570         DEBUG_TRACE (DEBUG::Processors, "}\n");
1571
1572         return configuration;
1573 }
1574
1575 /** Set the input/output configuration of each processor in the processors list.
1576  *  Caller must hold process lock.
1577  *  Return 0 on success, otherwise configuration is impossible.
1578  */
1579 int
1580 Route::configure_processors_unlocked (ProcessorStreams* err)
1581 {
1582         assert (!AudioEngine::instance()->process_lock().trylock());
1583
1584         if (_in_configure_processors) {
1585                 return 0;
1586         }
1587
1588         /* put invisible processors where they should be */
1589         setup_invisible_processors ();
1590
1591         _in_configure_processors = true;
1592
1593         list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1594
1595         if (configuration.empty ()) {
1596                 _in_configure_processors = false;
1597                 return -1;
1598         }
1599
1600         ChanCount out;
1601
1602         list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1603         for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1604
1605                 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1606                         break;
1607                 }
1608
1609                 (*p)->configure_io(c->first, c->second);
1610                 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1611                 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1612                 out = c->second;
1613         }
1614
1615         if (_meter) {
1616                 _meter->reset_max_channels (processor_max_streams);
1617         }
1618
1619         /* make sure we have sufficient scratch buffers to cope with the new processor
1620            configuration
1621         */
1622         _session.ensure_buffers (n_process_buffers ());
1623
1624         DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1625
1626         _in_configure_processors = false;
1627         return 0;
1628 }
1629
1630 /** Set all processors with a given placement to a given active state.
1631  * @param p Placement of processors to change.
1632  * @param state New active state for those processors.
1633  */
1634 void
1635 Route::all_processors_active (Placement p, bool state)
1636 {
1637         Glib::RWLock::ReaderLock lm (_processor_lock);
1638
1639         if (_processors.empty()) {
1640                 return;
1641         }
1642
1643         ProcessorList::iterator start, end;
1644         placement_range(p, start, end);
1645
1646         for (ProcessorList::iterator i = start; i != end; ++i) {
1647                 if (state) {
1648                         (*i)->activate ();
1649                 } else {
1650                         (*i)->deactivate ();
1651                 }
1652         }
1653
1654         _session.set_dirty ();
1655 }
1656
1657 int
1658 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
1659 {
1660         /* "new_order" is an ordered list of processors to be positioned according to "placement".
1661            NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1662            processors in the current actual processor list that are hidden. Any visible processors
1663            in the current list but not in "new_order" will be assumed to be deleted.
1664         */
1665
1666         {
1667                 Glib::RWLock::WriterLock lm (_processor_lock);
1668                 ProcessorState pstate (this);
1669
1670                 ProcessorList::iterator oiter;
1671                 ProcessorList::const_iterator niter;
1672                 ProcessorList as_it_will_be;
1673
1674                 oiter = _processors.begin();
1675                 niter = new_order.begin();
1676
1677                 while (niter !=  new_order.end()) {
1678
1679                         /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1680                            then append it to the temp list.
1681
1682                            Otherwise, see if the next processor in the old list is in the new list. if not,
1683                            its been deleted. If its there, append it to the temp list.
1684                         */
1685
1686                         if (oiter == _processors.end()) {
1687
1688                                 /* no more elements in the old list, so just stick the rest of
1689                                    the new order onto the temp list.
1690                                 */
1691
1692                                 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1693                                 while (niter != new_order.end()) {
1694                                         ++niter;
1695                                 }
1696                                 break;
1697
1698                         } else {
1699
1700                                 if (!(*oiter)->display_to_user()) {
1701
1702                                         as_it_will_be.push_back (*oiter);
1703
1704                                 } else {
1705
1706                                         /* visible processor: check that its in the new order */
1707
1708                                         if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1709                                                 /* deleted: do nothing, shared_ptr<> will clean up */
1710                                         } else {
1711                                                 /* ignore this one, and add the next item from the new order instead */
1712                                                 as_it_will_be.push_back (*niter);
1713                                                 ++niter;
1714                                         }
1715                                 }
1716
1717                                 /* now remove from old order - its taken care of no matter what */
1718                                 oiter = _processors.erase (oiter);
1719                         }
1720
1721                 }
1722
1723                 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1724
1725                 {
1726                         Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1727
1728                         if (configure_processors_unlocked (err)) {
1729                                 pstate.restore ();
1730                                 return -1;
1731                         }
1732                 }
1733         }
1734
1735         processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1736         set_processor_positions ();
1737
1738         return 0;
1739 }
1740
1741 XMLNode&
1742 Route::get_state()
1743 {
1744         return state(true);
1745 }
1746
1747 XMLNode&
1748 Route::get_template()
1749 {
1750         return state(false);
1751 }
1752
1753 XMLNode&
1754 Route::state(bool full_state)
1755 {
1756         XMLNode *node = new XMLNode("Route");
1757         ProcessorList::iterator i;
1758         char buf[32];
1759
1760         id().print (buf, sizeof (buf));
1761         node->add_property("id", buf);
1762         node->add_property ("name", _name);
1763         node->add_property("default-type", _default_type.to_string());
1764
1765         if (_flags) {
1766                 node->add_property("flags", enum_2_string (_flags));
1767         }
1768
1769         node->add_property("active", _active?"yes":"no");
1770         string p;
1771         boost::to_string (_phase_invert, p);
1772         node->add_property("phase-invert", p);
1773         node->add_property("denormal-protection", _denormal_protection?"yes":"no");
1774         node->add_property("meter-point", enum_2_string (_meter_point));
1775
1776         if (_route_group) {
1777                 node->add_property("route-group", _route_group->name());
1778         }
1779
1780         string order_string;
1781         OrderKeys::iterator x = order_keys.begin();
1782
1783         while (x != order_keys.end()) {
1784                 order_string += string ((*x).first);
1785                 order_string += '=';
1786                 snprintf (buf, sizeof(buf), "%ld", (*x).second);
1787                 order_string += buf;
1788
1789                 ++x;
1790
1791                 if (x == order_keys.end()) {
1792                         break;
1793                 }
1794
1795                 order_string += ':';
1796         }
1797         node->add_property ("order-keys", order_string);
1798         node->add_property ("self-solo", (_self_solo ? "yes" : "no"));
1799         snprintf (buf, sizeof (buf), "%d", _soloed_by_others_upstream);
1800         node->add_property ("soloed-by-upstream", buf);
1801         snprintf (buf, sizeof (buf), "%d", _soloed_by_others_downstream);
1802         node->add_property ("soloed-by-downstream", buf);
1803         node->add_property ("solo-isolated", solo_isolated() ? "yes" : "no");
1804         node->add_property ("solo-safe", _solo_safe ? "yes" : "no");
1805
1806         node->add_child_nocopy (_input->state (full_state));
1807         node->add_child_nocopy (_output->state (full_state));
1808         node->add_child_nocopy (_solo_control->get_state ());
1809         node->add_child_nocopy (_mute_control->get_state ());
1810         node->add_child_nocopy (_mute_master->get_state ());
1811
1812         XMLNode* remote_control_node = new XMLNode (X_("RemoteControl"));
1813         snprintf (buf, sizeof (buf), "%d", _remote_control_id);
1814         remote_control_node->add_property (X_("id"), buf);
1815         node->add_child_nocopy (*remote_control_node);
1816
1817         if (_comment.length()) {
1818                 XMLNode *cmt = node->add_child ("Comment");
1819                 cmt->add_content (_comment);
1820         }
1821
1822         if (_pannable) {
1823                 node->add_child_nocopy (_pannable->state (full_state));
1824         }
1825
1826         for (i = _processors.begin(); i != _processors.end(); ++i) {
1827                 node->add_child_nocopy((*i)->state (full_state));
1828         }
1829
1830         if (_extra_xml){
1831                 node->add_child_copy (*_extra_xml);
1832         }
1833
1834         return *node;
1835 }
1836
1837 int
1838 Route::set_state (const XMLNode& node, int version)
1839 {
1840         return _set_state (node, version);
1841 }
1842
1843 int
1844 Route::_set_state (const XMLNode& node, int version)
1845 {
1846         if (version < 3000) {
1847                 return _set_state_2X (node, version);
1848         }
1849
1850         XMLNodeList nlist;
1851         XMLNodeConstIterator niter;
1852         XMLNode *child;
1853         const XMLProperty *prop;
1854
1855         if (node.name() != "Route"){
1856                 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
1857                 return -1;
1858         }
1859
1860         if ((prop = node.property (X_("name"))) != 0) {
1861                 Route::set_name (prop->value());
1862         }
1863
1864         set_id (node);
1865
1866         if ((prop = node.property (X_("flags"))) != 0) {
1867                 _flags = Flag (string_2_enum (prop->value(), _flags));
1868         } else {
1869                 _flags = Flag (0);
1870         }
1871
1872         if (is_master() || is_monitor() || is_hidden()) {
1873                 _mute_master->set_solo_ignore (true);
1874         }
1875
1876         if (is_monitor()) {
1877                 /* monitor bus does not get a panner, but if (re)created
1878                    via XML, it will already have one by the time we
1879                    call ::set_state(). so ... remove it.
1880                 */
1881                 unpan ();
1882         }
1883
1884         /* add all processors (except amp, which is always present) */
1885
1886         nlist = node.children();
1887         XMLNode processor_state (X_("processor_state"));
1888
1889         Stateful::save_extra_xml (node);
1890
1891         for (niter = nlist.begin(); niter != nlist.end(); ++niter){
1892
1893                 child = *niter;
1894
1895                 if (child->name() == IO::state_node_name) {
1896                         if ((prop = child->property (X_("direction"))) == 0) {
1897                                 continue;
1898                         }
1899
1900                         if (prop->value() == "Input") {
1901                                 _input->set_state (*child, version);
1902                         } else if (prop->value() == "Output") {
1903                                 _output->set_state (*child, version);
1904                         }
1905                 }
1906
1907                 if (child->name() == X_("Processor")) {
1908                         processor_state.add_child_copy (*child);
1909                 }
1910
1911
1912                 if (child->name() == X_("Pannable")) {
1913                         if (_pannable) {
1914                                 _pannable->set_state (*child, version);
1915                         } else {
1916                                 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
1917                         }
1918                 }
1919         }
1920
1921         if ((prop = node.property (X_("meter-point"))) != 0) {
1922                 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
1923                 set_meter_point (mp, true);
1924                 if (_meter) {
1925                         _meter->set_display_to_user (_meter_point == MeterCustom);
1926                 }
1927         }
1928
1929         set_processor_state (processor_state);
1930
1931         if ((prop = node.property ("self-solo")) != 0) {
1932                 set_self_solo (string_is_affirmative (prop->value()));
1933         }
1934
1935         if ((prop = node.property ("soloed-by-upstream")) != 0) {
1936                 _soloed_by_others_upstream = 0; // needed for mod_.... () to work
1937                 mod_solo_by_others_upstream (atoi (prop->value()));
1938         }
1939
1940         if ((prop = node.property ("soloed-by-downstream")) != 0) {
1941                 _soloed_by_others_downstream = 0; // needed for mod_.... () to work
1942                 mod_solo_by_others_downstream (atoi (prop->value()));
1943         }
1944
1945         if ((prop = node.property ("solo-isolated")) != 0) {
1946                 set_solo_isolated (string_is_affirmative (prop->value()), this);
1947         }
1948
1949         if ((prop = node.property ("solo-safe")) != 0) {
1950                 set_solo_safe (string_is_affirmative (prop->value()), this);
1951         }
1952
1953         if ((prop = node.property (X_("phase-invert"))) != 0) {
1954                 set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
1955         }
1956
1957         if ((prop = node.property (X_("denormal-protection"))) != 0) {
1958                 set_denormal_protection (string_is_affirmative (prop->value()));
1959         }
1960
1961         if ((prop = node.property (X_("active"))) != 0) {
1962                 bool yn = string_is_affirmative (prop->value());
1963                 _active = !yn; // force switch
1964                 set_active (yn, this);
1965         }
1966
1967         if ((prop = node.property (X_("order-keys"))) != 0) {
1968
1969                 int32_t n;
1970
1971                 string::size_type colon, equal;
1972                 string remaining = prop->value();
1973
1974                 while (remaining.length()) {
1975
1976                         if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
1977                                 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
1978                                       << endmsg;
1979                         } else {
1980                                 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
1981                                         error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
1982                                               << endmsg;
1983                                 } else {
1984                                         set_order_key (remaining.substr (0, equal), n);
1985                                 }
1986                         }
1987
1988                         colon = remaining.find_first_of (':');
1989
1990                         if (colon != string::npos) {
1991                                 remaining = remaining.substr (colon+1);
1992                         } else {
1993                                 break;
1994                         }
1995                 }
1996         }
1997
1998         for (niter = nlist.begin(); niter != nlist.end(); ++niter){
1999                 child = *niter;
2000
2001                 if (child->name() == X_("Comment")) {
2002
2003                         /* XXX this is a terrible API design in libxml++ */
2004
2005                         XMLNode *cmt = *(child->children().begin());
2006                         _comment = cmt->content();
2007
2008                 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2009                         if (prop->value() == "solo") {
2010                                 _solo_control->set_state (*child, version);
2011                         }
2012
2013                 } else if (child->name() == X_("RemoteControl")) {
2014                         if ((prop = child->property (X_("id"))) != 0) {
2015                                 int32_t x;
2016                                 sscanf (prop->value().c_str(), "%d", &x);
2017                                 set_remote_control_id (x);
2018                         }
2019
2020                 } else if (child->name() == X_("MuteMaster")) {
2021                         _mute_master->set_state (*child, version);
2022                 }
2023         }
2024
2025         return 0;
2026 }
2027
2028 int
2029 Route::_set_state_2X (const XMLNode& node, int version)
2030 {
2031         XMLNodeList nlist;
2032         XMLNodeConstIterator niter;
2033         XMLNode *child;
2034         const XMLProperty *prop;
2035
2036         /* 2X things which still remain to be handled:
2037          * default-type
2038          * automation
2039          * controlouts
2040          */
2041
2042         if (node.name() != "Route") {
2043                 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2044                 return -1;
2045         }
2046
2047         if ((prop = node.property (X_("flags"))) != 0) {
2048                 _flags = Flag (string_2_enum (prop->value(), _flags));
2049         } else {
2050                 _flags = Flag (0);
2051         }
2052
2053         if ((prop = node.property (X_("phase-invert"))) != 0) {
2054                 boost::dynamic_bitset<> p (_input->n_ports().n_audio ());
2055                 if (string_is_affirmative (prop->value ())) {
2056                         p.set ();
2057                 }
2058                 set_phase_invert (p);
2059         }
2060
2061         if ((prop = node.property (X_("denormal-protection"))) != 0) {
2062                 set_denormal_protection (string_is_affirmative (prop->value()));
2063         }
2064
2065         if ((prop = node.property (X_("soloed"))) != 0) {
2066                 bool yn = string_is_affirmative (prop->value());
2067
2068                 /* XXX force reset of solo status */
2069
2070                 set_solo (yn, this);
2071         }
2072
2073         if ((prop = node.property (X_("muted"))) != 0) {
2074
2075                 bool first = true;
2076                 bool muted = string_is_affirmative (prop->value());
2077
2078                 if (muted) {
2079
2080                         string mute_point;
2081
2082                         if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2083
2084                                 if (string_is_affirmative (prop->value())){
2085                                         mute_point = mute_point + "PreFader";
2086                                         first = false;
2087                                 }
2088                         }
2089
2090                         if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2091
2092                                 if (string_is_affirmative (prop->value())){
2093
2094                                         if (!first) {
2095                                                 mute_point = mute_point + ",";
2096                                         }
2097
2098                                         mute_point = mute_point + "PostFader";
2099                                         first = false;
2100                                 }
2101                         }
2102
2103                         if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2104
2105                                 if (string_is_affirmative (prop->value())){
2106
2107                                         if (!first) {
2108                                                 mute_point = mute_point + ",";
2109                                         }
2110
2111                                         mute_point = mute_point + "Listen";
2112                                         first = false;
2113                                 }
2114                         }
2115
2116                         if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2117
2118                                 if (string_is_affirmative (prop->value())){
2119
2120                                         if (!first) {
2121                                                 mute_point = mute_point + ",";
2122                                         }
2123
2124                                         mute_point = mute_point + "Main";
2125                                 }
2126                         }
2127
2128                         _mute_master->set_mute_points (mute_point);
2129                         _mute_master->set_muted_by_self (true);
2130                 }
2131         }
2132
2133         if ((prop = node.property (X_("meter-point"))) != 0) {
2134                 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2135         }
2136
2137         /* do not carry over edit/mix groups from 2.X because (a) its hard (b) they
2138            don't mean the same thing.
2139         */
2140
2141         if ((prop = node.property (X_("order-keys"))) != 0) {
2142
2143                 int32_t n;
2144
2145                 string::size_type colon, equal;
2146                 string remaining = prop->value();
2147
2148                 while (remaining.length()) {
2149
2150                         if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2151                                 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2152                                         << endmsg;
2153                         } else {
2154                                 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2155                                         error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2156                                                 << endmsg;
2157                                 } else {
2158                                         set_order_key (remaining.substr (0, equal), n);
2159                                 }
2160                         }
2161
2162                         colon = remaining.find_first_of (':');
2163
2164                         if (colon != string::npos) {
2165                                 remaining = remaining.substr (colon+1);
2166                         } else {
2167                                 break;
2168                         }
2169                 }
2170         }
2171
2172         /* IOs */
2173
2174         nlist = node.children ();
2175         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2176
2177                 child = *niter;
2178
2179                 if (child->name() == IO::state_node_name) {
2180
2181                         /* there is a note in IO::set_state_2X() about why we have to call
2182                            this directly.
2183                            */
2184
2185                         _input->set_state_2X (*child, version, true);
2186                         _output->set_state_2X (*child, version, false);
2187
2188                         if ((prop = child->property (X_("name"))) != 0) {
2189                                 Route::set_name (prop->value ());
2190                         }
2191
2192                         set_id (*child);
2193
2194                         if ((prop = child->property (X_("active"))) != 0) {
2195                                 bool yn = string_is_affirmative (prop->value());
2196                                 _active = !yn; // force switch
2197                                 set_active (yn, this);
2198                         }
2199
2200                         if ((prop = child->property (X_("gain"))) != 0) {
2201                                 gain_t val;
2202
2203                                 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2204                                         _amp->gain_control()->set_value (val);
2205                                 }
2206                         }
2207
2208                         /* Set up Panners in the IO */
2209                         XMLNodeList io_nlist = child->children ();
2210
2211                         XMLNodeConstIterator io_niter;
2212                         XMLNode *io_child;
2213
2214                         for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2215
2216                                 io_child = *io_niter;
2217
2218                                 if (io_child->name() == X_("Panner")) {
2219                                         _main_outs->panner_shell()->set_state(*io_child, version);
2220                                 } else if (io_child->name() == X_("Automation")) {
2221                                         /* IO's automation is for the fader */
2222                                         _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2223                                 }
2224                         }
2225                 }
2226         }
2227
2228         XMLNodeList redirect_nodes;
2229
2230         for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2231
2232                 child = *niter;
2233
2234                 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2235                         redirect_nodes.push_back(child);
2236                 }
2237
2238         }
2239
2240         set_processor_state_2X (redirect_nodes, version);
2241
2242         Stateful::save_extra_xml (node);
2243
2244         for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2245                 child = *niter;
2246
2247                 if (child->name() == X_("Comment")) {
2248
2249                         /* XXX this is a terrible API design in libxml++ */
2250
2251                         XMLNode *cmt = *(child->children().begin());
2252                         _comment = cmt->content();
2253
2254                 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2255                         if (prop->value() == X_("solo")) {
2256                                 _solo_control->set_state (*child, version);
2257                         } else if (prop->value() == X_("mute")) {
2258                                 _mute_control->set_state (*child, version);
2259                         }
2260
2261                 } else if (child->name() == X_("RemoteControl")) {
2262                         if ((prop = child->property (X_("id"))) != 0) {
2263                                 int32_t x;
2264                                 sscanf (prop->value().c_str(), "%d", &x);
2265                                 set_remote_control_id (x);
2266                         }
2267
2268                 }
2269         }
2270
2271         return 0;
2272 }
2273
2274 XMLNode&
2275 Route::get_processor_state ()
2276 {
2277         XMLNode* root = new XMLNode (X_("redirects"));
2278         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2279                 root->add_child_nocopy ((*i)->state (true));
2280         }
2281
2282         return *root;
2283 }
2284
2285 void
2286 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2287 {
2288         /* We don't bother removing existing processors not in nList, as this
2289            method will only be called when creating a Route from scratch, not
2290            for undo purposes.  Just put processors in at the appropriate place
2291            in the list.
2292         */
2293
2294         for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2295                 add_processor_from_xml_2X (**i, version);
2296         }
2297 }
2298
2299 void
2300 Route::set_processor_state (const XMLNode& node)
2301 {
2302         const XMLNodeList &nlist = node.children();
2303         XMLNodeConstIterator niter;
2304         ProcessorList new_order;
2305         bool must_configure = false;
2306
2307         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2308
2309                 XMLProperty* prop = (*niter)->property ("type");
2310
2311                 if (prop->value() == "amp") {
2312                         _amp->set_state (**niter, Stateful::current_state_version);
2313                         new_order.push_back (_amp);
2314                 } else if (prop->value() == "meter") {
2315                         _meter->set_state (**niter, Stateful::current_state_version);
2316                         new_order.push_back (_meter);
2317                 } else if (prop->value() == "main-outs") {
2318                         _main_outs->set_state (**niter, Stateful::current_state_version);
2319                 } else if (prop->value() == "intreturn") {
2320                         if (!_intreturn) {
2321                                 _intreturn.reset (new InternalReturn (_session));
2322                                 must_configure = true;
2323                         }
2324                         _intreturn->set_state (**niter, Stateful::current_state_version);
2325                 } else if (is_monitor() && prop->value() == "monitor") {
2326                         if (!_monitor_control) {
2327                                 _monitor_control.reset (new MonitorProcessor (_session));
2328                                 must_configure = true;
2329                         }
2330                         _monitor_control->set_state (**niter, Stateful::current_state_version);
2331                 } else if (prop->value() == "capture") {
2332                         _capturing_processor.reset (new CapturingProcessor (_session));
2333                 } else {
2334                         ProcessorList::iterator o;
2335
2336                         for (o = _processors.begin(); o != _processors.end(); ++o) {
2337                                 XMLProperty* id_prop = (*niter)->property(X_("id"));
2338                                 if (id_prop && (*o)->id() == id_prop->value()) {
2339                                         (*o)->set_state (**niter, Stateful::current_state_version);
2340                                         new_order.push_back (*o);
2341                                         break;
2342                                 }
2343                         }
2344
2345                         // If the processor (*niter) is not on the route then create it
2346
2347                         if (o == _processors.end()) {
2348
2349                                 boost::shared_ptr<Processor> processor;
2350
2351                                 if (prop->value() == "intsend") {
2352
2353                                         processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::shared_ptr<Route>(), Delivery::Role (0)));
2354
2355                                 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2356                                            prop->value() == "lv2" ||
2357                                            prop->value() == "vst" ||
2358                                            prop->value() == "lxvst" ||
2359                                            prop->value() == "audiounit") {
2360
2361                                         processor.reset (new PluginInsert(_session));
2362
2363                                 } else if (prop->value() == "port") {
2364
2365                                         processor.reset (new PortInsert (_session, _pannable, _mute_master));
2366
2367                                 } else if (prop->value() == "send") {
2368
2369                                         processor.reset (new Send (_session, _pannable, _mute_master));
2370
2371                                 } else {
2372                                         error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2373                                         continue;
2374                                 }
2375
2376                                 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2377                                         /* This processor could not be configured.  Turn it into a UnknownProcessor */
2378                                         processor.reset (new UnknownProcessor (_session, **niter));
2379                                 }
2380
2381                                 /* we have to note the monitor send here, otherwise a new one will be created
2382                                    and the state of this one will be lost.
2383                                 */
2384                                 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2385                                 if (isend && isend->role() == Delivery::Listen) {
2386                                         _monitor_send = isend;
2387                                 }
2388
2389                                 /* it doesn't matter if invisible processors are added here, as they
2390                                    will be sorted out by setup_invisible_processors () shortly.
2391                                 */
2392
2393                                 new_order.push_back (processor);
2394                                 must_configure = true;
2395                         }
2396                 }
2397         }
2398
2399         {
2400                 Glib::RWLock::WriterLock lm (_processor_lock);
2401                 _processors = new_order;
2402
2403                 if (must_configure) {
2404                         Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2405                         configure_processors_unlocked (0);
2406                 }
2407
2408                 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2409
2410                         (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2411
2412                         boost::shared_ptr<PluginInsert> pi;
2413
2414                         if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2415                                 if (pi->has_no_inputs ()) {
2416                                         _have_internal_generator = true;
2417                                         break;
2418                                 }
2419                         }
2420                 }
2421         }
2422
2423         processors_changed (RouteProcessorChange ());
2424         set_processor_positions ();
2425 }
2426
2427 void
2428 Route::curve_reallocate ()
2429 {
2430 //      _gain_automation_curve.finish_resize ();
2431 //      _pan_automation_curve.finish_resize ();
2432 }
2433
2434 void
2435 Route::silence (framecnt_t nframes)
2436 {
2437         Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2438         if (!lm.locked()) {
2439                 return;
2440         }
2441
2442         silence_unlocked (nframes);
2443 }
2444
2445 void
2446 Route::silence_unlocked (framecnt_t nframes)
2447 {
2448         /* Must be called with the processor lock held */
2449
2450         if (!_silent) {
2451
2452                 _output->silence (nframes);
2453
2454                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2455                         boost::shared_ptr<PluginInsert> pi;
2456
2457                         if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2458                                 // skip plugins, they don't need anything when we're not active
2459                                 continue;
2460                         }
2461
2462                         (*i)->silence (nframes);
2463                 }
2464
2465                 if (nframes == _session.get_block_size()) {
2466                         // _silent = true;
2467                 }
2468         }
2469 }
2470
2471 void
2472 Route::add_internal_return ()
2473 {
2474         if (!_intreturn) {
2475                 _intreturn.reset (new InternalReturn (_session));
2476                 add_processor (_intreturn, PreFader);
2477         }
2478 }
2479
2480 void
2481 Route::add_send_to_internal_return (InternalSend* send)
2482 {
2483         Glib::RWLock::ReaderLock rm (_processor_lock);
2484
2485         for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2486                 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2487
2488                 if (d) {
2489                         return d->add_send (send);
2490                 }
2491         }
2492 }
2493
2494 void
2495 Route::remove_send_from_internal_return (InternalSend* send)
2496 {
2497         Glib::RWLock::ReaderLock rm (_processor_lock);
2498
2499         for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2500                 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2501
2502                 if (d) {
2503                         return d->remove_send (send);
2504                 }
2505         }
2506 }
2507
2508 /** Add a monitor send (if we don't already have one) but don't activate it */
2509 int
2510 Route::listen_via_monitor ()
2511 {
2512         /* master never sends to control outs */
2513         assert (!is_master ());
2514
2515         /* make sure we have one */
2516         if (!_monitor_send) {
2517                 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, _session.monitor_out(), Delivery::Listen));
2518                 _monitor_send->set_display_to_user (false);
2519         }
2520
2521         /* set it up */
2522         Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2523         configure_processors (0);
2524
2525         return 0;
2526 }
2527
2528 /** Add an internal send to a route.
2529  *  @param route route to send to.
2530  *  @param placement placement for the send.
2531  */
2532 int
2533 Route::listen_via (boost::shared_ptr<Route> route, Placement placement)
2534 {
2535         assert (route != _session.monitor_out ());
2536
2537         {
2538                 Glib::RWLock::ReaderLock rm (_processor_lock);
2539
2540                 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2541
2542                         boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2543
2544                         if (d && d->target_route() == route) {
2545                                 /* already listening via the specified IO: do nothing */
2546                                 return 0;
2547                         }
2548                 }
2549         }
2550
2551         try {
2552                 boost::shared_ptr<InternalSend> listener (new InternalSend (_session, _pannable, _mute_master, route, Delivery::Aux));
2553                 add_processor (listener, placement);
2554
2555         } catch (failed_constructor& err) {
2556                 return -1;
2557         }
2558
2559         return 0;
2560 }
2561
2562 void
2563 Route::drop_listen (boost::shared_ptr<Route> route)
2564 {
2565         ProcessorStreams err;
2566         ProcessorList::iterator tmp;
2567
2568         Glib::RWLock::ReaderLock rl(_processor_lock);
2569         rl.acquire ();
2570
2571   again:
2572         for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ) {
2573
2574                 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
2575
2576                 if (d && d->target_route() == route) {
2577                         rl.release ();
2578                         remove_processor (*x, &err);
2579                         rl.acquire ();
2580
2581                         /* list could have been demolished while we dropped the lock
2582                            so start over.
2583                         */
2584
2585                         goto again;
2586                 }
2587         }
2588
2589         rl.release ();
2590
2591         if (route == _session.monitor_out()) {
2592                 _monitor_send.reset ();
2593         }
2594 }
2595
2596 void
2597 Route::set_comment (string cmt, void *src)
2598 {
2599         _comment = cmt;
2600         comment_changed (src);
2601         _session.set_dirty ();
2602 }
2603
2604 bool
2605 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
2606 {
2607         FeedRecord fr (other, via_sends_only);
2608
2609         pair<FedBy::iterator,bool> result =  _fed_by.insert (fr);
2610
2611         if (!result.second) {
2612
2613                 /* already a record for "other" - make sure sends-only information is correct */
2614                 if (!via_sends_only && result.first->sends_only) {
2615                         FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
2616                         frp->sends_only = false;
2617                 }
2618         }
2619
2620         return result.second;
2621 }
2622
2623 void
2624 Route::clear_fed_by ()
2625 {
2626         _fed_by.clear ();
2627 }
2628
2629 bool
2630 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
2631 {
2632         const FedBy& fed_by (other->fed_by());
2633
2634         for (FedBy::iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
2635                 boost::shared_ptr<Route> sr = f->r.lock();
2636
2637                 if (sr && (sr.get() == this)) {
2638
2639                         if (via_sends_only) {
2640                                 *via_sends_only = f->sends_only;
2641                         }
2642
2643                         return true;
2644                 }
2645         }
2646
2647         return false;
2648 }
2649
2650 bool
2651 Route::direct_feeds (boost::shared_ptr<Route> other, bool* only_send)
2652 {
2653         DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
2654
2655         if (_output->connected_to (other->input())) {
2656                 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
2657                 if (only_send) {
2658                         *only_send = false;
2659                 }
2660
2661                 return true;
2662         }
2663
2664
2665         for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
2666
2667                 boost::shared_ptr<IOProcessor> iop;
2668
2669                 if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*r)) != 0) {
2670                         if (iop->feeds (other)) {
2671                                 DEBUG_TRACE (DEBUG::Graph,  string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
2672                                 if (only_send) {
2673                                         *only_send = true;
2674                                 }
2675                                 return true;
2676                         } else {
2677                                 DEBUG_TRACE (DEBUG::Graph,  string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
2678                         }
2679                 } else {
2680                         DEBUG_TRACE (DEBUG::Graph,  string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
2681                 }
2682
2683         }
2684
2685         DEBUG_TRACE (DEBUG::Graph,  string_compose ("\tdoes NOT feed %1\n", other->name()));
2686         return false;
2687 }
2688
2689 /** Called from the (non-realtime) butler thread when the transport is stopped */
2690 void
2691 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool did_locate, bool can_flush_processors)
2692 {
2693         framepos_t now = _session.transport_frame();
2694
2695         {
2696                 Glib::RWLock::ReaderLock lm (_processor_lock);
2697
2698                 if (!did_locate) {
2699                         automation_snapshot (now, true);
2700                 }
2701
2702                 Automatable::transport_stopped (now);
2703
2704                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2705
2706                         if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
2707                                 (*i)->flush ();
2708                         }
2709
2710                         (*i)->transport_stopped (now);
2711                 }
2712         }
2713
2714         _roll_delay = _initial_delay;
2715 }
2716
2717 /** Called with the process lock held if change contains ConfigurationChanged */
2718 void
2719 Route::input_change_handler (IOChange change, void * /*src*/)
2720 {
2721         if ((change.type & IOChange::ConfigurationChanged)) {
2722                 configure_processors (0);
2723                 _phase_invert.resize (_input->n_ports().n_audio ());
2724                 io_changed (); /* EMIT SIGNAL */
2725         }
2726 }
2727
2728 uint32_t
2729 Route::pans_required () const
2730 {
2731         if (n_outputs().n_audio() < 2) {
2732                 return 0;
2733         }
2734
2735         return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
2736 }
2737
2738 int
2739 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
2740 {
2741         Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2742         if (!lm.locked()) {
2743                 return 0;
2744         }
2745
2746         if (n_outputs().n_total() == 0) {
2747                 return 0;
2748         }
2749
2750         if (!_active || n_inputs() == ChanCount::ZERO)  {
2751                 silence_unlocked (nframes);
2752                 return 0;
2753         }
2754         if (session_state_changing) {
2755                 if (_session.transport_speed() != 0.0f) {
2756                         /* we're rolling but some state is changing (e.g. our diskstream contents)
2757                            so we cannot use them. Be silent till this is over.
2758
2759                            XXX note the absurdity of ::no_roll() being called when we ARE rolling!
2760                         */
2761                         silence_unlocked (nframes);
2762                         return 0;
2763                 }
2764                 /* we're really not rolling, so we're either delivery silence or actually
2765                    monitoring, both of which are safe to do while session_state_changing is true.
2766                 */
2767         }
2768
2769         _amp->apply_gain_automation (false);
2770         passthru (start_frame, end_frame, nframes, 0);
2771
2772         return 0;
2773 }
2774
2775 int
2776 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
2777 {
2778         Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2779         if (!lm.locked()) {
2780                 return 0;
2781         }
2782
2783         automation_snapshot (_session.transport_frame(), false);
2784
2785         if (n_outputs().n_total() == 0) {
2786                 return 0;
2787         }
2788
2789         if (!_active || n_inputs().n_total() == 0) {
2790                 silence_unlocked (nframes);
2791                 return 0;
2792         }
2793
2794         framecnt_t unused = 0;
2795
2796         if ((nframes = check_initial_delay (nframes, unused)) == 0) {
2797                 return 0;
2798         }
2799
2800         _silent = false;
2801
2802         passthru (start_frame, end_frame, nframes, declick);
2803
2804         return 0;
2805 }
2806
2807 int
2808 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
2809 {
2810         silence (nframes);
2811         return 0;
2812 }
2813
2814 void
2815 Route::toggle_monitor_input ()
2816 {
2817         for (PortSet::iterator i = _input->ports().begin(); i != _input->ports().end(); ++i) {
2818                 i->ensure_monitor_input( ! i->monitoring_input());
2819         }
2820 }
2821
2822 bool
2823 Route::has_external_redirects () const
2824 {
2825         // FIXME: what about sends? - they don't return a signal back to ardour?
2826
2827         boost::shared_ptr<const PortInsert> pi;
2828
2829         for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2830
2831                 if ((pi = boost::dynamic_pointer_cast<const PortInsert>(*i)) != 0) {
2832
2833                         for (PortSet::const_iterator port = pi->output()->ports().begin(); port != pi->output()->ports().end(); ++port) {
2834
2835                                 string port_name = port->name();
2836                                 string client_name = port_name.substr (0, port_name.find(':'));
2837
2838                                 /* only say "yes" if the redirect is actually in use */
2839
2840                                 if (client_name != "ardour" && pi->active()) {
2841                                         return true;
2842                                 }
2843                         }
2844                 }
2845         }
2846
2847         return false;
2848 }
2849
2850 void
2851 Route::flush_processors ()
2852 {
2853         /* XXX shouldn't really try to take this lock, since
2854            this is called from the RT audio thread.
2855         */
2856
2857         Glib::RWLock::ReaderLock lm (_processor_lock);
2858
2859         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2860                 (*i)->flush ();
2861         }
2862 }
2863
2864 void
2865 Route::set_meter_point (MeterPoint p, bool force)
2866 {
2867         /* CAN BE CALLED FROM PROCESS CONTEXT */
2868
2869         if (_meter_point == p && !force) {
2870                 return;
2871         }
2872
2873         _meter_point = p;
2874
2875         bool meter_was_visible_to_user = _meter->display_to_user ();
2876
2877         {
2878                 Glib::RWLock::WriterLock lm (_processor_lock);
2879
2880                 if (_meter_point != MeterCustom) {
2881
2882                         _meter->set_display_to_user (false);
2883
2884                         setup_invisible_processors ();
2885
2886                         ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
2887
2888                         ChanCount m_in;
2889
2890                         if (loc == _processors.begin()) {
2891                                 m_in = _input->n_ports();
2892                         } else {
2893                                 ProcessorList::iterator before = loc;
2894                                 --before;
2895                                 m_in = (*before)->output_streams ();
2896                         }
2897
2898                         _meter->reflect_inputs (m_in);
2899
2900                         /* we do not need to reconfigure the processors, because the meter
2901                            (a) is always ready to handle processor_max_streams
2902                            (b) is always an N-in/N-out processor, and thus moving
2903                            it doesn't require any changes to the other processors.
2904                         */
2905
2906                 } else {
2907
2908                         // just make it visible and let the user move it
2909
2910                         _meter->set_display_to_user (true);
2911                 }
2912         }
2913
2914         meter_change (); /* EMIT SIGNAL */
2915
2916         bool const meter_visibly_changed = (_meter->display_to_user() != meter_was_visible_to_user);
2917
2918         processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, meter_visibly_changed)); /* EMIT SIGNAL */
2919 }
2920
2921 void
2922 Route::listen_position_changed ()
2923 {
2924         {
2925                 Glib::RWLock::WriterLock lm (_processor_lock);
2926                 ProcessorState pstate (this);
2927
2928                 {
2929                         Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2930
2931                         if (configure_processors_unlocked (0)) {
2932                                 pstate.restore ();
2933                                 configure_processors_unlocked (0); // it worked before we tried to add it ...
2934                                 return;
2935                         }
2936                 }
2937         }
2938
2939         processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2940         _session.set_dirty ();
2941 }
2942
2943 boost::shared_ptr<CapturingProcessor>
2944 Route::add_export_point()
2945 {
2946         if (!_capturing_processor) {
2947
2948                 _capturing_processor.reset (new CapturingProcessor (_session));
2949                 _capturing_processor->activate ();
2950
2951                 {
2952                         Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2953                         configure_processors (0);
2954                 }
2955
2956         }
2957
2958         return _capturing_processor;
2959 }
2960
2961 framecnt_t
2962 Route::update_signal_latency ()
2963 {
2964         framecnt_t l = _output->user_latency();
2965
2966         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2967                 if ((*i)->active ()) {
2968                         l += (*i)->signal_latency ();
2969                 }
2970         }
2971
2972         DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
2973
2974         if (_signal_latency != l) {
2975                 _signal_latency = l;
2976                 signal_latency_changed (); /* EMIT SIGNAL */
2977         }
2978
2979         return _signal_latency;
2980 }
2981
2982 void
2983 Route::set_user_latency (framecnt_t nframes)
2984 {
2985         _output->set_user_latency (nframes);
2986         _session.update_latency_compensation ();
2987 }
2988
2989 void
2990 Route::set_latency_compensation (framecnt_t longest_session_latency)
2991 {
2992         framecnt_t old = _initial_delay;
2993
2994         if (_signal_latency < longest_session_latency) {
2995                 _initial_delay = longest_session_latency - _signal_latency;
2996         } else {
2997                 _initial_delay = 0;
2998         }
2999
3000         DEBUG_TRACE (DEBUG::Latency, string_compose (
3001                              "%1: compensate for maximum latency of %2,"
3002                              "given own latency of %3, using initial delay of %4\n",
3003                              name(), longest_session_latency, _signal_latency, _initial_delay));
3004
3005         if (_initial_delay != old) {
3006                 initial_delay_changed (); /* EMIT SIGNAL */
3007         }
3008
3009         if (_session.transport_stopped()) {
3010                 _roll_delay = _initial_delay;
3011         }
3012 }
3013
3014 void
3015 Route::automation_snapshot (framepos_t now, bool force)
3016 {
3017         if (_pannable) {
3018                 _pannable->automation_snapshot (now, force);
3019         }
3020
3021         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3022                 (*i)->automation_snapshot (now, force);
3023         }
3024 }
3025
3026 Route::SoloControllable::SoloControllable (std::string name, boost::shared_ptr<Route> r)
3027         : AutomationControl (r->session(), Evoral::Parameter (SoloAutomation),
3028                              boost::shared_ptr<AutomationList>(), name)
3029         , _route (r)
3030 {
3031         boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(SoloAutomation)));
3032         set_list (gl);
3033 }
3034
3035 void
3036 Route::SoloControllable::set_value (double val)
3037 {
3038         bool bval = ((val >= 0.5f) ? true: false);
3039
3040         boost::shared_ptr<RouteList> rl (new RouteList);
3041
3042         boost::shared_ptr<Route> r = _route.lock ();
3043         if (!r) {
3044                 return;
3045         }
3046
3047         rl->push_back (r);
3048
3049         if (Config->get_solo_control_is_listen_control()) {
3050                 _session.set_listen (rl, bval);
3051         } else {
3052                 _session.set_solo (rl, bval);
3053         }
3054 }
3055
3056 double
3057 Route::SoloControllable::get_value () const
3058 {
3059         boost::shared_ptr<Route> r = _route.lock ();
3060         if (!r) {
3061                 return 0;
3062         }
3063
3064         if (Config->get_solo_control_is_listen_control()) {
3065                 return r->listening_via_monitor() ? 1.0f : 0.0f;
3066         } else {
3067                 return r->self_soloed() ? 1.0f : 0.0f;
3068         }
3069 }
3070
3071 Route::MuteControllable::MuteControllable (std::string name, boost::shared_ptr<Route> r)
3072         : AutomationControl (r->session(), Evoral::Parameter (MuteAutomation),
3073                              boost::shared_ptr<AutomationList>(), name)
3074         , _route (r)
3075 {
3076         boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(MuteAutomation)));
3077         set_list (gl);
3078 }
3079
3080 void
3081 Route::MuteControllable::set_value (double val)
3082 {
3083         bool bval = ((val >= 0.5f) ? true: false);
3084
3085         boost::shared_ptr<RouteList> rl (new RouteList);
3086
3087         boost::shared_ptr<Route> r = _route.lock ();
3088         if (!r) {
3089                 return;
3090         }
3091
3092         rl->push_back (r);
3093         _session.set_mute (rl, bval);
3094 }
3095
3096 double
3097 Route::MuteControllable::get_value () const
3098 {
3099         boost::shared_ptr<Route> r = _route.lock ();
3100         if (!r) {
3101                 return 0;
3102         }
3103
3104         return r->muted() ? 1.0f : 0.0f;
3105 }
3106
3107 void
3108 Route::set_block_size (pframes_t nframes)
3109 {
3110         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3111                 (*i)->set_block_size (nframes);
3112         }
3113
3114         _session.ensure_buffers (n_process_buffers ());
3115 }
3116
3117 void
3118 Route::protect_automation ()
3119 {
3120         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3121                 (*i)->protect_automation();
3122 }
3123
3124 void
3125 Route::set_pending_declick (int declick)
3126 {
3127         if (_declickable) {
3128                 /* this call is not allowed to turn off a pending declick unless "force" is true */
3129                 if (declick) {
3130                         _pending_declick = declick;
3131                 }
3132                 // cerr << _name << ": after setting to " << declick << " pending declick = " << _pending_declick << endl;
3133         } else {
3134                 _pending_declick = 0;
3135         }
3136
3137 }
3138
3139 /** Shift automation forwards from a particular place, thereby inserting time.
3140  *  Adds undo commands for any shifts that are performed.
3141  *
3142  * @param pos Position to start shifting from.
3143  * @param frames Amount to shift forwards by.
3144  */
3145
3146 void
3147 Route::shift (framepos_t pos, framecnt_t frames)
3148 {
3149         /* gain automation */
3150         {
3151                 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3152
3153                 XMLNode &before = gc->alist()->get_state ();
3154                 gc->alist()->shift (pos, frames);
3155                 XMLNode &after = gc->alist()->get_state ();
3156                 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3157         }
3158
3159         /* pan automation */
3160         if (_pannable) {
3161                 ControlSet::Controls& c (_pannable->controls());
3162
3163                 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3164                         boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3165                         if (pc) {
3166                                 boost::shared_ptr<AutomationList> al = pc->alist();
3167                                 XMLNode& before = al->get_state ();
3168                                 al->shift (pos, frames);
3169                                 XMLNode& after = al->get_state ();
3170                                 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3171                         }
3172                 }
3173         }
3174
3175         /* redirect automation */
3176         {
3177                 Glib::RWLock::ReaderLock lm (_processor_lock);
3178                 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3179
3180                         set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3181
3182                         for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3183                                 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3184                                 if (ac) {
3185                                         boost::shared_ptr<AutomationList> al = ac->alist();
3186                                         XMLNode &before = al->get_state ();
3187                                         al->shift (pos, frames);
3188                                         XMLNode &after = al->get_state ();
3189                                         _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3190                                 }
3191                         }
3192                 }
3193         }
3194 }
3195
3196
3197 int
3198 Route::save_as_template (const string& path, const string& name)
3199 {
3200         XMLNode& node (state (false));
3201         XMLTree tree;
3202
3203         IO::set_name_in_state (*node.children().front(), name);
3204
3205         tree.set_root (&node);
3206         return tree.write (path.c_str());
3207 }
3208
3209
3210 bool
3211 Route::set_name (const string& str)
3212 {
3213         bool ret;
3214         string ioproc_name;
3215         string name;
3216
3217         name = Route::ensure_track_or_route_name (str, _session);
3218         SessionObject::set_name (name);
3219
3220         ret = (_input->set_name(name) && _output->set_name(name));
3221
3222         if (ret) {
3223                 /* rename the main outs. Leave other IO processors
3224                  * with whatever name they already have, because its
3225                  * just fine as it is (it will not contain the route
3226                  * name if its a port insert, port send or port return).
3227                  */
3228
3229                 if (_main_outs) {
3230                         if (_main_outs->set_name (name)) {
3231                                 /* XXX returning false here is stupid because
3232                                    we already changed the route name.
3233                                 */
3234                                 return false;
3235                         }
3236                 }
3237         }
3238
3239         return ret;
3240 }
3241
3242 boost::shared_ptr<Send>
3243 Route::internal_send_for (boost::shared_ptr<const Route> target) const
3244 {
3245         Glib::RWLock::ReaderLock lm (_processor_lock);
3246
3247         for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3248                 boost::shared_ptr<InternalSend> send;
3249
3250                 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
3251                         if (send->target_route() == target) {
3252                                 return send;
3253                         }
3254                 }
3255         }
3256
3257         return boost::shared_ptr<Send>();
3258 }
3259
3260 /** @param c Audio channel index.
3261  *  @param yn true to invert phase, otherwise false.
3262  */
3263 void
3264 Route::set_phase_invert (uint32_t c, bool yn)
3265 {
3266         if (_phase_invert[c] != yn) {
3267                 _phase_invert[c] = yn;
3268                 phase_invert_changed (); /* EMIT SIGNAL */
3269                 _session.set_dirty ();
3270         }
3271 }
3272
3273 void
3274 Route::set_phase_invert (boost::dynamic_bitset<> p)
3275 {
3276         if (_phase_invert != p) {
3277                 _phase_invert = p;
3278                 phase_invert_changed (); /* EMIT SIGNAL */
3279                 _session.set_dirty ();
3280         }
3281 }
3282
3283 bool
3284 Route::phase_invert (uint32_t c) const
3285 {
3286         return _phase_invert[c];
3287 }
3288
3289 boost::dynamic_bitset<>
3290 Route::phase_invert () const
3291 {
3292         return _phase_invert;
3293 }
3294
3295 void
3296 Route::set_denormal_protection (bool yn)
3297 {
3298         if (_denormal_protection != yn) {
3299                 _denormal_protection = yn;
3300                 denormal_protection_changed (); /* EMIT SIGNAL */
3301         }
3302 }
3303
3304 bool
3305 Route::denormal_protection () const
3306 {
3307         return _denormal_protection;
3308 }
3309
3310 void
3311 Route::set_active (bool yn, void* src)
3312 {
3313         if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
3314                 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
3315                 return;
3316         }
3317
3318         if (_active != yn) {
3319                 _active = yn;
3320                 _input->set_active (yn);
3321                 _output->set_active (yn);
3322                 active_changed (); // EMIT SIGNAL
3323         }
3324 }
3325
3326 void
3327 Route::meter ()
3328 {
3329         Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
3330
3331         assert (_meter);
3332
3333         _meter->meter ();
3334
3335         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3336
3337                 boost::shared_ptr<Send> s;
3338                 boost::shared_ptr<Return> r;
3339
3340                 if ((s = boost::dynamic_pointer_cast<Send> (*i)) != 0) {
3341                         s->meter()->meter();
3342                 } else if ((r = boost::dynamic_pointer_cast<Return> (*i)) != 0) {
3343                         r->meter()->meter ();
3344                 }
3345         }
3346 }
3347
3348 boost::shared_ptr<Pannable>
3349 Route::pannable() const
3350 {
3351         return _pannable;
3352 }
3353
3354 boost::shared_ptr<Panner>
3355 Route::panner() const
3356 {
3357         /* may be null ! */
3358         return _main_outs->panner_shell()->panner();
3359 }
3360
3361 boost::shared_ptr<PannerShell>
3362 Route::panner_shell() const
3363 {
3364         return _main_outs->panner_shell();
3365 }
3366
3367 boost::shared_ptr<AutomationControl>
3368 Route::gain_control() const
3369 {
3370         return _amp->gain_control();
3371 }
3372
3373 boost::shared_ptr<AutomationControl>
3374 Route::get_control (const Evoral::Parameter& param)
3375 {
3376         /* either we own the control or .... */
3377
3378         boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
3379
3380         if (!c) {
3381
3382                 /* maybe one of our processors does or ... */
3383
3384                 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
3385                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3386                         if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
3387                                 break;
3388                         }
3389                 }
3390         }
3391
3392         if (!c) {
3393
3394                 /* nobody does so we'll make a new one */
3395
3396                 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
3397                 add_control(c);
3398         }
3399
3400         return c;
3401 }
3402
3403 boost::shared_ptr<Processor>
3404 Route::nth_plugin (uint32_t n)
3405 {
3406         Glib::RWLock::ReaderLock lm (_processor_lock);
3407         ProcessorList::iterator i;
3408
3409         for (i = _processors.begin(); i != _processors.end(); ++i) {
3410                 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
3411                         if (n-- == 0) {
3412                                 return *i;
3413                         }
3414                 }
3415         }
3416
3417         return boost::shared_ptr<Processor> ();
3418 }
3419
3420 boost::shared_ptr<Processor>
3421 Route::nth_send (uint32_t n)
3422 {
3423         Glib::RWLock::ReaderLock lm (_processor_lock);
3424         ProcessorList::iterator i;
3425
3426         for (i = _processors.begin(); i != _processors.end(); ++i) {
3427                 if (boost::dynamic_pointer_cast<Send> (*i)) {
3428                         if (n-- == 0) {
3429                                 return *i;
3430                         }
3431                 }
3432         }
3433
3434         return boost::shared_ptr<Processor> ();
3435 }
3436
3437 bool
3438 Route::has_io_processor_named (const string& name)
3439 {
3440         Glib::RWLock::ReaderLock lm (_processor_lock);
3441         ProcessorList::iterator i;
3442
3443         for (i = _processors.begin(); i != _processors.end(); ++i) {
3444                 if (boost::dynamic_pointer_cast<Send> (*i) ||
3445                     boost::dynamic_pointer_cast<PortInsert> (*i)) {
3446                         if ((*i)->name() == name) {
3447                                 return true;
3448                         }
3449                 }
3450         }
3451
3452         return false;
3453 }
3454
3455 MuteMaster::MutePoint
3456 Route::mute_points () const
3457 {
3458         return _mute_master->mute_points ();
3459 }
3460
3461 void
3462 Route::set_processor_positions ()
3463 {
3464         Glib::RWLock::ReaderLock lm (_processor_lock);
3465
3466         bool had_amp = false;
3467         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3468                 (*i)->set_pre_fader (!had_amp);
3469                 if (boost::dynamic_pointer_cast<Amp> (*i)) {
3470                         had_amp = true;
3471                 }
3472         }
3473 }
3474
3475 /** Called when there is a proposed change to the input port count */
3476 bool
3477 Route::input_port_count_changing (ChanCount to)
3478 {
3479         list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
3480         if (c.empty()) {
3481                 /* The processors cannot be configured with the new input arrangement, so
3482                    block the change.
3483                 */
3484                 return true;
3485         }
3486
3487         /* The change is ok */
3488         return false;
3489 }
3490
3491 list<string>
3492 Route::unknown_processors () const
3493 {
3494         list<string> p;
3495
3496         Glib::RWLock::ReaderLock lm (_processor_lock);
3497         for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3498                 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
3499                         p.push_back ((*i)->name ());
3500                 }
3501         }
3502
3503         return p;
3504 }
3505
3506
3507 framecnt_t
3508 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
3509 {
3510         /* we assume that all our input ports feed all our output ports. its not
3511            universally true, but the alternative is way too corner-case to worry about.
3512         */
3513
3514         jack_latency_range_t all_connections;
3515
3516         if (from.empty()) {
3517                 all_connections.min = 0;
3518                 all_connections.max = 0;
3519         } else {
3520                 all_connections.min = ~((jack_nframes_t) 0);
3521                 all_connections.max = 0;
3522
3523                 /* iterate over all "from" ports and determine the latency range for all of their
3524                    connections to the "outside" (outside of this Route).
3525                 */
3526
3527                 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3528
3529                         jack_latency_range_t range;
3530
3531                         p->get_connected_latency_range (range, playback);
3532
3533                         all_connections.min = min (all_connections.min, range.min);
3534                         all_connections.max = max (all_connections.max, range.max);
3535                 }
3536         }
3537
3538         /* set the "from" port latencies to the max/min range of all their connections */
3539
3540         for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3541                 p->set_private_latency_range (all_connections, playback);
3542         }
3543
3544         /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
3545
3546         all_connections.min += our_latency;
3547         all_connections.max += our_latency;
3548
3549         for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
3550                 p->set_private_latency_range (all_connections, playback);
3551         }
3552
3553         return all_connections.max;
3554 }
3555
3556 framecnt_t
3557 Route::set_private_port_latencies (bool playback) const
3558 {
3559         framecnt_t own_latency = 0;
3560
3561         /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
3562            OR LATENCY CALLBACK.
3563
3564            This is called (early) from the latency callback. It computes the REAL
3565            latency associated with each port and stores the result as the "private"
3566            latency of the port. A later call to Route::set_public_port_latencies()
3567            sets all ports to the same value to reflect the fact that we do latency
3568            compensation and so all signals are delayed by the same amount as they
3569            flow through ardour.
3570         */
3571
3572         for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3573                 if ((*i)->active ()) {
3574                         own_latency += (*i)->signal_latency ();
3575                 }
3576         }
3577
3578         if (playback) {
3579                 /* playback: propagate latency from "outside the route" to outputs to inputs */
3580                 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
3581         } else {
3582                 /* capture: propagate latency from "outside the route" to inputs to outputs */
3583                 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
3584         }
3585 }
3586
3587 void
3588 Route::set_public_port_latencies (framecnt_t value, bool playback) const
3589 {
3590         /* this is called to set the JACK-visible port latencies, which take
3591            latency compensation into account.
3592         */
3593
3594         jack_latency_range_t range;
3595
3596         range.min = value;
3597         range.max = value;
3598
3599         {
3600                 const PortSet& ports (_input->ports());
3601                 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3602                         p->set_public_latency_range (range, playback);
3603                 }
3604         }
3605
3606         {
3607                 const PortSet& ports (_output->ports());
3608                 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3609                         p->set_public_latency_range (range, playback);
3610                 }
3611         }
3612 }
3613
3614 /** Put the invisible processors in the right place in _processors.
3615  *  Must be called with a writer lock on _processor_lock held.
3616  */
3617 void
3618 Route::setup_invisible_processors ()
3619 {
3620 #ifndef NDEBUG
3621         Glib::RWLock::WriterLock lm (_processor_lock, Glib::TRY_LOCK);
3622         assert (!lm.locked ());
3623 #endif
3624
3625         if (!_main_outs) {
3626                 /* too early to be doing this stuff */
3627                 return;
3628         }
3629
3630         /* we'll build this new list here and then use it */
3631
3632         ProcessorList new_processors;
3633
3634         /* find visible processors */
3635
3636         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3637                 if ((*i)->display_to_user ()) {
3638                         new_processors.push_back (*i);
3639                 }
3640         }
3641
3642         /* find the amp */
3643
3644         ProcessorList::iterator amp = new_processors.begin ();
3645         while (amp != new_processors.end() && boost::dynamic_pointer_cast<Amp> (*amp) == 0) {
3646                 ++amp;
3647         }
3648
3649         assert (amp != _processors.end ());
3650
3651         /* and the processor after the amp */
3652
3653         ProcessorList::iterator after_amp = amp;
3654         ++after_amp;
3655
3656         /* METER */
3657
3658         if (_meter) {
3659                 switch (_meter_point) {
3660                 case MeterInput:
3661                         assert (!_meter->display_to_user ());
3662                         new_processors.push_front (_meter);
3663                         break;
3664                 case MeterPreFader:
3665                         assert (!_meter->display_to_user ());
3666                         new_processors.insert (amp, _meter);
3667                         break;
3668                 case MeterPostFader:
3669                         /* do nothing here */
3670                         break;
3671                 case MeterOutput:
3672                         /* do nothing here */
3673                         break;
3674                 case MeterCustom:
3675                         /* the meter is visible, so we don't touch it here */
3676                         break;
3677                 }
3678         }
3679
3680         /* MAIN OUTS */
3681
3682         assert (_main_outs);
3683         assert (!_main_outs->display_to_user ());
3684         new_processors.push_back (_main_outs);
3685
3686         /* iterator for the main outs */
3687
3688         ProcessorList::iterator main = new_processors.end();
3689         --main;
3690
3691         /* OUTPUT METERING */
3692
3693         if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
3694                 assert (!_meter->display_to_user ());
3695
3696                 /* add the processor just before or just after the main outs */
3697
3698                 ProcessorList::iterator meter_point = main;
3699
3700                 if (_meter_point == MeterOutput) {
3701                         ++meter_point;
3702                 }
3703                 new_processors.insert (meter_point, _meter);
3704         }
3705
3706         /* MONITOR SEND */
3707
3708         if (_monitor_send && !is_monitor ()) {
3709                 assert (!_monitor_send->display_to_user ());
3710                 if (Config->get_solo_control_is_listen_control()) {
3711                         switch (Config->get_listen_position ()) {
3712                         case PreFaderListen:
3713                                 switch (Config->get_pfl_position ()) {
3714                                 case PFLFromBeforeProcessors:
3715                                         new_processors.push_front (_monitor_send);
3716                                         break;
3717                                 case PFLFromAfterProcessors:
3718                                         new_processors.insert (amp, _monitor_send);
3719                                         break;
3720                                 }
3721                                 _monitor_send->set_can_pan (false);
3722                                 break;
3723                         case AfterFaderListen:
3724                                 switch (Config->get_afl_position ()) {
3725                                 case AFLFromBeforeProcessors:
3726                                         new_processors.insert (after_amp, _monitor_send);
3727                                         break;
3728                                 case AFLFromAfterProcessors:
3729                                         new_processors.insert (new_processors.end(), _monitor_send);
3730                                         break;
3731                                 }
3732                                 _monitor_send->set_can_pan (true);
3733                                 break;
3734                         }
3735                 }  else {
3736                         new_processors.insert (new_processors.end(), _monitor_send);
3737                         _monitor_send->set_can_pan (false);
3738                 }
3739         }
3740
3741         /* MONITOR CONTROL */
3742
3743         if (_monitor_control && is_monitor ()) {
3744                 assert (!_monitor_control->display_to_user ());
3745                 new_processors.push_front (_monitor_control);
3746         }
3747
3748         /* INTERNAL RETURN */
3749
3750         /* doing this here means that any monitor control will come just after
3751            the return.
3752         */
3753
3754         if (_intreturn) {
3755                 assert (!_intreturn->display_to_user ());
3756                 new_processors.push_front (_intreturn);
3757         }
3758
3759         /* EXPORT PROCESSOR */
3760
3761         if (_capturing_processor) {
3762                 assert (!_capturing_processor->display_to_user ());
3763                 new_processors.push_front (_capturing_processor);
3764         }
3765
3766         _processors = new_processors;
3767
3768         DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
3769         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3770                 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
3771         }
3772 }
3773
3774 bool
3775 Route::should_monitor () const
3776 {
3777         switch (Config->get_monitoring_model()) {
3778         case HardwareMonitoring:
3779         case ExternalMonitoring:
3780                 return !record_enabled() || (_session.config.get_auto_input() && !_session.actively_recording());
3781                 break;
3782         default:
3783                 break;
3784         }
3785
3786         return true;
3787 }
3788
3789 void
3790 Route::unpan ()
3791 {
3792         Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3793         Glib::RWLock::ReaderLock lp (_processor_lock);
3794
3795         _pannable.reset ();
3796
3797         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3798                 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
3799                 if (d) {
3800                         d->unpan ();
3801                 }
3802         }
3803 }