2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 /** @file src/ffmpeg_decoder.cc
22 * @brief A decoder using FFmpeg to decode content.
26 #include "exceptions.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"
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>
49 #include <libavcodec/avcodec.h>
50 #include <libavformat/avformat.h>
52 #include <boost/foreach.hpp>
53 #include <boost/algorithm/string.hpp>
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);
74 using boost::shared_ptr;
75 using boost::is_any_of;
77 using boost::optional;
78 using boost::dynamic_pointer_cast;
81 FFmpegDecoder::FFmpegDecoder (shared_ptr<const FFmpegContent> c, shared_ptr<Log> log)
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());
89 _pts_offset = ContentTime ();
93 audio.reset (new AudioDecoder (this, c->audio, log));
102 bind (&FFmpegDecoder::image_subtitles_during, this, _1, _2),
103 bind (&FFmpegDecoder::text_subtitles_during, this, _1, _2)
110 FFmpegDecoder::flush ()
112 /* Get any remaining frames */
117 /* XXX: should we reset _packet.data and size after each *_decode_* call? */
119 while (video && decode_video_packet ()) {}
122 decode_audio_packet ();
128 FFmpegDecoder::pass (PassReason reason, bool accurate)
130 int r = av_read_frame (_format_context, &_packet);
132 /* AVERROR_INVALIDDATA can apparently be returned sometimes even when av_read_frame
133 has pretty-much succeeded (and hence generated data which should be processed).
134 Hence it makes sense to continue here in that case.
136 if (r < 0 && r != AVERROR_INVALIDDATA) {
137 if (r != AVERROR_EOF) {
138 /* Maybe we should fail here, but for now we'll just finish off instead */
140 av_strerror (r, buf, sizeof(buf));
141 LOG_ERROR (N_("error on av_read_frame (%1) (%2)"), &buf[0], r);
148 int const si = _packet.stream_index;
149 shared_ptr<const FFmpegContent> fc = _ffmpeg_content;
151 if (_video_stream && si == _video_stream.get() && !video->ignore() && (accurate || reason != PASS_REASON_SUBTITLE)) {
152 decode_video_packet ();
153 } else if (fc->subtitle_stream() && fc->subtitle_stream()->uses_index (_format_context, si)) {
154 decode_subtitle_packet ();
155 } else if (accurate || reason != PASS_REASON_SUBTITLE) {
156 decode_audio_packet ();
159 av_packet_unref (&_packet);
163 /** @param data pointer to array of pointers to buffers.
164 * Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
166 shared_ptr<AudioBuffers>
167 FFmpegDecoder::deinterleave_audio (shared_ptr<FFmpegAudioStream> stream) const
169 DCPOMATIC_ASSERT (bytes_per_audio_sample (stream));
171 int const size = av_samples_get_buffer_size (
172 0, stream->stream(_format_context)->codec->channels, _frame->nb_samples, audio_sample_format (stream), 1
175 /* Deinterleave and convert to float */
177 /* total_samples and frames will be rounded down here, so if there are stray samples at the end
178 of the block that do not form a complete sample or frame they will be dropped.
180 int const total_samples = size / bytes_per_audio_sample (stream);
181 int const frames = total_samples / stream->channels();
182 shared_ptr<AudioBuffers> audio (new AudioBuffers (stream->channels(), frames));
184 switch (audio_sample_format (stream)) {
185 case AV_SAMPLE_FMT_U8:
187 uint8_t* p = reinterpret_cast<uint8_t *> (_frame->data[0]);
190 for (int i = 0; i < total_samples; ++i) {
191 audio->data(channel)[sample] = float(*p++) / (1 << 23);
194 if (channel == stream->channels()) {
202 case AV_SAMPLE_FMT_S16:
204 int16_t* p = reinterpret_cast<int16_t *> (_frame->data[0]);
207 for (int i = 0; i < total_samples; ++i) {
208 audio->data(channel)[sample] = float(*p++) / (1 << 15);
211 if (channel == stream->channels()) {
219 case AV_SAMPLE_FMT_S16P:
221 int16_t** p = reinterpret_cast<int16_t **> (_frame->data);
222 for (int i = 0; i < stream->channels(); ++i) {
223 for (int j = 0; j < frames; ++j) {
224 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
230 case AV_SAMPLE_FMT_S32:
232 int32_t* p = reinterpret_cast<int32_t *> (_frame->data[0]);
235 for (int i = 0; i < total_samples; ++i) {
236 audio->data(channel)[sample] = static_cast<float>(*p++) / 2147483648;
239 if (channel == stream->channels()) {
247 case AV_SAMPLE_FMT_S32P:
249 int32_t** p = reinterpret_cast<int32_t **> (_frame->data);
250 for (int i = 0; i < stream->channels(); ++i) {
251 for (int j = 0; j < frames; ++j) {
252 audio->data(i)[j] = static_cast<float>(p[i][j]) / 2147483648;
258 case AV_SAMPLE_FMT_FLT:
260 float* p = reinterpret_cast<float*> (_frame->data[0]);
263 for (int i = 0; i < total_samples; ++i) {
264 audio->data(channel)[sample] = *p++;
267 if (channel == stream->channels()) {
275 case AV_SAMPLE_FMT_FLTP:
277 float** p = reinterpret_cast<float**> (_frame->data);
278 /* Sometimes there aren't as many channels in the _frame as in the stream */
279 for (int i = 0; i < _frame->channels; ++i) {
280 memcpy (audio->data(i), p[i], frames * sizeof(float));
282 for (int i = _frame->channels; i < stream->channels(); ++i) {
283 audio->make_silent (i);
289 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format (stream))));
296 FFmpegDecoder::audio_sample_format (shared_ptr<FFmpegAudioStream> stream) const
298 return stream->stream (_format_context)->codec->sample_fmt;
302 FFmpegDecoder::bytes_per_audio_sample (shared_ptr<FFmpegAudioStream> stream) const
304 return av_get_bytes_per_sample (audio_sample_format (stream));
308 FFmpegDecoder::seek (ContentTime time, bool accurate)
311 video->seek (time, accurate);
315 audio->seek (time, accurate);
319 subtitle->seek (time, accurate);
322 /* If we are doing an `accurate' seek, we need to use pre-roll, as
323 we don't really know what the seek will give us.
326 ContentTime pre_roll = accurate ? ContentTime::from_seconds (2) : ContentTime (0);
329 /* XXX: it seems debatable whether PTS should be used here...
330 http://www.mjbshaw.com/2012/04/seeking-in-ffmpeg-know-your-timestamp.html
333 optional<int> stream;
336 stream = _video_stream;
338 shared_ptr<FFmpegAudioStream> s = dynamic_pointer_cast<FFmpegAudioStream> (_ffmpeg_content->audio->stream ());
340 stream = s->index (_format_context);
344 DCPOMATIC_ASSERT (stream);
346 ContentTime u = time - _pts_offset;
347 if (u < ContentTime ()) {
353 u.seconds() / av_q2d (_format_context->streams[stream.get()]->time_base),
357 if (video_codec_context ()) {
358 avcodec_flush_buffers (video_codec_context());
361 /* XXX: should be flushing audio buffers? */
363 if (subtitle_codec_context ()) {
364 avcodec_flush_buffers (subtitle_codec_context ());
369 FFmpegDecoder::decode_audio_packet ()
371 /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
375 AVPacket copy_packet = _packet;
377 /* XXX: inefficient */
378 vector<shared_ptr<FFmpegAudioStream> > streams = ffmpeg_content()->ffmpeg_audio_streams ();
379 vector<shared_ptr<FFmpegAudioStream> >::const_iterator stream = streams.begin ();
380 while (stream != streams.end () && !(*stream)->uses_index (_format_context, copy_packet.stream_index)) {
384 if (stream == streams.end ()) {
385 /* The packet's stream may not be an audio one; just ignore it in this method if so */
389 while (copy_packet.size > 0) {
392 int decode_result = avcodec_decode_audio4 ((*stream)->stream (_format_context)->codec, _frame, &frame_finished, ©_packet);
393 if (decode_result < 0) {
394 /* avcodec_decode_audio4 can sometimes return an error even though it has decoded
395 some valid data; for example dca_subframe_footer can return AVERROR_INVALIDDATA
396 if it overreads the auxiliary data. ffplay carries on if frame_finished is true,
397 even in the face of such an error, so I think we should too.
399 Returning from the method here caused mantis #352.
401 LOG_WARNING ("avcodec_decode_audio4 failed (%1)", decode_result);
403 /* Fudge decode_result so that we come out of the while loop when
404 we've processed this data.
406 decode_result = copy_packet.size;
409 if (frame_finished) {
410 ContentTime ct = ContentTime::from_seconds (
411 av_frame_get_best_effort_timestamp (_frame) *
412 av_q2d ((*stream)->stream (_format_context)->time_base))
415 shared_ptr<AudioBuffers> data = deinterleave_audio (*stream);
417 if (ct < ContentTime ()) {
418 /* Discard audio data that comes before time 0 */
419 Frame const remove = min (int64_t (data->frames()), (-ct).frames_ceil(double((*stream)->frame_rate ())));
420 data->move (remove, 0, data->frames() - remove);
421 data->set_frames (data->frames() - remove);
422 ct += ContentTime::from_frames (remove, (*stream)->frame_rate ());
425 if (ct < ContentTime()) {
426 LOG_WARNING ("Crazy timestamp %s", to_string (ct));
429 audio->set_position (ct);
431 /* Give this data provided there is some, and its time is sane */
432 if (ct >= ContentTime() && data->frames() > 0) {
433 audio->give (*stream, data, ct);
437 copy_packet.data += decode_result;
438 copy_packet.size -= decode_result;
443 FFmpegDecoder::decode_video_packet ()
445 DCPOMATIC_ASSERT (_video_stream);
448 if (avcodec_decode_video2 (video_codec_context(), _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
452 boost::mutex::scoped_lock lm (_filter_graphs_mutex);
454 shared_ptr<VideoFilterGraph> graph;
456 list<shared_ptr<VideoFilterGraph> >::iterator i = _filter_graphs.begin();
457 while (i != _filter_graphs.end() && !(*i)->can_process (dcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
461 if (i == _filter_graphs.end ()) {
462 graph.reset (new VideoFilterGraph (dcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
463 graph->setup (_ffmpeg_content->filters ());
464 _filter_graphs.push_back (graph);
465 LOG_GENERAL (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format);
470 list<pair<shared_ptr<Image>, int64_t> > images = graph->process (_frame);
472 for (list<pair<shared_ptr<Image>, int64_t> >::iterator i = images.begin(); i != images.end(); ++i) {
474 shared_ptr<Image> image = i->first;
476 if (i->second != AV_NOPTS_VALUE) {
477 double const pts = i->second * av_q2d (_format_context->streams[_video_stream.get()]->time_base) + _pts_offset.seconds ();
479 shared_ptr<ImageProxy> (new RawImageProxy (image)),
480 llrint (pts * _ffmpeg_content->active_video_frame_rate ())
482 video->set_position (ContentTime::from_seconds (pts));
484 LOG_WARNING_NC ("Dropping frame without PTS");
492 FFmpegDecoder::decode_subtitle_packet ()
496 if (avcodec_decode_subtitle2 (subtitle_codec_context(), &sub, &got_subtitle, &_packet) < 0 || !got_subtitle) {
500 if (sub.num_rects <= 0) {
501 /* Sometimes we get an empty AVSubtitle, which is used by some codecs to
502 indicate that the previous subtitle should stop. We can ignore it here.
507 /* Subtitle PTS (within the source, not taking into account any of the
508 source that we may have chopped off for the DCP).
510 FFmpegSubtitlePeriod sub_period = subtitle_period (sub);
511 ContentTimePeriod period;
512 period.from = sub_period.from + _pts_offset;
513 subtitle->set_position (period.from);
514 /* We can't trust the `to' time from sub_period as there are some decoders which
515 give a sub_period time for `to' which is subsequently overridden by a `stop' subtitle;
516 see also FFmpegExaminer.
518 period.to = ffmpeg_content()->subtitle_stream()->find_subtitle_to (subtitle_id (sub));
520 for (unsigned int i = 0; i < sub.num_rects; ++i) {
521 AVSubtitleRect const * rect = sub.rects[i];
523 switch (rect->type) {
526 case SUBTITLE_BITMAP:
527 decode_bitmap_subtitle (rect, period);
530 cout << "XXX: SUBTITLE_TEXT " << rect->text << "\n";
533 decode_ass_subtitle (rect->ass, period);
538 avsubtitle_free (&sub);
541 list<ContentTimePeriod>
542 FFmpegDecoder::image_subtitles_during (ContentTimePeriod p, bool starting) const
544 return _ffmpeg_content->image_subtitles_during (p, starting);
547 list<ContentTimePeriod>
548 FFmpegDecoder::text_subtitles_during (ContentTimePeriod p, bool starting) const
550 return _ffmpeg_content->text_subtitles_during (p, starting);
554 FFmpegDecoder::decode_bitmap_subtitle (AVSubtitleRect const * rect, ContentTimePeriod period)
556 /* Note RGBA is expressed little-endian, so the first byte in the word is R, second
557 G, third B, fourth A.
559 shared_ptr<Image> image (new Image (AV_PIX_FMT_RGBA, dcp::Size (rect->w, rect->h), true));
561 #ifdef DCPOMATIC_HAVE_AVSUBTITLERECT_PICT
562 /* Start of the first line in the subtitle */
563 uint8_t* sub_p = rect->pict.data[0];
564 /* sub_p looks up into a BGRA palette which is here
565 (i.e. first byte B, second G, third R, fourth A)
567 uint32_t const * palette = (uint32_t *) rect->pict.data[1];
569 /* Start of the first line in the subtitle */
570 uint8_t* sub_p = rect->data[0];
571 /* sub_p looks up into a BGRA palette which is here
572 (i.e. first byte B, second G, third R, fourth A)
574 uint32_t const * palette = (uint32_t *) rect->data[1];
576 /* And the stream has a map of those palette colours to colours
577 chosen by the user; created a `mapped' palette from those settings.
579 map<RGBA, RGBA> colour_map = ffmpeg_content()->subtitle_stream()->colours ();
580 vector<RGBA> mapped_palette (rect->nb_colors);
581 for (int i = 0; i < rect->nb_colors; ++i) {
582 RGBA c ((palette[i] & 0xff0000) >> 16, (palette[i] & 0xff00) >> 8, palette[i] & 0xff, (palette[i] & 0xff000000) >> 24);
583 map<RGBA, RGBA>::const_iterator j = colour_map.find (c);
584 if (j != colour_map.end ()) {
585 mapped_palette[i] = j->second;
587 /* This colour was not found in the FFmpegSubtitleStream's colour map; probably because
588 it is from a project that was created before this stuff was added. Just use the
589 colour straight from the original palette.
591 mapped_palette[i] = c;
595 /* Start of the output data */
596 uint32_t* out_p = (uint32_t *) image->data()[0];
598 for (int y = 0; y < rect->h; ++y) {
599 uint8_t* sub_line_p = sub_p;
600 uint32_t* out_line_p = out_p;
601 for (int x = 0; x < rect->w; ++x) {
602 RGBA const p = mapped_palette[*sub_line_p++];
603 /* XXX: this seems to be wrong to me (isn't the output image RGBA?) but it looks right on screen */
604 *out_line_p++ = (p.a << 24) | (p.r << 16) | (p.g << 8) | p.b;
606 #ifdef DCPOMATIC_HAVE_AVSUBTITLERECT_PICT
607 sub_p += rect->pict.linesize[0];
609 sub_p += rect->linesize[0];
611 out_p += image->stride()[0] / sizeof (uint32_t);
614 int const target_width = subtitle_codec_context()->width;
615 int const target_height = subtitle_codec_context()->height;
616 dcpomatic::Rect<double> const scaled_rect (
617 static_cast<double> (rect->x) / target_width,
618 static_cast<double> (rect->y) / target_height,
619 static_cast<double> (rect->w) / target_width,
620 static_cast<double> (rect->h) / target_height
623 subtitle->give_image (period, image, scaled_rect);
627 FFmpegDecoder::decode_ass_subtitle (string ass, ContentTimePeriod period)
629 /* We have no styles and no Format: line, so I'm assuming that FFmpeg
630 produces a single format of Dialogue: lines...
634 split (bits, ass, is_any_of (","));
635 if (bits.size() < 10) {
639 sub::RawSubtitle base;
640 list<sub::RawSubtitle> raw = sub::SSAReader::parse_line (base, bits[9]);
642 BOOST_FOREACH (sub::Subtitle const & i, sub::collect<list<sub::Subtitle> > (raw)) {
643 subtitle->give_text (period, i);