src/lib/video_decoder.cc

   1 /*
   2     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "video_decoder.h"
  22 #include "image.h"
  23 #include "raw_image_proxy.h"
  24 #include "film.h"
  25 #include "log.h"
  26 #include "compose.hpp"
  27 #include <boost/foreach.hpp>
  28 #include <iostream>
  29
  30 #include "i18n.h"
  31
  32 using std::cout;
  33 using std::list;
  34 using std::max;
  35 using std::back_inserter;
  36 using boost::shared_ptr;
  37 using boost::optional;
  38
  39 VideoDecoder::VideoDecoder (Decoder* parent, shared_ptr<const Content> c, shared_ptr<Log> log)
  40 #ifdef DCPOMATIC_DEBUG
  41         : test_gaps (0)
  42         , _parent (parent),
  43           _content (c)
  44 #else
  45         : _parent (parent)
  46         , _content (c)
  47 #endif
  48         , _log (log)
  49         , _last_seek_accurate (true)
  50         , _ignore (false)
  51 {
  52         _black_image.reset (new Image (AV_PIX_FMT_RGB24, _content->video->size(), true));
  53         _black_image->make_black ();
  54 }
  55
  56 list<ContentVideo>
  57 VideoDecoder::decoded (Frame frame)
  58 {
  59         list<ContentVideo> output;
  60
  61         BOOST_FOREACH (ContentVideo const & i, _decoded) {
  62                 if (i.frame.index() == frame) {
  63                         output.push_back (i);
  64                 }
  65         }
  66
  67         return output;
  68 }
  69
  70 /** Get all frames which exist in the content at a given frame index.
  71  *  @param frame Frame index.
  72  *  @param accurate true to try hard to return frames at the precise time that was requested, otherwise frames nearby may be returned.
  73  *  @return Frames; there may be none (if there is no video there), 1 for 2D or 2 for 3D.
  74  */
  75 list<ContentVideo>
  76 VideoDecoder::get (Frame frame, bool accurate)
  77 {
  78         if (_no_data_frame && frame >= _no_data_frame.get()) {
  79                 return list<ContentVideo> ();
  80         }
  81
  82         /* At this stage, if we have get_video()ed before, _decoded will contain the last frame that this
  83            method returned (and possibly a few more).  If the requested frame is not in _decoded and it is not the next
  84            one after the end of _decoded we need to seek.
  85         */
  86
  87         _log->log (String::compose ("VD has request for %1", frame), LogEntry::TYPE_DEBUG_DECODE);
  88
  89         if (_decoded.empty() || frame < _decoded.front().frame.index() || frame > (_decoded.back().frame.index() + 1)) {
  90                 _parent->seek (ContentTime::from_frames (frame, _content->active_video_frame_rate()), accurate);
  91         }
  92
  93         /* Work out the number of frames that we should return; we
  94            must return all frames in our content at the requested `time'
  95            (i.e. frame)
  96         */
  97         unsigned int frames_wanted = 0;
  98         switch (_content->video->frame_type()) {
  99         case VIDEO_FRAME_TYPE_2D:
 100         case VIDEO_FRAME_TYPE_3D_LEFT:
 101         case VIDEO_FRAME_TYPE_3D_RIGHT:
 102                 frames_wanted = 1;
 103                 break;
 104         case VIDEO_FRAME_TYPE_3D:
 105         case VIDEO_FRAME_TYPE_3D_ALTERNATE:
 106         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 107         case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
 108                 frames_wanted = 2;
 109                 break;
 110         default:
 111                 DCPOMATIC_ASSERT (false);
 112         }
 113
 114         list<ContentVideo> dec;
 115
 116         /* Now enough pass() calls should either:
 117          *  (a) give us what we want, or
 118          *  (b) give us something after what we want, indicating that we will never get what we want, or
 119          *  (c) hit the end of the decoder.
 120          */
 121         if (accurate) {
 122                 /* We are being accurate, so we want the right frame.
 123                  * This could all be one statement but it's split up for clarity.
 124                  */
 125                 bool no_data = false;
 126
 127                 while (true) {
 128                         if (decoded(frame).size() == frames_wanted) {
 129                                 /* We got what we want */
 130                                 break;
 131                         }
 132
 133                         if (_parent->pass (Decoder::PASS_REASON_VIDEO, accurate)) {
 134                                 /* The decoder has nothing more for us */
 135                                 no_data = true;
 136                                 break;
 137                         }
 138
 139                         if (!_decoded.empty() && _decoded.front().frame.index() > frame) {
 140                                 /* We're never going to get the frame we want.  Perhaps the caller is asking
 141                                  * for a video frame before the content's video starts (if its audio
 142                                  * begins before its video, for example).
 143                                  */
 144                                 break;
 145                         }
 146                 }
 147
 148                 dec = decoded (frame);
 149
 150                 if (no_data && dec.empty()) {
 151                         _no_data_frame = frame;
 152                 }
 153
 154         } else {
 155                 /* Any frame(s) will do: use the first one(s) that comes out of pass() */
 156                 while (_decoded.size() < frames_wanted && !_parent->pass (Decoder::PASS_REASON_VIDEO, accurate)) {}
 157                 list<ContentVideo>::const_iterator i = _decoded.begin();
 158                 unsigned int j = 0;
 159                 while (i != _decoded.end() && j < frames_wanted) {
 160                         dec.push_back (*i);
 161                         ++i;
 162                         ++j;
 163                 }
 164         }
 165
 166         /* Clean up _decoded; keep the frame we are returning, if any (which may have two images
 167            for 3D), but nothing before that
 168         */
 169         while (!_decoded.empty() && !dec.empty() && _decoded.front().frame.index() < dec.front().frame.index()) {
 170                 _decoded.pop_front ();
 171         }
 172
 173         return dec;
 174 }
 175
 176 /** Fill _decoded from `from' up to, but not including, `to' with
 177  *  a frame for one particular Eyes value (which could be EYES_BOTH,
 178  *  EYES_LEFT or EYES_RIGHT)
 179  */
 180 void
 181 VideoDecoder::fill_one_eye (Frame from, Frame to, Eyes eye)
 182 {
 183         if (to == 0) {
 184                 /* Already OK */
 185                 return;
 186         }
 187
 188         /* Fill with black... */
 189         shared_ptr<const ImageProxy> filler_image (new RawImageProxy (_black_image));
 190         Part filler_part = PART_WHOLE;
 191
 192         /* ...unless there's some video we can fill with */
 193         if (!_decoded.empty ()) {
 194                 filler_image = _decoded.back().image;
 195                 filler_part = _decoded.back().part;
 196         }
 197
 198         for (Frame i = from; i < to; ++i) {
 199 #ifdef DCPOMATIC_DEBUG
 200                 test_gaps++;
 201 #endif
 202                 _decoded.push_back (
 203                         ContentVideo (filler_image, VideoFrame (i, eye), filler_part)
 204                         );
 205         }
 206 }
 207
 208 /** Fill _decoded from `from' up to, but not including, `to'
 209  *  adding both left and right eye frames.
 210  */
 211 void
 212 VideoDecoder::fill_both_eyes (VideoFrame from, VideoFrame to)
 213 {
 214         /* Fill with black... */
 215         shared_ptr<const ImageProxy> filler_left_image (new RawImageProxy (_black_image));
 216         shared_ptr<const ImageProxy> filler_right_image (new RawImageProxy (_black_image));
 217         Part filler_left_part = PART_WHOLE;
 218         Part filler_right_part = PART_WHOLE;
 219
 220         /* ...unless there's some video we can fill with */
 221         for (list<ContentVideo>::const_reverse_iterator i = _decoded.rbegin(); i != _decoded.rend(); ++i) {
 222                 if (i->frame.eyes() == EYES_LEFT && !filler_left_image) {
 223                         filler_left_image = i->image;
 224                         filler_left_part = i->part;
 225                 } else if (i->frame.eyes() == EYES_RIGHT && !filler_right_image) {
 226                         filler_right_image = i->image;
 227                         filler_right_part = i->part;
 228                 }
 229
 230                 if (filler_left_image && filler_right_image) {
 231                         break;
 232                 }
 233         }
 234
 235         while (from != to) {
 236
 237 #ifdef DCPOMATIC_DEBUG
 238                 test_gaps++;
 239 #endif
 240
 241                 _decoded.push_back (
 242                         ContentVideo (
 243                                 from.eyes() == EYES_LEFT ? filler_left_image : filler_right_image,
 244                                 from,
 245                                 from.eyes() == EYES_LEFT ? filler_left_part : filler_right_part
 246                                 )
 247                         );
 248
 249                 ++from;
 250         }
 251 }
 252
 253 /** Called by decoder classes when they have a video frame ready */
 254 void
 255 VideoDecoder::give (shared_ptr<const ImageProxy> image, Frame frame)
 256 {
 257         if (_ignore) {
 258                 return;
 259         }
 260
 261         _log->log (String::compose ("VD receives %1", frame), LogEntry::TYPE_DEBUG_DECODE);
 262
 263         /* Work out what we are going to push into _decoded next */
 264         list<ContentVideo> to_push;
 265         switch (_content->video->frame_type ()) {
 266         case VIDEO_FRAME_TYPE_2D:
 267                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_BOTH), PART_WHOLE));
 268                 break;
 269         case VIDEO_FRAME_TYPE_3D:
 270         {
 271                 /* We receive the same frame index twice for 3D; hence we know which
 272                    frame this one is.
 273                 */
 274                 bool const same = (!_decoded.empty() && frame == _decoded.back().frame.index());
 275                 to_push.push_back (ContentVideo (image, VideoFrame (frame, same ? EYES_RIGHT : EYES_LEFT), PART_WHOLE));
 276                 break;
 277         }
 278         case VIDEO_FRAME_TYPE_3D_ALTERNATE:
 279                 to_push.push_back (ContentVideo (image, VideoFrame (frame / 2, (frame % 2) ? EYES_RIGHT : EYES_LEFT), PART_WHOLE));
 280                 break;
 281         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 282                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_LEFT), PART_LEFT_HALF));
 283                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_RIGHT), PART_RIGHT_HALF));
 284                 break;
 285         case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
 286                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_LEFT), PART_TOP_HALF));
 287                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_RIGHT), PART_BOTTOM_HALF));
 288                 break;
 289         case VIDEO_FRAME_TYPE_3D_LEFT:
 290                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_LEFT), PART_WHOLE));
 291                 break;
 292         case VIDEO_FRAME_TYPE_3D_RIGHT:
 293                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_RIGHT), PART_WHOLE));
 294                 break;
 295         default:
 296                 DCPOMATIC_ASSERT (false);
 297         }
 298
 299         /* Now VideoDecoder is required never to have gaps in the frames that it presents
 300            via get_video().  Hence we need to fill in any gap between the last thing in _decoded
 301            and the things we are about to push.
 302         */
 303
 304         optional<VideoFrame> from;
 305
 306         if (_decoded.empty() && _last_seek_time && _last_seek_accurate) {
 307                 from = VideoFrame (
 308                         _last_seek_time->frames_round (_content->active_video_frame_rate ()),
 309                         _content->video->frame_type() == VIDEO_FRAME_TYPE_2D ? EYES_BOTH : EYES_LEFT
 310                         );
 311         } else if (!_decoded.empty ()) {
 312                 /* Get the last frame we have */
 313                 from = _decoded.back().frame;
 314                 /* And move onto the first frame we need */
 315                 ++(*from);
 316                 if (_content->video->frame_type() == VIDEO_FRAME_TYPE_3D_LEFT || _content->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
 317                         /* The previous ++ will increment a 3D-left-eye to the same index right-eye.  If we are dealing with
 318                            a single-eye source we need an extra ++ to move back to the same eye.
 319                         */
 320                         ++(*from);
 321                 }
 322         }
 323
 324         /* If we've pre-rolled on a seek we may now receive out-of-order frames
 325            (frames before the last seek time) which we can just ignore.
 326         */
 327         if (from && (*from) > to_push.front().frame) {
 328                 return;
 329         }
 330
 331         int const max_decoded_size = 96;
 332
 333         /* If _decoded is already `full' there is no point in adding anything more to it,
 334            as the new stuff will just be removed again.
 335         */
 336         if (_decoded.size() < max_decoded_size) {
 337                 if (from) {
 338                         switch (_content->video->frame_type ()) {
 339                         case VIDEO_FRAME_TYPE_2D:
 340                                 fill_one_eye (from->index(), to_push.front().frame.index(), EYES_BOTH);
 341                                 break;
 342                         case VIDEO_FRAME_TYPE_3D:
 343                         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 344                         case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
 345                         case VIDEO_FRAME_TYPE_3D_ALTERNATE:
 346                                 fill_both_eyes (from.get(), to_push.front().frame);
 347                                 break;
 348                         case VIDEO_FRAME_TYPE_3D_LEFT:
 349                                 fill_one_eye (from->index(), to_push.front().frame.index(), EYES_LEFT);
 350                                 break;
 351                         case VIDEO_FRAME_TYPE_3D_RIGHT:
 352                                 fill_one_eye (from->index(), to_push.front().frame.index(), EYES_RIGHT);
 353                                 break;
 354                         }
 355                 }
 356
 357                 copy (to_push.begin(), to_push.end(), back_inserter (_decoded));
 358         }
 359
 360         /* We can't let this build up too much or we will run out of memory.  There is a
 361            `best' value for the allowed size of _decoded which balances memory use
 362            with decoding efficiency (lack of seeks).  Throwing away video frames here
 363            is not a problem for correctness, so do it.
 364         */
 365         while (_decoded.size() > max_decoded_size) {
 366                 _decoded.pop_back ();
 367         }
 368 }
 369
 370 void
 371 VideoDecoder::seek (ContentTime s, bool accurate)
 372 {
 373         _decoded.clear ();
 374         _last_seek_time = s;
 375         _last_seek_accurate = accurate;
 376 }
 377
 378 /** Set this decoder never to produce any data */
 379 void
 380 VideoDecoder::set_ignore ()
 381 {
 382         _ignore = true;
 383 }