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