X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Fdiskstream.h;h=c960e925c81046ce651a6288f34b90a027bde117;hb=8a128b33d38172ae525ac798c53bc105bc4e2c64;hp=240448a78b3c65ced1b3b20aa678651b6a315c83;hpb=10bdce85a0e7381d1b5db38e3640600c6fd3ec79;p=ardour.git diff --git a/libs/ardour/ardour/diskstream.h b/libs/ardour/ardour/diskstream.h index 240448a78b..c960e925c8 100644 --- a/libs/ardour/ardour/diskstream.h +++ b/libs/ardour/ardour/diskstream.h @@ -34,6 +34,7 @@ #include "ardour/ardour.h" #include "ardour/chan_count.h" #include "ardour/session_object.h" +#include "ardour/libardour_visibility.h" #include "ardour/types.h" #include "ardour/utils.h" #include "ardour/public_diskstream.h" @@ -48,9 +49,13 @@ class Processor; class Source; class Session; class Track; -class Location; +class Location; +class BufferSet; -class Diskstream : public SessionObject, public PublicDiskstream +/** 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 LIBARDOUR_API Diskstream : public SessionObject, public PublicDiskstream { public: enum Flag { @@ -64,27 +69,42 @@ 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); + virtual bool set_write_source_name (const std::string& str); + + std::string write_source_name () const { + if (_write_source_name.empty()) { + return name(); + } else { + return _write_source_name; + } + } + + virtual std::string steal_write_source_name () { return std::string(); } boost::shared_ptr 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; } @@ -110,23 +130,25 @@ class Diskstream : public SessionObject, public PublicDiskstream virtual int use_new_playlist () = 0; virtual int use_copy_playlist () = 0; + /** @return Start position of currently-running capture (in session frames) */ framepos_t current_capture_start() const { return capture_start_frame; } framepos_t current_capture_end() const { return capture_start_frame + capture_captured; } - framepos_t get_capture_start_frame (uint32_t n=0); - framecnt_t get_captured_frames (uint32_t n=0); + framepos_t get_capture_start_frame (uint32_t n = 0) const; + framecnt_t get_captured_frames (uint32_t n = 0) const; 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_input_monitoring (bool) {} + virtual void ensure_input_monitoring (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; } @@ -143,7 +165,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; @@ -152,6 +174,7 @@ class Diskstream : public SessionObject, public PublicDiskstream PBD::Signal0 RecordEnableChanged; PBD::Signal0 SpeedChanged; PBD::Signal0 ReverseChanged; + /* Emitted when this diskstream is set to use a different playlist */ PBD::Signal0 PlaylistChanged; PBD::Signal0 AlignmentStyleChanged; PBD::Signal1 LoopSet; @@ -171,13 +194,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; @@ -185,8 +204,9 @@ 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 (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: @@ -214,8 +234,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; @@ -230,19 +250,27 @@ class Diskstream : public SessionObject, public PublicDiskstream virtual int use_pending_capture_data (XMLNode& node) = 0; - virtual void check_record_status (framepos_t transport_frame, nframes_t nframes, bool can_record); + virtual void check_record_status (framepos_t transport_frame, bool can_record); virtual void prepare_record_status (framepos_t /*capture_start_frame*/) {} 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 transport_pos, framepos_t audible_frame); + + void engage_record_enable (); + void disengage_record_enable (); - void calculate_record_range(OverlapType ot, framepos_t transport_frame, framecnt_t nframes, - nframes_t& rec_nframes, nframes_t& rec_offset); + virtual bool prep_record_enable () = 0; + virtual bool prep_record_disable () = 0; - static nframes_t disk_io_chunk_frames; - std::vector capture_info; - Glib::Mutex capture_info_lock; + 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 capture_info; + mutable Glib::Threads::Mutex capture_info_lock; uint32_t i_am_the_modifier; @@ -259,18 +287,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; @@ -278,34 +309,28 @@ 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; + std::string _write_source_name; - framepos_t scrub_start; - nframes_t scrub_buffer_size; - nframes_t scrub_offset; + Glib::Threads::Mutex state_lock; PBD::ScopedConnectionList playlist_connections; PBD::ScopedConnection ic_connection; Flag _flags; + XMLNode* deprecated_io_node; void route_going_away (); };