libs/ardour/session.cc

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