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