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