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