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
57#define DEFAULT_KF_BOOST_RT 2300
58#define DEFAULT_GF_BOOST_RT 2000
59
60// 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
70typedef struct {
71 int resize_width;
72 int resize_height;
73 uint8_t superres_denom;
74} size_params_type;
75
76enum {
77 INTER_NORMAL,
78 GF_ARF_LOW,
79 GF_ARF_STD,
80 KF_STD,
81 RATE_FACTOR_LEVELS
82} UENUM1BYTE(RATE_FACTOR_LEVEL);
83
84enum {
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
95enum {
96 REFBUF_RESET, // Clear reference frame buffer
97 REFBUF_UPDATE, // Refresh reference frame buffer
98 REFBUF_STATES
99} UENUM1BYTE(REFBUF_STATE);
100
101typedef 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
111#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
134 typedef struct {
135 // Rate targetting variables
136
141 int base_frame_target;
145 int this_frame_target; // Actual frame target after rc adjustment.
146
150 int projected_frame_size;
151
155 int coefficient_size;
156
160 int sb64_target_rate;
161
165 int frames_since_golden;
166
170 int frames_till_gf_update_due;
171
175 int intervals_till_gf_calculate_due;
176
178 int min_gf_interval;
179 int max_gf_interval;
180 int static_scene_max_gf_interval;
185 int frames_to_key;
187 int frames_since_key;
188 int frames_to_fwd_kf;
189 int is_src_frame_alt_ref;
190 int sframe_due;
191
192 int high_source_sad;
193 uint64_t avg_source_sad;
194 uint64_t prev_avg_source_sad;
195 uint64_t frame_source_sad;
196
197 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.
200 int prev_avg_frame_bandwidth;
201
202 int ni_av_qi;
203 int ni_tot_qi;
204
205 int decimation_factor;
206 int decimation_count;
207
212 int worst_quality;
216 int best_quality;
217
220 // rate control history for last frame(1) and the frame before(2).
221 // -1: overshoot
222 // 1: undershoot
223 // 0: not initialized.
224 int rc_1_frame;
225 int rc_2_frame;
226 int q_1_frame;
227 int q_2_frame;
228
233 int active_worst_quality;
234
236 // Track amount of low motion in scene
237 int avg_frame_low_motion;
238
239 // signals if number of blocks with motion is high
240 int high_num_blocks_with_motion;
241
242 // For dynamic resize, 1 pass cbr.
243 RESIZE_STATE resize_state;
244 int resize_avg_qp;
245 int resize_buffer_underflow;
246 int resize_count;
247
248 // Flag to disable content related qp adjustment.
249 int rtc_external_ratectrl;
250
251 // Stores fast_extra_bits of the current frame.
252 int frame_level_fast_extra_bits;
253
254 double frame_level_rate_correction_factors[RATE_FACTOR_LEVELS];
256} RATE_CONTROL;
257
261 typedef struct {
262 // Sub-gop level Rate targetting variables
263
267 int64_t gf_group_bits;
268
272 int kf_boost;
273
277 int gfu_boost;
278
282 int gf_intervals[MAX_NUM_GF_INTERVALS];
283
287 int cur_gf_index;
288
290 int num_regions;
291
292 REGIONS regions[MAX_FIRSTPASS_ANALYSIS_FRAMES];
293 int regions_offset; // offset of regions from the last keyframe
294 int frames_till_regions_update;
295
296 int baseline_gf_interval;
297
298 int constrained_gf_group;
299
300 int this_key_frame_forced;
301
302 int next_key_frame_forced;
308 int64_t starting_buffer_level;
309
313 int64_t optimal_buffer_level;
314
318 int64_t maximum_buffer_size;
319
323 int arf_q;
324
326 float_t arf_boost_factor;
327
328 int base_layer_qp;
329
330 // Total number of stats used only for kf_boost calculation.
331 int num_stats_used_for_kf_boost;
332
333 // Total number of stats used only for gfu_boost calculation.
334 int num_stats_used_for_gfu_boost;
335
336 // Total number of stats required by gfu_boost calculation.
337 int num_stats_required_for_gfu_boost;
338
339 int enable_scenecut_detection;
340
341 int use_arf_in_this_kf_group;
342
343 int ni_frames;
344
345 double tot_q;
351 int last_kf_qindex;
352
356 int avg_frame_qindex[FRAME_TYPES];
357
358#if CONFIG_FRAME_PARALLEL_ENCODE && CONFIG_FPMT_TEST
363 int temp_active_best_quality[MAX_ARF_LAYERS + 1];
364
369 int temp_last_boosted_qindex;
370
375 double temp_avg_q;
376
381 int temp_last_q[FRAME_TYPES];
382
387 int temp_projected_frame_size;
388
393 int64_t temp_total_actual_bits;
394
399 int64_t temp_buffer_level;
400
405 int64_t temp_vbr_bits_off_target;
406
411 int64_t temp_vbr_bits_off_target_fast;
412
417 double temp_rate_correction_factors[RATE_FACTOR_LEVELS];
418
423 int temp_rate_error_estimate;
424
429 int temp_rolling_arf_group_target_bits;
430
435 int temp_rolling_arf_group_actual_bits;
436
441 int64_t temp_bits_left;
442
447 int temp_extend_minq;
448
453 int temp_extend_maxq;
454
459 int temp_extend_minq_fast;
460#endif
464 int active_best_quality[MAX_ARF_LAYERS + 1];
465
469 int last_boosted_qindex;
470
474 double avg_q;
475
479 int last_q[FRAME_TYPES];
480
485 double rate_correction_factors[RATE_FACTOR_LEVELS];
486
490 int64_t total_actual_bits;
491
495 int64_t total_target_bits;
496
500 int64_t buffer_level;
501
505 int rate_error_estimate;
506
510 int64_t vbr_bits_off_target;
511
515 int64_t vbr_bits_off_target_fast;
516
521 int64_t bits_off_target;
522
526 int rolling_target_bits;
527
532 int rolling_actual_bits;
533
538 int q_history[MAX_Q_HISTORY];
539} PRIMARY_RATE_CONTROL;
540
541struct AV1_COMP;
542struct AV1EncoderConfig;
543struct GF_GROUP;
544
545void av1_primary_rc_init(const struct AV1EncoderConfig *oxcf,
546 PRIMARY_RATE_CONTROL *p_rc);
547
548void av1_rc_init(const struct AV1EncoderConfig *oxcf, RATE_CONTROL *rc);
549
550int av1_estimate_bits_at_q(FRAME_TYPE frame_kind, int q, int mbs,
551 double correction_factor, aom_bit_depth_t bit_depth,
552 const int is_screen_content_type);
553
554double av1_convert_qindex_to_q(int qindex, aom_bit_depth_t bit_depth);
555
556void av1_rc_init_minq_luts(void);
557
558int av1_rc_get_default_min_gf_interval(int width, int height, double framerate);
559// Note av1_rc_get_default_max_gf_interval() requires the min_gf_interval to
560// be passed in to ensure that the max_gf_interval returned is at least as bis
561// as that.
562int av1_rc_get_default_max_gf_interval(double framerate, int min_gf_interval);
563
564// Generally at the high level, the following flow is expected
565// to be enforced for rate control:
566// First call per frame, one of:
567// av1_get_one_pass_rt_params()
568// av1_get_second_pass_params()
569// depending on the usage to set the rate control encode parameters desired.
570//
571// Then, call encode_frame_to_data_rate() to perform the
572// actual encode. This function will in turn call encode_frame()
573// one or more times, followed by:
574// av1_rc_postencode_update_drop_frame()
575//
576// The majority of rate control parameters are only expected
577// to be set in the av1_get_..._params() functions and
578// updated during the av1_rc_postencode_update...() functions.
579// The only exceptions are av1_rc_drop_frame() and
580// av1_rc_update_rate_correction_factors() functions.
581
582// Functions to set parameters for encoding before the actual
583// encode_frame_to_data_rate() function.
584struct EncodeFrameParams;
585
586// Post encode update of the rate control parameters based
587// on bytes used
588void av1_rc_postencode_update(struct AV1_COMP *cpi, uint64_t bytes_used);
589// Post encode update of the rate control parameters for dropped frames
590void av1_rc_postencode_update_drop_frame(struct AV1_COMP *cpi);
591
606void av1_rc_update_rate_correction_factors(struct AV1_COMP *cpi,
607 int is_encode_stage, int width,
608 int height);
611// Decide if we should drop this frame: For 1-pass CBR.
612// Changes only the decimation count in the rate control structure
613int av1_rc_drop_frame(struct AV1_COMP *cpi);
614
615// Computes frame size bounds.
616void av1_rc_compute_frame_size_bounds(const struct AV1_COMP *cpi,
617 int this_frame_target,
618 int *frame_under_shoot_limit,
619 int *frame_over_shoot_limit);
620
635 int av1_rc_pick_q_and_bounds(const struct AV1_COMP *cpi, int width, int height,
636 int gf_index, int *bottom_index, int *top_index);
637
650 int av1_rc_regulate_q(const struct AV1_COMP *cpi, int target_bits_per_frame,
651 int active_best_quality, int active_worst_quality,
652 int width, int height);
653
655// Estimates bits per mb for a given qindex and correction factor.
656int av1_rc_bits_per_mb(FRAME_TYPE frame_type, int qindex,
657 double correction_factor, aom_bit_depth_t bit_depth,
658 const int is_screen_content_type);
659
660// Clamping utilities for bitrate targets for iframes and pframes.
661int av1_rc_clamp_iframe_target_size(const struct AV1_COMP *const cpi,
662 int64_t target);
663int av1_rc_clamp_pframe_target_size(const struct AV1_COMP *const cpi,
664 int target, uint8_t frame_update_type);
665
666// Find q_index corresponding to desired_q, within [best_qindex, worst_qindex].
667// To be precise, 'q_index' is the smallest integer, for which the corresponding
668// q >= desired_q.
669// If no such q index is found, returns 'worst_qindex'.
670int av1_find_qindex(double desired_q, aom_bit_depth_t bit_depth,
671 int best_qindex, int worst_qindex);
672
673// Computes a q delta (in "q index" terms) to get from a starting q value
674// to a target q value
675int av1_compute_qdelta(const RATE_CONTROL *rc, double qstart, double qtarget,
676 aom_bit_depth_t bit_depth);
677
678// Computes a q delta (in "q index" terms) to get from a starting q value
679// to a value that should equate to the given rate ratio.
680int av1_compute_qdelta_by_rate(const RATE_CONTROL *rc, FRAME_TYPE frame_type,
681 int qindex, double rate_target_ratio,
682 const int is_screen_content_type,
683 aom_bit_depth_t bit_depth);
684
685int av1_frame_type_qdelta(const struct AV1_COMP *cpi, int q);
686
687void av1_rc_update_framerate(struct AV1_COMP *cpi, int width, int height);
688
689void av1_rc_set_gf_interval_range(const struct AV1_COMP *const cpi,
690 RATE_CONTROL *const rc);
691
692void av1_set_target_rate(struct AV1_COMP *cpi, int width, int height);
693
694int av1_resize_one_pass_cbr(struct AV1_COMP *cpi);
695
696void av1_rc_set_frame_target(struct AV1_COMP *cpi, int target, int width,
697 int height);
698
699void av1_adjust_gf_refresh_qp_one_pass_rt(struct AV1_COMP *cpi);
700
701void av1_set_reference_structure_one_pass_rt(struct AV1_COMP *cpi,
702 int gf_update);
703
716 int av1_calc_pframe_target_size_one_pass_vbr(
717 const struct AV1_COMP *const cpi, FRAME_UPDATE_TYPE frame_update_type);
718
729 int av1_calc_iframe_target_size_one_pass_vbr(const struct AV1_COMP *const cpi);
730
742 int av1_calc_pframe_target_size_one_pass_cbr(
743 const struct AV1_COMP *cpi, FRAME_UPDATE_TYPE frame_update_type);
744
755 int av1_calc_iframe_target_size_one_pass_cbr(const struct AV1_COMP *cpi);
756
773void av1_get_one_pass_rt_params(struct AV1_COMP *cpi,
774 struct EncodeFrameParams *const frame_params,
775 unsigned int frame_flags);
776
791int av1_encodedframe_overshoot_cbr(struct AV1_COMP *cpi, int *q);
792
804int av1_q_mode_get_q_index(int base_q_index, int gf_update_type,
805 int gf_pyramid_level, int arf_q);
806
816int av1_get_arf_q_index(int base_q_index, int gfu_boost, int bit_depth,
817 double arf_boost_factor);
818
819#if !CONFIG_REALTIME_ONLY
820struct TplDepFrame;
828int av1_get_arf_q_index_q_mode(struct AV1_COMP *cpi,
829 struct TplDepFrame *tpl_frame);
830#endif
831#ifdef __cplusplus
832} // extern "C"
833#endif
834
835#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_rc_update_rate_correction_factors
void av1_rc_update_rate_correction_factors(struct AV1_COMP *cpi, int is_encode_stage, int width, int height)
Updates the rate correction factor linking Q to output bits.
Definition: ratectrl.c:652
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:3146
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:2587
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:3021
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:261
PRIMARY_RATE_CONTROL::bits_off_target
int64_t bits_off_target
Definition: ratectrl.h:521
PRIMARY_RATE_CONTROL::rate_error_estimate
int rate_error_estimate
Definition: ratectrl.h:505
PRIMARY_RATE_CONTROL::avg_q
double avg_q
Definition: ratectrl.h:474
PRIMARY_RATE_CONTROL::maximum_buffer_size
int64_t maximum_buffer_size
Definition: ratectrl.h:318
PRIMARY_RATE_CONTROL::kf_boost
int kf_boost
Definition: ratectrl.h:272
PRIMARY_RATE_CONTROL::starting_buffer_level
int64_t starting_buffer_level
Definition: ratectrl.h:308
PRIMARY_RATE_CONTROL::total_actual_bits
int64_t total_actual_bits
Definition: ratectrl.h:490
PRIMARY_RATE_CONTROL::vbr_bits_off_target_fast
int64_t vbr_bits_off_target_fast
Definition: ratectrl.h:515
PRIMARY_RATE_CONTROL::rolling_target_bits
int rolling_target_bits
Definition: ratectrl.h:526
PRIMARY_RATE_CONTROL::buffer_level
int64_t buffer_level
Definition: ratectrl.h:500
PRIMARY_RATE_CONTROL::gfu_boost
int gfu_boost
Definition: ratectrl.h:277
PRIMARY_RATE_CONTROL::optimal_buffer_level
int64_t optimal_buffer_level
Definition: ratectrl.h:313
PRIMARY_RATE_CONTROL::arf_q
int arf_q
Definition: ratectrl.h:323
PRIMARY_RATE_CONTROL::rolling_actual_bits
int rolling_actual_bits
Definition: ratectrl.h:532
PRIMARY_RATE_CONTROL::last_boosted_qindex
int last_boosted_qindex
Definition: ratectrl.h:469
PRIMARY_RATE_CONTROL::cur_gf_index
int cur_gf_index
Definition: ratectrl.h:287
PRIMARY_RATE_CONTROL::total_target_bits
int64_t total_target_bits
Definition: ratectrl.h:495
PRIMARY_RATE_CONTROL::last_kf_qindex
int last_kf_qindex
Definition: ratectrl.h:351
PRIMARY_RATE_CONTROL::gf_group_bits
int64_t gf_group_bits
Definition: ratectrl.h:267
PRIMARY_RATE_CONTROL::vbr_bits_off_target
int64_t vbr_bits_off_target
Definition: ratectrl.h:510
RATE_CONTROL
Rate Control parameters and status.
Definition: ratectrl.h:134
RATE_CONTROL::best_quality
int best_quality
Definition: ratectrl.h:216
RATE_CONTROL::intervals_till_gf_calculate_due
int intervals_till_gf_calculate_due
Definition: ratectrl.h:175
RATE_CONTROL::this_frame_target
int this_frame_target
Definition: ratectrl.h:145
RATE_CONTROL::frames_to_key
int frames_to_key
Definition: ratectrl.h:185
RATE_CONTROL::base_frame_target
int base_frame_target
Definition: ratectrl.h:141
RATE_CONTROL::projected_frame_size
int projected_frame_size
Definition: ratectrl.h:150
RATE_CONTROL::worst_quality
int worst_quality
Definition: ratectrl.h:212
RATE_CONTROL::sb64_target_rate
int sb64_target_rate
Definition: ratectrl.h:160
RATE_CONTROL::coefficient_size
int coefficient_size
Definition: ratectrl.h:155
RATE_CONTROL::active_worst_quality
int active_worst_quality
Definition: ratectrl.h:233
RATE_CONTROL::frames_since_golden
int frames_since_golden
Definition: ratectrl.h:165
RATE_CONTROL::frames_till_gf_update_due
int frames_till_gf_update_due
Definition: ratectrl.h:170