src/lib/ffmpeg.cc

   1 /*
   2     Copyright (C) 2013-2021 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
  22 #include "compose.hpp"
  23 #include "config.h"
  24 #include "dcpomatic_log.h"
  25 #include "digester.h"
  26 #include "exceptions.h"
  27 #include "ffmpeg.h"
  28 #include "ffmpeg_audio_stream.h"
  29 #include "ffmpeg_content.h"
  30 #include "ffmpeg_subtitle_stream.h"
  31 #include "film.h"
  32 #include "log.h"
  33 #include "memory_util.h"
  34 #include "util.h"
  35 #include <dcp/raw_convert.h>
  36 extern "C" {
  37 #include <libavcodec/avcodec.h>
  38 #include <libavformat/avformat.h>
  39 #include <libswscale/swscale.h>
  40 }
  41 #include <boost/algorithm/string.hpp>
  42 #include <iostream>
  43
  44 #include "i18n.h"
  45
  46
  47 using std::string;
  48 using std::cout;
  49 using std::cerr;
  50 using std::vector;
  51 using std::shared_ptr;
  52 using boost::optional;
  53 using dcp::raw_convert;
  54 using namespace dcpomatic;
  55
  56
  57 boost::mutex FFmpeg::_mutex;
  58
  59
  60 FFmpeg::FFmpeg (std::shared_ptr<const FFmpegContent> c)
  61         : _ffmpeg_content (c)
  62 {
  63         setup_general ();
  64         setup_decoders ();
  65 }
  66
  67
  68 FFmpeg::~FFmpeg ()
  69 {
  70         boost::mutex::scoped_lock lm (_mutex);
  71
  72         for (auto& i: _codec_context) {
  73                 avcodec_free_context (&i);
  74         }
  75
  76         av_frame_free (&_video_frame);
  77         for (auto& audio_frame: _audio_frame) {
  78                 av_frame_free (&audio_frame.second);
  79         }
  80
  81         avformat_close_input (&_format_context);
  82 }
  83
  84
  85 static int
  86 avio_read_wrapper (void* data, uint8_t* buffer, int amount)
  87 {
  88         return reinterpret_cast<FFmpeg*>(data)->avio_read (buffer, amount);
  89 }
  90
  91
  92 static int64_t
  93 avio_seek_wrapper (void* data, int64_t offset, int whence)
  94 {
  95         return reinterpret_cast<FFmpeg*>(data)->avio_seek (offset, whence);
  96 }
  97
  98
  99 void
 100 FFmpeg::ffmpeg_log_callback (void* ptr, int level, const char* fmt, va_list vl)
 101 {
 102         if (level > AV_LOG_WARNING) {
 103                 return;
 104         }
 105
 106         char line[1024];
 107         static int prefix = 0;
 108         av_log_format_line (ptr, level, fmt, vl, line, sizeof (line), &prefix);
 109         string str (line);
 110         boost::algorithm::trim (str);
 111         dcpomatic_log->log (String::compose ("FFmpeg: %1", str), LogEntry::TYPE_GENERAL);
 112 }
 113
 114
 115 void
 116 FFmpeg::setup_general ()
 117 {
 118         /* This might not work too well in some cases of multiple FFmpeg decoders,
 119            but it's probably good enough.
 120         */
 121         av_log_set_callback (FFmpeg::ffmpeg_log_callback);
 122
 123         _file_group.set_paths (_ffmpeg_content->paths ());
 124         _avio_buffer = static_cast<uint8_t*> (wrapped_av_malloc(_avio_buffer_size));
 125         _avio_context = avio_alloc_context (_avio_buffer, _avio_buffer_size, 0, this, avio_read_wrapper, 0, avio_seek_wrapper);
 126         if (!_avio_context) {
 127                 throw std::bad_alloc ();
 128         }
 129         _format_context = avformat_alloc_context ();
 130         if (!_format_context) {
 131                 throw std::bad_alloc ();
 132         }
 133         _format_context->pb = _avio_context;
 134
 135         AVDictionary* options = nullptr;
 136         int e = avformat_open_input (&_format_context, 0, 0, &options);
 137         if (e < 0) {
 138                 throw OpenFileError (_ffmpeg_content->path(0).string(), e, OpenFileError::READ);
 139         }
 140
 141         if (avformat_find_stream_info (_format_context, 0) < 0) {
 142                 throw DecodeError (_("could not find stream information"));
 143         }
 144
 145         /* Find video stream */
 146
 147         optional<int> video_stream_undefined_frame_rate;
 148
 149         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 150                 auto s = _format_context->streams[i];
 151                 if (s->codecpar->codec_type == AVMEDIA_TYPE_VIDEO && avcodec_find_decoder(s->codecpar->codec_id)) {
 152                         auto const frame_rate = av_q2d(s->avg_frame_rate);
 153                         if (frame_rate < 1 || frame_rate > 1000) {
 154                                 /* Ignore video streams with crazy frame rates.  These are usually things like album art on MP3s. */
 155                                 continue;
 156                         }
 157                         if (s->avg_frame_rate.num > 0 && s->avg_frame_rate.den > 0) {
 158                                 /* This is definitely our video stream */
 159                                 _video_stream = i;
 160                         } else {
 161                                 /* This is our video stream if we don't get a better offer */
 162                                 video_stream_undefined_frame_rate = i;
 163                         }
 164                 }
 165         }
 166
 167         /* Files from iTunes sometimes have two video streams, one with the avg_frame_rate.num and .den set
 168            to zero.  Only use such a stream if there is no alternative.
 169         */
 170         if (!_video_stream && video_stream_undefined_frame_rate) {
 171                 _video_stream = video_stream_undefined_frame_rate.get();
 172         }
 173
 174         /* Hack: if the AVStreams have duplicate IDs, replace them with our
 175            own.  We use the IDs so that we can cope with VOBs, in which streams
 176            move about in index but remain with the same ID in different
 177            VOBs.  However, some files have duplicate IDs, hence this hack.
 178         */
 179
 180         bool duplicates = false;
 181         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 182                 for (uint32_t j = i + 1; j < _format_context->nb_streams; ++j) {
 183                         if (_format_context->streams[i]->id == _format_context->streams[j]->id) {
 184                                 duplicates = true;
 185                         }
 186                 }
 187         }
 188
 189         if (duplicates) {
 190                 /* Put in our own IDs */
 191                 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 192                         _format_context->streams[i]->id = i;
 193                 }
 194         }
 195
 196         _video_frame = av_frame_alloc ();
 197         if (_video_frame == nullptr) {
 198                 throw std::bad_alloc ();
 199         }
 200 }
 201
 202
 203 void
 204 FFmpeg::setup_decoders ()
 205 {
 206         boost::mutex::scoped_lock lm (_mutex);
 207
 208         _codec_context.resize (_format_context->nb_streams);
 209         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 210                 auto codec = avcodec_find_decoder (_format_context->streams[i]->codecpar->codec_id);
 211                 if (codec) {
 212                         auto context = avcodec_alloc_context3 (codec);
 213                         if (!context) {
 214                                 throw std::bad_alloc ();
 215                         }
 216                         _codec_context[i] = context;
 217
 218                         int r = avcodec_parameters_to_context (context, _format_context->streams[i]->codecpar);
 219                         if (r < 0) {
 220                                 throw DecodeError ("avcodec_parameters_to_context", "FFmpeg::setup_decoders", r);
 221                         }
 222
 223                         context->thread_count = 8;
 224                         context->thread_type = FF_THREAD_FRAME | FF_THREAD_SLICE;
 225
 226                         AVDictionary* options = nullptr;
 227                         /* This option disables decoding of DCA frame footers in our patched version
 228                            of FFmpeg.  I believe these footers are of no use to us, and they can cause
 229                            problems when FFmpeg fails to decode them (mantis #352).
 230                         */
 231                         av_dict_set (&options, "disable_footer", "1", 0);
 232                         /* This allows decoding of some DNxHR 444 and HQX files; see
 233                            https://trac.ffmpeg.org/ticket/5681
 234                         */
 235                         av_dict_set_int (&options, "strict", FF_COMPLIANCE_EXPERIMENTAL, 0);
 236                         /* Enable following of links in files */
 237                         av_dict_set_int (&options, "enable_drefs", 1, 0);
 238
 239                         r = avcodec_open2 (context, codec, &options);
 240                         if (r < 0) {
 241                                 throw DecodeError (N_("avcodec_open2"), N_("FFmpeg::setup_decoders"), r);
 242                         }
 243                 } else {
 244                         dcpomatic_log->log (String::compose ("No codec found for stream %1", i), LogEntry::TYPE_WARNING);
 245                 }
 246         }
 247 }
 248
 249
 250 AVCodecContext *
 251 FFmpeg::video_codec_context () const
 252 {
 253         if (!_video_stream) {
 254                 return nullptr;
 255         }
 256
 257         return _codec_context[_video_stream.get()];
 258 }
 259
 260
 261 AVCodecContext *
 262 FFmpeg::subtitle_codec_context () const
 263 {
 264         auto str = _ffmpeg_content->subtitle_stream();
 265         if (!str) {
 266                 return nullptr;
 267         }
 268
 269         return _codec_context[str->index(_format_context)];
 270 }
 271
 272
 273 int
 274 FFmpeg::avio_read (uint8_t* buffer, int const amount)
 275 {
 276         return _file_group.read (buffer, amount);
 277 }
 278
 279
 280 int64_t
 281 FFmpeg::avio_seek (int64_t const pos, int whence)
 282 {
 283         if (whence == AVSEEK_SIZE) {
 284                 return _file_group.length ();
 285         }
 286
 287         return _file_group.seek (pos, whence);
 288 }
 289
 290
 291 FFmpegSubtitlePeriod
 292 FFmpeg::subtitle_period (AVPacket const* packet, AVStream const* stream, AVSubtitle const & sub)
 293 {
 294         auto const packet_time = ContentTime::from_seconds (packet->pts * av_q2d(stream->time_base));
 295         auto const start = packet_time + ContentTime::from_seconds(sub.start_display_time / 1e3);
 296
 297         if (sub.end_display_time == 0 || sub.end_display_time == static_cast<uint32_t>(-1)) {
 298                 /* End time is not in the AVSubtitle; perhaps we can use the AVPacket's duration */
 299                 if (packet->duration) {
 300                         return FFmpegSubtitlePeriod(start, start + ContentTime::from_seconds(packet->duration * av_q2d(stream->time_base)));
 301                 } else {
 302                         return FFmpegSubtitlePeriod(start);
 303                 }
 304         }
 305
 306         return FFmpegSubtitlePeriod (start, packet_time + ContentTime::from_seconds(sub.end_display_time / 1e3));
 307 }
 308
 309
 310 /** Compute the pts offset to use given a set of audio streams and some video details.
 311  *  Sometimes these parameters will have just been determined by an Examiner, sometimes
 312  *  they will have been retrieved from a piece of Content, hence the need for this method
 313  *  in FFmpeg.
 314  */
 315 ContentTime
 316 FFmpeg::pts_offset (vector<shared_ptr<FFmpegAudioStream>> audio_streams, optional<ContentTime> first_video, double video_frame_rate) const
 317 {
 318         /* Audio and video frame PTS values may not start with 0.  We want
 319            to fiddle them so that:
 320
 321            1.  One of them starts at time 0.
 322            2.  The first video PTS value ends up on a frame boundary.
 323
 324            Then we remove big initial gaps in PTS and we allow our
 325            insertion of black frames to work.
 326
 327            We will do:
 328              audio_pts_to_use = audio_pts_from_ffmpeg + pts_offset;
 329              video_pts_to_use = video_pts_from_ffmpeg + pts_offset;
 330         */
 331
 332         /* First, make one of them start at 0 */
 333
 334         auto po = ContentTime::min ();
 335
 336         if (first_video) {
 337                 po = - first_video.get ();
 338         }
 339
 340         for (auto i: audio_streams) {
 341                 if (i->first_audio) {
 342                         po = max (po, - i->first_audio.get ());
 343                 }
 344         }
 345
 346         /* If the offset is positive we would be pushing things from a -ve PTS to be played.
 347            I don't think we ever want to do that, as it seems things at -ve PTS are not meant
 348            to be seen (use for alignment bars etc.); see mantis #418.
 349         */
 350         if (po > ContentTime ()) {
 351                 po = ContentTime ();
 352         }
 353
 354         /* Now adjust so that the video pts starts on a frame */
 355         if (first_video) {
 356                 auto const fvc = first_video.get() + po;
 357                 po += fvc.ceil (video_frame_rate) - fvc;
 358         }
 359
 360         return po;
 361 }
 362
 363
 364 AVFrame *
 365 FFmpeg::audio_frame (shared_ptr<const FFmpegAudioStream> stream)
 366 {
 367         auto iter = _audio_frame.find(stream);
 368         if (iter != _audio_frame.end()) {
 369                 return iter->second;
 370         }
 371
 372         auto frame = av_frame_alloc ();
 373         if (frame == nullptr) {
 374                 throw std::bad_alloc();
 375         }
 376
 377         _audio_frame[stream] = frame;
 378         return frame;
 379
 380 }
 381