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
  46 #include "i18n.h"
  47
  48 using std::cout;
  49 using std::string;
  50 using std::vector;
  51 using std::stringstream;
  52 using std::list;
  53 using std::min;
  54 using std::pair;
  55 using boost::shared_ptr;
  56 using boost::optional;
  57 using boost::dynamic_pointer_cast;
  58 using libdcp::Size;
  59
  60 FFmpegDecoder::FFmpegDecoder (shared_ptr<const Film> f, shared_ptr<const FFmpegContent> c, bool video, bool audio)
  61         : Decoder (f)
  62         , VideoDecoder (f)
  63         , AudioDecoder (f)
  64         , SubtitleDecoder (f)
  65         , FFmpeg (c)
  66         , _subtitle_codec_context (0)
  67         , _subtitle_codec (0)
  68         , _decode_video (video)
  69         , _decode_audio (audio)
  70         , _video_pts_offset (0)
  71         , _audio_pts_offset (0)
  72         , _just_sought (false)
  73 {
  74         setup_subtitle ();
  75
  76         /* Audio and video frame PTS values may not start with 0.  We want
  77            to fiddle them so that:
  78
  79            1.  One of them starts at time 0.
  80            2.  The first video PTS value ends up on a frame boundary.
  81
  82            Then we remove big initial gaps in PTS and we allow our
  83            insertion of black frames to work.
  84
  85            We will do:
  86              audio_pts_to_use = audio_pts_from_ffmpeg + audio_pts_offset;
  87              video_pts_to_use = video_pts_from_ffmpeg + video_pts_offset;
  88         */
  89
  90         bool const have_video = video && c->first_video();
  91         bool const have_audio = audio && c->audio_stream() && c->audio_stream()->first_audio;
  92
  93         /* First, make one of them start at 0 */
  94
  95         if (have_audio && have_video) {
  96                 _video_pts_offset = _audio_pts_offset = - min (c->first_video().get(), c->audio_stream()->first_audio.get());
  97         } else if (have_video) {
  98                 _video_pts_offset = - c->first_video().get();
  99         }
 100
 101         /* Now adjust both so that the video pts starts on a frame */
 102         if (have_video && have_audio) {
 103                 double first_video = c->first_video().get() + _video_pts_offset;
 104                 double const old_first_video = first_video;
 105
 106                 /* Round the first video up to a frame boundary */
 107                 if (fabs (rint (first_video * c->video_frame_rate()) - first_video * c->video_frame_rate()) > 1e-6) {
 108                         first_video = ceil (first_video * c->video_frame_rate()) / c->video_frame_rate ();
 109                 }
 110
 111                 _video_pts_offset += first_video - old_first_video;
 112                 _audio_pts_offset += first_video - old_first_video;
 113         }
 114 }
 115
 116 FFmpegDecoder::~FFmpegDecoder ()
 117 {
 118         boost::mutex::scoped_lock lm (_mutex);
 119
 120         if (_subtitle_codec_context) {
 121                 avcodec_close (_subtitle_codec_context);
 122         }
 123 }
 124
 125 void
 126 FFmpegDecoder::pass ()
 127 {
 128         int r = av_read_frame (_format_context, &_packet);
 129
 130         if (r < 0) {
 131                 if (r != AVERROR_EOF) {
 132                         /* Maybe we should fail here, but for now we'll just finish off instead */
 133                         char buf[256];
 134                         av_strerror (r, buf, sizeof(buf));
 135                         shared_ptr<const Film> film = _film.lock ();
 136                         assert (film);
 137                         film->log()->log (String::compose (N_("error on av_read_frame (%1) (%2)"), buf, r));
 138                 }
 139
 140                 /* Get any remaining frames */
 141
 142                 _packet.data = 0;
 143                 _packet.size = 0;
 144
 145                 /* XXX: should we reset _packet.data and size after each *_decode_* call? */
 146
 147                 if (_decode_video) {
 148                         while (decode_video_packet ()) {}
 149                 }
 150
 151                 if (_ffmpeg_content->audio_stream() && _decode_audio) {
 152                         decode_audio_packet ();
 153                 }
 154
 155                 /* Stop us being asked for any more data */
 156                 _video_position = _ffmpeg_content->video_length ();
 157                 _audio_position = _ffmpeg_content->audio_length ();
 158                 return;
 159         }
 160
 161         avcodec_get_frame_defaults (_frame);
 162
 163         if (_packet.stream_index == _video_stream && _decode_video) {
 164                 decode_video_packet ();
 165         } else if (_ffmpeg_content->audio_stream() && _packet.stream_index == _ffmpeg_content->audio_stream()->id && _decode_audio) {
 166                 decode_audio_packet ();
 167         } else if (_ffmpeg_content->subtitle_stream() && _packet.stream_index == _ffmpeg_content->subtitle_stream()->id) {
 168                 decode_subtitle_packet ();
 169         }
 170
 171         av_free_packet (&_packet);
 172 }
 173
 174 /** @param data pointer to array of pointers to buffers.
 175  *  Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
 176  */
 177 shared_ptr<AudioBuffers>
 178 FFmpegDecoder::deinterleave_audio (uint8_t** data, int size)
 179 {
 180         assert (_ffmpeg_content->audio_channels());
 181         assert (bytes_per_audio_sample());
 182
 183         /* Deinterleave and convert to float */
 184
 185         assert ((size % (bytes_per_audio_sample() * _ffmpeg_content->audio_channels())) == 0);
 186
 187         int const total_samples = size / bytes_per_audio_sample();
 188         int const frames = total_samples / _ffmpeg_content->audio_channels();
 189         shared_ptr<AudioBuffers> audio (new AudioBuffers (_ffmpeg_content->audio_channels(), frames));
 190
 191         switch (audio_sample_format()) {
 192         case AV_SAMPLE_FMT_S16:
 193         {
 194                 int16_t* p = reinterpret_cast<int16_t *> (data[0]);
 195                 int sample = 0;
 196                 int channel = 0;
 197                 for (int i = 0; i < total_samples; ++i) {
 198                         audio->data(channel)[sample] = float(*p++) / (1 << 15);
 199
 200                         ++channel;
 201                         if (channel == _ffmpeg_content->audio_channels()) {
 202                                 channel = 0;
 203                                 ++sample;
 204                         }
 205                 }
 206         }
 207         break;
 208
 209         case AV_SAMPLE_FMT_S16P:
 210         {
 211                 int16_t** p = reinterpret_cast<int16_t **> (data);
 212                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 213                         for (int j = 0; j < frames; ++j) {
 214                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
 215                         }
 216                 }
 217         }
 218         break;
 219
 220         case AV_SAMPLE_FMT_S32:
 221         {
 222                 int32_t* p = reinterpret_cast<int32_t *> (data[0]);
 223                 int sample = 0;
 224                 int channel = 0;
 225                 for (int i = 0; i < total_samples; ++i) {
 226                         audio->data(channel)[sample] = static_cast<float>(*p++) / (1 << 31);
 227
 228                         ++channel;
 229                         if (channel == _ffmpeg_content->audio_channels()) {
 230                                 channel = 0;
 231                                 ++sample;
 232                         }
 233                 }
 234         }
 235         break;
 236
 237         case AV_SAMPLE_FMT_FLT:
 238         {
 239                 float* p = reinterpret_cast<float*> (data[0]);
 240                 int sample = 0;
 241                 int channel = 0;
 242                 for (int i = 0; i < total_samples; ++i) {
 243                         audio->data(channel)[sample] = *p++;
 244
 245                         ++channel;
 246                         if (channel == _ffmpeg_content->audio_channels()) {
 247                                 channel = 0;
 248                                 ++sample;
 249                         }
 250                 }
 251         }
 252         break;
 253
 254         case AV_SAMPLE_FMT_FLTP:
 255         {
 256                 float** p = reinterpret_cast<float**> (data);
 257                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 258                         memcpy (audio->data(i), p[i], frames * sizeof(float));
 259                 }
 260         }
 261         break;
 262
 263         default:
 264                 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format())));
 265         }
 266
 267         return audio;
 268 }
 269
 270 AVSampleFormat
 271 FFmpegDecoder::audio_sample_format () const
 272 {
 273         if (!_ffmpeg_content->audio_stream()) {
 274                 return (AVSampleFormat) 0;
 275         }
 276
 277         return audio_codec_context()->sample_fmt;
 278 }
 279
 280 int
 281 FFmpegDecoder::bytes_per_audio_sample () const
 282 {
 283         return av_get_bytes_per_sample (audio_sample_format ());
 284 }
 285
 286 void
 287 FFmpegDecoder::seek (VideoContent::Frame frame, bool accurate)
 288 {
 289         double const time_base = av_q2d (_format_context->streams[_video_stream]->time_base);
 290
 291         /* If we are doing an accurate seek, our initial shot will be 5 frames (5 being
 292            a number plucked from the air) earlier than we want to end up.  The loop below
 293            will hopefully then step through to where we want to be.
 294         */
 295         int initial = frame;
 296
 297         if (accurate) {
 298                 initial -= 5;
 299         }
 300
 301         if (initial < 0) {
 302                 initial = 0;
 303         }
 304
 305         /* Initial seek time in the stream's timebase */
 306         int64_t const initial_vt = ((initial / _ffmpeg_content->video_frame_rate()) - _video_pts_offset) / time_base;
 307
 308         av_seek_frame (_format_context, _video_stream, initial_vt, AVSEEK_FLAG_BACKWARD);
 309
 310         avcodec_flush_buffers (video_codec_context());
 311         if (_subtitle_codec_context) {
 312                 avcodec_flush_buffers (_subtitle_codec_context);
 313         }
 314
 315         _just_sought = true;
 316
 317         if (frame == 0 || !accurate) {
 318                 /* We're already there, or we're as close as we need to be */
 319                 return;
 320         }
 321
 322         while (1) {
 323                 int r = av_read_frame (_format_context, &_packet);
 324                 if (r < 0) {
 325                         return;
 326                 }
 327
 328                 if (_packet.stream_index != _video_stream) {
 329                         continue;
 330                 }
 331
 332                 avcodec_get_frame_defaults (_frame);
 333
 334                 int finished = 0;
 335                 r = avcodec_decode_video2 (video_codec_context(), _frame, &finished, &_packet);
 336                 if (r >= 0 && finished) {
 337                         _video_position = rint (
 338                                 (av_frame_get_best_effort_timestamp (_frame) * time_base + _video_pts_offset) * _ffmpeg_content->video_frame_rate()
 339                                 );
 340
 341                         if (_video_position >= (frame - 1)) {
 342                                 av_free_packet (&_packet);
 343                                 break;
 344                         }
 345                 }
 346
 347                 av_free_packet (&_packet);
 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         while (copy_packet.size > 0) {
 361
 362                 int frame_finished;
 363                 int const decode_result = avcodec_decode_audio4 (audio_codec_context(), _frame, &frame_finished, &copy_packet);
 364                 if (decode_result >= 0) {
 365                         if (frame_finished) {
 366
 367                                 if (_audio_position == 0) {
 368                                         /* Where we are in the source, in seconds */
 369                                         double const pts = av_q2d (_format_context->streams[copy_packet.stream_index]->time_base)
 370                                                 * av_frame_get_best_effort_timestamp(_frame) + _audio_pts_offset;
 371
 372                                         if (pts > 0) {
 373                                                 /* Emit some silence */
 374                                                 shared_ptr<AudioBuffers> silence (
 375                                                         new AudioBuffers (
 376                                                                 _ffmpeg_content->audio_channels(),
 377                                                                 pts * _ffmpeg_content->content_audio_frame_rate()
 378                                                                 )
 379                                                         );
 380
 381                                                 silence->make_silent ();
 382                                                 audio (silence, _audio_position);
 383                                         }
 384                                 }
 385
 386                                 copy_packet.data += decode_result;
 387                                 copy_packet.size -= decode_result;
 388                         }
 389                 }
 390         }
 391 }
 392
 393 bool
 394 FFmpegDecoder::decode_video_packet ()
 395 {
 396         int frame_finished;
 397         if (avcodec_decode_video2 (video_codec_context(), _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
 398                 return false;
 399         }
 400
 401         boost::mutex::scoped_lock lm (_filter_graphs_mutex);
 402
 403         shared_ptr<FilterGraph> graph;
 404
 405         list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
 406         while (i != _filter_graphs.end() && !(*i)->can_process (libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
 407                 ++i;
 408         }
 409
 410         if (i == _filter_graphs.end ()) {
 411                 shared_ptr<const Film> film = _film.lock ();
 412                 assert (film);
 413
 414                 graph.reset (new FilterGraph (_ffmpeg_content, libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
 415                 _filter_graphs.push_back (graph);
 416
 417                 film->log()->log (String::compose (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format));
 418         } else {
 419                 graph = *i;
 420         }
 421
 422         list<pair<shared_ptr<Image>, int64_t> > images = graph->process (_frame);
 423
 424         string post_process = Filter::ffmpeg_strings (_ffmpeg_content->filters()).second;
 425
 426         for (list<pair<shared_ptr<Image>, int64_t> >::iterator i = images.begin(); i != images.end(); ++i) {
 427
 428                 shared_ptr<Image> image = i->first;
 429                 if (!post_process.empty ()) {
 430                         image = image->post_process (post_process, true);
 431                 }
 432
 433                 if (i->second != AV_NOPTS_VALUE) {
 434
 435                         double const pts = i->second * av_q2d (_format_context->streams[_video_stream]->time_base) + _video_pts_offset;
 436
 437                         if (_just_sought) {
 438                                 /* We just did a seek, so disable any attempts to correct for where we
 439                                    are / should be.
 440                                 */
 441                                 _video_position = rint (pts * _ffmpeg_content->video_frame_rate ());
 442                                 _just_sought = false;
 443                         }
 444
 445                         double const next = _video_position / _ffmpeg_content->video_frame_rate();
 446                         double const one_frame = 1 / _ffmpeg_content->video_frame_rate ();
 447                         double delta = pts - next;
 448
 449                         while (delta > one_frame) {
 450                                 /* This PTS is more than one frame forward in time of where we think we should be; emit
 451                                    a black frame.
 452                                 */
 453                                 boost::shared_ptr<Image> black (
 454                                         new Image (
 455                                                 static_cast<AVPixelFormat> (_frame->format),
 456                                                 libdcp::Size (video_codec_context()->width, video_codec_context()->height),
 457                                                 true
 458                                                 )
 459                                         );
 460
 461                                 black->make_black ();
 462                                 video (image, false, _video_position);
 463                                 delta -= one_frame;
 464                         }
 465
 466                         if (delta > -one_frame) {
 467                                 /* This PTS is within a frame of being right; emit this (otherwise it will be dropped) */
 468                                 video (image, false, _video_position);
 469                         }
 470
 471                 } else {
 472                         shared_ptr<const Film> film = _film.lock ();
 473                         assert (film);
 474                         film->log()->log ("Dropping frame without PTS");
 475                 }
 476         }
 477
 478         return true;
 479 }
 480
 481
 482 void
 483 FFmpegDecoder::setup_subtitle ()
 484 {
 485         boost::mutex::scoped_lock lm (_mutex);
 486
 487         if (!_ffmpeg_content->subtitle_stream() || _ffmpeg_content->subtitle_stream()->id >= int (_format_context->nb_streams)) {
 488                 return;
 489         }
 490
 491         _subtitle_codec_context = _format_context->streams[_ffmpeg_content->subtitle_stream()->id]->codec;
 492         _subtitle_codec = avcodec_find_decoder (_subtitle_codec_context->codec_id);
 493
 494         if (_subtitle_codec == 0) {
 495                 throw DecodeError (_("could not find subtitle decoder"));
 496         }
 497
 498         if (avcodec_open2 (_subtitle_codec_context, _subtitle_codec, 0) < 0) {
 499                 throw DecodeError (N_("could not open subtitle decoder"));
 500         }
 501 }
 502
 503 bool
 504 FFmpegDecoder::done () const
 505 {
 506         bool const vd = !_decode_video || (_video_position >= _ffmpeg_content->video_length());
 507         bool const ad = !_decode_audio || !_ffmpeg_content->audio_stream() || (_audio_position >= _ffmpeg_content->audio_length());
 508         return vd && ad;
 509 }
 510
 511 void
 512 FFmpegDecoder::decode_subtitle_packet ()
 513 {
 514         int got_subtitle;
 515         AVSubtitle sub;
 516         if (avcodec_decode_subtitle2 (_subtitle_codec_context, &sub, &got_subtitle, &_packet) < 0 || !got_subtitle) {
 517                 return;
 518         }
 519
 520         /* Sometimes we get an empty AVSubtitle, which is used by some codecs to
 521            indicate that the previous subtitle should stop.
 522         */
 523         if (sub.num_rects <= 0) {
 524                 subtitle (shared_ptr<Image> (), dcpomatic::Rect<double> (), 0, 0);
 525                 return;
 526         } else if (sub.num_rects > 1) {
 527                 throw DecodeError (_("multi-part subtitles not yet supported"));
 528         }
 529
 530         /* Subtitle PTS in seconds (within the source, not taking into account any of the
 531            source that we may have chopped off for the DCP)
 532         */
 533         double const packet_time = static_cast<double> (sub.pts) / AV_TIME_BASE;
 534
 535         /* hence start time for this sub */
 536         Time const from = (packet_time + (double (sub.start_display_time) / 1e3)) * TIME_HZ;
 537         Time const to = (packet_time + (double (sub.end_display_time) / 1e3)) * TIME_HZ;
 538
 539         AVSubtitleRect const * rect = sub.rects[0];
 540
 541         if (rect->type != SUBTITLE_BITMAP) {
 542                 throw DecodeError (_("non-bitmap subtitles not yet supported"));
 543         }
 544
 545         shared_ptr<Image> image (new Image (PIX_FMT_RGBA, libdcp::Size (rect->w, rect->h), true));
 546
 547         /* Start of the first line in the subtitle */
 548         uint8_t* sub_p = rect->pict.data[0];
 549         /* sub_p looks up into a RGB palette which is here */
 550         uint32_t const * palette = (uint32_t *) rect->pict.data[1];
 551         /* Start of the output data */
 552         uint32_t* out_p = (uint32_t *) image->data()[0];
 553
 554         for (int y = 0; y < rect->h; ++y) {
 555                 uint8_t* sub_line_p = sub_p;
 556                 uint32_t* out_line_p = out_p;
 557                 for (int x = 0; x < rect->w; ++x) {
 558                         *out_line_p++ = palette[*sub_line_p++];
 559                 }
 560                 sub_p += rect->pict.linesize[0];
 561                 out_p += image->stride()[0] / sizeof (uint32_t);
 562         }
 563
 564         libdcp::Size const vs = _ffmpeg_content->video_size ();
 565
 566         subtitle (
 567                 image,
 568                 dcpomatic::Rect<double> (
 569                         static_cast<double> (rect->x) / vs.width,
 570                         static_cast<double> (rect->y) / vs.height,
 571                         static_cast<double> (rect->w) / vs.width,
 572                         static_cast<double> (rect->h) / vs.height
 573                         ),
 574                 from,
 575                 to
 576                 );
 577
 578
 579         avsubtitle_free (&sub);
 580 }