libs/ardour/ardour/session.h

   1 /*
   2   Copyright (C) 2000 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 #ifndef __ardour_session_h__
  21 #define __ardour_session_h__
  22
  23 #ifdef WAF_BUILD
  24 #include "libardour-config.h"
  25 #endif
  26
  27 #include <exception>
  28 #include <list>
  29 #include <map>
  30 #include <set>
  31 #include <string>
  32 #include <vector>
  33 #include <queue>
  34 #include <stdint.h>
  35
  36 #include <boost/dynamic_bitset.hpp>
  37 #include <boost/scoped_ptr.hpp>
  38 #include <boost/weak_ptr.hpp>
  39 #include <boost/utility.hpp>
  40
  41 #include <glibmm/threads.h>
  42
  43 #include <ltc.h>
  44
  45 #include "pbd/error.h"
  46 #include "pbd/event_loop.h"
  47 #include "pbd/file_archive.h"
  48 #include "pbd/rcu.h"
  49 #include "pbd/reallocpool.h"
  50 #include "pbd/statefuldestructible.h"
  51 #include "pbd/signals.h"
  52 #include "pbd/undo.h"
  53
  54 #include "lua/luastate.h"
  55
  56 #include "evoral/Range.hpp"
  57
  58 #include "midi++/types.h"
  59 #include "midi++/mmc.h"
  60
  61 #include "temporal/time.h"
  62
  63 #include "ardour/ardour.h"
  64 #include "ardour/chan_count.h"
  65 #include "ardour/delivery.h"
  66 #include "ardour/interthread_info.h"
  67 #include "ardour/luascripting.h"
  68 #include "ardour/location.h"
  69 #include "ardour/monitor_processor.h"
  70 #include "ardour/presentation_info.h"
  71 #include "ardour/rc_configuration.h"
  72 #include "ardour/session_configuration.h"
  73 #include "ardour/session_event.h"
  74 #include "ardour/interpolation.h"
  75 #include "ardour/plugin.h"
  76 #include "ardour/presentation_info.h"
  77 #include "ardour/route.h"
  78 #include "ardour/route_graph.h"
  79
  80
  81 class XMLTree;
  82 class XMLNode;
  83 struct _AEffect;
  84 typedef struct _AEffect AEffect;
  85
  86 namespace MIDI {
  87 class Port;
  88 class MachineControl;
  89 class Parser;
  90 }
  91
  92 namespace PBD {
  93 class Controllable;
  94 }
  95
  96 namespace luabridge {
  97         class LuaRef;
  98 }
  99
 100 namespace Evoral {
 101 class Curve;
 102 }
 103
 104 namespace ARDOUR {
 105
 106 class Amp;
 107 class AudioEngine;
 108 class AudioFileSource;
 109 class AudioRegion;
 110 class AudioSource;
 111 class AudioTrack;
 112 class Auditioner;
 113 class AutomationList;
 114 class AuxInput;
 115 class BufferSet;
 116 class Bundle;
 117 class Butler;
 118 class Click;
 119 class CoreSelection;
 120 class ExportHandler;
 121 class ExportStatus;
 122 class Graph;
 123 class IO;
 124 class IOProcessor;
 125 class ImportStatus;
 126 class MidiClockTicker;
 127 class MidiControlUI;
 128 class MidiPortManager;
 129 class MidiPort;
 130 class MidiRegion;
 131 class MidiSource;
 132 class MidiTrack;
 133 class Playlist;
 134 class PluginInsert;
 135 class PluginInfo;
 136 class Port;
 137 class PortInsert;
 138 class ProcessThread;
 139 class Progress;
 140 class Processor;
 141 class Region;
 142 class Return;
 143 class Route;
 144 class RouteGroup;
 145 class RTTaskList;
 146 class SMFSource;
 147 class Send;
 148 class SceneChanger;
 149 class SessionDirectory;
 150 class SessionMetadata;
 151 class SessionPlaylists;
 152 class Source;
 153 class Speakers;
 154 class TempoMap;
 155 class TransportMaster;
 156 class Track;
 157 class UI_TransportMaster;
 158 class VCAManager;
 159 class WindowsVSTPlugin;
 160
 161 extern void setup_enum_writer ();
 162
 163 class LIBARDOUR_API SessionException: public std::exception {
 164 public:
 165         explicit SessionException(const std::string msg) : _message(msg) {}
 166         virtual ~SessionException() throw() {}
 167
 168         virtual const char* what() const throw() { return _message.c_str(); }
 169
 170 private:
 171         std::string _message;
 172 };
 173
 174 /** Ardour Session */
 175 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
 176 {
 177 private:
 178
 179 public:
 180         enum RecordState {
 181                 Disabled = 0,
 182                 Enabled = 1,
 183                 Recording = 2
 184         };
 185
 186         /* a new session might have non-empty mix_template, an existing session should always have an empty one.
 187            the bus profile can be null if no master out bus is required.
 188         */
 189
 190         Session (AudioEngine&,
 191                  const std::string& fullpath,
 192                  const std::string& snapshot_name,
 193                  BusProfile* bus_profile = 0,
 194                  std::string mix_template = "");
 195
 196         virtual ~Session ();
 197
 198         static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format, std::string& program_version);
 199         static std::string get_snapshot_from_instant (const std::string& session_dir);
 200
 201         /** a monotonic counter used for naming user-visible things uniquely
 202          * (curently the sidechain port).
 203          * Use sparingly to keep the numbers low, prefer PBD::ID for all
 204          * internal, not user-visible IDs */
 205         static unsigned int next_name_id ();
 206
 207         std::string path() const { return _path; }
 208         std::string name() const { return _name; }
 209         std::string snap_name() const { return _current_snapshot_name; }
 210         std::string raid_path () const;
 211         bool path_is_within_session (const std::string&);
 212
 213         bool writable() const { return _writable; }
 214         void set_dirty ();
 215         void set_clean ();
 216         bool dirty() const { return _state_of_the_state & Dirty; }
 217         void set_deletion_in_progress ();
 218         void clear_deletion_in_progress ();
 219         bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
 220         bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
 221         bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
 222         bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
 223         bool loading () const { return _state_of_the_state & Loading; }
 224
 225         PBD::Signal0<void> DirtyChanged;
 226
 227         const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
 228
 229         static PBD::Signal1<void,std::string> Dialog;
 230
 231         PBD::Signal0<void> BatchUpdateStart;
 232         PBD::Signal0<void> BatchUpdateEnd;
 233
 234         int ensure_subdirs ();
 235
 236         std::string automation_dir () const;  ///< Automation data
 237         std::string analysis_dir () const;    ///< Analysis data
 238         std::string plugins_dir () const;     ///< Plugin state
 239         std::string externals_dir () const;   ///< Links to external files
 240
 241         std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
 242
 243         bool audio_source_name_is_unique (const std::string& name);
 244         std::string format_audio_source_name (const std::string& legalized_base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required, uint32_t cnt, bool related_exists);
 245         std::string new_audio_source_path_for_embedded (const std::string& existing_path);
 246         std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
 247         std::string new_midi_source_path (const std::string&, bool need_source_lock = true);
 248         /** create a new track or bus from a template (XML path)
 249          * @param how_many how many tracks or busses to create
 250          * @param template_path path to xml template file
 251          * @param name name (prefix) of the route to create
 252          * @param pd Playlist disposition
 253          * @return list of newly created routes
 254          */
 255         RouteList new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, const std::string& template_path, const std::string& name, PlaylistDisposition pd = NewPlaylist);
 256         RouteList new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
 257         std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path,
 258                                                             uint32_t channels, std::vector<std::string> const & smf_track_names);
 259
 260         int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
 261
 262         void process (pframes_t nframes);
 263
 264         BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
 265         BufferSet& get_noinplace_buffers (ChanCount count = ChanCount::ZERO);
 266         BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
 267         BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
 268         BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
 269
 270         bool have_rec_enabled_track () const;
 271     bool have_rec_disabled_track () const;
 272
 273         bool have_captured() const { return _have_captured; }
 274
 275         void refill_all_track_buffers ();
 276         Butler* butler() { return _butler; }
 277         void butler_transport_work ();
 278
 279         void refresh_disk_space ();
 280
 281         int load_routes (const XMLNode&, int);
 282         boost::shared_ptr<RouteList> get_routes() const {
 283                 return routes.reader ();
 284         }
 285
 286         boost::shared_ptr<RTTaskList> rt_tasklist () { return _rt_tasklist; }
 287
 288         RouteList get_routelist (bool mixer_order = false) const;
 289
 290         CoreSelection& selection () { return *_selection; }
 291
 292         /* because the set of Stripables consists of objects managed
 293          * independently, in multiple containers within the Session (or objects
 294          * owned by the session), we fill out a list in-place rather than
 295          * return a pointer to a copy of the (RCU) managed list, as happens
 296          * with get_routes()
 297          */
 298
 299         void get_stripables (StripableList&) const;
 300         StripableList get_stripables () const;
 301         boost::shared_ptr<RouteList> get_tracks() const;
 302         boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
 303         boost::shared_ptr<RouteList> get_routes_with_regions_at (samplepos_t const) const;
 304
 305         uint32_t nstripables (bool with_monitor = false) const;
 306         uint32_t nroutes() const { return routes.reader()->size(); }
 307         uint32_t ntracks () const;
 308         uint32_t nbusses () const;
 309
 310         boost::shared_ptr<BundleList> bundles () {
 311                 return _bundles.reader ();
 312         }
 313
 314         void notify_presentation_info_change ();
 315
 316         template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
 317         template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
 318         template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
 319
 320         static char session_name_is_legal (const std::string&);
 321         bool io_name_is_legal (const std::string&) const;
 322         boost::shared_ptr<Route> route_by_name (std::string) const;
 323         boost::shared_ptr<Route> route_by_id (PBD::ID) const;
 324         boost::shared_ptr<Stripable> stripable_by_id (PBD::ID) const;
 325         boost::shared_ptr<Stripable> get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag) const;
 326         boost::shared_ptr<Route> get_remote_nth_route (PresentationInfo::order_t n) const;
 327         boost::shared_ptr<Route> route_by_selected_count (uint32_t cnt) const;
 328         void routes_using_input_from (const std::string& str, RouteList& rl);
 329
 330         bool route_name_unique (std::string) const;
 331         bool route_name_internal (std::string) const;
 332
 333         uint32_t track_number_decimals () const {
 334                 return _track_number_decimals;
 335         }
 336
 337         bool get_record_enabled() const {
 338                 return (record_status () >= Enabled);
 339         }
 340
 341         RecordState record_status() const {
 342                 return (RecordState) g_atomic_int_get (&_record_status);
 343         }
 344
 345         bool actively_recording () const {
 346                 return record_status() == Recording;
 347         }
 348
 349         bool record_enabling_legal () const;
 350         void maybe_enable_record (bool rt_context = false);
 351         void disable_record (bool rt_context, bool force = false);
 352         void step_back_from_record ();
 353
 354         void set_all_tracks_record_enabled(bool);
 355
 356         void maybe_write_autosave ();
 357
 358         /* Emitted when all i/o connections are complete */
 359
 360         PBD::Signal0<void> IOConnectionsComplete;
 361
 362         /* Record status signals */
 363
 364         PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
 365         /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
 366            from the previous signal and session state.
 367         */
 368         PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
 369
 370         /* Emited when session is loaded */
 371         PBD::Signal0<void> SessionLoaded;
 372
 373         /* Transport mechanism signals */
 374
 375         /** Emitted on the following changes in transport state:
 376          *  - stop (from the butler thread)
 377          *  - change in whether or not we are looping (from the process thread)
 378          *  - change in the play range (from the process thread)
 379          *  - start (from the process thread)
 380          *  - engine halted
 381          */
 382         PBD::Signal0<void> TransportStateChange;
 383
 384         PBD::Signal1<void,samplepos_t> PositionChanged; /* sent after any non-sequential motion */
 385         PBD::Signal1<void,samplepos_t> Xrun;
 386         PBD::Signal0<void> TransportLooped;
 387
 388         /** emitted when a locate has occurred */
 389         PBD::Signal0<void> Located;
 390
 391         PBD::Signal1<void,RouteList&> RouteAdded;
 392         /** Emitted when a property of one of our route groups changes.
 393          *  The parameter is the RouteGroup that has changed.
 394          */
 395         PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
 396         /** Emitted when a route is added to one of our route groups.
 397          *  First parameter is the RouteGroup, second is the route.
 398          */
 399         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
 400         /** Emitted when a route is removed from one of our route groups.
 401          *  First parameter is the RouteGroup, second is the route.
 402          */
 403         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
 404
 405         /* Step Editing status changed */
 406         PBD::Signal1<void,bool> StepEditStatusChange;
 407
 408         /* Timecode state signals */
 409         PBD::Signal0<void> MtcOrLtcInputPortChanged;
 410
 411         void queue_event (SessionEvent*);
 412
 413         void request_roll_at_and_return (samplepos_t start, samplepos_t return_to);
 414         void request_bounded_roll (samplepos_t start, samplepos_t end);
 415         void request_stop (bool abort = false, bool clear_state = false, TransportRequestSource origin = TRS_UI);
 416         void request_locate (samplepos_t sample, bool with_roll = false, TransportRequestSource origin = TRS_UI);
 417
 418         void request_play_loop (bool yn, bool leave_rolling = false);
 419         bool get_play_loop () const { return play_loop; }
 420
 421         samplepos_t last_transport_start () const { return _last_roll_location; }
 422         void goto_end ();
 423         void goto_start (bool and_roll = false);
 424         void use_rf_shuttle_speed ();
 425         void allow_auto_play (bool yn);
 426         void request_transport_speed (double speed, bool as_default = true, TransportRequestSource origin = TRS_UI);
 427         void request_transport_speed_nonzero (double, bool as_default = true, TransportRequestSource origin = TRS_UI);
 428         void request_overwrite_buffer (boost::shared_ptr<Route>);
 429         void adjust_playback_buffering();
 430         void adjust_capture_buffering();
 431
 432         bool global_locate_pending() const { return _global_locate_pending; }
 433         bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
 434         bool transport_locked () const;
 435
 436         int wipe ();
 437
 438         samplepos_t current_end_sample () const;
 439         samplepos_t current_start_sample () const;
 440         /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
 441         samplecnt_t sample_rate () const { return _current_sample_rate; }
 442         /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
 443         samplecnt_t nominal_sample_rate () const { return _nominal_sample_rate; }
 444         samplecnt_t frames_per_hour () const { return _frames_per_hour; }
 445
 446         double samples_per_timecode_frame() const { return _samples_per_timecode_frame; }
 447         samplecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
 448
 449         MIDI::byte get_mtc_timecode_bits() const {
 450                 return mtc_timecode_bits;   /* encoding of SMTPE type for MTC */
 451         }
 452
 453         double timecode_frames_per_second() const;
 454         bool timecode_drop_frames() const;
 455
 456         /* Locations */
 457
 458         Locations *locations() { return _locations; }
 459
 460         PBD::Signal1<void,Location*>    auto_loop_location_changed;
 461         PBD::Signal1<void,Location*>    auto_punch_location_changed;
 462         PBD::Signal0<void>              locations_modified;
 463
 464         void set_auto_punch_location (Location *);
 465         void set_auto_loop_location (Location *);
 466         void set_session_extents (samplepos_t start, samplepos_t end);
 467         bool end_is_free () const { return _session_range_end_is_free; }
 468         void set_end_is_free (bool);
 469
 470         pframes_t get_block_size () const         { return current_block_size; }
 471         samplecnt_t worst_output_latency () const { return _worst_output_latency; }
 472         samplecnt_t worst_input_latency () const  { return _worst_input_latency; }
 473         samplecnt_t worst_route_latency () const  { return _worst_route_latency; }
 474         samplecnt_t worst_latency_preroll () const;
 475
 476         struct SaveAs {
 477                 std::string new_parent_folder;  /* parent folder where new session folder will be created */
 478                 std::string new_name;           /* name of newly saved session */
 479                 bool        switch_to;     /* true if we should be working on newly saved session after save-as; false otherwise */
 480                 bool        include_media; /* true if the newly saved session should contain references to media */
 481                 bool        copy_media;    /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
 482                 bool        copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
 483
 484                 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
 485
 486                 /* emitted as we make progress. 3 arguments passed to signal
 487                  * handler:
 488                  *
 489                  *  1: percentage complete measured as a fraction (0-1.0) of
 490                  *     total data copying done.
 491                  *  2: number of files copied so far
 492                  *  3: total number of files to copy
 493                  *
 494                  * Handler should return true for save-as to continue, or false
 495                  * to stop (and remove all evidence of partial save-as).
 496                  */
 497                 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
 498
 499                 /* if save_as() returns non-zero, this string will indicate the reason why.
 500                  */
 501                 std::string failure_message;
 502         };
 503
 504         int save_as (SaveAs&);
 505
 506         /** save session
 507          * @param snapshot_name name of the session (use an empty string for the current name)
 508          * @param pending save a 'recovery', not full state (default: false)
 509          * @param switch_to_snapshot switch to given snapshot after saving (default: false)
 510          * @param template_only save a session template (default: false)
 511          * @return zero on success
 512          */
 513         int save_state (std::string snapshot_name,
 514                         bool pending = false,
 515                         bool switch_to_snapshot = false,
 516                         bool template_only = false,
 517                         bool for_archive = false,
 518                         bool only_used_assets = false);
 519
 520         enum ArchiveEncode {
 521                 NO_ENCODE,
 522                 FLAC_16BIT,
 523                 FLAC_24BIT
 524         };
 525
 526         int archive_session (const std::string&, const std::string&,
 527                              ArchiveEncode compress_audio = FLAC_16BIT,
 528                              PBD::FileArchive::CompressionLevel compression_level = PBD::FileArchive::CompressGood,
 529                              bool only_used_sources = false,
 530                              Progress* p = 0);
 531
 532         int restore_state (std::string snapshot_name);
 533         int save_template (const std::string& template_name, const std::string& description = "", bool replace_existing = false);
 534         int save_history (std::string snapshot_name = "");
 535         int restore_history (std::string snapshot_name);
 536         void remove_state (std::string snapshot_name);
 537         void rename_state (std::string old_name, std::string new_name);
 538         void remove_pending_capture_state ();
 539         int rename (const std::string&);
 540         bool get_nsm_state () const { return _under_nsm_control; }
 541         void set_nsm_state (bool state) { _under_nsm_control = state; }
 542         bool save_default_options ();
 543
 544         PBD::Signal1<void,std::string> StateSaved;
 545         PBD::Signal0<void> StateReady;
 546
 547         /* emitted when session needs to be saved due to some internal
 548          * event or condition (i.e. not in response to a user request).
 549          *
 550          * Only one object should
 551          * connect to this signal and take responsibility.
 552          *
 553          * Argument is the snapshot name to use when saving.
 554          */
 555         PBD::Signal1<void,std::string> SaveSessionRequested;
 556
 557         /* emitted during a session save to allow other entities to add state, via
 558          * extra XML, to the session state
 559          */
 560         PBD::Signal0<void> SessionSaveUnderway;
 561
 562         std::vector<std::string> possible_states() const;
 563         static std::vector<std::string> possible_states (std::string path);
 564
 565         bool export_track_state (boost::shared_ptr<RouteList> rl, const std::string& path);
 566
 567         /// The instant xml file is written to the session directory
 568         void add_instant_xml (XMLNode&, bool write_to_config = true);
 569         XMLNode* instant_xml (const std::string& str);
 570
 571         enum StateOfTheState {
 572                 Clean = 0x0,
 573                 Dirty = 0x1,
 574                 CannotSave = 0x2,
 575                 Deletion = 0x4,
 576                 InitialConnecting = 0x8,
 577                 Loading = 0x10,
 578                 InCleanup = 0x20,
 579                 PeakCleanup = 0x40
 580         };
 581
 582         StateOfTheState state_of_the_state() const { return _state_of_the_state; }
 583
 584         class StateProtector {
 585                 public:
 586                         StateProtector (Session* s) : _session (s) {
 587                                 g_atomic_int_inc (&s->_suspend_save);
 588                         }
 589                         ~StateProtector () {
 590                                 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
 591                                         while (_session->_save_queued) {
 592                                                 _session->_save_queued = false;
 593                                                 _session->save_state ("");
 594                                         }
 595                                 }
 596                         }
 597                 private:
 598                         Session * _session;
 599         };
 600
 601         class ProcessorChangeBlocker {
 602                 public:
 603                         ProcessorChangeBlocker (Session* s, bool rc = true)
 604                                 : _session (s)
 605                                 , _reconfigure_on_delete (rc)
 606                         {
 607                                 g_atomic_int_inc (&s->_ignore_route_processor_changes);
 608                         }
 609                         ~ProcessorChangeBlocker () {
 610                                 if (g_atomic_int_dec_and_test (&_session->_ignore_route_processor_changes)) {
 611                                         if (_reconfigure_on_delete) {
 612                                                 _session->route_processors_changed (RouteProcessorChange ());
 613                                         }
 614                                 }
 615                         }
 616                 private:
 617                         Session* _session;
 618                         bool _reconfigure_on_delete;
 619         };
 620
 621         RouteGroup* new_route_group (const std::string&);
 622         void add_route_group (RouteGroup *);
 623         void remove_route_group (RouteGroup* rg) { if (rg) remove_route_group (*rg); }
 624         void remove_route_group (RouteGroup&);
 625         void reorder_route_groups (std::list<RouteGroup*>);
 626
 627         RouteGroup* route_group_by_name (std::string);
 628         RouteGroup& all_route_group() const;
 629
 630         PBD::Signal1<void,RouteGroup*> route_group_added;
 631         PBD::Signal0<void>             route_group_removed;
 632         PBD::Signal0<void>             route_groups_reordered;
 633
 634         void foreach_route_group (boost::function<void(RouteGroup*)> f) {
 635                 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
 636                         f (*i);
 637                 }
 638         }
 639
 640         std::list<RouteGroup*> const & route_groups () const {
 641                 return _route_groups;
 642         }
 643
 644         /* fundamental operations. duh. */
 645
 646         std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
 647                 int input_channels,
 648                 int output_channels,
 649                 RouteGroup* route_group,
 650                 uint32_t how_many,
 651                 std::string name_template,
 652                 PresentationInfo::order_t order,
 653                 TrackMode mode = Normal
 654                 );
 655
 656         std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
 657                 const ChanCount& input, const ChanCount& output, bool strict_io,
 658                 boost::shared_ptr<PluginInfo> instrument,
 659                 Plugin::PresetRecord* pset,
 660                 RouteGroup* route_group, uint32_t how_many, std::string name_template,
 661                 PresentationInfo::order_t,
 662                 TrackMode mode = Normal
 663                 );
 664
 665         RouteList new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template, PresentationInfo::Flag, PresentationInfo::order_t);
 666         RouteList new_midi_route (RouteGroup* route_group, uint32_t how_many, std::string name_template, bool strict_io, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord*, PresentationInfo::Flag, PresentationInfo::order_t);
 667
 668         void remove_routes (boost::shared_ptr<RouteList>);
 669         void remove_route (boost::shared_ptr<Route>);
 670
 671         void resort_routes ();
 672         void resort_routes_using (boost::shared_ptr<RouteList>);
 673
 674         AudioEngine & engine() { return _engine; }
 675         AudioEngine const & engine () const { return _engine; }
 676
 677         static std::string default_track_name_pattern (DataType);
 678
 679         /* Time */
 680
 681         samplepos_t transport_sample () const { return _transport_sample; }
 682         samplepos_t record_location () const { return _last_record_location; }
 683         samplepos_t audible_sample (bool* latent_locate = NULL) const;
 684         samplepos_t requested_return_sample() const { return _requested_return_sample; }
 685         void set_requested_return_sample(samplepos_t return_to);
 686
 687         bool compute_audible_delta (samplepos_t& pos_and_delta) const;
 688         samplecnt_t remaining_latency_preroll () const { return _remaining_latency_preroll; }
 689
 690         enum PullupFormat {
 691                 pullup_Plus4Plus1,
 692                 pullup_Plus4,
 693                 pullup_Plus4Minus1,
 694                 pullup_Plus1,
 695                 pullup_None,
 696                 pullup_Minus1,
 697                 pullup_Minus4Plus1,
 698                 pullup_Minus4,
 699                 pullup_Minus4Minus1
 700         };
 701
 702         void sync_time_vars();
 703
 704         void bbt_time (samplepos_t when, Timecode::BBT_Time&);
 705         void timecode_to_sample(Timecode::Time& timecode, samplepos_t& sample, bool use_offset, bool use_subframes) const;
 706         void sample_to_timecode(samplepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
 707         void timecode_time (Timecode::Time &);
 708         void timecode_time (samplepos_t when, Timecode::Time&);
 709         void timecode_time_subframes (samplepos_t when, Timecode::Time&);
 710
 711         void timecode_duration (samplecnt_t, Timecode::Time&) const;
 712         void timecode_duration_string (char *, size_t len, samplecnt_t) const;
 713
 714         samplecnt_t convert_to_samples (AnyTime const & position);
 715         samplecnt_t any_duration_to_samples (samplepos_t position, AnyTime const & duration);
 716
 717         static PBD::Signal1<void, samplepos_t> StartTimeChanged;
 718         static PBD::Signal1<void, samplepos_t> EndTimeChanged;
 719
 720         void   request_sync_source (boost::shared_ptr<TransportMaster>);
 721         bool   synced_to_engine() const;
 722
 723         double engine_speed() const { return _engine_speed; }
 724         double actual_speed() const {
 725                 if (_transport_speed > 0) return _engine_speed;
 726                 if (_transport_speed < 0) return - _engine_speed;
 727                 return 0;
 728         }
 729         double transport_speed() const { return _count_in_samples > 0 ? 0. : _transport_speed; }
 730         bool   transport_stopped() const { return _transport_speed == 0.0; }
 731         bool   transport_rolling() const { return _transport_speed != 0.0 && _count_in_samples == 0 && _remaining_latency_preroll == 0; }
 732
 733         bool silent () { return _silent; }
 734
 735         TempoMap&       tempo_map()       { return *_tempo_map; }
 736         const TempoMap& tempo_map() const { return *_tempo_map; }
 737
 738         unsigned int    get_xrun_count () const {return _xrun_count; }
 739         void            reset_xrun_count () {_xrun_count = 0; }
 740
 741         /* region info  */
 742
 743         boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
 744
 745         boost::shared_ptr<Region>      XMLRegionFactory (const XMLNode&, bool full);
 746         boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
 747         boost::shared_ptr<MidiRegion>  XMLMidiRegionFactory (const XMLNode&, bool full);
 748
 749         /* source management */
 750
 751         void import_files (ImportStatus&);
 752         bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
 753         std::string build_tmp_convert_name (std::string file);
 754
 755         boost::shared_ptr<ExportHandler> get_export_handler ();
 756         boost::shared_ptr<ExportStatus> get_export_status ();
 757
 758         int start_audio_export (samplepos_t position, bool realtime = false, bool region_export = false);
 759
 760         PBD::Signal1<int, samplecnt_t> ProcessExport;
 761         static PBD::Signal2<void,std::string, std::string> Exported;
 762
 763         void add_source (boost::shared_ptr<Source>);
 764         void remove_source (boost::weak_ptr<Source>);
 765
 766         void cleanup_regions();
 767         bool can_cleanup_peakfiles () const;
 768         int  cleanup_peakfiles ();
 769         int  cleanup_sources (CleanupReport&);
 770         int  cleanup_trash_sources (CleanupReport&);
 771
 772         int destroy_sources (std::list<boost::shared_ptr<Source> >);
 773
 774         int remove_last_capture ();
 775
 776         /** handlers should return 0 for "everything OK", and any other value for
 777          * "cannot setup audioengine".
 778          */
 779         static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
 780
 781         /** handlers should return -1 for "stop cleanup",
 782             0 for "yes, delete this playlist",
 783             1 for "no, don't delete this playlist".
 784         */
 785         static PBD::Signal1<int,boost::shared_ptr<Playlist> >  AskAboutPlaylistDeletion;
 786
 787         /** handlers should return 0 for "ignore the rate mismatch",
 788             !0 for "do not use this session"
 789         */
 790         static PBD::Signal2<int, samplecnt_t, samplecnt_t> AskAboutSampleRateMismatch;
 791
 792         /** non interactive message */
 793         static PBD::Signal2<void, samplecnt_t, samplecnt_t> NotifyAboutSampleRateMismatch;
 794
 795         /** handlers should return !0 for use pending state, 0 for ignore it.
 796          */
 797         static PBD::Signal0<int> AskAboutPendingState;
 798
 799         boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
 800                 size_t, std::string const &, uint32_t, bool destructive);
 801
 802         boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
 803         boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
 804
 805         boost::shared_ptr<Source> source_by_id (const PBD::ID&);
 806         boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
 807         boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&, bool need_source_lock) const;
 808         uint32_t count_sources_by_origin (const std::string&);
 809
 810         void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
 811
 812         /* Curves and AutomationLists (TODO when they go away) */
 813         void add_automation_list(AutomationList*);
 814
 815         /* auditioning */
 816
 817         boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
 818         void audition_playlist ();
 819         void audition_region (boost::shared_ptr<Region>);
 820         void cancel_audition ();
 821         bool is_auditioning () const;
 822
 823         PBD::Signal1<void,bool> AuditionActive;
 824
 825         /* session script */
 826         void register_lua_function (const std::string&, const std::string&, const LuaScriptParamList&);
 827         void unregister_lua_function (const std::string& name);
 828         std::vector<std::string> registered_lua_functions ();
 829         uint32_t registered_lua_function_count () const { return _n_lua_scripts; }
 830         void scripts_changed (); // called from lua, updates _n_lua_scripts
 831
 832         PBD::Signal0<void> LuaScriptsChanged;
 833
 834         /* flattening stuff */
 835
 836         boost::shared_ptr<Region> write_one_track (Track&, samplepos_t start, samplepos_t end,
 837                                                    bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
 838                                                    boost::shared_ptr<Processor> endpoint,
 839                                                    bool include_endpoint, bool for_export, bool for_freeze);
 840         int freeze_all (InterThreadInfo&);
 841
 842         /* session-wide solo/mute/rec-enable */
 843
 844         bool muted() const;
 845         std::vector<boost::weak_ptr<AutomationControl> > cancel_all_mute ();
 846
 847         bool soloing() const { return _non_soloed_outs_muted; }
 848         bool listening() const { return _listen_cnt > 0; }
 849         bool solo_isolated() const { return _solo_isolated_cnt > 0; }
 850         void cancel_all_solo ();
 851
 852         bool solo_selection_active();
 853         void solo_selection( StripableList&, bool );
 854
 855         static const SessionEvent::RTeventCallback rt_cleanup;
 856
 857         void clear_all_solo_state (boost::shared_ptr<RouteList>);
 858
 859         /* Control-based methods */
 860
 861         void set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition);
 862         void set_control (boost::shared_ptr<AutomationControl>, double val, PBD::Controllable::GroupControlDisposition);
 863
 864         void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others = false);
 865
 866         PBD::Signal1<void,bool> SoloActive;
 867         PBD::Signal0<void> SoloChanged;
 868         PBD::Signal0<void> MuteChanged;
 869         PBD::Signal0<void> IsolatedChanged;
 870         PBD::Signal0<void> MonitorChanged;
 871
 872         PBD::Signal0<void> session_routes_reconnected;
 873
 874         /* monitor/master out */
 875         int add_master_bus (ChanCount const&);
 876
 877         void add_monitor_section ();
 878         void reset_monitor_section ();
 879         void remove_monitor_section ();
 880         bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
 881
 882         boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
 883         boost::shared_ptr<Route> master_out() const { return _master_out; }
 884
 885         PresentationInfo::order_t master_order_key () const { return _master_out ? _master_out->presentation_info ().order () : -1; }
 886         bool ensure_stripable_sort_order ();
 887
 888         void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
 889         void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
 890         void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
 891         void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
 892         void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
 893         void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
 894         void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
 895
 896         static void set_disable_all_loaded_plugins (bool yn) {
 897                 _disable_all_loaded_plugins = yn;
 898         }
 899         static bool get_disable_all_loaded_plugins() {
 900                 return _disable_all_loaded_plugins;
 901         }
 902         static void set_bypass_all_loaded_plugins (bool yn) {
 903                 _bypass_all_loaded_plugins = yn;
 904         }
 905         static bool get_bypass_all_loaded_plugins() {
 906                 return _bypass_all_loaded_plugins;
 907         }
 908
 909         uint32_t next_send_id();
 910         uint32_t next_aux_send_id();
 911         uint32_t next_return_id();
 912         uint32_t next_insert_id();
 913         void mark_send_id (uint32_t);
 914         void mark_aux_send_id (uint32_t);
 915         void mark_return_id (uint32_t);
 916         void mark_insert_id (uint32_t);
 917         void unmark_send_id (uint32_t);
 918         void unmark_aux_send_id (uint32_t);
 919         void unmark_return_id (uint32_t);
 920         void unmark_insert_id (uint32_t);
 921
 922         /* s/w "RAID" management */
 923
 924         boost::optional<samplecnt_t> available_capture_duration();
 925
 926         /* I/O bundles */
 927
 928         void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
 929         void remove_bundle (boost::shared_ptr<Bundle>);
 930         boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
 931
 932         PBD::Signal0<void> BundleAddedOrRemoved;
 933
 934         void midi_panic ();
 935
 936         /* History (for editors, mixers, UIs etc.) */
 937
 938         /** Undo some transactions.
 939          * @param n Number of transactions to undo.
 940          */
 941         void undo (uint32_t n);
 942         /** Redo some transactions.
 943          * @param n Number of transactions to undo.
 944          */
 945         void redo (uint32_t n);
 946
 947         UndoHistory& history() { return _history; }
 948
 949         uint32_t undo_depth() const { return _history.undo_depth(); }
 950         uint32_t redo_depth() const { return _history.redo_depth(); }
 951         std::string next_undo() const { return _history.next_undo(); }
 952         std::string next_redo() const { return _history.next_redo(); }
 953
 954         /** begin collecting undo information
 955          *
 956          * This call must always be followed by either
 957          * begin_reversible_command() or commit_reversible_command()
 958          *
 959          * @param cmd_name human readable name for the undo operation
 960          */
 961         void begin_reversible_command (const std::string& cmd_name);
 962         void begin_reversible_command (GQuark);
 963         /** abort an open undo command
 964          * This must only be called after begin_reversible_command ()
 965          */
 966         void abort_reversible_command ();
 967         /** finalize an undo command and commit pending transactions
 968          *
 969          * This must only be called after begin_reversible_command ()
 970          * @param cmd (additional) command to add
 971          */
 972         void commit_reversible_command (Command* cmd = 0);
 973
 974         void add_command (Command *const cmd);
 975
 976         /** create an StatefulDiffCommand from the given object and add it to the stack.
 977          *
 978          * This function must only be called after  begin_reversible_command.
 979          * Failing to do so may lead to a crash.
 980          *
 981          * @param sfd the object to diff
 982          * @returns the allocated StatefulDiffCommand (already added via add_command)
 983          */
 984         PBD::StatefulDiffCommand* add_stateful_diff_command (boost::shared_ptr<PBD::StatefulDestructible> sfd);
 985
 986         /** @return The list of operations that are currently in progress */
 987         std::list<GQuark> const & current_operations () {
 988                 return _current_trans_quarks;
 989         }
 990
 991         bool operation_in_progress (GQuark) const;
 992
 993         void add_commands (std::vector<Command*> const & cmds);
 994
 995         std::map<PBD::ID,PBD::StatefulDestructible*> registry;
 996
 997         // these commands are implemented in libs/ardour/session_command.cc
 998         Command* memento_command_factory(XMLNode* n);
 999         Command* stateful_diff_command_factory (XMLNode *);
