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