libs/ardour/ardour/session.h

   1 /*
   2   Copyright (C) 2000 Paul Davis
   3
   4   This program is free software; you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation; either version 2 of the License, or
   7   (at your option) any later version.
   8
   9   This program is distributed in the hope that it will be useful,
  10   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12   GNU General Public License for more details.
  13
  14   You should have received a copy of the GNU General Public License
  15   along with this program; if not, write to the Free Software
  16   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_session_h__
  21 #define __ardour_session_h__
  22
  23 #include "libardour-config.h"
  24
  25 #include <exception>
  26 #include <list>
  27 #include <map>
  28 #include <set>
  29 #include <string>
  30 #include <vector>
  31 #include <queue>
  32 #include <stdint.h>
  33
  34 #include <boost/dynamic_bitset.hpp>
  35 #include <boost/scoped_ptr.hpp>
  36 #include <boost/weak_ptr.hpp>
  37 #include <boost/utility.hpp>
  38
  39 #include <glibmm/threads.h>
  40
  41 #include <ltc.h>
  42
  43 #include "pbd/error.h"
  44 #include "pbd/event_loop.h"
  45 #include "pbd/rcu.h"
  46 #include "pbd/reallocpool.h"
  47 #include "pbd/statefuldestructible.h"
  48 #include "pbd/signals.h"
  49 #include "pbd/undo.h"
  50
  51 #include "lua/luastate.h"
  52
  53 #include "evoral/Range.hpp"
  54
  55 #include "midi++/types.h"
  56 #include "midi++/mmc.h"
  57
  58 #include "timecode/time.h"
  59
  60 #include "ardour/ardour.h"
  61 #include "ardour/chan_count.h"
  62 #include "ardour/delivery.h"
  63 #include "ardour/interthread_info.h"
  64 #include "ardour/luascripting.h"
  65 #include "ardour/location.h"
  66 #include "ardour/monitor_processor.h"
  67 #include "ardour/presentation_info.h"
  68 #include "ardour/rc_configuration.h"
  69 #include "ardour/session_configuration.h"
  70 #include "ardour/session_event.h"
  71 #include "ardour/interpolation.h"
  72 #include "ardour/plugin.h"
  73 #include "ardour/presentation_info.h"
  74 #include "ardour/route.h"
  75 #include "ardour/route_graph.h"
  76
  77
  78 class XMLTree;
  79 class XMLNode;
  80 struct _AEffect;
  81 typedef struct _AEffect AEffect;
  82
  83 namespace MIDI {
  84 class Port;
  85 class MachineControl;
  86 class Parser;
  87 }
  88
  89 namespace PBD {
  90 class Controllable;
  91 }
  92
  93 namespace luabridge {
  94         class LuaRef;
  95 }
  96
  97 namespace Evoral {
  98 class Curve;
  99 }
 100
 101 namespace ARDOUR {
 102
 103 class Amp;
 104 class AudioEngine;
 105 class AudioFileSource;
 106 class AudioRegion;
 107 class AudioSource;
 108 class AudioTrack;
 109 class Auditioner;
 110 class AutomationList;
 111 class AuxInput;
 112 class BufferSet;
 113 class Bundle;
 114 class Butler;
 115 class Click;
 116 class ControllableDescriptor;
 117 class CoreSelection;
 118 class Diskstream;
 119 class ExportHandler;
 120 class ExportStatus;
 121 class Graph;
 122 class IO;
 123 class IOProcessor;
 124 class ImportStatus;
 125 class MidiClockTicker;
 126 class MidiControlUI;
 127 class MidiPortManager;
 128 class MidiPort;
 129 class MidiRegion;
 130 class MidiSource;
 131 class MidiTrack;
 132 class Playlist;
 133 class PluginInsert;
 134 class PluginInfo;
 135 class Port;
 136 class PortInsert;
 137 class ProcessThread;
 138 class Progress;
 139 class Processor;
 140 class Region;
 141 class Return;
 142 class Route;
 143 class RouteGroup;
 144 class SMFSource;
 145 class Send;
 146 class SceneChanger;
 147 class SessionDirectory;
 148 class SessionMetadata;
 149 class SessionPlaylists;
 150 class Slave;
 151 class Source;
 152 class Speakers;
 153 class TempoMap;
 154 class Track;
 155 class VCAManager;
 156 class WindowsVSTPlugin;
 157
 158 extern void setup_enum_writer ();
 159
 160 class LIBARDOUR_API SessionException: public std::exception {
 161 public:
 162         explicit SessionException(const std::string msg) : _message(msg) {}
 163         virtual ~SessionException() throw() {}
 164
 165         virtual const char* what() const throw() { return _message.c_str(); }
 166
 167 private:
 168         std::string _message;
 169 };
 170
 171 /** Ardour Session */
 172 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
 173 {
 174   private:
 175         enum SubState {
 176                 PendingDeclickIn      = 0x1,  ///< pending de-click fade-in for start
 177                 PendingDeclickOut     = 0x2,  ///< pending de-click fade-out for stop
 178                 StopPendingCapture    = 0x4,
 179                 PendingLoopDeclickIn  = 0x8,  ///< pending de-click fade-in at the start of a loop
 180                 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
 181                 PendingLocate         = 0x20,
 182         };
 183
 184   public:
 185         enum RecordState {
 186                 Disabled = 0,
 187                 Enabled = 1,
 188                 Recording = 2
 189         };
 190
 191         /* a new session might have non-empty mix_template, an existing session should always have an empty one.
 192            the bus profile can be null if no master out bus is required.
 193         */
 194
 195         Session (AudioEngine&,
 196                  const std::string& fullpath,
 197                  const std::string& snapshot_name,
 198                  BusProfile* bus_profile = 0,
 199                  std::string mix_template = "");
 200
 201         virtual ~Session ();
 202
 203         static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format, std::string& program_version);
 204         static std::string get_snapshot_from_instant (const std::string& session_dir);
 205
 206         /** a monotonic counter used for naming user-visible things uniquely
 207          * (curently the sidechain port).
 208          * Use sparingly to keep the numbers low, prefer PBD::ID for all
 209          * internal, not user-visible IDs */
 210         static unsigned int next_name_id ();
 211
 212         std::string path() const { return _path; }
 213         std::string name() const { return _name; }
 214         std::string snap_name() const { return _current_snapshot_name; }
 215         std::string raid_path () const;
 216         bool path_is_within_session (const std::string&);
 217
 218         bool writable() const { return _writable; }
 219         void set_dirty ();
 220         void set_clean ();
 221         bool dirty() const { return _state_of_the_state & Dirty; }
 222         void set_deletion_in_progress ();
 223         void clear_deletion_in_progress ();
 224         bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
 225         bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
 226         bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
 227         bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
 228         bool loading () const { return _state_of_the_state & Loading; }
 229
 230         PBD::Signal0<void> DirtyChanged;
 231
 232         const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
 233
 234         static PBD::Signal1<void,std::string> Dialog;
 235
 236         PBD::Signal0<void> BatchUpdateStart;
 237         PBD::Signal0<void> BatchUpdateEnd;
 238
 239         int ensure_subdirs ();
 240
 241         std::string automation_dir () const;  ///< Automation data
 242         std::string analysis_dir () const;    ///< Analysis data
 243         std::string plugins_dir () const;     ///< Plugin state
 244         std::string externals_dir () const;   ///< Links to external files
 245
 246         std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
 247
 248         bool audio_source_name_is_unique (const std::string& name);
 249         std::string format_audio_source_name (const std::string& legalized_base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required, uint32_t cnt, bool related_exists);
 250         std::string new_audio_source_path_for_embedded (const std::string& existing_path);
 251         std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
 252         std::string new_midi_source_path (const std::string&);
 253         /** create a new track or bus from a template (XML path)
 254          * @param how_many how many tracks or busses to create
 255          * @param template_path path to xml template file
 256          * @param name name (prefix) of the route to create
 257          * @param pd Playlist disposition
 258          * @return list of newly created routes
 259          */
 260         RouteList new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, const std::string& template_path, const std::string& name, PlaylistDisposition pd = NewPlaylist);
 261         RouteList new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
 262         std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path,
 263                                                             uint32_t channels, std::vector<std::string> const & smf_track_names);
 264
 265         int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
 266
 267         void process (pframes_t nframes);
 268
 269         BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
 270         BufferSet& get_noinplace_buffers (ChanCount count = ChanCount::ZERO);
 271         BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
 272         BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
 273         BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
 274
 275         bool have_rec_enabled_track () const;
 276     bool have_rec_disabled_track () const;
 277
 278         bool have_captured() const { return _have_captured; }
 279
 280         void refill_all_track_buffers ();
 281         Butler* butler() { return _butler; }
 282         void butler_transport_work ();
 283
 284         void refresh_disk_space ();
 285
 286         int load_diskstreams_2X (XMLNode const &, int);
 287
 288         int load_routes (const XMLNode&, int);
 289         boost::shared_ptr<RouteList> get_routes() const {
 290                 return routes.reader ();
 291         }
 292
 293         CoreSelection& selection () { return *_selection; }
 294
 295         /* because the set of Stripables consists of objects managed
 296          * independently, in multiple containers within the Session (or objects
 297          * owned by the session), we fill out a list in-place rather than
 298          * return a pointer to a copy of the (RCU) managed list, as happens
 299          * with get_routes()
 300          */
 301
 302         void get_stripables (StripableList&) const;
 303         boost::shared_ptr<RouteList> get_tracks() const;
 304         boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
 305         boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
 306
 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         struct LIBARDOUR_API RoutePublicOrderSorter {
 316                 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
 317         };
 318
 319         void notify_presentation_info_change ();
 320
 321         template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
 322         template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
 323         template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
 324
 325         static char session_name_is_legal (const std::string&);
 326         bool io_name_is_legal (const std::string&) const;
 327         boost::shared_ptr<Route> route_by_name (std::string) const;
 328         boost::shared_ptr<Route> route_by_id (PBD::ID) const;
 329         boost::shared_ptr<Stripable> stripable_by_id (PBD::ID) const;
 330         boost::shared_ptr<Stripable> get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag) const;
 331         boost::shared_ptr<Route> get_remote_nth_route (PresentationInfo::order_t n) const;
 332         boost::shared_ptr<Route> route_by_selected_count (uint32_t cnt) const;
 333         boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID) const;
 334         void routes_using_input_from (const std::string& str, RouteList& rl);
 335
 336         bool route_name_unique (std::string) const;
 337         bool route_name_internal (std::string) const;
 338
 339         uint32_t track_number_decimals () const {
 340                 return _track_number_decimals;
 341         }
 342
 343         bool get_record_enabled() const {
 344                 return (record_status () >= Enabled);
 345         }
 346
 347         RecordState record_status() const {
 348                 return (RecordState) g_atomic_int_get (&_record_status);
 349         }
 350
 351         bool actively_recording () const {
 352                 return record_status() == Recording;
 353         }
 354
 355         bool record_enabling_legal () const;
 356         void maybe_enable_record (bool rt_context = false);
 357         void disable_record (bool rt_context, bool force = false);
 358         void step_back_from_record ();
 359
 360         void set_all_tracks_record_enabled(bool);
 361
 362         void maybe_write_autosave ();
 363
 364         /* Emitted when all i/o connections are complete */
 365
 366         PBD::Signal0<void> IOConnectionsComplete;
 367
 368         /* Timecode status signals */
 369         PBD::Signal1<void, bool> MTCSyncStateChanged;
 370         PBD::Signal1<void, bool> LTCSyncStateChanged;
 371
 372         /* Record status signals */
 373
 374         PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
 375         /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
 376            from the previous signal and session state.
 377         */
 378         PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
 379
 380         /* Emited when session is loaded */
 381         PBD::Signal0<void> SessionLoaded;
 382
 383         /* Transport mechanism signals */
 384
 385         /** Emitted on the following changes in transport state:
 386          *  - stop (from the butler thread)
 387          *  - change in whether or not we are looping (from the process thread)
 388          *  - change in the play range (from the process thread)
 389          *  - start (from the process thread)
 390          *  - engine halted
 391          */
 392         PBD::Signal0<void> TransportStateChange;
 393
 394         PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
 395         PBD::Signal1<void,framepos_t> Xrun;
 396         PBD::Signal0<void> TransportLooped;
 397
 398         /** emitted when a locate has occurred */
 399         PBD::Signal0<void> Located;
 400
 401         PBD::Signal1<void,RouteList&> RouteAdded;
 402         /** Emitted when a property of one of our route groups changes.
 403          *  The parameter is the RouteGroup that has changed.
 404          */
 405         PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
 406         /** Emitted when a route is added to one of our route groups.
 407          *  First parameter is the RouteGroup, second is the route.
 408          */
 409         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
 410         /** Emitted when a route is removed from one of our route groups.
 411          *  First parameter is the RouteGroup, second is the route.
 412          */
 413         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
 414
 415         /* Step Editing status changed */
 416         PBD::Signal1<void,bool> StepEditStatusChange;
 417
 418         /* Timecode state signals */
 419         PBD::Signal0<void> MtcOrLtcInputPortChanged;
 420
 421         void queue_event (SessionEvent*);
 422
 423         void request_roll_at_and_return (framepos_t start, framepos_t return_to);
 424         void request_bounded_roll (framepos_t start, framepos_t end);
 425         void request_stop (bool abort = false, bool clear_state = false);
 426         void request_locate (framepos_t frame, bool with_roll = false);
 427
 428         void request_play_loop (bool yn, bool leave_rolling = false);
 429         bool get_play_loop () const { return play_loop; }
 430
 431         framepos_t last_transport_start () const { return _last_roll_location; }
 432         void goto_end ();
 433         void goto_start (bool and_roll = false);
 434         void use_rf_shuttle_speed ();
 435         void allow_auto_play (bool yn);
 436         void request_transport_speed (double speed, bool as_default = true);
 437         void request_transport_speed_nonzero (double, bool as_default = true);
 438         void request_overwrite_buffer (Track *);
 439         void adjust_playback_buffering();
 440         void adjust_capture_buffering();
 441         void request_track_speed (Track *, double speed);
 442         void request_input_change_handling ();
 443
 444         bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
 445         bool declick_out_pending() const { return static_cast<bool>(transport_sub_state&(PendingDeclickOut)); }
 446         bool transport_locked () const;
 447
 448         int wipe ();
 449
 450         framepos_t current_end_frame () const;
 451         framepos_t current_start_frame () const;
 452         /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
 453         framecnt_t frame_rate () const { return _current_frame_rate; }
 454         /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
 455         framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
 456         framecnt_t frames_per_hour () const { return _frames_per_hour; }
 457
 458         double samples_per_timecode_frame() const { return _samples_per_timecode_frame; }
 459         framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
 460
 461         MIDI::byte get_mtc_timecode_bits() const {
 462                 return mtc_timecode_bits;   /* encoding of SMTPE type for MTC */
 463         }
 464
 465         double timecode_frames_per_second() const;
 466         bool timecode_drop_frames() const;
 467
 468         /* Locations */
 469
 470         Locations *locations() { return _locations; }
 471
 472         PBD::Signal1<void,Location*>    auto_loop_location_changed;
 473         PBD::Signal1<void,Location*>    auto_punch_location_changed;
 474         PBD::Signal0<void>              locations_modified;
 475
 476         void set_auto_punch_location (Location *);
 477         void set_auto_loop_location (Location *);
 478         void set_session_extents (framepos_t start, framepos_t end);
 479         bool end_is_free () const { return _session_range_end_is_free; }
 480         void set_end_is_free (bool);
 481         int location_name(std::string& result, std::string base = std::string(""));
 482
 483         pframes_t get_block_size()        const { return current_block_size; }
 484         framecnt_t worst_output_latency () const { return _worst_output_latency; }
 485         framecnt_t worst_input_latency ()  const { return _worst_input_latency; }
 486         framecnt_t worst_track_latency ()  const { return _worst_track_latency; }
 487         framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
 488
 489         struct SaveAs {
 490                 std::string new_parent_folder;  /* parent folder where new session folder will be created */
 491                 std::string new_name;           /* name of newly saved session */
 492                 bool        switch_to;     /* true if we should be working on newly saved session after save-as; false otherwise */
 493                 bool        include_media; /* true if the newly saved session should contain references to media */
 494                 bool        copy_media;    /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
 495                 bool        copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
 496
 497                 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
 498
 499                 /* emitted as we make progress. 3 arguments passed to signal
 500                  * handler:
 501                  *
 502                  *  1: percentage complete measured as a fraction (0-1.0) of
 503                  *     total data copying done.
 504                  *  2: number of files copied so far
 505                  *  3: total number of files to copy
 506                  *
 507                  * Handler should return true for save-as to continue, or false
 508                  * to stop (and remove all evidence of partial save-as).
 509                  */
 510                 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
 511
 512                 /* if save_as() returns non-zero, this string will indicate the reason why.
 513                  */
 514                 std::string failure_message;
 515         };
 516
 517         int save_as (SaveAs&);
 518         /** save session
 519          * @param snapshot_name name of the session (use an empty string for the current name)
 520          * @param pending save a 'recovery', not full state (default: false)
 521          * @param switch_to_snapshot switch to given snapshot after saving (default: false)
 522          * @param template_only save a session template (default: false)
 523          * @return zero on success
 524          */
 525         int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
 526
 527         enum ArchiveEncode {
 528                 NO_ENCODE,
 529                 FLAC_16BIT,
 530                 FLAC_24BIT
 531         };
 532
 533         int archive_session (const std::string&, const std::string&, ArchiveEncode compress_audio = FLAC_16BIT, bool only_used_sources = false, Progress* p = 0);
 534
 535         int restore_state (std::string snapshot_name);
 536         int save_template (std::string template_name, bool replace_existing = false);
 537         int save_history (std::string snapshot_name = "");
 538         int restore_history (std::string snapshot_name);
 539         void remove_state (std::string snapshot_name);
 540         void rename_state (std::string old_name, std::string new_name);
 541         void remove_pending_capture_state ();
 542         int rename (const std::string&);
 543         bool get_nsm_state () const { return _under_nsm_control; }
 544         void set_nsm_state (bool state) { _under_nsm_control = state; }
 545         bool save_default_options ();
 546
 547         PBD::Signal1<void,std::string> StateSaved;
 548         PBD::Signal0<void> StateReady;
 549
 550         /* emitted when session needs to be saved due to some internal
 551          * event or condition (i.e. not in response to a user request).
 552          *
 553          * Only one object should
 554          * connect to this signal and take responsibility.
 555          *
 556          * Argument is the snapshot name to use when saving.
 557          */
 558         PBD::Signal1<void,std::string> SaveSessionRequested;
 559
 560         /* emitted during a session save to allow other entities to add state, via
 561          * extra XML, to the session state
 562          */
 563         PBD::Signal0<void> SessionSaveUnderway;
 564
 565         std::vector<std::string> possible_states() const;
 566         static std::vector<std::string> possible_states (std::string path);
 567
 568         XMLNode& get_state();
 569         int      set_state(const XMLNode& node, int version); // not idempotent
 570         XMLNode& get_template();
 571         bool     export_track_state (boost::shared_ptr<RouteList> rl, const std::string& path);
 572
 573         /// The instant xml file is written to the session directory
 574         void add_instant_xml (XMLNode&, bool write_to_config = true);
 575         XMLNode* instant_xml (const std::string& str);
 576
 577         enum StateOfTheState {
 578                 Clean = 0x0,
 579                 Dirty = 0x1,
 580                 CannotSave = 0x2,
 581                 Deletion = 0x4,
 582                 InitialConnecting = 0x8,
 583                 Loading = 0x10,
 584                 InCleanup = 0x20,
 585                 PeakCleanup = 0x40
 586         };
 587
 588         StateOfTheState state_of_the_state() const { return _state_of_the_state; }
 589
 590         class StateProtector {
 591                 public:
 592                         StateProtector (Session* s) : _session (s) {
 593                                 g_atomic_int_inc (&s->_suspend_save);
 594                         }
 595                         ~StateProtector () {
 596                                 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
 597                                         while (_session->_save_queued) {
 598                                                 _session->_save_queued = false;
 599                                                 _session->save_state ("");
 600                                         }
 601                                 }
 602                         }
 603                 private:
 604                         Session * _session;
 605         };
 606
 607         class ProcessorChangeBlocker {
 608                 public:
 609                         ProcessorChangeBlocker (Session* s, bool rc = true)
 610                                 : _session (s)
 611                                 , _reconfigure_on_delete (rc)
 612                         {
 613                                 g_atomic_int_inc (&s->_ignore_route_processor_changes);
 614                         }
 615                         ~ProcessorChangeBlocker () {
 616                                 if (g_atomic_int_dec_and_test (&_session->_ignore_route_processor_changes)) {
 617                                         if (_reconfigure_on_delete) {
 618                                                 _session->route_processors_changed (RouteProcessorChange ());
 619                                         }
 620                                 }
 621                         }
 622                 private:
 623                         Session* _session;
 624                         bool _reconfigure_on_delete;
 625         };
 626
 627         RouteGroup* new_route_group (const std::string&);
 628         void add_route_group (RouteGroup *);
 629         void remove_route_group (RouteGroup* rg) { if (rg) remove_route_group (*rg); }
 630         void remove_route_group (RouteGroup&);
 631         void reorder_route_groups (std::list<RouteGroup*>);
 632
 633         RouteGroup* route_group_by_name (std::string);
 634         RouteGroup& all_route_group() const;
 635
 636         PBD::Signal1<void,RouteGroup*> route_group_added;
 637         PBD::Signal0<void>             route_group_removed;
 638         PBD::Signal0<void>             route_groups_reordered;
 639
 640         void foreach_route_group (boost::function<void(RouteGroup*)> f) {
 641                 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
 642                         f (*i);
 643                 }
 644         }
 645
 646         std::list<RouteGroup*> const & route_groups () const {
 647                 return _route_groups;
 648         }
 649
 650         /* fundamental operations. duh. */
 651
 652         std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
 653                 int input_channels,
 654                 int output_channels,
 655                 RouteGroup* route_group,
 656                 uint32_t how_many,
 657                 std::string name_template,
 658                 PresentationInfo::order_t order,
 659                 TrackMode mode = Normal
 660                 );
 661
 662         std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
 663                 const ChanCount& input, const ChanCount& output, bool strict_io,
 664                 boost::shared_ptr<PluginInfo> instrument,
 665                 Plugin::PresetRecord* pset,
 666                 RouteGroup* route_group, uint32_t how_many, std::string name_template,
 667                 PresentationInfo::order_t,
 668                 TrackMode mode = Normal
 669                 );
 670
 671         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);
 672         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);
 673
 674         void remove_routes (boost::shared_ptr<RouteList>);
 675         void remove_route (boost::shared_ptr<Route>);
 676
 677         void resort_routes ();
 678         void resort_routes_using (boost::shared_ptr<RouteList>);
 679
 680         AudioEngine & engine() { return _engine; }
 681         AudioEngine const & engine () const { return _engine; }
 682
 683         static std::string default_track_name_pattern (DataType);
 684
 685         /* Time */
 686
 687         framepos_t transport_frame () const {return _transport_frame; }
 688         framepos_t record_location () const {return _last_record_location; }
 689         framepos_t audible_frame (bool* latent_locate = NULL) const;
 690         framepos_t requested_return_frame() const { return _requested_return_frame; }
 691         void set_requested_return_frame(framepos_t return_to);
 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 (framepos_t when, Timecode::BBT_Time&);
 708         void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
 709         void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
 710         void timecode_time (Timecode::Time &);
 711         void timecode_time (framepos_t when, Timecode::Time&);
 712         void timecode_time_subframes (framepos_t when, Timecode::Time&);
 713
 714         void timecode_duration (framecnt_t, Timecode::Time&) const;
 715         void timecode_duration_string (char *, size_t len, framecnt_t) const;
 716
 717         framecnt_t convert_to_frames (AnyTime const & position);
 718         framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
 719
 720         static PBD::Signal1<void, framepos_t> StartTimeChanged;
 721         static PBD::Signal1<void, framepos_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; }
 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 (framepos_t position, bool realtime = false, bool region_export = false, bool comensate_master_latency = false);
 758
 759         PBD::Signal1<int, framecnt_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, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
 790
 791         /** non interactive message */
 792         static PBD::Signal2<void, framecnt_t, framecnt_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&) 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&, framepos_t start, framepos_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
 872         void add_monitor_section ();
 873         void reset_monitor_section ();
 874         void remove_monitor_section ();
 875         bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
 876
 877         boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
 878         boost::shared_ptr<Route> master_out() const { return _master_out; }
 879
 880         void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
 881         void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
 882         void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
 883         void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
 884         void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
 885         void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
 886         void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
 887
 888         static void set_disable_all_loaded_plugins (bool yn) {
 889                 _disable_all_loaded_plugins = yn;
 890         }
 891         static bool get_disable_all_loaded_plugins() {
 892                 return _disable_all_loaded_plugins;
 893         }
 894         static void set_bypass_all_loaded_plugins (bool yn) {
 895                 _bypass_all_loaded_plugins = yn;
 896         }
 897         static bool get_bypass_all_loaded_plugins() {
 898                 return _bypass_all_loaded_plugins;
 899         }
 900
 901         uint32_t next_send_id();
 902         uint32_t next_aux_send_id();
 903         uint32_t next_return_id();
 904         uint32_t next_insert_id();
 905         void mark_send_id (uint32_t);
 906         void mark_aux_send_id (uint32_t);
 907         void mark_return_id (uint32_t);
 908         void mark_insert_id (uint32_t);
 909         void unmark_send_id (uint32_t);
 910         void unmark_aux_send_id (uint32_t);
 911         void unmark_return_id (uint32_t);
 912         void unmark_insert_id (uint32_t);
 913
 914         /* s/w "RAID" management */
 915
 916         boost::optional<framecnt_t> available_capture_duration();
 917
 918         /* I/O bundles */
 919
 920         void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
 921         void remove_bundle (boost::shared_ptr<Bundle>);
 922         boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
 923
 924         PBD::Signal0<void> BundleAddedOrRemoved;
 925
 926         void midi_panic ();
 927
 928         /* History (for editors, mixers, UIs etc.) */
 929
 930         /** Undo some transactions.
 931          * @param n Number of transactions to undo.
 932          */
 933         void undo (uint32_t n);
 934         /** Redo some transactions.
 935          * @param n Number of transactions to undo.
 936          */
 937         void redo (uint32_t n);
 938
 939         UndoHistory& history() { return _history; }
 940
 941         uint32_t undo_depth() const { return _history.undo_depth(); }
 942         uint32_t redo_depth() const { return _history.redo_depth(); }
 943         std::string next_undo() const { return _history.next_undo(); }
 944         std::string next_redo() const { return _history.next_redo(); }
 945
 946         /** begin collecting undo information
 947          *
 948          * This call must always be followed by either
 949          * begin_reversible_command() or commit_reversible_command()
 950          *
 951          * @param cmd_name human readable name for the undo operation
 952          */
 953         void begin_reversible_command (const std::string& cmd_name);
 954         void begin_reversible_command (GQuark);
 955         /** abort an open undo command
 956          * This must only be called after begin_reversible_command ()
 957          */
 958         void abort_reversible_command ();
 959         /** finalize an undo command and commit pending transactions
 960          *
 961          * This must only be called after begin_reversible_command ()
 962          * @param cmd (additional) command to add
 963          */
 964         void commit_reversible_command (Command* cmd = 0);
 965
 966         void add_command (Command *const cmd);
 967
 968         /** create an StatefulDiffCommand from the given object and add it to the stack.
 969          *
 970          * This function must only be called after  begin_reversible_command.
 971          * Failing to do so may lead to a crash.
 972          *
 973          * @param sfd the object to diff
 974          * @returns the allocated StatefulDiffCommand (already added via add_command)
 975          */
 976         PBD::StatefulDiffCommand* add_stateful_diff_command (boost::shared_ptr<PBD::StatefulDestructible> sfd);
 977
 978         /** @return The list of operations that are currently in progress */
 979         std::list<GQuark> const & current_operations () {
 980                 return _current_trans_quarks;
 981         }
 982
 983         bool operation_in_progress (GQuark) const;
 984
 985         void add_commands (std::vector<Command*> const & cmds);
 986
 987         std::map<PBD::ID,PBD::StatefulDestructible*> registry;
 988
 989         // these commands are implemented in libs/ardour/session_command.cc
 990         Command* memento_command_factory(XMLNode* n);
 991         Command* stateful_diff_command_factory (XMLNode *);
 992         void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
 993
 994         /* clicking */
 995
 996         boost::shared_ptr<IO> click_io() { return _click_io; }
 997         boost::shared_ptr<Amp> click_gain() { return _click_gain; }
 998
 999         /* disk, buffer loads */
