libs/ardour/session.cc

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