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