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