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.
18 $Id: diskstream.h 579 2006-06-12 19:56:37Z essej $
21 #ifndef __ardour_diskstream_h__
22 #define __ardour_diskstream_h__
24 #include <sigc++/signal.h>
34 #include <pbd/fastlog.h>
35 #include <pbd/ringbufferNPT.h>
36 #include <pbd/stateful.h>
37 #include <pbd/statefuldestructible.h>
39 #include <ardour/ardour.h>
40 #include <ardour/configuration.h>
41 #include <ardour/session.h>
42 #include <ardour/route_group.h>
43 #include <ardour/route.h>
44 #include <ardour/port.h>
45 #include <ardour/utils.h>
57 class Diskstream : public PBD::StatefulDestructible
66 Diskstream (Session &, const string& name, Flag f = Recordable);
67 Diskstream (Session &, const XMLNode&);
68 virtual ~Diskstream();
70 string name () const { return _name; }
71 virtual int set_name (string str);
73 ARDOUR::IO* io() const { return _io; }
74 void set_io (ARDOUR::IO& io);
76 virtual float playback_buffer_load() const = 0;
77 virtual float capture_buffer_load() const = 0;
79 void set_flag (Flag f) { _flags |= f; }
80 void unset_flag (Flag f) { _flags &= ~f; }
82 AlignStyle alignment_style() const { return _alignment_style; }
83 void set_align_style (AlignStyle);
84 void set_persistent_align_style (AlignStyle a) { _persistent_alignment_style = a; }
86 nframes_t roll_delay() const { return _roll_delay; }
87 void set_roll_delay (nframes_t);
89 bool record_enabled() const { return g_atomic_int_get (&_record_enabled); }
90 virtual void set_record_enabled (bool yn) = 0;
92 bool destructive() const { return _flags & Destructive; }
93 virtual void set_destructive (bool yn);
95 bool hidden() const { return _flags & Hidden; }
96 bool recordable() const { return _flags & Recordable; }
97 bool reversed() const { return _actual_speed < 0.0f; }
98 double speed() const { return _visible_speed; }
100 virtual void punch_in() {}
101 virtual void punch_out() {}
103 void set_speed (double);
104 void non_realtime_set_speed ();
106 Playlist* playlist () { return _playlist; }
108 virtual int use_playlist (Playlist *);
109 virtual int use_new_playlist () = 0;
110 virtual int use_copy_playlist () = 0;
112 nframes_t current_capture_start() const { return capture_start_frame; }
113 nframes_t current_capture_end() const { return capture_start_frame + capture_captured; }
114 nframes_t get_capture_start_frame (uint32_t n=0);
115 nframes_t get_captured_frames (uint32_t n=0);
117 uint32_t n_channels() { return _n_channels; }
119 static nframes_t disk_io_frames() { return disk_io_chunk_frames; }
120 static void set_disk_io_chunk_frames (uint32_t n) { disk_io_chunk_frames = n; }
123 virtual XMLNode& get_state(void) = 0;
124 virtual int set_state(const XMLNode& node) = 0;
126 // FIXME: makes sense for all diskstream types?
127 virtual void monitor_input (bool) {}
129 nframes_t capture_offset() const { return _capture_offset; }
130 virtual void set_capture_offset ();
132 bool slaved() const { return _slaved; }
133 void set_slaved(bool yn) { _slaved = yn; }
135 int set_loop (Location *loc);
137 std::list<boost::shared_ptr<Region> >& last_capture_regions () { return _last_capture_regions; }
139 void handle_input_change (IOChange, void *src);
141 sigc::signal<void> RecordEnableChanged;
142 sigc::signal<void> SpeedChanged;
143 sigc::signal<void> ReverseChanged;
144 sigc::signal<void> PlaylistChanged;
145 sigc::signal<void> AlignmentStyleChanged;
146 sigc::signal<void,Location *> LoopSet;
148 static sigc::signal<void> DiskOverrun;
149 static sigc::signal<void> DiskUnderrun;
152 friend class Session;
154 /* the Session is the only point of access for these because they require
155 * that the Session is "inactive" while they are called.
158 virtual void set_pending_overwrite (bool) = 0;
159 virtual int overwrite_existing_buffers () = 0;
160 virtual void set_block_size (nframes_t) = 0;
161 virtual int internal_playback_seek (nframes_t distance) = 0;
162 virtual int can_internal_playback_seek (nframes_t distance) = 0;
163 virtual int rename_write_sources () = 0;
164 virtual void reset_write_sources (bool, bool force = false) = 0;
165 virtual void non_realtime_input_change () = 0;
167 uint32_t read_data_count() const { return _read_data_count; }
168 uint32_t write_data_count() const { return _write_data_count; }
171 friend class Auditioner;
172 virtual int seek (nframes_t which_sample, bool complete_refill = false) = 0;
177 virtual void prepare ();
178 virtual int process (nframes_t transport_frame, nframes_t nframes, nframes_t offset, bool can_record, bool rec_monitors_input) = 0;
179 virtual bool commit (nframes_t nframes) = 0;
180 virtual void recover (); /* called if commit will not be called, but process was */
184 enum TransitionType {
189 struct CaptureTransition {
191 nframes_t capture_val; ///< The start or end file frame position
194 /* The two central butler operations */
195 virtual int do_flush (Session::RunContext context, bool force = false) = 0;
196 virtual int do_refill () = 0;
198 /** For non-butler contexts (allocates temporary working buffers) */
199 virtual int do_refill_with_alloc() = 0;
202 /* XXX fix this redundancy ... */
204 virtual void playlist_changed (Change);
205 virtual void playlist_modified ();
206 virtual void playlist_deleted (Playlist*);
208 virtual void finish_capture (bool rec_monitors_input) = 0;
209 virtual void transport_stopped (struct tm&, time_t, bool abort) = 0;
216 virtual void init (Flag);
218 virtual int use_new_write_source (uint32_t n=0) = 0;
220 virtual int find_and_use_playlist (const string&) = 0;
222 virtual void allocate_temporary_buffers () = 0;
224 virtual bool realtime_set_speed (double, bool global_change);
226 std::list<boost::shared_ptr<Region> > _last_capture_regions;
227 virtual int use_pending_capture_data (XMLNode& node) = 0;
229 virtual void get_input_sources () = 0;
230 virtual void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record) = 0;
231 virtual void set_align_style_from_io() {}
232 virtual void setup_destructive_playlist () = 0;
233 virtual void use_destructive_playlist () = 0;
235 static nframes_t disk_io_chunk_frames;
236 vector<CaptureInfo*> capture_info;
237 Glib::Mutex capture_info_lock;
239 uint32_t i_am_the_modifier;
242 ARDOUR::Session& _session;
244 uint32_t _n_channels;
247 mutable gint _record_enabled;
248 double _visible_speed;
249 double _actual_speed;
250 /* items needed for speed change logic */
251 bool _buffer_reallocation_required;
255 nframes_t capture_start_frame;
256 nframes_t capture_captured;
258 nframes_t adjust_capture_position;
259 nframes_t _capture_offset;
260 nframes_t _roll_delay;
261 nframes_t first_recordable_frame;
262 nframes_t last_recordable_frame;
263 int last_possibly_recording;
264 AlignStyle _alignment_style;
268 Location* loop_location;
269 nframes_t overwrite_frame;
270 off_t overwrite_offset;
271 bool pending_overwrite;
272 bool overwrite_queued;
273 IOChange input_change_pending;
274 nframes_t wrap_buffer_size;
275 nframes_t speed_buffer_size;
280 nframes_t file_frame;
281 nframes_t playback_sample;
282 nframes_t playback_distance;
284 uint32_t _read_data_count;
285 uint32_t _write_data_count;
288 AlignStyle _persistent_alignment_style;
289 bool first_input_change;
291 Glib::Mutex state_lock;
293 nframes_t scrub_start;
294 nframes_t scrub_buffer_size;
295 nframes_t scrub_offset;
297 sigc::connection ports_created_c;
298 sigc::connection plmod_connection;
299 sigc::connection plstate_connection;
300 sigc::connection plgone_connection;
302 unsigned char _flags;
305 }; /* namespace ARDOUR */
307 #endif /* __ardour_diskstream_h__ */