Replace Time::frames with Time::frames_round and Time::frames_floor.
[dcpomatic.git] / src / lib / audio_decoder_stream.cc
1 /*
2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
3
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.
8
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.
13
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.
17
18 */
19
20 #include "audio_decoder_stream.h"
21 #include "audio_buffers.h"
22 #include "audio_processor.h"
23 #include "audio_decoder.h"
24 #include "resampler.h"
25 #include "util.h"
26 #include "film.h"
27 #include "log.h"
28 #include <iostream>
29
30 #include "i18n.h"
31
32 using std::list;
33 using std::pair;
34 using std::cout;
35 using std::min;
36 using std::max;
37 using boost::optional;
38 using boost::shared_ptr;
39
40 AudioDecoderStream::AudioDecoderStream (shared_ptr<const AudioContent> content, AudioStreamPtr stream, AudioDecoder* decoder)
41         : _content (content)
42         , _stream (stream)
43         , _decoder (decoder)
44 {
45         if (content->resampled_audio_frame_rate() != _stream->frame_rate()) {
46                 _resampler.reset (new Resampler (_stream->frame_rate(), content->resampled_audio_frame_rate(), _stream->channels ()));
47         }
48
49         reset_decoded ();
50 }
51
52 void
53 AudioDecoderStream::reset_decoded ()
54 {
55         _decoded = ContentAudio (shared_ptr<AudioBuffers> (new AudioBuffers (_stream->channels(), 0)), 0);
56 }
57
58 ContentAudio
59 AudioDecoderStream::get (Frame frame, Frame length, bool accurate)
60 {
61         shared_ptr<ContentAudio> dec;
62
63         _content->film()->log()->log (String::compose ("ADS has request for %1 %2", frame, length), Log::TYPE_DEBUG_DECODE);
64
65         Frame const end = frame + length - 1;
66
67         if (frame < _decoded.frame || end > (_decoded.frame + length * 4)) {
68                 /* Either we have no decoded data, or what we do have is a long way from what we want: seek */
69                 seek (ContentTime::from_frames (frame, _content->resampled_audio_frame_rate()), accurate);
70         }
71
72         /* Offset of the data that we want from the start of _decoded.audio
73            (to be set up shortly)
74         */
75         Frame decoded_offset = 0;
76
77         /* Now enough pass() calls will either:
78          *  (a) give us what we want, or
79          *  (b) hit the end of the decoder.
80          *
81          * If we are being accurate, we want the right frames,
82          * otherwise any frames will do.
83          */
84         if (accurate) {
85                 /* Keep stuffing data into _decoded until we have enough data, or the subclass does not want to give us any more */
86                 while (
87                         (_decoded.frame > frame || (_decoded.frame + _decoded.audio->frames()) < end) &&
88                         !_decoder->pass ()
89                         )
90                 {}
91
92                 decoded_offset = frame - _decoded.frame;
93         } else {
94                 while (
95                         _decoded.audio->frames() < length &&
96                         !_decoder->pass ()
97                         )
98                 {}
99
100                 /* Use decoded_offset of 0, as we don't really care what frames we return */
101         }
102
103         /* The amount of data available in _decoded.audio starting from `frame'.  This could be -ve
104            if pass() returned true before we got enough data.
105         */
106         Frame const available = _decoded.audio->frames() - decoded_offset;
107
108         /* We will return either that, or the requested amount, whichever is smaller */
109         Frame const to_return = max ((Frame) 0, min (available, length));
110
111         /* Copy our data to the output */
112         shared_ptr<AudioBuffers> out (new AudioBuffers (_decoded.audio->channels(), to_return));
113         out->copy_from (_decoded.audio.get(), to_return, decoded_offset, 0);
114
115         Frame const remaining = max ((Frame) 0, available - to_return);
116
117         /* Clean up decoded; first, move the data after what we just returned to the start of the buffer */
118         _decoded.audio->move (decoded_offset + to_return, 0, remaining);
119         /* And set up the number of frames we have left */
120         _decoded.audio->set_frames (remaining);
121         /* Also bump where those frames are in terms of the content */
122         _decoded.frame += decoded_offset + to_return;
123
124         return ContentAudio (out, frame);
125 }
126
127 /** Audio timestamping is made hard by many factors, but perhaps the most entertaining is resampling.
128  *  We have to assume that we are feeding continuous data into the resampler, and so we get continuous
129  *  data out.  Hence we do the timestamping here, post-resampler, just by counting samples.
130  *
131  *  The time is passed in here so that after a seek we can set up our _position.  The
132  *  time is ignored once this has been done.
133  */
134 void
135 AudioDecoderStream::audio (shared_ptr<const AudioBuffers> data, ContentTime time)
136 {
137         _content->film()->log()->log (String::compose ("ADS receives %1 %2", time, data->frames ()), Log::TYPE_DEBUG_DECODE);
138
139         if (_resampler) {
140                 data = _resampler->run (data);
141         }
142
143         Frame const frame_rate = _content->resampled_audio_frame_rate ();
144
145         if (_seek_reference) {
146                 /* We've had an accurate seek and now we're seeing some data */
147                 ContentTime const delta = time - _seek_reference.get ();
148                 Frame const delta_frames = delta.frames_round (frame_rate);
149                 if (delta_frames > 0) {
150                         /* This data comes after the seek time.  Pad the data with some silence. */
151                         shared_ptr<AudioBuffers> padded (new AudioBuffers (data->channels(), data->frames() + delta_frames));
152                         padded->make_silent ();
153                         padded->copy_from (data.get(), data->frames(), 0, delta_frames);
154                         data = padded;
155                         time -= delta;
156                 } else if (delta_frames < 0) {
157                         /* This data comes before the seek time.  Throw some data away */
158                         Frame const to_discard = min (-delta_frames, static_cast<Frame> (data->frames()));
159                         Frame const to_keep = data->frames() - to_discard;
160                         if (to_keep == 0) {
161                                 /* We have to throw all this data away, so keep _seek_reference and
162                                    try again next time some data arrives.
163                                 */
164                                 return;
165                         }
166                         shared_ptr<AudioBuffers> trimmed (new AudioBuffers (data->channels(), to_keep));
167                         trimmed->copy_from (data.get(), to_keep, to_discard, 0);
168                         data = trimmed;
169                         time += ContentTime::from_frames (to_discard, frame_rate);
170                 }
171                 _seek_reference = optional<ContentTime> ();
172         }
173
174         if (!_position) {
175                 _position = time.frames_round (frame_rate);
176         }
177
178         DCPOMATIC_ASSERT (_position.get() >= (_decoded.frame + _decoded.audio->frames()));
179
180         add (data);
181 }
182
183 void
184 AudioDecoderStream::add (shared_ptr<const AudioBuffers> data)
185 {
186         if (!_position) {
187                 /* This should only happen when there is a seek followed by a flush, but
188                    we need to cope with it.
189                 */
190                 return;
191         }
192
193         /* Resize _decoded to fit the new data */
194         int new_size = 0;
195         if (_decoded.audio->frames() == 0) {
196                 /* There's nothing in there, so just store the new data */
197                 new_size = data->frames ();
198                 _decoded.frame = _position.get ();
199         } else {
200                 /* Otherwise we need to extend _decoded to include the new stuff */
201                 new_size = _position.get() + data->frames() - _decoded.frame;
202         }
203
204         _decoded.audio->ensure_size (new_size);
205         _decoded.audio->set_frames (new_size);
206
207         /* Copy new data in */
208         _decoded.audio->copy_from (data.get(), data->frames(), 0, _position.get() - _decoded.frame);
209         _position = _position.get() + data->frames ();
210
211         /* Limit the amount of data we keep in case nobody is asking for it */
212         int const max_frames = _content->resampled_audio_frame_rate () * 10;
213         if (_decoded.audio->frames() > max_frames) {
214                 int const to_remove = _decoded.audio->frames() - max_frames;
215                 _decoded.frame += to_remove;
216                 _decoded.audio->move (to_remove, 0, max_frames);
217                 _decoded.audio->set_frames (max_frames);
218         }
219 }
220
221 void
222 AudioDecoderStream::flush ()
223 {
224         if (!_resampler) {
225                 return;
226         }
227
228         shared_ptr<const AudioBuffers> b = _resampler->flush ();
229         if (b) {
230                 add (b);
231         }
232 }
233
234 void
235 AudioDecoderStream::seek (ContentTime t, bool accurate)
236 {
237         _position.reset ();
238         reset_decoded ();
239         if (accurate) {
240                 _seek_reference = t;
241         }
242 }