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/types.h"
38 #include "ardour/utils.h"
39 #include "ardour/public_diskstream.h"
53 /** Parent class for classes which can stream data to and from disk.
54 * These are used by Tracks to get playback and put recorded data.
56 class Diskstream : public SessionObject, public PublicDiskstream
66 Diskstream (Session &, const std::string& name, Flag f = Recordable);
67 Diskstream (Session &, const XMLNode&);
68 virtual ~Diskstream();
70 virtual bool set_name (const std::string& str);
72 boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
73 void set_track (ARDOUR::Track *);
75 /** @return A number between 0 and 1, where 0 indicates that the playback buffer
76 * is dry (ie the disk subsystem could not keep up) and 1 indicates that the
79 virtual float playback_buffer_load() const = 0;
80 virtual float capture_buffer_load() const = 0;
82 void set_flag (Flag f) { _flags = Flag (_flags | f); }
83 void unset_flag (Flag f) { _flags = Flag (_flags & ~f); }
85 AlignStyle alignment_style() const { return _alignment_style; }
86 AlignChoice alignment_choice() const { return _alignment_choice; }
87 void set_align_style (AlignStyle, bool force=false);
88 void set_align_choice (AlignChoice a, bool force=false);
90 framecnt_t roll_delay() const { return _roll_delay; }
91 void set_roll_delay (framecnt_t);
93 bool record_enabled() const { return g_atomic_int_get (&_record_enabled); }
94 virtual void set_record_enabled (bool yn) = 0;
96 bool destructive() const { return _flags & Destructive; }
97 virtual int set_destructive (bool /*yn*/) { return -1; }
98 virtual int set_non_layered (bool /*yn*/) { return -1; }
99 virtual bool can_become_destructive (bool& /*requires_bounce*/) const { return false; }
101 bool hidden() const { return _flags & Hidden; }
102 bool recordable() const { return _flags & Recordable; }
103 bool non_layered() const { return _flags & NonLayered; }
104 bool reversed() const { return _actual_speed < 0.0f; }
105 double speed() const { return _visible_speed; }
107 virtual void punch_in() {}
108 virtual void punch_out() {}
110 void non_realtime_set_speed ();
111 virtual void non_realtime_locate (framepos_t /*location*/) {};
112 virtual void playlist_modified ();
114 boost::shared_ptr<Playlist> playlist () { return _playlist; }
116 virtual int use_playlist (boost::shared_ptr<Playlist>);
117 virtual int use_new_playlist () = 0;
118 virtual int use_copy_playlist () = 0;
120 /** @return Start position of currently-running capture (in session frames) */
121 framepos_t current_capture_start() const { return capture_start_frame; }
122 framepos_t current_capture_end() const { return capture_start_frame + capture_captured; }
123 framepos_t get_capture_start_frame (uint32_t n = 0) const;
124 framecnt_t get_captured_frames (uint32_t n = 0) const;
126 ChanCount n_channels() { return _n_channels; }
128 static framecnt_t disk_io_frames() { return disk_io_chunk_frames; }
129 static void set_disk_io_chunk_frames (framecnt_t n) { disk_io_chunk_frames = n; }
132 virtual XMLNode& get_state(void);
133 virtual int set_state(const XMLNode&, int version);
135 virtual void request_jack_monitors_input (bool) {}
136 virtual void ensure_jack_monitors_input (bool) {}
138 framecnt_t capture_offset() const { return _capture_offset; }
139 virtual void set_capture_offset ();
141 bool slaved() const { return _slaved; }
142 void set_slaved(bool yn) { _slaved = yn; }
144 int set_loop (Location *loc);
146 std::list<boost::shared_ptr<Source> >& last_capture_sources () { return _last_capture_sources; }
148 void handle_input_change (IOChange, void *src);
150 void move_processor_automation (boost::weak_ptr<Processor>,
151 std::list<Evoral::RangeMove<framepos_t> > const &);
153 /** For non-butler contexts (allocates temporary working buffers) */
154 virtual int do_refill_with_alloc() = 0;
155 virtual void set_block_size (pframes_t) = 0;
157 bool pending_overwrite () const {
158 return _pending_overwrite;
161 PBD::Signal0<void> RecordEnableChanged;
162 PBD::Signal0<void> SpeedChanged;
163 PBD::Signal0<void> ReverseChanged;
164 /* Emitted when this diskstream is set to use a different playlist */
165 PBD::Signal0<void> PlaylistChanged;
166 PBD::Signal0<void> AlignmentStyleChanged;
167 PBD::Signal1<void,Location *> LoopSet;
169 static PBD::Signal0<void> DiskOverrun;
170 static PBD::Signal0<void> DiskUnderrun;
173 friend class Session;
176 /* the Session is the only point of access for these because they require
177 * that the Session is "inactive" while they are called.
180 virtual void set_pending_overwrite (bool) = 0;
181 virtual int overwrite_existing_buffers () = 0;
182 virtual int internal_playback_seek (framecnt_t distance) = 0;
183 virtual int can_internal_playback_seek (framecnt_t distance) = 0;
184 virtual void reset_write_sources (bool, bool force = false) = 0;
185 virtual void non_realtime_input_change () = 0;
188 friend class Auditioner;
189 virtual int seek (framepos_t which_sample, bool complete_refill = false) = 0;
194 virtual int process (framepos_t transport_frame, pframes_t nframes, framecnt_t &) = 0;
195 virtual bool commit (framecnt_t) = 0;
199 enum TransitionType {
204 struct CaptureTransition {
206 framepos_t capture_val; ///< The start or end file frame position
209 /* The two central butler operations */
210 virtual int do_flush (RunContext context, bool force = false) = 0;
211 virtual int do_refill () = 0;
213 /* XXX fix this redundancy ... */
215 virtual void playlist_changed (const PBD::PropertyChange&);
216 virtual void playlist_deleted (boost::weak_ptr<Playlist>);
217 virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<framepos_t> > const &, bool);
219 virtual void transport_stopped_wallclock (struct tm&, time_t, bool abort) = 0;
220 virtual void transport_looped (framepos_t transport_frame) = 0;
227 virtual int use_new_write_source (uint32_t n=0) = 0;
229 virtual int find_and_use_playlist (const std::string&) = 0;
231 virtual void allocate_temporary_buffers () = 0;
233 virtual bool realtime_set_speed (double, bool global_change);
235 std::list<boost::shared_ptr<Source> > _last_capture_sources;
237 virtual int use_pending_capture_data (XMLNode& node) = 0;
239 virtual void check_record_status (framepos_t transport_frame, bool can_record);
240 virtual void prepare_record_status (framepos_t /*capture_start_frame*/) {}
241 virtual void set_align_style_from_io() {}
242 virtual void setup_destructive_playlist () {}
243 virtual void use_destructive_playlist () {}
244 virtual void prepare_to_stop (framepos_t pos);
246 void engage_record_enable ();
247 void disengage_record_enable ();
249 virtual bool prep_record_enable () = 0;
250 virtual bool prep_record_disable () = 0;
252 void calculate_record_range (
253 Evoral::OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
254 framecnt_t& rec_nframes, framecnt_t& rec_offset
257 static framecnt_t disk_io_chunk_frames;
258 std::vector<CaptureInfo*> capture_info;
259 mutable Glib::Threads::Mutex capture_info_lock;
261 uint32_t i_am_the_modifier;
263 boost::shared_ptr<ARDOUR::IO> _io;
265 ChanCount _n_channels;
267 boost::shared_ptr<Playlist> _playlist;
269 mutable gint _record_enabled;
270 double _visible_speed;
271 double _actual_speed;
272 /* items needed for speed change logic */
273 bool _buffer_reallocation_required;
276 /** Start of currently running capture in session frames */
277 framepos_t capture_start_frame;
278 framecnt_t capture_captured;
280 framecnt_t adjust_capture_position;
281 framecnt_t _capture_offset;
282 /** The number of frames by which this diskstream's output should be delayed
283 with respect to the transport frame. This is used for latency compensation.
285 framecnt_t _roll_delay;
286 framepos_t first_recordable_frame;
287 framepos_t last_recordable_frame;
288 int last_possibly_recording;
289 AlignStyle _alignment_style;
290 AlignChoice _alignment_choice;
292 Location* loop_location;
293 framepos_t overwrite_frame;
294 off_t overwrite_offset;
295 bool _pending_overwrite;
296 bool overwrite_queued;
297 IOChange input_change_pending;
298 framecnt_t wrap_buffer_size;
299 framecnt_t speed_buffer_size;
302 double _target_speed;
304 /** The next frame position that we should be reading from in our playlist */
305 framepos_t file_frame;
306 framepos_t playback_sample;
310 Glib::Threads::Mutex state_lock;
312 PBD::ScopedConnectionList playlist_connections;
314 PBD::ScopedConnection ic_connection;
317 XMLNode* deprecated_io_node;
319 void route_going_away ();
322 }; /* namespace ARDOUR */
324 #endif /* __ardour_diskstream_h__ */