FPMT: Fix doxygen warnings
A couple of doxygen warnings which arise when FPMT is enabled are fixed
by changing the interface of set_rate_correction_factor() and
av1_rc_update_rate_correction_factors() as well as those of their caller
functions.
Change-Id: I8ed9d5990bcfcb8c0c78fcf9b65557539c960272
diff --git a/av1/encoder/ratectrl.c b/av1/encoder/ratectrl.c
index 66606b8..6423a82 100644
--- a/av1/encoder/ratectrl.c
+++ b/av1/encoder/ratectrl.c
@@ -609,6 +609,7 @@
*
* \ingroup rate_control
* \param[in] cpi Top level encoder instance structure
+ * \param[in] is_encode_stage Indicates if recode loop or post-encode
* \param[in] factor New correction factor
* \param[in] width Frame width
* \param[in] height Frame height
@@ -616,14 +617,14 @@
* \return None but updates the rate correction factor for the
* current frame type in cpi->rc.
*/
-static void set_rate_correction_factor(AV1_COMP *cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- int is_encode_stage,
-#endif // CONFIG_FRAME_PARALLEL_ENCODE
+static void set_rate_correction_factor(AV1_COMP *cpi, int is_encode_stage,
double factor, int width, int height) {
RATE_CONTROL *const rc = &cpi->rc;
PRIMARY_RATE_CONTROL *const p_rc = &cpi->ppi->p_rc;
const RefreshFrameInfo *const refresh_frame = &cpi->refresh_frame;
+#if !CONFIG_FRAME_PARALLEL_ENCODE
+ (void)is_encode_stage;
+#endif
int update_default_rcf = 1;
// Normalize RCF to account for the size-dependent scaling factor.
factor /= resize_rate_factor(&cpi->oxcf.frm_dim_cfg, width, height);
@@ -663,10 +664,7 @@
}
}
-void av1_rc_update_rate_correction_factors(AV1_COMP *cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- int is_encode_stage,
-#endif
+void av1_rc_update_rate_correction_factors(AV1_COMP *cpi, int is_encode_stage,
int width, int height) {
const AV1_COMMON *const cm = &cpi->common;
int correction_factor = 100;
@@ -675,6 +673,10 @@
double adjustment_limit;
const int MBs = av1_get_MBs(width, height);
+#if !CONFIG_FRAME_PARALLEL_ENCODE
+ (void)is_encode_stage;
+#endif
+
int projected_size_based_on_q = 0;
// Do not update the rate factors for arf overlay frames.
@@ -737,11 +739,8 @@
rate_correction_factor = MIN_BPB_FACTOR;
}
- set_rate_correction_factor(cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- is_encode_stage,
-#endif
- rate_correction_factor, width, height);
+ set_rate_correction_factor(cpi, is_encode_stage, rate_correction_factor,
+ width, height);
}
// Calculate rate for the given 'q'.
@@ -2011,11 +2010,7 @@
rc->projected_frame_size = (int)(bytes_used << 3);
// Post encode loop adjustment of Q prediction.
- av1_rc_update_rate_correction_factors(cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- 0,
-#endif
- cm->width, cm->height);
+ av1_rc_update_rate_correction_factors(cpi, 0, cm->width, cm->height);
// Keep a record of last Q and ambient average Q.
if (current_frame->frame_type == KEY_FRAME) {
diff --git a/av1/encoder/ratectrl.h b/av1/encoder/ratectrl.h
index c47348c..de3da04 100644
--- a/av1/encoder/ratectrl.h
+++ b/av1/encoder/ratectrl.h
@@ -577,16 +577,15 @@
*
* \ingroup rate_control
* \param[in] cpi Top level encoder instance structure
+ * \param[in] is_encode_stage Indicates if recode loop or post-encode
* \param[in] width Frame width
* \param[in] height Frame height
*
* \return None but updates the relevant rate correction factor in cpi->rc
*/
void av1_rc_update_rate_correction_factors(struct AV1_COMP *cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- int is_encode_stage,
-#endif // CONFIG_FRAME_PARALLEL_ENCODE
- int width, int height);
+ int is_encode_stage, int width,
+ int height);
/*!\cond */
// Decide if we should drop this frame: For 1-pass CBR.
diff --git a/av1/encoder/rc_utils.h b/av1/encoder/rc_utils.h
index 69ab726..88b1f5c 100644
--- a/av1/encoder/rc_utils.h
+++ b/av1/encoder/rc_utils.h
@@ -181,20 +181,14 @@
}
static AOM_INLINE int get_regulated_q_overshoot(AV1_COMP *const cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- int is_encode_stage,
-#endif
- int q_low, int q_high,
- int top_index,
+ int is_encode_stage, int q_low,
+ int q_high, int top_index,
int bottom_index) {
const AV1_COMMON *const cm = &cpi->common;
const RATE_CONTROL *const rc = &cpi->rc;
- av1_rc_update_rate_correction_factors(cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- is_encode_stage,
-#endif
- cm->width, cm->height);
+ av1_rc_update_rate_correction_factors(cpi, is_encode_stage, cm->width,
+ cm->height);
int q_regulated =
av1_rc_regulate_q(cpi, rc->this_frame_target, bottom_index,
@@ -202,11 +196,8 @@
int retries = 0;
while (q_regulated < q_low && retries < 10) {
- av1_rc_update_rate_correction_factors(cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- is_encode_stage,
-#endif
- cm->width, cm->height);
+ av1_rc_update_rate_correction_factors(cpi, is_encode_stage, cm->width,
+ cm->height);
q_regulated =
av1_rc_regulate_q(cpi, rc->this_frame_target, bottom_index,
AOMMAX(q_high, top_index), cm->width, cm->height);
@@ -216,29 +207,21 @@
}
static AOM_INLINE int get_regulated_q_undershoot(AV1_COMP *const cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
int is_encode_stage,
-#endif
int q_high, int top_index,
int bottom_index) {
const AV1_COMMON *const cm = &cpi->common;
const RATE_CONTROL *const rc = &cpi->rc;
- av1_rc_update_rate_correction_factors(cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- is_encode_stage,
-#endif
- cm->width, cm->height);
+ av1_rc_update_rate_correction_factors(cpi, is_encode_stage, cm->width,
+ cm->height);
int q_regulated = av1_rc_regulate_q(cpi, rc->this_frame_target, bottom_index,
top_index, cm->width, cm->height);
int retries = 0;
while (q_regulated > q_high && retries < 10) {
- av1_rc_update_rate_correction_factors(cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- is_encode_stage,
-#endif
- cm->width, cm->height);
+ av1_rc_update_rate_correction_factors(cpi, is_encode_stage, cm->width,
+ cm->height);
q_regulated = av1_rc_regulate_q(cpi, rc->this_frame_target, bottom_index,
top_index, cm->width, cm->height);
retries++;
@@ -415,31 +398,19 @@
if (*undershoot_seen || loop_count > 2 ||
(loop_count == 2 && !frame_is_intra_only(cm))) {
- av1_rc_update_rate_correction_factors(cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- 1,
-#endif
- cm->width, cm->height);
+ av1_rc_update_rate_correction_factors(cpi, 1, cm->width, cm->height);
*q = (*q_high + *q_low + 1) / 2;
} else if (loop_count == 2 && frame_is_intra_only(cm)) {
const int q_mid = (*q_high + *q_low + 1) / 2;
- const int q_regulated =
- get_regulated_q_overshoot(cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- 1,
-#endif
- *q_low, *q_high, top_index, bottom_index);
+ const int q_regulated = get_regulated_q_overshoot(
+ cpi, 1, *q_low, *q_high, top_index, bottom_index);
// Get 'q' in-between 'q_mid' and 'q_regulated' for a smooth
// transition between loop_count < 2 and loop_count > 2.
*q = (q_mid + q_regulated + 1) / 2;
} else {
- *q =
- get_regulated_q_overshoot(cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- 1,
-#endif
- *q_low, *q_high, top_index, bottom_index);
+ *q = get_regulated_q_overshoot(cpi, 1, *q_low, *q_high, top_index,
+ bottom_index);
}
*overshoot_seen = 1;
@@ -449,20 +420,12 @@
if (*overshoot_seen || loop_count > 2 ||
(loop_count == 2 && !frame_is_intra_only(cm))) {
- av1_rc_update_rate_correction_factors(cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- 1,
-#endif
- cm->width, cm->height);
+ av1_rc_update_rate_correction_factors(cpi, 1, cm->width, cm->height);
*q = (*q_high + *q_low) / 2;
} else if (loop_count == 2 && frame_is_intra_only(cm)) {
const int q_mid = (*q_high + *q_low) / 2;
- const int q_regulated =
- get_regulated_q_undershoot(cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- 1,
-#endif
- *q_high, top_index, bottom_index);
+ const int q_regulated = get_regulated_q_undershoot(
+ cpi, 1, *q_high, top_index, bottom_index);
// Get 'q' in-between 'q_mid' and 'q_regulated' for a smooth
// transition between loop_count < 2 and loop_count > 2.
*q = (q_mid + q_regulated) / 2;
@@ -475,11 +438,8 @@
*q_low = *q;
}
} else {
- *q = get_regulated_q_undershoot(cpi,
-#if CONFIG_FRAME_PARALLEL_ENCODE
- 1,
-#endif
- *q_high, top_index, bottom_index);
+ *q = get_regulated_q_undershoot(cpi, 1, *q_high, top_index,
+ bottom_index);
// Special case reset for qlow for constrained quality.
// This should only trigger where there is very substantial
