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