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