2 Copyright (C) 2009-2016 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_disk_reader_h__
21 #define __ardour_disk_reader_h__
25 #include "ardour/disk_io.h"
26 #include "ardour/midi_buffer.h"
34 template<typename T> class MidiRingBuffer;
36 class LIBARDOUR_API DiskReader : public DiskIOProcessor
39 DiskReader (Session&, std::string const & name, DiskIOProcessor::Flag f = DiskIOProcessor::Flag (0));
42 bool set_name (std::string const & str);
43 std::string display_name() const { return std::string (_("player")); }
45 static samplecnt_t chunk_samples() { return _chunk_samples; }
46 static samplecnt_t default_chunk_samples ();
47 static void set_chunk_samples (samplecnt_t n) { _chunk_samples = n; }
49 void run (BufferSet& /*bufs*/, samplepos_t /*start_sample*/, samplepos_t /*end_sample*/, double speed, pframes_t /*nframes*/, bool /*result_required*/);
50 void realtime_handle_transport_stopped ();
51 void realtime_locate ();
52 int overwrite_existing_buffers ();
53 void set_pending_overwrite (bool yn);
55 int set_state (const XMLNode&, int version);
57 PBD::Signal0<void> AlignmentStyleChanged;
59 float buffer_load() const;
61 void move_processor_automation (boost::weak_ptr<Processor>, std::list<Evoral::RangeMove<samplepos_t> > const &);
63 /* called by the Butler in a non-realtime context */
66 return refill (_mixdown_buffer, _gain_buffer, 0);
69 /** For non-butler contexts (allocates temporary working buffers)
71 * This accessible method has a default argument; derived classes
72 * must inherit the virtual method that we call which does NOT
73 * have a default argument, to avoid complications with inheritance
75 int do_refill_with_alloc (bool partial_fill = true) {
76 return _do_refill_with_alloc (partial_fill);
79 bool pending_overwrite () const { return _pending_overwrite; }
81 // Working buffers for do_refill (butler thread)
82 static void allocate_working_buffers();
83 static void free_working_buffers();
85 void adjust_buffering ();
87 int can_internal_playback_seek (samplecnt_t distance);
88 int internal_playback_seek (samplecnt_t distance);
89 int seek (samplepos_t sample, bool complete_refill = false);
91 static PBD::Signal0<void> Underrun;
93 void playlist_modified ();
94 void reset_tracker ();
96 static void set_midi_readahead_samples (samplecnt_t samples_ahead) { midi_readahead = samples_ahead; }
98 static void set_no_disk_output (bool yn);
99 static bool no_disk_output() { return _no_disk_output; }
103 friend class MidiTrack;
105 struct ReaderChannelInfo : public DiskIOProcessor::ChannelInfo {
106 ReaderChannelInfo (samplecnt_t buffer_size)
107 : DiskIOProcessor::ChannelInfo::ChannelInfo (buffer_size)
109 resize (buffer_size);
111 void resize (samplecnt_t);
116 void resolve_tracker (Evoral::EventSink<samplepos_t>& buffer, samplepos_t time);
118 void playlist_changed (const PBD::PropertyChange&);
119 int use_playlist (DataType, boost::shared_ptr<Playlist>);
120 void playlist_ranges_moved (std::list< Evoral::RangeMove<samplepos_t> > const &, bool);
122 int add_channel_to (boost::shared_ptr<ChannelList>, uint32_t how_many);
125 /** The number of samples by which this diskstream's output should be delayed
126 with respect to the transport sample. This is used for latency compensation.
128 samplepos_t overwrite_sample;
129 off_t overwrite_offset;
130 bool _pending_overwrite;
131 bool overwrite_queued;
132 IOChange input_change_pending;
133 samplepos_t file_sample[DataType::num_types];
135 int _do_refill_with_alloc (bool partial_fill);
137 static samplecnt_t _chunk_samples;
138 static samplecnt_t midi_readahead;
139 static bool _no_disk_output;
141 int audio_read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer,
142 samplepos_t& start, samplecnt_t cnt,
143 int channel, bool reversed);
144 int midi_read (samplepos_t& start, samplecnt_t cnt, bool reversed);
146 static Sample* _mixdown_buffer;
147 static gain_t* _gain_buffer;
149 int refill (Sample* mixdown_buffer, float* gain_buffer, samplecnt_t fill_level);
150 int refill_audio (Sample *mixdown_buffer, float *gain_buffer, samplecnt_t fill_level);
153 sampleoffset_t calculate_playback_distance (pframes_t);
155 void get_midi_playback (MidiBuffer& dst, samplepos_t start_sample, samplepos_t end_sample, MonitorState, BufferSet&, double speed, samplecnt_t distance);
160 #endif /* __ardour_disk_reader_h__ */