libs/ardour/ardour/session.h

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