AOMedia AV1 Codec: av1/encoder/ratectrl.h Source File

| AOMedia AV1 Codec

ratectrl.h
1/*
2 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
3 *
4 * 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.
10 */
11
12#ifndef AOM_AV1_ENCODER_RATECTRL_H_
13#define AOM_AV1_ENCODER_RATECTRL_H_
14
15#include "aom/aom_codec.h"
16#include "aom/aom_integer.h"
17
18#include "aom_ports/mem.h"
19
20#include "av1/common/av1_common_int.h"
21#include "av1/common/blockd.h"
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
29// Bits Per MB at different Q (Multiplied by 512)
30#define BPER_MB_NORMBITS 9
31
32// Use this macro to turn on/off use of alt-refs in one-pass mode.
33#define USE_ALTREF_FOR_ONE_PASS 1
34
35// 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
44#define MIN_GF_INTERVAL 4
45#define MAX_GF_INTERVAL 32
46#define FIXED_GF_INTERVAL 16
47#define MAX_GF_LENGTH_LAP 16
48
49#define FIXED_GF_INTERVAL_RT 80
50#define MAX_GF_INTERVAL_RT 160
51
52#define MAX_NUM_GF_INTERVALS 15
53
54#define MAX_ARF_LAYERS 6
55// #define STRICT_RC
56
57typedef struct {
58 int resize_width;
59 int resize_height;
60 uint8_t superres_denom;
61} size_params_type;
62
63enum {
64 INTER_NORMAL,
65 GF_ARF_LOW,
66 GF_ARF_STD,
67 KF_STD,
68 RATE_FACTOR_LEVELS
69} UENUM1BYTE(RATE_FACTOR_LEVEL);
70
71enum {
72 KF_UPDATE,
73 LF_UPDATE,
74 GF_UPDATE,
75 ARF_UPDATE,
76 OVERLAY_UPDATE,
77 INTNL_OVERLAY_UPDATE, // Internal Overlay Frame
78 INTNL_ARF_UPDATE, // Internal Altref Frame
79 FRAME_UPDATE_TYPES
80} UENUM1BYTE(FRAME_UPDATE_TYPE);
81
82enum {
83 REFBUF_RESET, // Clear reference frame buffer
84 REFBUF_UPDATE, // Refresh reference frame buffer
85 REFBUF_STATES
86} UENUM1BYTE(REFBUF_STATE);
87
88typedef enum {
89 NO_RESIZE = 0,
90 DOWN_THREEFOUR = 1, // From orig to 3/4.
91 DOWN_ONEHALF = 2, // From orig or 3/4 to 1/2.
92 UP_THREEFOUR = -1, // From 1/2 to 3/4.
93 UP_ORIG = -2, // From 1/2 or 3/4 to orig.
94} RESIZE_ACTION;
95
96typedef enum { ORIG = 0, THREE_QUARTER = 1, ONE_HALF = 2 } RESIZE_STATE;
97
98#define MAX_FIRSTPASS_ANALYSIS_FRAMES 150
99typedef enum region_types {
100 STABLE_REGION = 0,
101 HIGH_VAR_REGION = 1,
102 SCENECUT_REGION = 2,
103 BLENDING_REGION = 3,
104} REGION_TYPES;
105
106typedef struct regions {
107 int start;
108 int last;
109 double avg_noise_var;
110 double avg_cor_coeff;
111 double avg_sr_fr_ratio;
112 double avg_intra_err;
113 double avg_coded_err;
114 REGION_TYPES type;
115} REGIONS;
116
121 typedef struct {
122 // Rate targetting variables
123
128 int base_frame_target;
132 int this_frame_target; // Actual frame target after rc adjustment.
133
137 int projected_frame_size;
138
142 int coefficient_size;
143
147 int sb64_target_rate;
148
152 int frames_since_golden;
153
157 int frames_till_gf_update_due;
158
162 int intervals_till_gf_calculate_due;
163
165 int min_gf_interval;
166 int max_gf_interval;
167 int static_scene_max_gf_interval;
172 int frames_to_key;
174 int frames_since_key;
175 int frames_to_fwd_kf;
176 int is_src_frame_alt_ref;
177 int sframe_due;
178
179 int high_source_sad;
180 uint64_t avg_source_sad;
181 uint64_t prev_avg_source_sad;
182
183 int avg_frame_bandwidth; // Average frame size target for clip
184 int min_frame_bandwidth; // Minimum allocation used for any frame
185 int max_frame_bandwidth; // Maximum burst rate allowed for a frame.
186 int prev_avg_frame_bandwidth;
187
188 int ni_av_qi;
189 int ni_tot_qi;
190
191 int decimation_factor;
192 int decimation_count;
193
198 int worst_quality;
202 int best_quality;
203
206 // rate control history for last frame(1) and the frame before(2).
207 // -1: undershot
208 // 1: overshoot
209 // 0: not initialized.
210 int rc_1_frame;
211 int rc_2_frame;
212 int q_1_frame;
213 int q_2_frame;
214
219 int active_worst_quality;
220
222 // Track amount of low motion in scene
223 int avg_frame_low_motion;
224
225 // For dynamic resize, 1 pass cbr.
226 RESIZE_STATE resize_state;
227 int resize_avg_qp;
228 int resize_buffer_underflow;
229 int resize_count;
230
231 // Flag to disable content related qp adjustment.
232 int rtc_external_ratectrl;
233#if CONFIG_FRAME_PARALLEL_ENCODE
234 int frame_level_fast_extra_bits;
235 double frame_level_rate_correction_factors[RATE_FACTOR_LEVELS];
236#endif
238} RATE_CONTROL;
239
243 typedef struct {
244 // Sub-gop level Rate targetting variables
245
249 int64_t gf_group_bits;
250
254 int kf_boost;
255
259 int gfu_boost;
260
264 int gf_intervals[MAX_NUM_GF_INTERVALS];
265
269 int cur_gf_index;
270
272 int num_regions;
273
274 REGIONS regions[MAX_FIRSTPASS_ANALYSIS_FRAMES];
275 int regions_offset; // offset of regions from the last keyframe
276 int frames_till_regions_update;
277
278 int baseline_gf_interval;
279
280 int constrained_gf_group;
281
282 int this_key_frame_forced;
283
284 int next_key_frame_forced;
290 int64_t starting_buffer_level;
291
295 int64_t optimal_buffer_level;
296
300 int64_t maximum_buffer_size;
301
305 int arf_q;
306
308 float_t arf_boost_factor;
309
310 int base_layer_qp;
311
312 // Total number of stats used only for kf_boost calculation.
313 int num_stats_used_for_kf_boost;
314
315 // Total number of stats used only for gfu_boost calculation.
316 int num_stats_used_for_gfu_boost;
317
318 // Total number of stats required by gfu_boost calculation.
319 int num_stats_required_for_gfu_boost;
320
321 int enable_scenecut_detection;
322
323 int use_arf_in_this_kf_group;
324
325 int ni_frames;
326
327 double tot_q;
333 int last_kf_qindex;
334
338 int avg_frame_qindex[FRAME_TYPES];
339
340#if CONFIG_FRAME_PARALLEL_ENCODE && CONFIG_FPMT_TEST
345 int temp_active_best_quality[MAX_ARF_LAYERS + 1];
346
351 int temp_last_boosted_qindex;
352
357 double temp_avg_q;
358
363 int temp_last_q[FRAME_TYPES];
364
369 int temp_projected_frame_size;
370
375 int64_t temp_total_actual_bits;
376
381 int64_t temp_buffer_level;
382
387 int64_t temp_vbr_bits_off_target;
388
393 int64_t temp_vbr_bits_off_target_fast;
394
399 double temp_rate_correction_factors[RATE_FACTOR_LEVELS];
400
405 int temp_rate_error_estimate;
406
411 int temp_rolling_arf_group_target_bits;
412
417 int temp_rolling_arf_group_actual_bits;
418
423 int64_t temp_bits_left;
424
429 int temp_extend_minq;
430
435 int temp_extend_maxq;
436
441 int temp_extend_minq_fast;
442#endif
446 int active_best_quality[MAX_ARF_LAYERS + 1];
447
451 int last_boosted_qindex;
452
456 double avg_q;
457
461 int last_q[FRAME_TYPES];
462
467 double rate_correction_factors[RATE_FACTOR_LEVELS];
468
472 int64_t total_actual_bits;
473
477 int64_t total_target_bits;
478
482 int64_t buffer_level;
483
487 int rate_error_estimate;
488
492 int64_t vbr_bits_off_target;
493
497 int64_t vbr_bits_off_target_fast;
498
503 int64_t bits_off_target;
504
508 int rolling_target_bits;
509
514 int rolling_actual_bits;
515} PRIMARY_RATE_CONTROL;
516
517struct AV1_COMP;
518struct AV1EncoderConfig;
519struct GF_GROUP;
520
521void av1_primary_rc_init(const struct AV1EncoderConfig *oxcf,
522 PRIMARY_RATE_CONTROL *p_rc);
523
524void av1_rc_init(const struct AV1EncoderConfig *oxcf, RATE_CONTROL *rc);
525
526int av1_estimate_bits_at_q(FRAME_TYPE frame_kind, int q, int mbs,
527 double correction_factor, aom_bit_depth_t bit_depth,
528 const int is_screen_content_type);
529
530double av1_convert_qindex_to_q(int qindex, aom_bit_depth_t bit_depth);
531
532void av1_rc_init_minq_luts(void);
533
534int av1_rc_get_default_min_gf_interval(int width, int height, double framerate);
535// Note av1_rc_get_default_max_gf_interval() requires the min_gf_interval to
536// be passed in to ensure that the max_gf_interval returned is at least as bis
537// as that.
538int av1_rc_get_default_max_gf_interval(double framerate, int min_gf_interval);
539
540// Generally at the high level, the following flow is expected
541// to be enforced for rate control:
542// First call per frame, one of:
543// av1_rc_get_first_pass_params()
544// av1_rc_get_second_pass_params()
545// depending on the usage to set the rate control encode parameters desired.
546//
547// Then, call encode_frame_to_data_rate() to perform the
548// actual encode. This function will in turn call encode_frame()
549// one or more times, followed by:
550// av1_rc_postencode_update_drop_frame()
551//
552// The majority of rate control parameters are only expected
553// to be set in the av1_rc_get_..._params() functions and
554// updated during the av1_rc_postencode_update...() functions.
555// The only exceptions are av1_rc_drop_frame() and
556// av1_rc_update_rate_correction_factors() functions.
557
558// Functions to set parameters for encoding before the actual
559// encode_frame_to_data_rate() function.
560struct EncodeFrameParams;
561
562// Post encode update of the rate control parameters based
563// on bytes used
564void av1_rc_postencode_update(struct AV1_COMP *cpi, uint64_t bytes_used);
565// Post encode update of the rate control parameters for dropped frames
566void av1_rc_postencode_update_drop_frame(struct AV1_COMP *cpi);
567
581void av1_rc_update_rate_correction_factors(struct AV1_COMP *cpi,
582#if CONFIG_FRAME_PARALLEL_ENCODE
583 int is_encode_stage,
584#endif // CONFIG_FRAME_PARALLEL_ENCODE
585 int width, int height);
588// Decide if we should drop this frame: For 1-pass CBR.
589// Changes only the decimation count in the rate control structure
590int av1_rc_drop_frame(struct AV1_COMP *cpi);
591
592// Computes frame size bounds.
593void av1_rc_compute_frame_size_bounds(const struct AV1_COMP *cpi,
594 int this_frame_target,
595 int *frame_under_shoot_limit,
596 int *frame_over_shoot_limit);
597
612 int av1_rc_pick_q_and_bounds(const struct AV1_COMP *cpi, int width, int height,
613 int gf_index, int *bottom_index, int *top_index);
614
627 int av1_rc_regulate_q(const struct AV1_COMP *cpi, int target_bits_per_frame,
628 int active_best_quality, int active_worst_quality,
629 int width, int height);
630
632// Estimates bits per mb for a given qindex and correction factor.
633int av1_rc_bits_per_mb(FRAME_TYPE frame_type, int qindex,
634 double correction_factor, aom_bit_depth_t bit_depth,
635 const int is_screen_content_type);
636
637// Clamping utilities for bitrate targets for iframes and pframes.
638int av1_rc_clamp_iframe_target_size(const struct AV1_COMP *const cpi,
639 int target);
640int av1_rc_clamp_pframe_target_size(const struct AV1_COMP *const cpi,
641 int target, uint8_t frame_update_type);
642
643// Find q_index corresponding to desired_q, within [best_qindex, worst_qindex].
644// To be precise, 'q_index' is the smallest integer, for which the corresponding
645// q >= desired_q.
646// If no such q index is found, returns 'worst_qindex'.
647int av1_find_qindex(double desired_q, aom_bit_depth_t bit_depth,
648 int best_qindex, int worst_qindex);
649
650// Computes a q delta (in "q index" terms) to get from a starting q value
651// to a target q value
652int av1_compute_qdelta(const RATE_CONTROL *rc, double qstart, double qtarget,
653 aom_bit_depth_t bit_depth);
654
655// Computes a q delta (in "q index" terms) to get from a starting q value
656// to a value that should equate to the given rate ratio.
657int av1_compute_qdelta_by_rate(const RATE_CONTROL *rc, FRAME_TYPE frame_type,
658 int qindex, double rate_target_ratio,
659 const int is_screen_content_type,
660 aom_bit_depth_t bit_depth);
661
662int av1_frame_type_qdelta(const struct AV1_COMP *cpi, int q);
663
664void av1_rc_update_framerate(struct AV1_COMP *cpi, int width, int height);
665
666void av1_rc_set_gf_interval_range(const struct AV1_COMP *const cpi,
667 RATE_CONTROL *const rc);
668
669void av1_set_target_rate(struct AV1_COMP *cpi, int width, int height);
670
671int av1_resize_one_pass_cbr(struct AV1_COMP *cpi);
672
673void av1_rc_set_frame_target(struct AV1_COMP *cpi, int target, int width,
674 int height);
675
676void av1_adjust_gf_refresh_qp_one_pass_rt(struct AV1_COMP *cpi);
677
678void av1_set_reference_structure_one_pass_rt(struct AV1_COMP *cpi,
679 int gf_update);
680
693 int av1_calc_pframe_target_size_one_pass_vbr(
694 const struct AV1_COMP *const cpi, FRAME_UPDATE_TYPE frame_update_type);
695
706 int av1_calc_iframe_target_size_one_pass_vbr(const struct AV1_COMP *const cpi);
707
719 int av1_calc_pframe_target_size_one_pass_cbr(
720 const struct AV1_COMP *cpi, FRAME_UPDATE_TYPE frame_update_type);
721
732 int av1_calc_iframe_target_size_one_pass_cbr(const struct AV1_COMP *cpi);
733
750void av1_get_one_pass_rt_params(struct AV1_COMP *cpi,
751 struct EncodeFrameParams *const frame_params,
752 unsigned int frame_flags);
753
768int av1_encodedframe_overshoot_cbr(struct AV1_COMP *cpi, int *q);
769
770#if !CONFIG_REALTIME_ONLY
782void av1_q_mode_compute_gop_q_indices(int gf_frame_index, int base_q_index,
783 const double *qstep_ratio_list,
784 aom_bit_depth_t bit_depth,
785 const struct GF_GROUP *gf_group,
786 int *q_index_list);
787#endif // !CONFIG_REALTIME_ONLY
788
800int av1_q_mode_get_q_index(int base_q_index, int gf_update_type,
801 int gf_pyramid_level, int arf_q);
802
812int av1_get_arf_q_index(int base_q_index, int gfu_boost, int bit_depth,
813 double arf_boost_factor);
814
815#if !CONFIG_REALTIME_ONLY
816struct TplDepFrame;
824int av1_get_arf_q_index_q_mode(struct AV1_COMP *cpi,
825 struct TplDepFrame *tpl_frame);
826#endif
827#ifdef __cplusplus
828} // extern "C"
829#endif
830
831#endif // AOM_AV1_ENCODER_RATECTRL_H_
aom_codec.h
Describes the codec algorithm interface to applications.
aom_bit_depth_t
enum aom_bit_depth aom_bit_depth_t
Bit depth for codecThis enumeration determines the bit depth of the codec.
av1_calc_pframe_target_size_one_pass_vbr
int av1_calc_pframe_target_size_one_pass_vbr(const struct AV1_COMP *const cpi, FRAME_UPDATE_TYPE frame_update_type)
Calculates how many bits to use for a P frame in one pass vbr.
av1_encodedframe_overshoot_cbr
int av1_encodedframe_overshoot_cbr(struct AV1_COMP *cpi, int *q)
Increase q on expected encoder overshoot, for CBR mode.
Definition: ratectrl.c:3044
av1_calc_pframe_target_size_one_pass_cbr
int av1_calc_pframe_target_size_one_pass_cbr(const struct AV1_COMP *cpi, FRAME_UPDATE_TYPE frame_update_type)
Calculates how many bits to use for a P frame in one pass cbr.
av1_set_reference_structure_one_pass_rt
void av1_set_reference_structure_one_pass_rt(AV1_COMP *cpi, int gf_update)
Setup the reference prediction structure for 1 pass real-time.
Definition: ratectrl.c:2556
av1_rc_pick_q_and_bounds
int av1_rc_pick_q_and_bounds(const struct AV1_COMP *cpi, int width, int height, int gf_index, int *bottom_index, int *top_index)
Picks q and q bounds given the rate control parameters in cpi->rc.
av1_calc_iframe_target_size_one_pass_cbr
int av1_calc_iframe_target_size_one_pass_cbr(const struct AV1_COMP *cpi)
Calculates how many bits to use for an i frame in one pass cbr.
av1_calc_iframe_target_size_one_pass_vbr
int av1_calc_iframe_target_size_one_pass_vbr(const struct AV1_COMP *const cpi)
Calculates how many bits to use for an i frame in one pass vbr.
av1_rc_regulate_q
int av1_rc_regulate_q(const struct AV1_COMP *cpi, int target_bits_per_frame, int active_best_quality, int active_worst_quality, int width, int height)
Estimates q to achieve a target bits per frame.
av1_get_one_pass_rt_params
void av1_get_one_pass_rt_params(struct AV1_COMP *cpi, struct EncodeFrameParams *const frame_params, unsigned int frame_flags)
Setup the rate control parameters for 1 pass real-time mode.
Definition: ratectrl.c:2938
av1_rc_update_rate_correction_factors
void av1_rc_update_rate_correction_factors(struct AV1_COMP *cpi, int width, int height)
Updates the rate correction factor linking Q to output bits.
Definition: ratectrl.c:648
GF_GROUP
Data related to the current GF/ARF group and the individual frames within the group.
Definition: firstpass.h:344
PRIMARY_RATE_CONTROL
Primary Rate Control parameters and status.
Definition: ratectrl.h:243
PRIMARY_RATE_CONTROL::bits_off_target
int64_t bits_off_target
Definition: ratectrl.h:503
PRIMARY_RATE_CONTROL::rate_error_estimate
int rate_error_estimate
Definition: ratectrl.h:487
PRIMARY_RATE_CONTROL::avg_q
double avg_q
Definition: ratectrl.h:456
PRIMARY_RATE_CONTROL::maximum_buffer_size
int64_t maximum_buffer_size
Definition: ratectrl.h:300
PRIMARY_RATE_CONTROL::kf_boost
int kf_boost
Definition: ratectrl.h:254
PRIMARY_RATE_CONTROL::starting_buffer_level
int64_t starting_buffer_level
Definition: ratectrl.h:290
PRIMARY_RATE_CONTROL::total_actual_bits
int64_t total_actual_bits
Definition: ratectrl.h:472
PRIMARY_RATE_CONTROL::vbr_bits_off_target_fast
int64_t vbr_bits_off_target_fast
Definition: ratectrl.h:497
PRIMARY_RATE_CONTROL::rolling_target_bits
int rolling_target_bits
Definition: ratectrl.h:508
PRIMARY_RATE_CONTROL::buffer_level
int64_t buffer_level
Definition: ratectrl.h:482
PRIMARY_RATE_CONTROL::gfu_boost
int gfu_boost
Definition: ratectrl.h:259
PRIMARY_RATE_CONTROL::optimal_buffer_level
int64_t optimal_buffer_level
Definition: ratectrl.h:295
PRIMARY_RATE_CONTROL::arf_q
int arf_q
Definition: ratectrl.h:305
PRIMARY_RATE_CONTROL::rolling_actual_bits
int rolling_actual_bits
Definition: ratectrl.h:514
PRIMARY_RATE_CONTROL::last_boosted_qindex
int last_boosted_qindex
Definition: ratectrl.h:451
PRIMARY_RATE_CONTROL::cur_gf_index
int cur_gf_index
Definition: ratectrl.h:269
PRIMARY_RATE_CONTROL::total_target_bits
int64_t total_target_bits
Definition: ratectrl.h:477
PRIMARY_RATE_CONTROL::last_kf_qindex
int last_kf_qindex
Definition: ratectrl.h:333
PRIMARY_RATE_CONTROL::gf_group_bits
int64_t gf_group_bits
Definition: ratectrl.h:249
PRIMARY_RATE_CONTROL::vbr_bits_off_target
int64_t vbr_bits_off_target
Definition: ratectrl.h:492
RATE_CONTROL
Rate Control parameters and status.
Definition: ratectrl.h:121
RATE_CONTROL::best_quality
int best_quality
Definition: ratectrl.h:202
RATE_CONTROL::intervals_till_gf_calculate_due
int intervals_till_gf_calculate_due
Definition: ratectrl.h:162
RATE_CONTROL::this_frame_target
int this_frame_target
Definition: ratectrl.h:132
RATE_CONTROL::frames_to_key
int frames_to_key
Definition: ratectrl.h:172
RATE_CONTROL::base_frame_target
int base_frame_target
Definition: ratectrl.h:128
RATE_CONTROL::projected_frame_size
int projected_frame_size
Definition: ratectrl.h:137
RATE_CONTROL::worst_quality
int worst_quality
Definition: ratectrl.h:198
RATE_CONTROL::sb64_target_rate
int sb64_target_rate
Definition: ratectrl.h:147
RATE_CONTROL::coefficient_size
int coefficient_size
Definition: ratectrl.h:142
RATE_CONTROL::active_worst_quality
int active_worst_quality
Definition: ratectrl.h:219
RATE_CONTROL::frames_since_golden
int frames_since_golden
Definition: ratectrl.h:152
RATE_CONTROL::frames_till_gf_update_due
int frames_till_gf_update_due
Definition: ratectrl.h:157