libs/ardour/ardour/session.h

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