1000
1001         uint32_t playback_load ();
1002         uint32_t capture_load ();
1003
1004         /* ranges */
1005
1006         void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
1007         void request_cancel_play_range ();
1008         bool get_play_range () const { return _play_range; }
1009
1010         void maybe_update_session_range (framepos_t, framepos_t);
1011
1012         /* preroll */
1013         framecnt_t preroll_samples (framepos_t) const;
1014
1015         void request_preroll_record_punch (framepos_t start, framecnt_t preroll);
1016         void request_preroll_record_trim (framepos_t start, framecnt_t preroll);
1017         void request_count_in_record ();
1018
1019         framepos_t preroll_record_punch_pos () const { return _preroll_record_punch_pos; }
1020         bool preroll_record_punch_enabled () const { return _preroll_record_punch_pos >= 0; }
1021
1022         framecnt_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 (framepos_t start, framepos_t end);
1028         void set_object_selection (framepos_t start, framepos_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         pan_t** pan_automation_buffer () const;
1038
1039         void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
1040
1041         /* VST support */
1042
1043         static int  vst_current_loading_id;
1044         static const char* vst_can_do_strings[];
1045         static const int vst_can_do_string_count;
1046
1047         static intptr_t vst_callback (
1048                 AEffect* effect,
1049                 int32_t opcode,
1050                 int32_t index,
1051                 intptr_t value,
1052                 void* ptr,
1053                 float opt
1054                 );
1055
1056         static PBD::Signal0<void> SendFeedback;
1057
1058         /* Speakers */
1059
1060         boost::shared_ptr<Speakers> get_speakers ();
1061
1062         /* Controllables */
1063
1064         boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
1065
1066         boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
1067         boost::shared_ptr<AutomationControl> automation_control_by_id (const PBD::ID&);
1068         boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const ARDOUR::ControllableDescriptor&);
1069
1070         void add_controllable (boost::shared_ptr<PBD::Controllable>);
1071         void remove_controllable (PBD::Controllable*);
1072
1073         boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
1074
1075         SessionConfiguration config;
1076
1077         SessionConfiguration* cfg () { return &config; }
1078
1079         bool exporting () const {
1080                 return _exporting;
1081         }
1082
1083         bool bounce_processing() const {
1084                 return _bounce_processing_active;
1085         }
1086
1087         /* this is a private enum, but setup_enum_writer() needs it,
1088            and i can't find a way to give that function
1089            friend access. sigh.
1090         */
1091
1092         enum PostTransportWork {
1093                 PostTransportStop               = 0x1,
1094                 PostTransportDuration           = 0x2,
1095                 PostTransportLocate             = 0x4,
1096                 PostTransportRoll               = 0x8,
1097                 PostTransportAbort              = 0x10,
1098                 PostTransportOverWrite          = 0x20,
1099                 PostTransportSpeed              = 0x40,
1100                 PostTransportAudition           = 0x80,
1101                 PostTransportReverse            = 0x100,
1102                 PostTransportInputChange        = 0x200,
1103                 PostTransportCurveRealloc       = 0x400,
1104                 PostTransportClearSubstate      = 0x800,
1105                 PostTransportAdjustPlaybackBuffering  = 0x1000,
1106                 PostTransportAdjustCaptureBuffering   = 0x2000
1107         };
1108
1109         enum SlaveState {
1110                 Stopped,
1111                 Waiting,
1112                 Running
1113         };
1114
1115         SlaveState slave_state() const { return _slave_state; }
1116         Slave* slave() const { return _slave; }
1117
1118         boost::shared_ptr<SessionPlaylists> playlists;
1119
1120         void send_mmc_locate (framepos_t);
1121         void queue_full_time_code () { _send_timecode_update = true; }
1122         void queue_song_position_pointer () { /* currently does nothing */ }
1123
1124         bool step_editing() const { return (_step_editors > 0); }
1125
1126         void request_suspend_timecode_transmission ();
1127         void request_resume_timecode_transmission ();
1128         bool timecode_transmission_suspended () const;
1129
1130         std::vector<std::string> source_search_path(DataType) const;
1131         void ensure_search_path_includes (const std::string& path, DataType type);
1132         void remove_dir_from_search_path (const std::string& path, DataType type);
1133
1134         std::list<std::string> unknown_processors () const;
1135
1136         /** Emitted when a feedback cycle has been detected within Ardour's signal
1137             processing path.  Until it is fixed (by the user) some (unspecified)
1138             routes will not be run.
1139         */
1140         static PBD::Signal0<void> FeedbackDetected;
1141
1142         /** Emitted when a graph sort has successfully completed, which means
1143             that it has no feedback cycles.
1144         */
1145         static PBD::Signal0<void> SuccessfulGraphSort;
1146
1147         /* handlers can return an integer value:
1148            0: config.set_audio_search_path() or config.set_midi_search_path() was used
1149            to modify the search path and we should try to find it again.
1150            1: quit entire session load
1151            2: as 0, but don't ask about other missing files
1152            3: don't ask about other missing files, and just mark this one missing
1153            -1: just mark this one missing
1154            any other value: as -1
1155         */
1156         static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1157
1158         void set_missing_file_replacement (const std::string& mfr) {
1159                 _missing_file_replacement = mfr;
1160         }
1161
1162         /** Emitted when the session wants Ardour to quit */
1163         static PBD::Signal0<void> Quit;
1164
1165         /** Emitted when Ardour is asked to load a session in an older session
1166          * format, and makes a backup copy.
1167          */
1168         static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1169
1170         SceneChanger* scene_changer() const { return _scene_changer; }
1171
1172         /* asynchronous MIDI control ports */
1173
1174         boost::shared_ptr<Port> midi_input_port () const;
1175         boost::shared_ptr<Port> midi_output_port () const;
1176         boost::shared_ptr<Port> mmc_output_port () const;
1177         boost::shared_ptr<Port> mmc_input_port () const;
1178         boost::shared_ptr<Port> scene_input_port () const;
1179         boost::shared_ptr<Port> scene_output_port () const;
1180
1181         /* synchronous MIDI ports used for synchronization */
1182
1183         boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1184         boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1185         boost::shared_ptr<MidiPort> mtc_output_port () const;
1186         boost::shared_ptr<MidiPort> mtc_input_port () const;
1187         boost::shared_ptr<Port> ltc_input_port() const;
1188         boost::shared_ptr<Port> ltc_output_port() const;
1189
1190         boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
1191         boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1192
1193         MIDI::MachineControl& mmc() { return *_mmc; }
1194
1195         void reconnect_midi_scene_ports (bool);
1196         void reconnect_mtc_ports ();
1197         void reconnect_mmc_ports (bool);
1198
1199         void reconnect_ltc_input ();
1200         void reconnect_ltc_output ();
1201
1202         VCAManager& vca_manager() { return *_vca_manager; }
1203
1204         void auto_connect_thread_wakeup ();
1205
1206
1207   protected:
1208         friend class AudioEngine;
1209         void set_block_size (pframes_t nframes);
1210         void set_frame_rate (framecnt_t nframes);
1211 #ifdef USE_TRACKS_CODE_FEATURES
1212         void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1213 #endif
1214
1215   protected:
1216         friend class Route;
1217         void schedule_curve_reallocation ();
1218         void update_latency_compensation (bool force = false);
1219
1220   private:
1221         int  create (const std::string& mix_template, BusProfile*);
1222         void destroy ();
1223
1224         static guint _name_id_counter;
1225         static void init_name_id_counter (guint n);
1226         static unsigned int name_id_counter ();
1227
1228         /* stuff used in process() should be close together to
1229            maximise cache hits
1230         */
1231
1232         typedef void (Session::*process_function_type)(pframes_t);
1233
1234         AudioEngine&            _engine;
1235         mutable gint             processing_prohibited;
1236         process_function_type    process_function;
1237         process_function_type    last_process_function;
1238         bool                    _bounce_processing_active;
1239         bool                     waiting_for_sync_offset;
1240         framecnt_t              _base_frame_rate;     // sample-rate of the session at creation time, "native" SR
1241         framecnt_t              _nominal_frame_rate;  // overridden by audioengine setting
1242         framecnt_t              _current_frame_rate;  // this includes video pullup offset
1243         int                      transport_sub_state;
1244         mutable gint            _record_status;
1245         framepos_t              _transport_frame;
1246         Location*               _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1247         bool                    _session_range_end_is_free;
1248         Slave*                  _slave;
1249         bool                    _silent;
1250
1251         // varispeed playback
1252         double                  _transport_speed;
1253         double                  _default_transport_speed;
1254         double                  _last_transport_speed;
1255         double                  _signalled_varispeed;
1256         double                  _target_transport_speed;
1257         CubicInterpolation       interpolation;
1258
1259         bool                     auto_play_legal;
1260         framepos_t              _last_slave_transport_frame;
1261         framecnt_t               maximum_output_latency;
1262         framepos_t              _requested_return_frame;
1263         pframes_t                current_block_size;
1264         framecnt_t              _worst_output_latency;
1265         framecnt_t              _worst_input_latency;
1266         framecnt_t              _worst_track_latency;
1267         bool                    _have_captured;
1268         bool                    _non_soloed_outs_muted;
1269         bool                    _listening;
1270         uint32_t                _listen_cnt;
1271         uint32_t                _solo_isolated_cnt;
1272         bool                    _writable;
1273         bool                    _was_seamless;
1274         bool                    _under_nsm_control;
1275         unsigned int            _xrun_count;
1276
1277         std::string             _missing_file_replacement;
1278
1279         void mtc_status_changed (bool);
1280         PBD::ScopedConnection mtc_status_connection;
1281         void ltc_status_changed (bool);
1282         PBD::ScopedConnection ltc_status_connection;
1283
1284         void initialize_latencies ();
1285         void set_worst_io_latencies ();
1286         void set_worst_playback_latency ();
1287         void set_worst_capture_latency ();
1288         void set_worst_io_latencies_x (IOChange, void *) {
1289                 set_worst_io_latencies ();
1290         }
1291         void post_capture_latency ();
1292         void post_playback_latency ();
1293
1294         void update_latency_compensation_proxy (void* ignored);
1295
1296         void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1297
1298         void process_scrub          (pframes_t);
1299         void process_without_events (pframes_t);
1300         void process_with_events    (pframes_t);
1301         void process_audition       (pframes_t);
1302         void process_export         (pframes_t);
1303         void process_export_fw      (pframes_t);
1304
1305         void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1306         void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1307         bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1308
1309         static const framecnt_t bounce_chunk_size;
1310
1311         /* slave tracking */
1312
1313         static const int delta_accumulator_size = 25;
1314         int delta_accumulator_cnt;
1315         int32_t delta_accumulator[delta_accumulator_size];
1316         int32_t average_slave_delta;
1317         int  average_dir;
1318         bool have_first_delta_accumulator;
1319
1320         SlaveState _slave_state;
1321         gint _mtc_active;
1322         gint _ltc_active;
1323         framepos_t slave_wait_end;
1324
1325         void reset_slave_state ();
1326         bool follow_slave (pframes_t);
1327         void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1328         void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1329         void follow_slave_silently (pframes_t nframes, float slave_speed);
1330
1331         void switch_to_sync_source (SyncSource); /* !RT context */
1332         void drop_sync_source ();  /* !RT context */
1333         void use_sync_source (Slave*); /* RT context */
1334
1335         bool post_export_sync;
1336         framepos_t post_export_position;
1337
1338         bool _exporting;
1339         bool _export_rolling;
1340         bool _realtime_export;
1341         bool _region_export;
1342         framepos_t _export_preroll;
1343         framepos_t _export_latency;
1344
1345         boost::shared_ptr<ExportHandler> export_handler;
1346         boost::shared_ptr<ExportStatus>  export_status;
1347
1348         int  pre_export ();
1349         int  stop_audio_export ();
1350         void finalize_audio_export ();
1351         void finalize_export_internal (bool stop_freewheel);
1352         bool _pre_export_mmc_enabled;
1353
1354         PBD::ScopedConnection export_freewheel_connection;
1355
1356         void get_track_statistics ();
1357         int  process_routes (pframes_t, bool& need_butler);
1358         int  silent_process_routes (pframes_t, bool& need_butler);
1359
1360         /** @return 1 if there is a pending declick fade-in,
1361             -1 if there is a pending declick fade-out,
1362             0 if there is no pending declick.
1363         */
1364         int get_transport_declick_required () {
1365                 if (transport_sub_state & PendingDeclickIn) {
1366                         transport_sub_state &= ~PendingDeclickIn;
1367                         return 1;
1368                 } else if (transport_sub_state & PendingDeclickOut) {
1369                         /* XXX: not entirely sure why we don't clear this */
1370                         return -1;
1371                 } else if (transport_sub_state & PendingLoopDeclickOut) {
1372                         /* Return the declick out first ... */
1373                         transport_sub_state &= ~PendingLoopDeclickOut;
1374                         return -1;
1375                 } else if (transport_sub_state & PendingLoopDeclickIn) {
1376                         /* ... then the declick in on the next call */
1377                         transport_sub_state &= ~PendingLoopDeclickIn;
1378                         return 1;
1379                 } else {
1380                         return 0;
1381                 }
1382         }
1383
1384         bool maybe_stop (framepos_t limit);
1385         bool maybe_sync_start (pframes_t &);
1386
1387         void check_declick_out ();
1388
1389         std::string             _path;
1390         std::string             _name;
1391         bool                    _is_new;
1392         bool                    _send_qf_mtc;
1393         /** Number of process frames since the last MTC output (when sending MTC); used to
1394          *  know when to send full MTC messages every so often.
1395          */
1396         pframes_t               _pframes_since_last_mtc;
1397         bool                     play_loop;
1398         bool                     loop_changing;
1399         framepos_t               last_loopend;
1400
1401         boost::scoped_ptr<SessionDirectory> _session_dir;
1402
1403         void hookup_io ();
1404         void graph_reordered ();
1405
1406         /** current snapshot name, without the .ardour suffix */
1407         void set_snapshot_name (const std::string &);
1408         void save_snapshot_name (const std::string &);
1409         std::string _current_snapshot_name;
1410
1411         XMLTree*         state_tree;
1412         bool             state_was_pending;
1413         StateOfTheState _state_of_the_state;
1414
1415         friend class    StateProtector;
1416         gint            _suspend_save; /* atomic */
1417         volatile bool   _save_queued;
1418         Glib::Threads::Mutex save_state_lock;
1419         Glib::Threads::Mutex peak_cleanup_lock;
1420
1421         int      load_options (const XMLNode&);
1422         int      load_state (std::string snapshot_name);
1423
1424         framepos_t _last_roll_location;
1425         /** the session frame time at which we last rolled, located, or changed transport direction */
1426         framepos_t _last_roll_or_reversal_location;
1427         framepos_t _last_record_location;
1428
1429         bool              pending_locate_roll;
1430         framepos_t        pending_locate_frame;
1431         bool              pending_locate_flush;
1432         bool              pending_abort;
1433         bool              pending_auto_loop;
1434
1435         PBD::ReallocPool _mempool;
1436         LuaState lua;
1437         Glib::Threads::Mutex lua_lock;
1438         luabridge::LuaRef * _lua_run;
1439         luabridge::LuaRef * _lua_add;
1440         luabridge::LuaRef * _lua_del;
1441         luabridge::LuaRef * _lua_list;
1442         luabridge::LuaRef * _lua_load;
1443         luabridge::LuaRef * _lua_save;
1444         luabridge::LuaRef * _lua_cleanup;
1445         uint32_t            _n_lua_scripts;
1446
1447         void setup_lua ();
1448         void try_run_lua (pframes_t);
1449
1450         Butler* _butler;
1451
1452         static const PostTransportWork ProcessCannotProceedMask =
1453                 PostTransportWork (
1454                         PostTransportInputChange|
1455                         PostTransportReverse|
1456                         PostTransportCurveRealloc|
1457                         PostTransportAudition|
1458                         PostTransportLocate|
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 (framecnt_t frames_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 *, framepos_t &, framepos_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 (framecnt_t val) {
1514                 if (max_framepos - val < _transport_frame) {
1515                         _transport_frame = max_framepos;
1516                 } else {
1517                         _transport_frame += val;
1518                 }
1519         }
1520
1521         void decrement_transport_position (framecnt_t val) {
1522                 if (val < _transport_frame) {
1523                         _transport_frame -= val;
1524                 } else {
1525                         _transport_frame = 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 frame */
1638         framecnt_t _frames_per_hour;
1639         framecnt_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 frame) */
1643         bool last_timecode_valid;
1644         framepos_t last_timecode_when;
1645         Timecode::Time last_timecode;
1646
1647         bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1648
1649         int send_midi_time_code_for_cycle (framepos_t, framepos_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         framepos_t        ltc_enc_pos;
1661         double            ltc_enc_cnt;
1662         framepos_t        ltc_enc_off;
1663         bool              restarting;
1664         framepos_t        ltc_prev_cycle;
1665
1666         framepos_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 (framepos_t, framepos_t, double, double, pframes_t nframes);
1678
1679         void reset_record_status ();
1680
1681         int no_roll (pframes_t nframes);
1682         int fail_roll (pframes_t nframes);
1683
1684         bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1685         bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1686
1687         MidiControlUI* midi_control_ui;
1688
1689         int           start_midi_thread ();
1690
1691         void set_play_loop (bool yn, double speed);
1692         void unset_play_loop ();
1693         void overwrite_some_buffers (Track *);
1694         void flush_all_inserts ();
1695         int  micro_locate (framecnt_t distance);
1696         void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1697         void start_locate (framepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1698         void force_locate (framepos_t frame, bool with_roll = false);
1699         void set_track_speed (Track *, double speed);
1700         void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1701         void stop_transport (bool abort = false, bool clear_state = false);
1702         void start_transport ();
1703         void realtime_stop (bool abort, bool clear_state);
1704         void realtime_locate ();
1705         void non_realtime_start_scrub ();
1706         void non_realtime_set_speed ();
1707         void non_realtime_locate ();
1708         void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1709         void non_realtime_overwrite (int entry_request_count, bool& finished);
1710         void post_transport ();
1711         void engine_halted ();
1712         void xrun_recovery ();
1713         void set_track_loop (bool);
1714         bool select_playhead_priority_target (framepos_t&);
1715         void follow_playhead_priority ();
1716
1717         /* These are synchronous and so can only be called from within the process
1718          * cycle
1719          */
1720
1721         int  send_full_time_code (framepos_t, pframes_t nframes);
1722         void send_song_position_pointer (framepos_t);
1723
1724         TempoMap    *_tempo_map;
1725         void          tempo_map_changed (const PBD::PropertyChange&);
1726
1727         /* edit/mix groups */
1728
1729         int load_route_groups (const XMLNode&, int);
1730
1731         std::list<RouteGroup *> _route_groups;
1732         RouteGroup*             _all_route_group;
1733
1734         /* routes stuff */
1735
1736         boost::shared_ptr<Graph> _process_graph;
1737
1738         SerializedRCUManager<RouteList>  routes;
1739
1740         void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t);
1741         void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t);
1742         bool _adding_routes_in_progress;
1743         bool _reconnecting_routes_in_progress;
1744         bool _route_deletion_in_progress;
1745
1746         uint32_t destructive_index;
1747
1748         boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1749         boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1750
1751         void route_processors_changed (RouteProcessorChange);
1752
1753         bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1754         void count_existing_track_channels (ChanCount& in, ChanCount& out);
1755         void auto_connect_route (boost::shared_ptr<Route>, bool, const ChanCount&, const ChanCount&, const ChanCount& io = ChanCount(), const ChanCount& oo = ChanCount());
1756         void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1757
1758         /* track numbering */
1759
1760         void reassign_track_numbers ();
1761         uint32_t _track_number_decimals;
1762
1763         /* solo/mute/notifications */
1764
1765         void route_listen_changed (PBD::Controllable::GroupControlDisposition, boost::weak_ptr<Route>);
1766         void route_mute_changed ();
1767         void route_solo_changed (bool self_solo_change, PBD::Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route>);
1768         void route_solo_isolated_changed (boost::weak_ptr<Route>);
1769
1770         void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1771
1772         void listen_position_changed ();
1773         void solo_control_mode_changed ();
1774
1775         /* REGION MANAGEMENT */
1776
1777         mutable Glib::Threads::Mutex region_lock;
1778
1779         int load_regions (const XMLNode& node);
1780         int load_compounds (const XMLNode& node);
1781
1782         void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1783         void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1784         void route_group_property_changed (RouteGroup *);
1785
1786         /* SOURCES */
1787
1788         mutable Glib::Threads::Mutex source_lock;
1789
1790   public:
1791         typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1792
1793   private:
1794         void reset_write_sources (bool mark_write_complete, bool force = false);
1795         SourceMap sources;
1796
1797
1798   private:
1799         int load_sources (const XMLNode& node);
1800         XMLNode& get_sources_as_xml ();
1801
1802         boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1803
1804         /* PLAYLISTS */
1805
1806         void remove_playlist (boost::weak_ptr<Playlist>);
1807         void track_playlist_changed (boost::weak_ptr<Track>);
1808         void playlist_region_added (boost::weak_ptr<Region>);
1809         void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1810         void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1811
1812         /* CURVES and AUTOMATION LISTS */
1813         std::map<PBD::ID, AutomationList*> automation_lists;
1814
1815         /* DEFAULT FADE CURVES */
1816
1817         float default_fade_steepness;
1818         float default_fade_msecs;
1819
1820         /* AUDITIONING */
1821
1822         boost::shared_ptr<Auditioner> auditioner;
1823         void set_audition (boost::shared_ptr<Region>);
1824         void non_realtime_set_audition ();
1825         boost::shared_ptr<Region> pending_audition_region;
1826
1827         /* EXPORT */
1828
1829         /* FLATTEN */
1830
1831         int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1832
1833         /* INSERT AND SEND MANAGEMENT */
1834
1835         boost::dynamic_bitset<uint32_t> send_bitset;
1836         boost::dynamic_bitset<uint32_t> aux_send_bitset;
1837         boost::dynamic_bitset<uint32_t> return_bitset;
1838         boost::dynamic_bitset<uint32_t> insert_bitset;
1839
1840         /* S/W RAID */
1841
1842         struct space_and_path {
1843                 uint32_t blocks;     ///< 4kB blocks
1844                 bool blocks_unknown; ///< true if blocks is unknown
1845                 std::string path;
1846
1847                 space_and_path ()
1848                         : blocks (0)
1849                         , blocks_unknown (true)
1850                 {}
1851         };
1852
1853         struct space_and_path_ascending_cmp {
1854                 bool operator() (space_and_path a, space_and_path b) {
1855                         if (a.blocks_unknown != b.blocks_unknown) {
1856                                 return !a.blocks_unknown;
1857                         }
1858                         return a.blocks > b.blocks;
1859                 }
1860         };
1861
1862         void setup_raid_path (std::string path);
1863
1864         std::vector<space_and_path> session_dirs;
1865         std::vector<space_and_path>::iterator last_rr_session_dir;
1866         uint32_t _total_free_4k_blocks;
1867         /** If this is true, _total_free_4k_blocks is not definite,
1868             as one or more of the session directories' filesystems
1869             could not report free space.
1870         */
1871         bool _total_free_4k_blocks_uncertain;
1872         Glib::Threads::Mutex space_lock;
1873
1874         bool no_questions_about_missing_files;
1875
1876         std::string get_best_session_directory_for_new_audio ();
1877
1878         mutable gint _playback_load;
1879         mutable gint _capture_load;
1880
1881         /* I/O bundles */
1882
1883         SerializedRCUManager<BundleList> _bundles;
1884         XMLNode* _bundle_xml_node;
1885         int load_bundles (XMLNode const &);
1886
1887         UndoHistory      _history;
1888         /** current undo transaction, or 0 */
1889         UndoTransaction* _current_trans;
1890         /** GQuarks to describe the reversible commands that are currently in progress.
1891          *  These may be nested, in which case more recently-started commands are toward
1892          *  the front of the list.
1893          */
1894         std::list<GQuark> _current_trans_quarks;
1895
1896         int  backend_sync_callback (TransportState, framepos_t);
1897
1898         void process_rtop (SessionEvent*);
1899
1900         void  update_latency (bool playback);
1901
1902         XMLNode& state(bool);
1903
1904         /* click track */
1905         typedef std::list<Click*> Clicks;
1906         Clicks                  clicks;
1907         bool                   _clicking;
1908         bool                   _click_rec_only;
1909         boost::shared_ptr<IO>  _click_io;
1910         boost::shared_ptr<Amp> _click_gain;
1911         Sample*                 click_data;
1912         Sample*                 click_emphasis_data;
1913         framecnt_t              click_length;
1914         framecnt_t              click_emphasis_length;
1915         mutable Glib::Threads::RWLock    click_lock;
1916
1917         static const Sample     default_click[];
1918         static const framecnt_t default_click_length;
1919         static const Sample     default_click_emphasis[];
1920         static const framecnt_t default_click_emphasis_length;
1921
1922         Click *get_click();
1923         framepos_t _clicks_cleared;
1924         void   setup_click_sounds (int which);
1925         void   setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1926         void   clear_clicks ();
1927         void   click (framepos_t start, framecnt_t nframes);
1928         void   run_click (framepos_t start, framecnt_t nframes);
1929         void   add_click (framepos_t pos, bool emphasis);
1930         framecnt_t _count_in_samples;
1931
1932         std::vector<Route*> master_outs;
1933
1934         /* range playback */
1935
1936         std::list<AudioRange> current_audio_range;
1937         bool _play_range;
1938         void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1939         void unset_play_range ();
1940
1941         /* temporary hacks to allow selection to be pushed from GUI into backend
1942            Whenever we move the selection object into libardour, these will go away.
1943         */
1944         Evoral::Range<framepos_t> _range_selection;
1945         Evoral::Range<framepos_t> _object_selection;
1946
1947         void unset_preroll_record_punch ();
1948         void unset_preroll_record_trim ();
1949
1950         framepos_t _preroll_record_punch_pos;
1951         framecnt_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_frame(*)
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         /** temporary list of Diskstreams used only during load of 2.X sessions */
2030         std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
2031
2032         void set_session_range_location (framepos_t, framepos_t);
2033
2034         void setup_midi_machine_control ();
2035
2036         void step_edit_status_change (bool);
2037         uint32_t _step_editors;
2038
2039         /** true if timecode transmission by the transport is suspended, otherwise false */
2040         mutable gint _suspend_timecode_transmission;
2041
2042         void update_locations_after_tempo_map_change (const Locations::LocationList &);
2043
2044         void start_time_changed (framepos_t);
2045         void end_time_changed (framepos_t);
2046
2047         void set_track_monitor_input_status (bool);
2048         framepos_t compute_stop_limit () const;
2049
2050         boost::shared_ptr<Speakers> _speakers;
2051         void load_nested_sources (const XMLNode& node);
2052
2053         /** The directed graph of routes that is currently being used for audio processing
2054             and solo/mute computations.
2055         */
2056         GraphEdges _current_route_graph;
2057
2058         void ensure_route_presentation_info_gap (PresentationInfo::order_t, uint32_t gap_size);
2059
2060         friend class    ProcessorChangeBlocker;
2061         gint            _ignore_route_processor_changes; /* atomic */
2062
2063         MidiClockTicker* midi_clock;
2064
2065         boost::shared_ptr<IO>   _ltc_input;
2066         boost::shared_ptr<IO>   _ltc_output;
2067
2068         /* Scene Changing */
2069         SceneChanger* _scene_changer;
2070
2071         /* persistent, non-track related MIDI ports */
2072         MidiPortManager* _midi_ports;
2073         MIDI::MachineControl* _mmc;
2074
2075         void setup_ltc ();
2076         void setup_click ();
2077         void setup_click_state (const XMLNode*);
2078         void setup_bundles ();
2079
2080         void save_as_bring_callback (uint32_t, uint32_t, std::string);
2081
2082         static const uint32_t session_end_shift;
2083
2084         std::string _template_state_dir;
2085
2086         VCAManager* _vca_manager;
2087
2088         boost::shared_ptr<Route> get_midi_nth_route_by_id (PresentationInfo::order_t n) const;
2089
2090         std::string created_with;
2091
2092         void midi_track_presentation_info_changed (PBD::PropertyChange const &, boost::weak_ptr<MidiTrack>);
2093         void rewire_selected_midi (boost::shared_ptr<MidiTrack>);
2094         void rewire_midi_selection_ports ();
2095         boost::weak_ptr<MidiTrack> current_midi_target;
2096
2097         CoreSelection* _selection;
2098 };
2099
2100
2101 } // namespace ARDOUR
2102
2103 #endif /* __ardour_session_h__ */