libs/ardour/ardour/session.h

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