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