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)
84 , _have_current_subtitle (false)
87 video.reset (new VideoDecoder (this, c, log));
88 _pts_offset = pts_offset (c->ffmpeg_audio_streams(), c->first_video(), c->active_video_frame_rate());
89 /* It doesn't matter what size or pixel format this is, it just needs to be black */
90 _black_image.reset (new Image (AV_PIX_FMT_RGB24, dcp::Size (128, 128), true));
91 _black_image->make_black ();
93 _pts_offset = ContentTime ();
97 audio.reset (new AudioDecoder (this, c->audio, log));
101 subtitle.reset (new SubtitleDecoder (this, c->subtitle, log));
106 FFmpegDecoder::flush ()
108 /* Get any remaining frames */
113 /* XXX: should we reset _packet.data and size after each *_decode_* call? */
115 while (video && decode_video_packet ()) {}
118 decode_audio_packet ();
121 /* Make sure all streams are the same length and round up to the next video frame */
123 FrameRateChange const frc = _ffmpeg_content->film()->active_frame_rate_change(_ffmpeg_content->position());
124 ContentTime full_length (_ffmpeg_content->full_length(), frc);
125 full_length = full_length.ceil (frc.source);
127 double const vfr = _ffmpeg_content->video_frame_rate().get();
128 Frame const f = full_length.frames_round (vfr);
129 Frame v = video->position().frames_round (vfr);
131 video->emit (shared_ptr<const ImageProxy> (new RawImageProxy (_black_image)), v);
136 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, _ffmpeg_content->ffmpeg_audio_streams ()) {
137 ContentTime a = audio->stream_position(i);
138 while (a < full_length) {
139 ContentTime to_do = min (full_length - a, ContentTime::from_seconds (0.1));
140 shared_ptr<AudioBuffers> silence (new AudioBuffers (i->channels(), to_do.frames_ceil (i->frame_rate())));
141 silence->make_silent ();
142 audio->emit (i, silence, a);
153 FFmpegDecoder::pass ()
155 int r = av_read_frame (_format_context, &_packet);
157 /* AVERROR_INVALIDDATA can apparently be returned sometimes even when av_read_frame
158 has pretty-much succeeded (and hence generated data which should be processed).
159 Hence it makes sense to continue here in that case.
161 if (r < 0 && r != AVERROR_INVALIDDATA) {
162 if (r != AVERROR_EOF) {
163 /* Maybe we should fail here, but for now we'll just finish off instead */
165 av_strerror (r, buf, sizeof(buf));
166 LOG_ERROR (N_("error on av_read_frame (%1) (%2)"), &buf[0], r);
173 int const si = _packet.stream_index;
174 shared_ptr<const FFmpegContent> fc = _ffmpeg_content;
176 if (_video_stream && si == _video_stream.get() && !video->ignore()) {
177 decode_video_packet ();
178 } else if (fc->subtitle_stream() && fc->subtitle_stream()->uses_index(_format_context, si) && !subtitle->ignore()) {
179 decode_subtitle_packet ();
181 decode_audio_packet ();
184 av_packet_unref (&_packet);
188 /** @param data pointer to array of pointers to buffers.
189 * Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
191 shared_ptr<AudioBuffers>
192 FFmpegDecoder::deinterleave_audio (shared_ptr<FFmpegAudioStream> stream) const
194 DCPOMATIC_ASSERT (bytes_per_audio_sample (stream));
196 int const size = av_samples_get_buffer_size (
197 0, stream->stream(_format_context)->codec->channels, _frame->nb_samples, audio_sample_format (stream), 1
200 /* Deinterleave and convert to float */
202 /* total_samples and frames will be rounded down here, so if there are stray samples at the end
203 of the block that do not form a complete sample or frame they will be dropped.
205 int const total_samples = size / bytes_per_audio_sample (stream);
206 int const frames = total_samples / stream->channels();
207 shared_ptr<AudioBuffers> audio (new AudioBuffers (stream->channels(), frames));
209 switch (audio_sample_format (stream)) {
210 case AV_SAMPLE_FMT_U8:
212 uint8_t* p = reinterpret_cast<uint8_t *> (_frame->data[0]);
215 for (int i = 0; i < total_samples; ++i) {
216 audio->data(channel)[sample] = float(*p++) / (1 << 23);
219 if (channel == stream->channels()) {
227 case AV_SAMPLE_FMT_S16:
229 int16_t* p = reinterpret_cast<int16_t *> (_frame->data[0]);
232 for (int i = 0; i < total_samples; ++i) {
233 audio->data(channel)[sample] = float(*p++) / (1 << 15);
236 if (channel == stream->channels()) {
244 case AV_SAMPLE_FMT_S16P:
246 int16_t** p = reinterpret_cast<int16_t **> (_frame->data);
247 for (int i = 0; i < stream->channels(); ++i) {
248 for (int j = 0; j < frames; ++j) {
249 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
255 case AV_SAMPLE_FMT_S32:
257 int32_t* p = reinterpret_cast<int32_t *> (_frame->data[0]);
260 for (int i = 0; i < total_samples; ++i) {
261 audio->data(channel)[sample] = static_cast<float>(*p++) / 2147483648;
264 if (channel == stream->channels()) {
272 case AV_SAMPLE_FMT_S32P:
274 int32_t** p = reinterpret_cast<int32_t **> (_frame->data);
275 for (int i = 0; i < stream->channels(); ++i) {
276 for (int j = 0; j < frames; ++j) {
277 audio->data(i)[j] = static_cast<float>(p[i][j]) / 2147483648;
283 case AV_SAMPLE_FMT_FLT:
285 float* p = reinterpret_cast<float*> (_frame->data[0]);
288 for (int i = 0; i < total_samples; ++i) {
289 audio->data(channel)[sample] = *p++;
292 if (channel == stream->channels()) {
300 case AV_SAMPLE_FMT_FLTP:
302 float** p = reinterpret_cast<float**> (_frame->data);
303 /* Sometimes there aren't as many channels in the _frame as in the stream */
304 for (int i = 0; i < _frame->channels; ++i) {
305 memcpy (audio->data(i), p[i], frames * sizeof(float));
307 for (int i = _frame->channels; i < stream->channels(); ++i) {
308 audio->make_silent (i);
314 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format (stream))));
321 FFmpegDecoder::audio_sample_format (shared_ptr<FFmpegAudioStream> stream) const
323 return stream->stream (_format_context)->codec->sample_fmt;
327 FFmpegDecoder::bytes_per_audio_sample (shared_ptr<FFmpegAudioStream> stream) const
329 return av_get_bytes_per_sample (audio_sample_format (stream));
333 FFmpegDecoder::seek (ContentTime time, bool accurate)
335 Decoder::seek (time, accurate);
337 /* If we are doing an `accurate' seek, we need to use pre-roll, as
338 we don't really know what the seek will give us.
341 ContentTime pre_roll = accurate ? ContentTime::from_seconds (2) : ContentTime (0);
344 /* XXX: it seems debatable whether PTS should be used here...
345 http://www.mjbshaw.com/2012/04/seeking-in-ffmpeg-know-your-timestamp.html
348 optional<int> stream;
351 stream = _video_stream;
353 shared_ptr<FFmpegAudioStream> s = dynamic_pointer_cast<FFmpegAudioStream> (_ffmpeg_content->audio->stream ());
355 stream = s->index (_format_context);
359 DCPOMATIC_ASSERT (stream);
361 ContentTime u = time - _pts_offset;
362 if (u < ContentTime ()) {
368 u.seconds() / av_q2d (_format_context->streams[stream.get()]->time_base),
372 if (video_codec_context ()) {
373 avcodec_flush_buffers (video_codec_context());
376 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_content()->ffmpeg_audio_streams()) {
377 avcodec_flush_buffers (i->stream(_format_context)->codec);
380 if (subtitle_codec_context ()) {
381 avcodec_flush_buffers (subtitle_codec_context ());
384 _have_current_subtitle = false;
388 FFmpegDecoder::decode_audio_packet ()
390 /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
394 AVPacket copy_packet = _packet;
396 /* XXX: inefficient */
397 vector<shared_ptr<FFmpegAudioStream> > streams = ffmpeg_content()->ffmpeg_audio_streams ();
398 vector<shared_ptr<FFmpegAudioStream> >::const_iterator stream = streams.begin ();
399 while (stream != streams.end () && !(*stream)->uses_index (_format_context, copy_packet.stream_index)) {
403 if (stream == streams.end ()) {
404 /* The packet's stream may not be an audio one; just ignore it in this method if so */
408 while (copy_packet.size > 0) {
411 int decode_result = avcodec_decode_audio4 ((*stream)->stream (_format_context)->codec, _frame, &frame_finished, ©_packet);
412 if (decode_result < 0) {
413 /* avcodec_decode_audio4 can sometimes return an error even though it has decoded
414 some valid data; for example dca_subframe_footer can return AVERROR_INVALIDDATA
415 if it overreads the auxiliary data. ffplay carries on if frame_finished is true,
416 even in the face of such an error, so I think we should too.
418 Returning from the method here caused mantis #352.
420 LOG_WARNING ("avcodec_decode_audio4 failed (%1)", decode_result);
422 /* Fudge decode_result so that we come out of the while loop when
423 we've processed this data.
425 decode_result = copy_packet.size;
428 if (frame_finished) {
429 ContentTime ct = ContentTime::from_seconds (
430 av_frame_get_best_effort_timestamp (_frame) *
431 av_q2d ((*stream)->stream (_format_context)->time_base))
434 shared_ptr<AudioBuffers> data = deinterleave_audio (*stream);
436 if (ct < ContentTime ()) {
437 /* Discard audio data that comes before time 0 */
438 Frame const remove = min (int64_t (data->frames()), (-ct).frames_ceil(double((*stream)->frame_rate ())));
439 data->move (data->frames() - remove, remove, 0);
440 data->set_frames (data->frames() - remove);
441 ct += ContentTime::from_frames (remove, (*stream)->frame_rate ());
444 if (ct < ContentTime()) {
445 LOG_WARNING ("Crazy timestamp %1", to_string (ct));
448 /* Give this data provided there is some, and its time is sane */
449 if (ct >= ContentTime() && data->frames() > 0) {
450 audio->emit (*stream, data, ct);
454 copy_packet.data += decode_result;
455 copy_packet.size -= decode_result;
460 FFmpegDecoder::decode_video_packet ()
462 DCPOMATIC_ASSERT (_video_stream);
465 if (avcodec_decode_video2 (video_codec_context(), _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
469 boost::mutex::scoped_lock lm (_filter_graphs_mutex);
471 shared_ptr<VideoFilterGraph> graph;
473 list<shared_ptr<VideoFilterGraph> >::iterator i = _filter_graphs.begin();
474 while (i != _filter_graphs.end() && !(*i)->can_process (dcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
478 if (i == _filter_graphs.end ()) {
479 graph.reset (new VideoFilterGraph (dcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
480 graph->setup (_ffmpeg_content->filters ());
481 _filter_graphs.push_back (graph);
482 LOG_GENERAL (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format);
487 list<pair<shared_ptr<Image>, int64_t> > images = graph->process (_frame);
489 for (list<pair<shared_ptr<Image>, int64_t> >::iterator i = images.begin(); i != images.end(); ++i) {
491 shared_ptr<Image> image = i->first;
493 if (i->second != AV_NOPTS_VALUE) {
494 double const pts = i->second * av_q2d (_format_context->streams[_video_stream.get()]->time_base) + _pts_offset.seconds ();
496 shared_ptr<ImageProxy> (new RawImageProxy (image)),
497 llrint (pts * _ffmpeg_content->active_video_frame_rate ())
500 LOG_WARNING_NC ("Dropping frame without PTS");
508 FFmpegDecoder::decode_subtitle_packet ()
512 if (avcodec_decode_subtitle2 (subtitle_codec_context(), &sub, &got_subtitle, &_packet) < 0 || !got_subtitle) {
516 /* Stop any current subtitle, either at the time it was supposed to stop, or now if now is sooner */
517 if (_have_current_subtitle) {
518 if (_current_subtitle_to) {
519 subtitle->emit_stop (min(*_current_subtitle_to, subtitle_period(sub).from + _pts_offset));
521 subtitle->emit_stop (subtitle_period(sub).from + _pts_offset);
523 _have_current_subtitle = false;
526 if (sub.num_rects <= 0) {
527 /* Nothing new in this subtitle */
531 /* Subtitle PTS (within the source, not taking into account any of the
532 source that we may have chopped off for the DCP).
534 FFmpegSubtitlePeriod sub_period = subtitle_period (sub);
536 from = sub_period.from + _pts_offset;
537 _have_current_subtitle = true;
539 _current_subtitle_to = *sub_period.to + _pts_offset;
542 for (unsigned int i = 0; i < sub.num_rects; ++i) {
543 AVSubtitleRect const * rect = sub.rects[i];
545 switch (rect->type) {
548 case SUBTITLE_BITMAP:
549 decode_bitmap_subtitle (rect, from);
552 cout << "XXX: SUBTITLE_TEXT " << rect->text << "\n";
555 decode_ass_subtitle (rect->ass, from);
560 avsubtitle_free (&sub);
564 FFmpegDecoder::decode_bitmap_subtitle (AVSubtitleRect const * rect, ContentTime from)
566 /* Note RGBA is expressed little-endian, so the first byte in the word is R, second
567 G, third B, fourth A.
569 shared_ptr<Image> image (new Image (AV_PIX_FMT_RGBA, dcp::Size (rect->w, rect->h), true));
571 #ifdef DCPOMATIC_HAVE_AVSUBTITLERECT_PICT
572 /* Start of the first line in the subtitle */
573 uint8_t* sub_p = rect->pict.data[0];
574 /* sub_p looks up into a BGRA palette which is here
575 (i.e. first byte B, second G, third R, fourth A)
577 uint32_t const * palette = (uint32_t *) rect->pict.data[1];
579 /* Start of the first line in the subtitle */
580 uint8_t* sub_p = rect->data[0];
581 /* sub_p looks up into a BGRA palette which is here
582 (i.e. first byte B, second G, third R, fourth A)
584 uint32_t const * palette = (uint32_t *) rect->data[1];
586 /* And the stream has a map of those palette colours to colours
587 chosen by the user; created a `mapped' palette from those settings.
589 map<RGBA, RGBA> colour_map = ffmpeg_content()->subtitle_stream()->colours ();
590 vector<RGBA> mapped_palette (rect->nb_colors);
591 for (int i = 0; i < rect->nb_colors; ++i) {
592 RGBA c ((palette[i] & 0xff0000) >> 16, (palette[i] & 0xff00) >> 8, palette[i] & 0xff, (palette[i] & 0xff000000) >> 24);
593 map<RGBA, RGBA>::const_iterator j = colour_map.find (c);
594 if (j != colour_map.end ()) {
595 mapped_palette[i] = j->second;
597 /* This colour was not found in the FFmpegSubtitleStream's colour map; probably because
598 it is from a project that was created before this stuff was added. Just use the
599 colour straight from the original palette.
601 mapped_palette[i] = c;
605 /* Start of the output data */
606 uint32_t* out_p = (uint32_t *) image->data()[0];
608 for (int y = 0; y < rect->h; ++y) {
609 uint8_t* sub_line_p = sub_p;
610 uint32_t* out_line_p = out_p;
611 for (int x = 0; x < rect->w; ++x) {
612 RGBA const p = mapped_palette[*sub_line_p++];
613 /* XXX: this seems to be wrong to me (isn't the output image RGBA?) but it looks right on screen */
614 *out_line_p++ = (p.a << 24) | (p.r << 16) | (p.g << 8) | p.b;
616 #ifdef DCPOMATIC_HAVE_AVSUBTITLERECT_PICT
617 sub_p += rect->pict.linesize[0];
619 sub_p += rect->linesize[0];
621 out_p += image->stride()[0] / sizeof (uint32_t);
624 int const target_width = subtitle_codec_context()->width;
625 int const target_height = subtitle_codec_context()->height;
626 dcpomatic::Rect<double> const scaled_rect (
627 static_cast<double> (rect->x) / target_width,
628 static_cast<double> (rect->y) / target_height,
629 static_cast<double> (rect->w) / target_width,
630 static_cast<double> (rect->h) / target_height
633 subtitle->emit_image_start (from, image, scaled_rect);
637 FFmpegDecoder::decode_ass_subtitle (string ass, ContentTime from)
639 /* We have no styles and no Format: line, so I'm assuming that FFmpeg
640 produces a single format of Dialogue: lines...
644 split (bits, ass, is_any_of (","));
645 if (bits.size() < 10) {
649 sub::RawSubtitle base;
650 list<sub::RawSubtitle> raw = sub::SSAReader::parse_line (base, bits[9]);
652 BOOST_FOREACH (sub::Subtitle const & i, sub::collect<list<sub::Subtitle> > (raw)) {
653 subtitle->emit_text_start (from, i);