summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/disk_reader.h
blob: 4c5244ab99f3a85029f9f160ea9d290a1abf28ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/*
    Copyright (C) 2009-2016 Paul Davis

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_disk_reader_h__
#define __ardour_disk_reader_h__

#include "ardour/disk_io.h"
#include "ardour/midi_buffer.h"

namespace ARDOUR
{

class Playlist;
class AudioPlaylist;
class MidiPlaylist;
template<typename T> class MidiRingBuffer;

class LIBARDOUR_API DiskReader : public DiskIOProcessor
{
  public:
	DiskReader (Session&, std::string const & name, DiskIOProcessor::Flag f = DiskIOProcessor::Flag (0));
	~DiskReader ();

	bool set_name (std::string const & str);

	static framecnt_t chunk_frames() { return _chunk_frames; }
	static framecnt_t default_chunk_frames ();
	static void set_chunk_frames (framecnt_t n) { _chunk_frames = n; }

	void run (BufferSet& /*bufs*/, framepos_t /*start_frame*/, framepos_t /*end_frame*/, double speed, pframes_t /*nframes*/, bool /*result_required*/);
	int set_block_size (pframes_t);
	bool configure_io (ChanCount in, ChanCount out);
	bool can_support_io_configuration (const ChanCount& in, ChanCount& out) = 0;
	void realtime_handle_transport_stopped ();
	void realtime_locate ();
	void non_realtime_locate (framepos_t);
	int overwrite_existing_buffers ();
	void set_pending_overwrite (bool yn);

	framecnt_t roll_delay() const { return _roll_delay; }
	void set_roll_delay (framecnt_t);

	virtual XMLNode& state (bool full);
	int set_state (const XMLNode&, int version);

	boost::shared_ptr<Playlist>      get_playlist (DataType dt) const { return _playlists[dt]; }
	boost::shared_ptr<MidiPlaylist>  midi_playlist() const;
	boost::shared_ptr<AudioPlaylist> audio_playlist() const;

	virtual void playlist_modified ();
	virtual int use_playlist (DataType, boost::shared_ptr<Playlist>);
	virtual int use_new_playlist (DataType);
	virtual int use_copy_playlist (DataType);

	PBD::Signal1<void,DataType>   PlaylistChanged;
	PBD::Signal0<void>            AlignmentStyleChanged;

	int set_loop (Location *loc);

	float buffer_load() const;

	void move_processor_automation (boost::weak_ptr<Processor>, std::list<Evoral::RangeMove<framepos_t> > const &);

	/* called by the Butler in a non-realtime context */

	int do_refill () {
		return refill (_mixdown_buffer, _gain_buffer, 0);
	}

	/** For non-butler contexts (allocates temporary working buffers)
	 *
	 * This accessible method has a default argument; derived classes
	 * must inherit the virtual method that we call which does NOT
	 * have a default argument, to avoid complications with inheritance
	 */
	int do_refill_with_alloc (bool partial_fill = true) {
		return _do_refill_with_alloc (partial_fill);
	}

	bool pending_overwrite () const { return _pending_overwrite; }

	virtual int find_and_use_playlist (DataType, std::string const &);

	// Working buffers for do_refill (butler thread)
	static void allocate_working_buffers();
	static void free_working_buffers();

	void adjust_buffering ();

	int can_internal_playback_seek (framecnt_t distance);
	int seek (framepos_t frame, bool complete_refill = false);

	bool need_butler() const { return _need_butler; }

	PBD::Signal0<void> Underrun;

  protected:
	boost::shared_ptr<Playlist> _playlists[DataType::num_types];

	virtual void playlist_changed (const PBD::PropertyChange&);
	virtual void playlist_deleted (boost::weak_ptr<Playlist>);
	virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<framepos_t> > const &, bool);

	void reset_tracker ();
	void resolve_tracker (Evoral::EventSink<framepos_t>& buffer, framepos_t time);
	boost::shared_ptr<MidiBuffer> get_gui_feed_buffer () const;

  private:
	/** The number of frames by which this diskstream's output should be delayed
	    with respect to the transport frame.  This is used for latency compensation.
	*/
	framecnt_t   _roll_delay;
	Location*     loop_location;
	framepos_t    overwrite_frame;
	off_t         overwrite_offset;
	bool          _pending_overwrite;
	bool          overwrite_queued;
	IOChange      input_change_pending;
	framecnt_t    wrap_buffer_size;
	framecnt_t    speed_buffer_size;
	framepos_t     file_frame;
	framepos_t     playback_sample;
	MonitorChoice   _monitoring_choice;
	bool            _need_butler;

	PBD::ScopedConnectionList playlist_connections;

	int _do_refill_with_alloc (bool partial_fill);

	static framecnt_t _chunk_frames;
	static framecnt_t midi_readahead;

	/* The MIDI stuff */

	MidiRingBuffer<framepos_t>*  _midi_buf;

	/** A buffer that we use to put newly-arrived MIDI data in for
	    the GUI to read (so that it can update itself).
	*/
	MidiBuffer                   _gui_feed_buffer;
	mutable Glib::Threads::Mutex _gui_feed_buffer_mutex;
	CubicMidiInterpolation midi_interpolation;
	gint                         _frames_written_to_ringbuffer;
	gint                         _frames_read_from_ringbuffer;


	int audio_read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer,
	                framepos_t& start, framecnt_t cnt,
	                int channel, bool reversed);
	int midi_read (framepos_t& start, framecnt_t cnt, bool reversed);

	static Sample* _mixdown_buffer;
	static gain_t* _gain_buffer;

	int refill (Sample* mixdown_buffer, float* gain_buffer, framecnt_t fill_level);
	int refill_audio (Sample *mixdown_buffer, float *gain_buffer, framecnt_t fill_level);
	int refill_midi ();

	int internal_playback_seek (framecnt_t distance);
	frameoffset_t calculate_playback_distance (pframes_t);

	void allocate_temporary_buffers();
	void get_playback (MidiBuffer& dst, framecnt_t nframes);
	void flush_playback (framepos_t start, framepos_t end);
};

} // namespace

#endif /* __ardour_disk_reader_h__ */