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         bool end_is_free () const { return _session_range_end_is_free; }
 476         void set_end_is_free (bool);
 477         int location_name(std::string& result, std::string base = std::string(""));
 478
 479         pframes_t get_block_size()        const { return current_block_size; }
 480         framecnt_t worst_output_latency () const { return _worst_output_latency; }
 481         framecnt_t worst_input_latency ()  const { return _worst_input_latency; }
 482         framecnt_t worst_track_latency ()  const { return _worst_track_latency; }
 483         framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
 484
 485         struct SaveAs {
 486                 std::string new_parent_folder;  /* parent folder where new session folder will be created */
 487                 std::string new_name;           /* name of newly saved session */
 488                 bool        switch_to;     /* true if we should be working on newly saved session after save-as; false otherwise */
 489                 bool        include_media; /* true if the newly saved session should contain references to media */
 490                 bool        copy_media;    /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
 491                 bool        copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
 492
 493                 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
 494
 495                 /* emitted as we make progress. 3 arguments passed to signal
 496                  * handler:
 497                  *
 498                  *  1: percentage complete measured as a fraction (0-1.0) of
 499                  *     total data copying done.
 500                  *  2: number of files copied so far
 501                  *  3: total number of files to copy
 502                  *
 503                  * Handler should return true for save-as to continue, or false
 504                  * to stop (and remove all evidence of partial save-as).
 505                  */
 506                 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
 507
 508                 /* if save_as() returns non-zero, this string will indicate the reason why.
 509                  */
 510                 std::string failure_message;
 511         };
 512
 513         int save_as (SaveAs&);
 514         /** save session
 515          * @param snapshot_name name of the session (use an empty string for the current name)
 516          * @param pending save a 'recovery', not full state (default: false)
 517          * @param switch_to_snapshot switch to given snapshot after saving (default: false)
 518          * @param template_only save a session template (default: false)
 519          * @return zero on success
 520          */
 521         int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
 522
 523         enum ArchiveEncode {
 524                 NO_ENCODE,
 525                 FLAC_16BIT,
 526                 FLAC_24BIT
 527         };
 528
 529         int archive_session (const std::string&, const std::string&, ArchiveEncode compress_audio = FLAC_16BIT, bool only_used_sources = false, Progress* p = 0);
 530
 531         int restore_state (std::string snapshot_name);
 532         int save_template (std::string template_name, bool replace_existing = false);
 533         int save_history (std::string snapshot_name = "");
 534         int restore_history (std::string snapshot_name);
 535         void remove_state (std::string snapshot_name);
 536         void rename_state (std::string old_name, std::string new_name);
 537         void remove_pending_capture_state ();
 538         int rename (const std::string&);
 539         bool get_nsm_state () const { return _under_nsm_control; }
 540         void set_nsm_state (bool state) { _under_nsm_control = state; }
 541         bool save_default_options ();
 542
 543         PBD::Signal1<void,std::string> StateSaved;
 544         PBD::Signal0<void> StateReady;
 545
 546         /* emitted when session needs to be saved due to some internal
 547          * event or condition (i.e. not in response to a user request).
 548          *
 549          * Only one object should
 550          * connect to this signal and take responsibility.
 551          *
 552          * Argument is the snapshot name to use when saving.
 553          */
 554         PBD::Signal1<void,std::string> SaveSessionRequested;
 555
 556         /* emitted during a session save to allow other entities to add state, via
 557          * extra XML, to the session state
 558          */
 559         PBD::Signal0<void> SessionSaveUnderway;
 560
 561         std::vector<std::string> possible_states() const;
 562         static std::vector<std::string> possible_states (std::string path);
 563
 564         XMLNode& get_state();
 565         int      set_state(const XMLNode& node, int version); // not idempotent
 566         XMLNode& get_template();
 567         bool     export_track_state (boost::shared_ptr<RouteList> rl, const std::string& path);
 568
 569         /// The instant xml file is written to the session directory
 570         void add_instant_xml (XMLNode&, bool write_to_config = true);
 571         XMLNode* instant_xml (const std::string& str);
 572
 573         enum StateOfTheState {
 574                 Clean = 0x0,
 575                 Dirty = 0x1,
 576                 CannotSave = 0x2,
 577                 Deletion = 0x4,
 578                 InitialConnecting = 0x8,
 579                 Loading = 0x10,
 580                 InCleanup = 0x20,
 581                 PeakCleanup = 0x40
 582         };
 583
 584         StateOfTheState state_of_the_state() const { return _state_of_the_state; }
 585
 586         class StateProtector {
 587                 public:
 588                         StateProtector (Session* s) : _session (s) {
 589                                 g_atomic_int_inc (&s->_suspend_save);
 590                         }
 591                         ~StateProtector () {
 592                                 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
 593                                         while (_session->_save_queued) {
 594                                                 _session->_save_queued = false;
 595                                                 _session->save_state ("");
 596                                         }
 597                                 }
 598                         }
 599                 private:
 600                         Session * _session;
 601         };
 602
 603         class ProcessorChangeBlocker {
 604                 public:
 605                         ProcessorChangeBlocker (Session* s, bool rc = true)
 606                                 : _session (s)
 607                                 , _reconfigure_on_delete (rc)
 608                         {
 609                                 g_atomic_int_inc (&s->_ignore_route_processor_changes);
 610                         }
 611                         ~ProcessorChangeBlocker () {
 612                                 if (g_atomic_int_dec_and_test (&_session->_ignore_route_processor_changes)) {
 613                                         if (_reconfigure_on_delete) {
 614                                                 _session->route_processors_changed (RouteProcessorChange ());
 615                                         }
 616                                 }
 617                         }
 618                 private:
 619                         Session* _session;
 620                         bool _reconfigure_on_delete;
 621         };
 622
 623         RouteGroup* new_route_group (const std::string&);
 624         void add_route_group (RouteGroup *);
 625         void remove_route_group (RouteGroup* rg) { if (rg) remove_route_group (*rg); }
 626         void remove_route_group (RouteGroup&);
 627         void reorder_route_groups (std::list<RouteGroup*>);
 628
 629         RouteGroup* route_group_by_name (std::string);
 630         RouteGroup& all_route_group() const;
 631
 632         PBD::Signal1<void,RouteGroup*> route_group_added;
 633         PBD::Signal0<void>             route_group_removed;
 634         PBD::Signal0<void>             route_groups_reordered;
 635
 636         void foreach_route_group (boost::function<void(RouteGroup*)> f) {
 637                 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
 638                         f (*i);
 639                 }
 640         }
 641
 642         std::list<RouteGroup*> const & route_groups () const {
 643                 return _route_groups;
 644         }
 645
 646         /* fundamental operations. duh. */
 647
 648         std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
 649                 int input_channels,
 650                 int output_channels,
 651                 RouteGroup* route_group,
 652                 uint32_t how_many,
 653                 std::string name_template,
 654                 PresentationInfo::order_t order,
 655                 TrackMode mode = Normal
 656                 );
 657
 658         std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
 659                 const ChanCount& input, const ChanCount& output, bool strict_io,
 660                 boost::shared_ptr<PluginInfo> instrument,
 661                 Plugin::PresetRecord* pset,
 662                 RouteGroup* route_group, uint32_t how_many, std::string name_template,
 663                 PresentationInfo::order_t,
 664                 TrackMode mode = Normal
 665                 );
 666
 667         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);
 668         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);
 669
 670         void remove_routes (boost::shared_ptr<RouteList>);
 671         void remove_route (boost::shared_ptr<Route>);
 672
 673         void resort_routes ();
 674         void resort_routes_using (boost::shared_ptr<RouteList>);
 675
 676         AudioEngine & engine() { return _engine; }
 677         AudioEngine const & engine () const { return _engine; }
 678
 679         static std::string default_track_name_pattern (DataType);
 680
 681         /* Time */
 682
 683         framepos_t transport_frame () const {return _transport_frame; }
 684         framepos_t record_location () const {return _last_record_location; }
 685         framepos_t audible_frame (bool* latent_locate = NULL) const;
 686         framepos_t requested_return_frame() const { return _requested_return_frame; }
 687         void set_requested_return_frame(framepos_t return_to);
 688
 689         enum PullupFormat {
 690                 pullup_Plus4Plus1,
 691                 pullup_Plus4,
 692                 pullup_Plus4Minus1,
 693                 pullup_Plus1,
 694                 pullup_None,
 695                 pullup_Minus1,
 696                 pullup_Minus4Plus1,
 697                 pullup_Minus4,
 698                 pullup_Minus4Minus1
 699         };
 700
 701         void sync_time_vars();
 702
 703         void bbt_time (framepos_t when, Timecode::BBT_Time&);
 704         void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
 705         void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
 706         void timecode_time (Timecode::Time &);
 707         void timecode_time (framepos_t when, Timecode::Time&);
 708         void timecode_time_subframes (framepos_t when, Timecode::Time&);
 709
 710         void timecode_duration (framecnt_t, Timecode::Time&) const;
 711         void timecode_duration_string (char *, size_t len, framecnt_t) const;
 712
 713         framecnt_t convert_to_frames (AnyTime const & position);
 714         framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
 715
 716         static PBD::Signal1<void, framepos_t> StartTimeChanged;
 717         static PBD::Signal1<void, framepos_t> EndTimeChanged;
 718
 719         void   request_sync_source (Slave*);
 720         bool   synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
 721         bool   synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
 722         bool   synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
 723
 724         double transport_speed() const { return _count_in_samples > 0 ? 0. : _transport_speed; }
 725         bool   transport_stopped() const { return _transport_speed == 0.0; }
 726         bool   transport_rolling() const { return _transport_speed != 0.0 && _count_in_samples == 0; }
 727
 728         bool silent () { return _silent; }
 729
 730         TempoMap&       tempo_map()       { return *_tempo_map; }
 731         const TempoMap& tempo_map() const { return *_tempo_map; }
 732
 733         unsigned int    get_xrun_count () const {return _xrun_count; }
 734         void            reset_xrun_count () {_xrun_count = 0; }
 735
 736         /* region info  */
 737
 738         boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
 739
 740         boost::shared_ptr<Region>      XMLRegionFactory (const XMLNode&, bool full);
 741         boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
 742         boost::shared_ptr<MidiRegion>  XMLMidiRegionFactory (const XMLNode&, bool full);
 743
 744         /* source management */
 745
 746         void import_files (ImportStatus&);
 747         bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
 748         std::string build_tmp_convert_name (std::string file);
 749
 750         boost::shared_ptr<ExportHandler> get_export_handler ();
 751         boost::shared_ptr<ExportStatus> get_export_status ();
 752
 753         int start_audio_export (framepos_t position, bool realtime = false, bool region_export = false, bool comensate_master_latency = false);
 754
 755         PBD::Signal1<int, framecnt_t> ProcessExport;
 756         static PBD::Signal2<void,std::string, std::string> Exported;
 757
 758         void add_source (boost::shared_ptr<Source>);
 759         void remove_source (boost::weak_ptr<Source>);
 760
 761         void cleanup_regions();
 762         bool can_cleanup_peakfiles () const;
 763         int  cleanup_peakfiles ();
 764         int  cleanup_sources (CleanupReport&);
 765         int  cleanup_trash_sources (CleanupReport&);
 766
 767         int destroy_sources (std::list<boost::shared_ptr<Source> >);
 768
 769         int remove_last_capture ();
 770
 771         /** handlers should return 0 for "everything OK", and any other value for
 772          * "cannot setup audioengine".
 773          */
 774         static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
 775
 776         /** handlers should return -1 for "stop cleanup",
 777             0 for "yes, delete this playlist",
 778             1 for "no, don't delete this playlist".
 779         */
 780         static PBD::Signal1<int,boost::shared_ptr<Playlist> >  AskAboutPlaylistDeletion;
 781
 782         /** handlers should return 0 for "ignore the rate mismatch",
 783             !0 for "do not use this session"
 784         */
 785         static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
 786
 787         /** non interactive message */
 788         static PBD::Signal2<void, framecnt_t, framecnt_t> NotifyAboutSampleRateMismatch;
 789
 790         /** handlers should return !0 for use pending state, 0 for ignore it.
 791          */
 792         static PBD::Signal0<int> AskAboutPendingState;
 793
 794         boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
 795                 size_t, std::string const &, uint32_t, bool destructive);
 796
 797         boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
 798         boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
 799
 800         boost::shared_ptr<Source> source_by_id (const PBD::ID&);
 801         boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
 802         boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
 803         uint32_t count_sources_by_origin (const std::string&);
 804
 805         void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
 806
 807         /* Curves and AutomationLists (TODO when they go away) */
 808         void add_automation_list(AutomationList*);
 809
 810         /* auditioning */
 811
 812         boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
 813         void audition_playlist ();
 814         void audition_region (boost::shared_ptr<Region>);
 815         void cancel_audition ();
 816         bool is_auditioning () const;
 817
 818         PBD::Signal1<void,bool> AuditionActive;
 819
 820         /* session script */
 821         void register_lua_function (const std::string&, const std::string&, const LuaScriptParamList&);
 822         void unregister_lua_function (const std::string& name);
 823         std::vector<std::string> registered_lua_functions ();
 824         uint32_t registered_lua_function_count () const { return _n_lua_scripts; }
 825         void scripts_changed (); // called from lua, updates _n_lua_scripts
 826
 827         PBD::Signal0<void> LuaScriptsChanged;
 828
 829         /* flattening stuff */
 830
 831         boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
 832                                                    bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
 833                                                    boost::shared_ptr<Processor> endpoint,
 834                                                    bool include_endpoint, bool for_export, bool for_freeze);
 835         int freeze_all (InterThreadInfo&);
 836
 837         /* session-wide solo/mute/rec-enable */
 838
 839         bool muted() const;
 840         std::vector<boost::weak_ptr<AutomationControl> > cancel_all_mute ();
 841
 842         bool soloing() const { return _non_soloed_outs_muted; }
 843         bool listening() const { return _listen_cnt > 0; }
 844         bool solo_isolated() const { return _solo_isolated_cnt > 0; }
 845         void cancel_all_solo ();
 846
 847         static const SessionEvent::RTeventCallback rt_cleanup;
 848
 849         void clear_all_solo_state (boost::shared_ptr<RouteList>);
 850
 851         /* Control-based methods */
 852
 853         void set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition);
 854         void set_control (boost::shared_ptr<AutomationControl>, double val, PBD::Controllable::GroupControlDisposition);
 855
 856         void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others = false);
 857
 858         PBD::Signal1<void,bool> SoloActive;
 859         PBD::Signal0<void> SoloChanged;
 860         PBD::Signal0<void> MuteChanged;
 861         PBD::Signal0<void> IsolatedChanged;
 862         PBD::Signal0<void> MonitorChanged;
 863
 864         PBD::Signal0<void> session_routes_reconnected;
 865
 866         /* monitor/master out */
 867
 868         void add_monitor_section ();
 869         void reset_monitor_section ();
 870         void remove_monitor_section ();
 871         bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
 872
 873         boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
 874         boost::shared_ptr<Route> master_out() const { return _master_out; }
 875
 876         void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
 877         void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
 878         void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
 879         void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
 880         void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
 881         void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
 882         void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
 883
 884         static void set_disable_all_loaded_plugins (bool yn) {
 885                 _disable_all_loaded_plugins = yn;
 886         }
 887         static bool get_disable_all_loaded_plugins() {
 888                 return _disable_all_loaded_plugins;
 889         }
 890         static void set_bypass_all_loaded_plugins (bool yn) {
 891                 _bypass_all_loaded_plugins = yn;
 892         }
 893         static bool get_bypass_all_loaded_plugins() {
 894                 return _bypass_all_loaded_plugins;
 895         }
 896
 897         uint32_t next_send_id();
 898         uint32_t next_aux_send_id();
 899         uint32_t next_return_id();
 900         uint32_t next_insert_id();
 901         void mark_send_id (uint32_t);
 902         void mark_aux_send_id (uint32_t);
 903         void mark_return_id (uint32_t);
 904         void mark_insert_id (uint32_t);
 905         void unmark_send_id (uint32_t);
 906         void unmark_aux_send_id (uint32_t);
 907         void unmark_return_id (uint32_t);
 908         void unmark_insert_id (uint32_t);
 909
 910         /* s/w "RAID" management */
 911
 912         boost::optional<framecnt_t> available_capture_duration();
 913
 914         /* I/O bundles */
 915
 916         void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
 917         void remove_bundle (boost::shared_ptr<Bundle>);
 918         boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
 919
 920         PBD::Signal0<void> BundleAddedOrRemoved;
 921
 922         void midi_panic ();
 923
 924         /* History (for editors, mixers, UIs etc.) */
 925
 926         /** Undo some transactions.
 927          * @param n Number of transactions to undo.
 928          */
 929         void undo (uint32_t n);
 930         /** Redo some transactions.
 931          * @param n Number of transactions to undo.
 932          */
 933         void redo (uint32_t n);
 934
 935         UndoHistory& history() { return _history; }
 936
 937         uint32_t undo_depth() const { return _history.undo_depth(); }
 938         uint32_t redo_depth() const { return _history.redo_depth(); }
 939         std::string next_undo() const { return _history.next_undo(); }
 940         std::string next_redo() const { return _history.next_redo(); }
 941
 942         /** begin collecting undo information
 943          *
 944          * This call must always be followed by either
 945          * begin_reversible_command() or commit_reversible_command()
 946          *
 947          * @param cmd_name human readable name for the undo operation
 948          */
 949         void begin_reversible_command (const std::string& cmd_name);
 950         void begin_reversible_command (GQuark);
 951         /** abort an open undo command
 952          * This must only be called after begin_reversible_command ()
 953          */
 954         void abort_reversible_command ();
 955         /** finalize an undo command and commit pending transactions
 956          *
 957          * This must only be called after begin_reversible_command ()
 958          * @param cmd (additional) command to add
 959          */
 960         void commit_reversible_command (Command* cmd = 0);
 961
 962         void add_command (Command *const cmd);
 963
 964         /** create an StatefulDiffCommand from the given object and add it to the stack.
 965          *
 966          * This function must only be called after  begin_reversible_command.
 967          * Failing to do so may lead to a crash.
 968          *
 969          * @param sfd the object to diff
 970          * @returns the allocated StatefulDiffCommand (already added via add_command)
 971          */
 972         PBD::StatefulDiffCommand* add_stateful_diff_command (boost::shared_ptr<PBD::StatefulDestructible> sfd);
 973
 974         /** @return The list of operations that are currently in progress */
 975         std::list<GQuark> const & current_operations () {
 976                 return _current_trans_quarks;
 977         }
 978
 979         bool operation_in_progress (GQuark) const;
 980
 981         void add_commands (std::vector<Command*> const & cmds);
 982
 983         std::map<PBD::ID,PBD::StatefulDestructible*> registry;
 984
 985         // these commands are implemented in libs/ardour/session_command.cc
 986         Command* memento_command_factory(XMLNode* n);
 987         Command* stateful_diff_command_factory (XMLNode *);
 988         void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
 989
 990         /* clicking */
 991
 992         boost::shared_ptr<IO> click_io() { return _click_io; }
 993         boost::shared_ptr<Amp> click_gain() { return _click_gain; }
 994
 995         /* disk, buffer loads */
 996
 997         uint32_t playback_load ();
 998         uint32_t capture_load ();
 999
