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 {
  49         if (content->resampled_frame_rate() != _stream->frame_rate() && _stream->channels() > 0) {
  50                 _resampler.reset (new Resampler (_stream->frame_rate(), content->resampled_frame_rate(), _stream->channels ()));
  51         }
  52
  53         reset_decoded ();
  54 }
  55
  56 void
  57 AudioDecoderStream::reset_decoded ()
  58 {
  59         _decoded = ContentAudio (shared_ptr<AudioBuffers> (new AudioBuffers (_stream->channels(), 0)), 0);
  60 }
  61
  62 ContentAudio
  63 AudioDecoderStream::get (Frame frame, Frame length, bool accurate)
  64 {
  65         shared_ptr<ContentAudio> dec;
  66
  67         _log->log (String::compose ("-> ADS has request for %1 %2", frame, length), LogEntry::TYPE_DEBUG_DECODE);
  68
  69         Frame const end = frame + length - 1;
  70
  71         /* If we are less than (about) 5 seconds behind the data that we want we'll
  72            run through it rather than seeking.
  73         */
  74         Frame const slack = 5 * 48000;
  75
  76         if (frame < _decoded.frame || end > (_decoded.frame + _decoded.audio->frames() + slack)) {
  77                 /* Either we have no decoded data, all our data is after the time that we
  78                    want, or what we do have is a long way from what we want: seek */
  79                 _decoder->seek (ContentTime::from_frames (frame, _content->resampled_frame_rate()), accurate);
  80         }
  81
  82         /* Offset of the data that we want from the start of _decoded.audio
  83            (to be set up shortly)
  84         */
  85         Frame decoded_offset = 0;
  86
  87         /* Now enough pass() calls will either:
  88          *  (a) give us what we want, or
  89          *  (b) hit the end of the decoder.
  90          *
  91          * If we are being accurate, we want the right frames,
  92          * otherwise any frames will do.
  93          */
  94         if (accurate) {
  95                 /* Keep stuffing data into _decoded until we have enough data, or the subclass does not want to give us any more */
  96                 while (
  97                         (_decoded.frame > frame || (_decoded.frame + _decoded.audio->frames()) < end) &&
  98                         !_decoder->pass (Decoder::PASS_REASON_AUDIO, accurate)
  99                         )
 100                 {}
 101
 102                 decoded_offset = frame - _decoded.frame;
 103
 104                 _log->log (
 105                         String::compose ("Accurate ADS::get has offset %1 from request %2 and available %3", decoded_offset, frame, _decoded.frame),
 106                         LogEntry::TYPE_DEBUG_DECODE
 107                         );
 108         } else {
 109                 while (
 110                         _decoded.audio->frames() < length &&
 111                         !_decoder->pass (Decoder::PASS_REASON_AUDIO, accurate)
 112                         )
 113                 {}
 114
 115                 /* Use decoded_offset of 0, as we don't really care what frames we return */
 116         }
 117
 118         /* The amount of data available in _decoded.audio starting from `frame'.  This could be -ve
 119            if pass() returned true before we got enough data.
 120         */
 121         Frame const available = _decoded.audio->frames() - decoded_offset;
 122
 123         /* We will return either that, or the requested amount, whichever is smaller */
 124         Frame const to_return = max ((Frame) 0, min (available, length));
 125
 126         /* Copy our data to the output */
 127         shared_ptr<AudioBuffers> out (new AudioBuffers (_decoded.audio->channels(), to_return));
 128         out->copy_from (_decoded.audio.get(), to_return, decoded_offset, 0);
 129
 130         Frame const remaining = max ((Frame) 0, available - to_return);
 131
 132         /* Clean up decoded; first, move the data after what we just returned to the start of the buffer */
 133         _decoded.audio->move (decoded_offset + to_return, 0, remaining);
 134         /* And set up the number of frames we have left */
 135         _decoded.audio->set_frames (remaining);
 136         /* Also bump where those frames are in terms of the content */
 137         _decoded.frame += decoded_offset + to_return;
 138
 139         return ContentAudio (out, frame);
 140 }
 141
 142 /** Audio timestamping is made hard by many factors, but perhaps the most entertaining is resampling.
 143  *  We have to assume that we are feeding continuous data into the resampler, and so we get continuous
 144  *  data out.  Hence we do the timestamping here, post-resampler, just by counting samples.
 145  *
 146  *  The time is passed in here so that after a seek we can set up our _position.  The
 147  *  time is ignored once this has been done.
 148  */
 149 void
 150 AudioDecoderStream::audio (shared_ptr<const AudioBuffers> data, ContentTime time)
 151 {
 152         _log->log (String::compose ("ADS receives %1 %2", time, data->frames ()), LogEntry::TYPE_DEBUG_DECODE);
 153
 154         if (_resampler) {
 155                 data = _resampler->run (data);
 156         }
 157
 158         Frame const frame_rate = _content->resampled_frame_rate ();
 159
 160         if (_seek_reference) {
 161                 /* We've had an accurate seek and now we're seeing some data */
 162                 ContentTime const delta = time - _seek_reference.get ();
 163                 Frame const delta_frames = delta.frames_round (frame_rate);
 164                 if (delta_frames > 0) {
 165                         /* This data comes after the seek time.  Pad the data with some silence. */
 166                         shared_ptr<AudioBuffers> padded (new AudioBuffers (data->channels(), data->frames() + delta_frames));
 167                         padded->make_silent ();
 168                         padded->copy_from (data.get(), data->frames(), 0, delta_frames);
 169                         data = padded;
 170                         time -= delta;
 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_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 }
 244
 245 void
 246 AudioDecoderStream::set_fast ()
 247 {
 248         if (_resampler) {
 249                 _resampler->set_fast ();
 250         }
 251 }