6ed7b06fea050cc33f04763978283025456fbb9e
[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
96         while (true) {
97                 int r = av_read_frame (_format_context, &_packet);
98                 if (r < 0) {
99                         break;
100                 }
101
102                 if (job) {
103                         job->set_progress_unknown ();
104                 }
105
106                 AVCodecContext* context = _format_context->streams[_packet.stream_index]->codec;
107
108                 if (_packet.stream_index == _video_stream) {
109                         video_packet (context);
110                 }
111
112                 bool got_all_audio = true;
113
114                 for (size_t i = 0; i < _audio_streams.size(); ++i) {
115                         if (_audio_streams[i]->uses_index (_format_context, _packet.stream_index)) {
116                                 audio_packet (context, _audio_streams[i]);
117                         }
118                         if (!_audio_streams[i]->first_audio) {
119                                 got_all_audio = false;
120                         }
121                 }
122
123                 for (size_t i = 0; i < _subtitle_streams.size(); ++i) {
124                         if (_subtitle_streams[i]->uses_index (_format_context, _packet.stream_index)) {
125                                 subtitle_packet (context, _subtitle_streams[i]);
126                         }
127                 }
128
129                 av_free_packet (&_packet);
130
131                 if (_first_video && got_all_audio && _subtitle_streams.empty ()) {
132                         /* All done */
133                         break;
134                 }
135         }
136 }
137
138 void
139 FFmpegExaminer::video_packet (AVCodecContext* context)
140 {
141         if (_first_video && !_need_video_length) {
142                 return;
143         }
144
145         int frame_finished;
146         if (avcodec_decode_video2 (context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
147                 if (!_first_video) {
148                         _first_video = frame_time (_format_context->streams[_video_stream]);
149                 }
150                 if (_need_video_length) {
151                         _video_length = frame_time (
152                                 _format_context->streams[_video_stream]
153                                 ).get_value_or (ContentTime ()).frames_round (video_frame_rate().get ());
154                 }
155         }
156 }
157
158 void
159 FFmpegExaminer::audio_packet (AVCodecContext* context, shared_ptr<FFmpegAudioStream> stream)
160 {
161         if (stream->first_audio) {
162                 return;
163         }
164
165         int frame_finished;
166         if (avcodec_decode_audio4 (context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
167                 stream->first_audio = frame_time (stream->stream (_format_context));
168         }
169 }
170
171 void
172 FFmpegExaminer::subtitle_packet (AVCodecContext* context, shared_ptr<FFmpegSubtitleStream> stream)
173 {
174         int frame_finished;
175         AVSubtitle sub;
176         if (avcodec_decode_subtitle2 (context, &sub, &frame_finished, &_packet) >= 0 && frame_finished) {
177                 FFmpegSubtitlePeriod const period = subtitle_period (sub);
178                 if (sub.num_rects <= 0 && _last_subtitle_start) {
179                         stream->add_subtitle (ContentTimePeriod (_last_subtitle_start.get (), period.from));
180                         _last_subtitle_start = optional<ContentTime> ();
181                 } else if (sub.num_rects == 1) {
182                         if (period.to) {
183                                 stream->add_subtitle (ContentTimePeriod (period.from, period.to.get ()));
184                         } else {
185                                 _last_subtitle_start = period.from;
186                         }
187                 }
188                 avsubtitle_free (&sub);
189         }
190 }
191
192 optional<ContentTime>
193 FFmpegExaminer::frame_time (AVStream* s) const
194 {
195         optional<ContentTime> t;
196
197         int64_t const bet = av_frame_get_best_effort_timestamp (_frame);
198         if (bet != AV_NOPTS_VALUE) {
199                 t = ContentTime::from_seconds (bet * av_q2d (s->time_base));
200         }
201
202         return t;
203 }
204
205 optional<double>
206 FFmpegExaminer::video_frame_rate () const
207 {
208         /* This use of r_frame_rate is debateable; there's a few different
209          * frame rates in the format context, but this one seems to be the most
210          * reliable.
211          */
212         return av_q2d (av_stream_get_r_frame_rate (_format_context->streams[_video_stream]));
213 }
214
215 dcp::Size
216 FFmpegExaminer::video_size () const
217 {
218         return dcp::Size (video_codec_context()->width, video_codec_context()->height);
219 }
220
221 /** @return Length according to our content's header */
222 Frame
223 FFmpegExaminer::video_length () const
224 {
225         return max (Frame (1), _video_length);
226 }
227
228 optional<double>
229 FFmpegExaminer::sample_aspect_ratio () const
230 {
231         AVRational sar = av_guess_sample_aspect_ratio (_format_context, _format_context->streams[_video_stream], 0);
232         if (sar.num == 0) {
233                 /* I assume this means that we don't know */
234                 return optional<double> ();
235         }
236         return double (sar.num) / sar.den;
237 }
238
239 string
240 FFmpegExaminer::audio_stream_name (AVStream* s) const
241 {
242         SafeStringStream n;
243
244         n << stream_name (s);
245
246         if (!n.str().empty()) {
247                 n << "; ";
248         }
249
250         n << s->codec->channels << " channels";
251
252         return n.str ();
253 }
254
255 string
256 FFmpegExaminer::subtitle_stream_name (AVStream* s) const
257 {
258         SafeStringStream n;
259
260         n << stream_name (s);
261
262         if (n.str().empty()) {
263                 n << _("unknown");
264         }
265
266         return n.str ();
267 }
268
269 string
270 FFmpegExaminer::stream_name (AVStream* s) const
271 {
272         SafeStringStream n;
273
274         if (s->metadata) {
275                 AVDictionaryEntry const * lang = av_dict_get (s->metadata, "language", 0, 0);
276                 if (lang) {
277                         n << lang->value;
278                 }
279
280                 AVDictionaryEntry const * title = av_dict_get (s->metadata, "title", 0, 0);
281                 if (title) {
282                         if (!n.str().empty()) {
283                                 n << " ";
284                         }
285                         n << title->value;
286                 }
287         }
288
289         return n.str ();
290 }
291
292 int
293 FFmpegExaminer::bits_per_pixel () const
294 {
295         return av_get_bits_per_pixel (av_pix_fmt_desc_get (video_codec_context()->pix_fmt));
296 }