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