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 #ifdef DCPOMATIC_DEBUG
49 , _last_seek_accurate (true)
52 _black_image.reset (new Image (AV_PIX_FMT_RGB24, _content->video->size(), true));
53 _black_image->make_black ();
57 VideoDecoder::decoded (Frame frame)
59 list<ContentVideo> output;
61 BOOST_FOREACH (ContentVideo const & i, _decoded) {
62 if (i.frame.index() == frame) {
70 /** Get all frames which exist in the content at a given frame index.
71 * @param frame Frame index.
72 * @param accurate true to try hard to return frames at the precise time that was requested, otherwise frames nearby may be returned.
73 * @return Frames; there may be none (if there is no video there), 1 for 2D or 2 for 3D.
76 VideoDecoder::get (Frame frame, bool accurate)
78 if (_no_data_frame && frame >= _no_data_frame.get()) {
79 return list<ContentVideo> ();
82 /* At this stage, if we have get_video()ed before, _decoded will contain the last frame that this
83 method returned (and possibly a few more). If the requested frame is not in _decoded and it is not the next
84 one after the end of _decoded we need to seek.
87 _log->log (String::compose ("VD has request for %1", frame), LogEntry::TYPE_DEBUG_DECODE);
89 if (_decoded.empty() || frame < _decoded.front().frame.index() || frame > (_decoded.back().frame.index() + 1)) {
90 _parent->seek (ContentTime::from_frames (frame, _content->active_video_frame_rate()), accurate);
93 /* Work out the number of frames that we should return; we
94 must return all frames in our content at the requested `time'
97 unsigned int frames_wanted = 0;
98 switch (_content->video->frame_type()) {
99 case VIDEO_FRAME_TYPE_2D:
100 case VIDEO_FRAME_TYPE_3D_LEFT:
101 case VIDEO_FRAME_TYPE_3D_RIGHT:
104 case VIDEO_FRAME_TYPE_3D:
105 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
106 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
107 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
111 DCPOMATIC_ASSERT (false);
114 list<ContentVideo> dec;
116 /* Now enough pass() calls should either:
117 * (a) give us what we want, or
118 * (b) give us something after what we want, indicating that we will never get what we want, or
119 * (c) hit the end of the decoder.
122 /* We are being accurate, so we want the right frame.
123 * This could all be one statement but it's split up for clarity.
125 bool no_data = false;
128 if (decoded(frame).size() == frames_wanted) {
129 /* We got what we want */
133 if (_parent->pass (Decoder::PASS_REASON_VIDEO, accurate)) {
134 /* The decoder has nothing more for us */
139 if (!_decoded.empty() && _decoded.front().frame.index() > frame) {
140 /* We're never going to get the frame we want. Perhaps the caller is asking
141 * for a video frame before the content's video starts (if its audio
142 * begins before its video, for example).
148 dec = decoded (frame);
150 if (no_data && dec.empty()) {
151 _no_data_frame = frame;
155 /* Any frame(s) will do: use the first one(s) that comes out of pass() */
156 while (_decoded.size() < frames_wanted && !_parent->pass (Decoder::PASS_REASON_VIDEO, accurate)) {}
157 list<ContentVideo>::const_iterator i = _decoded.begin();
159 while (i != _decoded.end() && j < frames_wanted) {
166 /* Clean up _decoded; keep the frame we are returning, if any (which may have two images
167 for 3D), but nothing before that
169 while (!_decoded.empty() && !dec.empty() && _decoded.front().frame.index() < dec.front().frame.index()) {
170 _decoded.pop_front ();
176 /** Fill _decoded from `from' up to, but not including, `to' with
177 * a frame for one particular Eyes value (which could be EYES_BOTH,
178 * EYES_LEFT or EYES_RIGHT)
181 VideoDecoder::fill_one_eye (Frame from, Frame to, Eyes eye)
188 /* Fill with black... */
189 shared_ptr<const ImageProxy> filler_image (new RawImageProxy (_black_image));
190 Part filler_part = PART_WHOLE;
192 /* ...unless there's some video we can fill with */
193 if (!_decoded.empty ()) {
194 filler_image = _decoded.back().image;
195 filler_part = _decoded.back().part;
198 for (Frame i = from; i < to; ++i) {
199 #ifdef DCPOMATIC_DEBUG
203 ContentVideo (filler_image, VideoFrame (i, eye), filler_part)
208 /** Fill _decoded from `from' up to, but not including, `to'
209 * adding both left and right eye frames.
212 VideoDecoder::fill_both_eyes (VideoFrame from, VideoFrame to)
214 /* Fill with black... */
215 shared_ptr<const ImageProxy> filler_left_image (new RawImageProxy (_black_image));
216 shared_ptr<const ImageProxy> filler_right_image (new RawImageProxy (_black_image));
217 Part filler_left_part = PART_WHOLE;
218 Part filler_right_part = PART_WHOLE;
220 /* ...unless there's some video we can fill with */
221 for (list<ContentVideo>::const_reverse_iterator i = _decoded.rbegin(); i != _decoded.rend(); ++i) {
222 if (i->frame.eyes() == EYES_LEFT && !filler_left_image) {
223 filler_left_image = i->image;
224 filler_left_part = i->part;
225 } else if (i->frame.eyes() == EYES_RIGHT && !filler_right_image) {
226 filler_right_image = i->image;
227 filler_right_part = i->part;
230 if (filler_left_image && filler_right_image) {
237 #ifdef DCPOMATIC_DEBUG
243 from.eyes() == EYES_LEFT ? filler_left_image : filler_right_image,
245 from.eyes() == EYES_LEFT ? filler_left_part : filler_right_part
253 /** Called by decoder classes when they have a video frame ready */
255 VideoDecoder::give (shared_ptr<const ImageProxy> image, Frame frame)
261 _log->log (String::compose ("VD receives %1", frame), LogEntry::TYPE_DEBUG_DECODE);
263 /* Work out what we are going to push into _decoded next */
264 list<ContentVideo> to_push;
265 switch (_content->video->frame_type ()) {
266 case VIDEO_FRAME_TYPE_2D:
267 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_BOTH), PART_WHOLE));
269 case VIDEO_FRAME_TYPE_3D:
271 /* We receive the same frame index twice for 3D; hence we know which
274 bool const same = (!_decoded.empty() && frame == _decoded.back().frame.index());
275 to_push.push_back (ContentVideo (image, VideoFrame (frame, same ? EYES_RIGHT : EYES_LEFT), PART_WHOLE));
278 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
279 to_push.push_back (ContentVideo (image, VideoFrame (frame / 2, (frame % 2) ? EYES_RIGHT : EYES_LEFT), PART_WHOLE));
281 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
282 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_LEFT), PART_LEFT_HALF));
283 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_RIGHT), PART_RIGHT_HALF));
285 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
286 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_LEFT), PART_TOP_HALF));
287 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_RIGHT), PART_BOTTOM_HALF));
289 case VIDEO_FRAME_TYPE_3D_LEFT:
290 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_LEFT), PART_WHOLE));
292 case VIDEO_FRAME_TYPE_3D_RIGHT:
293 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_RIGHT), PART_WHOLE));
296 DCPOMATIC_ASSERT (false);
299 /* Now VideoDecoder is required never to have gaps in the frames that it presents
300 via get_video(). Hence we need to fill in any gap between the last thing in _decoded
301 and the things we are about to push.
304 optional<VideoFrame> from;
306 if (_decoded.empty() && _last_seek_time && _last_seek_accurate) {
308 _last_seek_time->frames_round (_content->active_video_frame_rate ()),
309 _content->video->frame_type() == VIDEO_FRAME_TYPE_2D ? EYES_BOTH : EYES_LEFT
311 } else if (!_decoded.empty ()) {
312 /* Get the last frame we have */
313 from = _decoded.back().frame;
314 /* And move onto the first frame we need */
316 if (_content->video->frame_type() == VIDEO_FRAME_TYPE_3D_LEFT || _content->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
317 /* The previous ++ will increment a 3D-left-eye to the same index right-eye. If we are dealing with
318 a single-eye source we need an extra ++ to move back to the same eye.
324 /* If we've pre-rolled on a seek we may now receive out-of-order frames
325 (frames before the last seek time) which we can just ignore.
327 if (from && (*from) > to_push.front().frame) {
331 int const max_decoded_size = 96;
333 /* If _decoded is already `full' there is no point in adding anything more to it,
334 as the new stuff will just be removed again.
336 if (_decoded.size() < max_decoded_size) {
338 switch (_content->video->frame_type ()) {
339 case VIDEO_FRAME_TYPE_2D:
340 fill_one_eye (from->index(), to_push.front().frame.index(), EYES_BOTH);
342 case VIDEO_FRAME_TYPE_3D:
343 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
344 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
345 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
346 fill_both_eyes (from.get(), to_push.front().frame);
348 case VIDEO_FRAME_TYPE_3D_LEFT:
349 fill_one_eye (from->index(), to_push.front().frame.index(), EYES_LEFT);
351 case VIDEO_FRAME_TYPE_3D_RIGHT:
352 fill_one_eye (from->index(), to_push.front().frame.index(), EYES_RIGHT);
357 copy (to_push.begin(), to_push.end(), back_inserter (_decoded));
360 /* We can't let this build up too much or we will run out of memory. There is a
361 `best' value for the allowed size of _decoded which balances memory use
362 with decoding efficiency (lack of seeks). Throwing away video frames here
363 is not a problem for correctness, so do it.
365 while (_decoded.size() > max_decoded_size) {
366 _decoded.pop_back ();
371 VideoDecoder::seek (ContentTime s, bool accurate)
375 _last_seek_accurate = accurate;
378 /** Set this decoder never to produce any data */
380 VideoDecoder::set_ignore ()