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