src/lib/ffmpeg_decoder.cc

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