#include <boost/utility.hpp>
-#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"
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 {
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<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); }
+ bool record_enabled() const { return g_atomic_int_get (const_cast<gint*>(&_record_enabled)); }
+ bool record_safe () const { return g_atomic_int_get (const_cast<gint*>(&_record_safe)); }
virtual void set_record_enabled (bool yn) = 0;
- virtual void get_input_sources () = 0;
+ virtual void set_record_safe (bool yn) = 0;
bool destructive() const { return _flags & Destructive; }
virtual int set_destructive (bool /*yn*/) { return -1; }
virtual void punch_out() {}
void non_realtime_set_speed ();
- virtual void non_realtime_locate (nframes_t /*location*/) {};
+ virtual void non_realtime_locate (framepos_t /*location*/) {};
virtual void playlist_modified ();
boost::shared_ptr<Playlist> playlist () { return _playlist; }
virtual int use_new_playlist () = 0;
virtual int use_copy_playlist () = 0;
- nframes_t current_capture_start() const { return capture_start_frame; }
- nframes_t current_capture_end() const { return capture_start_frame + capture_captured; }
- nframes_t get_capture_start_frame (uint32_t n=0);
- nframes_t get_captured_frames (uint32_t n=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) 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_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) = 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; }
void move_processor_automation (boost::weak_ptr<Processor>,
std::list<Evoral::RangeMove<framepos_t> > const &);
- /** For non-butler contexts (allocates temporary working buffers) */
- virtual int do_refill_with_alloc() = 0;
- virtual void set_block_size (nframes_t) = 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 {
return _pending_overwrite;
}
PBD::Signal0<void> RecordEnableChanged;
+ PBD::Signal0<void> RecordSafeChanged;
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;
virtual void set_pending_overwrite (bool) = 0;
virtual int overwrite_existing_buffers () = 0;
- virtual int internal_playback_seek (nframes_t distance) = 0;
- virtual int can_internal_playback_seek (nframes_t distance) = 0;
- virtual int rename_write_sources () = 0;
+ virtual int internal_playback_seek (framecnt_t distance) = 0;
+ 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;
- virtual int seek (nframes_t which_sample, bool complete_refill = false) = 0;
+ virtual int seek (framepos_t which_sample, bool complete_refill = false) = 0;
protected:
friend class Track;
- virtual int process (nframes_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:
struct CaptureTransition {
TransitionType type;
- nframes_t capture_val; ///< The start or end file frame position
+ framepos_t capture_val; ///< The start or end file frame position
};
/* The two central butler operations */
virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<framepos_t> > const &, bool);
virtual void transport_stopped_wallclock (struct tm&, time_t, bool abort) = 0;
- virtual void transport_looped (nframes_t transport_frame) = 0;
+ virtual void transport_looped (framepos_t transport_frame) = 0;
struct CaptureInfo {
- uint32_t start;
- uint32_t frames;
+ framepos_t start;
+ framecnt_t frames;
};
virtual int use_new_write_source (uint32_t n=0) = 0;
virtual int use_pending_capture_data (XMLNode& node) = 0;
- virtual void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record);
- virtual void prepare_record_status (nframes_t /*capture_start_frame*/) {}
+ 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 engage_record_safe ();
+ void disengage_record_safe ();
+
+ virtual bool prep_record_enable () = 0;
+ virtual bool prep_record_disable () = 0;
- void calculate_record_range(OverlapType ot, sframes_t transport_frame, nframes_t nframes,
- nframes_t& rec_nframes, nframes_t& rec_offset);
+ void calculate_record_range (
+ Evoral::OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
+ framecnt_t& rec_nframes, framecnt_t& rec_offset
+ );
- static nframes_t disk_io_chunk_frames;
- std::vector<CaptureInfo*> capture_info;
- Glib::Mutex capture_info_lock;
+ static framecnt_t disk_read_chunk_frames;
+ static framecnt_t disk_write_chunk_frames;
+
+ std::vector<CaptureInfo*> capture_info;
+ mutable Glib::Threads::Mutex capture_info_lock;
uint32_t i_am_the_modifier;
boost::shared_ptr<Playlist> _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;
- nframes_t capture_start_frame;
- nframes_t capture_captured;
+ /** 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;
- nframes_t first_recordable_frame;
- nframes_t last_recordable_frame;
+ 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;
- nframes_t overwrite_frame;
+ framepos_t overwrite_frame;
off_t overwrite_offset;
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;
- nframes_t file_frame;
- nframes_t playback_sample;
- nframes_t playback_distance;
-
- uint32_t _read_data_count;
- uint32_t _write_data_count;
+ /** The next frame position that we should be reading from in our playlist */
+ framepos_t file_frame;
+ framepos_t playback_sample;
bool in_set_state;
- AlignStyle _persistent_alignment_style;
- bool first_input_change;
- Glib::Mutex state_lock;
+ std::string _write_source_name;
- nframes_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 ();
+
+ 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 */
projects / ardour.git / blobdiff