2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
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.
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.
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.
20 /** @file src/ffmpeg_decoder.cc
21 * @brief A decoder using FFmpeg to decode content.
30 #include <boost/lexical_cast.hpp>
33 #include <libavcodec/avcodec.h>
34 #include <libavformat/avformat.h>
38 #include "exceptions.h"
42 #include "ffmpeg_decoder.h"
43 #include "filter_graph.h"
44 #include "audio_buffers.h"
45 #include "ffmpeg_content.h"
52 using std::stringstream;
56 using boost::shared_ptr;
57 using boost::optional;
58 using boost::dynamic_pointer_cast;
61 FFmpegDecoder::FFmpegDecoder (shared_ptr<const Film> f, shared_ptr<const FFmpegContent> c, bool video, bool audio)
67 , _subtitle_codec_context (0)
69 , _decode_video (video)
70 , _decode_audio (audio)
71 , _video_pts_offset (0)
72 , _audio_pts_offset (0)
73 , _just_sought (false)
77 /* Audio and video frame PTS values may not start with 0. We want
78 to fiddle them so that:
80 1. One of them starts at time 0.
81 2. The first video PTS value ends up on a frame boundary.
83 Then we remove big initial gaps in PTS and we allow our
84 insertion of black frames to work.
87 audio_pts_to_use = audio_pts_from_ffmpeg + audio_pts_offset;
88 video_pts_to_use = video_pts_from_ffmpeg + video_pts_offset;
91 bool const have_video = video && c->first_video();
92 bool const have_audio = audio && c->audio_stream() && c->audio_stream()->first_audio;
94 /* First, make one of them start at 0 */
96 if (have_audio && have_video) {
97 _video_pts_offset = _audio_pts_offset = - min (c->first_video().get(), c->audio_stream()->first_audio.get());
98 } else if (have_video) {
99 _video_pts_offset = - c->first_video().get();
102 /* Now adjust both so that the video pts starts on a frame */
103 if (have_video && have_audio) {
104 double first_video = c->first_video().get() + _video_pts_offset;
105 double const old_first_video = first_video;
107 /* Round the first video up to a frame boundary */
108 if (fabs (rint (first_video * c->video_frame_rate()) - first_video * c->video_frame_rate()) > 1e-6) {
109 first_video = ceil (first_video * c->video_frame_rate()) / c->video_frame_rate ();
112 _video_pts_offset += first_video - old_first_video;
113 _audio_pts_offset += first_video - old_first_video;
117 FFmpegDecoder::~FFmpegDecoder ()
119 boost::mutex::scoped_lock lm (_mutex);
121 if (_subtitle_codec_context) {
122 avcodec_close (_subtitle_codec_context);
127 FFmpegDecoder::flush ()
129 /* Get any remaining frames */
134 /* XXX: should we reset _packet.data and size after each *_decode_* call? */
137 while (decode_video_packet ()) {}
140 if (_ffmpeg_content->audio_stream() && _decode_audio) {
141 decode_audio_packet ();
144 /* Stop us being asked for any more data */
145 _video_position = _ffmpeg_content->video_length ();
146 _audio_position = _ffmpeg_content->audio_length ();
150 FFmpegDecoder::pass ()
152 int r = av_read_frame (_format_context, &_packet);
155 if (r != AVERROR_EOF) {
156 /* Maybe we should fail here, but for now we'll just finish off instead */
158 av_strerror (r, buf, sizeof(buf));
159 shared_ptr<const Film> film = _film.lock ();
161 film->log()->log (String::compose (N_("error on av_read_frame (%1) (%2)"), buf, r));
168 avcodec_get_frame_defaults (_frame);
170 shared_ptr<const Film> film = _film.lock ();
173 if (_packet.stream_index == _video_stream && _decode_video) {
174 decode_video_packet ();
175 } else if (_ffmpeg_content->audio_stream() && _packet.stream_index == _ffmpeg_content->audio_stream()->id && _decode_audio) {
176 decode_audio_packet ();
177 } else if (_ffmpeg_content->subtitle_stream() && _packet.stream_index == _ffmpeg_content->subtitle_stream()->id && film->with_subtitles ()) {
178 decode_subtitle_packet ();
181 av_free_packet (&_packet);
184 /** @param data pointer to array of pointers to buffers.
185 * Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
187 shared_ptr<AudioBuffers>
188 FFmpegDecoder::deinterleave_audio (uint8_t** data, int size)
190 assert (_ffmpeg_content->audio_channels());
191 assert (bytes_per_audio_sample());
193 /* Deinterleave and convert to float */
195 assert ((size % (bytes_per_audio_sample() * _ffmpeg_content->audio_channels())) == 0);
197 int const total_samples = size / bytes_per_audio_sample();
198 int const frames = total_samples / _ffmpeg_content->audio_channels();
199 shared_ptr<AudioBuffers> audio (new AudioBuffers (_ffmpeg_content->audio_channels(), frames));
201 switch (audio_sample_format()) {
202 case AV_SAMPLE_FMT_S16:
204 int16_t* p = reinterpret_cast<int16_t *> (data[0]);
207 for (int i = 0; i < total_samples; ++i) {
208 audio->data(channel)[sample] = float(*p++) / (1 << 15);
211 if (channel == _ffmpeg_content->audio_channels()) {
219 case AV_SAMPLE_FMT_S16P:
221 int16_t** p = reinterpret_cast<int16_t **> (data);
222 for (int i = 0; i < _ffmpeg_content->audio_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 *> (data[0]);
235 for (int i = 0; i < total_samples; ++i) {
236 audio->data(channel)[sample] = static_cast<float>(*p++) / (1 << 31);
239 if (channel == _ffmpeg_content->audio_channels()) {
247 case AV_SAMPLE_FMT_FLT:
249 float* p = reinterpret_cast<float*> (data[0]);
252 for (int i = 0; i < total_samples; ++i) {
253 audio->data(channel)[sample] = *p++;
256 if (channel == _ffmpeg_content->audio_channels()) {
264 case AV_SAMPLE_FMT_FLTP:
266 float** p = reinterpret_cast<float**> (data);
267 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
268 memcpy (audio->data(i), p[i], frames * sizeof(float));
274 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format())));
281 FFmpegDecoder::audio_sample_format () const
283 if (!_ffmpeg_content->audio_stream()) {
284 return (AVSampleFormat) 0;
287 return audio_codec_context()->sample_fmt;
291 FFmpegDecoder::bytes_per_audio_sample () const
293 return av_get_bytes_per_sample (audio_sample_format ());
297 FFmpegDecoder::seek (VideoContent::Frame frame, bool accurate)
299 double const time_base = av_q2d (_format_context->streams[_video_stream]->time_base);
301 /* If we are doing an accurate seek, our initial shot will be 5 frames (5 being
302 a number plucked from the air) earlier than we want to end up. The loop below
303 will hopefully then step through to where we want to be.
315 /* Initial seek time in the stream's timebase */
316 int64_t const initial_vt = ((initial / _ffmpeg_content->video_frame_rate()) - _video_pts_offset) / time_base;
318 av_seek_frame (_format_context, _video_stream, initial_vt, AVSEEK_FLAG_BACKWARD);
320 avcodec_flush_buffers (video_codec_context());
321 if (_subtitle_codec_context) {
322 avcodec_flush_buffers (_subtitle_codec_context);
326 _video_position = frame;
328 if (frame == 0 || !accurate) {
329 /* We're already there, or we're as close as we need to be */
334 int r = av_read_frame (_format_context, &_packet);
339 if (_packet.stream_index != _video_stream) {
343 avcodec_get_frame_defaults (_frame);
346 r = avcodec_decode_video2 (video_codec_context(), _frame, &finished, &_packet);
347 if (r >= 0 && finished) {
348 _video_position = rint (
349 (av_frame_get_best_effort_timestamp (_frame) * time_base + _video_pts_offset) * _ffmpeg_content->video_frame_rate()
352 if (_video_position >= (frame - 1)) {
353 av_free_packet (&_packet);
358 av_free_packet (&_packet);
363 FFmpegDecoder::decode_audio_packet ()
365 /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
369 AVPacket copy_packet = _packet;
371 while (copy_packet.size > 0) {
374 int const decode_result = avcodec_decode_audio4 (audio_codec_context(), _frame, &frame_finished, ©_packet);
375 if (decode_result < 0) {
376 shared_ptr<const Film> film = _film.lock ();
378 film->log()->log (String::compose ("avcodec_decode_audio4 failed (%1)", decode_result));
382 if (frame_finished) {
384 if (_audio_position == 0) {
385 /* Where we are in the source, in seconds */
386 double const pts = av_q2d (_format_context->streams[copy_packet.stream_index]->time_base)
387 * av_frame_get_best_effort_timestamp(_frame) + _audio_pts_offset;
390 /* Emit some silence */
391 shared_ptr<AudioBuffers> silence (
393 _ffmpeg_content->audio_channels(),
394 pts * _ffmpeg_content->content_audio_frame_rate()
398 silence->make_silent ();
399 audio (silence, _audio_position);
403 int const data_size = av_samples_get_buffer_size (
404 0, audio_codec_context()->channels, _frame->nb_samples, audio_sample_format (), 1
407 audio (deinterleave_audio (_frame->data, data_size), _audio_position);
410 copy_packet.data += decode_result;
411 copy_packet.size -= decode_result;
416 FFmpegDecoder::decode_video_packet ()
419 if (avcodec_decode_video2 (video_codec_context(), _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
423 boost::mutex::scoped_lock lm (_filter_graphs_mutex);
425 shared_ptr<FilterGraph> graph;
427 list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
428 while (i != _filter_graphs.end() && !(*i)->can_process (libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
432 if (i == _filter_graphs.end ()) {
433 shared_ptr<const Film> film = _film.lock ();
436 graph.reset (new FilterGraph (_ffmpeg_content, libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
437 _filter_graphs.push_back (graph);
439 film->log()->log (String::compose (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format));
444 list<pair<shared_ptr<Image>, int64_t> > images = graph->process (_frame);
446 string post_process = Filter::ffmpeg_strings (_ffmpeg_content->filters()).second;
448 for (list<pair<shared_ptr<Image>, int64_t> >::iterator i = images.begin(); i != images.end(); ++i) {
450 shared_ptr<Image> image = i->first;
451 if (!post_process.empty ()) {
452 image = image->post_process (post_process, true);
455 if (i->second != AV_NOPTS_VALUE) {
457 double const pts = i->second * av_q2d (_format_context->streams[_video_stream]->time_base) + _video_pts_offset;
460 /* We just did a seek, so disable any attempts to correct for where we
463 _video_position = rint (pts * _ffmpeg_content->video_frame_rate ());
464 _just_sought = false;
467 double const next = _video_position / _ffmpeg_content->video_frame_rate();
468 double const one_frame = 1 / _ffmpeg_content->video_frame_rate ();
469 double delta = pts - next;
471 while (delta > one_frame) {
472 /* This PTS is more than one frame forward in time of where we think we should be; emit
476 /* XXX: I think this should be a copy of the last frame... */
477 boost::shared_ptr<Image> black (
479 static_cast<AVPixelFormat> (_frame->format),
480 libdcp::Size (video_codec_context()->width, video_codec_context()->height),
485 black->make_black ();
486 video (image, false, _video_position);
490 if (delta > -one_frame) {
491 /* This PTS is within a frame of being right; emit this (otherwise it will be dropped) */
492 video (image, false, _video_position);
496 shared_ptr<const Film> film = _film.lock ();
498 film->log()->log ("Dropping frame without PTS");
507 FFmpegDecoder::setup_subtitle ()
509 boost::mutex::scoped_lock lm (_mutex);
511 if (!_ffmpeg_content->subtitle_stream() || _ffmpeg_content->subtitle_stream()->id >= int (_format_context->nb_streams)) {
515 _subtitle_codec_context = _format_context->streams[_ffmpeg_content->subtitle_stream()->id]->codec;
516 _subtitle_codec = avcodec_find_decoder (_subtitle_codec_context->codec_id);
518 if (_subtitle_codec == 0) {
519 throw DecodeError (_("could not find subtitle decoder"));
522 if (avcodec_open2 (_subtitle_codec_context, _subtitle_codec, 0) < 0) {
523 throw DecodeError (N_("could not open subtitle decoder"));
528 FFmpegDecoder::done () const
530 bool const vd = !_decode_video || (_video_position >= _ffmpeg_content->video_length());
531 bool const ad = !_decode_audio || !_ffmpeg_content->audio_stream() || (_audio_position >= _ffmpeg_content->audio_length());
536 FFmpegDecoder::decode_subtitle_packet ()
540 if (avcodec_decode_subtitle2 (_subtitle_codec_context, &sub, &got_subtitle, &_packet) < 0 || !got_subtitle) {
544 /* Sometimes we get an empty AVSubtitle, which is used by some codecs to
545 indicate that the previous subtitle should stop.
547 if (sub.num_rects <= 0) {
548 subtitle (shared_ptr<Image> (), dcpomatic::Rect<double> (), 0, 0);
550 } else if (sub.num_rects > 1) {
551 throw DecodeError (_("multi-part subtitles not yet supported"));
554 /* Subtitle PTS in seconds (within the source, not taking into account any of the
555 source that we may have chopped off for the DCP)
557 double const packet_time = static_cast<double> (sub.pts) / AV_TIME_BASE;
559 /* hence start time for this sub */
560 Time const from = (packet_time + (double (sub.start_display_time) / 1e3)) * TIME_HZ;
561 Time const to = (packet_time + (double (sub.end_display_time) / 1e3)) * TIME_HZ;
563 AVSubtitleRect const * rect = sub.rects[0];
565 if (rect->type != SUBTITLE_BITMAP) {
566 throw DecodeError (_("non-bitmap subtitles not yet supported"));
569 shared_ptr<Image> image (new Image (PIX_FMT_RGBA, libdcp::Size (rect->w, rect->h), true));
571 /* Start of the first line in the subtitle */
572 uint8_t* sub_p = rect->pict.data[0];
573 /* sub_p looks up into a RGB palette which is here */
574 uint32_t const * palette = (uint32_t *) rect->pict.data[1];
575 /* Start of the output data */
576 uint32_t* out_p = (uint32_t *) image->data()[0];
578 for (int y = 0; y < rect->h; ++y) {
579 uint8_t* sub_line_p = sub_p;
580 uint32_t* out_line_p = out_p;
581 for (int x = 0; x < rect->w; ++x) {
582 *out_line_p++ = palette[*sub_line_p++];
584 sub_p += rect->pict.linesize[0];
585 out_p += image->stride()[0] / sizeof (uint32_t);
588 libdcp::Size const vs = _ffmpeg_content->video_size ();
592 dcpomatic::Rect<double> (
593 static_cast<double> (rect->x) / vs.width,
594 static_cast<double> (rect->y) / vs.height,
595 static_cast<double> (rect->w) / vs.width,
596 static_cast<double> (rect->h) / vs.height
603 avsubtitle_free (&sub);