libs/ardour/ardour/session.h

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