Use dcp::file_to_string().
[dcpomatic.git] / src / lib / ffmpeg_examiner.cc
index 271180d5d0970521e58e45f45fa087131abca9d3..bd6a9b20d475b6b23a7781a735bf52f09b19281e 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
-extern "C" {
-#include <libavcodec/avcodec.h>
-#include <libavformat/avformat.h>
-#include <libavutil/pixfmt.h>
-#include <libavutil/pixdesc.h>
-}
+
+#include "dcpomatic_log.h"
 #include "ffmpeg_examiner.h"
 #include "ffmpeg_content.h"
 #include "job.h"
 #include "ffmpeg_audio_stream.h"
 #include "ffmpeg_subtitle_stream.h"
 #include "util.h"
-#include <boost/foreach.hpp>
+#include "warnings.h"
+DCPOMATIC_DISABLE_WARNINGS
+extern "C" {
+#include <libavcodec/avcodec.h>
+#include <libavformat/avformat.h>
+#include <libavutil/pixfmt.h>
+#include <libavutil/pixdesc.h>
+#include <libavutil/eval.h>
+#include <libavutil/display.h>
+}
+DCPOMATIC_ENABLE_WARNINGS
 #include <iostream>
 
 #include "i18n.h"
 
-using std::string;
+
 using std::cout;
+using std::make_shared;
 using std::max;
-using boost::shared_ptr;
+using std::shared_ptr;
+using std::string;
+using std::vector;
 using boost::optional;
+using namespace dcpomatic;
+
+
+/* This is how many frames from the start of any video that we will examine to see if we
+ * can spot soft 2:3 pull-down ("telecine").
+ */
+static const int PULLDOWN_CHECK_FRAMES = 16;
+
 
 /** @param job job that the examiner is operating in, or 0 */
 FFmpegExaminer::FFmpegExaminer (shared_ptr<const FFmpegContent> c, shared_ptr<Job> job)
        : FFmpeg (c)
        , _video_length (0)
        , _need_video_length (false)
