Detect soft 2:3 pulldown (telecine) files and decode them at 23.976.
[dcpomatic.git] / src / lib / ffmpeg_examiner.h
1 /*
2     Copyright (C) 2013-2017 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 "ffmpeg.h"
22 #include "video_examiner.h"
23 #include <boost/optional.hpp>
24
25 struct AVStream;
26
27 class FFmpegAudioStream;
28 class FFmpegSubtitleStream;
29 class Job;
30
31 class FFmpegExaminer : public FFmpeg, public VideoExaminer
32 {
33 public:
34         FFmpegExaminer (boost::shared_ptr<const FFmpegContent>, boost::shared_ptr<Job> job = boost::shared_ptr<Job> ());
35
36         bool has_video () const;
37
38         boost::optional<double> video_frame_rate () const;
39         dcp::Size video_size () const;
40         Frame video_length () const;
41         boost::optional<double> sample_aspect_ratio () const;
42         bool yuv () const;
43
44         std::vector<boost::shared_ptr<FFmpegSubtitleStream> > subtitle_streams () const {
45                 return _subtitle_streams;
46         }
47
48         std::vector<boost::shared_ptr<FFmpegAudioStream> > audio_streams () const {
49                 return _audio_streams;
50         }
51
52         boost::optional<dcpomatic::ContentTime> first_video () const {
53                 return _first_video;
54         }
55
56         VideoRange range () const;
57
58         AVColorRange color_range () const {
59                 return video_codec_context()->color_range;
60         }
61
62         AVColorPrimaries color_primaries () const {
63                 return video_codec_context()->color_primaries;
64         }
65
66         AVColorTransferCharacteristic color_trc () const {
67                 return video_codec_context()->color_trc;
68         }
69
70         AVColorSpace colorspace () const {
71                 return video_codec_context()->colorspace;
72         }
73
74         boost::optional<int> bits_per_pixel () const;
75
76         boost::optional<double> rotation () const {
77                 return _rotation;
78         }
79
80         bool pulldown () const {
81                 return _pulldown;
82         }
83
84 #ifdef DCPOMATIC_VARIANT_SWAROOP
85         boost::optional<std::string> id () const {
86                 return _id;
87         }
88 #endif
89
90 private:
91         void video_packet (AVCodecContext *, std::string& temporal_reference);
92         void audio_packet (AVCodecContext *, boost::shared_ptr<FFmpegAudioStream>);
93
94         std::string stream_name (AVStream* s) const;
95         std::string subtitle_stream_name (AVStream* s) const;
96         boost::optional<dcpomatic::ContentTime> frame_time (AVStream* s) const;
97
98         std::vector<boost::shared_ptr<FFmpegSubtitleStream> > _subtitle_streams;
99         std::vector<boost::shared_ptr<FFmpegAudioStream> > _audio_streams;
100         boost::optional<dcpomatic::ContentTime> _first_video;
101         /** Video length, either obtained from the header or derived by running
102          *  through the whole file.
103          */
104         Frame _video_length;
105         bool _need_video_length;
106
107         boost::optional<double> _rotation;
108         bool _pulldown;
109
110 #ifdef DCPOMATIC_VARIANT_SWAROOP
111         boost::optional<std::string> _id;
112 #endif
113
114         struct SubtitleStart
115         {
116                 SubtitleStart (std::string id_, bool image_, dcpomatic::ContentTime time_)
117                         : id (id_)
118                         , image (image_)
119                         , time (time_)
120                 {}
121
122                 std::string id;
123                 /** true if it's an image subtitle, false for text */
124                 bool image;
125                 dcpomatic::ContentTime time;
126         };
127
128         typedef std::map<boost::shared_ptr<FFmpegSubtitleStream>, boost::optional<SubtitleStart> > LastSubtitleMap;
129         LastSubtitleMap _last_subtitle_start;
130 };