src/lib/video_decoder.cc

   1 /*
   2     Copyright (C) 2012-2016 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 "raw_image_proxy.h"
  23 #include "film.h"
  24 #include "log.h"
  25 #include "compose.hpp"
  26 #include <iostream>
  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 (AV_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         if (_no_data_frame && frame >= _no_data_frame.get()) {
  74                 return list<ContentVideo> ();
  75         }
  76
  77         /* At this stage, if we have get_video()ed before, _decoded_video will contain the last frame that this
  78            method returned (and possibly a few more).  If the requested frame is not in _decoded_video and it is not the next
  79            one after the end of _decoded_video we need to seek.
  80         */
  81
  82         _video_content->film()->log()->log (String::compose ("VD has request for %1", frame), LogEntry::TYPE_DEBUG_DECODE);
  83
  84         if (_decoded_video.empty() || frame < _decoded_video.front().frame || frame > (_decoded_video.back().frame + 1)) {
  85                 seek (ContentTime::from_frames (frame, _video_content->video_frame_rate()), accurate);
  86         }
  87
  88         list<ContentVideo> dec;
  89
  90         /* Now enough pass() calls should either:
  91          *  (a) give us what we want, or
  92          *  (b) give us something after what we want, indicating that we will never get what we want, or
  93          *  (c) hit the end of the decoder.
  94          */
  95         if (accurate) {
  96                 /* We are being accurate, so we want the right frame.
  97                  * This could all be one statement but it's split up for clarity.
  98                  */
  99                 while (true) {
 100                         if (!decoded_video(frame).empty ()) {
 101                                 /* We got what we want */
 102                                 break;
 103                         }
 104
 105                         if (pass (PASS_REASON_VIDEO, accurate)) {
 106                                 /* The decoder has nothing more for us */
 107                                 _no_data_frame = frame;
 108                                 break;
 109                         }
 110
 111                         if (!_decoded_video.empty() && _decoded_video.front().frame > frame) {
 112                                 /* We're never going to get the frame we want.  Perhaps the caller is asking
 113                                  * for a video frame before the content's video starts (if its audio
 114                                  * begins before its video, for example).
 115                                  */
 116                                 break;
 117                         }
 118                 }
 119
 120                 dec = decoded_video (frame);
 121         } else {
 122                 /* Any frame will do: use the first one that comes out of pass() */
 123                 while (_decoded_video.empty() && !pass (PASS_REASON_VIDEO, accurate)) {}
 124                 if (!_decoded_video.empty ()) {
 125                         dec.push_back (_decoded_video.front ());
 126                 }
 127         }
 128
 129         /* Clean up _decoded_video; keep the frame we are returning, if any (which may have two images
 130            for 3D), but nothing before that */
 131         while (!_decoded_video.empty() && !dec.empty() && _decoded_video.front().frame < dec.front().frame) {
 132                 _decoded_video.pop_front ();
 133         }
 134
 135         return dec;
 136 }
 137
 138 /** Fill _decoded_video from `from' up to, but not including, `to' with
 139  *  a frame for one particular Eyes value (which could be EYES_BOTH,
 140  *  EYES_LEFT or EYES_RIGHT)
 141  */
 142 void
 143 VideoDecoder::fill_one_eye (Frame from, Frame to, Eyes eye)
 144 {
 145         if (to == 0) {
 146                 /* Already OK */
 147                 return;
 148         }
 149
 150         /* Fill with black... */
 151         shared_ptr<const ImageProxy> filler_image (new RawImageProxy (_black_image));
 152         Part filler_part = PART_WHOLE;
 153
 154         /* ...unless there's some video we can fill with */
 155         if (!_decoded_video.empty ()) {
 156                 filler_image = _decoded_video.back().image;
 157                 filler_part = _decoded_video.back().part;
 158         }
 159
 160         for (Frame i = from; i < to; ++i) {
 161 #ifdef DCPOMATIC_DEBUG
 162                 test_gaps++;
 163 #endif
 164                 _decoded_video.push_back (
 165                         ContentVideo (filler_image, eye, filler_part, i)
 166                         );
 167         }
 168 }
 169
 170 /** Fill _decoded_video from `from' up to, but not including, `to'
 171  *  adding both left and right eye frames.
 172  */
 173 void
 174 VideoDecoder::fill_both_eyes (Frame from, Frame to, Eyes eye)
 175 {
 176         if (to == 0 && eye == EYES_LEFT) {
 177                 /* Already OK */
 178                 return;
 179         }
 180
 181         /* Fill with black... */
 182         shared_ptr<const ImageProxy> filler_left_image (new RawImageProxy (_black_image));
 183         shared_ptr<const ImageProxy> filler_right_image (new RawImageProxy (_black_image));
 184         Part filler_left_part = PART_WHOLE;
 185         Part filler_right_part = PART_WHOLE;
 186
 187         /* ...unless there's some video we can fill with */
 188         for (list<ContentVideo>::const_reverse_iterator i = _decoded_video.rbegin(); i != _decoded_video.rend(); ++i) {
 189                 if (i->eyes == EYES_LEFT && !filler_left_image) {
 190                         filler_left_image = i->image;
 191                         filler_left_part = i->part;
 192                 } else if (i->eyes == EYES_RIGHT && !filler_right_image) {
 193                         filler_right_image = i->image;
 194                         filler_right_part = i->part;
 195                 }
 196
 197                 if (filler_left_image && filler_right_image) {
 198                         break;
 199                 }
 200         }
 201
 202         Frame filler_frame = from;
 203         Eyes filler_eye = _decoded_video.empty() ? EYES_LEFT : _decoded_video.back().eyes;
 204
 205         if (_decoded_video.empty ()) {
 206                 filler_frame = 0;
 207                 filler_eye = EYES_LEFT;
 208         } else if (_decoded_video.back().eyes == EYES_LEFT) {
 209                 filler_frame = _decoded_video.back().frame;
 210                 filler_eye = EYES_RIGHT;
 211         } else if (_decoded_video.back().eyes == EYES_RIGHT) {
 212                 filler_frame = _decoded_video.back().frame + 1;
 213                 filler_eye = EYES_LEFT;
 214         }
 215
 216         while (filler_frame != to || filler_eye != eye) {
 217
 218 #ifdef DCPOMATIC_DEBUG
 219                 test_gaps++;
 220 #endif
 221
 222                 _decoded_video.push_back (
 223                         ContentVideo (
 224                                 filler_eye == EYES_LEFT ? filler_left_image : filler_right_image,
 225                                 filler_eye,
 226                                 filler_eye == EYES_LEFT ? filler_left_part : filler_right_part,
 227                                 filler_frame
 228                                 )
 229                         );
 230
 231                 if (filler_eye == EYES_LEFT) {
 232                         filler_eye = EYES_RIGHT;
 233                 } else {
 234                         filler_eye = EYES_LEFT;
 235                         ++filler_frame;
 236                 }
 237         }
 238 }
 239
 240 /** Called by subclasses when they have a video frame ready */
 241 void
 242 VideoDecoder::video (shared_ptr<const ImageProxy> image, Frame frame)
 243 {
 244         if (_ignore_video) {
 245                 return;
 246         }
 247
 248         _video_content->film()->log()->log (String::compose ("VD receives %1", frame), LogEntry::TYPE_DEBUG_DECODE);
 249
 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));
 255                 break;
 256         case VIDEO_FRAME_TYPE_3D_ALTERNATE:
 257         {
 258                 /* We receive the same frame index twice for 3D-alternate; hence we know which
 259                    frame this one is.
 260                 */
 261                 bool const same = (!_decoded_video.empty() && frame == _decoded_video.back().frame);
 262                 to_push.push_back (ContentVideo (image, same ? EYES_RIGHT : EYES_LEFT, PART_WHOLE, frame));
 263                 break;
 264         }
 265         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 266                 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_LEFT_HALF, frame));
 267                 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_RIGHT_HALF, frame));
 268                 break;
 269         case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
 270                 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_TOP_HALF, frame));
 271                 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_BOTTOM_HALF, frame));
 272                 break;
 273         case VIDEO_FRAME_TYPE_3D_LEFT:
 274                 to_push.push_back (ContentVideo (image, EYES_LEFT, PART_WHOLE, frame));
 275                 break;
 276         case VIDEO_FRAME_TYPE_3D_RIGHT:
 277                 to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_WHOLE, frame));
 278                 break;
 279         default:
 280                 DCPOMATIC_ASSERT (false);
 281         }
 282
 283         /* Now VideoDecoder is required never to have gaps in the frames that it presents
 284            via get_video().  Hence we need to fill in any gap between the last thing in _decoded_video
 285            and the things we are about to push.
 286         */
 287
 288         optional<Frame> from;
 289         optional<Frame> to;
 290
 291         if (_decoded_video.empty() && _last_seek_time && _last_seek_accurate) {
 292                 from = _last_seek_time->frames_round (_video_content->video_frame_rate ());
 293                 to = to_push.front().frame;
 294         } else if (!_decoded_video.empty ()) {
 295                 from = _decoded_video.back().frame + 1;
 296                 to = to_push.front().frame;
 297         }
 298
 299         /* If we've pre-rolled on a seek we may now receive out-of-order frames
 300            (frames before the last seek time) which we can just ignore.
 301         */
 302
 303         if (from && to && from.get() > to.get()) {
 304                 return;
 305         }
 306
 307         if (from) {
 308                 switch (_video_content->video_frame_type ()) {
 309                 case VIDEO_FRAME_TYPE_2D:
 310                         fill_one_eye (from.get(), to.get (), EYES_BOTH);
 311                         break;
 312                 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 313                 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
 314                 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
 315                         fill_both_eyes (from.get(), to.get(), to_push.front().eyes);
 316                         break;
 317                 case VIDEO_FRAME_TYPE_3D_LEFT:
 318                         fill_one_eye (from.get(), to.get (), EYES_LEFT);
 319                         break;
 320                 case VIDEO_FRAME_TYPE_3D_RIGHT:
 321                         fill_one_eye (from.get(), to.get (), EYES_RIGHT);
 322                         break;
 323                 }
 324         }
 325
 326         copy (to_push.begin(), to_push.end(), back_inserter (_decoded_video));
 327
 328         /* We can't let this build up too much or we will run out of memory.  There is a
 329            `best' value for the allowed size of _decoded_video which balances memory use
 330            with decoding efficiency (lack of seeks).  Throwing away video frames here
 331            is not a problem for correctness, so do it.
 332         */
 333         while (_decoded_video.size() > 96) {
 334                 _decoded_video.pop_back ();
 335         }
 336 }
 337
 338 void
 339 VideoDecoder::seek (ContentTime s, bool accurate)
 340 {
 341         _decoded_video.clear ();
 342         _last_seek_time = s;
 343         _last_seek_accurate = accurate;
 344 }
 345
 346 /** Set this player never to produce any video data */
 347 void
 348 VideoDecoder::set_ignore_video ()
 349 {
 350         _ignore_video = true;
 351 }