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