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