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
 306         template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
 307         template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
 308         template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
 309
 310         static char session_name_is_legal (const std::string&);
 311         bool io_name_is_legal (const std::string&) const;
 312         boost::shared_ptr<Route> route_by_name (std::string) const;
 313         boost::shared_ptr<Route> route_by_id (PBD::ID) const;
 314         boost::shared_ptr<Stripable> get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag) const;
 315         boost::shared_ptr<Route> get_remote_nth_route (PresentationInfo::order_t n) const;
 316         boost::shared_ptr<Route> route_by_selected_count (uint32_t cnt) const;
 317         boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID) const;
 318         void routes_using_input_from (const std::string& str, RouteList& rl);
 319
 320         bool route_name_unique (std::string) const;
 321         bool route_name_internal (std::string) const;
 322
 323         uint32_t track_number_decimals () const {
 324                 return _track_number_decimals;
 325         }
 326
 327         bool get_record_enabled() const {
 328                 return (record_status () >= Enabled);
 329         }
 330
 331         RecordState record_status() const {
 332                 return (RecordState) g_atomic_int_get (&_record_status);
 333         }
 334
 335         bool actively_recording () const {
 336                 return record_status() == Recording;
 337         }
 338
 339         bool record_enabling_legal () const;
 340         void maybe_enable_record ();
 341         void disable_record (bool rt_context, bool force = false);
 342         void step_back_from_record ();
 343
 344         void set_all_tracks_record_enabled(bool);
 345
 346         void maybe_write_autosave ();
 347
 348         /* Emitted when all i/o connections are complete */
 349
 350         PBD::Signal0<void> IOConnectionsComplete;
 351
 352         /* Timecode status signals */
 353         PBD::Signal1<void, bool> MTCSyncStateChanged;
 354         PBD::Signal1<void, bool> LTCSyncStateChanged;
 355
 356         /* Record status signals */
 357
 358         PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
 359         /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
 360            from the previous signal and session state.
 361         */
 362         PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
 363
 364         /* Emited when session is loaded */
 365         PBD::Signal0<void> SessionLoaded;
 366
 367         /* Transport mechanism signals */
 368
 369         /** Emitted on the following changes in transport state:
 370          *  - stop (from the butler thread)
 371          *  - change in whether or not we are looping (from the process thread)
 372          *  - change in the play range (from the process thread)
 373          *  - start (from the process thread)
 374          *  - engine halted
 375          */
 376         PBD::Signal0<void> TransportStateChange;
 377
 378         PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
 379         PBD::Signal1<void,framepos_t> Xrun;
 380         PBD::Signal0<void> TransportLooped;
 381
 382         /** emitted when a locate has occurred */
 383         PBD::Signal0<void> Located;
 384
 385         PBD::Signal1<void,RouteList&> RouteAdded;
 386         /** Emitted when a property of one of our route groups changes.
 387          *  The parameter is the RouteGroup that has changed.
 388          */
 389         PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
 390         /** Emitted when a route is added to one of our route groups.
 391          *  First parameter is the RouteGroup, second is the route.
 392          */
 393         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
 394         /** Emitted when a route is removed from 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> > RouteRemovedFromRouteGroup;
 398
 399         /* Step Editing status changed */
 400         PBD::Signal1<void,bool> StepEditStatusChange;
 401
 402         /* Timecode state signals */
 403         PBD::Signal0<void> MtcOrLtcInputPortChanged;
 404
 405         void queue_event (SessionEvent*);
 406
 407         void request_roll_at_and_return (framepos_t start, framepos_t return_to);
 408         void request_bounded_roll (framepos_t start, framepos_t end);
 409         void request_stop (bool abort = false, bool clear_state = false);
 410         void request_locate (framepos_t frame, bool with_roll = false);
 411
 412         void request_play_loop (bool yn, bool leave_rolling = false);
 413         bool get_play_loop () const { return play_loop; }
 414
 415         framepos_t last_transport_start () const { return _last_roll_location; }
 416         void goto_end ();
 417         void goto_start ();
 418         void use_rf_shuttle_speed ();
 419         void allow_auto_play (bool yn);
 420         void request_transport_speed (double speed, bool as_default = true);
 421         void request_transport_speed_nonzero (double, bool as_default = true);
 422         void request_overwrite_buffer (Track *);
 423         void adjust_playback_buffering();
 424         void adjust_capture_buffering();
 425         void request_track_speed (Track *, double speed);
 426         void request_input_change_handling ();
 427
 428         bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
 429         bool transport_locked () const;
 430
 431         int wipe ();
 432
 433         framepos_t current_end_frame () const;
 434         framepos_t current_start_frame () const;
 435         /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
 436         framecnt_t frame_rate () const { return _current_frame_rate; }
 437         /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
 438         framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
 439         framecnt_t frames_per_hour () const { return _frames_per_hour; }
 440
 441         double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
 442         framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
 443
 444         MIDI::byte get_mtc_timecode_bits() const {
 445                 return mtc_timecode_bits;   /* encoding of SMTPE type for MTC */
 446         }
 447
 448         double timecode_frames_per_second() const;
 449         bool timecode_drop_frames() const;
 450
 451         /* Locations */
 452
 453         Locations *locations() { return _locations; }
 454
 455         PBD::Signal1<void,Location*>    auto_loop_location_changed;
 456         PBD::Signal1<void,Location*>    auto_punch_location_changed;
 457         PBD::Signal0<void>              locations_modified;
 458
 459         void set_auto_punch_location (Location *);
 460         void set_auto_loop_location (Location *);
 461         void set_session_extents (framepos_t start, framepos_t end);
 462         void set_end_is_free (bool);
 463         int location_name(std::string& result, std::string base = std::string(""));
 464
 465         pframes_t get_block_size()        const { return current_block_size; }
 466         framecnt_t worst_output_latency () const { return _worst_output_latency; }
 467         framecnt_t worst_input_latency ()  const { return _worst_input_latency; }
 468         framecnt_t worst_track_latency ()  const { return _worst_track_latency; }
 469         framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
 470
 471         struct SaveAs {
 472                 std::string new_parent_folder;  /* parent folder where new session folder will be created */
 473                 std::string new_name;           /* name of newly saved session */
 474                 bool        switch_to;     /* true if we should be working on newly saved session after save-as; false otherwise */
 475                 bool        include_media; /* true if the newly saved session should contain references to media */
 476                 bool        copy_media;    /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
 477                 bool        copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
 478
 479                 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
 480
 481                 /* emitted as we make progress. 3 arguments passed to signal
 482                  * handler:
 483                  *
 484                  *  1: percentage complete measured as a fraction (0-1.0) of
 485                  *     total data copying done.
 486                  *  2: number of files copied so far
 487                  *  3: total number of files to copy
 488                  *
 489                  * Handler should return true for save-as to continue, or false
 490                  * to stop (and remove all evidence of partial save-as).
 491                  */
 492                 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
 493
 494                 /* if save_as() returns non-zero, this string will indicate the reason why.
 495                  */
 496                 std::string failure_message;
 497         };
 498
 499         int save_as (SaveAs&);
 500         /** save session
 501          * @param snapshot_name name of the session (use an empty string for the current name)
 502          * @param pending save a 'recovery', not full state (default: false)
 503          * @param switch_to_snapshot switch to given snapshot after saving (default: false)
 504          * @param template_only save a session template (default: false)
 505          * @return zero on success
 506          */
 507         int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
 508         int restore_state (std::string snapshot_name);
 509         int save_template (std::string template_name, bool replace_existing = false);
 510         int save_history (std::string snapshot_name = "");
 511         int restore_history (std::string snapshot_name);
 512         void remove_state (std::string snapshot_name);
 513         void rename_state (std::string old_name, std::string new_name);
 514         void remove_pending_capture_state ();
 515         int rename (const std::string&);
 516         bool get_nsm_state () const { return _under_nsm_control; }
 517         void set_nsm_state (bool state) { _under_nsm_control = state; }
 518         bool save_default_options ();
 519
 520         PBD::Signal1<void,std::string> StateSaved;
 521         PBD::Signal0<void> StateReady;
 522
 523         /* emitted when session needs to be saved due to some internal
 524          * event or condition (i.e. not in response to a user request).
 525          *
 526          * Only one object should
 527          * connect to this signal and take responsibility.
 528          *
 529          * Argument is the snapshot name to use when saving.
 530          */
 531         PBD::Signal1<void,std::string> SaveSessionRequested;
 532
 533         /* emitted during a session save to allow other entities to add state, via
 534          * extra XML, to the session state
 535          */
 536         PBD::Signal0<void> SessionSaveUnderway;
 537
 538         std::vector<std::string> possible_states() const;
 539         static std::vector<std::string> possible_states (std::string path);
 540
 541         XMLNode& get_state();
 542         int      set_state(const XMLNode& node, int version); // not idempotent
 543         XMLNode& get_template();
 544
 545         /// The instant xml file is written to the session directory
 546         void add_instant_xml (XMLNode&, bool write_to_config = true);
 547         XMLNode* instant_xml (const std::string& str);
 548
 549         enum StateOfTheState {
 550                 Clean = 0x0,
 551                 Dirty = 0x1,
 552                 CannotSave = 0x2,
 553                 Deletion = 0x4,
 554                 InitialConnecting = 0x8,
 555                 Loading = 0x10,
 556                 InCleanup = 0x20,
 557                 PeakCleanup = 0x40
 558         };
 559
 560         StateOfTheState state_of_the_state() const { return _state_of_the_state; }
 561
 562         class StateProtector {
 563                                                 public:
 564                 StateProtector (Session* s) : _session (s) {
 565                         g_atomic_int_inc (&s->_suspend_save);
 566                 }
 567                 ~StateProtector () {
 568                         if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
 569                                 while (_session->_save_queued) {
 570                                         _session->_save_queued = false;
 571                                         _session->save_state ("");
 572                                 }
 573                         }
 574                 }
 575                                                 private:
 576                 Session * _session;
 577         };
 578
 579         void add_route_group (RouteGroup *);
 580         void remove_route_group (RouteGroup&);
 581         void reorder_route_groups (std::list<RouteGroup*>);
 582
 583         RouteGroup* route_group_by_name (std::string);
 584         RouteGroup& all_route_group() const;
 585
 586         PBD::Signal1<void,RouteGroup*> route_group_added;
 587         PBD::Signal0<void>             route_group_removed;
 588         PBD::Signal0<void>             route_groups_reordered;
 589
 590         void foreach_route_group (boost::function<void(RouteGroup*)> f) {
 591                 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
 592                         f (*i);
 593                 }
 594         }
 595
 596         std::list<RouteGroup*> const & route_groups () const {
 597                 return _route_groups;
 598         }
 599
 600         /* fundamental operations. duh. */
 601
 602         std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
 603                 int input_channels,
 604                 int output_channels,
 605                 RouteGroup* route_group,
 606                 uint32_t how_many,
 607                 std::string name_template,
 608                 PresentationInfo::order_t order,
 609                 TrackMode mode = Normal
 610                 );
 611
 612         std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
 613                 const ChanCount& input, const ChanCount& output,
 614                 boost::shared_ptr<PluginInfo> instrument,
 615                 Plugin::PresetRecord* pset,
 616                 RouteGroup* route_group, uint32_t how_many, std::string name_template,
 617                 PresentationInfo::order_t,
 618                 TrackMode mode = Normal
 619                 );
 620
 621         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);
 622         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);
 623
 624         void remove_routes (boost::shared_ptr<RouteList>);
 625         void remove_route (boost::shared_ptr<Route>);
 626
 627         void resort_routes ();
 628         void resort_routes_using (boost::shared_ptr<RouteList>);
 629
 630         AudioEngine & engine() { return _engine; }
 631         AudioEngine const & engine () const { return _engine; }
 632
 633         static std::string default_track_name_pattern (DataType);
 634
 635         /* Time */
 636
 637         framepos_t transport_frame () const {return _transport_frame; }
 638         framepos_t record_location () const {return _last_record_location; }
 639         framepos_t audible_frame () const;
 640         framepos_t requested_return_frame() const { return _requested_return_frame; }
 641         void set_requested_return_frame(framepos_t return_to);
 642
 643         enum PullupFormat {
 644                 pullup_Plus4Plus1,
 645                 pullup_Plus4,
 646                 pullup_Plus4Minus1,
 647                 pullup_Plus1,
 648                 pullup_None,
 649                 pullup_Minus1,
 650                 pullup_Minus4Plus1,
 651                 pullup_Minus4,
 652                 pullup_Minus4Minus1
 653         };
 654
 655         void sync_time_vars();
 656
 657         void bbt_time (framepos_t when, Timecode::BBT_Time&);
 658         void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
 659         void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
 660         void timecode_time (Timecode::Time &);
 661         void timecode_time (framepos_t when, Timecode::Time&);
 662         void timecode_time_subframes (framepos_t when, Timecode::Time&);
 663
 664         void timecode_duration (framecnt_t, Timecode::Time&) const;
 665         void timecode_duration_string (char *, size_t len, framecnt_t) const;
 666
 667         framecnt_t convert_to_frames (AnyTime const & position);
 668         framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
 669
 670         static PBD::Signal1<void, framepos_t> StartTimeChanged;
 671         static PBD::Signal1<void, framepos_t> EndTimeChanged;
 672
 673         void   request_sync_source (Slave*);
 674         bool   synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
 675         bool   synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
 676         bool   synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
 677
 678         double transport_speed() const { return _transport_speed; }
 679         bool   transport_stopped() const { return _transport_speed == 0.0; }
 680         bool   transport_rolling() const { return _transport_speed != 0.0; }
 681
 682         bool silent () { return _silent; }
 683
 684         TempoMap&       tempo_map()       { return *_tempo_map; }
 685         const TempoMap& tempo_map() const { return *_tempo_map; }
 686
 687         unsigned int    get_xrun_count () const {return _xrun_count; }
 688         void            reset_xrun_count () {_xrun_count = 0; }
 689
 690         /* region info  */
 691
 692         boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
 693
 694         boost::shared_ptr<Region>      XMLRegionFactory (const XMLNode&, bool full);
 695         boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
 696         boost::shared_ptr<MidiRegion>  XMLMidiRegionFactory (const XMLNode&, bool full);
 697
 698         /* source management */
 699
 700         void import_files (ImportStatus&);
 701         bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
 702         std::string build_tmp_convert_name (std::string file);
 703
 704         boost::shared_ptr<ExportHandler> get_export_handler ();
 705         boost::shared_ptr<ExportStatus> get_export_status ();
 706
 707         int start_audio_export (framepos_t position, bool realtime = false);
 708
 709         PBD::Signal1<int, framecnt_t> ProcessExport;
 710         static PBD::Signal2<void,std::string, std::string> Exported;
 711
 712         void add_source (boost::shared_ptr<Source>);
 713         void remove_source (boost::weak_ptr<Source>);
 714
 715         void cleanup_regions();
 716         bool can_cleanup_peakfiles () const;
 717         int  cleanup_peakfiles ();
 718         int  cleanup_sources (CleanupReport&);
 719         int  cleanup_trash_sources (CleanupReport&);
 720
 721         int destroy_sources (std::list<boost::shared_ptr<Source> >);
 722
 723         int remove_last_capture ();
 724
 725         /** handlers should return 0 for "everything OK", and any other value for
 726          * "cannot setup audioengine".
 727          */
 728         static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
 729
 730         /** handlers should return -1 for "stop cleanup",
 731             0 for "yes, delete this playlist",
 732             1 for "no, don't delete this playlist".
 733         */
 734         static PBD::Signal1<int,boost::shared_ptr<Playlist> >  AskAboutPlaylistDeletion;
 735
 736         /** handlers should return 0 for "ignore the rate mismatch",
 737             !0 for "do not use this session"
 738         */
 739         static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
 740
 741         /** non interactive message */
 742         static PBD::Signal2<void, framecnt_t, framecnt_t> NotifyAboutSampleRateMismatch;
 743
 744         /** handlers should return !0 for use pending state, 0 for ignore it.
 745          */
 746         static PBD::Signal0<int> AskAboutPendingState;
 747
 748         boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
 749                 size_t, std::string const &, uint32_t, bool destructive);
 750
 751         boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
 752         boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
 753
 754         boost::shared_ptr<Source> source_by_id (const PBD::ID&);
 755         boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
 756         boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
 757         uint32_t count_sources_by_origin (const std::string&);
 758
 759         void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
 760
 761         /* Curves and AutomationLists (TODO when they go away) */
 762         void add_automation_list(AutomationList*);
 763
 764         /* auditioning */
 765
 766         boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
 767         void audition_playlist ();
 768         void audition_region (boost::shared_ptr<Region>);
 769         void cancel_audition ();
 770         bool is_auditioning () const;
 771
 772         PBD::Signal1<void,bool> AuditionActive;
 773
 774         /* session script */
 775         void register_lua_function (const std::string&, const std::string&, const LuaScriptParamList&);
 776         void unregister_lua_function (const std::string& name);
 777         std::vector<std::string> registered_lua_functions ();
 778         uint32_t registered_lua_function_count () const { return _n_lua_scripts; }
 779         void scripts_changed (); // called from lua, updates _n_lua_scripts
 780
 781         /* flattening stuff */
 782
 783         boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
 784                                                    bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
 785                                                    boost::shared_ptr<Processor> endpoint,
 786                                                    bool include_endpoint, bool for_export, bool for_freeze);
 787         int freeze_all (InterThreadInfo&);
 788
 789         /* session-wide solo/mute/rec-enable */
 790
 791         bool soloing() const { return _non_soloed_outs_muted; }
 792         bool listening() const { return _listen_cnt > 0; }
 793         bool solo_isolated() const { return _solo_isolated_cnt > 0; }
 794         void cancel_all_solo ();
 795
 796         static const SessionEvent::RTeventCallback rt_cleanup;
 797
 798         void clear_all_solo_state (boost::shared_ptr<RouteList>);
 799
 800         /* Control-based methods */
 801
 802         void set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition);
 803         void set_control (boost::shared_ptr<AutomationControl>, double val, PBD::Controllable::GroupControlDisposition);
 804
 805         void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others = false);
 806
 807         PBD::Signal1<void,bool> SoloActive;
 808         PBD::Signal0<void> SoloChanged;
 809         PBD::Signal0<void> IsolatedChanged;
 810         PBD::Signal0<void> MonitorChanged;
 811
 812         PBD::Signal0<void> session_routes_reconnected;
 813
 814         /* monitor/master out */
 815
 816         void add_monitor_section ();
 817         void reset_monitor_section ();
 818         void remove_monitor_section ();
 819         bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
 820
 821         boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
 822         boost::shared_ptr<Route> master_out() const { return _master_out; }
 823
 824         void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
 825         void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
 826         void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
 827         void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
 828         void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
 829         void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
 830         void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
 831
 832         static void set_disable_all_loaded_plugins (bool yn) {
 833                 _disable_all_loaded_plugins = yn;
 834         }
 835         static bool get_disable_all_loaded_plugins() {
 836                 return _disable_all_loaded_plugins;
 837         }
 838         static void set_bypass_all_loaded_plugins (bool yn) {
 839                 _bypass_all_loaded_plugins = yn;
 840         }
 841         static bool get_bypass_all_loaded_plugins() {
 842                 return _bypass_all_loaded_plugins;
 843         }
 844
 845         uint32_t next_send_id();
 846         uint32_t next_aux_send_id();
 847         uint32_t next_return_id();
 848         uint32_t next_insert_id();
 849         void mark_send_id (uint32_t);
 850         void mark_aux_send_id (uint32_t);
 851         void mark_return_id (uint32_t);
 852         void mark_insert_id (uint32_t);
 853         void unmark_send_id (uint32_t);
 854         void unmark_aux_send_id (uint32_t);
 855         void unmark_return_id (uint32_t);
 856         void unmark_insert_id (uint32_t);
 857
 858         /* s/w "RAID" management */
 859
 860         boost::optional<framecnt_t> available_capture_duration();
 861
 862         /* I/O bundles */
 863
 864         void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
 865         void remove_bundle (boost::shared_ptr<Bundle>);
 866         boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
 867
 868         PBD::Signal0<void> BundleAddedOrRemoved;
 869
 870         void midi_panic ();
 871
 872         /* History (for editors, mixers, UIs etc.) */
 873
 874         /** Undo some transactions.
 875          * @param n Number of transactions to undo.
 876          */
 877         void undo (uint32_t n) {
 878                 _history.undo (n);
 879         }
 880
 881         void redo (uint32_t n) {
 882                 _history.redo (n);
 883         }
 884
 885         UndoHistory& history() { return _history; }
 886
 887         uint32_t undo_depth() const { return _history.undo_depth(); }
 888         uint32_t redo_depth() const { return _history.redo_depth(); }
 889         std::string next_undo() const { return _history.next_undo(); }
 890         std::string next_redo() const { return _history.next_redo(); }
 891
 892         /** begin collecting undo information
 893          *
 894          * This call must always be followed by either
 895          * begin_reversible_command() or commit_reversible_command()
 896          *
 897          * @param cmd_name human readable name for the undo operation
 898          */
 899         void begin_reversible_command (const std::string& cmd_name);
 900         void begin_reversible_command (GQuark);
 901         /** abort an open undo command
 902          * This must only be called after begin_reversible_command ()
 903          */
 904         void abort_reversible_command ();
 905         /** finalize an undo command and commit pending transactions
 906          *
 907          * This must only be called after begin_reversible_command ()
 908          * @param cmd (additional) command to add
 909          */
 910         void commit_reversible_command (Command* cmd = 0);
 911
 912         void add_command (Command *const cmd);
 913
 914         /** create an StatefulDiffCommand from the given object and add it to the stack.
 915          *
 916          * This function must only be called after  begin_reversible_command.
 917          * Failing to do so may lead to a crash.
 918          *
 919          * @param sfd the object to diff
 920          * @returns the allocated StatefulDiffCommand (already added via add_command)
 921          */
 922         PBD::StatefulDiffCommand* add_stateful_diff_command (boost::shared_ptr<PBD::StatefulDestructible> sfd);
 923
 924         /** @return The list of operations that are currently in progress */
 925         std::list<GQuark> const & current_operations () {
 926                 return _current_trans_quarks;
 927         }
 928
 929         bool operation_in_progress (GQuark) const;
 930
 931         void add_commands (std::vector<Command*> const & cmds);
 932
 933         std::map<PBD::ID,PBD::StatefulDestructible*> registry;
 934
 935         // these commands are implemented in libs/ardour/session_command.cc
 936         Command* memento_command_factory(XMLNode* n);
 937         Command* stateful_diff_command_factory (XMLNode *);
 938         void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
 939
 940         /* clicking */
 941
 942         boost::shared_ptr<IO> click_io() { return _click_io; }
 943         boost::shared_ptr<Amp> click_gain() { return _click_gain; }
 944
 945         /* disk, buffer loads */
 946
 947         uint32_t playback_load ();
 948         uint32_t capture_load ();
 949
 950         /* ranges */
 951
 952         void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
 953         void request_cancel_play_range ();
 954         bool get_play_range () const { return _play_range; }
 955
 956         void maybe_update_session_range (framepos_t, framepos_t);
 957
 958         /* temporary hacks to allow selection to be pushed from GUI into backend.
 959            Whenever we move the selection object into libardour, these will go away.
 960          */
 961         void set_range_selection (framepos_t start, framepos_t end);
 962         void set_object_selection (framepos_t start, framepos_t end);
 963         void clear_range_selection ();
 964         void clear_object_selection ();
 965
 966         /* buffers for gain and pan */
 967
 968         gain_t* gain_automation_buffer () const;
 969         gain_t* trim_automation_buffer () const;
 970         gain_t* send_gain_automation_buffer () const;
 971         pan_t** pan_automation_buffer () const;
 972
 973         void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
 974
 975         /* VST support */
 976
 977         static int  vst_current_loading_id;
 978         static const char* vst_can_do_strings[];
 979         static const int vst_can_do_string_count;
 980
 981         static intptr_t vst_callback (
 982                 AEffect* effect,
 983                 int32_t opcode,
 984                 int32_t index,
 985                 intptr_t value,
 986                 void* ptr,
 987                 float opt
 988                 );
 989
 990         static PBD::Signal0<void> SendFeedback;
 991
 992         /* Speakers */
 993
 994         boost::shared_ptr<Speakers> get_speakers ();
 995
 996         /* Controllables */
 997
 998         boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
 999
