2 Copyright (C) 2000-2006 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_diskstream_h__
21 #define __ardour_diskstream_h__
30 #include <boost/utility.hpp>
32 #include "evoral/Range.hpp"
34 #include "ardour/ardour.h"
35 #include "ardour/chan_count.h"
36 #include "ardour/session_object.h"
37 #include "ardour/libardour_visibility.h"
38 #include "ardour/types.h"
39 #include "ardour/utils.h"
40 #include "ardour/public_diskstream.h"
55 /** Parent class for classes which can stream data to and from disk.
56 * These are used by Tracks to get playback and put recorded data.
58 class LIBARDOUR_API Diskstream : public SessionObject, public PublicDiskstream
68 Diskstream (Session &, const std::string& name, Flag f = Recordable);
69 Diskstream (Session &, const XMLNode&);
70 virtual ~Diskstream();
72 virtual bool set_name (const std::string& str);
73 virtual bool set_write_source_name (const std::string& str);
75 std::string write_source_name () const {
76 if (_write_source_name.empty()) {
79 return _write_source_name;
83 virtual std::string steal_write_source_name () { return std::string(); }
85 boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
86 void set_track (ARDOUR::Track *);
88 /** @return A number between 0 and 1, where 0 indicates that the playback buffer
89 * is dry (ie the disk subsystem could not keep up) and 1 indicates that the
92 virtual float playback_buffer_load() const = 0;
93 virtual float capture_buffer_load() const = 0;
95 void set_flag (Flag f) { _flags = Flag (_flags | f); }
96 void unset_flag (Flag f) { _flags = Flag (_flags & ~f); }
98 AlignStyle alignment_style() const { return _alignment_style; }
99 AlignChoice alignment_choice() const { return _alignment_choice; }
100 void set_align_style (AlignStyle, bool force=false);
101 void set_align_choice (AlignChoice a, bool force=false);
103 framecnt_t roll_delay() const { return _roll_delay; }
104 void set_roll_delay (framecnt_t);
106 bool record_enabled() const { return g_atomic_int_get (const_cast<gint*>(&_record_enabled)); }
107 bool record_safe () const { return g_atomic_int_get (const_cast<gint*>(&_record_safe)); }
108 virtual void set_record_enabled (bool yn) = 0;
109 virtual void set_record_safe (bool yn) = 0;
111 bool destructive() const { return _flags & Destructive; }
113 bool hidden() const { return _flags & Hidden; }
114 bool recordable() const { return _flags & Recordable; }
115 bool non_layered() const; // { return _flags & NonLayered; }
116 bool reversed() const { return _actual_speed < 0.0f; }
117 double speed() const { return _visible_speed; }
119 virtual void punch_in() {}
120 virtual void punch_out() {}
122 void non_realtime_set_speed ();
123 virtual void non_realtime_locate (framepos_t /*location*/) {};
124 virtual void playlist_modified ();
126 boost::shared_ptr<Playlist> playlist () { return _playlist; }
128 virtual int use_playlist (boost::shared_ptr<Playlist>);
129 virtual int use_new_playlist () = 0;
130 virtual int use_copy_playlist () = 0;
132 /** @return Start position of currently-running capture (in session frames) */
133 framepos_t current_capture_start() const { return capture_start_frame; }
134 framepos_t current_capture_end() const { return capture_start_frame + capture_captured; }
135 framepos_t get_capture_start_frame (uint32_t n = 0) const;
136 framecnt_t get_captured_frames (uint32_t n = 0) const;
138 ChanCount n_channels() { return _n_channels; }
140 static framecnt_t disk_read_frames() { return disk_read_chunk_frames; }
141 static framecnt_t disk_write_frames() { return disk_write_chunk_frames; }
142 static void set_disk_read_chunk_frames (framecnt_t n) { disk_read_chunk_frames = n; }
143 static void set_disk_write_chunk_frames (framecnt_t n) { disk_write_chunk_frames = n; }
144 static framecnt_t default_disk_read_chunk_frames ();
145 static framecnt_t default_disk_write_chunk_frames ();
147 static void set_buffering_parameters (BufferingPreset bp);
150 virtual XMLNode& get_state(void);
151 virtual int set_state(const XMLNode&, int version);
153 virtual void request_input_monitoring (bool) {}
154 virtual void ensure_input_monitoring (bool) {}
156 framecnt_t capture_offset() const { return _capture_offset; }
157 virtual void set_capture_offset ();
159 bool slaved() const { return _slaved; }
160 void set_slaved(bool yn) { _slaved = yn; }
162 int set_loop (Location *loc);
164 std::list<boost::shared_ptr<Source> >& last_capture_sources () { return _last_capture_sources; }
166 void handle_input_change (IOChange, void *src);
168 void move_processor_automation (boost::weak_ptr<Processor>,
169 std::list<Evoral::RangeMove<framepos_t> > const &);
171 /** For non-butler contexts (allocates temporary working buffers)
173 * This accessible method has a default argument; derived classes
174 * must inherit the virtual method that we call which does NOT
175 * have a default argument, to avoid complications with inheritance
177 int do_refill_with_alloc(bool partial_fill = true) {
178 return _do_refill_with_alloc (partial_fill);
180 virtual void set_block_size (pframes_t) = 0;
182 bool pending_overwrite () const {
183 return _pending_overwrite;
186 PBD::Signal0<void> RecordEnableChanged;
187 PBD::Signal0<void> RecordSafeChanged;
188 PBD::Signal0<void> SpeedChanged;
189 PBD::Signal0<void> ReverseChanged;
190 /* Emitted when this diskstream is set to use a different playlist */
191 PBD::Signal0<void> PlaylistChanged;
192 PBD::Signal0<void> AlignmentStyleChanged;
193 PBD::Signal1<void,Location *> LoopSet;
195 static PBD::Signal0<void> DiskOverrun;
196 static PBD::Signal0<void> DiskUnderrun;
199 friend class Session;
202 /* the Session is the only point of access for these because they require
203 * that the Session is "inactive" while they are called.
206 virtual void set_pending_overwrite (bool) = 0;
207 virtual int overwrite_existing_buffers () = 0;
208 virtual int internal_playback_seek (framecnt_t distance) = 0;
209 virtual int can_internal_playback_seek (framecnt_t distance) = 0;
210 virtual void reset_write_sources (bool, bool force = false) = 0;
211 virtual void non_realtime_input_change () = 0;
212 /* accessible method has default argument, so use standard C++ "trick"
213 to avoid complications with inheritance, by adding this virtual
214 method which does NOT have a default argument.
216 virtual int _do_refill_with_alloc (bool partial_fill) = 0;
219 friend class Auditioner;
220 virtual int seek (framepos_t which_sample, bool complete_refill = false) = 0;
225 virtual int process (BufferSet&, framepos_t transport_frame, pframes_t nframes, framecnt_t &, bool need_disk_signal) = 0;
226 virtual frameoffset_t calculate_playback_distance (pframes_t nframes) = 0;
227 virtual bool commit (framecnt_t) = 0;
231 enum TransitionType {
236 struct CaptureTransition {
238 framepos_t capture_val; ///< The start or end file frame position
241 /* The two central butler operations */
242 virtual int do_flush (RunContext context, bool force = false) = 0;
243 virtual int do_refill () = 0;
245 /* XXX fix this redundancy ... */
247 virtual void playlist_changed (const PBD::PropertyChange&);
248 virtual void playlist_deleted (boost::weak_ptr<Playlist>);
249 virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<framepos_t> > const &, bool);
251 virtual void transport_stopped_wallclock (struct tm&, time_t, bool abort) = 0;
252 virtual void transport_looped (framepos_t transport_frame) = 0;
259 virtual int use_new_write_source (uint32_t n=0) = 0;
261 virtual int find_and_use_playlist (const std::string&) = 0;
263 virtual void allocate_temporary_buffers () = 0;
265 virtual bool realtime_set_speed (double, bool global_change);
267 std::list<boost::shared_ptr<Source> > _last_capture_sources;
269 virtual int use_pending_capture_data (XMLNode& node) = 0;
271 virtual void check_record_status (framepos_t transport_frame, bool can_record);
272 virtual void prepare_record_status (framepos_t /*capture_start_frame*/) {}
273 virtual void set_align_style_from_io() {}
274 virtual void setup_destructive_playlist () {}
275 virtual void use_destructive_playlist () {}
276 virtual void prepare_to_stop (framepos_t transport_pos, framepos_t audible_frame);
278 void engage_record_enable ();
279 void disengage_record_enable ();
280 void engage_record_safe ();
281 void disengage_record_safe ();
283 virtual bool prep_record_enable () = 0;
284 virtual bool prep_record_disable () = 0;
286 void calculate_record_range (
287 Evoral::OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
288 framecnt_t& rec_nframes, framecnt_t& rec_offset
291 static framecnt_t disk_read_chunk_frames;
292 static framecnt_t disk_write_chunk_frames;
294 std::vector<CaptureInfo*> capture_info;
295 mutable Glib::Threads::Mutex capture_info_lock;
297 uint32_t i_am_the_modifier;
299 boost::shared_ptr<ARDOUR::IO> _io;
301 ChanCount _n_channels;
303 boost::shared_ptr<Playlist> _playlist;
305 gint _record_enabled;
307 double _visible_speed;
308 double _actual_speed;
309 /* items needed for speed change logic */
310 bool _buffer_reallocation_required;
313 /** Start of currently running capture in session frames */
314 framepos_t capture_start_frame;
315 framecnt_t capture_captured;
317 framecnt_t adjust_capture_position;
318 framecnt_t _capture_offset;
319 /** The number of frames by which this diskstream's output should be delayed
320 with respect to the transport frame. This is used for latency compensation.
322 framecnt_t _roll_delay;
323 framepos_t first_recordable_frame;
324 framepos_t last_recordable_frame;
325 int last_possibly_recording;
326 AlignStyle _alignment_style;
327 AlignChoice _alignment_choice;
329 Location* loop_location;
330 framepos_t overwrite_frame;
331 off_t overwrite_offset;
332 bool _pending_overwrite;
333 bool overwrite_queued;
334 IOChange input_change_pending;
335 framecnt_t wrap_buffer_size;
336 framecnt_t speed_buffer_size;
339 double _target_speed;
341 /** The next frame position that we should be reading from in our playlist */
342 framepos_t file_frame;
343 framepos_t playback_sample;
347 std::string _write_source_name;
349 Glib::Threads::Mutex state_lock;
351 PBD::ScopedConnectionList playlist_connections;
353 PBD::ScopedConnection ic_connection;
356 XMLNode* deprecated_io_node;
358 void route_going_away ();
360 static bool get_buffering_presets (BufferingPreset bp,
361 framecnt_t& read_chunk_size,
362 framecnt_t& read_buffer_size,
363 framecnt_t& write_chunk_size,
364 framecnt_t& write_buffer_size);
367 }; /* namespace ARDOUR */
369 #endif /* __ardour_diskstream_h__ */