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/types.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);
74 boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
75 void set_track (ARDOUR::Track *);
77 /** @return A number between 0 and 1, where 0 indicates that the playback buffer
78 * is dry (ie the disk subsystem could not keep up) and 1 indicates that the
81 virtual float playback_buffer_load() const = 0;
82 virtual float capture_buffer_load() const = 0;
84 void set_flag (Flag f) { _flags = Flag (_flags | f); }
85 void unset_flag (Flag f) { _flags = Flag (_flags & ~f); }
87 AlignStyle alignment_style() const { return _alignment_style; }
88 AlignChoice alignment_choice() const { return _alignment_choice; }
89 void set_align_style (AlignStyle, bool force=false);
90 void set_align_choice (AlignChoice a, bool force=false);
92 framecnt_t roll_delay() const { return _roll_delay; }
93 void set_roll_delay (framecnt_t);
95 bool record_enabled() const { return g_atomic_int_get (&_record_enabled); }
96 virtual void set_record_enabled (bool yn) = 0;
98 bool destructive() const { return _flags & Destructive; }
99 virtual int set_destructive (bool /*yn*/) { return -1; }
100 virtual int set_non_layered (bool /*yn*/) { return -1; }
101 virtual bool can_become_destructive (bool& /*requires_bounce*/) const { return false; }
103 bool hidden() const { return _flags & Hidden; }
104 bool recordable() const { return _flags & Recordable; }
105 bool non_layered() const { return _flags & NonLayered; }
106 bool reversed() const { return _actual_speed < 0.0f; }
107 double speed() const { return _visible_speed; }
109 virtual void punch_in() {}
110 virtual void punch_out() {}
112 void non_realtime_set_speed ();
113 virtual void non_realtime_locate (framepos_t /*location*/) {};
114 virtual void playlist_modified ();
116 boost::shared_ptr<Playlist> playlist () { return _playlist; }
118 virtual int use_playlist (boost::shared_ptr<Playlist>);
119 virtual int use_new_playlist () = 0;
120 virtual int use_copy_playlist () = 0;
122 /** @return Start position of currently-running capture (in session frames) */
123 framepos_t current_capture_start() const { return capture_start_frame; }
124 framepos_t current_capture_end() const { return capture_start_frame + capture_captured; }
125 framepos_t get_capture_start_frame (uint32_t n = 0) const;
126 framecnt_t get_captured_frames (uint32_t n = 0) const;
128 ChanCount n_channels() { return _n_channels; }
130 static framecnt_t disk_io_frames() { return disk_io_chunk_frames; }
131 static void set_disk_io_chunk_frames (framecnt_t n) { disk_io_chunk_frames = n; }
134 virtual XMLNode& get_state(void);
135 virtual int set_state(const XMLNode&, int version);
137 virtual void request_input_monitoring (bool) {}
138 virtual void ensure_input_monitoring (bool) {}
140 framecnt_t capture_offset() const { return _capture_offset; }
141 virtual void set_capture_offset ();
143 bool slaved() const { return _slaved; }
144 void set_slaved(bool yn) { _slaved = yn; }
146 int set_loop (Location *loc);
148 std::list<boost::shared_ptr<Source> >& last_capture_sources () { return _last_capture_sources; }
150 void handle_input_change (IOChange, void *src);
152 void move_processor_automation (boost::weak_ptr<Processor>,
153 std::list<Evoral::RangeMove<framepos_t> > const &);
155 /** For non-butler contexts (allocates temporary working buffers) */
156 virtual int do_refill_with_alloc() = 0;
157 virtual void set_block_size (pframes_t) = 0;
159 bool pending_overwrite () const {
160 return _pending_overwrite;
163 PBD::Signal0<void> RecordEnableChanged;
164 PBD::Signal0<void> SpeedChanged;
165 PBD::Signal0<void> ReverseChanged;
166 /* Emitted when this diskstream is set to use a different playlist */
167 PBD::Signal0<void> PlaylistChanged;
168 PBD::Signal0<void> AlignmentStyleChanged;
169 PBD::Signal1<void,Location *> LoopSet;
171 static PBD::Signal0<void> DiskOverrun;
172 static PBD::Signal0<void> DiskUnderrun;
175 friend class Session;
178 /* the Session is the only point of access for these because they require
179 * that the Session is "inactive" while they are called.
182 virtual void set_pending_overwrite (bool) = 0;
183 virtual int overwrite_existing_buffers () = 0;
184 virtual int internal_playback_seek (framecnt_t distance) = 0;
185 virtual int can_internal_playback_seek (framecnt_t distance) = 0;
186 virtual void reset_write_sources (bool, bool force = false) = 0;
187 virtual void non_realtime_input_change () = 0;
190 friend class Auditioner;
191 virtual int seek (framepos_t which_sample, bool complete_refill = false) = 0;
196 virtual int process (BufferSet&, framepos_t transport_frame, pframes_t nframes, framecnt_t &, bool need_disk_signal) = 0;
197 virtual frameoffset_t calculate_playback_distance (pframes_t nframes) = 0;
198 virtual bool commit (framecnt_t) = 0;
202 enum TransitionType {
207 struct CaptureTransition {
209 framepos_t capture_val; ///< The start or end file frame position
212 /* The two central butler operations */
213 virtual int do_flush (RunContext context, bool force = false) = 0;
214 virtual int do_refill () = 0;
216 /* XXX fix this redundancy ... */
218 virtual void playlist_changed (const PBD::PropertyChange&);
219 virtual void playlist_deleted (boost::weak_ptr<Playlist>);
220 virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<framepos_t> > const &, bool);
222 virtual void transport_stopped_wallclock (struct tm&, time_t, bool abort) = 0;
223 virtual void transport_looped (framepos_t transport_frame) = 0;
230 virtual int use_new_write_source (uint32_t n=0) = 0;
232 virtual int find_and_use_playlist (const std::string&) = 0;
234 virtual void allocate_temporary_buffers () = 0;
236 virtual bool realtime_set_speed (double, bool global_change);
238 std::list<boost::shared_ptr<Source> > _last_capture_sources;
240 virtual int use_pending_capture_data (XMLNode& node) = 0;
242 virtual void check_record_status (framepos_t transport_frame, bool can_record);
243 virtual void prepare_record_status (framepos_t /*capture_start_frame*/) {}
244 virtual void set_align_style_from_io() {}
245 virtual void setup_destructive_playlist () {}
246 virtual void use_destructive_playlist () {}
247 virtual void prepare_to_stop (framepos_t pos);
249 void engage_record_enable ();
250 void disengage_record_enable ();
252 virtual bool prep_record_enable () = 0;
253 virtual bool prep_record_disable () = 0;
255 void calculate_record_range (
256 Evoral::OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
257 framecnt_t& rec_nframes, framecnt_t& rec_offset
260 static framecnt_t disk_io_chunk_frames;
261 std::vector<CaptureInfo*> capture_info;
262 mutable Glib::Threads::Mutex capture_info_lock;
264 uint32_t i_am_the_modifier;
266 boost::shared_ptr<ARDOUR::IO> _io;
268 ChanCount _n_channels;
270 boost::shared_ptr<Playlist> _playlist;
272 mutable gint _record_enabled;
273 double _visible_speed;
274 double _actual_speed;
275 /* items needed for speed change logic */
276 bool _buffer_reallocation_required;
279 /** Start of currently running capture in session frames */
280 framepos_t capture_start_frame;
281 framecnt_t capture_captured;
283 framecnt_t adjust_capture_position;
284 framecnt_t _capture_offset;
285 /** The number of frames by which this diskstream's output should be delayed
286 with respect to the transport frame. This is used for latency compensation.
288 framecnt_t _roll_delay;
289 framepos_t first_recordable_frame;
290 framepos_t last_recordable_frame;
291 int last_possibly_recording;
292 AlignStyle _alignment_style;
293 AlignChoice _alignment_choice;
295 Location* loop_location;
296 framepos_t overwrite_frame;
297 off_t overwrite_offset;
298 bool _pending_overwrite;
299 bool overwrite_queued;
300 IOChange input_change_pending;
301 framecnt_t wrap_buffer_size;
302 framecnt_t speed_buffer_size;
305 double _target_speed;
307 /** The next frame position that we should be reading from in our playlist */
308 framepos_t file_frame;
309 framepos_t playback_sample;
313 Glib::Threads::Mutex state_lock;
315 PBD::ScopedConnectionList playlist_connections;
317 PBD::ScopedConnection ic_connection;
320 XMLNode* deprecated_io_node;
322 void route_going_away ();
325 }; /* namespace ARDOUR */
327 #endif /* __ardour_diskstream_h__ */