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 <sigc++/signal.h>
32 #include <boost/utility.hpp>
34 #include <evoral/types.hpp>
36 #include <pbd/fastlog.h>
37 #include <pbd/ringbufferNPT.h>
38 #include <pbd/stateful.h>
39 #include <pbd/statefuldestructible.h>
41 #include <ardour/ardour.h>
42 #include <ardour/configuration.h>
43 #include <ardour/location.h>
44 #include <ardour/session_object.h>
45 #include <ardour/types.h>
46 #include <ardour/utils.h>
47 #include <ardour/chan_count.h>
61 class Diskstream : public SessionObject, public boost::noncopyable
70 Diskstream (Session &, const string& name, Flag f = Recordable);
71 Diskstream (Session &, const XMLNode&);
72 virtual ~Diskstream();
74 bool set_name (const string& str);
76 ARDOUR::IO* io() const { return _io; }
77 void set_io (ARDOUR::IO& io);
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 void set_align_style (AlignStyle);
87 void set_persistent_align_style (AlignStyle a) { _persistent_alignment_style = a; }
89 nframes_t roll_delay() const { return _roll_delay; }
90 void set_roll_delay (nframes_t);
92 bool record_enabled() const { return g_atomic_int_get (&_record_enabled); }
93 virtual void set_record_enabled (bool yn) = 0;
95 bool destructive() const { return _flags & Destructive; }
96 virtual int set_destructive (bool yn) { return -1; }
97 virtual bool can_become_destructive (bool& requires_bounce) const { return false; }
99 bool hidden() const { return _flags & Hidden; }
100 bool recordable() const { return _flags & Recordable; }
101 bool reversed() const { return _actual_speed < 0.0f; }
102 double speed() const { return _visible_speed; }
104 virtual void punch_in() {}
105 virtual void punch_out() {}
107 void set_speed (double);
108 void non_realtime_set_speed ();
109 virtual void non_realtime_locate (nframes_t location) {};
110 virtual void playlist_modified ();
112 boost::shared_ptr<Playlist> playlist () { return _playlist; }
114 virtual int use_playlist (boost::shared_ptr<Playlist>);
115 virtual int use_new_playlist () = 0;
116 virtual int use_copy_playlist () = 0;
118 nframes_t current_capture_start() const { return capture_start_frame; }
119 nframes_t current_capture_end() const { return capture_start_frame + capture_captured; }
120 nframes_t get_capture_start_frame (uint32_t n=0);
121 nframes_t get_captured_frames (uint32_t n=0);
123 ChanCount n_channels() { return _n_channels; }
125 static nframes_t disk_io_frames() { return disk_io_chunk_frames; }
126 static void set_disk_io_chunk_frames (uint32_t n) { disk_io_chunk_frames = n; }
129 virtual XMLNode& get_state(void) = 0;
130 virtual int set_state(const XMLNode& node) = 0;
132 virtual void monitor_input (bool) {}
134 nframes_t capture_offset() const { return _capture_offset; }
135 virtual void set_capture_offset ();
137 bool slaved() const { return _slaved; }
138 void set_slaved(bool yn) { _slaved = yn; }
140 int set_loop (Location *loc);
142 std::list<boost::shared_ptr<Region> >& last_capture_regions () { return _last_capture_regions; }
144 void handle_input_change (IOChange, void *src);
146 void remove_region_from_last_capture (boost::weak_ptr<Region> wregion);
148 void move_processor_automation (boost::weak_ptr<Processor>,
149 list< Evoral::RangeMove<nframes_t> > const &);
151 sigc::signal<void> RecordEnableChanged;
152 sigc::signal<void> SpeedChanged;
153 sigc::signal<void> ReverseChanged;
154 sigc::signal<void> PlaylistChanged;
155 sigc::signal<void> AlignmentStyleChanged;
156 sigc::signal<void,Location *> LoopSet;
158 static sigc::signal<void> DiskOverrun;
159 static sigc::signal<void> DiskUnderrun;
162 friend class Session;
164 /* the Session is the only point of access for these because they require
165 * that the Session is "inactive" while they are called.
168 virtual void set_pending_overwrite (bool) = 0;
169 virtual int overwrite_existing_buffers () = 0;
170 virtual void set_block_size (nframes_t) = 0;
171 virtual int internal_playback_seek (nframes_t distance) = 0;
172 virtual int can_internal_playback_seek (nframes_t distance) = 0;
173 virtual int rename_write_sources () = 0;
174 virtual void reset_write_sources (bool, bool force = false) = 0;
175 virtual void non_realtime_input_change () = 0;
177 uint32_t read_data_count() const { return _read_data_count; }
178 uint32_t write_data_count() const { return _write_data_count; }
181 friend class Auditioner;
182 virtual int seek (nframes_t which_sample, bool complete_refill = false) = 0;
187 virtual void prepare ();
188 virtual int process (nframes_t transport_frame, nframes_t nframes, nframes_t offset, bool can_record, bool rec_monitors_input) = 0;
189 virtual bool commit (nframes_t nframes) = 0;
190 virtual void recover (); /* called if commit will not be called, but process was */
194 enum TransitionType {
199 struct CaptureTransition {
201 nframes_t capture_val; ///< The start or end file frame position
204 /* The two central butler operations */
205 virtual int do_flush (RunContext context, bool force = false) = 0;
206 virtual int do_refill () = 0;
208 /** For non-butler contexts (allocates temporary working buffers) */
209 virtual int do_refill_with_alloc() = 0;
211 /* XXX fix this redundancy ... */
213 virtual void playlist_changed (Change);
214 virtual void playlist_deleted (boost::weak_ptr<Playlist>);
215 virtual void playlist_ranges_moved (list< Evoral::RangeMove<nframes_t> > const &);
217 virtual void transport_stopped (struct tm&, time_t, bool abort) = 0;
218 virtual void transport_looped (nframes_t transport_frame) = 0;
225 virtual void init (Flag);
227 virtual int use_new_write_source (uint32_t n=0) = 0;
229 virtual int find_and_use_playlist (const 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<Region> > _last_capture_regions;
237 virtual int use_pending_capture_data (XMLNode& node) = 0;
239 virtual void get_input_sources () = 0;
240 virtual void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record) = 0;
241 virtual void set_align_style_from_io() {}
242 virtual void setup_destructive_playlist () {}
243 virtual void use_destructive_playlist () {}
245 static nframes_t disk_io_chunk_frames;
246 std::vector<CaptureInfo*> capture_info;
247 Glib::Mutex capture_info_lock;
249 uint32_t i_am_the_modifier;
252 ChanCount _n_channels;
254 boost::shared_ptr<Playlist> _playlist;
256 mutable gint _record_enabled;
257 double _visible_speed;
258 double _actual_speed;
259 /* items needed for speed change logic */
260 bool _buffer_reallocation_required;
264 nframes_t capture_start_frame;
265 nframes_t capture_captured;
267 nframes_t adjust_capture_position;
268 nframes_t _capture_offset;
269 nframes_t _roll_delay;
270 nframes_t first_recordable_frame;
271 nframes_t last_recordable_frame;
272 int last_possibly_recording;
273 AlignStyle _alignment_style;
277 Location* loop_location;
278 nframes_t overwrite_frame;
279 off_t overwrite_offset;
280 bool pending_overwrite;
281 bool overwrite_queued;
282 IOChange input_change_pending;
283 nframes_t wrap_buffer_size;
284 nframes_t speed_buffer_size;
288 /// diskstream speed in 40.24 fixed point math
291 /// target diskstream speed in 40.24 fixed point math
294 nframes_t file_frame;
295 nframes_t playback_sample;
296 nframes_t playback_distance;
297 bool commit_should_unlock;
299 uint32_t _read_data_count;
300 uint32_t _write_data_count;
303 AlignStyle _persistent_alignment_style;
304 bool first_input_change;
306 Glib::Mutex state_lock;
308 nframes_t scrub_start;
309 nframes_t scrub_buffer_size;
310 nframes_t scrub_offset;
312 sigc::connection ports_created_c;
313 sigc::connection plmod_connection;
314 sigc::connection plgone_connection;
315 sigc::connection plregion_connection;
320 }; /* namespace ARDOUR */
322 #endif /* __ardour_diskstream_h__ */