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         reassign_track_numbers ();
3482 }
3483
3484 void
3485 Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
3486 {
3487         boost::shared_ptr<RouteList> r = routes.reader ();
3488         boost::shared_ptr<Send> s;
3489
3490         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3491                 if ((s = (*i)->internal_send_for (dest)) != 0) {
3492                         s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO, Controllable::NoGroup);
3493                 }
3494         }
3495 }
3496
3497 void
3498 Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
3499 {
3500         boost::shared_ptr<RouteList> r = routes.reader ();
3501         boost::shared_ptr<Send> s;
3502
3503         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3504                 if ((s = (*i)->internal_send_for (dest)) != 0) {
3505                         s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
3506                 }
3507         }
3508 }
3509
3510 void
3511 Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
3512 {
3513         boost::shared_ptr<RouteList> r = routes.reader ();
3514         boost::shared_ptr<Send> s;
3515
3516         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3517                 if ((s = (*i)->internal_send_for (dest)) != 0) {
3518                         s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value(), Controllable::NoGroup);
3519                 }
3520         }
3521 }
3522
3523 /** @param include_buses true to add sends to buses and tracks, false for just tracks */
3524 void
3525 Session::globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool include_buses)
3526 {
3527         boost::shared_ptr<RouteList> r = routes.reader ();
3528         boost::shared_ptr<RouteList> t (new RouteList);
3529
3530         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3531                 /* no MIDI sends because there are no MIDI busses yet */
3532                 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(*i)) {
3533                         t->push_back (*i);
3534                 }
3535         }
3536
3537         add_internal_sends (dest, p, t);
3538 }
3539
3540 void
3541 Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders)
3542 {
3543         for (RouteList::iterator i = senders->begin(); i != senders->end(); ++i) {
3544                 add_internal_send (dest, (*i)->before_processor_for_placement (p), *i);
3545         }
3546 }
3547
3548 void
3549 Session::add_internal_send (boost::shared_ptr<Route> dest, int index, boost::shared_ptr<Route> sender)
3550 {
3551         add_internal_send (dest, sender->before_processor_for_index (index), sender);
3552 }
3553
3554 void
3555 Session::add_internal_send (boost::shared_ptr<Route> dest, boost::shared_ptr<Processor> before, boost::shared_ptr<Route> sender)
3556 {
3557         if (sender->is_monitor() || sender->is_master() || sender == dest || dest->is_monitor() || dest->is_master()) {
3558                 return;
3559         }
3560
3561         if (!dest->internal_return()) {
3562                 dest->add_internal_return ();
3563         }
3564
3565         sender->add_aux_send (dest, before);
3566
3567         graph_reordered ();
3568 }
3569
3570 void
3571 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
3572 {
3573         { // RCU Writer scope
3574                 PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
3575                 RCUWriter<RouteList> writer (routes);
3576                 boost::shared_ptr<RouteList> rs = writer.get_copy ();
3577
3578
3579                 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3580
3581                         if (*iter == _master_out) {
3582                                 continue;
3583                         }
3584
3585                         (*iter)->solo_control()->set_value (0.0, Controllable::NoGroup);
3586
3587                         rs->remove (*iter);
3588
3589                         /* deleting the master out seems like a dumb
3590                            idea, but its more of a UI policy issue
3591                            than our concern.
3592                         */
3593
3594                         if (*iter == _master_out) {
3595                                 _master_out = boost::shared_ptr<Route> ();
3596                         }
3597
3598                         if (*iter == _monitor_out) {
3599                                 _monitor_out.reset ();
3600                         }
3601
3602                         // We need to disconnect the route's inputs and outputs
3603
3604                         (*iter)->input()->disconnect (0);
3605                         (*iter)->output()->disconnect (0);
3606
3607                         /* if the route had internal sends sending to it, remove them */
3608                         if ((*iter)->internal_return()) {
3609
3610                                 boost::shared_ptr<RouteList> r = routes.reader ();
3611                                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3612                                         boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
3613                                         if (s) {
3614                                                 (*i)->remove_processor (s);
3615                                         }
3616                                 }
3617                         }
3618
3619                         /* if the monitoring section had a pointer to this route, remove it */
3620                         if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
3621                                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3622                                 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
3623                                 (*iter)->remove_aux_or_listen (_monitor_out);
3624                         }
3625
3626                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
3627                         if (mt && mt->step_editing()) {
3628                                 if (_step_editors > 0) {
3629                                         _step_editors--;
3630                                 }
3631                         }
3632                 }
3633
3634                 /* writer goes out of scope, forces route list update */
3635
3636         } // end of RCU Writer scope
3637
3638         update_route_solo_state ();
3639         update_latency_compensation ();
3640         set_dirty();
3641
3642         /* Re-sort routes to remove the graph's current references to the one that is
3643          * going away, then flush old references out of the graph.
3644          * Wave Tracks: reconnect routes
3645          */
3646
3647 #ifdef USE_TRACKS_CODE_FEATURES
3648                 reconnect_existing_routes(true, false);
3649 #else
3650                 routes.flush (); // maybe unsafe, see below.
3651                 resort_routes ();
3652 #endif
3653
3654         if (_process_graph && !(_state_of_the_state & Deletion)) {
3655                 _process_graph->clear_other_chain ();
3656         }
3657
3658         /* get rid of it from the dead wood collection in the route list manager */
3659         /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
3660
3661         routes.flush ();
3662
3663         /* try to cause everyone to drop their references
3664          * and unregister ports from the backend
3665          */
3666
3667         for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3668                 (*iter)->drop_references ();
3669         }
3670
3671         if (_state_of_the_state & Deletion) {
3672                 return;
3673         }
3674
3675         Stripable::PresentationInfoChange(); /* EMIT SIGNAL */
3676
3677         /* save the new state of the world */
3678
3679         if (save_state (_current_snapshot_name)) {
3680                 save_history (_current_snapshot_name);
3681         }
3682
3683         update_route_record_state ();
3684 }
3685
3686 void
3687 Session::remove_route (boost::shared_ptr<Route> route)
3688 {
3689         boost::shared_ptr<RouteList> rl (new RouteList);
3690         rl->push_back (route);
3691         remove_routes (rl);
3692 }
3693
3694 void
3695 Session::route_mute_changed ()
3696 {
3697         set_dirty ();
3698 }
3699
3700 void
3701 Session::route_listen_changed (Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3702 {
3703         boost::shared_ptr<Route> route (wpr.lock());
3704
3705         if (!route) {
3706                 return;
3707         }
3708
3709         assert (Config->get_solo_control_is_listen_control());
3710
3711         if (route->solo_control()->soloed_by_self_or_masters()) {
3712
3713                 if (Config->get_exclusive_solo()) {
3714
3715                         RouteGroup* rg = route->route_group ();
3716                         const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3717
3718                         boost::shared_ptr<RouteList> r = routes.reader ();
3719
3720                         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3721                                 if ((*i) == route) {
3722                                         /* already changed */
3723                                         continue;
3724                                 }
3725
3726                                 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3727                                         /* route does not get solo propagated to it */
3728                                         continue;
3729                                 }
3730
3731                                 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3732                                         /* this route is a part of the same solo group as the route
3733                                          * that was changed. Changing that route did change or will
3734                                          * change all group members appropriately, so we can ignore it
3735                                          * here
3736                                          */
3737                                         continue;
3738                                 }
3739                                 (*i)->solo_control()->set_value (0.0, Controllable::NoGroup);
3740                         }
3741                 }
3742
3743                 _listen_cnt++;
3744
3745         } else if (_listen_cnt > 0) {
3746
3747                 _listen_cnt--;
3748         }
3749
3750         update_route_solo_state ();
3751 }
3752
3753 void
3754 Session::route_solo_isolated_changed (boost::weak_ptr<Route> wpr)
3755 {
3756         boost::shared_ptr<Route> route (wpr.lock());
3757
3758         if (!route) {
3759                 return;
3760         }
3761
3762         bool send_changed = false;
3763
3764         if (route->solo_isolate_control()->solo_isolated()) {
3765                 if (_solo_isolated_cnt == 0) {
3766                         send_changed = true;
3767                 }
3768                 _solo_isolated_cnt++;
3769         } else if (_solo_isolated_cnt > 0) {
3770                 _solo_isolated_cnt--;
3771                 if (_solo_isolated_cnt == 0) {
3772                         send_changed = true;
3773                 }
3774         }
3775
3776         if (send_changed) {
3777                 IsolatedChanged (); /* EMIT SIGNAL */
3778         }
3779 }
3780
3781 void
3782 Session::route_solo_changed (bool self_solo_changed, Controllable::GroupControlDisposition group_override,  boost::weak_ptr<Route> wpr)
3783 {
3784         DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1\n", self_solo_changed));
3785
3786         boost::shared_ptr<Route> route (wpr.lock());
3787
3788         if (!route) {
3789                 return;
3790         }
3791
3792         if (Config->get_solo_control_is_listen_control()) {
3793                 route_listen_changed (group_override, wpr);
3794                 return;
3795         }
3796
3797         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()));
3798
3799         if (route->solo_control()->transitioned_into_solo() == 0) {
3800                 /* route solo changed by upstream/downstream; not interesting
3801                    to Session.
3802                 */
3803                 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()));
3804                 return;
3805         }
3806
3807         if (route->solo_control()->transitioned_into_solo() == 0) {
3808                 /* reason for being soloed changed (e.g. master went away, we
3809                  * took over the master state), but actual status did
3810                  * not. nothing to do.
3811                  */
3812                 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: solo change was change in reason, not status\n", route->name()));
3813         }
3814
3815         boost::shared_ptr<RouteList> r = routes.reader ();
3816         int32_t delta = route->solo_control()->transitioned_into_solo ();
3817
3818         /* the route may be a member of a group that has shared-solo
3819          * semantics. If so, then all members of that group should follow the
3820          * solo of the changed route. But ... this is optional, controlled by a
3821          * Controllable::GroupControlDisposition.
3822          *
3823          * The first argument to the signal that this method is connected to is the
3824          * GroupControlDisposition value that was used to change solo.
3825          *
3826          * If the solo change was done with group semantics (either InverseGroup
3827          * (force the entire group to change even if the group shared solo is
3828          * disabled) or UseGroup (use the group, which may or may not have the
3829          * shared solo property enabled)) then as we propagate the change to
3830          * the entire session we should IGNORE THE GROUP that the changed route
3831          * belongs to.
3832          */
3833
3834         RouteGroup* rg = route->route_group ();
3835         const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3836
3837         if (delta == 1 && Config->get_exclusive_solo()) {
3838
3839                 /* new solo: disable all other solos, but not the group if its solo-enabled */
3840
3841                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3842
3843                         if ((*i) == route) {
3844                                 /* already changed */
3845                                 continue;
3846                         }
3847
3848                         if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3849                                 /* route does not get solo propagated to it */
3850                                 continue;
3851                         }
3852
3853                         if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3854                                 /* this route is a part of the same solo group as the route
3855                                  * that was changed. Changing that route did change or will
3856                                  * change all group members appropriately, so we can ignore it
3857                                  * here
3858                                  */
3859                                 continue;
3860                         }
3861
3862                         (*i)->solo_control()->set_value (0.0, group_override);
3863                 }
3864         }
3865
3866         DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
3867
3868         RouteList uninvolved;
3869
3870         DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
3871
3872         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3873                 bool via_sends_only;
3874                 bool in_signal_flow;
3875
3876                 if ((*i) == route) {
3877                         /* already changed */
3878                         continue;
3879                 }
3880
3881                 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3882                         /* route does not get solo propagated to it */
3883                         continue;
3884                 }
3885
3886                 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3887                         /* this route is a part of the same solo group as the route
3888                          * that was changed. Changing that route did change or will
3889                          * change all group members appropriately, so we can ignore it
3890                          * here
3891                          */
3892                         continue;
3893                 }
3894
3895                 in_signal_flow = false;
3896
3897                 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
3898
3899                 if ((*i)->feeds (route, &via_sends_only)) {
3900                         DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
3901                         if (!via_sends_only) {
3902                                 if (!route->soloed_by_others_upstream()) {
3903                                         (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3904                                 } else {
3905                                         DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others upstream\n");
3906                                 }
3907                         } else {
3908                                 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
3909                         }
3910                         in_signal_flow = true;
3911                 } else {
3912                         DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
3913                 }
3914
3915                 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
3916
3917                 if (route->feeds (*i, &via_sends_only)) {
3918                         /* propagate solo upstream only if routing other than
3919                            sends is involved, but do consider the other route
3920                            (*i) to be part of the signal flow even if only
3921                            sends are involved.
3922                         */
3923                         DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 feeds %2 via sends only %3 sboD %4 sboU %5\n",
3924                                                                   route->name(),
3925                                                                   (*i)->name(),
3926                                                                   via_sends_only,
3927                                                                   route->soloed_by_others_downstream(),
3928                                                                   route->soloed_by_others_upstream()));
3929                         if (!via_sends_only) {
3930                                 //NB. Triggers Invert Push, which handles soloed by downstream
3931                                 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
3932                                 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3933                         } else {
3934                                 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
3935                         }
3936                         in_signal_flow = true;
3937                 } else {
3938                         DEBUG_TRACE (DEBUG::Solo, "\tno feed to\n");
3939                 }
3940
3941                 if (!in_signal_flow) {
3942                         uninvolved.push_back (*i);
3943                 }
3944         }
3945
3946         DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
3947
3948         update_route_solo_state (r);
3949
3950         /* now notify that the mute state of the routes not involved in the signal
3951            pathway of the just-solo-changed route may have altered.
3952         */
3953
3954         for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
3955                 DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1, which neither feeds or is fed by %2\n", (*i)->name(), route->name()));
3956                 (*i)->act_on_mute ();
3957                 (*i)->mute_control()->Changed (false, Controllable::NoGroup);
3958         }
3959
3960         SoloChanged (); /* EMIT SIGNAL */
3961         set_dirty();
3962 }
3963
3964 void
3965 Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
3966 {
3967         /* now figure out if anything that matters is soloed (or is "listening")*/
3968
3969         bool something_soloed = false;
3970         bool something_listening = false;
3971         uint32_t listeners = 0;
3972         uint32_t isolated = 0;
3973
3974         if (!r) {
3975                 r = routes.reader();
3976         }
3977
3978         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3979                 if ((*i)->can_solo()) {
3980                         if (Config->get_solo_control_is_listen_control()) {
3981                                 if ((*i)->self_soloed() || (*i)->solo_control()->get_masters_value()) {
3982                                         listeners++;
3983                                         something_listening = true;
3984                                 }
3985                         } else {
3986                                 (*i)->set_listen (false);
3987                                 if ((*i)->can_solo() && ((*i)->self_soloed() || (*i)->solo_control()->get_masters_value())) {
3988                                         something_soloed = true;
3989                                 }
3990                         }
3991                 }
3992
3993                 if ((*i)->solo_isolate_control()->solo_isolated()) {
3994                         isolated++;
3995                 }
3996         }
3997
3998         if (something_soloed != _non_soloed_outs_muted) {
3999                 _non_soloed_outs_muted = something_soloed;
4000                 SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
4001         }
4002
4003         if (something_listening != _listening) {
4004                 _listening = something_listening;
4005                 SoloActive (_listening);
4006         }
4007
4008         _listen_cnt = listeners;
4009
4010         if (isolated != _solo_isolated_cnt) {
4011                 _solo_isolated_cnt = isolated;
4012                 IsolatedChanged (); /* EMIT SIGNAL */
4013         }
4014
4015         DEBUG_TRACE (DEBUG::Solo, string_compose ("solo state updated by session, soloed? %1 listeners %2 isolated %3\n",
4016                                                   something_soloed, listeners, isolated));
4017 }
4018
4019 void
4020 Session::get_stripables (StripableList& sl) const
4021 {
4022         boost::shared_ptr<RouteList> r = routes.reader ();
4023         sl.insert (sl.end(), r->begin(), r->end());
4024
4025         VCAList v = _vca_manager->vcas ();
4026         sl.insert (sl.end(), v.begin(), v.end());
4027 }
4028
4029 boost::shared_ptr<RouteList>
4030 Session::get_routes_with_internal_returns() const
4031 {
4032         boost::shared_ptr<RouteList> r = routes.reader ();
4033         boost::shared_ptr<RouteList> rl (new RouteList);
4034
4035         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4036                 if ((*i)->internal_return ()) {
4037                         rl->push_back (*i);
4038                 }
4039         }
4040         return rl;
4041 }
4042
4043 bool
4044 Session::io_name_is_legal (const std::string& name) const
4045 {
4046         boost::shared_ptr<RouteList> r = routes.reader ();
4047
4048         for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
4049                 if (name == *reserved) {
4050                         if (!route_by_name (*reserved)) {
4051                                 /* first instance of a reserved name is allowed */
4052                                 return true;
4053                         }
4054                         /* all other instances of a reserved name are not allowed */
4055                         return false;
4056                 }
4057         }
4058
4059         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4060                 if ((*i)->name() == name) {
4061                         return false;
4062                 }
4063
4064                 if ((*i)->has_io_processor_named (name)) {
4065                         return false;
4066                 }
4067         }
4068
4069         return true;
4070 }
4071
4072 void
4073 Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff, bool flip_others)
4074 {
4075         RouteList rl2;
4076         vector<string> connections;
4077
4078         /* if we are passed only a single route and we're not told to turn
4079          * others off, then just do the simple thing.
4080          */
4081
4082         if (flip_others == false && rl->size() == 1) {
4083                 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (rl->front());
4084                 if (mt) {
4085                         mt->set_input_active (onoff);
4086                         return;
4087                 }
4088         }
4089
4090         for (RouteList::iterator rt = rl->begin(); rt != rl->end(); ++rt) {
4091
4092                 PortSet& ps ((*rt)->input()->ports());
4093
4094                 for (PortSet::iterator p = ps.begin(); p != ps.end(); ++p) {
4095                         p->get_connections (connections);
4096                 }
4097
4098                 for (vector<string>::iterator s = connections.begin(); s != connections.end(); ++s) {
4099                         routes_using_input_from (*s, rl2);
4100                 }
4101
4102                 /* scan all relevant routes to see if others are on or off */
4103
4104                 bool others_are_already_on = false;
4105
4106                 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4107
4108                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4109
4110                         if (!mt) {
4111                                 continue;
4112                         }
4113
4114                         if ((*r) != (*rt)) {
4115                                 if (mt->input_active()) {
4116                                         others_are_already_on = true;
4117                                 }
4118                         } else {
4119                                 /* this one needs changing */
4120                                 mt->set_input_active (onoff);
4121                         }
4122                 }
4123
4124                 if (flip_others) {
4125
4126                         /* globally reverse other routes */
4127
4128                         for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4129                                 if ((*r) != (*rt)) {
4130                                         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4131                                         if (mt) {
4132                                                 mt->set_input_active (!others_are_already_on);
4133                                         }
4134                                 }
4135                         }
4136                 }
4137         }
4138 }
4139
4140 void
4141 Session::routes_using_input_from (const string& str, RouteList& rl)
4142 {
4143         boost::shared_ptr<RouteList> r = routes.reader();
4144
4145         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4146                 if ((*i)->input()->connected_to (str)) {
4147                         rl.push_back (*i);
4148                 }
4149         }
4150 }
4151
4152 boost::shared_ptr<Route>
4153 Session::route_by_name (string name) const
4154 {
4155         boost::shared_ptr<RouteList> r = routes.reader ();
4156
4157         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4158                 if ((*i)->name() == name) {
4159                         return *i;
4160                 }
4161         }
4162
4163         return boost::shared_ptr<Route> ((Route*) 0);
4164 }
4165
4166 boost::shared_ptr<Route>
4167 Session::route_by_id (PBD::ID id) const
4168 {
4169         boost::shared_ptr<RouteList> r = routes.reader ();
4170
4171         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4172                 if ((*i)->id() == id) {
4173                         return *i;
4174                 }
4175         }
4176
4177         return boost::shared_ptr<Route> ((Route*) 0);
4178 }
4179
4180 boost::shared_ptr<Processor>
4181 Session::processor_by_id (PBD::ID id) const
4182 {
4183         boost::shared_ptr<RouteList> r = routes.reader ();
4184
4185         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4186                 boost::shared_ptr<Processor> p = (*i)->Route::processor_by_id (id);
4187                 if (p) {
4188                         return p;
4189                 }
4190         }
4191
4192         return boost::shared_ptr<Processor> ();
4193 }
4194
4195 boost::shared_ptr<Track>
4196 Session::track_by_diskstream_id (PBD::ID id) const
4197 {
4198         boost::shared_ptr<RouteList> r = routes.reader ();
4199
4200         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4201                 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4202                 if (t && t->using_diskstream_id (id)) {
4203                         return t;
4204                 }
4205         }
4206
4207         return boost::shared_ptr<Track> ();
4208 }
4209
4210 boost::shared_ptr<Route>
4211 Session::get_remote_nth_route (uint16_t n) const
4212 {
4213         return boost::dynamic_pointer_cast<Route> (get_remote_nth_stripable (n, PresentationInfo::Route));
4214 }
4215
4216 boost::shared_ptr<Stripable>
4217 Session::get_remote_nth_stripable (uint16_t n, PresentationInfo::Flag flags) const
4218 {
4219         boost::shared_ptr<RouteList> r = routes.reader ();
4220         vector<boost::shared_ptr<Route> > v;
4221
4222         if (n >= r->size()) {
4223                 return boost::shared_ptr<Route> ();
4224         }
4225
4226         v.assign (r->size(), boost::shared_ptr<Route>());
4227
4228         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4229                 if ((*i)->presentation_info().flag_match (flags)) {
4230                         v[(*i)->presentation_info().group_order()] = (*i);
4231                 }
4232         }
4233
4234         return v[n];
4235 }
4236
4237 boost::shared_ptr<Route>
4238 Session::route_by_selected_count (uint32_t id) const
4239 {
4240         boost::shared_ptr<RouteList> r = routes.reader ();
4241
4242         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4243                 /* NOT IMPLEMENTED */
4244         }
4245
4246         return boost::shared_ptr<Route> ((Route*) 0);
4247 }
4248
4249 struct PresentationOrderSorter {
4250         bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
4251                 if (a->presentation_info().special() && !b->presentation_info().special()) {
4252                         /* a is not ordered, b is; b comes before a */
4253                         return false;
4254                 } else if (b->presentation_info().unordered() && !a->presentation_info().unordered()) {
4255                         /* b is not ordered, a is; a comes before b */
4256                         return true;
4257                 } else {
4258                         return a->presentation_info().global_order() < b->presentation_info().global_order();
4259                 }
4260         }
4261 };
4262
4263 void
4264 Session::reassign_track_numbers ()
4265 {
4266         int64_t tn = 0;
4267         int64_t bn = 0;
4268         RouteList r (*(routes.reader ()));
4269         PresentationOrderSorter sorter;
4270         r.sort (sorter);
4271
4272         StateProtector sp (this);
4273
4274         for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4275                 if (boost::dynamic_pointer_cast<Track> (*i)) {
4276                         (*i)->set_track_number(++tn);
4277                 }
4278                 else if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner()) {
4279                         (*i)->set_track_number(--bn);
4280                 }
4281         }
4282         const uint32_t decimals = ceilf (log10f (tn + 1));
4283         const bool decimals_changed = _track_number_decimals != decimals;
4284         _track_number_decimals = decimals;
4285
4286         if (decimals_changed && config.get_track_name_number ()) {
4287                 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4288                         boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4289                         if (t) {
4290                                 t->resync_track_name();
4291                         }
4292                 }
4293                 // trigger GUI re-layout
4294                 config.ParameterChanged("track-name-number");
4295         }
4296
4297 #ifndef NDEBUG
4298         if (DEBUG_ENABLED(DEBUG::OrderKeys)) {
4299                 boost::shared_ptr<RouteList> rl = routes.reader ();
4300                 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4301                         DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1 numbered %2\n", (*i)->name(), (*i)->track_number()));
4302                 }
4303         }
4304 #endif /* NDEBUG */
4305
4306 }
4307
4308 void
4309 Session::playlist_region_added (boost::weak_ptr<Region> w)
4310 {
4311         boost::shared_ptr<Region> r = w.lock ();
4312         if (!r) {
4313                 return;
4314         }
4315
4316         /* These are the operations that are currently in progress... */
4317         list<GQuark> curr = _current_trans_quarks;
4318         curr.sort ();
4319
4320         /* ...and these are the operations during which we want to update
4321            the session range location markers.
4322         */
4323         list<GQuark> ops;
4324         ops.push_back (Operations::capture);
4325         ops.push_back (Operations::paste);
4326         ops.push_back (Operations::duplicate_region);
4327         ops.push_back (Operations::insert_file);
4328         ops.push_back (Operations::insert_region);
4329         ops.push_back (Operations::drag_region_brush);
4330         ops.push_back (Operations::region_drag);
4331         ops.push_back (Operations::selection_grab);
4332         ops.push_back (Operations::region_fill);
4333         ops.push_back (Operations::fill_selection);
4334         ops.push_back (Operations::create_region);
4335         ops.push_back (Operations::region_copy);
4336         ops.push_back (Operations::fixed_time_region_copy);
4337         ops.sort ();
4338
4339         /* See if any of the current operations match the ones that we want */
4340         list<GQuark> in;
4341         set_intersection (_current_trans_quarks.begin(), _current_trans_quarks.end(), ops.begin(), ops.end(), back_inserter (in));
4342
4343         /* If so, update the session range markers */
4344         if (!in.empty ()) {
4345                 maybe_update_session_range (r->position (), r->last_frame ());
4346         }
4347 }
4348
4349 /** Update the session range markers if a is before the current start or
4350  *  b is after the current end.
4351  */
4352 void
4353 Session::maybe_update_session_range (framepos_t a, framepos_t b)
4354 {
4355         if (_state_of_the_state & Loading) {
4356                 return;
4357         }
4358
4359         framepos_t session_end_marker_shift_samples = session_end_shift * _nominal_frame_rate;
4360
4361         if (_session_range_location == 0) {
4362
4363                 set_session_range_location (a, b + session_end_marker_shift_samples);
4364
4365         } else {
4366
4367                 if (a < _session_range_location->start()) {
4368                         _session_range_location->set_start (a);
4369                 }
4370
4371                 if (b > _session_range_location->end()) {
4372                         _session_range_location->set_end (b);
4373                 }
4374         }
4375 }
4376
4377 void
4378 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
4379 {
4380         for (list<Evoral::RangeMove<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4381                 maybe_update_session_range (i->to, i->to + i->length);
4382         }
4383 }
4384
4385 void
4386 Session::playlist_regions_extended (list<Evoral::Range<framepos_t> > const & ranges)
4387 {
4388         for (list<Evoral::Range<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4389                 maybe_update_session_range (i->from, i->to);
4390         }
4391 }
4392
4393 /* Region management */
4394
4395 boost::shared_ptr<Region>
4396 Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
4397 {
4398         const RegionFactory::RegionMap& regions (RegionFactory::regions());
4399         RegionFactory::RegionMap::const_iterator i;
4400         boost::shared_ptr<Region> region;
4401
4402         Glib::Threads::Mutex::Lock lm (region_lock);
4403
4404         for (i = regions.begin(); i != regions.end(); ++i) {
4405
4406                 region = i->second;
4407
4408                 if (region->whole_file()) {
4409
4410                         if (child->source_equivalent (region)) {
4411                                 return region;
4412                         }
4413                 }
4414         }
4415
4416         return boost::shared_ptr<Region> ();
4417 }
4418
4419 int
4420 Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
4421 {
4422         set<boost::shared_ptr<Region> > relevant_regions;
4423
4424         for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
4425                 RegionFactory::get_regions_using_source (*s, relevant_regions);
4426         }
4427
4428         for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
4429                 set<boost::shared_ptr<Region> >::iterator tmp;
4430
4431                 tmp = r;
4432                 ++tmp;
4433
4434                 playlists->destroy_region (*r);
4435                 RegionFactory::map_remove (*r);
4436
4437                 (*r)->drop_sources ();
4438                 (*r)->drop_references ();
4439
4440                 relevant_regions.erase (r);
4441
4442                 r = tmp;
4443         }
4444
4445         for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
4446
4447                 {
4448                         Glib::Threads::Mutex::Lock ls (source_lock);
4449                         /* remove from the main source list */
4450                         sources.erase ((*s)->id());
4451                 }
4452
4453                 (*s)->mark_for_remove ();
4454                 (*s)->drop_references ();
4455
4456                 s = srcs.erase (s);
4457         }
4458
4459         return 0;
4460 }
4461
4462 int
4463 Session::remove_last_capture ()
4464 {
4465         list<boost::shared_ptr<Source> > srcs;
4466
4467         boost::shared_ptr<RouteList> rl = routes.reader ();
4468         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4469                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4470                 if (!tr) {
4471                         continue;
4472                 }
4473
4474                 list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
4475
4476                 if (!l.empty()) {
4477                         srcs.insert (srcs.end(), l.begin(), l.end());
4478                         l.clear ();
4479                 }
4480         }
4481
4482         destroy_sources (srcs);
4483
4484         save_state (_current_snapshot_name);
4485
4486         return 0;
4487 }
4488
4489 /* Source Management */
4490
4491 void
4492 Session::add_source (boost::shared_ptr<Source> source)
4493 {
4494         pair<SourceMap::key_type, SourceMap::mapped_type> entry;
4495         pair<SourceMap::iterator,bool> result;
4496
4497         entry.first = source->id();
4498         entry.second = source;
4499
4500         {
4501                 Glib::Threads::Mutex::Lock lm (source_lock);
4502                 result = sources.insert (entry);
4503         }
4504
4505         if (result.second) {
4506
4507                 /* yay, new source */
4508
4509                 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
4510
4511                 if (fs) {
4512                         if (!fs->within_session()) {
4513                                 ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
4514                         }
4515                 }
4516
4517                 set_dirty();
4518
4519                 boost::shared_ptr<AudioFileSource> afs;
4520
4521                 if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
4522                         if (Config->get_auto_analyse_audio()) {
4523                                 Analyser::queue_source_for_analysis (source, false);
4524                         }
4525                 }
4526
4527                 source->DropReferences.connect_same_thread (*this, boost::bind (&Session::remove_source, this, boost::weak_ptr<Source> (source)));
4528         }
4529 }
4530
4531 void
4532 Session::remove_source (boost::weak_ptr<Source> src)
4533 {
4534         if (_state_of_the_state & Deletion) {
4535                 return;
4536         }
4537
4538         SourceMap::iterator i;
4539         boost::shared_ptr<Source> source = src.lock();
4540
4541         if (!source) {
4542                 return;
4543         }
4544
4545         {
4546                 Glib::Threads::Mutex::Lock lm (source_lock);
4547
4548                 if ((i = sources.find (source->id())) != sources.end()) {
4549                         sources.erase (i);
4550                 }
4551         }
4552
4553         if (!(_state_of_the_state & StateOfTheState (InCleanup|Loading))) {
4554
4555                 /* save state so we don't end up with a session file
4556                    referring to non-existent sources.
4557                 */
4558
4559                 save_state (_current_snapshot_name);
4560         }
4561 }
4562
4563 boost::shared_ptr<Source>
4564 Session::source_by_id (const PBD::ID& id)
4565 {
4566         Glib::Threads::Mutex::Lock lm (source_lock);
4567         SourceMap::iterator i;
4568         boost::shared_ptr<Source> source;
4569
4570         if ((i = sources.find (id)) != sources.end()) {
4571                 source = i->second;
4572         }
4573
4574         return source;
4575 }
4576
4577 boost::shared_ptr<AudioFileSource>
4578 Session::audio_source_by_path_and_channel (const string& path, uint16_t chn) const
4579 {
4580         /* Restricted to audio files because only audio sources have channel
4581            as a property.
4582         */
4583
4584         Glib::Threads::Mutex::Lock lm (source_lock);
4585
4586         for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
4587                 boost::shared_ptr<AudioFileSource> afs
4588                         = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
4589
4590                 if (afs && afs->path() == path && chn == afs->channel()) {
4591                         return afs;
4592                 }
4593         }
4594
4595         return boost::shared_ptr<AudioFileSource>();
4596 }
4597
4598 boost::shared_ptr<MidiSource>
4599 Session::midi_source_by_path (const std::string& path) const
4600 {
4601         /* Restricted to MIDI files because audio sources require a channel
4602            for unique identification, in addition to a path.
4603         */
4604
4605         Glib::Threads::Mutex::Lock lm (source_lock);
4606
4607         for (SourceMap::const_iterator s = sources.begin(); s != sources.end(); ++s) {
4608                 boost::shared_ptr<MidiSource> ms
4609                         = boost::dynamic_pointer_cast<MidiSource>(s->second);
4610                 boost::shared_ptr<FileSource> fs
4611                         = boost::dynamic_pointer_cast<FileSource>(s->second);
4612
4613                 if (ms && fs && fs->path() == path) {
4614                         return ms;
4615                 }
4616         }
4617
4618         return boost::shared_ptr<MidiSource>();
4619 }
4620
4621 uint32_t
4622 Session::count_sources_by_origin (const string& path)
4623 {
4624         uint32_t cnt = 0;
4625         Glib::Threads::Mutex::Lock lm (source_lock);
4626
4627         for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
4628                 boost::shared_ptr<FileSource> fs
4629                         = boost::dynamic_pointer_cast<FileSource>(i->second);
4630
4631                 if (fs && fs->origin() == path) {
4632                         ++cnt;
4633                 }
4634         }
4635
4636         return cnt;
4637 }
4638
4639 static string
4640 peak_file_helper (const string& peak_path, const string& file_path, const string& file_base, bool hash) {
4641         if (hash) {
4642                 std::string checksum = Glib::Checksum::compute_checksum(Glib::Checksum::CHECKSUM_SHA1, file_path + G_DIR_SEPARATOR + file_base);
4643                 return Glib::build_filename (peak_path, checksum + peakfile_suffix);
4644         } else {
4645                 return Glib::build_filename (peak_path, file_base + peakfile_suffix);
4646         }
4647 }
4648
4649 string
4650 Session::construct_peak_filepath (const string& filepath, const bool in_session, const bool old_peak_name) const
4651 {
4652         string interchange_dir_string = string (interchange_dir_name) + G_DIR_SEPARATOR;
4653
4654         if (Glib::path_is_absolute (filepath)) {
4655
4656                 /* rip the session dir from the audiofile source */
4657
4658                 string session_path;
4659                 bool in_another_session = true;
4660
4661                 if (filepath.find (interchange_dir_string) != string::npos) {
4662
4663                         session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
4664                         session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
4665                         session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
4666                         session_path = Glib::path_get_dirname (session_path); /* now has session path */
4667
4668                         /* see if it is within our session */
4669
4670                         for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
4671                                 if (i->path == session_path) {
4672                                         in_another_session = false;
4673                                         break;
4674                                 }
4675                         }
4676                 } else {
4677                         in_another_session = false;
4678                 }
4679
4680
4681                 if (in_another_session) {
4682                         SessionDirectory sd (session_path);
4683                         return peak_file_helper (sd.peak_path(), "", Glib::path_get_basename (filepath), !old_peak_name);
4684                 }
4685         }
4686
4687         /* 1) if file belongs to this session
4688          * it may be a relative path (interchange/...)
4689          * or just basename (session_state, remove source)
4690          * -> just use the basename
4691          */
4692         std::string filename = Glib::path_get_basename (filepath);
4693         std::string path;
4694
4695         /* 2) if the file is outside our session dir:
4696          * (imported but not copied) add the path for check-summming */
4697         if (!in_session) {
4698                 path = Glib::path_get_dirname (filepath);
4699         }
4700
4701         return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
4702 }
4703
4704 string
4705 Session::new_audio_source_path_for_embedded (const std::string& path)
4706 {
4707         /* embedded source:
4708          *
4709          * we know that the filename is already unique because it exists
4710          * out in the filesystem.
4711          *
4712          * However, when we bring it into the session, we could get a
4713          * collision.
4714          *
4715          * Eg. two embedded files:
4716          *
4717          *          /foo/bar/baz.wav
4718          *          /frob/nic/baz.wav
4719          *
4720          * When merged into session, these collide.
4721          *
4722          * There will not be a conflict with in-memory sources
4723          * because when the source was created we already picked
4724          * a unique name for it.
4725          *
4726          * This collision is not likely to be common, but we have to guard
4727          * against it.  So, if there is a collision, take the md5 hash of the
4728          * the path, and use that as the filename instead.
4729          */
4730
4731         SessionDirectory sdir (get_best_session_directory_for_new_audio());
4732         string base = Glib::path_get_basename (path);
4733         string newpath = Glib::build_filename (sdir.sound_path(), base);
4734
4735         if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4736
4737                 MD5 md5;
4738
4739                 md5.digestString (path.c_str());
4740                 md5.writeToString ();
4741                 base = md5.digestChars;
4742
4743                 string ext = get_suffix (path);
4744
4745                 if (!ext.empty()) {
4746                         base += '.';
4747                         base += ext;
4748                 }
4749
4750                 newpath = Glib::build_filename (sdir.sound_path(), base);
4751
4752                 /* if this collides, we're screwed */
4753
4754                 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4755                         error << string_compose (_("Merging embedded file %1: name collision AND md5 hash collision!"), path) << endmsg;
4756                         return string();
4757                 }
4758
4759         }
4760
4761         return newpath;
4762 }
4763
4764 /** Return true if there are no audio file sources that use @param name as
4765  * the filename component of their path.
4766  *
4767  * Return false otherwise.
4768  *
4769  * This method MUST ONLY be used to check in-session, mono files since it
4770  * hard-codes the channel of the audio file source we are looking for as zero.
4771  *
4772  * If/when Ardour supports native files in non-mono formats, the logic here
4773  * will need to be revisited.
4774  */
4775 bool
4776 Session::audio_source_name_is_unique (const string& name)
4777 {
4778         std::vector<string> sdirs = source_search_path (DataType::AUDIO);
4779         vector<space_and_path>::iterator i;
4780         uint32_t existing = 0;
4781
4782         for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4783
4784                 /* note that we search *without* the extension so that
4785                    we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
4786                    in the event that this new name is required for
4787                    a file format change.
4788                 */
4789
4790                 const string spath = *i;
4791
4792                 if (matching_unsuffixed_filename_exists_in (spath, name)) {
4793                         existing++;
4794                         break;
4795                 }
4796
4797                 /* it is possible that we have the path already
4798                  * assigned to a source that has not yet been written
4799                  * (ie. the write source for a diskstream). we have to
4800                  * check this in order to make sure that our candidate
4801                  * path isn't used again, because that can lead to
4802                  * two Sources point to the same file with different
4803                  * notions of their removability.
4804                  */
4805
4806
4807                 string possible_path = Glib::build_filename (spath, name);
4808
4809                 if (audio_source_by_path_and_channel (possible_path, 0)) {
4810                         existing++;
4811                         break;
4812                 }
4813         }
4814
4815         return (existing == 0);
4816 }
4817
4818 string
4819 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)
4820 {
4821         ostringstream sstr;
4822         const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
4823
4824         if (Profile->get_trx() && destructive) {
4825                 sstr << 'T';
4826                 sstr << setfill ('0') << setw (4) << cnt;
4827                 sstr << legalized_base;
4828         } else {
4829                 sstr << legalized_base;
4830
4831                 if (take_required || related_exists) {
4832                         sstr << '-';
4833                         sstr << cnt;
4834                 }
4835         }
4836
4837         if (nchan == 2) {
4838                 if (chan == 0) {
4839                         sstr << "%L";
4840                 } else {
4841                         sstr << "%R";
4842                 }
4843         } else if (nchan > 2) {
4844                 if (nchan < 26) {
4845                         sstr << '%';
4846                         sstr << 'a' + chan;
4847                 } else {
4848                         /* XXX what? more than 26 channels! */
4849                         sstr << '%';
4850                         sstr << chan+1;
4851                 }
4852         }
4853
4854         sstr << ext;
4855
4856         return sstr.str();
4857 }
4858
4859 /** Return a unique name based on \a base for a new internal audio source */
4860 string
4861 Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required)
4862 {
4863         uint32_t cnt;
4864         string possible_name;
4865         const uint32_t limit = 9999; // arbitrary limit on number of files with the same basic name
4866         string legalized;
4867         bool some_related_source_name_exists = false;
4868
4869         legalized = legalize_for_path (base);
4870
4871         // Find a "version" of the base name that doesn't exist in any of the possible directories.
4872
4873         for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
4874
4875                 possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
4876
4877                 if (audio_source_name_is_unique (possible_name)) {
4878                         break;
4879                 }
4880
4881                 some_related_source_name_exists = true;
4882
4883                 if (cnt > limit) {
4884                         error << string_compose(
4885                                         _("There are already %1 recordings for %2, which I consider too many."),
4886                                         limit, base) << endmsg;
4887                         destroy ();
4888                         throw failed_constructor();
4889                 }
4890         }
4891
4892         /* We've established that the new name does not exist in any session
4893          * directory, so now find out which one we should use for this new
4894          * audio source.
4895          */
4896
4897         SessionDirectory sdir (get_best_session_directory_for_new_audio());
4898
4899         std::string s = Glib::build_filename (sdir.sound_path(), possible_name);
4900
4901         return s;
4902 }
4903
4904 /** Return a unique name based on `base` for a new internal MIDI source */
4905 string
4906 Session::new_midi_source_path (const string& base)
4907 {
4908         uint32_t cnt;
4909         char buf[PATH_MAX+1];
4910         const uint32_t limit = 10000;
4911         string legalized;
4912         string possible_path;
4913         string possible_name;
4914
4915         buf[0] = '\0';
4916         legalized = legalize_for_path (base);
4917
4918         // Find a "version" of the file name that doesn't exist in any of the possible directories.
4919         std::vector<string> sdirs = source_search_path(DataType::MIDI);
4920
4921         /* - the main session folder is the first in the vector.
4922          * - after checking all locations for file-name uniqueness,
4923          *   we keep the one from the last iteration as new file name
4924          * - midi files are small and should just be kept in the main session-folder
4925          *
4926          * -> reverse the array, check main session folder last and use that as location
4927          *    for MIDI files.
4928          */
4929         std::reverse(sdirs.begin(), sdirs.end());
4930
4931         for (cnt = 1; cnt <= limit; ++cnt) {
4932
4933                 vector<space_and_path>::iterator i;
4934                 uint32_t existing = 0;
4935
4936                 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4937
4938                         snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
4939                         possible_name = buf;
4940
4941                         possible_path = Glib::build_filename (*i, possible_name);
4942
4943                         if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
4944                                 existing++;
4945                         }
4946
4947                         if (midi_source_by_path (possible_path)) {
4948                                 existing++;
4949                         }
4950                 }
4951
4952                 if (existing == 0) {
4953                         break;
4954                 }
4955
4956                 if (cnt > limit) {
4957                         error << string_compose(
4958                                         _("There are already %1 recordings for %2, which I consider too many."),
4959                                         limit, base) << endmsg;
4960                         destroy ();
4961                         return 0;
4962                 }
4963         }
4964
4965         /* No need to "find best location" for software/app-based RAID, because
4966            MIDI is so small that we always put it in the same place.
4967         */
4968
4969         return possible_path;
4970 }
4971
4972
4973 /** Create a new within-session audio source */
4974 boost::shared_ptr<AudioFileSource>
4975 Session::create_audio_source_for_session (size_t n_chans, string const & base, uint32_t chan, bool destructive)
4976 {
4977         const string path = new_audio_source_path (base, n_chans, chan, destructive, true);
4978
4979         if (!path.empty()) {
4980                 return boost::dynamic_pointer_cast<AudioFileSource> (
4981                         SourceFactory::createWritable (DataType::AUDIO, *this, path, destructive, frame_rate(), true, true));
4982         } else {
4983                 throw failed_constructor ();
4984         }
4985 }
4986
4987 /** Create a new within-session MIDI source */
4988 boost::shared_ptr<MidiSource>
4989 Session::create_midi_source_for_session (string const & basic_name)
4990 {
4991         const string path = new_midi_source_path (basic_name);
4992
4993         if (!path.empty()) {
4994                 return boost::dynamic_pointer_cast<SMFSource> (
4995                         SourceFactory::createWritable (
4996                                 DataType::MIDI, *this, path, false, frame_rate()));
4997         } else {
4998                 throw failed_constructor ();
4999         }
5000 }
5001
5002 /** Create a new within-session MIDI source */
5003 boost::shared_ptr<MidiSource>
5004 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
5005 {
5006         /* the caller passes in the track the source will be used in,
5007            so that we can keep the numbering sane.
5008
5009            Rationale: a track with the name "Foo" that has had N
5010            captures carried out so far will ALREADY have a write source
5011            named "Foo-N+1.mid" waiting to be used for the next capture.
5012
5013            If we call new_midi_source_name() we will get "Foo-N+2". But
5014            there is no region corresponding to "Foo-N+1", so when
5015            "Foo-N+2" appears in the track, the gap presents the user
5016            with odd behaviour - why did it skip past Foo-N+1?
5017
5018            We could explain this to the user in some odd way, but
5019            instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
5020            use "Foo-N+1" here.
5021
5022            If that attempted rename fails, we get "Foo-N+2.mid" anyway.
5023         */
5024
5025         boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
5026         assert (mt);
5027         std::string name = track->steal_write_source_name ();
5028
5029         if (name.empty()) {
5030                 return boost::shared_ptr<MidiSource>();
5031         }
5032
5033         /* MIDI files are small, just put them in the first location of the
5034            session source search path.
5035         */
5036
5037         const string path = Glib::build_filename (source_search_path (DataType::MIDI).front(), name);
5038
5039         return boost::dynamic_pointer_cast<SMFSource> (
5040                 SourceFactory::createWritable (
5041                         DataType::MIDI, *this, path, false, frame_rate()));
5042 }
5043
5044
5045 void
5046 Session::add_playlist (boost::shared_ptr<Playlist> playlist, bool unused)
5047 {
5048         if (playlist->hidden()) {
5049                 return;
5050         }
5051
5052         playlists->add (playlist);
5053
5054         if (unused) {
5055                 playlist->release();
5056         }
5057
5058         set_dirty();
5059 }
5060
5061 void
5062 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
5063 {
5064         if (_state_of_the_state & Deletion) {
5065                 return;
5066         }
5067
5068         boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
5069
5070         if (!playlist) {
5071                 return;
5072         }
5073
5074         playlists->remove (playlist);
5075
5076         set_dirty();
5077 }
5078
5079 void
5080 Session::set_audition (boost::shared_ptr<Region> r)
5081 {
5082         pending_audition_region = r;
5083         add_post_transport_work (PostTransportAudition);
5084         _butler->schedule_transport_work ();
5085 }
5086
5087 void
5088 Session::audition_playlist ()
5089 {
5090         SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5091         ev->region.reset ();
5092         queue_event (ev);
5093 }
5094
5095
5096 void
5097 Session::register_lua_function (
5098                 const std::string& name,
5099                 const std::string& script,
5100                 const LuaScriptParamList& args
5101                 )
5102 {
5103         Glib::Threads::Mutex::Lock lm (lua_lock);
5104
5105         lua_State* L = lua.getState();
5106
5107         const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
5108         luabridge::LuaRef tbl_arg (luabridge::newTable(L));
5109         for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
5110                 if ((*i)->optional && !(*i)->is_set) { continue; }
5111                 tbl_arg[(*i)->name] = (*i)->value;
5112         }
5113         (*_lua_add)(name, bytecode, tbl_arg); // throws luabridge::LuaException
5114         set_dirty();
5115 }
5116
5117 void
5118 Session::unregister_lua_function (const std::string& name)
5119 {
5120         Glib::Threads::Mutex::Lock lm (lua_lock);
5121         (*_lua_del)(name); // throws luabridge::LuaException
5122         lua.collect_garbage ();
5123         set_dirty();
5124 }
5125
5126 std::vector<std::string>
5127 Session::registered_lua_functions ()
5128 {
5129         Glib::Threads::Mutex::Lock lm (lua_lock);
5130         std::vector<std::string> rv;
5131
5132         try {
5133                 luabridge::LuaRef list ((*_lua_list)());
5134                 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5135                         if (!i.key ().isString ()) { assert(0); continue; }
5136                         rv.push_back (i.key ().cast<std::string> ());
5137                 }
5138         } catch (luabridge::LuaException const& e) { }
5139         return rv;
5140 }
5141
5142 #ifndef NDEBUG
5143 static void _lua_print (std::string s) {
5144         std::cout << "SessionLua: " << s << "\n";
5145 }
5146 #endif
5147
5148 void
5149 Session::try_run_lua (pframes_t nframes)
5150 {
5151         if (_n_lua_scripts == 0) return;
5152         Glib::Threads::Mutex::Lock tm (lua_lock, Glib::Threads::TRY_LOCK);
5153         if (tm.locked ()) {
5154                 try { (*_lua_run)(nframes); } catch (luabridge::LuaException const& e) { }
5155         }
5156 }
5157
5158 void
5159 Session::setup_lua ()
5160 {
5161 #ifndef NDEBUG
5162         lua.Print.connect (&_lua_print);
5163 #endif
5164         lua.do_command (
5165                         "function ArdourSession ()"
5166                         "  local self = { scripts = {}, instances = {} }"
5167                         ""
5168                         "  local remove = function (n)"
5169                         "   self.scripts[n] = nil"
5170                         "   self.instances[n] = nil"
5171                         "   Session:scripts_changed()" // call back
5172                         "  end"
5173                         ""
5174                         "  local addinternal = function (n, f, a)"
5175                         "   assert(type(n) == 'string', 'function-name must be string')"
5176                         "   assert(type(f) == 'function', 'Given script is a not a function')"
5177                         "   assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
5178                         "   assert(self.scripts[n] == nil, 'Callback \"'.. n ..'\" already exists.')"
5179                         "   self.scripts[n] = { ['f'] = f, ['a'] = a }"
5180                         "   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"
5181                         "   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 }"
5182                         "   self.instances[n] = load (string.dump(f, true), nil, nil, env)(a)"
5183                         "   Session:scripts_changed()" // call back
5184                         "  end"
5185                         ""
5186                         "  local add = function (n, b, a)"
5187                         "   assert(type(b) == 'string', 'ByteCode must be string')"
5188                         "   load (b)()" // assigns f
5189                         "   assert(type(f) == 'string', 'Assigned ByteCode must be string')"
5190                         "   addinternal (n, load(f), a)"
5191                         "  end"
5192                         ""
5193                         "  local run = function (...)"
5194                         "   for n, s in pairs (self.instances) do"
5195                         "     local status, err = pcall (s, ...)"
5196                         "     if not status then"
5197                         "       print ('fn \"'.. n .. '\": ', err)"
5198                         "       remove (n)"
5199                         "      end"
5200                         "   end"
5201                         "   collectgarbage()"
5202                         "  end"
5203                         ""
5204                         "  local cleanup = function ()"
5205                         "   self.scripts = nil"
5206                         "   self.instances = nil"
5207                         "  end"
5208                         ""
5209                         "  local list = function ()"
5210                         "   local rv = {}"
5211                         "   for n, _ in pairs (self.scripts) do"
5212                         "     rv[n] = true"
5213                         "   end"
5214                         "   return rv"
5215                         "  end"
5216                         ""
5217                         "  local function basic_serialize (o)"
5218                         "    if type(o) == \"number\" then"
5219                         "     return tostring(o)"
5220                         "    else"
5221                         "     return string.format(\"%q\", o)"
5222                         "    end"
5223                         "  end"
5224                         ""
5225                         "  local function serialize (name, value)"
5226                         "   local rv = name .. ' = '"
5227                         "   collectgarbage()"
5228                         "   if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
5229                         "    return rv .. basic_serialize(value) .. ' '"
5230                         "   elseif type(value) == \"table\" then"
5231                         "    rv = rv .. '{} '"
5232                         "    for k,v in pairs(value) do"
5233                         "     local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
5234                         "     rv = rv .. serialize(fieldname, v) .. ' '"
5235                         "     collectgarbage()" // string concatenation allocates a new string :(
5236                         "    end"
5237                         "    return rv;"
5238                         "   elseif type(value) == \"function\" then"
5239                         "     return rv .. string.format(\"%q\", string.dump(value, true))"
5240                         "   else"
5241                         "    error('cannot save a ' .. type(value))"
5242                         "   end"
5243                         "  end"
5244                         ""
5245                         ""
5246                         "  local save = function ()"
5247                         "   return (serialize('scripts', self.scripts))"
5248                         "  end"
5249                         ""
5250                         "  local restore = function (state)"
5251                         "   self.scripts = {}"
5252                         "   load (state)()"
5253                         "   for n, s in pairs (scripts) do"
5254                         "    addinternal (n, load(s['f']), s['a'])"
5255                         "   end"
5256                         "  end"
5257                         ""
5258                         " return { run = run, add = add, remove = remove,"
5259                   "          list = list, restore = restore, save = save, cleanup = cleanup}"
5260                         " end"
5261                         " "
5262                         " sess = ArdourSession ()"
5263                         " ArdourSession = nil"
5264                         " "
5265                         "function ardour () end"
5266                         );
5267
5268         lua_State* L = lua.getState();
5269
5270         try {
5271                 luabridge::LuaRef lua_sess = luabridge::getGlobal (L, "sess");
5272                 lua.do_command ("sess = nil"); // hide it.
5273                 lua.do_command ("collectgarbage()");
5274
5275                 _lua_run = new luabridge::LuaRef(lua_sess["run"]);
5276                 _lua_add = new luabridge::LuaRef(lua_sess["add"]);
5277                 _lua_del = new luabridge::LuaRef(lua_sess["remove"]);
5278                 _lua_list = new luabridge::LuaRef(lua_sess["list"]);
5279                 _lua_save = new luabridge::LuaRef(lua_sess["save"]);
5280                 _lua_load = new luabridge::LuaRef(lua_sess["restore"]);
5281                 _lua_cleanup = new luabridge::LuaRef(lua_sess["cleanup"]);
5282         } catch (luabridge::LuaException const& e) {
5283                 fatal << string_compose (_("programming error: %1"),
5284                                 X_("Failed to setup Lua interpreter"))
5285                         << endmsg;
5286                 abort(); /*NOTREACHED*/
5287         }
5288
5289         LuaBindings::stddef (L);
5290         LuaBindings::common (L);
5291         LuaBindings::dsp (L);
5292         luabridge::push <Session *> (L, this);
5293         lua_setglobal (L, "Session");
5294 }
5295
5296 void
5297 Session::scripts_changed ()
5298 {
5299         assert (!lua_lock.trylock()); // must hold lua_lock
5300
5301         try {
5302                 luabridge::LuaRef list ((*_lua_list)());
5303                 int cnt = 0;
5304                 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5305                         if (!i.key ().isString ()) { assert(0); continue; }
5306                         ++cnt;
5307                 }
5308                 _n_lua_scripts = cnt;
5309         } catch (luabridge::LuaException const& e) {
5310                 fatal << string_compose (_("programming error: %1"),
5311                                 X_("Indexing Lua Session Scripts failed."))
5312                         << endmsg;
5313                 abort(); /*NOTREACHED*/
5314         }
5315 }
5316
5317 void
5318 Session::non_realtime_set_audition ()
5319 {
5320         assert (pending_audition_region);
5321         auditioner->audition_region (pending_audition_region);
5322         pending_audition_region.reset ();
5323         AuditionActive (true); /* EMIT SIGNAL */
5324 }
5325
5326 void
5327 Session::audition_region (boost::shared_ptr<Region> r)
5328 {
5329         SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5330         ev->region = r;
5331         queue_event (ev);
5332 }
5333
5334 void
5335 Session::cancel_audition ()
5336 {
5337         if (!auditioner) {
5338                 return;
5339         }
5340         if (auditioner->auditioning()) {
5341                 auditioner->cancel_audition ();
5342                 AuditionActive (false); /* EMIT SIGNAL */
5343         }
5344 }
5345
5346 bool
5347 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
5348 {
5349         if (a->is_monitor()) {
5350                 return true;
5351         }
5352         if (b->is_monitor()) {
5353                 return false;
5354         }
5355         return a->presentation_info() < b->presentation_info();
5356 }
5357
5358 bool
5359 Session::is_auditioning () const
5360 {
5361         /* can be called before we have an auditioner object */
5362         if (auditioner) {
5363                 return auditioner->auditioning();
5364         } else {
5365                 return false;
5366         }
5367 }
5368
5369 void
5370 Session::graph_reordered ()
5371 {
5372         /* don't do this stuff if we are setting up connections
5373            from a set_state() call or creating new tracks. Ditto for deletion.
5374         */
5375
5376         if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
5377                 return;
5378         }
5379
5380         /* every track/bus asked for this to be handled but it was deferred because
5381            we were connecting. do it now.
5382         */
5383
5384         request_input_change_handling ();
5385
5386         resort_routes ();
5387
5388         /* force all diskstreams to update their capture offset values to
5389            reflect any changes in latencies within the graph.
5390         */
5391
5392         boost::shared_ptr<RouteList> rl = routes.reader ();
5393         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5394                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5395                 if (tr) {
5396                         tr->set_capture_offset ();
5397                 }
5398         }
5399 }
5400
5401 /** @return Number of frames that there is disk space available to write,
5402  *  if known.
5403  */
5404 boost::optional<framecnt_t>
5405 Session::available_capture_duration ()
5406 {
5407         Glib::Threads::Mutex::Lock lm (space_lock);
5408
5409         if (_total_free_4k_blocks_uncertain) {
5410                 return boost::optional<framecnt_t> ();
5411         }
5412
5413         float sample_bytes_on_disk = 4.0; // keep gcc happy
5414
5415         switch (config.get_native_file_data_format()) {
5416         case FormatFloat:
5417                 sample_bytes_on_disk = 4.0;
5418                 break;
5419
5420         case FormatInt24:
5421                 sample_bytes_on_disk = 3.0;
5422                 break;
5423
5424         case FormatInt16:
5425                 sample_bytes_on_disk = 2.0;
5426                 break;
5427
5428         default:
5429                 /* impossible, but keep some gcc versions happy */
5430                 fatal << string_compose (_("programming error: %1"),
5431                                          X_("illegal native file data format"))
5432                       << endmsg;
5433                 abort(); /*NOTREACHED*/
5434         }
5435
5436         double scale = 4096.0 / sample_bytes_on_disk;
5437
5438         if (_total_free_4k_blocks * scale > (double) max_framecnt) {
5439                 return max_framecnt;
5440         }
5441
5442         return (framecnt_t) floor (_total_free_4k_blocks * scale);
5443 }
5444
5445 void
5446 Session::add_bundle (boost::shared_ptr<Bundle> bundle, bool emit_signal)
5447 {
5448         {
5449                 RCUWriter<BundleList> writer (_bundles);
5450                 boost::shared_ptr<BundleList> b = writer.get_copy ();
5451                 b->push_back (bundle);
5452         }
5453
5454         if (emit_signal) {
5455                 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5456         }
5457
5458         set_dirty();
5459 }
5460
5461 void
5462 Session::remove_bundle (boost::shared_ptr<Bundle> bundle)
5463 {
5464         bool removed = false;
5465
5466         {
5467                 RCUWriter<BundleList> writer (_bundles);
5468                 boost::shared_ptr<BundleList> b = writer.get_copy ();
5469                 BundleList::iterator i = find (b->begin(), b->end(), bundle);
5470
5471                 if (i != b->end()) {
5472                         b->erase (i);
5473                         removed = true;
5474                 }
5475         }
5476
5477         if (removed) {
5478                  BundleAddedOrRemoved (); /* EMIT SIGNAL */
5479         }
5480
5481         set_dirty();
5482 }
5483
5484 boost::shared_ptr<Bundle>
5485 Session::bundle_by_name (string name) const
5486 {
5487         boost::shared_ptr<BundleList> b = _bundles.reader ();
5488
5489         for (BundleList::const_iterator i = b->begin(); i != b->end(); ++i) {
5490                 if ((*i)->name() == name) {
5491                         return* i;
5492                 }
5493         }
5494
5495         return boost::shared_ptr<Bundle> ();
5496 }
5497
5498 void
5499 Session::tempo_map_changed (const PropertyChange&)
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         set_dirty ();
5508 }
5509
5510 void
5511 Session::gui_tempo_map_changed ()
5512 {
5513         clear_clicks ();
5514
5515         playlists->update_after_tempo_map_change ();
5516
5517         _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5518 }
5519
5520 void
5521 Session::update_locations_after_tempo_map_change (const Locations::LocationList& loc)
5522 {
5523         for (Locations::LocationList::const_iterator i = loc.begin(); i != loc.end(); ++i) {
5524                 (*i)->recompute_frames_from_bbt ();
5525         }
5526 }
5527
5528 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
5529  * the given count with the current block size.
5530  */
5531 void
5532 Session::ensure_buffers (ChanCount howmany)
5533 {
5534         BufferManager::ensure_buffers (howmany, bounce_processing() ? bounce_chunk_size : 0);
5535 }
5536
5537 void
5538 Session::ensure_buffer_set(BufferSet& buffers, const ChanCount& count)
5539 {
5540         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5541                 buffers.ensure_buffers(*t, count.get(*t), _engine.raw_buffer_size(*t));
5542         }
5543 }
5544
5545 uint32_t
5546 Session::next_insert_id ()
5547 {
5548         /* this doesn't really loop forever. just think about it */
5549
5550         while (true) {
5551                 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < insert_bitset.size(); ++n) {
5552                         if (!insert_bitset[n]) {
5553                                 insert_bitset[n] = true;
5554                                 return n;
5555
5556                         }
5557                 }
5558
5559                 /* none available, so resize and try again */
5560
5561                 insert_bitset.resize (insert_bitset.size() + 16, false);
5562         }
5563 }
5564
5565 uint32_t
5566 Session::next_send_id ()
5567 {
5568         /* this doesn't really loop forever. just think about it */
5569
5570         while (true) {
5571                 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < send_bitset.size(); ++n) {
5572                         if (!send_bitset[n]) {
5573                                 send_bitset[n] = true;
5574                                 return n;
5575
5576                         }
5577                 }
5578
5579                 /* none available, so resize and try again */
5580
5581                 send_bitset.resize (send_bitset.size() + 16, false);
5582         }
5583 }
5584
5585 uint32_t
5586 Session::next_aux_send_id ()
5587 {
5588         /* this doesn't really loop forever. just think about it */
5589
5590         while (true) {
5591                 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < aux_send_bitset.size(); ++n) {
5592                         if (!aux_send_bitset[n]) {
5593                                 aux_send_bitset[n] = true;
5594                                 return n;
5595
5596                         }
5597                 }
5598
5599                 /* none available, so resize and try again */
5600
5601                 aux_send_bitset.resize (aux_send_bitset.size() + 16, false);
5602         }
5603 }
5604
5605 uint32_t
5606 Session::next_return_id ()
5607 {
5608         /* this doesn't really loop forever. just think about it */
5609
5610         while (true) {
5611                 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < return_bitset.size(); ++n) {
5612                         if (!return_bitset[n]) {
5613                                 return_bitset[n] = true;
5614                                 return n;
5615
5616                         }
5617                 }
5618
5619                 /* none available, so resize and try again */
5620
5621                 return_bitset.resize (return_bitset.size() + 16, false);
5622         }
5623 }
5624
5625 void
5626 Session::mark_send_id (uint32_t id)
5627 {
5628         if (id >= send_bitset.size()) {
5629                 send_bitset.resize (id+16, false);
5630         }
5631         if (send_bitset[id]) {
5632                 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
5633         }
5634         send_bitset[id] = true;
5635 }
5636
5637 void
5638 Session::mark_aux_send_id (uint32_t id)
5639 {
5640         if (id >= aux_send_bitset.size()) {
5641                 aux_send_bitset.resize (id+16, false);
5642         }
5643         if (aux_send_bitset[id]) {
5644                 warning << string_compose (_("aux send ID %1 appears to be in use already"), id) << endmsg;
5645         }
5646         aux_send_bitset[id] = true;
5647 }
5648
5649 void
5650 Session::mark_return_id (uint32_t id)
5651 {
5652         if (id >= return_bitset.size()) {
5653                 return_bitset.resize (id+16, false);
5654         }
5655         if (return_bitset[id]) {
5656                 warning << string_compose (_("return ID %1 appears to be in use already"), id) << endmsg;
5657         }
5658         return_bitset[id] = true;
5659 }
5660
5661 void
5662 Session::mark_insert_id (uint32_t id)
5663 {
5664         if (id >= insert_bitset.size()) {
5665                 insert_bitset.resize (id+16, false);
5666         }
5667         if (insert_bitset[id]) {
5668                 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
5669         }
5670         insert_bitset[id] = true;
5671 }
5672
5673 void
5674 Session::unmark_send_id (uint32_t id)
5675 {
5676         if (id < send_bitset.size()) {
5677                 send_bitset[id] = false;
5678         }
5679 }
5680
5681 void
5682 Session::unmark_aux_send_id (uint32_t id)
5683 {
5684         if (id < aux_send_bitset.size()) {
5685                 aux_send_bitset[id] = false;
5686         }
5687 }
5688
5689 void
5690 Session::unmark_return_id (uint32_t id)
5691 {
5692         if (_state_of_the_state & Deletion) { return; }
5693         if (id < return_bitset.size()) {
5694                 return_bitset[id] = false;
5695         }
5696 }
5697
5698 void
5699 Session::unmark_insert_id (uint32_t id)
5700 {
5701         if (id < insert_bitset.size()) {
5702                 insert_bitset[id] = false;
5703         }
5704 }
5705
5706 void
5707 Session::reset_native_file_format ()
5708 {
5709         boost::shared_ptr<RouteList> rl = routes.reader ();
5710
5711         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5712                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5713                 if (tr) {
5714                         /* don't save state as we do this, there's no point
5715                          */
5716                         _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
5717                         tr->reset_write_sources (false);
5718                         _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
5719                 }
5720         }
5721 }
5722
5723 bool
5724 Session::route_name_unique (string n) const
5725 {
5726         boost::shared_ptr<RouteList> r = routes.reader ();
5727
5728         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5729                 if ((*i)->name() == n) {
5730                         return false;
5731                 }
5732         }
5733
5734         return true;
5735 }
5736
5737 bool
5738 Session::route_name_internal (string n) const
5739 {
5740         if (auditioner && auditioner->name() == n) {
5741                 return true;
5742         }
5743
5744         if (_click_io && _click_io->name() == n) {
5745                 return true;
5746         }
5747
5748         return false;
5749 }
5750
5751 int
5752 Session::freeze_all (InterThreadInfo& itt)
5753 {
5754         boost::shared_ptr<RouteList> r = routes.reader ();
5755
5756         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5757
5758                 boost::shared_ptr<Track> t;
5759
5760                 if ((t = boost::dynamic_pointer_cast<Track>(*i)) != 0) {
5761                         /* XXX this is wrong because itt.progress will keep returning to zero at the start
5762                            of every track.
5763                         */
5764                         t->freeze_me (itt);
5765                 }
5766         }
5767
5768         return 0;
5769 }
5770
5771 boost::shared_ptr<Region>
5772 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
5773                           bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
5774                           InterThreadInfo& itt,
5775                           boost::shared_ptr<Processor> endpoint, bool include_endpoint,
5776                           bool for_export, bool for_freeze)
5777 {
5778         boost::shared_ptr<Region> result;
5779         boost::shared_ptr<Playlist> playlist;
5780         boost::shared_ptr<Source> source;
5781         ChanCount diskstream_channels (track.n_channels());
5782         framepos_t position;
5783         framecnt_t this_chunk;
5784         framepos_t to_do;
5785         framepos_t latency_skip;
5786         BufferSet buffers;
5787         framepos_t len = end - start;
5788         bool need_block_size_reset = false;
5789         ChanCount const max_proc = track.max_processor_streams ();
5790         string legal_playlist_name;
5791         string possible_path;
5792
5793         if (end <= start) {
5794                 error << string_compose (_("Cannot write a range where end <= start (e.g. %1 <= %2)"),
5795                                          end, start) << endmsg;
5796                 return result;
5797         }
5798
5799         diskstream_channels = track.bounce_get_output_streams (diskstream_channels, endpoint,
5800                         include_endpoint, for_export, for_freeze);
5801
5802         if (diskstream_channels.n(track.data_type()) < 1) {
5803                 error << _("Cannot write a range with no data.") << endmsg;
5804                 return result;
5805         }
5806
5807         // block all process callback handling
5808
5809         block_processing ();
5810
5811         {
5812                 // synchronize with AudioEngine::process_callback()
5813                 // make sure processing is not currently running
5814                 // and processing_blocked() is honored before
5815                 // acquiring thread buffers
5816                 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5817         }
5818
5819         _bounce_processing_active = true;
5820
5821         /* call tree *MUST* hold route_lock */
5822
5823         if ((playlist = track.playlist()) == 0) {
5824                 goto out;
5825         }
5826
5827         legal_playlist_name = legalize_for_path (playlist->name());
5828
5829         for (uint32_t chan_n = 0; chan_n < diskstream_channels.n(track.data_type()); ++chan_n) {
5830
5831                 string base_name = string_compose ("%1-%2-bounce", playlist->name(), chan_n);
5832                 string path = ((track.data_type() == DataType::AUDIO)
5833                                ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
5834                                : new_midi_source_path (legal_playlist_name));
5835
5836                 if (path.empty()) {
5837                         goto out;
5838                 }
5839
5840                 try {
5841                         source = SourceFactory::createWritable (track.data_type(), *this, path, false, frame_rate());
5842                 }
5843
5844                 catch (failed_constructor& err) {
5845                         error << string_compose (_("cannot create new file \"%1\" for %2"), path, track.name()) << endmsg;
5846                         goto out;
5847                 }
5848
5849                 srcs.push_back (source);
5850         }
5851
5852         /* tell redirects that care that we are about to use a much larger
5853          * blocksize. this will flush all plugins too, so that they are ready
5854          * to be used for this process.
5855          */
5856
5857         need_block_size_reset = true;
5858         track.set_block_size (bounce_chunk_size);
5859         _engine.main_thread()->get_buffers ();
5860
5861         position = start;
5862         to_do = len;
5863         latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5864
5865         /* create a set of reasonably-sized buffers */
5866         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5867                 buffers.ensure_buffers(*t, max_proc.get(*t), bounce_chunk_size);
5868         }
5869         buffers.set_count (max_proc);
5870
5871         for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5872                 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5873                 boost::shared_ptr<MidiSource> ms;
5874                 if (afs) {
5875                         afs->prepare_for_peakfile_writes ();
5876                 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5877                         Source::Lock lock(ms->mutex());
5878                         ms->mark_streaming_write_started(lock);
5879                 }
5880         }
5881
5882         while (to_do && !itt.cancel) {
5883
5884                 this_chunk = min (to_do, bounce_chunk_size);
5885
5886                 if (track.export_stuff (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze)) {
5887                         goto out;
5888                 }
5889
5890                 start += this_chunk;
5891                 to_do -= this_chunk;
5892                 itt.progress = (float) (1.0 - ((double) to_do / len));
5893
5894                 if (latency_skip >= bounce_chunk_size) {
5895                         latency_skip -= bounce_chunk_size;
5896                         continue;
5897                 }
5898
5899                 const framecnt_t current_chunk = this_chunk - latency_skip;
5900
5901                 uint32_t n = 0;
5902                 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5903                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5904                         boost::shared_ptr<MidiSource> ms;
5905
5906                         if (afs) {
5907                                 if (afs->write (buffers.get_audio(n).data(latency_skip), current_chunk) != current_chunk) {
5908                                         goto out;
5909                                 }
5910                         } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5911                                 Source::Lock lock(ms->mutex());
5912
5913                                 const MidiBuffer& buf = buffers.get_midi(0);
5914                                 for (MidiBuffer::const_iterator i = buf.begin(); i != buf.end(); ++i) {
5915                                         Evoral::Event<framepos_t> ev = *i;
5916                                         ev.set_time(ev.time() - position);
5917                                         ms->append_event_frames(lock, ev, ms->timeline_position());
5918                                 }
5919                         }
5920                 }
5921                 latency_skip = 0;
5922         }
5923
5924         /* post-roll, pick up delayed processor output */
5925         latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5926
5927         while (latency_skip && !itt.cancel) {
5928                 this_chunk = min (latency_skip, bounce_chunk_size);
5929                 latency_skip -= this_chunk;
5930
5931                 buffers.silence (this_chunk, 0);
5932                 track.bounce_process (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze);
5933
5934                 uint32_t n = 0;
5935                 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5936                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5937
5938                         if (afs) {
5939                                 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
5940                                         goto out;
5941                                 }
5942                         }
5943                 }
5944         }
5945
5946         if (!itt.cancel) {
5947
5948                 time_t now;
5949                 struct tm* xnow;
5950                 time (&now);
5951                 xnow = localtime (&now);
5952
5953                 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
5954                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5955                         boost::shared_ptr<MidiSource> ms;
5956
5957                         if (afs) {
5958                                 afs->update_header (position, *xnow, now);
5959                                 afs->flush_header ();
5960                         } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5961                                 Source::Lock lock(ms->mutex());
5962                                 ms->mark_streaming_write_completed(lock);
5963                         }
5964                 }
5965
5966                 /* construct a region to represent the bounced material */
5967
5968                 PropertyList plist;
5969
5970                 plist.add (Properties::start, 0);
5971                 plist.add (Properties::length, srcs.front()->length(srcs.front()->timeline_position()));
5972                 plist.add (Properties::name, region_name_from_path (srcs.front()->name(), true));
5973
5974                 result = RegionFactory::create (srcs, plist);
5975
5976         }
5977
5978   out:
5979         if (!result) {
5980                 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5981                         (*src)->mark_for_remove ();
5982                         (*src)->drop_references ();
5983                 }
5984
5985         } else {
5986                 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5987                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5988
5989                         if (afs)
5990                                 afs->done_with_peakfile_writes ();
5991                 }
5992         }
5993
5994         _bounce_processing_active = false;
5995
5996         if (need_block_size_reset) {
5997                 _engine.main_thread()->drop_buffers ();
5998                 track.set_block_size (get_block_size());
5999         }
6000
6001         unblock_processing ();
6002
6003         return result;
6004 }
6005
6006 gain_t*
6007 Session::gain_automation_buffer() const
6008 {
6009         return ProcessThread::gain_automation_buffer ();
6010 }
6011
6012 gain_t*
6013 Session::trim_automation_buffer() const
6014 {
6015         return ProcessThread::trim_automation_buffer ();
6016 }
6017
6018 gain_t*
6019 Session::send_gain_automation_buffer() const
6020 {
6021         return ProcessThread::send_gain_automation_buffer ();
6022 }
6023
6024 pan_t**
6025 Session::pan_automation_buffer() const
6026 {
6027         return ProcessThread::pan_automation_buffer ();
6028 }
6029
6030 BufferSet&
6031 Session::get_silent_buffers (ChanCount count)
6032 {
6033         return ProcessThread::get_silent_buffers (count);
6034 }
6035
6036 BufferSet&
6037 Session::get_scratch_buffers (ChanCount count, bool silence)
6038 {
6039         return ProcessThread::get_scratch_buffers (count, silence);
6040 }
6041
6042 BufferSet&
6043 Session::get_noinplace_buffers (ChanCount count)
6044 {
6045         return ProcessThread::get_noinplace_buffers (count);
6046 }
6047
6048 BufferSet&
6049 Session::get_route_buffers (ChanCount count, bool silence)
6050 {
6051         return ProcessThread::get_route_buffers (count, silence);
6052 }
6053
6054
6055 BufferSet&
6056 Session::get_mix_buffers (ChanCount count)
6057 {
6058         return ProcessThread::get_mix_buffers (count);
6059 }
6060
6061 uint32_t
6062 Session::ntracks () const
6063 {
6064         uint32_t n = 0;
6065         boost::shared_ptr<RouteList> r = routes.reader ();
6066
6067         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6068                 if (boost::dynamic_pointer_cast<Track> (*i)) {
6069                         ++n;
6070                 }
6071         }
6072
6073         return n;
6074 }
6075
6076 uint32_t
6077 Session::nbusses () const
6078 {
6079         uint32_t n = 0;
6080         boost::shared_ptr<RouteList> r = routes.reader ();
6081
6082         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6083                 if (boost::dynamic_pointer_cast<Track>(*i) == 0) {
6084                         ++n;
6085                 }
6086         }
6087
6088         return n;
6089 }
6090
6091 void
6092 Session::add_automation_list(AutomationList *al)
6093 {
6094         automation_lists[al->id()] = al;
6095 }
6096
6097 /** @return true if there is at least one record-enabled track, otherwise false */
6098 bool
6099 Session::have_rec_enabled_track () const
6100 {
6101         return g_atomic_int_get (const_cast<gint*>(&_have_rec_enabled_track)) == 1;
6102 }
6103
6104 bool
6105 Session::have_rec_disabled_track () const
6106 {
6107     return g_atomic_int_get (const_cast<gint*>(&_have_rec_disabled_track)) == 1;
6108 }
6109
6110 /** Update the state of our rec-enabled tracks flag */
6111 void
6112 Session::update_route_record_state ()
6113 {
6114         boost::shared_ptr<RouteList> rl = routes.reader ();
6115         RouteList::iterator i = rl->begin();
6116         while (i != rl->end ()) {
6117
6118                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6119                                     if (tr && tr->rec_enable_control()->get_value()) {
6120                         break;
6121                 }
6122
6123                 ++i;
6124         }
6125
6126         int const old = g_atomic_int_get (&_have_rec_enabled_track);
6127
6128         g_atomic_int_set (&_have_rec_enabled_track, i != rl->end () ? 1 : 0);
6129
6130         if (g_atomic_int_get (&_have_rec_enabled_track) != old) {
6131                 RecordStateChanged (); /* EMIT SIGNAL */
6132         }
6133
6134         for (i = rl->begin(); i != rl->end (); ++i) {
6135                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6136                 if (tr && !tr->rec_enable_control()->get_value()) {
6137                         break;
6138                 }
6139         }
6140
6141         g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
6142
6143         bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
6144
6145         if (record_status() == Recording && record_arm_state_changed ) {
6146                 RecordArmStateChanged ();
6147         }
6148
6149 }
6150
6151 void
6152 Session::listen_position_changed ()
6153 {
6154         boost::shared_ptr<RouteList> r = routes.reader ();
6155
6156         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6157                 (*i)->listen_position_changed ();
6158         }
6159 }
6160
6161 void
6162 Session::solo_control_mode_changed ()
6163 {
6164         if (soloing() || listening()) {
6165                 /* We can't use ::clear_all_solo_state() here because during
6166                    session loading at program startup, that will queue a call
6167                    to rt_clear_all_solo_state() that will not execute until
6168                    AFTER solo states have been established (thus throwing away
6169                    the session's saved solo state). So just explicitly turn
6170                    them all off.
6171                 */
6172                 set_controls (route_list_to_control_list (get_routes(), &Route::solo_control), 0.0, Controllable::NoGroup);
6173         }
6174 }
6175
6176 /** Called when a property of one of our route groups changes */
6177 void
6178 Session::route_group_property_changed (RouteGroup* rg)
6179 {
6180         RouteGroupPropertyChanged (rg); /* EMIT SIGNAL */
6181 }
6182
6183 /** Called when a route is added to one of our route groups */
6184 void
6185 Session::route_added_to_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6186 {
6187         RouteAddedToRouteGroup (rg, r);
6188 }
6189
6190 /** Called when a route is removed from one of our route groups */
6191 void
6192 Session::route_removed_from_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6193 {
6194         update_route_record_state ();
6195         RouteRemovedFromRouteGroup (rg, r); /* EMIT SIGNAL */
6196 }
6197
6198 boost::shared_ptr<RouteList>
6199 Session::get_tracks () const
6200 {
6201         boost::shared_ptr<RouteList> rl = routes.reader ();
6202         boost::shared_ptr<RouteList> tl (new RouteList);
6203
6204         for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
6205                 if (boost::dynamic_pointer_cast<Track> (*r)) {
6206                         if (!(*r)->is_auditioner()) {
6207                                 tl->push_back (*r);
6208                         }
6209                 }
6210         }
6211         return tl;
6212 }
6213
6214 boost::shared_ptr<RouteList>
6215 Session::get_routes_with_regions_at (framepos_t const p) const
6216 {
6217         boost::shared_ptr<RouteList> r = routes.reader ();
6218         boost::shared_ptr<RouteList> rl (new RouteList);
6219
6220         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6221                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6222                 if (!tr) {
6223                         continue;
6224                 }
6225
6226                 boost::shared_ptr<Playlist> pl = tr->playlist ();
6227                 if (!pl) {
6228                         continue;
6229                 }
6230
6231                 if (pl->has_region_at (p)) {
6232                         rl->push_back (*i);
6233                 }
6234         }
6235
6236         return rl;
6237 }
6238
6239 void
6240 Session::goto_end ()
6241 {
6242         if (_session_range_location) {
6243                 request_locate (_session_range_location->end(), false);
6244         } else {
6245                 request_locate (0, false);
6246         }
6247 }
6248
6249 void
6250 Session::goto_start ()
6251 {
6252         if (_session_range_location) {
6253                 request_locate (_session_range_location->start(), false);
6254         } else {
6255                 request_locate (0, false);
6256         }
6257 }
6258
6259 framepos_t
6260 Session::current_start_frame () const
6261 {
6262         return _session_range_location ? _session_range_location->start() : 0;
6263 }
6264
6265 framepos_t
6266 Session::current_end_frame () const
6267 {
6268         return _session_range_location ? _session_range_location->end() : 0;
6269 }
6270
6271 void
6272 Session::set_session_range_location (framepos_t start, framepos_t end)
6273 {
6274         _session_range_location = new Location (*this, start, end, _("session"), Location::IsSessionRange);
6275         _locations->add (_session_range_location);
6276 }
6277
6278 void
6279 Session::step_edit_status_change (bool yn)
6280 {
6281         bool send = false;
6282
6283         bool val = false;
6284         if (yn) {
6285                 send = (_step_editors == 0);
6286                 val = true;
6287
6288                 _step_editors++;
6289         } else {
6290                 send = (_step_editors == 1);
6291                 val = false;
6292
6293                 if (_step_editors > 0) {
6294                         _step_editors--;
6295                 }
6296         }
6297
6298         if (send) {
6299                 StepEditStatusChange (val);
6300         }
6301 }
6302
6303
6304 void
6305 Session::start_time_changed (framepos_t old)
6306 {
6307         /* Update the auto loop range to match the session range
6308            (unless the auto loop range has been changed by the user)
6309         */
6310
6311         Location* s = _locations->session_range_location ();
6312         if (s == 0) {
6313                 return;
6314         }
6315
6316         Location* l = _locations->auto_loop_location ();
6317
6318         if (l && l->start() == old) {
6319                 l->set_start (s->start(), true);
6320         }
6321 }
6322
6323 void
6324 Session::end_time_changed (framepos_t old)
6325 {
6326         /* Update the auto loop range to match the session range
6327            (unless the auto loop range has been changed by the user)
6328         */
6329
6330         Location* s = _locations->session_range_location ();
6331         if (s == 0) {
6332                 return;
6333         }
6334
6335         Location* l = _locations->auto_loop_location ();
6336
6337         if (l && l->end() == old) {
6338                 l->set_end (s->end(), true);
6339         }
6340 }
6341
6342 std::vector<std::string>
6343 Session::source_search_path (DataType type) const
6344 {
6345         Searchpath sp;
6346
6347         if (session_dirs.size() == 1) {
6348                 switch (type) {
6349                 case DataType::AUDIO:
6350                         sp.push_back (_session_dir->sound_path());
6351                         break;
6352                 case DataType::MIDI:
6353                         sp.push_back (_session_dir->midi_path());
6354                         break;
6355                 }
6356         } else {
6357                 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
6358                         SessionDirectory sdir (i->path);
6359                         switch (type) {
6360                         case DataType::AUDIO:
6361                                 sp.push_back (sdir.sound_path());
6362                                 break;
6363                         case DataType::MIDI:
6364                                 sp.push_back (sdir.midi_path());
6365                                 break;
6366                         }
6367                 }
6368         }
6369
6370         if (type == DataType::AUDIO) {
6371                 const string sound_path_2X = _session_dir->sound_path_2X();
6372                 if (Glib::file_test (sound_path_2X, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_DIR)) {
6373                         if (find (sp.begin(), sp.end(), sound_path_2X) == sp.end()) {
6374                                 sp.push_back (sound_path_2X);
6375                         }
6376                 }
6377         }
6378
6379         // now check the explicit (possibly user-specified) search path
6380
6381         switch (type) {
6382         case DataType::AUDIO:
6383                 sp += Searchpath(config.get_audio_search_path ());
6384                 break;
6385         case DataType::MIDI:
6386                 sp += Searchpath(config.get_midi_search_path ());
6387                 break;
6388         }
6389
6390         return sp;
6391 }
6392
6393 void
6394 Session::ensure_search_path_includes (const string& path, DataType type)
6395 {
6396         Searchpath sp;
6397
6398         if (path == ".") {
6399                 return;
6400         }
6401
6402         switch (type) {
6403         case DataType::AUDIO:
6404                 sp += Searchpath(config.get_audio_search_path ());
6405                 break;
6406         case DataType::MIDI:
6407                 sp += Searchpath (config.get_midi_search_path ());
6408                 break;
6409         }
6410
6411         for (vector<std::string>::iterator i = sp.begin(); i != sp.end(); ++i) {
6412                 /* No need to add this new directory if it has the same inode as
6413                    an existing one; checking inode rather than name prevents duplicated
6414                    directories when we are using symlinks.
6415
6416                    On Windows, I think we could just do if (*i == path) here.
6417                 */
6418                 if (PBD::equivalent_paths (*i, path)) {
6419                         return;
6420                 }
6421         }
6422
6423         sp += path;
6424
6425         switch (type) {
6426         case DataType::AUDIO:
6427                 config.set_audio_search_path (sp.to_string());
6428                 break;
6429         case DataType::MIDI:
6430                 config.set_midi_search_path (sp.to_string());
6431                 break;
6432         }
6433 }
6434
6435 void
6436 Session::remove_dir_from_search_path (const string& dir, DataType type)
6437 {
6438         Searchpath sp;
6439
6440         switch (type) {
6441         case DataType::AUDIO:
6442                 sp = Searchpath(config.get_audio_search_path ());
6443                 break;
6444         case DataType::MIDI:
6445                 sp = Searchpath (config.get_midi_search_path ());
6446                 break;
6447         }
6448
6449         sp -= dir;
6450
6451         switch (type) {
6452         case DataType::AUDIO:
6453                 config.set_audio_search_path (sp.to_string());
6454                 break;
6455         case DataType::MIDI:
6456                 config.set_midi_search_path (sp.to_string());
6457                 break;
6458         }
6459
6460 }
6461
6462 boost::shared_ptr<Speakers>
6463 Session::get_speakers()
6464 {
6465         return _speakers;
6466 }
6467
6468 list<string>
6469 Session::unknown_processors () const
6470 {
6471         list<string> p;
6472
6473         boost::shared_ptr<RouteList> r = routes.reader ();
6474         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6475                 list<string> t = (*i)->unknown_processors ();
6476                 copy (t.begin(), t.end(), back_inserter (p));
6477         }
6478
6479         p.sort ();
6480         p.unique ();
6481
6482         return p;
6483 }
6484
6485 void
6486 Session::update_latency (bool playback)
6487 {
6488
6489         DEBUG_TRACE (DEBUG::Latency, string_compose ("JACK latency callback: %1\n", (playback ? "PLAYBACK" : "CAPTURE")));
6490
6491         if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _route_deletion_in_progress) {
6492                 return;
6493         }
6494
6495         boost::shared_ptr<RouteList> r = routes.reader ();
6496         framecnt_t max_latency = 0;
6497
6498         if (playback) {
6499                 /* reverse the list so that we work backwards from the last route to run to the first */
6500                 RouteList* rl = routes.reader().get();
6501                 r.reset (new RouteList (*rl));
6502                 reverse (r->begin(), r->end());
6503         }
6504
6505         /* compute actual latency values for the given direction and store them all in per-port
6506            structures. this will also publish the same values (to JACK) so that computation of latency
6507            for routes can consistently use public latency values.
6508         */
6509
6510         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6511                 max_latency = max (max_latency, (*i)->set_private_port_latencies (playback));
6512         }
6513
6514         /* because we latency compensate playback, our published playback latencies should
6515            be the same for all output ports - all material played back by ardour has
6516            the same latency, whether its caused by plugins or by latency compensation. since
6517            these may differ from the values computed above, reset all playback port latencies
6518            to the same value.
6519         */
6520
6521         DEBUG_TRACE (DEBUG::Latency, string_compose ("Set public port latencies to %1\n", max_latency));
6522
6523         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6524                 (*i)->set_public_port_latencies (max_latency, playback);
6525         }
6526
6527         if (playback) {
6528
6529                 post_playback_latency ();
6530
6531         } else {
6532
6533                 post_capture_latency ();
6534         }
6535
6536         DEBUG_TRACE (DEBUG::Latency, "JACK latency callback: DONE\n");
6537 }
6538
6539 void
6540 Session::post_playback_latency ()
6541 {
6542         set_worst_playback_latency ();
6543
6544         boost::shared_ptr<RouteList> r = routes.reader ();
6545
6546         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6547                 if (!(*i)->is_auditioner() && ((*i)->active())) {
6548                         _worst_track_latency = max (_worst_track_latency, (*i)->update_signal_latency ());
6549                 }
6550         }
6551
6552         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6553                 (*i)->set_latency_compensation (_worst_track_latency);
6554         }
6555 }
6556
6557 void
6558 Session::post_capture_latency ()
6559 {
6560         set_worst_capture_latency ();
6561
6562         /* reflect any changes in capture latencies into capture offsets
6563          */
6564
6565         boost::shared_ptr<RouteList> rl = routes.reader();
6566         for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
6567                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6568                 if (tr) {
6569                         tr->set_capture_offset ();
6570                 }
6571         }
6572 }
6573
6574 void
6575 Session::initialize_latencies ()
6576 {
6577         {
6578                 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
6579                 update_latency (false);
6580                 update_latency (true);
6581         }
6582
6583         set_worst_io_latencies ();
6584 }
6585
6586 void
6587 Session::set_worst_io_latencies ()
6588 {
6589         set_worst_playback_latency ();
6590         set_worst_capture_latency ();
6591 }
6592
6593 void
6594 Session::set_worst_playback_latency ()
6595 {
6596         if (_state_of_the_state & (InitialConnecting|Deletion)) {
6597                 return;
6598         }
6599
6600         _worst_output_latency = 0;
6601
6602         if (!_engine.connected()) {
6603                 return;
6604         }
6605
6606         boost::shared_ptr<RouteList> r = routes.reader ();
6607
6608         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6609                 _worst_output_latency = max (_worst_output_latency, (*i)->output()->latency());
6610         }
6611
6612         DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst output latency: %1\n", _worst_output_latency));
6613 }
6614
6615 void
6616 Session::set_worst_capture_latency ()
6617 {
6618         if (_state_of_the_state & (InitialConnecting|Deletion)) {
6619                 return;
6620         }
6621
6622         _worst_input_latency = 0;
6623
6624         if (!_engine.connected()) {
6625                 return;
6626         }
6627
6628         boost::shared_ptr<RouteList> r = routes.reader ();
6629
6630         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6631                 _worst_input_latency = max (_worst_input_latency, (*i)->input()->latency());
6632         }
6633
6634         DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst input latency: %1\n", _worst_input_latency));
6635 }
6636
6637 void
6638 Session::update_latency_compensation (bool force_whole_graph)
6639 {
6640         bool some_track_latency_changed = false;
6641
6642         if (_state_of_the_state & (InitialConnecting|Deletion)) {
6643                 return;
6644         }
6645
6646         DEBUG_TRACE(DEBUG::Latency, "---------------------------- update latency compensation\n\n");
6647
6648         _worst_track_latency = 0;
6649
6650         boost::shared_ptr<RouteList> r = routes.reader ();
6651
6652         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6653                 if (!(*i)->is_auditioner() && ((*i)->active())) {
6654                         framecnt_t tl;
6655                         if ((*i)->signal_latency () != (tl = (*i)->update_signal_latency ())) {
6656                                 some_track_latency_changed = true;
6657                         }
6658                         _worst_track_latency = max (tl, _worst_track_latency);
6659                 }
6660         }
6661
6662         DEBUG_TRACE (DEBUG::Latency, string_compose ("worst signal processing latency: %1 (changed ? %2)\n", _worst_track_latency,
6663                                                      (some_track_latency_changed ? "yes" : "no")));
6664
6665         DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
6666
6667         if (some_track_latency_changed || force_whole_graph)  {
6668                 _engine.update_latencies ();
6669         }
6670
6671
6672         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6673                 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6674                 if (!tr) {
6675                         continue;
6676                 }
6677                 tr->set_capture_offset ();
6678         }
6679 }
6680
6681 char
6682 Session::session_name_is_legal (const string& path)
6683 {
6684         char illegal_chars[] = { '/', '\\', ':', ';', '\0' };
6685
6686         for (int i = 0; illegal_chars[i]; ++i) {
6687                 if (path.find (illegal_chars[i]) != string::npos) {
6688                         return illegal_chars[i];
6689                 }
6690         }
6691
6692         return 0;
6693 }
6694
6695 void
6696 Session::notify_presentation_info_change ()
6697 {
6698         if (deletion_in_progress()) {
6699                 return;
6700         }
6701
6702         Stripable::PresentationInfoChange (); /* EMIT SIGNAL */
6703         reassign_track_numbers();
6704
6705 #ifdef USE_TRACKS_CODE_FEATURES
6706         /* Waves Tracks: for Waves Tracks session it's required to reconnect their IOs
6707          * if track order has been changed by user
6708          */
6709         reconnect_existing_routes(true, true);
6710 #endif
6711
6712 }
6713
6714 bool
6715 Session::operation_in_progress (GQuark op) const
6716 {
6717         return (find (_current_trans_quarks.begin(), _current_trans_quarks.end(), op) != _current_trans_quarks.end());
6718 }
6719
6720 boost::shared_ptr<Port>
6721 Session::ltc_input_port () const
6722 {
6723         return _ltc_input->nth (0);
6724 }
6725
6726 boost::shared_ptr<Port>
6727 Session::ltc_output_port () const
6728 {
6729         return _ltc_output->nth (0);
6730 }
6731
6732 void
6733 Session::reconnect_ltc_input ()
6734 {
6735         if (_ltc_input) {
6736
6737                 string src = Config->get_ltc_source_port();
6738
6739                 _ltc_input->disconnect (this);
6740
6741                 if (src != _("None") && !src.empty())  {
6742                         _ltc_input->nth (0)->connect (src);
6743                 }
6744
6745                 if ( ARDOUR::Profile->get_trx () ) {
6746                         // Tracks need this signal to update timecode_source_dropdown
6747                         MtcOrLtcInputPortChanged (); //emit signal
6748                 }
6749         }
6750 }
6751
6752 void
6753 Session::reconnect_ltc_output ()
6754 {
6755         if (_ltc_output) {
6756
6757                 string src = Config->get_ltc_output_port();
6758
6759                 _ltc_output->disconnect (this);
6760
6761                 if (src != _("None") && !src.empty())  {
6762                         _ltc_output->nth (0)->connect (src);
6763                 }
6764         }
6765 }
6766
6767 void
6768 Session::set_range_selection (framepos_t start, framepos_t end)
6769 {
6770         _range_selection = Evoral::Range<framepos_t> (start, end);
6771 #ifdef USE_TRACKS_CODE_FEATURES
6772         follow_playhead_priority ();
6773 #endif
6774 }
6775
6776 void
6777 Session::set_object_selection (framepos_t start, framepos_t end)
6778 {
6779         _object_selection = Evoral::Range<framepos_t> (start, end);
6780 #ifdef USE_TRACKS_CODE_FEATURES
6781         follow_playhead_priority ();
6782 #endif
6783 }
6784
6785 void
6786 Session::clear_range_selection ()
6787 {
6788         _range_selection = Evoral::Range<framepos_t> (-1,-1);
6789 #ifdef USE_TRACKS_CODE_FEATURES
6790         follow_playhead_priority ();
6791 #endif
6792 }
6793
6794 void
6795 Session::clear_object_selection ()
6796 {
6797         _object_selection = Evoral::Range<framepos_t> (-1,-1);
6798 #ifdef USE_TRACKS_CODE_FEATURES
6799         follow_playhead_priority ();
6800 #endif
6801 }
6802
6803 void
6804 Session::auto_connect_route (boost::shared_ptr<Route> route, bool connect_inputs,
6805                 const ChanCount& input_start,
6806                 const ChanCount& output_start,
6807                 const ChanCount& input_offset,
6808                 const ChanCount& output_offset)
6809 {
6810         Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6811         _auto_connect_queue.push (AutoConnectRequest (route, connect_inputs,
6812                                 input_start, output_start,
6813                                 input_offset, output_offset));
6814
6815         if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
6816                 pthread_cond_signal (&_auto_connect_cond);
6817                 pthread_mutex_unlock (&_auto_connect_mutex);
6818         }
6819 }
6820
6821 void
6822 Session::auto_connect (const AutoConnectRequest& ar)
6823 {
6824         boost::shared_ptr<Route> route = ar.route.lock();
6825
6826         if (!route) { return; }
6827
6828         if (!IO::connecting_legal) {
6829                 return;
6830         }
6831
6832         /* If both inputs and outputs are auto-connected to physical ports,
6833          * use the max of input and output offsets to ensure auto-connected
6834          * port numbers always match up (e.g. the first audio input and the
6835          * first audio output of the route will have the same physical
6836          * port number).  Otherwise just use the lowest input or output
6837          * offset possible.
6838          */
6839
6840         const bool in_out_physical =
6841                 (Config->get_input_auto_connect() & AutoConnectPhysical)
6842                 && (Config->get_output_auto_connect() & AutoConnectPhysical)
6843                 && ar.connect_inputs;
6844
6845         const ChanCount in_offset = in_out_physical
6846                 ? ChanCount::max(ar.input_offset, ar.output_offset)
6847                 : ar.input_offset;
6848
6849         const ChanCount out_offset = in_out_physical
6850                 ? ChanCount::max(ar.input_offset, ar.output_offset)
6851                 : ar.output_offset;
6852
6853         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
6854                 vector<string> physinputs;
6855                 vector<string> physoutputs;
6856
6857                 _engine.get_physical_outputs (*t, physoutputs);
6858                 _engine.get_physical_inputs (*t, physinputs);
6859
6860                 if (!physinputs.empty() && ar.connect_inputs) {
6861                         uint32_t nphysical_in = physinputs.size();
6862
6863                         for (uint32_t i = ar.input_start.get(*t); i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
6864                                 string port;
6865
6866                                 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
6867                                         port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
6868                                 }
6869
6870                                 if (!port.empty() && route->input()->connect (route->input()->ports().port(*t, i), port, this)) {
6871                                         break;
6872                                 }
6873                         }
6874                 }
6875
6876                 if (!physoutputs.empty()) {
6877                         uint32_t nphysical_out = physoutputs.size();
6878                         for (uint32_t i = ar.output_start.get(*t); i < route->n_outputs().get(*t); ++i) {
6879                                 string port;
6880
6881                                 /* Waves Tracks:
6882                                  * do not create new connections if we reached the limit of physical outputs
6883                                  * in Multi Out mode
6884                                  */
6885                                 if (!(Config->get_output_auto_connect() & AutoConnectMaster) &&
6886                                                 ARDOUR::Profile->get_trx () &&
6887                                                 ar.output_offset.get(*t) == nphysical_out ) {
6888                                         break;
6889                                 }
6890
6891                                 if ((*t) == DataType::MIDI && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
6892                                         port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
6893                                 } else if ((*t) == DataType::AUDIO && (Config->get_output_auto_connect() & AutoConnectMaster)) {
6894                                         /* master bus is audio only */
6895                                         if (_master_out && _master_out->n_inputs().get(*t) > 0) {
6896                                                 port = _master_out->input()->ports().port(*t,
6897                                                                 i % _master_out->input()->n_ports().get(*t))->name();
6898                                         }
6899                                 }
6900
6901                                 if (!port.empty() && route->output()->connect (route->output()->ports().port(*t, i), port, this)) {
6902                                         break;
6903                                 }
6904                         }
6905                 }
6906         }
6907 }
6908
6909 void
6910 Session::auto_connect_thread_start ()
6911 {
6912         if (_ac_thread_active) {
6913                 return;
6914         }
6915
6916         while (!_auto_connect_queue.empty ()) {
6917                 _auto_connect_queue.pop ();
6918         }
6919
6920         _ac_thread_active = true;
6921         if (pthread_create (&_auto_connect_thread, NULL, auto_connect_thread, this)) {
6922                 _ac_thread_active = false;
6923         }
6924 }
6925
6926 void
6927 Session::auto_connect_thread_terminate ()
6928 {
6929         if (!_ac_thread_active) {
6930                 return;
6931         }
6932         _ac_thread_active = false;
6933
6934         {
6935                 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6936                 while (!_auto_connect_queue.empty ()) {
6937                         _auto_connect_queue.pop ();
6938                 }
6939         }
6940
6941         if (pthread_mutex_lock (&_auto_connect_mutex) == 0) {
6942                 pthread_cond_signal (&_auto_connect_cond);
6943                 pthread_mutex_unlock (&_auto_connect_mutex);
6944         }
6945
6946         void *status;
6947         pthread_join (_auto_connect_thread, &status);
6948 }
6949
6950 void *
6951 Session::auto_connect_thread (void *arg)
6952 {
6953         Session *s = static_cast<Session *>(arg);
6954         s->auto_connect_thread_run ();
6955         pthread_exit (0);
6956         return 0;
6957 }
6958
6959 void
6960 Session::auto_connect_thread_run ()
6961 {
6962         pthread_set_name (X_("autoconnect"));
6963         SessionEvent::create_per_thread_pool (X_("autoconnect"), 1024);
6964         PBD::notify_event_loops_about_thread_creation (pthread_self(), X_("autoconnect"), 1024);
6965         pthread_mutex_lock (&_auto_connect_mutex);
6966         while (_ac_thread_active) {
6967
6968                 if (!_auto_connect_queue.empty ()) {
6969                         // Why would we need the process lock ??
6970                         // A: if ports are added while we're connecting, the backend's iterator may be invalidated:
6971                         //   graph_order_callback() -> resort_routes() -> direct_feeds_according_to_reality () -> backend::connected_to()
6972                         //   All ardour-internal backends use a std::vector   xxxAudioBackend::find_port()
6973                         //   We have control over those, but what does jack do?
6974                         Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
6975
6976                         Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6977                         while (!_auto_connect_queue.empty ()) {
6978                                 const AutoConnectRequest ar (_auto_connect_queue.front());
6979                                 _auto_connect_queue.pop ();
6980                                 lx.release ();
6981                                 auto_connect (ar);
6982                                 lx.acquire ();
6983                         }
6984                 }
6985
6986                 pthread_cond_wait (&_auto_connect_cond, &_auto_connect_mutex);
6987         }
6988         pthread_mutex_unlock (&_auto_connect_mutex);
6989 }