libs/ardour/ardour/session.h

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