src/lib/ffmpeg_decoder.cc

   1 /* -*- c-basic-offset: 8; default-tab-width: 8; -*- */
   2
   3 /*
   4     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   5
   6     This program 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     This program 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 this program; if not, write to the Free Software
  18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19
  20 */
  21
  22 /** @file  src/ffmpeg_decoder.cc
  23  *  @brief A decoder using FFmpeg to decode content.
  24  */
  25
  26 #include <stdexcept>
  27 #include <vector>
  28 #include <sstream>
  29 #include <iomanip>
  30 #include <iostream>
  31 #include <stdint.h>
  32 #include <boost/lexical_cast.hpp>
  33 extern "C" {
  34 #include <tiffio.h>
  35 #include <libavcodec/avcodec.h>
  36 #include <libavformat/avformat.h>
  37 #include <libswscale/swscale.h>
  38 #include <libpostproc/postprocess.h>
  39 }
  40 #include <sndfile.h>
  41 #include "film.h"
  42 #include "format.h"
  43 #include "transcoder.h"
  44 #include "job.h"
  45 #include "filter.h"
  46 #include "exceptions.h"
  47 #include "image.h"
  48 #include "util.h"
  49 #include "log.h"
  50 #include "ffmpeg_decoder.h"
  51 #include "filter_graph.h"
  52 #include "subtitle.h"
  53 #include "audio_buffers.h"
  54
  55 #include "i18n.h"
  56
  57 using std::cout;
  58 using std::string;
  59 using std::vector;
  60 using std::stringstream;
  61 using std::list;
  62 using boost::shared_ptr;
  63 using boost::optional;
  64 using boost::dynamic_pointer_cast;
  65 using libdcp::Size;
  66
  67 boost::mutex FFmpegDecoder::_mutex;
  68
  69 FFmpegDecoder::FFmpegDecoder (shared_ptr<const Film> f, shared_ptr<const FFmpegContent> c, bool video, bool audio, bool subtitles)
  70         : Decoder (f)
  71         , VideoDecoder (f)
  72         , AudioDecoder (f, c)
  73         , _ffmpeg_content (c)
  74         , _format_context (0)
  75         , _video_stream (-1)
  76         , _frame (0)
  77         , _video_codec_context (0)
  78         , _video_codec (0)
  79         , _audio_codec_context (0)
  80         , _audio_codec (0)
  81         , _subtitle_codec_context (0)
  82         , _subtitle_codec (0)
  83         , _decode_video (video)
  84         , _decode_audio (audio)
  85         , _decode_subtitles (subtitles)
  86 {
  87         setup_general ();
  88         setup_video ();
  89         setup_audio ();
  90         setup_subtitle ();
  91 }
  92
  93 FFmpegDecoder::~FFmpegDecoder ()
  94 {
  95         boost::mutex::scoped_lock lm (_mutex);
  96
  97         if (_audio_codec_context) {
  98                 avcodec_close (_audio_codec_context);
  99         }
 100
 101         if (_video_codec_context) {
 102                 avcodec_close (_video_codec_context);
 103         }
 104
 105         if (_subtitle_codec_context) {
 106                 avcodec_close (_subtitle_codec_context);
 107         }
 108
 109         av_free (_frame);
 110
 111         avformat_close_input (&_format_context);
 112 }
 113
 114 void
 115 FFmpegDecoder::setup_general ()
 116 {
 117         av_register_all ();
 118
 119         if (avformat_open_input (&_format_context, _ffmpeg_content->file().string().c_str(), 0, 0) < 0) {
 120                 throw OpenFileError (_ffmpeg_content->file().string ());
 121         }
 122
 123         if (avformat_find_stream_info (_format_context, 0) < 0) {
 124                 throw DecodeError (_("could not find stream information"));
 125         }
 126
 127         /* Find video, audio and subtitle streams */
 128
 129         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 130                 AVStream* s = _format_context->streams[i];
 131                 if (s->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
 132                         _video_stream = i;
 133                 } else if (s->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
 134
 135                         /* This is a hack; sometimes it seems that _audio_codec_context->channel_layout isn't set up,
 136                            so bodge it here.  No idea why we should have to do this.
 137                         */
 138
 139                         if (s->codec->channel_layout == 0) {
 140                                 s->codec->channel_layout = av_get_default_channel_layout (s->codec->channels);
 141                         }
 142
 143                         _audio_streams.push_back (
 144                                 shared_ptr<FFmpegAudioStream> (
 145                                         new FFmpegAudioStream (stream_name (s), i, s->codec->sample_rate, s->codec->channels)
 146                                         )
 147                                 );
 148
 149                 } else if (s->codec->codec_type == AVMEDIA_TYPE_SUBTITLE) {
 150                         _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (stream_name (s), i)));
 151                 }
 152         }
 153
 154         if (_video_stream < 0) {
 155                 throw DecodeError (N_("could not find video stream"));
 156         }
 157
 158         _frame = avcodec_alloc_frame ();
 159         if (_frame == 0) {
 160                 throw DecodeError (N_("could not allocate frame"));
 161         }
 162 }
 163
 164 void
 165 FFmpegDecoder::setup_video ()
 166 {
 167         boost::mutex::scoped_lock lm (_mutex);
 168
 169         _video_codec_context = _format_context->streams[_video_stream]->codec;
 170         _video_codec = avcodec_find_decoder (_video_codec_context->codec_id);
 171
 172         if (_video_codec == 0) {
 173                 throw DecodeError (_("could not find video decoder"));
 174         }
 175
 176         if (avcodec_open2 (_video_codec_context, _video_codec, 0) < 0) {
 177                 throw DecodeError (N_("could not open video decoder"));
 178         }
 179 }
 180
 181 void
 182 FFmpegDecoder::setup_audio ()
 183 {
 184         boost::mutex::scoped_lock lm (_mutex);
 185
 186         if (!_ffmpeg_content->audio_stream ()) {
 187                 return;
 188         }
 189
 190         _audio_codec_context = _format_context->streams[_ffmpeg_content->audio_stream()->id]->codec;
 191         _audio_codec = avcodec_find_decoder (_audio_codec_context->codec_id);
 192
 193         if (_audio_codec == 0) {
 194                 throw DecodeError (_("could not find audio decoder"));
 195         }
 196
 197         if (avcodec_open2 (_audio_codec_context, _audio_codec, 0) < 0) {
 198                 throw DecodeError (N_("could not open audio decoder"));
 199         }
 200 }
 201
 202 void
 203 FFmpegDecoder::setup_subtitle ()
 204 {
 205         boost::mutex::scoped_lock lm (_mutex);
 206
 207         if (!_ffmpeg_content->subtitle_stream() || _ffmpeg_content->subtitle_stream()->id >= int (_format_context->nb_streams)) {
 208                 return;
 209         }
 210
 211         _subtitle_codec_context = _format_context->streams[_ffmpeg_content->subtitle_stream()->id]->codec;
 212         _subtitle_codec = avcodec_find_decoder (_subtitle_codec_context->codec_id);
 213
 214         if (_subtitle_codec == 0) {
 215                 throw DecodeError (_("could not find subtitle decoder"));
 216         }
 217
 218         if (avcodec_open2 (_subtitle_codec_context, _subtitle_codec, 0) < 0) {
 219                 throw DecodeError (N_("could not open subtitle decoder"));
 220         }
 221 }
 222
 223
 224 bool
 225 FFmpegDecoder::pass ()
 226 {
 227         int r = av_read_frame (_format_context, &_packet);
 228
 229         if (r < 0) {
 230                 if (r != AVERROR_EOF) {
 231                         /* Maybe we should fail here, but for now we'll just finish off instead */
 232                         char buf[256];
 233                         av_strerror (r, buf, sizeof(buf));
 234                         _film->log()->log (String::compose (N_("error on av_read_frame (%1) (%2)"), buf, r));
 235                 }
 236
 237                 /* Get any remaining frames */
 238
 239                 _packet.data = 0;
 240                 _packet.size = 0;
 241
 242                 /* XXX: should we reset _packet.data and size after each *_decode_* call? */
 243
 244                 if (_decode_video) {
 245                         while (decode_video_packet ());
 246                 }
 247
 248                 if (_ffmpeg_content->audio_stream() && _decode_audio) {
 249                         decode_audio_packet ();
 250                 }
 251
 252                 return true;
 253         }
 254
 255         avcodec_get_frame_defaults (_frame);
 256
 257         if (_packet.stream_index == _video_stream && _decode_video) {
 258                 decode_video_packet ();
 259         } else if (_ffmpeg_content->audio_stream() && _packet.stream_index == _ffmpeg_content->audio_stream()->id && _decode_audio) {
 260                 decode_audio_packet ();
 261         } else if (_ffmpeg_content->subtitle_stream() && _packet.stream_index == _ffmpeg_content->subtitle_stream()->id && _decode_subtitles) {
 262
 263                 int got_subtitle;
 264                 AVSubtitle sub;
 265                 if (avcodec_decode_subtitle2 (_subtitle_codec_context, &sub, &got_subtitle, &_packet) && got_subtitle) {
 266                         /* Sometimes we get an empty AVSubtitle, which is used by some codecs to
 267                            indicate that the previous subtitle should stop.
 268                         */
 269                         if (sub.num_rects > 0) {
 270                                 shared_ptr<TimedSubtitle> ts;
 271                                 try {
 272                                         emit_subtitle (shared_ptr<TimedSubtitle> (new TimedSubtitle (sub)));
 273                                 } catch (...) {
 274                                         /* some problem with the subtitle; we probably didn't understand it */
 275                                 }
 276                         } else {
 277                                 emit_subtitle (shared_ptr<TimedSubtitle> ());
 278                         }
 279                         avsubtitle_free (&sub);
 280                 }
 281         }
 282
 283         av_free_packet (&_packet);
 284         return false;
 285 }
 286
 287 /** @param data pointer to array of pointers to buffers.
 288  *  Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
 289  */
 290 shared_ptr<AudioBuffers>
 291 FFmpegDecoder::deinterleave_audio (uint8_t** data, int size)
 292 {
 293         assert (_ffmpeg_content->audio_channels());
 294         assert (bytes_per_audio_sample());
 295
 296         /* Deinterleave and convert to float */
 297
 298         assert ((size % (bytes_per_audio_sample() * _ffmpeg_content->audio_channels())) == 0);
 299
 300         int const total_samples = size / bytes_per_audio_sample();
 301         int const frames = total_samples / _ffmpeg_content->audio_channels();
 302         shared_ptr<AudioBuffers> audio (new AudioBuffers (_ffmpeg_content->audio_channels(), frames));
 303
 304         switch (audio_sample_format()) {
 305         case AV_SAMPLE_FMT_S16:
 306         {
 307                 int16_t* p = reinterpret_cast<int16_t *> (data[0]);
 308                 int sample = 0;
 309                 int channel = 0;
 310                 for (int i = 0; i < total_samples; ++i) {
 311                         audio->data(channel)[sample] = float(*p++) / (1 << 15);
 312
 313                         ++channel;
 314                         if (channel == _ffmpeg_content->audio_channels()) {
 315                                 channel = 0;
 316                                 ++sample;
 317                         }
 318                 }
 319         }
 320         break;
 321
 322         case AV_SAMPLE_FMT_S16P:
 323         {
 324                 int16_t** p = reinterpret_cast<int16_t **> (data);
 325                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 326                         for (int j = 0; j < frames; ++j) {
 327                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
 328                         }
 329                 }
 330         }
 331         break;
 332
 333         case AV_SAMPLE_FMT_S32:
 334         {
 335                 int32_t* p = reinterpret_cast<int32_t *> (data[0]);
 336                 int sample = 0;
 337                 int channel = 0;
 338                 for (int i = 0; i < total_samples; ++i) {
 339                         audio->data(channel)[sample] = static_cast<float>(*p++) / (1 << 31);
 340
 341                         ++channel;
 342                         if (channel == _ffmpeg_content->audio_channels()) {
 343                                 channel = 0;
 344                                 ++sample;
 345                         }
 346                 }
 347         }
 348         break;
 349
 350         case AV_SAMPLE_FMT_FLT:
 351         {
 352                 float* p = reinterpret_cast<float*> (data[0]);
 353                 int sample = 0;
 354                 int channel = 0;
 355                 for (int i = 0; i < total_samples; ++i) {
 356                         audio->data(channel)[sample] = *p++;
 357
 358                         ++channel;
 359                         if (channel == _ffmpeg_content->audio_channels()) {
 360                                 channel = 0;
 361                                 ++sample;
 362                         }
 363                 }
 364         }
 365         break;
 366
 367         case AV_SAMPLE_FMT_FLTP:
 368         {
 369                 float** p = reinterpret_cast<float**> (data);
 370                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 371                         memcpy (audio->data(i), p[i], frames * sizeof(float));
 372                 }
 373         }
 374         break;
 375
 376         default:
 377                 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format())));
 378         }
 379
 380         return audio;
 381 }
 382
 383 float
 384 FFmpegDecoder::video_frame_rate () const
 385 {
 386         AVStream* s = _format_context->streams[_video_stream];
 387
 388         if (s->avg_frame_rate.num && s->avg_frame_rate.den) {
 389                 return av_q2d (s->avg_frame_rate);
 390         }
 391
 392         return av_q2d (s->r_frame_rate);
 393 }
 394
 395 AVSampleFormat
 396 FFmpegDecoder::audio_sample_format () const
 397 {
 398         if (_audio_codec_context == 0) {
 399                 return (AVSampleFormat) 0;
 400         }
 401
 402         return _audio_codec_context->sample_fmt;
 403 }
 404
 405 libdcp::Size
 406 FFmpegDecoder::native_size () const
 407 {
 408         return libdcp::Size (_video_codec_context->width, _video_codec_context->height);
 409 }
 410
 411 PixelFormat
 412 FFmpegDecoder::pixel_format () const
 413 {
 414         return _video_codec_context->pix_fmt;
 415 }
 416
 417 int
 418 FFmpegDecoder::time_base_numerator () const
 419 {
 420         return _video_codec_context->time_base.num;
 421 }
 422
 423 int
 424 FFmpegDecoder::time_base_denominator () const
 425 {
 426         return _video_codec_context->time_base.den;
 427 }
 428
 429 int
 430 FFmpegDecoder::sample_aspect_ratio_numerator () const
 431 {
 432         return _video_codec_context->sample_aspect_ratio.num;
 433 }
 434
 435 int
 436 FFmpegDecoder::sample_aspect_ratio_denominator () const
 437 {
 438         return _video_codec_context->sample_aspect_ratio.den;
 439 }
 440
 441 string
 442 FFmpegDecoder::stream_name (AVStream* s) const
 443 {
 444         stringstream n;
 445
 446         if (s->metadata) {
 447                 AVDictionaryEntry const * lang = av_dict_get (s->metadata, N_("language"), 0, 0);
 448                 if (lang) {
 449                         n << lang->value;
 450                 }
 451
 452                 AVDictionaryEntry const * title = av_dict_get (s->metadata, N_("title"), 0, 0);
 453                 if (title) {
 454                         if (!n.str().empty()) {
 455                                 n << N_(" ");
 456                         }
 457                         n << title->value;
 458                 }
 459         }
 460
 461         if (n.str().empty()) {
 462                 n << N_("unknown");
 463         }
 464
 465         return n.str ();
 466 }
 467
 468 int
 469 FFmpegDecoder::bytes_per_audio_sample () const
 470 {
 471         return av_get_bytes_per_sample (audio_sample_format ());
 472 }
 473
 474 bool
 475 FFmpegDecoder::seek (double p)
 476 {
 477         return do_seek (p, false, false);
 478 }
 479
 480 bool
 481 FFmpegDecoder::seek_back ()
 482 {
 483         if (last_content_time() < 2.5) {
 484                 return true;
 485         }
 486
 487         return do_seek (last_content_time() - 2.5 / video_frame_rate(), true, true);
 488 }
 489
 490 bool
 491 FFmpegDecoder::seek_forward ()
 492 {
 493         if (last_content_time() >= (video_length() - video_frame_rate())) {
 494                 return true;
 495         }
 496
 497         return do_seek (last_content_time() - 0.5 / video_frame_rate(), true, true);
 498 }
 499
 500 bool
 501 FFmpegDecoder::do_seek (double p, bool backwards, bool accurate)
 502 {
 503         int64_t const vt = p / av_q2d (_format_context->streams[_video_stream]->time_base);
 504
 505         int const r = av_seek_frame (_format_context, _video_stream, vt, backwards ? AVSEEK_FLAG_BACKWARD : 0);
 506
 507         avcodec_flush_buffers (_video_codec_context);
 508         if (_subtitle_codec_context) {
 509                 avcodec_flush_buffers (_subtitle_codec_context);
 510         }
 511
 512         if (accurate) {
 513                 while (1) {
 514                         int r = av_read_frame (_format_context, &_packet);
 515                         if (r < 0) {
 516                                 return true;
 517                         }
 518
 519                         avcodec_get_frame_defaults (_frame);
 520
 521                         if (_packet.stream_index == _video_stream) {
 522                                 int finished = 0;
 523                                 int const r = avcodec_decode_video2 (_video_codec_context, _frame, &finished, &_packet);
 524                                 if (r >= 0 && finished) {
 525                                         int64_t const bet = av_frame_get_best_effort_timestamp (_frame);
 526                                         if (bet > vt) {
 527                                                 break;
 528                                         }
 529                                 }
 530                         }
 531
 532                         av_free_packet (&_packet);
 533                 }
 534         }
 535
 536         return r < 0;
 537 }
 538
 539 void
 540 FFmpegDecoder::film_changed (Film::Property p)
 541 {
 542         switch (p) {
 543         case Film::CROP:
 544         case Film::FILTERS:
 545         {
 546                 boost::mutex::scoped_lock lm (_filter_graphs_mutex);
 547                 _filter_graphs.clear ();
 548         }
 549         break;
 550
 551         default:
 552                 break;
 553         }
 554 }
 555
 556 /** @return Length (in video frames) according to our content's header */
 557 ContentVideoFrame
 558 FFmpegDecoder::video_length () const
 559 {
 560         return (double(_format_context->duration) / AV_TIME_BASE) * video_frame_rate();
 561 }
 562
 563 void
 564 FFmpegDecoder::decode_audio_packet ()
 565 {
 566         /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
 567            several times.
 568         */
 569
 570         AVPacket copy_packet = _packet;
 571
 572         while (copy_packet.size > 0) {
 573
 574                 int frame_finished;
 575                 int const decode_result = avcodec_decode_audio4 (_audio_codec_context, _frame, &frame_finished, &copy_packet);
 576                 if (decode_result >= 0) {
 577                         if (frame_finished) {
 578
 579                                 /* Where we are in the source, in seconds */
 580                                 double const source_pts_seconds = av_q2d (_format_context->streams[copy_packet.stream_index]->time_base)
 581                                         * av_frame_get_best_effort_timestamp(_frame);
 582
 583                                 int const data_size = av_samples_get_buffer_size (
 584                                         0, _audio_codec_context->channels, _frame->nb_samples, audio_sample_format (), 1
 585                                         );
 586
 587                                 assert (_audio_codec_context->channels == _ffmpeg_content->audio_channels());
 588                                 Audio (deinterleave_audio (_frame->data, data_size), source_pts_seconds);
 589                         }
 590
 591                         copy_packet.data += decode_result;
 592                         copy_packet.size -= decode_result;
 593                 }
 594         }
 595 }
 596
 597 bool
 598 FFmpegDecoder::decode_video_packet ()
 599 {
 600         int frame_finished;
 601         if (avcodec_decode_video2 (_video_codec_context, _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
 602                 return false;
 603         }
 604
 605         boost::mutex::scoped_lock lm (_filter_graphs_mutex);
 606
 607         shared_ptr<FilterGraph> graph;
 608
 609         list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
 610         while (i != _filter_graphs.end() && !(*i)->can_process (libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
 611                 ++i;
 612         }
 613
 614         if (i == _filter_graphs.end ()) {
 615                 graph.reset (new FilterGraph (_film, this, libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
 616                 _filter_graphs.push_back (graph);
 617                 _film->log()->log (String::compose (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format));
 618         } else {
 619                 graph = *i;
 620         }
 621
 622         list<shared_ptr<Image> > images = graph->process (_frame);
 623
 624         for (list<shared_ptr<Image> >::iterator i = images.begin(); i != images.end(); ++i) {
 625                 int64_t const bet = av_frame_get_best_effort_timestamp (_frame);
 626                 if (bet != AV_NOPTS_VALUE) {
 627                         /* XXX: may need to insert extra frames / remove frames here ...
 628                            (as per old Matcher)
 629                         */
 630                         emit_video (*i, false, bet * av_q2d (_format_context->streams[_video_stream]->time_base) * TIME_HZ);
 631                 } else {
 632                         _film->log()->log ("Dropping frame without PTS");
 633                 }
 634         }
 635
 636         return true;
 637 }