src/lib/ffmpeg_decoder.cc

   1 /*
   2     Copyright (C) 2012-2014 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 <iomanip>
  27 #include <iostream>
  28 #include <stdint.h>
  29 #include <sndfile.h>
  30 extern "C" {
  31 #include <libavcodec/avcodec.h>
  32 #include <libavformat/avformat.h>
  33 }
  34 #include "filter.h"
  35 #include "exceptions.h"
  36 #include "image.h"
  37 #include "util.h"
  38 #include "log.h"
  39 #include "ffmpeg_decoder.h"
  40 #include "ffmpeg_audio_stream.h"
  41 #include "ffmpeg_subtitle_stream.h"
  42 #include "filter_graph.h"
  43 #include "audio_buffers.h"
  44 #include "ffmpeg_content.h"
  45 #include "raw_image_proxy.h"
  46 #include "film.h"
  47 #include "timer.h"
  48
  49 #include "i18n.h"
  50
  51 #define LOG_GENERAL(...) _video_content->film()->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
  52 #define LOG_ERROR(...) _video_content->film()->log()->log (String::compose (__VA_ARGS__), Log::TYPE_ERROR);
  53 #define LOG_WARNING_NC(...) _video_content->film()->log()->log (__VA_ARGS__, Log::TYPE_WARNING);
  54 #define LOG_WARNING(...) _video_content->film()->log()->log (String::compose (__VA_ARGS__), Log::TYPE_WARNING);
  55
  56 using std::cout;
  57 using std::string;
  58 using std::vector;
  59 using std::list;
  60 using std::min;
  61 using std::pair;
  62 using std::make_pair;
  63 using boost::shared_ptr;
  64 using boost::optional;
  65 using boost::dynamic_pointer_cast;
  66 using dcp::Size;
  67
  68 FFmpegDecoder::FFmpegDecoder (shared_ptr<const FFmpegContent> c, shared_ptr<Log> log)
  69         : VideoDecoder (c)
  70         , AudioDecoder (c)
  71         , SubtitleDecoder (c)
  72         , FFmpeg (c)
  73         , _log (log)
  74 {
  75         /* Audio and video frame PTS values may not start with 0.  We want
  76            to fiddle them so that:
  77
  78            1.  One of them starts at time 0.
  79            2.  The first video PTS value ends up on a frame boundary.
  80
  81            Then we remove big initial gaps in PTS and we allow our
  82            insertion of black frames to work.
  83
  84            We will do pts_to_use = pts_from_ffmpeg + pts_offset;
  85         */
  86
  87         bool const have_video = c->first_video();
  88         bool const have_audio = c->audio_stream () && c->audio_stream()->first_audio;
  89
  90         /* First, make one of them start at 0 */
  91
  92         if (have_audio && have_video) {
  93                 _pts_offset = - min (c->first_video().get(), c->audio_stream()->first_audio.get());
  94         } else if (have_video) {
  95                 _pts_offset = - c->first_video().get();
  96         } else if (have_audio) {
  97                 _pts_offset = - c->audio_stream()->first_audio.get();
  98         }
  99
 100         /* Now adjust both so that the video pts starts on a frame */
 101         if (have_video && have_audio) {
 102                 ContentTime first_video = c->first_video().get() + _pts_offset;
 103                 ContentTime const old_first_video = first_video;
 104                 _pts_offset += first_video.round_up (c->video_frame_rate ()) - old_first_video;
 105         }
 106 }
 107
 108 void
 109 FFmpegDecoder::flush ()
 110 {
 111         /* Get any remaining frames */
 112
 113         _packet.data = 0;
 114         _packet.size = 0;
 115
 116         /* XXX: should we reset _packet.data and size after each *_decode_* call? */
 117
 118         while (decode_video_packet ()) {}
 119
 120         if (_ffmpeg_content->audio_stream()) {
 121                 decode_audio_packet ();
 122                 AudioDecoder::flush ();
 123         }
 124 }
 125
 126 bool
 127 FFmpegDecoder::pass ()
 128 {
 129         int r = av_read_frame (_format_context, &_packet);
 130
 131         if (r < 0) {
 132                 if (r != AVERROR_EOF) {
 133                         /* Maybe we should fail here, but for now we'll just finish off instead */
 134                         char buf[256];
 135                         av_strerror (r, buf, sizeof(buf));
 136                         LOG_ERROR (N_("error on av_read_frame (%1) (%2)"), buf, r);
 137                 }
 138
 139                 flush ();
 140                 return true;
 141         }
 142
 143         int const si = _packet.stream_index;
 144
 145         if (si == _video_stream) {
 146                 decode_video_packet ();
 147         } else if (_ffmpeg_content->audio_stream() && _ffmpeg_content->audio_stream()->uses_index (_format_context, si)) {
 148                 decode_audio_packet ();
 149         } else if (_ffmpeg_content->subtitle_stream() && _ffmpeg_content->subtitle_stream()->uses_index (_format_context, si)) {
 150                 decode_subtitle_packet ();
 151         }
 152
 153         av_free_packet (&_packet);
 154         return false;
 155 }
 156
 157 /** @param data pointer to array of pointers to buffers.
 158  *  Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
 159  */
 160 shared_ptr<AudioBuffers>
 161 FFmpegDecoder::deinterleave_audio (uint8_t** data, int size)
 162 {
 163         assert (_ffmpeg_content->audio_channels());
 164         assert (bytes_per_audio_sample());
 165
 166         /* Deinterleave and convert to float */
 167
 168         assert ((size % (bytes_per_audio_sample() * _ffmpeg_content->audio_channels())) == 0);
 169
 170         int const total_samples = size / bytes_per_audio_sample();
 171         int const frames = total_samples / _ffmpeg_content->audio_channels();
 172         shared_ptr<AudioBuffers> audio (new AudioBuffers (_ffmpeg_content->audio_channels(), frames));
 173
 174         switch (audio_sample_format()) {
 175         case AV_SAMPLE_FMT_U8:
 176         {
 177                 uint8_t* p = reinterpret_cast<uint8_t *> (data[0]);
 178                 int sample = 0;
 179                 int channel = 0;
 180                 for (int i = 0; i < total_samples; ++i) {
 181                         audio->data(channel)[sample] = float(*p++) / (1 << 23);
 182
 183                         ++channel;
 184                         if (channel == _ffmpeg_content->audio_channels()) {
 185                                 channel = 0;
 186                                 ++sample;
 187                         }
 188                 }
 189         }
 190         break;
 191
 192         case AV_SAMPLE_FMT_S16:
 193         {
 194                 int16_t* p = reinterpret_cast<int16_t *> (data[0]);
 195                 int sample = 0;
 196                 int channel = 0;
 197                 for (int i = 0; i < total_samples; ++i) {
 198                         audio->data(channel)[sample] = float(*p++) / (1 << 15);
 199
 200                         ++channel;
 201                         if (channel == _ffmpeg_content->audio_channels()) {
 202                                 channel = 0;
 203                                 ++sample;
 204                         }
 205                 }
 206         }
 207         break;
 208
 209         case AV_SAMPLE_FMT_S16P:
 210         {
 211                 int16_t** p = reinterpret_cast<int16_t **> (data);
 212                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 213                         for (int j = 0; j < frames; ++j) {
 214                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
 215                         }
 216                 }
 217         }
 218         break;
 219
 220         case AV_SAMPLE_FMT_S32:
 221         {
 222                 int32_t* p = reinterpret_cast<int32_t *> (data[0]);
 223                 int sample = 0;
 224                 int channel = 0;
 225                 for (int i = 0; i < total_samples; ++i) {
 226                         audio->data(channel)[sample] = static_cast<float>(*p++) / (1 << 31);
 227
 228                         ++channel;
 229                         if (channel == _ffmpeg_content->audio_channels()) {
 230                                 channel = 0;
 231                                 ++sample;
 232                         }
 233                 }
 234         }
 235         break;
 236
 237         case AV_SAMPLE_FMT_FLT:
 238         {
 239                 float* p = reinterpret_cast<float*> (data[0]);
 240                 int sample = 0;
 241                 int channel = 0;
 242                 for (int i = 0; i < total_samples; ++i) {
 243                         audio->data(channel)[sample] = *p++;
 244
 245                         ++channel;
 246                         if (channel == _ffmpeg_content->audio_channels()) {
 247                                 channel = 0;
 248                                 ++sample;
 249                         }
 250                 }
 251         }
 252         break;
 253
 254         case AV_SAMPLE_FMT_FLTP:
 255         {
 256                 float** p = reinterpret_cast<float**> (data);
 257                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 258                         memcpy (audio->data(i), p[i], frames * sizeof(float));
 259                 }
 260         }
 261         break;
 262
 263         default:
 264                 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format())));
 265         }
 266
 267         return audio;
 268 }
 269
 270 AVSampleFormat
 271 FFmpegDecoder::audio_sample_format () const
 272 {
 273         if (!_ffmpeg_content->audio_stream()) {
 274                 return (AVSampleFormat) 0;
 275         }
 276
 277         return audio_codec_context()->sample_fmt;
 278 }
 279
 280 int
 281 FFmpegDecoder::bytes_per_audio_sample () const
 282 {
 283         return av_get_bytes_per_sample (audio_sample_format ());
 284 }
 285
 286 void
 287 FFmpegDecoder::seek (ContentTime time, bool accurate)
 288 {
 289         VideoDecoder::seek (time, accurate);
 290         AudioDecoder::seek (time, accurate);
 291
 292         /* If we are doing an `accurate' seek, we need to use pre-roll, as
 293            we don't really know what the seek will give us.
 294         */
 295
 296         ContentTime pre_roll = accurate ? ContentTime::from_seconds (2) : ContentTime (0);
 297         time -= pre_roll;
 298
 299         /* XXX: it seems debatable whether PTS should be used here...
 300            http://www.mjbshaw.com/2012/04/seeking-in-ffmpeg-know-your-timestamp.html
 301         */
 302
 303         ContentTime const u = time - _pts_offset;
 304         int64_t s = u.seconds() / av_q2d (_format_context->streams[_video_stream]->time_base);
 305
 306         if (_ffmpeg_content->audio_stream ()) {
 307                 s = min (
 308                         s, int64_t (u.seconds() / av_q2d (_ffmpeg_content->audio_stream()->stream(_format_context)->time_base))
 309                         );
 310         }
 311
 312         av_seek_frame (_format_context, _video_stream, s, 0);
 313
 314         avcodec_flush_buffers (video_codec_context());
 315         if (audio_codec_context ()) {
 316                 avcodec_flush_buffers (audio_codec_context ());
 317         }
 318         if (subtitle_codec_context ()) {
 319                 avcodec_flush_buffers (subtitle_codec_context ());
 320         }
 321 }
 322
 323 void
 324 FFmpegDecoder::decode_audio_packet ()
 325 {
 326         /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
 327            several times.
 328         */
 329
 330         AVPacket copy_packet = _packet;
 331
 332         while (copy_packet.size > 0) {
 333
 334                 int frame_finished;
 335                 int decode_result = avcodec_decode_audio4 (audio_codec_context(), _frame, &frame_finished, &copy_packet);
 336                 if (decode_result < 0) {
 337                         /* avcodec_decode_audio4 can sometimes return an error even though it has decoded
 338                            some valid data; for example dca_subframe_footer can return AVERROR_INVALIDDATA
 339                            if it overreads the auxiliary data.  ffplay carries on if frame_finished is true,
 340                            even in the face of such an error, so I think we should too.
 341
 342                            Returning from the method here caused mantis #352.
 343                         */
 344                         LOG_WARNING ("avcodec_decode_audio4 failed (%1)", decode_result);
 345
 346                         /* Fudge decode_result so that we come out of the while loop when
 347                            we've processed this data.
 348                         */
 349                         decode_result = copy_packet.size;
 350                 }
 351
 352                 if (frame_finished) {
 353                         ContentTime const ct = ContentTime::from_seconds (
 354                                 av_frame_get_best_effort_timestamp (_frame) *
 355                                 av_q2d (_ffmpeg_content->audio_stream()->stream (_format_context)->time_base))
 356                                 + _pts_offset;
 357
 358                         int const data_size = av_samples_get_buffer_size (
 359                                 0, audio_codec_context()->channels, _frame->nb_samples, audio_sample_format (), 1
 360                                 );
 361
 362                         audio (deinterleave_audio (_frame->data, data_size), ct);
 363                 }
 364
 365                 copy_packet.data += decode_result;
 366                 copy_packet.size -= decode_result;
 367         }
 368 }
 369
 370 bool
 371 FFmpegDecoder::decode_video_packet ()
 372 {
 373         int frame_finished;
 374         if (avcodec_decode_video2 (video_codec_context(), _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
 375                 return false;
 376         }
 377
 378         boost::mutex::scoped_lock lm (_filter_graphs_mutex);
 379
 380         shared_ptr<FilterGraph> graph;
 381
 382         list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
 383         while (i != _filter_graphs.end() && !(*i)->can_process (dcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
 384                 ++i;
 385         }
 386
 387         if (i == _filter_graphs.end ()) {
 388                 graph.reset (new FilterGraph (_ffmpeg_content, dcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
 389                 _filter_graphs.push_back (graph);
 390                 LOG_GENERAL (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format);
 391         } else {
 392                 graph = *i;
 393         }
 394
 395         list<pair<shared_ptr<Image>, int64_t> > images = graph->process (_frame);
 396
 397         for (list<pair<shared_ptr<Image>, int64_t> >::iterator i = images.begin(); i != images.end(); ++i) {
 398
 399                 shared_ptr<Image> image = i->first;
 400
 401                 if (i->second != AV_NOPTS_VALUE) {
 402                         double const pts = i->second * av_q2d (_format_context->streams[_video_stream]->time_base) + _pts_offset.seconds ();
 403                         video (
 404                                 shared_ptr<ImageProxy> (new RawImageProxy (image, _video_content->film()->log())),
 405                                 rint (pts * _ffmpeg_content->video_frame_rate ())
 406                                 );
 407                 } else {
 408                         LOG_WARNING_NC ("Dropping frame without PTS");
 409                 }
 410         }
 411
 412         return true;
 413 }
 414
 415 void
 416 FFmpegDecoder::decode_subtitle_packet ()
 417 {
 418         int got_subtitle;
 419         AVSubtitle sub;
 420         if (avcodec_decode_subtitle2 (subtitle_codec_context(), &sub, &got_subtitle, &_packet) < 0 || !got_subtitle) {
 421                 return;
 422         }
 423
 424         /* Sometimes we get an empty AVSubtitle, which is used by some codecs to
 425            indicate that the previous subtitle should stop.
 426         */
 427         if (sub.num_rects <= 0) {
 428                 image_subtitle (ContentTimePeriod (), shared_ptr<Image> (), dcpomatic::Rect<double> ());
 429                 return;
 430         } else if (sub.num_rects > 1) {
 431                 throw DecodeError (_("multi-part subtitles not yet supported"));
 432         }
 433
 434         /* Subtitle PTS (within the source, not taking into account any of the
 435            source that we may have chopped off for the DCP)
 436         */
 437         ContentTimePeriod period = subtitle_period (sub) + _pts_offset;
 438
 439         AVSubtitleRect const * rect = sub.rects[0];
 440
 441         if (rect->type != SUBTITLE_BITMAP) {
 442                 /* XXX */
 443                 // throw DecodeError (_("non-bitmap subtitles not yet supported"));
 444                 return;
 445         }
 446
 447         /* Note RGBA is expressed little-endian, so the first byte in the word is R, second
 448            G, third B, fourth A.
 449         */
 450         shared_ptr<Image> image (new Image (PIX_FMT_RGBA, dcp::Size (rect->w, rect->h), true));
 451
 452         /* Start of the first line in the subtitle */
 453         uint8_t* sub_p = rect->pict.data[0];
 454         /* sub_p looks up into a BGRA palette which is here
 455            (i.e. first byte B, second G, third R, fourth A)
 456         */
 457         uint32_t const * palette = (uint32_t *) rect->pict.data[1];
 458         /* Start of the output data */
 459         uint32_t* out_p = (uint32_t *) image->data()[0];
 460
 461         for (int y = 0; y < rect->h; ++y) {
 462                 uint8_t* sub_line_p = sub_p;
 463                 uint32_t* out_line_p = out_p;
 464                 for (int x = 0; x < rect->w; ++x) {
 465                         uint32_t const p = palette[*sub_line_p++];
 466                         *out_line_p++ = ((p & 0xff) << 16) | (p & 0xff00) | ((p & 0xff0000) >> 16) | (p & 0xff000000);
 467                 }
 468                 sub_p += rect->pict.linesize[0];
 469                 out_p += image->stride()[0] / sizeof (uint32_t);
 470         }
 471
 472         dcp::Size const vs = _ffmpeg_content->video_size ();
 473
 474         image_subtitle (
 475                 period,
 476                 image,
 477                 dcpomatic::Rect<double> (
 478                         static_cast<double> (rect->x) / vs.width,
 479                         static_cast<double> (rect->y) / vs.height,
 480                         static_cast<double> (rect->w) / vs.width,
 481                         static_cast<double> (rect->h) / vs.height
 482                         )
 483                 );
 484
 485         avsubtitle_free (&sub);
 486 }
 487
 488 list<ContentTimePeriod>
 489 FFmpegDecoder::subtitles_during (ContentTimePeriod p, bool starting) const
 490 {
 491         return _ffmpeg_content->subtitles_during (p, starting);
 492 }