src/lib/ffmpeg_decoder.cc

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