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