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