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