libs/ardour/ardour/session.h

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