libs/ardour/ardour/session.h

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