Tweak logging format.
[dcpomatic.git] / src / lib / video_decoder.cc
index 9b27055c73ba737b00fa86f55ed8a41bfe7b9c1e..fd5779a657f0304124a28ef27980a62a85a1945a 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 #include "video_decoder.h"
 #include "image.h"
-#include "image_proxy.h"
 #include "raw_image_proxy.h"
-#include "content_video.h"
+#include "film.h"
+#include "log.h"
+#include "compose.hpp"
+#include <iostream>
 
 #include "i18n.h"
 
@@ -39,17 +41,18 @@ VideoDecoder::VideoDecoder (shared_ptr<const VideoContent> c)
 #else
        : _video_content (c)
 #endif
-       , _same (false)
+       , _last_seek_accurate (true)
+       , _ignore_video (false)
 {
-       _black_image.reset (new Image (PIX_FMT_RGB24, _video_content->video_size(), true));
+       _black_image.reset (new Image (AV_PIX_FMT_RGB24, _video_content->video_size(), true));
        _black_image->make_black ();
 }
 
 list<ContentVideo>
-VideoDecoder::decoded_video (VideoFrame frame)
+VideoDecoder::decoded_video (Frame frame)
 {
        list<ContentVideo> output;
-       
+
        for (list<ContentVideo>::const_iterator i = _decoded_video.begin(); i != _decoded_video.end(); ++i) {
                if (i->frame == frame) {
                        output.push_back (*i);
@@ -65,13 +68,15 @@ VideoDecoder::decoded_video (VideoFrame frame)
  *  @return Frames; there may be none (if there is no video there), 1 for 2D or 2 for 3D.
  */
 list<ContentVideo>
-VideoDecoder::get_video (VideoFrame frame, bool accurate)
+VideoDecoder::get_video (Frame frame, bool accurate)
 {
        /* At this stage, if we have get_video()ed before, _decoded_video will contain the last frame that this
           method returned (and possibly a few more).  If the requested frame is not in _decoded_video and it is not the next
           one after the end of _decoded_video we need to seek.
        */
-          
+
+       _video_content->film()->log()->log (String::compose ("VD has request for %1", frame), LogEntry::TYPE_DEBUG_DECODE);
+
        if (_decoded_video.empty() || frame < _decoded_video.front().frame || frame > (_decoded_video.back().frame + 1)) {
                seek (ContentTime::from_frames (frame, _video_content->video_frame_rate()), accurate);
        }
@@ -93,7 +98,7 @@ VideoDecoder::get_video (VideoFrame frame, bool accurate)
                                break;
                        }
 
-                       if (pass ()) {
+                       if (pass (PASS_REASON_VIDEO, accurate)) {
                                /* The decoder has nothing more for us */
                                break;
                        }
@@ -110,7 +115,7 @@ VideoDecoder::get_video (VideoFrame frame, bool accurate)
                dec = decoded_video (frame);
        } else {
                /* Any frame will do: use the first one that comes out of pass() */
-               while (_decoded_video.empty() && !pass ()) {}
+               while (_decoded_video.empty() && !pass (PASS_REASON_VIDEO, accurate)) {}
                if (!_decoded_video.empty ()) {
                        dec.push_back (_decoded_video.front ());
                }
@@ -125,17 +130,20 @@ VideoDecoder::get_video (VideoFrame frame, bool accurate)
        return dec;
 }
 
-/** Fill _decoded_video up to, but not including, the specified frame */
+/** Fill _decoded_video from `from' up to, but not including, `to' with
+ *  a frame for one particular Eyes value (which could be EYES_BOTH,
+ *  EYES_LEFT or EYES_RIGHT)
+ */
 void
-VideoDecoder::fill_up_to_2d (VideoFrame frame)
+VideoDecoder::fill_one_eye (Frame from, Frame to, Eyes eye)
 {
-       if (frame == 0) {
+       if (to == 0) {
                /* Already OK */
                return;
        }
 
        /* Fill with black... */
-       boost::shared_ptr<const ImageProxy> filler_image (new RawImageProxy (_black_image));
+       shared_ptr<const ImageProxy> filler_image (new RawImageProxy (_black_image));
        Part filler_part = PART_WHOLE;
 
        /* ...unless there's some video we can fill with */
@@ -144,33 +152,30 @@ VideoDecoder::fill_up_to_2d (VideoFrame frame)
                filler_part = _decoded_video.back().part;
        }
 
-       VideoFrame filler_frame = _decoded_video.empty() ? 0 : (_decoded_video.back().frame + 1);
-       while (filler_frame < frame) {
-
+       for (Frame i = from; i < to; ++i) {
 #ifdef DCPOMATIC_DEBUG
                test_gaps++;
 #endif
-
                _decoded_video.push_back (
-                       ContentVideo (filler_image, EYES_BOTH, filler_part, filler_frame)
+                       ContentVideo (filler_image, eye, filler_part, i)
                        );
-               
-               ++filler_frame;
        }
 }
 
-/** Fill _decoded_video up to, but not including, the specified frame and eye */
+/** Fill _decoded_video from `from' up to, but not including, `to'
+ *  adding both left and right eye frames.
+ */
 void
-VideoDecoder::fill_up_to_3d (VideoFrame frame, Eyes eye)
+VideoDecoder::fill_both_eyes (Frame from, Frame to, Eyes eye)
 {
-       if (frame == 0 && eye == EYES_LEFT) {
+       if (to == 0 && eye == EYES_LEFT) {
                /* Already OK */
                return;
        }
 
        /* Fill with black... */
-       boost::shared_ptr<const ImageProxy> filler_left_image (new RawImageProxy (_black_image));
-       boost::shared_ptr<const ImageProxy> filler_right_image (new RawImageProxy (_black_image));
+       shared_ptr<const ImageProxy> filler_left_image (new RawImageProxy (_black_image));
+       shared_ptr<const ImageProxy> filler_right_image (new RawImageProxy (_black_image));
        Part filler_left_part = PART_WHOLE;
        Part filler_right_part = PART_WHOLE;
 
@@ -189,7 +194,7 @@ VideoDecoder::fill_up_to_3d (VideoFrame frame, Eyes eye)
                }
        }
 
-       VideoFrame filler_frame = _decoded_video.empty() ? 0 : _decoded_video.back().frame;
+       Frame filler_frame = from;
        Eyes filler_eye = _decoded_video.empty() ? EYES_LEFT : _decoded_video.back().eyes;
 
        if (_decoded_video.empty ()) {
@@ -203,7 +208,7 @@ VideoDecoder::fill_up_to_3d (VideoFrame frame, Eyes eye)
                filler_eye = EYES_LEFT;
        }
 
-       while (filler_frame != frame || filler_eye != eye) {
+       while (filler_frame != to || filler_eye != eye) {
 
 #ifdef DCPOMATIC_DEBUG
                test_gaps++;
@@ -226,15 +231,21 @@ VideoDecoder::fill_up_to_3d (VideoFrame frame, Eyes eye)
                }
        }
 }
-       
+
 /** Called by subclasses when they have a video frame ready */
 void
-VideoDecoder::video (shared_ptr<const ImageProxy> image, VideoFrame frame)
+VideoDecoder::video (shared_ptr<const ImageProxy> image, Frame frame)
 {
+       if (_ignore_video) {
+               return;
+       }
+
+       _video_content->film()->log()->log (String::compose ("VD receives %1", frame), LogEntry::TYPE_DEBUG_DECODE);
+
        /* We may receive the same frame index twice for 3D, and we need to know
           when that happens.
        */
-       _same = (!_decoded_video.empty() && frame == _decoded_video.back().frame);
+       bool const same = (!_decoded_video.empty() && frame == _decoded_video.back().frame);
 
        /* Work out what we are going to push into _decoded_video next */
        list<ContentVideo> to_push;
@@ -243,7 +254,7 @@ VideoDecoder::video (shared_ptr<const ImageProxy> image, VideoFrame frame)
                to_push.push_back (ContentVideo (image, EYES_BOTH, PART_WHOLE, frame));
                break;
        case VIDEO_FRAME_TYPE_3D_ALTERNATE:
-               to_push.push_back (ContentVideo (image, _same ? EYES_RIGHT : EYES_LEFT, PART_WHOLE, frame));
+               to_push.push_back (ContentVideo (image, same ? EYES_RIGHT : EYES_LEFT, PART_WHOLE, frame));
                break;
        case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
                to_push.push_back (ContentVideo (image, EYES_LEFT, PART_LEFT_HALF, frame));
@@ -260,7 +271,7 @@ VideoDecoder::video (shared_ptr<const ImageProxy> image, VideoFrame frame)
                to_push.push_back (ContentVideo (image, EYES_RIGHT, PART_WHOLE, frame));
                break;
        default:
-               assert (false);
+               DCPOMATIC_ASSERT (false);
        }
 
        /* Now VideoDecoder is required never to have gaps in the frames that it presents
@@ -268,18 +279,66 @@ VideoDecoder::video (shared_ptr<const ImageProxy> image, VideoFrame frame)
           and the things we are about to push.
        */
 
-       if (_video_content->video_frame_type() == VIDEO_FRAME_TYPE_2D) {
-               fill_up_to_2d (to_push.front().frame);
-       } else {
-               fill_up_to_3d (to_push.front().frame, to_push.front().eyes);
+       optional<Frame> from;
+       optional<Frame> to;
+
+       if (_decoded_video.empty() && _last_seek_time && _last_seek_accurate) {
+               from = _last_seek_time->frames_round (_video_content->video_frame_rate ());
+               to = to_push.front().frame;
+       } else if (!_decoded_video.empty ()) {
+               from = _decoded_video.back().frame + 1;
+               to = to_push.front().frame;
+       }
+
+       /* If we've pre-rolled on a seek we may now receive out-of-order frames
+          (frames before the last seek time) which we can just ignore.
+       */
+
+       if (from && to && from.get() > to.get()) {
+               return;
+       }
+
+       if (from) {
+               switch (_video_content->video_frame_type ()) {
+               case VIDEO_FRAME_TYPE_2D:
+                       fill_one_eye (from.get(), to.get (), EYES_BOTH);
+                       break;
+               case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
+               case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
+               case VIDEO_FRAME_TYPE_3D_ALTERNATE:
+                       fill_both_eyes (from.get(), to.get(), to_push.front().eyes);
+                       break;
+               case VIDEO_FRAME_TYPE_3D_LEFT:
+                       fill_one_eye (from.get(), to.get (), EYES_LEFT);
+                       break;
+               case VIDEO_FRAME_TYPE_3D_RIGHT:
+                       fill_one_eye (from.get(), to.get (), EYES_RIGHT);
+               }
        }
 
        copy (to_push.begin(), to_push.end(), back_inserter (_decoded_video));
+
+       /* We can't let this build up too much or we will run out of memory.  There is a
+          `best' value for the allowed size of _decoded_video which balances memory use
+          with decoding efficiency (lack of seeks).  Throwing away video frames here
+          is not a problem for correctness, so do it.
+       */
+       while (_decoded_video.size() > 96) {
+               _decoded_video.pop_back ();
+       }
 }
 
 void
-VideoDecoder::seek (ContentTime, bool)
+VideoDecoder::seek (ContentTime s, bool accurate)
 {
        _decoded_video.clear ();
+       _last_seek_time = s;
+       _last_seek_accurate = accurate;
 }
 
+/** Set this player never to produce any video data */
+void
+VideoDecoder::set_ignore_video ()
+{
+       _ignore_video = true;
+}