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