src/lib/ffmpeg_examiner.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 "dcpomatic_log.h"
  23 #include "ffmpeg_examiner.h"
  24 #include "ffmpeg_content.h"
  25 #include "job.h"
  26 #include "ffmpeg_audio_stream.h"
  27 #include "ffmpeg_subtitle_stream.h"
  28 #include "util.h"
  29 #include "warnings.h"
  30 DCPOMATIC_DISABLE_WARNINGS
  31 extern "C" {
  32 #include <libavcodec/avcodec.h>
  33 #include <libavformat/avformat.h>
  34 #include <libavutil/pixfmt.h>
  35 #include <libavutil/pixdesc.h>
  36 #include <libavutil/channel_layout.h>
  37 #include <libavutil/display.h>
  38 #include <libavutil/eval.h>
  39 }
  40 DCPOMATIC_ENABLE_WARNINGS
  41 #include <iostream>
  42
  43 #include "i18n.h"
  44
  45
  46 using std::cout;
  47 using std::make_shared;
  48 using std::max;
  49 using std::shared_ptr;
  50 using std::string;
  51 using std::vector;
  52 using boost::optional;
  53 using namespace dcpomatic;
  54
  55
  56 /* This is how many frames from the start of any video that we will examine to see if we
  57  * can spot soft 2:3 pull-down ("telecine").
  58  */
  59 static const int PULLDOWN_CHECK_FRAMES = 16;
  60
  61
  62 /** @param job job that the examiner is operating in, or 0 */
  63 FFmpegExaminer::FFmpegExaminer (shared_ptr<const FFmpegContent> c, shared_ptr<Job> job)
  64         : FFmpeg (c)
  65         , _video_length (0)
  66         , _need_video_length (false)
  67         , _pulldown (false)
  68 {
  69         /* Find audio and subtitle streams */
  70
  71         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
  72                 auto s = _format_context->streams[i];
  73                 auto codec = _codec_context[i] ? _codec_context[i]->codec : nullptr;
  74                 if (s->codecpar->codec_type == AVMEDIA_TYPE_AUDIO && codec) {
  75
  76                         /* This is a hack; sometimes it seems that _audio_codec_context->channel_layout isn't set up,
  77                            so bodge it here.  No idea why we should have to do this.
  78                         */
  79
  80                         if (s->codecpar->channel_layout == 0) {
  81                                 s->codecpar->channel_layout = av_get_default_channel_layout (s->codecpar->channels);
  82                         }
  83
  84                         DCPOMATIC_ASSERT (_format_context->duration != AV_NOPTS_VALUE);
  85                         DCPOMATIC_ASSERT (codec->name);
  86
  87                         _audio_streams.push_back (
  88                                 make_shared<FFmpegAudioStream>(
  89                                         stream_name (s),
  90                                         codec->name,
  91                                         s->id,
  92                                         s->codecpar->sample_rate,
  93                                         llrint ((double(_format_context->duration) / AV_TIME_BASE) * s->codecpar->sample_rate),
  94                                         s->codecpar->channels
  95                                         )
  96                                 );
  97
  98                 } else if (s->codecpar->codec_type == AVMEDIA_TYPE_SUBTITLE) {
  99                         _subtitle_streams.push_back (make_shared<FFmpegSubtitleStream>(subtitle_stream_name (s), s->id));
 100                 }
 101         }
 102
 103         if (has_video ()) {
 104                 /* See if the header has duration information in it */
 105                 _need_video_length = _format_context->duration == AV_NOPTS_VALUE;
 106                 if (!_need_video_length) {
 107                         _video_length = llrint ((double (_format_context->duration) / AV_TIME_BASE) * video_frame_rate().get());
 108                 }
 109         }
 110
 111         if (job && _need_video_length) {
 112                 job->sub (_("Finding length"));
 113         }
 114
 115         /* Run through until we find:
 116          *   - the first video.
 117          *   - the first audio for each stream.
 118          *   - the top-field-first and repeat-first-frame values ("temporal_reference") for the first PULLDOWN_CHECK_FRAMES video frames.
 119          */
 120
 121         int64_t const len = _file_group.length ();
 122         /* A string which we build up to describe the top-field-first and repeat-first-frame values for the first few frames.
 123          * It would be nicer to use something like vector<bool> here but we want to search the array for a pattern later,
 124          * and a string seems a reasonably neat way to do that.
 125          */
 126         string temporal_reference;
 127         while (true) {
 128                 auto packet = av_packet_alloc ();
 129                 DCPOMATIC_ASSERT (packet);
 130                 int r = av_read_frame (_format_context, packet);
 131                 if (r < 0) {
 132                         av_packet_free (&packet);
 133                         break;
 134                 }
 135
 136                 if (job) {
 137                         if (len > 0) {
 138                                 job->set_progress (float (_format_context->pb->pos) / len);
 139                         } else {
 140                                 job->set_progress_unknown ();
 141                         }
 142                 }
 143
 144                 auto context = _codec_context[packet->stream_index];
 145
 146                 if (_video_stream && packet->stream_index == _video_stream.get()) {
 147                         video_packet (context, temporal_reference, packet);
 148                 }
 149
 150                 bool got_all_audio = true;
 151
 152                 for (size_t i = 0; i < _audio_streams.size(); ++i) {
 153                         if (_audio_streams[i]->uses_index(_format_context, packet->stream_index)) {
 154                                 audio_packet (context, _audio_streams[i], packet);
 155                         }
 156                         if (!_audio_streams[i]->first_audio) {
 157                                 got_all_audio = false;
 158                         }
 159                 }
 160
 161                 av_packet_free (&packet);
 162
 163                 if (_first_video && got_all_audio && temporal_reference.size() >= (PULLDOWN_CHECK_FRAMES * 2)) {
 164                         /* All done */
 165                         break;
 166                 }
 167         }
 168
 169         if (_video_stream) {
 170                 auto context = _codec_context[_video_stream.get()];
 171                 while (video_packet(context, temporal_reference, nullptr)) {}
 172         }
 173
 174         for (auto i: _audio_streams) {
 175                 auto context = _codec_context[i->index(_format_context)];
 176                 audio_packet(context, i, nullptr);
 177         }
 178
 179         if (_video_stream) {
 180                 /* This code taken from get_rotation() in ffmpeg:cmdutils.c */
 181                 auto stream = _format_context->streams[*_video_stream];
 182                 auto rotate_tag = av_dict_get (stream->metadata, "rotate", 0, 0);
 183                 uint8_t* displaymatrix = av_stream_get_side_data (stream, AV_PKT_DATA_DISPLAYMATRIX, 0);
 184                 _rotation = 0;
 185
 186                 if (rotate_tag && *rotate_tag->value && strcmp(rotate_tag->value, "0")) {
 187                         char *tail;
 188                         _rotation = av_strtod (rotate_tag->value, &tail);
 189                         if (*tail) {
 190                                 _rotation = 0;
 191                         }
 192                 }
 193
 194                 if (displaymatrix && !_rotation) {
 195                         _rotation = - av_display_rotation_get ((int32_t*) displaymatrix);
 196                 }
 197
 198                 _rotation = *_rotation - 360 * floor (*_rotation / 360 + 0.9 / 360);
 199         }
 200
 201         LOG_GENERAL("Temporal reference was %1", temporal_reference);
 202         if (temporal_reference.find("T2T3B2B3T2T3B2B3") != string::npos || temporal_reference.find("B2B3T2T3B2B3T2T3") != string::npos) {
 203                 /* The magical sequence (taken from mediainfo) suggests that 2:3 pull-down is in use */
 204                 _pulldown = true;
 205                 LOG_GENERAL_NC("Suggest that this may be 2:3 pull-down (soft telecine)");
 206         }
 207 }
 208
 209
 210 /** @param temporal_reference A string to which we should add two characters per frame;
 211  *  the first   is T or B depending on whether it's top- or bottom-field first,
 212  *  the second  is 3 or 2 depending on whether "repeat_pict" is true or not.
 213  *  @return true if some video was decoded, otherwise false.
 214  */
 215 bool
 216 FFmpegExaminer::video_packet (AVCodecContext* context, string& temporal_reference, AVPacket* packet)
 217 {
 218         DCPOMATIC_ASSERT (_video_stream);
 219
 220         if (_first_video && !_need_video_length && temporal_reference.size() >= (PULLDOWN_CHECK_FRAMES * 2)) {
 221                 return false;
 222         }
 223
 224         int r = avcodec_send_packet (context, packet);
 225         if (r < 0 && !(r == AVERROR_EOF && !packet)) {
 226                 /* We could cope with AVERROR(EAGAIN) and re-send the packet but I think it should never happen.
 227                  * AVERROR_EOF can happen during flush if we've already sent a flush packet.
 228                  */
 229                 throw DecodeError (N_("avcodec_send_packet"), N_("FFmpegExaminer::video_packet"), r);
 230         }
 231
 232         r = avcodec_receive_frame (context, _frame);
 233         if (r == AVERROR(EAGAIN)) {
 234                 /* More input is required */
 235                 return true;
 236         } else if (r == AVERROR_EOF) {
 237                 /* No more output is coming */
 238                 return false;
 239         }
 240
 241         if (!_first_video) {
 242                 _first_video = frame_time (_format_context->streams[_video_stream.get()]);
 243         }
 244         if (_need_video_length) {
 245                 _video_length = frame_time (
 246                         _format_context->streams[_video_stream.get()]
 247                         ).get_value_or (ContentTime ()).frames_round (video_frame_rate().get ());
 248         }
 249         if (temporal_reference.size() < (PULLDOWN_CHECK_FRAMES * 2)) {
 250                 temporal_reference += (_frame->top_field_first ? "T" : "B");
 251                 temporal_reference += (_frame->repeat_pict ? "3" : "2");
 252         }
 253
 254         return true;
 255 }
 256
 257
 258 void
 259 FFmpegExaminer::audio_packet (AVCodecContext* context, shared_ptr<FFmpegAudioStream> stream, AVPacket* packet)
 260 {
 261         if (stream->first_audio) {
 262                 return;
 263         }
 264
 265         int r = avcodec_send_packet (context, packet);
 266         if (r < 0 && !(r == AVERROR_EOF && !packet) && r != AVERROR(EAGAIN)) {
 267                 /* We could cope with AVERROR(EAGAIN) and re-send the packet but I think it should never happen.
 268                  * AVERROR_EOF can happen during flush if we've already sent a flush packet.
 269                  * EAGAIN means we need to do avcodec_receive_frame, so just carry on and do that.
 270                  */
 271                 throw DecodeError (N_("avcodec_send_packet"), N_("FFmpegExaminer::audio_packet"), r);
 272         }
 273
 274         if (avcodec_receive_frame (context, _frame) < 0) {
 275                 return;
 276         }
 277
 278         stream->first_audio = frame_time (stream->stream(_format_context));
 279 }
 280
 281
 282 optional<ContentTime>
 283 FFmpegExaminer::frame_time (AVStream* s) const
 284 {
 285         optional<ContentTime> t;
 286
 287         int64_t const bet = _frame->best_effort_timestamp;
 288         if (bet != AV_NOPTS_VALUE) {
 289                 t = ContentTime::from_seconds (bet * av_q2d (s->time_base));
 290         }
 291
 292         return t;
 293 }
 294
 295
 296 optional<double>
 297 FFmpegExaminer::video_frame_rate () const
 298 {
 299         DCPOMATIC_ASSERT (_video_stream);
 300         return av_q2d(av_guess_frame_rate(_format_context, _format_context->streams[_video_stream.get()], 0));
 301 }
 302
 303
 304 dcp::Size
 305 FFmpegExaminer::video_size () const
 306 {
 307         return dcp::Size (video_codec_context()->width, video_codec_context()->height);
 308 }
 309
 310
 311 /** @return Length according to our content's header */
 312 Frame
 313 FFmpegExaminer::video_length () const
 314 {
 315         return max (Frame (1), _video_length);
 316 }
 317
 318
 319 optional<double>
 320 FFmpegExaminer::sample_aspect_ratio () const
 321 {
 322         DCPOMATIC_ASSERT (_video_stream);
 323         auto sar = av_guess_sample_aspect_ratio (_format_context, _format_context->streams[_video_stream.get()], 0);
 324         if (sar.num == 0) {
 325                 /* I assume this means that we don't know */
 326                 return {};
 327         }
 328         return double (sar.num) / sar.den;
 329 }
 330
 331
 332 string
 333 FFmpegExaminer::subtitle_stream_name (AVStream* s) const
 334 {
 335         auto n = stream_name (s);
 336
 337         if (n.empty()) {
 338                 n = _("unknown");
 339         }
 340
 341         return n;
 342 }
 343
 344
 345 string
 346 FFmpegExaminer::stream_name (AVStream* s) const
 347 {
 348         string n;
 349
 350         if (s->metadata) {
 351                 auto const lang = av_dict_get (s->metadata, "language", 0, 0);
 352                 if (lang) {
 353                         n = lang->value;
 354                 }
 355
 356                 auto const title = av_dict_get (s->metadata, "title", 0, 0);
 357                 if (title) {
 358                         if (!n.empty()) {
 359                                 n += " ";
 360                         }
 361                         n += title->value;
 362                 }
 363         }
 364
 365         return n;
 366 }
 367
 368
 369 optional<int>
 370 FFmpegExaminer::bits_per_pixel () const
 371 {
 372         if (video_codec_context()->pix_fmt == -1) {
 373                 return {};
 374         }
 375
 376         auto const d = av_pix_fmt_desc_get (video_codec_context()->pix_fmt);
 377         DCPOMATIC_ASSERT (d);
 378         return av_get_bits_per_pixel (d);
 379 }
 380
 381
 382 bool
 383 FFmpegExaminer::yuv () const
 384 {
 385         switch (video_codec_context()->pix_fmt) {
 386         case AV_PIX_FMT_YUV420P:
 387         case AV_PIX_FMT_YUYV422:
 388         case AV_PIX_FMT_YUV422P:
 389         case AV_PIX_FMT_YUV444P:
 390         case AV_PIX_FMT_YUV410P:
 391         case AV_PIX_FMT_YUV411P:
 392         case AV_PIX_FMT_YUVJ420P:
 393         case AV_PIX_FMT_YUVJ422P:
 394         case AV_PIX_FMT_YUVJ444P:
 395         case AV_PIX_FMT_UYVY422:
 396         case AV_PIX_FMT_UYYVYY411:
 397         case AV_PIX_FMT_NV12:
 398         case AV_PIX_FMT_NV21:
 399         case AV_PIX_FMT_YUV440P:
 400         case AV_PIX_FMT_YUVJ440P:
 401         case AV_PIX_FMT_YUVA420P:
 402         case AV_PIX_FMT_YUV420P16LE:
 403         case AV_PIX_FMT_YUV420P16BE:
 404         case AV_PIX_FMT_YUV422P16LE:
 405         case AV_PIX_FMT_YUV422P16BE:
 406         case AV_PIX_FMT_YUV444P16LE:
 407         case AV_PIX_FMT_YUV444P16BE:
 408         case AV_PIX_FMT_YUV420P9BE:
 409         case AV_PIX_FMT_YUV420P9LE:
 410         case AV_PIX_FMT_YUV420P10BE:
 411         case AV_PIX_FMT_YUV420P10LE:
 412         case AV_PIX_FMT_YUV422P10BE:
 413         case AV_PIX_FMT_YUV422P10LE:
 414         case AV_PIX_FMT_YUV444P9BE:
 415         case AV_PIX_FMT_YUV444P9LE:
 416         case AV_PIX_FMT_YUV444P10BE:
 417         case AV_PIX_FMT_YUV444P10LE:
 418         case AV_PIX_FMT_YUV422P9BE:
 419         case AV_PIX_FMT_YUV422P9LE:
 420         case AV_PIX_FMT_YUVA420P9BE:
 421         case AV_PIX_FMT_YUVA420P9LE:
 422         case AV_PIX_FMT_YUVA422P9BE:
 423         case AV_PIX_FMT_YUVA422P9LE:
 424         case AV_PIX_FMT_YUVA444P9BE:
 425         case AV_PIX_FMT_YUVA444P9LE:
 426         case AV_PIX_FMT_YUVA420P10BE:
 427         case AV_PIX_FMT_YUVA420P10LE:
 428         case AV_PIX_FMT_YUVA422P10BE:
 429         case AV_PIX_FMT_YUVA422P10LE:
 430         case AV_PIX_FMT_YUVA444P10BE:
 431         case AV_PIX_FMT_YUVA444P10LE:
 432         case AV_PIX_FMT_YUVA420P16BE:
 433         case AV_PIX_FMT_YUVA420P16LE:
 434         case AV_PIX_FMT_YUVA422P16BE:
 435         case AV_PIX_FMT_YUVA422P16LE:
 436         case AV_PIX_FMT_YUVA444P16BE:
 437         case AV_PIX_FMT_YUVA444P16LE:
 438         case AV_PIX_FMT_NV16:
 439         case AV_PIX_FMT_NV20LE:
 440         case AV_PIX_FMT_NV20BE:
 441         case AV_PIX_FMT_YVYU422:
 442         case AV_PIX_FMT_YUVA444P:
 443         case AV_PIX_FMT_YUVA422P:
 444         case AV_PIX_FMT_YUV420P12BE:
 445         case AV_PIX_FMT_YUV420P12LE:
 446         case AV_PIX_FMT_YUV420P14BE:
 447         case AV_PIX_FMT_YUV420P14LE:
 448         case AV_PIX_FMT_YUV422P12BE:
 449         case AV_PIX_FMT_YUV422P12LE:
 450         case AV_PIX_FMT_YUV422P14BE:
 451         case AV_PIX_FMT_YUV422P14LE:
 452         case AV_PIX_FMT_YUV444P12BE:
 453         case AV_PIX_FMT_YUV444P12LE:
 454         case AV_PIX_FMT_YUV444P14BE:
 455         case AV_PIX_FMT_YUV444P14LE:
 456         case AV_PIX_FMT_YUVJ411P:
 457                 return true;
 458         default:
 459                 return false;
 460         }
 461 }
 462
 463
 464 bool
 465 FFmpegExaminer::has_video () const
 466 {
 467         return static_cast<bool>(_video_stream);
 468 }
 469
 470
 471 VideoRange
 472 FFmpegExaminer::range () const
 473 {
 474         switch (color_range()) {
 475         case AVCOL_RANGE_MPEG:
 476         case AVCOL_RANGE_UNSPECIFIED:
 477                 return VideoRange::VIDEO;
 478         case AVCOL_RANGE_JPEG:
 479         default:
 480                 return VideoRange::FULL;
 481         }
 482 }
 483
 484
 485 PixelQuanta
 486 FFmpegExaminer::pixel_quanta () const
 487 {
 488         auto const desc = av_pix_fmt_desc_get(video_codec_context()->pix_fmt);
 489         return { 1 << desc->log2_chroma_w, 1 << desc->log2_chroma_h };
 490 }
 491