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 #include "video_decoder.h"
23 #include "raw_image_proxy.h"
26 #include "compose.hpp"
27 #include <boost/foreach.hpp>
35 using std::back_inserter;
36 using boost::shared_ptr;
37 using boost::optional;
39 VideoDecoder::VideoDecoder (Decoder* parent, shared_ptr<const Content> c, shared_ptr<Log> log)
40 : DecoderPart (parent, log)
41 #ifdef DCPOMATIC_DEBUG
45 , _last_seek_accurate (true)
47 _black_image.reset (new Image (AV_PIX_FMT_RGB24, _content->video->size(), true));
48 _black_image->make_black ();
52 VideoDecoder::decoded (Frame frame)
54 list<ContentVideo> output;
56 BOOST_FOREACH (ContentVideo const & i, _decoded) {
57 if (i.frame.index() == frame) {
65 /** Get all frames which exist in the content at a given frame index.
66 * @param frame Frame index.
67 * @param accurate true to try hard to return frames at the precise time that was requested, otherwise frames nearby may be returned.
68 * @return Frames; there may be none (if there is no video there), 1 for 2D or 2 for 3D.
71 VideoDecoder::get (Frame frame, bool accurate)
73 if (_no_data_frame && frame >= _no_data_frame.get()) {
74 return list<ContentVideo> ();
77 _log->log (String::compose ("VD has request for %1", frame), LogEntry::TYPE_DEBUG_DECODE);
79 /* See if we have frame, and suggest a seek if not */
81 list<ContentVideo>::const_iterator i = _decoded.begin ();
82 while (i != _decoded.end() && i->frame.index() != frame) {
83 _log->log (String::compose ("VD has stored %1 which is no good", i->frame.index()), LogEntry::TYPE_DEBUG_DECODE);
87 if (i == _decoded.end()) {
88 Frame seek_frame = frame;
89 if (_content->video->frame_type() == VIDEO_FRAME_TYPE_3D_ALTERNATE) {
90 /* 3D alternate is a special case as the frame index in the content is not the same
91 as the frame index we are talking about here.
95 _log->log (String::compose ("VD suggests seek to %1", seek_frame), LogEntry::TYPE_DEBUG_DECODE);
96 maybe_seek (ContentTime::from_frames (seek_frame, _content->active_video_frame_rate()), accurate);
99 /* Work out the number of frames that we should return; we
100 must return all frames in our content at the requested `time'
103 unsigned int frames_wanted = 0;
104 switch (_content->video->frame_type()) {
105 case VIDEO_FRAME_TYPE_2D:
106 case VIDEO_FRAME_TYPE_3D_LEFT:
107 case VIDEO_FRAME_TYPE_3D_RIGHT:
110 case VIDEO_FRAME_TYPE_3D:
111 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
112 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
113 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
117 DCPOMATIC_ASSERT (false);
120 list<ContentVideo> dec;
122 /* Now enough pass() calls should either:
123 * (a) give us what we want, or
124 * (b) give us something after what we want, indicating that we will never get what we want, or
125 * (c) hit the end of the decoder.
128 /* We are being accurate, so we want the right frame.
129 * This could all be one statement but it's split up for clarity.
131 bool no_data = false;
134 if (decoded(frame).size() == frames_wanted) {
135 /* We got what we want */
139 if (_parent->pass (Decoder::PASS_REASON_VIDEO, accurate)) {
140 /* The decoder has nothing more for us */
145 if (!_decoded.empty() && _decoded.front().frame.index() > frame) {
146 /* We're never going to get the frame we want. Perhaps the caller is asking
147 * for a video frame before the content's video starts (if its audio
148 * begins before its video, for example).
154 dec = decoded (frame);
156 if (no_data && dec.empty()) {
157 _no_data_frame = frame;
161 /* Any frame(s) will do: use the first one(s) that comes out of pass() */
162 while (_decoded.size() < frames_wanted && !_parent->pass (Decoder::PASS_REASON_VIDEO, accurate)) {}
163 list<ContentVideo>::const_iterator i = _decoded.begin();
165 while (i != _decoded.end() && j < frames_wanted) {
172 /* Clean up _decoded; keep the frame we are returning, if any (which may have two images
173 for 3D), but nothing before that
175 while (!_decoded.empty() && !dec.empty() && _decoded.front().frame.index() < dec.front().frame.index()) {
176 _log->log (String::compose ("VD discards %1", _decoded.front().frame.index()), LogEntry::TYPE_DEBUG_DECODE);
177 _decoded.pop_front ();
183 /** Fill _decoded from `from' up to, but not including, `to' with
184 * a frame for one particular Eyes value (which could be EYES_BOTH,
185 * EYES_LEFT or EYES_RIGHT)
188 VideoDecoder::fill_one_eye (Frame from, Frame to, Eyes eye)
195 /* Fill with black... */
196 shared_ptr<const ImageProxy> filler_image (new RawImageProxy (_black_image));
197 Part filler_part = PART_WHOLE;
199 /* ...unless there's some video we can fill with */
200 if (!_decoded.empty ()) {
201 filler_image = _decoded.back().image;
202 filler_part = _decoded.back().part;
205 for (Frame i = from; i < to; ++i) {
206 #ifdef DCPOMATIC_DEBUG
210 ContentVideo (filler_image, VideoFrame (i, eye), filler_part)
215 /** Fill _decoded from `from' up to, but not including, `to'
216 * adding both left and right eye frames.
219 VideoDecoder::fill_both_eyes (VideoFrame from, VideoFrame to)
221 /* Fill with black... */
222 shared_ptr<const ImageProxy> filler_left_image (new RawImageProxy (_black_image));
223 shared_ptr<const ImageProxy> filler_right_image (new RawImageProxy (_black_image));
224 Part filler_left_part = PART_WHOLE;
225 Part filler_right_part = PART_WHOLE;
227 /* ...unless there's some video we can fill with */
228 for (list<ContentVideo>::const_reverse_iterator i = _decoded.rbegin(); i != _decoded.rend(); ++i) {
229 if (i->frame.eyes() == EYES_LEFT && !filler_left_image) {
230 filler_left_image = i->image;
231 filler_left_part = i->part;
232 } else if (i->frame.eyes() == EYES_RIGHT && !filler_right_image) {
233 filler_right_image = i->image;
234 filler_right_part = i->part;
237 if (filler_left_image && filler_right_image) {
244 #ifdef DCPOMATIC_DEBUG
250 from.eyes() == EYES_LEFT ? filler_left_image : filler_right_image,
252 from.eyes() == EYES_LEFT ? filler_left_part : filler_right_part
260 /** Called by decoder classes when they have a video frame ready.
261 * @param frame Frame index within the content; this does not take into account 3D
262 * so for 3D_ALTERNATE this value goes:
270 VideoDecoder::give (shared_ptr<const ImageProxy> image, Frame frame)
276 _log->log (String::compose ("VD receives %1", frame), LogEntry::TYPE_DEBUG_DECODE);
278 /* Work out what we are going to push into _decoded next */
279 list<ContentVideo> to_push;
280 switch (_content->video->frame_type ()) {
281 case VIDEO_FRAME_TYPE_2D:
282 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_BOTH), PART_WHOLE));
284 case VIDEO_FRAME_TYPE_3D:
286 /* We receive the same frame index twice for 3D; hence we know which
289 bool const same = (!_decoded.empty() && frame == _decoded.back().frame.index());
290 to_push.push_back (ContentVideo (image, VideoFrame (frame, same ? EYES_RIGHT : EYES_LEFT), PART_WHOLE));
293 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
294 to_push.push_back (ContentVideo (image, VideoFrame (frame / 2, (frame % 2) ? EYES_RIGHT : EYES_LEFT), PART_WHOLE));
296 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
297 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_LEFT), PART_LEFT_HALF));
298 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_RIGHT), PART_RIGHT_HALF));
300 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
301 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_LEFT), PART_TOP_HALF));
302 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_RIGHT), PART_BOTTOM_HALF));
304 case VIDEO_FRAME_TYPE_3D_LEFT:
305 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_LEFT), PART_WHOLE));
307 case VIDEO_FRAME_TYPE_3D_RIGHT:
308 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_RIGHT), PART_WHOLE));
311 DCPOMATIC_ASSERT (false);
314 /* Now VideoDecoder is required never to have gaps in the frames that it presents
315 via get_video(). Hence we need to fill in any gap between the last thing in _decoded
316 and the things we are about to push.
319 optional<VideoFrame> from;
321 if (_decoded.empty() && _last_seek_time && _last_seek_accurate) {
323 _last_seek_time->frames_round (_content->active_video_frame_rate ()),
324 _content->video->frame_type() == VIDEO_FRAME_TYPE_2D ? EYES_BOTH : EYES_LEFT
326 } else if (!_decoded.empty ()) {
327 /* Get the last frame we have */
328 from = _decoded.back().frame;
329 /* And move onto the first frame we need */
331 if (_content->video->frame_type() == VIDEO_FRAME_TYPE_3D_LEFT || _content->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
332 /* The previous ++ will increment a 3D-left-eye to the same index right-eye. If we are dealing with
333 a single-eye source we need an extra ++ to move back to the same eye.
339 /* If we've pre-rolled on a seek we may now receive out-of-order frames
340 (frames before the last seek time) which we can just ignore.
342 if (from && (*from) > to_push.front().frame) {
346 int const max_decoded_size = 96;
348 /* If _decoded is already `full' there is no point in adding anything more to it,
349 as the new stuff will just be removed again.
351 if (_decoded.size() < max_decoded_size) {
353 switch (_content->video->frame_type ()) {
354 case VIDEO_FRAME_TYPE_2D:
355 fill_one_eye (from->index(), to_push.front().frame.index(), EYES_BOTH);
357 case VIDEO_FRAME_TYPE_3D:
358 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
359 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
360 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
361 fill_both_eyes (from.get(), to_push.front().frame);
363 case VIDEO_FRAME_TYPE_3D_LEFT:
364 fill_one_eye (from->index(), to_push.front().frame.index(), EYES_LEFT);
366 case VIDEO_FRAME_TYPE_3D_RIGHT:
367 fill_one_eye (from->index(), to_push.front().frame.index(), EYES_RIGHT);
372 copy (to_push.begin(), to_push.end(), back_inserter (_decoded));
375 /* We can't let this build up too much or we will run out of memory. There is a
376 `best' value for the allowed size of _decoded which balances memory use
377 with decoding efficiency (lack of seeks). Throwing away video frames here
378 is not a problem for correctness, so do it.
380 while (_decoded.size() > max_decoded_size) {
381 _decoded.pop_back ();
386 VideoDecoder::seek (ContentTime s, bool accurate)
388 _log->log (String::compose ("VD seek to %1", to_string(s)), LogEntry::TYPE_DEBUG_DECODE);
391 _last_seek_accurate = accurate;