libs/ardour/session.cc

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