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