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