src/lib/ffmpeg_decoder.cc

   1 /*
   2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/ffmpeg_decoder.cc
  21  *  @brief A decoder using FFmpeg to decode content.
  22  */
  23
  24 #include <stdexcept>
  25 #include <vector>
  26 #include <iomanip>
  27 #include <iostream>
  28 #include <stdint.h>
  29 #include <sndfile.h>
  30 extern "C" {
  31 #include <libavcodec/avcodec.h>
  32 #include <libavformat/avformat.h>
  33 }
  34 #include "film.h"
  35 #include "filter.h"
  36 #include "exceptions.h"
  37 #include "image.h"
  38 #include "util.h"
  39 #include "log.h"
  40 #include "ffmpeg_decoder.h"
  41 #include "filter_graph.h"
  42 #include "audio_buffers.h"
  43 #include "ffmpeg_content.h"
  44 #include "image_proxy.h"
  45
  46 #include "i18n.h"
  47
  48 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
  49 #define LOG_ERROR(...) film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_ERROR);
  50 #define LOG_WARNING(...) film->log()->log (__VA_ARGS__, Log::TYPE_WARNING);
  51
  52 using std::cout;
  53 using std::string;
  54 using std::vector;
  55 using std::list;
  56 using std::min;
  57 using std::pair;
  58 using boost::shared_ptr;
  59 using boost::optional;
  60 using boost::dynamic_pointer_cast;
  61 using libdcp::Size;
  62
  63 FFmpegDecoder::FFmpegDecoder (shared_ptr<const Film> f, shared_ptr<const FFmpegContent> c, bool video, bool audio)
  64         : Decoder (f)
  65         , VideoDecoder (f, c)
  66         , AudioDecoder (f, c)
  67         , SubtitleDecoder (f)
  68         , FFmpeg (c)
  69         , _subtitle_codec_context (0)
  70         , _subtitle_codec (0)
  71         , _decode_video (video)
  72         , _decode_audio (audio)
  73         , _pts_offset (0)
  74         , _just_sought (false)
  75 {
  76         setup_subtitle ();
  77
  78         /* Audio and video frame PTS values may not start with 0.  We want
  79            to fiddle them so that:
  80
  81            1.  One of them starts at time 0.
  82            2.  The first video PTS value ends up on a frame boundary.
  83
  84            Then we remove big initial gaps in PTS and we allow our
  85            insertion of black frames to work.
  86
  87            We will do:
  88              audio_pts_to_use = audio_pts_from_ffmpeg + pts_offset;
  89              video_pts_to_use = video_pts_from_ffmpeg + pts_offset;
  90         */
  91
  92         bool const have_video = video && c->first_video();
  93         bool const have_audio = audio && c->audio_stream() && c->audio_stream()->first_audio;
  94
  95         /* First, make one of them start at 0 */
  96
  97         if (have_audio && have_video) {
  98                 _pts_offset = - min (c->first_video().get(), c->audio_stream()->first_audio.get());
  99         } else if (have_video) {
 100                 _pts_offset = - c->first_video().get();
 101         } else if (have_audio) {
 102                 _pts_offset = - c->audio_stream()->first_audio.get();
 103         }
 104
 105         /* Now adjust both so that the video pts starts on a frame */
 106         if (have_video && have_audio) {
 107                 double first_video = c->first_video().get() + _pts_offset;
 108                 double const old_first_video = first_video;
 109
 110                 /* Round the first video up to a frame boundary */
 111                 if (fabs (rint (first_video * c->video_frame_rate()) - first_video * c->video_frame_rate()) > 1e-6) {
 112                         first_video = ceil (first_video * c->video_frame_rate()) / c->video_frame_rate ();
 113                 }
 114
 115                 _pts_offset += first_video - old_first_video;
 116         }
 117 }
 118
 119 FFmpegDecoder::~FFmpegDecoder ()
 120 {
 121         boost::mutex::scoped_lock lm (_mutex);
 122
 123         if (_subtitle_codec_context) {
 124                 avcodec_close (_subtitle_codec_context);
 125         }
 126 }
 127
 128 void
 129 FFmpegDecoder::flush ()
 130 {
 131         /* Get any remaining frames */
 132
 133         _packet.data = 0;
 134         _packet.size = 0;
 135
 136         /* XXX: should we reset _packet.data and size after each *_decode_* call? */
 137
 138         if (_decode_video) {
 139                 while (decode_video_packet ()) {}
 140         }
 141
 142         if (_ffmpeg_content->audio_stream() && _decode_audio) {
 143                 decode_audio_packet ();
 144         }
 145
 146         /* Stop us being asked for any more data */
 147         _video_position = _ffmpeg_content->video_length_after_3d_combine ();
 148         _audio_position = _ffmpeg_content->audio_length ();
 149 }
 150
 151 void
 152 FFmpegDecoder::pass ()
 153 {
 154         int r = av_read_frame (_format_context, &_packet);
 155
 156         if (r < 0) {
 157                 if (r != AVERROR_EOF) {
 158                         /* Maybe we should fail here, but for now we'll just finish off instead */
 159                         char buf[256];
 160                         av_strerror (r, buf, sizeof(buf));
 161                         shared_ptr<const Film> film = _film.lock ();
 162                         assert (film);
 163                         LOG_ERROR (N_("error on av_read_frame (%1) (%2)"), buf, r);
 164                 }
 165
 166                 flush ();
 167                 return;
 168         }
 169
 170         shared_ptr<const Film> film = _film.lock ();
 171         assert (film);
 172
 173         int const si = _packet.stream_index;
 174
 175         if (si == _video_stream && _decode_video) {
 176                 decode_video_packet ();
 177         } else if (_ffmpeg_content->audio_stream() && _ffmpeg_content->audio_stream()->uses_index (_format_context, si) && _decode_audio) {
 178                 decode_audio_packet ();
 179         } else if (_ffmpeg_content->subtitle_stream() && _ffmpeg_content->subtitle_stream()->uses_index (_format_context, si) && film->with_subtitles ()) {
 180                 decode_subtitle_packet ();
 181         }
 182
 183         av_free_packet (&_packet);
 184 }
 185
 186 /** @param data pointer to array of pointers to buffers.
 187  *  Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
 188  */
 189 shared_ptr<AudioBuffers>
 190 FFmpegDecoder::deinterleave_audio (uint8_t** data, int size)
 191 {
 192         assert (_ffmpeg_content->audio_channels());
 193         assert (bytes_per_audio_sample());
 194
 195         /* Deinterleave and convert to float */
 196
 197         assert ((size % (bytes_per_audio_sample() * _ffmpeg_content->audio_channels())) == 0);
 198
 199         int const total_samples = size / bytes_per_audio_sample();
 200         int const frames = total_samples / _ffmpeg_content->audio_channels();
 201         shared_ptr<AudioBuffers> audio (new AudioBuffers (_ffmpeg_content->audio_channels(), frames));
 202
 203         switch (audio_sample_format()) {
 204         case AV_SAMPLE_FMT_U8:
 205         {
 206                 uint8_t* p = reinterpret_cast<uint8_t *> (data[0]);
 207                 int sample = 0;
 208                 int channel = 0;
 209                 for (int i = 0; i < total_samples; ++i) {
 210                         audio->data(channel)[sample] = float(*p++) / (1 << 23);
 211
 212                         ++channel;
 213                         if (channel == _ffmpeg_content->audio_channels()) {
 214                                 channel = 0;
 215                                 ++sample;
 216                         }
 217                 }
 218         }
 219         break;
 220
 221         case AV_SAMPLE_FMT_S16:
 222         {
 223                 int16_t* p = reinterpret_cast<int16_t *> (data[0]);
 224                 int sample = 0;
 225                 int channel = 0;
 226                 for (int i = 0; i < total_samples; ++i) {
 227                         audio->data(channel)[sample] = float(*p++) / (1 << 15);
 228
 229                         ++channel;
 230                         if (channel == _ffmpeg_content->audio_channels()) {
 231                                 channel = 0;
 232                                 ++sample;
 233                         }
 234                 }
 235         }
 236         break;
 237
 238         case AV_SAMPLE_FMT_S16P:
 239         {
 240                 int16_t** p = reinterpret_cast<int16_t **> (data);
 241                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 242                         for (int j = 0; j < frames; ++j) {
 243                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
 244                         }
 245                 }
 246         }
 247         break;
 248
 249         case AV_SAMPLE_FMT_S32:
 250         {
 251                 int32_t* p = reinterpret_cast<int32_t *> (data[0]);
 252                 int sample = 0;
 253                 int channel = 0;
 254                 for (int i = 0; i < total_samples; ++i) {
 255                         audio->data(channel)[sample] = static_cast<float>(*p++) / (1 << 31);
 256
 257                         ++channel;
 258                         if (channel == _ffmpeg_content->audio_channels()) {
 259                                 channel = 0;
 260                                 ++sample;
 261                         }
 262                 }
 263         }
 264         break;
 265
 266         case AV_SAMPLE_FMT_FLT:
 267         {
 268                 float* p = reinterpret_cast<float*> (data[0]);
 269                 int sample = 0;
 270                 int channel = 0;
 271                 for (int i = 0; i < total_samples; ++i) {
 272                         audio->data(channel)[sample] = *p++;
 273
 274                         ++channel;
 275                         if (channel == _ffmpeg_content->audio_channels()) {
 276                                 channel = 0;
 277                                 ++sample;
 278                         }
 279                 }
 280         }
 281         break;
 282
 283         case AV_SAMPLE_FMT_FLTP:
 284         {
 285                 float** p = reinterpret_cast<float**> (data);
 286                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 287                         memcpy (audio->data(i), p[i], frames * sizeof(float));
 288                 }
 289         }
 290         break;
 291
 292         default:
 293                 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format())));
 294         }
 295
 296         return audio;
 297 }
 298
 299 AVSampleFormat
 300 FFmpegDecoder::audio_sample_format () const
 301 {
 302         if (!_ffmpeg_content->audio_stream()) {
 303                 return (AVSampleFormat) 0;
 304         }
 305
 306         return audio_codec_context()->sample_fmt;
 307 }
 308
 309 int
 310 FFmpegDecoder::bytes_per_audio_sample () const
 311 {
 312         return av_get_bytes_per_sample (audio_sample_format ());
 313 }
 314
 315 void
 316 FFmpegDecoder::seek (VideoContent::Frame frame, bool accurate)
 317 {
 318         double const time_base = av_q2d (_format_context->streams[_video_stream]->time_base);
 319
 320         /* If we are doing an accurate seek, our initial shot will be 5 frames (5 being
 321            a number plucked from the air) earlier than we want to end up.  The loop below
 322            will hopefully then step through to where we want to be.
 323         */
 324         int initial = frame;
 325
 326         if (accurate) {
 327                 initial -= 5;
 328         }
 329
 330         if (initial < 0) {
 331                 initial = 0;
 332         }
 333
 334         /* Initial seek time in the stream's timebase */
 335         int64_t const initial_vt = ((initial / _ffmpeg_content->original_video_frame_rate()) - _pts_offset) / time_base;
 336
 337         av_seek_frame (_format_context, _video_stream, initial_vt, AVSEEK_FLAG_BACKWARD);
 338
 339         avcodec_flush_buffers (video_codec_context());
 340         if (_subtitle_codec_context) {
 341                 avcodec_flush_buffers (_subtitle_codec_context);
 342         }
 343
 344         /* This !accurate is piling hack upon hack; setting _just_sought to true
 345            even with accurate == true defeats our attempt to align the start
 346            of the video and audio.  Here we disable that defeat when accurate == true
 347            i.e. when we are making a DCP rather than just previewing one.
 348            Ewww.  This should be gone in 2.0.
 349         */
 350         if (!accurate) {
 351                 _just_sought = true;
 352         }
 353
 354         _video_position = frame;
 355
 356         if (frame == 0 || !accurate) {
 357                 /* We're already there, or we're as close as we need to be */
 358                 return;
 359         }
 360
 361         while (true) {
 362                 int r = av_read_frame (_format_context, &_packet);
 363                 if (r < 0) {
 364                         return;
 365                 }
 366
 367                 if (_packet.stream_index != _video_stream) {
 368                         av_free_packet (&_packet);
 369                         continue;
 370                 }
 371
 372                 int finished = 0;
 373                 r = avcodec_decode_video2 (video_codec_context(), _frame, &finished, &_packet);
 374                 if (r >= 0 && finished) {
 375                         _video_position = rint (
 376                                 (av_frame_get_best_effort_timestamp (_frame) * time_base + _pts_offset) * _ffmpeg_content->original_video_frame_rate()
 377                                 );
 378
 379                         if (_video_position >= (frame - 1)) {
 380                                 av_free_packet (&_packet);
 381                                 break;
 382                         }
 383                 }
 384
 385                 av_free_packet (&_packet);
 386         }
 387
 388         /* _video_position should be the next thing to be emitted, which will the one after the thing
 389            we just saw.
 390         */
 391         _video_position++;
 392 }
 393
 394 void
 395 FFmpegDecoder::decode_audio_packet ()
 396 {
 397         /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
 398            several times.
 399         */
 400
 401         AVPacket copy_packet = _packet;
 402
 403         while (copy_packet.size > 0) {
 404
 405                 int frame_finished;
 406                 int const decode_result = avcodec_decode_audio4 (audio_codec_context(), _frame, &frame_finished, &copy_packet);
 407                 if (decode_result < 0) {
 408                         shared_ptr<const Film> film = _film.lock ();
 409                         assert (film);
 410                         LOG_ERROR ("avcodec_decode_audio4 failed (%1)", decode_result);
 411                         return;
 412                 }
 413
 414                 if (frame_finished) {
 415
 416                         if (_audio_position == 0) {
 417                                 /* Where we are in the source, in seconds */
 418                                 double const pts = av_q2d (_format_context->streams[copy_packet.stream_index]->time_base)
 419                                         * av_frame_get_best_effort_timestamp(_frame) + _pts_offset;
 420
 421                                 if (pts > 0) {
 422                                         /* Emit some silence */
 423                                         int64_t frames = pts * _ffmpeg_content->content_audio_frame_rate ();
 424                                         while (frames > 0) {
 425                                                 int64_t const this_time = min (frames, (int64_t) _ffmpeg_content->content_audio_frame_rate() / 2);
 426
 427                                                 shared_ptr<AudioBuffers> silence (
 428                                                         new AudioBuffers (_ffmpeg_content->audio_channels(), this_time)
 429                                                         );
 430
 431                                                 silence->make_silent ();
 432                                                 audio (silence, _audio_position);
 433                                                 frames -= this_time;
 434                                         }
 435                                 }
 436                         }
 437
 438                         int const data_size = av_samples_get_buffer_size (
 439                                 0, audio_codec_context()->channels, _frame->nb_samples, audio_sample_format (), 1
 440                                 );
 441
 442                         audio (deinterleave_audio (_frame->data, data_size), _audio_position);
 443                 }
 444
 445                 copy_packet.data += decode_result;
 446                 copy_packet.size -= decode_result;
 447         }
 448 }
 449
 450 bool
 451 FFmpegDecoder::decode_video_packet ()
 452 {
 453         int frame_finished;
 454         if (avcodec_decode_video2 (video_codec_context(), _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
 455                 return false;
 456         }
 457
 458         boost::mutex::scoped_lock lm (_filter_graphs_mutex);
 459
 460         shared_ptr<FilterGraph> graph;
 461
 462         list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
 463         while (i != _filter_graphs.end() && !(*i)->can_process (libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
 464                 ++i;
 465         }
 466
 467         if (i == _filter_graphs.end ()) {
 468                 shared_ptr<const Film> film = _film.lock ();
 469                 assert (film);
 470
 471                 graph.reset (new FilterGraph (_ffmpeg_content, libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
 472                 _filter_graphs.push_back (graph);
 473
 474                 LOG_GENERAL (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format);
 475         } else {
 476                 graph = *i;
 477         }
 478
 479         list<pair<shared_ptr<Image>, int64_t> > images = graph->process (_frame);
 480
 481         shared_ptr<const Film> film = _film.lock ();
 482         assert (film);
 483
 484         for (list<pair<shared_ptr<Image>, int64_t> >::iterator i = images.begin(); i != images.end(); ++i) {
 485
 486                 shared_ptr<Image> image = i->first;
 487
 488                 if (i->second != AV_NOPTS_VALUE) {
 489
 490                         double const pts = i->second * av_q2d (_format_context->streams[_video_stream]->time_base) + _pts_offset;
 491
 492                         if (_just_sought) {
 493                                 /* We just did a seek, so disable any attempts to correct for where we
 494                                    are / should be.
 495                                 */
 496                                 _video_position = rint (pts * _ffmpeg_content->original_video_frame_rate ());
 497                                 _just_sought = false;
 498                         }
 499
 500                         double const next = _video_position / _ffmpeg_content->original_video_frame_rate();
 501                         double const one_frame = 1 / _ffmpeg_content->original_video_frame_rate ();
 502                         double delta = pts - next;
 503
 504                         while (delta > one_frame) {
 505                                 /* This PTS is more than one frame forward in time of where we think we should be; emit
 506                                    a black frame.
 507                                 */
 508
 509                                 /* XXX: I think this should be a copy of the last frame... */
 510                                 boost::shared_ptr<Image> black (
 511                                         new Image (
 512                                                 static_cast<AVPixelFormat> (_frame->format),
 513                                                 libdcp::Size (video_codec_context()->width, video_codec_context()->height),
 514                                                 true
 515                                                 )
 516                                         );
 517
 518                                 shared_ptr<const Film> film = _film.lock ();
 519                                 assert (film);
 520
 521                                 black->make_black ();
 522                                 video (shared_ptr<ImageProxy> (new RawImageProxy (image, film->log())), false, _video_position);
 523                                 delta -= one_frame;
 524                         }
 525
 526                         if (delta > -one_frame) {
 527                                 /* This PTS is within a frame of being right; emit this (otherwise it will be dropped) */
 528                                 video (shared_ptr<ImageProxy> (new RawImageProxy (image, film->log())), false, _video_position);
 529                         }
 530
 531                 } else {
 532                         LOG_WARNING ("Dropping frame without PTS");
 533                 }
 534         }
 535
 536         return true;
 537 }
 538
 539
 540 void
 541 FFmpegDecoder::setup_subtitle ()
 542 {
 543         boost::mutex::scoped_lock lm (_mutex);
 544
 545         if (!_ffmpeg_content->subtitle_stream()) {
 546                 return;
 547         }
 548
 549         _subtitle_codec_context = _ffmpeg_content->subtitle_stream()->stream(_format_context)->codec;
 550         if (_subtitle_codec_context == 0) {
 551                 throw DecodeError (N_("could not find subtitle stream"));
 552         }
 553
 554         _subtitle_codec = avcodec_find_decoder (_subtitle_codec_context->codec_id);
 555
 556         if (_subtitle_codec == 0) {
 557                 throw DecodeError (N_("could not find subtitle decoder"));
 558         }
 559
 560         if (avcodec_open2 (_subtitle_codec_context, _subtitle_codec, 0) < 0) {
 561                 throw DecodeError (N_("could not open subtitle decoder"));
 562         }
 563 }
 564
 565 bool
 566 FFmpegDecoder::done () const
 567 {
 568         bool const vd = !_decode_video || (_video_position >= _ffmpeg_content->video_length());
 569         bool const ad = !_decode_audio || !_ffmpeg_content->audio_stream() || (_audio_position >= _ffmpeg_content->audio_length());
 570         return vd && ad;
 571 }
 572
 573 void
 574 FFmpegDecoder::decode_subtitle_packet ()
 575 {
 576         int got_subtitle;
 577         AVSubtitle sub;
 578         if (avcodec_decode_subtitle2 (_subtitle_codec_context, &sub, &got_subtitle, &_packet) < 0 || !got_subtitle) {
 579                 return;
 580         }
 581
 582         /* Sometimes we get an empty AVSubtitle, which is used by some codecs to
 583            indicate that the previous subtitle should stop.
 584         */
 585         if (sub.num_rects <= 0) {
 586                 subtitle (shared_ptr<Image> (), dcpomatic::Rect<double> (), 0, 0);
 587                 return;
 588         } else if (sub.num_rects > 1) {
 589                 throw DecodeError (_("multi-part subtitles not yet supported"));
 590         }
 591
 592         /* Subtitle PTS in seconds (within the source, not taking into account any of the
 593            source that we may have chopped off for the DCP)
 594         */
 595         double const packet_time = (static_cast<double> (sub.pts ) / AV_TIME_BASE) + _pts_offset;
 596
 597         /* hence start time for this sub */
 598         Time const from = (packet_time + (double (sub.start_display_time) / 1e3)) * TIME_HZ;
 599         Time const to = (packet_time + (double (sub.end_display_time) / 1e3)) * TIME_HZ;
 600
 601         AVSubtitleRect const * rect = sub.rects[0];
 602
 603         if (rect->type != SUBTITLE_BITMAP) {
 604                 throw DecodeError (_("non-bitmap subtitles not yet supported"));
 605         }
 606
 607         /* Note RGBA is expressed little-endian, so the first byte in the word is R, second
 608            G, third B, fourth A.
 609         */
 610         shared_ptr<Image> image (new Image (PIX_FMT_RGBA, libdcp::Size (rect->w, rect->h), true));
 611
 612         /* Start of the first line in the subtitle */
 613         uint8_t* sub_p = rect->pict.data[0];
 614         /* sub_p looks up into a BGRA palette which is here
 615            (i.e. first byte B, second G, third R, fourth A)
 616         */
 617         uint32_t const * palette = (uint32_t *) rect->pict.data[1];
 618         /* Start of the output data */
 619         uint32_t* out_p = (uint32_t *) image->data()[0];
 620
 621         for (int y = 0; y < rect->h; ++y) {
 622                 uint8_t* sub_line_p = sub_p;
 623                 uint32_t* out_line_p = out_p;
 624                 for (int x = 0; x < rect->w; ++x) {
 625                         uint32_t const p = palette[*sub_line_p++];
 626                         *out_line_p++ = ((p & 0xff) << 16) | (p & 0xff00) | ((p & 0xff0000) >> 16) | (p & 0xff000000);
 627                 }
 628                 sub_p += rect->pict.linesize[0];
 629                 out_p += image->stride()[0] / sizeof (uint32_t);
 630         }
 631
 632         libdcp::Size const vs = _ffmpeg_content->video_size ();
 633
 634         subtitle (
 635                 image,
 636                 dcpomatic::Rect<double> (
 637                         static_cast<double> (rect->x) / vs.width,
 638                         static_cast<double> (rect->y) / vs.height,
 639                         static_cast<double> (rect->w) / vs.width,
 640                         static_cast<double> (rect->h) / vs.height
 641                         ),
 642                 from,
 643                 to
 644                 );
 645
 646
 647         avsubtitle_free (&sub);
 648 }