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);
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 (&_record_enabled); }
107 virtual void set_record_enabled (bool yn) = 0;
109 bool destructive() const { return _flags & Destructive; }
110 virtual int set_destructive (bool /*yn*/) { return -1; }
111 virtual int set_non_layered (bool /*yn*/) { return -1; }
112 virtual bool can_become_destructive (bool& /*requires_bounce*/) const { return false; }
114 bool hidden() const { return _flags & Hidden; }
115 bool recordable() const { return _flags & Recordable; }
116 bool non_layered() const { return _flags & NonLayered; }
117 bool reversed() const { return _actual_speed < 0.0f; }
118 double speed() const { return _visible_speed; }
120 virtual void punch_in() {}
121 virtual void punch_out() {}
123 void non_realtime_set_speed ();
124 virtual void non_realtime_locate (framepos_t /*location*/) {};
125 virtual void playlist_modified ();
127 boost::shared_ptr<Playlist> playlist () { return _playlist; }
129 virtual int use_playlist (boost::shared_ptr<Playlist>);
130 virtual int use_new_playlist () = 0;
131 virtual int use_copy_playlist () = 0;
133 /** @return Start position of currently-running capture (in session frames) */
134 framepos_t current_capture_start() const { return capture_start_frame; }
135 framepos_t current_capture_end() const { return capture_start_frame + capture_captured; }
136 framepos_t get_capture_start_frame (uint32_t n = 0) const;
137 framecnt_t get_captured_frames (uint32_t n = 0) const;
139 ChanCount n_channels() { return _n_channels; }
141 static framecnt_t disk_io_frames() { return disk_io_chunk_frames; }
142 static void set_disk_io_chunk_frames (framecnt_t n) { disk_io_chunk_frames = n; }
145 virtual XMLNode& get_state(void);
146 virtual int set_state(const XMLNode&, int version);
148 virtual void request_input_monitoring (bool) {}
149 virtual void ensure_input_monitoring (bool) {}
151 framecnt_t capture_offset() const { return _capture_offset; }
152 virtual void set_capture_offset ();
154 bool slaved() const { return _slaved; }
155 void set_slaved(bool yn) { _slaved = yn; }
157 int set_loop (Location *loc);
159 std::list<boost::shared_ptr<Source> >& last_capture_sources () { return _last_capture_sources; }
161 void handle_input_change (IOChange, void *src);
163 void move_processor_automation (boost::weak_ptr<Processor>,
164 std::list<Evoral::RangeMove<framepos_t> > const &);
166 /** For non-butler contexts (allocates temporary working buffers) */
167 virtual int do_refill_with_alloc() = 0;
168 virtual void set_block_size (pframes_t) = 0;
170 bool pending_overwrite () const {
171 return _pending_overwrite;
174 PBD::Signal0<void> RecordEnableChanged;
175 PBD::Signal0<void> SpeedChanged;
176 PBD::Signal0<void> ReverseChanged;
177 /* Emitted when this diskstream is set to use a different playlist */
178 PBD::Signal0<void> PlaylistChanged;
179 PBD::Signal0<void> AlignmentStyleChanged;
180 PBD::Signal1<void,Location *> LoopSet;
182 static PBD::Signal0<void> DiskOverrun;
183 static PBD::Signal0<void> DiskUnderrun;
186 friend class Session;
189 /* the Session is the only point of access for these because they require
190 * that the Session is "inactive" while they are called.
193 virtual void set_pending_overwrite (bool) = 0;
194 virtual int overwrite_existing_buffers () = 0;
195 virtual int internal_playback_seek (framecnt_t distance) = 0;
196 virtual int can_internal_playback_seek (framecnt_t distance) = 0;
197 virtual void reset_write_sources (bool, bool force = false) = 0;
198 virtual void non_realtime_input_change () = 0;
201 friend class Auditioner;
202 virtual int seek (framepos_t which_sample, bool complete_refill = false) = 0;
207 virtual int process (BufferSet&, framepos_t transport_frame, pframes_t nframes, framecnt_t &, bool need_disk_signal) = 0;
208 virtual frameoffset_t calculate_playback_distance (pframes_t nframes) = 0;
209 virtual bool commit (framecnt_t) = 0;
213 enum TransitionType {
218 struct CaptureTransition {
220 framepos_t capture_val; ///< The start or end file frame position
223 /* The two central butler operations */
224 virtual int do_flush (RunContext context, bool force = false) = 0;
225 virtual int do_refill () = 0;
227 /* XXX fix this redundancy ... */
229 virtual void playlist_changed (const PBD::PropertyChange&);
230 virtual void playlist_deleted (boost::weak_ptr<Playlist>);
231 virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<framepos_t> > const &, bool);
233 virtual void transport_stopped_wallclock (struct tm&, time_t, bool abort) = 0;
234 virtual void transport_looped (framepos_t transport_frame) = 0;
241 virtual int use_new_write_source (uint32_t n=0) = 0;
243 virtual int find_and_use_playlist (const std::string&) = 0;
245 virtual void allocate_temporary_buffers () = 0;
247 virtual bool realtime_set_speed (double, bool global_change);
249 std::list<boost::shared_ptr<Source> > _last_capture_sources;
251 virtual int use_pending_capture_data (XMLNode& node) = 0;
253 virtual void check_record_status (framepos_t transport_frame, bool can_record);
254 virtual void prepare_record_status (framepos_t /*capture_start_frame*/) {}
255 virtual void set_align_style_from_io() {}
256 virtual void setup_destructive_playlist () {}
257 virtual void use_destructive_playlist () {}
258 virtual void prepare_to_stop (framepos_t transport_pos, framepos_t audible_frame);
260 void engage_record_enable ();
261 void disengage_record_enable ();
263 virtual bool prep_record_enable () = 0;
264 virtual bool prep_record_disable () = 0;
266 void calculate_record_range (
267 Evoral::OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
268 framecnt_t& rec_nframes, framecnt_t& rec_offset
271 static framecnt_t disk_io_chunk_frames;
272 std::vector<CaptureInfo*> capture_info;
273 mutable Glib::Threads::Mutex capture_info_lock;
275 uint32_t i_am_the_modifier;
277 boost::shared_ptr<ARDOUR::IO> _io;
279 ChanCount _n_channels;
281 boost::shared_ptr<Playlist> _playlist;
283 mutable gint _record_enabled;
284 double _visible_speed;
285 double _actual_speed;
286 /* items needed for speed change logic */
287 bool _buffer_reallocation_required;
290 /** Start of currently running capture in session frames */
291 framepos_t capture_start_frame;
292 framecnt_t capture_captured;
294 framecnt_t adjust_capture_position;
295 framecnt_t _capture_offset;
296 /** The number of frames by which this diskstream's output should be delayed
297 with respect to the transport frame. This is used for latency compensation.
299 framecnt_t _roll_delay;
300 framepos_t first_recordable_frame;
301 framepos_t last_recordable_frame;
302 int last_possibly_recording;
303 AlignStyle _alignment_style;
304 AlignChoice _alignment_choice;
306 Location* loop_location;
307 framepos_t overwrite_frame;
308 off_t overwrite_offset;
309 bool _pending_overwrite;
310 bool overwrite_queued;
311 IOChange input_change_pending;
312 framecnt_t wrap_buffer_size;
313 framecnt_t speed_buffer_size;
316 double _target_speed;
318 /** The next frame position that we should be reading from in our playlist */
319 framepos_t file_frame;
320 framepos_t playback_sample;
324 std::string _write_source_name;
326 Glib::Threads::Mutex state_lock;
328 PBD::ScopedConnectionList playlist_connections;
330 PBD::ScopedConnection ic_connection;
333 XMLNode* deprecated_io_node;
335 void route_going_away ();
338 }; /* namespace ARDOUR */
340 #endif /* __ardour_diskstream_h__ */