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