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