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         */
 150         while (!_decoded.empty() && !dec.empty() && _decoded.front().frame.index() < dec.front().frame.index()) {
 151                 _decoded.pop_front ();
 152         }
 153
 154         return dec;
 155 }
 156
 157 /** Fill _decoded from `from' up to, but not including, `to' with
 158  *  a frame for one particular Eyes value (which could be EYES_BOTH,
 159  *  EYES_LEFT or EYES_RIGHT)
 160  */
 161 void
 162 VideoDecoder::fill_one_eye (Frame from, Frame to, Eyes eye)
 163 {
 164         if (to == 0) {
 165                 /* Already OK */
 166                 return;
 167         }
 168
 169         /* Fill with black... */
 170         shared_ptr<const ImageProxy> filler_image (new RawImageProxy (_black_image));
 171         Part filler_part = PART_WHOLE;
 172
 173         /* ...unless there's some video we can fill with */
 174         if (!_decoded.empty ()) {
 175                 filler_image = _decoded.back().image;
 176                 filler_part = _decoded.back().part;
 177         }
 178
 179         for (Frame i = from; i < to; ++i) {
 180 #ifdef DCPOMATIC_DEBUG
 181                 test_gaps++;
 182 #endif
 183                 _decoded.push_back (
 184                         ContentVideo (filler_image, VideoFrame (i, eye), filler_part)
 185                         );
 186         }
 187 }
 188
 189 /** Fill _decoded from `from' up to, but not including, `to'
 190  *  adding both left and right eye frames.
 191  */
 192 void
 193 VideoDecoder::fill_both_eyes (VideoFrame from, VideoFrame to)
 194 {
 195         /* Fill with black... */
 196         shared_ptr<const ImageProxy> filler_left_image (new RawImageProxy (_black_image));
 197         shared_ptr<const ImageProxy> filler_right_image (new RawImageProxy (_black_image));
 198         Part filler_left_part = PART_WHOLE;
 199         Part filler_right_part = PART_WHOLE;
 200
 201         /* ...unless there's some video we can fill with */
 202         for (list<ContentVideo>::const_reverse_iterator i = _decoded.rbegin(); i != _decoded.rend(); ++i) {
 203                 if (i->frame.eyes() == EYES_LEFT && !filler_left_image) {
 204                         filler_left_image = i->image;
 205                         filler_left_part = i->part;
 206                 } else if (i->frame.eyes() == EYES_RIGHT && !filler_right_image) {
 207                         filler_right_image = i->image;
 208                         filler_right_part = i->part;
 209                 }
 210
 211                 if (filler_left_image && filler_right_image) {
 212                         break;
 213                 }
 214         }
 215
 216         while (from != to) {
 217
 218 #ifdef DCPOMATIC_DEBUG
 219                 test_gaps++;
 220 #endif
 221
 222                 _decoded.push_back (
 223                         ContentVideo (
 224                                 from.eyes() == EYES_LEFT ? filler_left_image : filler_right_image,
 225                                 from,
 226                                 from.eyes() == EYES_LEFT ? filler_left_part : filler_right_part
 227                                 )
 228                         );
 229
 230                 ++from;
 231         }
 232 }
 233
 234 /** Called by decoder classes when they have a video frame ready */
 235 void
 236 VideoDecoder::give (shared_ptr<const ImageProxy> image, Frame frame)
 237 {
 238         if (_ignore) {
 239                 return;
 240         }
 241
 242         _log->log (String::compose ("VD receives %1", frame), LogEntry::TYPE_DEBUG_DECODE);
 243
 244         /* Work out what we are going to push into _decoded next */
 245         list<ContentVideo> to_push;
 246         switch (_content->video->frame_type ()) {
 247         case VIDEO_FRAME_TYPE_2D:
 248                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_BOTH), PART_WHOLE));
 249                 break;
 250         case VIDEO_FRAME_TYPE_3D:
 251         case VIDEO_FRAME_TYPE_3D_ALTERNATE:
 252         {
 253                 /* We receive the same frame index twice for 3D-alternate; hence we know which
 254                    frame this one is.
 255                 */
 256                 bool const same = (!_decoded.empty() && frame == _decoded.back().frame.index());
 257                 to_push.push_back (ContentVideo (image, VideoFrame (frame, same ? EYES_RIGHT : EYES_LEFT), PART_WHOLE));
 258                 break;
 259         }
 260         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 261                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_LEFT), PART_LEFT_HALF));
 262                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_RIGHT), PART_RIGHT_HALF));
 263                 break;
 264         case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
 265                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_LEFT), PART_TOP_HALF));
 266                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_RIGHT), PART_BOTTOM_HALF));
 267                 break;
 268         case VIDEO_FRAME_TYPE_3D_LEFT:
 269                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_LEFT), PART_WHOLE));
 270                 break;
 271         case VIDEO_FRAME_TYPE_3D_RIGHT:
 272                 to_push.push_back (ContentVideo (image, VideoFrame (frame, EYES_RIGHT), PART_WHOLE));
 273                 break;
 274         default:
 275                 DCPOMATIC_ASSERT (false);
 276         }
 277
 278         /* Now VideoDecoder is required never to have gaps in the frames that it presents
 279            via get_video().  Hence we need to fill in any gap between the last thing in _decoded
 280            and the things we are about to push.
 281         */
 282
 283         optional<VideoFrame> from;
 284
 285         if (_decoded.empty() && _last_seek_time && _last_seek_accurate) {
 286                 from = VideoFrame (
 287                         _last_seek_time->frames_round (_content->active_video_frame_rate ()),
 288                         _content->video->frame_type() == VIDEO_FRAME_TYPE_2D ? EYES_BOTH : EYES_LEFT
 289                         );
 290         } else if (!_decoded.empty ()) {
 291                 from = _decoded.back().frame;
 292                 ++(*from);
 293         }
 294
 295         /* If we've pre-rolled on a seek we may now receive out-of-order frames
 296            (frames before the last seek time) which we can just ignore.
 297         */
 298         if (from && (*from) > to_push.front().frame) {
 299                 return;
 300         }
 301
 302         int const max_decoded_size = 96;
 303
 304         /* If _decoded is already `full' there is no point in adding anything more to it,
 305            as the new stuff will just be removed again.
 306         */
 307         if (_decoded.size() < max_decoded_size) {
 308                 if (from) {
 309                         switch (_content->video->frame_type ()) {
 310                         case VIDEO_FRAME_TYPE_2D:
 311                                 fill_one_eye (from->index(), to_push.front().frame.index(), EYES_BOTH);
 312                                 break;
 313                         case VIDEO_FRAME_TYPE_3D:
 314                         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 315                         case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
 316                         case VIDEO_FRAME_TYPE_3D_ALTERNATE:
 317                                 fill_both_eyes (from.get(), to_push.front().frame);
 318                                 break;
 319                         case VIDEO_FRAME_TYPE_3D_LEFT:
 320                                 fill_one_eye (from->index(), to_push.front().frame.index(), EYES_LEFT);
 321                                 break;
 322                         case VIDEO_FRAME_TYPE_3D_RIGHT:
 323                                 fill_one_eye (from->index(), to_push.front().frame.index(), EYES_RIGHT);
 324                                 break;
 325                         }
 326                 }
 327
 328                 copy (to_push.begin(), to_push.end(), back_inserter (_decoded));
 329         }
 330
 331         /* We can't let this build up too much or we will run out of memory.  There is a
 332            `best' value for the allowed size of _decoded which balances memory use
 333            with decoding efficiency (lack of seeks).  Throwing away video frames here
 334            is not a problem for correctness, so do it.
 335         */
 336         while (_decoded.size() > max_decoded_size) {
 337                 _decoded.pop_back ();
 338         }
 339 }
 340
 341 void
 342 VideoDecoder::seek (ContentTime s, bool accurate)
 343 {
 344         _decoded.clear ();
 345         _last_seek_time = s;
 346         _last_seek_accurate = accurate;
 347 }
 348
 349 /** Set this decoder never to produce any data */
 350 void
 351 VideoDecoder::set_ignore ()
 352 {
 353         _ignore = true;
 354 }