| /* | 
 |  * Copyright (c) 2020, Alliance for Open Media. All rights reserved | 
 |  * | 
 |  * This source code is subject to the terms of the BSD 2 Clause License and | 
 |  * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License | 
 |  * was not distributed with this source code in the LICENSE file, you can | 
 |  * obtain it at www.aomedia.org/license/software. If the Alliance for Open | 
 |  * Media Patent License 1.0 was not distributed with this source code in the | 
 |  * PATENTS file, you can obtain it at www.aomedia.org/license/patent. | 
 |  */ | 
 |  | 
 | #include <string.h> | 
 |  | 
 | #include <ostream> | 
 |  | 
 | #include "aom/aom_codec.h" | 
 | #include "aom/aom_encoder.h" | 
 | #include "aom/aom_image.h" | 
 | #include "aom/aomcx.h" | 
 | #include "third_party/googletest/src/googletest/include/gtest/gtest.h" | 
 | #include "test/codec_factory.h" | 
 | #include "test/encode_test_driver.h" | 
 | #include "test/i420_video_source.h" | 
 | #include "test/util.h" | 
 |  | 
 | #define NUM_LAG_VALUES 3 | 
 |  | 
 | namespace { | 
 | aom_image_t *CreateGrayImage(aom_img_fmt_t fmt, unsigned int w, | 
 |                              unsigned int h) { | 
 |   aom_image_t *const image = aom_img_alloc(nullptr, fmt, w, h, 1); | 
 |   if (!image) return image; | 
 |  | 
 |   for (unsigned int i = 0; i < image->d_h; ++i) { | 
 |     memset(image->planes[0] + i * image->stride[0], 128, image->d_w); | 
 |   } | 
 |   const unsigned int uv_h = (image->d_h + 1) / 2; | 
 |   const unsigned int uv_w = (image->d_w + 1) / 2; | 
 |   for (unsigned int i = 0; i < uv_h; ++i) { | 
 |     memset(image->planes[1] + i * image->stride[1], 128, uv_w); | 
 |     memset(image->planes[2] + i * image->stride[2], 128, uv_w); | 
 |   } | 
 |   return image; | 
 | } | 
 |  | 
 | // Tests kf_max_dist in one-pass encoding with zero lag. | 
 | void TestKeyFrameMaximumInterval(unsigned int usage, unsigned int kf_max_dist) { | 
 |   aom_codec_iface_t *iface = aom_codec_av1_cx(); | 
 |   aom_codec_enc_cfg_t cfg; | 
 |   ASSERT_EQ(aom_codec_enc_config_default(iface, &cfg, usage), AOM_CODEC_OK); | 
 |   cfg.g_w = 320; | 
 |   cfg.g_h = 240; | 
 |   cfg.g_pass = AOM_RC_ONE_PASS; | 
 |   cfg.g_lag_in_frames = 0; | 
 |   cfg.kf_mode = AOM_KF_AUTO; | 
 |   cfg.kf_min_dist = 0; | 
 |   cfg.kf_max_dist = kf_max_dist; | 
 |  | 
 |   aom_codec_ctx_t enc; | 
 |   ASSERT_EQ(aom_codec_enc_init(&enc, iface, &cfg, 0), AOM_CODEC_OK); | 
 |  | 
 |   ASSERT_EQ(aom_codec_control(&enc, AOME_SET_CPUUSED, 6), AOM_CODEC_OK); | 
 |  | 
 |   aom_image_t *image = CreateGrayImage(AOM_IMG_FMT_I420, cfg.g_w, cfg.g_h); | 
 |   ASSERT_NE(image, nullptr); | 
 |  | 
 |   // Encode frames. | 
 |   const aom_codec_cx_pkt_t *pkt; | 
 |   const unsigned int num_frames = kf_max_dist == 0 ? 4 : 3 * kf_max_dist + 1; | 
 |   for (unsigned int i = 0; i < num_frames; ++i) { | 
 |     ASSERT_EQ(aom_codec_encode(&enc, image, i, 1, 0), AOM_CODEC_OK); | 
 |     aom_codec_iter_t iter = nullptr; | 
 |     while ((pkt = aom_codec_get_cx_data(&enc, &iter)) != nullptr) { | 
 |       ASSERT_EQ(pkt->kind, AOM_CODEC_CX_FRAME_PKT); | 
 |       if (kf_max_dist == 0 || i % kf_max_dist == 0) { | 
 |         ASSERT_EQ(pkt->data.frame.flags & AOM_FRAME_IS_KEY, AOM_FRAME_IS_KEY); | 
 |       } else { | 
 |         ASSERT_EQ(pkt->data.frame.flags & AOM_FRAME_IS_KEY, 0u); | 
 |       } | 
 |     } | 
 |   } | 
 |  | 
 |   // Flush the encoder. | 
 |   bool got_data; | 
 |   do { | 
 |     ASSERT_EQ(aom_codec_encode(&enc, nullptr, 0, 1, 0), AOM_CODEC_OK); | 
 |     got_data = false; | 
 |     aom_codec_iter_t iter = nullptr; | 
 |     while ((pkt = aom_codec_get_cx_data(&enc, &iter)) != nullptr) { | 
 |       ASSERT_EQ(pkt->kind, AOM_CODEC_CX_FRAME_PKT); | 
 |       got_data = true; | 
 |     } | 
 |   } while (got_data); | 
 |  | 
 |   aom_img_free(image); | 
 |   ASSERT_EQ(aom_codec_destroy(&enc), AOM_CODEC_OK); | 
 | } | 
 |  | 
 | TEST(KeyFrameIntervalTest, KeyFrameMaximumInterval) { | 
 |   for (unsigned int usage : { AOM_USAGE_GOOD_QUALITY, AOM_USAGE_REALTIME }) { | 
 |     // Test 0 and 1 (both mean all intra), some powers of 2, some multiples of | 
 |     // 10, and some prime numbers. | 
 |     for (unsigned int kf_max_dist : | 
 |          { 0, 1, 2, 3, 4, 7, 10, 13, 16, 20, 23, 29, 32 }) { | 
 |       TestKeyFrameMaximumInterval(usage, kf_max_dist); | 
 |     } | 
 |   } | 
 | } | 
 |  | 
 | typedef struct { | 
 |   const unsigned int min_kf_dist; | 
 |   const unsigned int max_kf_dist; | 
 | } kfIntervalParam; | 
 |  | 
 | const kfIntervalParam kfTestParams[] = { | 
 |   { 1, 1 }, { 0, 10 }, { 10, 10 }, { 0, 30 }, { 30, 30 } | 
 | }; | 
 |  | 
 | std::ostream &operator<<(std::ostream &os, const kfIntervalParam &test_arg) { | 
 |   return os << "kfIntervalParam { min_kf_dist:" << test_arg.min_kf_dist | 
 |             << " max_kf_dist:" << test_arg.max_kf_dist << " }"; | 
 | } | 
 |  | 
 | // This class is used to test the presence of forward key frame. | 
 | class KeyFrameIntervalTestLarge | 
 |     : public ::libaom_test::CodecTestWith3Params<libaom_test::TestMode, | 
 |                                                  kfIntervalParam, aom_rc_mode>, | 
 |       public ::libaom_test::EncoderTest { | 
 |  protected: | 
 |   KeyFrameIntervalTestLarge() | 
 |       : EncoderTest(GET_PARAM(0)), encoding_mode_(GET_PARAM(1)), | 
 |         kf_dist_param_(GET_PARAM(2)), end_usage_check_(GET_PARAM(3)) { | 
 |     kf_dist_ = -1; | 
 |     is_kf_interval_violated_ = false; | 
 |   } | 
 |   ~KeyFrameIntervalTestLarge() override = default; | 
 |  | 
 |   void SetUp() override { | 
 |     InitializeConfig(encoding_mode_); | 
 |     const aom_rational timebase = { 1, 30 }; | 
 |     cfg_.g_timebase = timebase; | 
 |     cfg_.rc_end_usage = end_usage_check_; | 
 |     cfg_.g_threads = 1; | 
 |     cfg_.kf_min_dist = kf_dist_param_.min_kf_dist; | 
 |     cfg_.kf_max_dist = kf_dist_param_.max_kf_dist; | 
 |     cfg_.g_lag_in_frames = 19; | 
 |   } | 
 |  | 
 |   bool DoDecode() const override { return true; } | 
 |  | 
 |   void PreEncodeFrameHook(::libaom_test::VideoSource *video, | 
 |                           ::libaom_test::Encoder *encoder) override { | 
 |     if (video->frame() == 0) { | 
 |       encoder->Control(AOME_SET_CPUUSED, 5); | 
 |       encoder->Control(AOME_SET_ENABLEAUTOALTREF, 1); | 
 |     } | 
 |   } | 
 |  | 
 |   bool HandleDecodeResult(const aom_codec_err_t res_dec, | 
 |                           libaom_test::Decoder *decoder) override { | 
 |     EXPECT_EQ(AOM_CODEC_OK, res_dec) << decoder->DecodeError(); | 
 |     if (AOM_CODEC_OK == res_dec) { | 
 |       aom_codec_ctx_t *ctx_dec = decoder->GetDecoder(); | 
 |       int frame_flags = 0; | 
 |       AOM_CODEC_CONTROL_TYPECHECKED(ctx_dec, AOMD_GET_FRAME_FLAGS, | 
 |                                     &frame_flags); | 
 |       if (kf_dist_ != -1) { | 
 |         kf_dist_++; | 
 |         if (kf_dist_ > (int)kf_dist_param_.max_kf_dist) { | 
 |           is_kf_interval_violated_ = true; | 
 |         } | 
 |       } | 
 |       if ((frame_flags & AOM_FRAME_IS_KEY) == AOM_FRAME_IS_KEY) { | 
 |         if (kf_dist_ != -1 && kf_dist_ < (int)kf_dist_param_.min_kf_dist) { | 
 |           is_kf_interval_violated_ = true; | 
 |         } | 
 |         kf_dist_ = 0; | 
 |       } | 
 |     } | 
 |     return AOM_CODEC_OK == res_dec; | 
 |   } | 
 |  | 
 |   ::libaom_test::TestMode encoding_mode_; | 
 |   const kfIntervalParam kf_dist_param_; | 
 |   int kf_dist_; | 
 |   bool is_kf_interval_violated_; | 
 |   aom_rc_mode end_usage_check_; | 
 | }; | 
 |  | 
 | // Because valgrind builds take a very long time to run, use a lower | 
 | // resolution video for valgrind runs. | 
 | const char *TestFileName() { | 
 | #if AOM_VALGRIND_BUILD | 
 |   return "hantro_collage_w176h144.yuv"; | 
 | #else | 
 |   return "hantro_collage_w352h288.yuv"; | 
 | #endif  // AOM_VALGRIND_BUILD | 
 | } | 
 |  | 
 | int TestFileWidth() { | 
 | #if AOM_VALGRIND_BUILD | 
 |   return 176; | 
 | #else | 
 |   return 352; | 
 | #endif  // AOM_VALGRIND_BUILD | 
 | } | 
 |  | 
 | int TestFileHeight() { | 
 | #if AOM_VALGRIND_BUILD | 
 |   return 144; | 
 | #else | 
 |   return 288; | 
 | #endif  // AOM_VALGRIND_BUILD | 
 | } | 
 |  | 
 | TEST_P(KeyFrameIntervalTestLarge, KeyFrameIntervalTest) { | 
 |   libaom_test::I420VideoSource video(TestFileName(), TestFileWidth(), | 
 |                                      TestFileHeight(), cfg_.g_timebase.den, | 
 |                                      cfg_.g_timebase.num, 0, 75); | 
 |   ASSERT_NO_FATAL_FAILURE(RunLoop(&video)); | 
 |   ASSERT_EQ(is_kf_interval_violated_, false) << kf_dist_param_; | 
 | } | 
 |  | 
 | // This class tests for presence and placement of application forced key frames. | 
 | class ForcedKeyTestLarge | 
 |     : public ::libaom_test::CodecTestWith5Params<libaom_test::TestMode, int, | 
 |                                                  int, int, aom_rc_mode>, | 
 |       public ::libaom_test::EncoderTest { | 
 |  protected: | 
 |   ForcedKeyTestLarge() | 
 |       : EncoderTest(GET_PARAM(0)), encoding_mode_(GET_PARAM(1)), | 
 |         auto_alt_ref_(GET_PARAM(2)), fwd_kf_enabled_(GET_PARAM(3)), | 
 |         cpu_used_(GET_PARAM(4)), rc_end_usage_(GET_PARAM(5)) { | 
 |     forced_kf_frame_num_ = 1; | 
 |     frame_num_ = 0; | 
 |     is_kf_placement_violated_ = false; | 
 |   } | 
 |   ~ForcedKeyTestLarge() override = default; | 
 |  | 
 |   void SetUp() override { | 
 |     InitializeConfig(encoding_mode_); | 
 |     cfg_.rc_end_usage = rc_end_usage_; | 
 |     cfg_.g_threads = 0; | 
 |     cfg_.kf_max_dist = 30; | 
 |     cfg_.kf_min_dist = 0; | 
 |     cfg_.fwd_kf_enabled = fwd_kf_enabled_; | 
 |   } | 
 |  | 
 |   void PreEncodeFrameHook(::libaom_test::VideoSource *video, | 
 |                           ::libaom_test::Encoder *encoder) override { | 
 |     if (video->frame() == 0) { | 
 |       encoder->Control(AOME_SET_CPUUSED, cpu_used_); | 
 |       encoder->Control(AOME_SET_ENABLEAUTOALTREF, auto_alt_ref_); | 
 | #if CONFIG_AV1_ENCODER | 
 |       // override test default for tile columns if necessary. | 
 |       if (GET_PARAM(0) == &libaom_test::kAV1) { | 
 |         encoder->Control(AV1E_SET_TILE_COLUMNS, 6); | 
 |       } | 
 | #endif | 
 |     } | 
 |     frame_flags_ = | 
 |         ((int)video->frame() == forced_kf_frame_num_) ? AOM_EFLAG_FORCE_KF : 0; | 
 |   } | 
 |  | 
 |   bool HandleDecodeResult(const aom_codec_err_t res_dec, | 
 |                           libaom_test::Decoder *decoder) override { | 
 |     EXPECT_EQ(AOM_CODEC_OK, res_dec) << decoder->DecodeError(); | 
 |     if (AOM_CODEC_OK == res_dec) { | 
 |       if ((int)frame_num_ == forced_kf_frame_num_) { | 
 |         aom_codec_ctx_t *ctx_dec = decoder->GetDecoder(); | 
 |         int frame_flags = 0; | 
 |         AOM_CODEC_CONTROL_TYPECHECKED(ctx_dec, AOMD_GET_FRAME_FLAGS, | 
 |                                       &frame_flags); | 
 |         if ((frame_flags & AOM_FRAME_IS_KEY) != AOM_FRAME_IS_KEY) { | 
 |           is_kf_placement_violated_ = true; | 
 |         } | 
 |       } | 
 |       ++frame_num_; | 
 |     } | 
 |     return AOM_CODEC_OK == res_dec; | 
 |   } | 
 |  | 
 |   void Frame1IsKey(); | 
 |   void ForcedFrameIsKey(); | 
 |   void ForcedFrameIsKeyCornerCases(); | 
 |  | 
 |   ::libaom_test::TestMode encoding_mode_; | 
 |   int auto_alt_ref_; | 
 |   int fwd_kf_enabled_; | 
 |   int cpu_used_; | 
 |   aom_rc_mode rc_end_usage_; | 
 |   int forced_kf_frame_num_; | 
 |   unsigned int frame_num_; | 
 |   bool is_kf_placement_violated_; | 
 | }; | 
 |  | 
 | void ForcedKeyTestLarge::Frame1IsKey() { | 
 |   const aom_rational timebase = { 1, 30 }; | 
 |   // 1st element of this 2D array is for good encoding mode and 2nd element | 
 |   // is for RT encoding mode. | 
 |   const int lag_values[2][NUM_LAG_VALUES] = { { 3, 15, 25 }, { 0, -1, -1 } }; | 
 |   int is_realtime = (encoding_mode_ == ::libaom_test::kRealTime); | 
 |  | 
 |   forced_kf_frame_num_ = 1; | 
 |   for (int i = 0; i < NUM_LAG_VALUES; ++i) { | 
 |     if (lag_values[is_realtime][i] == -1) continue; | 
 |     frame_num_ = 0; | 
 |     cfg_.g_lag_in_frames = lag_values[is_realtime][i]; | 
 |     is_kf_placement_violated_ = false; | 
 |     libaom_test::I420VideoSource video( | 
 |         TestFileName(), TestFileWidth(), TestFileHeight(), timebase.den, | 
 |         timebase.num, 0, fwd_kf_enabled_ ? 60 : 30); | 
 |     ASSERT_NO_FATAL_FAILURE(RunLoop(&video)); | 
 |     ASSERT_EQ(is_kf_placement_violated_, false) | 
 |         << "Frame #" << frame_num_ << " isn't a keyframe!"; | 
 |   } | 
 | } | 
 |  | 
 | // This class checks the presence and placement of application | 
 | // forced key frames. | 
 | void ForcedKeyTestLarge::ForcedFrameIsKey() { | 
 |   const aom_rational timebase = { 1, 30 }; | 
 |   const int lag_values[] = { 3, 15, 25, -1 }; | 
 |  | 
 |   for (int i = 0; lag_values[i] != -1; ++i) { | 
 |     frame_num_ = 0; | 
 |     forced_kf_frame_num_ = lag_values[i] - 1; | 
 |     cfg_.g_lag_in_frames = lag_values[i]; | 
 |     is_kf_placement_violated_ = false; | 
 |     libaom_test::I420VideoSource video( | 
 |         TestFileName(), TestFileWidth(), TestFileHeight(), timebase.den, | 
 |         timebase.num, 0, fwd_kf_enabled_ ? 60 : 30); | 
 |     ASSERT_NO_FATAL_FAILURE(RunLoop(&video)); | 
 |     ASSERT_EQ(is_kf_placement_violated_, false) | 
 |         << "Frame #" << frame_num_ << " isn't a keyframe!"; | 
 |  | 
 |     // Two pass and single pass CBR are currently segfaulting for the case when | 
 |     // forced kf is placed after lag in frames. | 
 |     // TODO(anyone): Enable(uncomment) below test once above bug is fixed. | 
 |     //    frame_num_ = 0; | 
 |     //    forced_kf_frame_num_ = lag_values[i] + 1; | 
 |     //    cfg_.g_lag_in_frames = lag_values[i]; | 
 |     //    is_kf_placement_violated_ = false; | 
 |     //    ASSERT_NO_FATAL_FAILURE(RunLoop(&video)); | 
 |     //    ASSERT_EQ(is_kf_placement_violated_, false) | 
 |     //    << "Frame #" << frame_num_ << " isn't a keyframe!"; | 
 |   } | 
 | } | 
 |  | 
 | void ForcedKeyTestLarge::ForcedFrameIsKeyCornerCases() { | 
 |   const aom_rational timebase = { 1, 30 }; | 
 |   const int kf_offsets[] = { -2, -1, 1, 2, 0 }; | 
 |   cfg_.g_lag_in_frames = 35; | 
 |   if (encoding_mode_ == ::libaom_test::kRealTime) cfg_.g_lag_in_frames = 0; | 
 |  | 
 |   for (int i = 0; kf_offsets[i] != 0; ++i) { | 
 |     frame_num_ = 0; | 
 |     forced_kf_frame_num_ = (int)cfg_.kf_max_dist + kf_offsets[i]; | 
 |     forced_kf_frame_num_ = forced_kf_frame_num_ > 0 ? forced_kf_frame_num_ : 1; | 
 |     is_kf_placement_violated_ = false; | 
 |     libaom_test::I420VideoSource video( | 
 |         TestFileName(), TestFileWidth(), TestFileHeight(), timebase.den, | 
 |         timebase.num, 0, fwd_kf_enabled_ ? 60 : 30); | 
 |     ASSERT_NO_FATAL_FAILURE(RunLoop(&video)); | 
 |     ASSERT_EQ(is_kf_placement_violated_, false) | 
 |         << "Frame #" << frame_num_ << " isn't a keyframe!"; | 
 |   } | 
 | } | 
 |  | 
 | AV1_INSTANTIATE_TEST_SUITE(KeyFrameIntervalTestLarge, | 
 |                            testing::Values(::libaom_test::kOnePassGood, | 
 |                                            ::libaom_test::kTwoPassGood), | 
 |                            ::testing::ValuesIn(kfTestParams), | 
 |                            ::testing::Values(AOM_Q, AOM_VBR, AOM_CBR, AOM_CQ)); | 
 |  | 
 | TEST_P(ForcedKeyTestLarge, Frame1IsKey) { Frame1IsKey(); } | 
 | TEST_P(ForcedKeyTestLarge, ForcedFrameIsKey) { ForcedFrameIsKey(); } | 
 | TEST_P(ForcedKeyTestLarge, ForcedFrameIsKeyCornerCases) { | 
 |   ForcedFrameIsKeyCornerCases(); | 
 | } | 
 |  | 
 | class ForcedKeyRTTestLarge : public ForcedKeyTestLarge {}; | 
 |  | 
 | TEST_P(ForcedKeyRTTestLarge, Frame1IsKey) { Frame1IsKey(); } | 
 | TEST_P(ForcedKeyRTTestLarge, ForcedFrameIsKeyCornerCases) { | 
 |   ForcedFrameIsKeyCornerCases(); | 
 | } | 
 | // TODO(anyone): Add CBR to list of rc_modes once forced kf placement after | 
 | // lag in frames bug is fixed. | 
 | AV1_INSTANTIATE_TEST_SUITE(ForcedKeyTestLarge, | 
 |                            ::testing::Values(::libaom_test::kOnePassGood, | 
 |                                              ::libaom_test::kTwoPassGood), | 
 |                            ::testing::Values(0, 1), ::testing::Values(0, 1), | 
 |                            ::testing::Values(2, 5), | 
 |                            ::testing::Values(AOM_Q, AOM_VBR, AOM_CQ)); | 
 | AV1_INSTANTIATE_TEST_SUITE(ForcedKeyRTTestLarge, | 
 |                            ::testing::Values(::libaom_test::kRealTime), | 
 |                            ::testing::Values(0), ::testing::Values(0), | 
 |                            ::testing::Values(7, 9), | 
 |                            ::testing::Values(AOM_Q, AOM_VBR, AOM_CBR)); | 
 | }  // namespace |