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