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 <boost/utility.hpp>
32 #include "evoral/types.hpp"
34 #include "ardour/ardour.h"
35 #include "ardour/chan_count.h"
36 #include "ardour/session_object.h"
37 #include "ardour/types.h"
38 #include "ardour/utils.h"
39 #include "ardour/public_diskstream.h"
53 class Diskstream : public SessionObject, public PublicDiskstream
63 Diskstream (Session &, const std::string& name, Flag f = Recordable);
64 Diskstream (Session &, const XMLNode&);
65 virtual ~Diskstream();
67 bool set_name (const std::string& str);
69 boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
70 void set_track (ARDOUR::Track *);
72 virtual float playback_buffer_load() const = 0;
73 virtual float capture_buffer_load() const = 0;
75 void set_flag (Flag f) { _flags = Flag (_flags | f); }
76 void unset_flag (Flag f) { _flags = Flag (_flags & ~f); }
78 AlignStyle alignment_style() const { return _alignment_style; }
79 AlignChoice alignment_choice() const { return _alignment_choice; }
80 void set_align_style (AlignStyle);
81 void set_align_choice (AlignChoice a);
83 framecnt_t roll_delay() const { return _roll_delay; }
84 void set_roll_delay (framecnt_t);
86 bool record_enabled() const { return g_atomic_int_get (&_record_enabled); }
87 virtual void set_record_enabled (bool yn) = 0;
88 virtual void get_input_sources () = 0;
90 bool destructive() const { return _flags & Destructive; }
91 virtual int set_destructive (bool /*yn*/) { return -1; }
92 virtual int set_non_layered (bool /*yn*/) { return -1; }
93 virtual bool can_become_destructive (bool& /*requires_bounce*/) const { return false; }
95 bool hidden() const { return _flags & Hidden; }
96 bool recordable() const { return _flags & Recordable; }
97 bool non_layered() const { return _flags & NonLayered; }
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 non_realtime_set_speed ();
105 virtual void non_realtime_locate (framepos_t /*location*/) {};
106 virtual void playlist_modified ();
108 boost::shared_ptr<Playlist> playlist () { return _playlist; }
110 virtual int use_playlist (boost::shared_ptr<Playlist>);
111 virtual int use_new_playlist () = 0;
112 virtual int use_copy_playlist () = 0;
114 /** @return Start position of currently-running capture (in session frames) */
115 framepos_t current_capture_start() const { return capture_start_frame; }
116 framepos_t current_capture_end() const { return capture_start_frame + capture_captured; }
117 framepos_t get_capture_start_frame (uint32_t n = 0) const;
118 framecnt_t get_captured_frames (uint32_t n = 0) const;
120 ChanCount n_channels() { return _n_channels; }
122 static framecnt_t disk_io_frames() { return disk_io_chunk_frames; }
123 static void set_disk_io_chunk_frames (framecnt_t n) { disk_io_chunk_frames = n; }
126 virtual XMLNode& get_state(void);
127 virtual int set_state(const XMLNode&, int version);
129 virtual void monitor_input (bool) {}
131 framecnt_t capture_offset() const { return _capture_offset; }
132 virtual void set_capture_offset ();
134 bool slaved() const { return _slaved; }
135 void set_slaved(bool yn) { _slaved = yn; }
137 int set_loop (Location *loc);
139 std::list<boost::shared_ptr<Source> >& last_capture_sources () { return _last_capture_sources; }
141 void handle_input_change (IOChange, void *src);
143 void move_processor_automation (boost::weak_ptr<Processor>,
144 std::list<Evoral::RangeMove<framepos_t> > const &);
146 /** For non-butler contexts (allocates temporary working buffers) */
147 virtual int do_refill_with_alloc() = 0;
148 virtual void set_block_size (pframes_t) = 0;
150 bool pending_overwrite () const {
151 return _pending_overwrite;
154 PBD::Signal0<void> RecordEnableChanged;
155 PBD::Signal0<void> SpeedChanged;
156 PBD::Signal0<void> ReverseChanged;
157 PBD::Signal0<void> PlaylistChanged;
158 PBD::Signal0<void> AlignmentStyleChanged;
159 PBD::Signal1<void,Location *> LoopSet;
161 static PBD::Signal0<void> DiskOverrun;
162 static PBD::Signal0<void> DiskUnderrun;
165 friend class Session;
168 /* the Session is the only point of access for these because they require
169 * that the Session is "inactive" while they are called.
172 virtual void set_pending_overwrite (bool) = 0;
173 virtual int overwrite_existing_buffers () = 0;
174 virtual int internal_playback_seek (framecnt_t distance) = 0;
175 virtual int can_internal_playback_seek (framecnt_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 (framepos_t which_sample, bool complete_refill = false) = 0;
190 virtual int process (framepos_t transport_frame, pframes_t nframes, bool can_record, bool rec_monitors_input, bool& need_butler) = 0;
191 virtual bool commit (framecnt_t nframes) = 0;
195 enum TransitionType {
200 struct CaptureTransition {
202 framepos_t capture_val; ///< The start or end file frame position
205 /* The two central butler operations */
206 virtual int do_flush (RunContext context, bool force = false) = 0;
207 virtual int do_refill () = 0;
209 /* XXX fix this redundancy ... */
211 virtual void playlist_changed (const PBD::PropertyChange&);
212 virtual void playlist_deleted (boost::weak_ptr<Playlist>);
213 virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<framepos_t> > const &, bool);
215 virtual void transport_stopped_wallclock (struct tm&, time_t, bool abort) = 0;
216 virtual void transport_looped (framepos_t transport_frame) = 0;
223 virtual int use_new_write_source (uint32_t n=0) = 0;
225 virtual int find_and_use_playlist (const std::string&) = 0;
227 virtual void allocate_temporary_buffers () = 0;
229 virtual bool realtime_set_speed (double, bool global_change);
231 std::list<boost::shared_ptr<Source> > _last_capture_sources;
233 virtual int use_pending_capture_data (XMLNode& node) = 0;
235 virtual void check_record_status (framepos_t transport_frame, bool can_record);
236 virtual void prepare_record_status (framepos_t /*capture_start_frame*/) {}
237 virtual void set_align_style_from_io() {}
238 virtual void setup_destructive_playlist () {}
239 virtual void use_destructive_playlist () {}
240 virtual void prepare_to_stop (framepos_t pos);
242 void calculate_record_range(OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
243 framecnt_t& rec_nframes, framecnt_t& rec_offset);
245 static framecnt_t disk_io_chunk_frames;
246 std::vector<CaptureInfo*> capture_info;
247 mutable Glib::Mutex capture_info_lock;
249 uint32_t i_am_the_modifier;
251 boost::shared_ptr<ARDOUR::IO> _io;
253 ChanCount _n_channels;
255 boost::shared_ptr<Playlist> _playlist;
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 /** Start of currently running capture in session frames */
266 framepos_t capture_start_frame;
267 framecnt_t capture_captured;
269 framecnt_t adjust_capture_position;
270 framecnt_t _capture_offset;
271 framecnt_t _roll_delay;
272 framepos_t first_recordable_frame;
273 framepos_t last_recordable_frame;
274 int last_possibly_recording;
275 AlignStyle _alignment_style;
276 AlignChoice _alignment_choice;
279 Location* loop_location;
280 framepos_t overwrite_frame;
281 off_t overwrite_offset;
282 bool _pending_overwrite;
283 bool overwrite_queued;
284 IOChange input_change_pending;
285 framecnt_t wrap_buffer_size;
286 framecnt_t speed_buffer_size;
289 double _target_speed;
291 framepos_t file_frame;
292 framepos_t playback_sample;
293 framecnt_t playback_distance;
295 uint32_t _read_data_count;
296 uint32_t _write_data_count;
300 Glib::Mutex state_lock;
302 PBD::ScopedConnectionList playlist_connections;
304 PBD::ScopedConnection ic_connection;
307 XMLNode* deprecated_io_node;
309 void route_going_away ();
312 }; /* namespace ARDOUR */
314 #endif /* __ardour_diskstream_h__ */