Fix some uninitialised variables.
[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 }
24 #include "ffmpeg_examiner.h"
25 #include "ffmpeg_content.h"
26 #include "job.h"
27 #include "ffmpeg_audio_stream.h"
28 #include "ffmpeg_subtitle_stream.h"
29 #include "util.h"
30 #include "safe_stringstream.h"
31
32 #include "i18n.h"
33
34 using std::string;
35 using std::cout;
36 using std::max;
37 using boost::shared_ptr;
38 using boost::optional;
39
40 /** @param job job that the examiner is operating in, or 0 */
41 FFmpegExaminer::FFmpegExaminer (shared_ptr<const FFmpegContent> c, shared_ptr<Job> job)
42         : FFmpeg (c)
43         , _video_length (0)
44         , _need_video_length (false)
45 {
46         /* Find audio and subtitle streams */
47
48         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
49                 AVStream* s = _format_context->streams[i];
50                 if (s->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
51
52                         /* This is a hack; sometimes it seems that _audio_codec_context->channel_layout isn't set up,
53                            so bodge it here.  No idea why we should have to do this.
54                         */
55
56                         if (s->codec->channel_layout == 0) {
57                                 s->codec->channel_layout = av_get_default_channel_layout (s->codec->channels);
58                         }
59                         
60                         _audio_streams.push_back (
61                                 shared_ptr<FFmpegAudioStream> (
62                                         new FFmpegAudioStream (audio_stream_name (s), s->id, s->codec->sample_rate, s->codec->channels)
63                                         )
64                                 );
65
66                 } else if (s->codec->codec_type == AVMEDIA_TYPE_SUBTITLE) {
67                         _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (subtitle_stream_name (s), s->id)));
68                 }
69         }
70
71         /* See if the header has duration information in it */
72         _need_video_length = _format_context->duration == AV_NOPTS_VALUE;
73         if (!_need_video_length) {
74                 _video_length = (double (_format_context->duration) / AV_TIME_BASE) * video_frame_rate().get ();
75         } else if (job) {
76                 job->sub (_("Finding length"));
77                 job->set_progress_unknown ();
78         }
79
80         /* Run through until we find:
81          *   - the first video.
82          *   - the first audio for each stream.
83          *   - the subtitle periods for each stream.
84          *
85          * We have to note subtitle periods as otherwise we have no way of knowing
86          * where we should look for subtitles (video and audio are always present,
87          * so they are ok).
88          */
89         while (true) {
90                 int r = av_read_frame (_format_context, &_packet);
91                 if (r < 0) {
92                         break;
93                 }
94
95                 AVCodecContext* context = _format_context->streams[_packet.stream_index]->codec;
96
97                 if (_packet.stream_index == _video_stream) {
98                         video_packet (context);
99                 }
100                 
101                 for (size_t i = 0; i < _audio_streams.size(); ++i) {
102                         if (_audio_streams[i]->uses_index (_format_context, _packet.stream_index)) {
103                                 audio_packet (context, _audio_streams[i]);
104                         }
105                 }
106
107                 for (size_t i = 0; i < _subtitle_streams.size(); ++i) {
108                         if (_subtitle_streams[i]->uses_index (_format_context, _packet.stream_index)) {
109                                 subtitle_packet (context, _subtitle_streams[i]);
110                         }
111                 }
112
113                 av_free_packet (&_packet);
114         }
115 }
116
117 void
118 FFmpegExaminer::video_packet (AVCodecContext* context)
119 {
120         if (_first_video && !_need_video_length) {
121                 return;
122         }
123
124         int frame_finished;
125         if (avcodec_decode_video2 (context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
126                 if (!_first_video) {
127                         _first_video = frame_time (_format_context->streams[_video_stream]);
128                 }
129                 if (_need_video_length) {
130                         _video_length = frame_time (
131                                 _format_context->streams[_video_stream]
132                                 ).get_value_or (ContentTime ()).frames (video_frame_rate().get ());
133                 }
134         }
135 }
136
137 void
138 FFmpegExaminer::audio_packet (AVCodecContext* context, shared_ptr<FFmpegAudioStream> stream)
139 {
140         if (stream->first_audio) {
141                 return;
142         }
143
144         int frame_finished;
145         if (avcodec_decode_audio4 (context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
146                 stream->first_audio = frame_time (stream->stream (_format_context));
147         }
148 }
149
150 void
151 FFmpegExaminer::subtitle_packet (AVCodecContext* context, shared_ptr<FFmpegSubtitleStream> stream)
152 {
153         int frame_finished;
154         AVSubtitle sub;
155         if (avcodec_decode_subtitle2 (context, &sub, &frame_finished, &_packet) >= 0 && frame_finished) {
156                 FFmpegSubtitlePeriod const period = subtitle_period (sub);
157                 if (sub.num_rects <= 0 && _last_subtitle_start) {
158                         stream->add_subtitle (ContentTimePeriod (_last_subtitle_start.get (), period.from));
159                         _last_subtitle_start = optional<ContentTime> ();
160                 } else if (sub.num_rects == 1) {
161                         if (period.to) {
162                                 stream->add_subtitle (ContentTimePeriod (period.from, period.to.get ()));
163                         } else {
164                                 _last_subtitle_start = period.from;
165                         }
166                 }
167                 avsubtitle_free (&sub);
168         }
169 }
170
171 optional<ContentTime>
172 FFmpegExaminer::frame_time (AVStream* s) const
173 {
174         optional<ContentTime> t;
175         
176         int64_t const bet = av_frame_get_best_effort_timestamp (_frame);
177         if (bet != AV_NOPTS_VALUE) {
178                 t = ContentTime::from_seconds (bet * av_q2d (s->time_base));
179         }
180
181         return t;
182 }
183
184 optional<float>
185 FFmpegExaminer::video_frame_rate () const
186 {
187         /* This use of r_frame_rate is debateable; there's a few different
188          * frame rates in the format context, but this one seems to be the most
189          * reliable.
190          */
191         return av_q2d (av_stream_get_r_frame_rate (_format_context->streams[_video_stream]));
192 }
193
194 dcp::Size
195 FFmpegExaminer::video_size () const
196 {
197         return dcp::Size (video_codec_context()->width, video_codec_context()->height);
198 }
199
200 /** @return Length according to our content's header */
201 Frame
202 FFmpegExaminer::video_length () const
203 {
204         return max (Frame (1), _video_length);
205 }
206
207 optional<float>
208 FFmpegExaminer::sample_aspect_ratio () const
209 {
210         AVRational sar = av_guess_sample_aspect_ratio (_format_context, _format_context->streams[_video_stream], 0);
211         if (sar.num == 0) {
212                 /* I assume this means that we don't know */
213                 return optional<float> ();
214         }
215         return float (sar.num) / sar.den;
216 }
217
218 string
219 FFmpegExaminer::audio_stream_name (AVStream* s) const
220 {
221         SafeStringStream n;
222
223         n << stream_name (s);
224
225         if (!n.str().empty()) {
226                 n << "; ";
227         }
228
229         n << s->codec->channels << " channels";
230
231         return n.str ();
232 }
233
234 string
235 FFmpegExaminer::subtitle_stream_name (AVStream* s) const
236 {
237         SafeStringStream n;
238
239         n << stream_name (s);
240
241         if (n.str().empty()) {
242                 n << _("unknown");
243         }
244
245         return n.str ();
246 }
247
248 string
249 FFmpegExaminer::stream_name (AVStream* s) const
250 {
251         SafeStringStream n;
252
253         if (s->metadata) {
254                 AVDictionaryEntry const * lang = av_dict_get (s->metadata, "language", 0, 0);
255                 if (lang) {
256                         n << lang->value;
257                 }
258                 
259                 AVDictionaryEntry const * title = av_dict_get (s->metadata, "title", 0, 0);
260                 if (title) {
261                         if (!n.str().empty()) {
262                                 n << " ";
263                         }
264                         n << title->value;
265                 }
266         }
267
268         return n.str ();
269 }