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