X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Fdiskstream.h;h=404aceec5e9075e78df1d3bdbf71974d8ca12926;hb=f756dc69f41c6950f5c573401ebbd767be493f01;hp=deb81d48376d172320bfa631bcfcd3a007f18e26;hpb=d901dbccc912314b54494fab068785c188884fe4;p=ardour.git diff --git a/libs/ardour/ardour/diskstream.h b/libs/ardour/ardour/diskstream.h index deb81d4837..404aceec5e 100644 --- a/libs/ardour/ardour/diskstream.h +++ b/libs/ardour/ardour/diskstream.h @@ -29,11 +29,12 @@ #include -#include "evoral/types.hpp" +#include "evoral/Range.hpp" #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 { @@ -65,10 +70,25 @@ class Diskstream : public SessionObject, public PublicDiskstream virtual ~Diskstream(); 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; @@ -83,17 +103,21 @@ class Diskstream : public SessionObject, public PublicDiskstream 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); } + bool record_enabled() const { return g_atomic_int_get (const_cast(&_record_enabled)); } + bool record_safe () const { return g_atomic_int_get (const_cast(&_record_safe)); } virtual void set_record_enabled (bool yn) = 0; + virtual void set_record_safe (bool yn) = 0; bool destructive() const { return _flags & Destructive; } +#ifdef XXX_OLD_DESTRUCTIVE_API_XXX virtual int set_destructive (bool /*yn*/) { return -1; } virtual int set_non_layered (bool /*yn*/) { return -1; } virtual bool can_become_destructive (bool& /*requires_bounce*/) const { return false; } +#endif bool hidden() const { return _flags & Hidden; } bool recordable() const { return _flags & Recordable; } - bool non_layered() const { return _flags & NonLayered; } + bool non_layered() const; // { return _flags & NonLayered; } bool reversed() const { return _actual_speed < 0.0f; } double speed() const { return _visible_speed; } @@ -118,14 +142,21 @@ class Diskstream : public SessionObject, public PublicDiskstream ChanCount n_channels() { return _n_channels; } - 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; } + static framecnt_t disk_read_frames() { return disk_read_chunk_frames; } + static framecnt_t disk_write_frames() { return disk_write_chunk_frames; } + static void set_disk_read_chunk_frames (framecnt_t n) { disk_read_chunk_frames = n; } + static void set_disk_write_chunk_frames (framecnt_t n) { disk_write_chunk_frames = n; } + static framecnt_t default_disk_read_chunk_frames (); + static framecnt_t default_disk_write_chunk_frames (); + + static void set_buffering_parameters (BufferingPreset bp); /* Stateful */ 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) {} framecnt_t capture_offset() const { return _capture_offset; } virtual void set_capture_offset (); @@ -142,8 +173,15 @@ class Diskstream : public SessionObject, public PublicDiskstream void move_processor_automation (boost::weak_ptr, std::list > const &); - /** For non-butler contexts (allocates temporary working buffers) */ - virtual int do_refill_with_alloc() = 0; + /** For non-butler contexts (allocates temporary working buffers) + * + * This accessible method has a default argument; derived classes + * must inherit the virtual method that we call which does NOT + * have a default argument, to avoid complications with inheritance + */ + int do_refill_with_alloc(bool partial_fill = true) { + return _do_refill_with_alloc (partial_fill); + } virtual void set_block_size (pframes_t) = 0; bool pending_overwrite () const { @@ -151,8 +189,10 @@ class Diskstream : public SessionObject, public PublicDiskstream } PBD::Signal0 RecordEnableChanged; + PBD::Signal0 RecordSafeChanged; 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; @@ -174,9 +214,11 @@ class Diskstream : public SessionObject, public PublicDiskstream virtual int can_internal_playback_seek (framecnt_t distance) = 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; } + /* accessible method has default argument, so use standard C++ "trick" + to avoid complications with inheritance, by adding this virtual + method which does NOT have a default argument. + */ + virtual int _do_refill_with_alloc (bool partial_fill) = 0; protected: friend class Auditioner; @@ -185,8 +227,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 rec_monitors_input, 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: @@ -214,8 +257,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; @@ -235,14 +278,26 @@ 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 transport_pos, framepos_t audible_frame); - 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 (); + void engage_record_safe (); + void disengage_record_safe (); + + 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_read_chunk_frames; + static framecnt_t disk_write_chunk_frames; - static framecnt_t disk_io_chunk_frames; std::vector capture_info; - mutable Glib::Mutex capture_info_lock; + mutable Glib::Threads::Mutex capture_info_lock; uint32_t i_am_the_modifier; @@ -252,27 +307,29 @@ class Diskstream : public SessionObject, public PublicDiskstream boost::shared_ptr _playlist; - mutable gint _record_enabled; + gint _record_enabled; + gint _record_safe; double _visible_speed; double _actual_speed; /* items needed for speed change logic */ 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 +343,15 @@ 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; + std::string _write_source_name; + + Glib::Threads::Mutex state_lock; PBD::ScopedConnectionList playlist_connections; @@ -305,6 +361,12 @@ class Diskstream : public SessionObject, public PublicDiskstream XMLNode* deprecated_io_node; void route_going_away (); + + static bool get_buffering_presets (BufferingPreset bp, + framecnt_t& read_chunk_size, + framecnt_t& read_buffer_size, + framecnt_t& write_chunk_size, + framecnt_t& write_buffer_size); }; }; /* namespace ARDOUR */