1000         boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
1001         boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const ARDOUR::ControllableDescriptor&);
1002
1003         void add_controllable (boost::shared_ptr<PBD::Controllable>);
1004         void remove_controllable (PBD::Controllable*);
1005
1006         boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
1007
1008         SessionConfiguration config;
1009
1010         bool exporting () const {
1011                 return _exporting;
1012         }
1013
1014         bool bounce_processing() const {
1015                 return _bounce_processing_active;
1016         }
1017
1018         /* this is a private enum, but setup_enum_writer() needs it,
1019            and i can't find a way to give that function
1020            friend access. sigh.
1021         */
1022
1023         enum PostTransportWork {
1024                 PostTransportStop               = 0x1,
1025                 PostTransportDuration           = 0x2,
1026                 PostTransportLocate             = 0x4,
1027                 PostTransportRoll               = 0x8,
1028                 PostTransportAbort              = 0x10,
1029                 PostTransportOverWrite          = 0x20,
1030                 PostTransportSpeed              = 0x40,
1031                 PostTransportAudition           = 0x80,
1032                 PostTransportReverse            = 0x100,
1033                 PostTransportInputChange        = 0x200,
1034                 PostTransportCurveRealloc       = 0x400,
1035                 PostTransportClearSubstate      = 0x800,
1036                 PostTransportAdjustPlaybackBuffering  = 0x1000,
1037                 PostTransportAdjustCaptureBuffering   = 0x2000
1038         };
1039
1040         enum SlaveState {
1041                 Stopped,
1042                 Waiting,
1043                 Running
1044         };
1045
1046         SlaveState slave_state() const { return _slave_state; }
1047         Slave* slave() const { return _slave; }
1048
1049         boost::shared_ptr<SessionPlaylists> playlists;
1050
1051         void send_mmc_locate (framepos_t);
1052         void queue_full_time_code () { _send_timecode_update = true; }
1053         void queue_song_position_pointer () { /* currently does nothing */ }
1054
1055         bool step_editing() const { return (_step_editors > 0); }
1056
1057         void request_suspend_timecode_transmission ();
1058         void request_resume_timecode_transmission ();
1059         bool timecode_transmission_suspended () const;
1060
1061         std::vector<std::string> source_search_path(DataType) const;
1062         void ensure_search_path_includes (const std::string& path, DataType type);
1063         void remove_dir_from_search_path (const std::string& path, DataType type);
1064
1065         std::list<std::string> unknown_processors () const;
1066
1067         /** Emitted when a feedback cycle has been detected within Ardour's signal
1068             processing path.  Until it is fixed (by the user) some (unspecified)
1069             routes will not be run.
1070         */
1071         static PBD::Signal0<void> FeedbackDetected;
1072
1073         /** Emitted when a graph sort has successfully completed, which means
1074             that it has no feedback cycles.
1075         */
1076         static PBD::Signal0<void> SuccessfulGraphSort;
1077
1078         /* handlers can return an integer value:
1079            0: config.set_audio_search_path() or config.set_midi_search_path() was used
1080            to modify the search path and we should try to find it again.
1081            1: quit entire session load
1082            2: as 0, but don't ask about other missing files
1083            3: don't ask about other missing files, and just mark this one missing
1084            -1: just mark this one missing
1085            any other value: as -1
1086         */
1087         static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1088
1089         /** Emitted when the session wants Ardour to quit */
1090         static PBD::Signal0<void> Quit;
1091
1092         /** Emitted when Ardour is asked to load a session in an older session
1093          * format, and makes a backup copy.
1094          */
1095         static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1096
1097         SceneChanger* scene_changer() const { return _scene_changer; }
1098
1099         /* asynchronous MIDI control ports */
1100
1101         boost::shared_ptr<Port> midi_input_port () const;
1102         boost::shared_ptr<Port> midi_output_port () const;
1103         boost::shared_ptr<Port> mmc_output_port () const;
1104         boost::shared_ptr<Port> mmc_input_port () const;
1105         boost::shared_ptr<Port> scene_input_port () const;
1106         boost::shared_ptr<Port> scene_output_port () const;
1107
1108         /* synchronous MIDI ports used for synchronization */
1109
1110         boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1111         boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1112         boost::shared_ptr<MidiPort> mtc_output_port () const;
1113         boost::shared_ptr<MidiPort> mtc_input_port () const;
1114         boost::shared_ptr<Port> ltc_input_port() const;
1115         boost::shared_ptr<Port> ltc_output_port() const;
1116
1117         boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
1118         boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1119
1120         MIDI::MachineControl& mmc() { return *_mmc; }
1121
1122         void reconnect_midi_scene_ports (bool);
1123         void reconnect_mtc_ports ();
1124         void reconnect_mmc_ports (bool);
1125
1126         void reconnect_ltc_input ();
1127         void reconnect_ltc_output ();
1128
1129         VCAManager& vca_manager() { return *_vca_manager; }
1130
1131   protected:
1132         friend class AudioEngine;
1133         void set_block_size (pframes_t nframes);
1134         void set_frame_rate (framecnt_t nframes);
1135 #ifdef USE_TRACKS_CODE_FEATURES
1136         void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1137 #endif
1138
1139   protected:
1140         friend class Route;
1141         void schedule_curve_reallocation ();
1142         void update_latency_compensation (bool force = false);
1143
1144   private:
1145         int  create (const std::string& mix_template, BusProfile*);
1146         void destroy ();
1147
1148         static guint _name_id_counter;
1149         static void init_name_id_counter (guint n);
1150         static unsigned int name_id_counter ();
1151
1152         enum SubState {
1153                 PendingDeclickIn      = 0x1,  ///< pending de-click fade-in for start
1154                 PendingDeclickOut     = 0x2,  ///< pending de-click fade-out for stop
1155                 StopPendingCapture    = 0x4,
1156                 PendingLoopDeclickIn  = 0x8,  ///< pending de-click fade-in at the start of a loop
1157                 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
1158                 PendingLocate         = 0x20,
1159         };
1160
1161         /* stuff used in process() should be close together to
1162            maximise cache hits
1163         */
1164
1165         typedef void (Session::*process_function_type)(pframes_t);
1166
1167         AudioEngine&            _engine;
1168         mutable gint             processing_prohibited;
1169         process_function_type    process_function;
1170         process_function_type    last_process_function;
1171         bool                    _bounce_processing_active;
1172         bool                     waiting_for_sync_offset;
1173         framecnt_t              _base_frame_rate;     // sample-rate of the session at creation time, "native" SR
1174         framecnt_t              _nominal_frame_rate;  // overridden by audioengine setting
1175         framecnt_t              _current_frame_rate;  // this includes video pullup offset
1176         int                      transport_sub_state;
1177         mutable gint            _record_status;
1178         framepos_t              _transport_frame;
1179         Location*               _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1180         bool                    _session_range_end_is_free;
1181         Slave*                  _slave;
1182         bool                    _silent;
1183
1184         // varispeed playback
1185         double                  _transport_speed;
1186         double                  _default_transport_speed;
1187         double                  _last_transport_speed;
1188         double                  _signalled_varispeed;
1189         double                  _target_transport_speed;
1190         CubicInterpolation       interpolation;
1191
1192         bool                     auto_play_legal;
1193         framepos_t              _last_slave_transport_frame;
1194         framecnt_t               maximum_output_latency;
1195         framepos_t              _requested_return_frame;
1196         pframes_t                current_block_size;
1197         framecnt_t              _worst_output_latency;
1198         framecnt_t              _worst_input_latency;
1199         framecnt_t              _worst_track_latency;
1200         bool                    _have_captured;
1201         bool                    _non_soloed_outs_muted;
1202         bool                    _listening;
1203         uint32_t                _listen_cnt;
1204         uint32_t                _solo_isolated_cnt;
1205         bool                    _writable;
1206         bool                    _was_seamless;
1207         bool                    _under_nsm_control;
1208         unsigned int            _xrun_count;
1209
1210         void mtc_status_changed (bool);
1211         PBD::ScopedConnection mtc_status_connection;
1212         void ltc_status_changed (bool);
1213         PBD::ScopedConnection ltc_status_connection;
1214
1215         void initialize_latencies ();
1216         void set_worst_io_latencies ();
1217         void set_worst_playback_latency ();
1218         void set_worst_capture_latency ();
1219         void set_worst_io_latencies_x (IOChange, void *) {
1220                 set_worst_io_latencies ();
1221         }
1222         void post_capture_latency ();
1223         void post_playback_latency ();
1224
1225         void update_latency_compensation_proxy (void* ignored);
1226
1227         void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1228
1229         void process_scrub          (pframes_t);
1230         void process_without_events (pframes_t);
1231         void process_with_events    (pframes_t);
1232         void process_audition       (pframes_t);
1233         void process_export         (pframes_t);
1234         void process_export_fw      (pframes_t);
1235
1236         void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1237         void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1238         bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1239
1240         static const framecnt_t bounce_chunk_size;
1241
1242         /* slave tracking */
1243
1244         static const int delta_accumulator_size = 25;
1245         int delta_accumulator_cnt;
1246         int32_t delta_accumulator[delta_accumulator_size];
1247         int32_t average_slave_delta;
1248         int  average_dir;
1249         bool have_first_delta_accumulator;
1250
1251         SlaveState _slave_state;
1252         gint _mtc_active;
1253         gint _ltc_active;
1254         framepos_t slave_wait_end;
1255
1256         void reset_slave_state ();
1257         bool follow_slave (pframes_t);
1258         void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1259         void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1260         void follow_slave_silently (pframes_t nframes, float slave_speed);
1261
1262         void switch_to_sync_source (SyncSource); /* !RT context */
1263         void drop_sync_source ();  /* !RT context */
1264         void use_sync_source (Slave*); /* RT context */
1265
1266         bool post_export_sync;
1267         framepos_t post_export_position;
1268
1269         bool _exporting;
1270         bool _export_rolling;
1271         bool _realtime_export;
1272         framepos_t _export_preroll;
1273         framepos_t _export_latency;
1274
1275         boost::shared_ptr<ExportHandler> export_handler;
1276         boost::shared_ptr<ExportStatus>  export_status;
1277
1278         int  pre_export ();
1279         int  stop_audio_export ();
1280         void finalize_audio_export ();
1281         void finalize_export_internal (bool stop_freewheel);
1282         bool _pre_export_mmc_enabled;
1283
1284         PBD::ScopedConnection export_freewheel_connection;
1285
1286         void get_track_statistics ();
1287         int  process_routes (pframes_t, bool& need_butler);
1288         int  silent_process_routes (pframes_t, bool& need_butler);
1289
1290         /** @return 1 if there is a pending declick fade-in,
1291             -1 if there is a pending declick fade-out,
1292             0 if there is no pending declick.
1293         */
1294         int get_transport_declick_required () {
1295                 if (transport_sub_state & PendingDeclickIn) {
1296                         transport_sub_state &= ~PendingDeclickIn;
1297                         return 1;
1298                 } else if (transport_sub_state & PendingDeclickOut) {
1299                         /* XXX: not entirely sure why we don't clear this */
1300                         return -1;
1301                 } else if (transport_sub_state & PendingLoopDeclickOut) {
1302                         /* Return the declick out first ... */
1303                         transport_sub_state &= ~PendingLoopDeclickOut;
1304                         return -1;
1305                 } else if (transport_sub_state & PendingLoopDeclickIn) {
1306                         /* ... then the declick in on the next call */
1307                         transport_sub_state &= ~PendingLoopDeclickIn;
1308                         return 1;
1309                 } else {
1310                         return 0;
1311                 }
1312         }
1313
1314         bool maybe_stop (framepos_t limit);
1315         bool maybe_sync_start (pframes_t &);
1316
1317         void check_declick_out ();
1318
1319         std::string             _path;
1320         std::string             _name;
1321         bool                    _is_new;
1322         bool                    _send_qf_mtc;
1323         /** Number of process frames since the last MTC output (when sending MTC); used to
1324          *  know when to send full MTC messages every so often.
1325          */
1326         pframes_t               _pframes_since_last_mtc;
1327         bool                     session_midi_feedback;
1328         bool                     play_loop;
1329         bool                     loop_changing;
1330         framepos_t               last_loopend;
1331
1332         boost::scoped_ptr<SessionDirectory> _session_dir;
1333
1334         void hookup_io ();
1335         void graph_reordered ();
1336
1337         /** current snapshot name, without the .ardour suffix */
1338         void set_snapshot_name (const std::string &);
1339         void save_snapshot_name (const std::string &);
1340         std::string _current_snapshot_name;
1341
1342         XMLTree*         state_tree;
1343         bool             state_was_pending;
1344         StateOfTheState _state_of_the_state;
1345
1346         friend class    StateProtector;
1347         gint            _suspend_save; /* atomic */
1348         volatile bool   _save_queued;
1349         Glib::Threads::Mutex save_state_lock;
1350         Glib::Threads::Mutex peak_cleanup_lock;
1351
1352         int      load_options (const XMLNode&);
1353         int      load_state (std::string snapshot_name);
1354
1355         framepos_t _last_roll_location;
1356         /** the session frame time at which we last rolled, located, or changed transport direction */
1357         framepos_t _last_roll_or_reversal_location;
1358         framepos_t _last_record_location;
1359
1360         bool              pending_locate_roll;
1361         framepos_t        pending_locate_frame;
1362         bool              pending_locate_flush;
1363         bool              pending_abort;
1364         bool              pending_auto_loop;
1365
1366         PBD::ReallocPool _mempool;
1367         LuaState lua;
1368         Glib::Threads::Mutex lua_lock;
1369         luabridge::LuaRef * _lua_run;
1370         luabridge::LuaRef * _lua_add;
1371         luabridge::LuaRef * _lua_del;
1372         luabridge::LuaRef * _lua_list;
1373         luabridge::LuaRef * _lua_load;
1374         luabridge::LuaRef * _lua_save;
1375         luabridge::LuaRef * _lua_cleanup;
1376         uint32_t            _n_lua_scripts;
1377
1378         void setup_lua ();
1379         void try_run_lua (pframes_t);
1380
1381         Butler* _butler;
1382
1383         static const PostTransportWork ProcessCannotProceedMask =
1384                 PostTransportWork (
1385                         PostTransportInputChange|
1386                         PostTransportSpeed|
1387                         PostTransportReverse|
1388                         PostTransportCurveRealloc|
1389                         PostTransportAudition|
1390                         PostTransportLocate|
1391                         PostTransportStop|
1392                         PostTransportClearSubstate);
1393
1394         gint _post_transport_work; /* accessed only atomic ops */
1395         PostTransportWork post_transport_work() const        { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1396         void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1397         void add_post_transport_work (PostTransportWork ptw);
1398
1399         void schedule_playback_buffering_adjustment ();
1400         void schedule_capture_buffering_adjustment ();
1401
1402         uint32_t    cumulative_rf_motion;
1403         uint32_t    rf_scale;
1404
1405         void set_rf_speed (float speed);
1406         void reset_rf_scale (framecnt_t frames_moved);
1407
1408         Locations*       _locations;
1409         void location_added (Location*);
1410         void location_removed (Location*);
1411         void locations_changed ();
1412         void _locations_changed (const Locations::LocationList&);
1413
1414         void update_skips (Location*, bool consolidate);
1415         void update_marks (Location* loc);
1416         void consolidate_skips (Location*);
1417         void sync_locations_to_skips ();
1418         void _sync_locations_to_skips ();
1419
1420         PBD::ScopedConnectionList skip_update_connections;
1421         bool _ignore_skips_updates;
1422
1423         PBD::ScopedConnectionList punch_connections;
1424         void             auto_punch_start_changed (Location *);
1425         void             auto_punch_end_changed (Location *);
1426         void             auto_punch_changed (Location *);
1427
1428         PBD::ScopedConnectionList loop_connections;
1429         void             auto_loop_changed (Location *);
1430         void             auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1431
1432         int  ensure_engine (uint32_t desired_sample_rate, bool);
1433         void pre_engine_init (std::string path);
1434         int  post_engine_init ();
1435         int  immediately_post_engine ();
1436         void remove_empty_sounds ();
1437
1438         void session_loaded ();
1439
1440         void setup_midi_control ();
1441         int  midi_read (MIDI::Port *);
1442
1443         void enable_record ();
1444
1445         void increment_transport_position (framecnt_t val) {
1446                 if (max_framepos - val < _transport_frame) {
1447                         _transport_frame = max_framepos;
1448                 } else {
1449                         _transport_frame += val;
1450                 }
1451         }
1452
1453         void decrement_transport_position (framecnt_t val) {
1454                 if (val < _transport_frame) {
1455                         _transport_frame -= val;
1456                 } else {
1457                         _transport_frame = 0;
1458                 }
1459         }
1460
1461         void post_transport_motion ();
1462         static void *session_loader_thread (void *arg);
1463
1464         void *do_work();
1465
1466         /* Signal Forwarding */
1467         void emit_route_signals ();
1468         void emit_thread_run ();
1469         static void *emit_thread (void *);
1470         void emit_thread_start ();
1471         void emit_thread_terminate ();
1472
1473         pthread_t       _rt_emit_thread;
1474         bool            _rt_thread_active;
1475
1476         pthread_mutex_t _rt_emit_mutex;
1477         pthread_cond_t  _rt_emit_cond;
1478         bool            _rt_emit_pending;
1479
1480         /* Auto Connect Thread */
1481         static void *auto_connect_thread (void *);
1482         void auto_connect_thread_run ();
1483         void auto_connect_thread_start ();
1484         void auto_connect_thread_terminate ();
1485
1486         pthread_t       _auto_connect_thread;
1487         bool            _ac_thread_active;
1488         pthread_mutex_t _auto_connect_mutex;
1489         pthread_cond_t  _auto_connect_cond;
1490
1491         struct AutoConnectRequest {
1492                 public:
1493                 AutoConnectRequest (boost::shared_ptr <Route> r, bool ci,
1494                                 const ChanCount& is,
1495                                 const ChanCount& os,
1496                                 const ChanCount& io,
1497                                 const ChanCount& oo)
1498                         : route (boost::weak_ptr<Route> (r))
1499                         , connect_inputs (ci)
1500                         , input_start (is)
1501                         , output_start (os)
1502                         , input_offset (io)
1503                         , output_offset (oo)
1504                 {}
1505
1506                 boost::weak_ptr <Route> route;
1507                 bool connect_inputs;
1508                 ChanCount input_start;
1509                 ChanCount output_start;
1510                 ChanCount input_offset;
1511                 ChanCount output_offset;
1512         };
1513
1514         typedef std::queue<AutoConnectRequest> AutoConnectQueue;
1515         Glib::Threads::Mutex  _auto_connect_queue_lock;
1516         AutoConnectQueue _auto_connect_queue;
1517         guint _latency_recompute_pending;
1518
1519         void auto_connect (const AutoConnectRequest&);
1520         void queue_latency_recompute ();
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
1878         void auto_connect_master_bus ();
1879
1880         /* Windows VST support */
1881
1882         long _windows_vst_callback (
1883                 WindowsVSTPlugin*,
1884                 long opcode,
1885                 long index,
1886                 long value,
1887                 void* ptr,
1888                 float opt
1889                 );
1890
1891         int find_all_sources (std::string path, std::set<std::string>& result);
1892         int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1893
1894         typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1895         Glib::Threads::Mutex controllables_lock;
1896         Controllables controllables;
1897
1898         boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1899
1900         void reset_native_file_format();
1901         bool first_file_data_format_reset;
1902         bool first_file_header_format_reset;
1903
1904         void config_changed (std::string, bool);
1905
1906         XMLNode& get_control_protocol_state ();
1907
1908         void set_history_depth (uint32_t depth);
1909
1910         static bool _disable_all_loaded_plugins;
1911         static bool _bypass_all_loaded_plugins;
1912
1913         mutable bool have_looped; ///< Used in ::audible_frame(*)
1914
1915         void update_route_record_state ();
1916         gint _have_rec_enabled_track;
1917         gint _have_rec_disabled_track;
1918
1919         static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1920
1921         /* realtime "apply to set of routes" operations */
1922         template<typename T> SessionEvent*
1923                 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1924                               void (Session::*method) (boost::shared_ptr<RouteList>, T, PBD::Controllable::GroupControlDisposition)) {
1925                 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1926                 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1927                 ev->rt_return = after;
1928                 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1929
1930                 return ev;
1931         }
1932
1933         /* specialized version realtime "apply to set of routes" operations */
1934         template<typename T1, typename T2> SessionEvent*
1935                 get_rt_event (boost::shared_ptr<RouteList> rl, T1 t1arg, T2 t2arg, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1936                               void (Session::*method) (boost::shared_ptr<RouteList>, T1, T2, PBD::Controllable::GroupControlDisposition)) {
1937                 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1938                 ev->rt_slot = boost::bind (method, this, rl, t1arg, t2arg, group_override);
1939                 ev->rt_return = after;
1940                 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1941
1942                 return ev;
1943         }
1944
1945         /* specialized version realtime "apply to set of controls" operations */
1946         SessionEvent* get_rt_event (boost::shared_ptr<ControlList> cl, double arg, PBD::Controllable::GroupControlDisposition group_override) {
1947                 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1948                 ev->rt_slot = boost::bind (&Session::rt_set_controls, this, cl, arg, group_override);
1949                 ev->rt_return = Session::rt_cleanup;
1950                 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1951
1952                 return ev;
1953         }
1954
1955         void rt_set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition group_override);
1956         void rt_clear_all_solo_state (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1957
1958         /** temporary list of Diskstreams used only during load of 2.X sessions */
1959         std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1960
1961         void set_session_range_location (framepos_t, framepos_t);
1962
1963         void setup_midi_machine_control ();
1964
1965         void step_edit_status_change (bool);
1966         uint32_t _step_editors;
1967
1968         /** true if timecode transmission by the transport is suspended, otherwise false */
1969         mutable gint _suspend_timecode_transmission;
1970
1971         void update_locations_after_tempo_map_change (const Locations::LocationList &);
1972
1973         void start_time_changed (framepos_t);
1974         void end_time_changed (framepos_t);
1975
1976         void set_track_monitor_input_status (bool);
1977         framepos_t compute_stop_limit () const;
1978
1979         boost::shared_ptr<Speakers> _speakers;
1980         void load_nested_sources (const XMLNode& node);
1981
1982         /** The directed graph of routes that is currently being used for audio processing
1983             and solo/mute computations.
1984         */
1985         GraphEdges _current_route_graph;
1986
1987         void ensure_route_presentation_info_gap (PresentationInfo::order_t, uint32_t gap_size);
1988         bool ignore_route_processor_changes;
1989
1990         MidiClockTicker* midi_clock;
1991
1992         boost::shared_ptr<IO>   _ltc_input;
1993         boost::shared_ptr<IO>   _ltc_output;
1994
1995         /* Scene Changing */
1996         SceneChanger* _scene_changer;
1997
1998         /* persistent, non-track related MIDI ports */
1999         MidiPortManager* _midi_ports;
2000         MIDI::MachineControl* _mmc;
2001
2002         void setup_ltc ();
2003         void setup_click ();
2004         void setup_click_state (const XMLNode*);
2005         void setup_bundles ();
2006
2007         void save_as_bring_callback (uint32_t, uint32_t, std::string);
2008
2009         static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
2010         static const uint32_t session_end_shift;
2011
2012         std::string _template_state_dir;
2013
2014         VCAManager* _vca_manager;
2015
2016         boost::shared_ptr<Route> get_midi_nth_route_by_id (PresentationInfo::order_t n) const;
2017
2018         std::string created_with;
2019 };
2020
2021
2022 } // namespace ARDOUR
2023
2024 #endif /* __ardour_session_h__ */