Add bits per pixel to video content properties.
[dcpomatic.git] / src / lib / ffmpeg_examiner.cc
1 /*
2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 extern "C" {
21 #include <libavcodec/avcodec.h>
22 #include <libavformat/avformat.h>
23 #include <libavutil/pixfmt.h>
24 #include <libavutil/pixdesc.h>
25 }
26 #include "ffmpeg_examiner.h"
27 #include "ffmpeg_content.h"
28 #include "job.h"
29 #include "ffmpeg_audio_stream.h"
30 #include "ffmpeg_subtitle_stream.h"
31 #include "util.h"
32 #include "safe_stringstream.h"
33
34 #include "i18n.h"
35
36 using std::string;
37 using std::cout;
38 using std::max;
39 using boost::shared_ptr;
40 using boost::optional;
41
42 /** @param job job that the examiner is operating in, or 0 */
43 FFmpegExaminer::FFmpegExaminer (shared_ptr<const FFmpegContent> c, shared_ptr<Job> job)
44         : FFmpeg (c)
45         , _video_length (0)
46         , _need_video_length (false)
47 {
48         /* Find audio and subtitle streams */
49
50         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
51                 AVStream* s = _format_context->streams[i];
52                 if (s->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
53
54                         /* This is a hack; sometimes it seems that _audio_codec_context->channel_layout isn't set up,
55                            so bodge it here.  No idea why we should have to do this.
56                         */
57
58                         if (s->codec->channel_layout == 0) {
59                                 s->codec->channel_layout = av_get_default_channel_layout (s->codec->channels);
60                         }
61
62                         _audio_streams.push_back (
63                                 shared_ptr<FFmpegAudioStream> (
64                                         new FFmpegAudioStream (audio_stream_name (s), s->id, s->codec->sample_rate, s->codec->channels)
65                                         )
66                                 );
67
68                 } else if (s->codec->codec_type == AVMEDIA_TYPE_SUBTITLE) {
69                         _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (subtitle_stream_name (s), s->id)));
70                 }
71         }
72
73         /* See if the header has duration information in it */
74         _need_video_length = _format_context->duration == AV_NOPTS_VALUE;
75         if (!_need_video_length) {
76                 _video_length = (double (_format_context->duration) / AV_TIME_BASE) * video_frame_rate().get ();
77         } else if (job) {
78                 job->sub (_("Finding length"));
79                 job->set_progress_unknown ();
80         }
81
82         if (job) {
83                 job->sub (_("Finding subtitles"));
84         }
85
86         /* Run through until we find:
87          *   - the first video.
88          *   - the first audio for each stream.
89          *   - the subtitle periods for each stream.
90          *
91          * We have to note subtitle periods as otherwise we have no way of knowing
92          * where we should look for subtitles (video and audio are always present,
93          * so they are ok).
94          */
95         while (true) {
96                 int r = av_read_frame (_format_context, &_packet);
97                 if (r < 0) {
98                         break;
99                 }
100
101                 if (job) {
102                         job->set_progress_unknown ();
103                 }
104
105                 AVCodecContext* context = _format_context->streams[_packet.stream_index]->codec;
106
107                 if (_packet.stream_index == _video_stream) {
108                         video_packet (context);
109                 }
110
111                 for (size_t i = 0; i < _audio_streams.size(); ++i) {
112                         if (_audio_streams[i]->uses_index (_format_context, _packet.stream_index)) {
113                                 audio_packet (context, _audio_streams[i]);
114                         }
115                 }
116
117                 for (size_t i = 0; i < _subtitle_streams.size(); ++i) {
118                         if (_subtitle_streams[i]->uses_index (_format_context, _packet.stream_index)) {
119                                 subtitle_packet (context, _subtitle_streams[i]);
120                         }
121                 }
122
123                 av_free_packet (&_packet);
124         }
125 }
126
127 void
128 FFmpegExaminer::video_packet (AVCodecContext* context)
129 {
130         if (_first_video && !_need_video_length) {
131                 return;
132         }
133
134         int frame_finished;
135         if (avcodec_decode_video2 (context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
136                 if (!_first_video) {
137                         _first_video = frame_time (_format_context->streams[_video_stream]);
138                 }
139                 if (_need_video_length) {
140                         _video_length = frame_time (
141                                 _format_context->streams[_video_stream]
142                                 ).get_value_or (ContentTime ()).frames (video_frame_rate().get ());
143                 }
144         }
145 }
146
147 void
148 FFmpegExaminer::audio_packet (AVCodecContext* context, shared_ptr<FFmpegAudioStream> stream)
149 {
150         if (stream->first_audio) {
151                 return;
152         }
153
154         int frame_finished;
155         if (avcodec_decode_audio4 (context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
156                 stream->first_audio = frame_time (stream->stream (_format_context));
157         }
158 }
159
160 void
161 FFmpegExaminer::subtitle_packet (AVCodecContext* context, shared_ptr<FFmpegSubtitleStream> stream)
162 {
163         int frame_finished;
164         AVSubtitle sub;
165         if (avcodec_decode_subtitle2 (context, &sub, &frame_finished, &_packet) >= 0 && frame_finished) {
166                 FFmpegSubtitlePeriod const period = subtitle_period (sub);
167                 if (sub.num_rects <= 0 && _last_subtitle_start) {
168                         stream->add_subtitle (ContentTimePeriod (_last_subtitle_start.get (), period.from));
169                         _last_subtitle_start = optional<ContentTime> ();
170                 } else if (sub.num_rects == 1) {
171                         if (period.to) {
172                                 stream->add_subtitle (ContentTimePeriod (period.from, period.to.get ()));
173                         } else {
174                                 _last_subtitle_start = period.from;
175                         }
176                 }
177                 avsubtitle_free (&sub);
178         }
179 }
180
181 optional<ContentTime>
182 FFmpegExaminer::frame_time (AVStream* s) const
183 {
184         optional<ContentTime> t;
185
186         int64_t const bet = av_frame_get_best_effort_timestamp (_frame);
187         if (bet != AV_NOPTS_VALUE) {
188                 t = ContentTime::from_seconds (bet * av_q2d (s->time_base));
189         }
190
191         return t;
192 }
193
194 optional<float>
195 FFmpegExaminer::video_frame_rate () const
196 {
197         /* This use of r_frame_rate is debateable; there's a few different
198          * frame rates in the format context, but this one seems to be the most
199          * reliable.
200          */
201         return av_q2d (av_stream_get_r_frame_rate (_format_context->streams[_video_stream]));
202 }
203
204 dcp::Size
205 FFmpegExaminer::video_size () const
206 {
207         return dcp::Size (video_codec_context()->width, video_codec_context()->height);
208 }
209
210 /** @return Length according to our content's header */
211 Frame
212 FFmpegExaminer::video_length () const
213 {
214         return max (Frame (1), _video_length);
215 }
216
217 optional<float>
218 FFmpegExaminer::sample_aspect_ratio () const
219 {
220         AVRational sar = av_guess_sample_aspect_ratio (_format_context, _format_context->streams[_video_stream], 0);
221         if (sar.num == 0) {
222                 /* I assume this means that we don't know */
223                 return optional<float> ();
224         }
225         return float (sar.num) / sar.den;
226 }
227
228 string
229 FFmpegExaminer::audio_stream_name (AVStream* s) const
230 {
231         SafeStringStream n;
232
233         n << stream_name (s);
234
235         if (!n.str().empty()) {
236                 n << "; ";
237         }
238
239         n << s->codec->channels << " channels";
240
241         return n.str ();
242 }
243
244 string
245 FFmpegExaminer::subtitle_stream_name (AVStream* s) const
246 {
247         SafeStringStream n;
248
249         n << stream_name (s);
250
251         if (n.str().empty()) {
252                 n << _("unknown");
253         }
254
255         return n.str ();
256 }
257
258 string
259 FFmpegExaminer::stream_name (AVStream* s) const
260 {
261         SafeStringStream n;
262
263         if (s->metadata) {
264                 AVDictionaryEntry const * lang = av_dict_get (s->metadata, "language", 0, 0);
265                 if (lang) {
266                         n << lang->value;
267                 }
268
269                 AVDictionaryEntry const * title = av_dict_get (s->metadata, "title", 0, 0);
270                 if (title) {
271                         if (!n.str().empty()) {
272                                 n << " ";
273                         }
274                         n << title->value;
275                 }
276         }
277
278         return n.str ();
279 }
280
281 int
282 FFmpegExaminer::bits_per_pixel () const
283 {
284         return av_get_bits_per_pixel (av_pix_fmt_desc_get (video_codec_context()->pix_fmt));
285 }