+       , _pulldown (false)
 {
        /* Find audio and subtitle streams */
 
        for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
-               AVStream* s = _format_context->streams[i];
-               if (s->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
+               auto s = _format_context->streams[i];
+               auto codec = _codec_context[i] ? _codec_context[i]->codec : nullptr;
+               if (s->codecpar->codec_type == AVMEDIA_TYPE_AUDIO && codec) {
 
                        /* This is a hack; sometimes it seems that _audio_codec_context->channel_layout isn't set up,
                           so bodge it here.  No idea why we should have to do this.
                        */
 
-                       if (s->codec->channel_layout == 0) {
-                               s->codec->channel_layout = av_get_default_channel_layout (s->codec->channels);
+                       if (s->codecpar->channel_layout == 0) {
+                               s->codecpar->channel_layout = av_get_default_channel_layout (s->codecpar->channels);
                        }
 
                        DCPOMATIC_ASSERT (_format_context->duration != AV_NOPTS_VALUE);
-                       DCPOMATIC_ASSERT (s->codec->codec);
-                       DCPOMATIC_ASSERT (s->codec->codec->name);
+                       DCPOMATIC_ASSERT (codec->name);
 
                        _audio_streams.push_back (
-                               shared_ptr<FFmpegAudioStream> (
-                                       new FFmpegAudioStream (
-                                               stream_name (s),
-                                               s->codec->codec->name,
-                                               s->id,
-                                               s->codec->sample_rate,
-                                               (double (_format_context->duration) / AV_TIME_BASE) * s->codec->sample_rate,
-                                               s->codec->channels
-                                               )
+                               make_shared<FFmpegAudioStream>(
+                                       stream_name (s),
+                                       codec->name,
+                                       s->id,
+                                       s->codecpar->sample_rate,
+                                       llrint ((double(_format_context->duration) / AV_TIME_BASE) * s->codecpar->sample_rate),
+                                       s->codecpar->channels
                                        )
                                );
 
-               } else if (s->codec->codec_type == AVMEDIA_TYPE_SUBTITLE) {
-                       _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (subtitle_stream_name (s), s->id)));
+               } else if (s->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE) {
+                       _subtitle_streams.push_back (make_shared<FFmpegSubtitleStream>(subtitle_stream_name (s), s->id));
                }
        }
 
@@ -87,34 +103,32 @@ FFmpegExaminer::FFmpegExaminer (shared_ptr<const FFmpegContent> c, shared_ptr<Jo
                /* See if the header has duration information in it */
                _need_video_length = _format_context->duration == AV_NOPTS_VALUE;
                if (!_need_video_length) {
-                       _video_length = (double (_format_context->duration) / AV_TIME_BASE) * video_frame_rate().get ();
+                       _video_length = llrint ((double (_format_context->duration) / AV_TIME_BASE) * video_frame_rate().get());
                }
        }
 
-       if (job) {
-               if (_need_video_length) {
-                       job->sub (_("Finding length and subtitles"));
-               } else if (!_subtitle_streams.empty()) {
-                       job->sub (_("Finding subtitles"));
-               } else {
-                       job->sub (_("Finding length"));
-               }
+       if (job && _need_video_length) {
+               job->sub (_("Finding length"));
        }
 
        /* Run through until we find:
         *   - the first video.
         *   - the first audio for each stream.
-        *   - the subtitle periods for each stream.
-        *
-        * We have to note subtitle periods as otherwise we have no way of knowing
-        * where we should look for subtitles (video and audio are always present,
-        * so they are ok).
+        *   - the top-field-first and repeat-first-frame values ("temporal_reference") for the first PULLDOWN_CHECK_FRAMES video frames.
         */
 
        int64_t const len = _file_group.length ();
+       /* A string which we build up to describe the top-field-first and repeat-first-frame values for the first few frames.
+        * It would be nicer to use something like vector<bool> here but we want to search the array for a pattern later,
+        * and a string seems a reasonably neat way to do that.
+        */
+       string temporal_reference;
        while (true) {
-               int r = av_read_frame (_format_context, &_packet);
+               auto packet = av_packet_alloc ();
+               DCPOMATIC_ASSERT (packet);
+               int r = av_read_frame (_format_context, packet);
                if (r < 0) {
+                       av_packet_free (&packet);
                        break;
                }
 
@@ -126,176 +140,150 @@ FFmpegExaminer::FFmpegExaminer (shared_ptr<const FFmpegContent> c, shared_ptr<Jo
                        }
                }
 
-               AVCodecContext* context = _format_context->streams[_packet.stream_index]->codec;
+               auto context = _codec_context[packet->stream_index];
 
-               if (_video_stream && _packet.stream_index == _video_stream.get()) {
-                       video_packet (context);
+               if (_video_stream && packet->stream_index == _video_stream.get()) {
+                       video_packet (context, temporal_reference, packet);
                }
 
                bool got_all_audio = true;
 
                for (size_t i = 0; i < _audio_streams.size(); ++i) {
-                       if (_audio_streams[i]->uses_index (_format_context, _packet.stream_index)) {
-                               audio_packet (context, _audio_streams[i]);
+                       if (_audio_streams[i]->uses_index(_format_context, packet->stream_index)) {
+                               audio_packet (context, _audio_streams[i], packet);
                        }
                        if (!_audio_streams[i]->first_audio) {
                                got_all_audio = false;
                        }
                }
 
-               for (size_t i = 0; i < _subtitle_streams.size(); ++i) {
-                       if (_subtitle_streams[i]->uses_index (_format_context, _packet.stream_index)) {
-                               subtitle_packet (context, _subtitle_streams[i]);
-                       }
-               }
+               av_packet_free (&packet);
 
-               av_packet_unref (&_packet);
-
-               if (_first_video && got_all_audio && _subtitle_streams.empty ()) {
+               if (_first_video && got_all_audio && temporal_reference.size() >= (PULLDOWN_CHECK_FRAMES * 2)) {
                        /* All done */
                        break;
                }
        }
 
-       /* Finish off any hanging subtitles at the end */
-       for (LastSubtitleMap::const_iterator i = _last_subtitle_start.begin(); i != _last_subtitle_start.end(); ++i) {
-               if (i->second) {
-                       if (i->second->image) {
-                               i->first->add_image_subtitle (
-                                       i->second->id,
-                                       ContentTimePeriod (
-                                               i->second->time,
-                                               ContentTime::from_frames (video_length(), video_frame_rate().get_value_or (24))
-                                               )
-                                       );
-                       } else {
-                               i->first->add_text_subtitle (
-                                       i->second->id,
-                                       ContentTimePeriod (
-                                               i->second->time,
-                                               ContentTime::from_frames (video_length(), video_frame_rate().get_value_or (24))
-                                               )
-                                       );
+       if (_video_stream) {
+               auto context = _codec_context[_video_stream.get()];
+               while (video_packet(context, temporal_reference, nullptr)) {}
+       }
+
+       for (auto i: _audio_streams) {
+               auto context = _codec_context[i->index(_format_context)];
+               audio_packet(context, i, nullptr);
+       }
+
+       if (_video_stream) {
+               /* This code taken from get_rotation() in ffmpeg:cmdutils.c */
+               auto stream = _format_context->streams[*_video_stream];
+               auto rotate_tag = av_dict_get (stream->metadata, "rotate", 0, 0);
+               uint8_t* displaymatrix = av_stream_get_side_data (stream, AV_PKT_DATA_DISPLAYMATRIX, 0);
+               _rotation = 0;
+
+               if (rotate_tag && *rotate_tag->value && strcmp(rotate_tag->value, "0")) {
+                       char *tail;
+                       _rotation = av_strtod (rotate_tag->value, &tail);
+                       if (*tail) {
+                               _rotation = 0;
                        }
                }
-       }
 
-       /* We just added subtitles to our streams without taking the PTS offset into account;
-          this is because we might not know the PTS offset when the first subtitle is seen.
-          Now we know the PTS offset so we can apply it to those subtitles.
-       */
-       if (has_video() && video_frame_rate()) {
-               BOOST_FOREACH (shared_ptr<FFmpegSubtitleStream> i, _subtitle_streams) {
-                       i->add_offset (pts_offset (_audio_streams, _first_video, video_frame_rate().get()));
+               if (displaymatrix && !_rotation) {
+                       _rotation = - av_display_rotation_get ((int32_t*) displaymatrix);
                }
+
+               _rotation = *_rotation - 360 * floor (*_rotation / 360 + 0.9 / 360);
+       }
+
+       LOG_GENERAL("Temporal reference was %1", temporal_reference);
+       if (temporal_reference.find("T2T3B2B3T2T3B2B3") != string::npos || temporal_reference.find("B2B3T2T3B2B3T2T3") != string::npos) {
+               /* The magical sequence (taken from mediainfo) suggests that 2:3 pull-down is in use */
+               _pulldown = true;
+               LOG_GENERAL_NC("Suggest that this may be 2:3 pull-down (soft telecine)");
        }
 }
 
-void
-FFmpegExaminer::video_packet (AVCodecContext* context)
+
+/** @param temporal_reference A string to which we should add two characters per frame;
+ *  the first   is T or B depending on whether it's top- or bottom-field first,
+ *  the second  is 3 or 2 depending on whether "repeat_pict" is true or not.
+ *  @return true if some video was decoded, otherwise false.
+ */
+bool
+FFmpegExaminer::video_packet (AVCodecContext* context, string& temporal_reference, AVPacket* packet)
 {
        DCPOMATIC_ASSERT (_video_stream);
 
-       if (_first_video && !_need_video_length) {
-               return;
+       if (_first_video && !_need_video_length && temporal_reference.size() >= (PULLDOWN_CHECK_FRAMES * 2)) {
+               return false;
        }
 
-       int frame_finished;
-       if (avcodec_decode_video2 (context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
-               if (!_first_video) {
-                       _first_video = frame_time (_format_context->streams[_video_stream.get()]);
-               }
-               if (_need_video_length) {
-                       _video_length = frame_time (
-                               _format_context->streams[_video_stream.get()]
-                               ).get_value_or (ContentTime ()).frames_round (video_frame_rate().get ());
-               }
+       int r = avcodec_send_packet (context, packet);
+       if (r < 0 && !(r == AVERROR_EOF && !packet)) {
+               /* We could cope with AVERROR(EAGAIN) and re-send the packet but I think it should never happen.
+                * AVERROR_EOF can happen during flush if we've already sent a flush packet.
+                */
+               throw DecodeError (N_("avcodec_send_packet"), N_("FFmpegExaminer::video_packet"), r);
        }
-}
 
-void
-FFmpegExaminer::audio_packet (AVCodecContext* context, shared_ptr<FFmpegAudioStream> stream)
-{
-       if (stream->first_audio) {
-               return;
+       r = avcodec_receive_frame (context, _frame);
+       if (r == AVERROR(EAGAIN)) {
+               /* More input is required */
+               return true;
+       } else if (r == AVERROR_EOF) {
+               /* No more output is coming */
+               return false;
        }
 
-       int frame_finished;
-       if (avcodec_decode_audio4 (context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
-               stream->first_audio = frame_time (stream->stream (_format_context));
+       if (!_first_video) {
+               _first_video = frame_time (_format_context->streams[_video_stream.get()]);
+       }
+       if (_need_video_length) {
+               _video_length = frame_time (
+                       _format_context->streams[_video_stream.get()]
+                       ).get_value_or (ContentTime ()).frames_round (video_frame_rate().get ());
        }
+       if (temporal_reference.size() < (PULLDOWN_CHECK_FRAMES * 2)) {
+               temporal_reference += (_frame->top_field_first ? "T" : "B");
+               temporal_reference += (_frame->repeat_pict ? "3" : "2");
+       }
+
+       return true;
 }
 
+
 void
-FFmpegExaminer::subtitle_packet (AVCodecContext* context, shared_ptr<FFmpegSubtitleStream> stream)
+FFmpegExaminer::audio_packet (AVCodecContext* context, shared_ptr<FFmpegAudioStream> stream, AVPacket* packet)
 {
-       int frame_finished;
-       AVSubtitle sub;
-       if (avcodec_decode_subtitle2 (context, &sub, &frame_finished, &_packet) >= 0 && frame_finished) {
-               string id = subtitle_id (sub);
-               FFmpegSubtitlePeriod const period = subtitle_period (sub);
-               bool const starts_image = subtitle_starts_image (sub);
-
-               /* Some streams (notably DVB streams) have subtitles which have a specified end time
-                  but which are then stopped earlier than this by a zero-num_rect subtitle.
-               */
-
-               LastSubtitleMap::iterator last = _last_subtitle_start.find (stream);
-               if (sub.num_rects == 0 && last != _last_subtitle_start.end() && last->second) {
-                       /* Set (or fix) the `to' time for the last subtitle */
-                       stream->set_subtitle_to (last->second->id, period.from);
-                       _last_subtitle_start[stream] = optional<SubtitleStart> ();
-               } else if (sub.num_rects > 0) {
-                       /* Add a subtitle; if we don't know the `to' time we set it to the from time and fix it later */
-                       if (starts_image) {
-                               stream->add_image_subtitle (id, ContentTimePeriod (period.from, period.to.get_value_or (period.from)));
-                       } else {
-                               stream->add_text_subtitle (id, ContentTimePeriod (period.from, period.to.get_value_or (period.from)));
-                       }
-
-                       _last_subtitle_start[stream] = SubtitleStart (id, starts_image, period.from);
-               }
+       if (stream->first_audio) {
+               return;
+       }
 
-               for (unsigned int i = 0; i < sub.num_rects; ++i) {
-                       if (sub.rects[i]->type == SUBTITLE_BITMAP) {
-#ifdef DCPOMATIC_HAVE_AVSUBTITLERECT_PICT
-                               uint32_t* palette = (uint32_t *) sub.rects[i]->pict.data[1];
-                               for (int j = 0; j < sub.rects[i]->nb_colors; ++j) {
-                                       RGBA rgba  (
-                                               (palette[j] & 0x00ff0000) >> 16,
-                                               (palette[j] & 0x0000ff00) >> 8,
-                                               (palette[j] & 0x000000ff) >> 0,
-                                               (palette[j] & 0xff000000) >> 24
-                                               );
-
-                                       stream->set_colour (rgba, rgba);
-                               }
-#else
-                               uint32_t* palette = (uint32_t *) sub.rects[i]->data[1];
-                               for (int j = 0; j < sub.rects[i]->nb_colors; ++j) {
-                                       RGBA rgba  (
-                                               (palette[j] & 0x00ff0000) >> 16,
-                                               (palette[j] & 0x0000ff00) >> 8,
-                                               (palette[j] & 0x000000ff) >> 0,
-                                               (palette[j] & 0xff000000) >> 24
-                                               );
-
-                                       stream->set_colour (rgba, rgba);
-                               }
-#endif
-                       }
-               }
+       int r = avcodec_send_packet (context, packet);
+       if (r < 0 && !(r == AVERROR_EOF && !packet) && r != AVERROR(EAGAIN)) {
+               /* We could cope with AVERROR(EAGAIN) and re-send the packet but I think it should never happen.
+                * AVERROR_EOF can happen during flush if we've already sent a flush packet.
+                * EAGAIN means we need to do avcodec_receive_frame, so just carry on and do that.
+                */
+               throw DecodeError (N_("avcodec_send_packet"), N_("FFmpegExaminer::audio_packet"), r);
+       }
 
-               avsubtitle_free (&sub);
+       if (avcodec_receive_frame (context, _frame) < 0) {
+               return;
        }
+
+       stream->first_audio = frame_time (stream->stream(_format_context));
 }
 
+
 optional<ContentTime>
 FFmpegExaminer::frame_time (AVStream* s) const
 {
        optional<ContentTime> t;
 
-       int64_t const bet = av_frame_get_best_effort_timestamp (_frame);
+       int64_t const bet = _frame->best_effort_timestamp;
        if (bet != AV_NOPTS_VALUE) {
                t = ContentTime::from_seconds (bet * av_q2d (s->time_base));
        }
@@ -303,23 +291,22 @@ FFmpegExaminer::frame_time (AVStream* s) const
        return t;
 }
 
+
 optional<double>
 FFmpegExaminer::video_frame_rate () const
 {
        DCPOMATIC_ASSERT (_video_stream);
-       /* This use of r_frame_rate is debateable; there's a few different
-        * frame rates in the format context, but this one seems to be the most
-        * reliable.
-        */
-       return av_q2d (av_stream_get_r_frame_rate (_format_context->streams[_video_stream.get()]));
+       return av_q2d(av_guess_frame_rate(_format_context, _format_context->streams[_video_stream.get()], 0));
 }
 
+
 dcp::Size
 FFmpegExaminer::video_size () const
 {
        return dcp::Size (video_codec_context()->width, video_codec_context()->height);
 }
 
+
 /** @return Length according to our content's header */
 Frame
 FFmpegExaminer::video_length () const
@@ -327,22 +314,24 @@ FFmpegExaminer::video_length () const
        return max (Frame (1), _video_length);
 }
 
+
 optional<double>
 FFmpegExaminer::sample_aspect_ratio () const
 {
        DCPOMATIC_ASSERT (_video_stream);
-       AVRational sar = av_guess_sample_aspect_ratio (_format_context, _format_context->streams[_video_stream.get()], 0);
+       auto sar = av_guess_sample_aspect_ratio (_format_context, _format_context->streams[_video_stream.get()], 0);
        if (sar.num == 0) {
                /* I assume this means that we don't know */
-               return optional<double> ();
+               return {};
        }
        return double (sar.num) / sar.den;
 }
 
+
 string
 FFmpegExaminer::subtitle_stream_name (AVStream* s) const
 {
-       string n = stream_name (s);
+       auto n = stream_name (s);
 
        if (n.empty()) {
                n = _("unknown");
@@ -351,18 +340,19 @@ FFmpegExaminer::subtitle_stream_name (AVStream* s) const
        return n;
 }
 
+
 string
 FFmpegExaminer::stream_name (AVStream* s) const
 {
        string n;
 
        if (s->metadata) {
-               AVDictionaryEntry const * lang = av_dict_get (s->metadata, "language", 0, 0);
+               auto const lang = av_dict_get (s->metadata, "language", 0, 0);
                if (lang) {
                        n = lang->value;
                }
 
-               AVDictionaryEntry const * title = av_dict_get (s->metadata, "title", 0, 0);
+               auto const title = av_dict_get (s->metadata, "title", 0, 0);
                if (title) {
                        if (!n.empty()) {
                                n += " ";
@@ -374,18 +364,20 @@ FFmpegExaminer::stream_name (AVStream* s) const
        return n;
 }
 
-int
+
+optional<int>
 FFmpegExaminer::bits_per_pixel () const
 {
        if (video_codec_context()->pix_fmt == -1) {
-               throw DecodeError (_("Could not find pixel format for video."));
+               return {};
        }
 
-       AVPixFmtDescriptor const * d = av_pix_fmt_desc_get (video_codec_context()->pix_fmt);
+       auto const d = av_pix_fmt_desc_get (video_codec_context()->pix_fmt);
        DCPOMATIC_ASSERT (d);
        return av_get_bits_per_pixel (d);
 }
 
+
 bool
 FFmpegExaminer::yuv () const
 {
@@ -467,8 +459,23 @@ FFmpegExaminer::yuv () const
        }
 }
 
+
 bool
 FFmpegExaminer::has_video () const
 {
-       return static_cast<bool> (_video_stream);
+       return static_cast<bool>(_video_stream);
+}
+
+
+VideoRange
+FFmpegExaminer::range () const
+{
+       switch (color_range()) {
+       case AVCOL_RANGE_MPEG:
+       case AVCOL_RANGE_UNSPECIFIED:
+               return VideoRange::VIDEO;
+       case AVCOL_RANGE_JPEG:
+       default:
+               return VideoRange::FULL;
+       }
 }