advance track's play-position even if processing is locked

[ardour.git] / libs / ardour / ardour / diskstream.h

diff --git a/libs/ardour/ardour/diskstream.h b/libs/ardour/ardour/diskstream.h
index dad9501c8e60a60e6096381084c9a2180aa4c4c8..427b52b0545274f72b8c8e5a2947cbdc1328d9e7 100644 (file)
--- a/libs/ardour/ardour/diskstream.h
+++ b/libs/ardour/ardour/diskstream.h
@@ -49,7 +49,11 @@ class Source;
 class Session;
 class Track;
 class Location;
+class BufferSet;
 
+/** Parent class for classes which can stream data to and from disk.
+ *  These are used by Tracks to get playback and put recorded data.
+ */
 class Diskstream : public SessionObject, public PublicDiskstream
 {
   public:
@@ -69,6 +73,10 @@ class Diskstream : public SessionObject, public PublicDiskstream
        boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
        void set_track (ARDOUR::Track *);
 
+       /** @return A number between 0 and 1, where 0 indicates that the playback buffer
+        *  is dry (ie the disk subsystem could not keep up) and 1 indicates that the
+        *  buffer is full.
+        */
        virtual float playback_buffer_load() const = 0;
        virtual float capture_buffer_load() const = 0;
 
@@ -125,7 +133,8 @@ class Diskstream : public SessionObject, public PublicDiskstream
        virtual XMLNode& get_state(void);
        virtual int      set_state(const XMLNode&, int version);
 
-       virtual void monitor_input (bool) {}
+       virtual void request_jack_monitors_input (bool) {}
+       virtual void ensure_jack_monitors_input (bool) {}
 
        framecnt_t   capture_offset() const { return _capture_offset; }
        virtual void set_capture_offset ();
@@ -153,6 +162,7 @@ class Diskstream : public SessionObject, public PublicDiskstream
        PBD::Signal0<void>            RecordEnableChanged;
        PBD::Signal0<void>            SpeedChanged;
        PBD::Signal0<void>            ReverseChanged;
+       /* Emitted when this diskstream is set to use a different playlist */
        PBD::Signal0<void>            PlaylistChanged;
        PBD::Signal0<void>            AlignmentStyleChanged;
        PBD::Signal1<void,Location *> LoopSet;
@@ -175,9 +185,6 @@ class Diskstream : public SessionObject, public PublicDiskstream
        virtual void reset_write_sources (bool, bool force = false) = 0;
        virtual void non_realtime_input_change () = 0;
 
-       uint32_t read_data_count() const { return _read_data_count; }
-       uint32_t write_data_count() const { return _write_data_count; }
-
   protected:
        friend class Auditioner;
        virtual int  seek (framepos_t which_sample, bool complete_refill = false) = 0;
@@ -185,8 +192,9 @@ class Diskstream : public SessionObject, public PublicDiskstream
   protected:
        friend class Track;
 
-       virtual int  process (framepos_t transport_frame, pframes_t nframes, bool can_record, bool& need_butler) = 0;
-       virtual bool commit  (framecnt_t nframes) = 0;
+    virtual int  process (BufferSet&, framepos_t transport_frame, pframes_t nframes, framecnt_t &, bool need_disk_signal) = 0;
+    virtual frameoffset_t calculate_playback_distance (pframes_t nframes) = 0;
+       virtual bool commit  (framecnt_t) = 0;
 
        //private:
 
@@ -237,12 +245,20 @@ class Diskstream : public SessionObject, public PublicDiskstream
        virtual void use_destructive_playlist () {}
        virtual void prepare_to_stop (framepos_t pos);
 
-       void calculate_record_range(OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
-                       framecnt_t& rec_nframes, framecnt_t& rec_offset);
+       void engage_record_enable ();
+       void disengage_record_enable ();
+
+        virtual bool prep_record_enable () = 0;
+        virtual bool prep_record_disable () = 0;
+
+       void calculate_record_range (
+               Evoral::OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
+               framecnt_t& rec_nframes, framecnt_t& rec_offset
+               );
 
        static framecnt_t disk_io_chunk_frames;
        std::vector<CaptureInfo*> capture_info;
-       mutable Glib::Mutex capture_info_lock;
+       mutable Glib::Threads::Mutex capture_info_lock;
 
        uint32_t i_am_the_modifier;
 
@@ -259,20 +275,21 @@ class Diskstream : public SessionObject, public PublicDiskstream
        bool         _buffer_reallocation_required;
        bool         _seek_required;
 
-       bool          force_refill;
        /** Start of currently running capture in session frames */
        framepos_t    capture_start_frame;
        framecnt_t    capture_captured;
        bool          was_recording;
        framecnt_t    adjust_capture_position;
        framecnt_t   _capture_offset;
+       /** The number of frames by which this diskstream's output should be delayed
+           with respect to the transport frame.  This is used for latency compensation.
+       */
        framecnt_t   _roll_delay;
        framepos_t    first_recordable_frame;
        framepos_t    last_recordable_frame;
        int           last_possibly_recording;
        AlignStyle   _alignment_style;
        AlignChoice  _alignment_choice;
-       bool         _scrubbing;
        bool         _slaved;
        Location*     loop_location;
        framepos_t    overwrite_frame;
@@ -286,16 +303,13 @@ class Diskstream : public SessionObject, public PublicDiskstream
        double        _speed;
        double        _target_speed;
 
+       /** The next frame position that we should be reading from in our playlist */
        framepos_t     file_frame;
        framepos_t     playback_sample;
-       framecnt_t     playback_distance;
-
-       uint32_t     _read_data_count;
-       uint32_t     _write_data_count;
 
        bool          in_set_state;
 
-       Glib::Mutex state_lock;
+       Glib::Threads::Mutex state_lock;
 
        PBD::ScopedConnectionList playlist_connections;