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