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