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