libs/ardour/session.cc

   1 /*
   2     Copyright (C) 1999-2004 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 <algorithm>
  21 #include <string>
  22 #include <vector>
  23 #include <sstream>
  24 #include <fstream>
  25 #include <cstdio> /* sprintf(3) ... grrr */
  26 #include <cmath>
  27 #include <cerrno>
  28 #include <unistd.h>
  29 #include <limits.h>
  30
  31 #include <sigc++/bind.h>
  32 #include <sigc++/retype.h>
  33
  34 #include <glibmm/thread.h>
  35 #include <glibmm/miscutils.h>
  36
  37 #include <pbd/error.h>
  38 #include <glibmm/thread.h>
  39 #include <pbd/pathscanner.h>
  40 #include <pbd/stl_delete.h>
  41 #include <pbd/basename.h>
  42 #include <pbd/stacktrace.h>
  43
  44 #include <ardour/audioengine.h>
  45 #include <ardour/configuration.h>
  46 #include <ardour/session.h>
  47 #include <ardour/utils.h>
  48 #include <ardour/audio_diskstream.h>
  49 #include <ardour/audioplaylist.h>
  50 #include <ardour/audioregion.h>
  51 #include <ardour/audiofilesource.h>
  52 #include <ardour/midi_diskstream.h>
  53 #include <ardour/midi_playlist.h>
  54 #include <ardour/midi_region.h>
  55 #include <ardour/smf_source.h>
  56 #include <ardour/auditioner.h>
  57 #include <ardour/recent_sessions.h>
  58 #include <ardour/redirect.h>
  59 #include <ardour/send.h>
  60 #include <ardour/insert.h>
  61 #include <ardour/connection.h>
  62 #include <ardour/slave.h>
  63 #include <ardour/tempo.h>
  64 #include <ardour/audio_track.h>
  65 #include <ardour/midi_track.h>
  66 #include <ardour/cycle_timer.h>
  67 #include <ardour/named_selection.h>
  68 #include <ardour/crossfade.h>
  69 #include <ardour/playlist.h>
  70 #include <ardour/click.h>
  71 #include <ardour/data_type.h>
  72 #include <ardour/buffer_set.h>
  73 #include <ardour/source_factory.h>
  74 #include <ardour/region_factory.h>
  75
  76 #ifdef HAVE_LIBLO
  77 #include <ardour/osc.h>
  78 #endif
  79
  80 #include "i18n.h"
  81
  82 using namespace std;
  83 using namespace ARDOUR;
  84 using namespace PBD;
  85 using boost::shared_ptr;
  86
  87 #ifdef __x86_64__
  88 static const int CPU_CACHE_ALIGN = 64;
  89 #else
  90 static const int CPU_CACHE_ALIGN = 16; /* arguably 32 on most arches, but it matters less */
  91 #endif
  92
  93 const char* Session::_template_suffix = X_(".template");
  94 const char* Session::_statefile_suffix = X_(".ardour");
  95 const char* Session::_pending_suffix = X_(".pending");
  96 const char* Session::old_sound_dir_name = X_("sounds");
  97 const char* Session::sound_dir_name = X_("audiofiles");
  98 const char* Session::peak_dir_name = X_("peaks");
  99 const char* Session::dead_sound_dir_name = X_("dead_sounds");
 100 const char* Session::interchange_dir_name = X_("interchange");
 101 const char* Session::export_dir_name = X_("export");
 102
 103 sigc::signal<int> Session::AskAboutPendingState;
 104 sigc::signal<void> Session::SendFeedback;
 105
 106 sigc::signal<void> Session::SMPTEOffsetChanged;
 107 sigc::signal<void> Session::StartTimeChanged;
 108 sigc::signal<void> Session::EndTimeChanged;
 109
 110 int
 111 Session::find_session (string str, string& path, string& snapshot, bool& isnew)
 112 {
 113         struct stat statbuf;
 114         char buf[PATH_MAX+1];
 115
 116         isnew = false;
 117
 118         if (!realpath (str.c_str(), buf) && (errno != ENOENT && errno != ENOTDIR)) {
 119                 error << string_compose (_("Could not resolve path: %1 (%2)"), buf, strerror(errno)) << endmsg;
 120                 return -1;
 121         }
 122
 123         str = buf;
 124
 125         /* check to see if it exists, and what it is */
 126
 127         if (stat (str.c_str(), &statbuf)) {
 128                 if (errno == ENOENT) {
 129                         isnew = true;
 130                 } else {
 131                         error << string_compose (_("cannot check session path %1 (%2)"), str, strerror (errno))
 132                               << endmsg;
 133                         return -1;
 134                 }
 135         }
 136
 137         if (!isnew) {
 138
 139                 /* it exists, so it must either be the name
 140                    of the directory, or the name of the statefile
 141                    within it.
 142                 */
 143
 144                 if (S_ISDIR (statbuf.st_mode)) {
 145
 146                         string::size_type slash = str.find_last_of ('/');
 147
 148                         if (slash == string::npos) {
 149
 150                                 /* a subdirectory of cwd, so statefile should be ... */
 151
 152                                 string tmp;
 153                                 tmp = str;
 154                                 tmp += '/';
 155                                 tmp += str;
 156                                 tmp += _statefile_suffix;
 157
 158                                 /* is it there ? */
 159
 160                                 if (stat (tmp.c_str(), &statbuf)) {
 161                                         error << string_compose (_("cannot check statefile %1 (%2)"), tmp, strerror (errno))
 162                                               << endmsg;
 163                                         return -1;
 164                                 }
 165
 166                                 path = str;
 167                                 snapshot = str;
 168
 169                         } else {
 170
 171                                 /* some directory someplace in the filesystem.
 172                                    the snapshot name is the directory name
 173                                    itself.
 174                                 */
 175
 176                                 path = str;
 177                                 snapshot = str.substr (slash+1);
 178
 179                         }
 180
 181                 } else if (S_ISREG (statbuf.st_mode)) {
 182
 183                         string::size_type slash = str.find_last_of ('/');
 184                         string::size_type suffix;
 185
 186                         /* remove the suffix */
 187
 188                         if (slash != string::npos) {
 189                                 snapshot = str.substr (slash+1);
 190                         } else {
 191                                 snapshot = str;
 192                         }
 193
 194                         suffix = snapshot.find (_statefile_suffix);
 195
 196                         if (suffix == string::npos) {
 197                                 error << string_compose (_("%1 is not an Ardour snapshot file"), str) << endmsg;
 198                                 return -1;
 199                         }
 200
 201                         /* remove suffix */
 202
 203                         snapshot = snapshot.substr (0, suffix);
 204
 205                         if (slash == string::npos) {
 206
 207                                 /* we must be in the directory where the
 208                                    statefile lives. get it using cwd().
 209                                 */
 210
 211                                 char cwd[PATH_MAX+1];
 212
 213                                 if (getcwd (cwd, sizeof (cwd)) == 0) {
 214                                         error << string_compose (_("cannot determine current working directory (%1)"), strerror (errno))
 215                                               << endmsg;
 216                                         return -1;
 217                                 }
 218
 219                                 path = cwd;
 220
 221                         } else {
 222
 223                                 /* full path to the statefile */
 224
 225                                 path = str.substr (0, slash);
 226                         }
 227
 228                 } else {
 229
 230                         /* what type of file is it? */
 231                         error << string_compose (_("unknown file type for session %1"), str) << endmsg;
 232                         return -1;
 233                 }
 234
 235         } else {
 236
 237                 /* its the name of a new directory. get the name
 238                    as "dirname" does.
 239                 */
 240
 241                 string::size_type slash = str.find_last_of ('/');
 242
 243                 if (slash == string::npos) {
 244
 245                         /* no slash, just use the name, but clean it up */
 246
 247                         path = legalize_for_path (str);
 248                         snapshot = path;
 249
 250                 } else {
 251
 252                         path = str;
 253                         snapshot = str.substr (slash+1);
 254                 }
 255         }
 256
 257         return 0;
 258 }
 259
 260 Session::Session (AudioEngine &eng,
 261                   string fullpath,
 262                   string snapshot_name,
 263                   string* mix_template)
 264
 265         : _engine (eng),
 266           _scratch_buffers(new BufferSet()),
 267           _silent_buffers(new BufferSet()),
 268           _send_buffers(new BufferSet()),
 269           _mmc_port (default_mmc_port),
 270           _mtc_port (default_mtc_port),
 271           _midi_port (default_midi_port),
 272           pending_events (2048),
 273           //midi_requests (128), // the size of this should match the midi request pool size
 274           _send_smpte_update (false),
 275           diskstreams (new DiskstreamList),
 276           routes (new RouteList),
 277           auditioner ((Auditioner*) 0),
 278           _click_io ((IO*) 0),
 279           main_outs (0)
 280 {
 281         bool new_session;
 282
 283         if (!eng.connected()) {
 284                 throw failed_constructor();
 285         }
 286
 287         cerr << "Loading session " << fullpath << " using snapshot " << snapshot_name << " (1)" << endl;
 288
 289         n_physical_outputs = _engine.n_physical_outputs();
 290         n_physical_inputs =  _engine.n_physical_inputs();
 291
 292         first_stage_init (fullpath, snapshot_name);
 293
 294         new_session = !g_file_test (_path.c_str(), GFileTest (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR));
 295         if (new_session) {
 296                 if (create (new_session, mix_template, compute_initial_length())) {
 297                         cerr << "create failed\n";
 298                         destroy ();
 299                         throw failed_constructor ();
 300                 }
 301         }
 302
 303         if (second_stage_init (new_session)) {
 304                 destroy ();
 305                 throw failed_constructor ();
 306         }
 307
 308         store_recent_sessions(_name, _path);
 309
 310         bool was_dirty = dirty();
 311
 312         _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
 313
 314         Config->ParameterChanged.connect (mem_fun (*this, &Session::config_changed));
 315
 316         if (was_dirty) {
 317                 DirtyChanged (); /* EMIT SIGNAL */
 318         }
 319 }
 320
 321 Session::Session (AudioEngine &eng,
 322                   string fullpath,
 323                   string snapshot_name,
 324                   AutoConnectOption input_ac,
 325                   AutoConnectOption output_ac,
 326                   uint32_t control_out_channels,
 327                   uint32_t master_out_channels,
 328                   uint32_t requested_physical_in,
 329                   uint32_t requested_physical_out,
 330                   nframes_t initial_length)
 331
 332         : _engine (eng),
 333           _scratch_buffers(new BufferSet()),
 334           _silent_buffers(new BufferSet()),
 335           _send_buffers(new BufferSet()),
 336           _mmc_port (default_mmc_port),
 337           _mtc_port (default_mtc_port),
 338           _midi_port (default_midi_port),
 339           pending_events (2048),
 340           //midi_requests (16),
 341           _send_smpte_update (false),
 342           diskstreams (new DiskstreamList),
 343           routes (new RouteList),
 344           main_outs (0)
 345
 346 {
 347         bool new_session;
 348
 349         if (!eng.connected()) {
 350                 throw failed_constructor();
 351         }
 352
 353         cerr << "Loading session " << fullpath << " using snapshot " << snapshot_name << " (2)" << endl;
 354
 355         n_physical_outputs = _engine.n_physical_outputs();
 356         n_physical_inputs = _engine.n_physical_inputs();
 357
 358         if (n_physical_inputs) {
 359                 n_physical_inputs = max (requested_physical_in, n_physical_inputs);
 360         }
 361
 362         if (n_physical_outputs) {
 363                 n_physical_outputs = max (requested_physical_out, n_physical_outputs);
 364         }
 365
 366         first_stage_init (fullpath, snapshot_name);
 367
 368         new_session = !g_file_test (_path.c_str(), GFileTest (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR));
 369
 370         if (new_session) {
 371                 if (create (new_session, 0, initial_length)) {
 372                         destroy ();
 373                         throw failed_constructor ();
 374                 }
 375         }
 376
 377         {
 378                 /* set up Master Out and Control Out if necessary */
 379
 380                 RouteList rl;
 381                 int control_id = 1;
 382
 383                 if (control_out_channels) {
 384                         shared_ptr<Route> r (new Route (*this, _("monitor"), -1, control_out_channels, -1, control_out_channels, Route::ControlOut));
 385                         r->set_remote_control_id (control_id++);
 386
 387                         rl.push_back (r);
 388                 }
 389
 390                 if (master_out_channels) {
 391                         shared_ptr<Route> r (new Route (*this, _("master"), -1, master_out_channels, -1, master_out_channels, Route::MasterOut));
 392                         r->set_remote_control_id (control_id);
 393
 394                         rl.push_back (r);
 395                 } else {
 396                         /* prohibit auto-connect to master, because there isn't one */
 397                         output_ac = AutoConnectOption (output_ac & ~AutoConnectMaster);
 398                 }
 399
 400                 if (!rl.empty()) {
 401                         add_routes (rl);
 402                 }
 403
 404         }
 405
 406         Config->set_input_auto_connect (input_ac);
 407         Config->set_output_auto_connect (output_ac);
 408
 409         if (second_stage_init (new_session)) {
 410                 destroy ();
 411                 throw failed_constructor ();
 412         }
 413
 414         store_recent_sessions(_name, _path);
 415
 416         bool was_dirty = dirty ();
 417
 418         _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
 419
 420         Config->ParameterChanged.connect (mem_fun (*this, &Session::config_changed));
 421
 422         if (was_dirty) {
 423                 DirtyChanged (); /* EMIT SIGNAL */
 424         }
 425 }
 426
 427 Session::~Session ()
 428 {
 429         destroy ();
 430 }
 431
 432 void
 433 Session::destroy ()
 434 {
 435         /* if we got to here, leaving pending capture state around
 436            is a mistake.
 437         */
 438
 439         remove_pending_capture_state ();
 440
 441         _state_of_the_state = StateOfTheState (CannotSave|Deletion);
 442         _engine.remove_session ();
 443
 444         GoingAway (); /* EMIT SIGNAL */
 445
 446         /* do this */
 447
 448         notify_callbacks ();
 449
 450         /* clear history so that no references to objects are held any more */
 451
 452         _history.clear ();
 453
 454         /* clear state tree so that no references to objects are held any more */
 455
 456         if (state_tree) {
 457                 delete state_tree;
 458         }
 459
 460         terminate_butler_thread ();
 461         //terminate_midi_thread ();
 462
 463         if (click_data && click_data != default_click) {
 464                 delete [] click_data;
 465         }
 466
 467         if (click_emphasis_data && click_emphasis_data != default_click_emphasis) {
 468                 delete [] click_emphasis_data;
 469         }
 470
 471         clear_clicks ();
 472
 473         delete _scratch_buffers;
 474         delete _silent_buffers;
 475         delete _send_buffers;
 476
 477         AudioDiskstream::free_working_buffers();
 478
 479 #undef TRACK_DESTRUCTION
 480 #ifdef TRACK_DESTRUCTION
 481         cerr << "delete named selections\n";
 482 #endif /* TRACK_DESTRUCTION */
 483         for (NamedSelectionList::iterator i = named_selections.begin(); i != named_selections.end(); ) {
 484                 NamedSelectionList::iterator tmp;
 485
 486                 tmp = i;
 487                 ++tmp;
 488
 489                 delete *i;
 490                 i = tmp;
 491         }
 492
 493 #ifdef TRACK_DESTRUCTION
 494         cerr << "delete playlists\n";
 495 #endif /* TRACK_DESTRUCTION */
 496         for (PlaylistList::iterator i = playlists.begin(); i != playlists.end(); ) {
 497                 PlaylistList::iterator tmp;
 498
 499                 tmp = i;
 500                 ++tmp;
 501
 502                 (*i)->drop_references ();
 503
 504                 i = tmp;
 505         }
 506
 507         for (PlaylistList::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ) {
 508                 PlaylistList::iterator tmp;
 509
 510                 tmp = i;
 511                 ++tmp;
 512
 513                 (*i)->drop_references ();
 514
 515                 i = tmp;
 516         }
 517
 518         playlists.clear ();
 519         unused_playlists.clear ();
 520
 521 #ifdef TRACK_DESTRUCTION
 522         cerr << "delete regions\n";
 523 #endif /* TRACK_DESTRUCTION */
 524
 525         for (RegionList::iterator i = regions.begin(); i != regions.end(); ) {
 526                 RegionList::iterator tmp;
 527
 528                 tmp = i;
 529                 ++tmp;
 530
 531                 i->second->drop_references ();
 532
 533                 i = tmp;
 534         }
 535
 536         regions.clear ();
 537
 538 #ifdef TRACK_DESTRUCTION
 539         cerr << "delete routes\n";
 540 #endif /* TRACK_DESTRUCTION */
 541         {
 542                 RCUWriter<RouteList> writer (routes);
 543                 boost::shared_ptr<RouteList> r = writer.get_copy ();
 544                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 545                         (*i)->drop_references ();
 546                 }
 547                 r->clear ();
 548                 /* writer goes out of scope and updates master */
 549         }
 550
 551         routes.flush ();
 552
 553 #ifdef TRACK_DESTRUCTION
 554         cerr << "delete diskstreams\n";
 555 #endif /* TRACK_DESTRUCTION */
 556        {
 557                RCUWriter<DiskstreamList> dwriter (diskstreams);
 558                boost::shared_ptr<DiskstreamList> dsl = dwriter.get_copy();
 559                for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
 560                        (*i)->drop_references ();
 561                }
 562                dsl->clear ();
 563        }
 564        diskstreams.flush ();
 565
 566 #ifdef TRACK_DESTRUCTION
 567         cerr << "delete audio sources\n";
 568 #endif /* TRACK_DESTRUCTION */
 569         for (SourceMap::iterator i = sources.begin(); i != sources.end(); ) {
 570                 SourceMap::iterator tmp;
 571
 572                 tmp = i;
 573                 ++tmp;
 574
 575                 i->second->drop_references ();
 576
 577                 i = tmp;
 578         }
 579
 580         sources.clear ();
 581
 582 #ifdef TRACK_DESTRUCTION
 583         cerr << "delete mix groups\n";
 584 #endif /* TRACK_DESTRUCTION */
 585         for (list<RouteGroup *>::iterator i = mix_groups.begin(); i != mix_groups.end(); ) {
 586                 list<RouteGroup*>::iterator tmp;
 587
 588                 tmp = i;
 589                 ++tmp;
 590
 591                 delete *i;
 592
 593                 i = tmp;
 594         }
 595
 596 #ifdef TRACK_DESTRUCTION
 597         cerr << "delete edit groups\n";
 598 #endif /* TRACK_DESTRUCTION */
 599         for (list<RouteGroup *>::iterator i = edit_groups.begin(); i != edit_groups.end(); ) {
 600                 list<RouteGroup*>::iterator tmp;
 601
 602                 tmp = i;
 603                 ++tmp;
 604
 605                 delete *i;
 606
 607                 i = tmp;
 608         }
 609
 610 #ifdef TRACK_DESTRUCTION
 611         cerr << "delete connections\n";
 612 #endif /* TRACK_DESTRUCTION */
 613         for (ConnectionList::iterator i = _connections.begin(); i != _connections.end(); ) {
 614                 ConnectionList::iterator tmp;
 615
 616                 tmp = i;
 617                 ++tmp;
 618
 619                 delete *i;
 620
 621                 i = tmp;
 622         }
 623
 624         if (butler_mixdown_buffer) {
 625                 delete [] butler_mixdown_buffer;
 626         }
 627
 628         if (butler_gain_buffer) {
 629                 delete [] butler_gain_buffer;
 630         }
 631
 632         Crossfade::set_buffer_size (0);
 633
 634         if (mmc) {
 635                 delete mmc;
 636         }
 637 }
 638
 639 void
 640 Session::set_worst_io_latencies ()
 641 {
 642         _worst_output_latency = 0;
 643         _worst_input_latency = 0;
 644
 645         if (!_engine.connected()) {
 646                 return;
 647         }
 648
 649         boost::shared_ptr<RouteList> r = routes.reader ();
 650
 651         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 652                 _worst_output_latency = max (_worst_output_latency, (*i)->output_latency());
 653                 _worst_input_latency = max (_worst_input_latency, (*i)->input_latency());
 654         }
 655 }
 656
 657 void
 658 Session::when_engine_running ()
 659 {
 660         string first_physical_output;
 661
 662         /* we don't want to run execute this again */
 663
 664         set_block_size (_engine.frames_per_cycle());
 665         set_frame_rate (_engine.frame_rate());
 666
 667         Config->map_parameters (mem_fun (*this, &Session::config_changed));
 668
 669         /* every time we reconnect, recompute worst case output latencies */
 670
 671         _engine.Running.connect (mem_fun (*this, &Session::set_worst_io_latencies));
 672
 673         if (synced_to_jack()) {
 674                 _engine.transport_stop ();
 675         }
 676
 677         if (Config->get_jack_time_master()) {
 678                 _engine.transport_locate (_transport_frame);
 679         }
 680
 681         _clicking = false;
 682
 683         try {
 684                 XMLNode* child = 0;
 685
 686                 _click_io.reset (new ClickIO (*this, "click", 0, 0, -1, -1));
 687
 688                 if (state_tree && (child = find_named_node (*state_tree->root(), "Click")) != 0) {
 689
 690                         /* existing state for Click */
 691
 692                         if (_click_io->set_state (*child->children().front()) == 0) {
 693
 694                                 _clicking = Config->get_clicking ();
 695
 696                         } else {
 697
 698                                 error << _("could not setup Click I/O") << endmsg;
 699                                 _clicking = false;
 700                         }
 701
 702                 } else {
 703
 704                         /* default state for Click */
 705
 706                         first_physical_output = _engine.get_nth_physical_output (DataType::AUDIO, 0);
 707
 708                         if (first_physical_output.length()) {
 709                                 if (_click_io->add_output_port (first_physical_output, this)) {
 710                                         // relax, even though its an error
 711                                 } else {
 712                                         _clicking = Config->get_clicking ();
 713                                 }
 714                         }
 715                 }
 716         }
 717
 718         catch (failed_constructor& err) {
 719                 error << _("cannot setup Click I/O") << endmsg;
 720         }
 721
 722         set_worst_io_latencies ();
 723
 724         if (_clicking) {
 725                 // XXX HOW TO ALERT UI TO THIS ? DO WE NEED TO?
 726         }
 727
 728         /* Create a set of Connection objects that map
 729            to the physical outputs currently available
 730         */
 731
 732         /* ONE: MONO */
 733
 734         for (uint32_t np = 0; np < n_physical_outputs; ++np) {
 735                 char buf[32];
 736                 snprintf (buf, sizeof (buf), _("out %" PRIu32), np+1);
 737
 738                 Connection* c = new OutputConnection (buf, true);
 739
 740                 c->add_port ();
 741                 c->add_connection (0, _engine.get_nth_physical_output (DataType::AUDIO, np));
 742
 743                 add_connection (c);
 744         }
 745
 746         for (uint32_t np = 0; np < n_physical_inputs; ++np) {
 747                 char buf[32];
 748                 snprintf (buf, sizeof (buf), _("in %" PRIu32), np+1);
 749
 750                 Connection* c = new InputConnection (buf, true);
 751
 752                 c->add_port ();
 753                 c->add_connection (0, _engine.get_nth_physical_input (DataType::AUDIO, np));
 754
 755                 add_connection (c);
 756         }
 757
 758         /* TWO: STEREO */
 759
 760         for (uint32_t np = 0; np < n_physical_outputs; np +=2) {
 761                 char buf[32];
 762                 snprintf (buf, sizeof (buf), _("out %" PRIu32 "+%" PRIu32), np+1, np+2);
 763
 764                 Connection* c = new OutputConnection (buf, true);
 765
 766                 c->add_port ();
 767                 c->add_port ();
 768                 c->add_connection (0, _engine.get_nth_physical_output (DataType::AUDIO, np));
 769                 c->add_connection (1, _engine.get_nth_physical_output (DataType::AUDIO, np+1));
 770
 771                 add_connection (c);
 772         }
 773
 774         for (uint32_t np = 0; np < n_physical_inputs; np +=2) {
 775                 char buf[32];
 776                 snprintf (buf, sizeof (buf), _("in %" PRIu32 "+%" PRIu32), np+1, np+2);
 777
 778                 Connection* c = new InputConnection (buf, true);
 779
 780                 c->add_port ();
 781                 c->add_port ();
 782                 c->add_connection (0, _engine.get_nth_physical_input (DataType::AUDIO, np));
 783                 c->add_connection (1, _engine.get_nth_physical_input (DataType::AUDIO, np+1));
 784
 785                 add_connection (c);
 786         }
 787
 788         /* THREE MASTER */
 789
 790         if (_master_out) {
 791
 792                 /* create master/control ports */
 793
 794                 if (_master_out) {
 795                         uint32_t n;
 796
 797                         /* force the master to ignore any later call to this */
 798
 799                         if (_master_out->pending_state_node) {
 800                                 _master_out->ports_became_legal();
 801                         }
 802
 803                         /* no panner resets till we are through */
 804
 805                         _master_out->defer_pan_reset ();
 806
 807                         while (_master_out->n_inputs().get(DataType::AUDIO)
 808                                         < _master_out->input_maximum().get(DataType::AUDIO)) {
 809                                 if (_master_out->add_input_port ("", this, DataType::AUDIO)) {
 810                                         error << _("cannot setup master inputs")
 811                                               << endmsg;
 812                                         break;
 813                                 }
 814                         }
 815                         n = 0;
 816                         while (_master_out->n_outputs().get(DataType::AUDIO)
 817                                         < _master_out->output_maximum().get(DataType::AUDIO)) {
 818                                 if (_master_out->add_output_port (_engine.get_nth_physical_output (DataType::AUDIO, n), this, DataType::AUDIO)) {
 819                                         error << _("cannot setup master outputs")
 820                                               << endmsg;
 821                                         break;
 822                                 }
 823                                 n++;
 824                         }
 825
 826                         _master_out->allow_pan_reset ();
 827
 828                 }
 829
 830                 Connection* c = new OutputConnection (_("Master Out"), true);
 831
 832                 for (uint32_t n = 0; n < _master_out->n_inputs ().get_total(); ++n) {
 833                         c->add_port ();
 834                         c->add_connection ((int) n, _master_out->input(n)->name());
 835                 }
 836                 add_connection (c);
 837         }
 838
 839         hookup_io ();
 840
 841         /* catch up on send+insert cnts */
 842
 843         insert_cnt = 0;
 844
 845         for (list<PortInsert*>::iterator i = _port_inserts.begin(); i != _port_inserts.end(); ++i) {
 846                 uint32_t id;
 847
 848                 if (sscanf ((*i)->name().c_str(), "%*s %u", &id) == 1) {
 849                         if (id > insert_cnt) {
 850                                 insert_cnt = id;
 851                         }
 852                 }
 853         }
 854
 855         send_cnt = 0;
 856
 857         for (list<Send*>::iterator i = _sends.begin(); i != _sends.end(); ++i) {
 858                 uint32_t id;
 859
 860                 if (sscanf ((*i)->name().c_str(), "%*s %u", &id) == 1) {
 861                         if (id > send_cnt) {
 862                                 send_cnt = id;
 863                         }
 864                 }
 865         }
 866
 867
 868         _state_of_the_state = StateOfTheState (_state_of_the_state & ~(CannotSave|Dirty));
 869
 870         /* hook us up to the engine */
 871
 872         _engine.set_session (this);
 873
 874 #ifdef HAVE_LIBLO
 875         /* and to OSC */
 876
 877         osc->set_session (*this);
 878 #endif
 879
 880         _state_of_the_state = Clean;
 881
 882         DirtyChanged (); /* EMIT SIGNAL */
 883 }
 884
 885 void
 886 Session::hookup_io ()
 887 {
 888         /* stop graph reordering notifications from
 889            causing resorts, etc.
 890         */
 891
 892         _state_of_the_state = StateOfTheState (_state_of_the_state | InitialConnecting);
 893
 894         if (auditioner == 0) {
 895
 896                 /* we delay creating the auditioner till now because
 897                    it makes its own connections to ports.
 898                    the engine has to be running for this to work.
 899                 */
 900
 901                 try {
 902                         auditioner.reset (new Auditioner (*this));
 903                 }
 904
 905                 catch (failed_constructor& err) {
 906                         warning << _("cannot create Auditioner: no auditioning of regions possible") << endmsg;
 907                 }
 908         }
 909
 910         /* Tell all IO objects to create their ports */
 911
 912         IO::enable_ports ();
 913
 914         if (_control_out) {
 915                 uint32_t n;
 916
 917                 while (_control_out->n_inputs().get(DataType::AUDIO) < _control_out->input_maximum().get(DataType::AUDIO)) {
 918                         if (_control_out->add_input_port ("", this)) {
 919                                 error << _("cannot setup control inputs")
 920                                       << endmsg;
 921                                 break;
 922                         }
 923                 }
 924                 n = 0;
 925                 while (_control_out->n_outputs().get(DataType::AUDIO) < _control_out->output_maximum().get(DataType::AUDIO)) {
 926                         if (_control_out->add_output_port (_engine.get_nth_physical_output (DataType::AUDIO, n), this)) {
 927                                 error << _("cannot set up master outputs")
 928                                       << endmsg;
 929                                 break;
 930                         }
 931                         n++;
 932                 }
 933         }
 934
 935         /* Tell all IO objects to connect themselves together */
 936
 937         IO::enable_connecting ();
 938
 939         /* Now reset all panners */
 940
 941         IO::reset_panners ();
 942
 943         /* Anyone who cares about input state, wake up and do something */
 944
 945         IOConnectionsComplete (); /* EMIT SIGNAL */
 946
 947         _state_of_the_state = StateOfTheState (_state_of_the_state & ~InitialConnecting);
 948
 949         /* now handle the whole enchilada as if it was one
 950            graph reorder event.
 951         */
 952
 953         graph_reordered ();
 954
 955         /* update mixer solo state */
 956
 957         catch_up_on_solo();
 958 }
 959
 960 void
 961 Session::playlist_length_changed ()
 962 {
 963         /* we can't just increase end_location->end() if pl->get_maximum_extent()
 964            if larger. if the playlist used to be the longest playlist,
 965            and its now shorter, we have to decrease end_location->end(). hence,
 966            we have to iterate over all diskstreams and check the
 967            playlists currently in use.
 968         */
 969         find_current_end ();
 970 }
 971
 972 void
 973 Session::diskstream_playlist_changed (boost::shared_ptr<Diskstream> dstream)
 974 {
 975         boost::shared_ptr<Playlist> playlist;
 976
 977         if ((playlist = dstream->playlist()) != 0) {
 978                 playlist->LengthChanged.connect (mem_fun (this, &Session::playlist_length_changed));
 979         }
 980
 981         /* see comment in playlist_length_changed () */
 982         find_current_end ();
 983 }
 984
 985 bool
 986 Session::record_enabling_legal () const
 987 {
 988         /* this used to be in here, but survey says.... we don't need to restrict it */
 989         // if (record_status() == Recording) {
 990         //      return false;
 991         // }
 992
 993         if (Config->get_all_safe()) {
 994                 return false;
 995         }
 996         return true;
 997 }
 998
 999 void
