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