Write unit tests for get QM formulas
Write unit tests for both `aom_get_qmlevel()` and
`aom_get_qmlevel_allintra()`. Assert some basic properties hold up
under various QM min and max level conditions.
Bug: aomedia:375221136
Change-Id: I677d2516673157fbc723026da03011aa04ddb88a
diff --git a/av1/common/quant_common.h b/av1/common/quant_common.h
index 1a7b281..6d2fb97 100644
--- a/av1/common/quant_common.h
+++ b/av1/common/quant_common.h
@@ -55,7 +55,7 @@
const struct macroblockd *xd, int segment_id);
// Reduce the large number of quantizers to a smaller number of levels for which
-// different matrices may be defined
+// different matrices may be defined. This is an increasing function in qindex.
static inline int aom_get_qmlevel(int qindex, int first, int last) {
return first + (qindex * (last + 1 - first)) / QINDEX_RANGE;
}
@@ -64,7 +64,7 @@
// This formula was empirically derived by encoding the CID22 validation
// testset for each QP/QM tuple, and building a convex hull that
// maximizes SSIMU2 scores, and a final subjective visual quality pass
-// as a sanity check.
+// as a sanity check. This is a decreasing function in qindex.
static inline int aom_get_qmlevel_allintra(int qindex, int first, int last) {
int qm_level = 0;
diff --git a/test/av1_get_qmlevel_test.cc b/test/av1_get_qmlevel_test.cc
new file mode 100644
index 0000000..da7dc24
--- /dev/null
+++ b/test/av1_get_qmlevel_test.cc
@@ -0,0 +1,110 @@
+/*
+ * Copyright (c) 2024, 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 "gtest/gtest.h"
+
+#include "av1/common/quant_common.h"
+
+namespace {
+
+TEST(GetQmLevelTest, Regular) {
+ // Get some QM levels from representative qindex values.
+ int qindex_1_qmlevel = aom_get_qmlevel(1, DEFAULT_QM_FIRST, DEFAULT_QM_LAST);
+ int qindex_60_qmlevel =
+ aom_get_qmlevel(60, DEFAULT_QM_FIRST, DEFAULT_QM_LAST);
+ int qindex_120_qmlevel =
+ aom_get_qmlevel(120, DEFAULT_QM_FIRST, DEFAULT_QM_LAST);
+ int qindex_180_qmlevel =
+ aom_get_qmlevel(180, DEFAULT_QM_FIRST, DEFAULT_QM_LAST);
+ int qindex_255_qmlevel =
+ aom_get_qmlevel(255, DEFAULT_QM_FIRST, DEFAULT_QM_LAST);
+
+ // Extreme qindex values should also result in extreme QM levels.
+ EXPECT_EQ(qindex_1_qmlevel, DEFAULT_QM_FIRST);
+ EXPECT_EQ(qindex_255_qmlevel, DEFAULT_QM_LAST);
+
+ // aom_get_qmlevel() QMs become steeper (i.e. QM levels become lower) the
+ // lower the qindex.
+ EXPECT_GE(qindex_255_qmlevel, qindex_180_qmlevel);
+ EXPECT_GE(qindex_180_qmlevel, qindex_120_qmlevel);
+ EXPECT_GE(qindex_120_qmlevel, qindex_60_qmlevel);
+ EXPECT_GE(qindex_60_qmlevel, qindex_1_qmlevel);
+ EXPECT_GT(qindex_255_qmlevel, qindex_1_qmlevel);
+
+ // Set min and max QM levels to be lower than DEFAULT_QM_FIRST.
+ int qindex_1_qmlevel_belowfirst = aom_get_qmlevel(1, 1, DEFAULT_QM_FIRST - 1);
+ int qindex_255_qmlevel_belowfirst =
+ aom_get_qmlevel(255, 1, DEFAULT_QM_FIRST - 1);
+
+ // Formula should always respect QM level boundaries, even when they're below
+ // DEFAULT_QM_FIRST.
+ EXPECT_LT(qindex_1_qmlevel_belowfirst, DEFAULT_QM_FIRST);
+ EXPECT_LT(qindex_255_qmlevel_belowfirst, DEFAULT_QM_FIRST);
+
+ // Set min and max QM levels to be higher than DEFAULT_QM_LAST.
+ int qindex_1_qmlevel_abovelast = aom_get_qmlevel(1, DEFAULT_QM_LAST + 1, 15);
+ int qindex_255_qmlevel_abovelast =
+ aom_get_qmlevel(255, DEFAULT_QM_LAST + 1, 15);
+
+ // Formula should always respect QM level boundaries, even when they're above
+ // DEFAULT_QM_LAST.
+ EXPECT_GT(qindex_1_qmlevel_abovelast, DEFAULT_QM_LAST);
+ EXPECT_GT(qindex_255_qmlevel_abovelast, DEFAULT_QM_LAST);
+}
+
+TEST(GetQmLevelTest, AllIntra) {
+ // Get some QM levels from representative qindex values.
+ int qindex_1_qmlevel = aom_get_qmlevel_allintra(1, DEFAULT_QM_FIRST_ALLINTRA,
+ DEFAULT_QM_LAST_ALLINTRA);
+ int qindex_60_qmlevel = aom_get_qmlevel_allintra(
+ 60, DEFAULT_QM_FIRST_ALLINTRA, DEFAULT_QM_LAST_ALLINTRA);
+ int qindex_120_qmlevel = aom_get_qmlevel_allintra(
+ 120, DEFAULT_QM_FIRST_ALLINTRA, DEFAULT_QM_LAST_ALLINTRA);
+ int qindex_180_qmlevel = aom_get_qmlevel_allintra(
+ 180, DEFAULT_QM_FIRST_ALLINTRA, DEFAULT_QM_LAST_ALLINTRA);
+ int qindex_255_qmlevel = aom_get_qmlevel_allintra(
+ 255, DEFAULT_QM_FIRST_ALLINTRA, DEFAULT_QM_LAST_ALLINTRA);
+
+ // Extreme qindex values should also result in extreme QM levels.
+ EXPECT_EQ(qindex_1_qmlevel, DEFAULT_QM_LAST_ALLINTRA);
+ EXPECT_EQ(qindex_255_qmlevel, DEFAULT_QM_FIRST_ALLINTRA);
+
+ // Unlike with aom_get_qmlevel(), aom_get_qmlevel_allintra() QMs become
+ // flatter (i.e. QM levels become higher) the lower the qindex.
+ EXPECT_LE(qindex_255_qmlevel, qindex_180_qmlevel);
+ EXPECT_LE(qindex_180_qmlevel, qindex_120_qmlevel);
+ EXPECT_LE(qindex_120_qmlevel, qindex_60_qmlevel);
+ EXPECT_LE(qindex_60_qmlevel, qindex_1_qmlevel);
+ EXPECT_LT(qindex_255_qmlevel, qindex_1_qmlevel);
+
+ // Set min and max QM levels to be lower than DEFAULT_QM_FIRST_ALLINTRA.
+ int qindex_1_qmlevel_belowfirst =
+ aom_get_qmlevel_allintra(1, 1, DEFAULT_QM_FIRST_ALLINTRA - 1);
+ int qindex_255_qmlevel_belowfirst =
+ aom_get_qmlevel_allintra(255, 1, DEFAULT_QM_FIRST_ALLINTRA - 1);
+
+ // Formula should always respect QM level boundaries, even when they're below
+ // DEFAULT_QM_FIRST_ALLINTRA.
+ EXPECT_EQ(qindex_1_qmlevel_belowfirst, DEFAULT_QM_FIRST_ALLINTRA - 1);
+ EXPECT_EQ(qindex_255_qmlevel_belowfirst, DEFAULT_QM_FIRST_ALLINTRA - 1);
+
+ // Set min and max QM levels to be higher than DEFAULT_QM_LAST_ALLINTRA.
+ int qindex_1_qmlevel_abovelast =
+ aom_get_qmlevel_allintra(1, DEFAULT_QM_LAST_ALLINTRA + 1, 15);
+ int qindex_255_qmlevel_abovelast =
+ aom_get_qmlevel_allintra(255, DEFAULT_QM_LAST_ALLINTRA + 1, 15);
+
+ // Formula should always respect QM level boundaries, even when they're above
+ // DEFAULT_QM_LAST_ALLINTRA.
+ EXPECT_EQ(qindex_1_qmlevel_abovelast, DEFAULT_QM_LAST_ALLINTRA + 1);
+ EXPECT_EQ(qindex_255_qmlevel_abovelast, DEFAULT_QM_LAST_ALLINTRA + 1);
+}
+
+} // namespace
diff --git a/test/test.cmake b/test/test.cmake
index 7557f63..e708a03 100644
--- a/test/test.cmake
+++ b/test/test.cmake
@@ -190,6 +190,7 @@
"${AOM_ROOT}/test/av1_convolve_test.cc"
"${AOM_ROOT}/test/av1_fwd_txfm1d_test.cc"
"${AOM_ROOT}/test/av1_fwd_txfm2d_test.cc"
+ "${AOM_ROOT}/test/av1_get_qmlevel_test.cc"
"${AOM_ROOT}/test/av1_inv_txfm1d_test.cc"
"${AOM_ROOT}/test/av1_inv_txfm2d_test.cc"
"${AOM_ROOT}/test/av1_k_means_test.cc"
