src/lib/ffmpeg_decoder.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 /** @file  src/ffmpeg_decoder.cc
  22  *  @brief A decoder using FFmpeg to decode content.
  23  */
  24
  25 #include "filter.h"
  26 #include "exceptions.h"
  27 #include "image.h"
  28 #include "util.h"
  29 #include "log.h"
  30 #include "ffmpeg_decoder.h"
  31 #include "subtitle_decoder.h"
  32 #include "ffmpeg_audio_stream.h"
  33 #include "ffmpeg_subtitle_stream.h"
  34 #include "video_filter_graph.h"
  35 #include "audio_buffers.h"
  36 #include "ffmpeg_content.h"
  37 #include "raw_image_proxy.h"
  38 #include "video_decoder.h"
  39 #include "film.h"
  40 #include "audio_decoder.h"
  41 #include "compose.hpp"
  42 #include "subtitle_content.h"
  43 #include "audio_content.h"
  44 #include <dcp/subtitle_string.h>
  45 #include <sub/ssa_reader.h>
  46 #include <sub/subtitle.h>
  47 #include <sub/collect.h>
  48 extern "C" {
  49 #include <libavcodec/avcodec.h>
  50 #include <libavformat/avformat.h>
  51 }
  52 #include <boost/foreach.hpp>
  53 #include <boost/algorithm/string.hpp>
  54 #include <vector>
  55 #include <iomanip>
  56 #include <iostream>
  57 #include <stdint.h>
  58
  59 #include "i18n.h"
  60
  61 #define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  62 #define LOG_ERROR(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
  63 #define LOG_WARNING_NC(...) _log->log (__VA_ARGS__, LogEntry::TYPE_WARNING);
  64 #define LOG_WARNING(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_WARNING);
  65
  66 using std::cout;
  67 using std::string;
  68 using std::vector;
  69 using std::list;
  70 using std::min;
  71 using std::pair;
  72 using std::max;
  73 using std::map;
  74 using boost::shared_ptr;
  75 using boost::is_any_of;
  76 using boost::split;
  77 using boost::optional;
  78 using boost::dynamic_pointer_cast;
  79 using dcp::Size;
  80
  81 FFmpegDecoder::FFmpegDecoder (shared_ptr<const FFmpegContent> c, shared_ptr<Log> log)
  82         : FFmpeg (c)
  83         , _log (log)
  84         , _have_current_subtitle (false)
  85 {
  86         if (c->video) {
  87                 video.reset (new VideoDecoder (this, c, log));
  88                 _pts_offset = pts_offset (c->ffmpeg_audio_streams(), c->first_video(), c->active_video_frame_rate());
  89         } else {
  90                 _pts_offset = ContentTime ();
  91         }
  92
  93         if (c->audio) {
  94                 audio.reset (new AudioDecoder (this, c->audio, log));
  95         }
  96
  97         if (c->subtitle) {
  98                 subtitle.reset (new SubtitleDecoder (this, c->subtitle, log));
  99         }
 100 }
 101
 102 void
 103 FFmpegDecoder::flush ()
 104 {
 105         /* Get any remaining frames */
 106
 107         _packet.data = 0;
 108         _packet.size = 0;
 109
 110         /* XXX: should we reset _packet.data and size after each *_decode_* call? */
 111
 112         while (video && decode_video_packet ()) {}
 113
 114         if (audio) {
 115                 decode_audio_packet ();
 116                 audio->flush ();
 117         }
 118 }
 119
 120 bool
 121 FFmpegDecoder::pass ()
 122 {
 123         int r = av_read_frame (_format_context, &_packet);
 124
 125         /* AVERROR_INVALIDDATA can apparently be returned sometimes even when av_read_frame
 126            has pretty-much succeeded (and hence generated data which should be processed).
 127            Hence it makes sense to continue here in that case.
 128         */
 129         if (r < 0 && r != AVERROR_INVALIDDATA) {
 130                 if (r != AVERROR_EOF) {
 131                         /* Maybe we should fail here, but for now we'll just finish off instead */
 132                         char buf[256];
 133                         av_strerror (r, buf, sizeof(buf));
 134                         LOG_ERROR (N_("error on av_read_frame (%1) (%2)"), &buf[0], r);
 135                 }
 136
 137                 flush ();
 138                 return true;
 139         }
 140
 141         int const si = _packet.stream_index;
 142         shared_ptr<const FFmpegContent> fc = _ffmpeg_content;
 143
 144         if (_video_stream && si == _video_stream.get() && !video->ignore()) {
 145                 decode_video_packet ();
 146         } else if (fc->subtitle_stream() && fc->subtitle_stream()->uses_index (_format_context, si)) {
 147                 decode_subtitle_packet ();
 148         } else {
 149                 decode_audio_packet ();
 150         }
 151
 152         av_packet_unref (&_packet);
 153         return false;
 154 }
 155
 156 /** @param data pointer to array of pointers to buffers.
 157  *  Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
 158  */
 159 shared_ptr<AudioBuffers>
 160 FFmpegDecoder::deinterleave_audio (shared_ptr<FFmpegAudioStream> stream) const
 161 {
 162         DCPOMATIC_ASSERT (bytes_per_audio_sample (stream));
 163
 164         int const size = av_samples_get_buffer_size (
 165                 0, stream->stream(_format_context)->codec->channels, _frame->nb_samples, audio_sample_format (stream), 1
 166                 );
 167
 168         /* Deinterleave and convert to float */
 169
 170         /* total_samples and frames will be rounded down here, so if there are stray samples at the end
 171            of the block that do not form a complete sample or frame they will be dropped.
 172         */
 173         int const total_samples = size / bytes_per_audio_sample (stream);
 174         int const frames = total_samples / stream->channels();
 175         shared_ptr<AudioBuffers> audio (new AudioBuffers (stream->channels(), frames));
 176
 177         switch (audio_sample_format (stream)) {
 178         case AV_SAMPLE_FMT_U8:
 179         {
 180                 uint8_t* p = reinterpret_cast<uint8_t *> (_frame->data[0]);
 181                 int sample = 0;
 182                 int channel = 0;
 183                 for (int i = 0; i < total_samples; ++i) {
 184                         audio->data(channel)[sample] = float(*p++) / (1 << 23);
 185
 186                         ++channel;
 187                         if (channel == stream->channels()) {
 188                                 channel = 0;
 189                                 ++sample;
 190                         }
 191                 }
 192         }
 193         break;
 194
 195         case AV_SAMPLE_FMT_S16:
 196         {
 197                 int16_t* p = reinterpret_cast<int16_t *> (_frame->data[0]);
 198                 int sample = 0;
 199                 int channel = 0;
 200                 for (int i = 0; i < total_samples; ++i) {
 201                         audio->data(channel)[sample] = float(*p++) / (1 << 15);
 202
 203                         ++channel;
 204                         if (channel == stream->channels()) {
 205                                 channel = 0;
 206                                 ++sample;
 207                         }
 208                 }
 209         }
 210         break;
 211
 212         case AV_SAMPLE_FMT_S16P:
 213         {
 214                 int16_t** p = reinterpret_cast<int16_t **> (_frame->data);
 215                 for (int i = 0; i < stream->channels(); ++i) {
 216                         for (int j = 0; j < frames; ++j) {
 217                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
 218                         }
 219                 }
 220         }
 221         break;
 222
 223         case AV_SAMPLE_FMT_S32:
 224         {
 225                 int32_t* p = reinterpret_cast<int32_t *> (_frame->data[0]);
 226                 int sample = 0;
 227                 int channel = 0;
 228                 for (int i = 0; i < total_samples; ++i) {
 229                         audio->data(channel)[sample] = static_cast<float>(*p++) / 2147483648;
 230
 231                         ++channel;
 232                         if (channel == stream->channels()) {
 233                                 channel = 0;
 234                                 ++sample;
 235                         }
 236                 }
 237         }
 238         break;
 239
 240         case AV_SAMPLE_FMT_S32P:
 241         {
 242                 int32_t** p = reinterpret_cast<int32_t **> (_frame->data);
 243                 for (int i = 0; i < stream->channels(); ++i) {
 244                         for (int j = 0; j < frames; ++j) {
 245                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / 2147483648;
 246                         }
 247                 }
 248         }
 249         break;
 250
 251         case AV_SAMPLE_FMT_FLT:
 252         {
 253                 float* p = reinterpret_cast<float*> (_frame->data[0]);
 254                 int sample = 0;
 255                 int channel = 0;
 256                 for (int i = 0; i < total_samples; ++i) {
 257                         audio->data(channel)[sample] = *p++;
 258
 259                         ++channel;
 260                         if (channel == stream->channels()) {
 261                                 channel = 0;
 262                                 ++sample;
 263                         }
 264                 }
 265         }
 266         break;
 267
 268         case AV_SAMPLE_FMT_FLTP:
 269         {
 270                 float** p = reinterpret_cast<float**> (_frame->data);
 271                 /* Sometimes there aren't as many channels in the _frame as in the stream */
 272                 for (int i = 0; i < _frame->channels; ++i) {
 273                         memcpy (audio->data(i), p[i], frames * sizeof(float));
 274                 }
 275                 for (int i = _frame->channels; i < stream->channels(); ++i) {
 276                         audio->make_silent (i);
 277                 }
 278         }
 279         break;
 280
 281         default:
 282                 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format (stream))));
 283         }
 284
 285         return audio;
 286 }
 287
 288 AVSampleFormat
 289 FFmpegDecoder::audio_sample_format (shared_ptr<FFmpegAudioStream> stream) const
 290 {
 291         return stream->stream (_format_context)->codec->sample_fmt;
 292 }
 293
 294 int
 295 FFmpegDecoder::bytes_per_audio_sample (shared_ptr<FFmpegAudioStream> stream) const
 296 {
 297         return av_get_bytes_per_sample (audio_sample_format (stream));
 298 }
 299
 300 void
 301 FFmpegDecoder::seek (ContentTime time, bool accurate)
 302 {
 303         Decoder::seek (time, accurate);
 304
 305         /* If we are doing an `accurate' seek, we need to use pre-roll, as
 306            we don't really know what the seek will give us.
 307         */
 308
 309         ContentTime pre_roll = accurate ? ContentTime::from_seconds (2) : ContentTime (0);
 310         time -= pre_roll;
 311
 312         /* XXX: it seems debatable whether PTS should be used here...
 313            http://www.mjbshaw.com/2012/04/seeking-in-ffmpeg-know-your-timestamp.html
 314         */
 315
 316         optional<int> stream;
 317
 318         if (_video_stream) {
 319                 stream = _video_stream;
 320         } else {
 321                 shared_ptr<FFmpegAudioStream> s = dynamic_pointer_cast<FFmpegAudioStream> (_ffmpeg_content->audio->stream ());
 322                 if (s) {
 323                         stream = s->index (_format_context);
 324                 }
 325         }
 326
 327         DCPOMATIC_ASSERT (stream);
 328
 329         ContentTime u = time - _pts_offset;
 330         if (u < ContentTime ()) {
 331                 u = ContentTime ();
 332         }
 333         av_seek_frame (
 334                 _format_context,
 335                 stream.get(),
 336                 u.seconds() / av_q2d (_format_context->streams[stream.get()]->time_base),
 337                 AVSEEK_FLAG_BACKWARD
 338                 );
 339
 340         if (video_codec_context ()) {
 341                 avcodec_flush_buffers (video_codec_context());
 342         }
 343
 344         BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_content()->ffmpeg_audio_streams()) {
 345                 avcodec_flush_buffers (i->stream(_format_context)->codec);
 346         }
 347
 348         if (subtitle_codec_context ()) {
 349                 avcodec_flush_buffers (subtitle_codec_context ());
 350         }
 351
 352         _have_current_subtitle = false;
 353 }
 354
 355 void
 356 FFmpegDecoder::decode_audio_packet ()
 357 {
 358         /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
 359            several times.
 360         */
 361
 362         AVPacket copy_packet = _packet;
 363
 364         /* XXX: inefficient */
 365         vector<shared_ptr<FFmpegAudioStream> > streams = ffmpeg_content()->ffmpeg_audio_streams ();
 366         vector<shared_ptr<FFmpegAudioStream> >::const_iterator stream = streams.begin ();
 367         while (stream != streams.end () && !(*stream)->uses_index (_format_context, copy_packet.stream_index)) {
 368                 ++stream;
 369         }
 370
 371         if (stream == streams.end ()) {
 372                 /* The packet's stream may not be an audio one; just ignore it in this method if so */
 373                 return;
 374         }
 375
 376         while (copy_packet.size > 0) {
 377
 378                 int frame_finished;
 379                 int decode_result = avcodec_decode_audio4 ((*stream)->stream (_format_context)->codec, _frame, &frame_finished, &copy_packet);
 380                 if (decode_result < 0) {
 381                         /* avcodec_decode_audio4 can sometimes return an error even though it has decoded
 382                            some valid data; for example dca_subframe_footer can return AVERROR_INVALIDDATA
 383                            if it overreads the auxiliary data.  ffplay carries on if frame_finished is true,
 384                            even in the face of such an error, so I think we should too.
 385
 386                            Returning from the method here caused mantis #352.
 387                         */
 388                         LOG_WARNING ("avcodec_decode_audio4 failed (%1)", decode_result);
 389
 390                         /* Fudge decode_result so that we come out of the while loop when
 391                            we've processed this data.
 392                         */
 393                         decode_result = copy_packet.size;
 394                 }
 395
 396                 if (frame_finished) {
 397                         ContentTime ct = ContentTime::from_seconds (
 398                                 av_frame_get_best_effort_timestamp (_frame) *
 399                                 av_q2d ((*stream)->stream (_format_context)->time_base))
 400                                 + _pts_offset;
 401
 402                         shared_ptr<AudioBuffers> data = deinterleave_audio (*stream);
 403
 404                         if (ct < ContentTime ()) {
 405                                 /* Discard audio data that comes before time 0 */
 406                                 Frame const remove = min (int64_t (data->frames()), (-ct).frames_ceil(double((*stream)->frame_rate ())));
 407                                 data->move (data->frames() - remove, remove, 0);
 408                                 data->set_frames (data->frames() - remove);
 409                                 ct += ContentTime::from_frames (remove, (*stream)->frame_rate ());
 410                         }
 411
 412                         if (ct < ContentTime()) {
 413                                 LOG_WARNING ("Crazy timestamp %1", to_string (ct));
 414                         }
 415
 416                         /* Give this data provided there is some, and its time is sane */
 417                         if (ct >= ContentTime() && data->frames() > 0) {
 418                                 audio->emit (*stream, data, ct);
 419                         }
 420                 }
 421
 422                 copy_packet.data += decode_result;
 423                 copy_packet.size -= decode_result;
 424         }
 425 }
 426
 427 bool
 428 FFmpegDecoder::decode_video_packet ()
 429 {
 430         DCPOMATIC_ASSERT (_video_stream);
 431
 432         int frame_finished;
 433         if (avcodec_decode_video2 (video_codec_context(), _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
 434                 return false;
 435         }
 436
 437         boost::mutex::scoped_lock lm (_filter_graphs_mutex);
 438
 439         shared_ptr<VideoFilterGraph> graph;
 440
 441         list<shared_ptr<VideoFilterGraph> >::iterator i = _filter_graphs.begin();
 442         while (i != _filter_graphs.end() && !(*i)->can_process (dcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
 443                 ++i;
 444         }
 445
 446         if (i == _filter_graphs.end ()) {
 447                 graph.reset (new VideoFilterGraph (dcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
 448                 graph->setup (_ffmpeg_content->filters ());
 449                 _filter_graphs.push_back (graph);
 450                 LOG_GENERAL (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format);
 451         } else {
 452                 graph = *i;
 453         }
 454
 455         list<pair<shared_ptr<Image>, int64_t> > images = graph->process (_frame);
 456
 457         for (list<pair<shared_ptr<Image>, int64_t> >::iterator i = images.begin(); i != images.end(); ++i) {
 458
 459                 shared_ptr<Image> image = i->first;
 460
 461                 if (i->second != AV_NOPTS_VALUE) {
 462                         double const pts = i->second * av_q2d (_format_context->streams[_video_stream.get()]->time_base) + _pts_offset.seconds ();
 463                         video->emit (
 464                                 shared_ptr<ImageProxy> (new RawImageProxy (image)),
 465                                 llrint (pts * _ffmpeg_content->active_video_frame_rate ())
 466                                 );
 467                 } else {
 468                         LOG_WARNING_NC ("Dropping frame without PTS");
 469                 }
 470         }
 471
 472         return true;
 473 }
 474
 475 void
 476 FFmpegDecoder::decode_subtitle_packet ()
 477 {
 478         int got_subtitle;
 479         AVSubtitle sub;
 480         if (avcodec_decode_subtitle2 (subtitle_codec_context(), &sub, &got_subtitle, &_packet) < 0 || !got_subtitle) {
 481                 return;
 482         }
 483
 484         /* Stop any current subtitle, either at the time it was supposed to stop, or now if now is sooner */
 485         if (_have_current_subtitle) {
 486                 if (_current_subtitle_to) {
 487                         subtitle->emit_stop (min(*_current_subtitle_to, subtitle_period(sub).from + _pts_offset));
 488                 } else {
 489                         subtitle->emit_stop (subtitle_period(sub).from + _pts_offset);
 490                 }
 491                 _have_current_subtitle = false;
 492         }
 493
 494         if (sub.num_rects <= 0) {
 495                 /* Nothing new in this subtitle */
 496                 return;
 497         }
 498
 499         /* Subtitle PTS (within the source, not taking into account any of the
 500            source that we may have chopped off for the DCP).
 501         */
 502         FFmpegSubtitlePeriod sub_period = subtitle_period (sub);
 503         ContentTime from;
 504         from = sub_period.from + _pts_offset;
 505         _have_current_subtitle = true;
 506         if (sub_period.to) {
 507                 _current_subtitle_to = *sub_period.to + _pts_offset;
 508         }
 509
 510         for (unsigned int i = 0; i < sub.num_rects; ++i) {
 511                 AVSubtitleRect const * rect = sub.rects[i];
 512
 513                 switch (rect->type) {
 514                 case SUBTITLE_NONE:
 515                         break;
 516                 case SUBTITLE_BITMAP:
 517                         decode_bitmap_subtitle (rect, from);
 518                         break;
 519                 case SUBTITLE_TEXT:
 520                         cout << "XXX: SUBTITLE_TEXT " << rect->text << "\n";
 521                         break;
 522                 case SUBTITLE_ASS:
 523                         decode_ass_subtitle (rect->ass, from);
 524                         break;
 525                 }
 526         }
 527
 528         avsubtitle_free (&sub);
 529 }
 530
 531 void
 532 FFmpegDecoder::decode_bitmap_subtitle (AVSubtitleRect const * rect, ContentTime from)
 533 {
 534         /* Note RGBA is expressed little-endian, so the first byte in the word is R, second
 535            G, third B, fourth A.
 536         */
 537         shared_ptr<Image> image (new Image (AV_PIX_FMT_RGBA, dcp::Size (rect->w, rect->h), true));
 538
 539 #ifdef DCPOMATIC_HAVE_AVSUBTITLERECT_PICT
 540         /* Start of the first line in the subtitle */
 541         uint8_t* sub_p = rect->pict.data[0];
 542         /* sub_p looks up into a BGRA palette which is here
 543            (i.e. first byte B, second G, third R, fourth A)
 544         */
 545         uint32_t const * palette = (uint32_t *) rect->pict.data[1];
 546 #else
 547         /* Start of the first line in the subtitle */
 548         uint8_t* sub_p = rect->data[0];
 549         /* sub_p looks up into a BGRA palette which is here
 550            (i.e. first byte B, second G, third R, fourth A)
 551         */
 552         uint32_t const * palette = (uint32_t *) rect->data[1];
 553 #endif
 554         /* And the stream has a map of those palette colours to colours
 555            chosen by the user; created a `mapped' palette from those settings.
 556         */
 557         map<RGBA, RGBA> colour_map = ffmpeg_content()->subtitle_stream()->colours ();
 558         vector<RGBA> mapped_palette (rect->nb_colors);
 559         for (int i = 0; i < rect->nb_colors; ++i) {
 560                 RGBA c ((palette[i] & 0xff0000) >> 16, (palette[i] & 0xff00) >> 8, palette[i] & 0xff, (palette[i] & 0xff000000) >> 24);
 561                 map<RGBA, RGBA>::const_iterator j = colour_map.find (c);
 562                 if (j != colour_map.end ()) {
 563                         mapped_palette[i] = j->second;
 564                 } else {
 565                         /* This colour was not found in the FFmpegSubtitleStream's colour map; probably because
 566                            it is from a project that was created before this stuff was added.  Just use the
 567                            colour straight from the original palette.
 568                         */
 569                         mapped_palette[i] = c;
 570                 }
 571         }
 572
 573         /* Start of the output data */
 574         uint32_t* out_p = (uint32_t *) image->data()[0];
 575
 576         for (int y = 0; y < rect->h; ++y) {
 577                 uint8_t* sub_line_p = sub_p;
 578                 uint32_t* out_line_p = out_p;
 579                 for (int x = 0; x < rect->w; ++x) {
 580                         RGBA const p = mapped_palette[*sub_line_p++];
 581                         /* XXX: this seems to be wrong to me (isn't the output image RGBA?) but it looks right on screen */
 582                         *out_line_p++ = (p.a << 24) | (p.r << 16) | (p.g << 8) | p.b;
 583                 }
 584 #ifdef DCPOMATIC_HAVE_AVSUBTITLERECT_PICT
 585                 sub_p += rect->pict.linesize[0];
 586 #else
 587                 sub_p += rect->linesize[0];
 588 #endif
 589                 out_p += image->stride()[0] / sizeof (uint32_t);
 590         }
 591
 592         int const target_width = subtitle_codec_context()->width;
 593         int const target_height = subtitle_codec_context()->height;
 594         dcpomatic::Rect<double> const scaled_rect (
 595                 static_cast<double> (rect->x) / target_width,
 596                 static_cast<double> (rect->y) / target_height,
 597                 static_cast<double> (rect->w) / target_width,
 598                 static_cast<double> (rect->h) / target_height
 599                 );
 600
 601         subtitle->emit_image_start (from, image, scaled_rect);
 602 }
 603
 604 void
 605 FFmpegDecoder::decode_ass_subtitle (string ass, ContentTime from)
 606 {
 607         /* We have no styles and no Format: line, so I'm assuming that FFmpeg
 608            produces a single format of Dialogue: lines...
 609         */
 610
 611         vector<string> bits;
 612         split (bits, ass, is_any_of (","));
 613         if (bits.size() < 10) {
 614                 return;
 615         }
 616
 617         sub::RawSubtitle base;
 618         list<sub::RawSubtitle> raw = sub::SSAReader::parse_line (base, bits[9]);
 619
 620         BOOST_FOREACH (sub::Subtitle const & i, sub::collect<list<sub::Subtitle> > (raw)) {
 621                 subtitle->emit_text_start (from, i);
 622         }
 623 }