test/keyframe_test.cc

   1 /*
   2  *  Copyright (c) 2012 The WebM project authors. All Rights Reserved.
   3  *
   4  *  Use of this source code is governed by a BSD-style license
   5  *  that can be found in the LICENSE file in the root of the source
   6  *  tree. An additional intellectual property rights grant can be found
   7  *  in the file PATENTS.  All contributing project authors may
   8  *  be found in the AUTHORS file in the root of the source tree.
   9  */
  10 #include <climits>
  11 #include <vector>
  12 #include "third_party/googletest/src/include/gtest/gtest.h"
  13 #include "test/codec_factory.h"
  14 #include "test/encode_test_driver.h"
  15 #include "test/i420_video_source.h"
  16 #include "test/util.h"
  17
  18 namespace {
  19
  20 class KeyframeTest
  21     : public ::libvpx_test::EncoderTest,
  22       public ::libvpx_test::CodecTestWithParam<libvpx_test::TestMode> {
  23  protected:
  24   KeyframeTest() : EncoderTest(GET_PARAM(0)) {}
  25   virtual ~KeyframeTest() {}
  26
  27   virtual void SetUp() {
  28     InitializeConfig();
  29     SetMode(GET_PARAM(1));
  30     kf_count_ = 0;
  31     kf_count_max_ = INT_MAX;
  32     kf_do_force_kf_ = false;
  33     set_cpu_used_ = 0;
  34   }
  35
  36   virtual void PreEncodeFrameHook(::libvpx_test::VideoSource *video,
  37                                   ::libvpx_test::Encoder *encoder) {
  38     if (kf_do_force_kf_)
  39       frame_flags_ = (video->frame() % 3) ? 0 : VPX_EFLAG_FORCE_KF;
  40     if (set_cpu_used_ && video->frame() == 1)
  41       encoder->Control(VP8E_SET_CPUUSED, set_cpu_used_);
  42   }
  43
  44   virtual void FramePktHook(const vpx_codec_cx_pkt_t *pkt) {
  45     if (pkt->data.frame.flags & VPX_FRAME_IS_KEY) {
  46       kf_pts_list_.push_back(pkt->data.frame.pts);
  47       kf_count_++;
  48       abort_ |= kf_count_ > kf_count_max_;
  49     }
  50   }
  51
  52   bool kf_do_force_kf_;
  53   int kf_count_;
  54   int kf_count_max_;
  55   std::vector<vpx_codec_pts_t> kf_pts_list_;
  56   int set_cpu_used_;
  57 };
  58
  59 TEST_P(KeyframeTest, TestRandomVideoSource) {
  60   // Validate that encoding the RandomVideoSource produces multiple keyframes.
  61   // This validates the results of the TestDisableKeyframes test.
  62   kf_count_max_ = 2;  // early exit successful tests.
  63
  64   ::libvpx_test::RandomVideoSource video;
  65   ASSERT_NO_FATAL_FAILURE(RunLoop(&video));
  66
  67   // In realtime mode - auto placed keyframes are exceedingly rare,  don't
  68   // bother with this check   if(GetParam() > 0)
  69   if (GET_PARAM(1) > 0) EXPECT_GT(kf_count_, 1);
  70 }
  71
  72 TEST_P(KeyframeTest, TestDisableKeyframes) {
  73   cfg_.kf_mode = VPX_KF_DISABLED;
  74   kf_count_max_ = 1;  // early exit failed tests.
  75
  76   ::libvpx_test::RandomVideoSource video;
  77   ASSERT_NO_FATAL_FAILURE(RunLoop(&video));
  78
  79   EXPECT_EQ(1, kf_count_);
  80 }
  81
  82 TEST_P(KeyframeTest, TestForceKeyframe) {
  83   cfg_.kf_mode = VPX_KF_DISABLED;
  84   kf_do_force_kf_ = true;
  85
  86   ::libvpx_test::DummyVideoSource video;
  87   ASSERT_NO_FATAL_FAILURE(RunLoop(&video));
  88
  89   // verify that every third frame is a keyframe.
  90   for (std::vector<vpx_codec_pts_t>::const_iterator iter = kf_pts_list_.begin();
  91        iter != kf_pts_list_.end(); ++iter) {
  92     ASSERT_EQ(0, *iter % 3) << "Unexpected keyframe at frame " << *iter;
  93   }
  94 }
  95
  96 TEST_P(KeyframeTest, TestKeyframeMaxDistance) {
  97   cfg_.kf_max_dist = 25;
  98
  99   ::libvpx_test::DummyVideoSource video;
 100   ASSERT_NO_FATAL_FAILURE(RunLoop(&video));
 101
 102   // verify that keyframe interval matches kf_max_dist
 103   for (std::vector<vpx_codec_pts_t>::const_iterator iter = kf_pts_list_.begin();
 104        iter != kf_pts_list_.end(); ++iter) {
 105     ASSERT_EQ(0, *iter % 25) << "Unexpected keyframe at frame " << *iter;
 106   }
 107 }
 108
 109 TEST_P(KeyframeTest, TestAutoKeyframe) {
 110   cfg_.kf_mode = VPX_KF_AUTO;
 111   kf_do_force_kf_ = false;
 112
 113   // Force a deterministic speed step in Real Time mode, as the faster modes
 114   // may not produce a keyframe like we expect. This is necessary when running
 115   // on very slow environments (like Valgrind). The step -11 was determined
 116   // experimentally as the fastest mode that still throws the keyframe.
 117   if (deadline_ == VPX_DL_REALTIME) set_cpu_used_ = -11;
 118
 119   // This clip has a cut scene every 30 frames -> Frame 0, 30, 60, 90, 120.
 120   // I check only the first 40 frames to make sure there's a keyframe at frame
 121   // 0 and 30.
 122   ::libvpx_test::I420VideoSource video("hantro_collage_w352h288.yuv", 352, 288,
 123                                        30, 1, 0, 40);
 124
 125   ASSERT_NO_FATAL_FAILURE(RunLoop(&video));
 126
 127   // In realtime mode - auto placed keyframes are exceedingly rare,  don't
 128   // bother with this check
 129   if (GET_PARAM(1) > 0)
 130     EXPECT_EQ(2u, kf_pts_list_.size()) << " Not the right number of keyframes ";
 131
 132   // Verify that keyframes match the file keyframes in the file.
 133   for (std::vector<vpx_codec_pts_t>::const_iterator iter = kf_pts_list_.begin();
 134        iter != kf_pts_list_.end(); ++iter) {
 135     if (deadline_ == VPX_DL_REALTIME && *iter > 0)
 136       EXPECT_EQ(0, (*iter - 1) % 30) << "Unexpected keyframe at frame "
 137                                      << *iter;
 138     else
 139       EXPECT_EQ(0, *iter % 30) << "Unexpected keyframe at frame " << *iter;
 140   }
 141 }
 142
 143 VP8_INSTANTIATE_TEST_CASE(KeyframeTest, ALL_TEST_MODES);
 144 }  // namespace