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 <evoral/types.hpp>
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/location.h>
42 #include <ardour/session_object.h>
43 #include <ardour/types.h>
44 #include <ardour/utils.h>
45 #include <ardour/chan_count.h>
59 class Diskstream : public SessionObject
68 Diskstream (Session &, const string& name, Flag f = Recordable);
69 Diskstream (Session &, const XMLNode&);
70 virtual ~Diskstream();
72 bool set_name (const string& str);
74 ARDOUR::IO* io() const { return _io; }
75 void set_io (ARDOUR::IO& io);
77 virtual float playback_buffer_load() const = 0;
78 virtual float capture_buffer_load() const = 0;
80 void set_flag (Flag f) { _flags = Flag (_flags | f); }
81 void unset_flag (Flag f) { _flags = Flag (_flags & ~f); }
83 AlignStyle alignment_style() const { return _alignment_style; }
84 void set_align_style (AlignStyle);
85 void set_persistent_align_style (AlignStyle a) { _persistent_alignment_style = a; }
87 nframes_t roll_delay() const { return _roll_delay; }
88 void set_roll_delay (nframes_t);
90 bool record_enabled() const { return g_atomic_int_get (&_record_enabled); }
91 virtual void set_record_enabled (bool yn) = 0;
93 bool destructive() const { return _flags & Destructive; }
94 virtual int set_destructive (bool yn) { return -1; }
95 virtual bool can_become_destructive (bool& requires_bounce) const { return false; }
97 bool hidden() const { return _flags & Hidden; }
98 bool recordable() const { return _flags & Recordable; }
99 bool reversed() const { return _actual_speed < 0.0f; }
100 double speed() const { return _visible_speed; }
102 virtual void punch_in() {}
103 virtual void punch_out() {}
105 void set_speed (double);
106 void non_realtime_set_speed ();
107 virtual void non_realtime_locate (nframes_t location) {};
108 virtual void playlist_modified ();
110 boost::shared_ptr<Playlist> playlist () { return _playlist; }
112 virtual int use_playlist (boost::shared_ptr<Playlist>);
113 virtual int use_new_playlist () = 0;
114 virtual int use_copy_playlist () = 0;
116 nframes_t current_capture_start() const { return capture_start_frame; }
117 nframes_t current_capture_end() const { return capture_start_frame + capture_captured; }
118 nframes_t get_capture_start_frame (uint32_t n=0);
119 nframes_t get_captured_frames (uint32_t n=0);
121 ChanCount n_channels() { return _n_channels; }
123 static nframes_t disk_io_frames() { return disk_io_chunk_frames; }
124 static void set_disk_io_chunk_frames (uint32_t n) { disk_io_chunk_frames = n; }
127 virtual XMLNode& get_state(void) = 0;
128 virtual int set_state(const XMLNode& node) = 0;
130 virtual void monitor_input (bool) {}
132 nframes_t capture_offset() const { return _capture_offset; }
133 virtual void set_capture_offset ();
135 bool slaved() const { return _slaved; }
136 void set_slaved(bool yn) { _slaved = yn; }
138 int set_loop (Location *loc);
140 std::list<boost::shared_ptr<Region> >& last_capture_regions () { return _last_capture_regions; }
142 void handle_input_change (IOChange, void *src);
144 void remove_region_from_last_capture (boost::weak_ptr<Region> wregion);
146 void move_processor_automation (boost::weak_ptr<Processor>, Evoral::RangeMoveList const &);
148 sigc::signal<void> RecordEnableChanged;
149 sigc::signal<void> SpeedChanged;
150 sigc::signal<void> ReverseChanged;
151 sigc::signal<void> PlaylistChanged;
152 sigc::signal<void> AlignmentStyleChanged;
153 sigc::signal<void,Location *> LoopSet;
155 static sigc::signal<void> DiskOverrun;
156 static sigc::signal<void> DiskUnderrun;
159 friend class Session;
161 /* the Session is the only point of access for these because they require
162 * that the Session is "inactive" while they are called.
165 virtual void set_pending_overwrite (bool) = 0;
166 virtual int overwrite_existing_buffers () = 0;
167 virtual void set_block_size (nframes_t) = 0;
168 virtual int internal_playback_seek (nframes_t distance) = 0;
169 virtual int can_internal_playback_seek (nframes_t distance) = 0;
170 virtual int rename_write_sources () = 0;
171 virtual void reset_write_sources (bool, bool force = false) = 0;
172 virtual void non_realtime_input_change () = 0;
174 uint32_t read_data_count() const { return _read_data_count; }
175 uint32_t write_data_count() const { return _write_data_count; }
178 friend class Auditioner;
179 virtual int seek (nframes_t which_sample, bool complete_refill = false) = 0;
184 virtual void prepare ();
185 virtual int process (nframes_t transport_frame, nframes_t nframes, nframes_t offset, bool can_record, bool rec_monitors_input) = 0;
186 virtual bool commit (nframes_t nframes) = 0;
187 virtual void recover (); /* called if commit will not be called, but process was */
191 enum TransitionType {
196 struct CaptureTransition {
198 nframes_t capture_val; ///< The start or end file frame position
201 /* The two central butler operations */
202 virtual int do_flush (RunContext context, bool force = false) = 0;
203 virtual int do_refill () = 0;
205 /** For non-butler contexts (allocates temporary working buffers) */
206 virtual int do_refill_with_alloc() = 0;
208 /* XXX fix this redundancy ... */
210 virtual void playlist_changed (Change);
211 virtual void playlist_deleted (boost::weak_ptr<Playlist>);
212 virtual void playlist_ranges_moved (Evoral::RangeMoveList const &);
214 virtual void transport_stopped (struct tm&, time_t, bool abort) = 0;
215 virtual void transport_looped (nframes_t transport_frame) = 0;
222 virtual void init (Flag);
224 virtual int use_new_write_source (uint32_t n=0) = 0;
226 virtual int find_and_use_playlist (const string&) = 0;
228 virtual void allocate_temporary_buffers () = 0;
230 virtual bool realtime_set_speed (double, bool global_change);
232 std::list<boost::shared_ptr<Region> > _last_capture_regions;
234 virtual int use_pending_capture_data (XMLNode& node) = 0;
236 virtual void get_input_sources () = 0;
237 virtual void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record) = 0;
238 virtual void set_align_style_from_io() {}
239 virtual void setup_destructive_playlist () {}
240 virtual void use_destructive_playlist () {}
242 static nframes_t disk_io_chunk_frames;
243 std::vector<CaptureInfo*> capture_info;
244 Glib::Mutex capture_info_lock;
246 uint32_t i_am_the_modifier;
249 ChanCount _n_channels;
251 boost::shared_ptr<Playlist> _playlist;
253 mutable gint _record_enabled;
254 double _visible_speed;
255 double _actual_speed;
256 /* items needed for speed change logic */
257 bool _buffer_reallocation_required;
261 nframes_t capture_start_frame;
262 nframes_t capture_captured;
264 nframes_t adjust_capture_position;
265 nframes_t _capture_offset;
266 nframes_t _roll_delay;
267 nframes_t first_recordable_frame;
268 nframes_t last_recordable_frame;
269 int last_possibly_recording;
270 AlignStyle _alignment_style;
274 Location* loop_location;
275 nframes_t overwrite_frame;
276 off_t overwrite_offset;
277 bool pending_overwrite;
278 bool overwrite_queued;
279 IOChange input_change_pending;
280 nframes_t wrap_buffer_size;
281 nframes_t speed_buffer_size;
285 /// diskstream speed in 40.24 fixed point math
288 /// target diskstream speed in 40.24 fixed point math
291 nframes_t file_frame;
292 nframes_t playback_sample;
293 nframes_t playback_distance;
294 bool commit_should_unlock;
296 uint32_t _read_data_count;
297 uint32_t _write_data_count;
300 AlignStyle _persistent_alignment_style;
301 bool first_input_change;
303 Glib::Mutex state_lock;
305 nframes_t scrub_start;
306 nframes_t scrub_buffer_size;
307 nframes_t scrub_offset;
309 sigc::connection ports_created_c;
310 sigc::connection plmod_connection;
311 sigc::connection plgone_connection;
312 sigc::connection plregion_connection;
317 }; /* namespace ARDOUR */
319 #endif /* __ardour_diskstream_h__ */