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