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 (const ChanCount& input, const ChanCount& output,
2427                          boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2428                          RouteGroup* route_group, uint32_t how_many, string name_template, PresentationInfo::order_t order,
2429                          TrackMode mode)
2430 {
2431         string track_name;
2432         uint32_t track_id = 0;
2433         string port;
2434         RouteList new_routes;
2435         list<boost::shared_ptr<MidiTrack> > ret;
2436
2437         const string name_pattern = default_track_name_pattern (DataType::MIDI);
2438         bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2439
2440         while (how_many) {
2441                 if (!find_route_name (name_template.empty() ? _("MIDI") : name_template, ++track_id, track_name, use_number)) {
2442                         error << "cannot find name for new midi track" << endmsg;
2443                         goto failed;
2444                 }
2445
2446                 boost::shared_ptr<MidiTrack> track;
2447
2448                 try {
2449                         track.reset (new MidiTrack (*this, track_name, mode));
2450
2451                         if (track->init ()) {
2452                                 goto failed;
2453                         }
2454
2455                         if (Profile->get_mixbus ()) {
2456                                 track->set_strict_io (true);
2457                         }
2458
2459                         track->use_new_diskstream();
2460
2461                         BOOST_MARK_TRACK (track);
2462
2463                         {
2464                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2465                                 if (track->input()->ensure_io (input, false, this)) {
2466                                         error << "cannot configure " << input << " out configuration for new midi track" << endmsg;
2467                                         goto failed;
2468                                 }
2469
2470                                 if (track->output()->ensure_io (output, false, this)) {
2471                                         error << "cannot configure " << output << " out configuration for new midi track" << endmsg;
2472                                         goto failed;
2473                                 }
2474                         }
2475
2476                         track->non_realtime_input_change();
2477
2478                         if (route_group) {
2479                                 route_group->add (track);
2480                         }
2481
2482                         track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2483
2484                         new_routes.push_back (track);
2485                         ret.push_back (track);
2486                 }
2487
2488                 catch (failed_constructor &err) {
2489                         error << _("Session: could not create new midi track.") << endmsg;
2490                         goto failed;
2491                 }
2492
2493                 catch (AudioEngine::PortRegistrationFailure& pfe) {
2494
2495                         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;
2496                         goto failed;
2497                 }
2498
2499                 --how_many;
2500         }
2501
2502   failed:
2503         if (!new_routes.empty()) {
2504                 StateProtector sp (this);
2505                 if (Profile->get_trx()) {
2506                         add_routes (new_routes, false, false, false, order);
2507                 } else {
2508                         add_routes (new_routes, true, true, false, order);
2509                 }
2510
2511                 if (instrument) {
2512                         for (RouteList::iterator r = new_routes.begin(); r != new_routes.end(); ++r) {
2513                                 PluginPtr plugin = instrument->load (*this);
2514                                 if (pset) {
2515                                         plugin->load_preset (*pset);
2516                                 }
2517                                 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2518                                 (*r)->add_processor (p, PreFader);
2519
2520                         }
2521                 }
2522         }
2523
2524         return ret;
2525 }
2526
2527 RouteList
2528 Session::new_midi_route (RouteGroup* route_group, uint32_t how_many, string name_template, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2529                          PresentationInfo::Flag flag, PresentationInfo::order_t order)
2530 {
2531         string bus_name;
2532         uint32_t bus_id = 0;
2533         string port;
2534         RouteList ret;
2535
2536         bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Midi Bus");
2537
2538         while (how_many) {
2539                 if (!find_route_name (name_template.empty () ? _("Midi Bus") : name_template, ++bus_id, bus_name, use_number)) {
2540                         error << "cannot find name for new midi bus" << endmsg;
2541                         goto failure;
2542                 }
2543
2544                 try {
2545                         boost::shared_ptr<Route> bus (new Route (*this, bus_name, flag, DataType::AUDIO)); // XXX Editor::add_routes is not ready for ARDOUR::DataType::MIDI
2546
2547                         if (bus->init ()) {
2548                                 goto failure;
2549                         }
2550
2551                         if (Profile->get_mixbus ()) {
2552                                 bus->set_strict_io (true);
2553                         }
2554
2555                         BOOST_MARK_ROUTE(bus);
2556
2557                         {
2558                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2559
2560                                 if (bus->input()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2561                                         error << _("cannot configure new midi bus input") << endmsg;
2562                                         goto failure;
2563                                 }
2564
2565
2566                                 if (bus->output()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2567                                         error << _("cannot configure new midi bus output") << endmsg;
2568                                         goto failure;
2569                                 }
2570                         }
2571
2572                         if (route_group) {
2573                                 route_group->add (bus);
2574                         }
2575
2576                         ret.push_back (bus);
2577                 }
2578
2579                 catch (failed_constructor &err) {
2580                         error << _("Session: could not create new audio route.") << endmsg;
2581                         goto failure;
2582                 }
2583
2584                 catch (AudioEngine::PortRegistrationFailure& pfe) {
2585                         error << pfe.what() << endmsg;
2586                         goto failure;
2587                 }
2588
2589
2590                 --how_many;
2591         }
2592
2593   failure:
2594         if (!ret.empty()) {
2595                 StateProtector sp (this);
2596                 add_routes (ret, false, false, false, order);
2597
2598                 if (instrument) {
2599                         for (RouteList::iterator r = ret.begin(); r != ret.end(); ++r) {
2600                                 PluginPtr plugin = instrument->load (*this);
2601                                 if (pset) {
2602                                         plugin->load_preset (*pset);
2603                                 }
2604                                 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2605                                 (*r)->add_processor (p, PreFader);
2606                         }
2607                 }
2608         }
2609
2610         return ret;
2611
2612 }
2613
2614
2615 void
2616 Session::midi_output_change_handler (IOChange change, void * /*src*/, boost::weak_ptr<Route> wmt)
2617 {
2618         boost::shared_ptr<Route> midi_track (wmt.lock());
2619
2620         if (!midi_track) {
2621                 return;
2622         }
2623
2624         if ((change.type & IOChange::ConfigurationChanged) && Config->get_output_auto_connect() != ManualConnect) {
2625
2626                 if (change.after.n_audio() <= change.before.n_audio()) {
2627                         return;
2628                 }
2629
2630                 /* new audio ports: make sure the audio goes somewhere useful,
2631                  * unless the user has no-auto-connect selected.
2632                  *
2633                  * The existing ChanCounts don't matter for this call as they are only
2634                  * to do with matching input and output indices, and we are only changing
2635                  * outputs here.
2636                  */
2637                 auto_connect_route (midi_track, false, ChanCount(), change.before);
2638         }
2639 }
2640
2641 #ifdef USE_TRACKS_CODE_FEATURES
2642
2643 static bool
2644 compare_routes_by_remote_id (const boost::shared_ptr<Route>& route1, const boost::shared_ptr<Route>& route2)
2645 {
2646         return route1->remote_control_id() < route2->remote_control_id();
2647 }
2648
2649 void
2650 Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool reconnect_inputs, bool reconnect_outputs)
2651 {
2652         // it is not allowed to perform connection
2653         if (!IO::connecting_legal) {
2654                 return;
2655         }
2656
2657         // if we are deleting routes we will call this once at the end
2658         if (_route_deletion_in_progress) {
2659                 return;
2660         }
2661
2662         Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2663
2664         if (withLock) {
2665                 lm.acquire ();
2666         }
2667
2668         // We need to disconnect the route's inputs and outputs first
2669         // basing on autoconnect configuration
2670         bool reconnectIputs = !(Config->get_input_auto_connect() & ManualConnect) && reconnect_inputs;
2671         bool reconnectOutputs = !(Config->get_output_auto_connect() & ManualConnect) && reconnect_outputs;
2672
2673         ChanCount existing_inputs;
2674         ChanCount existing_outputs;
2675         count_existing_track_channels (existing_inputs, existing_outputs);
2676
2677         //ChanCount inputs = ChanCount::ZERO;
2678         //ChanCount outputs = ChanCount::ZERO;
2679
2680         RouteList existing_routes = *routes.reader ();
2681         existing_routes.sort (compare_routes_by_remote_id);
2682
2683         {
2684                 PBD::Unwinder<bool> protect_ignore_changes (_reconnecting_routes_in_progress, true);
2685
2686                 vector<string> physinputs;
2687                 vector<string> physoutputs;
2688
2689                 EngineStateController::instance()->get_physical_audio_outputs(physoutputs);
2690                 EngineStateController::instance()->get_physical_audio_inputs(physinputs);
2691
2692                 uint32_t input_n = 0;
2693                 uint32_t output_n = 0;
2694                 RouteList::iterator rIter = existing_routes.begin();
2695                 const AutoConnectOption current_input_auto_connection (Config->get_input_auto_connect());
2696                 const AutoConnectOption current_output_auto_connection (Config->get_output_auto_connect());
2697                 for (; rIter != existing_routes.end(); ++rIter) {
2698                         if (*rIter == _master_out || *rIter == _monitor_out ) {
2699                                 continue;
2700                         }
2701
2702                         if (current_output_auto_connection == AutoConnectPhysical) {
2703                                 (*rIter)->amp()->deactivate();
2704                         } else if (current_output_auto_connection == AutoConnectMaster) {
2705                                 (*rIter)->amp()->activate();
2706                         }
2707
2708                         if (reconnectIputs) {
2709                                 (*rIter)->input()->disconnect (this); //GZ: check this; could be heavy
2710
2711                                 for (uint32_t route_input_n = 0; route_input_n < (*rIter)->n_inputs().get(DataType::AUDIO); ++route_input_n) {
2712
2713                                         if (current_input_auto_connection & AutoConnectPhysical) {
2714
2715                                                 if ( input_n == physinputs.size() ) {
2716                                                         break;
2717                                                 }
2718
2719                                                 string port = physinputs[input_n];
2720
2721                                                 if (port.empty() ) {
2722                                                         error << "Physical Input number "<< input_n << " is unavailable and cannot be connected" << endmsg;
2723                                                 }
2724
2725                                                 //GZ: check this; could be heavy
2726                                                 (*rIter)->input()->connect ((*rIter)->input()->ports().port(DataType::AUDIO, route_input_n), port, this);
2727                                                 ++input_n;
2728                                         }
2729                                 }
2730                         }
2731
2732                         if (reconnectOutputs) {
2733
2734                                 //normalize route ouptuts: reduce the amount outputs to be equal to the amount of inputs
2735                                 if (current_output_auto_connection & AutoConnectPhysical) {
2736
2737                                         //GZ: check this; could be heavy
2738                                         (*rIter)->output()->disconnect (this);
2739                                         size_t route_inputs_count = (*rIter)->n_inputs().get(DataType::AUDIO);
2740
2741                                         //GZ: check this; could be heavy
2742                                         (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, route_inputs_count), false, this );
2743
2744                                 } else if (current_output_auto_connection & AutoConnectMaster){
2745
2746                                         if (!reconnect_master) {
2747                                                 continue;
2748                                         }
2749
2750                                         //GZ: check this; could be heavy
2751                                         (*rIter)->output()->disconnect (this);
2752
2753                                         if (_master_out) {
2754                                                 uint32_t master_inputs_count = _master_out->n_inputs().get(DataType::AUDIO);
2755                                                 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, master_inputs_count), false, this );
2756                                         } else {
2757                                                 error << error << "Master bus is not available" << endmsg;
2758                                                 break;
2759                                         }
2760                                 }
2761
2762                                 for (uint32_t route_output_n = 0; route_output_n < (*rIter)->n_outputs().get(DataType::AUDIO); ++route_output_n) {
2763                                         if (current_output_auto_connection & AutoConnectPhysical) {
2764
2765                                                 if ( output_n == physoutputs.size() ) {
2766                                                         break;
2767                                                 }
2768
2769                                                 string port = physoutputs[output_n];
2770
2771                                                 if (port.empty() ) {
2772                                                         error << "Physical Output number "<< output_n << " is unavailable and cannot be connected" << endmsg;
2773                                                 }
2774
2775                                                 //GZ: check this; could be heavy
2776                                                 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2777                                                 ++output_n;
2778
2779                                         } else if (current_output_auto_connection & AutoConnectMaster) {
2780
2781                                                 if ( route_output_n == _master_out->n_inputs().get(DataType::AUDIO) ) {
2782                                                         break;
2783                                                 }
2784
2785                                                 // connect to master bus
2786                                                 string port = _master_out->input()->ports().port(DataType::AUDIO, route_output_n)->name();
2787
2788                                                 if (port.empty() ) {
2789                                                         error << "MasterBus Input number "<< route_output_n << " is unavailable and cannot be connected" << endmsg;
2790                                                 }
2791
2792
2793                                                 //GZ: check this; could be heavy
2794                                                 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2795
2796                                         }
2797                                 }
2798                         }
2799                 }
2800
2801                 _master_out->output()->disconnect (this);
2802                 auto_connect_master_bus ();
2803         }
2804
2805         graph_reordered ();
2806
2807         session_routes_reconnected (); /* EMIT SIGNAL */
2808 }
2809
2810 void
2811 Session::reconnect_midi_scene_ports(bool inputs)
2812 {
2813     if (inputs ) {
2814
2815         boost::shared_ptr<MidiPort> scene_in_ptr = scene_in();
2816         if (scene_in_ptr) {
2817             scene_in_ptr->disconnect_all ();
2818
2819             std::vector<EngineStateController::MidiPortState> midi_port_states;
2820             EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2821
2822             std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2823
2824             for (; state_iter != midi_port_states.end(); ++state_iter) {
2825                 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2826                     scene_in_ptr->connect (state_iter->name);
2827                 }
2828             }
2829         }
2830
2831     } else {
2832
2833         boost::shared_ptr<MidiPort> scene_out_ptr = scene_out();
2834
2835         if (scene_out_ptr ) {
2836             scene_out_ptr->disconnect_all ();
2837
2838             std::vector<EngineStateController::MidiPortState> midi_port_states;
2839             EngineStateController::instance()->get_physical_midi_output_states (midi_port_states);
2840
2841             std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2842
2843             for (; state_iter != midi_port_states.end(); ++state_iter) {
2844                 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2845                     scene_out_ptr->connect (state_iter->name);
2846                 }
2847             }
2848         }
2849     }
2850 }
2851
2852 void
2853 Session::reconnect_mtc_ports ()
2854 {
2855         boost::shared_ptr<MidiPort> mtc_in_ptr = _midi_ports->mtc_input_port();
2856
2857         if (!mtc_in_ptr) {
2858                 return;
2859         }
2860
2861         mtc_in_ptr->disconnect_all ();
2862
2863         std::vector<EngineStateController::MidiPortState> midi_port_states;
2864         EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2865
2866         std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2867
2868         for (; state_iter != midi_port_states.end(); ++state_iter) {
2869                 if (state_iter->available && state_iter->mtc_in) {
2870                         mtc_in_ptr->connect (state_iter->name);
2871                 }
2872         }
2873
2874         if (!_midi_ports->mtc_input_port ()->connected () &&
2875             config.get_external_sync () &&
2876             (Config->get_sync_source () == MTC) ) {
2877                 config.set_external_sync (false);
2878         }
2879
2880         if ( ARDOUR::Profile->get_trx () ) {
2881                 // Tracks need this signal to update timecode_source_dropdown
2882                 MtcOrLtcInputPortChanged (); //emit signal
2883         }
2884 }
2885
2886 void
2887 Session::reconnect_mmc_ports(bool inputs)
2888 {
2889         if (inputs ) { // get all enabled midi input ports
2890
2891                 boost::shared_ptr<MidiPort> mmc_in_ptr = _midi_ports->mmc_in();
2892                 if (mmc_in_ptr) {
2893                         mmc_in_ptr->disconnect_all ();
2894                         std::vector<std::string> enabled_midi_inputs;
2895                         EngineStateController::instance()->get_physical_midi_inputs (enabled_midi_inputs);
2896
2897                         std::vector<std::string>::iterator port_iter = enabled_midi_inputs.begin();
2898
2899                         for (; port_iter != enabled_midi_inputs.end(); ++port_iter) {
2900                                 mmc_in_ptr->connect (*port_iter);
2901                         }
2902
2903                 }
2904         } else { // get all enabled midi output ports
2905
2906                 boost::shared_ptr<MidiPort> mmc_out_ptr = _midi_ports->mmc_out();
2907                 if (mmc_out_ptr ) {
2908                         mmc_out_ptr->disconnect_all ();
2909                         std::vector<std::string> enabled_midi_outputs;
2910                         EngineStateController::instance()->get_physical_midi_outputs (enabled_midi_outputs);
2911
2912                         std::vector<std::string>::iterator port_iter = enabled_midi_outputs.begin();
2913
2914                         for (; port_iter != enabled_midi_outputs.end(); ++port_iter) {
2915                                 mmc_out_ptr->connect (*port_iter);
2916                         }
2917                 }
2918         }
2919 }
2920
2921 #endif
2922
2923 void
2924 Session::ensure_presentation_info_gap (PresentationInfo::order_t first_new_order, uint32_t how_many)
2925 {
2926         if (first_new_order == PresentationInfo::max_order) {
2927                 /* adding at end, no worries */
2928                 return;
2929         }
2930
2931         /* create a gap in the existing route order keys to accomodate new routes.*/
2932         boost::shared_ptr <RouteList> rd = routes.reader();
2933         for (RouteList::iterator ri = rd->begin(); ri != rd->end(); ++ri) {
2934                 boost::shared_ptr<Route> rt (*ri);
2935
2936                 if (rt->presentation_info().special()) {
2937                         continue;
2938                 }
2939
2940                 if (rt->presentation_info().group_order () >= first_new_order) {
2941                         rt->set_presentation_group_order (rt->presentation_info().group_order () + how_many);
2942                 }
2943         }
2944 }
2945
2946 /** Caller must not hold process lock
2947  *  @param name_template string to use for the start of the name, or "" to use "Audio".
2948  */
2949 list< boost::shared_ptr<AudioTrack> >
2950 Session::new_audio_track (int input_channels, int output_channels, RouteGroup* route_group,
2951                           uint32_t how_many, string name_template, PresentationInfo::order_t order,
2952                           TrackMode mode)
2953 {
2954         string track_name;
2955         uint32_t track_id = 0;
2956         string port;
2957         RouteList new_routes;
2958         list<boost::shared_ptr<AudioTrack> > ret;
2959
2960         const string name_pattern = default_track_name_pattern (DataType::AUDIO);
2961         bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2962
2963         while (how_many) {
2964
2965                 if (!find_route_name (name_template.empty() ? _(name_pattern.c_str()) : name_template, ++track_id, track_name, use_number)) {
2966                         error << "cannot find name for new audio track" << endmsg;
2967                         goto failed;
2968                 }
2969
2970                 boost::shared_ptr<AudioTrack> track;
2971
2972                 try {
2973                         track.reset (new AudioTrack (*this, track_name, mode));
2974
2975                         if (track->init ()) {
2976                                 goto failed;
2977                         }
2978
2979                         if (Profile->get_mixbus ()) {
2980                                 track->set_strict_io (true);
2981                         }
2982
2983                         if (ARDOUR::Profile->get_trx ()) {
2984                                 // TRACKS considers it's not a USE CASE, it's
2985                                 // a piece of behavior of the session model:
2986                                 //
2987                                 // Gain for a newly created route depends on
2988                                 // the current output_auto_connect mode:
2989                                 //
2990                                 //  0 for Stereo Out mode
2991                                 //  0 Multi Out mode
2992                                 if (Config->get_output_auto_connect() & AutoConnectMaster) {
2993                                         track->gain_control()->set_value (dB_to_coefficient (0), Controllable::NoGroup);
2994                                 }
2995                         }
2996
2997                         track->use_new_diskstream();
2998
2999                         BOOST_MARK_TRACK (track);
3000
3001                         {
3002                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3003
3004                                 if (track->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3005                                         error << string_compose (
3006                                                 _("cannot configure %1 in/%2 out configuration for new audio track"),
3007                                                 input_channels, output_channels)
3008                                               << endmsg;
3009                                         goto failed;
3010                                 }
3011
3012                                 if (track->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3013                                         error << string_compose (
3014                                                 _("cannot configure %1 in/%2 out configuration for new audio track"),
3015                                                 input_channels, output_channels)
3016                                               << endmsg;
3017                                         goto failed;
3018                                 }
3019                         }
3020
3021                         if (route_group) {
3022                                 route_group->add (track);
3023                         }
3024
3025                         track->non_realtime_input_change();
3026
3027                         track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
3028
3029                         new_routes.push_back (track);
3030                         ret.push_back (track);
3031                 }
3032
3033                 catch (failed_constructor &err) {
3034                         error << _("Session: could not create new audio track.") << endmsg;
3035                         goto failed;
3036                 }
3037
3038                 catch (AudioEngine::PortRegistrationFailure& pfe) {
3039
3040                         error << pfe.what() << endmsg;
3041                         goto failed;
3042                 }
3043
3044                 --how_many;
3045         }
3046
3047   failed:
3048         if (!new_routes.empty()) {
3049                 StateProtector sp (this);
3050                 if (Profile->get_trx()) {
3051                         add_routes (new_routes, false, false, false, order);
3052                 } else {
3053                         add_routes (new_routes, true, true, false, order);
3054                 }
3055         }
3056
3057         return ret;
3058 }
3059
3060 /** Caller must not hold process lock.
3061  *  @param name_template string to use for the start of the name, or "" to use "Bus".
3062  */
3063 RouteList
3064 Session::new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, string name_template,
3065                           PresentationInfo::Flag flags, PresentationInfo::order_t order)
3066 {
3067         string bus_name;
3068         uint32_t bus_id = 0;
3069         string port;
3070         RouteList ret;
3071
3072         bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
3073
3074         ensure_presentation_info_gap (order, how_many);
3075
3076         while (how_many) {
3077                 if (!find_route_name (name_template.empty () ? _("Bus") : name_template, ++bus_id, bus_name, use_number)) {
3078                         error << "cannot find name for new audio bus" << endmsg;
3079                         goto failure;
3080                 }
3081
3082                 try {
3083                         boost::shared_ptr<Route> bus (new Route (*this, bus_name, flags, DataType::AUDIO));
3084
3085                         if (bus->init ()) {
3086                                 goto failure;
3087                         }
3088
3089                         if (Profile->get_mixbus ()) {
3090                                 bus->set_strict_io (true);
3091                         }
3092
3093                         BOOST_MARK_ROUTE(bus);
3094
3095                         {
3096                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3097
3098                                 if (bus->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3099                                         error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3100                                                                  input_channels, output_channels)
3101                                               << endmsg;
3102                                         goto failure;
3103                                 }
3104
3105
3106                                 if (bus->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3107                                         error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3108                                                                  input_channels, output_channels)
3109                                               << endmsg;
3110                                         goto failure;
3111                                 }
3112                         }
3113
3114                         if (route_group) {
3115                                 route_group->add (bus);
3116                         }
3117
3118                         bus->add_internal_return ();
3119                         ret.push_back (bus);
3120                 }
3121
3122                 catch (failed_constructor &err) {
3123                         error << _("Session: could not create new audio route.") << endmsg;
3124                         goto failure;
3125                 }
3126
3127                 catch (AudioEngine::PortRegistrationFailure& pfe) {
3128                         error << pfe.what() << endmsg;
3129                         goto failure;
3130                 }
3131
3132
3133                 --how_many;
3134         }
3135
3136   failure:
3137         if (!ret.empty()) {
3138                 StateProtector sp (this);
3139                 if (Profile->get_trx()) {
3140                         add_routes (ret, false, false, false, order);
3141                 } else {
3142                         add_routes (ret, false, true, true, order); // autoconnect // outputs only
3143                 }
3144         }
3145
3146         return ret;
3147
3148 }
3149
3150 RouteList
3151 Session::new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name_base, PlaylistDisposition pd)
3152 {
3153         XMLTree tree;
3154
3155         if (!tree.read (template_path.c_str())) {
3156                 return RouteList();
3157         }
3158
3159         return new_route_from_template (how_many, *tree.root(), name_base, pd);
3160 }
3161
3162 RouteList
3163 Session::new_route_from_template (uint32_t how_many, XMLNode& node, const std::string& name_base, PlaylistDisposition pd)
3164 {
3165         RouteList ret;
3166         uint32_t number = 0;
3167         const uint32_t being_added = how_many;
3168         /* This will prevent the use of any existing XML-provided PBD::ID
3169            values by Stateful.
3170         */
3171         Stateful::ForceIDRegeneration force_ids;
3172         IO::disable_connecting ();
3173
3174         while (how_many) {
3175
3176                 /* We're going to modify the node contents a bit so take a
3177                  * copy. The node may be re-used when duplicating more than once.
3178                  */
3179
3180                 XMLNode node_copy (node);
3181
3182                 try {
3183                         string name;
3184
3185                         if (!name_base.empty()) {
3186
3187                                 /* if we're adding more than one routes, force
3188                                  * all the names of the new routes to be
3189                                  * numbered, via the final parameter.
3190                                  */
3191
3192                                 if (!find_route_name (name_base.c_str(), ++number, name, (being_added > 1))) {
3193                                         fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3194                                         /*NOTREACHDE*/
3195                                 }
3196
3197                         } else {
3198
3199                                 string const route_name  = node_copy.property(X_("name"))->value ();
3200
3201                                 /* generate a new name by adding a number to the end of the template name */
3202                                 if (!find_route_name (route_name.c_str(), ++number, name, true)) {
3203                                         fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3204                                         abort(); /*NOTREACHED*/
3205                                 }
3206                         }
3207
3208                         /* set this name in the XML description that we are about to use */
3209
3210                         bool rename_playlist;
3211                         switch (pd) {
3212                         case NewPlaylist:
3213                                 rename_playlist = true;
3214                                 break;
3215                         default:
3216                         case CopyPlaylist:
3217                         case SharePlaylist:
3218                                 rename_playlist = false;
3219                         }
3220
3221                         Route::set_name_in_state (node_copy, name, rename_playlist);
3222
3223                         /* trim bitslots from listen sends so that new ones are used */
3224                         XMLNodeList children = node_copy.children ();
3225                         for (XMLNodeList::iterator i = children.begin(); i != children.end(); ++i) {
3226                                 if ((*i)->name() == X_("Processor")) {
3227                                         /* ForceIDRegeneration does not catch the following */
3228                                         XMLProperty const * role = (*i)->property (X_("role"));
3229                                         XMLProperty const * type = (*i)->property (X_("type"));
3230                                         if (role && role->value() == X_("Aux")) {
3231                                                 /* check if the target bus exists.
3232                                                  * we should not save aux-sends in templates.
3233                                                  */
3234                                                 XMLProperty const * target = (*i)->property (X_("target"));
3235                                                 if (!target) {
3236                                                         (*i)->add_property ("type", "dangling-aux-send");
3237                                                         continue;
3238                                                 }
3239                                                 boost::shared_ptr<Route> r = route_by_id (target->value());
3240                                                 if (!r || boost::dynamic_pointer_cast<Track>(r)) {
3241                                                         (*i)->add_property ("type", "dangling-aux-send");
3242                                                         continue;
3243                                                 }
3244                                         }
3245                                         if (role && role->value() == X_("Listen")) {
3246                                                 (*i)->remove_property (X_("bitslot"));
3247                                         }
3248                                         else if (role && (role->value() == X_("Send") || role->value() == X_("Aux"))) {
3249                                                 char buf[32];
3250                                                 Delivery::Role xrole;
3251                                                 uint32_t bitslot = 0;
3252                                                 xrole = Delivery::Role (string_2_enum (role->value(), xrole));
3253                                                 std::string name = Send::name_and_id_new_send(*this, xrole, bitslot, false);
3254                                                 snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
3255                                                 (*i)->remove_property (X_("bitslot"));
3256                                                 (*i)->remove_property (X_("name"));
3257                                                 (*i)->add_property ("bitslot", buf);
3258                                                 (*i)->add_property ("name", name);
3259                                         }
3260                                         else if (type && type->value() == X_("return")) {
3261                                                 // Return::set_state() generates a new one
3262                                                 (*i)->remove_property (X_("bitslot"));
3263                                         }
3264                                         else if (type && type->value() == X_("port")) {
3265                                                 // PortInsert::set_state() handles the bitslot
3266                                                 (*i)->remove_property (X_("bitslot"));
3267                                                 (*i)->add_property ("ignore-name", "1");
3268                                         }
3269                                 }
3270                         }
3271
3272                         boost::shared_ptr<Route> route (XMLRouteFactory (node_copy, 3000));
3273
3274                         if (route == 0) {
3275                                 error << _("Session: cannot create track/bus from template description") << endmsg;
3276                                 goto out;
3277                         }
3278
3279                         if (boost::dynamic_pointer_cast<Track>(route)) {
3280                                 /* force input/output change signals so that the new diskstream
3281                                    picks up the configuration of the route. During session
3282                                    loading this normally happens in a different way.
3283                                 */
3284
3285                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3286
3287                                 IOChange change (IOChange::Type (IOChange::ConfigurationChanged | IOChange::ConnectionsChanged));
3288                                 change.after = route->input()->n_ports();
3289                                 route->input()->changed (change, this);
3290                                 change.after = route->output()->n_ports();
3291                                 route->output()->changed (change, this);
3292                         }
3293
3294                         boost::shared_ptr<Track> track;
3295
3296                         if ((track = boost::dynamic_pointer_cast<Track> (route))) {
3297                                 switch (pd) {
3298                                 case NewPlaylist:
3299                                         track->use_new_playlist ();
3300                                         break;
3301                                 case CopyPlaylist:
3302                                         track->use_copy_playlist ();
3303                                         break;
3304                                 case SharePlaylist:
3305                                         break;
3306                                 }
3307                         };
3308
3309                         ret.push_back (route);
3310                 }
3311
3312                 catch (failed_constructor &err) {
3313                         error << _("Session: could not create new route from template") << endmsg;
3314                         goto out;
3315                 }
3316
3317                 catch (AudioEngine::PortRegistrationFailure& pfe) {
3318                         error << pfe.what() << endmsg;
3319                         goto out;
3320                 }
3321
3322                 --how_many;
3323         }
3324
3325   out:
3326         if (!ret.empty()) {
3327                 StateProtector sp (this);
3328                 if (Profile->get_trx()) {
3329                         add_routes (ret, false, false, false, PresentationInfo::max_order);
3330                 } else {
3331                         add_routes (ret, true, true, false, PresentationInfo::max_order);
3332                 }
3333                 IO::enable_connecting ();
3334         }
3335
3336         return ret;
3337 }
3338
3339 void
3340 Session::add_routes (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t order)
3341 {
3342         try {
3343                 PBD::Unwinder<bool> aip (_adding_routes_in_progress, true);
3344                 add_routes_inner (new_routes, input_auto_connect, output_auto_connect, order);
3345
3346         } catch (...) {
3347                 error << _("Adding new tracks/busses failed") << endmsg;
3348         }
3349
3350         graph_reordered ();
3351
3352         update_latency (true);
3353         update_latency (false);
3354
3355         set_dirty();
3356
3357         if (save) {
3358                 save_state (_current_snapshot_name);
3359         }
3360
3361         update_route_record_state ();
3362
3363         RouteAdded (new_routes); /* EMIT SIGNAL */
3364 }
3365
3366 void
3367 Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t order)
3368 {
3369         ChanCount existing_inputs;
3370         ChanCount existing_outputs;
3371         uint32_t n_routes;
3372         uint32_t added = 0;
3373
3374         count_existing_track_channels (existing_inputs, existing_outputs);
3375
3376         {
3377                 RCUWriter<RouteList> writer (routes);
3378                 boost::shared_ptr<RouteList> r = writer.get_copy ();
3379                 r->insert (r->end(), new_routes.begin(), new_routes.end());
3380                 n_routes = r->size();
3381
3382                 /* if there is no control out and we're not in the middle of loading,
3383                  * resort the graph here. if there is a control out, we will resort
3384                  * toward the end of this method. if we are in the middle of loading,
3385                  * we will resort when done.
3386                  */
3387
3388                 if (!_monitor_out && IO::connecting_legal) {
3389                         resort_routes_using (r);
3390                 }
3391         }
3392
3393         DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("ensure order gap starting at %1 for %2\n", order, new_routes.size()));
3394         ensure_presentation_info_gap (order, new_routes.size());
3395
3396         for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x, ++added) {
3397
3398                 boost::weak_ptr<Route> wpr (*x);
3399                 boost::shared_ptr<Route> r (*x);
3400
3401                 r->solo_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_changed, this, _1, _2,wpr));
3402                 r->solo_isolate_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, wpr));
3403                 r->mute_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this));
3404
3405                 r->output()->changed.connect_same_thread (*this, boost::bind (&Session::set_worst_io_latencies_x, this, _1, _2));
3406                 r->processors_changed.connect_same_thread (*this, boost::bind (&Session::route_processors_changed, this, _1));
3407
3408                 if (r->is_master()) {
3409                         _master_out = r;
3410                 }
3411
3412                 if (r->is_monitor()) {
3413                         _monitor_out = r;
3414                 }
3415
3416                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (r);
3417                 if (tr) {
3418                         tr->PlaylistChanged.connect_same_thread (*this, boost::bind (&Session::track_playlist_changed, this, boost::weak_ptr<Track> (tr)));
3419                         track_playlist_changed (boost::weak_ptr<Track> (tr));
3420                         tr->rec_enable_control()->Changed.connect_same_thread (*this, boost::bind (&Session::update_route_record_state, this));
3421
3422                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (tr);
3423                         if (mt) {
3424                                 mt->StepEditStatusChange.connect_same_thread (*this, boost::bind (&Session::step_edit_status_change, this, _1));
3425                                 mt->output()->changed.connect_same_thread (*this, boost::bind (&Session::midi_output_change_handler, this, _1, _2, boost::weak_ptr<Route>(mt)));
3426                         }
3427                 }
3428
3429                 if (!r->presentation_info().special()) {
3430
3431                         DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("checking PI state for %1\n", r->name()));
3432
3433                         /* presentation info order may already have been set from XML */
3434
3435                         if (r->presentation_info().unordered()) {
3436
3437                                 if (order == PresentationInfo::max_order) {
3438                                         /* just add to the end */
3439                                         r->set_presentation_group_order_explicit (n_routes + added);
3440                                         DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to NR %1 + %2 = %3\n", n_routes, added, n_routes + added));
3441                                 } else {
3442                                         r->set_presentation_group_order_explicit (order + added);
3443                                         DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to %1 + %2 = %3\n", order, added, order + added));
3444                                 }
3445                         } else {
3446                                 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order already set to %1\n", r->presentation_info().group_order()));
3447                         }
3448                 }
3449
3450                 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("added route %1, group order %2 global order %3 type %4 (summary: %5)\n",
3451                                                                r->name(),
3452                                                                r->presentation_info().group_order(),
3453                                                                r->presentation_info().global_order(),
3454                                                                enum_2_string (r->presentation_info().flags()),
3455                                                                r->presentation_info().to_string()));
3456
3457
3458                 if (input_auto_connect || output_auto_connect) {
3459                         auto_connect_route (r, input_auto_connect, ChanCount (), ChanCount (), existing_inputs, existing_outputs);
3460                         existing_inputs += r->n_inputs();
3461                         existing_outputs += r->n_outputs();
3462                 }
3463
3464                 ARDOUR::GUIIdle ();
3465         }
3466
3467         if (_monitor_out && IO::connecting_legal) {
3468                 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
3469
3470                 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3471                         if ((*x)->is_monitor()) {
3472                                 /* relax */
3473                         } else if ((*x)->is_master()) {
3474                                 /* relax */
3475                         } else {
3476                                 (*x)->enable_monitor_send ();
3477                         }
3478                 }
3479         }
3480 }
3481
3482 void
3483 Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
3484 {
3485         boost::shared_ptr<RouteList> r = routes.reader ();
3486         boost::shared_ptr<Send> s;
3487
3488         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3489                 if ((s = (*i)->internal_send_for (dest)) != 0) {
3490                         s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO, Controllable::NoGroup);
3491                 }
3492         }
3493 }
3494
3495 void
3496 Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
3497 {
3498         boost::shared_ptr<RouteList> r = routes.reader ();
3499         boost::shared_ptr<Send> s;
3500
3501         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3502                 if ((s = (*i)->internal_send_for (dest)) != 0) {
3503                         s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
3504                 }
3505         }
3506 }
3507
3508 void
3509 Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
3510 {
3511         boost::shared_ptr<RouteList> r = routes.reader ();
3512         boost::shared_ptr<Send> s;
3513
3514         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3515                 if ((s = (*i)->internal_send_for (dest)) != 0) {
3516                         s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value(), Controllable::NoGroup);
3517                 }
3518         }
3519 }
3520
3521 /** @param include_buses true to add sends to buses and tracks, false for just tracks */
3522 void
3523 Session::globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool include_buses)
3524 {
3525         boost::shared_ptr<RouteList> r = routes.reader ();
3526         boost::shared_ptr<RouteList> t (new RouteList);
3527
3528         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3529                 /* no MIDI sends because there are no MIDI busses yet */
3530                 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(*i)) {
3531                         t->push_back (*i);
3532                 }
3533         }
3534
3535         add_internal_sends (dest, p, t);
3536 }
3537
3538 void
3539 Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders)
3540 {
3541         for (RouteList::iterator i = senders->begin(); i != senders->end(); ++i) {
3542                 add_internal_send (dest, (*i)->before_processor_for_placement (p), *i);
3543         }
3544 }
3545
3546 void
3547 Session::add_internal_send (boost::shared_ptr<Route> dest, int index, boost::shared_ptr<Route> sender)
3548 {
3549         add_internal_send (dest, sender->before_processor_for_index (index), sender);
3550 }
3551
3552 void
3553 Session::add_internal_send (boost::shared_ptr<Route> dest, boost::shared_ptr<Processor> before, boost::shared_ptr<Route> sender)
3554 {
3555         if (sender->is_monitor() || sender->is_master() || sender == dest || dest->is_monitor() || dest->is_master()) {
3556                 return;
3557         }
3558
3559         if (!dest->internal_return()) {
3560                 dest->add_internal_return ();
3561         }
3562
3563         sender->add_aux_send (dest, before);
3564
3565         graph_reordered ();
3566 }
3567
3568 void
3569 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
3570 {
3571         { // RCU Writer scope
3572                 PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
3573                 RCUWriter<RouteList> writer (routes);
3574                 boost::shared_ptr<RouteList> rs = writer.get_copy ();
3575
3576
3577                 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3578
3579                         if (*iter == _master_out) {
3580                                 continue;
3581                         }
3582
3583                         (*iter)->solo_control()->set_value (0.0, Controllable::NoGroup);
3584
3585                         rs->remove (*iter);
3586
3587                         /* deleting the master out seems like a dumb
3588                            idea, but its more of a UI policy issue
3589                            than our concern.
3590                         */
3591
3592                         if (*iter == _master_out) {
3593                                 _master_out = boost::shared_ptr<Route> ();
3594                         }
3595
3596                         if (*iter == _monitor_out) {
3597                                 _monitor_out.reset ();
3598                         }
3599
3600                         // We need to disconnect the route's inputs and outputs
3601
3602                         (*iter)->input()->disconnect (0);
3603                         (*iter)->output()->disconnect (0);
3604
3605                         /* if the route had internal sends sending to it, remove them */
3606                         if ((*iter)->internal_return()) {
3607
3608                                 boost::shared_ptr<RouteList> r = routes.reader ();
3609                                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3610                                         boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
3611                                         if (s) {
3612                                                 (*i)->remove_processor (s);
3613                                         }
3614                                 }
3615                         }
3616
3617                         /* if the monitoring section had a pointer to this route, remove it */
3618                         if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
3619                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3620                                 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
3621                                 (*iter)->remove_aux_or_listen (_monitor_out);
3622                         }
3623
3624                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
3625                         if (mt && mt->step_editing()) {
3626                                 if (_step_editors > 0) {
3627                                         _step_editors--;
3628                                 }
3629                         }
3630                 }
3631
3632                 /* writer goes out of scope, forces route list update */
3633
3634         } // end of RCU Writer scope
3635
3636         update_route_solo_state ();
3637         update_latency_compensation ();
3638         set_dirty();
3639
3640         /* Re-sort routes to remove the graph's current references to the one that is
3641          * going away, then flush old references out of the graph.
3642          * Wave Tracks: reconnect routes
3643          */
3644
3645 #ifdef USE_TRACKS_CODE_FEATURES
3646                 reconnect_existing_routes(true, false);
3647 #else
3648                 routes.flush (); // maybe unsafe, see below.
3649                 resort_routes ();
3650 #endif
3651
3652         if (_process_graph && !(_state_of_the_state & Deletion)) {
3653                 _process_graph->clear_other_chain ();
3654         }
3655
3656         /* get rid of it from the dead wood collection in the route list manager */
3657         /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
3658
3659         routes.flush ();
3660
3661         /* try to cause everyone to drop their references
3662          * and unregister ports from the backend
3663          */
3664
3665         for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3666                 (*iter)->drop_references ();
3667         }
3668
3669         if (_state_of_the_state & Deletion) {
3670                 return;
3671         }
3672
3673         Stripable::PresentationInfoChange(); /* EMIT SIGNAL */
3674
3675         /* save the new state of the world */
3676
3677         if (save_state (_current_snapshot_name)) {
3678                 save_history (_current_snapshot_name);
3679         }
3680
3681         update_route_record_state ();
3682 }
3683
3684 void
3685 Session::remove_route (boost::shared_ptr<Route> route)
3686 {
3687         boost::shared_ptr<RouteList> rl (new RouteList);
3688         rl->push_back (route);
3689         remove_routes (rl);
3690 }
3691
3692 void
3693 Session::route_mute_changed ()
3694 {
3695         set_dirty ();
3696 }
3697
3698 void
3699 Session::route_listen_changed (Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3700 {
3701         boost::shared_ptr<Route> route (wpr.lock());
3702
3703         if (!route) {
3704                 return;
3705         }
3706
3707         assert (Config->get_solo_control_is_listen_control());
3708
3709         if (route->solo_control()->soloed_by_self_or_masters()) {
3710
3711                 if (Config->get_exclusive_solo()) {
3712
3713                         RouteGroup* rg = route->route_group ();
3714                         const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3715
3716                         boost::shared_ptr<RouteList> r = routes.reader ();
3717
3718                         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3719                                 if ((*i) == route) {
3720                                         /* already changed */
3721                                         continue;
3722                                 }
3723
3724                                 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3725                                         /* route does not get solo propagated to it */
3726                                         continue;
3727                                 }
3728
3729                                 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3730                                         /* this route is a part of the same solo group as the route
3731                                          * that was changed. Changing that route did change or will
3732                                          * change all group members appropriately, so we can ignore it
3733                                          * here
3734                                          */
3735                                         continue;
3736                                 }
3737                                 (*i)->solo_control()->set_value (0.0, Controllable::NoGroup);
3738                         }
3739                 }
3740
3741                 _listen_cnt++;
3742
3743         } else if (_listen_cnt > 0) {
3744
3745                 _listen_cnt--;
3746         }
3747
3748         update_route_solo_state ();
3749 }
3750
3751 void
3752 Session::route_solo_isolated_changed (boost::weak_ptr<Route> wpr)
3753 {
3754         boost::shared_ptr<Route> route (wpr.lock());
3755
3756         if (!route) {
3757                 return;
3758         }
3759
3760         bool send_changed = false;
3761
3762         if (route->solo_isolate_control()->solo_isolated()) {
3763                 if (_solo_isolated_cnt == 0) {
3764                         send_changed = true;
3765                 }
3766                 _solo_isolated_cnt++;
3767         } else if (_solo_isolated_cnt > 0) {
3768                 _solo_isolated_cnt--;
3769                 if (_solo_isolated_cnt == 0) {
3770                         send_changed = true;
3771                 }
3772         }
3773
3774         if (send_changed) {
3775                 IsolatedChanged (); /* EMIT SIGNAL */
3776         }
3777 }
3778
3779 void
3780 Session::route_solo_changed (bool self_solo_changed, Controllable::GroupControlDisposition group_override,  boost::weak_ptr<Route> wpr)
3781 {
3782         DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1\n", self_solo_changed));
3783
3784         boost::shared_ptr<Route> route (wpr.lock());
3785
3786         if (!route) {
3787                 return;
3788         }
3789
3790         if (Config->get_solo_control_is_listen_control()) {
3791                 route_listen_changed (group_override, wpr);
3792                 return;
3793         }
3794
3795         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()));
3796
3797         if (route->solo_control()->transitioned_into_solo() == 0) {
3798                 /* route solo changed by upstream/downstream; not interesting
3799                    to Session.
3800                 */
3801                 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()));
3802                 return;
3803         }
3804
3805         if (route->solo_control()->transitioned_into_solo() == 0) {
3806                 /* reason for being soloed changed (e.g. master went away, we
3807                  * took over the master state), but actual status did
3808                  * not. nothing to do.
3809                  */
3810                 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: solo change was change in reason, not status\n", route->name()));
3811         }
3812
3813         boost::shared_ptr<RouteList> r = routes.reader ();
3814         int32_t delta = route->solo_control()->transitioned_into_solo ();
3815
3816         /* the route may be a member of a group that has shared-solo
3817          * semantics. If so, then all members of that group should follow the
3818          * solo of the changed route. But ... this is optional, controlled by a
3819          * Controllable::GroupControlDisposition.
3820          *
3821          * The first argument to the signal that this method is connected to is the
3822          * GroupControlDisposition value that was used to change solo.
3823          *
3824          * If the solo change was done with group semantics (either InverseGroup
3825          * (force the entire group to change even if the group shared solo is
3826          * disabled) or UseGroup (use the group, which may or may not have the
3827          * shared solo property enabled)) then as we propagate the change to
3828          * the entire session we should IGNORE THE GROUP that the changed route
3829          * belongs to.
3830          */
3831
3832         RouteGroup* rg = route->route_group ();
3833         const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3834
3835         if (delta == 1 && Config->get_exclusive_solo()) {
3836
3837                 /* new solo: disable all other solos, but not the group if its solo-enabled */
3838
3839                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3840
3841                         if ((*i) == route) {
3842                                 /* already changed */
3843                                 continue;
3844                         }
3845
3846                         if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3847                                 /* route does not get solo propagated to it */
3848                                 continue;
3849                         }
3850
3851                         if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3852                                 /* this route is a part of the same solo group as the route
3853                                  * that was changed. Changing that route did change or will
3854                                  * change all group members appropriately, so we can ignore it
3855                                  * here
3856                                  */
3857                                 continue;
3858                         }
3859
3860                         (*i)->solo_control()->set_value (0.0, group_override);
3861                 }
3862         }
3863
3864         DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
3865
3866         RouteList uninvolved;
3867
3868         DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
3869
3870         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3871                 bool via_sends_only;
3872                 bool in_signal_flow;
3873
3874                 if ((*i) == route) {
3875                         /* already changed */
3876                         continue;
3877                 }
3878
3879                 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3880                         /* route does not get solo propagated to it */
3881                         continue;
3882                 }
3883
3884                 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3885                         /* this route is a part of the same solo group as the route
3886                          * that was changed. Changing that route did change or will
3887                          * change all group members appropriately, so we can ignore it
3888                          * here
3889                          */
3890                         continue;
3891                 }
3892
3893                 in_signal_flow = false;
3894
3895                 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
3896
3897                 if ((*i)->feeds (route, &via_sends_only)) {
3898                         DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
3899                         if (!via_sends_only) {
3900                                 if (!route->soloed_by_others_upstream()) {
3901                                         (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3902                                 } else {
3903                                         DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others upstream\n");
3904                                 }
3905                         } else {
3906                                 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
3907                         }
3908                         in_signal_flow = true;
3909                 } else {
3910                         DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
3911                 }
3912
3913                 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
3914
3915                 if (route->feeds (*i, &via_sends_only)) {
3916                         /* propagate solo upstream only if routing other than
3917                            sends is involved, but do consider the other route
3918                            (*i) to be part of the signal flow even if only
3919                            sends are involved.
3920                         */
3921                         DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 feeds %2 via sends only %3 sboD %4 sboU %5\n",
3922                                                                   route->name(),
3923                                                                   (*i)->name(),
3924                                                                   via_sends_only,
3925                                                                   route->soloed_by_others_downstream(),
3926                                                                   route->soloed_by_others_upstream()));
3927                         if (!via_sends_only) {
3928                                 //NB. Triggers Invert Push, which handles soloed by downstream
3929                                 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
3930                                 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3931                         } else {
3932                                 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
3933                         }
3934                         in_signal_flow = true;
3935                 } else {
3936                         DEBUG_TRACE (DEBUG::Solo, "\tno feed to\n");
3937                 }
3938
3939                 if (!in_signal_flow) {
3940                         uninvolved.push_back (*i);
3941                 }
3942         }
3943
3944         DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
3945
3946         update_route_solo_state (r);
3947
3948         /* now notify that the mute state of the routes not involved in the signal
3949            pathway of the just-solo-changed route may have altered.
3950         */
3951
3952         for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
3953                 DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1, which neither feeds or is fed by %2\n", (*i)->name(), route->name()));
3954                 (*i)->act_on_mute ();
3955                 (*i)->mute_control()->Changed (false, Controllable::NoGroup);
3956         }
3957
3958         SoloChanged (); /* EMIT SIGNAL */
3959         set_dirty();
3960 }
3961
3962 void
3963 Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
3964 {
3965         /* now figure out if anything that matters is soloed (or is "listening")*/
3966
3967         bool something_soloed = false;
3968         bool something_listening = false;
3969         uint32_t listeners = 0;
3970         uint32_t isolated = 0;
3971
3972         if (!r) {
3973                 r = routes.reader();
3974         }
3975
3976         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3977                 if ((*i)->can_solo()) {
3978                         if (Config->get_solo_control_is_listen_control()) {
3979                                 if ((*i)->self_soloed() || (*i)->solo_control()->get_masters_value()) {
3980                                         listeners++;
3981                                         something_listening = true;
3982                                 }
3983                         } else {
3984                                 (*i)->set_listen (false);
3985                                 if ((*i)->can_solo() && ((*i)->self_soloed() || (*i)->solo_control()->get_masters_value())) {
3986                                         something_soloed = true;
3987                                 }
3988                         }
3989                 }
3990
3991                 if ((*i)->solo_isolate_control()->solo_isolated()) {
3992                         isolated++;
3993                 }
3994         }
3995
3996         if (something_soloed != _non_soloed_outs_muted) {
3997                 _non_soloed_outs_muted = something_soloed;
3998                 SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
3999         }
4000
4001         if (something_listening != _listening) {
4002                 _listening = something_listening;
4003                 SoloActive (_listening);
4004         }
4005
4006         _listen_cnt = listeners;
4007
4008         if (isolated != _solo_isolated_cnt) {
4009                 _solo_isolated_cnt = isolated;
4010                 IsolatedChanged (); /* EMIT SIGNAL */
4011         }
4012
4013         DEBUG_TRACE (DEBUG::Solo, string_compose ("solo state updated by session, soloed? %1 listeners %2 isolated %3\n",
4014                                                   something_soloed, listeners, isolated));
4015 }
4016
4017 void
4018 Session::get_stripables (StripableList& sl) const
4019 {
4020         boost::shared_ptr<RouteList> r = routes.reader ();
4021         sl.insert (sl.end(), r->begin(), r->end());
4022
4023         VCAList v = _vca_manager->vcas ();
4024         sl.insert (sl.end(), v.begin(), v.end());
4025 }
4026
4027 boost::shared_ptr<RouteList>
4028 Session::get_routes_with_internal_returns() const
4029 {
4030         boost::shared_ptr<RouteList> r = routes.reader ();
4031         boost::shared_ptr<RouteList> rl (new RouteList);
4032
4033         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4034                 if ((*i)->internal_return ()) {
4035                         rl->push_back (*i);
4036                 }
4037         }
4038         return rl;
4039 }
4040
4041 bool
4042 Session::io_name_is_legal (const std::string& name) const
4043 {
4044         boost::shared_ptr<RouteList> r = routes.reader ();
4045
4046         for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
4047                 if (name == *reserved) {
4048                         if (!route_by_name (*reserved)) {
4049                                 /* first instance of a reserved name is allowed */
4050                                 return true;
4051                         }
4052                         /* all other instances of a reserved name are not allowed */
4053                         return false;
4054                 }
4055         }
4056
4057         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4058                 if ((*i)->name() == name) {
4059                         return false;
4060                 }
4061
4062                 if ((*i)->has_io_processor_named (name)) {
4063                         return false;
4064                 }
4065         }
4066
4067         return true;
4068 }
4069
4070 void
4071 Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff, bool flip_others)
4072 {
4073         RouteList rl2;
4074         vector<string> connections;
4075
4076         /* if we are passed only a single route and we're not told to turn
4077          * others off, then just do the simple thing.
4078          */
4079
4080         if (flip_others == false && rl->size() == 1) {
4081                 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (rl->front());
4082                 if (mt) {
4083                         mt->set_input_active (onoff);
4084                         return;
4085                 }
4086         }
4087
4088         for (RouteList::iterator rt = rl->begin(); rt != rl->end(); ++rt) {
4089
4090                 PortSet& ps ((*rt)->input()->ports());
4091
4092                 for (PortSet::iterator p = ps.begin(); p != ps.end(); ++p) {
4093                         p->get_connections (connections);
4094                 }
4095
4096                 for (vector<string>::iterator s = connections.begin(); s != connections.end(); ++s) {
4097                         routes_using_input_from (*s, rl2);
4098                 }
4099
4100                 /* scan all relevant routes to see if others are on or off */
4101
4102                 bool others_are_already_on = false;
4103
4104                 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4105
4106                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4107
4108                         if (!mt) {
4109                                 continue;
4110                         }
4111
4112                         if ((*r) != (*rt)) {
4113                                 if (mt->input_active()) {
4114                                         others_are_already_on = true;
4115                                 }
4116                         } else {
4117                                 /* this one needs changing */
4118                                 mt->set_input_active (onoff);
4119                         }
4120                 }
4121
4122                 if (flip_others) {
4123
4124                         /* globally reverse other routes */
4125
4126                         for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4127                                 if ((*r) != (*rt)) {
4128                                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4129                                         if (mt) {
4130                                                 mt->set_input_active (!others_are_already_on);
4131                                         }
4132                                 }
4133                         }
4134                 }
4135         }
4136 }
4137
4138 void
4139 Session::routes_using_input_from (const string& str, RouteList& rl)
4140 {
4141         boost::shared_ptr<RouteList> r = routes.reader();
4142
4143         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4144                 if ((*i)->input()->connected_to (str)) {
4145                         rl.push_back (*i);
4146                 }
4147         }
4148 }
4149
4150 boost::shared_ptr<Route>
4151 Session::route_by_name (string name) const
4152 {
4153         boost::shared_ptr<RouteList> r = routes.reader ();
4154
4155         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4156                 if ((*i)->name() == name) {
4157                         return *i;
4158                 }
4159         }
4160
4161         return boost::shared_ptr<Route> ((Route*) 0);
4162 }
4163
4164 boost::shared_ptr<Route>
4165 Session::route_by_id (PBD::ID id) const
4166 {
4167         boost::shared_ptr<RouteList> r = routes.reader ();
4168
4169         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4170                 if ((*i)->id() == id) {
4171                         return *i;
4172                 }
4173         }
4174
4175         return boost::shared_ptr<Route> ((Route*) 0);
4176 }
4177
4178 boost::shared_ptr<Processor>
4179 Session::processor_by_id (PBD::ID id) const
4180 {
4181         boost::shared_ptr<RouteList> r = routes.reader ();
4182
4183         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4184                 boost::shared_ptr<Processor> p = (*i)->Route::processor_by_id (id);
4185                 if (p) {
4186                         return p;
4187                 }
4188         }
4189
4190         return boost::shared_ptr<Processor> ();
4191 }
4192
4193 boost::shared_ptr<Track>
4194 Session::track_by_diskstream_id (PBD::ID id) const
4195 {
4196         boost::shared_ptr<RouteList> r = routes.reader ();
4197
4198         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4199                 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4200                 if (t && t->using_diskstream_id (id)) {
4201                         return t;
4202                 }
4203         }
4204
4205         return boost::shared_ptr<Track> ();
4206 }
4207
4208 boost::shared_ptr<Route>
4209 Session::get_remote_nth_route (uint16_t n) const
4210 {
4211         return boost::dynamic_pointer_cast<Route> (get_remote_nth_stripable (n, PresentationInfo::Route));
4212 }
4213
4214 boost::shared_ptr<Stripable>
4215 Session::get_remote_nth_stripable (uint16_t n, PresentationInfo::Flag flags) const
4216 {
4217         boost::shared_ptr<RouteList> r = routes.reader ();
4218         vector<boost::shared_ptr<Route> > v;
4219
4220         if (n >= r->size()) {
4221                 return boost::shared_ptr<Route> ();
4222         }
4223
4224         v.assign (r->size(), boost::shared_ptr<Route>());
4225
4226         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4227                 if ((*i)->presentation_info().flag_match (flags)) {
4228                         v[(*i)->presentation_info().group_order()] = (*i);
4229                 }
4230         }
4231
4232         return v[n];
4233 }
4234
4235 boost::shared_ptr<Route>
4236 Session::route_by_selected_count (uint32_t id) const
4237 {
4238         boost::shared_ptr<RouteList> r = routes.reader ();
4239
4240         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4241                 /* NOT IMPLEMENTED */
4242         }
4243
4244         return boost::shared_ptr<Route> ((Route*) 0);
4245 }
4246
4247 struct PresentationOrderSorter {
4248         bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
4249                 if (a->presentation_info().special() && !b->presentation_info().special()) {
4250                         /* a is not ordered, b is; b comes before a */
4251                         return false;
4252                 } else if (b->presentation_info().unordered() && !a->presentation_info().unordered()) {
4253                         /* b is not ordered, a is; a comes before b */
4254                         return true;
4255                 } else {
4256                         return a->presentation_info().global_order() < b->presentation_info().global_order();
4257                 }
4258         }
4259 };
4260
4261 void
4262 Session::reassign_track_numbers ()
4263 {
4264         int64_t tn = 0;
4265         int64_t bn = 0;
4266         RouteList r (*(routes.reader ()));
4267         PresentationOrderSorter sorter;
4268         r.sort (sorter);
4269
4270         StateProtector sp (this);
4271
4272         for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4273                 if (boost::dynamic_pointer_cast<Track> (*i)) {
4274                         (*i)->set_track_number(++tn);
4275                 }
4276                 else if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner()) {
4277                         (*i)->set_track_number(--bn);
4278                 }
4279         }
4280         const uint32_t decimals = ceilf (log10f (tn + 1));
4281         const bool decimals_changed = _track_number_decimals != decimals;
4282         _track_number_decimals = decimals;
4283
4284         if (decimals_changed && config.get_track_name_number ()) {
4285                 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4286                         boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4287                         if (t) {
4288                                 t->resync_track_name();
4289                         }
4290                 }
4291                 // trigger GUI re-layout
4292                 config.ParameterChanged("track-name-number");
4293         }
4294 }
4295
4296 void
4297 Session::playlist_region_added (boost::weak_ptr<Region> w)
4298 {
4299         boost::shared_ptr<Region> r = w.lock ();
4300         if (!r) {
4301                 return;
4302         }
4303
4304         /* These are the operations that are currently in progress... */
4305         list<GQuark> curr = _current_trans_quarks;
4306         curr.sort ();
4307
4308         /* ...and these are the operations during which we want to update
4309            the session range location markers.
4310         */
4311         list<GQuark> ops;
4312         ops.push_back (Operations::capture);
4313         ops.push_back (Operations::paste);
4314         ops.push_back (Operations::duplicate_region);
4315         ops.push_back (Operations::insert_file);
4316         ops.push_back (Operations::insert_region);
4317         ops.push_back (Operations::drag_region_brush);
4318         ops.push_back (Operations::region_drag);
4319         ops.push_back (Operations::selection_grab);
4320         ops.push_back (Operations::region_fill);
4321         ops.push_back (Operations::fill_selection);
4322         ops.push_back (Operations::create_region);
4323         ops.push_back (Operations::region_copy);
4324         ops.push_back (Operations::fixed_time_region_copy);
4325         ops.sort ();
4326
4327         /* See if any of the current operations match the ones that we want */
4328         list<GQuark> in;
4329         set_intersection (_current_trans_quarks.begin(), _current_trans_quarks.end(), ops.begin(), ops.end(), back_inserter (in));
4330
4331         /* If so, update the session range markers */
4332         if (!in.empty ()) {
4333                 maybe_update_session_range (r->position (), r->last_frame ());
4334         }
4335 }
4336
4337 /** Update the session range markers if a is before the current start or
4338  *  b is after the current end.
4339  */
4340 void
4341 Session::maybe_update_session_range (framepos_t a, framepos_t b)
4342 {
4343         if (_state_of_the_state & Loading) {
4344                 return;
4345         }
4346
4347         framepos_t session_end_marker_shift_samples = session_end_shift * _nominal_frame_rate;
4348
4349         if (_session_range_location == 0) {
4350
4351                 set_session_range_location (a, b + session_end_marker_shift_samples);
4352
4353         } else {
4354
4355                 if (a < _session_range_location->start()) {
4356                         _session_range_location->set_start (a);
4357                 }
4358
4359                 if (b > _session_range_location->end()) {
4360                         _session_range_location->set_end (b);
4361                 }
4362         }
4363 }
4364
4365 void
4366 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
4367 {
4368         for (list<Evoral::RangeMove<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4369                 maybe_update_session_range (i->to, i->to + i->length);
4370         }
4371 }
4372
4373 void
4374 Session::playlist_regions_extended (list<Evoral::Range<framepos_t> > const & ranges)
4375 {
4376         for (list<Evoral::Range<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4377                 maybe_update_session_range (i->from, i->to);
4378         }
4379 }
4380
4381 /* Region management */
4382
4383 boost::shared_ptr<Region>
4384 Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
4385 {
4386         const RegionFactory::RegionMap& regions (RegionFactory::regions());
4387         RegionFactory::RegionMap::const_iterator i;
4388         boost::shared_ptr<Region> region;
4389
4390         Glib::Threads::Mutex::Lock lm (region_lock);
4391
4392         for (i = regions.begin(); i != regions.end(); ++i) {
4393
4394                 region = i->second;
4395
4396                 if (region->whole_file()) {
4397
4398                         if (child->source_equivalent (region)) {
4399                                 return region;
4400                         }
4401                 }
4402         }
4403
4404         return boost::shared_ptr<Region> ();
4405 }
4406
4407 int
4408 Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
4409 {
4410         set<boost::shared_ptr<Region> > relevant_regions;
4411
4412         for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
4413                 RegionFactory::get_regions_using_source (*s, relevant_regions);
4414         }
4415
4416         for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
4417                 set<boost::shared_ptr<Region> >::iterator tmp;
4418
4419                 tmp = r;
4420                 ++tmp;
4421
4422                 playlists->destroy_region (*r);
4423                 RegionFactory::map_remove (*r);
4424
4425                 (*r)->drop_sources ();
4426                 (*r)->drop_references ();
4427
4428                 relevant_regions.erase (r);
4429
4430                 r = tmp;
4431         }
4432
4433         for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
4434
4435                 {
4436                         Glib::Threads::Mutex::Lock ls (source_lock);
4437                         /* remove from the main source list */
4438                         sources.erase ((*s)->id());
4439                 }
4440
4441                 (*s)->mark_for_remove ();
4442                 (*s)->drop_references ();
4443
4444                 s = srcs.erase (s);
4445         }
4446
4447         return 0;
4448 }
4449
4450 int
4451 Session::remove_last_capture ()
4452 {
4453         list<boost::shared_ptr<Source> > srcs;
4454
4455         boost::shared_ptr<RouteList> rl = routes.reader ();
4456         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4457                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4458                 if (!tr) {
4459                         continue;
4460                 }
4461
4462                 list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
4463
4464                 if (!l.empty()) {
4465                         srcs.insert (srcs.end(), l.begin(), l.end());
4466                         l.clear ();
4467                 }
4468         }
4469
4470         destroy_sources (srcs);
4471
4472         save_state (_current_snapshot_name);
4473
4474         return 0;
4475 }
4476
4477 /* Source Management */
4478
4479 void
4480 Session::add_source (boost::shared_ptr<Source> source)
4481 {
4482         pair<SourceMap::key_type, SourceMap::mapped_type> entry;
4483         pair<SourceMap::iterator,bool> result;
4484
4485         entry.first = source->id();
4486         entry.second = source;
4487
4488         {
4489                 Glib::Threads::Mutex::Lock lm (source_lock);
4490                 result = sources.insert (entry);
4491         }
4492
4493         if (result.second) {
4494
4495                 /* yay, new source */
4496
4497                 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
4498
4499                 if (fs) {
4500                         if (!fs->within_session()) {
4501                                 ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
4502                         }
4503                 }
4504
4505                 set_dirty();
4506
4507                 boost::shared_ptr<AudioFileSource> afs;
4508
4509                 if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
4510                         if (Config->get_auto_analyse_audio()) {
4511                                 Analyser::queue_source_for_analysis (source, false);
4512                         }
4513                 }
4514
4515                 source->DropReferences.connect_same_thread (*this, boost::bind (&Session::remove_source, this, boost::weak_ptr<Source> (source)));
4516         }
4517 }
4518
4519 void
4520 Session::remove_source (boost::weak_ptr<Source> src)
4521 {
4522         if (_state_of_the_state & Deletion) {
4523                 return;
4524         }
4525
4526         SourceMap::iterator i;
4527         boost::shared_ptr<Source> source = src.lock();
4528
4529         if (!source) {
4530                 return;
4531         }
4532
4533         {
4534                 Glib::Threads::Mutex::Lock lm (source_lock);
4535
4536                 if ((i = sources.find (source->id())) != sources.end()) {
4537                         sources.erase (i);
4538                 }
4539         }
4540
4541         if (!(_state_of_the_state & StateOfTheState (InCleanup|Loading))) {
4542
4543                 /* save state so we don't end up with a session file
4544                    referring to non-existent sources.
4545                 */
4546
4547                 save_state (_current_snapshot_name);
4548         }
4549 }
4550
4551 boost::shared_ptr<Source>
4552 Session::source_by_id (const PBD::ID& id)
4553 {
4554         Glib::Threads::Mutex::Lock lm (source_lock);
4555         SourceMap::iterator i;
4556         boost::shared_ptr<Source> source;
4557
4558         if ((i = sources.find (id)) != sources.end()) {
4559                 source = i->second;
4560         }
4561
4562         return source;
4563 }
4564
4565 boost::shared_ptr<AudioFileSource>
4566 Session::audio_source_by_path_and_channel (const string& path, uint16_t chn) const
4567 {
4568         /* Restricted to audio files because only audio sources have channel
4569            as a property.
4570         */
4571
4572         Glib::Threads::Mutex::Lock lm (source_lock);
4573
4574         for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
4575                 boost::shared_ptr<AudioFileSource> afs
4576                         = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
4577
4578                 if (afs && afs->path() == path && chn == afs->channel()) {
4579                         return afs;
4580                 }
4581         }
4582
4583         return boost::shared_ptr<AudioFileSource>();
4584 }
4585
4586 boost::shared_ptr<MidiSource>
4587 Session::midi_source_by_path (const std::string& path) const
4588 {
4589         /* Restricted to MIDI files because audio sources require a channel
4590            for unique identification, in addition to a path.
4591         */
4592
4593         Glib::Threads::Mutex::Lock lm (source_lock);
4594
4595         for (SourceMap::const_iterator s = sources.begin(); s != sources.end(); ++s) {
4596                 boost::shared_ptr<MidiSource> ms
4597                         = boost::dynamic_pointer_cast<MidiSource>(s->second);
4598                 boost::shared_ptr<FileSource> fs
4599                         = boost::dynamic_pointer_cast<FileSource>(s->second);
4600
4601                 if (ms && fs && fs->path() == path) {
4602                         return ms;
4603                 }
4604         }
4605
4606         return boost::shared_ptr<MidiSource>();
4607 }
4608
4609 uint32_t
4610 Session::count_sources_by_origin (const string& path)
4611 {
4612         uint32_t cnt = 0;
4613         Glib::Threads::Mutex::Lock lm (source_lock);
4614
4615         for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
4616                 boost::shared_ptr<FileSource> fs
4617                         = boost::dynamic_pointer_cast<FileSource>(i->second);
4618
4619                 if (fs && fs->origin() == path) {
4620                         ++cnt;
4621                 }
4622         }
4623
4624         return cnt;
4625 }
4626
4627 static string
4628 peak_file_helper (const string& peak_path, const string& file_path, const string& file_base, bool hash) {
4629         if (hash) {
4630                 std::string checksum = Glib::Checksum::compute_checksum(Glib::Checksum::CHECKSUM_SHA1, file_path + G_DIR_SEPARATOR + file_base);
4631                 return Glib::build_filename (peak_path, checksum + peakfile_suffix);
4632         } else {
4633                 return Glib::build_filename (peak_path, file_base + peakfile_suffix);
4634         }
4635 }
4636
4637 string
4638 Session::construct_peak_filepath (const string& filepath, const bool in_session, const bool old_peak_name) const
4639 {
4640         string interchange_dir_string = string (interchange_dir_name) + G_DIR_SEPARATOR;
4641
4642         if (Glib::path_is_absolute (filepath)) {
4643
4644                 /* rip the session dir from the audiofile source */
4645
4646                 string session_path;
4647                 bool in_another_session = true;
4648
4649                 if (filepath.find (interchange_dir_string) != string::npos) {
4650
4651                         session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
4652                         session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
4653                         session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
4654                         session_path = Glib::path_get_dirname (session_path); /* now has session path */
4655
4656                         /* see if it is within our session */
4657
4658                         for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
4659                                 if (i->path == session_path) {
4660                                         in_another_session = false;
4661                                         break;
4662                                 }
4663                         }
4664                 } else {
4665                         in_another_session = false;
4666                 }
4667
4668
4669                 if (in_another_session) {
4670                         SessionDirectory sd (session_path);
4671                         return peak_file_helper (sd.peak_path(), "", Glib::path_get_basename (filepath), !old_peak_name);
4672                 }
4673         }
4674
4675         /* 1) if file belongs to this session
4676          * it may be a relative path (interchange/...)
4677          * or just basename (session_state, remove source)
4678          * -> just use the basename
4679          */
4680         std::string filename = Glib::path_get_basename (filepath);
4681         std::string path;
4682
4683         /* 2) if the file is outside our session dir:
4684          * (imported but not copied) add the path for check-summming */
4685         if (!in_session) {
4686                 path = Glib::path_get_dirname (filepath);
4687         }
4688
4689         return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
4690 }
4691
4692 string
4693 Session::new_audio_source_path_for_embedded (const std::string& path)
4694 {
4695         /* embedded source:
4696          *
4697          * we know that the filename is already unique because it exists
4698          * out in the filesystem.
4699          *
4700          * However, when we bring it into the session, we could get a
4701          * collision.
4702          *
4703          * Eg. two embedded files:
4704          *
4705          *          /foo/bar/baz.wav
4706          *          /frob/nic/baz.wav
4707          *
4708          * When merged into session, these collide.
4709          *
4710          * There will not be a conflict with in-memory sources
4711          * because when the source was created we already picked
4712          * a unique name for it.
4713          *
4714          * This collision is not likely to be common, but we have to guard
4715          * against it.  So, if there is a collision, take the md5 hash of the
4716          * the path, and use that as the filename instead.
4717          */
4718
4719         SessionDirectory sdir (get_best_session_directory_for_new_audio());
4720         string base = Glib::path_get_basename (path);
4721         string newpath = Glib::build_filename (sdir.sound_path(), base);
4722
4723         if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4724
4725                 MD5 md5;
4726
4727                 md5.digestString (path.c_str());
4728                 md5.writeToString ();
4729                 base = md5.digestChars;
4730
4731                 string ext = get_suffix (path);
4732
4733                 if (!ext.empty()) {
4734                         base += '.';
4735                         base += ext;
4736                 }
4737
4738                 newpath = Glib::build_filename (sdir.sound_path(), base);
4739
4740                 /* if this collides, we're screwed */
4741
4742                 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4743                         error << string_compose (_("Merging embedded file %1: name collision AND md5 hash collision!"), path) << endmsg;
4744                         return string();
4745                 }
4746
4747         }
4748
4749         return newpath;
4750 }
4751
4752 /** Return true if there are no audio file sources that use @param name as
4753  * the filename component of their path.
4754  *
4755  * Return false otherwise.
4756  *
4757  * This method MUST ONLY be used to check in-session, mono files since it
4758  * hard-codes the channel of the audio file source we are looking for as zero.
4759  *
4760  * If/when Ardour supports native files in non-mono formats, the logic here
4761  * will need to be revisited.
4762  */
4763 bool
4764 Session::audio_source_name_is_unique (const string& name)
4765 {
4766         std::vector<string> sdirs = source_search_path (DataType::AUDIO);
4767         vector<space_and_path>::iterator i;
4768         uint32_t existing = 0;
4769
4770         for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4771
4772                 /* note that we search *without* the extension so that
4773                    we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
4774                    in the event that this new name is required for
4775                    a file format change.
4776                 */
4777
4778                 const string spath = *i;
4779
4780                 if (matching_unsuffixed_filename_exists_in (spath, name)) {
4781                         existing++;
4782                         break;
4783                 }
4784
4785                 /* it is possible that we have the path already
4786                  * assigned to a source that has not yet been written
4787                  * (ie. the write source for a diskstream). we have to
4788                  * check this in order to make sure that our candidate
4789                  * path isn't used again, because that can lead to
4790                  * two Sources point to the same file with different
4791                  * notions of their removability.
4792                  */
4793
4794
4795                 string possible_path = Glib::build_filename (spath, name);
4796
4797                 if (audio_source_by_path_and_channel (possible_path, 0)) {
4798                         existing++;
4799                         break;
4800                 }
4801         }
4802
4803         return (existing == 0);
4804 }
4805
4806 string
4807 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)
4808 {
4809         ostringstream sstr;
4810         const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
4811
4812         if (Profile->get_trx() && destructive) {
4813                 sstr << 'T';
4814                 sstr << setfill ('0') << setw (4) << cnt;
4815                 sstr << legalized_base;
4816         } else {
4817                 sstr << legalized_base;
4818
4819                 if (take_required || related_exists) {
4820                         sstr << '-';
4821                         sstr << cnt;
4822                 }
4823         }
4824
4825         if (nchan == 2) {
4826                 if (chan == 0) {
4827                         sstr << "%L";
4828                 } else {
4829                         sstr << "%R";
4830                 }
4831         } else if (nchan > 2) {
4832                 if (nchan < 26) {
4833                         sstr << '%';
4834                         sstr << 'a' + chan;
4835                 } else {
4836                         /* XXX what? more than 26 channels! */
4837                         sstr << '%';
4838                         sstr << chan+1;
4839                 }
4840         }
4841
4842         sstr << ext;
4843
4844         return sstr.str();
4845 }
4846
4847 /** Return a unique name based on \a base for a new internal audio source */
4848 string
4849 Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required)
4850 {
4851         uint32_t cnt;
4852         string possible_name;
4853         const uint32_t limit = 9999; // arbitrary limit on number of files with the same basic name
4854         string legalized;
4855         bool some_related_source_name_exists = false;
4856
4857         legalized = legalize_for_path (base);
4858
4859         // Find a "version" of the base name that doesn't exist in any of the possible directories.
4860
4861         for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
4862
4863                 possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
4864
4865                 if (audio_source_name_is_unique (possible_name)) {
4866                         break;
4867                 }
4868
4869                 some_related_source_name_exists = true;
4870
4871                 if (cnt > limit) {
4872                         error << string_compose(
4873                                         _("There are already %1 recordings for %2, which I consider too many."),
4874                                         limit, base) << endmsg;
4875                         destroy ();
4876                         throw failed_constructor();
4877                 }
4878         }
4879
4880         /* We've established that the new name does not exist in any session
4881          * directory, so now find out which one we should use for this new
4882          * audio source.
4883          */
4884
4885         SessionDirectory sdir (get_best_session_directory_for_new_audio());
4886
4887         std::string s = Glib::build_filename (sdir.sound_path(), possible_name);
4888
4889         return s;
4890 }
4891
4892 /** Return a unique name based on `base` for a new internal MIDI source */
4893 string
4894 Session::new_midi_source_path (const string& base)
4895 {
4896         uint32_t cnt;
4897         char buf[PATH_MAX+1];
4898         const uint32_t limit = 10000;
4899         string legalized;
4900         string possible_path;
4901         string possible_name;
4902
4903         buf[0] = '\0';
4904         legalized = legalize_for_path (base);
4905
4906         // Find a "version" of the file name that doesn't exist in any of the possible directories.
4907         std::vector<string> sdirs = source_search_path(DataType::MIDI);
4908
4909         /* - the main session folder is the first in the vector.
4910          * - after checking all locations for file-name uniqueness,
4911          *   we keep the one from the last iteration as new file name
4912          * - midi files are small and should just be kept in the main session-folder
4913          *
4914          * -> reverse the array, check main session folder last and use that as location
4915          *    for MIDI files.
4916          */
4917         std::reverse(sdirs.begin(), sdirs.end());
4918
4919         for (cnt = 1; cnt <= limit; ++cnt) {
4920
4921                 vector<space_and_path>::iterator i;
4922                 uint32_t existing = 0;
4923
4924                 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4925
4926                         snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
4927                         possible_name = buf;
4928
4929                         possible_path = Glib::build_filename (*i, possible_name);
4930
4931                         if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
4932                                 existing++;
4933                         }
4934
4935                         if (midi_source_by_path (possible_path)) {
4936                                 existing++;
4937                         }
4938                 }
4939
4940                 if (existing == 0) {
4941                         break;
4942                 }
4943
4944                 if (cnt > limit) {
4945                         error << string_compose(
4946                                         _("There are already %1 recordings for %2, which I consider too many."),
4947                                         limit, base) << endmsg;
4948                         destroy ();
4949                         return 0;
4950                 }
4951         }
4952
4953         /* No need to "find best location" for software/app-based RAID, because
4954            MIDI is so small that we always put it in the same place.
4955         */
4956
4957         return possible_path;
4958 }
4959
4960
4961 /** Create a new within-session audio source */
4962 boost::shared_ptr<AudioFileSource>
4963 Session::create_audio_source_for_session (size_t n_chans, string const & base, uint32_t chan, bool destructive)
4964 {
4965         const string path = new_audio_source_path (base, n_chans, chan, destructive, true);
4966
4967         if (!path.empty()) {
4968                 return boost::dynamic_pointer_cast<AudioFileSource> (
4969                         SourceFactory::createWritable (DataType::AUDIO, *this, path, destructive, frame_rate(), true, true));
4970         } else {
4971                 throw failed_constructor ();
4972         }
4973 }
4974
4975 /** Create a new within-session MIDI source */
4976 boost::shared_ptr<MidiSource>
4977 Session::create_midi_source_for_session (string const & basic_name)
4978 {
4979         const string path = new_midi_source_path (basic_name);
4980
4981         if (!path.empty()) {
4982                 return boost::dynamic_pointer_cast<SMFSource> (
4983                         SourceFactory::createWritable (
4984                                 DataType::MIDI, *this, path, false, frame_rate()));
4985         } else {
4986                 throw failed_constructor ();
4987         }
4988 }
4989
4990 /** Create a new within-session MIDI source */
4991 boost::shared_ptr<MidiSource>
4992 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
4993 {
4994         /* the caller passes in the track the source will be used in,
4995            so that we can keep the numbering sane.
4996
4997            Rationale: a track with the name "Foo" that has had N
4998            captures carried out so far will ALREADY have a write source
4999            named "Foo-N+1.mid" waiting to be used for the next capture.
5000
5001            If we call new_midi_source_name() we will get "Foo-N+2". But
5002            there is no region corresponding to "Foo-N+1", so when
5003            "Foo-N+2" appears in the track, the gap presents the user
5004            with odd behaviour - why did it skip past Foo-N+1?
5005
5006            We could explain this to the user in some odd way, but
5007            instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
5008            use "Foo-N+1" here.
5009
5010            If that attempted rename fails, we get "Foo-N+2.mid" anyway.
5011         */
5012
5013         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
5014         assert (mt);
5015         std::string name = track->steal_write_source_name ();
5016
5017         if (name.empty()) {
5018                 return boost::shared_ptr<MidiSource>();
5019         }
5020
5021         /* MIDI files are small, just put them in the first location of the
5022            session source search path.
5023         */
5024
5025         const string path = Glib::build_filename (source_search_path (DataType::MIDI).front(), name);
5026
5027         return boost::dynamic_pointer_cast<SMFSource> (
5028                 SourceFactory::createWritable (
5029                         DataType::MIDI, *this, path, false, frame_rate()));
5030 }
5031
5032
5033 void
5034 Session::add_playlist (boost::shared_ptr<Playlist> playlist, bool unused)
5035 {
5036         if (playlist->hidden()) {
5037                 return;
5038         }
5039
5040         playlists->add (playlist);
5041
5042         if (unused) {
5043                 playlist->release();
5044         }
5045
5046         set_dirty();
5047 }
5048
5049 void
5050 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
5051 {
5052         if (_state_of_the_state & Deletion) {
5053                 return;
5054         }
5055
5056         boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
5057
5058         if (!playlist) {
5059                 return;
5060         }
5061
5062         playlists->remove (playlist);
5063
5064         set_dirty();
5065 }
5066
5067 void
5068 Session::set_audition (boost::shared_ptr<Region> r)
5069 {
5070         pending_audition_region = r;
5071         add_post_transport_work (PostTransportAudition);
5072         _butler->schedule_transport_work ();
5073 }
5074
5075 void
5076 Session::audition_playlist ()
5077 {
5078         SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5079         ev->region.reset ();
5080         queue_event (ev);
5081 }
5082
5083
5084 void
5085 Session::register_lua_function (
5086                 const std::string& name,
5087                 const std::string& script,
5088                 const LuaScriptParamList& args
5089                 )
5090 {
5091         Glib::Threads::Mutex::Lock lm (lua_lock);
5092
5093         lua_State* L = lua.getState();
5094
5095         const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
5096         luabridge::LuaRef tbl_arg (luabridge::newTable(L));
5097         for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
5098                 if ((*i)->optional && !(*i)->is_set) { continue; }
5099                 tbl_arg[(*i)->name] = (*i)->value;
5100         }
5101         (*_lua_add)(name, bytecode, tbl_arg); // throws luabridge::LuaException
5102         set_dirty();
5103 }
5104
5105 void
5106 Session::unregister_lua_function (const std::string& name)
5107 {
5108         Glib::Threads::Mutex::Lock lm (lua_lock);
5109         (*_lua_del)(name); // throws luabridge::LuaException
5110         lua.collect_garbage ();
5111         set_dirty();
5112 }
5113
5114 std::vector<std::string>
5115 Session::registered_lua_functions ()
5116 {
5117         Glib::Threads::Mutex::Lock lm (lua_lock);
5118         std::vector<std::string> rv;
5119
5120         try {
5121                 luabridge::LuaRef list ((*_lua_list)());
5122                 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5123                         if (!i.key ().isString ()) { assert(0); continue; }
5124                         rv.push_back (i.key ().cast<std::string> ());
5125                 }
5126         } catch (luabridge::LuaException const& e) { }
5127         return rv;
5128 }
5129
5130 #ifndef NDEBUG
5131 static void _lua_print (std::string s) {
5132         std::cout << "SessionLua: " << s << "\n";
5133 }
5134 #endif
5135
5136 void
5137 Session::try_run_lua (pframes_t nframes)
5138 {
5139         if (_n_lua_scripts == 0) return;
5140         Glib::Threads::Mutex::Lock tm (lua_lock, Glib::Threads::TRY_LOCK);
5141         if (tm.locked ()) {
5142                 try { (*_lua_run)(nframes); } catch (luabridge::LuaException const& e) { }
5143         }
5144 }
5145
5146 void
5147 Session::setup_lua ()
5148 {
5149 #ifndef NDEBUG
5150         lua.Print.connect (&_lua_print);
5151 #endif
5152         lua.do_command (
5153                         "function ArdourSession ()"
5154                         "  local self = { scripts = {}, instances = {} }"
5155                         ""
5156                         "  local remove = function (n)"
5157                         "   self.scripts[n] = nil"
5158                         "   self.instances[n] = nil"
5159                         "   Session:scripts_changed()" // call back
5160                         "  end"
5161                         ""
5162                         "  local addinternal = function (n, f, a)"
5163                         "   assert(type(n) == 'string', 'function-name must be string')"
5164                         "   assert(type(f) == 'function', 'Given script is a not a function')"
5165                         "   assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
5166                         "   assert(self.scripts[n] == nil, 'Callback \"'.. n ..'\" already exists.')"
5167                         "   self.scripts[n] = { ['f'] = f, ['a'] = a }"
5168                         "   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"
5169                         "   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 }"
5170                         "   self.instances[n] = load (string.dump(f, true), nil, nil, env)(a)"
5171                         "   Session:scripts_changed()" // call back
5172                         "  end"
5173                         ""
5174                         "  local add = function (n, b, a)"
5175                         "   assert(type(b) == 'string', 'ByteCode must be string')"
5176                         "   load (b)()" // assigns f
5177                         "   assert(type(f) == 'string', 'Assigned ByteCode must be string')"
5178                         "   addinternal (n, load(f), a)"
5179                         "  end"
5180                         ""
5181                         "  local run = function (...)"
5182                         "   for n, s in pairs (self.instances) do"
5183                         "     local status, err = pcall (s, ...)"
5184                         "     if not status then"
5185                         "       print ('fn \"'.. n .. '\": ', err)"
5186                         "       remove (n)"
5187                         "      end"
5188                         "   end"
5189                         "   collectgarbage()"
5190                         "  end"
5191                         ""
5192                         "  local cleanup = function ()"
5193                         "   self.scripts = nil"
5194                         "   self.instances = nil"
5195                         "  end"
5196                         ""
5197                         "  local list = function ()"
5198                         "   local rv = {}"
5199                         "   for n, _ in pairs (self.scripts) do"
5200                         "     rv[n] = true"
5201                         "   end"
5202                         "   return rv"
5203                         "  end"
5204                         ""
5205                         "  local function basic_serialize (o)"
5206                         "    if type(o) == \"number\" then"
5207                         "     return tostring(o)"
5208                         "    else"
5209                         "     return string.format(\"%q\", o)"
5210                         "    end"
5211                         "  end"
5212                         ""
5213                         "  local function serialize (name, value)"
5214                         "   local rv = name .. ' = '"
5215                         "   collectgarbage()"
5216                         "   if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
5217                         "    return rv .. basic_serialize(value) .. ' '"
5218                         "   elseif type(value) == \"table\" then"
5219                         "    rv = rv .. '{} '"
5220                         "    for k,v in pairs(value) do"
5221                         "     local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
5222                         "     rv = rv .. serialize(fieldname, v) .. ' '"
5223                         "     collectgarbage()" // string concatenation allocates a new string :(
5224                         "    end"
5225                         "    return rv;"
5226                         "   elseif type(value) == \"function\" then"
5227                         "     return rv .. string.format(\"%q\", string.dump(value, true))"
5228                         "   else"
5229                         "    error('cannot save a ' .. type(value))"
5230                         "   end"
5231                         "  end"
5232                         ""
5233                         ""
5234                         "  local save = function ()"
5235                         "   return (serialize('scripts', self.scripts))"
5236                         "  end"
5237                         ""
5238                         "  local restore = function (state)"
5239                         "   self.scripts = {}"
5240                         "   load (state)()"
5241                         "   for n, s in pairs (scripts) do"
5242                         "    addinternal (n, load(s['f']), s['a'])"
5243                         "   end"
5244                         "  end"
5245                         ""
5246                         " return { run = run, add = add, remove = remove,"
5247                   "          list = list, restore = restore, save = save, cleanup = cleanup}"
5248                         " end"
5249                         " "
5250                         " sess = ArdourSession ()"
5251                         " ArdourSession = nil"
5252                         " "
5253                         "function ardour () end"
5254                         );
5255
5256         lua_State* L = lua.getState();
5257
5258         try {
5259                 luabridge::LuaRef lua_sess = luabridge::getGlobal (L, "sess");
5260                 lua.do_command ("sess = nil"); // hide it.
5261                 lua.do_command ("collectgarbage()");
5262
5263                 _lua_run = new luabridge::LuaRef(lua_sess["run"]);
5264                 _lua_add = new luabridge::LuaRef(lua_sess["add"]);
5265                 _lua_del = new luabridge::LuaRef(lua_sess["remove"]);
5266                 _lua_list = new luabridge::LuaRef(lua_sess["list"]);
5267                 _lua_save = new luabridge::LuaRef(lua_sess["save"]);
5268                 _lua_load = new luabridge::LuaRef(lua_sess["restore"]);
5269                 _lua_cleanup = new luabridge::LuaRef(lua_sess["cleanup"]);
5270         } catch (luabridge::LuaException const& e) {
5271                 fatal << string_compose (_("programming error: %1"),
5272                                 X_("Failed to setup Lua interpreter"))
5273                         << endmsg;
5274                 abort(); /*NOTREACHED*/
5275         }
5276
5277         LuaBindings::stddef (L);
5278         LuaBindings::common (L);
5279         LuaBindings::dsp (L);
5280         luabridge::push <Session *> (L, this);
5281         lua_setglobal (L, "Session");
5282 }
5283
5284 void
5285 Session::scripts_changed ()
5286 {
5287         assert (!lua_lock.trylock()); // must hold lua_lock
5288
5289         try {
5290                 luabridge::LuaRef list ((*_lua_list)());
5291                 int cnt = 0;
5292                 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5293                         if (!i.key ().isString ()) { assert(0); continue; }
5294                         ++cnt;
5295                 }
5296                 _n_lua_scripts = cnt;
5297         } catch (luabridge::LuaException const& e) {
5298                 fatal << string_compose (_("programming error: %1"),
5299                                 X_("Indexing Lua Session Scripts failed."))
5300                         << endmsg;
5301                 abort(); /*NOTREACHED*/
5302         }
5303 }
5304
5305 void
5306 Session::non_realtime_set_audition ()
5307 {
5308         assert (pending_audition_region);
5309         auditioner->audition_region (pending_audition_region);
5310         pending_audition_region.reset ();
5311         AuditionActive (true); /* EMIT SIGNAL */
5312 }
5313
5314 void
5315 Session::audition_region (boost::shared_ptr<Region> r)
5316 {
5317         SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5318         ev->region = r;
5319         queue_event (ev);
5320 }
5321
5322 void
5323 Session::cancel_audition ()
5324 {
5325         if (!auditioner) {
5326                 return;
5327         }
5328         if (auditioner->auditioning()) {
5329                 auditioner->cancel_audition ();
5330                 AuditionActive (false); /* EMIT SIGNAL */
5331         }
5332 }
5333
5334 bool
5335 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
5336 {
5337         if (a->is_monitor()) {
5338                 return true;
5339         }
5340         if (b->is_monitor()) {
5341                 return false;
5342         }
5343         return a->presentation_info() < b->presentation_info();
5344 }
5345
5346 bool
5347 Session::is_auditioning () const
5348 {
5349         /* can be called before we have an auditioner object */
5350         if (auditioner) {
5351                 return auditioner->auditioning();
5352         } else {
5353                 return false;
5354         }
5355 }
5356
5357 void
5358 Session::graph_reordered ()
5359 {
5360         /* don't do this stuff if we are setting up connections
5361            from a set_state() call or creating new tracks. Ditto for deletion.
5362         */
5363
5364         if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
5365                 return;
5366         }
5367
5368         /* every track/bus asked for this to be handled but it was deferred because
5369            we were connecting. do it now.
5370         */
5371
5372         request_input_change_handling ();
5373
5374         resort_routes ();
5375
5376         /* force all diskstreams to update their capture offset values to
5377            reflect any changes in latencies within the graph.
5378         */
5379
5380         boost::shared_ptr<RouteList> rl = routes.reader ();
5381         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5382                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5383                 if (tr) {
5384                         tr->set_capture_offset ();
5385                 }
5386         }
5387 }
5388
5389 /** @return Number of frames that there is disk space available to write,
5390  *  if known.
5391  */
5392 boost::optional<framecnt_t>
5393 Session::available_capture_duration ()
5394 {
5395         Glib::Threads::Mutex::Lock lm (space_lock);
5396
5397         if (_total_free_4k_blocks_uncertain) {
5398                 return boost::optional<framecnt_t> ();
5399         }
5400
5401         float sample_bytes_on_disk = 4.0; // keep gcc happy
5402
5403         switch (config.get_native_file_data_format()) {
5404         case FormatFloat:
5405                 sample_bytes_on_disk = 4.0;
5406                 break;
5407
5408         case FormatInt24:
5409                 sample_bytes_on_disk = 3.0;
5410                 break;
5411
5412         case FormatInt16:
5413                 sample_bytes_on_disk = 2.0;
5414                 break;
5415
5416         default:
5417                 /* impossible, but keep some gcc versions happy */
5418                 fatal << string_compose (_("programming error: %1"),
5419                                          X_("illegal native file data format"))
5420                       << endmsg;
5421                 abort(); /*NOTREACHED*/
5422         }
5423
5424         double scale = 4096.0 / sample_bytes_on_disk;
5425
5426         if (_total_free_4k_blocks * scale > (double) max_framecnt) {
5427                 return max_framecnt;
5428         }
5429
5430         return (framecnt_t) floor (_total_free_4k_blocks * scale);
5431 }
5432
5433 void
5434 Session::add_bundle (boost::shared_ptr<Bundle> bundle, bool emit_signal)
5435 {
5436         {
5437                 RCUWriter<BundleList> writer (_bundles);
5438                 boost::shared_ptr<BundleList> b = writer.get_copy ();
5439                 b->push_back (bundle);
5440         }
5441
5442         if (emit_signal) {
5443                 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5444         }
5445
5446         set_dirty();
5447 }
5448
5449 void
5450 Session::remove_bundle (boost::shared_ptr<Bundle> bundle)
5451 {
5452         bool removed = false;
5453
5454         {
5455                 RCUWriter<BundleList> writer (_bundles);
5456                 boost::shared_ptr<BundleList> b = writer.get_copy ();
5457                 BundleList::iterator i = find (b->begin(), b->end(), bundle);
5458
5459                 if (i != b->end()) {
5460                         b->erase (i);
5461                         removed = true;
5462                 }
5463         }
5464
5465         if (removed) {
5466                  BundleAddedOrRemoved (); /* EMIT SIGNAL */
5467         }
5468
5469         set_dirty();
5470 }
5471
5472 boost::shared_ptr<Bundle>
5473 Session::bundle_by_name (string name) const
5474 {
5475         boost::shared_ptr<BundleList> b = _bundles.reader ();
5476
5477         for (BundleList::const_iterator i = b->begin(); i != b->end(); ++i) {
5478                 if ((*i)->name() == name) {
5479                         return* i;
5480                 }
5481         }
5482
5483         return boost::shared_ptr<Bundle> ();
5484 }
5485
5486 void
5487 Session::tempo_map_changed (const PropertyChange&)
5488 {
5489         clear_clicks ();
5490
5491         playlists->update_after_tempo_map_change ();
5492
5493         _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5494
5495         set_dirty ();
5496 }
5497
5498 void
5499 Session::gui_tempo_map_changed ()
5500 {
5501         clear_clicks ();
5502
5503         playlists->update_after_tempo_map_change ();
5504
5505         _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5506 }
5507
5508 void
5509 Session::update_locations_after_tempo_map_change (const Locations::LocationList& loc)
5510 {
5511         for (Locations::LocationList::const_iterator i = loc.begin(); i != loc.end(); ++i) {
5512                 (*i)->recompute_frames_from_bbt ();
5513         }
5514 }
5515
5516 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
5517  * the given count with the current block size.
5518  */
5519 void
5520 Session::ensure_buffers (ChanCount howmany)
5521 {
5522         BufferManager::ensure_buffers (howmany, bounce_processing() ? bounce_chunk_size : 0);
5523 }
5524
5525 void
5526 Session::ensure_buffer_set(BufferSet& buffers, const ChanCount& count)
5527 {
5528         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5529                 buffers.ensure_buffers(*t, count.get(*t), _engine.raw_buffer_size(*t));
5530         }
5531 }
5532
5533 uint32_t
5534 Session::next_insert_id ()
5535 {
5536         /* this doesn't really loop forever. just think about it */
5537
5538         while (true) {
5539                 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < insert_bitset.size(); ++n) {
5540                         if (!insert_bitset[n]) {
5541                                 insert_bitset[n] = true;
5542                                 return n;
5543
5544                         }
5545                 }
5546
5547                 /* none available, so resize and try again */
5548
5549                 insert_bitset.resize (insert_bitset.size() + 16, false);
5550         }
5551 }
5552
5553 uint32_t
5554 Session::next_send_id ()
5555 {
5556         /* this doesn't really loop forever. just think about it */
5557
5558         while (true) {
5559                 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < send_bitset.size(); ++n) {
5560                         if (!send_bitset[n]) {
5561                                 send_bitset[n] = true;
5562                                 return n;
5563
5564                         }
5565                 }
5566
5567                 /* none available, so resize and try again */
5568
5569                 send_bitset.resize (send_bitset.size() + 16, false);
5570         }
5571 }
5572
5573 uint32_t
5574 Session::next_aux_send_id ()
5575 {
5576         /* this doesn't really loop forever. just think about it */
5577
5578         while (true) {
5579                 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < aux_send_bitset.size(); ++n) {
5580                         if (!aux_send_bitset[n]) {
5581                                 aux_send_bitset[n] = true;
5582                                 return n;
5583
5584                         }
5585                 }
5586
5587                 /* none available, so resize and try again */
5588
5589                 aux_send_bitset.resize (aux_send_bitset.size() + 16, false);
5590         }
5591 }
5592
5593 uint32_t
5594 Session::next_return_id ()
5595 {
5596         /* this doesn't really loop forever. just think about it */
5597
5598         while (true) {
5599                 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < return_bitset.size(); ++n) {
5600                         if (!return_bitset[n]) {
5601                                 return_bitset[n] = true;
5602                                 return n;
5603
5604                         }
5605                 }
5606
5607                 /* none available, so resize and try again */
5608
5609                 return_bitset.resize (return_bitset.size() + 16, false);
5610         }
5611 }
5612
5613 void
5614 Session::mark_send_id (uint32_t id)
5615 {
5616         if (id >= send_bitset.size()) {
5617                 send_bitset.resize (id+16, false);
5618         }
5619         if (send_bitset[id]) {
5620                 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
5621         }
5622         send_bitset[id] = true;
5623 }
5624
5625 void
5626 Session::mark_aux_send_id (uint32_t id)
5627 {
5628         if (id >= aux_send_bitset.size()) {
5629                 aux_send_bitset.resize (id+16, false);
5630         }
5631         if (aux_send_bitset[id]) {
5632                 warning << string_compose (_("aux send ID %1 appears to be in use already"), id) << endmsg;
5633         }
5634         aux_send_bitset[id] = true;
5635 }
5636
5637 void
5638 Session::mark_return_id (uint32_t id)
5639 {
5640         if (id >= return_bitset.size()) {
5641                 return_bitset.resize (id+16, false);
5642         }
5643         if (return_bitset[id]) {
5644                 warning << string_compose (_("return ID %1 appears to be in use already"), id) << endmsg;
5645         }
5646         return_bitset[id] = true;
5647 }
5648
5649 void
5650 Session::mark_insert_id (uint32_t id)
5651 {
5652         if (id >= insert_bitset.size()) {
5653                 insert_bitset.resize (id+16, false);
5654         }
5655         if (insert_bitset[id]) {
5656                 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
5657         }
5658         insert_bitset[id] = true;
5659 }
5660
5661 void
5662 Session::unmark_send_id (uint32_t id)
5663 {
5664         if (id < send_bitset.size()) {
5665                 send_bitset[id] = false;
5666         }
5667 }
5668
5669 void
5670 Session::unmark_aux_send_id (uint32_t id)
5671 {
5672         if (id < aux_send_bitset.size()) {
5673                 aux_send_bitset[id] = false;
5674         }
5675 }
5676
5677 void
5678 Session::unmark_return_id (uint32_t id)
5679 {
5680         if (_state_of_the_state & Deletion) { return; }
5681         if (id < return_bitset.size()) {
5682                 return_bitset[id] = false;
5683         }
5684 }
5685
5686 void
5687 Session::unmark_insert_id (uint32_t id)
5688 {
5689         if (id < insert_bitset.size()) {
5690                 insert_bitset[id] = false;
5691         }
5692 }
5693
5694 void
5695 Session::reset_native_file_format ()
5696 {
5697         boost::shared_ptr<RouteList> rl = routes.reader ();
5698
5699         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5700                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5701                 if (tr) {
5702                         /* don't save state as we do this, there's no point
5703                          */
5704                         _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
5705                         tr->reset_write_sources (false);
5706                         _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
5707                 }
5708         }
5709 }
5710
5711 bool
5712 Session::route_name_unique (string n) const
5713 {
5714         boost::shared_ptr<RouteList> r = routes.reader ();
5715
5716         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5717                 if ((*i)->name() == n) {
5718                         return false;
5719                 }
5720         }
5721
5722         return true;
5723 }
5724
5725 bool
5726 Session::route_name_internal (string n) const
5727 {
5728         if (auditioner && auditioner->name() == n) {
5729                 return true;
5730         }
5731
5732         if (_click_io && _click_io->name() == n) {
5733                 return true;
5734         }
5735
5736         return false;
5737 }
5738
5739 int
5740 Session::freeze_all (InterThreadInfo& itt)
5741 {
5742         boost::shared_ptr<RouteList> r = routes.reader ();
5743
5744         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5745
5746                 boost::shared_ptr<Track> t;
5747
5748                 if ((t = boost::dynamic_pointer_cast<Track>(*i)) != 0) {
5749                         /* XXX this is wrong because itt.progress will keep returning to zero at the start
5750                            of every track.
5751                         */
5752                         t->freeze_me (itt);
5753                 }
5754         }
5755
5756         return 0;
5757 }
5758
5759 boost::shared_ptr<Region>
5760 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
5761                           bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
5762                           InterThreadInfo& itt,
5763                           boost::shared_ptr<Processor> endpoint, bool include_endpoint,
5764                           bool for_export, bool for_freeze)
5765 {
5766         boost::shared_ptr<Region> result;
5767         boost::shared_ptr<Playlist> playlist;
5768         boost::shared_ptr<Source> source;
5769         ChanCount diskstream_channels (track.n_channels());
5770         framepos_t position;
5771         framecnt_t this_chunk;
5772         framepos_t to_do;
5773         framepos_t latency_skip;
5774         BufferSet buffers;
5775         framepos_t len = end - start;
5776         bool need_block_size_reset = false;
5777         ChanCount const max_proc = track.max_processor_streams ();
5778         string legal_playlist_name;
5779         string possible_path;
5780
5781         if (end <= start) {
5782                 error << string_compose (_("Cannot write a range where end <= start (e.g. %1 <= %2)"),
5783                                          end, start) << endmsg;
5784                 return result;
5785         }
5786
5787         diskstream_channels = track.bounce_get_output_streams (diskstream_channels, endpoint,
5788                         include_endpoint, for_export, for_freeze);
5789
5790         if (diskstream_channels.n(track.data_type()) < 1) {
5791                 error << _("Cannot write a range with no data.") << endmsg;
5792                 return result;
5793         }
5794
5795         // block all process callback handling
5796
5797         block_processing ();
5798
5799         {
5800                 // synchronize with AudioEngine::process_callback()
5801                 // make sure processing is not currently running
5802                 // and processing_blocked() is honored before
5803                 // acquiring thread buffers
5804                 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5805         }
5806
5807         _bounce_processing_active = true;
5808
5809         /* call tree *MUST* hold route_lock */
5810
5811         if ((playlist = track.playlist()) == 0) {
5812                 goto out;
5813         }
5814
5815         legal_playlist_name = legalize_for_path (playlist->name());
5816
5817         for (uint32_t chan_n = 0; chan_n < diskstream_channels.n(track.data_type()); ++chan_n) {
5818
5819                 string base_name = string_compose ("%1-%2-bounce", playlist->name(), chan_n);
5820                 string path = ((track.data_type() == DataType::AUDIO)
5821                                ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
5822                                : new_midi_source_path (legal_playlist_name));
5823
5824                 if (path.empty()) {
5825                         goto out;
5826                 }
5827
5828                 try {
5829                         source = SourceFactory::createWritable (track.data_type(), *this, path, false, frame_rate());
5830                 }
5831
5832                 catch (failed_constructor& err) {
5833                         error << string_compose (_("cannot create new file \"%1\" for %2"), path, track.name()) << endmsg;
5834                         goto out;
5835                 }
5836
5837                 srcs.push_back (source);
5838         }
5839
5840         /* tell redirects that care that we are about to use a much larger
5841          * blocksize. this will flush all plugins too, so that they are ready
5842          * to be used for this process.
5843          */
5844
5845         need_block_size_reset = true;
5846         track.set_block_size (bounce_chunk_size);
5847         _engine.main_thread()->get_buffers ();
5848
5849         position = start;
5850         to_do = len;
5851         latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5852
5853         /* create a set of reasonably-sized buffers */
5854         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5855                 buffers.ensure_buffers(*t, max_proc.get(*t), bounce_chunk_size);
5856         }
5857         buffers.set_count (max_proc);
5858
5859         for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5860                 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5861                 boost::shared_ptr<MidiSource> ms;
5862                 if (afs) {
5863                         afs->prepare_for_peakfile_writes ();
5864                 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5865                         Source::Lock lock(ms->mutex());
5866                         ms->mark_streaming_write_started(lock);
5867                 }
5868         }
5869
5870         while (to_do && !itt.cancel) {
5871
5872                 this_chunk = min (to_do, bounce_chunk_size);
5873
5874                 if (track.export_stuff (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze)) {
5875                         goto out;
5876                 }
5877
5878                 start += this_chunk;
5879                 to_do -= this_chunk;
5880                 itt.progress = (float) (1.0 - ((double) to_do / len));
5881
5882                 if (latency_skip >= bounce_chunk_size) {
5883                         latency_skip -= bounce_chunk_size;
5884                         continue;
5885                 }
5886
5887                 const framecnt_t current_chunk = this_chunk - latency_skip;
5888
5889                 uint32_t n = 0;
5890                 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5891                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5892                         boost::shared_ptr<MidiSource> ms;
5893
5894                         if (afs) {
5895                                 if (afs->write (buffers.get_audio(n).data(latency_skip), current_chunk) != current_chunk) {
5896                                         goto out;
5897                                 }
5898                         } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5899                                 Source::Lock lock(ms->mutex());
5900
5901                                 const MidiBuffer& buf = buffers.get_midi(0);
5902                                 for (MidiBuffer::const_iterator i = buf.begin(); i != buf.end(); ++i) {
5903                                         Evoral::Event<framepos_t> ev = *i;
5904                                         ev.set_time(ev.time() - position);
5905                                         ms->append_event_frames(lock, ev, ms->timeline_position());
5906                                 }
5907                         }
5908                 }
5909                 latency_skip = 0;
5910         }
5911
5912         /* post-roll, pick up delayed processor output */
5913         latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5914
5915         while (latency_skip && !itt.cancel) {
5916                 this_chunk = min (latency_skip, bounce_chunk_size);
5917                 latency_skip -= this_chunk;
5918
5919                 buffers.silence (this_chunk, 0);
5920                 track.bounce_process (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze);
5921
5922                 uint32_t n = 0;
5923                 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5924                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5925
5926                         if (afs) {
5927                                 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
5928                                         goto out;
5929                                 }
5930                         }
5931                 }
5932         }
5933
5934         if (!itt.cancel) {
5935
5936                 time_t now;
5937                 struct tm* xnow;
5938                 time (&now);
5939                 xnow = localtime (&now);
5940
5941                 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
5942                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5943                         boost::shared_ptr<MidiSource> ms;
5944
5945                         if (afs) {
5946                                 afs->update_header (position, *xnow, now);
5947                                 afs->flush_header ();
5948                         } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5949                                 Source::Lock lock(ms->mutex());
5950                                 ms->mark_streaming_write_completed(lock);
5951                         }
5952                 }
5953
5954                 /* construct a region to represent the bounced material */
5955
5956                 PropertyList plist;
5957
5958                 plist.add (Properties::start, 0);
5959                 plist.add (Properties::length, srcs.front()->length(srcs.front()->timeline_position()));
5960                 plist.add (Properties::name, region_name_from_path (srcs.front()->name(), true));
5961
5962                 result = RegionFactory::create (srcs, plist);
5963
5964         }
5965
5966   out:
5967         if (!result) {
5968                 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5969                         (*src)->mark_for_remove ();
5970                         (*src)->drop_references ();
5971                 }
5972
5973         } else {
5974                 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5975                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5976
5977                         if (afs)
5978                                 afs->done_with_peakfile_writes ();
5979                 }
5980         }
5981
5982         _bounce_processing_active = false;
5983
5984         if (need_block_size_reset) {
5985                 _engine.main_thread()->drop_buffers ();
5986                 track.set_block_size (get_block_size());
5987         }
5988
5989         unblock_processing ();
5990
5991         return result;
5992 }
5993
5994 gain_t*
5995 Session::gain_automation_buffer() const
5996 {
5997         return ProcessThread::gain_automation_buffer ();
5998 }
5999
6000 gain_t*
6001 Session::trim_automation_buffer() const
6002 {
6003         return ProcessThread::trim_automation_buffer ();
6004 }
6005
6006 gain_t*
6007 Session::send_gain_automation_buffer() const
6008 {
6009         return ProcessThread::send_gain_automation_buffer ();
6010 }
6011
6012 pan_t**
6013 Session::pan_automation_buffer() const
6014 {
6015         return ProcessThread::pan_automation_buffer ();
6016 }
6017
6018 BufferSet&
6019 Session::get_silent_buffers (ChanCount count)
6020 {
6021         return ProcessThread::get_silent_buffers (count);
6022 }
6023
6024 BufferSet&
6025 Session::get_scratch_buffers (ChanCount count, bool silence)
6026 {
6027         return ProcessThread::get_scratch_buffers (count, silence);
6028 }
6029
6030 BufferSet&
6031 Session::get_noinplace_buffers (ChanCount count)
6032 {
6033         return ProcessThread::get_noinplace_buffers (count);
6034 }
6035
6036 BufferSet&
6037 Session::get_route_buffers (ChanCount count, bool silence)
6038 {
6039         return ProcessThread::get_route_buffers (count, silence);
6040 }
6041
6042
6043 BufferSet&
6044 Session::get_mix_buffers (ChanCount count)
6045 {
6046         return ProcessThread::get_mix_buffers (count);
6047 }
6048
6049 uint32_t
6050 Session::ntracks () const
6051 {
6052         uint32_t n = 0;
6053         boost::shared_ptr<RouteList> r = routes.reader ();
6054
6055         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6056                 if (boost::dynamic_pointer_cast<Track> (*i)) {
6057                         ++n;
6058                 }
6059         }
6060
6061         return n;
6062 }
6063
6064 uint32_t
6065 Session::nbusses () const
6066 {
6067         uint32_t n = 0;
6068         boost::shared_ptr<RouteList> r = routes.reader ();
6069
6070         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6071                 if (boost::dynamic_pointer_cast<Track>(*i) == 0) {
6072                         ++n;
6073                 }
6074         }
6075
6076         return n;
6077 }
6078
6079 void
6080 Session::add_automation_list(AutomationList *al)
6081 {
6082         automation_lists[al->id()] = al;
6083 }
6084
6085 /** @return true if there is at least one record-enabled track, otherwise false */
6086 bool
6087 Session::have_rec_enabled_track () const
6088 {
6089         return g_atomic_int_get (const_cast<gint*>(&_have_rec_enabled_track)) == 1;
6090 }
6091
6092 bool
6093 Session::have_rec_disabled_track () const
6094 {
6095     return g_atomic_int_get (const_cast<gint*>(&_have_rec_disabled_track)) == 1;
6096 }
6097
6098 /** Update the state of our rec-enabled tracks flag */
6099 void
6100 Session::update_route_record_state ()
6101 {
6102         boost::shared_ptr<RouteList> rl = routes.reader ();
6103         RouteList::iterator i = rl->begin();
6104         while (i != rl->end ()) {
6105
6106                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6107                                     if (tr && tr->rec_enable_control()->get_value()) {
6108                         break;
6109                 }
6110
6111                 ++i;
6112         }
6113
6114         int const old = g_atomic_int_get (&_have_rec_enabled_track);
6115
6116         g_atomic_int_set (&_have_rec_enabled_track, i != rl->end () ? 1 : 0);
6117
6118         if (g_atomic_int_get (&_have_rec_enabled_track) != old) {
6119                 RecordStateChanged (); /* EMIT SIGNAL */
6120         }
6121
6122         for (i = rl->begin(); i != rl->end (); ++i) {
6123                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6124                 if (tr && !tr->rec_enable_control()->get_value()) {
6125                         break;
6126                 }
6127         }
6128
6129         g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
6130
6131         bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
6132
6133         if (record_status() == Recording && record_arm_state_changed ) {
6134                 RecordArmStateChanged ();
6135         }
6136
6137 }
6138
6139 void
6140 Session::listen_position_changed ()
6141 {
6142         boost::shared_ptr<RouteList> r = routes.reader ();
6143
6144         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6145                 (*i)->listen_position_changed ();
6146         }
6147 }
6148
6149 void
6150 Session::solo_control_mode_changed ()
6151 {
6152         if (soloing() || listening()) {
6153                 /* We can't use ::clear_all_solo_state() here because during
6154                    session loading at program startup, that will queue a call
6155                    to rt_clear_all_solo_state() that will not execute until
6156                    AFTER solo states have been established (thus throwing away
6157                    the session's saved solo state). So just explicitly turn
6158                    them all off.
6159                 */
6160                 set_controls (route_list_to_control_list (get_routes(), &Route::solo_control), 0.0, Controllable::NoGroup);
6161         }
6162 }
6163
6164 /** Called when a property of one of our route groups changes */
6165 void
6166 Session::route_group_property_changed (RouteGroup* rg)
6167 {
6168         RouteGroupPropertyChanged (rg); /* EMIT SIGNAL */
6169 }
6170
6171 /** Called when a route is added to one of our route groups */
6172 void
6173 Session::route_added_to_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6174 {
6175         RouteAddedToRouteGroup (rg, r);
6176 }
6177
6178 /** Called when a route is removed from one of our route groups */
6179 void
6180 Session::route_removed_from_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6181 {
6182         update_route_record_state ();
6183         RouteRemovedFromRouteGroup (rg, r); /* EMIT SIGNAL */
6184 }
6185
6186 boost::shared_ptr<RouteList>
6187 Session::get_tracks () const
6188 {
6189         boost::shared_ptr<RouteList> rl = routes.reader ();
6190         boost::shared_ptr<RouteList> tl (new RouteList);
6191
6192         for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
6193                 if (boost::dynamic_pointer_cast<Track> (*r)) {
6194                         if (!(*r)->is_auditioner()) {
6195                                 tl->push_back (*r);
6196                         }
6197                 }
6198         }
6199         return tl;
6200 }
6201
6202 boost::shared_ptr<RouteList>
6203 Session::get_routes_with_regions_at (framepos_t const p) const
6204 {
6205         boost::shared_ptr<RouteList> r = routes.reader ();
6206         boost::shared_ptr<RouteList> rl (new RouteList);
6207
6208         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6209                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6210                 if (!tr) {
6211                         continue;
6212                 }
6213
6214                 boost::shared_ptr<Playlist> pl = tr->playlist ();
6215                 if (!pl) {
6216                         continue;
6217                 }
6218
6219                 if (pl->has_region_at (p)) {
6220                         rl->push_back (*i);
6221                 }
6222         }
6223
6224         return rl;
6225 }
6226
6227 void
6228 Session::goto_end ()
6229 {
6230         if (_session_range_location) {
6231                 request_locate (_session_range_location->end(), false);
6232         } else {
6233                 request_locate (0, false);
6234         }
6235 }
6236
6237 void
6238 Session::goto_start ()
6239 {
6240         if (_session_range_location) {
6241                 request_locate (_session_range_location->start(), false);
6242         } else {
6243                 request_locate (0, false);
6244         }
6245 }
6246
6247 framepos_t
6248 Session::current_start_frame () const
6249 {
6250         return _session_range_location ? _session_range_location->start() : 0;
6251 }
6252
6253 framepos_t
6254 Session::current_end_frame () const
6255 {
6256         return _session_range_location ? _session_range_location->end() : 0;
6257 }
6258
6259 void
6260 Session::set_session_range_location (framepos_t start, framepos_t end)
6261 {
6262         _session_range_location = new Location (*this, start, end, _("session"), Location::IsSessionRange);
6263         _locations->add (_session_range_location);
6264 }
6265
6266 void
6267 Session::step_edit_status_change (bool yn)
6268 {
6269         bool send = false;
6270
6271         bool val = false;
6272         if (yn) {
6273                 send = (_step_editors == 0);
6274                 val = true;
6275
6276                 _step_editors++;
6277         } else {
6278                 send = (_step_editors == 1);
6279                 val = false;
6280
6281                 if (_step_editors > 0) {
6282                         _step_editors--;
6283                 }
6284         }
6285
6286         if (send) {
6287                 StepEditStatusChange (val);
6288         }
6289 }
6290
6291
6292 void
6293 Session::start_time_changed (framepos_t old)
6294 {
6295         /* Update the auto loop range to match the session range
6296            (unless the auto loop range has been changed by the user)
6297         */
6298
6299         Location* s = _locations->session_range_location ();
6300         if (s == 0) {
6301                 return;
6302         }
6303
6304         Location* l = _locations->auto_loop_location ();
6305
6306         if (l && l->start() == old) {
6307                 l->set_start (s->start(), true);
6308         }
6309 }
6310
6311 void
6312 Session::end_time_changed (framepos_t old)
6313 {
6314         /* Update the auto loop range to match the session range
6315            (unless the auto loop range has been changed by the user)
6316         */
6317
6318         Location* s = _locations->session_range_location ();
6319         if (s == 0) {
6320                 return;
6321         }
6322
6323         Location* l = _locations->auto_loop_location ();
6324
6325         if (l && l->end() == old) {
6326                 l->set_end (s->end(), true);
6327         }
6328 }
6329
6330 std::vector<std::string>
6331 Session::source_search_path (DataType type) const
6332 {
6333         Searchpath sp;
6334
6335         if (session_dirs.size() == 1) {
6336                 switch (type) {
6337                 case DataType::AUDIO:
6338                         sp.push_back (_session_dir->sound_path());
6339                         break;
6340                 case DataType::MIDI:
6341                         sp.push_back (_session_dir->midi_path());
6342                         break;
6343                 }
6344         } else {
6345                 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
6346                         SessionDirectory sdir (i->path);
6347                         switch (type) {
6348                         case DataType::AUDIO:
6349                                 sp.push_back (sdir.sound_path());
6350                                 break;
6351                         case DataType::MIDI:
6352                                 sp.push_back (sdir.midi_path());
6353                                 break;
6354                         }
6355                 }
6356         }
6357
6358         if (type == DataType::AUDIO) {
6359                 const string sound_path_2X = _session_dir->sound_path_2X();
6360                 if (Glib::file_test (sound_path_2X, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_DIR)) {
6361                         if (find (sp.begin(), sp.end(), sound_path_2X) == sp.end()) {
6362                                 sp.push_back (sound_path_2X);
6363                         }
6364                 }
6365         }
6366
6367         // now check the explicit (possibly user-specified) search path
6368
6369         switch (type) {
6370         case DataType::AUDIO:
6371                 sp += Searchpath(config.get_audio_search_path ());
6372                 break;
6373         case DataType::MIDI:
6374                 sp += Searchpath(config.get_midi_search_path ());
6375                 break;
6376         }
6377
6378         return sp;
6379 }
6380
6381 void
6382 Session::ensure_search_path_includes (const string& path, DataType type)
6383 {
6384         Searchpath sp;
6385
6386         if (path == ".") {
6387                 return;
6388         }
6389
6390         switch (type) {
6391         case DataType::AUDIO:
6392                 sp += Searchpath(config.get_audio_search_path ());
6393                 break;
6394         case DataType::MIDI:
6395                 sp += Searchpath (config.get_midi_search_path ());
6396                 break;
6397         }
6398
6399         for (vector<std::string>::iterator i = sp.begin(); i != sp.end(); ++i) {
6400                 /* No need to add this new directory if it has the same inode as
6401                    an existing one; checking inode rather than name prevents duplicated
6402                    directories when we are using symlinks.
6403
6404                    On Windows, I think we could just do if (*i == path) here.
6405                 */
6406                 if (PBD::equivalent_paths (*i, path)) {
6407                         return;
6408                 }
6409         }
6410
6411         sp += path;
6412
6413         switch (type) {
6414         case DataType::AUDIO:
6415                 config.set_audio_search_path (sp.to_string());
6416                 break;
6417         case DataType::MIDI:
6418                 config.set_midi_search_path (sp.to_string());
6419                 break;
6420         }
6421 }
6422
6423 void
6424 Session::remove_dir_from_search_path (const string& dir, DataType type)
6425 {
6426         Searchpath sp;
6427
6428         switch (type) {
6429         case DataType::AUDIO:
6430                 sp = Searchpath(config.get_audio_search_path ());
6431                 break;
6432         case DataType::MIDI:
6433                 sp = Searchpath (config.get_midi_search_path ());
6434                 break;
6435         }
6436
6437         sp -= dir;
6438
6439         switch (type) {
6440         case DataType::AUDIO:
6441                 config.set_audio_search_path (sp.to_string());
6442                 break;
6443         case DataType::MIDI:
6444                 config.set_midi_search_path (sp.to_string());
6445                 break;
6446         }
6447
6448 }
6449
6450 boost::shared_ptr<Speakers>
6451 Session::get_speakers()
6452 {
6453         return _speakers;
6454 }
6455
6456 list<string>
6457 Session::unknown_processors () const
6458 {
6459         list<string> p;
6460
6461         boost::shared_ptr<RouteList> r = routes.reader ();
6462         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6463                 list<string> t = (*i)->unknown_processors ();
6464                 copy (t.begin(), t.end(), back_inserter (p));
6465         }
6466
6467         p.sort ();
6468         p.unique ();
6469
6470         return p;
6471 }
6472
6473 void
6474 Session::update_latency (bool playback)
6475 {
6476
6477         DEBUG_TRACE (DEBUG::Latency, string_compose ("JACK latency callback: %1\n", (playback ? "PLAYBACK" : "CAPTURE")));
6478
6479         if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _route_deletion_in_progress) {
6480                 return;
6481         }
6482
6483         boost::shared_ptr<RouteList> r = routes.reader ();
6484         framecnt_t max_latency = 0;
6485
6486         if (playback) {
6487                 /* reverse the list so that we work backwards from the last route to run to the first */
6488                 RouteList* rl = routes.reader().get();
6489                 r.reset (new RouteList (*rl));
6490                 reverse (r->begin(), r->end());
6491         }
6492
6493         /* compute actual latency values for the given direction and store them all in per-port
6494            structures. this will also publish the same values (to JACK) so that computation of latency
6495            for routes can consistently use public latency values.
6496         */
6497
6498         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6499                 max_latency = max (max_latency, (*i)->set_private_port_latencies (playback));
6500         }
6501
6502         /* because we latency compensate playback, our published playback latencies should
6503            be the same for all output ports - all material played back by ardour has
6504            the same latency, whether its caused by plugins or by latency compensation. since
6505            these may differ from the values computed above, reset all playback port latencies
6506            to the same value.
6507         */
6508
6509         DEBUG_TRACE (DEBUG::Latency, string_compose ("Set public port latencies to %1\n", max_latency));
6510
6511         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6512                 (*i)->set_public_port_latencies (max_latency, playback);
6513         }
6514
6515         if (playback) {
6516
6517                 post_playback_latency ();
6518
6519         } else {
6520
6521                 post_capture_latency ();
6522         }
6523
6524         DEBUG_TRACE (DEBUG::Latency, "JACK latency callback: DONE\n");
6525 }
6526
6527 void
6528 Session::post_playback_latency ()
6529 {
6530         set_worst_playback_latency ();
6531
6532         boost::shared_ptr<RouteList> r = routes.reader ();
6533
6534         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6535                 if (!(*i)->is_auditioner() && ((*i)->active())) {
6536                         _worst_track_latency = max (_worst_track_latency, (*i)->update_signal_latency ());
6537                 }
6538         }
6539
6540         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6541                 (*i)->set_latency_compensation (_worst_track_latency);
6542         }
6543 }
6544
6545 void
6546 Session::post_capture_latency ()
6547 {
6548         set_worst_capture_latency ();
6549
6550         /* reflect any changes in capture latencies into capture offsets
6551          */
6552
6553         boost::shared_ptr<RouteList> rl = routes.reader();
6554         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
6555                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6556                 if (tr) {
6557                         tr->set_capture_offset ();
6558                 }
6559         }
6560 }
6561
6562 void
6563 Session::initialize_latencies ()
6564 {
6565         {
6566                 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
6567                 update_latency (false);
6568                 update_latency (true);
6569         }
6570
6571         set_worst_io_latencies ();
6572 }
6573
6574 void
6575 Session::set_worst_io_latencies ()
6576 {
6577         set_worst_playback_latency ();
6578         set_worst_capture_latency ();
6579 }
6580
6581 void
6582 Session::set_worst_playback_latency ()
6583 {
6584         if (_state_of_the_state & (InitialConnecting|Deletion)) {
6585                 return;
6586         }
6587
6588         _worst_output_latency = 0;
6589
6590         if (!_engine.connected()) {
6591                 return;
6592         }
6593
6594         boost::shared_ptr<RouteList> r = routes.reader ();
6595
6596         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6597                 _worst_output_latency = max (_worst_output_latency, (*i)->output()->latency());
6598         }
6599
6600         DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst output latency: %1\n", _worst_output_latency));
6601 }
6602
6603 void
6604 Session::set_worst_capture_latency ()
6605 {
6606         if (_state_of_the_state & (InitialConnecting|Deletion)) {
6607                 return;
6608         }
6609
6610         _worst_input_latency = 0;
6611
6612         if (!_engine.connected()) {
6613                 return;
6614         }
6615
6616         boost::shared_ptr<RouteList> r = routes.reader ();
6617
6618         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6619                 _worst_input_latency = max (_worst_input_latency, (*i)->input()->latency());
6620         }
6621
6622         DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst input latency: %1\n", _worst_input_latency));
6623 }
6624
6625 void
6626 Session::update_latency_compensation (bool force_whole_graph)
6627 {
6628         bool some_track_latency_changed = false;
6629
6630         if (_state_of_the_state & (InitialConnecting|Deletion)) {
6631                 return;
6632         }
6633
6634         DEBUG_TRACE(DEBUG::Latency, "---------------------------- update latency compensation\n\n");
6635
6636         _worst_track_latency = 0;
6637
6638         boost::shared_ptr<RouteList> r = routes.reader ();
6639
6640         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6641                 if (!(*i)->is_auditioner() && ((*i)->active())) {
6642                         framecnt_t tl;
6643                         if ((*i)->signal_latency () != (tl = (*i)->update_signal_latency ())) {
6644                                 some_track_latency_changed = true;
6645                         }
6646                         _worst_track_latency = max (tl, _worst_track_latency);
6647                 }
6648         }
6649
6650         DEBUG_TRACE (DEBUG::Latency, string_compose ("worst signal processing latency: %1 (changed ? %2)\n", _worst_track_latency,
6651                                                      (some_track_latency_changed ? "yes" : "no")));
6652
6653         DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
6654
6655         if (some_track_latency_changed || force_whole_graph)  {
6656                 _engine.update_latencies ();
6657         }
6658
6659
6660         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6661                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6662                 if (!tr) {
6663                         continue;
6664                 }
6665                 tr->set_capture_offset ();
6666         }
6667 }
6668
6669 char
6670 Session::session_name_is_legal (const string& path)
6671 {
6672         char illegal_chars[] = { '/', '\\', ':', ';', '\0' };
6673
6674         for (int i = 0; illegal_chars[i]; ++i) {
6675                 if (path.find (illegal_chars[i]) != string::npos) {
6676                         return illegal_chars[i];
6677                 }
6678         }
6679
6680         return 0;
6681 }
6682
6683 void
6684 Session::notify_presentation_info_change ()
6685 {
6686         if (deletion_in_progress()) {
6687                 return;
6688         }
6689
6690         Stripable::PresentationInfoChange (); /* EMIT SIGNAL */
6691         reassign_track_numbers();
6692
6693 #ifdef USE_TRACKS_CODE_FEATURES
6694         /* Waves Tracks: for Waves Tracks session it's required to reconnect their IOs
6695          * if track order has been changed by user
6696          */
6697         reconnect_existing_routes(true, true);
6698 #endif
6699
6700 }
6701
6702 bool
6703 Session::operation_in_progress (GQuark op) const
6704 {
6705         return (find (_current_trans_quarks.begin(), _current_trans_quarks.end(), op) != _current_trans_quarks.end());
6706 }
6707
6708 boost::shared_ptr<Port>
6709 Session::ltc_input_port () const
6710 {
6711         return _ltc_input->nth (0);
6712 }
6713
6714 boost::shared_ptr<Port>
6715 Session::ltc_output_port () const
6716 {
6717         return _ltc_output->nth (0);
6718 }
6719
6720 void
6721 Session::reconnect_ltc_input ()
6722 {
6723         if (_ltc_input) {
6724
6725                 string src = Config->get_ltc_source_port();
6726
6727                 _ltc_input->disconnect (this);
6728
6729                 if (src != _("None") && !src.empty())  {
6730                         _ltc_input->nth (0)->connect (src);
6731                 }
6732
6733                 if ( ARDOUR::Profile->get_trx () ) {
6734                         // Tracks need this signal to update timecode_source_dropdown
6735                         MtcOrLtcInputPortChanged (); //emit signal
6736                 }
6737         }
6738 }
6739
6740 void
6741 Session::reconnect_ltc_output ()
6742 {
6743         if (_ltc_output) {
6744
6745                 string src = Config->get_ltc_output_port();
6746
6747                 _ltc_output->disconnect (this);
6748
6749                 if (src != _("None") && !src.empty())  {
6750                         _ltc_output->nth (0)->connect (src);
6751                 }
6752         }
6753 }
6754
6755 void
6756 Session::set_range_selection (framepos_t start, framepos_t end)
6757 {
6758         _range_selection = Evoral::Range<framepos_t> (start, end);
6759 #ifdef USE_TRACKS_CODE_FEATURES
6760         follow_playhead_priority ();
6761 #endif
6762 }
6763
6764 void
6765 Session::set_object_selection (framepos_t start, framepos_t end)
6766 {
6767         _object_selection = Evoral::Range<framepos_t> (start, end);
6768 #ifdef USE_TRACKS_CODE_FEATURES
6769         follow_playhead_priority ();
6770 #endif
6771 }
6772
6773 void
6774 Session::clear_range_selection ()
6775 {
6776         _range_selection = Evoral::Range<framepos_t> (-1,-1);
6777 #ifdef USE_TRACKS_CODE_FEATURES
6778         follow_playhead_priority ();
6779 #endif
6780 }
6781
6782 void
6783 Session::clear_object_selection ()
6784 {
6785         _object_selection = Evoral::Range<framepos_t> (-1,-1);
6786 #ifdef USE_TRACKS_CODE_FEATURES
6787         follow_playhead_priority ();
6788 #endif
6789 }
6790
6791 void
6792 Session::auto_connect_route (boost::shared_ptr<Route> route, bool connect_inputs,
6793                 const ChanCount& input_start,
6794                 const ChanCount& output_start,
6795                 const ChanCount& input_offset,
6796                 const ChanCount& output_offset)
6797 {
6798         Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6799         _auto_connect_queue.push (AutoConnectRequest (route, connect_inputs,
6800                                 input_start, output_start,
6801                                 input_offset, output_offset));
6802
6803         if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
6804                 pthread_cond_signal (&_auto_connect_cond);
6805                 pthread_mutex_unlock (&_auto_connect_mutex);
6806         }
6807 }
6808
6809 void
6810 Session::auto_connect (const AutoConnectRequest& ar)
6811 {
6812         boost::shared_ptr<Route> route = ar.route.lock();
6813
6814         if (!route) { return; }
6815
6816         if (!IO::connecting_legal) {
6817                 return;
6818         }
6819
6820         /* If both inputs and outputs are auto-connected to physical ports,
6821          * use the max of input and output offsets to ensure auto-connected
6822          * port numbers always match up (e.g. the first audio input and the
6823          * first audio output of the route will have the same physical
6824          * port number).  Otherwise just use the lowest input or output
6825          * offset possible.
6826          */
6827
6828         const bool in_out_physical =
6829                 (Config->get_input_auto_connect() & AutoConnectPhysical)
6830                 && (Config->get_output_auto_connect() & AutoConnectPhysical)
6831                 && ar.connect_inputs;
6832
6833         const ChanCount in_offset = in_out_physical
6834                 ? ChanCount::max(ar.input_offset, ar.output_offset)
6835                 : ar.input_offset;
6836
6837         const ChanCount out_offset = in_out_physical
6838                 ? ChanCount::max(ar.input_offset, ar.output_offset)
6839                 : ar.output_offset;
6840
6841         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
6842                 vector<string> physinputs;
6843                 vector<string> physoutputs;
6844
6845                 _engine.get_physical_outputs (*t, physoutputs);
6846                 _engine.get_physical_inputs (*t, physinputs);
6847
6848                 if (!physinputs.empty() && ar.connect_inputs) {
6849                         uint32_t nphysical_in = physinputs.size();
6850
6851                         for (uint32_t i = ar.input_start.get(*t); i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
6852                                 string port;
6853
6854                                 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
6855                                         port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
6856                                 }
6857
6858                                 if (!port.empty() && route->input()->connect (route->input()->ports().port(*t, i), port, this)) {
6859                                         break;
6860                                 }
6861                         }
6862                 }
6863
6864                 if (!physoutputs.empty()) {
6865                         uint32_t nphysical_out = physoutputs.size();
6866                         for (uint32_t i = ar.output_start.get(*t); i < route->n_outputs().get(*t); ++i) {
6867                                 string port;
6868
6869                                 /* Waves Tracks:
6870                                  * do not create new connections if we reached the limit of physical outputs
6871                                  * in Multi Out mode
6872                                  */
6873                                 if (!(Config->get_output_auto_connect() & AutoConnectMaster) &&
6874                                                 ARDOUR::Profile->get_trx () &&
6875                                                 ar.output_offset.get(*t) == nphysical_out ) {
6876                                         break;
6877                                 }
6878
6879                                 if ((*t) == DataType::MIDI && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
6880                                         port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
6881                                 } else if ((*t) == DataType::AUDIO && (Config->get_output_auto_connect() & AutoConnectMaster)) {
6882                                         /* master bus is audio only */
6883                                         if (_master_out && _master_out->n_inputs().get(*t) > 0) {
6884                                                 port = _master_out->input()->ports().port(*t,
6885                                                                 i % _master_out->input()->n_ports().get(*t))->name();
6886                                         }
6887                                 }
6888
6889                                 if (!port.empty() && route->output()->connect (route->output()->ports().port(*t, i), port, this)) {
6890                                         break;
6891                                 }
6892                         }
6893                 }
6894         }
6895 }
6896
6897 void
6898 Session::auto_connect_thread_start ()
6899 {
6900         if (_ac_thread_active) {
6901                 return;
6902         }
6903
6904         while (!_auto_connect_queue.empty ()) {
6905                 _auto_connect_queue.pop ();
6906         }
6907
6908         _ac_thread_active = true;
6909         if (pthread_create (&_auto_connect_thread, NULL, auto_connect_thread, this)) {
6910                 _ac_thread_active = false;
6911         }
6912 }
6913
6914 void
6915 Session::auto_connect_thread_terminate ()
6916 {
6917         if (!_ac_thread_active) {
6918                 return;
6919         }
6920         _ac_thread_active = false;
6921
6922         {
6923                 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6924                 while (!_auto_connect_queue.empty ()) {
6925                         _auto_connect_queue.pop ();
6926                 }
6927         }
6928
6929         if (pthread_mutex_lock (&_auto_connect_mutex) == 0) {
6930                 pthread_cond_signal (&_auto_connect_cond);
6931                 pthread_mutex_unlock (&_auto_connect_mutex);
6932         }
6933
6934         void *status;
6935         pthread_join (_auto_connect_thread, &status);
6936 }
6937
6938 void *
6939 Session::auto_connect_thread (void *arg)
6940 {
6941         Session *s = static_cast<Session *>(arg);
6942         s->auto_connect_thread_run ();
6943         pthread_exit (0);
6944         return 0;
6945 }
6946
6947 void
6948 Session::auto_connect_thread_run ()
6949 {
6950         pthread_set_name (X_("autoconnect"));
6951         SessionEvent::create_per_thread_pool (X_("autoconnect"), 1024);
6952         PBD::notify_event_loops_about_thread_creation (pthread_self(), X_("autoconnect"), 1024);
6953         pthread_mutex_lock (&_auto_connect_mutex);
6954         while (_ac_thread_active) {
6955
6956                 if (!_auto_connect_queue.empty ()) {
6957                         // Why would we need the process lock ??
6958                         // A: if ports are added while we're connecting, the backend's iterator may be invalidated:
6959                         //   graph_order_callback() -> resort_routes() -> direct_feeds_according_to_reality () -> backend::connected_to()
6960                         //   All ardour-internal backends use a std::vector   xxxAudioBackend::find_port()
6961                         //   We have control over those, but what does jack do?
6962                         Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
6963
6964                         Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6965                         while (!_auto_connect_queue.empty ()) {
6966                                 const AutoConnectRequest ar (_auto_connect_queue.front());
6967                                 _auto_connect_queue.pop ();
6968                                 lx.release ();
6969                                 auto_connect (ar);
6970                                 lx.acquire ();
6971                         }
6972                 }
6973
6974                 pthread_cond_wait (&_auto_connect_cond, &_auto_connect_mutex);
6975         }
6976         pthread_mutex_unlock (&_auto_connect_mutex);
6977 }