libs/ardour/session.cc

   1 /*
   2     Copyright (C) 1999-2010 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <stdint.h>
  21
  22 #include <algorithm>
  23 #include <string>
  24 #include <vector>
  25 #include <sstream>
  26 #include <cstdio> /* sprintf(3) ... grrr */
  27 #include <cmath>
  28 #include <cerrno>
  29 #include <unistd.h>
  30 #include <limits.h>
  31
  32 #include <glibmm/threads.h>
  33 #include <glibmm/miscutils.h>
  34 #include <glibmm/fileutils.h>
  35
  36 #include <boost/algorithm/string/erase.hpp>
  37
  38 #include "pbd/basename.h"
  39 #include "pbd/convert.h"
  40 #include "pbd/convert.h"
  41 #include "pbd/error.h"
  42 #include "pbd/file_utils.h"
  43 #include "pbd/md5.h"
  44 #include "pbd/pthread_utils.h"
  45 #include "pbd/search_path.h"
  46 #include "pbd/stacktrace.h"
  47 #include "pbd/stl_delete.h"
  48 #include "pbd/replace_all.h"
  49 #include "pbd/unwind.h"
  50
  51 #include "ardour/amp.h"
  52 #include "ardour/analyser.h"
  53 #include "ardour/async_midi_port.h"
  54 #include "ardour/audio_buffer.h"
  55 #include "ardour/audio_diskstream.h"
  56 #include "ardour/audio_port.h"
  57 #include "ardour/audio_track.h"
  58 #include "ardour/audioengine.h"
  59 #include "ardour/audiofilesource.h"
  60 #include "ardour/auditioner.h"
  61 #include "ardour/boost_debug.h"
  62 #include "ardour/buffer_manager.h"
  63 #include "ardour/buffer_set.h"
  64 #include "ardour/bundle.h"
  65 #include "ardour/butler.h"
  66 #include "ardour/click.h"
  67 #include "ardour/control_protocol_manager.h"
  68 #include "ardour/data_type.h"
  69 #include "ardour/debug.h"
  70 #include "ardour/directory_names.h"
  71 #ifdef USE_TRACKS_CODE_FEATURES
  72 #include "ardour/engine_state_controller.h"
  73 #endif
  74 #include "ardour/filename_extensions.h"
  75 #include "ardour/gain_control.h"
  76 #include "ardour/graph.h"
  77 #include "ardour/luabindings.h"
  78 #include "ardour/midiport_manager.h"
  79 #include "ardour/scene_changer.h"
  80 #include "ardour/midi_patch_manager.h"
  81 #include "ardour/midi_track.h"
  82 #include "ardour/midi_ui.h"
  83 #include "ardour/operations.h"
  84 #include "ardour/playlist.h"
  85 #include "ardour/plugin.h"
  86 #include "ardour/plugin_insert.h"
  87 #include "ardour/process_thread.h"
  88 #include "ardour/profile.h"
  89 #include "ardour/rc_configuration.h"
  90 #include "ardour/recent_sessions.h"
  91 #include "ardour/region.h"
  92 #include "ardour/region_factory.h"
  93 #include "ardour/route_graph.h"
  94 #include "ardour/route_group.h"
  95 #include "ardour/send.h"
  96 #include "ardour/session.h"
  97 #include "ardour/session_directory.h"
  98 #include "ardour/session_playlists.h"
  99 #include "ardour/smf_source.h"
 100 #include "ardour/solo_isolate_control.h"
 101 #include "ardour/source_factory.h"
 102 #include "ardour/speakers.h"
 103 #include "ardour/tempo.h"
 104 #include "ardour/ticker.h"
 105 #include "ardour/track.h"
 106 #include "ardour/user_bundle.h"
 107 #include "ardour/utils.h"
 108 #include "ardour/vca_manager.h"
 109 #include "ardour/vca.h"
 110
 111 #include "midi++/port.h"
 112 #include "midi++/mmc.h"
 113
 114 #include "LuaBridge/LuaBridge.h"
 115
 116 #include "i18n.h"
 117
 118 #include <glibmm/checksum.h>
 119
 120 namespace ARDOUR {
 121 class MidiSource;
 122 class Processor;
 123 class Speakers;
 124 }
 125
 126 using namespace std;
 127 using namespace ARDOUR;
 128 using namespace PBD;
 129
 130 bool Session::_disable_all_loaded_plugins = false;
 131 bool Session::_bypass_all_loaded_plugins = false;
 132 guint Session::_name_id_counter = 0;
 133
 134 PBD::Signal1<int,uint32_t> Session::AudioEngineSetupRequired;
 135 PBD::Signal1<void,std::string> Session::Dialog;
 136 PBD::Signal0<int> Session::AskAboutPendingState;
 137 PBD::Signal2<int, framecnt_t, framecnt_t> Session::AskAboutSampleRateMismatch;
 138 PBD::Signal2<void, framecnt_t, framecnt_t> Session::NotifyAboutSampleRateMismatch;
 139 PBD::Signal0<void> Session::SendFeedback;
 140 PBD::Signal3<int,Session*,std::string,DataType> Session::MissingFile;
 141
 142 PBD::Signal1<void, framepos_t> Session::StartTimeChanged;
 143 PBD::Signal1<void, framepos_t> Session::EndTimeChanged;
 144 PBD::Signal2<void,std::string, std::string> Session::Exported;
 145 PBD::Signal1<int,boost::shared_ptr<Playlist> > Session::AskAboutPlaylistDeletion;
 146 PBD::Signal0<void> Session::Quit;
 147 PBD::Signal0<void> Session::FeedbackDetected;
 148 PBD::Signal0<void> Session::SuccessfulGraphSort;
 149 PBD::Signal2<void,std::string,std::string> Session::VersionMismatch;
 150
 151 const framecnt_t Session::bounce_chunk_size = 8192;
 152 static void clean_up_session_event (SessionEvent* ev) { delete ev; }
 153 const SessionEvent::RTeventCallback Session::rt_cleanup (clean_up_session_event);
 154
 155 // seconds should be added after the region exceeds end marker
 156 #ifdef USE_TRACKS_CODE_FEATURES
 157 const uint32_t Session::session_end_shift = 5;
 158 #else
 159 const uint32_t Session::session_end_shift = 0;
 160 #endif
 161
 162 /** @param snapshot_name Snapshot name, without .ardour suffix */
 163 Session::Session (AudioEngine &eng,
 164                   const string& fullpath,
 165                   const string& snapshot_name,
 166                   BusProfile* bus_profile,
 167                   string mix_template)
 168         : playlists (new SessionPlaylists)
 169         , _engine (eng)
 170         , process_function (&Session::process_with_events)
 171         , _bounce_processing_active (false)
 172         , waiting_for_sync_offset (false)
 173         , _base_frame_rate (0)
 174         , _nominal_frame_rate (0)
 175         , _current_frame_rate (0)
 176         , transport_sub_state (0)
 177         , _record_status (Disabled)
 178         , _transport_frame (0)
 179         , _session_range_location (0)
 180         , _slave (0)
 181         , _silent (false)
 182         , _transport_speed (0)
 183         , _default_transport_speed (1.0)
 184         , _last_transport_speed (0)
 185         , _target_transport_speed (0.0)
 186         , auto_play_legal (false)
 187         , _last_slave_transport_frame (0)
 188         , maximum_output_latency (0)
 189         , _requested_return_frame (-1)
 190         , current_block_size (0)
 191         , _worst_output_latency (0)
 192         , _worst_input_latency (0)
 193         , _worst_track_latency (0)
 194         , _have_captured (false)
 195         , _non_soloed_outs_muted (false)
 196         , _listening (false)
 197         , _listen_cnt (0)
 198         , _solo_isolated_cnt (0)
 199         , _writable (false)
 200         , _was_seamless (Config->get_seamless_loop ())
 201         , _under_nsm_control (false)
 202         , _xrun_count (0)
 203         , delta_accumulator_cnt (0)
 204         , average_slave_delta (1800) // !!! why 1800 ???
 205         , average_dir (0)
 206         , have_first_delta_accumulator (false)
 207         , _slave_state (Stopped)
 208         , _mtc_active (false)
 209         , _ltc_active (false)
 210         , post_export_sync (false)
 211         , post_export_position (0)
 212         , _exporting (false)
 213         , _export_rolling (false)
 214         , _export_preroll (0)
 215         , _pre_export_mmc_enabled (false)
 216         , _name (snapshot_name)
 217         , _is_new (true)
 218         , _send_qf_mtc (false)
 219         , _pframes_since_last_mtc (0)
 220         , session_midi_feedback (0)
 221         , play_loop (false)
 222         , loop_changing (false)
 223         , last_loopend (0)
 224         , _session_dir (new SessionDirectory (fullpath))
 225         , _current_snapshot_name (snapshot_name)
 226         , state_tree (0)
 227         , state_was_pending (false)
 228         , _state_of_the_state (StateOfTheState(CannotSave|InitialConnecting|Loading))
 229         , _suspend_save (0)
 230         , _save_queued (false)
 231         , _last_roll_location (0)
 232         , _last_roll_or_reversal_location (0)
 233         , _last_record_location (0)
 234         , pending_locate_roll (false)
 235         , pending_locate_frame (0)
 236         , pending_locate_flush (false)
 237         , pending_abort (false)
 238         , pending_auto_loop (false)
 239         , _mempool ("Session", 1048576)
 240         , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
 241         , _n_lua_scripts (0)
 242         , _butler (new Butler (*this))
 243         , _post_transport_work (0)
 244         ,  cumulative_rf_motion (0)
 245         , rf_scale (1.0)
 246         , _locations (new Locations (*this))
 247         , _ignore_skips_updates (false)
 248         , _rt_thread_active (false)
 249         , _rt_emit_pending (false)
 250         , _ac_thread_active (false)
 251         , step_speed (0)
 252         , outbound_mtc_timecode_frame (0)
 253         , next_quarter_frame_to_send (-1)
 254         , _frames_per_timecode_frame (0)
 255         , _frames_per_hour (0)
 256         , _timecode_frames_per_hour (0)
 257         , last_timecode_valid (false)
 258         , last_timecode_when (0)
 259         , _send_timecode_update (false)
 260         , ltc_encoder (0)
 261         , ltc_enc_buf(0)
 262         , ltc_buf_off (0)
 263         , ltc_buf_len (0)
 264         , ltc_speed (0)
 265         , ltc_enc_byte (0)
 266         , ltc_enc_pos (0)
 267         , ltc_enc_cnt (0)
 268         , ltc_enc_off (0)
 269         , restarting (false)
 270         , ltc_prev_cycle (0)
 271         , ltc_timecode_offset (0)
 272         , ltc_timecode_negative_offset (false)
 273         , midi_control_ui (0)
 274         , _tempo_map (0)
 275         , _all_route_group (new RouteGroup (*this, "all"))
 276         , routes (new RouteList)
 277         , _adding_routes_in_progress (false)
 278         , _reconnecting_routes_in_progress (false)
 279         , _route_deletion_in_progress (false)
 280         , destructive_index (0)
 281         , _track_number_decimals(1)
 282         , default_fade_steepness (0)
 283         , default_fade_msecs (0)
 284         , _total_free_4k_blocks (0)
 285         , _total_free_4k_blocks_uncertain (false)
 286         , no_questions_about_missing_files (false)
 287         , _playback_load (0)
 288         , _capture_load (0)
 289         , _bundles (new BundleList)
 290         , _bundle_xml_node (0)
 291         , _current_trans (0)
 292         , _clicking (false)
 293         , click_data (0)
 294         , click_emphasis_data (0)
 295         , click_length (0)
 296         , click_emphasis_length (0)
 297         , _clicks_cleared (0)
 298         , _play_range (false)
 299         , _range_selection (-1,-1)
 300         , _object_selection (-1,-1)
 301         , main_outs (0)
 302         , first_file_data_format_reset (true)
 303         , first_file_header_format_reset (true)
 304         , have_looped (false)
 305         , _have_rec_enabled_track (false)
 306         , _have_rec_disabled_track (true)
 307         , _step_editors (0)
 308         , _suspend_timecode_transmission (0)
 309         ,  _speakers (new Speakers)
 310         , ignore_route_processor_changes (false)
 311         , midi_clock (0)
 312         , _scene_changer (0)
 313         , _midi_ports (0)
 314         , _mmc (0)
 315         , _vca_manager (new VCAManager (*this))
 316 {
 317         uint32_t sr = 0;
 318
 319         pthread_mutex_init (&_rt_emit_mutex, 0);
 320         pthread_cond_init (&_rt_emit_cond, 0);
 321
 322         pthread_mutex_init (&_auto_connect_mutex, 0);
 323         pthread_cond_init (&_auto_connect_cond, 0);
 324
 325         init_name_id_counter (1); // reset for new sessions, start at 1
 326         VCA::set_next_vca_number (1); // reset for new sessions, start at 1
 327
 328         pre_engine_init (fullpath);
 329
 330         setup_lua ();
 331
 332         if (_is_new) {
 333
 334                 Stateful::loading_state_version = CURRENT_SESSION_FILE_VERSION;
 335
 336 #ifdef USE_TRACKS_CODE_FEATURES
 337                 sr = EngineStateController::instance()->get_current_sample_rate();
 338 #endif
 339                 if (ensure_engine (sr, true)) {
 340                         destroy ();
 341                         throw SessionException (_("Cannot connect to audio/midi engine"));
 342                 }
 343
 344                 // set samplerate for plugins added early
 345                 // e.g from templates or MB channelstrip
 346                 set_block_size (_engine.samples_per_cycle());
 347                 set_frame_rate (_engine.sample_rate());
 348
 349                 if (create (mix_template, bus_profile)) {
 350                         destroy ();
 351                         throw SessionException (_("Session initialization failed"));
 352                 }
 353
 354                 /* if a mix template was provided, then ::create() will
 355                  * have copied it into the session and we need to load it
 356                  * so that we have the state ready for ::set_state()
 357                  * after the engine is started.
 358                  *
 359                  * Note that we do NOT try to get the sample rate from
 360                  * the template at this time, though doing so would
 361                  * be easy if we decided this was an appropriate part
 362                  * of a template.
 363                  */
 364
 365                 if (!mix_template.empty()) {
 366                         if (load_state (_current_snapshot_name)) {
 367                                 throw SessionException (_("Failed to load template/snapshot state"));
 368                         }
 369                         store_recent_templates (mix_template);
 370                 }
 371
 372                 /* load default session properties - if any */
 373                 config.load_state();
 374
 375         } else {
 376
 377                 if (load_state (_current_snapshot_name)) {
 378                         throw SessionException (_("Failed to load state"));
 379                 }
 380
 381                 /* try to get sample rate from XML state so that we
 382                  * can influence the SR if we set up the audio
 383                  * engine.
 384                  */
 385
 386                 if (state_tree) {
 387                         XMLProperty const * prop;
 388                         XMLNode const * root (state_tree->root());
 389                         if ((prop = root->property (X_("sample-rate"))) != 0) {
 390                                 sr = atoi (prop->value());
 391                         }
 392                 }
 393
 394                 if (ensure_engine (sr, false)) {
 395                         destroy ();
 396                         throw SessionException (_("Cannot connect to audio/midi engine"));
 397                 }
 398         }
 399
 400         if (post_engine_init ()) {
 401                 destroy ();
 402                 throw SessionException (_("Cannot configure audio/midi engine with session parameters"));
 403         }
 404
 405         store_recent_sessions (_name, _path);
 406
 407         bool was_dirty = dirty();
 408
 409         _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
 410
 411         Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, false));
 412         config.ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, true));
 413
 414         if (was_dirty) {
 415                 DirtyChanged (); /* EMIT SIGNAL */
 416         }
 417
 418         StartTimeChanged.connect_same_thread (*this, boost::bind (&Session::start_time_changed, this, _1));
 419         EndTimeChanged.connect_same_thread (*this, boost::bind (&Session::end_time_changed, this, _1));
 420
 421         emit_thread_start ();
 422         auto_connect_thread_start ();
 423
 424         /* hook us up to the engine since we are now completely constructed */
 425
 426         BootMessage (_("Connect to engine"));
 427
 428         _engine.set_session (this);
 429         _engine.reset_timebase ();
 430
 431 #ifdef USE_TRACKS_CODE_FEATURES
 432
 433         EngineStateController::instance()->set_session(this);
 434
 435         if (_is_new ) {
 436                 if ( ARDOUR::Profile->get_trx () ) {
 437
 438                         /* Waves Tracks: fill session with tracks basing on the amount of inputs.
 439                          * each available input must have corresponding track when session starts.
 440                          */
 441
 442                         uint32_t how_many (0);
 443
 444                         std::vector<std::string> inputs;
 445                         EngineStateController::instance()->get_physical_audio_inputs(inputs);
 446
 447                         how_many = inputs.size();
 448
 449                         list<boost::shared_ptr<AudioTrack> > tracks;
 450
 451                         // Track names after driver
 452                         if (Config->get_tracks_auto_naming() == NameAfterDriver) {
 453                                 string track_name = "";
 454                                 for (std::vector<string>::size_type i = 0; i < inputs.size(); ++i) {
 455                                         string track_name;
 456                                         track_name = inputs[i];
 457                                         replace_all (track_name, "system:capture", "");
 458
 459                                         list<boost::shared_ptr<AudioTrack> > single_track = new_audio_track (1, 1, Normal, 0, 1, track_name);
 460                                         tracks.insert(tracks.begin(), single_track.front());
 461                                 }
 462                         } else { // Default track names
 463                                 tracks = new_audio_track (1, 1, Normal, 0, how_many, string());
 464                         }
 465
 466                         if (tracks.size() != how_many) {
 467                                 destroy ();
 468                                 throw failed_constructor ();
 469                         }
 470                 }
 471         }
 472 #endif
 473
 474         _is_new = false;
 475         session_loaded ();
 476
 477         BootMessage (_("Session loading complete"));
 478 }
 479
 480 Session::~Session ()
 481 {
 482 #ifdef PT_TIMING
 483         ST.dump ("ST.dump");
 484 #endif
 485         destroy ();
 486 }
 487
 488 unsigned int
 489 Session::next_name_id ()
 490 {
 491         return g_atomic_int_add (&_name_id_counter, 1);
 492 }
 493
 494 unsigned int
 495 Session::name_id_counter ()
 496 {
 497         return g_atomic_int_get (&_name_id_counter);
 498 }
 499
 500 void
 501 Session::init_name_id_counter (guint n)
 502 {
 503         g_atomic_int_set (&_name_id_counter, n);
 504 }
 505
 506 int
 507 Session::ensure_engine (uint32_t desired_sample_rate, bool isnew)
 508 {
 509         if (_engine.current_backend() == 0) {
 510                 /* backend is unknown ... */
 511                 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
 512                 if (r.get_value_or (-1) != 0) {
 513                         return -1;
 514                 }
 515         } else if (!isnew && _engine.running() && _engine.sample_rate () == desired_sample_rate) {
 516                 /* keep engine */
 517         } else if (_engine.setup_required()) {
 518                 /* backend is known, but setup is needed */
 519                 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
 520                 if (r.get_value_or (-1) != 0) {
 521                         return -1;
 522                 }
 523         } else if (!_engine.running()) {
 524                 if (_engine.start()) {
 525                         return -1;
 526                 }
 527         }
 528
 529         /* at this point the engine should be running */
 530
 531         if (!_engine.running()) {
 532                 return -1;
 533         }
 534
 535         return immediately_post_engine ();
 536
 537 }
 538
 539 int
 540 Session::immediately_post_engine ()
 541 {
 542         /* Do various initializations that should take place directly after we
 543          * know that the engine is running, but before we either create a
 544          * session or set state for an existing one.
 545          */
 546
 547         if (how_many_dsp_threads () > 1) {
 548                 /* For now, only create the graph if we are using >1 DSP threads, as
 549                    it is a bit slower than the old code with 1 thread.
 550                 */
 551                 _process_graph.reset (new Graph (*this));
 552         }
 553
 554         /* every time we reconnect, recompute worst case output latencies */
 555
 556         _engine.Running.connect_same_thread (*this, boost::bind (&Session::initialize_latencies, this));
 557
 558         if (synced_to_engine()) {
 559                 _engine.transport_stop ();
 560         }
 561
 562         if (config.get_jack_time_master()) {
 563                 _engine.transport_locate (_transport_frame);
 564         }
 565
 566         try {
 567                 LocaleGuard lg;
 568                 BootMessage (_("Set up LTC"));
 569                 setup_ltc ();
 570                 BootMessage (_("Set up Click"));
 571                 setup_click ();
 572                 BootMessage (_("Set up standard connections"));
 573                 setup_bundles ();
 574         }
 575
 576         catch (failed_constructor& err) {
 577                 return -1;
 578         }
 579
 580         /* TODO, connect in different thread. (PortRegisteredOrUnregistered may be in RT context)
 581          * can we do that? */
 582          _engine.PortRegisteredOrUnregistered.connect_same_thread (*this, boost::bind (&Session::setup_bundles, this));
 583
 584         return 0;
 585 }
 586
 587 void
 588 Session::destroy ()
 589 {
 590         vector<void*> debug_pointers;
 591
 592         /* if we got to here, leaving pending capture state around
 593            is a mistake.
 594         */
 595
 596         remove_pending_capture_state ();
 597
 598         Analyser::flush ();
 599
 600         _state_of_the_state = StateOfTheState (CannotSave|Deletion);
 601
 602         /* stop autoconnecting */
 603         auto_connect_thread_terminate ();
 604
 605         /* disconnect from any and all signals that we are connected to */
 606
 607         Port::PortSignalDrop (); /* EMIT SIGNAL */
 608         drop_connections ();
 609
 610         /* shutdown control surface protocols while we still have ports
 611            and the engine to move data to any devices.
 612         */
 613
 614         ControlProtocolManager::instance().drop_protocols ();
 615
 616         MIDI::Name::MidiPatchManager::instance().remove_search_path(session_directory().midi_patch_path());
 617
 618         _engine.remove_session ();
 619
 620 #ifdef USE_TRACKS_CODE_FEATURES
 621         EngineStateController::instance()->remove_session();
 622 #endif
 623
 624         /* deregister all ports - there will be no process or any other
 625          * callbacks from the engine any more.
 626          */
 627
 628         Port::PortDrop (); /* EMIT SIGNAL */
 629
 630         ltc_tx_cleanup();
 631
 632         /* clear history so that no references to objects are held any more */
 633
 634         _history.clear ();
 635
 636         /* clear state tree so that no references to objects are held any more */
 637
 638         delete state_tree;
 639         state_tree = 0;
 640
 641         // unregister all lua functions, drop held references (if any)
 642         (*_lua_cleanup)();
 643         lua.do_command ("Session = nil");
 644         delete _lua_run;
 645         delete _lua_add;
 646         delete _lua_del;
 647         delete _lua_list;
 648         delete _lua_save;
 649         delete _lua_load;
 650         delete _lua_cleanup;
 651         lua.collect_garbage ();
 652
 653         /* reset dynamic state version back to default */
 654         Stateful::loading_state_version = 0;
 655
 656         _butler->drop_references ();
 657         delete _butler;
 658         _butler = 0;
 659
 660         delete _all_route_group;
 661
 662         DEBUG_TRACE (DEBUG::Destruction, "delete route groups\n");
 663         for (list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
 664                 delete *i;
 665         }
 666
 667         if (click_data != default_click) {
 668                 delete [] click_data;
 669         }
 670
 671         if (click_emphasis_data != default_click_emphasis) {
 672                 delete [] click_emphasis_data;
 673         }
 674
 675         clear_clicks ();
 676
 677         /* need to remove auditioner before monitoring section
 678          * otherwise it is re-connected */
 679         auditioner.reset ();
 680
 681         /* drop references to routes held by the monitoring section
 682          * specifically _monitor_out aux/listen references */
 683         remove_monitor_section();
 684
 685         /* clear out any pending dead wood from RCU managed objects */
 686
 687         routes.flush ();
 688         _bundles.flush ();
 689
 690         AudioDiskstream::free_working_buffers();
 691
 692         /* tell everyone who is still standing that we're about to die */
 693         drop_references ();
 694
 695         /* tell everyone to drop references and delete objects as we go */
 696
 697         DEBUG_TRACE (DEBUG::Destruction, "delete regions\n");
 698         RegionFactory::delete_all_regions ();
 699
 700         /* Do this early so that VCAs no longer hold references to routes */
 701
 702         DEBUG_TRACE (DEBUG::Destruction, "delete vcas\n");
 703         delete _vca_manager;
 704
 705         DEBUG_TRACE (DEBUG::Destruction, "delete routes\n");
 706
 707         /* reset these three references to special routes before we do the usual route delete thing */
 708
 709         _master_out.reset ();
 710         _monitor_out.reset ();
 711
 712         {
 713                 RCUWriter<RouteList> writer (routes);
 714                 boost::shared_ptr<RouteList> r = writer.get_copy ();
 715
 716                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 717                         DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for route %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
 718                         (*i)->drop_references ();
 719                 }
 720
 721                 r->clear ();
 722                 /* writer goes out of scope and updates master */
 723         }
 724         routes.flush ();
 725
 726         {
 727                 DEBUG_TRACE (DEBUG::Destruction, "delete sources\n");
 728                 Glib::Threads::Mutex::Lock lm (source_lock);
 729                 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
 730                         DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for source %1 ; pre-ref = %2\n", i->second->name(), i->second.use_count()));
 731                         i->second->drop_references ();
 732                 }
 733
 734                 sources.clear ();
 735         }
 736
 737         /* not strictly necessary, but doing it here allows the shared_ptr debugging to work */
 738         playlists.reset ();
 739
 740         emit_thread_terminate ();
 741
 742         pthread_cond_destroy (&_rt_emit_cond);
 743         pthread_mutex_destroy (&_rt_emit_mutex);
 744
 745         pthread_cond_destroy (&_auto_connect_cond);
 746         pthread_mutex_destroy (&_auto_connect_mutex);
 747
 748         delete _scene_changer; _scene_changer = 0;
 749         delete midi_control_ui; midi_control_ui = 0;
 750
 751         delete _mmc; _mmc = 0;
 752         delete _midi_ports; _midi_ports = 0;
 753         delete _locations; _locations = 0;
 754
 755         delete midi_clock;
 756         delete _tempo_map;
 757
 758         /* clear event queue, the session is gone, nobody is interested in
 759          * those anymore, but they do leak memory if not removed
 760          */
 761         while (!immediate_events.empty ()) {
 762                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
 763                 SessionEvent *ev = immediate_events.front ();
 764                 DEBUG_TRACE (DEBUG::SessionEvents, string_compose ("Drop event: %1\n", enum_2_string (ev->type)));
 765                 immediate_events.pop_front ();
 766                 bool remove = true;
 767                 bool del = true;
 768                 switch (ev->type) {
 769                         case SessionEvent::AutoLoop:
 770                         case SessionEvent::AutoLoopDeclick:
 771                         case SessionEvent::Skip:
 772                         case SessionEvent::PunchIn:
 773                         case SessionEvent::PunchOut:
 774                         case SessionEvent::StopOnce:
 775                         case SessionEvent::RangeStop:
 776                         case SessionEvent::RangeLocate:
 777                                 remove = false;
 778                                 del = false;
 779                                 break;
 780                         case SessionEvent::RealTimeOperation:
 781                                 process_rtop (ev);
 782                                 del = false;
 783                         default:
 784                                 break;
 785                 }
 786                 if (remove) {
 787                         del = del && !_remove_event (ev);
 788                 }
 789                 if (del) {
 790                         delete ev;
 791                 }
 792         }
 793
 794         DEBUG_TRACE (DEBUG::Destruction, "Session::destroy() done\n");
 795
 796         BOOST_SHOW_POINTERS ();
 797 }
 798
 799 void
 800 Session::setup_ltc ()
 801 {
 802         XMLNode* child = 0;
 803
 804         _ltc_input.reset (new IO (*this, X_("LTC In"), IO::Input));
 805         _ltc_output.reset (new IO (*this, X_("LTC Out"), IO::Output));
 806
 807         if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC In"))) != 0) {
 808                 _ltc_input->set_state (*(child->children().front()), Stateful::loading_state_version);
 809         } else {
 810                 {
 811                         Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
 812                         _ltc_input->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
 813                 }
 814                 reconnect_ltc_input ();
 815         }
 816
 817         if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC Out"))) != 0) {
 818                 _ltc_output->set_state (*(child->children().front()), Stateful::loading_state_version);
 819         } else {
 820                 {
 821                         Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
 822                         _ltc_output->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
 823                 }
 824                 reconnect_ltc_output ();
 825         }
 826
 827         /* fix up names of LTC ports because we don't want the normal
 828          * IO style of NAME/TYPE-{in,out}N
 829          */
 830
 831         _ltc_input->nth (0)->set_name (X_("LTC-in"));
 832         _ltc_output->nth (0)->set_name (X_("LTC-out"));
 833 }
 834
 835 void
 836 Session::setup_click ()
 837 {
 838         _clicking = false;
 839
 840         boost::shared_ptr<AutomationList> gl (new AutomationList (Evoral::Parameter (GainAutomation)));
 841         boost::shared_ptr<GainControl> gain_control = boost::shared_ptr<GainControl> (new GainControl (*this, Evoral::Parameter(GainAutomation), gl));
 842
 843         _click_io.reset (new ClickIO (*this, X_("Click")));
 844         _click_gain.reset (new Amp (*this, _("Fader"), gain_control, true));
 845         _click_gain->activate ();
 846         if (state_tree) {
 847                 setup_click_state (state_tree->root());
 848         } else {
 849                 setup_click_state (0);
 850         }
 851 }
 852
 853 void
 854 Session::setup_click_state (const XMLNode* node)
 855 {
 856         const XMLNode* child = 0;
 857
 858         if (node && (child = find_named_node (*node, "Click")) != 0) {
 859
 860                 /* existing state for Click */
 861                 int c = 0;
 862
 863                 if (Stateful::loading_state_version < 3000) {
 864                         c = _click_io->set_state_2X (*child->children().front(), Stateful::loading_state_version, false);
 865                 } else {
 866                         const XMLNodeList& children (child->children());
 867                         XMLNodeList::const_iterator i = children.begin();
 868                         if ((c = _click_io->set_state (**i, Stateful::loading_state_version)) == 0) {
 869                                 ++i;
 870                                 if (i != children.end()) {
 871                                         c = _click_gain->set_state (**i, Stateful::loading_state_version);
 872                                 }
 873                         }
 874                 }
 875
 876                 if (c == 0) {
 877                         _clicking = Config->get_clicking ();
 878
 879                 } else {
 880
 881                         error << _("could not setup Click I/O") << endmsg;
 882                         _clicking = false;
 883                 }
 884
 885
 886         } else {
 887
 888                 /* default state for Click: dual-mono to first 2 physical outputs */
 889
 890                 vector<string> outs;
 891                 _engine.get_physical_outputs (DataType::AUDIO, outs);
 892
 893                 for (uint32_t physport = 0; physport < 2; ++physport) {
 894                         if (outs.size() > physport) {
 895                                 if (_click_io->add_port (outs[physport], this)) {
 896                                         // relax, even though its an error
 897                                 }
 898                         }
 899                 }
 900
 901                 if (_click_io->n_ports () > ChanCount::ZERO) {
 902                         _clicking = Config->get_clicking ();
 903                 }
 904         }
 905 }
 906
 907 void
 908 Session::setup_bundles ()
 909 {
 910
 911         {
 912                 RCUWriter<BundleList> writer (_bundles);
 913                 boost::shared_ptr<BundleList> b = writer.get_copy ();
 914                 for (BundleList::iterator i = b->begin(); i != b->end();) {
 915                         if (boost::dynamic_pointer_cast<UserBundle>(*i)) {
 916                                 ++i;
 917                                 continue;
 918                         }
 919                         i = b->erase(i);
 920                 }
 921         }
 922
 923         vector<string> inputs[DataType::num_types];
 924         vector<string> outputs[DataType::num_types];
 925         for (uint32_t i = 0; i < DataType::num_types; ++i) {
 926                 _engine.get_physical_inputs (DataType (DataType::Symbol (i)), inputs[i]);
 927                 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
 928         }
 929
 930         /* Create a set of Bundle objects that map
 931            to the physical I/O currently available.  We create both
 932            mono and stereo bundles, so that the common cases of mono
 933            and stereo tracks get bundles to put in their mixer strip
 934            in / out menus.  There may be a nicer way of achieving that;
 935            it doesn't really scale that well to higher channel counts
 936         */
 937
 938         /* mono output bundles */
 939
 940         for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); ++np) {
 941                 char buf[64];
 942                 std::string pn = _engine.get_pretty_name_by_name (outputs[DataType::AUDIO][np]);
 943                 if (!pn.empty()) {
 944                         snprintf (buf, sizeof (buf), _("out %s"), pn.c_str());
 945                 } else {
 946                         snprintf (buf, sizeof (buf), _("out %" PRIu32), np+1);
 947                 }
 948
 949                 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
 950                 c->add_channel (_("mono"), DataType::AUDIO);
 951                 c->set_port (0, outputs[DataType::AUDIO][np]);
 952
 953                 add_bundle (c, false);
 954         }
 955
 956         /* stereo output bundles */
 957
 958         for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); np += 2) {
 959                 if (np + 1 < outputs[DataType::AUDIO].size()) {
 960                         char buf[32];
 961                         snprintf (buf, sizeof(buf), _("out %" PRIu32 "+%" PRIu32), np + 1, np + 2);
 962                         boost::shared_ptr<Bundle> c (new Bundle (buf, true));
 963                         c->add_channel (_("L"), DataType::AUDIO);
 964                         c->set_port (0, outputs[DataType::AUDIO][np]);
 965                         c->add_channel (_("R"), DataType::AUDIO);
 966                         c->set_port (1, outputs[DataType::AUDIO][np + 1]);
 967
 968                         add_bundle (c, false);
 969                 }
 970         }
 971
 972         /* mono input bundles */
 973
 974         for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); ++np) {
 975                 char buf[64];
 976                 std::string pn = _engine.get_pretty_name_by_name (inputs[DataType::AUDIO][np]);
 977                 if (!pn.empty()) {
 978                         snprintf (buf, sizeof (buf), _("in %s"), pn.c_str());
 979                 } else {
 980                         snprintf (buf, sizeof (buf), _("in %" PRIu32), np+1);
 981                 }
 982
 983                 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
 984                 c->add_channel (_("mono"), DataType::AUDIO);
 985                 c->set_port (0, inputs[DataType::AUDIO][np]);
 986
 987                 add_bundle (c, false);
 988         }
 989
 990         /* stereo input bundles */
 991
 992         for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); np += 2) {
 993                 if (np + 1 < inputs[DataType::AUDIO].size()) {
 994                         char buf[32];
 995                         snprintf (buf, sizeof(buf), _("in %" PRIu32 "+%" PRIu32), np + 1, np + 2);
 996
 997                         boost::shared_ptr<Bundle> c (new Bundle (buf, false));
 998                         c->add_channel (_("L"), DataType::AUDIO);
 999                         c->set_port (0, inputs[DataType::AUDIO][np]);
1000                         c->add_channel (_("R"), DataType::AUDIO);
1001                         c->set_port (1, inputs[DataType::AUDIO][np + 1]);
1002
1003                         add_bundle (c, false);
1004                 }
1005         }
1006
1007         /* MIDI input bundles */
1008
1009         for (uint32_t np = 0; np < inputs[DataType::MIDI].size(); ++np) {
1010                 string n = inputs[DataType::MIDI][np];
1011                 std::string pn = _engine.get_pretty_name_by_name (n);
1012                 if (!pn.empty()) {
1013                         n = pn;
1014                 } else {
1015                         boost::erase_first (n, X_("alsa_pcm:"));
1016                 }
1017                 boost::shared_ptr<Bundle> c (new Bundle (n, false));
1018                 c->add_channel ("", DataType::MIDI);
1019                 c->set_port (0, inputs[DataType::MIDI][np]);
1020                 add_bundle (c, false);
1021         }
1022
1023         /* MIDI output bundles */
1024
1025         for (uint32_t np = 0; np < outputs[DataType::MIDI].size(); ++np) {
1026                 string n = outputs[DataType::MIDI][np];
1027                 std::string pn = _engine.get_pretty_name_by_name (n);
1028                 if (!pn.empty()) {
1029                         n = pn;
1030                 } else {
1031                         boost::erase_first (n, X_("alsa_pcm:"));
1032                 }
1033                 boost::shared_ptr<Bundle> c (new Bundle (n, true));
1034                 c->add_channel ("", DataType::MIDI);
1035                 c->set_port (0, outputs[DataType::MIDI][np]);
1036                 add_bundle (c, false);
1037         }
1038
1039         // we trust the backend to only calls us if there's a change
1040         BundleAddedOrRemoved (); /* EMIT SIGNAL */
1041 }
1042
1043 void
1044 Session::auto_connect_master_bus ()
1045 {
1046         if (!_master_out || !Config->get_auto_connect_standard_busses() || _monitor_out) {
1047                 return;
1048         }
1049
1050         // Waves Tracks: Do not connect master bas for Tracks if AutoConnectMaster option is not set
1051         // In this case it means "Multi Out" output mode
1052         if (ARDOUR::Profile->get_trx() && !(Config->get_output_auto_connect() & AutoConnectMaster) ) {
1053                 return;
1054         }
1055
1056         /* if requested auto-connect the outputs to the first N physical ports.
1057          */
1058
1059         uint32_t limit = _master_out->n_outputs().n_total();
1060         vector<string> outputs[DataType::num_types];
1061
1062         for (uint32_t i = 0; i < DataType::num_types; ++i) {
1063                 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1064         }
1065
1066         for (uint32_t n = 0; n < limit; ++n) {
1067                 boost::shared_ptr<Port> p = _master_out->output()->nth (n);
1068                 string connect_to;
1069                 if (outputs[p->type()].size() > n) {
1070                         connect_to = outputs[p->type()][n];
1071                 }
1072
1073                 if (!connect_to.empty() && p->connected_to (connect_to) == false) {
1074                         if (_master_out->output()->connect (p, connect_to, this)) {
1075                                 error << string_compose (_("cannot connect master output %1 to %2"), n, connect_to)
1076                                       << endmsg;
1077                                 break;
1078                         }
1079                 }
1080         }
1081 }
1082
1083 void
1084 Session::remove_monitor_section ()
1085 {
1086         if (!_monitor_out || Profile->get_trx()) {
1087                 return;
1088         }
1089
1090         /* force reversion to Solo-In-Place */
1091         Config->set_solo_control_is_listen_control (false);
1092
1093         /* if we are auditioning, cancel it ... this is a workaround
1094            to a problem (auditioning does not execute the process graph,
1095            which is needed to remove routes when using >1 core for processing)
1096         */
1097         cancel_audition ();
1098
1099         {
1100                 /* Hold process lock while doing this so that we don't hear bits and
1101                  * pieces of audio as we work on each route.
1102                  */
1103
1104                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1105
1106                 /* Connect tracks to monitor section. Note that in an
1107                    existing session, the internal sends will already exist, but we want the
1108                    routes to notice that they connect to the control out specifically.
1109                 */
1110
1111
1112                 boost::shared_ptr<RouteList> r = routes.reader ();
1113                 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1114
1115                 for (RouteList::iterator x = r->begin(); x != r->end(); ++x) {
1116
1117                         if ((*x)->is_monitor()) {
1118                                 /* relax */
1119                         } else if ((*x)->is_master()) {
1120                                 /* relax */
1121                         } else {
1122                                 (*x)->remove_aux_or_listen (_monitor_out);
1123                         }
1124                 }
1125         }
1126
1127         remove_route (_monitor_out);
1128         if (_state_of_the_state & Deletion) {
1129                 return;
1130         }
1131
1132         auto_connect_master_bus ();
1133
1134         if (auditioner) {
1135                 auditioner->connect ();
1136         }
1137
1138         Config->ParameterChanged ("use-monitor-bus");
1139 }
1140
1141 void
1142 Session::add_monitor_section ()
1143 {
1144         RouteList rl;
1145
1146         if (_monitor_out || !_master_out || Profile->get_trx()) {
1147                 return;
1148         }
1149
1150         boost::shared_ptr<Route> r (new Route (*this, _("Monitor"), PresentationInfo::MonitorOut, DataType::AUDIO));
1151
1152         if (r->init ()) {
1153                 return;
1154         }
1155
1156         BOOST_MARK_ROUTE(r);
1157
1158         try {
1159                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1160                 r->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1161                 r->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1162         } catch (...) {
1163                 error << _("Cannot create monitor section. 'Monitor' Port name is not unique.") << endmsg;
1164                 return;
1165         }
1166
1167         rl.push_back (r);
1168         add_routes (rl, false, false, false, 0);
1169
1170         assert (_monitor_out);
1171
1172         /* AUDIO ONLY as of june 29th 2009, because listen semantics for anything else
1173            are undefined, at best.
1174         */
1175
1176         uint32_t limit = _monitor_out->n_inputs().n_audio();
1177
1178         if (_master_out) {
1179
1180                 /* connect the inputs to the master bus outputs. this
1181                  * represents a separate data feed from the internal sends from
1182                  * each route. as of jan 2011, it allows the monitor section to
1183                  * conditionally ignore either the internal sends or the normal
1184                  * input feed, but we should really find a better way to do
1185                  * this, i think.
1186                  */
1187
1188                 _master_out->output()->disconnect (this);
1189
1190                 for (uint32_t n = 0; n < limit; ++n) {
1191                         boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1192                         boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1193
1194                         if (o) {
1195                                 string connect_to = o->name();
1196                                 if (_monitor_out->input()->connect (p, connect_to, this)) {
1197                                         error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1198                                               << endmsg;
1199                                         break;
1200                                 }
1201                         }
1202                 }
1203         }
1204
1205         /* if monitor section is not connected, connect it to physical outs
1206          */
1207
1208         if ((Config->get_auto_connect_standard_busses () || Profile->get_mixbus ()) && !_monitor_out->output()->connected ()) {
1209
1210                 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1211
1212                         boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1213
1214                         if (b) {
1215                                 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1216                         } else {
1217                                 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1218                                                            Config->get_monitor_bus_preferred_bundle())
1219                                         << endmsg;
1220                         }
1221
1222                 } else {
1223
1224                         /* Monitor bus is audio only */
1225
1226                         vector<string> outputs[DataType::num_types];
1227
1228                         for (uint32_t i = 0; i < DataType::num_types; ++i) {
1229                                 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1230                         }
1231
1232                         uint32_t mod = outputs[DataType::AUDIO].size();
1233                         uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1234
1235                         if (mod != 0) {
1236
1237                                 for (uint32_t n = 0; n < limit; ++n) {
1238
1239                                         boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1240                                         string connect_to;
1241                                         if (outputs[DataType::AUDIO].size() > (n % mod)) {
1242                                                 connect_to = outputs[DataType::AUDIO][n % mod];
1243                                         }
1244
1245                                         if (!connect_to.empty()) {
1246                                                 if (_monitor_out->output()->connect (p, connect_to, this)) {
1247                                                         error << string_compose (
1248                                                                 _("cannot connect control output %1 to %2"),
1249                                                                 n, connect_to)
1250                                                               << endmsg;
1251                                                         break;
1252                                                 }
1253                                         }
1254                                 }
1255                         }
1256                 }
1257         }
1258
1259         /* Hold process lock while doing this so that we don't hear bits and
1260          * pieces of audio as we work on each route.
1261          */
1262
1263         Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1264
1265         /* Connect tracks to monitor section. Note that in an
1266            existing session, the internal sends will already exist, but we want the
1267            routes to notice that they connect to the control out specifically.
1268         */
1269
1270
1271         boost::shared_ptr<RouteList> rls = routes.reader ();
1272
1273         PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1274
1275         for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1276
1277                 if ((*x)->is_monitor()) {
1278                         /* relax */
1279                 } else if ((*x)->is_master()) {
1280                         /* relax */
1281                 } else {
1282                         (*x)->enable_monitor_send ();
1283                 }
1284         }
1285
1286         if (auditioner) {
1287                 auditioner->connect ();
1288         }
1289         Config->ParameterChanged ("use-monitor-bus");
1290 }
1291
1292 void
1293 Session::reset_monitor_section ()
1294 {
1295         /* Process lock should be held by the caller.*/
1296
1297         if (!_monitor_out || Profile->get_trx()) {
1298                 return;
1299         }
1300
1301         uint32_t limit = _master_out->n_outputs().n_audio();
1302
1303         /* connect the inputs to the master bus outputs. this
1304          * represents a separate data feed from the internal sends from
1305          * each route. as of jan 2011, it allows the monitor section to
1306          * conditionally ignore either the internal sends or the normal
1307          * input feed, but we should really find a better way to do
1308          * this, i think.
1309          */
1310
1311         _master_out->output()->disconnect (this);
1312         _monitor_out->output()->disconnect (this);
1313
1314         _monitor_out->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1315         _monitor_out->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1316
1317         for (uint32_t n = 0; n < limit; ++n) {
1318                 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1319                 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1320
1321                 if (o) {
1322                         string connect_to = o->name();
1323                         if (_monitor_out->input()->connect (p, connect_to, this)) {
1324                                 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1325                                       << endmsg;
1326                                 break;
1327                         }
1328                 }
1329         }
1330
1331         /* connect monitor section to physical outs
1332          */
1333
1334         if (Config->get_auto_connect_standard_busses()) {
1335
1336                 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1337
1338                         boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1339
1340                         if (b) {
1341                                 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1342                         } else {
1343                                 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1344                                                            Config->get_monitor_bus_preferred_bundle())
1345                                         << endmsg;
1346                         }
1347
1348                 } else {
1349
1350                         /* Monitor bus is audio only */
1351
1352                         vector<string> outputs[DataType::num_types];
1353
1354                         for (uint32_t i = 0; i < DataType::num_types; ++i) {
1355                                 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1356                         }
1357
1358                         uint32_t mod = outputs[DataType::AUDIO].size();
1359                         uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1360
1361                         if (mod != 0) {
1362
1363                                 for (uint32_t n = 0; n < limit; ++n) {
1364
1365                                         boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1366                                         string connect_to;
1367                                         if (outputs[DataType::AUDIO].size() > (n % mod)) {
1368                                                 connect_to = outputs[DataType::AUDIO][n % mod];
1369                                         }
1370
1371                                         if (!connect_to.empty()) {
1372                                                 if (_monitor_out->output()->connect (p, connect_to, this)) {
1373                                                         error << string_compose (
1374                                                                 _("cannot connect control output %1 to %2"),
1375                                                                 n, connect_to)
1376                                                               << endmsg;
1377                                                         break;
1378                                                 }
1379                                         }
1380                                 }
1381                         }
1382                 }
1383         }
1384
1385         /* Connect tracks to monitor section. Note that in an
1386            existing session, the internal sends will already exist, but we want the
1387            routes to notice that they connect to the control out specifically.
1388         */
1389
1390
1391         boost::shared_ptr<RouteList> rls = routes.reader ();
1392
1393         PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1394
1395         for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1396
1397                 if ((*x)->is_monitor()) {
1398                         /* relax */
1399                 } else if ((*x)->is_master()) {
1400                         /* relax */
1401                 } else {
1402                         (*x)->enable_monitor_send ();
1403                 }
1404         }
1405 }
1406
1407 void
1408 Session::hookup_io ()
1409 {
1410         /* stop graph reordering notifications from
1411            causing resorts, etc.
1412         */
1413
1414         _state_of_the_state = StateOfTheState (_state_of_the_state | InitialConnecting);
1415
1416         if (!auditioner) {
1417
1418                 /* we delay creating the auditioner till now because
1419                    it makes its own connections to ports.
1420                 */
1421
1422                 try {
1423                         boost::shared_ptr<Auditioner> a (new Auditioner (*this));
1424                         if (a->init()) {
1425                                 throw failed_constructor ();
1426                         }
1427                         a->use_new_diskstream ();
1428                         auditioner = a;
1429                 }
1430
1431                 catch (failed_constructor& err) {
1432                         warning << _("cannot create Auditioner: no auditioning of regions possible") << endmsg;
1433                 }
1434         }
1435
1436         /* load bundles, which we may have postponed earlier on */
1437         if (_bundle_xml_node) {
1438                 load_bundles (*_bundle_xml_node);
1439                 delete _bundle_xml_node;
1440         }
1441
1442         /* Tell all IO objects to connect themselves together */
1443
1444         IO::enable_connecting ();
1445
1446         /* Now tell all "floating" ports to connect to whatever
1447            they should be connected to.
1448         */
1449
1450         AudioEngine::instance()->reconnect_ports ();
1451
1452         /* Anyone who cares about input state, wake up and do something */
1453
1454         IOConnectionsComplete (); /* EMIT SIGNAL */
1455
1456         _state_of_the_state = StateOfTheState (_state_of_the_state & ~InitialConnecting);
1457
1458         /* now handle the whole enchilada as if it was one
1459            graph reorder event.
1460         */
1461
1462         graph_reordered ();
1463
1464         /* update the full solo state, which can't be
1465            correctly determined on a per-route basis, but
1466            needs the global overview that only the session
1467            has.
1468         */
1469
1470         update_route_solo_state ();
1471 }
1472
1473 void
1474 Session::track_playlist_changed (boost::weak_ptr<Track> wp)
1475 {
1476         boost::shared_ptr<Track> track = wp.lock ();
1477         if (!track) {
1478                 return;
1479         }
1480
1481         boost::shared_ptr<Playlist> playlist;
1482
1483         if ((playlist = track->playlist()) != 0) {
1484                 playlist->RegionAdded.connect_same_thread (*this, boost::bind (&Session::playlist_region_added, this, _1));
1485                 playlist->RangesMoved.connect_same_thread (*this, boost::bind (&Session::playlist_ranges_moved, this, _1));
1486                 playlist->RegionsExtended.connect_same_thread (*this, boost::bind (&Session::playlist_regions_extended, this, _1));
1487         }
1488 }
1489
1490 bool
1491 Session::record_enabling_legal () const
1492 {
1493         /* this used to be in here, but survey says.... we don't need to restrict it */
1494         // if (record_status() == Recording) {
1495         //      return false;
1496         // }
1497
1498         if (Config->get_all_safe()) {
1499                 return false;
1500         }
1501         return true;
1502 }
1503
1504 void
1505 Session::set_track_monitor_input_status (bool yn)
1506 {
1507         boost::shared_ptr<RouteList> rl = routes.reader ();
1508         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1509                 boost::shared_ptr<AudioTrack> tr = boost::dynamic_pointer_cast<AudioTrack> (*i);
1510                 if (tr && tr->rec_enable_control()->get_value()) {
1511                         //cerr << "switching to input = " << !auto_input << __FILE__ << __LINE__ << endl << endl;
1512                         tr->request_input_monitoring (yn);
1513                 }
1514         }
1515 }
1516
1517 void
1518 Session::auto_punch_start_changed (Location* location)
1519 {
1520         replace_event (SessionEvent::PunchIn, location->start());
1521
1522         if (get_record_enabled() && config.get_punch_in()) {
1523                 /* capture start has been changed, so save new pending state */
1524                 save_state ("", true);
1525         }
1526 }
1527
1528 void
1529 Session::auto_punch_end_changed (Location* location)
1530 {
1531         framepos_t when_to_stop = location->end();
1532         // when_to_stop += _worst_output_latency + _worst_input_latency;
1533         replace_event (SessionEvent::PunchOut, when_to_stop);
1534 }
1535
1536 void
1537 Session::auto_punch_changed (Location* location)
1538 {
1539         framepos_t when_to_stop = location->end();
1540
1541         replace_event (SessionEvent::PunchIn, location->start());
1542         //when_to_stop += _worst_output_latency + _worst_input_latency;
1543         replace_event (SessionEvent::PunchOut, when_to_stop);
1544 }
1545
1546 /** @param loc A loop location.
1547  *  @param pos Filled in with the start time of the required fade-out (in session frames).
1548  *  @param length Filled in with the length of the required fade-out.
1549  */
1550 void
1551 Session::auto_loop_declick_range (Location* loc, framepos_t & pos, framepos_t & length)
1552 {
1553         pos = max (loc->start(), loc->end() - 64);
1554         length = loc->end() - pos;
1555 }
1556
1557 void
1558 Session::auto_loop_changed (Location* location)
1559 {
1560         replace_event (SessionEvent::AutoLoop, location->end(), location->start());
1561         framepos_t dcp;
1562         framecnt_t dcl;
1563         auto_loop_declick_range (location, dcp, dcl);
1564
1565         if (transport_rolling() && play_loop) {
1566
1567                 replace_event (SessionEvent::AutoLoopDeclick, dcp, dcl);
1568
1569                 // if (_transport_frame > location->end()) {
1570
1571                 if (_transport_frame < location->start() || _transport_frame > location->end()) {
1572                         // relocate to beginning of loop
1573                         clear_events (SessionEvent::LocateRoll);
1574
1575                         request_locate (location->start(), true);
1576
1577                 }
1578                 else if (Config->get_seamless_loop() && !loop_changing) {
1579
1580                         // schedule a locate-roll to refill the diskstreams at the
1581                         // previous loop end
1582                         loop_changing = true;
1583
1584                         if (location->end() > last_loopend) {
1585                                 clear_events (SessionEvent::LocateRoll);
1586                                 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, last_loopend, last_loopend, 0, true);
1587                                 queue_event (ev);
1588                         }
1589
1590                 }
1591         } else {
1592                 clear_events (SessionEvent::AutoLoopDeclick);
1593                 clear_events (SessionEvent::AutoLoop);
1594         }
1595
1596         /* possibly move playhead if not rolling; if we are rolling we'll move
1597            to the loop start on stop if that is appropriate.
1598          */
1599
1600         framepos_t pos;
1601
1602         if (!transport_rolling() && select_playhead_priority_target (pos)) {
1603                 if (pos == location->start()) {
1604                         request_locate (pos);
1605                 }
1606         }
1607
1608
1609         last_loopend = location->end();
1610         set_dirty ();
1611 }
1612
1613 void
1614 Session::set_auto_punch_location (Location* location)
1615 {
1616         Location* existing;
1617
1618         if ((existing = _locations->auto_punch_location()) != 0 && existing != location) {
1619                 punch_connections.drop_connections();
1620                 existing->set_auto_punch (false, this);
1621                 remove_event (existing->start(), SessionEvent::PunchIn);
1622                 clear_events (SessionEvent::PunchOut);
1623                 auto_punch_location_changed (0);
1624         }
1625
1626         set_dirty();
1627
1628         if (location == 0) {
1629                 return;
1630         }
1631
1632         if (location->end() <= location->start()) {
1633                 error << _("Session: you can't use that location for auto punch (start <= end)") << endmsg;
1634                 return;
1635         }
1636
1637         punch_connections.drop_connections ();
1638
1639         location->StartChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_start_changed, this, location));
1640         location->EndChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_end_changed, this, location));
1641         location->Changed.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_changed, this, location));
1642
1643         location->set_auto_punch (true, this);
1644
1645         auto_punch_changed (location);
1646
1647         auto_punch_location_changed (location);
1648 }
1649
1650 void
1651 Session::set_session_extents (framepos_t start, framepos_t end)
1652 {
1653         Location* existing;
1654         if ((existing = _locations->session_range_location()) == 0) {
1655                 //if there is no existing session, we need to make a new session location  (should never happen)
1656                 existing = new Location (*this, 0, 0, _("session"), Location::IsSessionRange);
1657         }
1658
1659         if (end <= start) {
1660                 error << _("Session: you can't use that location for session start/end)") << endmsg;
1661                 return;
1662         }
1663
1664         existing->set( start, end );
1665
1666         set_dirty();
1667 }
1668
1669 void
1670 Session::set_auto_loop_location (Location* location)
1671 {
1672         Location* existing;
1673
1674         if ((existing = _locations->auto_loop_location()) != 0 && existing != location) {
1675                 loop_connections.drop_connections ();
1676                 existing->set_auto_loop (false, this);
1677                 remove_event (existing->end(), SessionEvent::AutoLoop);
1678                 framepos_t dcp;
1679                 framecnt_t dcl;
1680                 auto_loop_declick_range (existing, dcp, dcl);
1681                 remove_event (dcp, SessionEvent::AutoLoopDeclick);
1682                 auto_loop_location_changed (0);
1683         }
1684
1685         set_dirty();
1686
1687         if (location == 0) {
1688                 return;
1689         }
1690
1691         if (location->end() <= location->start()) {
1692                 error << _("You cannot use this location for auto-loop because it has zero or negative length") << endmsg;
1693                 return;
1694         }
1695
1696         last_loopend = location->end();
1697
1698         loop_connections.drop_connections ();
1699
1700         location->StartChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1701         location->EndChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1702         location->Changed.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1703         location->FlagsChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1704
1705         location->set_auto_loop (true, this);
1706
1707         if (Config->get_loop_is_mode() && play_loop && Config->get_seamless_loop()) {
1708                 // set all tracks to use internal looping
1709                 boost::shared_ptr<RouteList> rl = routes.reader ();
1710                 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1711                         boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1712                         if (tr && !tr->hidden()) {
1713                                 tr->set_loop (location);
1714                         }
1715                 }
1716         }
1717
1718         /* take care of our stuff first */
1719
1720         auto_loop_changed (location);
1721
1722         /* now tell everyone else */
1723
1724         auto_loop_location_changed (location);
1725 }
1726
1727 void
1728 Session::update_marks (Location*)
1729 {
1730         set_dirty ();
1731 }
1732
1733 void
1734 Session::update_skips (Location* loc, bool consolidate)
1735 {
1736         if (_ignore_skips_updates) {
1737                 return;
1738         }
1739
1740         Locations::LocationList skips;
1741
1742         if (consolidate) {
1743                 PBD::Unwinder<bool> uw (_ignore_skips_updates, true);
1744                 consolidate_skips (loc);
1745         }
1746
1747         sync_locations_to_skips ();
1748
1749         set_dirty ();
1750 }
1751
1752 void
1753 Session::consolidate_skips (Location* loc)
1754 {
1755         Locations::LocationList all_locations = _locations->list ();
1756
1757         for (Locations::LocationList::iterator l = all_locations.begin(); l != all_locations.end(); ) {
1758
1759                 if (!(*l)->is_skip ()) {
1760                         ++l;
1761                         continue;
1762                 }
1763
1764                 /* don't test against self */
1765
1766                 if (*l == loc) {
1767                         ++l;
1768                         continue;
1769                 }
1770
1771                 switch (Evoral::coverage ((*l)->start(), (*l)->end(), loc->start(), loc->end())) {
1772                 case Evoral::OverlapInternal:
1773                 case Evoral::OverlapExternal:
1774                 case Evoral::OverlapStart:
1775                 case Evoral::OverlapEnd:
1776                         /* adjust new location to cover existing one */
1777                         loc->set_start (min (loc->start(), (*l)->start()));
1778                         loc->set_end (max (loc->end(), (*l)->end()));
1779                         /* we don't need this one any more */
1780                         _locations->remove (*l);
1781                         /* the location has been deleted, so remove reference to it in our local list */
1782                         l = all_locations.erase (l);
1783                         break;
1784
1785                 case Evoral::OverlapNone:
1786                         ++l;
1787                         break;
1788                 }
1789         }
1790 }
1791
1792 void
1793 Session::sync_locations_to_skips ()
1794 {
1795         /* This happens asynchronously (in the audioengine thread). After the clear is done, we will call
1796          * Session::_sync_locations_to_skips() from the audioengine thread.
1797          */
1798         clear_events (SessionEvent::Skip, boost::bind (&Session::_sync_locations_to_skips, this));
1799 }
1800
1801 void
1802 Session::_sync_locations_to_skips ()
1803 {
1804         /* called as a callback after existing Skip events have been cleared from a realtime audioengine thread */
1805
1806         Locations::LocationList const & locs (_locations->list());
1807
1808         for (Locations::LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
1809
1810                 Location* location = *i;
1811
1812                 if (location->is_skip() && location->is_skipping()) {
1813                         SessionEvent* ev = new SessionEvent (SessionEvent::Skip, SessionEvent::Add, location->start(), location->end(), 1.0);
1814                         queue_event (ev);
1815                 }
1816         }
1817 }
1818
1819
1820 void
1821 Session::location_added (Location *location)
1822 {
1823         if (location->is_auto_punch()) {
1824                 set_auto_punch_location (location);
1825         }
1826
1827         if (location->is_auto_loop()) {
1828                 set_auto_loop_location (location);
1829         }
1830
1831         if (location->is_session_range()) {
1832                 /* no need for any signal handling or event setting with the session range,
1833                    because we keep a direct reference to it and use its start/end directly.
1834                 */
1835                 _session_range_location = location;
1836         }
1837
1838         if (location->is_mark()) {
1839                 /* listen for per-location signals that require us to do any * global updates for marks */
1840
1841                 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1842                 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1843                 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1844                 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1845         }
1846
1847         if (location->is_skip()) {
1848                 /* listen for per-location signals that require us to update skip-locate events */
1849
1850                 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1851                 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1852                 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1853                 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, false));
1854
1855                 update_skips (location, true);
1856         }
1857
1858         set_dirty ();
1859 }
1860
1861 void
1862 Session::location_removed (Location *location)
1863 {
1864         if (location->is_auto_loop()) {
1865                 set_auto_loop_location (0);
1866                 set_track_loop (false);
1867         }
1868
1869         if (location->is_auto_punch()) {
1870                 set_auto_punch_location (0);
1871         }
1872
1873         if (location->is_session_range()) {
1874                 /* this is never supposed to happen */
1875                 error << _("programming error: session range removed!") << endl;
1876         }
1877
1878         if (location->is_skip()) {
1879
1880                 update_skips (location, false);
1881         }
1882
1883         set_dirty ();
1884 }
1885
1886 void
1887 Session::locations_changed ()
1888 {
1889         _locations->apply (*this, &Session::_locations_changed);
1890 }
1891
1892 void
1893 Session::_locations_changed (const Locations::LocationList& locations)
1894 {
1895         /* There was some mass-change in the Locations object.
1896
1897            We might be re-adding a location here but it doesn't actually matter
1898            for all the locations that the Session takes an interest in.
1899         */
1900
1901         {
1902                 PBD::Unwinder<bool> protect_ignore_skip_updates (_ignore_skips_updates, true);
1903                 for (Locations::LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
1904                         location_added (*i);
1905                 }
1906         }
1907
1908         update_skips (NULL, false);
1909 }
1910
1911 void
1912 Session::enable_record ()
1913 {
1914         if (_transport_speed != 0.0 && _transport_speed != 1.0) {
1915                 /* no recording at anything except normal speed */
1916                 return;
1917         }
1918
1919         while (1) {
1920                 RecordState rs = (RecordState) g_atomic_int_get (&_record_status);
1921
1922                 if (rs == Recording) {
1923                         break;
1924                 }
1925
1926                 if (g_atomic_int_compare_and_exchange (&_record_status, rs, Recording)) {
1927
1928                         _last_record_location = _transport_frame;
1929                         send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordStrobe));
1930
1931                         if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1932                                 set_track_monitor_input_status (true);
1933                         }
1934
1935                         RecordStateChanged ();
1936                         break;
1937                 }
1938         }
1939 }
1940
1941 void
1942 Session::set_all_tracks_record_enabled (bool enable )
1943 {
1944         boost::shared_ptr<RouteList> rl = routes.reader();
1945         set_controls (route_list_to_control_list (rl, &Track::rec_enable_control), enable, Controllable::NoGroup);
1946 }
1947
1948 void
1949 Session::disable_record (bool rt_context, bool force)
1950 {
1951         RecordState rs;
1952
1953         if ((rs = (RecordState) g_atomic_int_get (&_record_status)) != Disabled) {
1954
1955                 if (!Config->get_latched_record_enable () || force) {
1956                         g_atomic_int_set (&_record_status, Disabled);
1957                         send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordExit));
1958                 } else {
1959                         if (rs == Recording) {
1960                                 g_atomic_int_set (&_record_status, Enabled);
1961                         }
1962                 }
1963
1964                 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1965                         set_track_monitor_input_status (false);
1966                 }
1967
1968                 RecordStateChanged (); /* emit signal */
1969
1970                 if (!rt_context) {
1971                         remove_pending_capture_state ();
1972                 }
1973         }
1974 }
1975
1976 void
1977 Session::step_back_from_record ()
1978 {
1979         if (g_atomic_int_compare_and_exchange (&_record_status, Recording, Enabled)) {
1980
1981                 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1982                         set_track_monitor_input_status (false);
1983                 }
1984
1985                 RecordStateChanged (); /* emit signal */
1986         }
1987 }
1988
1989 void
1990 Session::maybe_enable_record ()
1991 {
1992         if (_step_editors > 0) {
1993                 return;
1994         }
1995
1996         g_atomic_int_set (&_record_status, Enabled);
1997
1998         /* This function is currently called from somewhere other than an RT thread.
1999            This save_state() call therefore doesn't impact anything.  Doing it here
2000            means that we save pending state of which sources the next record will use,
2001            which gives us some chance of recovering from a crash during the record.
2002         */
2003
2004         save_state ("", true);
2005
2006         if (_transport_speed) {
2007                 if (!config.get_punch_in()) {
2008                         enable_record ();
2009                 }
2010         } else {
2011                 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordPause));
2012                 RecordStateChanged (); /* EMIT SIGNAL */
2013         }
2014
2015         set_dirty();
2016 }
2017
2018 framepos_t
2019 Session::audible_frame () const
2020 {
2021         framepos_t ret;
2022         framepos_t tf;
2023         framecnt_t offset;
2024
2025         offset = worst_playback_latency ();
2026
2027         if (synced_to_engine()) {
2028                 /* Note: this is basically just sync-to-JACK */
2029                 tf = _engine.transport_frame();
2030         } else {
2031                 tf = _transport_frame;
2032         }
2033
2034         ret = tf;
2035
2036         if (!non_realtime_work_pending()) {
2037
2038                 /* MOVING */
2039
2040                 /* Check to see if we have passed the first guaranteed
2041                    audible frame past our last start position. if not,
2042                    return that last start point because in terms
2043                    of audible frames, we have not moved yet.
2044
2045                    `Start position' in this context means the time we last
2046                    either started, located, or changed transport direction.
2047                 */
2048
2049                 if (_transport_speed > 0.0f) {
2050
2051                         if (!play_loop || !have_looped) {
2052                                 if (tf < _last_roll_or_reversal_location + offset) {
2053                                         return _last_roll_or_reversal_location;
2054                                 }
2055                         }
2056
2057
2058                         /* forwards */
2059                         ret -= offset;
2060
2061                 } else if (_transport_speed < 0.0f) {
2062
2063                         /* XXX wot? no backward looping? */
2064
2065                         if (tf > _last_roll_or_reversal_location - offset) {
2066                                 return _last_roll_or_reversal_location;
2067                         } else {
2068                                 /* backwards */
2069                                 ret += offset;
2070                         }
2071                 }
2072         }
2073
2074         return ret;
2075 }
2076
2077 void
2078 Session::set_frame_rate (framecnt_t frames_per_second)
2079 {
2080         /** \fn void Session::set_frame_size(framecnt_t)
2081                 the AudioEngine object that calls this guarantees
2082                 that it will not be called while we are also in
2083                 ::process(). Its fine to do things that block
2084                 here.
2085         */
2086
2087         if (_base_frame_rate == 0) {
2088                 _base_frame_rate = frames_per_second;
2089         }
2090         else if (_base_frame_rate != frames_per_second && frames_per_second != _nominal_frame_rate) {
2091                 NotifyAboutSampleRateMismatch (_base_frame_rate, frames_per_second);
2092         }
2093         _nominal_frame_rate = frames_per_second;
2094
2095         sync_time_vars();
2096
2097         clear_clicks ();
2098         reset_write_sources (false);
2099
2100         // XXX we need some equivalent to this, somehow
2101         // SndFileSource::setup_standard_crossfades (frames_per_second);
2102
2103         set_dirty();
2104
2105         /* XXX need to reset/reinstantiate all LADSPA plugins */
2106 }
2107
2108 void
2109 Session::set_block_size (pframes_t nframes)
2110 {
2111         /* the AudioEngine guarantees
2112            that it will not be called while we are also in
2113            ::process(). It is therefore fine to do things that block
2114            here.
2115         */
2116
2117         {
2118                 current_block_size = nframes;
2119
2120                 ensure_buffers ();
2121
2122                 boost::shared_ptr<RouteList> r = routes.reader ();
2123
2124                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2125                         (*i)->set_block_size (nframes);
2126                 }
2127
2128                 boost::shared_ptr<RouteList> rl = routes.reader ();
2129                 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2130                         boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2131                         if (tr) {
2132                                 tr->set_block_size (nframes);
2133                         }
2134                 }
2135
2136                 set_worst_io_latencies ();
2137         }
2138 }
2139
2140
2141 static void
2142 trace_terminal (boost::shared_ptr<Route> r1, boost::shared_ptr<Route> rbase)
2143 {
2144         boost::shared_ptr<Route> r2;
2145
2146         if (r1->feeds (rbase) && rbase->feeds (r1)) {
2147                 info << string_compose(_("feedback loop setup between %1 and %2"), r1->name(), rbase->name()) << endmsg;
2148                 return;
2149         }
2150
2151         /* make a copy of the existing list of routes that feed r1 */
2152
2153         Route::FedBy existing (r1->fed_by());
2154
2155         /* for each route that feeds r1, recurse, marking it as feeding
2156            rbase as well.
2157         */
2158
2159         for (Route::FedBy::iterator i = existing.begin(); i != existing.end(); ++i) {
2160                 if (!(r2 = i->r.lock ())) {
2161                         /* (*i) went away, ignore it */
2162                         continue;
2163                 }
2164
2165                 /* r2 is a route that feeds r1 which somehow feeds base. mark
2166                    base as being fed by r2
2167                 */
2168
2169                 rbase->add_fed_by (r2, i->sends_only);
2170
2171                 if (r2 != rbase) {
2172
2173                         /* 2nd level feedback loop detection. if r1 feeds or is fed by r2,
2174                            stop here.
2175                         */
2176
2177                         if (r1->feeds (r2) && r2->feeds (r1)) {
2178                                 continue;
2179                         }
2180
2181                         /* now recurse, so that we can mark base as being fed by
2182                            all routes that feed r2
2183                         */
2184
2185                         trace_terminal (r2, rbase);
2186                 }
2187
2188         }
2189 }
2190
2191 void
2192 Session::resort_routes ()
2193 {
2194         /* don't do anything here with signals emitted
2195            by Routes during initial setup or while we
2196            are being destroyed.
2197         */
2198
2199         if (_state_of_the_state & (InitialConnecting | Deletion)) {
2200                 return;
2201         }
2202
2203         if (_route_deletion_in_progress) {
2204                 return;
2205         }
2206
2207         {
2208                 RCUWriter<RouteList> writer (routes);
2209                 boost::shared_ptr<RouteList> r = writer.get_copy ();
2210                 resort_routes_using (r);
2211                 /* writer goes out of scope and forces update */
2212         }
2213
2214 #ifndef NDEBUG
2215         if (DEBUG_ENABLED(DEBUG::Graph)) {
2216                 boost::shared_ptr<RouteList> rl = routes.reader ();
2217                 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2218                         DEBUG_TRACE (DEBUG::Graph, string_compose ("%1 fed by ...\n", (*i)->name()));
2219
2220                         const Route::FedBy& fb ((*i)->fed_by());
2221
2222                         for (Route::FedBy::const_iterator f = fb.begin(); f != fb.end(); ++f) {
2223                                 boost::shared_ptr<Route> sf = f->r.lock();
2224                                 if (sf) {
2225                                         DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 (sends only ? %2)\n", sf->name(), f->sends_only));
2226                                 }
2227                         }
2228                 }
2229         }
2230 #endif
2231
2232 }
2233
2234 /** This is called whenever we need to rebuild the graph of how we will process
2235  *  routes.
2236  *  @param r List of routes, in any order.
2237  */
2238
2239 void
2240 Session::resort_routes_using (boost::shared_ptr<RouteList> r)
2241 {
2242         /* We are going to build a directed graph of our routes;
2243            this is where the edges of that graph are put.
2244         */
2245
2246         GraphEdges edges;
2247
2248         /* Go through all routes doing two things:
2249          *
2250          * 1. Collect the edges of the route graph.  Each of these edges
2251          *    is a pair of routes, one of which directly feeds the other
2252          *    either by a JACK connection or by an internal send.
2253          *
2254          * 2. Begin the process of making routes aware of which other
2255          *    routes directly or indirectly feed them.  This information
2256          *    is used by the solo code.
2257          */
2258
2259         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2260
2261                 /* Clear out the route's list of direct or indirect feeds */
2262                 (*i)->clear_fed_by ();
2263
2264                 for (RouteList::iterator j = r->begin(); j != r->end(); ++j) {
2265
2266                         bool via_sends_only;
2267
2268                         /* See if this *j feeds *i according to the current state of the JACK
2269                            connections and internal sends.
2270                         */
2271                         if ((*j)->direct_feeds_according_to_reality (*i, &via_sends_only)) {
2272                                 /* add the edge to the graph (part #1) */
2273                                 edges.add (*j, *i, via_sends_only);
2274                                 /* tell the route (for part #2) */
2275                                 (*i)->add_fed_by (*j, via_sends_only);
2276                         }
2277                 }
2278         }
2279
2280         /* Attempt a topological sort of the route graph */
2281         boost::shared_ptr<RouteList> sorted_routes = topological_sort (r, edges);
2282
2283         if (sorted_routes) {
2284                 /* We got a satisfactory topological sort, so there is no feedback;
2285                    use this new graph.
2286
2287                    Note: the process graph rechain does not require a
2288                    topologically-sorted list, but hey ho.
2289                 */
2290                 if (_process_graph) {
2291                         _process_graph->rechain (sorted_routes, edges);
2292                 }
2293
2294                 _current_route_graph = edges;
2295
2296                 /* Complete the building of the routes' lists of what directly
2297                    or indirectly feeds them.
2298                 */
2299                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2300                         trace_terminal (*i, *i);
2301                 }
2302
2303                 *r = *sorted_routes;
2304
2305 #ifndef NDEBUG
2306                 DEBUG_TRACE (DEBUG::Graph, "Routes resorted, order follows:\n");
2307                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2308                         DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 presentation order %2\n", (*i)->name(), (*i)->presentation_info().global_order()));
2309                 }
2310 #endif
2311
2312                 SuccessfulGraphSort (); /* EMIT SIGNAL */
2313
2314         } else {
2315                 /* The topological sort failed, so we have a problem.  Tell everyone
2316                    and stick to the old graph; this will continue to be processed, so
2317                    until the feedback is fixed, what is played back will not quite
2318                    reflect what is actually connected.  Note also that we do not
2319                    do trace_terminal here, as it would fail due to an endless recursion,
2320                    so the solo code will think that everything is still connected
2321                    as it was before.
2322                 */
2323
2324                 FeedbackDetected (); /* EMIT SIGNAL */
2325         }
2326
2327 }
2328
2329 /** Find a route name starting with \a base, maybe followed by the
2330  *  lowest \a id.  \a id will always be added if \a definitely_add_number
2331  *  is true on entry; otherwise it will only be added if required
2332  *  to make the name unique.
2333  *
2334  *  Names are constructed like e.g. "Audio 3" for base="Audio" and id=3.
2335  *  The available route name with the lowest ID will be used, and \a id
2336  *  will be set to the ID.
2337  *
2338  *  \return false if a route name could not be found, and \a track_name
2339  *  and \a id do not reflect a free route name.
2340  */
2341 bool
2342 Session::find_route_name (string const & base, uint32_t& id, string& name, bool definitely_add_number)
2343 {
2344         /* the base may conflict with ports that do not belong to existing
2345            routes, but hidden objects like the click track. So check port names
2346            before anything else.
2347         */
2348
2349         for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
2350                 if (base == *reserved) {
2351                         /* Check if this reserved name already exists, and if
2352                            so, disallow it without a numeric suffix.
2353                         */
2354                         if (route_by_name (*reserved)) {
2355                                 definitely_add_number = true;
2356                                 if (id < 1) {
2357                                         id = 1;
2358                                 }
2359                         }
2360                         break;
2361                 }
2362         }
2363
2364         if (!definitely_add_number && route_by_name (base) == 0) {
2365                 /* juse use the base */
2366                 name = base;
2367                 return true;
2368         }
2369
2370         do {
2371                 name = string_compose ("%1 %2", base, id);
2372
2373                 if (route_by_name (name) == 0) {
2374                         return true;
2375                 }
2376
2377                 ++id;
2378
2379         } while (id < (UINT_MAX-1));
2380
2381         return false;
2382 }
2383
2384 /** Count the total ins and outs of all non-hidden tracks in the session and return them in in and out */
2385 void
2386 Session::count_existing_track_channels (ChanCount& in, ChanCount& out)
2387 {
2388         in  = ChanCount::ZERO;
2389         out = ChanCount::ZERO;
2390
2391         boost::shared_ptr<RouteList> r = routes.reader ();
2392
2393         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2394                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2395                 if (tr && !tr->is_auditioner()) {
2396                         in  += tr->n_inputs();
2397                         out += tr->n_outputs();
2398                 }
2399         }
2400 }
2401
2402 string
2403 Session::default_track_name_pattern (DataType t)
2404 {
2405         switch (t) {
2406         case DataType::AUDIO:
2407                 if (Profile->get_trx()) {
2408                         return _("Track ");
2409                 } else {
2410                         return _("Audio ");
2411                 }
2412                 break;
2413
2414         case DataType::MIDI:
2415                 return _("MIDI ");
2416         }
2417
2418         return "";
2419 }
2420
2421 /** Caller must not hold process lock
2422  *  @param name_template string to use for the start of the name, or "" to use "MIDI".
2423  *  @param instrument plugin info for the instrument to insert pre-fader, if any
2424  */
2425 list<boost::shared_ptr<MidiTrack> >
2426 Session::new_midi_track (boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2427                          RouteGroup* route_group, uint32_t how_many, string name_template, PresentationInfo::order_t order,
2428                          TrackMode mode)
2429 {
2430         string track_name;
2431         uint32_t track_id = 0;
2432         string port;
2433         RouteList new_routes;
2434         list<boost::shared_ptr<MidiTrack> > ret;
2435
2436         const string name_pattern = default_track_name_pattern (DataType::MIDI);
2437         bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2438
2439         while (how_many) {
2440                 if (!find_route_name (name_template.empty() ? _("MIDI") : name_template, ++track_id, track_name, use_number)) {
2441                         error << "cannot find name for new midi track" << endmsg;
2442                         goto failed;
2443                 }
2444
2445                 boost::shared_ptr<MidiTrack> track;
2446
2447                 try {
2448                         track.reset (new MidiTrack (*this, track_name, mode));
2449
2450                         if (track->init ()) {
2451                                 goto failed;
2452                         }
2453
2454                         if (Profile->get_mixbus ()) {
2455                                 track->set_strict_io (true);
2456                         }
2457
2458                         track->use_new_diskstream();
2459
2460                         BOOST_MARK_TRACK (track);
2461
2462                         {
2463                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2464                                 if (track->input()->ensure_io (input, false, this)) {
2465                                         error << "cannot configure " << input << " out configuration for new midi track" << endmsg;
2466                                         goto failed;
2467                                 }
2468
2469                                 if (track->output()->ensure_io (output, false, this)) {
2470                                         error << "cannot configure " << output << " out configuration for new midi track" << endmsg;
2471                                         goto failed;
2472                                 }
2473                         }
2474
2475                         track->non_realtime_input_change();
2476
2477                         if (route_group) {
2478                                 route_group->add (track);
2479                         }
2480
2481                         track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2482
2483                         new_routes.push_back (track);
2484                         ret.push_back (track);
2485                 }
2486
2487                 catch (failed_constructor &err) {
2488                         error << _("Session: could not create new midi track.") << endmsg;
2489                         goto failed;
2490                 }
2491
2492                 catch (AudioEngine::PortRegistrationFailure& pfe) {
2493
2494                         error << string_compose (_("No more JACK ports are available. You will need to stop %1 and restart JACK with more ports if you need this many tracks."), PROGRAM_NAME) << endmsg;
2495                         goto failed;
2496                 }
2497
2498                 --how_many;
2499         }
2500
2501   failed:
2502         if (!new_routes.empty()) {
2503                 StateProtector sp (this);
2504                 if (Profile->get_trx()) {
2505                         add_routes (new_routes, false, false, false, order);
2506                 } else {
2507                         add_routes (new_routes, true, true, false, order);
2508                 }
2509
2510                 if (instrument) {
2511                         for (RouteList::iterator r = new_routes.begin(); r != new_routes.end(); ++r) {
2512                                 PluginPtr plugin = instrument->load (*this);
2513                                 if (pset) {
2514                                         plugin->load_preset (*pset);
2515                                 }
2516                                 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2517                                 (*r)->add_processor (p, PreFader);
2518
2519                         }
2520                 }
2521         }
2522
2523         return ret;
2524 }
2525
2526 RouteList
2527 Session::new_midi_route (RouteGroup* route_group, uint32_t how_many, string name_template, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2528                          PresentationInfo::Flag flag, PresentationInfo::order_t order)
2529 {
2530         string bus_name;
2531         uint32_t bus_id = 0;
2532         string port;
2533         RouteList ret;
2534
2535         bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Midi Bus");
2536
2537         while (how_many) {
2538                 if (!find_route_name (name_template.empty () ? _("Midi Bus") : name_template, ++bus_id, bus_name, use_number)) {
2539                         error << "cannot find name for new midi bus" << endmsg;
2540                         goto failure;
2541                 }
2542
2543                 try {
2544                         boost::shared_ptr<Route> bus (new Route (*this, bus_name, flag, DataType::AUDIO)); // XXX Editor::add_routes is not ready for ARDOUR::DataType::MIDI
2545
2546                         if (bus->init ()) {
2547                                 goto failure;
2548                         }
2549
2550                         if (Profile->get_mixbus ()) {
2551                                 bus->set_strict_io (true);
2552                         }
2553
2554                         BOOST_MARK_ROUTE(bus);
2555
2556                         {
2557                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2558
2559                                 if (bus->input()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2560                                         error << _("cannot configure new midi bus input") << endmsg;
2561                                         goto failure;
2562                                 }
2563
2564
2565                                 if (bus->output()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2566                                         error << _("cannot configure new midi bus output") << endmsg;
2567                                         goto failure;
2568                                 }
2569                         }
2570
2571                         if (route_group) {
2572                                 route_group->add (bus);
2573                         }
2574
2575                         ret.push_back (bus);
2576                 }
2577
2578                 catch (failed_constructor &err) {
2579                         error << _("Session: could not create new audio route.") << endmsg;
2580                         goto failure;
2581                 }
2582
2583                 catch (AudioEngine::PortRegistrationFailure& pfe) {
2584                         error << pfe.what() << endmsg;
2585                         goto failure;
2586                 }
2587
2588
2589                 --how_many;
2590         }
2591
2592   failure:
2593         if (!ret.empty()) {
2594                 StateProtector sp (this);
2595                 add_routes (ret, false, false, false, order);
2596
2597                 if (instrument) {
2598                         for (RouteList::iterator r = ret.begin(); r != ret.end(); ++r) {
2599                                 PluginPtr plugin = instrument->load (*this);
2600                                 if (pset) {
2601                                         plugin->load_preset (*pset);
2602                                 }
2603                                 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2604                                 (*r)->add_processor (p, PreFader);
2605                         }
2606                 }
2607         }
2608
2609         return ret;
2610
2611 }
2612
2613
2614 void
2615 Session::midi_output_change_handler (IOChange change, void * /*src*/, boost::weak_ptr<Route> wmt)
2616 {
2617         boost::shared_ptr<Route> midi_track (wmt.lock());
2618
2619         if (!midi_track) {
2620                 return;
2621         }
2622
2623         if ((change.type & IOChange::ConfigurationChanged) && Config->get_output_auto_connect() != ManualConnect) {
2624
2625                 if (change.after.n_audio() <= change.before.n_audio()) {
2626                         return;
2627                 }
2628
2629                 /* new audio ports: make sure the audio goes somewhere useful,
2630                  * unless the user has no-auto-connect selected.
2631                  *
2632                  * The existing ChanCounts don't matter for this call as they are only
2633                  * to do with matching input and output indices, and we are only changing
2634                  * outputs here.
2635                  */
2636                 auto_connect_route (midi_track, false, ChanCount(), change.before);
2637         }
2638 }
2639
2640 #ifdef USE_TRACKS_CODE_FEATURES
2641
2642 static bool
2643 compare_routes_by_remote_id (const boost::shared_ptr<Route>& route1, const boost::shared_ptr<Route>& route2)
2644 {
2645         return route1->remote_control_id() < route2->remote_control_id();
2646 }
2647
2648 void
2649 Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool reconnect_inputs, bool reconnect_outputs)
2650 {
2651         // it is not allowed to perform connection
2652         if (!IO::connecting_legal) {
2653                 return;
2654         }
2655
2656         // if we are deleting routes we will call this once at the end
2657         if (_route_deletion_in_progress) {
2658                 return;
2659         }
2660
2661         Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2662
2663         if (withLock) {
2664                 lm.acquire ();
2665         }
2666
2667         // We need to disconnect the route's inputs and outputs first
2668         // basing on autoconnect configuration
2669         bool reconnectIputs = !(Config->get_input_auto_connect() & ManualConnect) && reconnect_inputs;
2670         bool reconnectOutputs = !(Config->get_output_auto_connect() & ManualConnect) && reconnect_outputs;
2671
2672         ChanCount existing_inputs;
2673         ChanCount existing_outputs;
2674         count_existing_track_channels (existing_inputs, existing_outputs);
2675
2676         //ChanCount inputs = ChanCount::ZERO;
2677         //ChanCount outputs = ChanCount::ZERO;
2678
2679         RouteList existing_routes = *routes.reader ();
2680         existing_routes.sort (compare_routes_by_remote_id);
2681
2682         {
2683                 PBD::Unwinder<bool> protect_ignore_changes (_reconnecting_routes_in_progress, true);
2684
2685                 vector<string> physinputs;
2686                 vector<string> physoutputs;
2687
2688                 EngineStateController::instance()->get_physical_audio_outputs(physoutputs);
2689                 EngineStateController::instance()->get_physical_audio_inputs(physinputs);
2690
2691                 uint32_t input_n = 0;
2692                 uint32_t output_n = 0;
2693                 RouteList::iterator rIter = existing_routes.begin();
2694                 const AutoConnectOption current_input_auto_connection (Config->get_input_auto_connect());
2695                 const AutoConnectOption current_output_auto_connection (Config->get_output_auto_connect());
2696                 for (; rIter != existing_routes.end(); ++rIter) {
2697                         if (*rIter == _master_out || *rIter == _monitor_out ) {
2698                                 continue;
2699                         }
2700
2701                         if (current_output_auto_connection == AutoConnectPhysical) {
2702                                 (*rIter)->amp()->deactivate();
2703                         } else if (current_output_auto_connection == AutoConnectMaster) {
2704                                 (*rIter)->amp()->activate();
2705                         }
2706
2707                         if (reconnectIputs) {
2708                                 (*rIter)->input()->disconnect (this); //GZ: check this; could be heavy
2709
2710                                 for (uint32_t route_input_n = 0; route_input_n < (*rIter)->n_inputs().get(DataType::AUDIO); ++route_input_n) {
2711
2712                                         if (current_input_auto_connection & AutoConnectPhysical) {
2713
2714                                                 if ( input_n == physinputs.size() ) {
2715                                                         break;
2716                                                 }
2717
2718                                                 string port = physinputs[input_n];
2719
2720                                                 if (port.empty() ) {
2721                                                         error << "Physical Input number "<< input_n << " is unavailable and cannot be connected" << endmsg;
2722                                                 }
2723
2724                                                 //GZ: check this; could be heavy
2725                                                 (*rIter)->input()->connect ((*rIter)->input()->ports().port(DataType::AUDIO, route_input_n), port, this);
2726                                                 ++input_n;
2727                                         }
2728                                 }
2729                         }
2730
2731                         if (reconnectOutputs) {
2732
2733                                 //normalize route ouptuts: reduce the amount outputs to be equal to the amount of inputs
2734                                 if (current_output_auto_connection & AutoConnectPhysical) {
2735
2736                                         //GZ: check this; could be heavy
2737                                         (*rIter)->output()->disconnect (this);
2738                                         size_t route_inputs_count = (*rIter)->n_inputs().get(DataType::AUDIO);
2739
2740                                         //GZ: check this; could be heavy
2741                                         (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, route_inputs_count), false, this );
2742
2743                                 } else if (current_output_auto_connection & AutoConnectMaster){
2744
2745                                         if (!reconnect_master) {
2746                                                 continue;
2747                                         }
2748
2749                                         //GZ: check this; could be heavy
2750                                         (*rIter)->output()->disconnect (this);
2751
2752                                         if (_master_out) {
2753                                                 uint32_t master_inputs_count = _master_out->n_inputs().get(DataType::AUDIO);
2754                                                 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, master_inputs_count), false, this );
2755                                         } else {
2756                                                 error << error << "Master bus is not available" << endmsg;
2757                                                 break;
2758                                         }
2759                                 }
2760
2761                                 for (uint32_t route_output_n = 0; route_output_n < (*rIter)->n_outputs().get(DataType::AUDIO); ++route_output_n) {
2762                                         if (current_output_auto_connection & AutoConnectPhysical) {
2763
2764                                                 if ( output_n == physoutputs.size() ) {
2765                                                         break;
2766                                                 }
2767
2768                                                 string port = physoutputs[output_n];
2769
2770                                                 if (port.empty() ) {
2771                                                         error << "Physical Output number "<< output_n << " is unavailable and cannot be connected" << endmsg;
2772                                                 }
2773
2774                                                 //GZ: check this; could be heavy
2775                                                 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2776                                                 ++output_n;
2777
2778                                         } else if (current_output_auto_connection & AutoConnectMaster) {
2779
2780                                                 if ( route_output_n == _master_out->n_inputs().get(DataType::AUDIO) ) {
2781                                                         break;
2782                                                 }
2783
2784                                                 // connect to master bus
2785                                                 string port = _master_out->input()->ports().port(DataType::AUDIO, route_output_n)->name();
2786
2787                                                 if (port.empty() ) {
2788                                                         error << "MasterBus Input number "<< route_output_n << " is unavailable and cannot be connected" << endmsg;
2789                                                 }
2790
2791
2792                                                 //GZ: check this; could be heavy
2793                                                 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2794
2795                                         }
2796                                 }
2797                         }
2798                 }
2799
2800                 _master_out->output()->disconnect (this);
2801                 auto_connect_master_bus ();
2802         }
2803
2804         graph_reordered ();
2805
2806         session_routes_reconnected (); /* EMIT SIGNAL */
2807 }
2808
2809 void
2810 Session::reconnect_midi_scene_ports(bool inputs)
2811 {
2812     if (inputs ) {
2813
2814         boost::shared_ptr<MidiPort> scene_in_ptr = scene_in();
2815         if (scene_in_ptr) {
2816             scene_in_ptr->disconnect_all ();
2817
2818             std::vector<EngineStateController::MidiPortState> midi_port_states;
2819             EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2820
2821             std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2822
2823             for (; state_iter != midi_port_states.end(); ++state_iter) {
2824                 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2825                     scene_in_ptr->connect (state_iter->name);
2826                 }
2827             }
2828         }
2829
2830     } else {
2831
2832         boost::shared_ptr<MidiPort> scene_out_ptr = scene_out();
2833
2834         if (scene_out_ptr ) {
2835             scene_out_ptr->disconnect_all ();
2836
2837             std::vector<EngineStateController::MidiPortState> midi_port_states;
2838             EngineStateController::instance()->get_physical_midi_output_states (midi_port_states);
2839
2840             std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2841
2842             for (; state_iter != midi_port_states.end(); ++state_iter) {
2843                 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2844                     scene_out_ptr->connect (state_iter->name);
2845                 }
2846             }
2847         }
2848     }
2849 }
2850
2851 void
2852 Session::reconnect_mtc_ports ()
2853 {
2854         boost::shared_ptr<MidiPort> mtc_in_ptr = _midi_ports->mtc_input_port();
2855
2856         if (!mtc_in_ptr) {
2857                 return;
2858         }
2859
2860         mtc_in_ptr->disconnect_all ();
2861
2862         std::vector<EngineStateController::MidiPortState> midi_port_states;
2863         EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2864
2865         std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2866
2867         for (; state_iter != midi_port_states.end(); ++state_iter) {
2868                 if (state_iter->available && state_iter->mtc_in) {
2869                         mtc_in_ptr->connect (state_iter->name);
2870                 }
2871         }
2872
2873         if (!_midi_ports->mtc_input_port ()->connected () &&
2874             config.get_external_sync () &&
2875             (Config->get_sync_source () == MTC) ) {
2876                 config.set_external_sync (false);
2877         }
2878
2879         if ( ARDOUR::Profile->get_trx () ) {
2880                 // Tracks need this signal to update timecode_source_dropdown
2881                 MtcOrLtcInputPortChanged (); //emit signal
2882         }
2883 }
2884
2885 void
2886 Session::reconnect_mmc_ports(bool inputs)
2887 {
2888         if (inputs ) { // get all enabled midi input ports
2889
2890                 boost::shared_ptr<MidiPort> mmc_in_ptr = _midi_ports->mmc_in();
2891                 if (mmc_in_ptr) {
2892                         mmc_in_ptr->disconnect_all ();
2893                         std::vector<std::string> enabled_midi_inputs;
2894                         EngineStateController::instance()->get_physical_midi_inputs (enabled_midi_inputs);
2895
2896                         std::vector<std::string>::iterator port_iter = enabled_midi_inputs.begin();
2897
2898                         for (; port_iter != enabled_midi_inputs.end(); ++port_iter) {
2899                                 mmc_in_ptr->connect (*port_iter);
2900                         }
2901
2902                 }
2903         } else { // get all enabled midi output ports
2904
2905                 boost::shared_ptr<MidiPort> mmc_out_ptr = _midi_ports->mmc_out();
2906                 if (mmc_out_ptr ) {
2907                         mmc_out_ptr->disconnect_all ();
2908                         std::vector<std::string> enabled_midi_outputs;
2909                         EngineStateController::instance()->get_physical_midi_outputs (enabled_midi_outputs);
2910
2911                         std::vector<std::string>::iterator port_iter = enabled_midi_outputs.begin();
2912
2913                         for (; port_iter != enabled_midi_outputs.end(); ++port_iter) {
2914                                 mmc_out_ptr->connect (*port_iter);
2915                         }
2916                 }
2917         }
2918 }
2919
2920 #endif
2921
2922 void
2923 Session::ensure_presentation_info_gap (PresentationInfo::order_t first_new_order, uint32_t how_many)
2924 {
2925         if (first_new_order == PresentationInfo::max_order) {
2926                 /* adding at end, no worries */
2927                 return;
2928         }
2929
2930         /* create a gap in the existing route order keys to accomodate new routes.*/
2931         boost::shared_ptr <RouteList> rd = routes.reader();
2932         for (RouteList::iterator ri = rd->begin(); ri != rd->end(); ++ri) {
2933                 boost::shared_ptr<Route> rt (*ri);
2934
2935                 if (rt->presentation_info().special()) {
2936                         continue;
2937                 }
2938
2939                 if (rt->presentation_info().group_order () >= first_new_order) {
2940                         rt->set_presentation_group_order (rt->presentation_info().group_order () + how_many);
2941                 }
2942         }
2943 }
2944
2945 /** Caller must not hold process lock
2946  *  @param name_template string to use for the start of the name, or "" to use "Audio".
2947  */
2948 list< boost::shared_ptr<AudioTrack> >
2949 Session::new_audio_track (int input_channels, int output_channels, RouteGroup* route_group,
2950                           uint32_t how_many, string name_template, PresentationInfo::order_t order,
2951                           TrackMode mode)
2952 {
2953         string track_name;
2954         uint32_t track_id = 0;
2955         string port;
2956         RouteList new_routes;
2957         list<boost::shared_ptr<AudioTrack> > ret;
2958
2959         const string name_pattern = default_track_name_pattern (DataType::AUDIO);
2960         bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2961
2962         while (how_many) {
2963
2964                 if (!find_route_name (name_template.empty() ? _(name_pattern.c_str()) : name_template, ++track_id, track_name, use_number)) {
2965                         error << "cannot find name for new audio track" << endmsg;
2966                         goto failed;
2967                 }
2968
2969                 boost::shared_ptr<AudioTrack> track;
2970
2971                 try {
2972                         track.reset (new AudioTrack (*this, track_name, mode));
2973
2974                         if (track->init ()) {
2975                                 goto failed;
2976                         }
2977
2978                         if (Profile->get_mixbus ()) {
2979                                 track->set_strict_io (true);
2980                         }
2981
2982                         if (ARDOUR::Profile->get_trx ()) {
2983                                 // TRACKS considers it's not a USE CASE, it's
2984                                 // a piece of behavior of the session model:
2985                                 //
2986                                 // Gain for a newly created route depends on
2987                                 // the current output_auto_connect mode:
2988                                 //
2989                                 //  0 for Stereo Out mode
2990                                 //  0 Multi Out mode
2991                                 if (Config->get_output_auto_connect() & AutoConnectMaster) {
2992                                         track->gain_control()->set_value (dB_to_coefficient (0), Controllable::NoGroup);
2993                                 }
2994                         }
2995
2996                         track->use_new_diskstream();
2997
2998                         BOOST_MARK_TRACK (track);
2999
3000                         {
3001                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3002
3003                                 if (track->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3004                                         error << string_compose (
3005                                                 _("cannot configure %1 in/%2 out configuration for new audio track"),
3006                                                 input_channels, output_channels)
3007                                               << endmsg;
3008                                         goto failed;
3009                                 }
3010
3011                                 if (track->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3012                                         error << string_compose (
3013                                                 _("cannot configure %1 in/%2 out configuration for new audio track"),
3014                                                 input_channels, output_channels)
3015                                               << endmsg;
3016                                         goto failed;
3017                                 }
3018                         }
3019
3020                         if (route_group) {
3021                                 route_group->add (track);
3022                         }
3023
3024                         track->non_realtime_input_change();
3025
3026                         track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
3027
3028                         new_routes.push_back (track);
3029                         ret.push_back (track);
3030                 }
3031
3032                 catch (failed_constructor &err) {
3033                         error << _("Session: could not create new audio track.") << endmsg;
3034                         goto failed;
3035                 }
3036
3037                 catch (AudioEngine::PortRegistrationFailure& pfe) {
3038
3039                         error << pfe.what() << endmsg;
3040                         goto failed;
3041                 }
3042
3043                 --how_many;
3044         }
3045
3046   failed:
3047         if (!new_routes.empty()) {
3048                 StateProtector sp (this);
3049                 if (Profile->get_trx()) {
3050                         add_routes (new_routes, false, false, false, order);
3051                 } else {
3052                         add_routes (new_routes, true, true, false, order);
3053                 }
3054         }
3055
3056         return ret;
3057 }
3058
3059 /** Caller must not hold process lock.
3060  *  @param name_template string to use for the start of the name, or "" to use "Bus".
3061  */
3062 RouteList
3063 Session::new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, string name_template,
3064                           PresentationInfo::Flag flags, PresentationInfo::order_t order)
3065 {
3066         string bus_name;
3067         uint32_t bus_id = 0;
3068         string port;
3069         RouteList ret;
3070
3071         bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
3072
3073         ensure_presentation_info_gap (order, how_many);
3074
3075         while (how_many) {
3076                 if (!find_route_name (name_template.empty () ? _("Bus") : name_template, ++bus_id, bus_name, use_number)) {
3077                         error << "cannot find name for new audio bus" << endmsg;
3078                         goto failure;
3079                 }
3080
3081                 try {
3082                         boost::shared_ptr<Route> bus (new Route (*this, bus_name, flags, DataType::AUDIO));
3083
3084                         if (bus->init ()) {
3085                                 goto failure;
3086                         }
3087
3088                         if (Profile->get_mixbus ()) {
3089                                 bus->set_strict_io (true);
3090                         }
3091
3092                         BOOST_MARK_ROUTE(bus);
3093
3094                         {
3095                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3096
3097                                 if (bus->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3098                                         error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3099                                                                  input_channels, output_channels)
3100                                               << endmsg;
3101                                         goto failure;
3102                                 }
3103
3104
3105                                 if (bus->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3106                                         error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3107                                                                  input_channels, output_channels)
3108                                               << endmsg;
3109                                         goto failure;
3110                                 }
3111                         }
3112
3113                         if (route_group) {
3114                                 route_group->add (bus);
3115                         }
3116
3117                         bus->add_internal_return ();
3118                         ret.push_back (bus);
3119                 }
3120
3121                 catch (failed_constructor &err) {
3122                         error << _("Session: could not create new audio route.") << endmsg;
3123                         goto failure;
3124                 }
3125
3126                 catch (AudioEngine::PortRegistrationFailure& pfe) {
3127                         error << pfe.what() << endmsg;
3128                         goto failure;
3129                 }
3130
3131
3132                 --how_many;
3133         }
3134
3135   failure:
3136         if (!ret.empty()) {
3137                 StateProtector sp (this);
3138                 if (Profile->get_trx()) {
3139                         add_routes (ret, false, false, false, order);
3140                 } else {
3141                         add_routes (ret, false, true, true, order); // autoconnect // outputs only
3142                 }
3143         }
3144
3145         return ret;
3146
3147 }
3148
3149 RouteList
3150 Session::new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name_base, PlaylistDisposition pd)
3151 {
3152         XMLTree tree;
3153
3154         if (!tree.read (template_path.c_str())) {
3155                 return RouteList();
3156         }
3157
3158         return new_route_from_template (how_many, *tree.root(), name_base, pd);
3159 }
3160
3161 RouteList
3162 Session::new_route_from_template (uint32_t how_many, XMLNode& node, const std::string& name_base, PlaylistDisposition pd)
3163 {
3164         RouteList ret;
3165         uint32_t number = 0;
3166         const uint32_t being_added = how_many;
3167         /* This will prevent the use of any existing XML-provided PBD::ID
3168            values by Stateful.
3169         */
3170         Stateful::ForceIDRegeneration force_ids;
3171         IO::disable_connecting ();
3172
3173         while (how_many) {
3174
3175                 /* We're going to modify the node contents a bit so take a
3176                  * copy. The node may be re-used when duplicating more than once.
3177                  */
3178
3179                 XMLNode node_copy (node);
3180
3181                 try {
3182                         string name;
3183
3184                         if (!name_base.empty()) {
3185
3186                                 /* if we're adding more than one routes, force
3187                                  * all the names of the new routes to be
3188                                  * numbered, via the final parameter.
3189                                  */
3190
3191                                 if (!find_route_name (name_base.c_str(), ++number, name, (being_added > 1))) {
3192                                         fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3193                                         /*NOTREACHDE*/
3194                                 }
3195
3196                         } else {
3197
3198                                 string const route_name  = node_copy.property(X_("name"))->value ();
3199
3200                                 /* generate a new name by adding a number to the end of the template name */
3201                                 if (!find_route_name (route_name.c_str(), ++number, name, true)) {
3202                                         fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3203                                         abort(); /*NOTREACHED*/
3204                                 }
3205                         }
3206
3207                         /* set this name in the XML description that we are about to use */
3208
3209                         bool rename_playlist;
3210                         switch (pd) {
3211                         case NewPlaylist:
3212                                 rename_playlist = true;
3213                                 break;
3214                         default:
3215                         case CopyPlaylist:
3216                         case SharePlaylist:
3217                                 rename_playlist = false;
3218                         }
3219
3220                         Route::set_name_in_state (node_copy, name, rename_playlist);
3221
3222                         /* trim bitslots from listen sends so that new ones are used */
3223                         XMLNodeList children = node_copy.children ();
3224                         for (XMLNodeList::iterator i = children.begin(); i != children.end(); ++i) {
3225                                 if ((*i)->name() == X_("Processor")) {
3226                                         /* ForceIDRegeneration does not catch the following */
3227                                         XMLProperty const * role = (*i)->property (X_("role"));
3228                                         XMLProperty const * type = (*i)->property (X_("type"));
3229                                         if (role && role->value() == X_("Aux")) {
3230                                                 /* check if the target bus exists.
3231                                                  * we should not save aux-sends in templates.
3232                                                  */
3233                                                 XMLProperty const * target = (*i)->property (X_("target"));
3234                                                 if (!target) {
3235                                                         (*i)->add_property ("type", "dangling-aux-send");
3236                                                         continue;
3237                                                 }
3238                                                 boost::shared_ptr<Route> r = route_by_id (target->value());
3239                                                 if (!r || boost::dynamic_pointer_cast<Track>(r)) {
3240                                                         (*i)->add_property ("type", "dangling-aux-send");
3241                                                         continue;
3242                                                 }
3243                                         }
3244                                         if (role && role->value() == X_("Listen")) {
3245                                                 (*i)->remove_property (X_("bitslot"));
3246                                         }
3247                                         else if (role && (role->value() == X_("Send") || role->value() == X_("Aux"))) {
3248                                                 char buf[32];
3249                                                 Delivery::Role xrole;
3250                                                 uint32_t bitslot = 0;
3251                                                 xrole = Delivery::Role (string_2_enum (role->value(), xrole));
3252                                                 std::string name = Send::name_and_id_new_send(*this, xrole, bitslot, false);
3253                                                 snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
3254                                                 (*i)->remove_property (X_("bitslot"));
3255                                                 (*i)->remove_property (X_("name"));
3256                                                 (*i)->add_property ("bitslot", buf);
3257                                                 (*i)->add_property ("name", name);
3258                                         }
3259                                         else if (type && type->value() == X_("return")) {
3260                                                 // Return::set_state() generates a new one
3261                                                 (*i)->remove_property (X_("bitslot"));
3262                                         }
3263                                         else if (type && type->value() == X_("port")) {
3264                                                 // PortInsert::set_state() handles the bitslot
3265                                                 (*i)->remove_property (X_("bitslot"));
3266                                                 (*i)->add_property ("ignore-name", "1");
3267                                         }
3268                                 }
3269                         }
3270
3271                         boost::shared_ptr<Route> route (XMLRouteFactory (node_copy, 3000));
3272
3273                         if (route == 0) {
3274                                 error << _("Session: cannot create track/bus from template description") << endmsg;
3275                                 goto out;
3276                         }
3277
3278                         if (boost::dynamic_pointer_cast<Track>(route)) {
3279                                 /* force input/output change signals so that the new diskstream
3280                                    picks up the configuration of the route. During session
3281                                    loading this normally happens in a different way.
3282                                 */
3283
3284                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3285
3286                                 IOChange change (IOChange::Type (IOChange::ConfigurationChanged | IOChange::ConnectionsChanged));
3287                                 change.after = route->input()->n_ports();
3288                                 route->input()->changed (change, this);
3289                                 change.after = route->output()->n_ports();
3290                                 route->output()->changed (change, this);
3291                         }
3292
3293                         boost::shared_ptr<Track> track;
3294
3295                         if ((track = boost::dynamic_pointer_cast<Track> (route))) {
3296                                 switch (pd) {
3297                                 case NewPlaylist:
3298                                         track->use_new_playlist ();
3299                                         break;
3300                                 case CopyPlaylist:
3301                                         track->use_copy_playlist ();
3302                                         break;
3303                                 case SharePlaylist:
3304                                         break;
3305                                 }
3306                         };
3307
3308                         ret.push_back (route);
3309                 }
3310
3311                 catch (failed_constructor &err) {
3312                         error << _("Session: could not create new route from template") << endmsg;
3313                         goto out;
3314                 }
3315
3316                 catch (AudioEngine::PortRegistrationFailure& pfe) {
3317                         error << pfe.what() << endmsg;
3318                         goto out;
3319                 }
3320
3321                 --how_many;
3322         }
3323
3324   out:
3325         if (!ret.empty()) {
3326                 StateProtector sp (this);
3327                 if (Profile->get_trx()) {
3328                         add_routes (ret, false, false, false, PresentationInfo::max_order);
3329                 } else {
3330                         add_routes (ret, true, true, false, PresentationInfo::max_order);
3331                 }
3332                 IO::enable_connecting ();
3333         }
3334
3335         return ret;
3336 }
3337
3338 void
3339 Session::add_routes (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t order)
3340 {
3341         try {
3342                 PBD::Unwinder<bool> aip (_adding_routes_in_progress, true);
3343                 add_routes_inner (new_routes, input_auto_connect, output_auto_connect, order);
3344
3345         } catch (...) {
3346                 error << _("Adding new tracks/busses failed") << endmsg;
3347         }
3348
3349         graph_reordered ();
3350
3351         update_latency (true);
3352         update_latency (false);
3353
3354         set_dirty();
3355
3356         if (save) {
3357                 save_state (_current_snapshot_name);
3358         }
3359
3360         update_route_record_state ();
3361
3362         RouteAdded (new_routes); /* EMIT SIGNAL */
3363 }
3364
3365 void
3366 Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t order)
3367 {
3368         ChanCount existing_inputs;
3369         ChanCount existing_outputs;
3370         uint32_t n_routes;
3371         uint32_t added = 0;
3372
3373         count_existing_track_channels (existing_inputs, existing_outputs);
3374
3375         {
3376                 RCUWriter<RouteList> writer (routes);
3377                 boost::shared_ptr<RouteList> r = writer.get_copy ();
3378                 r->insert (r->end(), new_routes.begin(), new_routes.end());
3379                 n_routes = r->size();
3380
3381                 /* if there is no control out and we're not in the middle of loading,
3382                  * resort the graph here. if there is a control out, we will resort
3383                  * toward the end of this method. if we are in the middle of loading,
3384                  * we will resort when done.
3385                  */
3386
3387                 if (!_monitor_out && IO::connecting_legal) {
3388                         resort_routes_using (r);
3389                 }
3390         }
3391
3392         DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("ensure order gap starting at %1 for %2\n", order, new_routes.size()));
3393         ensure_presentation_info_gap (order, new_routes.size());
3394
3395         for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x, ++added) {
3396
3397                 boost::weak_ptr<Route> wpr (*x);
3398                 boost::shared_ptr<Route> r (*x);
3399
3400                 r->solo_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_changed, this, _1, _2,wpr));
3401                 r->solo_isolate_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, wpr));
3402                 r->mute_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this));
3403
3404                 r->output()->changed.connect_same_thread (*this, boost::bind (&Session::set_worst_io_latencies_x, this, _1, _2));
3405                 r->processors_changed.connect_same_thread (*this, boost::bind (&Session::route_processors_changed, this, _1));
3406
3407                 if (r->is_master()) {
3408                         _master_out = r;
3409                 }
3410
3411                 if (r->is_monitor()) {
3412                         _monitor_out = r;
3413                 }
3414
3415                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (r);
3416                 if (tr) {
3417                         tr->PlaylistChanged.connect_same_thread (*this, boost::bind (&Session::track_playlist_changed, this, boost::weak_ptr<Track> (tr)));
3418                         track_playlist_changed (boost::weak_ptr<Track> (tr));
3419                         tr->rec_enable_control()->Changed.connect_same_thread (*this, boost::bind (&Session::update_route_record_state, this));
3420
3421                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (tr);
3422                         if (mt) {
3423                                 mt->StepEditStatusChange.connect_same_thread (*this, boost::bind (&Session::step_edit_status_change, this, _1));
3424                                 mt->output()->changed.connect_same_thread (*this, boost::bind (&Session::midi_output_change_handler, this, _1, _2, boost::weak_ptr<Route>(mt)));
3425                         }
3426                 }
3427
3428                 if (!r->presentation_info().special()) {
3429
3430                         DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("checking PI state for %1\n", r->name()));
3431
3432                         /* presentation info order may already have been set from XML */
3433
3434                         if (r->presentation_info().unordered()) {
3435
3436                                 if (order == PresentationInfo::max_order) {
3437                                         /* just add to the end */
3438                                         r->set_presentation_group_order_explicit (n_routes + added);
3439                                         DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to NR %1 + %2 = %3\n", n_routes, added, n_routes + added));
3440                                 } else {
3441                                         r->set_presentation_group_order_explicit (order + added);
3442                                         DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to %1 + %2 = %3\n", order, added, order + added));
3443                                 }
3444                         } else {
3445                                 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order already set to %1\n", r->presentation_info().group_order()));
3446                         }
3447                 }
3448
3449                 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("added route %1, group order %2 global order %3 type %4 (summary: %5)\n",
3450                                                                r->name(),
3451                                                                r->presentation_info().group_order(),
3452                                                                r->presentation_info().global_order(),
3453                                                                enum_2_string (r->presentation_info().flags()),
3454                                                                r->presentation_info().to_string()));
3455
3456
3457                 if (input_auto_connect || output_auto_connect) {
3458                         auto_connect_route (r, input_auto_connect, ChanCount (), ChanCount (), existing_inputs, existing_outputs);
3459                         existing_inputs += r->n_inputs();
3460                         existing_outputs += r->n_outputs();
3461                 }
3462
3463                 ARDOUR::GUIIdle ();
3464         }
3465
3466         if (_monitor_out && IO::connecting_legal) {
3467                 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
3468
3469                 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3470                         if ((*x)->is_monitor()) {
3471                                 /* relax */
3472                         } else if ((*x)->is_master()) {
3473                                 /* relax */
3474                         } else {
3475                                 (*x)->enable_monitor_send ();
3476                         }
3477                 }
3478         }
3479 }
3480
3481 void
3482 Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
3483 {
3484         boost::shared_ptr<RouteList> r = routes.reader ();
3485         boost::shared_ptr<Send> s;
3486
3487         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3488                 if ((s = (*i)->internal_send_for (dest)) != 0) {
3489                         s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO, Controllable::NoGroup);
3490                 }
3491         }
3492 }
3493
3494 void
3495 Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
3496 {
3497         boost::shared_ptr<RouteList> r = routes.reader ();
3498         boost::shared_ptr<Send> s;
3499
3500         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3501                 if ((s = (*i)->internal_send_for (dest)) != 0) {
3502                         s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
3503                 }
3504         }
3505 }
3506
3507 void
3508 Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
3509 {
3510         boost::shared_ptr<RouteList> r = routes.reader ();
3511         boost::shared_ptr<Send> s;
3512
3513         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3514                 if ((s = (*i)->internal_send_for (dest)) != 0) {
3515                         s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value(), Controllable::NoGroup);
3516                 }
3517         }
3518 }
3519
3520 /** @param include_buses true to add sends to buses and tracks, false for just tracks */
3521 void
3522 Session::globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool include_buses)
3523 {
3524         boost::shared_ptr<RouteList> r = routes.reader ();
3525         boost::shared_ptr<RouteList> t (new RouteList);
3526
3527         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3528                 /* no MIDI sends because there are no MIDI busses yet */
3529                 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(*i)) {
3530                         t->push_back (*i);
3531                 }
3532         }
3533
3534         add_internal_sends (dest, p, t);
3535 }
3536
3537 void
3538 Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders)
3539 {
3540         for (RouteList::iterator i = senders->begin(); i != senders->end(); ++i) {
3541                 add_internal_send (dest, (*i)->before_processor_for_placement (p), *i);
3542         }
3543 }
3544
3545 void
3546 Session::add_internal_send (boost::shared_ptr<Route> dest, int index, boost::shared_ptr<Route> sender)
3547 {
3548         add_internal_send (dest, sender->before_processor_for_index (index), sender);
3549 }
3550
3551 void
3552 Session::add_internal_send (boost::shared_ptr<Route> dest, boost::shared_ptr<Processor> before, boost::shared_ptr<Route> sender)
3553 {
3554         if (sender->is_monitor() || sender->is_master() || sender == dest || dest->is_monitor() || dest->is_master()) {
3555                 return;
3556         }
3557
3558         if (!dest->internal_return()) {
3559                 dest->add_internal_return ();
3560         }
3561
3562         sender->add_aux_send (dest, before);
3563
3564         graph_reordered ();
3565 }
3566
3567 void
3568 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
3569 {
3570         { // RCU Writer scope
3571                 PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
3572                 RCUWriter<RouteList> writer (routes);
3573                 boost::shared_ptr<RouteList> rs = writer.get_copy ();
3574
3575
3576                 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3577
3578                         if (*iter == _master_out) {
3579                                 continue;
3580                         }
3581
3582                         (*iter)->solo_control()->set_value (0.0, Controllable::NoGroup);
3583
3584                         rs->remove (*iter);
3585
3586                         /* deleting the master out seems like a dumb
3587                            idea, but its more of a UI policy issue
3588                            than our concern.
3589                         */
3590
3591                         if (*iter == _master_out) {
3592                                 _master_out = boost::shared_ptr<Route> ();
3593                         }
3594
3595                         if (*iter == _monitor_out) {
3596                                 _monitor_out.reset ();
3597                         }
3598
3599                         // We need to disconnect the route's inputs and outputs
3600
3601                         (*iter)->input()->disconnect (0);
3602                         (*iter)->output()->disconnect (0);
3603
3604                         /* if the route had internal sends sending to it, remove them */
3605                         if ((*iter)->internal_return()) {
3606
3607                                 boost::shared_ptr<RouteList> r = routes.reader ();
3608                                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3609                                         boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
3610                                         if (s) {
3611                                                 (*i)->remove_processor (s);
3612                                         }
3613                                 }
3614                         }
3615
3616                         /* if the monitoring section had a pointer to this route, remove it */
3617                         if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
3618                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3619                                 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
3620                                 (*iter)->remove_aux_or_listen (_monitor_out);
3621                         }
3622
3623                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
3624                         if (mt && mt->step_editing()) {
3625                                 if (_step_editors > 0) {
3626                                         _step_editors--;
3627                                 }
3628                         }
3629                 }
3630
3631                 /* writer goes out of scope, forces route list update */
3632
3633         } // end of RCU Writer scope
3634
3635         update_route_solo_state ();
3636         update_latency_compensation ();
3637         set_dirty();
3638
3639         /* Re-sort routes to remove the graph's current references to the one that is
3640          * going away, then flush old references out of the graph.
3641          * Wave Tracks: reconnect routes
3642          */
3643
3644 #ifdef USE_TRACKS_CODE_FEATURES
3645                 reconnect_existing_routes(true, false);
3646 #else
3647                 routes.flush (); // maybe unsafe, see below.
3648                 resort_routes ();
3649 #endif
3650
3651         if (_process_graph && !(_state_of_the_state & Deletion)) {
3652                 _process_graph->clear_other_chain ();
3653         }
3654
3655         /* get rid of it from the dead wood collection in the route list manager */
3656         /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
3657
3658         routes.flush ();
3659
3660         /* try to cause everyone to drop their references
3661          * and unregister ports from the backend
3662          */
3663
3664         for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3665                 (*iter)->drop_references ();
3666         }
3667
3668         if (_state_of_the_state & Deletion) {
3669                 return;
3670         }
3671
3672         Stripable::PresentationInfoChange(); /* EMIT SIGNAL */
3673
3674         /* save the new state of the world */
3675
3676         if (save_state (_current_snapshot_name)) {
3677                 save_history (_current_snapshot_name);
3678         }
3679
3680         update_route_record_state ();
3681 }
3682
3683 void
3684 Session::remove_route (boost::shared_ptr<Route> route)
3685 {
3686         boost::shared_ptr<RouteList> rl (new RouteList);
3687         rl->push_back (route);
3688         remove_routes (rl);
3689 }
3690
3691 void
3692 Session::route_mute_changed ()
3693 {
3694         set_dirty ();
3695 }
3696
3697 void
3698 Session::route_listen_changed (Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3699 {
3700         boost::shared_ptr<Route> route (wpr.lock());
3701
3702         if (!route) {
3703                 return;
3704         }
3705
3706         assert (Config->get_solo_control_is_listen_control());
3707
3708         if (route->solo_control()->soloed_by_self_or_masters()) {
3709
3710                 if (Config->get_exclusive_solo()) {
3711
3712                         RouteGroup* rg = route->route_group ();
3713                         const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3714
3715                         boost::shared_ptr<RouteList> r = routes.reader ();
3716
3717                         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3718                                 if ((*i) == route) {
3719                                         /* already changed */
3720                                         continue;
3721                                 }
3722
3723                                 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3724                                         /* route does not get solo propagated to it */
3725                                         continue;
3726                                 }
3727
3728                                 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3729                                         /* this route is a part of the same solo group as the route
3730                                          * that was changed. Changing that route did change or will
3731                                          * change all group members appropriately, so we can ignore it
3732                                          * here
3733                                          */
3734                                         continue;
3735                                 }
3736                                 (*i)->solo_control()->set_value (0.0, Controllable::NoGroup);
3737                         }
3738                 }
3739
3740                 _listen_cnt++;
3741
3742         } else if (_listen_cnt > 0) {
3743
3744                 _listen_cnt--;
3745         }
3746
3747         update_route_solo_state ();
3748 }
3749
3750 void
3751 Session::route_solo_isolated_changed (boost::weak_ptr<Route> wpr)
3752 {
3753         boost::shared_ptr<Route> route (wpr.lock());
3754
3755         if (!route) {
3756                 return;
3757         }
3758
3759         bool send_changed = false;
3760
3761         if (route->solo_isolate_control()->solo_isolated()) {
3762                 if (_solo_isolated_cnt == 0) {
3763                         send_changed = true;
3764                 }
3765                 _solo_isolated_cnt++;
3766         } else if (_solo_isolated_cnt > 0) {
3767                 _solo_isolated_cnt--;
3768                 if (_solo_isolated_cnt == 0) {
3769                         send_changed = true;
3770                 }
3771         }
3772
3773         if (send_changed) {
3774                 IsolatedChanged (); /* EMIT SIGNAL */
3775         }
3776 }
3777
3778 void
3779 Session::route_solo_changed (bool self_solo_changed, Controllable::GroupControlDisposition group_override,  boost::weak_ptr<Route> wpr)
3780 {
3781         DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1\n", self_solo_changed));
3782
3783         boost::shared_ptr<Route> route (wpr.lock());
3784
3785         if (!route) {
3786                 return;
3787         }
3788
3789         if (Config->get_solo_control_is_listen_control()) {
3790                 route_listen_changed (group_override, wpr);
3791                 return;
3792         }
3793
3794         DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: self %2 masters %3 transition %4\n", route->name(), route->self_soloed(), route->solo_control()->get_masters_value(), route->solo_control()->transitioned_into_solo()));
3795
3796         if (route->solo_control()->transitioned_into_solo() == 0) {
3797                 /* route solo changed by upstream/downstream; not interesting
3798                    to Session.
3799                 */
3800                 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 not self-soloed nor soloed by master (%2), ignoring\n", route->name(), route->solo_control()->get_masters_value()));
3801                 return;
3802         }
3803
3804         if (route->solo_control()->transitioned_into_solo() == 0) {
3805                 /* reason for being soloed changed (e.g. master went away, we
3806                  * took over the master state), but actual status did
3807                  * not. nothing to do.
3808                  */
3809                 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: solo change was change in reason, not status\n", route->name()));
3810         }
3811
3812         boost::shared_ptr<RouteList> r = routes.reader ();
3813         int32_t delta = route->solo_control()->transitioned_into_solo ();
3814
3815         /* the route may be a member of a group that has shared-solo
3816          * semantics. If so, then all members of that group should follow the
3817          * solo of the changed route. But ... this is optional, controlled by a
3818          * Controllable::GroupControlDisposition.
3819          *
3820          * The first argument to the signal that this method is connected to is the
3821          * GroupControlDisposition value that was used to change solo.
3822          *
3823          * If the solo change was done with group semantics (either InverseGroup
3824          * (force the entire group to change even if the group shared solo is
3825          * disabled) or UseGroup (use the group, which may or may not have the
3826          * shared solo property enabled)) then as we propagate the change to
3827          * the entire session we should IGNORE THE GROUP that the changed route
3828          * belongs to.
3829          */
3830
3831         RouteGroup* rg = route->route_group ();
3832         const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3833
3834         if (delta == 1 && Config->get_exclusive_solo()) {
3835
3836                 /* new solo: disable all other solos, but not the group if its solo-enabled */
3837
3838                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3839
3840                         if ((*i) == route) {
3841                                 /* already changed */
3842                                 continue;
3843                         }
3844
3845                         if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3846                                 /* route does not get solo propagated to it */
3847                                 continue;
3848                         }
3849
3850                         if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3851                                 /* this route is a part of the same solo group as the route
3852                                  * that was changed. Changing that route did change or will
3853                                  * change all group members appropriately, so we can ignore it
3854                                  * here
3855                                  */
3856                                 continue;
3857                         }
3858
3859                         (*i)->solo_control()->set_value (0.0, group_override);
3860                 }
3861         }
3862
3863         DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
3864
3865         RouteList uninvolved;
3866
3867         DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
3868
3869         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3870                 bool via_sends_only;
3871                 bool in_signal_flow;
3872
3873                 if ((*i) == route) {
3874                         /* already changed */
3875                         continue;
3876                 }
3877
3878                 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3879                         /* route does not get solo propagated to it */
3880                         continue;
3881                 }
3882
3883                 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3884                         /* this route is a part of the same solo group as the route
3885                          * that was changed. Changing that route did change or will
3886                          * change all group members appropriately, so we can ignore it
3887                          * here
3888                          */
3889                         continue;
3890                 }
3891
3892                 in_signal_flow = false;
3893
3894                 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
3895
3896                 if ((*i)->feeds (route, &via_sends_only)) {
3897                         DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
3898                         if (!via_sends_only) {
3899                                 if (!route->soloed_by_others_upstream()) {
3900                                         (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3901                                 } else {
3902                                         DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others upstream\n");
3903                                 }
3904                         } else {
3905                                 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
3906                         }
3907                         in_signal_flow = true;
3908                 } else {
3909                         DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
3910                 }
3911
3912                 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
3913
3914                 if (route->feeds (*i, &via_sends_only)) {
3915                         /* propagate solo upstream only if routing other than
3916                            sends is involved, but do consider the other route
3917                            (*i) to be part of the signal flow even if only
3918                            sends are involved.
3919                         */
3920                         DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 feeds %2 via sends only %3 sboD %4 sboU %5\n",
3921                                                                   route->name(),
3922                                                                   (*i)->name(),
3923                                                                   via_sends_only,
3924                                                                   route->soloed_by_others_downstream(),
3925                                                                   route->soloed_by_others_upstream()));
3926                         if (!via_sends_only) {
3927                                 //NB. Triggers Invert Push, which handles soloed by downstream
3928                                 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
3929                                 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3930                         } else {
3931                                 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
3932                         }
3933                         in_signal_flow = true;
3934                 } else {
3935                         DEBUG_TRACE (DEBUG::Solo, "\tno feed to\n");
3936                 }
3937
3938                 if (!in_signal_flow) {
3939                         uninvolved.push_back (*i);
3940                 }
3941         }
3942
3943         DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
3944
3945         update_route_solo_state (r);
3946
3947         /* now notify that the mute state of the routes not involved in the signal
3948            pathway of the just-solo-changed route may have altered.
3949         */
3950
3951         for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
3952                 DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1, which neither feeds or is fed by %2\n", (*i)->name(), route->name()));
3953                 (*i)->act_on_mute ();
3954                 (*i)->mute_control()->Changed (false, Controllable::NoGroup);
3955         }
3956
3957         SoloChanged (); /* EMIT SIGNAL */
3958         set_dirty();
3959 }
3960
3961 void
3962 Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
3963 {
3964         /* now figure out if anything that matters is soloed (or is "listening")*/
3965
3966         bool something_soloed = false;
3967         bool something_listening = false;
3968         uint32_t listeners = 0;
3969         uint32_t isolated = 0;
3970
3971         if (!r) {
3972                 r = routes.reader();
3973         }
3974
3975         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3976                 if ((*i)->can_solo()) {
3977                         if (Config->get_solo_control_is_listen_control()) {
3978                                 if ((*i)->self_soloed() || (*i)->solo_control()->get_masters_value()) {
3979                                         listeners++;
3980                                         something_listening = true;
3981                                 }
3982                         } else {
3983                                 (*i)->set_listen (false);
3984                                 if ((*i)->can_solo() && ((*i)->self_soloed() || (*i)->solo_control()->get_masters_value())) {
3985                                         something_soloed = true;
3986                                 }
3987                         }
3988                 }
3989
3990                 if ((*i)->solo_isolate_control()->solo_isolated()) {
3991                         isolated++;
3992                 }
3993         }
3994
3995         if (something_soloed != _non_soloed_outs_muted) {
3996                 _non_soloed_outs_muted = something_soloed;
3997                 SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
3998         }
3999
4000         if (something_listening != _listening) {
4001                 _listening = something_listening;
4002                 SoloActive (_listening);
4003         }
4004
4005         _listen_cnt = listeners;
4006
4007         if (isolated != _solo_isolated_cnt) {
4008                 _solo_isolated_cnt = isolated;
4009                 IsolatedChanged (); /* EMIT SIGNAL */
4010         }
4011
4012         DEBUG_TRACE (DEBUG::Solo, string_compose ("solo state updated by session, soloed? %1 listeners %2 isolated %3\n",
4013                                                   something_soloed, listeners, isolated));
4014 }
4015
4016 boost::shared_ptr<RouteList>
4017 Session::get_routes_with_internal_returns() const
4018 {
4019         boost::shared_ptr<RouteList> r = routes.reader ();
4020         boost::shared_ptr<RouteList> rl (new RouteList);
4021
4022         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4023                 if ((*i)->internal_return ()) {
4024                         rl->push_back (*i);
4025                 }
4026         }
4027         return rl;
4028 }
4029
4030 bool
4031 Session::io_name_is_legal (const std::string& name) const
4032 {
4033         boost::shared_ptr<RouteList> r = routes.reader ();
4034
4035         for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
4036                 if (name == *reserved) {
4037                         if (!route_by_name (*reserved)) {
4038                                 /* first instance of a reserved name is allowed */
4039                                 return true;
4040                         }
4041                         /* all other instances of a reserved name are not allowed */
4042                         return false;
4043                 }
4044         }
4045
4046         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4047                 if ((*i)->name() == name) {
4048                         return false;
4049                 }
4050
4051                 if ((*i)->has_io_processor_named (name)) {
4052                         return false;
4053                 }
4054         }
4055
4056         return true;
4057 }
4058
4059 void
4060 Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff, bool flip_others)
4061 {
4062         RouteList rl2;
4063         vector<string> connections;
4064
4065         /* if we are passed only a single route and we're not told to turn
4066          * others off, then just do the simple thing.
4067          */
4068
4069         if (flip_others == false && rl->size() == 1) {
4070                 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (rl->front());
4071                 if (mt) {
4072                         mt->set_input_active (onoff);
4073                         return;
4074                 }
4075         }
4076
4077         for (RouteList::iterator rt = rl->begin(); rt != rl->end(); ++rt) {
4078
4079                 PortSet& ps ((*rt)->input()->ports());
4080
4081                 for (PortSet::iterator p = ps.begin(); p != ps.end(); ++p) {
4082                         p->get_connections (connections);
4083                 }
4084
4085                 for (vector<string>::iterator s = connections.begin(); s != connections.end(); ++s) {
4086                         routes_using_input_from (*s, rl2);
4087                 }
4088
4089                 /* scan all relevant routes to see if others are on or off */
4090
4091                 bool others_are_already_on = false;
4092
4093                 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4094
4095                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4096
4097                         if (!mt) {
4098                                 continue;
4099                         }
4100
4101                         if ((*r) != (*rt)) {
4102                                 if (mt->input_active()) {
4103                                         others_are_already_on = true;
4104                                 }
4105                         } else {
4106                                 /* this one needs changing */
4107                                 mt->set_input_active (onoff);
4108                         }
4109                 }
4110
4111                 if (flip_others) {
4112
4113                         /* globally reverse other routes */
4114
4115                         for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4116                                 if ((*r) != (*rt)) {
4117                                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4118                                         if (mt) {
4119                                                 mt->set_input_active (!others_are_already_on);
4120                                         }
4121                                 }
4122                         }
4123                 }
4124         }
4125 }
4126
4127 void
4128 Session::routes_using_input_from (const string& str, RouteList& rl)
4129 {
4130         boost::shared_ptr<RouteList> r = routes.reader();
4131
4132         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4133                 if ((*i)->input()->connected_to (str)) {
4134                         rl.push_back (*i);
4135                 }
4136         }
4137 }
4138
4139 boost::shared_ptr<Route>
4140 Session::route_by_name (string name) const
4141 {
4142         boost::shared_ptr<RouteList> r = routes.reader ();
4143
4144         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4145                 if ((*i)->name() == name) {
4146                         return *i;
4147                 }
4148         }
4149
4150         return boost::shared_ptr<Route> ((Route*) 0);
4151 }
4152
4153 boost::shared_ptr<Route>
4154 Session::route_by_id (PBD::ID id) const
4155 {
4156         boost::shared_ptr<RouteList> r = routes.reader ();
4157
4158         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4159                 if ((*i)->id() == id) {
4160                         return *i;
4161                 }
4162         }
4163
4164         return boost::shared_ptr<Route> ((Route*) 0);
4165 }
4166
4167 boost::shared_ptr<Processor>
4168 Session::processor_by_id (PBD::ID id) const
4169 {
4170         boost::shared_ptr<RouteList> r = routes.reader ();
4171
4172         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4173                 boost::shared_ptr<Processor> p = (*i)->Route::processor_by_id (id);
4174                 if (p) {
4175                         return p;
4176                 }
4177         }
4178
4179         return boost::shared_ptr<Processor> ();
4180 }
4181
4182 boost::shared_ptr<Track>
4183 Session::track_by_diskstream_id (PBD::ID id) const
4184 {
4185         boost::shared_ptr<RouteList> r = routes.reader ();
4186
4187         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4188                 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4189                 if (t && t->using_diskstream_id (id)) {
4190                         return t;
4191                 }
4192         }
4193
4194         return boost::shared_ptr<Track> ();
4195 }
4196
4197 boost::shared_ptr<Route>
4198 Session::get_remote_nth_route (uint16_t n) const
4199 {
4200         return boost::dynamic_pointer_cast<Route> (get_remote_nth_stripable (n, PresentationInfo::Route));
4201 }
4202
4203 boost::shared_ptr<Stripable>
4204 Session::get_remote_nth_stripable (uint16_t n, PresentationInfo::Flag flags) const
4205 {
4206         boost::shared_ptr<RouteList> r = routes.reader ();
4207         vector<boost::shared_ptr<Route> > v;
4208
4209         if (n > r->size()) {
4210                 return boost::shared_ptr<Route> ();
4211         }
4212
4213         v.assign (r->size(), boost::shared_ptr<Route>());
4214
4215         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4216                 if ((*i)->presentation_info().flag_match (flags)) {
4217                         v[(*i)->presentation_info().group_order()] = (*i);
4218                 }
4219         }
4220
4221         return v[n];
4222 }
4223
4224 boost::shared_ptr<Route>
4225 Session::route_by_selected_count (uint32_t id) const
4226 {
4227         boost::shared_ptr<RouteList> r = routes.reader ();
4228
4229         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4230                 /* NOT IMPLEMENTED */
4231         }
4232
4233         return boost::shared_ptr<Route> ((Route*) 0);
4234 }
4235
4236 struct PresentationOrderSorter {
4237         bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
4238                 if (a->presentation_info().special() && !b->presentation_info().special()) {
4239                         /* a is not ordered, b is; b comes before a */
4240                         return false;
4241                 } else if (b->presentation_info().unordered() && !a->presentation_info().unordered()) {
4242                         /* b is not ordered, a is; a comes before b */
4243                         return true;
4244                 } else {
4245                         return a->presentation_info().global_order() < b->presentation_info().global_order();
4246                 }
4247         }
4248 };
4249
4250 void
4251 Session::reassign_track_numbers ()
4252 {
4253         int64_t tn = 0;
4254         int64_t bn = 0;
4255         RouteList r (*(routes.reader ()));
4256         PresentationOrderSorter sorter;
4257         r.sort (sorter);
4258
4259         StateProtector sp (this);
4260
4261         for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4262                 if (boost::dynamic_pointer_cast<Track> (*i)) {
4263                         (*i)->set_track_number(++tn);
4264                 }
4265                 else if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner()) {
4266                         (*i)->set_track_number(--bn);
4267                 }
4268         }
4269         const uint32_t decimals = ceilf (log10f (tn + 1));
4270         const bool decimals_changed = _track_number_decimals != decimals;
4271         _track_number_decimals = decimals;
4272
4273         if (decimals_changed && config.get_track_name_number ()) {
4274                 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4275                         boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4276                         if (t) {
4277                                 t->resync_track_name();
4278                         }
4279                 }
4280                 // trigger GUI re-layout
4281                 config.ParameterChanged("track-name-number");
4282         }
4283 }
4284
4285 void
4286 Session::playlist_region_added (boost::weak_ptr<Region> w)
4287 {
4288         boost::shared_ptr<Region> r = w.lock ();
4289         if (!r) {
4290                 return;
4291         }
4292
4293         /* These are the operations that are currently in progress... */
4294         list<GQuark> curr = _current_trans_quarks;
4295         curr.sort ();
4296
4297         /* ...and these are the operations during which we want to update
4298            the session range location markers.
4299         */
4300         list<GQuark> ops;
4301         ops.push_back (Operations::capture);
4302         ops.push_back (Operations::paste);
4303         ops.push_back (Operations::duplicate_region);
4304         ops.push_back (Operations::insert_file);
4305         ops.push_back (Operations::insert_region);
4306         ops.push_back (Operations::drag_region_brush);
4307         ops.push_back (Operations::region_drag);
4308         ops.push_back (Operations::selection_grab);
4309         ops.push_back (Operations::region_fill);
4310         ops.push_back (Operations::fill_selection);
4311         ops.push_back (Operations::create_region);
4312         ops.push_back (Operations::region_copy);
4313         ops.push_back (Operations::fixed_time_region_copy);
4314         ops.sort ();
4315
4316         /* See if any of the current operations match the ones that we want */
4317         list<GQuark> in;
4318         set_intersection (_current_trans_quarks.begin(), _current_trans_quarks.end(), ops.begin(), ops.end(), back_inserter (in));
4319
4320         /* If so, update the session range markers */
4321         if (!in.empty ()) {
4322                 maybe_update_session_range (r->position (), r->last_frame ());
4323         }
4324 }
4325
4326 /** Update the session range markers if a is before the current start or
4327  *  b is after the current end.
4328  */
4329 void
4330 Session::maybe_update_session_range (framepos_t a, framepos_t b)
4331 {
4332         if (_state_of_the_state & Loading) {
4333                 return;
4334         }
4335
4336         framepos_t session_end_marker_shift_samples = session_end_shift * _nominal_frame_rate;
4337
4338         if (_session_range_location == 0) {
4339
4340                 set_session_range_location (a, b + session_end_marker_shift_samples);
4341
4342         } else {
4343
4344                 if (a < _session_range_location->start()) {
4345                         _session_range_location->set_start (a);
4346                 }
4347
4348                 if (b > _session_range_location->end()) {
4349                         _session_range_location->set_end (b);
4350                 }
4351         }
4352 }
4353
4354 void
4355 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
4356 {
4357         for (list<Evoral::RangeMove<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4358                 maybe_update_session_range (i->to, i->to + i->length);
4359         }
4360 }
4361
4362 void
4363 Session::playlist_regions_extended (list<Evoral::Range<framepos_t> > const & ranges)
4364 {
4365         for (list<Evoral::Range<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4366                 maybe_update_session_range (i->from, i->to);
4367         }
4368 }
4369
4370 /* Region management */
4371
4372 boost::shared_ptr<Region>
4373 Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
4374 {
4375         const RegionFactory::RegionMap& regions (RegionFactory::regions());
4376         RegionFactory::RegionMap::const_iterator i;
4377         boost::shared_ptr<Region> region;
4378
4379         Glib::Threads::Mutex::Lock lm (region_lock);
4380
4381         for (i = regions.begin(); i != regions.end(); ++i) {
4382
4383                 region = i->second;
4384
4385                 if (region->whole_file()) {
4386
4387                         if (child->source_equivalent (region)) {
4388                                 return region;
4389                         }
4390                 }
4391         }
4392
4393         return boost::shared_ptr<Region> ();
4394 }
4395
4396 int
4397 Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
4398 {
4399         set<boost::shared_ptr<Region> > relevant_regions;
4400
4401         for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
4402                 RegionFactory::get_regions_using_source (*s, relevant_regions);
4403         }
4404
4405         for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
4406                 set<boost::shared_ptr<Region> >::iterator tmp;
4407
4408                 tmp = r;
4409                 ++tmp;
4410
4411                 playlists->destroy_region (*r);
4412                 RegionFactory::map_remove (*r);
4413
4414                 (*r)->drop_sources ();
4415                 (*r)->drop_references ();
4416
4417                 relevant_regions.erase (r);
4418
4419                 r = tmp;
4420         }
4421
4422         for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
4423
4424                 {
4425                         Glib::Threads::Mutex::Lock ls (source_lock);
4426                         /* remove from the main source list */
4427                         sources.erase ((*s)->id());
4428                 }
4429
4430                 (*s)->mark_for_remove ();
4431                 (*s)->drop_references ();
4432
4433                 s = srcs.erase (s);
4434         }
4435
4436         return 0;
4437 }
4438
4439 int
4440 Session::remove_last_capture ()
4441 {
4442         list<boost::shared_ptr<Source> > srcs;
4443
4444         boost::shared_ptr<RouteList> rl = routes.reader ();
4445         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4446                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4447                 if (!tr) {
4448                         continue;
4449                 }
4450
4451                 list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
4452
4453                 if (!l.empty()) {
4454                         srcs.insert (srcs.end(), l.begin(), l.end());
4455                         l.clear ();
4456                 }
4457         }
4458
4459         destroy_sources (srcs);
4460
4461         save_state (_current_snapshot_name);
4462
4463         return 0;
4464 }
4465
4466 /* Source Management */
4467
4468 void
4469 Session::add_source (boost::shared_ptr<Source> source)
4470 {
4471         pair<SourceMap::key_type, SourceMap::mapped_type> entry;
4472         pair<SourceMap::iterator,bool> result;
4473
4474         entry.first = source->id();
4475         entry.second = source;
4476
4477         {
4478                 Glib::Threads::Mutex::Lock lm (source_lock);
4479                 result = sources.insert (entry);
4480         }
4481
4482         if (result.second) {
4483
4484                 /* yay, new source */
4485
4486                 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
4487
4488                 if (fs) {
4489                         if (!fs->within_session()) {
4490                                 ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
4491                         }
4492                 }
4493
4494                 set_dirty();
4495
4496                 boost::shared_ptr<AudioFileSource> afs;
4497
4498                 if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
4499                         if (Config->get_auto_analyse_audio()) {
4500                                 Analyser::queue_source_for_analysis (source, false);
4501                         }
4502                 }
4503
4504                 source->DropReferences.connect_same_thread (*this, boost::bind (&Session::remove_source, this, boost::weak_ptr<Source> (source)));
4505         }
4506 }
4507
4508 void
4509 Session::remove_source (boost::weak_ptr<Source> src)
4510 {
4511         if (_state_of_the_state & Deletion) {
4512                 return;
4513         }
4514
4515         SourceMap::iterator i;
4516         boost::shared_ptr<Source> source = src.lock();
4517
4518         if (!source) {
4519                 return;
4520         }
4521
4522         {
4523                 Glib::Threads::Mutex::Lock lm (source_lock);
4524
4525                 if ((i = sources.find (source->id())) != sources.end()) {
4526                         sources.erase (i);
4527                 }
4528         }
4529
4530         if (!(_state_of_the_state & StateOfTheState (InCleanup|Loading))) {
4531
4532                 /* save state so we don't end up with a session file
4533                    referring to non-existent sources.
4534                 */
4535
4536                 save_state (_current_snapshot_name);
4537         }
4538 }
4539
4540 boost::shared_ptr<Source>
4541 Session::source_by_id (const PBD::ID& id)
4542 {
4543         Glib::Threads::Mutex::Lock lm (source_lock);
4544         SourceMap::iterator i;
4545         boost::shared_ptr<Source> source;
4546
4547         if ((i = sources.find (id)) != sources.end()) {
4548                 source = i->second;
4549         }
4550
4551         return source;
4552 }
4553
4554 boost::shared_ptr<AudioFileSource>
4555 Session::audio_source_by_path_and_channel (const string& path, uint16_t chn) const
4556 {
4557         /* Restricted to audio files because only audio sources have channel
4558            as a property.
4559         */
4560
4561         Glib::Threads::Mutex::Lock lm (source_lock);
4562
4563         for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
4564                 boost::shared_ptr<AudioFileSource> afs
4565                         = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
4566
4567                 if (afs && afs->path() == path && chn == afs->channel()) {
4568                         return afs;
4569                 }
4570         }
4571
4572         return boost::shared_ptr<AudioFileSource>();
4573 }
4574
4575 boost::shared_ptr<MidiSource>
4576 Session::midi_source_by_path (const std::string& path) const
4577 {
4578         /* Restricted to MIDI files because audio sources require a channel
4579            for unique identification, in addition to a path.
4580         */
4581
4582         Glib::Threads::Mutex::Lock lm (source_lock);
4583
4584         for (SourceMap::const_iterator s = sources.begin(); s != sources.end(); ++s) {
4585                 boost::shared_ptr<MidiSource> ms
4586                         = boost::dynamic_pointer_cast<MidiSource>(s->second);
4587                 boost::shared_ptr<FileSource> fs
4588                         = boost::dynamic_pointer_cast<FileSource>(s->second);
4589
4590                 if (ms && fs && fs->path() == path) {
4591                         return ms;
4592                 }
4593         }
4594
4595         return boost::shared_ptr<MidiSource>();
4596 }
4597
4598 uint32_t
4599 Session::count_sources_by_origin (const string& path)
4600 {
4601         uint32_t cnt = 0;
4602         Glib::Threads::Mutex::Lock lm (source_lock);
4603
4604         for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
4605                 boost::shared_ptr<FileSource> fs
4606                         = boost::dynamic_pointer_cast<FileSource>(i->second);
4607
4608                 if (fs && fs->origin() == path) {
4609                         ++cnt;
4610                 }
4611         }
4612
4613         return cnt;
4614 }
4615
4616 static string
4617 peak_file_helper (const string& peak_path, const string& file_path, const string& file_base, bool hash) {
4618         if (hash) {
4619                 std::string checksum = Glib::Checksum::compute_checksum(Glib::Checksum::CHECKSUM_SHA1, file_path + G_DIR_SEPARATOR + file_base);
4620                 return Glib::build_filename (peak_path, checksum + peakfile_suffix);
4621         } else {
4622                 return Glib::build_filename (peak_path, file_base + peakfile_suffix);
4623         }
4624 }
4625
4626 string
4627 Session::construct_peak_filepath (const string& filepath, const bool in_session, const bool old_peak_name) const
4628 {
4629         string interchange_dir_string = string (interchange_dir_name) + G_DIR_SEPARATOR;
4630
4631         if (Glib::path_is_absolute (filepath)) {
4632
4633                 /* rip the session dir from the audiofile source */
4634
4635                 string session_path;
4636                 bool in_another_session = true;
4637
4638                 if (filepath.find (interchange_dir_string) != string::npos) {
4639
4640                         session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
4641                         session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
4642                         session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
4643                         session_path = Glib::path_get_dirname (session_path); /* now has session path */
4644
4645                         /* see if it is within our session */
4646
4647                         for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
4648                                 if (i->path == session_path) {
4649                                         in_another_session = false;
4650                                         break;
4651                                 }
4652                         }
4653                 } else {
4654                         in_another_session = false;
4655                 }
4656
4657
4658                 if (in_another_session) {
4659                         SessionDirectory sd (session_path);
4660                         return peak_file_helper (sd.peak_path(), "", Glib::path_get_basename (filepath), !old_peak_name);
4661                 }
4662         }
4663
4664         /* 1) if file belongs to this session
4665          * it may be a relative path (interchange/...)
4666          * or just basename (session_state, remove source)
4667          * -> just use the basename
4668          */
4669         std::string filename = Glib::path_get_basename (filepath);
4670         std::string path;
4671
4672         /* 2) if the file is outside our session dir:
4673          * (imported but not copied) add the path for check-summming */
4674         if (!in_session) {
4675                 path = Glib::path_get_dirname (filepath);
4676         }
4677
4678         return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
4679 }
4680
4681 string
4682 Session::new_audio_source_path_for_embedded (const std::string& path)
4683 {
4684         /* embedded source:
4685          *
4686          * we know that the filename is already unique because it exists
4687          * out in the filesystem.
4688          *
4689          * However, when we bring it into the session, we could get a
4690          * collision.
4691          *
4692          * Eg. two embedded files:
4693          *
4694          *          /foo/bar/baz.wav
4695          *          /frob/nic/baz.wav
4696          *
4697          * When merged into session, these collide.
4698          *
4699          * There will not be a conflict with in-memory sources
4700          * because when the source was created we already picked
4701          * a unique name for it.
4702          *
4703          * This collision is not likely to be common, but we have to guard
4704          * against it.  So, if there is a collision, take the md5 hash of the
4705          * the path, and use that as the filename instead.
4706          */
4707
4708         SessionDirectory sdir (get_best_session_directory_for_new_audio());
4709         string base = Glib::path_get_basename (path);
4710         string newpath = Glib::build_filename (sdir.sound_path(), base);
4711
4712         if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4713
4714                 MD5 md5;
4715
4716                 md5.digestString (path.c_str());
4717                 md5.writeToString ();
4718                 base = md5.digestChars;
4719
4720                 string ext = get_suffix (path);
4721
4722                 if (!ext.empty()) {
4723                         base += '.';
4724                         base += ext;
4725                 }
4726
4727                 newpath = Glib::build_filename (sdir.sound_path(), base);
4728
4729                 /* if this collides, we're screwed */
4730
4731                 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4732                         error << string_compose (_("Merging embedded file %1: name collision AND md5 hash collision!"), path) << endmsg;
4733                         return string();
4734                 }
4735
4736         }
4737
4738         return newpath;
4739 }
4740
4741 /** Return true if there are no audio file sources that use @param name as
4742  * the filename component of their path.
4743  *
4744  * Return false otherwise.
4745  *
4746  * This method MUST ONLY be used to check in-session, mono files since it
4747  * hard-codes the channel of the audio file source we are looking for as zero.
4748  *
4749  * If/when Ardour supports native files in non-mono formats, the logic here
4750  * will need to be revisited.
4751  */
4752 bool
4753 Session::audio_source_name_is_unique (const string& name)
4754 {
4755         std::vector<string> sdirs = source_search_path (DataType::AUDIO);
4756         vector<space_and_path>::iterator i;
4757         uint32_t existing = 0;
4758
4759         for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4760
4761                 /* note that we search *without* the extension so that
4762                    we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
4763                    in the event that this new name is required for
4764                    a file format change.
4765                 */
4766
4767                 const string spath = *i;
4768
4769                 if (matching_unsuffixed_filename_exists_in (spath, name)) {
4770                         existing++;
4771                         break;
4772                 }
4773
4774                 /* it is possible that we have the path already
4775                  * assigned to a source that has not yet been written
4776                  * (ie. the write source for a diskstream). we have to
4777                  * check this in order to make sure that our candidate
4778                  * path isn't used again, because that can lead to
4779                  * two Sources point to the same file with different
4780                  * notions of their removability.
4781                  */
4782
4783
4784                 string possible_path = Glib::build_filename (spath, name);
4785
4786                 if (audio_source_by_path_and_channel (possible_path, 0)) {
4787                         existing++;
4788                         break;
4789                 }
4790         }
4791
4792         return (existing == 0);
4793 }
4794
4795 string
4796 Session::format_audio_source_name (const string& legalized_base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required, uint32_t cnt, bool related_exists)
4797 {
4798         ostringstream sstr;
4799         const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
4800
4801         if (Profile->get_trx() && destructive) {
4802                 sstr << 'T';
4803                 sstr << setfill ('0') << setw (4) << cnt;
4804                 sstr << legalized_base;
4805         } else {
4806                 sstr << legalized_base;
4807
4808                 if (take_required || related_exists) {
4809                         sstr << '-';
4810                         sstr << cnt;
4811                 }
4812         }
4813
4814         if (nchan == 2) {
4815                 if (chan == 0) {
4816                         sstr << "%L";
4817                 } else {
4818                         sstr << "%R";
4819                 }
4820         } else if (nchan > 2) {
4821                 if (nchan < 26) {
4822                         sstr << '%';
4823                         sstr << 'a' + chan;
4824                 } else {
4825                         /* XXX what? more than 26 channels! */
4826                         sstr << '%';
4827                         sstr << chan+1;
4828                 }
4829         }
4830
4831         sstr << ext;
4832
4833         return sstr.str();
4834 }
4835
4836 /** Return a unique name based on \a base for a new internal audio source */
4837 string
4838 Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required)
4839 {
4840         uint32_t cnt;
4841         string possible_name;
4842         const uint32_t limit = 9999; // arbitrary limit on number of files with the same basic name
4843         string legalized;
4844         bool some_related_source_name_exists = false;
4845
4846         legalized = legalize_for_path (base);
4847
4848         // Find a "version" of the base name that doesn't exist in any of the possible directories.
4849
4850         for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
4851
4852                 possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
4853
4854                 if (audio_source_name_is_unique (possible_name)) {
4855                         break;
4856                 }
4857
4858                 some_related_source_name_exists = true;
4859
4860                 if (cnt > limit) {
4861                         error << string_compose(
4862                                         _("There are already %1 recordings for %2, which I consider too many."),
4863                                         limit, base) << endmsg;
4864                         destroy ();
4865                         throw failed_constructor();
4866                 }
4867         }
4868
4869         /* We've established that the new name does not exist in any session
4870          * directory, so now find out which one we should use for this new
4871          * audio source.
4872          */
4873
4874         SessionDirectory sdir (get_best_session_directory_for_new_audio());
4875
4876         std::string s = Glib::build_filename (sdir.sound_path(), possible_name);
4877
4878         return s;
4879 }
4880
4881 /** Return a unique name based on `base` for a new internal MIDI source */
4882 string
4883 Session::new_midi_source_path (const string& base)
4884 {
4885         uint32_t cnt;
4886         char buf[PATH_MAX+1];
4887         const uint32_t limit = 10000;
4888         string legalized;
4889         string possible_path;
4890         string possible_name;
4891
4892         buf[0] = '\0';
4893         legalized = legalize_for_path (base);
4894
4895         // Find a "version" of the file name that doesn't exist in any of the possible directories.
4896         std::vector<string> sdirs = source_search_path(DataType::MIDI);
4897
4898         /* - the main session folder is the first in the vector.
4899          * - after checking all locations for file-name uniqueness,
4900          *   we keep the one from the last iteration as new file name
4901          * - midi files are small and should just be kept in the main session-folder
4902          *
4903          * -> reverse the array, check main session folder last and use that as location
4904          *    for MIDI files.
4905          */
4906         std::reverse(sdirs.begin(), sdirs.end());
4907
4908         for (cnt = 1; cnt <= limit; ++cnt) {
4909
4910                 vector<space_and_path>::iterator i;
4911                 uint32_t existing = 0;
4912
4913                 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4914
4915                         snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
4916                         possible_name = buf;
4917
4918                         possible_path = Glib::build_filename (*i, possible_name);
4919
4920                         if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
4921                                 existing++;
4922                         }
4923
4924                         if (midi_source_by_path (possible_path)) {
4925                                 existing++;
4926                         }
4927                 }
4928
4929                 if (existing == 0) {
4930                         break;
4931                 }
4932
4933                 if (cnt > limit) {
4934                         error << string_compose(
4935                                         _("There are already %1 recordings for %2, which I consider too many."),
4936                                         limit, base) << endmsg;
4937                         destroy ();
4938                         return 0;
4939                 }
4940         }
4941
4942         /* No need to "find best location" for software/app-based RAID, because
4943            MIDI is so small that we always put it in the same place.
4944         */
4945
4946         return possible_path;
4947 }
4948
4949
4950 /** Create a new within-session audio source */
4951 boost::shared_ptr<AudioFileSource>
4952 Session::create_audio_source_for_session (size_t n_chans, string const & base, uint32_t chan, bool destructive)
4953 {
4954         const string path = new_audio_source_path (base, n_chans, chan, destructive, true);
4955
4956         if (!path.empty()) {
4957                 return boost::dynamic_pointer_cast<AudioFileSource> (
4958                         SourceFactory::createWritable (DataType::AUDIO, *this, path, destructive, frame_rate(), true, true));
4959         } else {
4960                 throw failed_constructor ();
4961         }
4962 }
4963
4964 /** Create a new within-session MIDI source */
4965 boost::shared_ptr<MidiSource>
4966 Session::create_midi_source_for_session (string const & basic_name)
4967 {
4968         const string path = new_midi_source_path (basic_name);
4969
4970         if (!path.empty()) {
4971                 return boost::dynamic_pointer_cast<SMFSource> (
4972                         SourceFactory::createWritable (
4973                                 DataType::MIDI, *this, path, false, frame_rate()));
4974         } else {
4975                 throw failed_constructor ();
4976         }
4977 }
4978
4979 /** Create a new within-session MIDI source */
4980 boost::shared_ptr<MidiSource>
4981 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
4982 {
4983         /* the caller passes in the track the source will be used in,
4984            so that we can keep the numbering sane.
4985
4986            Rationale: a track with the name "Foo" that has had N
4987            captures carried out so far will ALREADY have a write source
4988            named "Foo-N+1.mid" waiting to be used for the next capture.
4989
4990            If we call new_midi_source_name() we will get "Foo-N+2". But
4991            there is no region corresponding to "Foo-N+1", so when
4992            "Foo-N+2" appears in the track, the gap presents the user
4993            with odd behaviour - why did it skip past Foo-N+1?
4994
4995            We could explain this to the user in some odd way, but
4996            instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
4997            use "Foo-N+1" here.
4998
4999            If that attempted rename fails, we get "Foo-N+2.mid" anyway.
5000         */
5001
5002         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
5003         assert (mt);
5004         std::string name = track->steal_write_source_name ();
5005
5006         if (name.empty()) {
5007                 return boost::shared_ptr<MidiSource>();
5008         }
5009
5010         /* MIDI files are small, just put them in the first location of the
5011            session source search path.
5012         */
5013
5014         const string path = Glib::build_filename (source_search_path (DataType::MIDI).front(), name);
5015
5016         return boost::dynamic_pointer_cast<SMFSource> (
5017                 SourceFactory::createWritable (
5018                         DataType::MIDI, *this, path, false, frame_rate()));
5019 }
5020
5021
5022 void
5023 Session::add_playlist (boost::shared_ptr<Playlist> playlist, bool unused)
5024 {
5025         if (playlist->hidden()) {
5026                 return;
5027         }
5028
5029         playlists->add (playlist);
5030
5031         if (unused) {
5032                 playlist->release();
5033         }
5034
5035         set_dirty();
5036 }
5037
5038 void
5039 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
5040 {
5041         if (_state_of_the_state & Deletion) {
5042                 return;
5043         }
5044
5045         boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
5046
5047         if (!playlist) {
5048                 return;
5049         }
5050
5051         playlists->remove (playlist);
5052
5053         set_dirty();
5054 }
5055
5056 void
5057 Session::set_audition (boost::shared_ptr<Region> r)
5058 {
5059         pending_audition_region = r;
5060         add_post_transport_work (PostTransportAudition);
5061         _butler->schedule_transport_work ();
5062 }
5063
5064 void
5065 Session::audition_playlist ()
5066 {
5067         SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5068         ev->region.reset ();
5069         queue_event (ev);
5070 }
5071
5072
5073 void
5074 Session::register_lua_function (
5075                 const std::string& name,
5076                 const std::string& script,
5077                 const LuaScriptParamList& args
5078                 )
5079 {
5080         Glib::Threads::Mutex::Lock lm (lua_lock);
5081
5082         lua_State* L = lua.getState();
5083
5084         const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
5085         luabridge::LuaRef tbl_arg (luabridge::newTable(L));
5086         for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
5087                 if ((*i)->optional && !(*i)->is_set) { continue; }
5088                 tbl_arg[(*i)->name] = (*i)->value;
5089         }
5090         (*_lua_add)(name, bytecode, tbl_arg); // throws luabridge::LuaException
5091         set_dirty();
5092 }
5093
5094 void
5095 Session::unregister_lua_function (const std::string& name)
5096 {
5097         Glib::Threads::Mutex::Lock lm (lua_lock);
5098         (*_lua_del)(name); // throws luabridge::LuaException
5099         lua.collect_garbage ();
5100         set_dirty();
5101 }
5102
5103 std::vector<std::string>
5104 Session::registered_lua_functions ()
5105 {
5106         Glib::Threads::Mutex::Lock lm (lua_lock);
5107         std::vector<std::string> rv;
5108
5109         try {
5110                 luabridge::LuaRef list ((*_lua_list)());
5111                 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5112                         if (!i.key ().isString ()) { assert(0); continue; }
5113                         rv.push_back (i.key ().cast<std::string> ());
5114                 }
5115         } catch (luabridge::LuaException const& e) { }
5116         return rv;
5117 }
5118
5119 #ifndef NDEBUG
5120 static void _lua_print (std::string s) {
5121         std::cout << "SessionLua: " << s << "\n";
5122 }
5123 #endif
5124
5125 void
5126 Session::try_run_lua (pframes_t nframes)
5127 {
5128         if (_n_lua_scripts == 0) return;
5129         Glib::Threads::Mutex::Lock tm (lua_lock, Glib::Threads::TRY_LOCK);
5130         if (tm.locked ()) {
5131                 try { (*_lua_run)(nframes); } catch (luabridge::LuaException const& e) { }
5132         }
5133 }
5134
5135 void
5136 Session::setup_lua ()
5137 {
5138 #ifndef NDEBUG
5139         lua.Print.connect (&_lua_print);
5140 #endif
5141         lua.do_command (
5142                         "function ArdourSession ()"
5143                         "  local self = { scripts = {}, instances = {} }"
5144                         ""
5145                         "  local remove = function (n)"
5146                         "   self.scripts[n] = nil"
5147                         "   self.instances[n] = nil"
5148                         "   Session:scripts_changed()" // call back
5149                         "  end"
5150                         ""
5151                         "  local addinternal = function (n, f, a)"
5152                         "   assert(type(n) == 'string', 'function-name must be string')"
5153                         "   assert(type(f) == 'function', 'Given script is a not a function')"
5154                         "   assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
5155                         "   assert(self.scripts[n] == nil, 'Callback \"'.. n ..'\" already exists.')"
5156                         "   self.scripts[n] = { ['f'] = f, ['a'] = a }"
5157                         "   local env = _ENV;  env.f = nil env.io = nil env.os = nil env.loadfile = nil env.require = nil env.dofile = nil env.package = nil env.debug = nil"
5158                         "   local env = { print = print, tostring = tostring, assert = assert, ipairs = ipairs, error = error, select = select, string = string, type = type, tonumber = tonumber, collectgarbage = collectgarbage, pairs = pairs, math = math, table = table, pcall = pcall, Session = Session, PBD = PBD, Timecode = Timecode, Evoral = Evoral, C = C, ARDOUR = ARDOUR }"
5159                         "   self.instances[n] = load (string.dump(f, true), nil, nil, env)(a)"
5160                         "   Session:scripts_changed()" // call back
5161                         "  end"
5162                         ""
5163                         "  local add = function (n, b, a)"
5164                         "   assert(type(b) == 'string', 'ByteCode must be string')"
5165                         "   load (b)()" // assigns f
5166                         "   assert(type(f) == 'string', 'Assigned ByteCode must be string')"
5167                         "   addinternal (n, load(f), a)"
5168                         "  end"
5169                         ""
5170                         "  local run = function (...)"
5171                         "   for n, s in pairs (self.instances) do"
5172                         "     local status, err = pcall (s, ...)"
5173                         "     if not status then"
5174                         "       print ('fn \"'.. n .. '\": ', err)"
5175                         "       remove (n)"
5176                         "      end"
5177                         "   end"
5178                         "   collectgarbage()"
5179                         "  end"
5180                         ""
5181                         "  local cleanup = function ()"
5182                         "   self.scripts = nil"
5183                         "   self.instances = nil"
5184                         "  end"
5185                         ""
5186                         "  local list = function ()"
5187                         "   local rv = {}"
5188                         "   for n, _ in pairs (self.scripts) do"
5189                         "     rv[n] = true"
5190                         "   end"
5191                         "   return rv"
5192                         "  end"
5193                         ""
5194                         "  local function basic_serialize (o)"
5195                         "    if type(o) == \"number\" then"
5196                         "     return tostring(o)"
5197                         "    else"
5198                         "     return string.format(\"%q\", o)"
5199                         "    end"
5200                         "  end"
5201                         ""
5202                         "  local function serialize (name, value)"
5203                         "   local rv = name .. ' = '"
5204                         "   collectgarbage()"
5205                         "   if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
5206                         "    return rv .. basic_serialize(value) .. ' '"
5207                         "   elseif type(value) == \"table\" then"
5208                         "    rv = rv .. '{} '"
5209                         "    for k,v in pairs(value) do"
5210                         "     local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
5211                         "     rv = rv .. serialize(fieldname, v) .. ' '"
5212                         "     collectgarbage()" // string concatenation allocates a new string :(
5213                         "    end"
5214                         "    return rv;"
5215                         "   elseif type(value) == \"function\" then"
5216                         "     return rv .. string.format(\"%q\", string.dump(value, true))"
5217                         "   else"
5218                         "    error('cannot save a ' .. type(value))"
5219                         "   end"
5220                         "  end"
5221                         ""
5222                         ""
5223                         "  local save = function ()"
5224                         "   return (serialize('scripts', self.scripts))"
5225                         "  end"
5226                         ""
5227                         "  local restore = function (state)"
5228                         "   self.scripts = {}"
5229                         "   load (state)()"
5230                         "   for n, s in pairs (scripts) do"
5231                         "    addinternal (n, load(s['f']), s['a'])"
5232                         "   end"
5233                         "  end"
5234                         ""
5235                         " return { run = run, add = add, remove = remove,"
5236                   "          list = list, restore = restore, save = save, cleanup = cleanup}"
5237                         " end"
5238                         " "
5239                         " sess = ArdourSession ()"
5240                         " ArdourSession = nil"
5241                         " "
5242                         "function ardour () end"
5243                         );
5244
5245         lua_State* L = lua.getState();
5246
5247         try {
5248                 luabridge::LuaRef lua_sess = luabridge::getGlobal (L, "sess");
5249                 lua.do_command ("sess = nil"); // hide it.
5250                 lua.do_command ("collectgarbage()");
5251
5252                 _lua_run = new luabridge::LuaRef(lua_sess["run"]);
5253                 _lua_add = new luabridge::LuaRef(lua_sess["add"]);
5254                 _lua_del = new luabridge::LuaRef(lua_sess["remove"]);
5255                 _lua_list = new luabridge::LuaRef(lua_sess["list"]);
5256                 _lua_save = new luabridge::LuaRef(lua_sess["save"]);
5257                 _lua_load = new luabridge::LuaRef(lua_sess["restore"]);
5258                 _lua_cleanup = new luabridge::LuaRef(lua_sess["cleanup"]);
5259         } catch (luabridge::LuaException const& e) {
5260                 fatal << string_compose (_("programming error: %1"),
5261                                 X_("Failed to setup Lua interpreter"))
5262                         << endmsg;
5263                 abort(); /*NOTREACHED*/
5264         }
5265
5266         LuaBindings::stddef (L);
5267         LuaBindings::common (L);
5268         LuaBindings::dsp (L);
5269         luabridge::push <Session *> (L, this);
5270         lua_setglobal (L, "Session");
5271 }
5272
5273 void
5274 Session::scripts_changed ()
5275 {
5276         assert (!lua_lock.trylock()); // must hold lua_lock
5277
5278         try {
5279                 luabridge::LuaRef list ((*_lua_list)());
5280                 int cnt = 0;
5281                 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5282                         if (!i.key ().isString ()) { assert(0); continue; }
5283                         ++cnt;
5284                 }
5285                 _n_lua_scripts = cnt;
5286         } catch (luabridge::LuaException const& e) {
5287                 fatal << string_compose (_("programming error: %1"),
5288                                 X_("Indexing Lua Session Scripts failed."))
5289                         << endmsg;
5290                 abort(); /*NOTREACHED*/
5291         }
5292 }
5293
5294 void
5295 Session::non_realtime_set_audition ()
5296 {
5297         assert (pending_audition_region);
5298         auditioner->audition_region (pending_audition_region);
5299         pending_audition_region.reset ();
5300         AuditionActive (true); /* EMIT SIGNAL */
5301 }
5302
5303 void
5304 Session::audition_region (boost::shared_ptr<Region> r)
5305 {
5306         SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5307         ev->region = r;
5308         queue_event (ev);
5309 }
5310
5311 void
5312 Session::cancel_audition ()
5313 {
5314         if (!auditioner) {
5315                 return;
5316         }
5317         if (auditioner->auditioning()) {
5318                 auditioner->cancel_audition ();
5319                 AuditionActive (false); /* EMIT SIGNAL */
5320         }
5321 }
5322
5323 bool
5324 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
5325 {
5326         if (a->is_monitor()) {
5327                 return true;
5328         }
5329         if (b->is_monitor()) {
5330                 return false;
5331         }
5332         return a->presentation_info() < b->presentation_info();
5333 }
5334
5335 bool
5336 Session::is_auditioning () const
5337 {
5338         /* can be called before we have an auditioner object */
5339         if (auditioner) {
5340                 return auditioner->auditioning();
5341         } else {
5342                 return false;
5343         }
5344 }
5345
5346 void
5347 Session::graph_reordered ()
5348 {
5349         /* don't do this stuff if we are setting up connections
5350            from a set_state() call or creating new tracks. Ditto for deletion.
5351         */
5352
5353         if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
5354                 return;
5355         }
5356
5357         /* every track/bus asked for this to be handled but it was deferred because
5358            we were connecting. do it now.
5359         */
5360
5361         request_input_change_handling ();
5362
5363         resort_routes ();
5364
5365         /* force all diskstreams to update their capture offset values to
5366            reflect any changes in latencies within the graph.
5367         */
5368
5369         boost::shared_ptr<RouteList> rl = routes.reader ();
5370         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5371                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5372                 if (tr) {
5373                         tr->set_capture_offset ();
5374                 }
5375         }
5376 }
5377
5378 /** @return Number of frames that there is disk space available to write,
5379  *  if known.
5380  */
5381 boost::optional<framecnt_t>
5382 Session::available_capture_duration ()
5383 {
5384         Glib::Threads::Mutex::Lock lm (space_lock);
5385
5386         if (_total_free_4k_blocks_uncertain) {
5387                 return boost::optional<framecnt_t> ();
5388         }
5389
5390         float sample_bytes_on_disk = 4.0; // keep gcc happy
5391
5392         switch (config.get_native_file_data_format()) {
5393         case FormatFloat:
5394                 sample_bytes_on_disk = 4.0;
5395                 break;
5396
5397         case FormatInt24:
5398                 sample_bytes_on_disk = 3.0;
5399                 break;
5400
5401         case FormatInt16:
5402                 sample_bytes_on_disk = 2.0;
5403                 break;
5404
5405         default:
5406                 /* impossible, but keep some gcc versions happy */
5407                 fatal << string_compose (_("programming error: %1"),
5408                                          X_("illegal native file data format"))
5409                       << endmsg;
5410                 abort(); /*NOTREACHED*/
5411         }
5412
5413         double scale = 4096.0 / sample_bytes_on_disk;
5414
5415         if (_total_free_4k_blocks * scale > (double) max_framecnt) {
5416                 return max_framecnt;
5417         }
5418
5419         return (framecnt_t) floor (_total_free_4k_blocks * scale);
5420 }
5421
5422 void
5423 Session::add_bundle (boost::shared_ptr<Bundle> bundle, bool emit_signal)
5424 {
5425         {
5426                 RCUWriter<BundleList> writer (_bundles);
5427                 boost::shared_ptr<BundleList> b = writer.get_copy ();
5428                 b->push_back (bundle);
5429         }
5430
5431         if (emit_signal) {
5432                 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5433         }
5434
5435         set_dirty();
5436 }
5437
5438 void
5439 Session::remove_bundle (boost::shared_ptr<Bundle> bundle)
5440 {
5441         bool removed = false;
5442
5443         {
5444                 RCUWriter<BundleList> writer (_bundles);
5445                 boost::shared_ptr<BundleList> b = writer.get_copy ();
5446                 BundleList::iterator i = find (b->begin(), b->end(), bundle);
5447
5448                 if (i != b->end()) {
5449                         b->erase (i);
5450                         removed = true;
5451                 }
5452         }
5453
5454         if (removed) {
5455                  BundleAddedOrRemoved (); /* EMIT SIGNAL */
5456         }
5457
5458         set_dirty();
5459 }
5460
5461 boost::shared_ptr<Bundle>
5462 Session::bundle_by_name (string name) const
5463 {
5464         boost::shared_ptr<BundleList> b = _bundles.reader ();
5465
5466         for (BundleList::const_iterator i = b->begin(); i != b->end(); ++i) {
5467                 if ((*i)->name() == name) {
5468                         return* i;
5469                 }
5470         }
5471
5472         return boost::shared_ptr<Bundle> ();
5473 }
5474
5475 void
5476 Session::tempo_map_changed (const PropertyChange&)
5477 {
5478         clear_clicks ();
5479
5480         playlists->update_after_tempo_map_change ();
5481
5482         _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5483
5484         set_dirty ();
5485 }
5486
5487 void
5488 Session::gui_tempo_map_changed ()
5489 {
5490         clear_clicks ();
5491
5492         playlists->update_after_tempo_map_change ();
5493
5494         _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5495 }
5496
5497 void
5498 Session::update_locations_after_tempo_map_change (const Locations::LocationList& loc)
5499 {
5500         for (Locations::LocationList::const_iterator i = loc.begin(); i != loc.end(); ++i) {
5501                 (*i)->recompute_frames_from_bbt ();
5502         }
5503 }
5504
5505 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
5506  * the given count with the current block size.
5507  */
5508 void
5509 Session::ensure_buffers (ChanCount howmany)
5510 {
5511         BufferManager::ensure_buffers (howmany, bounce_processing() ? bounce_chunk_size : 0);
5512 }
5513
5514 void
5515 Session::ensure_buffer_set(BufferSet& buffers, const ChanCount& count)
5516 {
5517         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5518                 buffers.ensure_buffers(*t, count.get(*t), _engine.raw_buffer_size(*t));
5519         }
5520 }
5521
5522 uint32_t
5523 Session::next_insert_id ()
5524 {
5525         /* this doesn't really loop forever. just think about it */
5526
5527         while (true) {
5528                 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < insert_bitset.size(); ++n) {
5529                         if (!insert_bitset[n]) {
5530                                 insert_bitset[n] = true;
5531                                 return n;
5532
5533                         }
5534                 }
5535
5536                 /* none available, so resize and try again */
5537
5538                 insert_bitset.resize (insert_bitset.size() + 16, false);
5539         }
5540 }
5541
5542 uint32_t
5543 Session::next_send_id ()
5544 {
5545         /* this doesn't really loop forever. just think about it */
5546
5547         while (true) {
5548                 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < send_bitset.size(); ++n) {
5549                         if (!send_bitset[n]) {
5550                                 send_bitset[n] = true;
5551                                 return n;
5552
5553                         }
5554                 }
5555
5556                 /* none available, so resize and try again */
5557
5558                 send_bitset.resize (send_bitset.size() + 16, false);
5559         }
5560 }
5561
5562 uint32_t
5563 Session::next_aux_send_id ()
5564 {
5565         /* this doesn't really loop forever. just think about it */
5566
5567         while (true) {
5568                 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < aux_send_bitset.size(); ++n) {
5569                         if (!aux_send_bitset[n]) {
5570                                 aux_send_bitset[n] = true;
5571                                 return n;
5572
5573                         }
5574                 }
5575
5576                 /* none available, so resize and try again */
5577
5578                 aux_send_bitset.resize (aux_send_bitset.size() + 16, false);
5579         }
5580 }
5581
5582 uint32_t
5583 Session::next_return_id ()
5584 {
5585         /* this doesn't really loop forever. just think about it */
5586
5587         while (true) {
5588                 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < return_bitset.size(); ++n) {
5589                         if (!return_bitset[n]) {
5590                                 return_bitset[n] = true;
5591                                 return n;
5592
5593                         }
5594                 }
5595
5596                 /* none available, so resize and try again */
5597
5598                 return_bitset.resize (return_bitset.size() + 16, false);
5599         }
5600 }
5601
5602 void
5603 Session::mark_send_id (uint32_t id)
5604 {
5605         if (id >= send_bitset.size()) {
5606                 send_bitset.resize (id+16, false);
5607         }
5608         if (send_bitset[id]) {
5609                 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
5610         }
5611         send_bitset[id] = true;
5612 }
5613
5614 void
5615 Session::mark_aux_send_id (uint32_t id)
5616 {
5617         if (id >= aux_send_bitset.size()) {
5618                 aux_send_bitset.resize (id+16, false);
5619         }
5620         if (aux_send_bitset[id]) {
5621                 warning << string_compose (_("aux send ID %1 appears to be in use already"), id) << endmsg;
5622         }
5623         aux_send_bitset[id] = true;
5624 }
5625
5626 void
5627 Session::mark_return_id (uint32_t id)
5628 {
5629         if (id >= return_bitset.size()) {
5630                 return_bitset.resize (id+16, false);
5631         }
5632         if (return_bitset[id]) {
5633                 warning << string_compose (_("return ID %1 appears to be in use already"), id) << endmsg;
5634         }
5635         return_bitset[id] = true;
5636 }
5637
5638 void
5639 Session::mark_insert_id (uint32_t id)
5640 {
5641         if (id >= insert_bitset.size()) {
5642                 insert_bitset.resize (id+16, false);
5643         }
5644         if (insert_bitset[id]) {
5645                 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
5646         }
5647         insert_bitset[id] = true;
5648 }
5649
5650 void
5651 Session::unmark_send_id (uint32_t id)
5652 {
5653         if (id < send_bitset.size()) {
5654                 send_bitset[id] = false;
5655         }
5656 }
5657
5658 void
5659 Session::unmark_aux_send_id (uint32_t id)
5660 {
5661         if (id < aux_send_bitset.size()) {
5662                 aux_send_bitset[id] = false;
5663         }
5664 }
5665
5666 void
5667 Session::unmark_return_id (uint32_t id)
5668 {
5669         if (_state_of_the_state & Deletion) { return; }
5670         if (id < return_bitset.size()) {
5671                 return_bitset[id] = false;
5672         }
5673 }
5674
5675 void
5676 Session::unmark_insert_id (uint32_t id)
5677 {
5678         if (id < insert_bitset.size()) {
5679                 insert_bitset[id] = false;
5680         }
5681 }
5682
5683 void
5684 Session::reset_native_file_format ()
5685 {
5686         boost::shared_ptr<RouteList> rl = routes.reader ();
5687
5688         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5689                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5690                 if (tr) {
5691                         /* don't save state as we do this, there's no point
5692                          */
5693                         _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
5694                         tr->reset_write_sources (false);
5695                         _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
5696                 }
5697         }
5698 }
5699
5700 bool
5701 Session::route_name_unique (string n) const
5702 {
5703         boost::shared_ptr<RouteList> r = routes.reader ();
5704
5705         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5706                 if ((*i)->name() == n) {
5707                         return false;
5708                 }
5709         }
5710
5711         return true;
5712 }
5713
5714 bool
5715 Session::route_name_internal (string n) const
5716 {
5717         if (auditioner && auditioner->name() == n) {
5718                 return true;
5719         }
5720
5721         if (_click_io && _click_io->name() == n) {
5722                 return true;
5723         }
5724
5725         return false;
5726 }
5727
5728 int
5729 Session::freeze_all (InterThreadInfo& itt)
5730 {
5731         boost::shared_ptr<RouteList> r = routes.reader ();
5732
5733         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5734
5735                 boost::shared_ptr<Track> t;
5736
5737                 if ((t = boost::dynamic_pointer_cast<Track>(*i)) != 0) {
5738                         /* XXX this is wrong because itt.progress will keep returning to zero at the start
5739                            of every track.
5740                         */
5741                         t->freeze_me (itt);
5742                 }
5743         }
5744
5745         return 0;
5746 }
5747
5748 boost::shared_ptr<Region>
5749 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
5750                           bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
5751                           InterThreadInfo& itt,
5752                           boost::shared_ptr<Processor> endpoint, bool include_endpoint,
5753                           bool for_export, bool for_freeze)
5754 {
5755         boost::shared_ptr<Region> result;
5756         boost::shared_ptr<Playlist> playlist;
5757         boost::shared_ptr<Source> source;
5758         ChanCount diskstream_channels (track.n_channels());
5759         framepos_t position;
5760         framecnt_t this_chunk;
5761         framepos_t to_do;
5762         framepos_t latency_skip;
5763         BufferSet buffers;
5764         framepos_t len = end - start;
5765         bool need_block_size_reset = false;
5766         ChanCount const max_proc = track.max_processor_streams ();
5767         string legal_playlist_name;
5768         string possible_path;
5769
5770         if (end <= start) {
5771                 error << string_compose (_("Cannot write a range where end <= start (e.g. %1 <= %2)"),
5772                                          end, start) << endmsg;
5773                 return result;
5774         }
5775
5776         diskstream_channels = track.bounce_get_output_streams (diskstream_channels, endpoint,
5777                         include_endpoint, for_export, for_freeze);
5778
5779         if (diskstream_channels.n(track.data_type()) < 1) {
5780                 error << _("Cannot write a range with no data.") << endmsg;
5781                 return result;
5782         }
5783
5784         // block all process callback handling
5785
5786         block_processing ();
5787
5788         {
5789                 // synchronize with AudioEngine::process_callback()
5790                 // make sure processing is not currently running
5791                 // and processing_blocked() is honored before
5792                 // acquiring thread buffers
5793                 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5794         }
5795
5796         _bounce_processing_active = true;
5797
5798         /* call tree *MUST* hold route_lock */
5799
5800         if ((playlist = track.playlist()) == 0) {
5801                 goto out;
5802         }
5803
5804         legal_playlist_name = legalize_for_path (playlist->name());
5805
5806         for (uint32_t chan_n = 0; chan_n < diskstream_channels.n(track.data_type()); ++chan_n) {
5807
5808                 string base_name = string_compose ("%1-%2-bounce", playlist->name(), chan_n);
5809                 string path = ((track.data_type() == DataType::AUDIO)
5810                                ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
5811                                : new_midi_source_path (legal_playlist_name));
5812
5813                 if (path.empty()) {
5814                         goto out;
5815                 }
5816
5817                 try {
5818                         source = SourceFactory::createWritable (track.data_type(), *this, path, false, frame_rate());
5819                 }
5820
5821                 catch (failed_constructor& err) {
5822                         error << string_compose (_("cannot create new file \"%1\" for %2"), path, track.name()) << endmsg;
5823                         goto out;
5824                 }
5825
5826                 srcs.push_back (source);
5827         }
5828
5829         /* tell redirects that care that we are about to use a much larger
5830          * blocksize. this will flush all plugins too, so that they are ready
5831          * to be used for this process.
5832          */
5833
5834         need_block_size_reset = true;
5835         track.set_block_size (bounce_chunk_size);
5836         _engine.main_thread()->get_buffers ();
5837
5838         position = start;
5839         to_do = len;
5840         latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5841
5842         /* create a set of reasonably-sized buffers */
5843         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5844                 buffers.ensure_buffers(*t, max_proc.get(*t), bounce_chunk_size);
5845         }
5846         buffers.set_count (max_proc);
5847
5848         for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5849                 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5850                 boost::shared_ptr<MidiSource> ms;
5851                 if (afs) {
5852                         afs->prepare_for_peakfile_writes ();
5853                 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5854                         Source::Lock lock(ms->mutex());
5855                         ms->mark_streaming_write_started(lock);
5856                 }
5857         }
5858
5859         while (to_do && !itt.cancel) {
5860
5861                 this_chunk = min (to_do, bounce_chunk_size);
5862
5863                 if (track.export_stuff (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze)) {
5864                         goto out;
5865                 }
5866
5867                 start += this_chunk;
5868                 to_do -= this_chunk;
5869                 itt.progress = (float) (1.0 - ((double) to_do / len));
5870
5871                 if (latency_skip >= bounce_chunk_size) {
5872                         latency_skip -= bounce_chunk_size;
5873                         continue;
5874                 }
5875
5876                 const framecnt_t current_chunk = this_chunk - latency_skip;
5877
5878                 uint32_t n = 0;
5879                 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5880                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5881                         boost::shared_ptr<MidiSource> ms;
5882
5883                         if (afs) {
5884                                 if (afs->write (buffers.get_audio(n).data(latency_skip), current_chunk) != current_chunk) {
5885                                         goto out;
5886                                 }
5887                         } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5888                                 Source::Lock lock(ms->mutex());
5889
5890                                 const MidiBuffer& buf = buffers.get_midi(0);
5891                                 for (MidiBuffer::const_iterator i = buf.begin(); i != buf.end(); ++i) {
5892                                         Evoral::Event<framepos_t> ev = *i;
5893                                         ev.set_time(ev.time() - position);
5894                                         ms->append_event_frames(lock, ev, ms->timeline_position());
5895                                 }
5896                         }
5897                 }
5898                 latency_skip = 0;
5899         }
5900
5901         /* post-roll, pick up delayed processor output */
5902         latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5903
5904         while (latency_skip && !itt.cancel) {
5905                 this_chunk = min (latency_skip, bounce_chunk_size);
5906                 latency_skip -= this_chunk;
5907
5908                 buffers.silence (this_chunk, 0);
5909                 track.bounce_process (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze);
5910
5911                 uint32_t n = 0;
5912                 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5913                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5914
5915                         if (afs) {
5916                                 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
5917                                         goto out;
5918                                 }
5919                         }
5920                 }
5921         }
5922
5923         if (!itt.cancel) {
5924
5925                 time_t now;
5926                 struct tm* xnow;
5927                 time (&now);
5928                 xnow = localtime (&now);
5929
5930                 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
5931                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5932                         boost::shared_ptr<MidiSource> ms;
5933
5934                         if (afs) {
5935                                 afs->update_header (position, *xnow, now);
5936                                 afs->flush_header ();
5937                         } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5938                                 Source::Lock lock(ms->mutex());
5939                                 ms->mark_streaming_write_completed(lock);
5940                         }
5941                 }
5942
5943                 /* construct a region to represent the bounced material */
5944
5945                 PropertyList plist;
5946
5947                 plist.add (Properties::start, 0);
5948                 plist.add (Properties::length, srcs.front()->length(srcs.front()->timeline_position()));
5949                 plist.add (Properties::name, region_name_from_path (srcs.front()->name(), true));
5950
5951                 result = RegionFactory::create (srcs, plist);
5952
5953         }
5954
5955   out:
5956         if (!result) {
5957                 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5958                         (*src)->mark_for_remove ();
5959                         (*src)->drop_references ();
5960                 }
5961
5962         } else {
5963                 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5964                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5965
5966                         if (afs)
5967                                 afs->done_with_peakfile_writes ();
5968                 }
5969         }
5970
5971         _bounce_processing_active = false;
5972
5973         if (need_block_size_reset) {
5974                 _engine.main_thread()->drop_buffers ();
5975                 track.set_block_size (get_block_size());
5976         }
5977
5978         unblock_processing ();
5979
5980         return result;
5981 }
5982
5983 gain_t*
5984 Session::gain_automation_buffer() const
5985 {
5986         return ProcessThread::gain_automation_buffer ();
5987 }
5988
5989 gain_t*
5990 Session::trim_automation_buffer() const
5991 {
5992         return ProcessThread::trim_automation_buffer ();
5993 }
5994
5995 gain_t*
5996 Session::send_gain_automation_buffer() const
5997 {
5998         return ProcessThread::send_gain_automation_buffer ();
5999 }
6000
6001 pan_t**
6002 Session::pan_automation_buffer() const
6003 {
6004         return ProcessThread::pan_automation_buffer ();
6005 }
6006
6007 BufferSet&
6008 Session::get_silent_buffers (ChanCount count)
6009 {
6010         return ProcessThread::get_silent_buffers (count);
6011 }
6012
6013 BufferSet&
6014 Session::get_scratch_buffers (ChanCount count, bool silence)
6015 {
6016         return ProcessThread::get_scratch_buffers (count, silence);
6017 }
6018
6019 BufferSet&
6020 Session::get_noinplace_buffers (ChanCount count)
6021 {
6022         return ProcessThread::get_noinplace_buffers (count);
6023 }
6024
6025 BufferSet&
6026 Session::get_route_buffers (ChanCount count, bool silence)
6027 {
6028         return ProcessThread::get_route_buffers (count, silence);
6029 }
6030
6031
6032 BufferSet&
6033 Session::get_mix_buffers (ChanCount count)
6034 {
6035         return ProcessThread::get_mix_buffers (count);
6036 }
6037
6038 uint32_t
6039 Session::ntracks () const
6040 {
6041         uint32_t n = 0;
6042         boost::shared_ptr<RouteList> r = routes.reader ();
6043
6044         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6045                 if (boost::dynamic_pointer_cast<Track> (*i)) {
6046                         ++n;
6047                 }
6048         }
6049
6050         return n;
6051 }
6052
6053 uint32_t
6054 Session::nbusses () const
6055 {
6056         uint32_t n = 0;
6057         boost::shared_ptr<RouteList> r = routes.reader ();
6058
6059         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6060                 if (boost::dynamic_pointer_cast<Track>(*i) == 0) {
6061                         ++n;
6062                 }
6063         }
6064
6065         return n;
6066 }
6067
6068 void
6069 Session::add_automation_list(AutomationList *al)
6070 {
6071         automation_lists[al->id()] = al;
6072 }
6073
6074 /** @return true if there is at least one record-enabled track, otherwise false */
6075 bool
6076 Session::have_rec_enabled_track () const
6077 {
6078         return g_atomic_int_get (const_cast<gint*>(&_have_rec_enabled_track)) == 1;
6079 }
6080
6081 bool
6082 Session::have_rec_disabled_track () const
6083 {
6084     return g_atomic_int_get (const_cast<gint*>(&_have_rec_disabled_track)) == 1;
6085 }
6086
6087 /** Update the state of our rec-enabled tracks flag */
6088 void
6089 Session::update_route_record_state ()
6090 {
6091         boost::shared_ptr<RouteList> rl = routes.reader ();
6092         RouteList::iterator i = rl->begin();
6093         while (i != rl->end ()) {
6094
6095                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6096                                     if (tr && tr->rec_enable_control()->get_value()) {
6097                         break;
6098                 }
6099
6100                 ++i;
6101         }
6102
6103         int const old = g_atomic_int_get (&_have_rec_enabled_track);
6104
6105         g_atomic_int_set (&_have_rec_enabled_track, i != rl->end () ? 1 : 0);
6106
6107         if (g_atomic_int_get (&_have_rec_enabled_track) != old) {
6108                 RecordStateChanged (); /* EMIT SIGNAL */
6109         }
6110
6111         for (i = rl->begin(); i != rl->end (); ++i) {
6112                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6113                 if (tr && !tr->rec_enable_control()->get_value()) {
6114                         break;
6115                 }
6116         }
6117
6118         g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
6119
6120         bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
6121
6122         if (record_status() == Recording && record_arm_state_changed ) {
6123                 RecordArmStateChanged ();
6124         }
6125
6126 }
6127
6128 void
6129 Session::listen_position_changed ()
6130 {
6131         boost::shared_ptr<RouteList> r = routes.reader ();
6132
6133         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6134                 (*i)->listen_position_changed ();
6135         }
6136 }
6137
6138 void
6139 Session::solo_control_mode_changed ()
6140 {
6141         if (soloing() || listening()) {
6142                 /* We can't use ::clear_all_solo_state() here because during
6143                    session loading at program startup, that will queue a call
6144                    to rt_clear_all_solo_state() that will not execute until
6145                    AFTER solo states have been established (thus throwing away
6146                    the session's saved solo state). So just explicitly turn
6147                    them all off.
6148                 */
6149                 set_controls (route_list_to_control_list (get_routes(), &Route::solo_control), 0.0, Controllable::NoGroup);
6150         }
6151 }
6152
6153 /** Called when a property of one of our route groups changes */
6154 void
6155 Session::route_group_property_changed (RouteGroup* rg)
6156 {
6157         RouteGroupPropertyChanged (rg); /* EMIT SIGNAL */
6158 }
6159
6160 /** Called when a route is added to one of our route groups */
6161 void
6162 Session::route_added_to_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6163 {
6164         RouteAddedToRouteGroup (rg, r);
6165 }
6166
6167 /** Called when a route is removed from one of our route groups */
6168 void
6169 Session::route_removed_from_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6170 {
6171         update_route_record_state ();
6172         RouteRemovedFromRouteGroup (rg, r); /* EMIT SIGNAL */
6173 }
6174
6175 boost::shared_ptr<RouteList>
6176 Session::get_tracks () const
6177 {
6178         boost::shared_ptr<RouteList> rl = routes.reader ();
6179         boost::shared_ptr<RouteList> tl (new RouteList);
6180
6181         for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
6182                 if (boost::dynamic_pointer_cast<Track> (*r)) {
6183                         if (!(*r)->is_auditioner()) {
6184                                 tl->push_back (*r);
6185                         }
6186                 }
6187         }
6188         return tl;
6189 }
6190
6191 boost::shared_ptr<RouteList>
6192 Session::get_routes_with_regions_at (framepos_t const p) const
6193 {
6194         boost::shared_ptr<RouteList> r = routes.reader ();
6195         boost::shared_ptr<RouteList> rl (new RouteList);
6196
6197         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6198                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6199                 if (!tr) {
6200                         continue;
6201                 }
6202
6203                 boost::shared_ptr<Playlist> pl = tr->playlist ();
6204                 if (!pl) {
6205                         continue;
6206                 }
6207
6208                 if (pl->has_region_at (p)) {
6209                         rl->push_back (*i);
6210                 }
6211         }
6212
6213         return rl;
6214 }
6215
6216 void
6217 Session::goto_end ()
6218 {
6219         if (_session_range_location) {
6220                 request_locate (_session_range_location->end(), false);
6221         } else {
6222                 request_locate (0, false);
6223         }
6224 }
6225
6226 void
6227 Session::goto_start ()
6228 {
6229         if (_session_range_location) {
6230                 request_locate (_session_range_location->start(), false);
6231         } else {
6232                 request_locate (0, false);
6233         }
6234 }
6235
6236 framepos_t
6237 Session::current_start_frame () const
6238 {
6239         return _session_range_location ? _session_range_location->start() : 0;
6240 }
6241
6242 framepos_t
6243 Session::current_end_frame () const
6244 {
6245         return _session_range_location ? _session_range_location->end() : 0;
6246 }
6247
6248 void
6249 Session::set_session_range_location (framepos_t start, framepos_t end)
6250 {
6251         _session_range_location = new Location (*this, start, end, _("session"), Location::IsSessionRange);
6252         _locations->add (_session_range_location);
6253 }
6254
6255 void
6256 Session::step_edit_status_change (bool yn)
6257 {
6258         bool send = false;
6259
6260         bool val = false;
6261         if (yn) {
6262                 send = (_step_editors == 0);
6263                 val = true;
6264
6265                 _step_editors++;
6266         } else {
6267                 send = (_step_editors == 1);
6268                 val = false;
6269
6270                 if (_step_editors > 0) {
6271                         _step_editors--;
6272                 }
6273         }
6274
6275         if (send) {
6276                 StepEditStatusChange (val);
6277         }
6278 }
6279
6280
6281 void
6282 Session::start_time_changed (framepos_t old)
6283 {
6284         /* Update the auto loop range to match the session range
6285            (unless the auto loop range has been changed by the user)
6286         */
6287
6288         Location* s = _locations->session_range_location ();
6289         if (s == 0) {
6290                 return;
6291         }
6292
6293         Location* l = _locations->auto_loop_location ();
6294
6295         if (l && l->start() == old) {
6296                 l->set_start (s->start(), true);
6297         }
6298 }
6299
6300 void
6301 Session::end_time_changed (framepos_t old)
6302 {
6303         /* Update the auto loop range to match the session range
6304            (unless the auto loop range has been changed by the user)
6305         */
6306
6307         Location* s = _locations->session_range_location ();
6308         if (s == 0) {
6309                 return;
6310         }
6311
6312         Location* l = _locations->auto_loop_location ();
6313
6314         if (l && l->end() == old) {
6315                 l->set_end (s->end(), true);
6316         }
6317 }
6318
6319 std::vector<std::string>
6320 Session::source_search_path (DataType type) const
6321 {
6322         Searchpath sp;
6323
6324         if (session_dirs.size() == 1) {
6325                 switch (type) {
6326                 case DataType::AUDIO:
6327                         sp.push_back (_session_dir->sound_path());
6328                         break;
6329                 case DataType::MIDI:
6330                         sp.push_back (_session_dir->midi_path());
6331                         break;
6332                 }
6333         } else {
6334                 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
6335                         SessionDirectory sdir (i->path);
6336                         switch (type) {
6337                         case DataType::AUDIO:
6338                                 sp.push_back (sdir.sound_path());
6339                                 break;
6340                         case DataType::MIDI:
6341                                 sp.push_back (sdir.midi_path());
6342                                 break;
6343                         }
6344                 }
6345         }
6346
6347         if (type == DataType::AUDIO) {
6348                 const string sound_path_2X = _session_dir->sound_path_2X();
6349                 if (Glib::file_test (sound_path_2X, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_DIR)) {
6350                         if (find (sp.begin(), sp.end(), sound_path_2X) == sp.end()) {
6351                                 sp.push_back (sound_path_2X);
6352                         }
6353                 }
6354         }
6355
6356         // now check the explicit (possibly user-specified) search path
6357
6358         switch (type) {
6359         case DataType::AUDIO:
6360                 sp += Searchpath(config.get_audio_search_path ());
6361                 break;
6362         case DataType::MIDI:
6363                 sp += Searchpath(config.get_midi_search_path ());
6364                 break;
6365         }
6366
6367         return sp;
6368 }
6369
6370 void
6371 Session::ensure_search_path_includes (const string& path, DataType type)
6372 {
6373         Searchpath sp;
6374
6375         if (path == ".") {
6376                 return;
6377         }
6378
6379         switch (type) {
6380         case DataType::AUDIO:
6381                 sp += Searchpath(config.get_audio_search_path ());
6382                 break;
6383         case DataType::MIDI:
6384                 sp += Searchpath (config.get_midi_search_path ());
6385                 break;
6386         }
6387
6388         for (vector<std::string>::iterator i = sp.begin(); i != sp.end(); ++i) {
6389                 /* No need to add this new directory if it has the same inode as
6390                    an existing one; checking inode rather than name prevents duplicated
6391                    directories when we are using symlinks.
6392
6393                    On Windows, I think we could just do if (*i == path) here.
6394                 */
6395                 if (PBD::equivalent_paths (*i, path)) {
6396                         return;
6397                 }
6398         }
6399
6400         sp += path;
6401
6402         switch (type) {
6403         case DataType::AUDIO:
6404                 config.set_audio_search_path (sp.to_string());
6405                 break;
6406         case DataType::MIDI:
6407                 config.set_midi_search_path (sp.to_string());
6408                 break;
6409         }
6410 }
6411
6412 void
6413 Session::remove_dir_from_search_path (const string& dir, DataType type)
6414 {
6415         Searchpath sp;
6416
6417         switch (type) {
6418         case DataType::AUDIO:
6419                 sp = Searchpath(config.get_audio_search_path ());
6420                 break;
6421         case DataType::MIDI:
6422                 sp = Searchpath (config.get_midi_search_path ());
6423                 break;
6424         }
6425
6426         sp -= dir;
6427
6428         switch (type) {
6429         case DataType::AUDIO:
6430                 config.set_audio_search_path (sp.to_string());
6431                 break;
6432         case DataType::MIDI:
6433                 config.set_midi_search_path (sp.to_string());
6434                 break;
6435         }
6436
6437 }
6438
6439 boost::shared_ptr<Speakers>
6440 Session::get_speakers()
6441 {
6442         return _speakers;
6443 }
6444
6445 list<string>
6446 Session::unknown_processors () const
6447 {
6448         list<string> p;
6449
6450         boost::shared_ptr<RouteList> r = routes.reader ();
6451         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6452                 list<string> t = (*i)->unknown_processors ();
6453                 copy (t.begin(), t.end(), back_inserter (p));
6454         }
6455
6456         p.sort ();
6457         p.unique ();
6458
6459         return p;
6460 }
6461
6462 void
6463 Session::update_latency (bool playback)
6464 {
6465
6466         DEBUG_TRACE (DEBUG::Latency, string_compose ("JACK latency callback: %1\n", (playback ? "PLAYBACK" : "CAPTURE")));
6467
6468         if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _route_deletion_in_progress) {
6469                 return;
6470         }
6471
6472         boost::shared_ptr<RouteList> r = routes.reader ();
6473         framecnt_t max_latency = 0;
6474
6475         if (playback) {
6476                 /* reverse the list so that we work backwards from the last route to run to the first */
6477                 RouteList* rl = routes.reader().get();
6478                 r.reset (new RouteList (*rl));
6479                 reverse (r->begin(), r->end());
6480         }
6481
6482         /* compute actual latency values for the given direction and store them all in per-port
6483            structures. this will also publish the same values (to JACK) so that computation of latency
6484            for routes can consistently use public latency values.
6485         */
6486
6487         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6488                 max_latency = max (max_latency, (*i)->set_private_port_latencies (playback));
6489         }
6490
6491         /* because we latency compensate playback, our published playback latencies should
6492            be the same for all output ports - all material played back by ardour has
6493            the same latency, whether its caused by plugins or by latency compensation. since
6494            these may differ from the values computed above, reset all playback port latencies
6495            to the same value.
6496         */
6497
6498         DEBUG_TRACE (DEBUG::Latency, string_compose ("Set public port latencies to %1\n", max_latency));
6499
6500         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6501                 (*i)->set_public_port_latencies (max_latency, playback);
6502         }
6503
6504         if (playback) {
6505
6506                 post_playback_latency ();
6507
6508         } else {
6509
6510                 post_capture_latency ();
6511         }
6512
6513         DEBUG_TRACE (DEBUG::Latency, "JACK latency callback: DONE\n");
6514 }
6515
6516 void
6517 Session::post_playback_latency ()
6518 {
6519         set_worst_playback_latency ();
6520
6521         boost::shared_ptr<RouteList> r = routes.reader ();
6522
6523         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6524                 if (!(*i)->is_auditioner() && ((*i)->active())) {
6525                         _worst_track_latency = max (_worst_track_latency, (*i)->update_signal_latency ());
6526                 }
6527         }
6528
6529         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6530                 (*i)->set_latency_compensation (_worst_track_latency);
6531         }
6532 }
6533
6534 void
6535 Session::post_capture_latency ()
6536 {
6537         set_worst_capture_latency ();
6538
6539         /* reflect any changes in capture latencies into capture offsets
6540          */
6541
6542         boost::shared_ptr<RouteList> rl = routes.reader();
6543         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
6544                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6545                 if (tr) {
6546                         tr->set_capture_offset ();
6547                 }
6548         }
6549 }
6550
6551 void
6552 Session::initialize_latencies ()
6553 {
6554         {
6555                 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
6556                 update_latency (false);
6557                 update_latency (true);
6558         }
6559
6560         set_worst_io_latencies ();
6561 }
6562
6563 void
6564 Session::set_worst_io_latencies ()
6565 {
6566         set_worst_playback_latency ();
6567         set_worst_capture_latency ();
6568 }
6569
6570 void
6571 Session::set_worst_playback_latency ()
6572 {
6573         if (_state_of_the_state & (InitialConnecting|Deletion)) {
6574                 return;
6575         }
6576
6577         _worst_output_latency = 0;
6578
6579         if (!_engine.connected()) {
6580                 return;
6581         }
6582
6583         boost::shared_ptr<RouteList> r = routes.reader ();
6584
6585         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6586                 _worst_output_latency = max (_worst_output_latency, (*i)->output()->latency());
6587         }
6588
6589         DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst output latency: %1\n", _worst_output_latency));
6590 }
6591
6592 void
6593 Session::set_worst_capture_latency ()
6594 {
6595         if (_state_of_the_state & (InitialConnecting|Deletion)) {
6596                 return;
6597         }
6598
6599         _worst_input_latency = 0;
6600
6601         if (!_engine.connected()) {
6602                 return;
6603         }
6604
6605         boost::shared_ptr<RouteList> r = routes.reader ();
6606
6607         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6608                 _worst_input_latency = max (_worst_input_latency, (*i)->input()->latency());
6609         }
6610
6611         DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst input latency: %1\n", _worst_input_latency));
6612 }
6613
6614 void
6615 Session::update_latency_compensation (bool force_whole_graph)
6616 {
6617         bool some_track_latency_changed = false;
6618
6619         if (_state_of_the_state & (InitialConnecting|Deletion)) {
6620                 return;
6621         }
6622
6623         DEBUG_TRACE(DEBUG::Latency, "---------------------------- update latency compensation\n\n");
6624
6625         _worst_track_latency = 0;
6626
6627         boost::shared_ptr<RouteList> r = routes.reader ();
6628
6629         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6630                 if (!(*i)->is_auditioner() && ((*i)->active())) {
6631                         framecnt_t tl;
6632                         if ((*i)->signal_latency () != (tl = (*i)->update_signal_latency ())) {
6633                                 some_track_latency_changed = true;
6634                         }
6635                         _worst_track_latency = max (tl, _worst_track_latency);
6636                 }
6637         }
6638
6639         DEBUG_TRACE (DEBUG::Latency, string_compose ("worst signal processing latency: %1 (changed ? %2)\n", _worst_track_latency,
6640                                                      (some_track_latency_changed ? "yes" : "no")));
6641
6642         DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
6643
6644         if (some_track_latency_changed || force_whole_graph)  {
6645                 _engine.update_latencies ();
6646         }
6647
6648
6649         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6650                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6651                 if (!tr) {
6652                         continue;
6653                 }
6654                 tr->set_capture_offset ();
6655         }
6656 }
6657
6658 char
6659 Session::session_name_is_legal (const string& path)
6660 {
6661         char illegal_chars[] = { '/', '\\', ':', ';', '\0' };
6662
6663         for (int i = 0; illegal_chars[i]; ++i) {
6664                 if (path.find (illegal_chars[i]) != string::npos) {
6665                         return illegal_chars[i];
6666                 }
6667         }
6668
6669         return 0;
6670 }
6671
6672 void
6673 Session::notify_presentation_info_change ()
6674 {
6675         if (deletion_in_progress()) {
6676                 return;
6677         }
6678
6679         switch (Config->get_remote_model()) {
6680         case MixerOrdered:
6681                 Stripable::PresentationInfoChange (); /* EMIT SIGNAL */
6682                 break;
6683         default:
6684                 break;
6685         }
6686
6687         reassign_track_numbers();
6688
6689 #ifdef USE_TRACKS_CODE_FEATURES
6690         /* Waves Tracks: for Waves Tracks session it's required to reconnect their IOs
6691          * if track order has been changed by user
6692          */
6693         reconnect_existing_routes(true, true);
6694 #endif
6695
6696 }
6697
6698 bool
6699 Session::operation_in_progress (GQuark op) const
6700 {
6701         return (find (_current_trans_quarks.begin(), _current_trans_quarks.end(), op) != _current_trans_quarks.end());
6702 }
6703
6704 boost::shared_ptr<Port>
6705 Session::ltc_input_port () const
6706 {
6707         return _ltc_input->nth (0);
6708 }
6709
6710 boost::shared_ptr<Port>
6711 Session::ltc_output_port () const
6712 {
6713         return _ltc_output->nth (0);
6714 }
6715
6716 void
6717 Session::reconnect_ltc_input ()
6718 {
6719         if (_ltc_input) {
6720
6721                 string src = Config->get_ltc_source_port();
6722
6723                 _ltc_input->disconnect (this);
6724
6725                 if (src != _("None") && !src.empty())  {
6726                         _ltc_input->nth (0)->connect (src);
6727                 }
6728
6729                 if ( ARDOUR::Profile->get_trx () ) {
6730                         // Tracks need this signal to update timecode_source_dropdown
6731                         MtcOrLtcInputPortChanged (); //emit signal
6732                 }
6733         }
6734 }
6735
6736 void
6737 Session::reconnect_ltc_output ()
6738 {
6739         if (_ltc_output) {
6740
6741                 string src = Config->get_ltc_output_port();
6742
6743                 _ltc_output->disconnect (this);
6744
6745                 if (src != _("None") && !src.empty())  {
6746                         _ltc_output->nth (0)->connect (src);
6747                 }
6748         }
6749 }
6750
6751 void
6752 Session::set_range_selection (framepos_t start, framepos_t end)
6753 {
6754         _range_selection = Evoral::Range<framepos_t> (start, end);
6755 #ifdef USE_TRACKS_CODE_FEATURES
6756         follow_playhead_priority ();
6757 #endif
6758 }
6759
6760 void
6761 Session::set_object_selection (framepos_t start, framepos_t end)
6762 {
6763         _object_selection = Evoral::Range<framepos_t> (start, end);
6764 #ifdef USE_TRACKS_CODE_FEATURES
6765         follow_playhead_priority ();
6766 #endif
6767 }
6768
6769 void
6770 Session::clear_range_selection ()
6771 {
6772         _range_selection = Evoral::Range<framepos_t> (-1,-1);
6773 #ifdef USE_TRACKS_CODE_FEATURES
6774         follow_playhead_priority ();
6775 #endif
6776 }
6777
6778 void
6779 Session::clear_object_selection ()
6780 {
6781         _object_selection = Evoral::Range<framepos_t> (-1,-1);
6782 #ifdef USE_TRACKS_CODE_FEATURES
6783         follow_playhead_priority ();
6784 #endif
6785 }
6786
6787 void
6788 Session::auto_connect_route (boost::shared_ptr<Route> route, bool connect_inputs,
6789                 const ChanCount& input_start,
6790                 const ChanCount& output_start,
6791                 const ChanCount& input_offset,
6792                 const ChanCount& output_offset)
6793 {
6794         Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6795         _auto_connect_queue.push (AutoConnectRequest (route, connect_inputs,
6796                                 input_start, output_start,
6797                                 input_offset, output_offset));
6798
6799         if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
6800                 pthread_cond_signal (&_auto_connect_cond);
6801                 pthread_mutex_unlock (&_auto_connect_mutex);
6802         }
6803 }
6804
6805 void
6806 Session::auto_connect (const AutoConnectRequest& ar)
6807 {
6808         boost::shared_ptr<Route> route = ar.route.lock();
6809
6810         if (!route) { return; }
6811
6812         if (!IO::connecting_legal) {
6813                 return;
6814         }
6815
6816         /* If both inputs and outputs are auto-connected to physical ports,
6817          * use the max of input and output offsets to ensure auto-connected
6818          * port numbers always match up (e.g. the first audio input and the
6819          * first audio output of the route will have the same physical
6820          * port number).  Otherwise just use the lowest input or output
6821          * offset possible.
6822          */
6823
6824         const bool in_out_physical =
6825                 (Config->get_input_auto_connect() & AutoConnectPhysical)
6826                 && (Config->get_output_auto_connect() & AutoConnectPhysical)
6827                 && ar.connect_inputs;
6828
6829         const ChanCount in_offset = in_out_physical
6830                 ? ChanCount::max(ar.input_offset, ar.output_offset)
6831                 : ar.input_offset;
6832
6833         const ChanCount out_offset = in_out_physical
6834                 ? ChanCount::max(ar.input_offset, ar.output_offset)
6835                 : ar.output_offset;
6836
6837         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
6838                 vector<string> physinputs;
6839                 vector<string> physoutputs;
6840
6841                 _engine.get_physical_outputs (*t, physoutputs);
6842                 _engine.get_physical_inputs (*t, physinputs);
6843
6844                 if (!physinputs.empty() && ar.connect_inputs) {
6845                         uint32_t nphysical_in = physinputs.size();
6846
6847                         for (uint32_t i = ar.input_start.get(*t); i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
6848                                 string port;
6849
6850                                 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
6851                                         port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
6852                                 }
6853
6854                                 if (!port.empty() && route->input()->connect (route->input()->ports().port(*t, i), port, this)) {
6855                                         break;
6856                                 }
6857                         }
6858                 }
6859
6860                 if (!physoutputs.empty()) {
6861                         uint32_t nphysical_out = physoutputs.size();
6862                         for (uint32_t i = ar.output_start.get(*t); i < route->n_outputs().get(*t); ++i) {
6863                                 string port;
6864
6865                                 /* Waves Tracks:
6866                                  * do not create new connections if we reached the limit of physical outputs
6867                                  * in Multi Out mode
6868                                  */
6869                                 if (!(Config->get_output_auto_connect() & AutoConnectMaster) &&
6870                                                 ARDOUR::Profile->get_trx () &&
6871                                                 ar.output_offset.get(*t) == nphysical_out ) {
6872                                         break;
6873                                 }
6874
6875                                 if ((*t) == DataType::MIDI && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
6876                                         port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
6877                                 } else if ((*t) == DataType::AUDIO && (Config->get_output_auto_connect() & AutoConnectMaster)) {
6878                                         /* master bus is audio only */
6879                                         if (_master_out && _master_out->n_inputs().get(*t) > 0) {
6880                                                 port = _master_out->input()->ports().port(*t,
6881                                                                 i % _master_out->input()->n_ports().get(*t))->name();
6882                                         }
6883                                 }
6884
6885                                 if (!port.empty() && route->output()->connect (route->output()->ports().port(*t, i), port, this)) {
6886                                         break;
6887                                 }
6888                         }
6889                 }
6890         }
6891 }
6892
6893 void
6894 Session::auto_connect_thread_start ()
6895 {
6896         if (_ac_thread_active) {
6897                 return;
6898         }
6899
6900         while (!_auto_connect_queue.empty ()) {
6901                 _auto_connect_queue.pop ();
6902         }
6903
6904         _ac_thread_active = true;
6905         if (pthread_create (&_auto_connect_thread, NULL, auto_connect_thread, this)) {
6906                 _ac_thread_active = false;
6907         }
6908 }
6909
6910 void
6911 Session::auto_connect_thread_terminate ()
6912 {
6913         if (!_ac_thread_active) {
6914                 return;
6915         }
6916         _ac_thread_active = false;
6917
6918         {
6919                 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6920                 while (!_auto_connect_queue.empty ()) {
6921                         _auto_connect_queue.pop ();
6922                 }
6923         }
6924
6925         if (pthread_mutex_lock (&_auto_connect_mutex) == 0) {
6926                 pthread_cond_signal (&_auto_connect_cond);
6927                 pthread_mutex_unlock (&_auto_connect_mutex);
6928         }
6929
6930         void *status;
6931         pthread_join (_auto_connect_thread, &status);
6932 }
6933
6934 void *
6935 Session::auto_connect_thread (void *arg)
6936 {
6937         Session *s = static_cast<Session *>(arg);
6938         s->auto_connect_thread_run ();
6939         pthread_exit (0);
6940         return 0;
6941 }
6942
6943 void
6944 Session::auto_connect_thread_run ()
6945 {
6946         pthread_set_name (X_("autoconnect"));
6947         SessionEvent::create_per_thread_pool (X_("autoconnect"), 1024);
6948         PBD::notify_event_loops_about_thread_creation (pthread_self(), X_("autoconnect"), 1024);
6949         pthread_mutex_lock (&_auto_connect_mutex);
6950         while (_ac_thread_active) {
6951
6952                 if (!_auto_connect_queue.empty ()) {
6953                         // Why would we need the process lock ??
6954                         // A: if ports are added while we're connecting, the backend's iterator may be invalidated:
6955                         //   graph_order_callback() -> resort_routes() -> direct_feeds_according_to_reality () -> backend::connected_to()
6956                         //   All ardour-internal backends use a std::vector   xxxAudioBackend::find_port()
6957                         //   We have control over those, but what does jack do?
6958                         Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
6959
6960                         Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6961                         while (!_auto_connect_queue.empty ()) {
6962                                 const AutoConnectRequest ar (_auto_connect_queue.front());
6963                                 _auto_connect_queue.pop ();
6964                                 lx.release ();
6965                                 auto_connect (ar);
6966                                 lx.acquire ();
6967                         }
6968                 }
6969
6970                 pthread_cond_wait (&_auto_connect_cond, &_auto_connect_mutex);
6971         }
6972         pthread_mutex_unlock (&_auto_connect_mutex);
6973 }