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