libs/ardour/ardour/session.h

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