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