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