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/location.h"
43 #include "ardour/session_object.h"
44 #include "ardour/types.h"
45 #include "ardour/utils.h"
46 #include "ardour/chan_count.h"
61 class Diskstream : public SessionObject, public boost::noncopyable
71 Diskstream (Session &, const std::string& name, Flag f = Recordable);
72 Diskstream (Session &, const XMLNode&);
73 virtual ~Diskstream();
75 bool set_name (const std::string& str);
77 boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
78 void set_route (ARDOUR::Route&);
80 virtual float playback_buffer_load() const = 0;
81 virtual float capture_buffer_load() const = 0;
83 void set_flag (Flag f) { _flags = Flag (_flags | f); }
84 void unset_flag (Flag f) { _flags = Flag (_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 nframes_t roll_delay() const { return _roll_delay; }
91 void set_roll_delay (nframes_t);
93 bool record_enabled() const { return g_atomic_int_get (&_record_enabled); }
94 virtual void set_record_enabled (bool yn) = 0;
96 bool destructive() const { return _flags & Destructive; }
97 virtual int set_destructive (bool /*yn*/) { return -1; }
98 virtual int set_non_layered (bool /*yn*/) { return -1; }
99 virtual bool can_become_destructive (bool& /*requires_bounce*/) const { return false; }
101 bool hidden() const { return _flags & Hidden; }
102 bool recordable() const { return _flags & Recordable; }
103 bool non_layered() const { return _flags & NonLayered; }
104 bool reversed() const { return _actual_speed < 0.0f; }
105 double speed() const { return _visible_speed; }
107 virtual void punch_in() {}
108 virtual void punch_out() {}
110 void set_speed (double);
111 void non_realtime_set_speed ();
112 virtual void non_realtime_locate (nframes_t /*location*/) {};
113 virtual void playlist_modified ();
115 boost::shared_ptr<Playlist> playlist () { return _playlist; }
117 virtual int use_playlist (boost::shared_ptr<Playlist>);
118 virtual int use_new_playlist () = 0;
119 virtual int use_copy_playlist () = 0;
121 nframes_t current_capture_start() const { return capture_start_frame; }
122 nframes_t current_capture_end() const { return capture_start_frame + capture_captured; }
123 nframes_t get_capture_start_frame (uint32_t n=0);
124 nframes_t get_captured_frames (uint32_t n=0);
126 ChanCount n_channels() { return _n_channels; }
128 static nframes_t disk_io_frames() { return disk_io_chunk_frames; }
129 static void set_disk_io_chunk_frames (uint32_t n) { disk_io_chunk_frames = n; }
132 virtual XMLNode& get_state(void) = 0;
133 virtual int set_state(const XMLNode& node) = 0;
135 virtual void monitor_input (bool) {}
137 nframes_t capture_offset() const { return _capture_offset; }
138 virtual void set_capture_offset ();
140 bool slaved() const { return _slaved; }
141 void set_slaved(bool yn) { _slaved = yn; }
143 int set_loop (Location *loc);
145 std::list<boost::shared_ptr<Region> >& last_capture_regions () { return _last_capture_regions; }
147 void handle_input_change (IOChange, void *src);
149 void remove_region_from_last_capture (boost::weak_ptr<Region> wregion);
151 void move_processor_automation (boost::weak_ptr<Processor>,
152 std::list< Evoral::RangeMove<nframes_t> > const &);
154 sigc::signal<void> RecordEnableChanged;
155 sigc::signal<void> SpeedChanged;
156 sigc::signal<void> ReverseChanged;
157 sigc::signal<void> PlaylistChanged;
158 sigc::signal<void> AlignmentStyleChanged;
159 sigc::signal<void,Location *> LoopSet;
161 static sigc::signal<void> DiskOverrun;
162 static sigc::signal<void> DiskUnderrun;
165 friend class Session;
167 /* the Session is the only point of access for these because they require
168 * that the Session is "inactive" while they are called.
171 virtual void set_pending_overwrite (bool) = 0;
172 virtual int overwrite_existing_buffers () = 0;
173 virtual void set_block_size (nframes_t) = 0;
174 virtual int internal_playback_seek (nframes_t distance) = 0;
175 virtual int can_internal_playback_seek (nframes_t distance) = 0;
176 virtual int rename_write_sources () = 0;
177 virtual void reset_write_sources (bool, bool force = false) = 0;
178 virtual void non_realtime_input_change () = 0;
180 uint32_t read_data_count() const { return _read_data_count; }
181 uint32_t write_data_count() const { return _write_data_count; }
184 friend class Auditioner;
185 virtual int seek (nframes_t which_sample, bool complete_refill = false) = 0;
190 virtual void prepare ();
191 virtual int process (nframes_t transport_frame, nframes_t nframes, bool can_record, bool rec_monitors_input) = 0;
192 virtual bool commit (nframes_t nframes) = 0;
193 virtual void recover (); /* called if commit will not be called, but process was */
197 enum TransitionType {
202 struct CaptureTransition {
204 nframes_t capture_val; ///< The start or end file frame position
207 /* The two central butler operations */
208 virtual int do_flush (RunContext context, bool force = false) = 0;
209 virtual int do_refill () = 0;
211 /** For non-butler contexts (allocates temporary working buffers) */
212 virtual int do_refill_with_alloc() = 0;
214 /* XXX fix this redundancy ... */
216 virtual void playlist_changed (Change);
217 virtual void playlist_deleted (boost::weak_ptr<Playlist>);
218 virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<nframes_t> > const &);
220 virtual void transport_stopped (struct tm&, time_t, bool abort) = 0;
221 virtual void transport_looped (nframes_t transport_frame) = 0;
228 virtual void init (Flag);
230 virtual int use_new_write_source (uint32_t n=0) = 0;
232 virtual int find_and_use_playlist (const std::string&) = 0;
234 virtual void allocate_temporary_buffers () = 0;
236 virtual bool realtime_set_speed (double, bool global_change);
238 std::list<boost::shared_ptr<Region> > _last_capture_regions;
240 virtual int use_pending_capture_data (XMLNode& node) = 0;
242 virtual void get_input_sources () = 0;
243 virtual void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record) = 0;
244 virtual void set_align_style_from_io() {}
245 virtual void setup_destructive_playlist () {}
246 virtual void use_destructive_playlist () {}
248 static nframes_t disk_io_chunk_frames;
249 std::vector<CaptureInfo*> capture_info;
250 Glib::Mutex capture_info_lock;
252 uint32_t i_am_the_modifier;
254 boost::shared_ptr<ARDOUR::IO> _io;
256 ChanCount _n_channels;
258 boost::shared_ptr<Playlist> _playlist;
260 mutable gint _record_enabled;
261 double _visible_speed;
262 double _actual_speed;
263 /* items needed for speed change logic */
264 bool _buffer_reallocation_required;
268 nframes_t capture_start_frame;
269 nframes_t capture_captured;
271 nframes_t adjust_capture_position;
272 nframes_t _capture_offset;
273 nframes_t _roll_delay;
274 nframes_t first_recordable_frame;
275 nframes_t last_recordable_frame;
276 int last_possibly_recording;
277 AlignStyle _alignment_style;
281 Location* loop_location;
282 nframes_t overwrite_frame;
283 off_t overwrite_offset;
284 bool pending_overwrite;
285 bool overwrite_queued;
286 IOChange input_change_pending;
287 nframes_t wrap_buffer_size;
288 nframes_t speed_buffer_size;
291 double _target_speed;
293 nframes_t file_frame;
294 nframes_t playback_sample;
295 nframes_t playback_distance;
296 bool commit_should_unlock;
298 uint32_t _read_data_count;
299 uint32_t _write_data_count;
302 AlignStyle _persistent_alignment_style;
303 bool first_input_change;
305 Glib::Mutex state_lock;
307 nframes_t scrub_start;
308 nframes_t scrub_buffer_size;
309 nframes_t scrub_offset;
311 sigc::connection ports_created_c;
312 sigc::connection plmod_connection;
313 sigc::connection plgone_connection;
314 sigc::connection plregion_connection;
318 void route_going_away ();
321 }; /* namespace ARDOUR */
323 #endif /* __ardour_diskstream_h__ */