src/lib/ffmpeg_decoder.cc

   1 /*
   2     Copyright (C) 2012 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 <sstream>
  27 #include <iomanip>
  28 #include <iostream>
  29 #include <stdint.h>
  30 #include <boost/lexical_cast.hpp>
  31 #include <sndfile.h>
  32 extern "C" {
  33 #include <libavcodec/avcodec.h>
  34 #include <libavformat/avformat.h>
  35 }
  36 #include "film.h"
  37 #include "filter.h"
  38 #include "exceptions.h"
  39 #include "image.h"
  40 #include "util.h"
  41 #include "log.h"
  42 #include "ffmpeg_decoder.h"
  43 #include "filter_graph.h"
  44 #include "audio_buffers.h"
  45 #include "ffmpeg_content.h"
  46
  47 #include "i18n.h"
  48
  49 using std::cout;
  50 using std::string;
  51 using std::vector;
  52 using std::stringstream;
  53 using std::list;
  54 using std::min;
  55 using std::pair;
  56 using boost::shared_ptr;
  57 using boost::optional;
  58 using boost::dynamic_pointer_cast;
  59 using libdcp::Size;
  60
  61 FFmpegDecoder::FFmpegDecoder (shared_ptr<const Film> f, shared_ptr<const FFmpegContent> c, bool video, bool audio)
  62         : Decoder (f)
  63         , VideoDecoder (f, c)
  64         , AudioDecoder (f, c)
  65         , SubtitleDecoder (f)
  66         , FFmpeg (c)
  67         , _subtitle_codec_context (0)
  68         , _subtitle_codec (0)
  69         , _decode_video (video)
  70         , _decode_audio (audio)
  71         , _video_pts_offset (0)
  72         , _audio_pts_offset (0)
  73         , _just_sought (false)
  74 {
  75         setup_subtitle ();
  76
  77         /* Audio and video frame PTS values may not start with 0.  We want
  78            to fiddle them so that:
  79
  80            1.  One of them starts at time 0.
  81            2.  The first video PTS value ends up on a frame boundary.
  82
  83            Then we remove big initial gaps in PTS and we allow our
  84            insertion of black frames to work.
  85
  86            We will do:
  87              audio_pts_to_use = audio_pts_from_ffmpeg + audio_pts_offset;
  88              video_pts_to_use = video_pts_from_ffmpeg + video_pts_offset;
  89         */
  90
  91         bool const have_video = video && c->first_video();
  92         bool const have_audio = audio && c->audio_stream() && c->audio_stream()->first_audio;
  93
  94         /* First, make one of them start at 0 */
  95
  96         if (have_audio && have_video) {
  97                 _video_pts_offset = _audio_pts_offset = - min (c->first_video().get(), c->audio_stream()->first_audio.get());
  98         } else if (have_video) {
  99                 _video_pts_offset = - c->first_video().get();
 100         } else if (have_audio) {
 101                 _audio_pts_offset = - c->audio_stream()->first_audio.get();
 102         }
 103
 104         /* Now adjust both so that the video pts starts on a frame */
 105         if (have_video && have_audio) {
 106                 double first_video = c->first_video().get() + _video_pts_offset;
 107                 double const old_first_video = first_video;
 108
 109                 /* Round the first video up to a frame boundary */
 110                 if (fabs (rint (first_video * c->video_frame_rate()) - first_video * c->video_frame_rate()) > 1e-6) {
 111                         first_video = ceil (first_video * c->video_frame_rate()) / c->video_frame_rate ();
 112                 }
 113
 114                 _video_pts_offset += first_video - old_first_video;
 115                 _audio_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 ();
 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                         film->log()->log (String::compose (N_("error on av_read_frame (%1) (%2)"), buf, r));
 164                 }
 165
 166                 flush ();
 167                 return;
 168         }
 169
 170         avcodec_get_frame_defaults (_frame);
 171
 172         shared_ptr<const Film> film = _film.lock ();
 173         assert (film);
 174
 175         if (_packet.stream_index == _video_stream && _decode_video) {
 176                 decode_video_packet ();
 177         } else if (_ffmpeg_content->audio_stream() && _packet.stream_index == _ffmpeg_content->audio_stream()->id && _decode_audio) {
 178                 decode_audio_packet ();
 179         } else if (_ffmpeg_content->subtitle_stream() && _packet.stream_index == _ffmpeg_content->subtitle_stream()->id && 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_S16:
 205         {
 206                 int16_t* p = reinterpret_cast<int16_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 << 15);
 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_S16P:
 222         {
 223                 int16_t** p = reinterpret_cast<int16_t **> (data);
 224                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 225                         for (int j = 0; j < frames; ++j) {
 226                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
 227                         }
 228                 }
 229         }
 230         break;
 231
 232         case AV_SAMPLE_FMT_S32:
 233         {
 234                 int32_t* p = reinterpret_cast<int32_t *> (data[0]);
 235                 int sample = 0;
 236                 int channel = 0;
 237                 for (int i = 0; i < total_samples; ++i) {
 238                         audio->data(channel)[sample] = static_cast<float>(*p++) / (1 << 31);
 239
 240                         ++channel;
 241                         if (channel == _ffmpeg_content->audio_channels()) {
 242                                 channel = 0;
 243                                 ++sample;
 244                         }
 245                 }
 246         }
 247         break;
 248
 249         case AV_SAMPLE_FMT_FLT:
 250         {
 251                 float* p = reinterpret_cast<float*> (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 == _ffmpeg_content->audio_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**> (data);
 269                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 270                         memcpy (audio->data(i), p[i], frames * sizeof(float));
 271                 }
 272         }
 273         break;
 274
 275         default:
 276                 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format())));
 277         }
 278
 279         return audio;
 280 }
 281
 282 AVSampleFormat
 283 FFmpegDecoder::audio_sample_format () const
 284 {
 285         if (!_ffmpeg_content->audio_stream()) {
 286                 return (AVSampleFormat) 0;
 287         }
 288
 289         return audio_codec_context()->sample_fmt;
 290 }
 291
 292 int
 293 FFmpegDecoder::bytes_per_audio_sample () const
 294 {
 295         return av_get_bytes_per_sample (audio_sample_format ());
 296 }
 297
 298 void
 299 FFmpegDecoder::seek (VideoContent::Frame frame, bool accurate)
 300 {
 301         double const time_base = av_q2d (_format_context->streams[_video_stream]->time_base);
 302
 303         /* If we are doing an accurate seek, our initial shot will be 5 frames (5 being
 304            a number plucked from the air) earlier than we want to end up.  The loop below
 305            will hopefully then step through to where we want to be.
 306         */
 307         int initial = frame;
 308
 309         if (accurate) {
 310                 initial -= 5;
 311         }
 312
 313         if (initial < 0) {
 314                 initial = 0;
 315         }
 316
 317         /* Initial seek time in the stream's timebase */
 318         int64_t const initial_vt = ((initial / _ffmpeg_content->video_frame_rate()) - _video_pts_offset) / time_base;
 319
 320         av_seek_frame (_format_context, _video_stream, initial_vt, AVSEEK_FLAG_BACKWARD);
 321
 322         avcodec_flush_buffers (video_codec_context());
 323         if (_subtitle_codec_context) {
 324                 avcodec_flush_buffers (_subtitle_codec_context);
 325         }
 326
 327         _just_sought = true;
 328         _video_position = frame;
 329
 330         if (frame == 0 || !accurate) {
 331                 /* We're already there, or we're as close as we need to be */
 332                 return;
 333         }
 334
 335         while (1) {
 336                 int r = av_read_frame (_format_context, &_packet);
 337                 if (r < 0) {
 338                         return;
 339                 }
 340
 341                 if (_packet.stream_index != _video_stream) {
 342                         av_free_packet (&_packet);
 343                         continue;
 344                 }
 345
 346                 avcodec_get_frame_defaults (_frame);
 347
 348                 int finished = 0;
 349                 r = avcodec_decode_video2 (video_codec_context(), _frame, &finished, &_packet);
 350                 if (r >= 0 && finished) {
 351                         _video_position = rint (
 352                                 (av_frame_get_best_effort_timestamp (_frame) * time_base + _video_pts_offset) * _ffmpeg_content->video_frame_rate()
 353                                 );
 354
 355                         if (_video_position >= (frame - 1)) {
 356                                 av_free_packet (&_packet);
 357                                 break;
 358                         }
 359                 }
 360
 361                 av_free_packet (&_packet);
 362         }
 363 }
 364
 365 void
 366 FFmpegDecoder::decode_audio_packet ()
 367 {
 368         /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
 369            several times.
 370         */
 371
 372         AVPacket copy_packet = _packet;
 373
 374         while (copy_packet.size > 0) {
 375
 376                 int frame_finished;
 377                 int const decode_result = avcodec_decode_audio4 (audio_codec_context(), _frame, &frame_finished, &copy_packet);
 378                 if (decode_result < 0) {
 379                         shared_ptr<const Film> film = _film.lock ();
 380                         assert (film);
 381                         film->log()->log (String::compose ("avcodec_decode_audio4 failed (%1)", decode_result));
 382                         return;
 383                 }
 384
 385                 if (frame_finished) {
 386
 387                         if (_audio_position == 0) {
 388                                 /* Where we are in the source, in seconds */
 389                                 double const pts = av_q2d (_format_context->streams[copy_packet.stream_index]->time_base)
 390                                         * av_frame_get_best_effort_timestamp(_frame) + _audio_pts_offset;
 391
 392                                 if (pts > 0) {
 393                                         /* Emit some silence */
 394                                         shared_ptr<AudioBuffers> silence (
 395                                                 new AudioBuffers (
 396                                                         _ffmpeg_content->audio_channels(),
 397                                                         pts * _ffmpeg_content->content_audio_frame_rate()
 398                                                         )
 399                                                 );
 400
 401                                         silence->make_silent ();
 402                                         audio (silence, _audio_position);
 403                                 }
 404                         }
 405
 406                         int const data_size = av_samples_get_buffer_size (
 407                                 0, audio_codec_context()->channels, _frame->nb_samples, audio_sample_format (), 1
 408                                 );
 409
 410                         audio (deinterleave_audio (_frame->data, data_size), _audio_position);
 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         int frame_finished;
 422         if (avcodec_decode_video2 (video_codec_context(), _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
 423                 return false;
 424         }
 425
 426         boost::mutex::scoped_lock lm (_filter_graphs_mutex);
 427
 428         shared_ptr<FilterGraph> graph;
 429
 430         list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
 431         while (i != _filter_graphs.end() && !(*i)->can_process (libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
 432                 ++i;
 433         }
 434
 435         if (i == _filter_graphs.end ()) {
 436                 shared_ptr<const Film> film = _film.lock ();
 437                 assert (film);
 438
 439                 graph.reset (new FilterGraph (_ffmpeg_content, libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
 440                 _filter_graphs.push_back (graph);
 441
 442                 film->log()->log (String::compose (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format));
 443         } else {
 444                 graph = *i;
 445         }
 446
 447         list<pair<shared_ptr<Image>, int64_t> > images = graph->process (_frame);
 448
 449         string post_process = Filter::ffmpeg_strings (_ffmpeg_content->filters()).second;
 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                 if (!post_process.empty ()) {
 455                         image = image->post_process (post_process, true);
 456                 }
 457
 458                 if (i->second != AV_NOPTS_VALUE) {
 459
 460                         double const pts = i->second * av_q2d (_format_context->streams[_video_stream]->time_base) + _video_pts_offset;
 461
 462                         if (_just_sought) {
 463                                 /* We just did a seek, so disable any attempts to correct for where we
 464                                    are / should be.
 465                                 */
 466                                 _video_position = rint (pts * _ffmpeg_content->video_frame_rate ());
 467                                 _just_sought = false;
 468                         }
 469
 470                         double const next = _video_position / _ffmpeg_content->video_frame_rate();
 471                         double const one_frame = 1 / _ffmpeg_content->video_frame_rate ();
 472                         double delta = pts - next;
 473
 474                         while (delta > one_frame) {
 475                                 /* This PTS is more than one frame forward in time of where we think we should be; emit
 476                                    a black frame.
 477                                 */
 478
 479                                 /* XXX: I think this should be a copy of the last frame... */
 480                                 boost::shared_ptr<Image> black (
 481                                         new Image (
 482                                                 static_cast<AVPixelFormat> (_frame->format),
 483                                                 libdcp::Size (video_codec_context()->width, video_codec_context()->height),
 484                                                 true
 485                                                 )
 486                                         );
 487
 488                                 black->make_black ();
 489                                 video (image, false, _video_position);
 490                                 delta -= one_frame;
 491                         }
 492
 493                         if (delta > -one_frame) {
 494                                 /* This PTS is within a frame of being right; emit this (otherwise it will be dropped) */
 495                                 video (image, false, _video_position);
 496                         }
 497
 498                 } else {
 499                         shared_ptr<const Film> film = _film.lock ();
 500                         assert (film);
 501                         film->log()->log ("Dropping frame without PTS");
 502                 }
 503         }
 504
 505         return true;
 506 }
 507
 508
 509 void
 510 FFmpegDecoder::setup_subtitle ()
 511 {
 512         boost::mutex::scoped_lock lm (_mutex);
 513
 514         if (!_ffmpeg_content->subtitle_stream() || _ffmpeg_content->subtitle_stream()->id >= int (_format_context->nb_streams)) {
 515                 return;
 516         }
 517
 518         _subtitle_codec_context = _format_context->streams[_ffmpeg_content->subtitle_stream()->id]->codec;
 519         _subtitle_codec = avcodec_find_decoder (_subtitle_codec_context->codec_id);
 520
 521         if (_subtitle_codec == 0) {
 522                 throw DecodeError (_("could not find subtitle decoder"));
 523         }
 524
 525         if (avcodec_open2 (_subtitle_codec_context, _subtitle_codec, 0) < 0) {
 526                 throw DecodeError (N_("could not open subtitle decoder"));
 527         }
 528 }
 529
 530 bool
 531 FFmpegDecoder::done () const
 532 {
 533         bool const vd = !_decode_video || (_video_position >= _ffmpeg_content->video_length());
 534         bool const ad = !_decode_audio || !_ffmpeg_content->audio_stream() || (_audio_position >= _ffmpeg_content->audio_length());
 535         return vd && ad;
 536 }
 537
 538 void
 539 FFmpegDecoder::decode_subtitle_packet ()
 540 {
 541         int got_subtitle;
 542         AVSubtitle sub;
 543         if (avcodec_decode_subtitle2 (_subtitle_codec_context, &sub, &got_subtitle, &_packet) < 0 || !got_subtitle) {
 544                 return;
 545         }
 546
 547         /* Sometimes we get an empty AVSubtitle, which is used by some codecs to
 548            indicate that the previous subtitle should stop.
 549         */
 550         if (sub.num_rects <= 0) {
 551                 subtitle (shared_ptr<Image> (), dcpomatic::Rect<double> (), 0, 0);
 552                 return;
 553         } else if (sub.num_rects > 1) {
 554                 throw DecodeError (_("multi-part subtitles not yet supported"));
 555         }
 556
 557         /* Subtitle PTS in seconds (within the source, not taking into account any of the
 558            source that we may have chopped off for the DCP)
 559         */
 560         double const packet_time = static_cast<double> (sub.pts) / AV_TIME_BASE;
 561
 562         /* hence start time for this sub */
 563         Time const from = (packet_time + (double (sub.start_display_time) / 1e3)) * TIME_HZ;
 564         Time const to = (packet_time + (double (sub.end_display_time) / 1e3)) * TIME_HZ;
 565
 566         AVSubtitleRect const * rect = sub.rects[0];
 567
 568         if (rect->type != SUBTITLE_BITMAP) {
 569                 throw DecodeError (_("non-bitmap subtitles not yet supported"));
 570         }
 571
 572         shared_ptr<Image> image (new Image (PIX_FMT_RGBA, libdcp::Size (rect->w, rect->h), true));
 573
 574         /* Start of the first line in the subtitle */
 575         uint8_t* sub_p = rect->pict.data[0];
 576         /* sub_p looks up into a RGB palette which is here */
 577         uint32_t const * palette = (uint32_t *) rect->pict.data[1];
 578         /* Start of the output data */
 579         uint32_t* out_p = (uint32_t *) image->data()[0];
 580
 581         for (int y = 0; y < rect->h; ++y) {
 582                 uint8_t* sub_line_p = sub_p;
 583                 uint32_t* out_line_p = out_p;
 584                 for (int x = 0; x < rect->w; ++x) {
 585                         *out_line_p++ = palette[*sub_line_p++];
 586                 }
 587                 sub_p += rect->pict.linesize[0];
 588                 out_p += image->stride()[0] / sizeof (uint32_t);
 589         }
 590
 591         libdcp::Size const vs = _ffmpeg_content->video_size ();
 592
 593         subtitle (
 594                 image,
 595                 dcpomatic::Rect<double> (
 596                         static_cast<double> (rect->x) / vs.width,
 597                         static_cast<double> (rect->y) / vs.height,
 598                         static_cast<double> (rect->w) / vs.width,
 599                         static_cast<double> (rect->h) / vs.height
 600                         ),
 601                 from,
 602                 to
 603                 );
 604
 605
 606         avsubtitle_free (&sub);
 607 }