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