src/lib/ffmpeg_examiner.cc

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