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 #include <sndfile.h>
  32 extern "C" {
  33 #include <libavcodec/avcodec.h>
  34 #include <libavformat/avformat.h>
  35 }
  36 #include "film.h"
  37 #include "filter.h"
  38 #include "exceptions.h"
  39 #include "image.h"
  40 #include "util.h"
  41 #include "log.h"
  42 #include "ffmpeg_decoder.h"
  43 #include "filter_graph.h"
  44 #include "audio_buffers.h"
  45
  46 #include "i18n.h"
  47
  48 using std::cout;
  49 using std::string;
  50 using std::vector;
  51 using std::stringstream;
  52 using std::list;
  53 using std::min;
  54 using std::pair;
  55 using boost::shared_ptr;
  56 using boost::optional;
  57 using boost::dynamic_pointer_cast;
  58 using libdcp::Size;
  59
  60 FFmpegDecoder::FFmpegDecoder (shared_ptr<const Film> f, shared_ptr<const FFmpegContent> c, bool video, bool audio)
  61         : Decoder (f)
  62         , VideoDecoder (f, c)
  63         , AudioDecoder (f, c)
  64         , SubtitleDecoder (f)
  65         , FFmpeg (c)
  66         , _subtitle_codec_context (0)
  67         , _subtitle_codec (0)
  68         , _decode_video (video)
  69         , _decode_audio (audio)
  70         , _video_pts_offset (0)
  71         , _audio_pts_offset (0)
  72         , _just_sought (false)
  73 {
  74         setup_subtitle ();
  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:
  86              audio_pts_to_use = audio_pts_from_ffmpeg + audio_pts_offset;
  87              video_pts_to_use = video_pts_from_ffmpeg + video_pts_offset;
  88         */
  89
  90         bool const have_video = video && c->first_video();
  91         bool const have_audio = audio && c->audio_stream() && c->audio_stream()->first_audio;
  92
  93         /* First, make one of them start at 0 */
  94
  95         if (have_audio && have_video) {
  96                 _video_pts_offset = _audio_pts_offset = - min (c->first_video().get(), c->audio_stream()->first_audio.get());
  97         } else if (have_video) {
  98                 _video_pts_offset = - c->first_video().get();
  99         }
 100
 101         /* Now adjust both so that the video pts starts on a frame */
 102         if (have_video && have_audio) {
 103                 double first_video = c->first_video().get() + _video_pts_offset;
 104                 double const old_first_video = first_video;
 105
 106                 /* Round the first video up to a frame boundary */
 107                 if (fabs (rint (first_video * c->video_frame_rate()) - first_video * c->video_frame_rate()) > 1e-6) {
 108                         first_video = ceil (first_video * c->video_frame_rate()) / c->video_frame_rate ();
 109                 }
 110
 111                 _video_pts_offset += first_video - old_first_video;
 112                 _audio_pts_offset += first_video - old_first_video;
 113         }
 114 }
 115
 116 FFmpegDecoder::~FFmpegDecoder ()
 117 {
 118         boost::mutex::scoped_lock lm (_mutex);
 119
 120         if (_subtitle_codec_context) {
 121                 avcodec_close (_subtitle_codec_context);
 122         }
 123 }
 124
 125 void
 126 FFmpegDecoder::flush ()
 127 {
 128         /* Get any remaining frames */
 129
 130         _packet.data = 0;
 131         _packet.size = 0;
 132
 133         /* XXX: should we reset _packet.data and size after each *_decode_* call? */
 134
 135         if (_decode_video) {
 136                 while (decode_video_packet ()) {}
 137         }
 138
 139         if (_ffmpeg_content->audio_stream() && _decode_audio) {
 140                 decode_audio_packet ();
 141         }
 142
 143         AudioDecoder::flush ();
 144
 145         /* Stop us being asked for any more data */
 146         _video_position = _ffmpeg_content->video_length ();
 147         _audio_position = _ffmpeg_content->audio_length ();
 148 }
 149
 150 void
 151 FFmpegDecoder::pass ()
 152 {
 153         int r = av_read_frame (_format_context, &_packet);
 154
 155         if (r < 0) {
 156                 if (r != AVERROR_EOF) {
 157                         /* Maybe we should fail here, but for now we'll just finish off instead */
 158                         char buf[256];
 159                         av_strerror (r, buf, sizeof(buf));
 160                         shared_ptr<const Film> film = _film.lock ();
 161                         assert (film);
 162                         film->log()->log (String::compose (N_("error on av_read_frame (%1) (%2)"), buf, r));
 163                 }
 164
 165                 flush ();
 166                 return;
 167         }
 168
 169         avcodec_get_frame_defaults (_frame);
 170
 171         if (_packet.stream_index == _video_stream && _decode_video) {
 172                 decode_video_packet ();
 173         } else if (_ffmpeg_content->audio_stream() && _packet.stream_index == _ffmpeg_content->audio_stream()->id && _decode_audio) {
 174                 decode_audio_packet ();
 175         } else if (_ffmpeg_content->subtitle_stream() && _packet.stream_index == _ffmpeg_content->subtitle_stream()->id) {
 176                 decode_subtitle_packet ();
 177         }
 178
 179         av_free_packet (&_packet);
 180 }
 181
 182 /** @param data pointer to array of pointers to buffers.
 183  *  Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
 184  */
 185 shared_ptr<AudioBuffers>
 186 FFmpegDecoder::deinterleave_audio (uint8_t** data, int size)
 187 {
 188         assert (_ffmpeg_content->audio_channels());
 189         assert (bytes_per_audio_sample());
 190
 191         /* Deinterleave and convert to float */
 192
 193         assert ((size % (bytes_per_audio_sample() * _ffmpeg_content->audio_channels())) == 0);
 194
 195         int const total_samples = size / bytes_per_audio_sample();
 196         int const frames = total_samples / _ffmpeg_content->audio_channels();
 197         shared_ptr<AudioBuffers> audio (new AudioBuffers (_ffmpeg_content->audio_channels(), frames));
 198
 199         switch (audio_sample_format()) {
 200         case AV_SAMPLE_FMT_S16:
 201         {
 202                 int16_t* p = reinterpret_cast<int16_t *> (data[0]);
 203                 int sample = 0;
 204                 int channel = 0;
 205                 for (int i = 0; i < total_samples; ++i) {
 206                         audio->data(channel)[sample] = float(*p++) / (1 << 15);
 207
 208                         ++channel;
 209                         if (channel == _ffmpeg_content->audio_channels()) {
 210                                 channel = 0;
 211                                 ++sample;
 212                         }
 213                 }
 214         }
 215         break;
 216
 217         case AV_SAMPLE_FMT_S16P:
 218         {
 219                 int16_t** p = reinterpret_cast<int16_t **> (data);
 220                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 221                         for (int j = 0; j < frames; ++j) {
 222                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
 223                         }
 224                 }
 225         }
 226         break;
 227
 228         case AV_SAMPLE_FMT_S32:
 229         {
 230                 int32_t* p = reinterpret_cast<int32_t *> (data[0]);
 231                 int sample = 0;
 232                 int channel = 0;
 233                 for (int i = 0; i < total_samples; ++i) {
 234                         audio->data(channel)[sample] = static_cast<float>(*p++) / (1 << 31);
 235
 236                         ++channel;
 237                         if (channel == _ffmpeg_content->audio_channels()) {
 238                                 channel = 0;
 239                                 ++sample;
 240                         }
 241                 }
 242         }
 243         break;
 244
 245         case AV_SAMPLE_FMT_FLT:
 246         {
 247                 float* p = reinterpret_cast<float*> (data[0]);
 248                 int sample = 0;
 249                 int channel = 0;
 250                 for (int i = 0; i < total_samples; ++i) {
 251                         audio->data(channel)[sample] = *p++;
 252
 253                         ++channel;
 254                         if (channel == _ffmpeg_content->audio_channels()) {
 255                                 channel = 0;
 256                                 ++sample;
 257                         }
 258                 }
 259         }
 260         break;
 261
 262         case AV_SAMPLE_FMT_FLTP:
 263         {
 264                 float** p = reinterpret_cast<float**> (data);
 265                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
 266                         memcpy (audio->data(i), p[i], frames * sizeof(float));
 267                 }
 268         }
 269         break;
 270
 271         default:
 272                 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format())));
 273         }
 274
 275         return audio;
 276 }
 277
 278 AVSampleFormat
 279 FFmpegDecoder::audio_sample_format () const
 280 {
 281         if (!_ffmpeg_content->audio_stream()) {
 282                 return (AVSampleFormat) 0;
 283         }
 284
 285         return audio_codec_context()->sample_fmt;
 286 }
 287
 288 int
 289 FFmpegDecoder::bytes_per_audio_sample () const
 290 {
 291         return av_get_bytes_per_sample (audio_sample_format ());
 292 }
 293
 294 void
 295 FFmpegDecoder::seek (VideoContent::Frame frame, bool accurate)
 296 {
 297         double const time_base = av_q2d (_format_context->streams[_video_stream]->time_base);
 298
 299         /* If we are doing an accurate seek, our initial shot will be 5 frames (5 being
 300            a number plucked from the air) earlier than we want to end up.  The loop below
 301            will hopefully then step through to where we want to be.
 302         */
 303         int initial = frame;
 304
 305         if (accurate) {
 306                 initial -= 5;
 307         }
 308
 309         if (initial < 0) {
 310                 initial = 0;
 311         }
 312
 313         /* Initial seek time in the stream's timebase */
 314         int64_t const initial_vt = ((initial / _ffmpeg_content->video_frame_rate()) - _video_pts_offset) / time_base;
 315
 316         av_seek_frame (_format_context, _video_stream, initial_vt, AVSEEK_FLAG_BACKWARD);
 317
 318         avcodec_flush_buffers (video_codec_context());
 319         if (_subtitle_codec_context) {
 320                 avcodec_flush_buffers (_subtitle_codec_context);
 321         }
 322
 323         _just_sought = true;
 324         _video_position = frame;
 325
 326         if (frame == 0 || !accurate) {
 327                 /* We're already there, or we're as close as we need to be */
 328                 return;
 329         }
 330
 331         while (1) {
 332                 int r = av_read_frame (_format_context, &_packet);
 333                 if (r < 0) {
 334                         return;
 335                 }
 336
 337                 if (_packet.stream_index != _video_stream) {
 338                         continue;
 339                 }
 340
 341                 avcodec_get_frame_defaults (_frame);
 342
 343                 int finished = 0;
 344                 r = avcodec_decode_video2 (video_codec_context(), _frame, &finished, &_packet);
 345                 if (r >= 0 && finished) {
 346                         _video_position = rint (
 347                                 (av_frame_get_best_effort_timestamp (_frame) * time_base + _video_pts_offset) * _ffmpeg_content->video_frame_rate()
 348                                 );
 349
 350                         if (_video_position >= (frame - 1)) {
 351                                 av_free_packet (&_packet);
 352                                 break;
 353                         }
 354                 }
 355
 356                 av_free_packet (&_packet);
 357         }
 358 }
 359
 360 void
 361 FFmpegDecoder::decode_audio_packet ()
 362 {
 363         /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
 364            several times.
 365         */
 366
 367         AVPacket copy_packet = _packet;
 368
 369         while (copy_packet.size > 0) {
 370
 371                 int frame_finished;
 372                 int const decode_result = avcodec_decode_audio4 (audio_codec_context(), _frame, &frame_finished, &copy_packet);
 373                 if (decode_result >= 0) {
 374                         if (frame_finished) {
 375
 376                                 if (_audio_position == 0) {
 377                                         /* Where we are in the source, in seconds */
 378                                         double const pts = av_q2d (_format_context->streams[copy_packet.stream_index]->time_base)
 379                                                 * av_frame_get_best_effort_timestamp(_frame) + _audio_pts_offset;
 380
 381                                         if (pts > 0) {
 382                                                 /* Emit some silence */
 383                                                 shared_ptr<AudioBuffers> silence (
 384                                                         new AudioBuffers (
 385                                                                 _ffmpeg_content->audio_channels(),
 386                                                                 pts * _ffmpeg_content->content_audio_frame_rate()
 387                                                                 )
 388                                                         );
 389
 390                                                 silence->make_silent ();
 391                                                 audio (silence, _audio_position);
 392                                         }
 393                                 }
 394
 395                                 int const data_size = av_samples_get_buffer_size (
 396                                         0, audio_codec_context()->channels, _frame->nb_samples, audio_sample_format (), 1
 397                                         );
 398
 399                                 audio (deinterleave_audio (_frame->data, data_size), _audio_position);
 400
 401                                 copy_packet.data += decode_result;
 402                                 copy_packet.size -= decode_result;
 403                         }
 404                 }
 405         }
 406 }
 407
 408 bool
 409 FFmpegDecoder::decode_video_packet ()
 410 {
 411         int frame_finished;
 412         if (avcodec_decode_video2 (video_codec_context(), _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
 413                 return false;
 414         }
 415
 416         boost::mutex::scoped_lock lm (_filter_graphs_mutex);
 417
 418         shared_ptr<FilterGraph> graph;
 419
 420         list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
 421         while (i != _filter_graphs.end() && !(*i)->can_process (libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
 422                 ++i;
 423         }
 424
 425         if (i == _filter_graphs.end ()) {
 426                 shared_ptr<const Film> film = _film.lock ();
 427                 assert (film);
 428
 429                 graph.reset (new FilterGraph (_ffmpeg_content, libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
 430                 _filter_graphs.push_back (graph);
 431
 432                 film->log()->log (String::compose (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format));
 433         } else {
 434                 graph = *i;
 435         }
 436
 437         list<pair<shared_ptr<Image>, int64_t> > images = graph->process (_frame);
 438
 439         string post_process = Filter::ffmpeg_strings (_ffmpeg_content->filters()).second;
 440
 441         for (list<pair<shared_ptr<Image>, int64_t> >::iterator i = images.begin(); i != images.end(); ++i) {
 442
 443                 shared_ptr<Image> image = i->first;
 444                 if (!post_process.empty ()) {
 445                         image = image->post_process (post_process, true);
 446                 }
 447
 448                 if (i->second != AV_NOPTS_VALUE) {
 449
 450                         double const pts = i->second * av_q2d (_format_context->streams[_video_stream]->time_base) + _video_pts_offset;
 451
 452                         if (_just_sought) {
 453                                 /* We just did a seek, so disable any attempts to correct for where we
 454                                    are / should be.
 455                                 */
 456                                 _video_position = rint (pts * _ffmpeg_content->video_frame_rate ());
 457                                 _just_sought = false;
 458                         }
 459
 460                         double const next = _video_position / _ffmpeg_content->video_frame_rate();
 461                         double const one_frame = 1 / _ffmpeg_content->video_frame_rate ();
 462                         double delta = pts - next;
 463
 464                         while (delta > one_frame) {
 465                                 /* This PTS is more than one frame forward in time of where we think we should be; emit
 466                                    a black frame.
 467                                 */
 468
 469                                 /* XXX: I think this should be a copy of the last frame... */
 470                                 boost::shared_ptr<Image> black (
 471                                         new Image (
 472                                                 static_cast<AVPixelFormat> (_frame->format),
 473                                                 libdcp::Size (video_codec_context()->width, video_codec_context()->height),
 474                                                 true
 475                                                 )
 476                                         );
 477
 478                                 black->make_black ();
 479                                 video (image, false, _video_position);
 480                                 delta -= one_frame;
 481                         }
 482
 483                         if (delta > -one_frame) {
 484                                 /* This PTS is within a frame of being right; emit this (otherwise it will be dropped) */
 485                                 video (image, false, _video_position);
 486                         }
 487
 488                 } else {
 489                         shared_ptr<const Film> film = _film.lock ();
 490                         assert (film);
 491                         film->log()->log ("Dropping frame without PTS");
 492                 }
 493         }
 494
 495         return true;
 496 }
 497
 498
 499 void
 500 FFmpegDecoder::setup_subtitle ()
 501 {
 502         boost::mutex::scoped_lock lm (_mutex);
 503
 504         if (!_ffmpeg_content->subtitle_stream() || _ffmpeg_content->subtitle_stream()->id >= int (_format_context->nb_streams)) {
 505                 return;
 506         }
 507
 508         _subtitle_codec_context = _format_context->streams[_ffmpeg_content->subtitle_stream()->id]->codec;
 509         _subtitle_codec = avcodec_find_decoder (_subtitle_codec_context->codec_id);
 510
 511         if (_subtitle_codec == 0) {
 512                 throw DecodeError (_("could not find subtitle decoder"));
 513         }
 514
 515         if (avcodec_open2 (_subtitle_codec_context, _subtitle_codec, 0) < 0) {
 516                 throw DecodeError (N_("could not open subtitle decoder"));
 517         }
 518 }
 519
 520 bool
 521 FFmpegDecoder::done () const
 522 {
 523         bool const vd = !_decode_video || (_video_position >= _ffmpeg_content->video_length());
 524         bool const ad = !_decode_audio || !_ffmpeg_content->audio_stream() || (_audio_position >= _ffmpeg_content->audio_length());
 525         return vd && ad;
 526 }
 527
 528 void
 529 FFmpegDecoder::decode_subtitle_packet ()
 530 {
 531         int got_subtitle;
 532         AVSubtitle sub;
 533         if (avcodec_decode_subtitle2 (_subtitle_codec_context, &sub, &got_subtitle, &_packet) < 0 || !got_subtitle) {
 534                 return;
 535         }
 536
 537         /* Sometimes we get an empty AVSubtitle, which is used by some codecs to
 538            indicate that the previous subtitle should stop.
 539         */
 540         if (sub.num_rects <= 0) {
 541                 subtitle (shared_ptr<Image> (), dcpomatic::Rect<double> (), 0, 0);
 542                 return;
 543         } else if (sub.num_rects > 1) {
 544                 throw DecodeError (_("multi-part subtitles not yet supported"));
 545         }
 546
 547         /* Subtitle PTS in seconds (within the source, not taking into account any of the
 548            source that we may have chopped off for the DCP)
 549         */
 550         double const packet_time = static_cast<double> (sub.pts) / AV_TIME_BASE;
 551
 552         /* hence start time for this sub */
 553         Time const from = (packet_time + (double (sub.start_display_time) / 1e3)) * TIME_HZ;
 554         Time const to = (packet_time + (double (sub.end_display_time) / 1e3)) * TIME_HZ;
 555
 556         AVSubtitleRect const * rect = sub.rects[0];
 557
 558         if (rect->type != SUBTITLE_BITMAP) {
 559                 throw DecodeError (_("non-bitmap subtitles not yet supported"));
 560         }
 561
 562         shared_ptr<Image> image (new Image (PIX_FMT_RGBA, libdcp::Size (rect->w, rect->h), true));
 563
 564         /* Start of the first line in the subtitle */
 565         uint8_t* sub_p = rect->pict.data[0];
 566         /* sub_p looks up into a RGB palette which is here */
 567         uint32_t const * palette = (uint32_t *) rect->pict.data[1];
 568         /* Start of the output data */
 569         uint32_t* out_p = (uint32_t *) image->data()[0];
 570
 571         for (int y = 0; y < rect->h; ++y) {
 572                 uint8_t* sub_line_p = sub_p;
 573                 uint32_t* out_line_p = out_p;
 574                 for (int x = 0; x < rect->w; ++x) {
 575                         *out_line_p++ = palette[*sub_line_p++];
 576                 }
 577                 sub_p += rect->pict.linesize[0];
 578                 out_p += image->stride()[0] / sizeof (uint32_t);
 579         }
 580
 581         libdcp::Size const vs = _ffmpeg_content->video_size ();
 582
 583         subtitle (
 584                 image,
 585                 dcpomatic::Rect<double> (
 586                         static_cast<double> (rect->x) / vs.width,
 587                         static_cast<double> (rect->y) / vs.height,
 588                         static_cast<double> (rect->w) / vs.width,
 589                         static_cast<double> (rect->h) / vs.height
 590                         ),
 591                 from,
 592                 to
 593                 );
 594
 595
 596         avsubtitle_free (&sub);
 597 }