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