2 Copyright (C) 2012-2015 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"
32 using std::back_inserter;
33 using boost::shared_ptr;
34 using boost::optional;
36 VideoDecoder::VideoDecoder (shared_ptr<const VideoContent> c)
37 #ifdef DCPOMATIC_DEBUG
43 , _last_seek_accurate (true)
44 , _ignore_video (false)
46 _black_image.reset (new Image (PIX_FMT_RGB24, _video_content->video_size(), true));
47 _black_image->make_black ();
51 VideoDecoder::decoded_video (Frame frame)
53 list<ContentVideo> output;
55 for (list<ContentVideo>::const_iterator i = _decoded_video.begin(); i != _decoded_video.end(); ++i) {
56 if (i->frame == frame) {
57 output.push_back (*i);
64 /** Get all frames which exist in the content at a given frame index.
65 * @param frame Frame index.
66 * @param accurate true to try hard to return frames at the precise time that was requested, otherwise frames nearby may be returned.
67 * @return Frames; there may be none (if there is no video there), 1 for 2D or 2 for 3D.
70 VideoDecoder::get_video (Frame frame, bool accurate)
72 /* At this stage, if we have get_video()ed before, _decoded_video will contain the last frame that this
73 method returned (and possibly a few more). If the requested frame is not in _decoded_video and it is not the next
74 one after the end of _decoded_video we need to seek.
77 _video_content->film()->log()->log (String::compose ("VD has request for %1", frame), Log::TYPE_DEBUG_DECODE);
79 if (_decoded_video.empty() || frame < _decoded_video.front().frame || frame > (_decoded_video.back().frame + 1)) {
80 seek (ContentTime::from_frames (frame, _video_content->video_frame_rate()), accurate);
83 list<ContentVideo> dec;
85 /* Now enough pass() calls should either:
86 * (a) give us what we want, or
87 * (b) give us something after what we want, indicating that we will never get what we want, or
88 * (c) hit the end of the decoder.
91 /* We are being accurate, so we want the right frame.
92 * This could all be one statement but it's split up for clarity.
95 if (!decoded_video(frame).empty ()) {
96 /* We got what we want */
101 /* The decoder has nothing more for us */
105 if (!_decoded_video.empty() && _decoded_video.front().frame > frame) {
106 /* We're never going to get the frame we want. Perhaps the caller is asking
107 * for a video frame before the content's video starts (if its audio
108 * begins before its video, for example).
114 dec = decoded_video (frame);
116 /* Any frame will do: use the first one that comes out of pass() */
117 while (_decoded_video.empty() && !pass ()) {}
118 if (!_decoded_video.empty ()) {
119 dec.push_back (_decoded_video.front ());
123 /* Clean up _decoded_video; keep the frame we are returning (which may have two images
124 for 3D), but nothing before that */
125 while (!_decoded_video.empty() && _decoded_video.front().frame < dec.front().frame) {
126 _decoded_video.pop_front ();
132 /** Fill _decoded_video from `from' up to, but not including, `to' with
133 * a frame for one particular Eyes value (which could be EYES_BOTH,
134 * EYES_LEFT or EYES_RIGHT)
137 VideoDecoder::fill_one_eye (Frame from, Frame to, Eyes eye)
144 /* Fill with black... */
145 shared_ptr<const ImageProxy> filler_image (new RawImageProxy (_black_image));
146 Part filler_part = PART_WHOLE;
148 /* ...unless there's some video we can fill with */
149 if (!_decoded_video.empty ()) {
150 filler_image = _decoded_video.back().image;
151 filler_part = _decoded_video.back().part;
154 for (Frame i = from; i < to; ++i) {
155 #ifdef DCPOMATIC_DEBUG
158 _decoded_video.push_back (
159 ContentVideo (filler_image, eye, filler_part, i)
164 /** Fill _decoded_video from `from' up to, but not including, `to'
165 * adding both left and right eye frames.
168 VideoDecoder::fill_both_eyes (Frame from, Frame to, Eyes eye)
170 if (to == 0 && eye == EYES_LEFT) {
175 /* Fill with black... */
176 shared_ptr<const ImageProxy> filler_left_image (new RawImageProxy (_black_image));
177 shared_ptr<const ImageProxy> filler_right_image (new RawImageProxy (_black_image));
178 Part filler_left_part = PART_WHOLE;
179 Part filler_right_part = PART_WHOLE;
181 /* ...unless there's some video we can fill with */
182 for (list<ContentVideo>::const_reverse_iterator i = _decoded_video.rbegin(); i != _decoded_video.rend(); ++i) {
183 if (i->eyes == EYES_LEFT && !filler_left_image) {
184 filler_left_image = i->image;
185 filler_left_part = i->part;
186 } else if (i->eyes == EYES_RIGHT && !filler_right_image) {
187 filler_right_image = i->image;
188 filler_right_part = i->part;
191 if (filler_left_image && filler_right_image) {
196 Frame filler_frame = from;
197 Eyes filler_eye = _decoded_video.empty() ? EYES_LEFT : _decoded_video.back().eyes;
199 if (_decoded_video.empty ()) {
201 filler_eye = EYES_LEFT;
202 } else if (_decoded_video.back().eyes == EYES_LEFT) {
203 filler_frame = _decoded_video.back().frame;
204 filler_eye = EYES_RIGHT;
205 } else if (_decoded_video.back().eyes == EYES_RIGHT) {
206 filler_frame = _decoded_video.back().frame + 1;
207 filler_eye = EYES_LEFT;
210 while (filler_frame != to || filler_eye != eye) {
212 #ifdef DCPOMATIC_DEBUG
216 _decoded_video.push_back (
218 filler_eye == EYES_LEFT ? filler_left_image : filler_right_image,
220 filler_eye == EYES_LEFT ? filler_left_part : filler_right_part,
225 if (filler_eye == EYES_LEFT) {
226 filler_eye = EYES_RIGHT;
228 filler_eye = EYES_LEFT;
234 /** Called by subclasses when they have a video frame ready */
236 VideoDecoder::video (shared_ptr<const ImageProxy> image, Frame frame)
242 _video_content->film()->log()->log (String::compose ("VD receives %1", frame), Log::TYPE_DEBUG_DECODE);
244 /* We may receive the same frame index twice for 3D, and we need to know
247 bool const same = (!_decoded_video.empty() && frame == _decoded_video.back().frame);
249 /* Work out what we are going to push into _decoded_video next */
250 list<ContentVideo> to_push;
251 switch (_video_content->video_frame_type ()) {
252 case VIDEO_FRAME_TYPE_2D:
253 to_push.push_back (ContentVideo (image, EYES_BOTH, PART_WHOLE, frame));
255 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
256 to_push.push_back (ContentVideo (image, same ? EYES_RIGHT : EYES_LEFT, PART_WHOLE, frame));
258 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
259 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_LEFT_HALF, frame));
260 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_RIGHT_HALF, frame));
262 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
263 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_TOP_HALF, frame));
264 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_BOTTOM_HALF, frame));
266 case VIDEO_FRAME_TYPE_3D_LEFT:
267 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_WHOLE, frame));
269 case VIDEO_FRAME_TYPE_3D_RIGHT:
270 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_WHOLE, frame));
273 DCPOMATIC_ASSERT (false);
276 /* Now VideoDecoder is required never to have gaps in the frames that it presents
277 via get_video(). Hence we need to fill in any gap between the last thing in _decoded_video
278 and the things we are about to push.
281 optional<Frame> from;
284 if (_decoded_video.empty() && _last_seek_time && _last_seek_accurate) {
285 from = _last_seek_time->frames_round (_video_content->video_frame_rate ());
286 to = to_push.front().frame;
287 } else if (!_decoded_video.empty ()) {
288 from = _decoded_video.back().frame + 1;
289 to = to_push.front().frame;
292 /* If we've pre-rolled on a seek we may now receive out-of-order frames
293 (frames before the last seek time) which we can just ignore.
296 if (from && to && from.get() > to.get()) {
301 switch (_video_content->video_frame_type ()) {
302 case VIDEO_FRAME_TYPE_2D:
303 fill_one_eye (from.get(), to.get (), EYES_BOTH);
305 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
306 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
307 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
308 fill_both_eyes (from.get(), to.get(), to_push.front().eyes);
310 case VIDEO_FRAME_TYPE_3D_LEFT:
311 fill_one_eye (from.get(), to.get (), EYES_LEFT);
313 case VIDEO_FRAME_TYPE_3D_RIGHT:
314 fill_one_eye (from.get(), to.get (), EYES_RIGHT);
318 copy (to_push.begin(), to_push.end(), back_inserter (_decoded_video));
320 /* We can't let this build up too much or we will run out of memory. We need to allow
321 the most frames that can exist between blocks of sound in a multiplexed file.
323 DCPOMATIC_ASSERT (_decoded_video.size() <= 96);
327 VideoDecoder::seek (ContentTime s, bool accurate)
329 _decoded_video.clear ();
331 _last_seek_accurate = accurate;
334 /** Set this player never to produce any video data */
336 VideoDecoder::set_ignore_video ()
338 _ignore_video = true;