2 Copyright (C) 2000 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>
58 /* FIXME: There are (obviously) far too many virtual functions in this ATM.
59 * Just to get things off the ground, they'll be removed. */
61 class Diskstream : public Stateful, public sigc::trackable
70 string name () const { return _name; }
71 virtual int set_name (string str, void* src);
73 ARDOUR::IO* io() const { return _io; }
74 virtual void set_io (ARDOUR::IO& io) = 0;
76 virtual Diskstream& ref() { _refcnt++; return *this; }
77 void unref() { if (_refcnt) _refcnt--; if (_refcnt == 0) delete this; }
78 uint32_t refcnt() const { return _refcnt; }
80 virtual float playback_buffer_load() const = 0;
81 virtual float capture_buffer_load() const = 0;
83 void set_flag (Flag f) { _flags |= f; }
84 void unset_flag (Flag f) { _flags &= ~f; }
86 AlignStyle alignment_style() const { return _alignment_style; }
87 void set_align_style (AlignStyle);
88 void set_persistent_align_style (AlignStyle a) { _persistent_alignment_style = a; }
90 jack_nframes_t roll_delay() const { return _roll_delay; }
91 void set_roll_delay (jack_nframes_t);
93 bool record_enabled() const { return g_atomic_int_get (&_record_enabled); }
94 virtual void set_record_enabled (bool yn, void *src) = 0;
96 bool destructive() const { return _flags & Destructive; }
97 virtual void set_destructive (bool yn);
99 const PBD::ID& id() const { return _id; }
100 bool hidden() const { return _flags & Hidden; }
101 bool recordable() const { return _flags & Recordable; }
102 bool reversed() const { return _actual_speed < 0.0f; }
103 double speed() const { return _visible_speed; }
105 virtual void punch_in() {}
106 virtual void punch_out() {}
108 virtual void set_speed (double);
109 virtual void non_realtime_set_speed () = 0;
111 virtual Playlist *playlist () = 0;
112 virtual int use_new_playlist () = 0;
113 virtual int use_playlist (Playlist *) = 0;
114 virtual int use_copy_playlist () = 0;
116 virtual void start_scrub (jack_nframes_t where) = 0;
117 virtual void end_scrub () = 0;
119 jack_nframes_t current_capture_start() const { return capture_start_frame; }
120 jack_nframes_t current_capture_end() const { return capture_start_frame + capture_captured; }
121 jack_nframes_t get_capture_start_frame (uint32_t n=0);
122 jack_nframes_t get_captured_frames (uint32_t n=0);
124 uint32_t n_channels() { return _n_channels; }
126 static jack_nframes_t disk_io_frames() { return disk_io_chunk_frames; }
127 static void set_disk_io_chunk_frames (uint32_t n) { disk_io_chunk_frames = n; }
130 virtual XMLNode& get_state(void) = 0;
131 virtual int set_state(const XMLNode& node) = 0;
133 // FIXME: makes sense for all diskstream types?
134 virtual void monitor_input (bool) {}
136 jack_nframes_t capture_offset() const { return _capture_offset; }
137 virtual void set_capture_offset ();
139 bool slaved() const { return _slaved; }
140 void set_slaved(bool yn) { _slaved = yn; }
142 virtual int set_loop (Location *loc);
143 sigc::signal<void,Location *> LoopSet;
145 std::list<Region*>& last_capture_regions () { return _last_capture_regions; }
147 virtual void handle_input_change (IOChange, void *src);
149 sigc::signal<void,void*> record_enable_changed;
150 sigc::signal<void> speed_changed;
151 sigc::signal<void,void*> reverse_changed;
152 sigc::signal<void> PlaylistChanged;
153 sigc::signal<void> AlignmentStyleChanged;
155 static sigc::signal<void> DiskOverrun;
156 static sigc::signal<void> DiskUnderrun;
157 static sigc::signal<void,Diskstream*> DiskstreamCreated; // XXX use a ref with sigc2
158 //static sigc::signal<void,list<Source*>*> DeleteSources;
160 XMLNode* deprecated_io_node;
163 friend class Session;
165 Diskstream (Session &, const string& name, Flag f = Recordable);
166 Diskstream (Session &, const XMLNode&);
168 /* the Session is the only point of access for these
169 because they require that the Session is "inactive"
170 while they are called.
173 virtual void set_pending_overwrite (bool) = 0;
174 virtual int overwrite_existing_buffers () = 0;
175 virtual void reverse_scrub_buffer (bool to_forward) = 0;
176 virtual void set_block_size (jack_nframes_t) = 0;
177 virtual int internal_playback_seek (jack_nframes_t distance) = 0;
178 virtual int can_internal_playback_seek (jack_nframes_t distance) = 0;
179 virtual int rename_write_sources () = 0;
180 virtual void reset_write_sources (bool, bool force = false) = 0;
181 virtual void non_realtime_input_change () = 0;
183 uint32_t read_data_count() const { return _read_data_count; }
184 uint32_t write_data_count() const { return _write_data_count; }
187 friend class Auditioner;
188 virtual int seek (jack_nframes_t which_sample, bool complete_refill = false) = 0;
193 virtual void prepare ();
194 virtual int process (jack_nframes_t transport_frame, jack_nframes_t nframes, jack_nframes_t offset, bool can_record, bool rec_monitors_input) = 0;
195 virtual bool commit (jack_nframes_t nframes) = 0;
196 virtual void recover (); /* called if commit will not be called, but process was */
200 /* use unref() to destroy a diskstream */
201 virtual ~Diskstream();
203 enum TransitionType {
208 struct CaptureTransition {
210 // the start or end file frame pos
211 jack_nframes_t capture_val;
214 /* the two central butler operations */
216 virtual int do_flush (char * workbuf, bool force = false) = 0;
217 //int do_refill (Sample *mixdown_buffer, float *gain_buffer, char *workbuf);
219 virtual int non_realtime_do_refill() = 0;
221 //int read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer, char * workbuf, jack_nframes_t& start, jack_nframes_t cnt,
222 // ChannelInfo& channel_info, int channel, bool reversed);
224 /* XXX fix this redundancy ... */
226 virtual void playlist_changed (Change);
227 virtual void playlist_modified ();
228 virtual void playlist_deleted (Playlist*) = 0;
229 virtual void session_controls_changed (Session::ControlType) = 0;
231 virtual void finish_capture (bool rec_monitors_input) = 0;
232 virtual void clean_up_capture (struct tm&, time_t, bool abort) = 0;
233 virtual void transport_stopped (struct tm&, time_t, bool abort) = 0;
240 virtual void init (Flag);
242 //void init_channel (ChannelInfo &chan);
243 //void destroy_channel (ChannelInfo &chan);
245 virtual int use_new_write_source (uint32_t n=0) = 0;
246 virtual int use_new_fade_source (uint32_t n=0) = 0;
248 virtual int find_and_use_playlist (const string&) = 0;
250 //void allocate_temporary_buffers ();
252 virtual int create_input_port () = 0;
253 virtual int connect_input_port () = 0;
254 virtual int seek_unlocked (jack_nframes_t which_sample) = 0;
256 virtual int ports_created () = 0;
258 virtual bool realtime_set_speed (double, bool global_change);
259 //void non_realtime_set_speed ();
261 std::list<Region*> _last_capture_regions;
262 //std::vector<FileSource*> capturing_sources;
263 virtual int use_pending_capture_data (XMLNode& node) = 0;
265 virtual void get_input_sources () = 0;
266 virtual void check_record_status (jack_nframes_t transport_frame, jack_nframes_t nframes, bool can_record) = 0;
267 //void set_align_style_from_io();
268 virtual void setup_destructive_playlist () = 0;
269 //void use_destructive_playlist ();
271 // Wouldn't hurt for this thing to do on a diet:
273 static jack_nframes_t disk_io_chunk_frames;
274 vector<CaptureInfo*> capture_info;
275 Glib::Mutex capture_info_lock;
277 uint32_t i_am_the_modifier;
280 ARDOUR::Session& _session;
282 uint32_t _n_channels;
285 mutable gint _record_enabled;
286 double _visible_speed;
287 double _actual_speed;
288 /* items needed for speed change logic */
289 bool _buffer_reallocation_required;
293 jack_nframes_t capture_start_frame;
294 jack_nframes_t capture_captured;
296 jack_nframes_t adjust_capture_position;
297 jack_nframes_t _capture_offset;
298 jack_nframes_t _roll_delay;
299 jack_nframes_t first_recordable_frame;
300 jack_nframes_t last_recordable_frame;
301 int last_possibly_recording;
302 AlignStyle _alignment_style;
306 Location* loop_location;
307 jack_nframes_t overwrite_frame;
308 off_t overwrite_offset;
309 bool pending_overwrite;
310 bool overwrite_queued;
311 IOChange input_change_pending;
312 jack_nframes_t wrap_buffer_size;
313 jack_nframes_t speed_buffer_size;
318 jack_nframes_t file_frame;
319 jack_nframes_t playback_sample;
320 jack_nframes_t playback_distance;
322 uint32_t _read_data_count;
323 uint32_t _write_data_count;
326 AlignStyle _persistent_alignment_style;
327 bool first_input_change;
329 Glib::Mutex state_lock;
331 jack_nframes_t scrub_start;
332 jack_nframes_t scrub_buffer_size;
333 jack_nframes_t scrub_offset;
337 sigc::connection ports_created_c;
338 sigc::connection plmod_connection;
339 sigc::connection plstate_connection;
340 sigc::connection plgone_connection;
342 unsigned char _flags;
346 }; /* namespace ARDOUR */
348 #endif /* __ardour_diskstream_h__ */