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