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