2 Copyright (C) 2012-2016 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 #include "video_decoder.h"
22 #include "raw_image_proxy.h"
25 #include "compose.hpp"
33 using std::back_inserter;
34 using boost::shared_ptr;
35 using boost::optional;
37 VideoDecoder::VideoDecoder (shared_ptr<const Content> c, shared_ptr<Log> log)
38 #ifdef DCPOMATIC_DEBUG
45 , _last_seek_accurate (true)
46 , _ignore_video (false)
48 _black_image.reset (new Image (AV_PIX_FMT_RGB24, _video_content->video->size(), true));
49 _black_image->make_black ();
53 VideoDecoder::decoded_video (Frame frame)
55 list<ContentVideo> output;
57 for (list<ContentVideo>::const_iterator i = _decoded_video.begin(); i != _decoded_video.end(); ++i) {
58 if (i->frame == frame) {
59 output.push_back (*i);
66 /** Get all frames which exist in the content at a given frame index.
67 * @param frame Frame index.
68 * @param accurate true to try hard to return frames at the precise time that was requested, otherwise frames nearby may be returned.
69 * @return Frames; there may be none (if there is no video there), 1 for 2D or 2 for 3D.
72 VideoDecoder::get_video (Frame frame, bool accurate)
74 if (_no_data_frame && frame >= _no_data_frame.get()) {
75 return list<ContentVideo> ();
78 /* At this stage, if we have get_video()ed before, _decoded_video will contain the last frame that this
79 method returned (and possibly a few more). If the requested frame is not in _decoded_video and it is not the next
80 one after the end of _decoded_video we need to seek.
83 _log->log (String::compose ("VD has request for %1", frame), LogEntry::TYPE_DEBUG_DECODE);
85 if (_decoded_video.empty() || frame < _decoded_video.front().frame || frame > (_decoded_video.back().frame + 1)) {
86 seek (ContentTime::from_frames (frame, _video_content->active_video_frame_rate()), accurate);
89 list<ContentVideo> dec;
91 /* Now enough pass() calls should either:
92 * (a) give us what we want, or
93 * (b) give us something after what we want, indicating that we will never get what we want, or
94 * (c) hit the end of the decoder.
97 /* We are being accurate, so we want the right frame.
98 * This could all be one statement but it's split up for clarity.
100 bool no_data = false;
103 if (!decoded_video(frame).empty ()) {
104 /* We got what we want */
108 if (pass (PASS_REASON_VIDEO, accurate)) {
109 /* The decoder has nothing more for us */
114 if (!_decoded_video.empty() && _decoded_video.front().frame > frame) {
115 /* We're never going to get the frame we want. Perhaps the caller is asking
116 * for a video frame before the content's video starts (if its audio
117 * begins before its video, for example).
123 dec = decoded_video (frame);
125 if (no_data && dec.empty()) {
126 _no_data_frame = frame;
130 /* Any frame will do: use the first one that comes out of pass() */
131 while (_decoded_video.empty() && !pass (PASS_REASON_VIDEO, accurate)) {}
132 if (!_decoded_video.empty ()) {
133 dec.push_back (_decoded_video.front ());
137 /* Clean up _decoded_video; keep the frame we are returning, if any (which may have two images
138 for 3D), but nothing before that */
139 while (!_decoded_video.empty() && !dec.empty() && _decoded_video.front().frame < dec.front().frame) {
140 _decoded_video.pop_front ();
146 /** Fill _decoded_video from `from' up to, but not including, `to' with
147 * a frame for one particular Eyes value (which could be EYES_BOTH,
148 * EYES_LEFT or EYES_RIGHT)
151 VideoDecoder::fill_one_eye (Frame from, Frame to, Eyes eye)
158 /* Fill with black... */
159 shared_ptr<const ImageProxy> filler_image (new RawImageProxy (_black_image));
160 Part filler_part = PART_WHOLE;
162 /* ...unless there's some video we can fill with */
163 if (!_decoded_video.empty ()) {
164 filler_image = _decoded_video.back().image;
165 filler_part = _decoded_video.back().part;
168 for (Frame i = from; i < to; ++i) {
169 #ifdef DCPOMATIC_DEBUG
172 _decoded_video.push_back (
173 ContentVideo (filler_image, eye, filler_part, i)
178 /** Fill _decoded_video from `from' up to, but not including, `to'
179 * adding both left and right eye frames.
182 VideoDecoder::fill_both_eyes (Frame from, Frame to, Eyes eye)
184 if (to == 0 && eye == EYES_LEFT) {
189 /* Fill with black... */
190 shared_ptr<const ImageProxy> filler_left_image (new RawImageProxy (_black_image));
191 shared_ptr<const ImageProxy> filler_right_image (new RawImageProxy (_black_image));
192 Part filler_left_part = PART_WHOLE;
193 Part filler_right_part = PART_WHOLE;
195 /* ...unless there's some video we can fill with */
196 for (list<ContentVideo>::const_reverse_iterator i = _decoded_video.rbegin(); i != _decoded_video.rend(); ++i) {
197 if (i->eyes == EYES_LEFT && !filler_left_image) {
198 filler_left_image = i->image;
199 filler_left_part = i->part;
200 } else if (i->eyes == EYES_RIGHT && !filler_right_image) {
201 filler_right_image = i->image;
202 filler_right_part = i->part;
205 if (filler_left_image && filler_right_image) {
210 Frame filler_frame = from;
211 Eyes filler_eye = _decoded_video.empty() ? EYES_LEFT : _decoded_video.back().eyes;
213 if (_decoded_video.empty ()) {
215 filler_eye = EYES_LEFT;
216 } else if (_decoded_video.back().eyes == EYES_LEFT) {
217 filler_frame = _decoded_video.back().frame;
218 filler_eye = EYES_RIGHT;
219 } else if (_decoded_video.back().eyes == EYES_RIGHT) {
220 filler_frame = _decoded_video.back().frame + 1;
221 filler_eye = EYES_LEFT;
224 while (filler_frame != to || filler_eye != eye) {
226 #ifdef DCPOMATIC_DEBUG
230 _decoded_video.push_back (
232 filler_eye == EYES_LEFT ? filler_left_image : filler_right_image,
234 filler_eye == EYES_LEFT ? filler_left_part : filler_right_part,
239 if (filler_eye == EYES_LEFT) {
240 filler_eye = EYES_RIGHT;
242 filler_eye = EYES_LEFT;
248 /** Called by subclasses when they have a video frame ready */
250 VideoDecoder::video (shared_ptr<const ImageProxy> image, Frame frame)
256 _log->log (String::compose ("VD receives %1", frame), LogEntry::TYPE_DEBUG_DECODE);
258 /* Work out what we are going to push into _decoded_video next */
259 list<ContentVideo> to_push;
260 switch (_video_content->video->frame_type ()) {
261 case VIDEO_FRAME_TYPE_2D:
262 to_push.push_back (ContentVideo (image, EYES_BOTH, PART_WHOLE, frame));
264 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
266 /* We receive the same frame index twice for 3D-alternate; hence we know which
269 bool const same = (!_decoded_video.empty() && frame == _decoded_video.back().frame);
270 to_push.push_back (ContentVideo (image, same ? EYES_RIGHT : EYES_LEFT, PART_WHOLE, frame));
273 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
274 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_LEFT_HALF, frame));
275 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_RIGHT_HALF, frame));
277 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
278 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_TOP_HALF, frame));
279 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_BOTTOM_HALF, frame));
281 case VIDEO_FRAME_TYPE_3D_LEFT:
282 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_WHOLE, frame));
284 case VIDEO_FRAME_TYPE_3D_RIGHT:
285 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_WHOLE, frame));
288 DCPOMATIC_ASSERT (false);
291 /* Now VideoDecoder is required never to have gaps in the frames that it presents
292 via get_video(). Hence we need to fill in any gap between the last thing in _decoded_video
293 and the things we are about to push.
296 optional<Frame> from;
299 if (_decoded_video.empty() && _last_seek_time && _last_seek_accurate) {
300 from = _last_seek_time->frames_round (_video_content->active_video_frame_rate ());
301 to = to_push.front().frame;
302 } else if (!_decoded_video.empty ()) {
303 from = _decoded_video.back().frame + 1;
304 to = to_push.front().frame;
307 /* If we've pre-rolled on a seek we may now receive out-of-order frames
308 (frames before the last seek time) which we can just ignore.
311 if (from && to && from.get() > to.get()) {
316 switch (_video_content->video->frame_type ()) {
317 case VIDEO_FRAME_TYPE_2D:
318 fill_one_eye (from.get(), to.get (), EYES_BOTH);
320 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
321 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
322 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
323 fill_both_eyes (from.get(), to.get(), to_push.front().eyes);
325 case VIDEO_FRAME_TYPE_3D_LEFT:
326 fill_one_eye (from.get(), to.get (), EYES_LEFT);
328 case VIDEO_FRAME_TYPE_3D_RIGHT:
329 fill_one_eye (from.get(), to.get (), EYES_RIGHT);
334 copy (to_push.begin(), to_push.end(), back_inserter (_decoded_video));
336 /* We can't let this build up too much or we will run out of memory. There is a
337 `best' value for the allowed size of _decoded_video which balances memory use
338 with decoding efficiency (lack of seeks). Throwing away video frames here
339 is not a problem for correctness, so do it.
341 while (_decoded_video.size() > 96) {
342 _decoded_video.pop_back ();
347 VideoDecoder::seek (ContentTime s, bool accurate)
349 _decoded_video.clear ();
351 _last_seek_accurate = accurate;
354 /** Set this player never to produce any video data */
356 VideoDecoder::set_ignore_video ()
358 _ignore_video = true;