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 MAX_NUM_GF_INTERVALS 15
50
51#define MAX_ARF_LAYERS 6
52// #define STRICT_RC
53
54typedef struct {
55 int resize_width;
56 int resize_height;
57 uint8_t superres_denom;
58} size_params_type;
59
60enum {
61 INTER_NORMAL,
62 GF_ARF_LOW,
63 GF_ARF_STD,
64 KF_STD,
65 RATE_FACTOR_LEVELS
66} UENUM1BYTE(RATE_FACTOR_LEVEL);
67
68enum {
69 KF_UPDATE,
70 LF_UPDATE,
71 GF_UPDATE,
72 ARF_UPDATE,
73 OVERLAY_UPDATE,
74 INTNL_OVERLAY_UPDATE, // Internal Overlay Frame
75 INTNL_ARF_UPDATE, // Internal Altref Frame
76 FRAME_UPDATE_TYPES
77} UENUM1BYTE(FRAME_UPDATE_TYPE);
78
79enum {
80 REFBUF_RESET, // Clear reference frame buffer
81 REFBUF_UPDATE, // Refresh reference frame buffer
82 REFBUF_STATES
83} UENUM1BYTE(REFBUF_STATE);
84
85typedef enum {
86 NO_RESIZE = 0,
87 DOWN_THREEFOUR = 1, // From orig to 3/4.
88 DOWN_ONEHALF = 2, // From orig or 3/4 to 1/2.
89 UP_THREEFOUR = -1, // From 1/2 to 3/4.
90 UP_ORIG = -2, // From 1/2 or 3/4 to orig.
91} RESIZE_ACTION;
92
93typedef enum { ORIG = 0, THREE_QUARTER = 1, ONE_HALF = 2 } RESIZE_STATE;
94
95#define MAX_FIRSTPASS_ANALYSIS_FRAMES 150
96typedef enum region_types {
97 STABLE_REGION = 0,
98 HIGH_VAR_REGION = 1,
99 SCENECUT_REGION = 2,
100 BLENDING_REGION = 3,
101} REGION_TYPES;
102
103typedef struct regions {
104 int start;
105 int last;
106 double avg_noise_var;
107 double avg_cor_coeff;
108 double avg_sr_fr_ratio;
109 double avg_intra_err;
110 double avg_coded_err;
111 REGION_TYPES type;
112} REGIONS;
113
118typedef struct {
119 // Rate targetting variables
120
129 int this_frame_target; // Actual frame target after rc adjustment.
130
135
140
145
150
155
160
162 int min_gf_interval;
163 int max_gf_interval;
164 int static_scene_max_gf_interval;
171 int frames_since_key;
172 int frames_to_fwd_kf;
173 int is_src_frame_alt_ref;
174 int sframe_due;
175
176 int high_source_sad;
177 uint64_t avg_source_sad;
178 uint64_t prev_avg_source_sad;
179
180 int avg_frame_bandwidth; // Average frame size target for clip
181 int min_frame_bandwidth; // Minimum allocation used for any frame
182 int max_frame_bandwidth; // Maximum burst rate allowed for a frame.
183 int prev_avg_frame_bandwidth;
184
185 int ni_av_qi;
186 int ni_tot_qi;
187
188 int decimation_factor;
189 int decimation_count;
190
200
203 // rate control history for last frame(1) and the frame before(2).
204 // -1: undershot
205 // 1: overshoot
206 // 0: not initialized.
207 int rc_1_frame;
208 int rc_2_frame;
209 int q_1_frame;
210 int q_2_frame;
211
217
219 // Track amount of low motion in scene
220 int avg_frame_low_motion;
221
222 // For dynamic resize, 1 pass cbr.
223 RESIZE_STATE resize_state;
224 int resize_avg_qp;
225 int resize_buffer_underflow;
226 int resize_count;
227#if CONFIG_FRAME_PARALLEL_ENCODE
228 int frame_level_fast_extra_bits;
229 double frame_level_rate_correction_factors[RATE_FACTOR_LEVELS];
230#endif
233
237typedef struct {
238 // Sub-gop level Rate targetting variables
239
244
249
254
258 int gf_intervals[MAX_NUM_GF_INTERVALS];
259
264
266 int num_regions;
267
268 REGIONS regions[MAX_FIRSTPASS_ANALYSIS_FRAMES];
269 int regions_offset; // offset of regions from the last keyframe
270 int frames_till_regions_update;
271
272 int baseline_gf_interval;
273
274 int constrained_gf_group;
275
276 int this_key_frame_forced;
277
278 int next_key_frame_forced;
285
290
295
299 int arf_q;
300
302 float_t arf_boost_factor;
303
304 int base_layer_qp;
305
306 // Total number of stats used only for kf_boost calculation.
307 int num_stats_used_for_kf_boost;
308
309 // Total number of stats used only for gfu_boost calculation.
310 int num_stats_used_for_gfu_boost;
311
312 // Total number of stats required by gfu_boost calculation.
313 int num_stats_required_for_gfu_boost;
314
315 int enable_scenecut_detection;
316
317 int use_arf_in_this_kf_group;
318
319 int ni_frames;
320
321 double tot_q;
328
332 int avg_frame_qindex[FRAME_TYPES];
333
337 int active_best_quality[MAX_ARF_LAYERS + 1];
338
343
347 double avg_q;
348
352 int last_q[FRAME_TYPES];
353
358 double rate_correction_factors[RATE_FACTOR_LEVELS];
359
364
369
374
379
384
389
395
400
407
408struct AV1_COMP;
409struct AV1EncoderConfig;
410struct GF_GROUP;
411
412void av1_primary_rc_init(const struct AV1EncoderConfig *oxcf,
414
415void av1_rc_init(const struct AV1EncoderConfig *oxcf, RATE_CONTROL *rc);
416
417int av1_estimate_bits_at_q(FRAME_TYPE frame_kind, int q, int mbs,
418 double correction_factor, aom_bit_depth_t bit_depth,
419 const int is_screen_content_type);
420
421double av1_convert_qindex_to_q(int qindex, aom_bit_depth_t bit_depth);
422
423void av1_rc_init_minq_luts(void);
424
425int av1_rc_get_default_min_gf_interval(int width, int height, double framerate);
426// Note av1_rc_get_default_max_gf_interval() requires the min_gf_interval to
427// be passed in to ensure that the max_gf_interval returned is at least as bis
428// as that.
429int av1_rc_get_default_max_gf_interval(double framerate, int min_gf_interval);
430
431// Generally at the high level, the following flow is expected
432// to be enforced for rate control:
433// First call per frame, one of:
434// av1_rc_get_first_pass_params()
435// av1_rc_get_second_pass_params()
436// depending on the usage to set the rate control encode parameters desired.
437//
438// Then, call encode_frame_to_data_rate() to perform the
439// actual encode. This function will in turn call encode_frame()
440// one or more times, followed by:
441// av1_rc_postencode_update_drop_frame()
442//
443// The majority of rate control parameters are only expected
444// to be set in the av1_rc_get_..._params() functions and
445// updated during the av1_rc_postencode_update...() functions.
446// The only exceptions are av1_rc_drop_frame() and
447// av1_rc_update_rate_correction_factors() functions.
448
449// Functions to set parameters for encoding before the actual
450// encode_frame_to_data_rate() function.
451struct EncodeFrameParams;
452
453// Post encode update of the rate control parameters based
454// on bytes used
455void av1_rc_postencode_update(struct AV1_COMP *cpi, uint64_t bytes_used);
456// Post encode update of the rate control parameters for dropped frames
457void av1_rc_postencode_update_drop_frame(struct AV1_COMP *cpi);
458
472void av1_rc_update_rate_correction_factors(struct AV1_COMP *cpi,
473#if CONFIG_FRAME_PARALLEL_ENCODE
474 int is_encode_stage,
475#endif // CONFIG_FRAME_PARALLEL_ENCODE
476 int width, int height);
479// Decide if we should drop this frame: For 1-pass CBR.
480// Changes only the decimation count in the rate control structure
481int av1_rc_drop_frame(struct AV1_COMP *cpi);
482
483// Computes frame size bounds.
484void av1_rc_compute_frame_size_bounds(const struct AV1_COMP *cpi,
485 int this_frame_target,
486 int *frame_under_shoot_limit,
487 int *frame_over_shoot_limit);
488
503int av1_rc_pick_q_and_bounds(const struct AV1_COMP *cpi, int width, int height,
504 int gf_index, int *bottom_index, int *top_index);
505
518int av1_rc_regulate_q(const struct AV1_COMP *cpi, int target_bits_per_frame,
519 int active_best_quality, int active_worst_quality,
520 int width, int height);
521
523// Estimates bits per mb for a given qindex and correction factor.
524int av1_rc_bits_per_mb(FRAME_TYPE frame_type, int qindex,
525 double correction_factor, aom_bit_depth_t bit_depth,
526 const int is_screen_content_type);
527
528// Clamping utilities for bitrate targets for iframes and pframes.
529int av1_rc_clamp_iframe_target_size(const struct AV1_COMP *const cpi,
530 int target);
531int av1_rc_clamp_pframe_target_size(const struct AV1_COMP *const cpi,
532 int target, uint8_t frame_update_type);
533
534// Find q_index corresponding to desired_q, within [best_qindex, worst_qindex].
535// To be precise, 'q_index' is the smallest integer, for which the corresponding
536// q >= desired_q.
537// If no such q index is found, returns 'worst_qindex'.
538int av1_find_qindex(double desired_q, aom_bit_depth_t bit_depth,
539 int best_qindex, int worst_qindex);
540
541// Computes a q delta (in "q index" terms) to get from a starting q value
542// to a target q value
543int av1_compute_qdelta(const RATE_CONTROL *rc, double qstart, double qtarget,
544 aom_bit_depth_t bit_depth);
545
546// Computes a q delta (in "q index" terms) to get from a starting q value
547// to a value that should equate to the given rate ratio.
548int av1_compute_qdelta_by_rate(const RATE_CONTROL *rc, FRAME_TYPE frame_type,
549 int qindex, double rate_target_ratio,
550 const int is_screen_content_type,
551 aom_bit_depth_t bit_depth);
552
553int av1_frame_type_qdelta(const struct AV1_COMP *cpi, int q);
554
555void av1_rc_update_framerate(struct AV1_COMP *cpi, int width, int height);
556
557void av1_rc_set_gf_interval_range(const struct AV1_COMP *const cpi,
558 RATE_CONTROL *const rc);
559
560void av1_set_target_rate(struct AV1_COMP *cpi, int width, int height);
561
562int av1_resize_one_pass_cbr(struct AV1_COMP *cpi);
563
564void av1_rc_set_frame_target(struct AV1_COMP *cpi, int target, int width,
565 int height);
566
567void av1_set_reference_structure_one_pass_rt(struct AV1_COMP *cpi,
568 int gf_update);
569
583 const struct AV1_COMP *const cpi, FRAME_UPDATE_TYPE frame_update_type);
584
595int av1_calc_iframe_target_size_one_pass_vbr(const struct AV1_COMP *const cpi);
596
609 const struct AV1_COMP *cpi, FRAME_UPDATE_TYPE frame_update_type);
610
621int av1_calc_iframe_target_size_one_pass_cbr(const struct AV1_COMP *cpi);
622
639void av1_get_one_pass_rt_params(struct AV1_COMP *cpi,
640 struct EncodeFrameParams *const frame_params,
641 unsigned int frame_flags);
642
657int av1_encodedframe_overshoot_cbr(struct AV1_COMP *cpi, int *q);
658
659#if !CONFIG_REALTIME_ONLY
672void av1_q_mode_compute_gop_q_indices(int gf_frame_index, int base_q_index,
673 double arf_qstep_ratio,
674 aom_bit_depth_t bit_depth,
675 const struct GF_GROUP *gf_group,
676 int *q_index_list);
677#endif // !CONFIG_REALTIME_ONLY
678
690int av1_q_mode_get_q_index(int base_q_index, int gf_update_type,
691 int gf_pyramid_level, int arf_q);
692
702int av1_get_arf_q_index(int base_q_index, int gfu_boost, int bit_depth,
703 double arf_boost_factor);
704
705#if !CONFIG_REALTIME_ONLY
706struct TplDepFrame;
714int av1_get_arf_q_index_q_mode(struct AV1_COMP *cpi,
715 struct TplDepFrame *tpl_frame);
716#endif
717#ifdef __cplusplus
718} // extern "C"
719#endif
720
721#endif // AOM_AV1_ENCODER_RATECTRL_H_
Describes the codec algorithm interface to applications.
enum aom_bit_depth aom_bit_depth_t
Bit depth for codecThis enumeration determines the bit depth of the codec.
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.
int av1_encodedframe_overshoot_cbr(struct AV1_COMP *cpi, int *q)
Increase q on expected encoder overshoot, for CBR mode.
Definition: ratectrl.c:2829
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.
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:2317
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.
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.
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.
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.
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:2717
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:624
Data related to the current GF/ARF group and the individual frames within the group.
Definition: firstpass.h:344
Primary Rate Control parameters and status.
Definition: ratectrl.h:237
int64_t bits_off_target
Definition: ratectrl.h:394
int rate_error_estimate
Definition: ratectrl.h:378
double avg_q
Definition: ratectrl.h:347
int64_t maximum_buffer_size
Definition: ratectrl.h:294
int kf_boost
Definition: ratectrl.h:248
int64_t starting_buffer_level
Definition: ratectrl.h:284
int64_t total_actual_bits
Definition: ratectrl.h:363
int64_t vbr_bits_off_target_fast
Definition: ratectrl.h:388
int rolling_target_bits
Definition: ratectrl.h:399
int64_t buffer_level
Definition: ratectrl.h:373
int gfu_boost
Definition: ratectrl.h:253
int64_t optimal_buffer_level
Definition: ratectrl.h:289
int arf_q
Definition: ratectrl.h:299
int rolling_actual_bits
Definition: ratectrl.h:405
int last_boosted_qindex
Definition: ratectrl.h:342
int cur_gf_index
Definition: ratectrl.h:263
int64_t total_target_bits
Definition: ratectrl.h:368
int last_kf_qindex
Definition: ratectrl.h:327
int64_t gf_group_bits
Definition: ratectrl.h:243
int64_t vbr_bits_off_target
Definition: ratectrl.h:383
Rate Control parameters and status.
Definition: ratectrl.h:118
int best_quality
Definition: ratectrl.h:199
int intervals_till_gf_calculate_due
Definition: ratectrl.h:159
int this_frame_target
Definition: ratectrl.h:129
int frames_to_key
Definition: ratectrl.h:169
int base_frame_target
Definition: ratectrl.h:125
int projected_frame_size
Definition: ratectrl.h:134
int worst_quality
Definition: ratectrl.h:195
int sb64_target_rate
Definition: ratectrl.h:144
int coefficient_size
Definition: ratectrl.h:139
int active_worst_quality
Definition: ratectrl.h:216
int frames_since_golden
Definition: ratectrl.h:149
int frames_till_gf_update_due
Definition: ratectrl.h:154