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