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 "image_proxy.h"
  23 #include "raw_image_proxy.h"
  24 #include "raw_image_proxy.h"
  25 #include "film.h"
  26 #include "log.h"
  27
  28 #include "i18n.h"
  29
  30 using std::cout;
  31 using std::list;
  32 using std::max;
  33 using std::back_inserter;
  34 using boost::shared_ptr;
  35 using boost::optional;
  36
  37 VideoDecoder::VideoDecoder (shared_ptr<const VideoContent> c)
  38 #ifdef DCPOMATIC_DEBUG
  39         : test_gaps (0)
  40         , _video_content (c)
  41 #else
  42         : _video_content (c)
  43 #endif
  44         , _last_seek_accurate (true)
  45         , _ignore_video (false)
  46 {
  47         _black_image.reset (new Image (PIX_FMT_RGB24, _video_content->video_size(), true));
  48         _black_image->make_black ();
  49 }
  50
  51 list<ContentVideo>
  52 VideoDecoder::decoded_video (Frame frame)
  53 {
  54         list<ContentVideo> output;
  55
  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);
  59                 }
  60         }
  61
  62         return output;
  63 }
  64
  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.
  69  */
  70 list<ContentVideo>
  71 VideoDecoder::get_video (Frame frame, bool accurate)
  72 {
  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.
  76         */
  77
  78         if (_decoded_video.empty() || frame < _decoded_video.front().frame || frame > (_decoded_video.back().frame + 1)) {
  79                 seek (ContentTime::from_frames (frame, _video_content->video_frame_rate()), accurate);
  80         }
  81
  82         list<ContentVideo> dec;
  83
  84         /* Now enough pass() calls should either:
  85          *  (a) give us what we want, or
  86          *  (b) give us something after what we want, indicating that we will never get what we want, or
  87          *  (c) hit the end of the decoder.
  88          */
  89         if (accurate) {
  90                 /* We are being accurate, so we want the right frame.
  91                  * This could all be one statement but it's split up for clarity.
  92                  */
  93                 while (true) {
  94                         if (!decoded_video(frame).empty ()) {
  95                                 /* We got what we want */
  96                                 break;
  97                         }
  98
  99                         if (pass ()) {
 100                                 /* The decoder has nothing more for us */
 101                                 break;
 102                         }
 103
 104                         if (!_decoded_video.empty() && _decoded_video.front().frame > frame) {
 105                                 /* We're never going to get the frame we want.  Perhaps the caller is asking
 106                                  * for a video frame before the content's video starts (if its audio
 107                                  * begins before its video, for example).
 108                                  */
 109                                 break;
 110                         }
 111                 }
 112
 113                 dec = decoded_video (frame);
 114         } else {
 115                 /* Any frame will do: use the first one that comes out of pass() */
 116                 while (_decoded_video.empty() && !pass ()) {}
 117                 if (!_decoded_video.empty ()) {
 118                         dec.push_back (_decoded_video.front ());
 119                 }
 120         }
 121
 122         /* Clean up _decoded_video; keep the frame we are returning (which may have two images
 123            for 3D), but nothing before that */
 124         while (!_decoded_video.empty() && _decoded_video.front().frame < dec.front().frame) {
 125                 _decoded_video.pop_front ();
 126         }
 127
 128         return dec;
 129 }
 130
 131 /** Fill _decoded_video from `from' up to, but not including, `to' */
 132 void
 133 VideoDecoder::fill_2d (Frame from, Frame to)
 134 {
 135         if (to == 0) {
 136                 /* Already OK */
 137                 return;
 138         }
 139
 140         /* Fill with black... */
 141         boost::shared_ptr<const ImageProxy> filler_image (new RawImageProxy (_black_image));
 142         Part filler_part = PART_WHOLE;
 143
 144         /* ...unless there's some video we can fill with */
 145         if (!_decoded_video.empty ()) {
 146                 filler_image = _decoded_video.back().image;
 147                 filler_part = _decoded_video.back().part;
 148         }
 149
 150         for (Frame i = from; i < to; ++i) {
 151 #ifdef DCPOMATIC_DEBUG
 152                 test_gaps++;
 153 #endif
 154                 _decoded_video.push_back (
 155                         ContentVideo (filler_image, EYES_BOTH, filler_part, i)
 156                         );
 157         }
 158 }
 159
 160 /** Fill _decoded_video from `from' up to, but not including, `to' */
 161 void
 162 VideoDecoder::fill_3d (Frame from, Frame to, Eyes eye)
 163 {
 164         if (to == 0 && eye == EYES_LEFT) {
 165                 /* Already OK */
 166                 return;
 167         }
 168
 169         /* Fill with black... */
 170         boost::shared_ptr<const ImageProxy> filler_left_image (new RawImageProxy (_black_image));
 171         boost::shared_ptr<const ImageProxy> filler_right_image (new RawImageProxy (_black_image));
 172         Part filler_left_part = PART_WHOLE;
 173         Part filler_right_part = PART_WHOLE;
 174
 175         /* ...unless there's some video we can fill with */
 176         for (list<ContentVideo>::const_reverse_iterator i = _decoded_video.rbegin(); i != _decoded_video.rend(); ++i) {
 177                 if (i->eyes == EYES_LEFT && !filler_left_image) {
 178                         filler_left_image = i->image;
 179                         filler_left_part = i->part;
 180                 } else if (i->eyes == EYES_RIGHT && !filler_right_image) {
 181                         filler_right_image = i->image;
 182                         filler_right_part = i->part;
 183                 }
 184
 185                 if (filler_left_image && filler_right_image) {
 186                         break;
 187                 }
 188         }
 189
 190         Frame filler_frame = from;
 191         Eyes filler_eye = _decoded_video.empty() ? EYES_LEFT : _decoded_video.back().eyes;
 192
 193         if (_decoded_video.empty ()) {
 194                 filler_frame = 0;
 195                 filler_eye = EYES_LEFT;
 196         } else if (_decoded_video.back().eyes == EYES_LEFT) {
 197                 filler_frame = _decoded_video.back().frame;
 198                 filler_eye = EYES_RIGHT;
 199         } else if (_decoded_video.back().eyes == EYES_RIGHT) {
 200                 filler_frame = _decoded_video.back().frame + 1;
 201                 filler_eye = EYES_LEFT;
 202         }
 203
 204         while (filler_frame != to || filler_eye != eye) {
 205
 206 #ifdef DCPOMATIC_DEBUG
 207                 test_gaps++;
 208 #endif
 209
 210                 _decoded_video.push_back (
 211                         ContentVideo (
 212                                 filler_eye == EYES_LEFT ? filler_left_image : filler_right_image,
 213                                 filler_eye,
 214                                 filler_eye == EYES_LEFT ? filler_left_part : filler_right_part,
 215                                 filler_frame
 216                                 )
 217                         );
 218
 219                 if (filler_eye == EYES_LEFT) {
 220                         filler_eye = EYES_RIGHT;
 221                 } else {
 222                         filler_eye = EYES_LEFT;
 223                         ++filler_frame;
 224                 }
 225         }
 226 }
 227
 228 /** Called by subclasses when they have a video frame ready */
 229 void
 230 VideoDecoder::video (shared_ptr<const ImageProxy> image, Frame frame)
 231 {
 232         if (_ignore_video) {
 233                 return;
 234         }
 235
 236         /* We may receive the same frame index twice for 3D, and we need to know
 237            when that happens.
 238         */
 239         bool const same = (!_decoded_video.empty() && frame == _decoded_video.back().frame);
 240
 241         /* Work out what we are going to push into _decoded_video next */
 242         list<ContentVideo> to_push;
 243         switch (_video_content->video_frame_type ()) {
 244         case VIDEO_FRAME_TYPE_2D:
 245                 to_push.push_back (ContentVideo (image, EYES_BOTH, PART_WHOLE, frame));
 246                 break;
 247         case VIDEO_FRAME_TYPE_3D_ALTERNATE:
 248                 to_push.push_back (ContentVideo (image, same ? EYES_RIGHT : EYES_LEFT, PART_WHOLE, frame));
 249                 break;
 250         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 251                 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_LEFT_HALF, frame));
 252                 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_RIGHT_HALF, frame));
 253                 break;
 254         case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
 255                 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_TOP_HALF, frame));
 256                 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_BOTTOM_HALF, frame));
 257                 break;
 258         case VIDEO_FRAME_TYPE_3D_LEFT:
 259                 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_WHOLE, frame));
 260                 break;
 261         case VIDEO_FRAME_TYPE_3D_RIGHT:
 262                 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_WHOLE, frame));
 263                 break;
 264         default:
 265                 DCPOMATIC_ASSERT (false);
 266         }
 267
 268         /* Now VideoDecoder is required never to have gaps in the frames that it presents
 269            via get_video().  Hence we need to fill in any gap between the last thing in _decoded_video
 270            and the things we are about to push.
 271         */
 272
 273         boost::optional<Frame> from;
 274         boost::optional<Frame> to;
 275
 276         if (_decoded_video.empty() && _last_seek_time && _last_seek_accurate) {
 277                 from = _last_seek_time->frames (_video_content->video_frame_rate ());
 278                 to = to_push.front().frame;
 279         } else if (!_decoded_video.empty ()) {
 280                 from = _decoded_video.back().frame + 1;
 281                 to = to_push.front().frame;
 282         }
 283
 284         /* It has been known that this method receives frames out of order; at this
 285            point I'm not sure why, but we'll just ignore them.
 286         */
 287
 288         if (from && to && from.get() > to.get()) {
 289                 _video_content->film()->log()->log (
 290                         String::compose ("Ignoring out-of-order decoded frame %1 after %2", to.get(), from.get()), Log::TYPE_WARNING
 291                         );
 292                 return;
 293         }
 294
 295         if (from) {
 296                 if (_video_content->video_frame_type() == VIDEO_FRAME_TYPE_2D) {
 297                         fill_2d (from.get(), to.get ());
 298                 } else {
 299                         fill_3d (from.get(), to.get(), to_push.front().eyes);
 300                 }
 301         }
 302
 303         copy (to_push.begin(), to_push.end(), back_inserter (_decoded_video));
 304
 305         /* We can't let this build up too much or we will run out of memory.  We need to allow
 306            the most frames that can exist between blocks of sound in a multiplexed file.
 307         */
 308         DCPOMATIC_ASSERT (_decoded_video.size() <= 96);
 309 }
 310
 311 void
 312 VideoDecoder::seek (ContentTime s, bool accurate)
 313 {
 314         _decoded_video.clear ();
 315         _last_seek_time = s;
 316         _last_seek_accurate = accurate;
 317 }
 318
 319 /** Set this player never to produce any video data */
 320 void
 321 VideoDecoder::set_ignore_video ()
 322 {
 323         _ignore_video = true;
 324 }