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