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