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