src/lib/ffmpeg.cc

   1 /*
   2     Copyright (C) 2013-2019 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "ffmpeg.h"
  22 #include "ffmpeg_content.h"
  23 #include "film.h"
  24 #include "exceptions.h"
  25 #include "util.h"
  26 #include "log.h"
  27 #include "dcpomatic_log.h"
  28 #include "ffmpeg_subtitle_stream.h"
  29 #include "ffmpeg_audio_stream.h"
  30 #include "decrypted_ecinema_kdm.h"
  31 #include "digester.h"
  32 #include "compose.hpp"
  33 #include "config.h"
  34 #include <dcp/raw_convert.h>
  35 extern "C" {
  36 #include <libavcodec/avcodec.h>
  37 #include <libavformat/avformat.h>
  38 #include <libswscale/swscale.h>
  39 }
  40 #include <boost/algorithm/string.hpp>
  41 #include <boost/foreach.hpp>
  42 #include <iostream>
  43
  44 #include "i18n.h"
  45
  46 using std::string;
  47 using std::cout;
  48 using std::cerr;
  49 using std::vector;
  50 using boost::shared_ptr;
  51 using boost::optional;
  52 using dcp::raw_convert;
  53 using namespace dcpomatic;
  54
  55 boost::mutex FFmpeg::_mutex;
  56
  57 FFmpeg::FFmpeg (boost::shared_ptr<const FFmpegContent> c)
  58         : _ffmpeg_content (c)
  59         , _avio_buffer (0)
  60         , _avio_buffer_size (4096)
  61         , _avio_context (0)
  62         , _format_context (0)
  63         , _frame (0)
  64 {
  65         setup_general ();
  66         setup_decoders ();
  67 }
  68
  69 FFmpeg::~FFmpeg ()
  70 {
  71         boost::mutex::scoped_lock lm (_mutex);
  72
  73         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
  74                 avcodec_close (_format_context->streams[i]->codec);
  75         }
  76
  77         av_frame_free (&_frame);
  78         avformat_close_input (&_format_context);
  79 }
  80
  81 static int
  82 avio_read_wrapper (void* data, uint8_t* buffer, int amount)
  83 {
  84         return reinterpret_cast<FFmpeg*>(data)->avio_read (buffer, amount);
  85 }
  86
  87 static int64_t
  88 avio_seek_wrapper (void* data, int64_t offset, int whence)
  89 {
  90         return reinterpret_cast<FFmpeg*>(data)->avio_seek (offset, whence);
  91 }
  92
  93 void
  94 FFmpeg::ffmpeg_log_callback (void* ptr, int level, const char* fmt, va_list vl)
  95 {
  96         if (level > AV_LOG_WARNING) {
  97                 return;
  98         }
  99
 100         char line[1024];
 101         static int prefix = 0;
 102         av_log_format_line (ptr, level, fmt, vl, line, sizeof (line), &prefix);
 103         string str (line);
 104         boost::algorithm::trim (str);
 105         dcpomatic_log->log (String::compose ("FFmpeg: %1", str), LogEntry::TYPE_GENERAL);
 106 }
 107
 108 void
 109 FFmpeg::setup_general ()
 110 {
 111         /* This might not work too well in some cases of multiple FFmpeg decoders,
 112            but it's probably good enough.
 113         */
 114         av_log_set_callback (FFmpeg::ffmpeg_log_callback);
 115
 116         _file_group.set_paths (_ffmpeg_content->paths ());
 117         _avio_buffer = static_cast<uint8_t*> (wrapped_av_malloc (_avio_buffer_size));
 118         _avio_context = avio_alloc_context (_avio_buffer, _avio_buffer_size, 0, this, avio_read_wrapper, 0, avio_seek_wrapper);
 119         _format_context = avformat_alloc_context ();
 120         _format_context->pb = _avio_context;
 121
 122         AVDictionary* options = 0;
 123 #ifdef DCPOMATIC_VARIANT_SWAROOP
 124         if (_ffmpeg_content->kdm()) {
 125                 DecryptedECinemaKDM kdm (_ffmpeg_content->kdm().get(), Config::instance()->decryption_chain()->key().get());
 126                 av_dict_set (&options, "decryption_key", kdm.key().hex().c_str(), 0);
 127         }
 128 #endif
 129
 130         int e = avformat_open_input (&_format_context, 0, 0, &options);
 131         if (e < 0) {
 132                 throw OpenFileError (_ffmpeg_content->path(0).string(), e, OpenFileError::READ);
 133         }
 134
 135         if (avformat_find_stream_info (_format_context, 0) < 0) {
 136                 throw DecodeError (_("could not find stream information"));
 137         }
 138
 139         /* Find video stream */
 140
 141         optional<int> video_stream_undefined_frame_rate;
 142
 143         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 144                 AVStream* s = _format_context->streams[i];
 145                 if (s->codec->codec_type == AVMEDIA_TYPE_VIDEO && avcodec_find_decoder(s->codec->codec_id)) {
 146                         if (s->avg_frame_rate.num > 0 && s->avg_frame_rate.den > 0) {
 147                                 /* This is definitely our video stream */
 148                                 _video_stream = i;
 149                         } else {
 150                                 /* This is our video stream if we don't get a better offer */
 151                                 video_stream_undefined_frame_rate = i;
 152                         }
 153                 }
 154         }
 155
 156         /* Files from iTunes sometimes have two video streams, one with the avg_frame_rate.num and .den set
 157            to zero.  Only use such a stream if there is no alternative.
 158         */
 159         if (!_video_stream && video_stream_undefined_frame_rate) {
 160                 _video_stream = video_stream_undefined_frame_rate.get();
 161         }
 162
 163         /* Ignore video streams with crazy frame rates.  These are usually things like album art on MP3s. */
 164         if (_video_stream && av_q2d(av_guess_frame_rate(_format_context, _format_context->streams[_video_stream.get()], 0)) > 1000) {
 165                 _video_stream = optional<int>();
 166         }
 167
 168         /* Hack: if the AVStreams have duplicate IDs, replace them with our
 169            own.  We use the IDs so that we can cope with VOBs, in which streams
 170            move about in index but remain with the same ID in different
 171            VOBs.  However, some files have duplicate IDs, hence this hack.
 172         */
 173
 174         bool duplicates = false;
 175         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 176                 for (uint32_t j = i + 1; j < _format_context->nb_streams; ++j) {
 177                         if (_format_context->streams[i]->id == _format_context->streams[j]->id) {
 178                                 duplicates = true;
 179                         }
 180                 }
 181         }
 182
 183         if (duplicates) {
 184                 /* Put in our own IDs */
 185                 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 186                         _format_context->streams[i]->id = i;
 187                 }
 188         }
 189
 190         _frame = av_frame_alloc ();
 191         if (_frame == 0) {
 192                 throw DecodeError (N_("could not allocate frame"));
 193         }
 194 }
 195
 196 void
 197 FFmpeg::setup_decoders ()
 198 {
 199         boost::mutex::scoped_lock lm (_mutex);
 200
 201         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 202                 AVCodecContext* context = _format_context->streams[i]->codec;
 203
 204                 AVCodec* codec = avcodec_find_decoder (context->codec_id);
 205                 if (codec) {
 206
 207                         AVDictionary* options = 0;
 208                         /* This option disables decoding of DCA frame footers in our patched version
 209                            of FFmpeg.  I believe these footers are of no use to us, and they can cause
 210                            problems when FFmpeg fails to decode them (mantis #352).
 211                         */
 212                         av_dict_set (&options, "disable_footer", "1", 0);
 213                         /* This allows decoding of some DNxHR 444 and HQX files; see
 214                            https://trac.ffmpeg.org/ticket/5681
 215                         */
 216                         av_dict_set_int (&options, "strict", FF_COMPLIANCE_EXPERIMENTAL, 0);
 217                         /* Enable following of links in files */
 218                         av_dict_set_int (&options, "enable_drefs", 1, 0);
 219
 220                         if (avcodec_open2 (context, codec, &options) < 0) {
 221                                 throw DecodeError (N_("could not open decoder"));
 222                         }
 223                 } else {
 224                         dcpomatic_log->log (String::compose ("No codec found for stream %1", i), LogEntry::TYPE_WARNING);
 225                 }
 226         }
 227 }
 228
 229 AVCodecContext *
 230 FFmpeg::video_codec_context () const
 231 {
 232         if (!_video_stream) {
 233                 return 0;
 234         }
 235
 236         return _format_context->streams[_video_stream.get()]->codec;
 237 }
 238
 239 AVCodecContext *
 240 FFmpeg::subtitle_codec_context () const
 241 {
 242         if (!_ffmpeg_content->subtitle_stream ()) {
 243                 return 0;
 244         }
 245
 246         return _ffmpeg_content->subtitle_stream()->stream(_format_context)->codec;
 247 }
 248
 249 int
 250 FFmpeg::avio_read (uint8_t* buffer, int const amount)
 251 {
 252         return _file_group.read (buffer, amount);
 253 }
 254
 255 int64_t
 256 FFmpeg::avio_seek (int64_t const pos, int whence)
 257 {
 258         if (whence == AVSEEK_SIZE) {
 259                 return _file_group.length ();
 260         }
 261
 262         return _file_group.seek (pos, whence);
 263 }
 264
 265 FFmpegSubtitlePeriod
 266 FFmpeg::subtitle_period (AVSubtitle const & sub)
 267 {
 268         ContentTime const packet_time = ContentTime::from_seconds (static_cast<double> (sub.pts) / AV_TIME_BASE);
 269
 270         if (sub.end_display_time == static_cast<uint32_t> (-1)) {
 271                 /* End time is not known */
 272                 return FFmpegSubtitlePeriod (packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3));
 273         }
 274
 275         return FFmpegSubtitlePeriod (
 276                 packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3),
 277                 packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3)
 278                 );
 279 }
 280
 281 /** Compute the pts offset to use given a set of audio streams and some video details.
 282  *  Sometimes these parameters will have just been determined by an Examiner, sometimes
 283  *  they will have been retrieved from a piece of Content, hence the need for this method
 284  *  in FFmpeg.
 285  */
 286 ContentTime
 287 FFmpeg::pts_offset (vector<shared_ptr<FFmpegAudioStream> > audio_streams, optional<ContentTime> first_video, double video_frame_rate) const
 288 {
 289         /* Audio and video frame PTS values may not start with 0.  We want
 290            to fiddle them so that:
 291
 292            1.  One of them starts at time 0.
 293            2.  The first video PTS value ends up on a frame boundary.
 294
 295            Then we remove big initial gaps in PTS and we allow our
 296            insertion of black frames to work.
 297
 298            We will do:
 299              audio_pts_to_use = audio_pts_from_ffmpeg + pts_offset;
 300              video_pts_to_use = video_pts_from_ffmpeg + pts_offset;
 301         */
 302
 303         /* First, make one of them start at 0 */
 304
 305         ContentTime po = ContentTime::min ();
 306
 307         if (first_video) {
 308                 po = - first_video.get ();
 309         }
 310
 311         BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, audio_streams) {
 312                 if (i->first_audio) {
 313                         po = max (po, - i->first_audio.get ());
 314                 }
 315         }
 316
 317         /* If the offset is positive we would be pushing things from a -ve PTS to be played.
 318            I don't think we ever want to do that, as it seems things at -ve PTS are not meant
 319            to be seen (use for alignment bars etc.); see mantis #418.
 320         */
 321         if (po > ContentTime ()) {
 322                 po = ContentTime ();
 323         }
 324
 325         /* Now adjust so that the video pts starts on a frame */
 326         if (first_video) {
 327                 ContentTime const fvc = first_video.get() + po;
 328                 po += fvc.ceil (video_frame_rate) - fvc;
 329         }
 330
 331         return po;
 332 }