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