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