1000         /* ranges */
1001
1002         void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
1003         void request_cancel_play_range ();
1004         bool get_play_range () const { return _play_range; }
1005
1006         void maybe_update_session_range (framepos_t, framepos_t);
1007
1008         /* preroll */
1009         framecnt_t preroll_samples (framepos_t) const;
1010
1011         void request_preroll_record_punch (framepos_t start, framecnt_t preroll);
1012         void request_preroll_record_trim (framepos_t start, framecnt_t preroll);
1013         void request_count_in_record ();
1014
1015         framepos_t preroll_record_punch_pos () const { return _preroll_record_punch_pos; }
1016         bool preroll_record_punch_enabled () const { return _preroll_record_punch_pos >= 0; }
1017
1018         framecnt_t preroll_record_trim_len () const { return _preroll_record_trim_len; }
1019
1020         /* temporary hacks to allow selection to be pushed from GUI into backend.
1021            Whenever we move the selection object into libardour, these will go away.
1022          */
1023         void set_range_selection (framepos_t start, framepos_t end);
1024         void set_object_selection (framepos_t start, framepos_t end);
1025         void clear_range_selection ();
1026         void clear_object_selection ();
1027
1028         /* buffers for gain and pan */
1029
1030         gain_t* gain_automation_buffer () const;
1031         gain_t* trim_automation_buffer () const;
1032         gain_t* send_gain_automation_buffer () const;
1033         pan_t** pan_automation_buffer () const;
1034
1035         void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
1036
1037         /* VST support */
1038
1039         static int  vst_current_loading_id;
1040         static const char* vst_can_do_strings[];
1041         static const int vst_can_do_string_count;
1042
1043         static intptr_t vst_callback (
1044                 AEffect* effect,
1045                 int32_t opcode,
1046                 int32_t index,
1047                 intptr_t value,
1048                 void* ptr,
1049                 float opt
1050                 );
1051
1052         static PBD::Signal0<void> SendFeedback;
1053
1054         /* Speakers */
1055
1056         boost::shared_ptr<Speakers> get_speakers ();
1057
1058         /* Controllables */
1059
1060         boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
1061
1062         boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
1063         boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const ARDOUR::ControllableDescriptor&);
1064
1065         void add_controllable (boost::shared_ptr<PBD::Controllable>);
1066         void remove_controllable (PBD::Controllable*);
1067
1068         boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
1069
1070         SessionConfiguration config;
1071
1072         SessionConfiguration* cfg () { return &config; }
1073
1074         bool exporting () const {
1075                 return _exporting;
1076         }
1077
1078         bool bounce_processing() const {
1079                 return _bounce_processing_active;
1080         }
1081
1082         /* this is a private enum, but setup_enum_writer() needs it,
1083            and i can't find a way to give that function
1084            friend access. sigh.
1085         */
1086
1087         enum PostTransportWork {
1088                 PostTransportStop               = 0x1,
1089                 PostTransportDuration           = 0x2,
1090                 PostTransportLocate             = 0x4,
1091                 PostTransportRoll               = 0x8,
1092                 PostTransportAbort              = 0x10,
1093                 PostTransportOverWrite          = 0x20,
1094                 PostTransportSpeed              = 0x40,
1095                 PostTransportAudition           = 0x80,
1096                 PostTransportReverse            = 0x100,
1097                 PostTransportInputChange        = 0x200,
1098                 PostTransportCurveRealloc       = 0x400,
1099                 PostTransportClearSubstate      = 0x800,
1100                 PostTransportAdjustPlaybackBuffering  = 0x1000,
1101                 PostTransportAdjustCaptureBuffering   = 0x2000
1102         };
1103
1104         enum SlaveState {
1105                 Stopped,
1106                 Waiting,
1107                 Running
1108         };
1109
1110         SlaveState slave_state() const { return _slave_state; }
1111         Slave* slave() const { return _slave; }
1112
1113         boost::shared_ptr<SessionPlaylists> playlists;
1114
1115         void send_mmc_locate (framepos_t);
1116         void queue_full_time_code () { _send_timecode_update = true; }
1117         void queue_song_position_pointer () { /* currently does nothing */ }
1118
1119         bool step_editing() const { return (_step_editors > 0); }
1120
1121         void request_suspend_timecode_transmission ();
1122         void request_resume_timecode_transmission ();
1123         bool timecode_transmission_suspended () const;
1124
1125         std::vector<std::string> source_search_path(DataType) const;
1126         void ensure_search_path_includes (const std::string& path, DataType type);
1127         void remove_dir_from_search_path (const std::string& path, DataType type);
1128
1129         std::list<std::string> unknown_processors () const;
1130
1131         /** Emitted when a feedback cycle has been detected within Ardour's signal
1132             processing path.  Until it is fixed (by the user) some (unspecified)
1133             routes will not be run.
1134         */
1135         static PBD::Signal0<void> FeedbackDetected;
1136
1137         /** Emitted when a graph sort has successfully completed, which means
1138             that it has no feedback cycles.
1139         */
1140         static PBD::Signal0<void> SuccessfulGraphSort;
1141
1142         /* handlers can return an integer value:
1143            0: config.set_audio_search_path() or config.set_midi_search_path() was used
1144            to modify the search path and we should try to find it again.
1145            1: quit entire session load
1146            2: as 0, but don't ask about other missing files
1147            3: don't ask about other missing files, and just mark this one missing
1148            -1: just mark this one missing
1149            any other value: as -1
1150         */
1151         static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1152
1153         void set_missing_file_replacement (const std::string& mfr) {
1154                 _missing_file_replacement = mfr;
1155         }
1156
1157         /** Emitted when the session wants Ardour to quit */
1158         static PBD::Signal0<void> Quit;
1159
1160         /** Emitted when Ardour is asked to load a session in an older session
1161          * format, and makes a backup copy.
1162          */
1163         static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1164
1165         SceneChanger* scene_changer() const { return _scene_changer; }
1166
1167         /* asynchronous MIDI control ports */
1168
1169         boost::shared_ptr<Port> midi_input_port () const;
1170         boost::shared_ptr<Port> midi_output_port () const;
1171         boost::shared_ptr<Port> mmc_output_port () const;
1172         boost::shared_ptr<Port> mmc_input_port () const;
1173         boost::shared_ptr<Port> scene_input_port () const;
1174         boost::shared_ptr<Port> scene_output_port () const;
1175
1176         /* synchronous MIDI ports used for synchronization */
1177
1178         boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1179         boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1180         boost::shared_ptr<MidiPort> mtc_output_port () const;
1181         boost::shared_ptr<MidiPort> mtc_input_port () const;
1182         boost::shared_ptr<Port> ltc_input_port() const;
1183         boost::shared_ptr<Port> ltc_output_port() const;
1184
1185         boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
1186         boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1187
1188         MIDI::MachineControl& mmc() { return *_mmc; }
1189
1190         void reconnect_midi_scene_ports (bool);
1191         void reconnect_mtc_ports ();
1192         void reconnect_mmc_ports (bool);
1193
1194         void reconnect_ltc_input ();
1195         void reconnect_ltc_output ();
1196
1197         VCAManager& vca_manager() { return *_vca_manager; }
1198
1199         void auto_connect_thread_wakeup ();
1200
1201
1202   protected:
1203         friend class AudioEngine;
1204         void set_block_size (pframes_t nframes);
1205         void set_frame_rate (framecnt_t nframes);
1206 #ifdef USE_TRACKS_CODE_FEATURES
1207         void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1208 #endif
1209
1210   protected:
1211         friend class Route;
1212         void schedule_curve_reallocation ();
1213         void update_latency_compensation (bool force = false);
1214
1215   private:
1216         int  create (const std::string& mix_template, BusProfile*);
1217         void destroy ();
1218
1219         static guint _name_id_counter;
1220         static void init_name_id_counter (guint n);
1221         static unsigned int name_id_counter ();
1222
1223         /* stuff used in process() should be close together to
1224            maximise cache hits
1225         */
1226
1227         typedef void (Session::*process_function_type)(pframes_t);
1228
1229         AudioEngine&            _engine;
1230         mutable gint             processing_prohibited;
1231         process_function_type    process_function;
1232         process_function_type    last_process_function;
1233         bool                    _bounce_processing_active;
1234         bool                     waiting_for_sync_offset;
1235         framecnt_t              _base_frame_rate;     // sample-rate of the session at creation time, "native" SR
1236         framecnt_t              _nominal_frame_rate;  // overridden by audioengine setting
1237         framecnt_t              _current_frame_rate;  // this includes video pullup offset
1238         int                      transport_sub_state;
1239         mutable gint            _record_status;
1240         framepos_t              _transport_frame;
1241         Location*               _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1242         bool                    _session_range_end_is_free;
1243         Slave*                  _slave;
1244         bool                    _silent;
1245
1246         // varispeed playback
1247         double                  _transport_speed;
1248         double                  _default_transport_speed;
1249         double                  _last_transport_speed;
1250         double                  _signalled_varispeed;
1251         double                  _target_transport_speed;
1252         CubicInterpolation       interpolation;
1253
1254         bool                     auto_play_legal;
1255         framepos_t              _last_slave_transport_frame;
1256         framecnt_t               maximum_output_latency;
1257         framepos_t              _requested_return_frame;
1258         pframes_t                current_block_size;
1259         framecnt_t              _worst_output_latency;
1260         framecnt_t              _worst_input_latency;
1261         framecnt_t              _worst_track_latency;
1262         bool                    _have_captured;
1263         bool                    _non_soloed_outs_muted;
1264         bool                    _listening;
1265         uint32_t                _listen_cnt;
1266         uint32_t                _solo_isolated_cnt;
1267         bool                    _writable;
1268         bool                    _was_seamless;
1269         bool                    _under_nsm_control;
1270         unsigned int            _xrun_count;
1271
1272         std::string             _missing_file_replacement;
1273
1274         void mtc_status_changed (bool);
1275         PBD::ScopedConnection mtc_status_connection;
1276         void ltc_status_changed (bool);
1277         PBD::ScopedConnection ltc_status_connection;
1278
1279         void initialize_latencies ();
1280         void set_worst_io_latencies ();
1281         void set_worst_playback_latency ();
1282         void set_worst_capture_latency ();
1283         void set_worst_io_latencies_x (IOChange, void *) {
1284                 set_worst_io_latencies ();
1285         }
1286         void post_capture_latency ();
1287         void post_playback_latency ();
1288
1289         void update_latency_compensation_proxy (void* ignored);
1290
1291         void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1292
1293         void process_scrub          (pframes_t);
1294         void process_without_events (pframes_t);
1295         void process_with_events    (pframes_t);
1296         void process_audition       (pframes_t);
1297         void process_export         (pframes_t);
1298         void process_export_fw      (pframes_t);
1299
1300         void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1301         void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1302         bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1303
1304         static const framecnt_t bounce_chunk_size;
1305
1306         /* slave tracking */
1307
1308         static const int delta_accumulator_size = 25;
1309         int delta_accumulator_cnt;
1310         int32_t delta_accumulator[delta_accumulator_size];
1311         int32_t average_slave_delta;
1312         int  average_dir;
1313         bool have_first_delta_accumulator;
1314
1315         SlaveState _slave_state;
1316         gint _mtc_active;
1317         gint _ltc_active;
1318         framepos_t slave_wait_end;
1319
1320         void reset_slave_state ();
1321         bool follow_slave (pframes_t);
1322         void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1323         void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1324         void follow_slave_silently (pframes_t nframes, float slave_speed);
1325
1326         void switch_to_sync_source (SyncSource); /* !RT context */
1327         void drop_sync_source ();  /* !RT context */
1328         void use_sync_source (Slave*); /* RT context */
1329
1330         bool post_export_sync;
1331         framepos_t post_export_position;
1332
1333         bool _exporting;
1334         bool _export_rolling;
1335         bool _realtime_export;
1336         bool _region_export;
1337         framepos_t _export_preroll;
1338         framepos_t _export_latency;
1339
1340         boost::shared_ptr<ExportHandler> export_handler;
1341         boost::shared_ptr<ExportStatus>  export_status;
1342
1343         int  pre_export ();
1344         int  stop_audio_export ();
1345         void finalize_audio_export ();
1346         void finalize_export_internal (bool stop_freewheel);
1347         bool _pre_export_mmc_enabled;
1348
1349         PBD::ScopedConnection export_freewheel_connection;
1350
1351         void get_track_statistics ();
1352         int  process_routes (pframes_t, bool& need_butler);
1353         int  silent_process_routes (pframes_t, bool& need_butler);
1354
1355         /** @return 1 if there is a pending declick fade-in,
1356             -1 if there is a pending declick fade-out,
1357             0 if there is no pending declick.
1358         */
1359         int get_transport_declick_required () {
1360                 if (transport_sub_state & PendingDeclickIn) {
1361                         transport_sub_state &= ~PendingDeclickIn;
1362                         return 1;
1363                 } else if (transport_sub_state & PendingDeclickOut) {
1364                         /* XXX: not entirely sure why we don't clear this */
1365                         return -1;
1366                 } else if (transport_sub_state & PendingLoopDeclickOut) {
1367                         /* Return the declick out first ... */
1368                         transport_sub_state &= ~PendingLoopDeclickOut;
1369                         return -1;
1370                 } else if (transport_sub_state & PendingLoopDeclickIn) {
1371                         /* ... then the declick in on the next call */
1372                         transport_sub_state &= ~PendingLoopDeclickIn;
1373                         return 1;
1374                 } else {
1375                         return 0;
1376                 }
1377         }
1378
1379         bool maybe_stop (framepos_t limit);
1380         bool maybe_sync_start (pframes_t &);
1381
1382         void check_declick_out ();
1383
1384         std::string             _path;
1385         std::string             _name;
1386         bool                    _is_new;
1387         bool                    _send_qf_mtc;
1388         /** Number of process frames since the last MTC output (when sending MTC); used to
1389          *  know when to send full MTC messages every so often.
1390          */
1391         pframes_t               _pframes_since_last_mtc;
1392         bool                     play_loop;
1393         bool                     loop_changing;
1394         framepos_t               last_loopend;
1395
1396         boost::scoped_ptr<SessionDirectory> _session_dir;
1397
1398         void hookup_io ();
1399         void graph_reordered ();
1400
1401         /** current snapshot name, without the .ardour suffix */
1402         void set_snapshot_name (const std::string &);
1403         void save_snapshot_name (const std::string &);
1404         std::string _current_snapshot_name;
1405
1406         XMLTree*         state_tree;
1407         bool             state_was_pending;
1408         StateOfTheState _state_of_the_state;
1409
1410         friend class    StateProtector;
1411         gint            _suspend_save; /* atomic */
1412         volatile bool   _save_queued;
1413         Glib::Threads::Mutex save_state_lock;
1414         Glib::Threads::Mutex peak_cleanup_lock;
1415
1416         int      load_options (const XMLNode&);
1417         int      load_state (std::string snapshot_name);
1418
1419         framepos_t _last_roll_location;
1420         /** the session frame time at which we last rolled, located, or changed transport direction */
1421         framepos_t _last_roll_or_reversal_location;
1422         framepos_t _last_record_location;
1423
1424         bool              pending_locate_roll;
1425         framepos_t        pending_locate_frame;
1426         bool              pending_locate_flush;
1427         bool              pending_abort;
1428         bool              pending_auto_loop;
1429
1430         PBD::ReallocPool _mempool;
1431         LuaState lua;
1432         Glib::Threads::Mutex lua_lock;
1433         luabridge::LuaRef * _lua_run;
1434         luabridge::LuaRef * _lua_add;
1435         luabridge::LuaRef * _lua_del;
1436         luabridge::LuaRef * _lua_list;
1437         luabridge::LuaRef * _lua_load;
1438         luabridge::LuaRef * _lua_save;
1439         luabridge::LuaRef * _lua_cleanup;
1440         uint32_t            _n_lua_scripts;
1441
1442         void setup_lua ();
1443         void try_run_lua (pframes_t);
1444
1445         Butler* _butler;
1446
1447         static const PostTransportWork ProcessCannotProceedMask =
1448                 PostTransportWork (
1449                         PostTransportInputChange|
1450                         PostTransportReverse|
1451                         PostTransportCurveRealloc|
1452                         PostTransportAudition|
1453                         PostTransportLocate|
1454                         PostTransportStop|
1455                         PostTransportClearSubstate);
1456
1457         gint _post_transport_work; /* accessed only atomic ops */
1458         PostTransportWork post_transport_work() const        { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1459         void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1460         void add_post_transport_work (PostTransportWork ptw);
1461
1462         void schedule_playback_buffering_adjustment ();
1463         void schedule_capture_buffering_adjustment ();
1464
1465         uint32_t    cumulative_rf_motion;
1466         uint32_t    rf_scale;
1467
1468         void set_rf_speed (float speed);
1469         void reset_rf_scale (framecnt_t frames_moved);
1470
1471         Locations*       _locations;
1472         void location_added (Location*);
1473         void location_removed (Location*);
1474         void locations_changed ();
1475         void _locations_changed (const Locations::LocationList&);
1476
1477         void update_skips (Location*, bool consolidate);
1478         void update_marks (Location* loc);
1479         void consolidate_skips (Location*);
1480         void sync_locations_to_skips ();
1481         void _sync_locations_to_skips ();
1482
1483         PBD::ScopedConnectionList skip_update_connections;
1484         bool _ignore_skips_updates;
1485
1486         PBD::ScopedConnectionList punch_connections;
1487         void             auto_punch_start_changed (Location *);
1488         void             auto_punch_end_changed (Location *);
1489         void             auto_punch_changed (Location *);
1490
1491         PBD::ScopedConnectionList loop_connections;
1492         void             auto_loop_changed (Location *);
1493         void             auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1494
1495         int  ensure_engine (uint32_t desired_sample_rate, bool);
1496         void pre_engine_init (std::string path);
1497         int  post_engine_init ();
1498         int  immediately_post_engine ();
1499         void remove_empty_sounds ();
1500
1501         void session_loaded ();
1502
1503         void setup_midi_control ();
1504         int  midi_read (MIDI::Port *);
1505
1506         void enable_record ();
1507
1508         void increment_transport_position (framecnt_t val) {
1509                 if (max_framepos - val < _transport_frame) {
1510                         _transport_frame = max_framepos;
1511                 } else {
1512                         _transport_frame += val;
1513                 }
1514         }
1515
1516         void decrement_transport_position (framecnt_t val) {
1517                 if (val < _transport_frame) {
1518                         _transport_frame -= val;
1519                 } else {
1520                         _transport_frame = 0;
1521                 }
1522         }
1523
1524         void post_transport_motion ();
1525         static void *session_loader_thread (void *arg);
1526
1527         void *do_work();
1528
1529         /* Signal Forwarding */
1530         void emit_route_signals ();
1531         void emit_thread_run ();
1532         static void *emit_thread (void *);
1533         void emit_thread_start ();
1534         void emit_thread_terminate ();
1535
1536         pthread_t       _rt_emit_thread;
1537         bool            _rt_thread_active;
1538
1539         pthread_mutex_t _rt_emit_mutex;
1540         pthread_cond_t  _rt_emit_cond;
1541         bool            _rt_emit_pending;
1542
1543         /* Auto Connect Thread */
1544         static void *auto_connect_thread (void *);
1545         void auto_connect_thread_run ();
1546         void auto_connect_thread_start ();
1547         void auto_connect_thread_terminate ();
1548
1549         pthread_t       _auto_connect_thread;
1550         gint            _ac_thread_active;
1551         pthread_mutex_t _auto_connect_mutex;
1552         pthread_cond_t  _auto_connect_cond;
1553
1554         struct AutoConnectRequest {
1555                 public:
1556                 AutoConnectRequest (boost::shared_ptr <Route> r, bool ci,
1557                                 const ChanCount& is,
1558                                 const ChanCount& os,
1559                                 const ChanCount& io,
1560                                 const ChanCount& oo)
1561                         : route (boost::weak_ptr<Route> (r))
1562                         , connect_inputs (ci)
1563                         , input_start (is)
1564                         , output_start (os)
1565                         , input_offset (io)
1566                         , output_offset (oo)
1567                 {}
1568
1569                 boost::weak_ptr <Route> route;
1570                 bool connect_inputs;
1571                 ChanCount input_start;
1572                 ChanCount output_start;
1573                 ChanCount input_offset;
1574                 ChanCount output_offset;
1575         };
1576
1577         typedef std::queue<AutoConnectRequest> AutoConnectQueue;
1578         Glib::Threads::Mutex  _auto_connect_queue_lock;
1579         AutoConnectQueue _auto_connect_queue;
1580         guint _latency_recompute_pending;
1581
1582         void get_physical_ports (std::vector<std::string>& inputs, std::vector<std::string>& outputs, DataType type,
1583                                  MidiPortFlags include = MidiPortFlags (0),
1584                                  MidiPortFlags exclude = MidiPortFlags (0));
1585
1586         void auto_connect (const AutoConnectRequest&);
1587         void queue_latency_recompute ();
1588
1589         /* SessionEventManager interface */
1590
1591         void process_event (SessionEvent*);
1592         void set_next_event ();
1593         void cleanup_event (SessionEvent*,int);
1594
1595         /* MIDI Machine Control */
1596
1597         void spp_start ();
1598         void spp_continue ();
1599         void spp_stop ();
1600
1601         void mmc_deferred_play (MIDI::MachineControl &);
1602         void mmc_stop (MIDI::MachineControl &);
1603         void mmc_step (MIDI::MachineControl &, int);
1604         void mmc_pause (MIDI::MachineControl &);
1605         void mmc_record_pause (MIDI::MachineControl &);
1606         void mmc_record_strobe (MIDI::MachineControl &);
1607         void mmc_record_exit (MIDI::MachineControl &);
1608         void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1609         void mmc_fast_forward (MIDI::MachineControl &);
1610         void mmc_rewind (MIDI::MachineControl &);
1611         void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1612         void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1613         void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1614
1615         struct timeval last_mmc_step;
1616         double step_speed;
1617
1618         typedef boost::function<bool()> MidiTimeoutCallback;
1619         typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1620
1621         MidiTimeoutList midi_timeouts;
1622         bool mmc_step_timeout ();
1623         void send_immediate_mmc (MIDI::MachineControlCommand);
1624
1625         MIDI::byte mtc_msg[16];
1626         MIDI::byte mtc_timecode_bits;   /* encoding of SMTPE type for MTC */
1627         MIDI::byte midi_msg[16];
1628         double outbound_mtc_timecode_frame;
1629         Timecode::Time transmitting_timecode_time;
1630         int next_quarter_frame_to_send;
1631
1632         double _samples_per_timecode_frame; /* has to be floating point because of drop frame */
1633         framecnt_t _frames_per_hour;
1634         framecnt_t _timecode_frames_per_hour;
1635
1636         /* cache the most-recently requested time conversions. This helps when we
1637          * have multiple clocks showing the same time (e.g. the transport frame) */
1638         bool last_timecode_valid;
1639         framepos_t last_timecode_when;
1640         Timecode::Time last_timecode;
1641
1642         bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1643
1644         int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1645
1646         LTCEncoder*       ltc_encoder;
1647         ltcsnd_sample_t*  ltc_enc_buf;
1648
1649         Timecode::TimecodeFormat ltc_enc_tcformat;
1650         int32_t           ltc_buf_off;
1651         int32_t           ltc_buf_len;
1652
1653         double            ltc_speed;
1654         int32_t           ltc_enc_byte;
1655         framepos_t        ltc_enc_pos;
1656         double            ltc_enc_cnt;
1657         framepos_t        ltc_enc_off;
1658         bool              restarting;
1659         framepos_t        ltc_prev_cycle;
1660
1661         framepos_t        ltc_timecode_offset;
1662         bool              ltc_timecode_negative_offset;
1663
1664         LatencyRange      ltc_out_latency;
1665
1666         void ltc_tx_initialize();
1667         void ltc_tx_cleanup();
1668         void ltc_tx_reset();
1669         void ltc_tx_resync_latency();
1670         void ltc_tx_recalculate_position();
1671         void ltc_tx_parse_offset();
1672         void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1673
1674         void reset_record_status ();
1675
1676         int no_roll (pframes_t nframes);
1677         int fail_roll (pframes_t nframes);
1678
1679         bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1680         bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1681
1682         MidiControlUI* midi_control_ui;
1683
1684         int           start_midi_thread ();
1685
1686         void set_play_loop (bool yn, double speed);
1687         void unset_play_loop ();
1688         void overwrite_some_buffers (Track *);
1689         void flush_all_inserts ();
1690         int  micro_locate (framecnt_t distance);
1691         void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1692         void start_locate (framepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1693         void force_locate (framepos_t frame, bool with_roll = false);
1694         void set_track_speed (Track *, double speed);
1695         void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1696         void stop_transport (bool abort = false, bool clear_state = false);
1697         void start_transport ();
1698         void realtime_stop (bool abort, bool clear_state);
1699         void realtime_locate ();
1700         void non_realtime_start_scrub ();
1701         void non_realtime_set_speed ();
1702         void non_realtime_locate ();
1703         void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1704         void non_realtime_overwrite (int entry_request_count, bool& finished);
1705         void post_transport ();
1706         void engine_halted ();
1707         void xrun_recovery ();
1708         void set_track_loop (bool);
1709         bool select_playhead_priority_target (framepos_t&);
1710         void follow_playhead_priority ();
1711
1712         /* These are synchronous and so can only be called from within the process
1713          * cycle
1714          */
1715
1716         int  send_full_time_code (framepos_t, pframes_t nframes);
1717         void send_song_position_pointer (framepos_t);
1718
1719         TempoMap    *_tempo_map;
1720         void          tempo_map_changed (const PBD::PropertyChange&);
1721
1722         /* edit/mix groups */
1723
1724         int load_route_groups (const XMLNode&, int);
1725
1726         std::list<RouteGroup *> _route_groups;
1727         RouteGroup*             _all_route_group;
1728
1729         /* routes stuff */
1730
1731         boost::shared_ptr<Graph> _process_graph;
1732
1733         SerializedRCUManager<RouteList>  routes;
1734
1735         void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t);
1736         void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t);
1737         bool _adding_routes_in_progress;
1738         bool _reconnecting_routes_in_progress;
1739         bool _route_deletion_in_progress;
1740
1741         uint32_t destructive_index;
1742
1743         boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1744         boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1745
1746         void route_processors_changed (RouteProcessorChange);
1747
1748         bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1749         void count_existing_track_channels (ChanCount& in, ChanCount& out);
1750         void auto_connect_route (boost::shared_ptr<Route>, bool, const ChanCount&, const ChanCount&, const ChanCount& io = ChanCount(), const ChanCount& oo = ChanCount());
1751         void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1752
1753         /* track numbering */
1754
1755         void reassign_track_numbers ();
1756         uint32_t _track_number_decimals;
1757
1758         /* solo/mute/notifications */
1759
1760         void route_listen_changed (PBD::Controllable::GroupControlDisposition, boost::weak_ptr<Route>);
1761         void route_mute_changed ();
1762         void route_solo_changed (bool self_solo_change, PBD::Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route>);
1763         void route_solo_isolated_changed (boost::weak_ptr<Route>);
1764
1765         void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1766
1767         void listen_position_changed ();
1768         void solo_control_mode_changed ();
1769
1770         /* REGION MANAGEMENT */
1771
1772         mutable Glib::Threads::Mutex region_lock;
1773
1774         int load_regions (const XMLNode& node);
1775         int load_compounds (const XMLNode& node);
1776
1777         void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1778         void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1779         void route_group_property_changed (RouteGroup *);
1780
1781         /* SOURCES */
1782
1783         mutable Glib::Threads::Mutex source_lock;
1784
1785   public:
1786         typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1787
1788   private:
1789         void reset_write_sources (bool mark_write_complete, bool force = false);
1790         SourceMap sources;
1791
1792
1793   private:
1794         int load_sources (const XMLNode& node);
1795         XMLNode& get_sources_as_xml ();
1796
1797         boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1798
1799         /* PLAYLISTS */
1800
1801         void remove_playlist (boost::weak_ptr<Playlist>);
1802         void track_playlist_changed (boost::weak_ptr<Track>);
1803         void playlist_region_added (boost::weak_ptr<Region>);
1804         void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1805         void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1806
1807         /* CURVES and AUTOMATION LISTS */
1808         std::map<PBD::ID, AutomationList*> automation_lists;
1809
1810         /* DEFAULT FADE CURVES */
1811
1812         float default_fade_steepness;
1813         float default_fade_msecs;
1814
1815         /* AUDITIONING */
1816
1817         boost::shared_ptr<Auditioner> auditioner;
1818         void set_audition (boost::shared_ptr<Region>);
1819         void non_realtime_set_audition ();
1820         boost::shared_ptr<Region> pending_audition_region;
1821
1822         /* EXPORT */
1823
1824         /* FLATTEN */
1825
1826         int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1827
1828         /* INSERT AND SEND MANAGEMENT */
1829
1830         boost::dynamic_bitset<uint32_t> send_bitset;
1831         boost::dynamic_bitset<uint32_t> aux_send_bitset;
1832         boost::dynamic_bitset<uint32_t> return_bitset;
1833         boost::dynamic_bitset<uint32_t> insert_bitset;
1834
1835         /* S/W RAID */
1836
1837         struct space_and_path {
1838                 uint32_t blocks;     ///< 4kB blocks
1839                 bool blocks_unknown; ///< true if blocks is unknown
1840                 std::string path;
1841
1842                 space_and_path ()
1843                         : blocks (0)
1844                         , blocks_unknown (true)
1845                 {}
1846         };
1847
1848         struct space_and_path_ascending_cmp {
1849                 bool operator() (space_and_path a, space_and_path b) {
1850                         if (a.blocks_unknown != b.blocks_unknown) {
1851                                 return !a.blocks_unknown;
1852                         }
1853                         return a.blocks > b.blocks;
1854                 }
1855         };
1856
1857         void setup_raid_path (std::string path);
1858
1859         std::vector<space_and_path> session_dirs;
1860         std::vector<space_and_path>::iterator last_rr_session_dir;
1861         uint32_t _total_free_4k_blocks;
1862         /** If this is true, _total_free_4k_blocks is not definite,
1863             as one or more of the session directories' filesystems
1864             could not report free space.
1865         */
1866         bool _total_free_4k_blocks_uncertain;
1867         Glib::Threads::Mutex space_lock;
1868
1869         bool no_questions_about_missing_files;
1870
1871         std::string get_best_session_directory_for_new_audio ();
1872
1873         mutable gint _playback_load;
1874         mutable gint _capture_load;
1875
1876         /* I/O bundles */
1877
1878         SerializedRCUManager<BundleList> _bundles;
1879         XMLNode* _bundle_xml_node;
1880         int load_bundles (XMLNode const &);
1881
1882         UndoHistory      _history;
1883         /** current undo transaction, or 0 */
1884         UndoTransaction* _current_trans;
1885         /** GQuarks to describe the reversible commands that are currently in progress.
1886          *  These may be nested, in which case more recently-started commands are toward
1887          *  the front of the list.
1888          */
1889         std::list<GQuark> _current_trans_quarks;
1890
1891         int  backend_sync_callback (TransportState, framepos_t);
1892
1893         void process_rtop (SessionEvent*);
1894
1895         void  update_latency (bool playback);
1896
1897         XMLNode& state(bool);
1898
1899         /* click track */
1900         typedef std::list<Click*> Clicks;
1901         Clicks                  clicks;
1902         bool                   _clicking;
1903         bool                   _click_rec_only;
1904         boost::shared_ptr<IO>  _click_io;
1905         boost::shared_ptr<Amp> _click_gain;
1906         Sample*                 click_data;
1907         Sample*                 click_emphasis_data;
1908         framecnt_t              click_length;
1909         framecnt_t              click_emphasis_length;
1910         mutable Glib::Threads::RWLock    click_lock;
1911
1912         static const Sample     default_click[];
1913         static const framecnt_t default_click_length;
1914         static const Sample     default_click_emphasis[];
1915         static const framecnt_t default_click_emphasis_length;
1916
1917         Click *get_click();
1918         framepos_t _clicks_cleared;
1919         void   setup_click_sounds (int which);
1920         void   setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1921         void   clear_clicks ();
1922         void   click (framepos_t start, framecnt_t nframes);
1923         void   run_click (framepos_t start, framecnt_t nframes);
1924         void   add_click (framepos_t pos, bool emphasis);
1925         framecnt_t _count_in_samples;
1926
1927         std::vector<Route*> master_outs;
1928
1929         /* range playback */
1930
1931         std::list<AudioRange> current_audio_range;
1932         bool _play_range;
1933         void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1934         void unset_play_range ();
1935
1936         /* temporary hacks to allow selection to be pushed from GUI into backend
1937            Whenever we move the selection object into libardour, these will go away.
1938         */
1939         Evoral::Range<framepos_t> _range_selection;
1940         Evoral::Range<framepos_t> _object_selection;
1941
1942         void unset_preroll_record_punch ();
1943         void unset_preroll_record_trim ();
1944
1945         framepos_t _preroll_record_punch_pos;
1946         framecnt_t _preroll_record_trim_len;
1947         bool _count_in_once;
1948
1949         /* main outs */
1950         uint32_t main_outs;
1951
1952         boost::shared_ptr<Route> _master_out;
1953         boost::shared_ptr<Route> _monitor_out;
1954
1955         void auto_connect_master_bus ();
1956
1957         int find_all_sources (std::string path, std::set<std::string>& result);
1958         int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1959
1960         typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1961         Glib::Threads::Mutex controllables_lock;
1962         Controllables controllables;
1963
1964         boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1965
1966         void reset_native_file_format();
1967         bool first_file_data_format_reset;
1968         bool first_file_header_format_reset;
1969
1970         void config_changed (std::string, bool);
1971
1972         XMLNode& get_control_protocol_state ();
1973
1974         void set_history_depth (uint32_t depth);
1975
1976         static bool _disable_all_loaded_plugins;
1977         static bool _bypass_all_loaded_plugins;
1978
1979         mutable bool have_looped; ///< Used in ::audible_frame(*)
1980
1981         void update_route_record_state ();
1982         gint _have_rec_enabled_track;
1983         gint _have_rec_disabled_track;
1984
1985         static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1986
1987         /* realtime "apply to set of routes" operations */
1988         template<typename T> SessionEvent*
1989                 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1990                               void (Session::*method) (boost::shared_ptr<RouteList>, T, PBD::Controllable::GroupControlDisposition)) {
1991                 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1992                 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1993                 ev->rt_return = after;
1994                 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1995
1996                 return ev;
1997         }
1998
1999         /* specialized version realtime "apply to set of routes" operations */
2000         template<typename T1, typename T2> SessionEvent*
2001                 get_rt_event (boost::shared_ptr<RouteList> rl, T1 t1arg, T2 t2arg, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
2002                               void (Session::*method) (boost::shared_ptr<RouteList>, T1, T2, PBD::Controllable::GroupControlDisposition)) {
2003                 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
2004                 ev->rt_slot = boost::bind (method, this, rl, t1arg, t2arg, group_override);
2005                 ev->rt_return = after;
2006                 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
2007
2008                 return ev;
2009         }
2010
2011         /* specialized version realtime "apply to set of controls" operations */
2012         SessionEvent* get_rt_event (boost::shared_ptr<ControlList> cl, double arg, PBD::Controllable::GroupControlDisposition group_override) {
2013                 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
2014                 ev->rt_slot = boost::bind (&Session::rt_set_controls, this, cl, arg, group_override);
2015                 ev->rt_return = Session::rt_cleanup;
2016                 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
2017
2018                 return ev;
2019         }
2020
2021         void rt_set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition group_override);
2022         void rt_clear_all_solo_state (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
2023
2024         /** temporary list of Diskstreams used only during load of 2.X sessions */
2025         std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
2026
2027         void set_session_range_location (framepos_t, framepos_t);
2028
2029         void setup_midi_machine_control ();
2030
2031         void step_edit_status_change (bool);
2032         uint32_t _step_editors;
2033
2034         /** true if timecode transmission by the transport is suspended, otherwise false */
2035         mutable gint _suspend_timecode_transmission;
2036
2037         void update_locations_after_tempo_map_change (const Locations::LocationList &);
2038
2039         void start_time_changed (framepos_t);
2040         void end_time_changed (framepos_t);
2041
2042         void set_track_monitor_input_status (bool);
2043         framepos_t compute_stop_limit () const;
2044
2045         boost::shared_ptr<Speakers> _speakers;
2046         void load_nested_sources (const XMLNode& node);
2047
2048         /** The directed graph of routes that is currently being used for audio processing
2049             and solo/mute computations.
2050         */
2051         GraphEdges _current_route_graph;
2052
2053         void ensure_route_presentation_info_gap (PresentationInfo::order_t, uint32_t gap_size);
2054
2055         friend class    ProcessorChangeBlocker;
2056         gint            _ignore_route_processor_changes; /* atomic */
2057
2058         MidiClockTicker* midi_clock;
2059
2060         boost::shared_ptr<IO>   _ltc_input;
2061         boost::shared_ptr<IO>   _ltc_output;
2062
2063         /* Scene Changing */
2064         SceneChanger* _scene_changer;
2065
2066         /* persistent, non-track related MIDI ports */
2067         MidiPortManager* _midi_ports;
2068         MIDI::MachineControl* _mmc;
2069
2070         void setup_ltc ();
2071         void setup_click ();
2072         void setup_click_state (const XMLNode*);
2073         void setup_bundles ();
2074
2075         void save_as_bring_callback (uint32_t, uint32_t, std::string);
2076
2077         static const uint32_t session_end_shift;
2078
2079         std::string _template_state_dir;
2080
2081         VCAManager* _vca_manager;
2082
2083         boost::shared_ptr<Route> get_midi_nth_route_by_id (PresentationInfo::order_t n) const;
2084
2085         std::string created_with;
2086
2087         void midi_track_presentation_info_changed (PBD::PropertyChange const &, boost::weak_ptr<MidiTrack>);
2088         void rewire_selected_midi (boost::shared_ptr<MidiTrack>);
2089         void rewire_midi_selection_ports ();
2090         boost::weak_ptr<MidiTrack> current_midi_target;
2091 };
2092
2093
2094 } // namespace ARDOUR
2095
2096 #endif /* __ardour_session_h__ */