1000         void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
1001
1002         /* clicking */
1003
1004         boost::shared_ptr<IO> click_io() { return _click_io; }
1005         boost::shared_ptr<Amp> click_gain() { return _click_gain; }
1006
1007         /* disk, buffer loads */
1008
1009         uint32_t playback_load ();
1010         uint32_t capture_load ();
1011
1012         /* ranges */
1013
1014         void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
1015         void request_cancel_play_range ();
1016         bool get_play_range () const { return _play_range; }
1017
1018         void maybe_update_session_range (samplepos_t, samplepos_t);
1019
1020         /* preroll */
1021         samplecnt_t preroll_samples (samplepos_t) const;
1022
1023         void request_preroll_record_trim (samplepos_t start, samplecnt_t preroll);
1024         void request_count_in_record ();
1025
1026         samplecnt_t preroll_record_trim_len () const { return _preroll_record_trim_len; }
1027
1028         /* temporary hacks to allow selection to be pushed from GUI into backend.
1029            Whenever we move the selection object into libardour, these will go away.
1030          */
1031         void set_range_selection (samplepos_t start, samplepos_t end);
1032         void set_object_selection (samplepos_t start, samplepos_t end);
1033         void clear_range_selection ();
1034         void clear_object_selection ();
1035
1036         /* buffers for gain and pan */
1037
1038         gain_t* gain_automation_buffer () const;
1039         gain_t* trim_automation_buffer () const;
1040         gain_t* send_gain_automation_buffer () const;
1041         gain_t* scratch_automation_buffer () const;
1042         pan_t** pan_automation_buffer () const;
1043
1044         void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
1045
1046         /* VST support */
1047
1048         static int  vst_current_loading_id;
1049         static const char* vst_can_do_strings[];
1050         static const int vst_can_do_string_count;
1051
1052         static intptr_t vst_callback (
1053                 AEffect* effect,
1054                 int32_t opcode,
1055                 int32_t index,
1056                 intptr_t value,
1057                 void* ptr,
1058                 float opt
1059                 );
1060
1061         static PBD::Signal0<void> SendFeedback;
1062
1063         /* Speakers */
1064
1065         boost::shared_ptr<Speakers> get_speakers ();
1066
1067         /* Controllables */
1068
1069         boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
1070
1071         boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
1072         boost::shared_ptr<AutomationControl> automation_control_by_id (const PBD::ID&);
1073
1074         void add_controllable (boost::shared_ptr<PBD::Controllable>);
1075         void remove_controllable (PBD::Controllable*);
1076
1077         boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
1078
1079         SessionConfiguration config;
1080
1081         SessionConfiguration* cfg () { return &config; }
1082
1083         bool exporting () const {
1084                 return _exporting;
1085         }
1086
1087         bool bounce_processing() const {
1088                 return _bounce_processing_active;
1089         }
1090
1091         /* this is a private enum, but setup_enum_writer() needs it,
1092            and i can't find a way to give that function
1093            friend access. sigh.
1094         */
1095
1096         enum PostTransportWork {
1097                 PostTransportStop               = 0x1,
1098                 PostTransportDuration           = 0x2,
1099                 PostTransportLocate             = 0x4,
1100                 PostTransportRoll               = 0x8,
1101                 PostTransportAbort              = 0x10,
1102                 PostTransportOverWrite          = 0x20,
1103                 /* was ... PostTransportSpeed              = 0x40, */
1104                 PostTransportAudition           = 0x80,
1105                 PostTransportReverse            = 0x100,
1106                 PostTransportInputChange        = 0x200,
1107                 PostTransportCurveRealloc       = 0x400,
1108                 PostTransportClearSubstate      = 0x800,
1109                 PostTransportAdjustPlaybackBuffering  = 0x1000,
1110                 PostTransportAdjustCaptureBuffering   = 0x2000
1111         };
1112
1113         boost::shared_ptr<SessionPlaylists> playlists;
1114
1115         void send_mmc_locate (samplepos_t);
1116         void queue_full_time_code () { _send_timecode_update = true; }
1117         void queue_song_position_pointer () { /* currently does nothing */ }
1118
1119         bool step_editing() const { return (_step_editors > 0); }
1120
1121         void request_suspend_timecode_transmission ();
1122         void request_resume_timecode_transmission ();
1123         bool timecode_transmission_suspended () const;
1124
1125         std::vector<std::string> source_search_path(DataType) const;
1126         void ensure_search_path_includes (const std::string& path, DataType type);
1127         void remove_dir_from_search_path (const std::string& path, DataType type);
1128
1129         std::list<std::string> unknown_processors () const;
1130
1131         /** Emitted when a feedback cycle has been detected within Ardour's signal
1132             processing path.  Until it is fixed (by the user) some (unspecified)
1133             routes will not be run.
1134         */
1135         static PBD::Signal0<void> FeedbackDetected;
1136
1137         /** Emitted when a graph sort has successfully completed, which means
1138             that it has no feedback cycles.
1139         */
1140         static PBD::Signal0<void> SuccessfulGraphSort;
1141
1142         /* handlers can return an integer value:
1143            0: config.set_audio_search_path() or config.set_midi_search_path() was used
1144            to modify the search path and we should try to find it again.
1145            1: quit entire session load
1146            2: as 0, but don't ask about other missing files
1147            3: don't ask about other missing files, and just mark this one missing
1148            -1: just mark this one missing
1149            any other value: as -1
1150         */
1151         static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1152
1153         void set_missing_file_replacement (const std::string& mfr) {
1154                 _missing_file_replacement = mfr;
1155         }
1156
1157         /** Emitted when the session wants Ardour to quit */
1158         static PBD::Signal0<void> Quit;
1159
1160         /** Emitted when Ardour is asked to load a session in an older session
1161          * format, and makes a backup copy.
1162          */
1163         static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1164
1165         SceneChanger* scene_changer() const { return _scene_changer; }
1166
1167         /* asynchronous MIDI control ports */
1168
1169         boost::shared_ptr<Port> midi_input_port () const;
1170         boost::shared_ptr<Port> midi_output_port () const;
1171         boost::shared_ptr<Port> mmc_output_port () const;
1172         boost::shared_ptr<Port> mmc_input_port () const;
1173         boost::shared_ptr<Port> scene_input_port () const;
1174         boost::shared_ptr<Port> scene_output_port () const;
1175
1176         /* synchronous MIDI ports used for synchronization */
1177
1178         boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1179         boost::shared_ptr<MidiPort> mtc_output_port () const;
1180         boost::shared_ptr<Port> ltc_output_port() const;
1181
1182         boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1183
1184         MIDI::MachineControl& mmc() { return *_mmc; }
1185
1186         void reconnect_midi_scene_ports (bool);
1187         void reconnect_mmc_ports (bool);
1188
1189         void reconnect_ltc_output ();
1190
1191         VCAManager& vca_manager() { return *_vca_manager; }
1192         VCAManager* vca_manager_ptr() { return _vca_manager; }
1193
1194         void auto_connect_thread_wakeup ();
1195
1196         double compute_speed_from_master (pframes_t nframes);
1197         bool   transport_master_is_external() const;
1198         boost::shared_ptr<TransportMaster> transport_master() const;
1199
1200 protected:
1201         friend class AudioEngine;
1202         void set_block_size (pframes_t nframes);
1203         void set_sample_rate (samplecnt_t nframes);
1204 #ifdef USE_TRACKS_CODE_FEATURES
1205         void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1206 #endif
1207
1208         friend class Route;
1209         void schedule_curve_reallocation ();
1210         void update_latency_compensation (bool force = false);
1211
1212 private:
1213         int  create (const std::string& mix_template, BusProfile*);
1214         void destroy ();
1215
1216         static guint _name_id_counter;
1217         static void init_name_id_counter (guint n);
1218         static unsigned int name_id_counter ();
1219
1220         /* stuff used in process() should be close together to
1221            maximise cache hits
1222         */
1223
1224         typedef void (Session::*process_function_type)(pframes_t);
1225
1226         AudioEngine&            _engine;
1227         mutable gint             processing_prohibited;
1228         process_function_type    process_function;
1229         process_function_type    last_process_function;
1230         bool                    _bounce_processing_active;
1231         bool                     waiting_for_sync_offset;
1232         samplecnt_t              _base_sample_rate;     // sample-rate of the session at creation time, "native" SR
1233         samplecnt_t             _nominal_sample_rate;  // overridden by audioengine setting
1234         samplecnt_t             _current_sample_rate;  // this includes video pullup offset
1235         int                      transport_sub_state;
1236         mutable gint            _record_status;
1237         samplepos_t             _transport_sample;
1238         gint                    _seek_counter;
1239         Location*               _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1240         bool                    _session_range_end_is_free;
1241         bool                    _silent;
1242         samplecnt_t             _remaining_latency_preroll;
1243
1244         // varispeed playback -- TODO: move out of session to backend.
1245         double                  _engine_speed;
1246         double                  _transport_speed; // only: -1, 0, +1
1247         double                  _default_transport_speed;
1248         double                  _last_transport_speed;
1249         double                  _signalled_varispeed;
1250         double                  _target_transport_speed;
1251
1252         bool                     auto_play_legal;
1253         samplepos_t             _requested_return_sample;
1254         pframes_t                current_block_size;
1255         samplecnt_t             _worst_output_latency;
1256         samplecnt_t             _worst_input_latency;
1257         samplecnt_t             _worst_route_latency;
1258         uint32_t                _send_latency_changes;
1259         bool                    _have_captured;
1260         bool                    _non_soloed_outs_muted;
1261         bool                    _listening;
1262         uint32_t                _listen_cnt;
1263         uint32_t                _solo_isolated_cnt;
1264         bool                    _writable;
1265         bool                    _was_seamless;
1266         bool                    _under_nsm_control;
1267         unsigned int            _xrun_count;
1268
1269         std::string             _missing_file_replacement;
1270
1271         void initialize_latencies ();
1272         void update_latency (bool playback);
1273         bool update_route_latency (bool reverse, bool apply_to_delayline);
1274
1275         void set_worst_io_latencies ();
1276         void set_worst_output_latency ();
1277         void set_worst_input_latency ();
1278
1279         void send_latency_compensation_change ();
1280         void set_worst_io_latencies_x (IOChange, void *);
1281
1282         void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1283
1284         void process_scrub          (pframes_t);
1285         void process_without_events (pframes_t);
1286         void process_with_events    (pframes_t);
1287         void process_audition       (pframes_t);
1288         void process_export         (pframes_t);
1289         void process_export_fw      (pframes_t);
1290
1291         void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1292         void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1293         bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1294
1295         static const samplecnt_t bounce_chunk_size;
1296
1297         /* Transport master DLL */
1298
1299         enum TransportMasterState {
1300                 Stopped, /* no incoming or invalid signal/data for master to run with */
1301                 Waiting, /* waiting to get full lock on incoming signal/data */
1302                 Running  /* lock achieved, master is generating meaningful speed & position */
1303         };
1304
1305         TransportMasterState transport_master_tracking_state;
1306         samplepos_t master_wait_end;
1307         void track_transport_master (float slave_speed, samplepos_t slave_transport_sample);
1308         bool follow_transport_master (pframes_t nframes);
1309
1310         void sync_source_changed (SyncSource, samplepos_t pos, pframes_t cycle_nframes);
1311         void reset_slave_state ();
1312
1313         bool post_export_sync;
1314         samplepos_t post_export_position;
1315
1316         bool _exporting;
1317         bool _export_rolling;
1318         bool _realtime_export;
1319         bool _region_export;
1320         samplepos_t _export_preroll;
1321
1322         boost::shared_ptr<ExportHandler> export_handler;
1323         boost::shared_ptr<ExportStatus>  export_status;
1324
1325         int  pre_export ();
1326         int  stop_audio_export ();
1327         void finalize_audio_export ();
1328         void finalize_export_internal (bool stop_freewheel);
1329         bool _pre_export_mmc_enabled;
1330
1331         PBD::ScopedConnection export_freewheel_connection;
1332
1333         void get_track_statistics ();
1334         int  process_routes (pframes_t, bool& need_butler);
1335         int  silent_process_routes (pframes_t, bool& need_butler);
1336
1337         /** @return 1 if there is a pending declick fade-in,
1338             -1 if there is a pending declick fade-out,
1339             0 if there is no pending declick.
1340         */
1341         bool maybe_stop (samplepos_t limit);
1342         bool maybe_sync_start (pframes_t &);
1343
1344         std::string             _path;
1345         std::string             _name;
1346         bool                    _is_new;
1347         bool                    _send_qf_mtc;
1348         /** Number of process samples since the last MTC output (when sending MTC); used to
1349          *  know when to send full MTC messages every so often.
1350          */
1351         pframes_t               _pframes_since_last_mtc;
1352         bool                     play_loop;
1353         bool                     loop_changing;
1354         samplepos_t               last_loopend;
1355
1356         boost::scoped_ptr<SessionDirectory> _session_dir;
1357
1358         void hookup_io ();
1359         void graph_reordered ();
1360
1361         /** current snapshot name, without the .ardour suffix */
1362         void set_snapshot_name (const std::string &);
1363         void save_snapshot_name (const std::string &);
1364         std::string _current_snapshot_name;
1365
1366         XMLTree*         state_tree;
1367         bool             state_was_pending;
1368         StateOfTheState _state_of_the_state;
1369
1370         friend class    StateProtector;
1371         gint            _suspend_save; /* atomic */
1372         volatile bool   _save_queued;
1373         Glib::Threads::Mutex save_state_lock;
1374         Glib::Threads::Mutex save_source_lock;
1375         Glib::Threads::Mutex peak_cleanup_lock;
1376
1377         int        load_options (const XMLNode&);
1378         int        load_state (std::string snapshot_name);
1379         static int parse_stateful_loading_version (const std::string&);
1380
1381         samplepos_t _last_roll_location;
1382         /** the session sample time at which we last rolled, located, or changed transport direction */
1383         samplepos_t _last_roll_or_reversal_location;
1384         samplepos_t _last_record_location;
1385
1386         bool              pending_abort;
1387         bool              pending_auto_loop;
1388
1389         PBD::ReallocPool _mempool;
1390         LuaState lua;
1391         Glib::Threads::Mutex lua_lock;
1392         luabridge::LuaRef * _lua_run;
1393         luabridge::LuaRef * _lua_add;
1394         luabridge::LuaRef * _lua_del;
1395         luabridge::LuaRef * _lua_list;
1396         luabridge::LuaRef * _lua_load;
1397         luabridge::LuaRef * _lua_save;
1398         luabridge::LuaRef * _lua_cleanup;
1399         uint32_t            _n_lua_scripts;
1400
1401         void setup_lua ();
1402         void try_run_lua (pframes_t);
1403
1404         Butler* _butler;
1405
1406         static const PostTransportWork ProcessCannotProceedMask =
1407                 PostTransportWork (
1408                         PostTransportInputChange|
1409                         PostTransportReverse|
1410                         PostTransportCurveRealloc|
1411                         PostTransportAudition|
1412                         PostTransportStop|
1413                         PostTransportClearSubstate);
1414
1415         gint _post_transport_work; /* accessed only atomic ops */
1416         PostTransportWork post_transport_work() const        { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1417         void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1418         void add_post_transport_work (PostTransportWork ptw);
1419
1420         void schedule_playback_buffering_adjustment ();
1421         void schedule_capture_buffering_adjustment ();
1422
1423         uint32_t    cumulative_rf_motion;
1424         uint32_t    rf_scale;
1425
1426         void set_rf_speed (float speed);
1427         void reset_rf_scale (samplecnt_t samples_moved);
1428
1429         Locations*       _locations;
1430         void location_added (Location*);
1431         void location_removed (Location*);
1432         void locations_changed ();
1433         void _locations_changed (const Locations::LocationList&);
1434
1435         void update_skips (Location*, bool consolidate);
1436         void update_marks (Location* loc);
1437         void consolidate_skips (Location*);
1438         void sync_locations_to_skips ();
1439         void _sync_locations_to_skips ();
1440
1441         PBD::ScopedConnectionList skip_update_connections;
1442         bool _ignore_skips_updates;
1443
1444         PBD::ScopedConnectionList punch_connections;
1445         void             auto_punch_start_changed (Location *);
1446         void             auto_punch_end_changed (Location *);
1447         void             auto_punch_changed (Location *);
1448
1449         PBD::ScopedConnectionList loop_connections;
1450         void             auto_loop_changed (Location *);
1451         void             auto_loop_declick_range (Location *, samplepos_t &, samplepos_t &);
1452
1453         int  ensure_engine (uint32_t desired_sample_rate, bool);
1454         void pre_engine_init (std::string path);
1455         int  post_engine_init ();
1456         int  immediately_post_engine ();
1457         void remove_empty_sounds ();
1458
1459         void session_loaded ();
1460
1461         void setup_midi_control ();
1462         int  midi_read (MIDI::Port *);
1463
1464         void enable_record ();
1465
1466         void increment_transport_position (samplecnt_t val) {
1467                 if (max_samplepos - val < _transport_sample) {
1468                         _transport_sample = max_samplepos;
1469                 } else {
1470                         _transport_sample += val;
1471                 }
1472         }
1473
1474         void decrement_transport_position (samplecnt_t val) {
1475                 if (val < _transport_sample) {
1476                         _transport_sample -= val;
1477                 } else {
1478                         _transport_sample = 0;
1479                 }
1480         }
1481
1482         void post_transport_motion ();
1483         static void *session_loader_thread (void *arg);
1484
1485         void *do_work();
1486
1487         /* Signal Forwarding */
1488         void emit_route_signals ();
1489         void emit_thread_run ();
1490         static void *emit_thread (void *);
1491         void emit_thread_start ();
1492         void emit_thread_terminate ();
1493
1494         pthread_t       _rt_emit_thread;
1495         bool            _rt_thread_active;
1496
1497         pthread_mutex_t _rt_emit_mutex;
1498         pthread_cond_t  _rt_emit_cond;
1499         bool            _rt_emit_pending;
1500
1501         /* Auto Connect Thread */
1502         static void *auto_connect_thread (void *);
1503         void auto_connect_thread_run ();
1504         void auto_connect_thread_start ();
1505         void auto_connect_thread_terminate ();
1506
1507         pthread_t       _auto_connect_thread;
1508         gint            _ac_thread_active;
1509         pthread_mutex_t _auto_connect_mutex;
1510         pthread_cond_t  _auto_connect_cond;
1511
1512         struct AutoConnectRequest {
1513                 public:
1514                 AutoConnectRequest (boost::shared_ptr <Route> r, bool ci,
1515                                 const ChanCount& is,
1516                                 const ChanCount& os,
1517                                 const ChanCount& io,
1518                                 const ChanCount& oo)
1519                         : route (boost::weak_ptr<Route> (r))
1520                         , connect_inputs (ci)
1521                         , input_start (is)
1522                         , output_start (os)
1523                         , input_offset (io)
1524                         , output_offset (oo)
1525                 {}
1526
1527                 boost::weak_ptr <Route> route;
1528                 bool connect_inputs;
1529                 ChanCount input_start;
1530                 ChanCount output_start;
1531                 ChanCount input_offset;
1532                 ChanCount output_offset;
1533         };
1534
1535         typedef std::queue<AutoConnectRequest> AutoConnectQueue;
1536         Glib::Threads::Mutex  _auto_connect_queue_lock;
1537         AutoConnectQueue _auto_connect_queue;
1538         guint _latency_recompute_pending;
1539
1540         void get_physical_ports (std::vector<std::string>& inputs, std::vector<std::string>& outputs, DataType type,
1541                                  MidiPortFlags include = MidiPortFlags (0),
1542                                  MidiPortFlags exclude = MidiPortFlags (0));
1543
1544         void auto_connect (const AutoConnectRequest&);
1545         void queue_latency_recompute ();
1546
1547         /* SessionEventManager interface */
1548
1549         void process_event (SessionEvent*);
1550         void set_next_event ();
1551         void cleanup_event (SessionEvent*,int);
1552
1553         /* MIDI Machine Control */
1554
1555         void spp_start ();
1556         void spp_continue ();
1557         void spp_stop ();
1558
1559         void mmc_deferred_play (MIDI::MachineControl &);
1560         void mmc_stop (MIDI::MachineControl &);
1561         void mmc_step (MIDI::MachineControl &, int);
1562         void mmc_pause (MIDI::MachineControl &);
1563         void mmc_record_pause (MIDI::MachineControl &);
1564         void mmc_record_strobe (MIDI::MachineControl &);
1565         void mmc_record_exit (MIDI::MachineControl &);
1566         void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1567         void mmc_fast_forward (MIDI::MachineControl &);
1568         void mmc_rewind (MIDI::MachineControl &);
1569         void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1570         void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1571         void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1572
1573         struct timeval last_mmc_step;
1574         double step_speed;
1575
1576         typedef boost::function<bool()> MidiTimeoutCallback;
1577         typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1578
1579         MidiTimeoutList midi_timeouts;
1580         bool mmc_step_timeout ();
1581         void send_immediate_mmc (MIDI::MachineControlCommand);
1582
1583         MIDI::byte mtc_msg[16];
1584         MIDI::byte mtc_timecode_bits;   /* encoding of SMTPE type for MTC */
1585         MIDI::byte midi_msg[16];
1586         double outbound_mtc_timecode_frame;
1587         Timecode::Time transmitting_timecode_time;
1588         int next_quarter_frame_to_send;
1589
1590         double _samples_per_timecode_frame; /* has to be floating point because of drop sample */
1591         samplecnt_t _frames_per_hour;
1592         samplecnt_t _timecode_frames_per_hour;
1593
1594         /* cache the most-recently requested time conversions. This helps when we
1595          * have multiple clocks showing the same time (e.g. the transport sample) */
1596         bool last_timecode_valid;
1597         samplepos_t last_timecode_when;
1598         Timecode::Time last_timecode;
1599
1600         bool _send_timecode_update; ///< Flag to send a full sample (Timecode) MTC message this cycle
1601
1602         int send_midi_time_code_for_cycle (samplepos_t, samplepos_t, pframes_t nframes);
1603
1604         LTCEncoder*       ltc_encoder;
1605         ltcsnd_sample_t*  ltc_enc_buf;
1606
1607         Timecode::TimecodeFormat ltc_enc_tcformat;
1608         int32_t           ltc_buf_off;
1609         int32_t           ltc_buf_len;
1610
1611         double            ltc_speed;
1612         int32_t           ltc_enc_byte;
1613         samplepos_t        ltc_enc_pos;
1614         double            ltc_enc_cnt;
1615         samplepos_t        ltc_enc_off;
1616         bool              restarting;
1617         samplepos_t        ltc_prev_cycle;
1618
1619         samplepos_t        ltc_timecode_offset;
1620         bool              ltc_timecode_negative_offset;
1621
1622         LatencyRange      ltc_out_latency;
1623
1624         void ltc_tx_initialize();
1625         void ltc_tx_cleanup();
1626         void ltc_tx_reset();
1627         void ltc_tx_resync_latency();
1628         void ltc_tx_recalculate_position();
1629         void ltc_tx_parse_offset();
1630         void ltc_tx_send_time_code_for_cycle (samplepos_t, samplepos_t, double, double, pframes_t nframes);
1631         PBD::ScopedConnectionList ltc_tx_connections;
1632
1633
1634         void reset_record_status ();
1635
1636         int no_roll (pframes_t nframes);
1637         int fail_roll (pframes_t nframes);
1638
1639         bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1640         bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1641
1642         MidiControlUI* midi_control_ui;
1643
1644         int           start_midi_thread ();
1645
1646         bool should_ignore_transport_request (TransportRequestSource, TransportRequestType) const;
1647
1648         void set_play_loop (bool yn, double speed);
1649         void unset_play_loop ();
1650         void overwrite_some_buffers (Track *);
1651         void flush_all_inserts ();
1652         int  micro_locate (samplecnt_t distance);
1653         void locate (samplepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1654         void start_locate (samplepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1655         void force_locate (samplepos_t sample, bool with_roll = false);
1656         void set_transport_speed (double speed, samplepos_t destination_sample, bool abort = false, bool clear_state = false, bool as_default = false);
1657         void stop_transport (bool abort = false, bool clear_state = false);
1658         void start_transport ();
1659         void realtime_stop (bool abort, bool clear_state);
1660         void realtime_locate ();
1661         void non_realtime_start_scrub ();
1662         void non_realtime_set_speed ();
1663         void non_realtime_locate ();
1664         void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1665         void non_realtime_overwrite (int entry_request_count, bool& finished);
1666         void post_transport ();
1667         void engine_halted ();
1668         void xrun_recovery ();
1669         void set_track_loop (bool);
1670         bool select_playhead_priority_target (samplepos_t&);
1671         void follow_playhead_priority ();
1672
1673         /* These are synchronous and so can only be called from within the process
1674          * cycle
1675          */
1676
1677         int  send_full_time_code (samplepos_t, pframes_t nframes);
1678         void send_song_position_pointer (samplepos_t);
1679
1680         TempoMap    *_tempo_map;
1681         void          tempo_map_changed (const PBD::PropertyChange&);
1682
1683         /* edit/mix groups */
1684
1685         int load_route_groups (const XMLNode&, int);
1686
1687         std::list<RouteGroup *> _route_groups;
1688         RouteGroup*             _all_route_group;
1689
1690         /* routes stuff */
1691
1692         boost::shared_ptr<Graph> _process_graph;
1693
1694         SerializedRCUManager<RouteList>  routes;
1695
1696         void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t);
1697         void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t);
1698         bool _adding_routes_in_progress;
1699         bool _reconnecting_routes_in_progress;
1700         bool _route_deletion_in_progress;
1701
1702         uint32_t destructive_index;
1703
1704         boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1705         boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1706         boost::shared_ptr<Route> XMLRouteFactory_3X (const XMLNode&, int);
1707
1708         void route_processors_changed (RouteProcessorChange);
1709
1710         bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1711         void count_existing_track_channels (ChanCount& in, ChanCount& out);
1712         void auto_connect_route (boost::shared_ptr<Route>, bool, const ChanCount&, const ChanCount&, const ChanCount& io = ChanCount(), const ChanCount& oo = ChanCount());
1713         void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1714
1715         /* track numbering */
1716
1717         void reassign_track_numbers ();
1718         uint32_t _track_number_decimals;
1719
1720         /* solo/mute/notifications */
1721
1722         void route_listen_changed (PBD::Controllable::GroupControlDisposition, boost::weak_ptr<Route>);
1723         void route_mute_changed ();
1724         void route_solo_changed (bool self_solo_change, PBD::Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route>);
1725         void route_solo_isolated_changed (boost::weak_ptr<Route>);
1726
1727         void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1728
1729         void listen_position_changed ();
1730         void solo_control_mode_changed ();
1731
1732         /* REGION MANAGEMENT */
1733
1734         mutable Glib::Threads::Mutex region_lock;
1735
1736         int load_regions (const XMLNode& node);
1737         int load_compounds (const XMLNode& node);
1738
1739         void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1740         void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1741         void route_group_property_changed (RouteGroup *);
1742
1743         /* SOURCES */
1744
1745         mutable Glib::Threads::Mutex source_lock;
1746
1747 public:
1748         typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1749
1750 private:
1751         void reset_write_sources (bool mark_write_complete, bool force = false);
1752         SourceMap sources;
1753
1754         int load_sources (const XMLNode& node);
1755         XMLNode& get_sources_as_xml ();
1756
1757         boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1758
1759         /* PLAYLISTS */
1760
1761         void remove_playlist (boost::weak_ptr<Playlist>);
1762         void track_playlist_changed (boost::weak_ptr<Track>);
1763         void playlist_region_added (boost::weak_ptr<Region>);
1764         void playlist_ranges_moved (std::list<Evoral::RangeMove<samplepos_t> > const &);
1765         void playlist_regions_extended (std::list<Evoral::Range<samplepos_t> > const &);
1766
1767         /* CURVES and AUTOMATION LISTS */
1768         std::map<PBD::ID, AutomationList*> automation_lists;
1769
1770         /* DEFAULT FADE CURVES */
1771
1772         float default_fade_steepness;
1773         float default_fade_msecs;
1774
1775         /* AUDITIONING */
1776
1777         boost::shared_ptr<Auditioner> auditioner;
1778         void set_audition (boost::shared_ptr<Region>);
1779         void non_realtime_set_audition ();
1780         boost::shared_ptr<Region> pending_audition_region;
1781
1782         /* EXPORT */
1783
1784         /* FLATTEN */
1785
1786         int flatten_one_track (AudioTrack&, samplepos_t start, samplecnt_t cnt);
1787
1788         /* INSERT AND SEND MANAGEMENT */
1789
1790         boost::dynamic_bitset<uint32_t> send_bitset;
1791         boost::dynamic_bitset<uint32_t> aux_send_bitset;
1792         boost::dynamic_bitset<uint32_t> return_bitset;
1793         boost::dynamic_bitset<uint32_t> insert_bitset;
1794
1795         /* S/W RAID */
1796
1797         struct space_and_path {
1798                 uint32_t blocks;     ///< 4kB blocks
1799                 bool blocks_unknown; ///< true if blocks is unknown
1800                 std::string path;
1801
1802                 space_and_path ()
1803                         : blocks (0)
1804                         , blocks_unknown (true)
1805                 {}
1806         };
1807
1808         struct space_and_path_ascending_cmp {
1809                 bool operator() (space_and_path a, space_and_path b) {
1810                         if (a.blocks_unknown != b.blocks_unknown) {
1811                                 return !a.blocks_unknown;
1812                         }
1813                         return a.blocks > b.blocks;
1814                 }
1815         };
1816
1817         void setup_raid_path (std::string path);
1818
1819         std::vector<space_and_path> session_dirs;
1820         std::vector<space_and_path>::iterator last_rr_session_dir;
1821         uint32_t _total_free_4k_blocks;
1822         /** If this is true, _total_free_4k_blocks is not definite,
1823             as one or more of the session directories' filesystems
1824             could not report free space.
1825         */
1826         bool _total_free_4k_blocks_uncertain;
1827         Glib::Threads::Mutex space_lock;
1828
1829         bool no_questions_about_missing_files;
1830
1831         std::string get_best_session_directory_for_new_audio ();
1832
1833         mutable gint _playback_load;
1834         mutable gint _capture_load;
1835
1836         /* I/O bundles */
1837
1838         SerializedRCUManager<BundleList> _bundles;
1839         XMLNode* _bundle_xml_node;
1840         int load_bundles (XMLNode const &);
1841
1842         UndoHistory      _history;
1843         /** current undo transaction, or 0 */
1844         UndoTransaction* _current_trans;
1845         /** GQuarks to describe the reversible commands that are currently in progress.
1846          *  These may be nested, in which case more recently-started commands are toward
1847          *  the front of the list.
1848          */
1849         std::list<GQuark> _current_trans_quarks;
1850
1851         int  backend_sync_callback (TransportState, samplepos_t);
1852
1853         void process_rtop (SessionEvent*);
1854
1855         enum snapshot_t {
1856                 NormalSave,
1857                 SnapshotKeep,
1858                 SwitchToSnapshot
1859         };
1860
1861         XMLNode& state (bool save_template,
1862                         snapshot_t snapshot_type = NormalSave,
1863                         bool only_used_assets = false);
1864
1865         XMLNode& get_state ();
1866         int      set_state (const XMLNode& node, int version); // not idempotent
1867         XMLNode& get_template ();
1868
1869         /* click track */
1870         typedef std::list<Click*> Clicks;
1871         Clicks                  clicks;
1872         bool                   _clicking;
1873         bool                   _click_rec_only;
1874         boost::shared_ptr<IO>  _click_io;
1875         boost::shared_ptr<Amp> _click_gain;
1876         Sample*                 click_data;
1877         Sample*                 click_emphasis_data;
1878         samplecnt_t              click_length;
1879         samplecnt_t              click_emphasis_length;
1880         mutable Glib::Threads::RWLock    click_lock;
1881
1882         static const Sample     default_click[];
1883         static const samplecnt_t default_click_length;
1884         static const Sample     default_click_emphasis[];
1885         static const samplecnt_t default_click_emphasis_length;
1886
1887         Click *get_click();
1888         samplepos_t _clicks_cleared;
1889         void   setup_click_sounds (int which);
1890         void   setup_click_sounds (Sample**, Sample const *, samplecnt_t*, samplecnt_t, std::string const &);
1891         void   clear_clicks ();
1892         void   click (samplepos_t start, samplecnt_t nframes);
1893         void   run_click (samplepos_t start, samplecnt_t nframes);
1894         void   add_click (samplepos_t pos, bool emphasis);
1895         samplecnt_t _count_in_samples;
1896
1897         /* range playback */
1898
1899         std::list<AudioRange> current_audio_range;
1900         bool _play_range;
1901         void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1902         void unset_play_range ();
1903
1904         /* temporary hacks to allow selection to be pushed from GUI into backend
1905            Whenever we move the selection object into libardour, these will go away.
1906         */
1907         Evoral::Range<samplepos_t> _range_selection;
1908         Evoral::Range<samplepos_t> _object_selection;
1909
1910         void unset_preroll_record_trim ();
1911
1912         samplecnt_t _preroll_record_trim_len;
1913         bool _count_in_once;
1914
1915         /* main outs */
1916         uint32_t main_outs;
1917
1918         boost::shared_ptr<Route> _master_out;
1919         boost::shared_ptr<Route> _monitor_out;
1920
1921         void auto_connect_master_bus ();
1922
1923         int find_all_sources (std::string path, std::set<std::string>& result);
1924         int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1925
1926         typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1927         Glib::Threads::Mutex controllables_lock;
1928         Controllables controllables;
1929
1930         boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1931
1932         void reset_native_file_format();
1933         bool first_file_data_format_reset;
1934         bool first_file_header_format_reset;
1935
1936         void config_changed (std::string, bool);
1937
1938         XMLNode& get_control_protocol_state ();
1939
1940         void set_history_depth (uint32_t depth);
1941
1942         static bool _disable_all_loaded_plugins;
1943         static bool _bypass_all_loaded_plugins;
1944
1945         mutable bool have_looped; ///< Used in ::audible_sample(*)
1946
1947         void update_route_record_state ();
1948         gint _have_rec_enabled_track;
1949         gint _have_rec_disabled_track;
1950
1951         static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1952
1953         /* realtime "apply to set of routes" operations */
1954         template<typename T> SessionEvent*
1955                 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1956                               void (Session::*method) (boost::shared_ptr<RouteList>, T, PBD::Controllable::GroupControlDisposition)) {
1957                 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1958                 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1959                 ev->rt_return = after;
1960                 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1961
1962                 return ev;
1963         }
1964
1965         /* specialized version realtime "apply to set of routes" operations */
1966         template<typename T1, typename T2> SessionEvent*
1967                 get_rt_event (boost::shared_ptr<RouteList> rl, T1 t1arg, T2 t2arg, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1968                               void (Session::*method) (boost::shared_ptr<RouteList>, T1, T2, PBD::Controllable::GroupControlDisposition)) {
1969                 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1970                 ev->rt_slot = boost::bind (method, this, rl, t1arg, t2arg, group_override);
1971                 ev->rt_return = after;
1972                 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1973
1974                 return ev;
1975         }
1976
1977         /* specialized version realtime "apply to set of controls" operations */
1978         SessionEvent* get_rt_event (boost::shared_ptr<ControlList> cl, double arg, PBD::Controllable::GroupControlDisposition group_override) {
1979                 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1980                 ev->rt_slot = boost::bind (&Session::rt_set_controls, this, cl, arg, group_override);
1981                 ev->rt_return = Session::rt_cleanup;
1982                 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1983
1984                 return ev;
1985         }
1986
1987         void rt_set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition group_override);
1988         void rt_clear_all_solo_state (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1989
1990         void set_session_range_location (samplepos_t, samplepos_t);
1991
1992         void setup_midi_machine_control ();
1993
1994         void step_edit_status_change (bool);
1995         uint32_t _step_editors;
1996
1997         /** true if timecode transmission by the transport is suspended, otherwise false */
1998         mutable gint _suspend_timecode_transmission;
1999
2000         void update_locations_after_tempo_map_change (const Locations::LocationList &);
2001
2002         void start_time_changed (samplepos_t);
2003         void end_time_changed (samplepos_t);
2004
2005         void set_track_monitor_input_status (bool);
2006         samplepos_t compute_stop_limit () const;
2007
2008         boost::shared_ptr<Speakers> _speakers;
2009         void load_nested_sources (const XMLNode& node);
2010
2011         /** The directed graph of routes that is currently being used for audio processing
2012             and solo/mute computations.
2013         */
2014         GraphEdges _current_route_graph;
2015
2016         void ensure_route_presentation_info_gap (PresentationInfo::order_t, uint32_t gap_size);
2017
2018         friend class    ProcessorChangeBlocker;
2019         gint            _ignore_route_processor_changes; /* atomic */
2020
2021         MidiClockTicker* midi_clock;
2022
2023         boost::shared_ptr<IO>   _ltc_output;
2024
2025         boost::shared_ptr<RTTaskList> _rt_tasklist;
2026
2027         /* Scene Changing */
2028         SceneChanger* _scene_changer;
2029
2030         /* persistent, non-track related MIDI ports */
2031         MidiPortManager* _midi_ports;
2032         MIDI::MachineControl* _mmc;
2033
2034         void setup_ltc ();
2035         void setup_click ();
2036         void setup_click_state (const XMLNode*);
2037         void setup_bundles ();
2038
2039         void save_as_bring_callback (uint32_t, uint32_t, std::string);
2040
2041         static const uint32_t session_end_shift;
2042
2043         std::string _template_state_dir;
2044
2045         VCAManager* _vca_manager;
2046
2047         boost::shared_ptr<Route> get_midi_nth_route_by_id (PresentationInfo::order_t n) const;
2048
2049         std::string created_with;
2050
2051         void midi_track_presentation_info_changed (PBD::PropertyChange const &, boost::weak_ptr<MidiTrack>);
2052         void rewire_selected_midi (boost::shared_ptr<MidiTrack>);
2053         void rewire_midi_selection_ports ();
2054         boost::weak_ptr<MidiTrack> current_midi_target;
2055
2056         StripableList _soloSelection;  //the items that are soloe'd during a solo-selection operation; need to unsolo after the roll
2057
2058         CoreSelection* _selection;
2059
2060         bool _global_locate_pending;
2061 };
2062
2063
2064 } // namespace ARDOUR
2065
2066 #endif /* __ardour_session_h__ */