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