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"
33 using std::back_inserter;
34 using boost::shared_ptr;
35 using boost::optional;
37 VideoDecoder::VideoDecoder (shared_ptr<const VideoContent> c)
38 #ifdef DCPOMATIC_DEBUG
44 , _last_seek_accurate (true)
45 , _ignore_video (false)
47 _black_image.reset (new Image (PIX_FMT_RGB24, _video_content->video_size(), true));
48 _black_image->make_black ();
52 VideoDecoder::decoded_video (Frame frame)
54 list<ContentVideo> output;
56 for (list<ContentVideo>::const_iterator i = _decoded_video.begin(); i != _decoded_video.end(); ++i) {
57 if (i->frame == frame) {
58 output.push_back (*i);
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_video (Frame frame, bool accurate)
73 /* At this stage, if we have get_video()ed before, _decoded_video will contain the last frame that this
74 method returned (and possibly a few more). If the requested frame is not in _decoded_video and it is not the next
75 one after the end of _decoded_video we need to seek.
78 _video_content->film()->log()->log (String::compose ("VD has request for %1", frame), Log::TYPE_DEBUG_DECODE);
80 if (_decoded_video.empty() || frame < _decoded_video.front().frame || frame > (_decoded_video.back().frame + 1)) {
81 seek (ContentTime::from_frames (frame, _video_content->video_frame_rate()), accurate);
84 list<ContentVideo> dec;
86 /* Now enough pass() calls should either:
87 * (a) give us what we want, or
88 * (b) give us something after what we want, indicating that we will never get what we want, or
89 * (c) hit the end of the decoder.
92 /* We are being accurate, so we want the right frame.
93 * This could all be one statement but it's split up for clarity.
96 if (!decoded_video(frame).empty ()) {
97 /* We got what we want */
102 /* The decoder has nothing more for us */
106 if (!_decoded_video.empty() && _decoded_video.front().frame > frame) {
107 /* We're never going to get the frame we want. Perhaps the caller is asking
108 * for a video frame before the content's video starts (if its audio
109 * begins before its video, for example).
115 dec = decoded_video (frame);
117 /* Any frame will do: use the first one that comes out of pass() */
118 while (_decoded_video.empty() && !pass ()) {}
119 if (!_decoded_video.empty ()) {
120 dec.push_back (_decoded_video.front ());
124 /* Clean up _decoded_video; keep the frame we are returning (which may have two images
125 for 3D), but nothing before that */
126 while (!_decoded_video.empty() && _decoded_video.front().frame < dec.front().frame) {
127 _decoded_video.pop_front ();
133 /** Fill _decoded_video from `from' up to, but not including, `to' with
134 * a frame for one particular Eyes value (which could be EYES_BOTH,
135 * EYES_LEFT or EYES_RIGHT)
138 VideoDecoder::fill_one_eye (Frame from, Frame to, Eyes eye)
145 /* Fill with black... */
146 shared_ptr<const ImageProxy> filler_image (new RawImageProxy (_black_image));
147 Part filler_part = PART_WHOLE;
149 /* ...unless there's some video we can fill with */
150 if (!_decoded_video.empty ()) {
151 filler_image = _decoded_video.back().image;
152 filler_part = _decoded_video.back().part;
155 for (Frame i = from; i < to; ++i) {
156 #ifdef DCPOMATIC_DEBUG
159 _decoded_video.push_back (
160 ContentVideo (filler_image, eye, filler_part, i)
165 /** Fill _decoded_video from `from' up to, but not including, `to'
166 * adding both left and right eye frames.
169 VideoDecoder::fill_both_eyes (Frame from, Frame to, Eyes eye)
171 if (to == 0 && eye == EYES_LEFT) {
176 /* Fill with black... */
177 shared_ptr<const ImageProxy> filler_left_image (new RawImageProxy (_black_image));
178 shared_ptr<const ImageProxy> filler_right_image (new RawImageProxy (_black_image));
179 Part filler_left_part = PART_WHOLE;
180 Part filler_right_part = PART_WHOLE;
182 /* ...unless there's some video we can fill with */
183 for (list<ContentVideo>::const_reverse_iterator i = _decoded_video.rbegin(); i != _decoded_video.rend(); ++i) {
184 if (i->eyes == EYES_LEFT && !filler_left_image) {
185 filler_left_image = i->image;
186 filler_left_part = i->part;
187 } else if (i->eyes == EYES_RIGHT && !filler_right_image) {
188 filler_right_image = i->image;
189 filler_right_part = i->part;
192 if (filler_left_image && filler_right_image) {
197 Frame filler_frame = from;
198 Eyes filler_eye = _decoded_video.empty() ? EYES_LEFT : _decoded_video.back().eyes;
200 if (_decoded_video.empty ()) {
202 filler_eye = EYES_LEFT;
203 } else if (_decoded_video.back().eyes == EYES_LEFT) {
204 filler_frame = _decoded_video.back().frame;
205 filler_eye = EYES_RIGHT;
206 } else if (_decoded_video.back().eyes == EYES_RIGHT) {
207 filler_frame = _decoded_video.back().frame + 1;
208 filler_eye = EYES_LEFT;
211 while (filler_frame != to || filler_eye != eye) {
213 #ifdef DCPOMATIC_DEBUG
217 _decoded_video.push_back (
219 filler_eye == EYES_LEFT ? filler_left_image : filler_right_image,
221 filler_eye == EYES_LEFT ? filler_left_part : filler_right_part,
226 if (filler_eye == EYES_LEFT) {
227 filler_eye = EYES_RIGHT;
229 filler_eye = EYES_LEFT;
235 /** Called by subclasses when they have a video frame ready */
237 VideoDecoder::video (shared_ptr<const ImageProxy> image, Frame frame)
243 _video_content->film()->log()->log (String::compose ("VD receives %1", frame), Log::TYPE_DEBUG_DECODE);
245 /* We may receive the same frame index twice for 3D, and we need to know
248 bool const same = (!_decoded_video.empty() && frame == _decoded_video.back().frame);
250 /* Work out what we are going to push into _decoded_video next */
251 list<ContentVideo> to_push;
252 switch (_video_content->video_frame_type ()) {
253 case VIDEO_FRAME_TYPE_2D:
254 to_push.push_back (ContentVideo (image, EYES_BOTH, PART_WHOLE, frame));
256 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
257 to_push.push_back (ContentVideo (image, same ? EYES_RIGHT : EYES_LEFT, PART_WHOLE, frame));
259 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
260 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_LEFT_HALF, frame));
261 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_RIGHT_HALF, frame));
263 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
264 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_TOP_HALF, frame));
265 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_BOTTOM_HALF, frame));
267 case VIDEO_FRAME_TYPE_3D_LEFT:
268 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_WHOLE, frame));
270 case VIDEO_FRAME_TYPE_3D_RIGHT:
271 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_WHOLE, frame));
274 DCPOMATIC_ASSERT (false);
277 /* Now VideoDecoder is required never to have gaps in the frames that it presents
278 via get_video(). Hence we need to fill in any gap between the last thing in _decoded_video
279 and the things we are about to push.
282 optional<Frame> from;
285 if (_decoded_video.empty() && _last_seek_time && _last_seek_accurate) {
286 from = _last_seek_time->frames_round (_video_content->video_frame_rate ());
287 to = to_push.front().frame;
288 } else if (!_decoded_video.empty ()) {
289 from = _decoded_video.back().frame + 1;
290 to = to_push.front().frame;
293 /* If we've pre-rolled on a seek we may now receive out-of-order frames
294 (frames before the last seek time) which we can just ignore.
297 if (from && to && from.get() > to.get()) {
302 switch (_video_content->video_frame_type ()) {
303 case VIDEO_FRAME_TYPE_2D:
304 fill_one_eye (from.get(), to.get (), EYES_BOTH);
306 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
307 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
308 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
309 fill_both_eyes (from.get(), to.get(), to_push.front().eyes);
311 case VIDEO_FRAME_TYPE_3D_LEFT:
312 fill_one_eye (from.get(), to.get (), EYES_LEFT);
314 case VIDEO_FRAME_TYPE_3D_RIGHT:
315 fill_one_eye (from.get(), to.get (), EYES_RIGHT);
319 copy (to_push.begin(), to_push.end(), back_inserter (_decoded_video));
321 /* We can't let this build up too much or we will run out of memory. We need to allow
322 the most frames that can exist between blocks of sound in a multiplexed file.
324 DCPOMATIC_ASSERT (_decoded_video.size() <= 96);
328 VideoDecoder::seek (ContentTime s, bool accurate)
330 _decoded_video.clear ();
332 _last_seek_accurate = accurate;
335 /** Set this player never to produce any video data */
337 VideoDecoder::set_ignore_video ()
339 _ignore_video = true;