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