Support new libdcp with subtitle direction.
[dcpomatic.git] / src / lib / ffmpeg_decoder.cc
1 /*
2     Copyright (C) 2012-2016 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 /** @file  src/ffmpeg_decoder.cc
21  *  @brief A decoder using FFmpeg to decode content.
22  */
23
24 #include "filter.h"
25 #include "exceptions.h"
26 #include "image.h"
27 #include "util.h"
28 #include "log.h"
29 #include "ffmpeg_decoder.h"
30 #include "ffmpeg_audio_stream.h"
31 #include "ffmpeg_subtitle_stream.h"
32 #include "video_filter_graph.h"
33 #include "audio_buffers.h"
34 #include "ffmpeg_content.h"
35 #include "raw_image_proxy.h"
36 #include "film.h"
37 #include "md5_digester.h"
38 #include "compose.hpp"
39 #include <dcp/subtitle_string.h>
40 #include <sub/ssa_reader.h>
41 #include <sub/subtitle.h>
42 #include <sub/collect.h>
43 extern "C" {
44 #include <libavcodec/avcodec.h>
45 #include <libavformat/avformat.h>
46 }
47 #include <boost/foreach.hpp>
48 #include <boost/algorithm/string.hpp>
49 #include <vector>
50 #include <iomanip>
51 #include <iostream>
52 #include <stdint.h>
53
54 #include "i18n.h"
55
56 #define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
57 #define LOG_ERROR(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
58 #define LOG_WARNING_NC(...) _log->log (__VA_ARGS__, LogEntry::TYPE_WARNING);
59 #define LOG_WARNING(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_WARNING);
60
61 using std::cout;
62 using std::string;
63 using std::vector;
64 using std::list;
65 using std::min;
66 using std::pair;
67 using std::max;
68 using std::map;
69 using boost::shared_ptr;
70 using boost::is_any_of;
71 using boost::split;
72 using dcp::Size;
73
74 FFmpegDecoder::FFmpegDecoder (shared_ptr<const FFmpegContent> c, shared_ptr<Log> log, bool fast)
75         : VideoDecoder (c)
76         , AudioDecoder (c, fast)
77         , SubtitleDecoder (c)
78         , FFmpeg (c)
79         , _log (log)
80         , _pts_offset (pts_offset (c->ffmpeg_audio_streams(), c->first_video(), c->video_frame_rate()))
81 {
82
83 }
84
85 void
86 FFmpegDecoder::flush ()
87 {
88         /* Get any remaining frames */
89
90         _packet.data = 0;
91         _packet.size = 0;
92
93         /* XXX: should we reset _packet.data and size after each *_decode_* call? */
94
95         while (decode_video_packet ()) {}
96
97         decode_audio_packet ();
98         AudioDecoder::flush ();
99 }
100
101 bool
102 FFmpegDecoder::pass (PassReason reason, bool accurate)
103 {
104         int r = av_read_frame (_format_context, &_packet);
105
106         /* AVERROR_INVALIDDATA can apparently be returned sometimes even when av_read_frame
107            has pretty-much succeeded (and hence generated data which should be processed).
108            Hence it makes sense to continue here in that case.
109         */
110         if (r < 0 && r != AVERROR_INVALIDDATA) {
111                 if (r != AVERROR_EOF) {
112                         /* Maybe we should fail here, but for now we'll just finish off instead */
113                         char buf[256];
114                         av_strerror (r, buf, sizeof(buf));
115                         LOG_ERROR (N_("error on av_read_frame (%1) (%2)"), buf, r);
116                 }
117
118                 flush ();
119                 return true;
120         }
121
122         int const si = _packet.stream_index;
123         shared_ptr<const FFmpegContent> fc = _ffmpeg_content;
124
125         if (si == _video_stream && !_ignore_video && (accurate || reason != PASS_REASON_SUBTITLE)) {
126                 decode_video_packet ();
127         } else if (fc->subtitle_stream() && fc->subtitle_stream()->uses_index (_format_context, si)) {
128                 decode_subtitle_packet ();
129         } else if (accurate || reason != PASS_REASON_SUBTITLE) {
130                 decode_audio_packet ();
131         }
132
133         av_packet_unref (&_packet);
134         return false;
135 }
136
137 /** @param data pointer to array of pointers to buffers.
138  *  Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
139  */
140 shared_ptr<AudioBuffers>
141 FFmpegDecoder::deinterleave_audio (shared_ptr<FFmpegAudioStream> stream) const
142 {
143         DCPOMATIC_ASSERT (bytes_per_audio_sample (stream));
144
145         int const size = av_samples_get_buffer_size (
146                 0, stream->stream(_format_context)->codec->channels, _frame->nb_samples, audio_sample_format (stream), 1
147                 );
148
149         /* Deinterleave and convert to float */
150
151         /* total_samples and frames will be rounded down here, so if there are stray samples at the end
152            of the block that do not form a complete sample or frame they will be dropped.
153         */
154         int const total_samples = size / bytes_per_audio_sample (stream);
155         int const frames = total_samples / stream->channels();
156         shared_ptr<AudioBuffers> audio (new AudioBuffers (stream->channels(), frames));
157
158         switch (audio_sample_format (stream)) {
159         case AV_SAMPLE_FMT_U8:
160         {
161                 uint8_t* p = reinterpret_cast<uint8_t *> (_frame->data[0]);
162                 int sample = 0;
163                 int channel = 0;
164                 for (int i = 0; i < total_samples; ++i) {
165                         audio->data(channel)[sample] = float(*p++) / (1 << 23);
166
167                         ++channel;
168                         if (channel == stream->channels()) {
169                                 channel = 0;
170                                 ++sample;
171                         }
172                 }
173         }
174         break;
175
176         case AV_SAMPLE_FMT_S16:
177         {
178                 int16_t* p = reinterpret_cast<int16_t *> (_frame->data[0]);
179                 int sample = 0;
180                 int channel = 0;
181                 for (int i = 0; i < total_samples; ++i) {
182                         audio->data(channel)[sample] = float(*p++) / (1 << 15);
183
184                         ++channel;
185                         if (channel == stream->channels()) {
186                                 channel = 0;
187                                 ++sample;
188                         }
189                 }
190         }
191         break;
192
193         case AV_SAMPLE_FMT_S16P:
194         {
195                 int16_t** p = reinterpret_cast<int16_t **> (_frame->data);
196                 for (int i = 0; i < stream->channels(); ++i) {
197                         for (int j = 0; j < frames; ++j) {
198                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
199                         }
200                 }
201         }
202         break;
203
204         case AV_SAMPLE_FMT_S32:
205         {
206                 int32_t* p = reinterpret_cast<int32_t *> (_frame->data[0]);
207                 int sample = 0;
208                 int channel = 0;
209                 for (int i = 0; i < total_samples; ++i) {
210                         audio->data(channel)[sample] = static_cast<float>(*p++) / (1 << 31);
211
212                         ++channel;
213                         if (channel == stream->channels()) {
214                                 channel = 0;
215                                 ++sample;
216                         }
217                 }
218         }
219         break;
220
221         case AV_SAMPLE_FMT_S32P:
222         {
223                 int32_t** p = reinterpret_cast<int32_t **> (_frame->data);
224                 for (int i = 0; i < stream->channels(); ++i) {
225                         for (int j = 0; j < frames; ++j) {
226                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 31);
227                         }
228                 }
229         }
230         break;
231
232         case AV_SAMPLE_FMT_FLT:
233         {
234                 float* p = reinterpret_cast<float*> (_frame->data[0]);
235                 int sample = 0;
236                 int channel = 0;
237                 for (int i = 0; i < total_samples; ++i) {
238                         audio->data(channel)[sample] = *p++;
239
240                         ++channel;
241                         if (channel == stream->channels()) {
242                                 channel = 0;
243                                 ++sample;
244                         }
245                 }
246         }
247         break;
248
249         case AV_SAMPLE_FMT_FLTP:
250         {
251                 float** p = reinterpret_cast<float**> (_frame->data);
252                 /* Sometimes there aren't as many channels in the _frame as in the stream */
253                 for (int i = 0; i < _frame->channels; ++i) {
254                         memcpy (audio->data(i), p[i], frames * sizeof(float));
255                 }
256                 for (int i = _frame->channels; i < stream->channels(); ++i) {
257                         audio->make_silent (i);
258                 }
259         }
260         break;
261
262         default:
263                 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format (stream))));
264         }
265
266         return audio;
267 }
268
269 AVSampleFormat
270 FFmpegDecoder::audio_sample_format (shared_ptr<FFmpegAudioStream> stream) const
271 {
272         return stream->stream (_format_context)->codec->sample_fmt;
273 }
274
275 int
276 FFmpegDecoder::bytes_per_audio_sample (shared_ptr<FFmpegAudioStream> stream) const
277 {
278         return av_get_bytes_per_sample (audio_sample_format (stream));
279 }
280
281 void
282 FFmpegDecoder::seek (ContentTime time, bool accurate)
283 {
284         VideoDecoder::seek (time, accurate);
285         AudioDecoder::seek (time, accurate);
286         SubtitleDecoder::seek (time, accurate);
287
288         /* If we are doing an `accurate' seek, we need to use pre-roll, as
289            we don't really know what the seek will give us.
290         */
291
292         ContentTime pre_roll = accurate ? ContentTime::from_seconds (2) : ContentTime (0);
293         time -= pre_roll;
294
295         /* XXX: it seems debatable whether PTS should be used here...
296            http://www.mjbshaw.com/2012/04/seeking-in-ffmpeg-know-your-timestamp.html
297         */
298
299         ContentTime u = time - _pts_offset;
300         if (u < ContentTime ()) {
301                 u = ContentTime ();
302         }
303         av_seek_frame (_format_context, _video_stream, u.seconds() / av_q2d (_format_context->streams[_video_stream]->time_base), AVSEEK_FLAG_BACKWARD);
304
305         avcodec_flush_buffers (video_codec_context());
306
307         /* XXX: should be flushing audio buffers? */
308
309         if (subtitle_codec_context ()) {
310                 avcodec_flush_buffers (subtitle_codec_context ());
311         }
312 }
313
314 void
315 FFmpegDecoder::decode_audio_packet ()
316 {
317         /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
318            several times.
319         */
320
321         AVPacket copy_packet = _packet;
322
323         /* XXX: inefficient */
324         vector<shared_ptr<FFmpegAudioStream> > streams = ffmpeg_content()->ffmpeg_audio_streams ();
325         vector<shared_ptr<FFmpegAudioStream> >::const_iterator stream = streams.begin ();
326         while (stream != streams.end () && !(*stream)->uses_index (_format_context, copy_packet.stream_index)) {
327                 ++stream;
328         }
329
330         if (stream == streams.end ()) {
331                 /* The packet's stream may not be an audio one; just ignore it in this method if so */
332                 return;
333         }
334
335         while (copy_packet.size > 0) {
336
337                 int frame_finished;
338                 int decode_result = avcodec_decode_audio4 ((*stream)->stream (_format_context)->codec, _frame, &frame_finished, &copy_packet);
339                 if (decode_result < 0) {
340                         /* avcodec_decode_audio4 can sometimes return an error even though it has decoded
341                            some valid data; for example dca_subframe_footer can return AVERROR_INVALIDDATA
342                            if it overreads the auxiliary data.  ffplay carries on if frame_finished is true,
343                            even in the face of such an error, so I think we should too.
344
345                            Returning from the method here caused mantis #352.
346                         */
347                         LOG_WARNING ("avcodec_decode_audio4 failed (%1)", decode_result);
348
349                         /* Fudge decode_result so that we come out of the while loop when
350                            we've processed this data.
351                         */
352                         decode_result = copy_packet.size;
353                 }
354
355                 if (frame_finished) {
356                         ContentTime ct = ContentTime::from_seconds (
357                                 av_frame_get_best_effort_timestamp (_frame) *
358                                 av_q2d ((*stream)->stream (_format_context)->time_base))
359                                 + _pts_offset;
360
361                         shared_ptr<AudioBuffers> data = deinterleave_audio (*stream);
362
363                         if (ct < ContentTime ()) {
364                                 /* Discard audio data that comes before time 0 */
365                                 Frame const remove = min (int64_t (data->frames()), (-ct).frames_ceil(double((*stream)->frame_rate ())));
366                                 data->move (remove, 0, data->frames() - remove);
367                                 data->set_frames (data->frames() - remove);
368                                 ct += ContentTime::from_frames (remove, (*stream)->frame_rate ());
369                         }
370
371                         if (data->frames() > 0) {
372                                 audio (*stream, data, ct);
373                         }
374                 }
375
376                 copy_packet.data += decode_result;
377                 copy_packet.size -= decode_result;
378         }
379 }
380
381 bool
382 FFmpegDecoder::decode_video_packet ()
383 {
384         int frame_finished;
385         if (avcodec_decode_video2 (video_codec_context(), _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
386                 return false;
387         }
388
389         boost::mutex::scoped_lock lm (_filter_graphs_mutex);
390
391         shared_ptr<VideoFilterGraph> graph;
392
393         list<shared_ptr<VideoFilterGraph> >::iterator i = _filter_graphs.begin();
394         while (i != _filter_graphs.end() && !(*i)->can_process (dcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
395                 ++i;
396         }
397
398         if (i == _filter_graphs.end ()) {
399                 graph.reset (new VideoFilterGraph (dcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
400                 graph->setup (_ffmpeg_content->filters ());
401                 _filter_graphs.push_back (graph);
402                 LOG_GENERAL (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format);
403         } else {
404                 graph = *i;
405         }
406
407         list<pair<shared_ptr<Image>, int64_t> > images = graph->process (_frame);
408
409         for (list<pair<shared_ptr<Image>, int64_t> >::iterator i = images.begin(); i != images.end(); ++i) {
410
411                 shared_ptr<Image> image = i->first;
412
413                 if (i->second != AV_NOPTS_VALUE) {
414                         double const pts = i->second * av_q2d (_format_context->streams[_video_stream]->time_base) + _pts_offset.seconds ();
415                         video (
416                                 shared_ptr<ImageProxy> (new RawImageProxy (image)),
417                                 llrint (pts * _ffmpeg_content->video_frame_rate ())
418                                 );
419                 } else {
420                         LOG_WARNING_NC ("Dropping frame without PTS");
421                 }
422         }
423
424         return true;
425 }
426
427 void
428 FFmpegDecoder::decode_subtitle_packet ()
429 {
430         int got_subtitle;
431         AVSubtitle sub;
432         if (avcodec_decode_subtitle2 (subtitle_codec_context(), &sub, &got_subtitle, &_packet) < 0 || !got_subtitle) {
433                 return;
434         }
435
436         if (sub.num_rects <= 0) {
437                 /* Sometimes we get an empty AVSubtitle, which is used by some codecs to
438                    indicate that the previous subtitle should stop.  We can ignore it here.
439                 */
440                 return;
441         }
442
443         /* Subtitle PTS (within the source, not taking into account any of the
444            source that we may have chopped off for the DCP).
445         */
446         FFmpegSubtitlePeriod sub_period = subtitle_period (sub);
447         ContentTimePeriod period;
448         period.from = sub_period.from + _pts_offset;
449         if (sub_period.to) {
450                 /* We already know the subtitle period `to' time */
451                 period.to = sub_period.to.get() + _pts_offset;
452         } else {
453                 /* We have to look up the `to' time in the stream's records */
454                 period.to = ffmpeg_content()->subtitle_stream()->find_subtitle_to (subtitle_id (sub));
455         }
456
457         for (unsigned int i = 0; i < sub.num_rects; ++i) {
458                 AVSubtitleRect const * rect = sub.rects[i];
459
460                 switch (rect->type) {
461                 case SUBTITLE_NONE:
462                         break;
463                 case SUBTITLE_BITMAP:
464                         decode_bitmap_subtitle (rect, period);
465                         break;
466                 case SUBTITLE_TEXT:
467                         cout << "XXX: SUBTITLE_TEXT " << rect->text << "\n";
468                         break;
469                 case SUBTITLE_ASS:
470                         decode_ass_subtitle (rect->ass, period);
471                         break;
472                 }
473         }
474
475         avsubtitle_free (&sub);
476 }
477
478 list<ContentTimePeriod>
479 FFmpegDecoder::image_subtitles_during (ContentTimePeriod p, bool starting) const
480 {
481         return _ffmpeg_content->image_subtitles_during (p, starting);
482 }
483
484 list<ContentTimePeriod>
485 FFmpegDecoder::text_subtitles_during (ContentTimePeriod p, bool starting) const
486 {
487         return _ffmpeg_content->text_subtitles_during (p, starting);
488 }
489
490 void
491 FFmpegDecoder::decode_bitmap_subtitle (AVSubtitleRect const * rect, ContentTimePeriod period)
492 {
493         /* Note RGBA is expressed little-endian, so the first byte in the word is R, second
494            G, third B, fourth A.
495         */
496         shared_ptr<Image> image (new Image (AV_PIX_FMT_RGBA, dcp::Size (rect->w, rect->h), true));
497
498         /* Start of the first line in the subtitle */
499         uint8_t* sub_p = rect->data[0];
500         /* sub_p looks up into a BGRA palette which is here
501            (i.e. first byte B, second G, third R, fourth A)
502         */
503         uint32_t const * palette = (uint32_t *) rect->data[1];
504         /* And the stream has a map of those palette colours to colours
505            chosen by the user; created a `mapped' palette from those settings.
506         */
507         map<RGBA, RGBA> colour_map = ffmpeg_content()->subtitle_stream()->colours ();
508         vector<RGBA> mapped_palette (rect->nb_colors);
509         for (int i = 0; i < rect->nb_colors; ++i) {
510                 RGBA c ((palette[i] & 0xff0000) >> 16, (palette[i] & 0xff00) >> 8, palette[i] & 0xff, (palette[i] & 0xff000000) >> 24);
511                 map<RGBA, RGBA>::const_iterator j = colour_map.find (c);
512                 if (j != colour_map.end ()) {
513                         mapped_palette[i] = j->second;
514                 } else {
515                         /* This colour was not found in the FFmpegSubtitleStream's colour map; probably because
516                            it is from a project that was created before this stuff was added.  Just use the
517                            colour straight from the original palette.
518                         */
519                         mapped_palette[i] = c;
520                 }
521         }
522
523         /* Start of the output data */
524         uint32_t* out_p = (uint32_t *) image->data()[0];
525
526         for (int y = 0; y < rect->h; ++y) {
527                 uint8_t* sub_line_p = sub_p;
528                 uint32_t* out_line_p = out_p;
529                 for (int x = 0; x < rect->w; ++x) {
530                         RGBA const p = mapped_palette[*sub_line_p++];
531                         /* XXX: this seems to be wrong to me (isn't the output image RGBA?) but it looks right on screen */
532                         *out_line_p++ = (p.a << 24) | (p.r << 16) | (p.g << 8) | p.b;
533                 }
534                 sub_p += rect->linesize[0];
535                 out_p += image->stride()[0] / sizeof (uint32_t);
536         }
537
538         dcp::Size const vs = _ffmpeg_content->video_size ();
539         dcpomatic::Rect<double> const scaled_rect (
540                 static_cast<double> (rect->x) / vs.width,
541                 static_cast<double> (rect->y) / vs.height,
542                 static_cast<double> (rect->w) / vs.width,
543                 static_cast<double> (rect->h) / vs.height
544                 );
545
546         image_subtitle (period, image, scaled_rect);
547 }
548
549 void
550 FFmpegDecoder::decode_ass_subtitle (string ass, ContentTimePeriod period)
551 {
552         /* We have no styles and no Format: line, so I'm assuming that FFmpeg
553            produces a single format of Dialogue: lines...
554         */
555
556         vector<string> bits;
557         split (bits, ass, is_any_of (","));
558         if (bits.size() < 10) {
559                 return;
560         }
561
562         sub::RawSubtitle base;
563         list<sub::RawSubtitle> raw = sub::SSAReader::parse_line (base, bits[9]);
564         list<sub::Subtitle> subs = sub::collect<list<sub::Subtitle> > (raw);
565
566         /* XXX: lots of this is copied from TextSubtitle; there should probably be some sharing */
567
568         /* Highest line index in this subtitle */
569         int highest = 0;
570         BOOST_FOREACH (sub::Subtitle i, subs) {
571                 BOOST_FOREACH (sub::Line j, i.lines) {
572                         DCPOMATIC_ASSERT (j.vertical_position.reference && j.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE);
573                         DCPOMATIC_ASSERT (j.vertical_position.line);
574                         highest = max (highest, j.vertical_position.line.get());
575                 }
576         }
577
578         list<dcp::SubtitleString> ss;
579
580         BOOST_FOREACH (sub::Subtitle i, sub::collect<list<sub::Subtitle> > (sub::SSAReader::parse_line (base, bits[9]))) {
581                 BOOST_FOREACH (sub::Line j, i.lines) {
582                         BOOST_FOREACH (sub::Block k, j.blocks) {
583                                 ss.push_back (
584                                         dcp::SubtitleString (
585                                                 boost::optional<string> (),
586                                                 k.italic,
587                                                 k.bold,
588                                                 dcp::Colour (255, 255, 255),
589                                                 /* 48pt is 1/22nd of the screen height */
590                                                 48,
591                                                 1,
592                                                 dcp::Time (i.from.seconds(), 1000),
593                                                 dcp::Time (i.to.seconds(), 1000),
594                                                 0,
595                                                 dcp::HALIGN_CENTER,
596                                                 /* This 1.015 is an arbitrary value to lift the bottom sub off the bottom
597                                                    of the screen a bit to a pleasing degree.
598                                                 */
599                                                 1.015 - ((1 + highest - j.vertical_position.line.get()) * 1.5 / 22),
600                                                 dcp::VALIGN_TOP,
601                                                 dcp::DIRECTION_LTR,
602                                                 k.text,
603                                                 static_cast<dcp::Effect> (0),
604                                                 dcp::Colour (255, 255, 255),
605                                                 dcp::Time (),
606                                                 dcp::Time ()
607                                                 )
608                                         );
609                         }
610                 }
611         }
612
613         text_subtitle (period, ss);
614 }