Clarify ensure vs. request for JACK monitoring, naming-wise.
[ardour.git] / libs / ardour / ardour / diskstream.h
index 4eabe29d8527e585d7736060ae5b3611707a1589..c51210265696110df472faf7ceeb6808ca2a5989 100644 (file)
@@ -48,8 +48,11 @@ class Processor;
 class Source;
 class Session;
 class Track;
-class Location;        
+class Location;
 
+/** 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:
@@ -64,27 +67,31 @@ class Diskstream : public SessionObject, public PublicDiskstream
        Diskstream (Session &, const XMLNode&);
        virtual ~Diskstream();
 
-       bool set_name (const std::string& str);
+       virtual bool set_name (const std::string& str);
 
        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;
 
        void set_flag (Flag f)   { _flags = Flag (_flags | f); }
        void unset_flag (Flag f) { _flags = Flag (_flags & ~f); }
 
-       AlignStyle alignment_style() const { return _alignment_style; }
-       void       set_align_style (AlignStyle);
-       void       set_persistent_align_style (AlignStyle a) { _persistent_alignment_style = a; }
+       AlignStyle  alignment_style() const { return _alignment_style; }
+       AlignChoice alignment_choice() const { return _alignment_choice; }
+       void       set_align_style (AlignStyle, bool force=false);
+       void       set_align_choice (AlignChoice a, bool force=false);
 
-       nframes_t roll_delay() const { return _roll_delay; }
-       void      set_roll_delay (nframes_t);
+       framecnt_t roll_delay() const { return _roll_delay; }
+       void       set_roll_delay (framecnt_t);
 
        bool         record_enabled() const { return g_atomic_int_get (&_record_enabled); }
        virtual void set_record_enabled (bool yn) = 0;
-       virtual void get_input_sources () = 0;
 
        bool destructive() const { return _flags & Destructive; }
        virtual int set_destructive (bool /*yn*/) { return -1; }
@@ -118,16 +125,17 @@ class Diskstream : public SessionObject, public PublicDiskstream
 
        ChanCount n_channels() { return _n_channels; }
 
-       static nframes_t disk_io_frames() { return disk_io_chunk_frames; }
-       static void set_disk_io_chunk_frames (uint32_t n) { disk_io_chunk_frames = n; }
+       static framecnt_t disk_io_frames() { return disk_io_chunk_frames; }
+       static void set_disk_io_chunk_frames (framecnt_t n) { disk_io_chunk_frames = n; }
 
        /* Stateful */
-       virtual XMLNode& get_state(void) = 0;
-       virtual int      set_state(const XMLNode&, int version) = 0;
+       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) {}
 
-       nframes_t    capture_offset() const { return _capture_offset; }
+       framecnt_t   capture_offset() const { return _capture_offset; }
        virtual void set_capture_offset ();
 
        bool slaved() const      { return _slaved; }
@@ -144,7 +152,7 @@ class Diskstream : public SessionObject, public PublicDiskstream
 
        /** For non-butler contexts (allocates temporary working buffers) */
        virtual int do_refill_with_alloc() = 0;
-       virtual void set_block_size (nframes_t) = 0;
+       virtual void set_block_size (pframes_t) = 0;
 
        bool pending_overwrite () const {
                return _pending_overwrite;
@@ -172,13 +180,9 @@ class Diskstream : public SessionObject, public PublicDiskstream
        virtual int  overwrite_existing_buffers () = 0;
        virtual int  internal_playback_seek (framecnt_t distance) = 0;
        virtual int  can_internal_playback_seek (framecnt_t distance) = 0;
-       virtual int  rename_write_sources () = 0;
        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;
@@ -186,8 +190,8 @@ class Diskstream : public SessionObject, public PublicDiskstream
   protected:
        friend class Track;
 
-       virtual int  process (framepos_t transport_frame, nframes_t nframes, bool can_record, bool rec_monitors_input, bool& need_butler) = 0;
-       virtual bool commit  (nframes_t nframes) = 0;
+       virtual int  process (framepos_t transport_frame, pframes_t nframes, framecnt_t &) = 0;
+       virtual bool commit  (framecnt_t) = 0;
 
        //private:
 
@@ -215,8 +219,8 @@ class Diskstream : public SessionObject, public PublicDiskstream
        virtual void transport_looped (framepos_t transport_frame) = 0;
 
        struct CaptureInfo {
-            framepos_t start;
-            framecnt_t frames;
+               framepos_t start;
+               framecnt_t frames;
        };
 
        virtual int use_new_write_source (uint32_t n=0) = 0;
@@ -236,12 +240,12 @@ class Diskstream : public SessionObject, public PublicDiskstream
        virtual void set_align_style_from_io() {}
        virtual void setup_destructive_playlist () {}
        virtual void use_destructive_playlist () {}
-        virtual void prepare_to_stop (framepos_t pos);
+       virtual void prepare_to_stop (framepos_t pos);
 
        void calculate_record_range(OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
-                       nframes_t& rec_nframes, nframes_t& rec_offset);
+                       framecnt_t& rec_nframes, framecnt_t& rec_offset);
 
-       static nframes_t disk_io_chunk_frames;
+       static framecnt_t disk_io_chunk_frames;
        std::vector<CaptureInfo*> capture_info;
        mutable Glib::Mutex capture_info_lock;
 
@@ -260,19 +264,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;
-       nframes_t     adjust_capture_position;
-       nframes_t    _capture_offset;
-       nframes_t    _roll_delay;
+       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;
-       bool         _scrubbing;
+       AlignChoice  _alignment_choice;
        bool         _slaved;
        Location*     loop_location;
        framepos_t    overwrite_frame;
@@ -280,34 +286,26 @@ class Diskstream : public SessionObject, public PublicDiskstream
        bool          _pending_overwrite;
        bool          overwrite_queued;
        IOChange      input_change_pending;
-       nframes_t     wrap_buffer_size;
-       nframes_t     speed_buffer_size;
+       framecnt_t    wrap_buffer_size;
+       framecnt_t    speed_buffer_size;
 
        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;
-       AlignStyle   _persistent_alignment_style;
-       bool          first_input_change;
 
        Glib::Mutex state_lock;
 
-       framepos_t scrub_start;
-       nframes_t  scrub_buffer_size;
-       nframes_t  scrub_offset;
-
        PBD::ScopedConnectionList playlist_connections;
 
        PBD::ScopedConnection ic_connection;
 
        Flag _flags;
+       XMLNode* deprecated_io_node;
 
        void route_going_away ();
 };