src/lib/audio_decoder_stream.cc

   1 /*
   2     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "audio_decoder_stream.h"
  22 #include "audio_buffers.h"
  23 #include "audio_processor.h"
  24 #include "audio_decoder.h"
  25 #include "resampler.h"
  26 #include "util.h"
  27 #include "film.h"
  28 #include "log.h"
  29 #include "audio_content.h"
  30 #include "compose.hpp"
  31 #include <iostream>
  32
  33 #include "i18n.h"
  34
  35 using std::list;
  36 using std::pair;
  37 using std::cout;
  38 using std::min;
  39 using std::max;
  40 using boost::optional;
  41 using boost::shared_ptr;
  42
  43 AudioDecoderStream::AudioDecoderStream (
  44         shared_ptr<const AudioContent> content, AudioStreamPtr stream, Decoder* decoder, AudioDecoder* audio_decoder, shared_ptr<Log> log
  45         )
  46         : _content (content)
  47         , _stream (stream)
  48         , _decoder (decoder)
  49         , _audio_decoder (audio_decoder)
  50         , _log (log)
  51           /* We effectively start having done a seek to zero; this allows silence-padding of the first
  52              data that comes out of our decoder.
  53           */
  54         , _seek_reference (ContentTime ())
  55 {
  56         if (content->resampled_frame_rate() != _stream->frame_rate() && _stream->channels() > 0) {
  57                 _resampler.reset (new Resampler (_stream->frame_rate(), content->resampled_frame_rate(), _stream->channels ()));
  58         }
  59
  60         reset_decoded ();
  61 }
  62
  63 void
  64 AudioDecoderStream::reset_decoded ()
  65 {
  66         _decoded = ContentAudio (shared_ptr<AudioBuffers> (new AudioBuffers (_stream->channels(), 0)), 0);
  67 }
  68
  69 ContentAudio
  70 AudioDecoderStream::get (Frame frame, Frame length, bool accurate)
  71 {
  72         shared_ptr<ContentAudio> dec;
  73
  74         _log->log (String::compose ("-> ADS has request for %1 %2", frame, length), LogEntry::TYPE_DEBUG_DECODE);
  75
  76         Frame const from = frame;
  77         Frame const to = from + length;
  78         Frame const have_from = _decoded.frame;
  79         Frame const have_to = _decoded.frame + _decoded.audio->frames();
  80
  81         optional<Frame> missing;
  82         if (have_from > from || have_to < to) {
  83                 /* We need something */
  84                 if (have_from < from && from < have_to) {
  85                         missing = have_to;
  86                 } else {
  87                         missing = from;
  88                 }
  89         }
  90
  91         if (missing) {
  92                 _audio_decoder->maybe_seek (ContentTime::from_frames (*missing, _content->resampled_frame_rate()), accurate);
  93         }
  94
  95         /* Offset of the data that we want from the start of _decoded.audio
  96            (to be set up shortly)
  97         */
  98         Frame decoded_offset = 0;
  99
 100         /* Now enough pass() calls will either:
 101          *  (a) give us what we want, or
 102          *  (b) hit the end of the decoder.
 103          *
 104          * If we are being accurate, we want the right frames,
 105          * otherwise any frames will do.
 106          */
 107         if (accurate) {
 108                 /* Keep stuffing data into _decoded until we have enough data, or the subclass does not want to give us any more */
 109                 while (
 110                         (_decoded.frame > frame || (_decoded.frame + _decoded.audio->frames()) <= to) &&
 111                         !_decoder->pass (Decoder::PASS_REASON_AUDIO, accurate)
 112                         )
 113                 {}
 114
 115                 decoded_offset = frame - _decoded.frame;
 116
 117                 _log->log (
 118                         String::compose ("Accurate ADS::get has offset %1 from request %2 and available %3", decoded_offset, frame, have_from),
 119                         LogEntry::TYPE_DEBUG_DECODE
 120                         );
 121         } else {
 122                 while (
 123                         _decoded.audio->frames() < length &&
 124                         !_decoder->pass (Decoder::PASS_REASON_AUDIO, accurate)
 125                         )
 126                 {}
 127
 128                 /* Use decoded_offset of 0, as we don't really care what frames we return */
 129         }
 130
 131         /* The amount of data available in _decoded.audio starting from `frame'.  This could be -ve
 132            if pass() returned true before we got enough data.
 133         */
 134         Frame const available = _decoded.audio->frames() - decoded_offset;
 135
 136         /* We will return either that, or the requested amount, whichever is smaller */
 137         Frame const to_return = max ((Frame) 0, min (available, length));
 138
 139         /* Copy our data to the output */
 140         shared_ptr<AudioBuffers> out (new AudioBuffers (_decoded.audio->channels(), to_return));
 141         out->copy_from (_decoded.audio.get(), to_return, decoded_offset, 0);
 142
 143         Frame const remaining = max ((Frame) 0, available - to_return);
 144
 145         /* Clean up decoded; first, move the data after what we just returned to the start of the buffer */
 146         _decoded.audio->move (decoded_offset + to_return, 0, remaining);
 147         /* And set up the number of frames we have left */
 148         _decoded.audio->set_frames (remaining);
 149         /* Also bump where those frames are in terms of the content */
 150         _decoded.frame += decoded_offset + to_return;
 151
 152         return ContentAudio (out, frame);
 153 }
 154
 155 /** Audio timestamping is made hard by many factors, but perhaps the most entertaining is resampling.
 156  *  We have to assume that we are feeding continuous data into the resampler, and so we get continuous
 157  *  data out.  Hence we do the timestamping here, post-resampler, just by counting samples.
 158  *
 159  *  The time is passed in here so that after a seek we can set up our _position.  The
 160  *  time is ignored once this has been done.
 161  */
 162 void
 163 AudioDecoderStream::audio (shared_ptr<const AudioBuffers> data, ContentTime time)
 164 {
 165         _log->log (String::compose ("ADS receives %1 %2", to_string(time), data->frames ()), LogEntry::TYPE_DEBUG_DECODE);
 166
 167         if (_resampler) {
 168                 data = _resampler->run (data);
 169         }
 170
 171         Frame const frame_rate = _content->resampled_frame_rate ();
 172
 173         if (_seek_reference) {
 174                 /* We've had an accurate seek and now we're seeing some data */
 175                 ContentTime const delta = time - _seek_reference.get ();
 176                 Frame const delta_frames = delta.frames_round (frame_rate);
 177                 if (delta_frames > 0) {
 178                         /* This data comes after the seek time.  Pad the data with some silence. */
 179                         shared_ptr<AudioBuffers> padded (new AudioBuffers (data->channels(), data->frames() + delta_frames));
 180                         padded->make_silent ();
 181                         padded->copy_from (data.get(), data->frames(), 0, delta_frames);
 182                         data = padded;
 183                         time -= delta;
 184                 }
 185                 _seek_reference = optional<ContentTime> ();
 186         }
 187
 188         if (!_position) {
 189                 _position = time.frames_round (frame_rate);
 190         }
 191
 192         DCPOMATIC_ASSERT (_position.get() >= (_decoded.frame + _decoded.audio->frames()));
 193
 194         add (data);
 195 }
 196
 197 void
 198 AudioDecoderStream::add (shared_ptr<const AudioBuffers> data)
 199 {
 200         if (!_position) {
 201                 /* This should only happen when there is a seek followed by a flush, but
 202                    we need to cope with it.
 203                 */
 204                 return;
 205         }
 206
 207         /* Resize _decoded to fit the new data */
 208         int new_size = 0;
 209         if (_decoded.audio->frames() == 0) {
 210                 /* There's nothing in there, so just store the new data */
 211                 new_size = data->frames ();
 212                 _decoded.frame = _position.get ();
 213         } else {
 214                 /* Otherwise we need to extend _decoded to include the new stuff */
 215                 new_size = _position.get() + data->frames() - _decoded.frame;
 216         }
 217
 218         _decoded.audio->ensure_size (new_size);
 219         _decoded.audio->set_frames (new_size);
 220
 221         /* Copy new data in */
 222         _decoded.audio->copy_from (data.get(), data->frames(), 0, _position.get() - _decoded.frame);
 223         _position = _position.get() + data->frames ();
 224
 225         /* Limit the amount of data we keep in case nobody is asking for it */
 226         int const max_frames = _content->resampled_frame_rate () * 10;
 227         if (_decoded.audio->frames() > max_frames) {
 228                 int const to_remove = _decoded.audio->frames() - max_frames;
 229                 _decoded.frame += to_remove;
 230                 _decoded.audio->move (to_remove, 0, max_frames);
 231                 _decoded.audio->set_frames (max_frames);
 232         }
 233 }
 234
 235 void
 236 AudioDecoderStream::flush ()
 237 {
 238         if (!_resampler) {
 239                 return;
 240         }
 241
 242         shared_ptr<const AudioBuffers> b = _resampler->flush ();
 243         if (b) {
 244                 add (b);
 245         }
 246 }
 247
 248 void
 249 AudioDecoderStream::seek (ContentTime t, bool accurate)
 250 {
 251         _position.reset ();
 252         reset_decoded ();
 253         if (accurate) {
 254                 _seek_reference = t;
 255         }
 256 }
 257
 258 void
 259 AudioDecoderStream::set_fast ()
 260 {
 261         if (_resampler) {
 262                 _resampler->set_fast ();
 263         }
 264 }