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