src/lib/ffmpeg_decoder.cc

   1 /*
   2     Copyright (C) 2012-2014 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 /** @file  src/ffmpeg_decoder.cc
  21  *  @brief A decoder using FFmpeg to decode content.
  22  */
  23
  24 #include <stdexcept>
  25 #include <vector>
  26 #include <iomanip>
  27 #include <iostream>
  28 #include <stdint.h>
  29 #include <sndfile.h>
  30 extern "C" {
  31 #include <libavcodec/avcodec.h>
  32 #include <libavformat/avformat.h>
  33 }
  34 #include "filter.h"
  35 #include "exceptions.h"
  36 #include "image.h"
  37 #include "util.h"
  38 #include "log.h"
  39 #include "ffmpeg_decoder.h"
  40 #include "ffmpeg_audio_stream.h"
  41 #include "ffmpeg_subtitle_stream.h"
  42 #include "filter_graph.h"
  43 #include "audio_buffers.h"
  44 #include "ffmpeg_content.h"
  45 #include "raw_image_proxy.h"
  46 #include "film.h"
  47 #include "timer.h"
  48
  49 #include "i18n.h"
  50
  51 #define LOG_GENERAL(...) _video_content->film()->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
  52 #define LOG_ERROR(...) _video_content->film()->log()->log (String::compose (__VA_ARGS__), Log::TYPE_ERROR);
  53 #define LOG_WARNING_NC(...) _video_content->film()->log()->log (__VA_ARGS__, Log::TYPE_WARNING);
  54 #define LOG_WARNING(...) _video_content->film()->log()->log (String::compose (__VA_ARGS__), Log::TYPE_WARNING);
  55
  56 using std::cout;
  57 using std::string;
  58 using std::vector;
  59 using std::list;
  60 using std::min;
  61 using std::pair;
  62 using std::make_pair;
  63 using boost::shared_ptr;
  64 using boost::optional;
  65 using boost::dynamic_pointer_cast;
  66 using dcp::Size;
  67
  68 FFmpegDecoder::FFmpegDecoder (shared_ptr<const FFmpegContent> c, shared_ptr<Log> log)
  69         : VideoDecoder (c)
  70         , AudioDecoder (c)
  71         , SubtitleDecoder (c)
  72         , FFmpeg (c)
  73         , _log (log)
  74 {
  75         /* Audio and video frame PTS values may not start with 0.  We want
  76            to fiddle them so that:
  77
  78            1.  One of them starts at time 0.
  79            2.  The first video PTS value ends up on a frame boundary.
  80
  81            Then we remove big initial gaps in PTS and we allow our
  82            insertion of black frames to work.
  83
  84            We will do pts_to_use = pts_from_ffmpeg + pts_offset;
  85         */
  86
  87         bool const have_video = c->first_video();
  88         bool const have_audio = c->audio_stream () && c->audio_stream()->first_audio;
  89
  90         /* First, make one of them start at 0 */
  91
  92         if (have_audio && have_video) {
  93                 _pts_offset = - min (c->first_video().get(), c->audio_stream()->first_audio.get());
  94         } else if (have_video) {
  95                 _pts_offset = - c->first_video().get();
  96         } else if (have_audio) {
  97                 _pts_offset = - c->audio_stream()->first_audio.get();
  98         }
  99
 100         /* If _pts_offset is positive we would be pushing things from a -ve PTS to be played.
 101            I don't think we ever want to do that, as it seems things at -ve PTS are not meant
 102            to be seen (use for alignment bars etc.); see mantis #418.
 103         */
 104         if (_pts_offset > ContentTime ()) {
 105                 _pts_offset = ContentTime ();
 106         }
 107
 108         /* Now adjust both so that the video pts starts on a frame */
 109         if (have_video && have_audio) {
 110                 ContentTime first_video = c->first_video().get() + _pts_offset;
 111                 ContentTime const old_first_video = first_video;
 112                 _pts_offset += first_video.round_up (c->video_frame_rate ()) - old_first_video;
 113         }
 114 }
 115
 116 void
 117 FFmpegDecoder::flush ()
 118 {
 119         /* Get any remaining frames */
 120
 121         _packet.data = 0;
 122         _packet.size = 0;
 123
 124         /* XXX: should we reset _packet.data and size after each *_decode_* call? */
 125
 126         while (decode_video_packet ()) {}
 127
 128         if (_ffmpeg_content->audio_stream()) {
 129                 decode_audio_packet ();
 130                 AudioDecoder::flush ();
 131         }
 132 }
 133
 134 bool
 135 FFmpegDecoder::pass ()
 136 {
 137         int r = av_read_frame (_format_context, &_packet);
 138
 139         /* AVERROR_INVALIDDATA can apparently be returned sometimes even when av_read_frame
 140            has pretty-much succeeded (and hence generated data which should be processed).
 141            Hence it makes sense to continue here in that case.
 142         */
 143         if (r < 0 && r != AVERROR_INVALIDDATA) {
 144                 if (r != AVERROR_EOF) {
 145                         /* Maybe we should fail here, but for now we'll just finish off instead */
 146                         char buf[256];
 147                         av_strerror (r, buf, sizeof(buf));
 148                         LOG_ERROR (N_("error on av_read_frame (%1) (%2)"), buf, r);
 149                 }
 150
 151                 flush ();
 152                 return true;
 153         }
 154
 155         int const si = _packet.stream_index;
 156
 157         if (si == _video_stream && !_ignore_video) {
 158                 decode_video_packet ();
 159         } else if (_ffmpeg_content->audio_stream() && _ffmpeg_content->audio_stream()->uses_index (_format_context, si)) {
 160                 decode_audio_packet ();
 161         } else if (_ffmpeg_content->subtitle_stream() && _ffmpeg_content->subtitle_stream()->uses_index (_format_context, si)) {
 162                 decode_subtitle_packet ();
 163         }
 164
 165         av_free_packet (&_packet);
 166         return false;
 167 }
 168
 169 /** @param data pointer to array of pointers to buffers.
 170  *  Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
 171  */
 172 shared_ptr<AudioBuffers>
 173 FFmpegDecoder::deinterleave_audio (uint8_t** data, int size)
 174 {
 175         DCPOMATIC_ASSERT (_ffmpeg_content->audio_channels());
 176         DCPOMATIC_ASSERT (bytes_per_audio_sample());
 177
 178         /* Deinterleave and convert to float */
 179
 180         /* total_samples and frames will be rounded down here, so if there are stray samples at the end
 181            of the block that do not form a complete sample or frame they will be dropped.
 182         */
 183         int const total_samples = size / bytes_per_audio_sample();
 184         int const frames = total_samples / _ffmpeg_content->audio_channels();
 185         shared_ptr<AudioBuffers> audio (new AudioBuffers (_ffmpeg_content->audio_channels(), frames));
 186
 187         switch (audio_sample_format()) {
 188         case AV_SAMPLE_FMT_U8:
 189         {
 190                 uint8_t* p = reinterpret_cast<uint8_t *> (data[0]);
 191                 int sample = 0;
 192                 int channel = 0;
 193                 for (int i = 0; i < total_samples; ++i) {
 194                         audio->data(channel)[sample] = float(*p++) / (1 << 23);
 195
 196                         ++channel;
 197                         if (channel == _ffmpeg_content->audio_channels()) {
 198                                 channel = 0;
 199                                 ++sample;
 200                         }
 201                 }
 202         }
 203         break;
 204
 205         case AV_SAMPLE_FMT_S16:
 206         {
 207                 int16_t* p = reinterpret_cast<int16_t *> (data[0]);
 208                 int sample = 0;
 209                 int channel = 0;
 210                 for (int i = 0; i < total_samples; ++i) {
 211                         audio->data(channel)[sample] = float(*p++) / (1 << 15);
 212
 213                         ++channel;
 214                         if (channel == _ffmpeg_content->audio_channels()) {
 215                                 channel = 0;
 216                                 ++sample;
 217                         }
 218                 }
 219         }
 220         break;
 221
 222         case AV_SAMPLE_FMT_S16P:
 223         {
 224                 int16_t** p = reinterpret_cast<int16_t **> (data);
 225                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 226                         for (int j = 0; j < frames; ++j) {
 227                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
 228                         }
 229                 }
 230         }
 231         break;
 232
 233         case AV_SAMPLE_FMT_S32:
 234         {
 235                 int32_t* p = reinterpret_cast<int32_t *> (data[0]);
 236                 int sample = 0;
 237                 int channel = 0;
 238                 for (int i = 0; i < total_samples; ++i) {
 239                         audio->data(channel)[sample] = static_cast<float>(*p++) / (1 << 31);
 240
 241                         ++channel;
 242                         if (channel == _ffmpeg_content->audio_channels()) {
 243                                 channel = 0;
 244                                 ++sample;
 245                         }
 246                 }
 247         }
 248         break;
 249
 250         case AV_SAMPLE_FMT_FLT:
 251         {
 252                 float* p = reinterpret_cast<float*> (data[0]);
 253                 int sample = 0;
 254                 int channel = 0;
 255                 for (int i = 0; i < total_samples; ++i) {
 256                         audio->data(channel)[sample] = *p++;
 257
 258                         ++channel;
 259                         if (channel == _ffmpeg_content->audio_channels()) {
 260                                 channel = 0;
 261                                 ++sample;
 262                         }
 263                 }
 264         }
 265         break;
 266
 267         case AV_SAMPLE_FMT_FLTP:
 268         {
 269                 float** p = reinterpret_cast<float**> (data);
 270                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 271                         memcpy (audio->data(i), p[i], frames * sizeof(float));
 272                 }
 273         }
 274         break;
 275
 276         default:
 277                 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format())));
 278         }
 279
 280         return audio;
 281 }
 282
 283 AVSampleFormat
 284 FFmpegDecoder::audio_sample_format () const
 285 {
 286         if (!_ffmpeg_content->audio_stream()) {
 287                 return (AVSampleFormat) 0;
 288         }
 289
 290         return audio_codec_context()->sample_fmt;
 291 }
 292
 293 int
 294 FFmpegDecoder::bytes_per_audio_sample () const
 295 {
 296         return av_get_bytes_per_sample (audio_sample_format ());
 297 }
 298
 299 void
 300 FFmpegDecoder::seek (ContentTime time, bool accurate)
 301 {
 302         VideoDecoder::seek (time, accurate);
 303         AudioDecoder::seek (time, accurate);
 304         SubtitleDecoder::seek (time, accurate);
 305
 306         /* If we are doing an `accurate' seek, we need to use pre-roll, as
 307            we don't really know what the seek will give us.
 308         */
 309
 310         ContentTime pre_roll = accurate ? ContentTime::from_seconds (2) : ContentTime (0);
 311         time -= pre_roll;
 312
 313         /* XXX: it seems debatable whether PTS should be used here...
 314            http://www.mjbshaw.com/2012/04/seeking-in-ffmpeg-know-your-timestamp.html
 315         */
 316
 317         ContentTime const u = time - _pts_offset;
 318         av_seek_frame (_format_context, _video_stream, u.seconds() / av_q2d (_format_context->streams[_video_stream]->time_base), 0);
 319
 320         avcodec_flush_buffers (video_codec_context());
 321         if (audio_codec_context ()) {
 322                 avcodec_flush_buffers (audio_codec_context ());
 323         }
 324         if (subtitle_codec_context ()) {
 325                 avcodec_flush_buffers (subtitle_codec_context ());
 326         }
 327 }
 328
 329 void
 330 FFmpegDecoder::decode_audio_packet ()
 331 {
 332         /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
 333            several times.
 334         */
 335
 336         AVPacket copy_packet = _packet;
 337
 338         while (copy_packet.size > 0) {
 339
 340                 int frame_finished;
 341                 int decode_result = avcodec_decode_audio4 (audio_codec_context(), _frame, &frame_finished, &copy_packet);
 342                 if (decode_result < 0) {
 343                         /* avcodec_decode_audio4 can sometimes return an error even though it has decoded
 344                            some valid data; for example dca_subframe_footer can return AVERROR_INVALIDDATA
 345                            if it overreads the auxiliary data.  ffplay carries on if frame_finished is true,
 346                            even in the face of such an error, so I think we should too.
 347
 348                            Returning from the method here caused mantis #352.
 349                         */
 350                         LOG_WARNING ("avcodec_decode_audio4 failed (%1)", decode_result);
 351
 352                         /* Fudge decode_result so that we come out of the while loop when
 353                            we've processed this data.
 354                         */
 355                         decode_result = copy_packet.size;
 356                 }
 357
 358                 if (frame_finished) {
 359                         ContentTime const ct = ContentTime::from_seconds (
 360                                 av_frame_get_best_effort_timestamp (_frame) *
 361                                 av_q2d (_ffmpeg_content->audio_stream()->stream (_format_context)->time_base))
 362                                 + _pts_offset;
 363
 364                         int const data_size = av_samples_get_buffer_size (
 365                                 0, audio_codec_context()->channels, _frame->nb_samples, audio_sample_format (), 1
 366                                 );
 367
 368                         audio (deinterleave_audio (_frame->data, data_size), ct);
 369                 }
 370
 371                 copy_packet.data += decode_result;
 372                 copy_packet.size -= decode_result;
 373         }
 374 }
 375
 376 bool
 377 FFmpegDecoder::decode_video_packet ()
 378 {
 379         int frame_finished;
 380         if (avcodec_decode_video2 (video_codec_context(), _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
 381                 return false;
 382         }
 383
 384         boost::mutex::scoped_lock lm (_filter_graphs_mutex);
 385
 386         shared_ptr<FilterGraph> graph;
 387
 388         list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
 389         while (i != _filter_graphs.end() && !(*i)->can_process (dcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
 390                 ++i;
 391         }
 392
 393         if (i == _filter_graphs.end ()) {
 394                 graph.reset (new FilterGraph (_ffmpeg_content, dcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
 395                 _filter_graphs.push_back (graph);
 396                 LOG_GENERAL (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format);
 397         } else {
 398                 graph = *i;
 399         }
 400
 401         list<pair<shared_ptr<Image>, int64_t> > images = graph->process (_frame);
 402
 403         for (list<pair<shared_ptr<Image>, int64_t> >::iterator i = images.begin(); i != images.end(); ++i) {
 404
 405                 shared_ptr<Image> image = i->first;
 406
 407                 if (i->second != AV_NOPTS_VALUE) {
 408                         double const pts = i->second * av_q2d (_format_context->streams[_video_stream]->time_base) + _pts_offset.seconds ();
 409                         video (
 410                                 shared_ptr<ImageProxy> (new RawImageProxy (image)),
 411                                 rint (pts * _ffmpeg_content->video_frame_rate ())
 412                                 );
 413                 } else {
 414                         LOG_WARNING_NC ("Dropping frame without PTS");
 415                 }
 416         }
 417
 418         return true;
 419 }
 420
 421 void
 422 FFmpegDecoder::decode_subtitle_packet ()
 423 {
 424         int got_subtitle;
 425         AVSubtitle sub;
 426         if (avcodec_decode_subtitle2 (subtitle_codec_context(), &sub, &got_subtitle, &_packet) < 0 || !got_subtitle) {
 427                 return;
 428         }
 429
 430         if (sub.num_rects <= 0) {
 431                 /* Sometimes we get an empty AVSubtitle, which is used by some codecs to
 432                    indicate that the previous subtitle should stop.  We can ignore it here.
 433                 */
 434                 return;
 435         } else if (sub.num_rects > 1) {
 436                 throw DecodeError (_("multi-part subtitles not yet supported"));
 437         }
 438
 439         /* Subtitle PTS (within the source, not taking into account any of the
 440            source that we may have chopped off for the DCP).
 441         */
 442         FFmpegSubtitlePeriod sub_period = subtitle_period (sub);
 443         ContentTimePeriod period;
 444         period.from = sub_period.from + _pts_offset;
 445         if (sub_period.to) {
 446                 /* We already know the subtitle period `to' time */
 447                 period.to = sub_period.to.get() + _pts_offset;
 448         } else {
 449                 /* We have to look up the `to' time in the stream's records */
 450                 period.to = ffmpeg_content()->subtitle_stream()->find_subtitle_to (sub_period.from);
 451         }
 452
 453         AVSubtitleRect const * rect = sub.rects[0];
 454
 455         if (rect->type != SUBTITLE_BITMAP) {
 456                 throw DecodeError (_("non-bitmap subtitles not yet supported"));
 457         }
 458
 459         /* Note RGBA is expressed little-endian, so the first byte in the word is R, second
 460            G, third B, fourth A.
 461         */
 462         shared_ptr<Image> image (new Image (PIX_FMT_RGBA, dcp::Size (rect->w, rect->h), true));
 463
 464         /* Start of the first line in the subtitle */
 465         uint8_t* sub_p = rect->pict.data[0];
 466         /* sub_p looks up into a BGRA palette which is here
 467            (i.e. first byte B, second G, third R, fourth A)
 468         */
 469         uint32_t const * palette = (uint32_t *) rect->pict.data[1];
 470         /* Start of the output data */
 471         uint32_t* out_p = (uint32_t *) image->data()[0];
 472
 473         for (int y = 0; y < rect->h; ++y) {
 474                 uint8_t* sub_line_p = sub_p;
 475                 uint32_t* out_line_p = out_p;
 476                 for (int x = 0; x < rect->w; ++x) {
 477                         uint32_t const p = palette[*sub_line_p++];
 478                         *out_line_p++ = ((p & 0xff) << 16) | (p & 0xff00) | ((p & 0xff0000) >> 16) | (p & 0xff000000);
 479                 }
 480                 sub_p += rect->pict.linesize[0];
 481                 out_p += image->stride()[0] / sizeof (uint32_t);
 482         }
 483
 484         dcp::Size const vs = _ffmpeg_content->video_size ();
 485         dcpomatic::Rect<double> const scaled_rect (
 486                 static_cast<double> (rect->x) / vs.width,
 487                 static_cast<double> (rect->y) / vs.height,
 488                 static_cast<double> (rect->w) / vs.width,
 489                 static_cast<double> (rect->h) / vs.height
 490                 );
 491
 492         image_subtitle (ContentTimePeriod (period.from, period.to), image, scaled_rect);
 493
 494         avsubtitle_free (&sub);
 495 }
 496
 497 list<ContentTimePeriod>
 498 FFmpegDecoder::image_subtitles_during (ContentTimePeriod p, bool starting) const
 499 {
 500         return _ffmpeg_content->subtitles_during (p, starting);
 501 }
 502
 503 list<ContentTimePeriod>
 504 FFmpegDecoder::text_subtitles_during (ContentTimePeriod, bool) const
 505 {
 506         return list<ContentTimePeriod> ();
 507 }