RC: Add codec control and impl for init/create
Bug: aomedia:450252793
Change-Id: Ida28381348130ff0cf7a6c84781099baeb2817e7
diff --git a/aom/aomcx.h b/aom/aomcx.h
index cae2a79..e7bfe96 100644
--- a/aom/aomcx.h
+++ b/aom/aomcx.h
@@ -18,6 +18,7 @@
*/
#include "aom/aom.h"
#include "aom/aom_encoder.h"
+#include "aom/aom_ext_ratectrl.h"
#include "aom/aom_external_partition.h"
/*!\file
@@ -1617,6 +1618,12 @@
*/
AV1E_SET_ENABLE_ADAPTIVE_SHARPNESS = 172,
+ /*!\brief Codec control function to enable external rate control library.
+ *
+ * args: a pointer to aom_rc_funcs_t that contains implementation of callbacks
+ */
+ AV1E_SET_EXTERNAL_RATE_CONTROL = 173,
+
// Any new encoder control IDs should be added above.
// Maximum allowed encoder control ID is 229.
// No encoder control ID should be added below.
@@ -2360,6 +2367,9 @@
AOM_CTRL_USE_TYPE(AV1E_SET_ENABLE_ADAPTIVE_SHARPNESS, unsigned int)
#define AOM_CTRL_AV1E_SET_ENABLE_ADAPTIVE_SHARPNESS
+AOM_CTRL_USE_TYPE(AV1E_SET_EXTERNAL_RATE_CONTROL, aom_rc_funcs_t *)
+#define AOM_CTRL_AV1E_SET_EXTERNAL_RATE_CONTROL
+
/*!\endcond */
/*! @} - end defgroup aom_encoder */
#ifdef __cplusplus
diff --git a/av1/av1.cmake b/av1/av1.cmake
index 42e7530..b2f1bdf 100644
--- a/av1/av1.cmake
+++ b/av1/av1.cmake
@@ -127,6 +127,7 @@
"${AOM_ROOT}/av1/encoder/allintra_vis.c"
"${AOM_ROOT}/av1/encoder/allintra_vis.h"
"${AOM_ROOT}/av1/encoder/enc_enums.h"
+ "${AOM_ROOT}/av1/encoder/av1_ext_ratectrl.c"
"${AOM_ROOT}/av1/encoder/av1_ext_ratectrl.h"
"${AOM_ROOT}/av1/encoder/av1_fwd_txfm1d.c"
"${AOM_ROOT}/av1/encoder/av1_fwd_txfm1d.h"
diff --git a/av1/av1_cx_iface.c b/av1/av1_cx_iface.c
index b49c1aa..295ff0d 100644
--- a/av1/av1_cx_iface.c
+++ b/av1/av1_cx_iface.c
@@ -34,6 +34,7 @@
#include "av1/common/enums.h"
#include "av1/common/quant_common.h"
#include "av1/common/scale.h"
+#include "av1/encoder/av1_ext_ratectrl.h"
#include "av1/encoder/bitstream.h"
#include "av1/encoder/enc_enums.h"
#include "av1/encoder/encoder.h"
@@ -3105,6 +3106,7 @@
if (ctx->ppi) {
AV1_PRIMARY *ppi = ctx->ppi;
+ av1_extrc_delete(&ppi->cpi->ext_ratectrl);
for (int i = 0; i < MAX_PARALLEL_FRAMES - 1; i++) {
if (ppi->parallel_frames_data[i].cx_data) {
free(ppi->parallel_frames_data[i].cx_data);
@@ -4193,6 +4195,50 @@
return update_extra_cfg(ctx, &extra_cfg);
}
+static aom_codec_err_t ctrl_set_external_rate_control(aom_codec_alg_priv_t *ctx,
+ va_list args) {
+ aom_rc_funcs_t funcs = *CAST(AV1E_SET_EXTERNAL_RATE_CONTROL, args);
+ AV1_COMP *cpi = ctx->ppi->cpi;
+ AOM_EXT_RATECTRL *ext_ratectrl = &cpi->ext_ratectrl;
+ const AV1EncoderConfig *oxcf = &cpi->oxcf;
+ if (oxcf->pass == AOM_RC_SECOND_PASS) {
+ const FRAME_INFO *frame_info = &cpi->frame_info;
+ aom_rc_config_t ratectrl_config;
+ aom_codec_err_t codec_status;
+ memset(&ratectrl_config, 0, sizeof(ratectrl_config));
+
+ ratectrl_config.frame_width = frame_info->frame_width;
+ ratectrl_config.frame_height = frame_info->frame_height;
+ ratectrl_config.show_frame_count =
+ cpi->ppi->twopass.firstpass_info.stats_count;
+ ratectrl_config.max_gf_interval = ctx->extra_cfg.max_gf_interval;
+ ratectrl_config.min_gf_interval = ctx->extra_cfg.min_gf_interval;
+ ratectrl_config.target_bitrate_kbps =
+ (int)(oxcf->rc_cfg.target_bandwidth / 1000);
+ ratectrl_config.frame_rate_num = ctx->cfg.g_timebase.den;
+ ratectrl_config.frame_rate_den = ctx->cfg.g_timebase.num;
+ ratectrl_config.overshoot_percent = oxcf->rc_cfg.over_shoot_pct;
+ ratectrl_config.undershoot_percent = oxcf->rc_cfg.under_shoot_pct;
+ ratectrl_config.min_base_q_index = oxcf->rc_cfg.best_allowed_q;
+ ratectrl_config.max_base_q_index = oxcf->rc_cfg.worst_allowed_q;
+ ratectrl_config.base_qp = ctx->extra_cfg.cq_level;
+
+ if (ctx->cfg.rc_end_usage == AOM_VBR) {
+ ratectrl_config.rc_mode = AOM_RC_VBR;
+ } else if (ctx->cfg.rc_end_usage == AOM_Q) {
+ ratectrl_config.rc_mode = AOM_RC_QMODE;
+ } else if (ctx->cfg.rc_end_usage == AOM_CQ) {
+ ratectrl_config.rc_mode = AOM_RC_CQ;
+ }
+
+ codec_status = av1_extrc_create(funcs, ratectrl_config, ext_ratectrl);
+ if (codec_status != AOM_CODEC_OK) {
+ return codec_status;
+ }
+ }
+ return AOM_CODEC_OK;
+}
+
static aom_codec_err_t encoder_set_option(aom_codec_alg_priv_t *ctx,
const char *name, const char *value) {
if (ctx == NULL || name == NULL || value == NULL)
@@ -4894,6 +4940,7 @@
{ AV1E_SET_SCREEN_CONTENT_DETECTION_MODE,
ctrl_set_screen_content_detection_mode },
{ AV1E_SET_ENABLE_ADAPTIVE_SHARPNESS, ctrl_set_enable_adaptive_sharpness },
+ { AV1E_SET_EXTERNAL_RATE_CONTROL, ctrl_set_external_rate_control },
// Getters
{ AOME_GET_LAST_QUANTIZER, ctrl_get_quantizer },
diff --git a/av1/encoder/av1_ext_ratectrl.c b/av1/encoder/av1_ext_ratectrl.c
new file mode 100644
index 0000000..bf24fb9
--- /dev/null
+++ b/av1/encoder/av1_ext_ratectrl.c
@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2025, 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 "aom/aom_ext_ratectrl.h"
+#include "av1/encoder/av1_ext_ratectrl.h"
+
+aom_codec_err_t av1_extrc_init(AOM_EXT_RATECTRL *ext_ratectrl) {
+ if (ext_ratectrl == NULL) {
+ return AOM_CODEC_INVALID_PARAM;
+ }
+ av1_zero(*ext_ratectrl);
+ return AOM_CODEC_OK;
+}
+
+aom_codec_err_t av1_extrc_create(aom_rc_funcs_t funcs,
+ aom_rc_config_t ratectrl_config,
+ AOM_EXT_RATECTRL *ext_ratectrl) {
+ aom_rc_status_t rc_status;
+ aom_rc_firstpass_stats_t *rc_firstpass_stats;
+ if (ext_ratectrl == NULL) {
+ return AOM_CODEC_INVALID_PARAM;
+ }
+ av1_extrc_delete(ext_ratectrl);
+ ext_ratectrl->funcs = funcs;
+ ext_ratectrl->ratectrl_config = ratectrl_config;
+ rc_status = ext_ratectrl->funcs.create_model(ext_ratectrl->funcs.priv,
+ &ext_ratectrl->ratectrl_config,
+ &ext_ratectrl->model);
+ if (rc_status == AOM_RC_ERROR) {
+ return AOM_CODEC_ERROR;
+ }
+ rc_firstpass_stats = &ext_ratectrl->rc_firstpass_stats;
+ rc_firstpass_stats->num_frames = ratectrl_config.show_frame_count;
+ rc_firstpass_stats->frame_stats =
+ aom_malloc(sizeof(*rc_firstpass_stats->frame_stats) *
+ rc_firstpass_stats->num_frames);
+ if (rc_firstpass_stats->frame_stats == NULL) {
+ return AOM_CODEC_MEM_ERROR;
+ }
+
+ ext_ratectrl->ready = 1;
+ return AOM_CODEC_OK;
+}
+
+aom_codec_err_t av1_extrc_delete(AOM_EXT_RATECTRL *ext_ratectrl) {
+ if (ext_ratectrl == NULL) {
+ return AOM_CODEC_INVALID_PARAM;
+ }
+ if (ext_ratectrl->ready) {
+ aom_rc_status_t rc_status =
+ ext_ratectrl->funcs.delete_model(ext_ratectrl->model);
+ if (rc_status == AOM_RC_ERROR) {
+ return AOM_CODEC_ERROR;
+ }
+ aom_free(ext_ratectrl->rc_firstpass_stats.frame_stats);
+ }
+ return av1_extrc_init(ext_ratectrl);
+}
diff --git a/av1/encoder/encoder.h b/av1/encoder/encoder.h
index b31a7d9..361332a 100644
--- a/av1/encoder/encoder.h
+++ b/av1/encoder/encoder.h
@@ -34,6 +34,7 @@
#include "av1/common/timing.h"
#include "av1/encoder/aq_cyclicrefresh.h"
+#include "av1/encoder/av1_ext_ratectrl.h"
#include "av1/encoder/av1_quantize.h"
#include "av1/encoder/block.h"
#include "av1/encoder/context_tree.h"
@@ -3706,6 +3707,11 @@
* ROI map.
*/
aom_roi_map_t roi;
+
+ /*!
+ * External rate control.
+ */
+ AOM_EXT_RATECTRL ext_ratectrl;
} AV1_COMP;
/*!
diff --git a/build/cmake/aom_install.cmake b/build/cmake/aom_install.cmake
index 4291782..1ac795e 100644
--- a/build/cmake/aom_install.cmake
+++ b/build/cmake/aom_install.cmake
@@ -20,7 +20,9 @@
if(CONFIG_AV1_ENCODER)
list(APPEND AOM_INSTALL_INCS "${AOM_ROOT}/aom/aomcx.h"
"${AOM_ROOT}/aom/aom_encoder.h"
- "${AOM_ROOT}/aom/aom_external_partition.h")
+ "${AOM_ROOT}/aom/aom_ext_ratectrl.h"
+ "${AOM_ROOT}/aom/aom_external_partition.h"
+ "${AOM_ROOT}/aom/aom_tpl.h")
endif()
# Generate aom.pc and setup dependencies to ensure it is created when necessary.
diff --git a/test/encode_test_driver.h b/test/encode_test_driver.h
index a589ae2..739e9a0 100644
--- a/test/encode_test_driver.h
+++ b/test/encode_test_driver.h
@@ -159,6 +159,10 @@
const aom_codec_err_t res = aom_codec_control(&encoder_, ctrl_id, arg);
ASSERT_EQ(AOM_CODEC_OK, res) << EncoderError();
}
+ void Control(int ctrl_id, aom_rc_funcs_t *arg) {
+ const aom_codec_err_t res = aom_codec_control(&encoder_, ctrl_id, arg);
+ ASSERT_EQ(AOM_CODEC_OK, res) << EncoderError();
+ }
#endif
void SetOption(const char *name, const char *value) {
diff --git a/test/ext_ratectrl_test.cc b/test/ext_ratectrl_test.cc
new file mode 100644
index 0000000..ef7f92e
--- /dev/null
+++ b/test/ext_ratectrl_test.cc
@@ -0,0 +1,121 @@
+/*
+ * Copyright (c) 2025, 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 "test/codec_factory.h"
+#include "test/encode_test_driver.h"
+#include "test/util.h"
+#include "test/y4m_video_source.h"
+#include "aom/aom_ext_ratectrl.h"
+#include "gtest/gtest.h"
+
+namespace {
+
+const int kFrameNum = 5;
+
+// A mock rate control model.
+struct MockRateCtrlModel {};
+
+// A mock private data for rate control callbacks.
+struct MockRC {};
+struct MockRC g_priv;
+
+// A flag to indicate if create_model() is called.
+bool is_create_model_called = false;
+
+// A flag to indicate if delete_model() is called.
+bool is_delete_model_called = false;
+
+aom_rc_status_t mock_create_model(void *priv,
+ const aom_rc_config_t *ratectrl_config,
+ aom_rc_model_t *ratectrl_model) {
+ (void)priv;
+ (void)ratectrl_config;
+ EXPECT_NE(ratectrl_model, nullptr);
+ *ratectrl_model = (aom_rc_model_t)(new MockRateCtrlModel());
+ is_create_model_called = true;
+ return AOM_RC_OK;
+}
+
+aom_rc_status_t mock_delete_model(aom_rc_model_t ratectrl_model) {
+ EXPECT_NE(ratectrl_model, nullptr);
+ delete (MockRateCtrlModel *)ratectrl_model;
+ is_delete_model_called = true;
+ return AOM_RC_OK;
+}
+
+aom_rc_status_t mock_send_firstpass_stats(
+ aom_rc_model_t ratectrl_model,
+ const aom_rc_firstpass_stats_t *firstpass_stats) {
+ (void)ratectrl_model;
+ (void)firstpass_stats;
+ return AOM_RC_OK;
+}
+
+aom_rc_status_t mock_get_encodeframe_decision(
+ aom_rc_model_t ratectrl_model, const int frame_gop_index,
+ aom_rc_encodeframe_decision_t *frame_decision) {
+ (void)ratectrl_model;
+ (void)frame_gop_index;
+ (void)frame_decision;
+ return AOM_RC_OK;
+}
+
+aom_rc_status_t mock_update_encodeframe_result(
+ aom_rc_model_t ratectrl_model,
+ const aom_rc_encodeframe_result_t *encode_frame_result) {
+ (void)ratectrl_model;
+ (void)encode_frame_result;
+ return AOM_RC_OK;
+}
+
+class ExtRateCtrlTest : public ::libaom_test::EncoderTest,
+ public ::libaom_test::CodecTestWith2Params<int, int> {
+ protected:
+ ExtRateCtrlTest() : EncoderTest(GET_PARAM(0)), cpu_used_(GET_PARAM(2)) {
+ aom_rc_funcs_t *rc_funcs = &rc_funcs_;
+ rc_funcs->priv = &g_priv;
+ rc_funcs->create_model = mock_create_model;
+ rc_funcs->delete_model = mock_delete_model;
+ rc_funcs->send_firstpass_stats = mock_send_firstpass_stats;
+ rc_funcs->get_encodeframe_decision = mock_get_encodeframe_decision;
+ rc_funcs->update_encodeframe_result = mock_update_encodeframe_result;
+ }
+ ~ExtRateCtrlTest() override = default;
+
+ void SetUp() override {
+ InitializeConfig(static_cast<libaom_test::TestMode>(GET_PARAM(1)));
+ cfg_.g_threads = 1;
+ cfg_.g_limit = kFrameNum;
+ }
+
+ void PreEncodeFrameHook(::libaom_test::VideoSource *video,
+ ::libaom_test::Encoder *encoder) override {
+ if (video->frame() == 0) {
+ encoder->Control(AOME_SET_CPUUSED, cpu_used_);
+ encoder->Control(AV1E_SET_EXTERNAL_RATE_CONTROL, &rc_funcs_);
+ }
+ }
+
+ aom_rc_funcs_t rc_funcs_;
+ int cpu_used_;
+};
+
+TEST_P(ExtRateCtrlTest, TestExternalRateCtrl) {
+ ::libaom_test::Y4mVideoSource video("screendata.y4m", 0, kFrameNum);
+ ASSERT_NO_FATAL_FAILURE(RunLoop(&video));
+ EXPECT_TRUE(is_create_model_called);
+ EXPECT_TRUE(is_delete_model_called);
+}
+
+AV1_INSTANTIATE_TEST_SUITE(ExtRateCtrlTest,
+ ::testing::Values(::libaom_test::kTwoPassGood),
+ ::testing::Values(0));
+} // namespace
diff --git a/test/test.cmake b/test/test.cmake
index 4228a25..088ce3c 100644
--- a/test/test.cmake
+++ b/test/test.cmake
@@ -76,6 +76,7 @@
"${AOM_ROOT}/test/encode_test_driver.cc"
"${AOM_ROOT}/test/encode_test_driver.h"
"${AOM_ROOT}/test/end_to_end_psnr_test.cc"
+ "${AOM_ROOT}/test/ext_ratectrl_test.cc"
"${AOM_ROOT}/test/forced_max_frame_width_height_test.cc"
"${AOM_ROOT}/test/force_key_frame_test.cc"
"${AOM_ROOT}/test/gf_pyr_height_test.cc"
