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>
38 #include <ardour/ardour.h>
39 #include <ardour/configuration.h>
40 #include <ardour/session.h>
41 #include <ardour/route_group.h>
42 #include <ardour/route.h>
43 #include <ardour/port.h>
44 #include <ardour/utils.h>
57 class Diskstream : public Stateful, public sigc::trackable
66 string name () const { return _name; }
67 virtual int set_name (string str);
69 ARDOUR::IO* io() const { return _io; }
70 void set_io (ARDOUR::IO& io);
72 virtual Diskstream& ref() { _refcnt++; return *this; }
73 void unref() { if (_refcnt) _refcnt--; if (_refcnt == 0) delete this; }
74 uint32_t refcnt() const { return _refcnt; }
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 jack_nframes_t roll_delay() const { return _roll_delay; }
87 void set_roll_delay (jack_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 const PBD::ID& id() const { return _id; }
96 bool hidden() const { return _flags & Hidden; }
97 bool recordable() const { return _flags & Recordable; }
98 bool reversed() const { return _actual_speed < 0.0f; }
99 double speed() const { return _visible_speed; }
101 virtual void punch_in() {}
102 virtual void punch_out() {}
104 void set_speed (double);
105 void non_realtime_set_speed ();
107 Playlist* playlist () { return _playlist; }
109 virtual int use_playlist (Playlist *);
110 virtual int use_new_playlist () = 0;
111 virtual int use_copy_playlist () = 0;
113 jack_nframes_t current_capture_start() const { return capture_start_frame; }
114 jack_nframes_t current_capture_end() const { return capture_start_frame + capture_captured; }
115 jack_nframes_t get_capture_start_frame (uint32_t n=0);
116 jack_nframes_t get_captured_frames (uint32_t n=0);
118 uint32_t n_channels() { return _n_channels; }
120 static jack_nframes_t disk_io_frames() { return disk_io_chunk_frames; }
121 static void set_disk_io_chunk_frames (uint32_t n) { disk_io_chunk_frames = n; }
124 virtual XMLNode& get_state(void) = 0;
125 virtual int set_state(const XMLNode& node) = 0;
127 // FIXME: makes sense for all diskstream types?
128 virtual void monitor_input (bool) {}
130 jack_nframes_t capture_offset() const { return _capture_offset; }
131 virtual void set_capture_offset ();
133 bool slaved() const { return _slaved; }
134 void set_slaved(bool yn) { _slaved = yn; }
136 int set_loop (Location *loc);
138 std::list<Region*>& last_capture_regions () { return _last_capture_regions; }
140 void handle_input_change (IOChange, void *src);
142 sigc::signal<void> RecordEnableChanged;
143 sigc::signal<void> SpeedChanged;
144 sigc::signal<void> ReverseChanged;
145 sigc::signal<void> PlaylistChanged;
146 sigc::signal<void> AlignmentStyleChanged;
147 sigc::signal<void,Location *> LoopSet;
149 static sigc::signal<void> DiskOverrun;
150 static sigc::signal<void> DiskUnderrun;
151 static sigc::signal<void,Diskstream*> DiskstreamCreated; // XXX use a ref with sigc2
152 static sigc::signal<void,list<Source*>*> DeleteSources;
155 friend class Session;
157 Diskstream (Session &, const string& name, Flag f = Recordable);
158 Diskstream (Session &, const XMLNode&);
160 /* the Session is the only point of access for these because they require
161 * that the Session is "inactive" while they are called.
164 virtual void set_pending_overwrite (bool) = 0;
165 virtual int overwrite_existing_buffers () = 0;
166 virtual void set_block_size (jack_nframes_t) = 0;
167 virtual int internal_playback_seek (jack_nframes_t distance) = 0;
168 virtual int can_internal_playback_seek (jack_nframes_t distance) = 0;
169 virtual int rename_write_sources () = 0;
170 virtual void reset_write_sources (bool, bool force = false) = 0;
171 virtual void non_realtime_input_change () = 0;
173 uint32_t read_data_count() const { return _read_data_count; }
174 uint32_t write_data_count() const { return _write_data_count; }
177 friend class Auditioner;
178 virtual int seek (jack_nframes_t which_sample, bool complete_refill = false) = 0;
183 virtual void prepare ();
184 virtual int process (jack_nframes_t transport_frame, jack_nframes_t nframes, jack_nframes_t offset, bool can_record, bool rec_monitors_input) = 0;
185 virtual bool commit (jack_nframes_t nframes) = 0;
186 virtual void recover (); /* called if commit will not be called, but process was */
190 /** Use unref() to destroy a diskstream */
191 virtual ~Diskstream();
193 enum TransitionType {
198 struct CaptureTransition {
200 jack_nframes_t capture_val; ///< The start or end file frame position
203 /* The two central butler operations */
204 virtual int do_flush (Session::RunContext context, bool force = false) = 0;
205 virtual int do_refill () = 0;
207 /** For non-butler contexts (allocates temporary working buffers) */
208 virtual int do_refill_with_alloc() = 0;
211 /* XXX fix this redundancy ... */
213 virtual void playlist_changed (Change);
214 virtual void playlist_modified ();
215 virtual void playlist_deleted (Playlist*);
217 virtual void finish_capture (bool rec_monitors_input) = 0;
218 virtual void transport_stopped (struct tm&, time_t, bool abort) = 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<Region*> _last_capture_regions;
236 virtual int use_pending_capture_data (XMLNode& node) = 0;
238 virtual void get_input_sources () = 0;
239 virtual void check_record_status (jack_nframes_t transport_frame, jack_nframes_t nframes, bool can_record) = 0;
240 virtual void set_align_style_from_io() {}
241 virtual void setup_destructive_playlist () = 0;
242 virtual void use_destructive_playlist () = 0;
244 static jack_nframes_t disk_io_chunk_frames;
245 vector<CaptureInfo*> capture_info;
246 Glib::Mutex capture_info_lock;
248 uint32_t i_am_the_modifier;
251 ARDOUR::Session& _session;
253 uint32_t _n_channels;
257 mutable gint _record_enabled;
258 double _visible_speed;
259 double _actual_speed;
260 /* items needed for speed change logic */
261 bool _buffer_reallocation_required;
265 jack_nframes_t capture_start_frame;
266 jack_nframes_t capture_captured;
268 jack_nframes_t adjust_capture_position;
269 jack_nframes_t _capture_offset;
270 jack_nframes_t _roll_delay;
271 jack_nframes_t first_recordable_frame;
272 jack_nframes_t last_recordable_frame;
273 int last_possibly_recording;
274 AlignStyle _alignment_style;
278 Location* loop_location;
279 jack_nframes_t overwrite_frame;
280 off_t overwrite_offset;
281 bool pending_overwrite;
282 bool overwrite_queued;
283 IOChange input_change_pending;
284 jack_nframes_t wrap_buffer_size;
285 jack_nframes_t speed_buffer_size;
290 jack_nframes_t file_frame;
291 jack_nframes_t playback_sample;
292 jack_nframes_t playback_distance;
294 uint32_t _read_data_count;
295 uint32_t _write_data_count;
298 AlignStyle _persistent_alignment_style;
299 bool first_input_change;
301 Glib::Mutex state_lock;
303 jack_nframes_t scrub_start;
304 jack_nframes_t scrub_buffer_size;
305 jack_nframes_t scrub_offset;
309 sigc::connection ports_created_c;
310 sigc::connection plmod_connection;
311 sigc::connection plstate_connection;
312 sigc::connection plgone_connection;
314 unsigned char _flags;
317 }; /* namespace ARDOUR */
319 #endif /* __ardour_diskstream_h__ */