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