blob: 6802ad42d05f5007f84aa7044166668ef6029d7f [file] [log] [blame]
Yaowu Xuc27fc142016-08-22 16:08:15 -07001/*
Yaowu Xu2ab7ff02016-09-02 12:04:54 -07002 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
Yaowu Xuc27fc142016-08-22 16:08:15 -07003 *
Yaowu Xu2ab7ff02016-09-02 12:04:54 -07004 * This source code is subject to the terms of the BSD 2 Clause License and
5 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
6 * was not distributed with this source code in the LICENSE file, you can
7 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
8 * Media Patent License 1.0 was not distributed with this source code in the
9 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
Yaowu Xuc27fc142016-08-22 16:08:15 -070010 */
11
James Zerne1cbb132018-08-22 14:10:36 -070012#ifndef AOM_AV1_ENCODER_RATECTRL_H_
13#define AOM_AV1_ENCODER_RATECTRL_H_
Yaowu Xuc27fc142016-08-22 16:08:15 -070014
Yaowu Xuf883b422016-08-30 14:01:10 -070015#include "aom/aom_codec.h"
16#include "aom/aom_integer.h"
Yaowu Xuc27fc142016-08-22 16:08:15 -070017
David Turner4f1f1812019-01-24 17:00:24 +000018#include "aom_ports/mem.h"
19
Wan-Teh Changf2d15ee2020-03-10 09:24:43 -070020#include "av1/common/av1_common_int.h"
Yaowu Xuc27fc142016-08-22 16:08:15 -070021#include "av1/common/blockd.h"
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
Urvang Joshifee52c62020-06-17 13:45:55 -070027/*!\cond */
28
Yaowu Xuc27fc142016-08-22 16:08:15 -070029// Bits Per MB at different Q (Multiplied by 512)
30#define BPER_MB_NORMBITS 9
31
Sarah Parker97803fc2019-05-17 14:15:37 -070032// Use this macro to turn on/off use of alt-refs in one-pass mode.
33#define USE_ALTREF_FOR_ONE_PASS 1
34
Urvang Joshic6d7e2d2018-11-06 15:52:42 -080035// Threshold used to define if a KF group is static (e.g. a slide show).
36// Essentially, this means that no frame in the group has more than 1% of MBs
37// that are not marked as coded with 0,0 motion in the first pass.
38#define STATIC_KF_GROUP_THRESH 99
39#define STATIC_KF_GROUP_FLOAT_THRESH 0.99
40
41// The maximum duration of a GF group that is static (e.g. a slide show).
42#define MAX_STATIC_GF_GROUP_LENGTH 250
43
Yaowu Xuc27fc142016-08-22 16:08:15 -070044#define MIN_GF_INTERVAL 4
Jingning Hanb5c134c2020-02-07 09:27:21 -080045#define MAX_GF_INTERVAL 32
Jingning Hanaa1d8fc2020-10-01 14:41:12 -070046#define FIXED_GF_INTERVAL 16
Aasaipriyad1ef4602020-03-16 20:13:35 +053047#define MAX_GF_LENGTH_LAP 16
Yaowu Xuc27fc142016-08-22 16:08:15 -070048
Yunqing Wang415abbd2021-10-06 20:17:26 -070049#define FIXED_GF_INTERVAL_RT 80
50#define MAX_GF_INTERVAL_RT 160
51
bohanlie1515342020-02-25 11:58:11 -080052#define MAX_NUM_GF_INTERVALS 15
bohanlia964eea2020-02-13 11:48:00 -080053
Paul Wilkins47426162020-03-02 17:46:07 +000054#define MAX_ARF_LAYERS 6
55// #define STRICT_RC
56
Jerome Jiangda133ca2021-11-15 07:50:10 -080057#define DEFAULT_KF_BOOST_RT 2300
58#define DEFAULT_GF_BOOST_RT 2000
59
Cheng Chen3e353752022-04-01 16:36:37 -070060// A passive rate control strategy for screen content type in real-time mode.
61// When it is turned on, the compression performance is improved by
62// 7.8% (overall_psnr), 5.0% (VMAF) on average. Some clips see gains
63// over 20% on metric.
64// The downside is that it does not guarantee frame size.
65// Since RT mode has a tight restriction on buffer overflow control, we
66// turn it off by default.
67#define RT_PASSIVE_STRATEGY 0
68#define MAX_Q_HISTORY 1000
69
Yaowu Xuc27fc142016-08-22 16:08:15 -070070typedef struct {
Debargha Mukherjeeccb27262017-09-25 14:19:46 -070071 int resize_width;
72 int resize_height;
Urvang Joshide71d142017-10-05 12:12:15 -070073 uint8_t superres_denom;
Debargha Mukherjee7166f222017-09-05 21:32:42 -070074} size_params_type;
75
Urvang Joshi7a890232019-03-22 17:00:31 -070076enum {
Jingning Hanbf237192019-12-15 15:21:31 +000077 INTER_NORMAL,
78 GF_ARF_LOW,
79 GF_ARF_STD,
80 KF_STD,
Urvang Joshi7a890232019-03-22 17:00:31 -070081 RATE_FACTOR_LEVELS
82} UENUM1BYTE(RATE_FACTOR_LEVEL);
83
Marco Paniconicea99e22019-07-16 18:36:31 -070084enum {
85 KF_UPDATE,
86 LF_UPDATE,
87 GF_UPDATE,
88 ARF_UPDATE,
89 OVERLAY_UPDATE,
90 INTNL_OVERLAY_UPDATE, // Internal Overlay Frame
91 INTNL_ARF_UPDATE, // Internal Altref Frame
92 FRAME_UPDATE_TYPES
93} UENUM1BYTE(FRAME_UPDATE_TYPE);
94
Jingning Hanf8420392020-08-20 14:42:08 -070095enum {
96 REFBUF_RESET, // Clear reference frame buffer
97 REFBUF_UPDATE, // Refresh reference frame buffer
98 REFBUF_STATES
99} UENUM1BYTE(REFBUF_STATE);
Jingning Hana77319b2020-08-09 23:10:44 -0700100
Marco Paniconi69e6dcc2020-07-20 14:19:20 -0700101typedef enum {
102 NO_RESIZE = 0,
103 DOWN_THREEFOUR = 1, // From orig to 3/4.
104 DOWN_ONEHALF = 2, // From orig or 3/4 to 1/2.
105 UP_THREEFOUR = -1, // From 1/2 to 3/4.
106 UP_ORIG = -2, // From 1/2 or 3/4 to orig.
107} RESIZE_ACTION;
108
109typedef enum { ORIG = 0, THREE_QUARTER = 1, ONE_HALF = 2 } RESIZE_STATE;
110
bohanli5c2c97d2020-09-24 11:59:32 -0700111#define MAX_FIRSTPASS_ANALYSIS_FRAMES 150
112typedef enum region_types {
113 STABLE_REGION = 0,
114 HIGH_VAR_REGION = 1,
115 SCENECUT_REGION = 2,
116 BLENDING_REGION = 3,
117} REGION_TYPES;
118
119typedef struct regions {
120 int start;
121 int last;
122 double avg_noise_var;
123 double avg_cor_coeff;
124 double avg_sr_fr_ratio;
125 double avg_intra_err;
126 double avg_coded_err;
127 REGION_TYPES type;
128} REGIONS;
129
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100130/*!\endcond */
131/*!
132 * \brief Rate Control parameters and status
133 */
Debargha Mukherjee7166f222017-09-05 21:32:42 -0700134typedef struct {
Yaowu Xuc27fc142016-08-22 16:08:15 -0700135 // Rate targetting variables
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100136
137 /*!
138 * Baseline target rate for frame before adjustment for previous under or
139 * over shoot.
140 */
141 int base_frame_target;
142 /*!
143 * Target rate for frame after adjustment for previous under or over shoot.
144 */
Yaowu Xuc27fc142016-08-22 16:08:15 -0700145 int this_frame_target; // Actual frame target after rc adjustment.
Jingning Han2eedec52020-02-05 10:33:43 -0800146
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100147 /*!
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100148 * Projected size for current frame
149 */
Yaowu Xuc27fc142016-08-22 16:08:15 -0700150 int projected_frame_size;
Yaowu Xuc27fc142016-08-22 16:08:15 -0700151
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100152 /*!
Cheng Chen8e74aaf2020-08-24 21:07:12 -0700153 * Bit size of transform coefficient for current frame.
154 */
155 int coefficient_size;
156
157 /*!
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100158 * Super block rate target used with some adaptive quantization strategies.
159 */
160 int sb64_target_rate;
161
162 /*!
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100163 * Number of frames since the last ARF / GF.
164 */
Yaowu Xuc27fc142016-08-22 16:08:15 -0700165 int frames_since_golden;
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100166
167 /*!
168 * Number of frames till the next ARF / GF is due.
169 */
Yaowu Xuc27fc142016-08-22 16:08:15 -0700170 int frames_till_gf_update_due;
bohanlia964eea2020-02-13 11:48:00 -0800171
Paul Wilkins1fb01722020-07-07 17:45:46 +0100172 /*!
173 * Number of determined gf groups left
174 */
bohanlia964eea2020-02-13 11:48:00 -0800175 int intervals_till_gf_calculate_due;
Paul Wilkins1fb01722020-07-07 17:45:46 +0100176
Paul Wilkins1fb01722020-07-07 17:45:46 +0100177 /*!\cond */
Yaowu Xuc27fc142016-08-22 16:08:15 -0700178 int min_gf_interval;
179 int max_gf_interval;
180 int static_scene_max_gf_interval;
Paul Wilkins1fb01722020-07-07 17:45:46 +0100181 /*!\endcond */
182 /*!
183 * Frames before the next key frame
184 */
Yaowu Xuc27fc142016-08-22 16:08:15 -0700185 int frames_to_key;
Paul Wilkins1fb01722020-07-07 17:45:46 +0100186 /*!\cond */
Yaowu Xuc27fc142016-08-22 16:08:15 -0700187 int frames_since_key;
Jingning Hanc7c31d12021-06-23 09:56:22 -0700188 int frames_to_fwd_kf;
Yaowu Xuc27fc142016-08-22 16:08:15 -0700189 int is_src_frame_alt_ref;
Urvang Joshi6ce7fbc2019-03-22 15:24:21 -0700190 int sframe_due;
Yaowu Xuc27fc142016-08-22 16:08:15 -0700191
Jerome Jiang854f9682020-04-03 15:15:33 -0700192 int high_source_sad;
193 uint64_t avg_source_sad;
Marco Paniconi482293b2020-05-01 10:56:13 -0700194 uint64_t prev_avg_source_sad;
Marco Paniconie591c6b2022-01-19 12:31:32 -0800195 uint64_t frame_source_sad;
Jerome Jiang854f9682020-04-03 15:15:33 -0700196
Yaowu Xuc27fc142016-08-22 16:08:15 -0700197 int avg_frame_bandwidth; // Average frame size target for clip
198 int min_frame_bandwidth; // Minimum allocation used for any frame
199 int max_frame_bandwidth; // Maximum burst rate allowed for a frame.
Marco Paniconifb4e6e52019-11-22 11:44:42 -0800200 int prev_avg_frame_bandwidth;
Yaowu Xuc27fc142016-08-22 16:08:15 -0700201
202 int ni_av_qi;
203 int ni_tot_qi;
Yaowu Xuc27fc142016-08-22 16:08:15 -0700204
Yaowu Xuc27fc142016-08-22 16:08:15 -0700205 int decimation_factor;
206 int decimation_count;
Marco Paniconi6154a1e2023-06-14 14:42:41 -0700207 int prev_frame_is_dropped;
Marco Paniconi5c46a342023-10-23 14:40:00 -0700208 int drop_count_consec;
209 int max_consec_drop;
Yaowu Xuc27fc142016-08-22 16:08:15 -0700210
Marco Paniconi233000f2023-06-12 15:10:54 -0700211 /*!
212 * Frame number for encoded frames (non-dropped).
213 * Use for setting the rtc reference structure.
214 */
215 unsigned int frame_number_encoded;
216
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100217 /*!\endcond */
218 /*!
219 * User specified maximum Q allowed for current frame
220 */
Yaowu Xuc27fc142016-08-22 16:08:15 -0700221 int worst_quality;
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100222 /*!
223 * User specified minimum Q allowed for current frame
224 */
Yaowu Xuc27fc142016-08-22 16:08:15 -0700225 int best_quality;
226
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100227 /*!\cond */
Yaowu Xuc27fc142016-08-22 16:08:15 -0700228
229 // rate control history for last frame(1) and the frame before(2).
Yunqing Wang89de3d52022-01-12 15:48:29 -0800230 // -1: overshoot
231 // 1: undershoot
Yaowu Xuc27fc142016-08-22 16:08:15 -0700232 // 0: not initialized.
233 int rc_1_frame;
234 int rc_2_frame;
235 int q_1_frame;
236 int q_2_frame;
237
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100238 /*!\endcond */
239 /*!
Paul Wilkinsff3923f2022-08-22 17:16:03 +0100240 * Proposed maximum allowed Q for current frame
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100241 */
Sarah Parkere1b22012019-06-06 16:35:25 -0700242 int active_worst_quality;
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100243
244 /*!\cond */
Fyodor Kyslov34b591f2020-06-24 20:13:58 -0700245 // Track amount of low motion in scene
246 int avg_frame_low_motion;
Marco Paniconi60e4e242022-07-24 23:32:02 -0700247 int cnt_zeromv;
Marco Paniconi69e6dcc2020-07-20 14:19:20 -0700248
Fyodor Kyslove76a05b2022-01-31 13:46:38 -0800249 // signals if number of blocks with motion is high
Marco Paniconi03b2ff92022-09-21 23:24:15 -0700250 int percent_blocks_with_motion;
251
252 // Maximum value of source sad across all blocks of frame.
253 uint64_t max_block_source_sad;
Fyodor Kyslove76a05b2022-01-31 13:46:38 -0800254
Marco Paniconi69e6dcc2020-07-20 14:19:20 -0700255 // For dynamic resize, 1 pass cbr.
256 RESIZE_STATE resize_state;
257 int resize_avg_qp;
258 int resize_buffer_underflow;
259 int resize_count;
Jerome Jiang089794f2021-11-18 12:30:37 -0800260
261 // Flag to disable content related qp adjustment.
262 int rtc_external_ratectrl;
Remya Prakasanfcfd50e2022-03-09 20:57:28 +0530263
264 // Stores fast_extra_bits of the current frame.
Aasaipriyae0da0852021-05-31 18:37:37 +0530265 int frame_level_fast_extra_bits;
Nithya V S56a23622022-05-10 11:32:43 +0530266
Aasaipriya87e4abc2021-06-07 19:20:00 +0530267 double frame_level_rate_correction_factors[RATE_FACTOR_LEVELS];
Marco Paniconi503c5e32022-10-13 13:47:32 -0700268
269 int frame_num_last_gf_refresh;
Marco Paniconibee1cad2022-11-28 14:25:08 -0800270
271 int prev_coded_width;
272 int prev_coded_height;
Yunqing Wangc964a812022-12-01 20:08:16 -0800273
274 // The ratio used for inter frames in bit estimation.
275 // TODO(yunqing): if golden frame is treated differently (e.g. gf_cbr_boost_
276 // pct > THR), consider to add bit_est_ratio_g for golden frames.
277 int bit_est_ratio;
Jerome Jiang706ee362023-01-25 13:37:57 -0500278
Wan-Teh Chang323fa022023-03-01 15:28:58 -0800279 // Whether to use a fixed qp for the frame, bypassing internal rate control.
Jerome Jiang706ee362023-01-25 13:37:57 -0500280 // This flag will reset to 0 after every frame.
281 int use_external_qp_one_pass;
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100282 /*!\endcond */
Yaowu Xuc27fc142016-08-22 16:08:15 -0700283} RATE_CONTROL;
284
Mufaddal Chakera94ee9bf2021-04-12 01:02:22 +0530285/*!
286 * \brief Primary Rate Control parameters and status
287 */
288typedef struct {
289 // Sub-gop level Rate targetting variables
290
291 /*!
292 * Target bit budget for the current GF / ARF group of frame.
293 */
294 int64_t gf_group_bits;
295
296 /*!
297 * Boost factor used to calculate the extra bits allocated to the key frame
298 */
299 int kf_boost;
300
301 /*!
302 * Boost factor used to calculate the extra bits allocated to ARFs and GFs
303 */
304 int gfu_boost;
305
306 /*!
307 * Stores the determined gf group lengths for a set of gf groups
308 */
309 int gf_intervals[MAX_NUM_GF_INTERVALS];
310
311 /*!
312 * The current group's index into gf_intervals[]
313 */
314 int cur_gf_index;
315
316 /*!\cond */
317 int num_regions;
318
319 REGIONS regions[MAX_FIRSTPASS_ANALYSIS_FRAMES];
320 int regions_offset; // offset of regions from the last keyframe
321 int frames_till_regions_update;
322
323 int baseline_gf_interval;
324
325 int constrained_gf_group;
326
327 int this_key_frame_forced;
328
329 int next_key_frame_forced;
330 /*!\endcond */
331
332 /*!
333 * Initial buffuer level in ms for CBR / low delay encoding
334 */
335 int64_t starting_buffer_level;
336
337 /*!
338 * Optimum / target buffuer level in ms for CBR / low delay encoding
339 */
340 int64_t optimal_buffer_level;
341
342 /*!
343 * Maximum target buffuer level in ms for CBR / low delay encoding
344 */
345 int64_t maximum_buffer_size;
346
347 /*!
348 * Q index used for ALT frame
349 */
350 int arf_q;
351
352 /*!\cond */
353 float_t arf_boost_factor;
354
355 int base_layer_qp;
356
357 // Total number of stats used only for kf_boost calculation.
358 int num_stats_used_for_kf_boost;
359
360 // Total number of stats used only for gfu_boost calculation.
361 int num_stats_used_for_gfu_boost;
362
363 // Total number of stats required by gfu_boost calculation.
364 int num_stats_required_for_gfu_boost;
365
Mufaddal Chakera94ee9bf2021-04-12 01:02:22 +0530366 int enable_scenecut_detection;
367
368 int use_arf_in_this_kf_group;
Remya Prakasan2c355282021-07-08 13:27:48 +0530369
370 int ni_frames;
371
372 double tot_q;
Mufaddal Chakera94ee9bf2021-04-12 01:02:22 +0530373 /*!\endcond */
374
375 /*!
376 * Q used for last boosted (non leaf) frame
377 */
378 int last_kf_qindex;
Aasaipriyacdfcf172021-06-05 16:40:57 +0530379
Tarundeep Singh5d03ed32021-06-23 19:23:19 +0530380 /*!
381 * Average of q index of previous encoded frames in a sequence.
382 */
383 int avg_frame_qindex[FRAME_TYPES];
384
Remya Prakasanffeb4972022-06-21 20:00:28 +0530385#if CONFIG_FPMT_TEST
Remya Prakasan6566bc82021-11-05 23:21:12 +0530386 /*!
387 * Temporary variable used in simulating the delayed update of
388 * active_best_quality.
389 */
390 int temp_active_best_quality[MAX_ARF_LAYERS + 1];
391
392 /*!
393 * Temporary variable used in simulating the delayed update of
394 * last_boosted_qindex.
395 */
396 int temp_last_boosted_qindex;
397
398 /*!
399 * Temporary variable used in simulating the delayed update of
400 * avg_q.
401 */
402 double temp_avg_q;
403
404 /*!
405 * Temporary variable used in simulating the delayed update of
406 * last_q.
407 */
408 int temp_last_q[FRAME_TYPES];
409
410 /*!
411 * Temporary variable used in simulating the delayed update of
412 * projected_frame_size.
413 */
414 int temp_projected_frame_size;
415
416 /*!
417 * Temporary variable used in simulating the delayed update of
418 * total_actual_bits.
419 */
420 int64_t temp_total_actual_bits;
421
422 /*!
423 * Temporary variable used in simulating the delayed update of
424 * buffer_level.
425 */
426 int64_t temp_buffer_level;
427
428 /*!
429 * Temporary variable used in simulating the delayed update of
430 * vbr_bits_off_target.
431 */
432 int64_t temp_vbr_bits_off_target;
433
434 /*!
435 * Temporary variable used in simulating the delayed update of
436 * vbr_bits_off_target_fast.
437 */
438 int64_t temp_vbr_bits_off_target_fast;
439
440 /*!
441 * Temporary variable used in simulating the delayed update of
442 * rate_correction_factors.
443 */
444 double temp_rate_correction_factors[RATE_FACTOR_LEVELS];
445
446 /*!
447 * Temporary variable used in simulating the delayed update of
448 * rate_error_estimate.
449 */
450 int temp_rate_error_estimate;
451
452 /*!
453 * Temporary variable used in simulating the delayed update of
454 * rolling_arf_group_target_bits.
455 */
456 int temp_rolling_arf_group_target_bits;
457
458 /*!
459 * Temporary variable used in simulating the delayed update of
460 * rolling_arf_group_actual_bits;.
461 */
462 int temp_rolling_arf_group_actual_bits;
463
464 /*!
465 * Temporary variable used in simulating the delayed update of
466 * bits_left;.
467 */
468 int64_t temp_bits_left;
469
470 /*!
471 * Temporary variable used in simulating the delayed update of
472 * extend_minq.
473 */
474 int temp_extend_minq;
475
476 /*!
477 * Temporary variable used in simulating the delayed update of
478 * extend_maxq.
479 */
480 int temp_extend_maxq;
481
Remya Prakasan6566bc82021-11-05 23:21:12 +0530482#endif
Aasaipriyac6f0a0b2021-08-12 11:27:03 +0530483 /*!
484 * Proposed minimum allowed Q different layers in a coding pyramid
485 */
486 int active_best_quality[MAX_ARF_LAYERS + 1];
487
488 /*!
489 * Q used for last boosted (non leaf) frame (GF/KF/ARF)
490 */
491 int last_boosted_qindex;
492
493 /*!
494 * Average Q value of previous inter frames
495 */
496 double avg_q;
497
498 /*!
499 * Q used on last encoded frame of the given type.
500 */
501 int last_q[FRAME_TYPES];
Aasaipriyae0da0852021-05-31 18:37:37 +0530502
503 /*!
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530504 * Correction factors used to adjust the q estimate for a given target rate
505 * in the encode loop.
Aasaipriyae0da0852021-05-31 18:37:37 +0530506 */
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530507 double rate_correction_factors[RATE_FACTOR_LEVELS];
Aasaipriyae0da0852021-05-31 18:37:37 +0530508
509 /*!
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530510 * Current total consumed bits.
Aasaipriyae0da0852021-05-31 18:37:37 +0530511 */
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530512 int64_t total_actual_bits;
Aasaipriyae0da0852021-05-31 18:37:37 +0530513
514 /*!
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530515 * Current total target bits.
Aasaipriyae0da0852021-05-31 18:37:37 +0530516 */
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530517 int64_t total_target_bits;
Aasaipriyae0da0852021-05-31 18:37:37 +0530518
519 /*!
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530520 * Current buffer level.
Aasaipriyae0da0852021-05-31 18:37:37 +0530521 */
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530522 int64_t buffer_level;
Aasaipriyae0da0852021-05-31 18:37:37 +0530523
524 /*!
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530525 * PCT rc error.
Aasaipriyae0da0852021-05-31 18:37:37 +0530526 */
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530527 int rate_error_estimate;
Aasaipriyae0da0852021-05-31 18:37:37 +0530528
529 /*!
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530530 * Error bits available from previously encoded frames.
Aasaipriyae0da0852021-05-31 18:37:37 +0530531 */
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530532 int64_t vbr_bits_off_target;
Aasaipriyae0da0852021-05-31 18:37:37 +0530533
534 /*!
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530535 * Error bits available from previously encoded frames undershoot.
Aasaipriyae0da0852021-05-31 18:37:37 +0530536 */
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530537 int64_t vbr_bits_off_target_fast;
Aasaipriyae0da0852021-05-31 18:37:37 +0530538
539 /*!
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530540 * Total bits deviated from the average frame target, from previously
541 * encoded frames.
Aasaipriyae0da0852021-05-31 18:37:37 +0530542 */
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530543 int64_t bits_off_target;
Aasaipriyabf0417d2021-08-12 11:34:14 +0530544
545 /*!
546 * Rolling monitor target bits updated based on current frame target size.
547 */
548 int rolling_target_bits;
549
550 /*!
551 * Rolling monitor actual bits updated based on current frame final projected
552 * size.
553 */
554 int rolling_actual_bits;
Cheng Chen3e353752022-04-01 16:36:37 -0700555
556 /*!
557 * The history of qindex for each frame.
558 * Only used when RT_PASSIVE_STRATEGY = 1.
559 */
560 int q_history[MAX_Q_HISTORY];
Mufaddal Chakera94ee9bf2021-04-12 01:02:22 +0530561} PRIMARY_RATE_CONTROL;
Paul Wilkinse8c76eb2020-06-30 17:24:11 +0100562
Wan-Teh Chang4d422742022-08-22 13:37:11 -0700563/*!\cond */
564
Yaowu Xuf883b422016-08-30 14:01:10 -0700565struct AV1_COMP;
566struct AV1EncoderConfig;
Kavi Ramamurthy291ef252021-06-09 17:07:30 +0000567struct GF_GROUP;
Yaowu Xuc27fc142016-08-22 16:08:15 -0700568
Mufaddal Chakera94ee9bf2021-04-12 01:02:22 +0530569void av1_primary_rc_init(const struct AV1EncoderConfig *oxcf,
570 PRIMARY_RATE_CONTROL *p_rc);
571
Aasaipriya65e5e9e2021-08-12 11:31:27 +0530572void av1_rc_init(const struct AV1EncoderConfig *oxcf, RATE_CONTROL *rc);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700573
Yunqing Wang1ff889c2022-11-07 15:24:29 -0800574int av1_estimate_bits_at_q(const struct AV1_COMP *cpi, int q,
575 double correction_factor);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700576
Yaowu Xuf883b422016-08-30 14:01:10 -0700577double av1_convert_qindex_to_q(int qindex, aom_bit_depth_t bit_depth);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700578
Yaowu Xuf883b422016-08-30 14:01:10 -0700579void av1_rc_init_minq_luts(void);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700580
Yaowu Xuf883b422016-08-30 14:01:10 -0700581int av1_rc_get_default_min_gf_interval(int width, int height, double framerate);
582// Note av1_rc_get_default_max_gf_interval() requires the min_gf_interval to
Yaowu Xuc27fc142016-08-22 16:08:15 -0700583// be passed in to ensure that the max_gf_interval returned is at least as bis
584// as that.
Urvang Joshi2abb7722019-03-19 14:28:37 -0700585int av1_rc_get_default_max_gf_interval(double framerate, int min_gf_interval);
Urvang Joshif4e775c2018-12-14 11:33:17 -0800586
Yaowu Xuc27fc142016-08-22 16:08:15 -0700587// Generally at the high level, the following flow is expected
588// to be enforced for rate control:
589// First call per frame, one of:
Mark Wachsler389f2672022-02-02 07:26:12 -0800590// av1_get_one_pass_rt_params()
591// av1_get_second_pass_params()
Yaowu Xuc27fc142016-08-22 16:08:15 -0700592// depending on the usage to set the rate control encode parameters desired.
593//
594// Then, call encode_frame_to_data_rate() to perform the
595// actual encode. This function will in turn call encode_frame()
Tarundeep Singh249a8672021-06-10 15:40:43 +0530596// one or more times, followed by:
Yaowu Xuf883b422016-08-30 14:01:10 -0700597// av1_rc_postencode_update_drop_frame()
Yaowu Xuc27fc142016-08-22 16:08:15 -0700598//
599// The majority of rate control parameters are only expected
Mark Wachsler389f2672022-02-02 07:26:12 -0800600// to be set in the av1_get_..._params() functions and
Yaowu Xuf883b422016-08-30 14:01:10 -0700601// updated during the av1_rc_postencode_update...() functions.
602// The only exceptions are av1_rc_drop_frame() and
603// av1_rc_update_rate_correction_factors() functions.
Yaowu Xuc27fc142016-08-22 16:08:15 -0700604
605// Functions to set parameters for encoding before the actual
606// encode_frame_to_data_rate() function.
Ranjit Kumar Tulabandud10be502022-08-08 16:45:06 +0530607struct EncodeFrameInput;
Yaowu Xuc27fc142016-08-22 16:08:15 -0700608
609// Post encode update of the rate control parameters based
610// on bytes used
Yaowu Xuf883b422016-08-30 14:01:10 -0700611void av1_rc_postencode_update(struct AV1_COMP *cpi, uint64_t bytes_used);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700612// Post encode update of the rate control parameters for dropped frames
Yaowu Xuf883b422016-08-30 14:01:10 -0700613void av1_rc_postencode_update_drop_frame(struct AV1_COMP *cpi);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700614
Paul Wilkins5ce9d502020-07-16 17:58:40 +0100615/*!\endcond */
616/*!\brief Updates the rate correction factor linking Q to output bits
617 *
618 * This function updates the Q rate correction factor after an encode
619 * cycle depending on whether we overshot or undershot the target rate.
620 *
621 * \ingroup rate_control
622 * \param[in] cpi Top level encoder instance structure
Nithya V S3ce203a2022-01-20 17:46:09 +0530623 * \param[in] is_encode_stage Indicates if recode loop or post-encode
Paul Wilkins5ce9d502020-07-16 17:58:40 +0100624 * \param[in] width Frame width
625 * \param[in] height Frame height
626 *
Wan-Teh Chang0defff82022-08-23 14:17:01 -0700627 * \remark Updates the relevant rate correction factor in cpi->rc
Paul Wilkins5ce9d502020-07-16 17:58:40 +0100628 */
Aasaipriya87e4abc2021-06-07 19:20:00 +0530629void av1_rc_update_rate_correction_factors(struct AV1_COMP *cpi,
Nithya V S3ce203a2022-01-20 17:46:09 +0530630 int is_encode_stage, int width,
631 int height);
Paul Wilkins5ce9d502020-07-16 17:58:40 +0100632/*!\cond */
Yaowu Xuc27fc142016-08-22 16:08:15 -0700633
634// Decide if we should drop this frame: For 1-pass CBR.
635// Changes only the decimation count in the rate control structure
Yaowu Xuf883b422016-08-30 14:01:10 -0700636int av1_rc_drop_frame(struct AV1_COMP *cpi);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700637
638// Computes frame size bounds.
Yaowu Xuf883b422016-08-30 14:01:10 -0700639void av1_rc_compute_frame_size_bounds(const struct AV1_COMP *cpi,
640 int this_frame_target,
641 int *frame_under_shoot_limit,
642 int *frame_over_shoot_limit);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700643
Urvang Joshifee52c62020-06-17 13:45:55 -0700644/*!\endcond */
645
646/*!\brief Picks q and q bounds given the rate control parameters in \c cpi->rc.
647 *
648 * \ingroup rate_control
649 * \param[in] cpi Top level encoder structure
Urvang Joshifee52c62020-06-17 13:45:55 -0700650 * \param[in] width Coded frame width
651 * \param[in] height Coded frame height
652 * \param[in] gf_index Index of this frame in the golden frame group
653 * \param[out] bottom_index Bottom bound for q index (best quality)
654 * \param[out] top_index Top bound for q index (worst quality)
655 * \return Returns selected q index to be used for encoding this frame.
656 * Also, updates \c rc->arf_q.
657 */
Paul Wilkinsff3923f2022-08-22 17:16:03 +0100658int av1_rc_pick_q_and_bounds(struct AV1_COMP *cpi, int width, int height,
Mufaddal Chakera94ee9bf2021-04-12 01:02:22 +0530659 int gf_index, int *bottom_index, int *top_index);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700660
Paul Wilkins5ce9d502020-07-16 17:58:40 +0100661/*!\brief Estimates q to achieve a target bits per frame
662 *
663 * \ingroup rate_control
664 * \param[in] cpi Top level encoder instance structure
665 * \param[in] target_bits_per_frame Frame rate target
666 * \param[in] active_worst_quality Max Q allowed
667 * \param[in] active_best_quality Min Q allowed
668 * \param[in] width Frame width
669 * \param[in] height Frame height
670 *
671 * \return Returns a q index value
672 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700673int av1_rc_regulate_q(const struct AV1_COMP *cpi, int target_bits_per_frame,
Debargha Mukherjee7166f222017-09-05 21:32:42 -0700674 int active_best_quality, int active_worst_quality,
675 int width, int height);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700676
Paul Wilkins5ce9d502020-07-16 17:58:40 +0100677/*!\cond */
Paul Wilkins418ba432022-11-14 13:07:45 +0000678// Gets the appropriate bpmb ennumerator based on the frame and content type
679int av1_get_bpmb_enumerator(FRAME_TYPE frame_type,
680 const int is_screen_content_type);
681
Yaowu Xuc27fc142016-08-22 16:08:15 -0700682// Estimates bits per mb for a given qindex and correction factor.
Yunqing Wang6d9cd9c2022-11-07 16:18:16 -0800683int av1_rc_bits_per_mb(const struct AV1_COMP *cpi, FRAME_TYPE frame_type,
684 int qindex, double correction_factor,
685 int accurate_estimate);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700686
687// Clamping utilities for bitrate targets for iframes and pframes.
Yaowu Xuf883b422016-08-30 14:01:10 -0700688int av1_rc_clamp_iframe_target_size(const struct AV1_COMP *const cpi,
Jerome Jiangee1ed1c2022-03-08 08:22:50 -0800689 int64_t target);
Yaowu Xuf883b422016-08-30 14:01:10 -0700690int av1_rc_clamp_pframe_target_size(const struct AV1_COMP *const cpi,
David Turner4f1f1812019-01-24 17:00:24 +0000691 int target, uint8_t frame_update_type);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700692
Urvang Joshi1765dd02019-02-08 10:26:00 -0800693// Find q_index corresponding to desired_q, within [best_qindex, worst_qindex].
694// To be precise, 'q_index' is the smallest integer, for which the corresponding
695// q >= desired_q.
696// If no such q index is found, returns 'worst_qindex'.
697int av1_find_qindex(double desired_q, aom_bit_depth_t bit_depth,
698 int best_qindex, int worst_qindex);
699
Yaowu Xuc27fc142016-08-22 16:08:15 -0700700// Computes a q delta (in "q index" terms) to get from a starting q value
701// to a target q value
Yaowu Xuf883b422016-08-30 14:01:10 -0700702int av1_compute_qdelta(const RATE_CONTROL *rc, double qstart, double qtarget,
703 aom_bit_depth_t bit_depth);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700704
705// Computes a q delta (in "q index" terms) to get from a starting q value
706// to a value that should equate to the given rate ratio.
Yunqing Wang97237792022-11-07 15:55:30 -0800707int av1_compute_qdelta_by_rate(const struct AV1_COMP *cpi,
708 FRAME_TYPE frame_type, int qindex,
709 double rate_target_ratio);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700710
Urvang Joshi7a890232019-03-22 17:00:31 -0700711int av1_frame_type_qdelta(const struct AV1_COMP *cpi, int q);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700712
Debargha Mukherjee7166f222017-09-05 21:32:42 -0700713void av1_rc_update_framerate(struct AV1_COMP *cpi, int width, int height);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700714
Yaowu Xuf883b422016-08-30 14:01:10 -0700715void av1_rc_set_gf_interval_range(const struct AV1_COMP *const cpi,
716 RATE_CONTROL *const rc);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700717
Debargha Mukherjee7166f222017-09-05 21:32:42 -0700718void av1_set_target_rate(struct AV1_COMP *cpi, int width, int height);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700719
Yaowu Xuf883b422016-08-30 14:01:10 -0700720int av1_resize_one_pass_cbr(struct AV1_COMP *cpi);
Yaowu Xuc27fc142016-08-22 16:08:15 -0700721
Sarah Parker97803fc2019-05-17 14:15:37 -0700722void av1_rc_set_frame_target(struct AV1_COMP *cpi, int target, int width,
723 int height);
724
Marco Paniconi6868fb42021-09-08 22:47:26 -0700725void av1_adjust_gf_refresh_qp_one_pass_rt(struct AV1_COMP *cpi);
726
Marco Paniconi1a3a74a2022-08-28 22:26:48 -0700727void av1_set_rtc_reference_structure_one_layer(struct AV1_COMP *cpi,
728 int gf_update);
Jingning Han3f3318f2020-08-16 16:12:10 -0700729
Paul Wilkins83cfad42020-06-26 12:38:07 +0100730/*!\endcond */
731/*!\brief Calculates how many bits to use for a P frame in one pass vbr
732 *
733 * \ingroup rate_control
734 * \callgraph
735 * \callergraph
736 *
737 * \param[in] cpi Top level encoder structure
738 * \param[in] frame_update_type Type of frame
739 *
740 * \return Returns the target number of bits for this frame.
741 */
Marco Paniconicea99e22019-07-16 18:36:31 -0700742int av1_calc_pframe_target_size_one_pass_vbr(
743 const struct AV1_COMP *const cpi, FRAME_UPDATE_TYPE frame_update_type);
744
Paul Wilkins83cfad42020-06-26 12:38:07 +0100745/*!\brief Calculates how many bits to use for an i frame in one pass vbr
746 *
747 * \ingroup rate_control
748 * \callgraph
749 * \callergraph
750 *
751 * \param[in] cpi Top level encoder structure
752 *
753 * \return Returns the target number of bits for this frame.
754 */
Marco Paniconicea99e22019-07-16 18:36:31 -0700755int av1_calc_iframe_target_size_one_pass_vbr(const struct AV1_COMP *const cpi);
756
Marco Paniconidd0fa452020-07-07 12:04:32 -0700757/*!\brief Calculates how many bits to use for a P frame in one pass cbr
758 *
759 * \ingroup rate_control
760 * \callgraph
761 * \callergraph
762 *
763 * \param[in] cpi Top level encoder structure
764 * \param[in] frame_update_type Type of frame
765 *
766 * \return Returns the target number of bits for this frame.
767 */
Marco Paniconicea99e22019-07-16 18:36:31 -0700768int av1_calc_pframe_target_size_one_pass_cbr(
769 const struct AV1_COMP *cpi, FRAME_UPDATE_TYPE frame_update_type);
770
Marco Paniconidd0fa452020-07-07 12:04:32 -0700771/*!\brief Calculates how many bits to use for an i frame in one pass cbr
772 *
773 * \ingroup rate_control
774 * \callgraph
775 * \callergraph
776 *
777 * \param[in] cpi Top level encoder structure
778 *
779 * \return Returns the target number of bits for this frame.
780 */
Marco Paniconicea99e22019-07-16 18:36:31 -0700781int av1_calc_iframe_target_size_one_pass_cbr(const struct AV1_COMP *cpi);
782
Marco Paniconidd0fa452020-07-07 12:04:32 -0700783/*!\brief Setup the rate control parameters for 1 pass real-time mode.
784 *
785 * - Sets the frame type and target frame size.
786 * - Sets the GF update.
787 * - Checks for scene change.
788 * - Sets the reference prediction structure for 1 layers (non-SVC).
789 * - Resets and updates are done for SVC.
790 *
791 * \ingroup rate_control
792 * \param[in] cpi Top level encoder structure
Wan-Teh Chang5529fda2022-09-02 11:31:17 -0700793 * \param[in] frame_type Encoder frame type
Ranjit Kumar Tulabandud10be502022-08-08 16:45:06 +0530794 * \param[in] frame_input Current and last input source frames
Wan-Teh Chang5529fda2022-09-02 11:31:17 -0700795 * \param[in] frame_flags Encoder frame flags
Marco Paniconidd0fa452020-07-07 12:04:32 -0700796 *
Wan-Teh Chang0defff82022-08-23 14:17:01 -0700797 * \remark Nothing is returned. Instead the settings computed in this
Wan-Teh Changc7812582022-08-23 20:17:34 -0700798 * function are set in: \c frame_params, \c cpi->common, \c cpi->rc,
799 * \c cpi->svc.
Marco Paniconidd0fa452020-07-07 12:04:32 -0700800 */
Marco Paniconicea99e22019-07-16 18:36:31 -0700801void av1_get_one_pass_rt_params(struct AV1_COMP *cpi,
Wan-Teh Chang5529fda2022-09-02 11:31:17 -0700802 FRAME_TYPE *const frame_type,
Ranjit Kumar Tulabandud10be502022-08-08 16:45:06 +0530803 const struct EncodeFrameInput *frame_input,
Marco Paniconicea99e22019-07-16 18:36:31 -0700804 unsigned int frame_flags);
805
Marco Paniconidd0fa452020-07-07 12:04:32 -0700806/*!\brief Increase q on expected encoder overshoot, for CBR mode.
807 *
808 * Handles the case when encoder is expected to create a large frame:
809 * - q is increased to value closer to \c cpi->rc.worst_quality
810 * - avg_frame_qindex is reset
811 * - buffer levels are reset
812 * - rate correction factor is adjusted
813 *
814 * \ingroup rate_control
815 * \param[in] cpi Top level encoder structure
816 * \param[in] q Current q index
817 *
818 * \return q is returned, and updates are done to \c cpi->rc.
819 */
820int av1_encodedframe_overshoot_cbr(struct AV1_COMP *cpi, int *q);
Urvang Joshifee52c62020-06-17 13:45:55 -0700821
Kavi Ramamurthy79046732021-06-11 20:25:00 +0000822/*!\brief Compute the q_indices for a single frame.
823 *
824 * Intended to be used with AOM_Q mode.
825 *
826 * \param[in] base_q_index Base q index
827 * \param[in] gf_update_type GOP update type
828 * \param[in] gf_pyramid_level GOP level of the current frame
829 * \param[in] arf_q ARF q_index
830 *
831 * \return Returns the q_index for the current frame.
832 */
833int av1_q_mode_get_q_index(int base_q_index, int gf_update_type,
834 int gf_pyramid_level, int arf_q);
835
836/*!\brief Compute the q_indices for the ARF of a GOP.
837 *
838 * \param[in] base_q_index Base q index
839 * \param[in] gfu_boost GFU boost
840 * \param[in] bit_depth Bit depth
841 * \param[in] arf_boost_factor ARF boost factor
842 *
843 * \return Returns the q_index for the ARF frame.
844 */
845int av1_get_arf_q_index(int base_q_index, int gfu_boost, int bit_depth,
846 double arf_boost_factor);
847
Jingning Han16579342021-05-12 00:02:01 -0700848#if !CONFIG_REALTIME_ONLY
Kavi Ramamurthy99bc51c2021-09-01 21:29:18 +0000849struct TplDepFrame;
Jingning Han16579342021-05-12 00:02:01 -0700850/*!\brief Compute the q_indices for the ARF of a GOP in Q mode.
851 *
852 * \param[in] cpi Top level encoder structure
853 * \param[in] tpl_frame Tpl Frame stats
854 *
855 * \return Returns the q_index for the ARF frame.
856 */
857int av1_get_arf_q_index_q_mode(struct AV1_COMP *cpi,
858 struct TplDepFrame *tpl_frame);
859#endif
Yaowu Xuc27fc142016-08-22 16:08:15 -0700860#ifdef __cplusplus
861} // extern "C"
862#endif
863
James Zerne1cbb132018-08-22 14:10:36 -0700864#endif // AOM_AV1_ENCODER_RATECTRL_H_