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