1000 Session::reset_input_monitor_state ()
1001 {
1002         if (transport_rolling()) {
1003
1004                 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
1005
1006                 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
1007                         if ((*i)->record_enabled ()) {
1008                                 //cerr << "switching to input = " << !auto_input << __FILE__ << __LINE__ << endl << endl;
1009                                 (*i)->monitor_input (Config->get_monitoring_model() == HardwareMonitoring && !Config->get_auto_input());
1010                         }
1011                 }
1012         } else {
1013                 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
1014
1015                 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
1016                         if ((*i)->record_enabled ()) {
1017                                 //cerr << "switching to input = " << !Config->get_auto_input() << __FILE__ << __LINE__ << endl << endl;
1018                                 (*i)->monitor_input (Config->get_monitoring_model() == HardwareMonitoring);
1019                         }
1020                 }
1021         }
1022 }
1023
1024 void
1025 Session::auto_punch_start_changed (Location* location)
1026 {
1027         replace_event (Event::PunchIn, location->start());
1028
1029         if (get_record_enabled() && Config->get_punch_in()) {
1030                 /* capture start has been changed, so save new pending state */
1031                 save_state ("", true);
1032         }
1033 }
1034
1035 void
1036 Session::auto_punch_end_changed (Location* location)
1037 {
1038         nframes_t when_to_stop = location->end();
1039         // when_to_stop += _worst_output_latency + _worst_input_latency;
1040         replace_event (Event::PunchOut, when_to_stop);
1041 }
1042
1043 void
1044 Session::auto_punch_changed (Location* location)
1045 {
1046         nframes_t when_to_stop = location->end();
1047
1048         replace_event (Event::PunchIn, location->start());
1049         //when_to_stop += _worst_output_latency + _worst_input_latency;
1050         replace_event (Event::PunchOut, when_to_stop);
1051 }
1052
1053 void
1054 Session::auto_loop_changed (Location* location)
1055 {
1056         replace_event (Event::AutoLoop, location->end(), location->start());
1057
1058         if (transport_rolling() && play_loop) {
1059
1060                 //if (_transport_frame < location->start() || _transport_frame > location->end()) {
1061
1062                 if (_transport_frame > location->end()) {
1063                         // relocate to beginning of loop
1064                         clear_events (Event::LocateRoll);
1065
1066                         request_locate (location->start(), true);
1067
1068                 }
1069                 else if (Config->get_seamless_loop() && !loop_changing) {
1070
1071                         // schedule a locate-roll to refill the diskstreams at the
1072                         // previous loop end
1073                         loop_changing = true;
1074
1075                         if (location->end() > last_loopend) {
1076                                 clear_events (Event::LocateRoll);
1077                                 Event *ev = new Event (Event::LocateRoll, Event::Add, last_loopend, last_loopend, 0, true);
1078                                 queue_event (ev);
1079                         }
1080
1081                 }
1082         }
1083
1084         last_loopend = location->end();
1085
1086 }
1087
1088 void
1089 Session::set_auto_punch_location (Location* location)
1090 {
1091         Location* existing;
1092
1093         if ((existing = _locations.auto_punch_location()) != 0 && existing != location) {
1094                 auto_punch_start_changed_connection.disconnect();
1095                 auto_punch_end_changed_connection.disconnect();
1096                 auto_punch_changed_connection.disconnect();
1097                 existing->set_auto_punch (false, this);
1098                 remove_event (existing->start(), Event::PunchIn);
1099                 clear_events (Event::PunchOut);
1100                 auto_punch_location_changed (0);
1101         }
1102
1103         set_dirty();
1104
1105         if (location == 0) {
1106                 return;
1107         }
1108
1109         if (location->end() <= location->start()) {
1110                 error << _("Session: you can't use that location for auto punch (start <= end)") << endmsg;
1111                 return;
1112         }
1113
1114         auto_punch_start_changed_connection.disconnect();
1115         auto_punch_end_changed_connection.disconnect();
1116         auto_punch_changed_connection.disconnect();
1117
1118         auto_punch_start_changed_connection = location->start_changed.connect (mem_fun (this, &Session::auto_punch_start_changed));
1119         auto_punch_end_changed_connection = location->end_changed.connect (mem_fun (this, &Session::auto_punch_end_changed));
1120         auto_punch_changed_connection = location->changed.connect (mem_fun (this, &Session::auto_punch_changed));
1121
1122         location->set_auto_punch (true, this);
1123         auto_punch_location_changed (location);
1124 }
1125
1126 void
1127 Session::set_auto_loop_location (Location* location)
1128 {
1129         Location* existing;
1130
1131         if ((existing = _locations.auto_loop_location()) != 0 && existing != location) {
1132                 auto_loop_start_changed_connection.disconnect();
1133                 auto_loop_end_changed_connection.disconnect();
1134                 auto_loop_changed_connection.disconnect();
1135                 existing->set_auto_loop (false, this);
1136                 remove_event (existing->end(), Event::AutoLoop);
1137                 auto_loop_location_changed (0);
1138         }
1139
1140         set_dirty();
1141
1142         if (location == 0) {
1143                 return;
1144         }
1145
1146         if (location->end() <= location->start()) {
1147                 error << _("Session: you can't use a mark for auto loop") << endmsg;
1148                 return;
1149         }
1150
1151         last_loopend = location->end();
1152
1153         auto_loop_start_changed_connection.disconnect();
1154         auto_loop_end_changed_connection.disconnect();
1155         auto_loop_changed_connection.disconnect();
1156
1157         auto_loop_start_changed_connection = location->start_changed.connect (mem_fun (this, &Session::auto_loop_changed));
1158         auto_loop_end_changed_connection = location->end_changed.connect (mem_fun (this, &Session::auto_loop_changed));
1159         auto_loop_changed_connection = location->changed.connect (mem_fun (this, &Session::auto_loop_changed));
1160
1161         location->set_auto_loop (true, this);
1162         auto_loop_location_changed (location);
1163 }
1164
1165 void
1166 Session::locations_added (Location* ignored)
1167 {
1168         set_dirty ();
1169 }
1170
1171 void
1172 Session::locations_changed ()
1173 {
1174         _locations.apply (*this, &Session::handle_locations_changed);
1175 }
1176
1177 void
1178 Session::handle_locations_changed (Locations::LocationList& locations)
1179 {
1180         Locations::LocationList::iterator i;
1181         Location* location;
1182         bool set_loop = false;
1183         bool set_punch = false;
1184
1185         for (i = locations.begin(); i != locations.end(); ++i) {
1186
1187                 location =* i;
1188
1189                 if (location->is_auto_punch()) {
1190                         set_auto_punch_location (location);
1191                         set_punch = true;
1192                 }
1193                 if (location->is_auto_loop()) {
1194                         set_auto_loop_location (location);
1195                         set_loop = true;
1196                 }
1197
1198         }
1199
1200         if (!set_loop) {
1201                 set_auto_loop_location (0);
1202         }
1203         if (!set_punch) {
1204                 set_auto_punch_location (0);
1205         }
1206
1207         set_dirty();
1208 }
1209
1210 void
1211 Session::enable_record ()
1212 {
1213         /* XXX really atomic compare+swap here */
1214         if (g_atomic_int_get (&_record_status) != Recording) {
1215                 g_atomic_int_set (&_record_status, Recording);
1216                 _last_record_location = _transport_frame;
1217                 deliver_mmc(MIDI::MachineControl::cmdRecordStrobe, _last_record_location);
1218
1219                 if (Config->get_monitoring_model() == HardwareMonitoring && Config->get_auto_input()) {
1220                         boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
1221                         for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
1222                                 if ((*i)->record_enabled ()) {
1223                                         (*i)->monitor_input (true);
1224                                 }
1225                         }
1226                 }
1227
1228                 RecordStateChanged ();
1229         }
1230 }
1231
1232 void
1233 Session::disable_record (bool rt_context, bool force)
1234 {
1235         RecordState rs;
1236
1237         if ((rs = (RecordState) g_atomic_int_get (&_record_status)) != Disabled) {
1238
1239                 if (!Config->get_latched_record_enable () || force) {
1240                         g_atomic_int_set (&_record_status, Disabled);
1241                 } else {
1242                         if (rs == Recording) {
1243                                 g_atomic_int_set (&_record_status, Enabled);
1244                         }
1245                 }
1246
1247                 // FIXME: timestamp correct? [DR]
1248                 // FIXME FIXME FIXME: rt_context?  this must be called in the process thread.
1249                 // does this /need/ to be sent in all cases?
1250                 if (rt_context)
1251                         deliver_mmc (MIDI::MachineControl::cmdRecordExit, _transport_frame);
1252
1253                 if (Config->get_monitoring_model() == HardwareMonitoring && Config->get_auto_input()) {
1254                         boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
1255
1256                         for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
1257                                 if ((*i)->record_enabled ()) {
1258                                         (*i)->monitor_input (false);
1259                                 }
1260                         }
1261                 }
1262
1263                 RecordStateChanged (); /* emit signal */
1264
1265                 if (!rt_context) {
1266                         remove_pending_capture_state ();
1267                 }
1268         }
1269 }
1270
1271 void
1272 Session::step_back_from_record ()
1273 {
1274         g_atomic_int_set (&_record_status, Enabled);
1275
1276         if (Config->get_monitoring_model() == HardwareMonitoring) {
1277                 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
1278
1279                 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
1280                         if (Config->get_auto_input() && (*i)->record_enabled ()) {
1281                                 //cerr << "switching from input" << __FILE__ << __LINE__ << endl << endl;
1282                                 (*i)->monitor_input (false);
1283                         }
1284                 }
1285         }
1286 }
1287
1288 void
1289 Session::maybe_enable_record ()
1290 {
1291         g_atomic_int_set (&_record_status, Enabled);
1292
1293         /* this function is currently called from somewhere other than an RT thread.
1294            this save_state() call therefore doesn't impact anything.
1295         */
1296
1297         save_state ("", true);
1298
1299         if (_transport_speed) {
1300                 if (!Config->get_punch_in()) {
1301                         enable_record ();
1302                 }
1303         } else {
1304                 deliver_mmc (MIDI::MachineControl::cmdRecordPause, _transport_frame);
1305                 RecordStateChanged (); /* EMIT SIGNAL */
1306         }
1307
1308         set_dirty();
1309 }
1310
1311 nframes_t
1312 Session::audible_frame () const
1313 {
1314         nframes_t ret;
1315         nframes_t offset;
1316         nframes_t tf;
1317
1318         /* the first of these two possible settings for "offset"
1319            mean that the audible frame is stationary until
1320            audio emerges from the latency compensation
1321            "pseudo-pipeline".
1322
1323            the second means that the audible frame is stationary
1324            until audio would emerge from a physical port
1325            in the absence of any plugin latency compensation
1326         */
1327
1328         offset = _worst_output_latency;
1329
1330         if (offset > current_block_size) {
1331                 offset -= current_block_size;
1332         } else {
1333                 /* XXX is this correct? if we have no external
1334                    physical connections and everything is internal
1335                    then surely this is zero? still, how
1336                    likely is that anyway?
1337                 */
1338                 offset = current_block_size;
1339         }
1340
1341         if (synced_to_jack()) {
1342                 tf = _engine.transport_frame();
1343         } else {
1344                 tf = _transport_frame;
1345         }
1346
1347         if (_transport_speed == 0) {
1348                 return tf;
1349         }
1350
1351         if (tf < offset) {
1352                 return 0;
1353         }
1354
1355         ret = tf;
1356
1357         if (!non_realtime_work_pending()) {
1358
1359                 /* MOVING */
1360
1361                 /* take latency into account */
1362
1363                 ret -= offset;
1364         }
1365
1366         return ret;
1367 }
1368
1369 void
1370 Session::set_frame_rate (nframes_t frames_per_second)
1371 {
1372         /** \fn void Session::set_frame_size(nframes_t)
1373                 the AudioEngine object that calls this guarantees
1374                 that it will not be called while we are also in
1375                 ::process(). Its fine to do things that block
1376                 here.
1377         */
1378
1379         _base_frame_rate = frames_per_second;
1380
1381         sync_time_vars();
1382
1383         Route::set_automation_interval ((nframes_t) ceil ((double) frames_per_second * 0.25));
1384
1385         // XXX we need some equivalent to this, somehow
1386         // SndFileSource::setup_standard_crossfades (frames_per_second);
1387
1388         set_dirty();
1389
1390         /* XXX need to reset/reinstantiate all LADSPA plugins */
1391 }
1392
1393 void
1394 Session::set_block_size (nframes_t nframes)
1395 {
1396         /* the AudioEngine guarantees
1397            that it will not be called while we are also in
1398            ::process(). It is therefore fine to do things that block
1399            here.
1400         */
1401
1402         {
1403
1404                 current_block_size = nframes;
1405
1406                 ensure_buffers(_scratch_buffers->available());
1407
1408                 if (_gain_automation_buffer) {
1409                         delete [] _gain_automation_buffer;
1410                 }
1411                 _gain_automation_buffer = new gain_t[nframes];
1412
1413                 allocate_pan_automation_buffers (nframes, _npan_buffers, true);
1414
1415                 boost::shared_ptr<RouteList> r = routes.reader ();
1416
1417                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1418                         (*i)->set_block_size (nframes);
1419                 }
1420
1421                 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
1422                 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
1423                         (*i)->set_block_size (nframes);
1424                 }
1425
1426                 set_worst_io_latencies ();
1427         }
1428 }
1429
1430 void
1431 Session::set_default_fade (float steepness, float fade_msecs)
1432 {
1433 #if 0
1434         nframes_t fade_frames;
1435
1436         /* Don't allow fade of less 1 frame */
1437
1438         if (fade_msecs < (1000.0 * (1.0/_current_frame_rate))) {
1439
1440                 fade_msecs = 0;
1441                 fade_frames = 0;
1442
1443         } else {
1444
1445                 fade_frames = (nframes_t) floor (fade_msecs * _current_frame_rate * 0.001);
1446
1447         }
1448
1449         default_fade_msecs = fade_msecs;
1450         default_fade_steepness = steepness;
1451
1452         {
1453                 // jlc, WTF is this!
1454                 Glib::RWLock::ReaderLock lm (route_lock);
1455                 AudioRegion::set_default_fade (steepness, fade_frames);
1456         }
1457
1458         set_dirty();
1459
1460         /* XXX have to do this at some point */
1461         /* foreach region using default fade, reset, then
1462            refill_all_diskstream_buffers ();
1463         */
1464 #endif
1465 }
1466
1467 struct RouteSorter {
1468     bool operator() (boost::shared_ptr<Route> r1, boost::shared_ptr<Route> r2) {
1469             if (r1->fed_by.find (r2) != r1->fed_by.end()) {
1470                     return false;
1471             } else if (r2->fed_by.find (r1) != r2->fed_by.end()) {
1472                     return true;
1473             } else {
1474                     if (r1->fed_by.empty()) {
1475                             if (r2->fed_by.empty()) {
1476                                     /* no ardour-based connections inbound to either route. just use signal order */
1477                                     return r1->order_key(N_("signal")) < r2->order_key(N_("signal"));
1478                             } else {
1479                                     /* r2 has connections, r1 does not; run r1 early */
1480                                     return true;
1481                             }
1482                     } else {
1483                             return r1->order_key(N_("signal")) < r2->order_key(N_("signal"));
1484                     }
1485             }
1486     }
1487 };
1488
1489 static void
1490 trace_terminal (shared_ptr<Route> r1, shared_ptr<Route> rbase)
1491 {
1492         shared_ptr<Route> r2;
1493
1494         if ((r1->fed_by.find (rbase) != r1->fed_by.end()) && (rbase->fed_by.find (r1) != rbase->fed_by.end())) {
1495                 info << string_compose(_("feedback loop setup between %1 and %2"), r1->name(), rbase->name()) << endmsg;
1496                 return;
1497         }
1498
1499         /* make a copy of the existing list of routes that feed r1 */
1500
1501         set<shared_ptr<Route> > existing = r1->fed_by;
1502
1503         /* for each route that feeds r1, recurse, marking it as feeding
1504            rbase as well.
1505         */
1506
1507         for (set<shared_ptr<Route> >::iterator i = existing.begin(); i != existing.end(); ++i) {
1508                 r2 =* i;
1509
1510                 /* r2 is a route that feeds r1 which somehow feeds base. mark
1511                    base as being fed by r2
1512                 */
1513
1514                 rbase->fed_by.insert (r2);
1515
1516                 if (r2 != rbase) {
1517
1518                         /* 2nd level feedback loop detection. if r1 feeds or is fed by r2,
1519                            stop here.
1520                          */
1521
1522                         if ((r1->fed_by.find (r2) != r1->fed_by.end()) && (r2->fed_by.find (r1) != r2->fed_by.end())) {
1523                                 continue;
1524                         }
1525
1526                         /* now recurse, so that we can mark base as being fed by
1527                            all routes that feed r2
1528                         */
1529
1530                         trace_terminal (r2, rbase);
1531                 }
1532
1533         }
1534 }
1535
1536 void
1537 Session::resort_routes ()
1538 {
1539         /* don't do anything here with signals emitted
1540            by Routes while we are being destroyed.
1541         */
1542
1543         if (_state_of_the_state & Deletion) {
1544                 return;
1545         }
1546
1547
1548         {
1549
1550                 RCUWriter<RouteList> writer (routes);
1551                 shared_ptr<RouteList> r = writer.get_copy ();
1552                 resort_routes_using (r);
1553                 /* writer goes out of scope and forces update */
1554         }
1555
1556 }
1557 void
1558 Session::resort_routes_using (shared_ptr<RouteList> r)
1559 {
1560         RouteList::iterator i, j;
1561
1562         for (i = r->begin(); i != r->end(); ++i) {
1563
1564                 (*i)->fed_by.clear ();
1565
1566                 for (j = r->begin(); j != r->end(); ++j) {
1567
1568                         /* although routes can feed themselves, it will
1569                            cause an endless recursive descent if we
1570                            detect it. so don't bother checking for
1571                            self-feeding.
1572                         */
1573
1574                         if (*j == *i) {
1575                                 continue;
1576                         }
1577
1578                         if ((*j)->feeds (*i)) {
1579                                 (*i)->fed_by.insert (*j);
1580                         }
1581                 }
1582         }
1583
1584         for (i = r->begin(); i != r->end(); ++i) {
1585                 trace_terminal (*i, *i);
1586         }
1587
1588         RouteSorter cmp;
1589         r->sort (cmp);
1590
1591 #if 0
1592         cerr << "finished route resort\n";
1593
1594         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1595                 cerr << " " << (*i)->name() << " signal order = " << (*i)->order_key ("signal") << endl;
1596         }
1597         cerr << endl;
1598 #endif
1599
1600 }
1601
1602 list<boost::shared_ptr<MidiTrack> >
1603 Session::new_midi_track (TrackMode mode, uint32_t how_many)
1604 {
1605         char track_name[32];
1606         uint32_t track_id = 0;
1607         uint32_t n = 0;
1608         uint32_t channels_used = 0;
1609         string port;
1610         RouteList new_routes;
1611         list<boost::shared_ptr<MidiTrack> > ret;
1612
1613         /* count existing midi tracks */
1614
1615         {
1616                 shared_ptr<RouteList> r = routes.reader ();
1617
1618                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1619                         if (dynamic_cast<MidiTrack*>((*i).get()) != 0) {
1620                                 if (!(*i)->hidden()) {
1621                                         n++;
1622                                         channels_used += (*i)->n_inputs().get(DataType::MIDI);
1623                                 }
1624                         }
1625                 }
1626         }
1627
1628         while (how_many) {
1629
1630                 /* check for duplicate route names, since we might have pre-existing
1631                    routes with this name (e.g. create Midi1, Midi2, delete Midi1,
1632                    save, close,restart,add new route - first named route is now
1633                    Midi2)
1634                 */
1635
1636
1637                 do {
1638                         ++track_id;
1639
1640                         snprintf (track_name, sizeof(track_name), "Midi %" PRIu32, track_id);
1641
1642                         if (route_by_name (track_name) == 0) {
1643                                 break;
1644                         }
1645
1646                 } while (track_id < (UINT_MAX-1));
1647
1648                 try {
1649                         shared_ptr<MidiTrack> track (new MidiTrack (*this, track_name, Route::Flag (0), mode));
1650
1651                         if (track->ensure_io (ChanCount(DataType::MIDI, 1), ChanCount(DataType::MIDI, 1), false, this)) {
1652                                 error << "cannot configure 1 in/1 out configuration for new midi track" << endmsg;
1653                         }
1654
1655                         channels_used += track->n_inputs ().get(DataType::MIDI);
1656
1657                         track->DiskstreamChanged.connect (mem_fun (this, &Session::resort_routes));
1658                         track->set_remote_control_id (ntracks());
1659
1660                         new_routes.push_back (track);
1661                         ret.push_back (track);
1662                 }
1663
1664                 catch (failed_constructor &err) {
1665                         error << _("Session: could not create new midi track.") << endmsg;
1666                         // XXX should we delete the tracks already created?
1667                         ret.clear ();
1668                         return ret;
1669                 }
1670
1671                 --how_many;
1672         }
1673
1674         if (!new_routes.empty()) {
1675                 add_routes (new_routes, false);
1676                 save_state (_current_snapshot_name);
1677         }
1678
1679         return ret;
1680 }
1681
1682 list<boost::shared_ptr<AudioTrack> >
1683 Session::new_audio_track (int input_channels, int output_channels, TrackMode mode, uint32_t how_many)
1684 {
1685         char track_name[32];
1686         uint32_t track_id = 0;
1687         uint32_t n = 0;
1688         uint32_t channels_used = 0;
1689         string port;
1690         RouteList new_routes;
1691         list<boost::shared_ptr<AudioTrack> > ret;
1692         uint32_t control_id;
1693
1694         /* count existing audio tracks */
1695
1696         {
1697                 shared_ptr<RouteList> r = routes.reader ();
1698
1699                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1700                         if (dynamic_cast<AudioTrack*>((*i).get()) != 0) {
1701                                 if (!(*i)->hidden()) {
1702                                         n++;
1703                                         channels_used += (*i)->n_inputs().get(DataType::AUDIO);
1704                                 }
1705                         }
1706                 }
1707         }
1708
1709         vector<string> physinputs;
1710         vector<string> physoutputs;
1711         uint32_t nphysical_in;
1712         uint32_t nphysical_out;
1713
1714         _engine.get_physical_outputs (physoutputs);
1715         _engine.get_physical_inputs (physinputs);
1716         control_id = ntracks() + nbusses() + 1;
1717
1718         while (how_many) {
1719
1720                 /* check for duplicate route names, since we might have pre-existing
1721                    routes with this name (e.g. create Audio1, Audio2, delete Audio1,
1722                    save, close,restart,add new route - first named route is now
1723                    Audio2)
1724                 */
1725
1726
1727                 do {
1728                         ++track_id;
1729
1730                         snprintf (track_name, sizeof(track_name), "Audio %" PRIu32, track_id);
1731
1732                         if (route_by_name (track_name) == 0) {
1733                                 break;
1734                         }
1735
1736                 } while (track_id < (UINT_MAX-1));
1737
1738                 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
1739                         nphysical_in = min (n_physical_inputs, (uint32_t) physinputs.size());
1740                 } else {
1741                         nphysical_in = 0;
1742                 }
1743
1744                 if (Config->get_output_auto_connect() & AutoConnectPhysical) {
1745                         nphysical_out = min (n_physical_outputs, (uint32_t) physinputs.size());
1746                 } else {
1747                         nphysical_out = 0;
1748                 }
1749
1750                 shared_ptr<AudioTrack> track;
1751
1752                 try {
1753                         track = boost::shared_ptr<AudioTrack>((new AudioTrack (*this, track_name, Route::Flag (0), mode)));
1754
1755                         if (track->ensure_io (ChanCount(DataType::AUDIO, input_channels), ChanCount(DataType::AUDIO, output_channels), false, this)) {
1756                                 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
1757                                                          input_channels, output_channels)
1758                                       << endmsg;
1759                                 goto failed;
1760                         }
1761
1762                         if (nphysical_in) {
1763                                 for (uint32_t x = 0; x < track->n_inputs().get(DataType::AUDIO) && x < nphysical_in; ++x) {
1764
1765                                         port = "";
1766
1767                                         if (Config->get_input_auto_connect() & AutoConnectPhysical) {
1768                                                 port = physinputs[(channels_used+x)%nphysical_in];
1769                                         }
1770
1771                                         if (port.length() && track->connect_input (track->input (x), port, this)) {
1772                                                 break;
1773                                         }
1774                                 }
1775                         }
1776
1777                         for (uint32_t x = 0; x < track->n_outputs().get(DataType::MIDI); ++x) {
1778
1779                                 port = "";
1780
1781                                 if (nphysical_out && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
1782                                         port = physoutputs[(channels_used+x)%nphysical_out];
1783                                 } else if (Config->get_output_auto_connect() & AutoConnectMaster) {
1784                                         if (_master_out) {
1785                                                 port = _master_out->input (x%_master_out->n_inputs().get(DataType::AUDIO))->name();
1786                                         }
1787                                 }
1788
1789                                 if (port.length() && track->connect_output (track->output (x), port, this)) {
1790                                         break;
1791                                 }
1792                         }
1793
1794                         channels_used += track->n_inputs ().get(DataType::AUDIO);
1795
1796                         if (_control_out) {
1797                                 vector<string> cports;
1798                                 uint32_t ni = _control_out->n_inputs().get(DataType::AUDIO);
1799
1800                                 for (n = 0; n < ni; ++n) {
1801                                         cports.push_back (_control_out->input(n)->name());
1802                                 }
1803
1804                                 track->set_control_outs (cports);
1805                         }
1806
1807                         // assert (current_thread != RT_thread)
1808
1809                         track->audio_diskstream()->non_realtime_input_change();
1810
1811                         track->DiskstreamChanged.connect (mem_fun (this, &Session::resort_routes));
1812                         track->set_remote_control_id (control_id);
1813                         ++control_id;
1814
1815                         new_routes.push_back (track);
1816                         ret.push_back (track);
1817                 }
1818
1819                 catch (failed_constructor &err) {
1820                         error << _("Session: could not create new audio track.") << endmsg;
1821
1822                         if (track) {
1823                                 /* we need to get rid of this, since the track failed to be created */
1824                                 /* XXX arguably, AudioTrack::AudioTrack should not do the Session::add_diskstream() */
1825
1826                                 {
1827                                         RCUWriter<DiskstreamList> writer (diskstreams);
1828                                         boost::shared_ptr<DiskstreamList> ds = writer.get_copy();
1829                                         ds->remove (track->audio_diskstream());
1830                                 }
1831                         }
1832
1833                         goto failed;
1834                 }
1835
1836                 catch (AudioEngine::PortRegistrationFailure& pfe) {
1837
1838                         error << _("No more JACK ports are available. You will need to stop Ardour and restart JACK with ports if you need this many tracks.") << endmsg;
1839
1840                         if (track) {
1841                                 /* we need to get rid of this, since the track failed to be created */
1842                                 /* XXX arguably, AudioTrack::AudioTrack should not do the Session::add_diskstream() */
1843
1844                                 {
1845                                         RCUWriter<DiskstreamList> writer (diskstreams);
1846                                         boost::shared_ptr<DiskstreamList> ds = writer.get_copy();
1847                                         ds->remove (track->audio_diskstream());
1848                                 }
1849                         }
1850
1851                         goto failed;
1852                 }
1853
1854                 --how_many;
1855         }
1856
1857   failed:
1858         if (!new_routes.empty()) {
1859                 add_routes (new_routes, false);
1860                 save_state (_current_snapshot_name);
1861         }
1862
1863         return ret;
1864 }
1865
1866 void
1867 Session::set_remote_control_ids ()
1868 {
1869         RemoteModel m = Config->get_remote_model();
1870
1871         shared_ptr<RouteList> r = routes.reader ();
1872
1873         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1874                 if ( MixerOrdered == m) {
1875                         long order = (*i)->order_key(N_("signal"));
1876                         (*i)->set_remote_control_id( order+1 );
1877                 } else if ( EditorOrdered == m) {
1878                         long order = (*i)->order_key(N_("editor"));
1879                         (*i)->set_remote_control_id( order+1 );
1880                 } else if ( UserOrdered == m) {
1881                         //do nothing ... only changes to remote id's are initiated by user
1882                 }
1883         }
1884 }
1885
1886
1887 Session::RouteList
1888 Session::new_audio_route (int input_channels, int output_channels, uint32_t how_many)
1889 {
1890         char bus_name[32];
1891         uint32_t bus_id = 1;
1892         uint32_t n = 0;
1893         string port;
1894         RouteList ret;
1895         uint32_t control_id;
1896
1897         /* count existing audio busses */
1898
1899         {
1900                 shared_ptr<RouteList> r = routes.reader ();
1901
1902                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1903                         if (dynamic_cast<AudioTrack*>((*i).get()) == 0) {
1904                                 if (!(*i)->hidden() && (*i)->name() != _("master")) {
1905                                         bus_id++;
1906                                 }
1907                         }
1908                 }
1909         }
1910
1911         vector<string> physinputs;
1912         vector<string> physoutputs;
1913
1914         _engine.get_physical_outputs (physoutputs);
1915         _engine.get_physical_inputs (physinputs);
1916         control_id = ntracks() + nbusses() + 1;
1917
1918         while (how_many) {
1919
1920                 do {
1921                         snprintf (bus_name, sizeof(bus_name), "Bus %" PRIu32, bus_id);
1922
1923                         if (route_by_name (bus_name) == 0) {
1924                                 break;
1925                         }
1926
1927                 } while (++bus_id < (UINT_MAX-1));
1928
1929                 try {
1930                         shared_ptr<Route> bus (new Route (*this, bus_name, -1, -1, -1, -1, Route::Flag(0), DataType::AUDIO));
1931
1932                         if (bus->ensure_io (ChanCount(DataType::AUDIO, input_channels), ChanCount(DataType::AUDIO, output_channels), false, this)) {
1933                                 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
1934                                                          input_channels, output_channels)
1935                                       << endmsg;
1936                                 goto failure;
1937                         }
1938
1939                         for (uint32_t x = 0; n_physical_inputs && x < bus->n_inputs().get(DataType::AUDIO); ++x) {
1940
1941                                 port = "";
1942
1943                                 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
1944                                                 port = physinputs[((n+x)%n_physical_inputs)];
1945                                 }
1946
1947                                 if (port.length() && bus->connect_input (bus->input (x), port, this)) {
1948                                         break;
1949                                 }
1950                         }
1951
1952                         for (uint32_t x = 0; n_physical_outputs && x < bus->n_outputs().get(DataType::AUDIO); ++x) {
1953
1954                                 port = "";
1955
1956                                 if (Config->get_output_auto_connect() & AutoConnectPhysical) {
1957                                         port = physoutputs[((n+x)%n_physical_outputs)];
1958                                 } else if (Config->get_output_auto_connect() & AutoConnectMaster) {
1959                                         if (_master_out) {
1960                                                 port = _master_out->input (x%_master_out->n_inputs().get(DataType::AUDIO))->name();
1961                                         }
1962                                 }
1963
1964                                 if (port.length() && bus->connect_output (bus->output (x), port, this)) {
1965                                         break;
1966                                 }
1967                         }
1968
1969                         if (_control_out) {
1970                                 vector<string> cports;
1971                                 uint32_t ni = _control_out->n_inputs().get(DataType::AUDIO);
1972
1973                                 for (uint32_t n = 0; n < ni; ++n) {
1974                                         cports.push_back (_control_out->input(n)->name());
1975                                 }
1976                                 bus->set_control_outs (cports);
1977                         }
1978
1979                         bus->set_remote_control_id (control_id);
1980                         ++control_id;
1981
1982                         ret.push_back (bus);
1983                 }
1984
1985
1986                 catch (failed_constructor &err) {
1987                         error << _("Session: could not create new audio route.") << endmsg;
1988                         goto failure;
1989                 }
1990
1991                 catch (AudioEngine::PortRegistrationFailure& pfe) {
1992                         error << _("No more JACK ports are available. You will need to stop Ardour and restart JACK with ports if you need this many tracks.") << endmsg;
1993                         goto failure;
1994                 }
1995
1996
1997                 --how_many;
1998         }
1999
2000   failure:
2001         if (!ret.empty()) {
2002                 add_routes (ret, false);
2003                 save_state (_current_snapshot_name);
2004         }
2005
2006         return ret;
2007
2008 }
2009
2010 void
2011 Session::add_routes (RouteList& new_routes, bool save)
2012 {
2013         {
2014                 RCUWriter<RouteList> writer (routes);
2015                 shared_ptr<RouteList> r = writer.get_copy ();
2016                 r->insert (r->end(), new_routes.begin(), new_routes.end());
2017                 resort_routes_using (r);
2018         }
2019
2020         for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
2021
2022                 boost::weak_ptr<Route> wpr (*x);
2023
2024                 (*x)->solo_changed.connect (sigc::bind (mem_fun (*this, &Session::route_solo_changed), wpr));
2025                 (*x)->mute_changed.connect (mem_fun (*this, &Session::route_mute_changed));
2026                 (*x)->output_changed.connect (mem_fun (*this, &Session::set_worst_io_latencies_x));
2027                 (*x)->redirects_changed.connect (mem_fun (*this, &Session::update_latency_compensation_proxy));
2028
2029                 if ((*x)->master()) {
2030                         _master_out = (*x);
2031                 }
2032
2033                 if ((*x)->control()) {
2034                         _control_out = (*x);
2035                 }
2036         }
2037
2038         set_dirty();
2039
2040         if (save) {
2041                 save_state (_current_snapshot_name);
2042         }
2043
2044         RouteAdded (new_routes); /* EMIT SIGNAL */
2045 }
2046
2047 void
2048 Session::add_diskstream (boost::shared_ptr<Diskstream> dstream)
2049 {
2050         /* need to do this in case we're rolling at the time, to prevent false underruns */
2051         dstream->do_refill_with_alloc ();
2052
2053         dstream->set_block_size (current_block_size);
2054
2055         {
2056                 RCUWriter<DiskstreamList> writer (diskstreams);
2057                 boost::shared_ptr<DiskstreamList> ds = writer.get_copy();
2058                 ds->push_back (dstream);
2059                 /* writer goes out of scope, copies ds back to main */
2060         }
2061
2062         dstream->PlaylistChanged.connect (sigc::bind (mem_fun (*this, &Session::diskstream_playlist_changed), dstream));
2063         /* this will connect to future changes, and check the current length */
2064         diskstream_playlist_changed (dstream);
2065
2066         dstream->prepare ();
2067
2068 }
2069
2070 void
2071 Session::remove_route (shared_ptr<Route> route)
2072 {
2073         {
2074                 RCUWriter<RouteList> writer (routes);
2075                 shared_ptr<RouteList> rs = writer.get_copy ();
2076
2077                 rs->remove (route);
2078
2079                 /* deleting the master out seems like a dumb
2080                    idea, but its more of a UI policy issue
2081                    than our concern.
2082                 */
2083
2084                 if (route == _master_out) {
2085                         _master_out = shared_ptr<Route> ();
2086                 }
2087
2088                 if (route == _control_out) {
2089                         _control_out = shared_ptr<Route> ();
2090
2091                         /* cancel control outs for all routes */
2092
2093                         vector<string> empty;
2094
2095                         for (RouteList::iterator r = rs->begin(); r != rs->end(); ++r) {
2096                                 (*r)->set_control_outs (empty);
2097                         }
2098                 }
2099
2100                 update_route_solo_state ();
2101
2102                 /* writer goes out of scope, forces route list update */
2103         }
2104
2105         Track* t;
2106         boost::shared_ptr<Diskstream> ds;
2107
2108         if ((t = dynamic_cast<Track*>(route.get())) != 0) {
2109                 ds = t->diskstream();
2110         }
2111
2112         if (ds) {
2113
2114                 {
2115                         RCUWriter<DiskstreamList> dsl (diskstreams);
2116                         boost::shared_ptr<DiskstreamList> d = dsl.get_copy();
2117                         d->remove (ds);
2118                 }
2119         }
2120
2121         find_current_end ();
2122
2123         update_latency_compensation (false, false);
2124         set_dirty();
2125
2126         // We need to disconnect the routes inputs and outputs
2127         route->disconnect_inputs(NULL);
2128         route->disconnect_outputs(NULL);
2129
2130         /* get rid of it from the dead wood collection in the route list manager */
2131
2132         /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
2133
2134         routes.flush ();
2135
2136         /* try to cause everyone to drop their references */
2137
2138         route->drop_references ();
2139
2140         /* save the new state of the world */
2141
2142         if (save_state (_current_snapshot_name)) {
2143                 save_history (_current_snapshot_name);
2144         }
2145 }
2146
2147 void
2148 Session::route_mute_changed (void* src)
2149 {
2150         set_dirty ();
2151 }
2152
2153 void
2154 Session::route_solo_changed (void* src, boost::weak_ptr<Route> wpr)
2155 {
2156         if (solo_update_disabled) {
2157                 // We know already
2158                 return;
2159         }
2160
2161         bool is_track;
2162         boost::shared_ptr<Route> route = wpr.lock ();
2163
2164         if (!route) {
2165                 /* should not happen */
2166                 error << string_compose (_("programming error: %1"), X_("invalid route weak ptr passed to route_solo_changed")) << endmsg;
2167                 return;
2168         }
2169
2170         is_track = (boost::dynamic_pointer_cast<AudioTrack>(route) != 0);
2171
2172         shared_ptr<RouteList> r = routes.reader ();
2173
2174         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2175
2176                 /* soloing a track mutes all other tracks, soloing a bus mutes all other busses */
2177
2178                 if (is_track) {
2179
2180                         /* don't mess with busses */
2181
2182                         if (dynamic_cast<Track*>((*i).get()) == 0) {
2183                                 continue;
2184                         }
2185
2186                 } else {
2187
2188                         /* don't mess with tracks */
2189
2190                         if (dynamic_cast<Track*>((*i).get()) != 0) {
2191                                 continue;
2192                         }
2193                 }
2194
2195                 if ((*i) != route &&
2196                     ((*i)->mix_group () == 0 ||
2197                      (*i)->mix_group () != route->mix_group () ||
2198                      !route->mix_group ()->is_active())) {
2199
2200                         if ((*i)->soloed()) {
2201
2202                                 /* if its already soloed, and solo latching is enabled,
2203                                    then leave it as it is.
2204                                 */
2205
2206                                 if (Config->get_solo_latched()) {
2207                                         continue;
2208                                 }
2209                         }
2210
2211                         /* do it */
2212
2213                         solo_update_disabled = true;
2214                         (*i)->set_solo (false, src);
2215                         solo_update_disabled = false;
2216                 }
2217         }
2218
2219         bool something_soloed = false;
2220         bool same_thing_soloed = false;
2221         bool signal = false;
2222
2223         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2224                 if ((*i)->soloed()) {
2225                         something_soloed = true;
2226                         if (dynamic_cast<Track*>((*i).get())) {
2227                                 if (is_track) {
2228                                         same_thing_soloed = true;
2229                                         break;
2230                                 }
2231                         } else {
2232                                 if (!is_track) {
2233                                         same_thing_soloed = true;
2234                                         break;
2235                                 }
2236                         }
2237                         break;
2238                 }
2239         }
2240
2241         if (something_soloed != currently_soloing) {
2242                 signal = true;
2243                 currently_soloing = something_soloed;
2244         }
2245
2246         modify_solo_mute (is_track, same_thing_soloed);
2247
2248         if (signal) {
2249                 SoloActive (currently_soloing); /* EMIT SIGNAL */
2250         }
2251
2252         SoloChanged (); /* EMIT SIGNAL */
2253
2254         set_dirty();
2255 }
2256
2257 void
2258 Session::update_route_solo_state ()
2259 {
2260         bool mute = false;
2261         bool is_track = false;
2262         bool signal = false;
2263
2264         /* caller must hold RouteLock */
2265
2266         /* this is where we actually implement solo by changing
2267            the solo mute setting of each track.
2268         */
2269
2270         shared_ptr<RouteList> r = routes.reader ();
2271
2272         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2273                 if ((*i)->soloed()) {
2274                         mute = true;
2275                         if (dynamic_cast<Track*>((*i).get())) {
2276                                 is_track = true;
2277                         }
2278                         break;
2279                 }
2280         }
2281
2282         if (mute != currently_soloing) {
2283                 signal = true;
2284                 currently_soloing = mute;
2285         }
2286
2287         if (!is_track && !mute) {
2288
2289                 /* nothing is soloed */
2290
2291                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2292                         (*i)->set_solo_mute (false);
2293                 }
2294
2295                 if (signal) {
2296                         SoloActive (false);
2297                 }
2298
2299                 return;
2300         }
2301
2302         modify_solo_mute (is_track, mute);
2303
2304         if (signal) {
2305                 SoloActive (currently_soloing);
2306         }
2307 }
2308
2309 void
2310 Session::modify_solo_mute (bool is_track, bool mute)
2311 {
2312         shared_ptr<RouteList> r = routes.reader ();
2313
2314         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2315
2316                 if (is_track) {
2317
2318                         /* only alter track solo mute */
2319
2320                         if (dynamic_cast<Track*>((*i).get())) {
2321                                 if ((*i)->soloed()) {
2322                                         (*i)->set_solo_mute (!mute);
2323                                 } else {
2324                                         (*i)->set_solo_mute (mute);
2325                                 }
2326                         }
2327
2328                 } else {
2329
2330                         /* only alter bus solo mute */
2331
2332                         if (!dynamic_cast<Track*>((*i).get())) {
2333
2334                                 if ((*i)->soloed()) {
2335
2336                                         (*i)->set_solo_mute (false);
2337
2338                                 } else {
2339
2340                                         /* don't mute master or control outs
2341                                            in response to another bus solo
2342                                         */
2343
2344                                         if ((*i) != _master_out &&
2345                                             (*i) != _control_out) {
2346                                                 (*i)->set_solo_mute (mute);
2347                                         }
2348                                 }
2349                         }
2350
2351                 }
2352         }
2353 }
2354
2355
2356 void
2357 Session::catch_up_on_solo ()
2358 {
2359         /* this is called after set_state() to catch the full solo
2360            state, which can't be correctly determined on a per-route
2361            basis, but needs the global overview that only the session
2362            has.
2363         */
2364         update_route_solo_state();
2365 }
2366
2367 shared_ptr<Route>
2368 Session::route_by_name (string name)
2369 {
2370         shared_ptr<RouteList> r = routes.reader ();
2371
2372         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2373                 if ((*i)->name() == name) {
2374                         return *i;
2375                 }
2376         }
2377
2378         return shared_ptr<Route> ((Route*) 0);
2379 }
2380
2381 shared_ptr<Route>
2382 Session::route_by_id (PBD::ID id)
2383 {
2384         shared_ptr<RouteList> r = routes.reader ();
2385
2386         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2387                 if ((*i)->id() == id) {
2388                         return *i;
2389                 }
2390         }
2391
2392         return shared_ptr<Route> ((Route*) 0);
2393 }
2394
2395 shared_ptr<Route>
2396 Session::route_by_remote_id (uint32_t id)
2397 {
2398         shared_ptr<RouteList> r = routes.reader ();
2399
2400         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2401                 if ((*i)->remote_control_id() == id) {
2402                         return *i;
2403                 }
2404         }
2405
2406         return shared_ptr<Route> ((Route*) 0);
2407 }
2408
2409 void
2410 Session::find_current_end ()
2411 {
2412         if (_state_of_the_state & Loading) {
2413                 return;
2414         }
2415
2416         nframes_t max = get_maximum_extent ();
2417
2418         if (max > end_location->end()) {
2419                 end_location->set_end (max);
2420                 set_dirty();
2421                 DurationChanged(); /* EMIT SIGNAL */
2422         }
2423 }
2424
2425 nframes_t
2426 Session::get_maximum_extent () const
2427 {
2428         nframes_t max = 0;
2429         nframes_t me;
2430
2431         boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
2432
2433         for (DiskstreamList::const_iterator i = dsl->begin(); i != dsl->end(); ++i) {
2434                 boost::shared_ptr<Playlist> pl = (*i)->playlist();
2435                 if ((me = pl->get_maximum_extent()) > max) {
2436                         max = me;
2437                 }
2438         }
2439
2440         return max;
2441 }
2442
2443 boost::shared_ptr<Diskstream>
2444 Session::diskstream_by_name (string name)
2445 {
2446         boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
2447
2448         for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
2449                 if ((*i)->name() == name) {
2450                         return *i;
2451                 }
2452         }
2453
2454         return boost::shared_ptr<Diskstream>((Diskstream*) 0);
2455 }
2456
2457 boost::shared_ptr<Diskstream>
2458 Session::diskstream_by_id (const PBD::ID& id)
2459 {
2460         boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
2461
2462         for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
2463                 if ((*i)->id() == id) {
2464                         return *i;
2465                 }
2466         }
2467
2468         return boost::shared_ptr<Diskstream>((Diskstream*) 0);
2469 }
2470
2471 /* Region management */
2472
2473 string
2474 Session::new_region_name (string old)
2475 {
2476         string::size_type last_period;
2477         uint32_t number;
2478         string::size_type len = old.length() + 64;
2479         char buf[len];
2480
2481         if ((last_period = old.find_last_of ('.')) == string::npos) {
2482
2483                 /* no period present - add one explicitly */
2484
2485                 old += '.';
2486                 last_period = old.length() - 1;
2487                 number = 0;
2488
2489         } else {
2490
2491                 number = atoi (old.substr (last_period+1).c_str());
2492
2493         }
2494
2495         while (number < (UINT_MAX-1)) {
2496
2497                 RegionList::const_iterator i;
2498                 string sbuf;
2499
2500                 number++;
2501
2502                 snprintf (buf, len, "%s%" PRIu32, old.substr (0, last_period + 1).c_str(), number);
2503                 sbuf = buf;
2504
2505                 for (i = regions.begin(); i != regions.end(); ++i) {
2506                         if (i->second->name() == sbuf) {
2507                                 break;
2508                         }
2509                 }
2510
2511                 if (i == regions.end()) {
2512                         break;
2513                 }
2514         }
2515
2516         if (number != (UINT_MAX-1)) {
2517                 return buf;
2518         }
2519
2520         error << string_compose (_("cannot create new name for region \"%1\""), old) << endmsg;
2521         return old;
2522 }
2523
2524 int
2525 Session::region_name (string& result, string base, bool newlevel) const
2526 {
2527         char buf[16];
2528         string subbase;
2529
2530         assert(base.find("/") == string::npos);
2531
2532         if (base == "") {
2533
2534                 Glib::Mutex::Lock lm (region_lock);
2535
2536                 snprintf (buf, sizeof (buf), "%d", (int)regions.size() + 1);
2537
2538
2539                 result = "region.";
2540                 result += buf;
2541
2542         } else {
2543
2544                 /* XXX this is going to be slow. optimize me later */
2545
2546                 if (newlevel) {
2547                         subbase = base;
2548                 } else {
2549                         string::size_type pos;
2550
2551                         pos = base.find_last_of ('.');
2552
2553                         /* pos may be npos, but then we just use entire base */
2554
2555                         subbase = base.substr (0, pos);
2556
2557                 }
2558
2559                 bool name_taken = true;
2560
2561                 {
2562                         Glib::Mutex::Lock lm (region_lock);
2563
2564                         for (int n = 1; n < 5000; ++n) {
2565
2566                                 result = subbase;
2567                                 snprintf (buf, sizeof (buf), ".%d", n);
2568                                 result += buf;
2569
2570                                 name_taken = false;
2571
2572                                 for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
2573                                         if (i->second->name() == result) {
2574                                                 name_taken = true;
2575                                                 break;
2576                                         }
2577                                 }
2578
2579                                 if (!name_taken) {
2580                                         break;
2581                                 }
2582                         }
2583                 }
2584
2585                 if (name_taken) {
2586                         fatal << string_compose(_("too many regions with names like %1"), base) << endmsg;
2587                         /*NOTREACHED*/
2588                 }
2589         }
2590         return 0;
2591 }
2592
2593 void
2594 Session::add_region (boost::shared_ptr<Region> region)
2595 {
2596         boost::shared_ptr<Region> other;
2597         bool added = false;
2598
2599         {
2600                 Glib::Mutex::Lock lm (region_lock);
2601
2602                 RegionList::iterator x;
2603
2604                 for (x = regions.begin(); x != regions.end(); ++x) {
2605
2606                         other = x->second;
2607
2608                         if (region->region_list_equivalent (other)) {
2609                                 break;
2610                         }
2611                 }
2612
2613                 if (x == regions.end()) {
2614
2615                         pair<RegionList::key_type,RegionList::mapped_type> entry;
2616
2617                         entry.first = region->id();
2618                         entry.second = region;
2619
2620                         pair<RegionList::iterator,bool> x = regions.insert (entry);
2621
2622
2623                         if (!x.second) {
2624                                 return;
2625                         }
2626
2627                         added = true;
2628                 }
2629
2630         }
2631
2632         /* mark dirty because something has changed even if we didn't
2633            add the region to the region list.
2634         */
2635
2636         set_dirty();
2637
2638         if (added) {
2639                 region->GoingAway.connect (sigc::bind (mem_fun (*this, &Session::remove_region), boost::weak_ptr<Region>(region)));
2640                 region->StateChanged.connect (sigc::bind (mem_fun (*this, &Session::region_changed), boost::weak_ptr<Region>(region)));
2641                 RegionAdded (region); /* EMIT SIGNAL */
2642         }
2643 }
2644
2645 void
2646 Session::region_changed (Change what_changed, boost::weak_ptr<Region> weak_region)
2647 {
2648         boost::shared_ptr<Region> region (weak_region.lock ());
2649
2650         if (!region) {
2651                 return;
2652         }
2653
2654         if (what_changed & Region::HiddenChanged) {
2655                 /* relay hidden changes */
2656                 RegionHiddenChange (region);
2657         }
2658 }
2659
2660 void
2661 Session::remove_region (boost::weak_ptr<Region> weak_region)
2662 {
2663         RegionList::iterator i;
2664         boost::shared_ptr<Region> region (weak_region.lock ());
2665
2666         if (!region) {
2667                 return;
2668         }
2669
2670         bool removed = false;
2671
2672         {
2673                 Glib::Mutex::Lock lm (region_lock);
2674
2675                 if ((i = regions.find (region->id())) != regions.end()) {
2676                         regions.erase (i);
2677                         removed = true;
2678                 }
2679         }
2680
2681         /* mark dirty because something has changed even if we didn't
2682            remove the region from the region list.
2683         */
2684
2685         set_dirty();
2686
2687         if (removed) {
2688                  RegionRemoved(region); /* EMIT SIGNAL */
2689         }
2690 }
2691
2692 boost::shared_ptr<Region>
2693 Session::find_whole_file_parent (boost::shared_ptr<Region const> child)
2694 {
2695         RegionList::iterator i;
2696         boost::shared_ptr<Region> region;
2697
2698         Glib::Mutex::Lock lm (region_lock);
2699
2700         for (i = regions.begin(); i != regions.end(); ++i) {
2701
2702                 region = i->second;
2703
2704                 if (region->whole_file()) {
2705
2706                         if (child->source_equivalent (region)) {
2707                                 return region;
2708                         }
2709                 }
2710         }
2711
2712         return boost::shared_ptr<Region> ();
2713 }
2714
2715 void
2716 Session::find_equivalent_playlist_regions (boost::shared_ptr<Region> region, vector<boost::shared_ptr<Region> >& result)
2717 {
2718         for (PlaylistList::iterator i = playlists.begin(); i != playlists.end(); ++i)
2719                 (*i)->get_region_list_equivalent_regions (region, result);
2720 }
2721
2722 int
2723 Session::destroy_region (boost::shared_ptr<Region> region)
2724 {
2725         vector<boost::shared_ptr<Source> > srcs;
2726
2727         {
2728                 boost::shared_ptr<AudioRegion> aregion;
2729
2730                 if ((aregion = boost::dynamic_pointer_cast<AudioRegion> (region)) == 0) {
2731                         return 0;
2732                 }
2733
2734                 if (aregion->playlist()) {
2735                         aregion->playlist()->destroy_region (region);
2736                 }
2737
2738                 for (uint32_t n = 0; n < aregion->n_channels(); ++n) {
2739                         srcs.push_back (aregion->source (n));
2740                 }
2741         }
2742
2743         region->drop_references ();
2744
2745         for (vector<boost::shared_ptr<Source> >::iterator i = srcs.begin(); i != srcs.end(); ++i) {
2746
2747                 if (!(*i)->used()) {
2748                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*i);
2749
2750                         if (afs) {
2751                                 (afs)->mark_for_remove ();
2752                         }
2753
2754                         (*i)->drop_references ();
2755
2756                         cerr << "source was not used by any playlist\n";
2757                 }
2758         }
2759
2760         return 0;
2761 }
2762
2763 int
2764 Session::destroy_regions (list<boost::shared_ptr<Region> > regions)
2765 {
2766         for (list<boost::shared_ptr<Region> >::iterator i = regions.begin(); i != regions.end(); ++i) {
2767                 destroy_region (*i);
2768         }
2769         return 0;
2770 }
2771
2772 int
2773 Session::remove_last_capture ()
2774 {
2775         list<boost::shared_ptr<Region> > r;
2776
2777         boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
2778
2779         for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
2780                 list<boost::shared_ptr<Region> >& l = (*i)->last_capture_regions();
2781
2782                 if (!l.empty()) {
2783                         r.insert (r.end(), l.begin(), l.end());
2784                         l.clear ();
2785                 }
2786         }
2787
2788         destroy_regions (r);
2789
2790         save_state (_current_snapshot_name);
2791
2792         return 0;
2793 }
2794
2795 int
2796 Session::remove_region_from_region_list (boost::shared_ptr<Region> r)
2797 {
2798         remove_region (r);
2799         return 0;
2800 }
2801
2802 /* Source Management */
2803 void
2804 Session::add_source (boost::shared_ptr<Source> source)
2805 {
2806         pair<SourceMap::key_type, SourceMap::mapped_type> entry;
2807         pair<SourceMap::iterator,bool> result;
2808
2809         entry.first = source->id();
2810         entry.second = source;
2811
2812         {
2813                 Glib::Mutex::Lock lm (source_lock);
2814                 result = sources.insert (entry);
2815         }
2816
2817         if (result.second) {
2818                 source->GoingAway.connect (sigc::bind (mem_fun (this, &Session::remove_source), boost::weak_ptr<Source> (source)));
2819                 set_dirty();
2820         }
2821 }
2822
2823 void
2824 Session::remove_source (boost::weak_ptr<Source> src)
2825 {
2826         SourceMap::iterator i;
2827         boost::shared_ptr<Source> source = src.lock();
2828
2829         if (!source) {
2830                 return;
2831         }
2832
2833         {
2834                 Glib::Mutex::Lock lm (source_lock);
2835
2836                 {
2837                         Glib::Mutex::Lock lm (source_lock);
2838
2839                         if ((i = sources.find (source->id())) != sources.end()) {
2840                                 sources.erase (i);
2841                         }
2842                 }
2843         }
2844
2845         if (!_state_of_the_state & InCleanup) {
2846
2847                 /* save state so we don't end up with a session file
2848                    referring to non-existent sources.
2849                 */
2850
2851                 save_state (_current_snapshot_name);
2852         }
2853 }
2854
2855 boost::shared_ptr<Source>
2856 Session::source_by_id (const PBD::ID& id)
2857 {
2858         Glib::Mutex::Lock lm (source_lock);
2859         SourceMap::iterator i;
2860         boost::shared_ptr<Source> source;
2861
2862         if ((i = sources.find (id)) != sources.end()) {
2863                 source = i->second;
2864         }
2865
2866         /* XXX search MIDI or other searches here */
2867
2868         return source;
2869 }
2870
2871
2872 boost::shared_ptr<Source>
2873 Session::source_by_path_and_channel (const Glib::ustring& path, uint16_t chn)
2874 {
2875         Glib::Mutex::Lock lm (source_lock);
2876
2877         for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
2878                 cerr << "comparing " << path << " with " << i->second->name() << endl;
2879                 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
2880
2881                 if (afs && afs->path() == path && chn == afs->channel()) {
2882                         return afs;
2883                 }
2884
2885         }
2886         return boost::shared_ptr<Source>();
2887 }
2888
2889 string
2890 Session::peak_path_from_audio_path (string audio_path) const
2891 {
2892         string res;
2893
2894         res = peak_dir ();
2895         res += PBD::basename_nosuffix (audio_path);
2896         res += ".peak";
2897
2898         return res;
2899 }
2900
2901 string
2902 Session::change_audio_path_by_name (string path, string oldname, string newname, bool destructive)
2903 {
2904         string look_for;
2905         string old_basename = PBD::basename_nosuffix (oldname);
2906         string new_legalized = legalize_for_path (newname);
2907
2908         /* note: we know (or assume) the old path is already valid */
2909
2910         if (destructive) {
2911
2912                 /* destructive file sources have a name of the form:
2913
2914                     /path/to/Tnnnn-NAME(%[LR])?.wav
2915
2916                     the task here is to replace NAME with the new name.
2917                 */
2918
2919                 /* find last slash */
2920
2921                 string dir;
2922                 string prefix;
2923                 string::size_type slash;
2924                 string::size_type dash;
2925
2926                 if ((slash = path.find_last_of ('/')) == string::npos) {
2927                         return "";
2928                 }
2929
2930                 dir = path.substr (0, slash+1);
2931
2932                 /* '-' is not a legal character for the NAME part of the path */
2933
2934                 if ((dash = path.find_last_of ('-')) == string::npos) {
2935                         return "";
2936                 }
2937
2938                 prefix = path.substr (slash+1, dash-(slash+1));
2939
2940                 path = dir;
2941                 path += prefix;
2942                 path += '-';
2943                 path += new_legalized;
2944                 path += ".wav";  /* XXX gag me with a spoon */
2945
2946         } else {
2947
2948                 /* non-destructive file sources have a name of the form:
2949
2950                     /path/to/NAME-nnnnn(%[LR])?.wav
2951
2952                     the task here is to replace NAME with the new name.
2953                 */
2954
2955                 string dir;
2956                 string suffix;
2957                 string::size_type slash;
2958                 string::size_type dash;
2959                 string::size_type postfix;
2960
2961                 /* find last slash */
2962
2963                 if ((slash = path.find_last_of ('/')) == string::npos) {
2964                         return "";
2965                 }
2966
2967                 dir = path.substr (0, slash+1);
2968
2969                 /* '-' is not a legal character for the NAME part of the path */
2970
2971                 if ((dash = path.find_last_of ('-')) == string::npos) {
2972                         return "";
2973                 }
2974
2975                 suffix = path.substr (dash+1);
2976
2977                 // Suffix is now everything after the dash. Now we need to eliminate
2978                 // the nnnnn part, which is done by either finding a '%' or a '.'
2979
2980                 postfix = suffix.find_last_of ("%");
2981                 if (postfix == string::npos) {
2982                         postfix = suffix.find_last_of ('.');
2983                 }
2984
2985                 if (postfix != string::npos) {
2986                         suffix = suffix.substr (postfix);
2987                 } else {
2988                         error << "Logic error in Session::change_audio_path_by_name(), please report to the developers" << endl;
2989                         return "";
2990                 }
2991
2992                 const uint32_t limit = 10000;
2993                 char buf[PATH_MAX+1];
2994
2995                 for (uint32_t cnt = 1; cnt <= limit; ++cnt) {
2996
2997                         snprintf (buf, sizeof(buf), "%s%s-%u%s", dir.c_str(), newname.c_str(), cnt, suffix.c_str());
2998
2999                         if (access (buf, F_OK) != 0) {
3000                                 path = buf;
3001                                 break;
3002                         }
3003                         path = "";
3004                 }
3005
3006                 if (path == "") {
3007                         error << "FATAL ERROR! Could not find a " << endl;
3008                 }
3009
3010         }
3011
3012         return path;
3013 }
3014
3015 string
3016 Session::audio_path_from_name (string name, uint32_t nchan, uint32_t chan, bool destructive)
3017 {
3018         string spath;
3019         uint32_t cnt;
3020         char buf[PATH_MAX+1];
3021         const uint32_t limit = 10000;
3022         string legalized;
3023
3024         buf[0] = '\0';
3025         legalized = legalize_for_path (name);
3026
3027         /* find a "version" of the file name that doesn't exist in
3028            any of the possible directories.
3029         */
3030
3031         for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
3032
3033                 vector<space_and_path>::iterator i;
3034                 uint32_t existing = 0;
3035
3036                 for (i = session_dirs.begin(); i != session_dirs.end(); ++i) {
3037
3038                         spath = (*i).path;
3039
3040                         spath += sound_dir (false);
3041
3042                         if (destructive) {
3043                                 if (nchan < 2) {
3044                                         snprintf (buf, sizeof(buf), "%s/T%04d-%s.wav", spath.c_str(), cnt, legalized.c_str());
3045                                 } else if (nchan == 2) {
3046                                         if (chan == 0) {
3047                                                 snprintf (buf, sizeof(buf), "%s/T%04d-%s%%L.wav", spath.c_str(), cnt, legalized.c_str());
3048                                         } else {
3049                                                 snprintf (buf, sizeof(buf), "%s/T%04d-%s%%R.wav", spath.c_str(), cnt, legalized.c_str());
3050                                         }
3051                                 } else if (nchan < 26) {
3052                                         snprintf (buf, sizeof(buf), "%s/T%04d-%s%%%c.wav", spath.c_str(), cnt, legalized.c_str(), 'a' + chan);
3053                                 } else {
3054                                         snprintf (buf, sizeof(buf), "%s/T%04d-%s.wav", spath.c_str(), cnt, legalized.c_str());
3055                                 }
3056
3057                         } else {
3058
3059                                 spath += '/';
3060                                 spath += legalized;
3061
3062                                 if (nchan < 2) {
3063                                         snprintf (buf, sizeof(buf), "%s-%u.wav", spath.c_str(), cnt);
3064                                 } else if (nchan == 2) {
3065                                         if (chan == 0) {
3066                                                 snprintf (buf, sizeof(buf), "%s-%u%%L.wav", spath.c_str(), cnt);
3067                                         } else {
3068                                                 snprintf (buf, sizeof(buf), "%s-%u%%R.wav", spath.c_str(), cnt);
3069                                         }
3070                                 } else if (nchan < 26) {
3071                                         snprintf (buf, sizeof(buf), "%s-%u%%%c.wav", spath.c_str(), cnt, 'a' + chan);
3072                                 } else {
3073                                         snprintf (buf, sizeof(buf), "%s-%u.wav", spath.c_str(), cnt);
3074                                 }
3075                         }
3076
3077                         if (g_file_test (buf, G_FILE_TEST_EXISTS)) {
3078                                 existing++;
3079                         }
3080
3081                 }
3082
3083                 if (existing == 0) {
3084                         break;
3085                 }
3086
3087                 if (cnt > limit) {
3088                         error << string_compose(_("There are already %1 recordings for %2, which I consider too many."), limit, name) << endmsg;
3089                         destroy ();
3090                         throw failed_constructor();
3091                 }
3092         }
3093
3094         /* we now have a unique name for the file, but figure out where to
3095            actually put it.
3096         */
3097
3098         string foo = buf;
3099
3100         spath = discover_best_sound_dir ();
3101         spath += '/';
3102
3103         string::size_type pos = foo.find_last_of ('/');
3104
3105         if (pos == string::npos) {
3106                 spath += foo;
3107         } else {
3108                 spath += foo.substr (pos + 1);
3109         }
3110
3111         return spath;
3112 }
3113
3114 boost::shared_ptr<AudioFileSource>
3115 Session::create_audio_source_for_session (AudioDiskstream& ds, uint32_t chan, bool destructive)
3116 {
3117         string spath = audio_path_from_name (ds.name(), ds.n_channels().get(DataType::AUDIO), chan, destructive);
3118         return boost::dynamic_pointer_cast<AudioFileSource> (
3119                 SourceFactory::createWritable (DataType::AUDIO, *this, spath, destructive, frame_rate()));
3120 }
3121
3122 // FIXME: _terrible_ code duplication
3123 string
3124 Session::change_midi_path_by_name (string path, string oldname, string newname, bool destructive)
3125 {
3126         string look_for;
3127         string old_basename = PBD::basename_nosuffix (oldname);
3128         string new_legalized = legalize_for_path (newname);
3129
3130         /* note: we know (or assume) the old path is already valid */
3131
3132         if (destructive) {
3133
3134                 /* destructive file sources have a name of the form:
3135
3136                     /path/to/Tnnnn-NAME(%[LR])?.wav
3137
3138                     the task here is to replace NAME with the new name.
3139                 */
3140
3141                 /* find last slash */
3142
3143                 string dir;
3144                 string prefix;
3145                 string::size_type slash;
3146                 string::size_type dash;
3147
3148                 if ((slash = path.find_last_of ('/')) == string::npos) {
3149                         return "";
3150                 }
3151
3152                 dir = path.substr (0, slash+1);
3153
3154                 /* '-' is not a legal character for the NAME part of the path */
3155
3156                 if ((dash = path.find_last_of ('-')) == string::npos) {
3157                         return "";
3158                 }
3159
3160                 prefix = path.substr (slash+1, dash-(slash+1));
3161
3162                 path = dir;
3163                 path += prefix;
3164                 path += '-';
3165                 path += new_legalized;
3166                 path += ".mid";  /* XXX gag me with a spoon */
3167
3168         } else {
3169
3170                 /* non-destructive file sources have a name of the form:
3171
3172                     /path/to/NAME-nnnnn(%[LR])?.wav
3173
3174                     the task here is to replace NAME with the new name.
3175                 */
3176
3177                 string dir;
3178                 string suffix;
3179                 string::size_type slash;
3180                 string::size_type dash;
3181                 string::size_type postfix;
3182
3183                 /* find last slash */
3184
3185                 if ((slash = path.find_last_of ('/')) == string::npos) {
3186                         return "";
3187                 }
3188
3189                 dir = path.substr (0, slash+1);
3190
3191                 /* '-' is not a legal character for the NAME part of the path */
3192
3193                 if ((dash = path.find_last_of ('-')) == string::npos) {
3194                         return "";
3195                 }
3196
3197                 suffix = path.substr (dash+1);
3198
3199                 // Suffix is now everything after the dash. Now we need to eliminate
3200                 // the nnnnn part, which is done by either finding a '%' or a '.'
3201
3202                 postfix = suffix.find_last_of ("%");
3203                 if (postfix == string::npos) {
3204                         postfix = suffix.find_last_of ('.');
3205                 }
3206
3207                 if (postfix != string::npos) {
3208                         suffix = suffix.substr (postfix);
3209                 } else {
3210                         error << "Logic error in Session::change_midi_path_by_name(), please report to the developers" << endl;
3211                         return "";
3212                 }
3213
3214                 const uint32_t limit = 10000;
3215                 char buf[PATH_MAX+1];
3216
3217                 for (uint32_t cnt = 1; cnt <= limit; ++cnt) {
3218
3219                         snprintf (buf, sizeof(buf), "%s%s-%u%s", dir.c_str(), newname.c_str(), cnt, suffix.c_str());
3220
3221                         if (access (buf, F_OK) != 0) {
3222                                 path = buf;
3223                                 break;
3224                         }
3225                         path = "";
3226                 }
3227
3228                 if (path == "") {
3229                         error << "FATAL ERROR! Could not find a " << endl;
3230                 }
3231
3232         }
3233
3234         return path;
3235 }
3236
3237 string
3238 Session::midi_path_from_name (string name)
3239 {
3240         string spath;
3241         uint32_t cnt;
3242         char buf[PATH_MAX+1];
3243         const uint32_t limit = 10000;
3244         string legalized;
3245
3246         buf[0] = '\0';
3247         legalized = legalize_for_path (name);
3248
3249         /* find a "version" of the file name that doesn't exist in
3250            any of the possible directories.
3251         */
3252
3253         for (cnt = 1; cnt <= limit; ++cnt) {
3254
3255                 vector<space_and_path>::iterator i;
3256                 uint32_t existing = 0;
3257
3258                 for (i = session_dirs.begin(); i != session_dirs.end(); ++i) {
3259
3260                         spath = (*i).path;
3261
3262                         // FIXME: different directory from audio?
3263                         spath += sound_dir(false) + "/" + legalized;
3264
3265                         snprintf (buf, sizeof(buf), "%s-%u.mid", spath.c_str(), cnt);
3266
3267                         if (g_file_test (buf, G_FILE_TEST_EXISTS)) {
3268                                 existing++;
3269                         }
3270                 }
3271
3272                 if (existing == 0) {
3273                         break;
3274                 }
3275
3276                 if (cnt > limit) {
3277                         error << string_compose(_("There are already %1 recordings for %2, which I consider too many."), limit, name) << endmsg;
3278                         throw failed_constructor();
3279                 }
3280         }
3281
3282         /* we now have a unique name for the file, but figure out where to
3283            actually put it.
3284         */
3285
3286         string foo = buf;
3287
3288         // FIXME: different directory than audio?
3289         spath = discover_best_sound_dir ();
3290         spath += '/';
3291
3292         string::size_type pos = foo.find_last_of ('/');
3293
3294         if (pos == string::npos) {
3295                 spath += foo;
3296         } else {
3297                 spath += foo.substr (pos + 1);
3298         }
3299
3300         return spath;
3301 }
3302
3303 boost::shared_ptr<MidiSource>
3304 Session::create_midi_source_for_session (MidiDiskstream& ds)
3305 {
3306         string spath = midi_path_from_name (ds.name());
3307
3308         return boost::dynamic_pointer_cast<SMFSource> (SourceFactory::createWritable (DataType::MIDI, *this, spath, false, frame_rate()));
3309 }
3310
3311
3312 /* Playlist management */
3313
3314 boost::shared_ptr<Playlist>
3315 Session::playlist_by_name (string name)
3316 {
3317         Glib::Mutex::Lock lm (playlist_lock);
3318         for (PlaylistList::iterator i = playlists.begin(); i != playlists.end(); ++i) {
3319                 if ((*i)->name() == name) {
3320                         return* i;
3321                 }
3322         }
3323         for (PlaylistList::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
3324                 if ((*i)->name() == name) {
3325                         return* i;
3326                 }
3327         }
3328
3329         return boost::shared_ptr<Playlist>();
3330 }
3331
3332 void
3333 Session::add_playlist (boost::shared_ptr<Playlist> playlist)
3334 {
3335         if (playlist->hidden()) {
3336                 return;
3337         }
3338
3339         {
3340                 Glib::Mutex::Lock lm (playlist_lock);
3341                 if (find (playlists.begin(), playlists.end(), playlist) == playlists.end()) {
3342                         playlists.insert (playlists.begin(), playlist);
3343                         playlist->InUse.connect (sigc::bind (mem_fun (*this, &Session::track_playlist), boost::weak_ptr<Playlist>(playlist)));
3344                         playlist->GoingAway.connect (sigc::bind (mem_fun (*this, &Session::remove_playlist), boost::weak_ptr<Playlist>(playlist)));
3345                 }
3346         }
3347
3348         set_dirty();
3349
3350         PlaylistAdded (playlist); /* EMIT SIGNAL */
3351 }
3352
3353 void
3354 Session::get_playlists (vector<boost::shared_ptr<Playlist> >& s)
3355 {
3356         {
3357                 Glib::Mutex::Lock lm (playlist_lock);
3358                 for (PlaylistList::iterator i = playlists.begin(); i != playlists.end(); ++i) {
3359                         s.push_back (*i);
3360                 }
3361                 for (PlaylistList::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
3362                         s.push_back (*i);
3363                 }
3364         }
3365 }
3366
3367 void
3368 Session::track_playlist (bool inuse, boost::weak_ptr<Playlist> wpl)
3369 {
3370         boost::shared_ptr<Playlist> pl(wpl.lock());
3371
3372         if (!pl) {
3373                 return;
3374         }
3375
3376         PlaylistList::iterator x;
3377
3378         if (pl->hidden()) {
3379                 /* its not supposed to be visible */
3380                 return;
3381         }
3382
3383         {
3384                 Glib::Mutex::Lock lm (playlist_lock);
3385
3386                 if (!inuse) {
3387
3388                         unused_playlists.insert (pl);
3389
3390                         if ((x = playlists.find (pl)) != playlists.end()) {
3391                                 playlists.erase (x);
3392                         }
3393
3394
3395                 } else {
3396
3397                         playlists.insert (pl);
3398
3399                         if ((x = unused_playlists.find (pl)) != unused_playlists.end()) {
3400                                 unused_playlists.erase (x);
3401                         }
3402                 }
3403         }
3404 }
3405
3406 void
3407 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
3408 {
3409         if (_state_of_the_state & Deletion) {
3410                 return;
3411         }
3412
3413         boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
3414
3415         if (!playlist) {
3416                 return;
3417         }
3418
3419         {
3420                 Glib::Mutex::Lock lm (playlist_lock);
3421
3422                 PlaylistList::iterator i;
3423
3424                 i = find (playlists.begin(), playlists.end(), playlist);
3425                 if (i != playlists.end()) {
3426                         playlists.erase (i);
3427                 }
3428
3429                 i = find (unused_playlists.begin(), unused_playlists.end(), playlist);
3430                 if (i != unused_playlists.end()) {
3431                         unused_playlists.erase (i);
3432                 }
3433
3434         }
3435
3436         set_dirty();
3437
3438         PlaylistRemoved (playlist); /* EMIT SIGNAL */
3439 }
3440
3441 void
3442 Session::set_audition (boost::shared_ptr<Region> r)
3443 {
3444         pending_audition_region = r;
3445         post_transport_work = PostTransportWork (post_transport_work | PostTransportAudition);
3446         schedule_butler_transport_work ();
3447 }
3448
3449 void
3450 Session::audition_playlist ()
3451 {
3452         Event* ev = new Event (Event::Audition, Event::Add, Event::Immediate, 0, 0.0);
3453         ev->region.reset ();
3454         queue_event (ev);
3455 }
3456
3457 void
3458 Session::non_realtime_set_audition ()
3459 {
3460         if (!pending_audition_region) {
3461                 auditioner->audition_current_playlist ();
3462         } else {
3463                 auditioner->audition_region (pending_audition_region);
3464                 pending_audition_region.reset ();
3465         }
3466         AuditionActive (true); /* EMIT SIGNAL */
3467 }
3468
3469 void
3470 Session::audition_region (boost::shared_ptr<Region> r)
3471 {
3472         Event* ev = new Event (Event::Audition, Event::Add, Event::Immediate, 0, 0.0);
3473         ev->region = r;
3474         queue_event (ev);
3475 }
3476
3477 void
3478 Session::cancel_audition ()
3479 {
3480         if (auditioner->active()) {
3481                 auditioner->cancel_audition ();
3482                 AuditionActive (false); /* EMIT SIGNAL */
3483         }
3484 }
3485
3486 bool
3487 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
3488 {
3489         return a->order_key(N_("signal")) < b->order_key(N_("signal"));
3490 }
3491
3492 void
3493 Session::remove_empty_sounds ()
3494 {
3495         PathScanner scanner;
3496
3497         vector<string *>* possible_audiofiles = scanner (sound_dir(), "\\.(wav|aiff|caf|w64)$", false, true);
3498
3499         Glib::Mutex::Lock lm (source_lock);
3500
3501         regex_t compiled_tape_track_pattern;
3502         int err;
3503
3504         if ((err = regcomp (&compiled_tape_track_pattern, "/T[0-9][0-9][0-9][0-9]-", REG_EXTENDED|REG_NOSUB))) {
3505
3506                 char msg[256];
3507
3508                 regerror (err, &compiled_tape_track_pattern, msg, sizeof (msg));
3509
3510                 error << string_compose (_("Cannot compile tape track regexp for use (%1)"), msg) << endmsg;
3511                 return;
3512         }
3513
3514         for (vector<string *>::iterator i = possible_audiofiles->begin(); i != possible_audiofiles->end(); ++i) {
3515
3516                 /* never remove files that appear to be a tape track */
3517
3518                 if (regexec (&compiled_tape_track_pattern, (*i)->c_str(), 0, 0, 0) == 0) {
3519                         delete *i;
3520                         continue;
3521                 }
3522
3523                 if (AudioFileSource::is_empty (*this, *(*i))) {
3524
3525                         unlink ((*i)->c_str());
3526
3527                         string peak_path = peak_path_from_audio_path (**i);
3528                         unlink (peak_path.c_str());
3529                 }
3530
3531                 delete* i;
3532         }
3533
3534         delete possible_audiofiles;
3535 }
3536
3537 bool
3538 Session::is_auditioning () const
3539 {
3540         /* can be called before we have an auditioner object */
3541         if (auditioner) {
3542                 return auditioner->active();
3543         } else {
3544                 return false;
3545         }
3546 }
3547
3548 void
3549 Session::set_all_solo (bool yn)
3550 {
3551         shared_ptr<RouteList> r = routes.reader ();
3552
3553         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3554                 if (!(*i)->hidden()) {
3555                         (*i)->set_solo (yn, this);
3556                 }
3557         }
3558
3559         set_dirty();
3560 }
3561
3562 void
3563 Session::set_all_mute (bool yn)
3564 {
3565         shared_ptr<RouteList> r = routes.reader ();
3566
3567         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3568                 if (!(*i)->hidden()) {
3569                         (*i)->set_mute (yn, this);
3570                 }
3571         }
3572
3573         set_dirty();
3574 }
3575
3576 uint32_t
3577 Session::n_diskstreams () const
3578 {
3579         uint32_t n = 0;
3580
3581         boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
3582
3583         for (DiskstreamList::const_iterator i = dsl->begin(); i != dsl->end(); ++i) {
3584                 if (!(*i)->hidden()) {
3585                         n++;
3586                 }
3587         }
3588         return n;
3589 }
3590
3591 void
3592 Session::graph_reordered ()
3593 {
3594         /* don't do this stuff if we are setting up connections
3595            from a set_state() call or creating new tracks.
3596         */
3597
3598         if (_state_of_the_state & InitialConnecting) {
3599                 return;
3600         }
3601
3602         /* every track/bus asked for this to be handled but it was deferred because
3603            we were connecting. do it now.
3604         */
3605
3606         request_input_change_handling ();
3607
3608         resort_routes ();
3609
3610         /* force all diskstreams to update their capture offset values to
3611            reflect any changes in latencies within the graph.
3612         */
3613
3614         boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
3615
3616         for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
3617                 (*i)->set_capture_offset ();
3618         }
3619 }
3620
3621 void
3622 Session::record_disenable_all ()
3623 {
3624         record_enable_change_all (false);
3625 }
3626
3627 void
3628 Session::record_enable_all ()
3629 {
3630         record_enable_change_all (true);
3631 }
3632
3633 void
3634 Session::record_enable_change_all (bool yn)
3635 {
3636         shared_ptr<RouteList> r = routes.reader ();
3637
3638         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3639                 Track* at;
3640
3641                 if ((at = dynamic_cast<Track*>((*i).get())) != 0) {
3642                         at->set_record_enable (yn, this);
3643                 }
3644         }
3645
3646         /* since we don't keep rec-enable state, don't mark session dirty */
3647 }
3648
3649 void
3650 Session::add_redirect (Redirect* redirect)
3651 {
3652         Send* send;
3653         Insert* insert;
3654         PortInsert* port_insert;
3655         PluginInsert* plugin_insert;
3656
3657         if ((insert = dynamic_cast<Insert *> (redirect)) != 0) {
3658                 if ((port_insert = dynamic_cast<PortInsert *> (insert)) != 0) {
3659                         _port_inserts.insert (_port_inserts.begin(), port_insert);
3660                 } else if ((plugin_insert = dynamic_cast<PluginInsert *> (insert)) != 0) {
3661                         _plugin_inserts.insert (_plugin_inserts.begin(), plugin_insert);
3662                 } else {
3663                         fatal << _("programming error: unknown type of Insert created!") << endmsg;
3664                         /*NOTREACHED*/
3665                 }
3666         } else if ((send = dynamic_cast<Send *> (redirect)) != 0) {
3667                 _sends.insert (_sends.begin(), send);
3668         } else {
3669                 fatal << _("programming error: unknown type of Redirect created!") << endmsg;
3670                 /*NOTREACHED*/
3671         }
3672
3673         redirect->GoingAway.connect (sigc::bind (mem_fun (*this, &Session::remove_redirect), redirect));
3674
3675         set_dirty();
3676 }
3677
3678 void
3679 Session::remove_redirect (Redirect* redirect)
3680 {
3681         Send* send;
3682         Insert* insert;
3683         PortInsert* port_insert;
3684         PluginInsert* plugin_insert;
3685
3686         if ((insert = dynamic_cast<Insert *> (redirect)) != 0) {
3687                 if ((port_insert = dynamic_cast<PortInsert *> (insert)) != 0) {
3688                         list<PortInsert*>::iterator x = find (_port_inserts.begin(), _port_inserts.end(), port_insert);
3689                         if (x != _port_inserts.end()) {
3690                                 insert_bitset[port_insert->bit_slot()] = false;
3691                                 _port_inserts.erase (x);
3692                         }
3693                 } else if ((plugin_insert = dynamic_cast<PluginInsert *> (insert)) != 0) {
3694                         _plugin_inserts.remove (plugin_insert);
3695                 } else {
3696                         fatal << string_compose (_("programming error: %1"),
3697                                                  X_("unknown type of Insert deleted!"))
3698                               << endmsg;
3699                         /*NOTREACHED*/
3700                 }
3701         } else if ((send = dynamic_cast<Send *> (redirect)) != 0) {
3702                 list<Send*>::iterator x = find (_sends.begin(), _sends.end(), send);
3703                 if (x != _sends.end()) {
3704                         send_bitset[send->bit_slot()] = false;
3705                         _sends.erase (x);
3706                 }
3707         } else {
3708                 fatal << _("programming error: unknown type of Redirect deleted!") << endmsg;
3709                 /*NOTREACHED*/
3710         }
3711
3712         set_dirty();
3713 }
3714
3715 nframes_t
3716 Session::available_capture_duration ()
3717 {
3718         float sample_bytes_on_disk = 4.0; // keep gcc happy
3719
3720         switch (Config->get_native_file_data_format()) {
3721         case FormatFloat:
3722                 sample_bytes_on_disk = 4.0;
3723                 break;
3724
3725         case FormatInt24:
3726                 sample_bytes_on_disk = 3.0;
3727                 break;
3728
3729         default:
3730                 /* impossible, but keep some gcc versions happy */
3731                 fatal << string_compose (_("programming error: %1"),
3732                                          X_("illegal native file data format"))
3733                       << endmsg;
3734                 /*NOTREACHED*/
3735         }
3736
3737         double scale = 4096.0 / sample_bytes_on_disk;
3738
3739         if (_total_free_4k_blocks * scale > (double) max_frames) {
3740                 return max_frames;
3741         }
3742
3743         return (nframes_t) floor (_total_free_4k_blocks * scale);
3744 }
3745
3746 void
3747 Session::add_connection (ARDOUR::Connection* connection)
3748 {
3749         {
3750                 Glib::Mutex::Lock guard (connection_lock);
3751                 _connections.push_back (connection);
3752         }
3753
3754         ConnectionAdded (connection); /* EMIT SIGNAL */
3755
3756         set_dirty();
3757 }
3758
3759 void
3760 Session::remove_connection (ARDOUR::Connection* connection)
3761 {
3762         bool removed = false;
3763
3764         {
3765                 Glib::Mutex::Lock guard (connection_lock);
3766                 ConnectionList::iterator i = find (_connections.begin(), _connections.end(), connection);
3767
3768                 if (i != _connections.end()) {
3769                         _connections.erase (i);
3770                         removed = true;
3771                 }
3772         }
3773
3774         if (removed) {
3775                  ConnectionRemoved (connection); /* EMIT SIGNAL */
3776         }
3777
3778         set_dirty();
3779 }
3780
3781 ARDOUR::Connection *
3782 Session::connection_by_name (string name) const
3783 {
3784         Glib::Mutex::Lock lm (connection_lock);
3785
3786         for (ConnectionList::const_iterator i = _connections.begin(); i != _connections.end(); ++i) {
3787                 if ((*i)->name() == name) {
3788                         return* i;
3789                 }
3790         }
3791
3792         return 0;
3793 }
3794
3795 void
3796 Session::tempo_map_changed (Change ignored)
3797 {
3798         clear_clicks ();
3799         set_dirty ();
3800 }
3801
3802 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
3803  * the given count with the current block size.
3804  */
3805 void
3806 Session::ensure_buffers (ChanCount howmany)
3807 {
3808         // FIXME: NASTY assumption (midi block size == audio block size)
3809         _scratch_buffers->ensure_buffers(howmany, current_block_size);
3810         _send_buffers->ensure_buffers(howmany, current_block_size);
3811         _silent_buffers->ensure_buffers(howmany, current_block_size);
3812
3813         allocate_pan_automation_buffers (current_block_size, howmany.get(DataType::AUDIO), false);
3814 }
3815
3816 uint32_t
3817 Session::next_insert_id ()
3818 {
3819         /* this doesn't really loop forever. just think about it */
3820
3821         while (true) {
3822                 for (boost::dynamic_bitset<uint32_t>::size_type n = 0; n < insert_bitset.size(); ++n) {
3823                         if (!insert_bitset[n]) {
3824                                 insert_bitset[n] = true;
3825                                 return n;
3826
3827                         }
3828                 }
3829
3830                 /* none available, so resize and try again */
3831
3832                 insert_bitset.resize (insert_bitset.size() + 16, false);
3833         }
3834 }
3835
3836 uint32_t
3837 Session::next_send_id ()
3838 {
3839         /* this doesn't really loop forever. just think about it */
3840
3841         while (true) {
3842                 for (boost::dynamic_bitset<uint32_t>::size_type n = 0; n < send_bitset.size(); ++n) {
3843                         if (!send_bitset[n]) {
3844                                 send_bitset[n] = true;
3845                                 return n;
3846
3847                         }
3848                 }
3849
3850                 /* none available, so resize and try again */
3851
3852                 send_bitset.resize (send_bitset.size() + 16, false);
3853         }
3854 }
3855
3856 void
3857 Session::mark_send_id (uint32_t id)
3858 {
3859         if (id >= send_bitset.size()) {
3860                 send_bitset.resize (id+16, false);
3861         }
3862         if (send_bitset[id]) {
3863                 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
3864         }
3865         send_bitset[id] = true;
3866 }
3867
3868 void
3869 Session::mark_insert_id (uint32_t id)
3870 {
3871         if (id >= insert_bitset.size()) {
3872                 insert_bitset.resize (id+16, false);
3873         }
3874         if (insert_bitset[id]) {
3875                 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
3876         }
3877         insert_bitset[id] = true;
3878 }
3879
3880 /* Named Selection management */
3881
3882 NamedSelection *
3883 Session::named_selection_by_name (string name)
3884 {
3885         Glib::Mutex::Lock lm (named_selection_lock);
3886         for (NamedSelectionList::iterator i = named_selections.begin(); i != named_selections.end(); ++i) {
3887                 if ((*i)->name == name) {
3888                         return* i;
3889                 }
3890         }
3891         return 0;
3892 }
3893
3894 void
3895 Session::add_named_selection (NamedSelection* named_selection)
3896 {
3897         {
3898                 Glib::Mutex::Lock lm (named_selection_lock);
3899                 named_selections.insert (named_selections.begin(), named_selection);
3900         }
3901
3902         for (list<boost::shared_ptr<Playlist> >::iterator i = named_selection->playlists.begin(); i != named_selection->playlists.end(); ++i) {
3903                 add_playlist (*i);
3904         }
3905
3906         set_dirty();
3907
3908         NamedSelectionAdded (); /* EMIT SIGNAL */
3909 }
3910
3911 void
3912 Session::remove_named_selection (NamedSelection* named_selection)
3913 {
3914         bool removed = false;
3915
3916         {
3917                 Glib::Mutex::Lock lm (named_selection_lock);
3918
3919                 NamedSelectionList::iterator i = find (named_selections.begin(), named_selections.end(), named_selection);
3920
3921                 if (i != named_selections.end()) {
3922                         delete (*i);
3923                         named_selections.erase (i);
3924                         set_dirty();
3925                         removed = true;
3926                 }
3927         }
3928
3929         if (removed) {
3930                  NamedSelectionRemoved (); /* EMIT SIGNAL */
3931         }
3932 }
3933
3934 void
3935 Session::reset_native_file_format ()
3936 {
3937         boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
3938
3939         for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
3940                 (*i)->reset_write_sources (false);
3941         }
3942 }
3943
3944 bool
3945 Session::route_name_unique (string n) const
3946 {
3947         shared_ptr<RouteList> r = routes.reader ();
3948
3949         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
3950                 if ((*i)->name() == n) {
3951                         return false;
3952                 }
3953         }
3954
3955         return true;
3956 }
3957
3958 uint32_t
3959 Session::n_playlists () const
3960 {
3961         Glib::Mutex::Lock lm (playlist_lock);
3962         return playlists.size();
3963 }
3964
3965 void
3966 Session::allocate_pan_automation_buffers (nframes_t nframes, uint32_t howmany, bool force)
3967 {
3968         if (!force && howmany <= _npan_buffers) {
3969                 return;
3970         }
3971
3972         if (_pan_automation_buffer) {
3973
3974                 for (uint32_t i = 0; i < _npan_buffers; ++i) {
3975                         delete [] _pan_automation_buffer[i];
3976                 }
3977
3978                 delete [] _pan_automation_buffer;
3979         }
3980
3981         _pan_automation_buffer = new pan_t*[howmany];
3982
3983         for (uint32_t i = 0; i < howmany; ++i) {
3984                 _pan_automation_buffer[i] = new pan_t[nframes];
3985         }
3986
3987         _npan_buffers = howmany;
3988 }
3989
3990 int
3991 Session::freeze (InterThreadInfo& itt)
3992 {
3993         shared_ptr<RouteList> r = routes.reader ();
3994
3995         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3996
3997                 Track *at;
3998
3999                 if ((at = dynamic_cast<Track*>((*i).get())) != 0) {
4000                         /* XXX this is wrong because itt.progress will keep returning to zero at the start
4001                            of every track.
4002                         */
4003                         at->freeze (itt);
4004                 }
4005         }
4006
4007         return 0;
4008 }
4009
4010 int
4011 Session::write_one_audio_track (AudioTrack& track, nframes_t start, nframes_t len,
4012                                bool overwrite, vector<boost::shared_ptr<Source> >& srcs, InterThreadInfo& itt)
4013 {
4014         int ret = -1;
4015         boost::shared_ptr<Playlist> playlist;
4016         boost::shared_ptr<AudioFileSource> fsource;
4017         uint32_t x;
4018         char buf[PATH_MAX+1];
4019         string dir;
4020         ChanCount nchans(track.audio_diskstream()->n_channels());
4021         nframes_t position;
4022         nframes_t this_chunk;
4023         nframes_t to_do;
4024         BufferSet buffers;
4025
4026         // any bigger than this seems to cause stack overflows in called functions
4027         const nframes_t chunk_size = (128 * 1024)/4;
4028
4029         g_atomic_int_set (&processing_prohibited, 1);
4030
4031         /* call tree *MUST* hold route_lock */
4032
4033         if ((playlist = track.diskstream()->playlist()) == 0) {
4034                 goto out;
4035         }
4036
4037         /* external redirects will be a problem */
4038
4039         if (track.has_external_redirects()) {
4040                 goto out;
4041         }
4042
4043         dir = discover_best_sound_dir ();
4044
4045         for (uint32_t chan_n=0; chan_n < nchans.get(DataType::AUDIO); ++chan_n) {
4046
4047                 for (x = 0; x < 99999; ++x) {
4048                         snprintf (buf, sizeof(buf), "%s/%s-%d-bounce-%" PRIu32 ".wav", dir.c_str(), playlist->name().c_str(), chan_n, x+1);
4049                         if (access (buf, F_OK) != 0) {
4050                                 break;
4051                         }
4052                 }
4053
4054                 if (x == 99999) {
4055                         error << string_compose (_("too many bounced versions of playlist \"%1\""), playlist->name()) << endmsg;
4056                         goto out;
4057                 }
4058
4059                 try {
4060                         fsource = boost::dynamic_pointer_cast<AudioFileSource> (
4061                                 SourceFactory::createWritable (DataType::AUDIO, *this, buf, false, frame_rate()));
4062                 }
4063
4064                 catch (failed_constructor& err) {
4065                         error << string_compose (_("cannot create new audio file \"%1\" for %2"), buf, track.name()) << endmsg;
4066                         goto out;
4067                 }
4068
4069                 srcs.push_back (fsource);
4070         }
4071
4072         /* XXX need to flush all redirects */
4073
4074         position = start;
4075         to_do = len;
4076
4077         /* create a set of reasonably-sized buffers */
4078         buffers.ensure_buffers(nchans, chunk_size);
4079         buffers.set_count(nchans);
4080
4081         for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
4082                 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
4083                 if (afs)
4084                         afs->prepare_for_peakfile_writes ();
4085         }
4086
4087         while (to_do && !itt.cancel) {
4088
4089                 this_chunk = min (to_do, chunk_size);
4090
4091                 if (track.export_stuff (buffers, start, this_chunk)) {
4092                         goto out;
4093                 }
4094
4095                 uint32_t n = 0;
4096                 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
4097                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
4098
4099                         if (afs) {
4100                                 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
4101                                         goto out;
4102                                 }
4103                         }
4104                 }
4105
4106                 start += this_chunk;
4107                 to_do -= this_chunk;
4108
4109                 itt.progress = (float) (1.0 - ((double) to_do / len));
4110
4111         }
4112
4113         if (!itt.cancel) {
4114
4115                 time_t now;
4116                 struct tm* xnow;
4117                 time (&now);
4118                 xnow = localtime (&now);
4119
4120                 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
4121                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
4122
4123                         if (afs) {
4124                                 afs->update_header (position, *xnow, now);
4125                                 afs->flush_header ();
4126                         }
4127                 }
4128
4129                 /* construct a region to represent the bounced material */
4130
4131                 boost::shared_ptr<Region> aregion = RegionFactory::create (srcs, 0, srcs.front()->length(),
4132                                                                            region_name_from_path (srcs.front()->name(), true));
4133
4134                 ret = 0;
4135         }
4136
4137   out:
4138         if (ret) {
4139                 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
4140                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
4141
4142                         if (afs) {
4143                                 afs->mark_for_remove ();
4144                         }
4145
4146                         (*src)->drop_references ();
4147                 }
4148
4149         } else {
4150                 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
4151                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
4152
4153                         if (afs)
4154                                 afs->done_with_peakfile_writes ();
4155                 }
4156         }
4157
4158         g_atomic_int_set (&processing_prohibited, 0);
4159
4160         itt.done = true;
4161
4162         return ret;
4163 }
4164
4165 BufferSet&
4166 Session::get_silent_buffers (ChanCount count)
4167 {
4168         assert(_silent_buffers->available() >= count);
4169         _silent_buffers->set_count(count);
4170
4171         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
4172                 for (size_t i=0; i < count.get(*t); ++i) {
4173                         _silent_buffers->get(*t, i).clear();
4174                 }
4175         }
4176
4177         return *_silent_buffers;
4178 }
4179
4180 BufferSet&
4181 Session::get_scratch_buffers (ChanCount count)
4182 {
4183         assert(_scratch_buffers->available() >= count);
4184         _scratch_buffers->set_count(count);
4185         return *_scratch_buffers;
4186 }
4187
4188 BufferSet&
4189 Session::get_send_buffers (ChanCount count)
4190 {
4191         assert(_send_buffers->available() >= count);
4192         _send_buffers->set_count(count);
4193         return *_send_buffers;
4194 }
4195
4196 uint32_t
4197 Session::ntracks () const
4198 {
4199         uint32_t n = 0;
4200         shared_ptr<RouteList> r = routes.reader ();
4201
4202         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
4203                 if (dynamic_cast<Track*> ((*i).get())) {
4204                         ++n;
4205                 }
4206         }
4207
4208         return n;
4209 }
4210
4211 uint32_t
4212 Session::nbusses () const
4213 {
4214         uint32_t n = 0;
4215         shared_ptr<RouteList> r = routes.reader ();
4216
4217         for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
4218                 if (dynamic_cast<Track*> ((*i).get()) == 0) {
4219                         ++n;
4220                 }
4221         }
4222
4223         return n;
4224 }
4225
4226 void
4227 Session::add_automation_list(AutomationList *al)
4228 {
4229         automation_lists[al->id()] = al;
4230 }
4231
4232 nframes_t
4233 Session::compute_initial_length ()
4234 {
4235         return _engine.frame_rate() * 60 * 5;
4236 }
4237