src/lib/video_decoder.cc

   1 /*
   2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #include "video_decoder.h"
  21 #include "image.h"
  22 #include "content_video.h"
  23
  24 #include "i18n.h"
  25
  26 using std::cout;
  27 using std::list;
  28 using boost::shared_ptr;
  29 using boost::optional;
  30
  31 VideoDecoder::VideoDecoder (shared_ptr<const VideoContent> c)
  32 #ifdef DCPOMATIC_DEBUG
  33         : test_gaps (0)
  34         , _video_content (c)
  35 #else
  36         : _video_content (c)
  37 #endif
  38 {
  39
  40 }
  41
  42 list<ContentVideo>
  43 VideoDecoder::decoded_video (VideoFrame frame)
  44 {
  45         list<ContentVideo> output;
  46
  47         for (list<ContentVideo>::const_iterator i = _decoded_video.begin(); i != _decoded_video.end(); ++i) {
  48                 if (i->frame == frame) {
  49                         output.push_back (*i);
  50                 }
  51         }
  52
  53         return output;
  54 }
  55
  56 /** Get all frames which exist in the content at a given frame index.
  57  *  @param frame Frame index.
  58  *  @param accurate true to try hard to return frames at the precise time that was requested, otherwise frames nearby may be returned.
  59  *  @return Frames; there may be none (if there is no video there), 1 for 2D or 2 for 3D.
  60  */
  61 list<ContentVideo>
  62 VideoDecoder::get_video (VideoFrame frame, bool accurate)
  63 {
  64         /* At this stage, if we have get_video()ed before, _decoded_video will contain the last frame that this
  65            method returned (and possibly a few more).  If the requested frame is not in _decoded_video and it is not the next
  66            one after the end of _decoded_video we need to seek.
  67         */
  68
  69         if (_decoded_video.empty() || frame < _decoded_video.front().frame || frame > (_decoded_video.back().frame + 1)) {
  70                 seek (ContentTime::from_frames (frame, _video_content->video_frame_rate()), accurate);
  71         }
  72
  73         list<ContentVideo> dec;
  74
  75         /* Now enough pass() calls should either:
  76          *  (a) give us what we want, or
  77          *  (b) give us something after what we want, indicating that we will never get what we want, or
  78          *  (c) hit the end of the decoder.
  79          */
  80         if (accurate) {
  81                 /* We are being accurate, so we want the right frame.
  82                  * This could all be one statement but it's split up for clarity.
  83                  */
  84                 while (true) {
  85                         if (!decoded_video(frame).empty ()) {
  86                                 /* We got what we want */
  87                                 break;
  88                         }
  89
  90                         if (pass ()) {
  91                                 /* The decoder has nothing more for us */
  92                                 break;
  93                         }
  94
  95                         if (!_decoded_video.empty() && _decoded_video.front().frame > frame) {
  96                                 /* We're never going to get the frame we want.  Perhaps the caller is asking
  97                                  * for a video frame before the content's video starts (if its audio
  98                                  * begins before its video, for example).
  99                                  */
 100                                 break;
 101                         }
 102                 }
 103
 104                 dec = decoded_video (frame);
 105         } else {
 106                 /* Any frame will do: use the first one that comes out of pass() */
 107                 while (_decoded_video.empty() && !pass ()) {}
 108                 if (!_decoded_video.empty ()) {
 109                         dec.push_back (_decoded_video.front ());
 110                 }
 111         }
 112
 113         /* Clean up _decoded_video; keep the frame we are returning, but nothing before that */
 114         while (!_decoded_video.empty() && _decoded_video.front().frame < dec.front().frame) {
 115                 _decoded_video.pop_front ();
 116         }
 117
 118         return dec;
 119 }
 120
 121
 122 /** Called by subclasses when they have a video frame ready */
 123 void
 124 VideoDecoder::video (shared_ptr<const ImageProxy> image, VideoFrame frame)
 125 {
 126         /* We should not receive the same thing twice */
 127         assert (_decoded_video.empty() || frame != _decoded_video.back().frame);
 128
 129         /* Fill in gaps */
 130         /* XXX: 3D */
 131
 132         while (!_decoded_video.empty () && (_decoded_video.back().frame + 1) < frame) {
 133 #ifdef DCPOMATIC_DEBUG
 134                 test_gaps++;
 135 #endif
 136                 _decoded_video.push_back (
 137                         ContentVideo (
 138                                 _decoded_video.back().image,
 139                                 _decoded_video.back().eyes,
 140                                 _decoded_video.back().part,
 141                                 _decoded_video.back().frame + 1
 142                                 )
 143                         );
 144         }
 145
 146         switch (_video_content->video_frame_type ()) {
 147         case VIDEO_FRAME_TYPE_2D:
 148                 _decoded_video.push_back (ContentVideo (image, EYES_BOTH, PART_WHOLE, frame));
 149                 break;
 150         case VIDEO_FRAME_TYPE_3D_ALTERNATE:
 151                 _decoded_video.push_back (ContentVideo (image, (frame % 2) ? EYES_RIGHT : EYES_LEFT, PART_WHOLE, frame));
 152                 break;
 153         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 154                 _decoded_video.push_back (ContentVideo (image, EYES_LEFT, PART_LEFT_HALF, frame));
 155                 _decoded_video.push_back (ContentVideo (image, EYES_RIGHT, PART_RIGHT_HALF, frame));
 156                 break;
 157         case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
 158                 _decoded_video.push_back (ContentVideo (image, EYES_LEFT, PART_TOP_HALF, frame));
 159                 _decoded_video.push_back (ContentVideo (image, EYES_RIGHT, PART_BOTTOM_HALF, frame));
 160                 break;
 161         case VIDEO_FRAME_TYPE_3D_LEFT:
 162                 _decoded_video.push_back (ContentVideo (image, EYES_LEFT, PART_WHOLE, frame));
 163                 break;
 164         case VIDEO_FRAME_TYPE_3D_RIGHT:
 165                 _decoded_video.push_back (ContentVideo (image, EYES_RIGHT, PART_WHOLE, frame));
 166                 break;
 167         default:
 168                 assert (false);
 169         }
 170 }
 171
 172 void
 173 VideoDecoder::seek (ContentTime, bool)
 174 {
 175         _decoded_video.clear ();
 176 }
 177