Commit b3c644d9fd for aom
commit b3c644d9fd64e71d912ce901b352fcdd09308523
Author: Wan-Teh Chang <wtc@google.com>
Date: Mon May 11 16:25:44 2026 -0700
Document the external RC interface is experimental
Change-Id: I1c08e00678f8514055b9acc9fdfb659756a19571
diff --git a/aom/aom_ext_ratectrl.h b/aom/aom_ext_ratectrl.h
index 46c8f2000a..562b394789 100644
--- a/aom/aom_ext_ratectrl.h
+++ b/aom/aom_ext_ratectrl.h
@@ -12,6 +12,7 @@
/*!\file
* \brief Defines structs and callbacks needed for external rate control.
*
+ * \attention Experimental. Not part of the stable API.
*/
#ifndef AOM_AOM_AOM_EXT_RATECTRL_H_
#define AOM_AOM_AOM_EXT_RATECTRL_H_
diff --git a/aom/aom_tpl.h b/aom/aom_tpl.h
index 5615b2f05d..f2d5e8f757 100644
--- a/aom/aom_tpl.h
+++ b/aom/aom_tpl.h
@@ -9,6 +9,12 @@
* PATENTS file, you can obtain it at www.aomedia.org/license/patent.
*/
+/*!\file
+ * \brief Defines structs related to temporal dependency model stats, needed for
+ * external rate control.
+ *
+ * \attention Experimental. Not part of the stable API.
+ */
#ifndef AOM_AOM_AOM_TPL_H_
#define AOM_AOM_AOM_TPL_H_
diff --git a/aom/aomcx.h b/aom/aomcx.h
index a4099490ba..01aa5b96d6 100644
--- a/aom/aomcx.h
+++ b/aom/aomcx.h
@@ -1626,12 +1626,16 @@ enum aome_enc_control_id {
/*!\brief Codec control function to enable external rate control library.
*
* args: a pointer to aom_rc_funcs_t that contains implementation of callbacks
+ *
+ * \attention Experimental. Not part of the stable API.
*/
AV1E_SET_EXTERNAL_RATE_CONTROL = 173,
/*!\brief Codec control function to get GOP structure from the encoder.
*
* args: a pointer to aom_gop_info_t
+ *
+ * \attention Experimental. Not part of the stable API.
*/
AV1E_GET_GOP_INFO,
@@ -1900,6 +1904,8 @@ typedef enum {
/*!\brief The GOP structure information determined by the encoder.
* 250 is MAX_STATIC_GF_GROUP_LENGTH defined in av1/firstpass.h.
* This is a subset of GF_GROUP. More fields can be added if needed.
+ *
+ * \attention Experimental. Not part of the stable API.
*/
typedef struct aom_gop_info {
int gop_size; /**< The number of frames of this GOP */