Bug Summary

File:root/firefox-clang/third_party/aom/av1/encoder/encoder.h
Warning:line 2907, column 16
Excessive padding in 'struct AV1_COMP' (114 padding bytes, where 2 is optimal). Optimal fields order: common, enc_quant_dequant_params, td, ppi, coeff_buffer_base, source, last_source, unscaled_source, unscaled_last_source, unfiltered_source, tpl_rdmult_scaling_factors, cdef_search_ctx, last_show_frame_buf, ambient_err, framerate, cyclic_refresh, tile_data, new_framerate, film_grain_table, denoise_and_model, ssim_rdmult_scaling_factors, consec_zero_mv, mb_weber_stats, prep_rate_estimates, ext_rate_distribution, ext_rate_scale, norm_wiener_variance, mb_delta_q, second_pass_log_stream, src_sad_blk_64x64, rec_sse, mbmi_ext_info, enc_seg, active_map, firstpass_data, extrc_tpl_gop_stats, coeff_buffer_pool, time_stamps, pick_lr_ctxt, twopass_frame, vbp_info, scaled_ref_buf, ducky_encode_info, ext_part_controller, roi, lr_ctxt, gm_info, ext_ratectrl, scaled_source, scaled_last_source, orig_source, last_frame_uf, trial_frame_rst, force_intpel_info, svc, tf_ctx, rc, oxcf, coding_context, sf, mt_info, mv_search_params, token_info, rd, skip_tpl_setup_stats, cb_delta_rdmult_enabled, rt_reduce_num_ref_buffers, ref_frame_flags, speed, all_one_sided_refs, droppable, frame_index_set, data_alloc_width, data_alloc_height, initial_mbs, last_coded_width, last_coded_height, allocated_tiles, vaq_refresh, num_frame_recode, do_update_vbr_bits_off_target_fast, existing_fb_idx_to_show, intrabc_used, prune_ref_frame_mask, keep_single_ref_frame_mask, keep_comp_ref_frame_mask, use_screen_content_tools, is_screen_content_type, frame_header_count, deltaq_used, num_tg, superres_mode, consec_zero_mv_alloc_size, sb_counter, ref_refresh_index, ref_idx_to_skip, src_sad_blk_alloc_size, use_ducky_encode, frames_since_last_update, palette_pixel_num, scaled_last_source_available, resize_pending_params, interp_search_flags, ext_flags, ref_frame_dist_info, noise_estimate, frame_info, do_update_frame_probs_txtype, do_update_frame_probs_obmc, do_update_frame_probs_warp, do_update_frame_probs_interpfilter, winner_mode_params, mv_stats, zeromv_skip_thresh_exit_part, counts, frame_new_probs, gf_frame_index, frame_size_related_setup_done, compressor_stage, last_frame_type, fp_block_size, refresh_idx_available, do_frame_data_update, weber_bsize, is_dropped_frame, alloc_pyramid, do_border_pad, refresh_frame, optimize_seg_arr, consider reordering the fields or adding explicit padding members

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -O2 -analyze -disable-free -clear-ast-before-backend -disable-llvm-verifier -discard-value-names -main-file-name av1_cx_iface.c -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -fhalf-no-semantic-interposition -mframe-pointer=all -relaxed-aliasing -ffp-contract=off -fno-rounding-math -mconstructor-aliases -funwind-tables=2 -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -fdebug-compilation-dir=/root/firefox-clang/obj-x86_64-pc-linux-gnu/media/libaom -fcoverage-compilation-dir=/root/firefox-clang/obj-x86_64-pc-linux-gnu/media/libaom -resource-dir /usr/lib/llvm-23/lib/clang/23 -include /root/firefox-clang/obj-x86_64-pc-linux-gnu/mozilla-config.h -U _FORTIFY_SOURCE -D _FORTIFY_SOURCE=2 -D DEBUG=1 -D MOZ_HAS_MOZGLUE -I /root/firefox-clang/media/libaom -I /root/firefox-clang/obj-x86_64-pc-linux-gnu/media/libaom -I /root/firefox-clang/media/libaom/config/linux/x64 -I /root/firefox-clang/media/libaom/config -I /root/firefox-clang/third_party/aom -I /root/firefox-clang/obj-x86_64-pc-linux-gnu/dist/include -I /root/firefox-clang/obj-x86_64-pc-linux-gnu/dist/include/nspr -I /root/firefox-clang/obj-x86_64-pc-linux-gnu/dist/include/nss -D MOZILLA_CLIENT -internal-isystem /usr/lib/llvm-23/lib/clang/23/include -internal-isystem /usr/local/include -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/16/../../../../x86_64-linux-gnu/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -Wno-error=tautological-type-limit-compare -Wno-range-loop-analysis -Wno-error=deprecated-declarations -Wno-error=array-bounds -Wno-error=free-nonheap-object -Wno-error=atomic-alignment -Wno-error=deprecated-builtins -Wno-psabi -Wno-error=builtin-macro-redefined -Wno-unknown-warning-option -Wno-character-conversion -Wno-sign-compare -Wno-unused-function -Wno-unreachable-code -Wno-unneeded-internal-declaration -ferror-limit 19 -fstrict-flex-arrays=1 -stack-protector 2 -fstack-clash-protection -ftrivial-auto-var-init=pattern -fgnuc-version=4.2.1 -fskip-odr-check-in-gmf -fdiagnostics-absolute-paths -vectorize-loops -vectorize-slp -analyzer-checker optin.performance.Padding -analyzer-output=html -analyzer-config stable-report-filename=true -mllvm -dwarf-linkage-names=Abstract -faddrsig -fdwarf2-cfi-asm -o /tmp/scan-build-2026-09-01-224014-2642839-1 -x c /root/firefox-clang/third_party/aom/av1/av1_cx_iface.c
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/*!\file
13 * \brief Declares top-level encoder structures and functions.
14 */
15#ifndef AOM_AV1_ENCODER_ENCODER_H_
16#define AOM_AV1_ENCODER_ENCODER_H_
17
18#include <stdbool.h>
19#include <stdio.h>
20
21#include "config/aom_config.h"
22
23#include "aom/aomcx.h"
24#include "aom_util/aom_pthread.h"
25
26#include "av1/common/alloccommon.h"
27#include "av1/common/av1_common_int.h"
28#include "av1/common/blockd.h"
29#include "av1/common/entropymode.h"
30#include "av1/common/enums.h"
31#include "av1/common/reconintra.h"
32#include "av1/common/resize.h"
33#include "av1/common/thread_common.h"
34#include "av1/common/timing.h"
35
36#include "av1/encoder/aq_cyclicrefresh.h"
37#include "av1/encoder/av1_ext_ratectrl.h"
38#include "av1/encoder/av1_quantize.h"
39#include "av1/encoder/block.h"
40#include "av1/encoder/context_tree.h"
41#include "av1/encoder/enc_enums.h"
42#include "av1/encoder/encodemb.h"
43#include "av1/encoder/external_partition.h"
44#include "av1/encoder/firstpass.h"
45#include "av1/encoder/global_motion.h"
46#include "av1/encoder/level.h"
47#include "av1/encoder/lookahead.h"
48#include "av1/encoder/mcomp.h"
49#include "av1/encoder/pickcdef.h"
50#include "av1/encoder/ratectrl.h"
51#include "av1/encoder/rd.h"
52#include "av1/encoder/speed_features.h"
53#include "av1/encoder/svc_layercontext.h"
54#include "av1/encoder/temporal_filter.h"
55#if CONFIG_THREE_PASS0
56#include "av1/encoder/thirdpass.h"
57#endif
58#include "av1/encoder/tokenize.h"
59#include "av1/encoder/tpl_model.h"
60#include "av1/encoder/av1_noise_estimate.h"
61#include "av1/encoder/bitstream.h"
62
63#if CONFIG_INTERNAL_STATS0
64#include "aom_dsp/ssim.h"
65#endif
66#include "aom_dsp/variance.h"
67#if CONFIG_DENOISE1
68#include "aom_dsp/noise_model.h"
69#endif
70#if CONFIG_TUNE_VMAF0
71#include "av1/encoder/tune_vmaf.h"
72#endif
73#if CONFIG_AV1_TEMPORAL_DENOISING0
74#include "av1/encoder/av1_temporal_denoiser.h"
75#endif
76#if CONFIG_TUNE_BUTTERAUGLI0
77#include "av1/encoder/tune_butteraugli.h"
78#endif
79
80#include "aom/internal/aom_codec_internal.h"
81
82#ifdef __cplusplus
83extern "C" {
84#endif
85
86// TODO(yunqing, any): Added suppression tag to quiet Doxygen warnings. Need to
87// adjust it while we work on documentation.
88/*!\cond */
89// Number of frames required to test for scene cut detection
90#define SCENE_CUT_KEY_TEST_INTERVAL16 16
91
92// Lookahead index threshold to enable temporal filtering for second arf.
93#define TF_LOOKAHEAD_IDX_THR7 7
94
95#define HDR_QP_LEVELS10 10
96#define CHROMA_CB_QP_SCALE1.04 1.04
97#define CHROMA_CR_QP_SCALE1.04 1.04
98#define CHROMA_QP_SCALE-0.46 -0.46
99#define CHROMA_QP_OFFSET9.26 9.26
100#define QP_SCALE_FACTOR2.0 2.0
101#define DISABLE_HDR_LUMA_DELTAQ1 1
102
103// Rational number with an int64 numerator
104// This structure holds a fractional value
105typedef struct aom_rational64 {
106 int64_t num; // fraction numerator
107 int den; // fraction denominator
108} aom_rational64_t; // alias for struct aom_rational
109
110enum {
111 FRAMEFLAGS_KEY = 1 << 0,
112 FRAMEFLAGS_GOLDEN = 1 << 1,
113 FRAMEFLAGS_BWDREF = 1 << 2,
114 // TODO(zoeliu): To determine whether a frame flag is needed for ALTREF2_FRAME
115 FRAMEFLAGS_ALTREF = 1 << 3,
116 FRAMEFLAGS_INTRAONLY = 1 << 4,
117 FRAMEFLAGS_SWITCH = 1 << 5,
118 FRAMEFLAGS_ERROR_RESILIENT = 1 << 6,
119} UENUM1BYTE(FRAMETYPE_FLAGS); typedef uint8_t FRAMETYPE_FLAGS;
120
121#if CONFIG_FPMT_TEST0
122enum {
123 PARALLEL_ENCODE = 0,
124 PARALLEL_SIMULATION_ENCODE,
125 NUM_FPMT_TEST_ENCODES
126} UENUM1BYTE(FPMT_TEST_ENC_CFG); typedef uint8_t FPMT_TEST_ENC_CFG;
127#endif // CONFIG_FPMT_TEST
128// 0 level frames are sometimes used for rate control purposes, but for
129// reference mapping purposes, the minimum level should be 1.
130#define MIN_PYR_LEVEL1 1
131static inline int get_true_pyr_level(int frame_level, int frame_order,
132 int max_layer_depth) {
133 if (frame_order == 0) {
134 // Keyframe case
135 return MIN_PYR_LEVEL1;
136 } else if (frame_level == MAX_ARF_LAYERS6) {
137 // Leaves
138 return max_layer_depth;
139 } else if (frame_level == (MAX_ARF_LAYERS6 + 1)) {
140 // Altrefs
141 return MIN_PYR_LEVEL1;
142 }
143 return AOMMAX(MIN_PYR_LEVEL, frame_level)(((1) > (frame_level)) ? (1) : (frame_level));
144}
145
146enum {
147 NO_AQ = 0,
148 VARIANCE_AQ = 1,
149 COMPLEXITY_AQ = 2,
150 CYCLIC_REFRESH_AQ = 3,
151 AQ_MODE_COUNT // This should always be the last member of the enum
152} UENUM1BYTE(AQ_MODE); typedef uint8_t AQ_MODE;
153enum {
154 NO_DELTA_Q = 0,
155 DELTA_Q_OBJECTIVE = 1, // Modulation to improve objective quality
156 DELTA_Q_PERCEPTUAL = 2, // Modulation to improve video perceptual quality
157 DELTA_Q_PERCEPTUAL_AI = 3, // Perceptual quality opt for all intra mode
158 DELTA_Q_USER_RATING_BASED = 4, // User rating based delta q mode
159 DELTA_Q_HDR = 5, // QP adjustment based on HDR block pixel average
160 DELTA_Q_VARIANCE_BOOST = 6, // Variance Boost style modulation
161 DELTA_Q_MODE_COUNT // This should always be the last member of the enum
162} UENUM1BYTE(DELTAQ_MODE); typedef uint8_t DELTAQ_MODE;
163
164enum {
165 RESIZE_NONE = 0, // No frame resizing allowed.
166 RESIZE_FIXED = 1, // All frames are coded at the specified scale.
167 RESIZE_RANDOM = 2, // All frames are coded at a random scale.
168 RESIZE_DYNAMIC = 3, // Frames coded at lower scale based on rate control.
169 RESIZE_MODES
170} UENUM1BYTE(RESIZE_MODE); typedef uint8_t RESIZE_MODE;
171
172enum {
173 SS_CFG_SRC = 0,
174 SS_CFG_LOOKAHEAD = 1,
175 SS_CFG_FPF = 2,
176 SS_CFG_TOTAL = 3
177} UENUM1BYTE(SS_CFG_OFFSET); typedef uint8_t SS_CFG_OFFSET;
178
179enum {
180 DISABLE_SCENECUT, // For LAP, lag_in_frames < 19
181 ENABLE_SCENECUT_MODE_1, // For LAP, lag_in_frames >=19 and < 33
182 ENABLE_SCENECUT_MODE_2 // For twopass and LAP - lag_in_frames >=33
183} UENUM1BYTE(SCENECUT_MODE); typedef uint8_t SCENECUT_MODE;
184
185#define MAX_VBR_CORPUS_COMPLEXITY10000 10000
186
187typedef enum {
188 MOD_FP, // First pass
189 MOD_TF, // Temporal filtering
190 MOD_TPL, // TPL
191 MOD_GME, // Global motion estimation
192 MOD_ENC, // Encode stage
193 MOD_LPF, // Deblocking loop filter
194 MOD_CDEF_SEARCH, // CDEF search
195 MOD_CDEF, // CDEF frame
196 MOD_LR, // Loop restoration filtering
197 MOD_PACK_BS, // Pack bitstream
198 MOD_FRAME_ENC, // Frame Parallel encode
199 MOD_AI, // All intra
200 NUM_MT_MODULES
201} MULTI_THREADED_MODULES;
202
203/*!\endcond */
204
205/*!\enum COST_UPDATE_TYPE
206 * \brief This enum controls how often the entropy costs should be updated.
207 * \warning In case of any modifications/additions done to the enum
208 * COST_UPDATE_TYPE, the enum INTERNAL_COST_UPDATE_TYPE needs to be updated as
209 * well.
210 */
211typedef enum {
212 COST_UPD_SB, /*!< Update every sb. */
213 COST_UPD_SBROW, /*!< Update every sb rows inside a tile. */
214 COST_UPD_TILE, /*!< Update every tile. */
215 COST_UPD_OFF, /*!< Turn off cost updates. */
216 NUM_COST_UPDATE_TYPES, /*!< Number of cost update types. */
217} COST_UPDATE_TYPE;
218
219/*!\enum LOOPFILTER_CONTROL
220 * \brief This enum controls to which frames loopfilter is applied.
221 */
222typedef enum {
223 LOOPFILTER_NONE = 0, /*!< Disable loopfilter on all frames. */
224 LOOPFILTER_ALL = 1, /*!< Enable loopfilter for all frames. */
225 LOOPFILTER_REFERENCE = 2, /*!< Disable loopfilter on non reference frames. */
226 LOOPFILTER_SELECTIVELY =
227 3, /*!< Disable loopfilter on frames with low motion. */
228} LOOPFILTER_CONTROL;
229
230/*!\enum SKIP_APPLY_POSTPROC_FILTER
231 * \brief This enum controls the application of post-processing filters on a
232 * reconstructed frame.
233 */
234typedef enum {
235 SKIP_APPLY_RESTORATION = 1 << 0,
236 SKIP_APPLY_SUPERRES = 1 << 1,
237 SKIP_APPLY_CDEF = 1 << 2,
238 SKIP_APPLY_LOOPFILTER = 1 << 3,
239} SKIP_APPLY_POSTPROC_FILTER;
240
241/*!
242 * \brief Encoder config related to resize.
243 */
244typedef struct {
245 /*!
246 * Indicates the frame resize mode to be used by the encoder.
247 */
248 RESIZE_MODE resize_mode;
249 /*!
250 * Indicates the denominator for resize of inter frames, assuming 8 as the
251 * numerator. Its value ranges between 8-16.
252 */
253 uint8_t resize_scale_denominator;
254 /*!
255 * Indicates the denominator for resize of key frames, assuming 8 as the
256 * numerator. Its value ranges between 8-16.
257 */
258 uint8_t resize_kf_scale_denominator;
259} ResizeCfg;
260
261/*!
262 * \brief Encoder config for coding block partitioning.
263 */
264typedef struct {
265 /*!
266 * Flag to indicate if rectanguar partitions should be enabled.
267 */
268 bool_Bool enable_rect_partitions;
269 /*!
270 * Flag to indicate if AB partitions should be enabled.
271 */
272 bool_Bool enable_ab_partitions;
273 /*!
274 * Flag to indicate if 1:4 / 4:1 partitions should be enabled.
275 */
276 bool_Bool enable_1to4_partitions;
277 /*!
278 * Indicates the minimum partition size that should be allowed. Both width and
279 * height of a partition cannot be smaller than the min_partition_size.
280 */
281 BLOCK_SIZE min_partition_size;
282 /*!
283 * Indicates the maximum partition size that should be allowed. Both width and
284 * height of a partition cannot be larger than the max_partition_size.
285 */
286 BLOCK_SIZE max_partition_size;
287} PartitionCfg;
288
289/*!
290 * \brief Encoder flags for intra prediction.
291 */
292typedef struct {
293 /*!
294 * Flag to indicate if intra edge filtering process should be enabled.
295 */
296 bool_Bool enable_intra_edge_filter;
297 /*!
298 * Flag to indicate if recursive filtering based intra prediction should be
299 * enabled.
300 */
301 bool_Bool enable_filter_intra;
302 /*!
303 * Flag to indicate if smooth intra prediction modes should be enabled.
304 */
305 bool_Bool enable_smooth_intra;
306 /*!
307 * Flag to indicate if PAETH intra prediction mode should be enabled.
308 */
309 bool_Bool enable_paeth_intra;
310 /*!
311 * Flag to indicate if CFL uv intra mode should be enabled.
312 */
313 bool_Bool enable_cfl_intra;
314 /*!
315 * Flag to indicate if directional modes should be enabled.
316 */
317 bool_Bool enable_directional_intra;
318 /*!
319 * Flag to indicate if the subset of directional modes from D45 to D203 intra
320 * should be enabled. Has no effect if directional modes are disabled.
321 */
322 bool_Bool enable_diagonal_intra;
323 /*!
324 * Flag to indicate if delta angles for directional intra prediction should be
325 * enabled.
326 */
327 bool_Bool enable_angle_delta;
328 /*!
329 * Flag to indicate whether to automatically turn off several intral coding
330 * tools.
331 * This flag is only used when "--deltaq-mode=3" is true.
332 * When set to 1, the encoder will analyze the reconstruction quality
333 * as compared to the source image in the preprocessing pass.
334 * If the recontruction quality is considered high enough, we disable
335 * the following intra coding tools, for better encoding speed:
336 * "--enable_smooth_intra",
337 * "--enable_paeth_intra",
338 * "--enable_cfl_intra",
339 * "--enable_diagonal_intra".
340 */
341 bool_Bool auto_intra_tools_off;
342} IntraModeCfg;
343
344/*!
345 * \brief Encoder flags for transform sizes and types.
346 */
347typedef struct {
348 /*!
349 * Flag to indicate if 64-pt transform should be enabled.
350 */
351 bool_Bool enable_tx64;
352 /*!
353 * Flag to indicate if flip and identity transform types should be enabled.
354 */
355 bool_Bool enable_flip_idtx;
356 /*!
357 * Flag to indicate if rectangular transform should be enabled.
358 */
359 bool_Bool enable_rect_tx;
360 /*!
361 * Flag to indicate whether or not to use a default reduced set for ext-tx
362 * rather than the potential full set of 16 transforms.
363 */
364 bool_Bool reduced_tx_type_set;
365 /*!
366 * Flag to indicate if transform type for intra blocks should be limited to
367 * DCT_DCT.
368 */
369 bool_Bool use_intra_dct_only;
370 /*!
371 * Flag to indicate if transform type for inter blocks should be limited to
372 * DCT_DCT.
373 */
374 bool_Bool use_inter_dct_only;
375 /*!
376 * Flag to indicate if intra blocks should use default transform type
377 * (mode-dependent) only.
378 */
379 bool_Bool use_intra_default_tx_only;
380 /*!
381 * Flag to indicate if transform size search should be enabled.
382 */
383 bool_Bool enable_tx_size_search;
384} TxfmSizeTypeCfg;
385
386/*!
387 * \brief Encoder flags for compound prediction modes.
388 */
389typedef struct {
390 /*!
391 * Flag to indicate if distance-weighted compound type should be enabled.
392 */
393 bool_Bool enable_dist_wtd_comp;
394 /*!
395 * Flag to indicate if masked (wedge/diff-wtd) compound type should be
396 * enabled.
397 */
398 bool_Bool enable_masked_comp;
399 /*!
400 * Flag to indicate if smooth interintra mode should be enabled.
401 */
402 bool_Bool enable_smooth_interintra;
403 /*!
404 * Flag to indicate if difference-weighted compound type should be enabled.
405 */
406 bool_Bool enable_diff_wtd_comp;
407 /*!
408 * Flag to indicate if inter-inter wedge compound type should be enabled.
409 */
410 bool_Bool enable_interinter_wedge;
411 /*!
412 * Flag to indicate if inter-intra wedge compound type should be enabled.
413 */
414 bool_Bool enable_interintra_wedge;
415} CompoundTypeCfg;
416
417/*!
418 * \brief Encoder config related to frame super-resolution.
419 */
420typedef struct {
421 /*!
422 * Indicates the qindex based threshold to be used when AOM_SUPERRES_QTHRESH
423 * mode is used for inter frames.
424 */
425 int superres_qthresh;
426 /*!
427 * Indicates the qindex based threshold to be used when AOM_SUPERRES_QTHRESH
428 * mode is used for key frames.
429 */
430 int superres_kf_qthresh;
431 /*!
432 * Indicates the denominator of the fraction that specifies the ratio between
433 * the superblock width before and after upscaling for inter frames. The
434 * numerator of this fraction is equal to the constant SCALE_NUMERATOR.
435 */
436 uint8_t superres_scale_denominator;
437 /*!
438 * Indicates the denominator of the fraction that specifies the ratio between
439 * the superblock width before and after upscaling for key frames. The
440 * numerator of this fraction is equal to the constant SCALE_NUMERATOR.
441 */
442 uint8_t superres_kf_scale_denominator;
443 /*!
444 * Indicates the Super-resolution mode to be used by the encoder.
445 */
446 aom_superres_mode superres_mode;
447 /*!
448 * Flag to indicate if super-resolution should be enabled for the sequence.
449 */
450 bool_Bool enable_superres;
451} SuperResCfg;
452
453/*!
454 * \brief Encoder config related to the coding of key frames.
455 */
456typedef struct {
457 /*!
458 * Indicates the minimum distance to a key frame.
459 */
460 int key_freq_min;
461
462 /*!
463 * Indicates the maximum distance to a key frame.
464 */
465 int key_freq_max;
466
467 /*!
468 * Indicates if temporal filtering should be applied on keyframe.
469 */
470 int enable_keyframe_filtering;
471
472 /*!
473 * Indicates the number of frames after which a frame may be coded as an
474 * S-Frame.
475 */
476 int sframe_dist;
477
478 /*!
479 * Indicates how an S-Frame should be inserted.
480 * 1: the considered frame will be made into an S-Frame only if it is an
481 * altref frame. 2: the next altref frame will be made into an S-Frame.
482 */
483 int sframe_mode;
484
485 /*!
486 * Indicates if encoder should autodetect cut scenes and set the keyframes.
487 */
488 bool_Bool auto_key;
489
490 /*!
491 * Indicates the forward key frame distance.
492 */
493 int fwd_kf_dist;
494
495 /*!
496 * Indicates if forward keyframe reference should be enabled.
497 */
498 bool_Bool fwd_kf_enabled;
499
500 /*!
501 * Indicates if S-Frames should be enabled for the sequence.
502 */
503 bool_Bool enable_sframe;
504
505 /*!
506 * Indicates if intra block copy prediction mode should be enabled or not.
507 */
508 bool_Bool enable_intrabc;
509} KeyFrameCfg;
510
511/*!
512 * \brief Encoder rate control configuration parameters
513 */
514typedef struct {
515 /*!\cond */
516 // BUFFERING PARAMETERS
517 /*!\endcond */
518 /*!
519 * Indicates the amount of data that will be buffered by the decoding
520 * application prior to beginning playback, and is expressed in units of
521 * time(milliseconds).
522 */
523 int64_t starting_buffer_level_ms;
524 /*!
525 * Indicates the amount of data that the encoder should try to maintain in the
526 * decoder's buffer, and is expressed in units of time(milliseconds).
527 */
528 int64_t optimal_buffer_level_ms;
529 /*!
530 * Indicates the maximum amount of data that may be buffered by the decoding
531 * application, and is expressed in units of time(milliseconds).
532 */
533 int64_t maximum_buffer_size_ms;
534
535 /*!
536 * Indicates the bandwidth to be used in bits per second.
537 */
538 int64_t target_bandwidth;
539
540 /*!
541 * Indicates average complexity of the corpus in single pass vbr based on
542 * LAP. 0 indicates that corpus complexity vbr mode is disabled.
543 */
544 unsigned int vbr_corpus_complexity_lap;
545 /*!
546 * Indicates the maximum allowed bitrate for any intra frame as % of bitrate
547 * target.
548 */
549 unsigned int max_intra_bitrate_pct;
550 /*!
551 * Indicates the maximum allowed bitrate for any inter frame as % of bitrate
552 * target.
553 */
554 unsigned int max_inter_bitrate_pct;
555 /*!
556 * Indicates the percentage of rate boost for golden frame in CBR mode.
557 */
558 unsigned int gf_cbr_boost_pct;
559 /*!
560 * min_cr / 100 indicates the target minimum compression ratio for each
561 * frame.
562 */
563 unsigned int min_cr;
564 /*!
565 * Indicates the frame drop threshold.
566 */
567 int drop_frames_water_mark;
568 /*!
569 * under_shoot_pct indicates the tolerance of the VBR algorithm to
570 * undershoot and is used as a trigger threshold for more aggressive
571 * adaptation of Q. It's value can range from 0-100.
572 */
573 int under_shoot_pct;
574 /*!
575 * over_shoot_pct indicates the tolerance of the VBR algorithm to overshoot
576 * and is used as a trigger threshold for more aggressive adaptation of Q.
577 * It's value can range from 0-1000.
578 */
579 int over_shoot_pct;
580 /*!
581 * Indicates the maximum qindex that can be used by the quantizer i.e. the
582 * worst quality qindex.
583 */
584 int worst_allowed_q;
585 /*!
586 * Indicates the minimum qindex that can be used by the quantizer i.e. the
587 * best quality qindex.
588 */
589 int best_allowed_q;
590 /*!
591 * Indicates the Constant/Constrained Quality level.
592 */
593 int cq_level;
594 /*!
595 * Indicates if the encoding mode is vbr, cbr, constrained quality or
596 * constant quality.
597 */
598 enum aom_rc_mode mode;
599 /*!
600 * Indicates the bias (expressed on a scale of 0 to 100) for determining
601 * target size for the current frame. The value 0 indicates the optimal CBR
602 * mode value should be used, and 100 indicates the optimal VBR mode value
603 * should be used.
604 */
605 int vbrbias;
606 /*!
607 * Indicates the minimum bitrate to be used for a single frame as a percentage
608 * of the target bitrate.
609 */
610 int vbrmin_section;
611 /*!
612 * Indicates the maximum bitrate to be used for a single frame as a percentage
613 * of the target bitrate.
614 */
615 int vbrmax_section;
616
617 /*!
618 * Indicates the maximum consecutive amount of frame drops, in units of time
619 * (milliseconds). This is converted to frame units internally. Only used in
620 * CBR mode.
621 */
622 int max_consec_drop_ms;
623 /*!
624 * Force to allow the usage of maximum q in vbr mode.
625 */
626 int force_max_q;
627} RateControlCfg;
628
629/*!\cond */
630typedef struct {
631 // Indicates the number of frames lag before encoding is started.
632 int lag_in_frames;
633 // Indicates the minimum gf/arf interval to be used.
634 int min_gf_interval;
635 // Indicates the maximum gf/arf interval to be used.
636 int max_gf_interval;
637 // Indicates the minimum height for GF group pyramid structure to be used.
638 int gf_min_pyr_height;
639 // Indicates the maximum height for GF group pyramid structure to be used.
640 int gf_max_pyr_height;
641 // Indicates if automatic set and use of altref frames should be enabled.
642 bool_Bool enable_auto_arf;
643 // Indicates if automatic set and use of (b)ackward (r)ef (f)rames should be
644 // enabled.
645 bool_Bool enable_auto_brf;
646} GFConfig;
647
648typedef struct {
649 // Indicates the number of tile groups.
650 unsigned int num_tile_groups;
651 // Indicates the MTU size for a tile group. If mtu is non-zero,
652 // num_tile_groups is set to DEFAULT_MAX_NUM_TG.
653 unsigned int mtu;
654 // Indicates the number of tile columns in log2.
655 int tile_columns;
656 // Indicates the number of tile rows in log2.
657 int tile_rows;
658 // Indicates the number of widths in the tile_widths[] array.
659 int tile_width_count;
660 // Indicates the number of heights in the tile_heights[] array.
661 int tile_height_count;
662 // Indicates the tile widths, and may be empty.
663 int tile_widths[MAX_TILE_COLS64];
664 // Indicates the tile heights, and may be empty.
665 int tile_heights[MAX_TILE_ROWS64];
666 // Indicates if large scale tile coding should be used.
667 bool_Bool enable_large_scale_tile;
668 // Indicates if single tile decoding mode should be enabled.
669 bool_Bool enable_single_tile_decoding;
670 // Indicates if EXT_TILE_DEBUG should be enabled.
671 bool_Bool enable_ext_tile_debug;
672} TileConfig;
673
674typedef struct {
675 // Indicates the width of the input frame.
676 int width;
677 // Indicates the height of the input frame.
678 int height;
679 // If forced_max_frame_width is non-zero then it is used to force the maximum
680 // frame width written in write_sequence_header().
681 int forced_max_frame_width;
682 // If forced_max_frame_width is non-zero then it is used to force the maximum
683 // frame height written in write_sequence_header().
684 int forced_max_frame_height;
685 // Indicates the frame width after applying both super-resolution and resize
686 // to the coded frame.
687 int render_width;
688 // Indicates the frame height after applying both super-resolution and resize
689 // to the coded frame.
690 int render_height;
691} FrameDimensionCfg;
692
693typedef struct {
694 // Indicates if warped motion should be enabled.
695 bool_Bool enable_warped_motion;
696 // Indicates if warped motion should be evaluated or not.
697 bool_Bool allow_warped_motion;
698 // Indicates if OBMC motion should be enabled.
699 bool_Bool enable_obmc;
700} MotionModeCfg;
701
702typedef struct {
703 // Timing info for each frame.
704 aom_timing_info_t timing_info;
705 // Indicates the number of time units of a decoding clock.
706 uint32_t num_units_in_decoding_tick;
707 // Indicates if decoder model information is present in the coded sequence
708 // header.
709 bool_Bool decoder_model_info_present_flag;
710 // Indicates if display model information is present in the coded sequence
711 // header.
712 bool_Bool display_model_info_present_flag;
713 // Indicates if timing info for each frame is present.
714 bool_Bool timing_info_present;
715} DecoderModelCfg;
716
717typedef struct {
718 // Indicates the update frequency for coeff costs.
719 COST_UPDATE_TYPE coeff;
720 // Indicates the update frequency for mode costs.
721 COST_UPDATE_TYPE mode;
722 // Indicates the update frequency for mv costs.
723 COST_UPDATE_TYPE mv;
724 // Indicates the update frequency for dv costs.
725 COST_UPDATE_TYPE dv;
726} CostUpdateFreq;
727
728typedef struct {
729 // Indicates the maximum number of reference frames allowed per frame.
730 unsigned int max_reference_frames;
731 // Indicates if the reduced set of references should be enabled.
732 bool_Bool enable_reduced_reference_set;
733 // Indicates if one-sided compound should be enabled.
734 bool_Bool enable_onesided_comp;
735} RefFrameCfg;
736
737typedef struct {
738 // Indicates the color space that should be used.
739 aom_color_primaries_t color_primaries;
740 // Indicates the characteristics of transfer function to be used.
741 aom_transfer_characteristics_t transfer_characteristics;
742 // Indicates the matrix coefficients to be used for the transfer function.
743 aom_matrix_coefficients_t matrix_coefficients;
744 // Indicates the chroma 4:2:0 sample position info.
745 aom_chroma_sample_position_t chroma_sample_position;
746 // Indicates if a limited color range or full color range should be used.
747 aom_color_range_t color_range;
748} ColorCfg;
749
750typedef struct {
751 // Indicates if extreme motion vector unit test should be enabled or not.
752 unsigned int motion_vector_unit_test;
753 // Indicates if superblock multipass unit test should be enabled or not.
754 unsigned int sb_multipass_unit_test;
755} UnitTestCfg;
756
757typedef struct {
758 // Indicates the file path to the VMAF model.
759 const char *vmaf_model_path;
760 // Indicates the path to the film grain parameters.
761 const char *film_grain_table_filename;
762 // Indicates the visual tuning metric.
763 aom_tune_metric tuning;
764 // Indicates if the current content is screen or default type.
765 aom_tune_content content;
766 // Indicates the film grain parameters.
767 int film_grain_test_vector;
768 // Indicates the in-block distortion metric to use.
769 aom_dist_metric dist_metric;
770} TuneCfg;
771
772typedef struct {
773 // Indicates the framerate of the input video.
774 double init_framerate;
775 // Indicates the actual bit-depth of the input source.
776 unsigned int input_bit_depth;
777 // Indicates the maximum number of frames to be encoded.
778 unsigned int limit;
779 // Indicates the chrome subsampling x value.
780 unsigned int chroma_subsampling_x;
781 // Indicates the chrome subsampling y value.
782 unsigned int chroma_subsampling_y;
783} InputCfg;
784
785typedef struct {
786 // Controls how the encoder applies fixed QP offsets.
787 // If the value is 0, QP offsets are chosen adaptively.
788 // If the value is 1, fixed QP offsets are picked automatically from cq_level.
789 // If the value is 2, no QP offsets will be applied.
790 int use_fixed_qp_offsets;
791 // Indicates the minimum flatness of the quantization matrix.
792 int qm_minlevel;
793 // Indicates the maximum flatness of the quantization matrix.
794 int qm_maxlevel;
795 // Indicates if adaptive quantize_b should be enabled.
796 int quant_b_adapt;
797 // Indicates the Adaptive Quantization mode to be used.
798 AQ_MODE aq_mode;
799 // Indicates the delta q mode to be used.
800 DELTAQ_MODE deltaq_mode;
801 // Indicates the delta q mode strength.
802 unsigned int deltaq_strength;
803 // Indicates if delta quantization should be enabled in chroma planes.
804 bool_Bool enable_chroma_deltaq;
805 // Indicates if delta quantization should be enabled for hdr video
806 bool_Bool enable_hdr_deltaq;
807 // Indicates if encoding with quantization matrices should be enabled.
808 bool_Bool using_qm;
809} QuantizationCfg;
810
811/*!\endcond */
812/*!
813 * \brief Algorithm configuration parameters.
814 */
815typedef struct {
816 /*!
817 * Controls the level at which rate-distortion optimization of transform
818 * coefficients favors sharpness in the block. Has no impact on RD when set
819 * to zero (default).
820 *
821 * For values 1-7, eob and skip block optimization are
822 * avoided and rdmult is adjusted in favor of block sharpness.
823 *
824 * In all-intra mode or tune IQ or SSIMULACRA2: it also sets the
825 * `loop_filter_sharpness` syntax element in the bitstream. Larger values
826 * increasingly reduce how much the filtering can change the sample values on
827 * block edges to favor perceived sharpness.
828 */
829 int sharpness;
830
831 /*!
832 * Indicates if sharpness is adapted based on frame QP
833 */
834 bool_Bool enable_adaptive_sharpness;
835
836 /*!
837 * Indicates the trellis optimization mode of quantized coefficients.
838 * 0: disabled
839 * 1: enabled
840 * 2: enabled for rd search
841 * 3: true for estimate yrd search
842 */
843 int disable_trellis_quant;
844
845 /*!
846 * The maximum number of frames used to create an arf.
847 */
848 int arnr_max_frames;
849
850 /*!
851 * The temporal filter strength for arf used when creating ARFs.
852 */
853 int arnr_strength;
854
855 /*!
856 * Indicates the CDF update mode
857 * 0: no update
858 * 1: update on every frame(default)
859 * 2: selectively update
860 */
861 uint8_t cdf_update_mode;
862
863 /*!
864 * Indicates if RDO based on frame temporal dependency should be enabled.
865 */
866 bool_Bool enable_tpl_model;
867
868 /*!
869 * Indicates if coding of overlay frames for filtered ALTREF frames is
870 * enabled.
871 */
872 bool_Bool enable_overlay;
873
874 /*!
875 * Controls loop filtering
876 * 0: Loop filter is disabled for all frames
877 * 1: Loop filter is enabled for all frames
878 * 2: Loop filter is disabled for non-reference frames
879 * 3: Loop filter is disables for the frames with low motion
880 */
881 LOOPFILTER_CONTROL loopfilter_control;
882
883 /*!
884 * Indicates if the application of post-processing filters should be skipped
885 * on reconstructed frame.
886 */
887 bool_Bool skip_postproc_filtering;
888
889 /*!
890 * Indicates if mode and reference frame delta should be enabled during
891 * loopfiltering.
892 */
893 int mode_ref_delta_enabled;
894
895 /*!
896 * Controls screen content detection mode
897 */
898 aom_screen_detection_mode screen_detection_mode;
899} AlgoCfg;
900/*!\cond */
901
902typedef struct {
903 // Indicates the codec bit-depth.
904 aom_bit_depth_t bit_depth;
905 // Indicates the superblock size that should be used by the encoder.
906 aom_superblock_size_t superblock_size;
907 // Indicates if loopfilter modulation should be enabled.
908 bool_Bool enable_deltalf_mode;
909 // Indicates how CDEF should be applied.
910 CDEF_CONTROL cdef_control;
911 // Indicates if loop restoration filter should be enabled.
912 bool_Bool enable_restoration;
913 // When enabled, video mode should be used even for single frame input.
914 bool_Bool force_video_mode;
915 // Indicates if the error resiliency features should be enabled.
916 bool_Bool error_resilient_mode;
917 // Indicates if frame parallel decoding feature should be enabled.
918 bool_Bool frame_parallel_decoding_mode;
919 // Indicates if the input should be encoded as monochrome.
920 bool_Bool enable_monochrome;
921 // When enabled, the encoder will use a full header even for still pictures.
922 // When disabled, a reduced header is used for still pictures.
923 bool_Bool full_still_picture_hdr;
924 // Indicates if dual interpolation filters should be enabled.
925 bool_Bool enable_dual_filter;
926 // Indicates if frame order hint should be enabled or not.
927 bool_Bool enable_order_hint;
928 // Indicates if ref_frame_mvs should be enabled at the sequence level.
929 bool_Bool ref_frame_mvs_present;
930 // Indicates if ref_frame_mvs should be enabled at the frame level.
931 bool_Bool enable_ref_frame_mvs;
932 // Indicates if interintra compound mode is enabled.
933 bool_Bool enable_interintra_comp;
934 // Indicates if global motion should be enabled.
935 bool_Bool enable_global_motion;
936 // Indicates if palette should be enabled.
937 bool_Bool enable_palette;
938} ToolCfg;
939
940/*!\endcond */
941/*!
942 * \brief Main encoder configuration data structure.
943 */
944typedef struct AV1EncoderConfig {
945 /*!\cond */
946 // Configuration related to the input video.
947 InputCfg input_cfg;
948
949 // Configuration related to frame-dimensions.
950 FrameDimensionCfg frm_dim_cfg;
951
952 /*!\endcond */
953 /*!
954 * Encoder algorithm configuration.
955 */
956 AlgoCfg algo_cfg;
957
958 /*!
959 * Configuration related to key-frames.
960 */
961 KeyFrameCfg kf_cfg;
962
963 /*!
964 * Rate control configuration
965 */
966 RateControlCfg rc_cfg;
967 /*!\cond */
968
969 // Configuration related to Quantization.
970 QuantizationCfg q_cfg;
971
972 // Internal frame size scaling.
973 ResizeCfg resize_cfg;
974
975 // Frame Super-Resolution size scaling.
976 SuperResCfg superres_cfg;
977
978 /*!\endcond */
979 /*!
980 * stats_in buffer contains all of the stats packets produced in the first
981 * pass, concatenated.
982 */
983 aom_fixed_buf_t twopass_stats_in;
984 /*!\cond */
985
986 // Configuration related to encoder toolsets.
987 ToolCfg tool_cfg;
988
989 // Configuration related to Group of frames.
990 GFConfig gf_cfg;
991
992 // Tile related configuration parameters.
993 TileConfig tile_cfg;
994
995 // Configuration related to Tune.
996 TuneCfg tune_cfg;
997
998 // Configuration related to color.
999 ColorCfg color_cfg;
1000
1001 // Configuration related to decoder model.
1002 DecoderModelCfg dec_model_cfg;
1003
1004 // Configuration related to reference frames.
1005 RefFrameCfg ref_frm_cfg;
1006
1007 // Configuration related to unit tests.
1008 UnitTestCfg unit_test_cfg;
1009
1010 // Flags related to motion mode.
1011 MotionModeCfg motion_mode_cfg;
1012
1013 // Flags related to intra mode search.
1014 IntraModeCfg intra_mode_cfg;
1015
1016 // Flags related to transform size/type.
1017 TxfmSizeTypeCfg txfm_cfg;
1018
1019 // Flags related to compound type.
1020 CompoundTypeCfg comp_type_cfg;
1021
1022 // Partition related information.
1023 PartitionCfg part_cfg;
1024
1025 // Configuration related to frequency of cost update.
1026 CostUpdateFreq cost_upd_freq;
1027
1028#if CONFIG_DENOISE1
1029 // Indicates the noise level.
1030 float noise_level;
1031 // Indicates the the denoisers block size.
1032 int noise_block_size;
1033 // Indicates whether to apply denoising to the frame to be encoded
1034 int enable_dnl_denoising;
1035#endif
1036
1037#if CONFIG_AV1_TEMPORAL_DENOISING0
1038 // Noise sensitivity.
1039 int noise_sensitivity;
1040#endif
1041 // Bit mask to specify which tier each of the 32 possible operating points
1042 // conforms to.
1043 unsigned int tier_mask;
1044
1045 // Indicates the number of pixels off the edge of a reference frame we're
1046 // allowed to go when forming an inter prediction.
1047 int border_in_pixels;
1048
1049 // Indicates the maximum number of threads that may be used by the encoder.
1050 int max_threads;
1051
1052 // Indicates the speed preset to be used.
1053 int speed;
1054
1055 // Enable the low complexity decode mode.
1056 unsigned int enable_low_complexity_decode;
1057
1058 // Indicates the target sequence level index for each operating point(OP).
1059 AV1_LEVEL target_seq_level_idx[MAX_NUM_OPERATING_POINTS(8 * 4)];
1060
1061 // Indicates the bitstream profile to be used.
1062 BITSTREAM_PROFILE profile;
1063
1064 /*!\endcond */
1065 /*!
1066 * Indicates the current encoder pass :
1067 * AOM_RC_ONE_PASS = One pass encode,
1068 * AOM_RC_FIRST_PASS = First pass of multiple-pass
1069 * AOM_RC_SECOND_PASS = Second pass of multiple-pass
1070 * AOM_RC_THIRD_PASS = Third pass of multiple-pass
1071 */
1072 enum aom_enc_pass pass;
1073 /*!\cond */
1074
1075 // Total number of encoding passes.
1076 int passes;
1077
1078 // the name of the second pass output file when passes > 2
1079 const char *two_pass_output;
1080
1081 // the name of the second pass log file when passes > 2
1082 const char *second_pass_log;
1083
1084 // Indicates if the encoding is GOOD or REALTIME.
1085 MODE mode;
1086
1087 // Indicates if row-based multi-threading should be enabled or not.
1088 bool_Bool row_mt;
1089
1090 // Indicates if frame parallel multi-threading should be enabled or not.
1091 bool_Bool fp_mt;
1092
1093 // Indicates if 16bit frame buffers are to be used i.e., the content is >
1094 // 8-bit.
1095 bool_Bool use_highbitdepth;
1096
1097 // Indicates the bitstream syntax mode. 0 indicates bitstream is saved as
1098 // Section 5 bitstream, while 1 indicates the bitstream is saved in Annex - B
1099 // format.
1100 bool_Bool save_as_annexb;
1101
1102 // The path for partition stats reading and writing, used in the experiment
1103 // CONFIG_PARTITION_SEARCH_ORDER.
1104 const char *partition_info_path;
1105
1106 // The flag that indicates whether we use an external rate distribution to
1107 // guide adaptive quantization. It requires --deltaq-mode=3. The rate
1108 // distribution map file name is stored in |rate_distribution_info|.
1109 unsigned int enable_rate_guide_deltaq;
1110
1111 // The input file of rate distribution information used in all intra mode
1112 // to determine delta quantization.
1113 const char *rate_distribution_info;
1114
1115 // Exit the encoder when it fails to encode to a given level.
1116 int strict_level_conformance;
1117
1118 // Max depth for the GOP after a key frame
1119 int kf_max_pyr_height;
1120
1121 // A flag to control if we enable the superblock qp sweep for a given lambda
1122 int sb_qp_sweep;
1123 /*!\endcond */
1124} AV1EncoderConfig;
1125
1126/*!\cond */
1127static inline int is_lossless_requested(const RateControlCfg *const rc_cfg) {
1128 return rc_cfg->best_allowed_q == 0 && rc_cfg->worst_allowed_q == 0;
1129}
1130/*!\endcond */
1131
1132/*!
1133 * \brief Encoder-side probabilities for pruning of various AV1 tools
1134 */
1135typedef struct {
1136 /*!
1137 * obmc_probs[i][j] is the probability of OBMC being the best motion mode for
1138 * jth block size and ith frame update type, averaged over past frames. If
1139 * obmc_probs[i][j] < thresh, then OBMC search is pruned.
1140 */
1141 int obmc_probs[FRAME_UPDATE_TYPES][BLOCK_SIZES_ALL];
1142
1143 /*!
1144 * warped_probs[i] is the probability of warped motion being the best motion
1145 * mode for ith frame update type, averaged over past frames. If
1146 * warped_probs[i] < thresh, then warped motion search is pruned.
1147 */
1148 int warped_probs[FRAME_UPDATE_TYPES];
1149
1150 /*!
1151 * tx_type_probs[i][j][k] is the probability of kth tx_type being the best
1152 * for jth transform size and ith frame update type, averaged over past
1153 * frames. If tx_type_probs[i][j][k] < thresh, then transform search for that
1154 * type is pruned.
1155 */
1156 int tx_type_probs[FRAME_UPDATE_TYPES][TX_SIZES_ALL][TX_TYPES];
1157
1158 /*!
1159 * switchable_interp_probs[i][j][k] is the probability of kth interpolation
1160 * filter being the best for jth filter context and ith frame update type,
1161 * averaged over past frames. If switchable_interp_probs[i][j][k] < thresh,
1162 * then interpolation filter search is pruned for that case.
1163 */
1164 int switchable_interp_probs[FRAME_UPDATE_TYPES][SWITCHABLE_FILTER_CONTEXTS((SWITCHABLE_FILTERS + 1) * 4)]
1165 [SWITCHABLE_FILTERS];
1166} FrameProbInfo;
1167
1168/*!\cond */
1169
1170typedef struct FRAME_COUNTS {
1171// Note: This structure should only contain 'unsigned int' fields, or
1172// aggregates built solely from 'unsigned int' fields/elements
1173#if CONFIG_ENTROPY_STATS0
1174 unsigned int kf_y_mode[KF_MODE_CONTEXTS5][KF_MODE_CONTEXTS5][INTRA_MODES];
1175 unsigned int angle_delta[DIRECTIONAL_MODES8][2 * MAX_ANGLE_DELTA3 + 1];
1176 unsigned int y_mode[BLOCK_SIZE_GROUPS4][INTRA_MODES];
1177 unsigned int uv_mode[CFL_ALLOWED_TYPES][INTRA_MODES][UV_INTRA_MODES];
1178 unsigned int cfl_sign[CFL_JOINT_SIGNS(CFL_SIGNS * CFL_SIGNS - 1)];
1179 unsigned int cfl_alpha[CFL_ALPHA_CONTEXTS((CFL_SIGNS * CFL_SIGNS - 1) + 1 - CFL_SIGNS)][CFL_ALPHABET_SIZE(1 << 4)];
1180 unsigned int palette_y_mode[PALATTE_BSIZE_CTXS7][PALETTE_Y_MODE_CONTEXTS3][2];
1181 unsigned int palette_uv_mode[PALETTE_UV_MODE_CONTEXTS2][2];
1182 unsigned int palette_y_size[PALATTE_BSIZE_CTXS7][PALETTE_SIZES];
1183 unsigned int palette_uv_size[PALATTE_BSIZE_CTXS7][PALETTE_SIZES];
1184 unsigned int palette_y_color_index[PALETTE_SIZES]
1185 [PALETTE_COLOR_INDEX_CONTEXTS5]
1186 [PALETTE_COLORS];
1187 unsigned int palette_uv_color_index[PALETTE_SIZES]
1188 [PALETTE_COLOR_INDEX_CONTEXTS5]
1189 [PALETTE_COLORS];
1190 unsigned int partition[PARTITION_CONTEXTS(5 * 4)][EXT_PARTITION_TYPES];
1191 unsigned int txb_skip[TOKEN_CDF_Q_CTXS4][TX_SIZES][TXB_SKIP_CONTEXTS13][2];
1192 unsigned int eob_extra[TOKEN_CDF_Q_CTXS4][TX_SIZES][PLANE_TYPES]
1193 [EOB_COEF_CONTEXTS9][2];
1194 unsigned int dc_sign[PLANE_TYPES][DC_SIGN_CONTEXTS3][2];
1195 unsigned int coeff_lps[TX_SIZES][PLANE_TYPES][BR_CDF_SIZE(4) - 1][LEVEL_CONTEXTS21]
1196 [2];
1197 unsigned int eob_flag[TX_SIZES][PLANE_TYPES][EOB_COEF_CONTEXTS9][2];
1198 unsigned int eob_multi16[TOKEN_CDF_Q_CTXS4][PLANE_TYPES][2][5];
1199 unsigned int eob_multi32[TOKEN_CDF_Q_CTXS4][PLANE_TYPES][2][6];
1200 unsigned int eob_multi64[TOKEN_CDF_Q_CTXS4][PLANE_TYPES][2][7];
1201 unsigned int eob_multi128[TOKEN_CDF_Q_CTXS4][PLANE_TYPES][2][8];
1202 unsigned int eob_multi256[TOKEN_CDF_Q_CTXS4][PLANE_TYPES][2][9];
1203 unsigned int eob_multi512[TOKEN_CDF_Q_CTXS4][PLANE_TYPES][2][10];
1204 unsigned int eob_multi1024[TOKEN_CDF_Q_CTXS4][PLANE_TYPES][2][11];
1205 unsigned int coeff_lps_multi[TOKEN_CDF_Q_CTXS4][TX_SIZES][PLANE_TYPES]
1206 [LEVEL_CONTEXTS21][BR_CDF_SIZE(4)];
1207 unsigned int coeff_base_multi[TOKEN_CDF_Q_CTXS4][TX_SIZES][PLANE_TYPES]
1208 [SIG_COEF_CONTEXTS(26 + 16)][NUM_BASE_LEVELS2 + 2];
1209 unsigned int coeff_base_eob_multi[TOKEN_CDF_Q_CTXS4][TX_SIZES][PLANE_TYPES]
1210 [SIG_COEF_CONTEXTS_EOB4][NUM_BASE_LEVELS2 + 1];
1211 unsigned int newmv_mode[NEWMV_MODE_CONTEXTS6][2];
1212 unsigned int zeromv_mode[GLOBALMV_MODE_CONTEXTS2][2];
1213 unsigned int refmv_mode[REFMV_MODE_CONTEXTS6][2];
1214 unsigned int drl_mode[DRL_MODE_CONTEXTS3][2];
1215 unsigned int inter_compound_mode[INTER_MODE_CONTEXTS8][INTER_COMPOUND_MODES(1 + NEW_NEWMV - NEAREST_NEARESTMV)];
1216 unsigned int wedge_idx[BLOCK_SIZES_ALL][16];
1217 unsigned int interintra[BLOCK_SIZE_GROUPS4][2];
1218 unsigned int interintra_mode[BLOCK_SIZE_GROUPS4][INTERINTRA_MODES];
1219 unsigned int wedge_interintra[BLOCK_SIZES_ALL][2];
1220 unsigned int compound_type[BLOCK_SIZES_ALL][MASKED_COMPOUND_TYPES];
1221 unsigned int motion_mode[BLOCK_SIZES_ALL][MOTION_MODES];
1222 unsigned int obmc[BLOCK_SIZES_ALL][2];
1223 unsigned int intra_inter[INTRA_INTER_CONTEXTS4][2];
1224 unsigned int comp_inter[COMP_INTER_CONTEXTS5][2];
1225 unsigned int comp_ref_type[COMP_REF_TYPE_CONTEXTS5][2];
1226 unsigned int uni_comp_ref[UNI_COMP_REF_CONTEXTS3][UNIDIR_COMP_REFS - 1][2];
1227 unsigned int single_ref[REF_CONTEXTS3][SINGLE_REFS - 1][2];
1228 unsigned int comp_ref[REF_CONTEXTS3][FWD_REFS - 1][2];
1229 unsigned int comp_bwdref[REF_CONTEXTS3][BWD_REFS - 1][2];
1230 unsigned int intrabc[2];
1231
1232 unsigned int txfm_partition[TXFM_PARTITION_CONTEXTS((TX_SIZES - TX_8X8) * 6 - 3)][2];
1233 unsigned int intra_tx_size[MAX_TX_CATS(TX_SIZES - ((TX_4X4) + 1))][TX_SIZE_CONTEXTS3][MAX_TX_DEPTH2 + 1];
1234 unsigned int skip_mode[SKIP_MODE_CONTEXTS3][2];
1235 unsigned int skip_txfm[SKIP_CONTEXTS3][2];
1236 unsigned int compound_index[COMP_INDEX_CONTEXTS6][2];
1237 unsigned int comp_group_idx[COMP_GROUP_IDX_CONTEXTS6][2];
1238 unsigned int delta_q[DELTA_Q_PROBS(3)][2];
1239 unsigned int delta_lf_multi[FRAME_LF_COUNT4][DELTA_LF_PROBS(3)][2];
1240 unsigned int delta_lf[DELTA_LF_PROBS(3)][2];
1241
1242 unsigned int inter_ext_tx[EXT_TX_SETS_INTER4][EXT_TX_SIZES4][TX_TYPES];
1243 unsigned int intra_ext_tx[EXT_TX_SETS_INTRA3][EXT_TX_SIZES4][INTRA_MODES]
1244 [TX_TYPES];
1245 unsigned int filter_intra_mode[FILTER_INTRA_MODES];
1246 unsigned int filter_intra[BLOCK_SIZES_ALL][2];
1247 unsigned int switchable_restore[RESTORE_SWITCHABLE_TYPES];
1248 unsigned int wiener_restore[2];
1249 unsigned int sgrproj_restore[2];
1250#endif // CONFIG_ENTROPY_STATS
1251
1252 unsigned int switchable_interp[SWITCHABLE_FILTER_CONTEXTS((SWITCHABLE_FILTERS + 1) * 4)]
1253 [SWITCHABLE_FILTERS];
1254} FRAME_COUNTS;
1255
1256#define INTER_MODE_RD_DATA_OVERALL_SIZE6400 6400
1257
1258typedef struct {
1259 int ready;
1260 double a;
1261 double b;
1262 double dist_mean;
1263 double ld_mean;
1264 double sse_mean;
1265 double sse_sse_mean;
1266 double sse_ld_mean;
1267 int num;
1268 double dist_sum;
1269 double ld_sum;
1270 double sse_sum;
1271 double sse_sse_sum;
1272 double sse_ld_sum;
1273} InterModeRdModel;
1274
1275typedef struct {
1276 int idx;
1277 int64_t rd;
1278} RdIdxPair;
1279// TODO(angiebird): This is an estimated size. We still need to figure what is
1280// the maximum number of modes.
1281#define MAX_INTER_MODES1024 1024
1282// TODO(any): rename this struct to something else. There is already another
1283// struct called inter_mode_info, which makes this terribly confusing.
1284/*!\endcond */
1285/*!
1286 * \brief Struct used to hold inter mode data for fast tx search.
1287 *
1288 * This struct is used to perform a full transform search only on winning
1289 * candidates searched with an estimate for transform coding RD.
1290 */
1291typedef struct inter_modes_info {
1292 /*!
1293 * The number of inter modes for which data was stored in each of the
1294 * following arrays.
1295 */
1296 int num;
1297 /*!
1298 * Mode info struct for each of the candidate modes.
1299 */
1300 MB_MODE_INFO mbmi_arr[MAX_INTER_MODES1024];
1301 /*!
1302 * The rate for each of the candidate modes.
1303 */
1304 int mode_rate_arr[MAX_INTER_MODES1024];
1305 /*!
1306 * The sse of the predictor for each of the candidate modes.
1307 */
1308 int64_t sse_arr[MAX_INTER_MODES1024];
1309 /*!
1310 * The estimated rd of the predictor for each of the candidate modes.
1311 */
1312 int64_t est_rd_arr[MAX_INTER_MODES1024];
1313 /*!
1314 * The rate and mode index for each of the candidate modes.
1315 */
1316 RdIdxPair rd_idx_pair_arr[MAX_INTER_MODES1024];
1317 /*!
1318 * The full rd stats for each of the candidate modes.
1319 */
1320 RD_STATS rd_cost_arr[MAX_INTER_MODES1024];
1321 /*!
1322 * The full rd stats of luma only for each of the candidate modes.
1323 */
1324 RD_STATS rd_cost_y_arr[MAX_INTER_MODES1024];
1325 /*!
1326 * The full rd stats of chroma only for each of the candidate modes.
1327 */
1328 RD_STATS rd_cost_uv_arr[MAX_INTER_MODES1024];
1329} InterModesInfo;
1330
1331/*!\cond */
1332typedef struct {
1333 // TODO(kyslov): consider changing to 64bit
1334
1335 // This struct is used for computing variance in choose_partitioning(), where
1336 // the max number of samples within a superblock is 32x32 (with 4x4 avg).
1337 // With 8bit bitdepth, uint32_t is enough for sum_square_error (2^8 * 2^8 * 32
1338 // * 32 = 2^26). For high bitdepth we need to consider changing this to 64 bit
1339 uint32_t sum_square_error;
1340 int32_t sum_error;
1341 int log2_count;
1342 int variance;
1343} VPartVar;
1344
1345typedef struct {
1346 VPartVar none;
1347 VPartVar horz[2];
1348 VPartVar vert[2];
1349} VPVariance;
1350
1351typedef struct {
1352 VPVariance part_variances;
1353 VPartVar split[4];
1354} VP4x4;
1355
1356typedef struct {
1357 VPVariance part_variances;
1358 VP4x4 split[4];
1359} VP8x8;
1360
1361typedef struct {
1362 VPVariance part_variances;
1363 VP8x8 split[4];
1364} VP16x16;
1365
1366typedef struct {
1367 VPVariance part_variances;
1368 VP16x16 split[4];
1369} VP32x32;
1370
1371typedef struct {
1372 VPVariance part_variances;
1373 VP32x32 split[4];
1374} VP64x64;
1375
1376typedef struct {
1377 VPVariance part_variances;
1378 VP64x64 *split;
1379} VP128x128;
1380
1381/*!\endcond */
1382
1383/*!
1384 * \brief Thresholds for variance based partitioning.
1385 */
1386typedef struct {
1387 /*!
1388 * If block variance > threshold, then that block is forced to split.
1389 * thresholds[0] - threshold for 128x128;
1390 * thresholds[1] - threshold for 64x64;
1391 * thresholds[2] - threshold for 32x32;
1392 * thresholds[3] - threshold for 16x16;
1393 * thresholds[4] - threshold for 8x8;
1394 */
1395 int64_t thresholds[5];
1396
1397 /*!
1398 * MinMax variance threshold for 8x8 sub blocks of a 16x16 block. If actual
1399 * minmax > threshold_minmax, the 16x16 is forced to split.
1400 */
1401 int64_t threshold_minmax;
1402} VarBasedPartitionInfo;
1403
1404/*!
1405 * \brief Encoder parameters for synchronization of row based multi-threading
1406 */
1407typedef struct {
1408#if CONFIG_MULTITHREAD1
1409 /**
1410 * \name Synchronization objects for top-right dependency.
1411 */
1412 /**@{*/
1413 pthread_mutex_t *mutex_; /*!< Mutex lock object */
1414 pthread_cond_t *cond_; /*!< Condition variable */
1415 /**@}*/
1416#endif // CONFIG_MULTITHREAD
1417 /*!
1418 * Buffer to store the superblock whose encoding is complete.
1419 * num_finished_cols[i] stores the number of superblocks which finished
1420 * encoding in the ith superblock row.
1421 */
1422 int *num_finished_cols;
1423 /*!
1424 * Denotes the superblock interval at which conditional signalling should
1425 * happen. Also denotes the minimum number of extra superblocks of the top row
1426 * to be complete to start encoding the current superblock. A value of 1
1427 * indicates top-right dependency.
1428 */
1429 int sync_range;
1430 /*!
1431 * Denotes the additional number of superblocks in the previous row to be
1432 * complete to start encoding the current superblock when intraBC tool is
1433 * enabled. This additional top-right delay is required to satisfy the
1434 * hardware constraints for intraBC tool when row multithreading is enabled.
1435 */
1436 int intrabc_extra_top_right_sb_delay;
1437 /*!
1438 * Number of superblock rows.
1439 */
1440 int rows;
1441 /*!
1442 * The superblock row (in units of MI blocks) to be processed next.
1443 */
1444 int next_mi_row;
1445 /*!
1446 * Number of threads processing the current tile.
1447 */
1448 int num_threads_working;
1449} AV1EncRowMultiThreadSync;
1450
1451/*!\cond */
1452
1453// TODO(jingning) All spatially adaptive variables should go to TileDataEnc.
1454typedef struct TileDataEnc {
1455 TileInfo tile_info;
1456 DECLARE_ALIGNED(16, FRAME_CONTEXT, tctx)FRAME_CONTEXT tctx __attribute__((aligned(16)));
1457 FRAME_CONTEXT *row_ctx;
1458 uint64_t abs_sum_level;
1459 uint8_t allow_update_cdf;
1460 InterModeRdModel inter_mode_rd_models[BLOCK_SIZES_ALL];
1461 AV1EncRowMultiThreadSync row_mt_sync;
1462 MV firstpass_top_mv;
1463} TileDataEnc;
1464
1465typedef struct RD_COUNTS {
1466 int compound_ref_used_flag;
1467 int skip_mode_used_flag;
1468 int tx_type_used[TX_SIZES_ALL][TX_TYPES];
1469 int obmc_used[BLOCK_SIZES_ALL][2];
1470 int warped_used[2];
1471 int newmv_or_intra_blocks;
1472 uint64_t seg_tmp_pred_cost[2];
1473} RD_COUNTS;
1474
1475typedef struct ThreadData {
1476 MACROBLOCK mb;
1477 MvCosts *mv_costs_alloc;
1478 IntraBCMVCosts *dv_costs_alloc;
1479 RD_COUNTS rd_counts;
1480 FRAME_COUNTS *counts;
1481 PC_TREE_SHARED_BUFFERS shared_coeff_buf;
1482 SIMPLE_MOTION_DATA_TREE *sms_tree;
1483 SIMPLE_MOTION_DATA_TREE *sms_root;
1484 // buffers are AOM_BUFFER_SIZE_FOR_BLOCK_HASH elements long
1485 uint32_t *hash_value_buffer[2];
1486 OBMCBuffer obmc_buffer;
1487 PALETTE_BUFFER *palette_buffer;
1488 CompoundTypeRdBuffers comp_rd_buffer;
1489 CONV_BUF_TYPE *tmp_conv_dst;
1490 uint64_t abs_sum_level;
1491 uint8_t *tmp_pred_bufs[2];
1492 uint8_t *upsample_pred;
1493 uint8_t *wiener_tmp_pred_buf;
1494 int intrabc_used;
1495 int deltaq_used;
1496 int coefficient_size;
1497 int max_mv_magnitude;
1498 int interp_filter_selected[SWITCHABLE];
1499 FRAME_CONTEXT *tctx;
1500 VP64x64 *vt64x64;
1501 int32_t num_64x64_blocks;
1502 PICK_MODE_CONTEXT *firstpass_ctx;
1503 TemporalFilterData tf_data;
1504 TplBuffers tpl_tmp_buffers;
1505 TplTxfmStats tpl_txfm_stats;
1506 GlobalMotionData gm_data;
1507 // Pointer to the array of structures to store gradient information of each
1508 // pixel in a superblock. The buffer constitutes of MAX_SB_SQUARE pixel level
1509 // structures for each of the plane types (PLANE_TYPE_Y and PLANE_TYPE_UV).
1510 PixelLevelGradientInfo *pixel_gradient_info;
1511 // Pointer to the array of structures to store source variance information of
1512 // each 4x4 sub-block in a superblock. Block4x4VarInfo structure is used to
1513 // store source variance and log of source variance of each 4x4 sub-block
1514 // for subsequent retrieval.
1515 Block4x4VarInfo *src_var_info_of_4x4_sub_blocks;
1516 // Pointer to pc tree root.
1517 PC_TREE *pc_root;
1518} ThreadData;
1519
1520struct EncWorkerData;
1521
1522/*!\endcond */
1523
1524/*!
1525 * \brief Encoder data related to row-based multi-threading
1526 */
1527typedef struct {
1528 /*!
1529 * Number of tile rows for which row synchronization memory is allocated.
1530 */
1531 int allocated_tile_rows;
1532 /*!
1533 * Number of tile cols for which row synchronization memory is allocated.
1534 */
1535 int allocated_tile_cols;
1536 /*!
1537 * Number of rows for which row synchronization memory is allocated
1538 * per tile. During first-pass/look-ahead stage this equals the
1539 * maximum number of macroblock rows in a tile. During encode stage,
1540 * this equals the maximum number of superblock rows in a tile.
1541 */
1542 int allocated_rows;
1543 /*!
1544 * Number of columns for which entropy context memory is allocated
1545 * per tile. During encode stage, this equals the maximum number of
1546 * superblock columns in a tile minus 1. The entropy context memory
1547 * is not allocated during first-pass/look-ahead stage.
1548 */
1549 int allocated_cols;
1550
1551 /*!
1552 * thread_id_to_tile_id[i] indicates the tile id assigned to the ith thread.
1553 */
1554 int thread_id_to_tile_id[MAX_NUM_THREADS64];
1555
1556 /*!
1557 * num_tile_cols_done[i] indicates the number of tile columns whose encoding
1558 * is complete in the ith superblock row.
1559 */
1560 int *num_tile_cols_done;
1561
1562 /*!
1563 * Number of superblock rows in a frame for which 'num_tile_cols_done' is
1564 * allocated.
1565 */
1566 int allocated_sb_rows;
1567
1568 /*!
1569 * Initialized to false, set to true by the worker thread that encounters an
1570 * error in order to abort the processing of other worker threads.
1571 */
1572 bool_Bool row_mt_exit;
1573
1574 /*!
1575 * Initialized to false, set to true during first pass encoding by the worker
1576 * thread that encounters an error in order to abort the processing of other
1577 * worker threads.
1578 */
1579 bool_Bool firstpass_mt_exit;
1580
1581 /*!
1582 * Initialized to false, set to true in cal_mb_wiener_var_hook() by the worker
1583 * thread that encounters an error in order to abort the processing of other
1584 * worker threads.
1585 */
1586 bool_Bool mb_wiener_mt_exit;
1587
1588#if CONFIG_MULTITHREAD1
1589 /*!
1590 * Mutex lock used while dispatching jobs.
1591 */
1592 pthread_mutex_t *mutex_;
1593 /*!
1594 * Condition variable used to dispatch loopfilter jobs.
1595 */
1596 pthread_cond_t *cond_;
1597#endif
1598
1599 /**
1600 * \name Row synchronization related function pointers.
1601 */
1602 /**@{*/
1603 /*!
1604 * Reader.
1605 */
1606 void (*sync_read_ptr)(AV1EncRowMultiThreadSync *const, int, int);
1607 /*!
1608 * Writer.
1609 */
1610 void (*sync_write_ptr)(AV1EncRowMultiThreadSync *const, int, int, int);
1611 /**@}*/
1612} AV1EncRowMultiThreadInfo;
1613
1614/*!
1615 * \brief Encoder data related to multi-threading for allintra deltaq-mode=3
1616 */
1617typedef struct {
1618#if CONFIG_MULTITHREAD1
1619 /*!
1620 * Mutex lock used while dispatching jobs.
1621 */
1622 pthread_mutex_t *mutex_;
1623 /*!
1624 * Condition variable used to dispatch loopfilter jobs.
1625 */
1626 pthread_cond_t *cond_;
1627#endif
1628
1629 /**
1630 * \name Row synchronization related function pointers for all intra mode
1631 */
1632 /**@{*/
1633 /*!
1634 * Reader.
1635 */
1636 void (*intra_sync_read_ptr)(AV1EncRowMultiThreadSync *const, int, int);
1637 /*!
1638 * Writer.
1639 */
1640 void (*intra_sync_write_ptr)(AV1EncRowMultiThreadSync *const, int, int, int);
1641 /**@}*/
1642} AV1EncAllIntraMultiThreadInfo;
1643
1644/*!
1645 * \brief Max number of recodes used to track the frame probabilities.
1646 */
1647#define NUM_RECODES_PER_FRAME10 10
1648
1649/*!
1650 * \brief Max number of frames that can be encoded in a parallel encode set.
1651 */
1652#define MAX_PARALLEL_FRAMES4 4
1653
1654/*!
1655 * \brief Buffers to be backed up during parallel encode set to be restored
1656 * later.
1657 */
1658typedef struct RestoreStateBuffers {
1659 /*!
1660 * Backup of original CDEF srcbuf.
1661 */
1662 uint16_t *cdef_srcbuf;
1663
1664 /*!
1665 * Backup of original CDEF colbuf.
1666 */
1667 uint16_t *cdef_colbuf[MAX_MB_PLANE3];
1668
1669 /*!
1670 * Backup of original LR rst_tmpbuf.
1671 */
1672 int32_t *rst_tmpbuf;
1673
1674 /*!
1675 * Backup of original LR rlbs.
1676 */
1677 RestorationLineBuffers *rlbs;
1678} RestoreStateBuffers;
1679
1680/*!
1681 * \brief Parameters related to restoration types.
1682 */
1683typedef struct {
1684 /*!
1685 * Stores the best coefficients for Wiener restoration.
1686 */
1687 WienerInfo wiener;
1688
1689 /*!
1690 * Stores the best coefficients for Sgrproj restoration.
1691 */
1692 SgrprojInfo sgrproj;
1693
1694 /*!
1695 * The rtype to use for this unit given a frame rtype as index. Indices:
1696 * WIENER, SGRPROJ, SWITCHABLE.
1697 */
1698 RestorationType best_rtype[RESTORE_TYPES - 1];
1699} RestUnitSearchInfo;
1700
1701/*!
1702 * \brief Structure to hold search parameter per restoration unit and
1703 * intermediate buffer of Wiener filter used in pick filter stage of Loop
1704 * restoration.
1705 */
1706typedef struct {
1707 /*!
1708 * Array of pointers to 'RestUnitSearchInfo' which holds data related to
1709 * restoration types.
1710 */
1711 RestUnitSearchInfo *rusi[MAX_MB_PLANE3];
1712
1713 /*!
1714 * Buffer used to hold dgd-avg data during SIMD call of Wiener filter.
1715 */
1716 int16_t *dgd_avg;
1717} AV1LrPickStruct;
1718
1719/*!
1720 * \brief Primary Encoder parameters related to multi-threading.
1721 */
1722typedef struct PrimaryMultiThreadInfo {
1723 /*!
1724 * Number of workers created for multi-threading.
1725 */
1726 int num_workers;
1727
1728 /*!
1729 * Number of workers used for different MT modules.
1730 */
1731 int num_mod_workers[NUM_MT_MODULES];
1732
1733 /*!
1734 * Synchronization object used to launch job in the worker thread.
1735 */
1736 AVxWorker *workers;
1737
1738 /*!
1739 * Data specific to each worker in encoder multi-threading.
1740 * tile_thr_data[i] stores the worker data of the ith thread.
1741 */
1742 struct EncWorkerData *tile_thr_data;
1743
1744 /*!
1745 * CDEF row multi-threading data.
1746 */
1747 AV1CdefWorkerData *cdef_worker;
1748
1749 /*!
1750 * Primary(Level 1) Synchronization object used to launch job in the worker
1751 * thread.
1752 */
1753 AVxWorker *p_workers[MAX_PARALLEL_FRAMES4];
1754
1755 /*!
1756 * Number of primary workers created for multi-threading.
1757 */
1758 int p_num_workers;
1759
1760 /*!
1761 * Tracks the number of workers in encode stage multi-threading.
1762 */
1763 int prev_num_enc_workers;
1764} PrimaryMultiThreadInfo;
1765
1766/*!
1767 * \brief Encoder parameters related to multi-threading.
1768 */
1769typedef struct MultiThreadInfo {
1770 /*!
1771 * Number of workers created for multi-threading.
1772 */
1773 int num_workers;
1774
1775 /*!
1776 * Number of workers used for different MT modules.
1777 */
1778 int num_mod_workers[NUM_MT_MODULES];
1779
1780 /*!
1781 * Synchronization object used to launch job in the worker thread.
1782 */
1783 AVxWorker *workers;
1784
1785 /*!
1786 * Data specific to each worker in encoder multi-threading.
1787 * tile_thr_data[i] stores the worker data of the ith thread.
1788 */
1789 struct EncWorkerData *tile_thr_data;
1790
1791 /*!
1792 * When set, indicates that row based multi-threading of the encoder is
1793 * enabled.
1794 */
1795 bool_Bool row_mt_enabled;
1796
1797 /*!
1798 * When set, indicates that multi-threading for bitstream packing is enabled.
1799 */
1800 bool_Bool pack_bs_mt_enabled;
1801
1802 /*!
1803 * Encoder row multi-threading data.
1804 */
1805 AV1EncRowMultiThreadInfo enc_row_mt;
1806
1807 /*!
1808 * Encoder multi-threading data for allintra mode in the preprocessing stage
1809 * when --deltaq-mode=3.
1810 */
1811 AV1EncAllIntraMultiThreadInfo intra_mt;
1812
1813 /*!
1814 * Tpl row multi-threading data.
1815 */
1816 AV1TplRowMultiThreadInfo tpl_row_mt;
1817
1818 /*!
1819 * Loop Filter multi-threading object.
1820 */
1821 AV1LfSync lf_row_sync;
1822
1823 /*!
1824 * Loop Restoration multi-threading object.
1825 */
1826 AV1LrSync lr_row_sync;
1827
1828 /*!
1829 * Pack bitstream multi-threading object.
1830 */
1831 AV1EncPackBSSync pack_bs_sync;
1832
1833 /*!
1834 * Global Motion multi-threading object.
1835 */
1836 AV1GlobalMotionSync gm_sync;
1837
1838 /*!
1839 * Temporal Filter multi-threading object.
1840 */
1841 AV1TemporalFilterSync tf_sync;
1842
1843 /*!
1844 * CDEF search multi-threading object.
1845 */
1846 AV1CdefSync cdef_sync;
1847
1848 /*!
1849 * Pointer to CDEF row multi-threading data for the frame.
1850 */
1851 AV1CdefWorkerData *cdef_worker;
1852
1853 /*!
1854 * Buffers to be stored/restored before/after parallel encode.
1855 */
1856 RestoreStateBuffers restore_state_buf;
1857
1858 /*!
1859 * In multi-threaded realtime encoding with row-mt enabled, pipeline
1860 * loop-filtering after encoding.
1861 */
1862 int pipeline_lpf_mt_with_enc;
1863} MultiThreadInfo;
1864
1865/*!\cond */
1866
1867typedef struct ActiveMap {
1868 int enabled;
1869 int update;
1870 unsigned char *map;
1871} ActiveMap;
1872
1873/*!\endcond */
1874
1875/*!
1876 * \brief Encoder info used for decision on forcing integer motion vectors.
1877 */
1878typedef struct {
1879 /*!
1880 * cs_rate_array[i] is the fraction of blocks in a frame which either match
1881 * with the collocated block or are smooth, where i is the rate_index.
1882 */
1883 double cs_rate_array[32];
1884 /*!
1885 * rate_index is used to index cs_rate_array.
1886 */
1887 int rate_index;
1888 /*!
1889 * rate_size is the total number of entries populated in cs_rate_array.
1890 */
1891 int rate_size;
1892} ForceIntegerMVInfo;
1893
1894/*!\cond */
1895
1896#if CONFIG_INTERNAL_STATS0
1897// types of stats
1898enum {
1899 STAT_Y,
1900 STAT_U,
1901 STAT_V,
1902 STAT_ALL,
1903 NUM_STAT_TYPES // This should always be the last member of the enum
1904} UENUM1BYTE(StatType); typedef uint8_t StatType;
1905
1906typedef struct IMAGE_STAT {
1907 double stat[NUM_STAT_TYPES];
1908 double worst;
1909} ImageStat;
1910#endif // CONFIG_INTERNAL_STATS
1911
1912typedef struct {
1913 int ref_count;
1914 YV12_BUFFER_CONFIG buf;
1915} EncRefCntBuffer;
1916
1917/*!\endcond */
1918
1919/*!
1920 * \brief Buffer to store mode information at mi_alloc_bsize (4x4 or 8x8) level
1921 *
1922 * This is used for bitstream preparation.
1923 */
1924typedef struct {
1925 /*!
1926 * frame_base[mi_row * stride + mi_col] stores the mode information of
1927 * block (mi_row,mi_col).
1928 */
1929 MB_MODE_INFO_EXT_FRAME *frame_base;
1930 /*!
1931 * Size of frame_base buffer.
1932 */
1933 int alloc_size;
1934 /*!
1935 * Stride of frame_base buffer.
1936 */
1937 int stride;
1938} MBMIExtFrameBufferInfo;
1939
1940/*!\cond */
1941
1942#if CONFIG_COLLECT_PARTITION_STATS0
1943typedef struct FramePartitionTimingStats {
1944 int partition_decisions[6][EXT_PARTITION_TYPES];
1945 int partition_attempts[6][EXT_PARTITION_TYPES];
1946 int64_t partition_times[6][EXT_PARTITION_TYPES];
1947
1948 int partition_redo;
1949} FramePartitionTimingStats;
1950#endif // CONFIG_COLLECT_PARTITION_STATS
1951
1952#if CONFIG_COLLECT_COMPONENT_TIMING0
1953#include "aom_ports/aom_timer.h"
1954// Adjust the following to add new components.
1955enum {
1956 av1_encode_strategy_time,
1957 av1_get_one_pass_rt_params_time,
1958 av1_get_second_pass_params_time,
1959 denoise_and_encode_time,
1960 apply_filtering_time,
1961 av1_tpl_setup_stats_time,
1962 encode_frame_to_data_rate_time,
1963 encode_with_or_without_recode_time,
1964 loop_filter_time,
1965 cdef_time,
1966 loop_restoration_time,
1967 av1_pack_bitstream_final_time,
1968 av1_encode_frame_time,
1969 av1_compute_global_motion_time,
1970 av1_setup_motion_field_time,
1971 encode_sb_row_time,
1972
1973 rd_pick_partition_time,
1974 rd_use_partition_time,
1975 choose_var_based_partitioning_time,
1976 av1_prune_partitions_time,
1977 none_partition_search_time,
1978 split_partition_search_time,
1979 rectangular_partition_search_time,
1980 ab_partitions_search_time,
1981 rd_pick_4partition_time,
1982 encode_sb_time,
1983
1984 rd_pick_sb_modes_time,
1985 av1_rd_pick_intra_mode_sb_time,
1986 av1_rd_pick_inter_mode_sb_time,
1987 set_params_rd_pick_inter_mode_time,
1988 skip_inter_mode_time,
1989 handle_inter_mode_time,
1990 evaluate_motion_mode_for_winner_candidates_time,
1991 do_tx_search_time,
1992 handle_intra_mode_time,
1993 refine_winner_mode_tx_time,
1994 av1_search_palette_mode_time,
1995 handle_newmv_time,
1996 compound_type_rd_time,
1997 interpolation_filter_search_time,
1998 motion_mode_rd_time,
1999
2000 nonrd_use_partition_time,
2001 pick_sb_modes_nonrd_time,
2002 hybrid_intra_mode_search_time,
2003 nonrd_pick_inter_mode_sb_time,
2004 encode_b_nonrd_time,
2005
2006 kTimingComponents,
2007} UENUM1BYTE(TIMING_COMPONENT); typedef uint8_t TIMING_COMPONENT;
2008
2009static inline char const *get_component_name(int index) {
2010 switch (index) {
2011 case av1_encode_strategy_time: return "av1_encode_strategy_time";
2012 case av1_get_one_pass_rt_params_time:
2013 return "av1_get_one_pass_rt_params_time";
2014 case av1_get_second_pass_params_time:
2015 return "av1_get_second_pass_params_time";
2016 case denoise_and_encode_time: return "denoise_and_encode_time";
2017 case apply_filtering_time: return "apply_filtering_time";
2018 case av1_tpl_setup_stats_time: return "av1_tpl_setup_stats_time";
2019 case encode_frame_to_data_rate_time:
2020 return "encode_frame_to_data_rate_time";
2021 case encode_with_or_without_recode_time:
2022 return "encode_with_or_without_recode_time";
2023 case loop_filter_time: return "loop_filter_time";
2024 case cdef_time: return "cdef_time";
2025 case loop_restoration_time: return "loop_restoration_time";
2026 case av1_pack_bitstream_final_time: return "av1_pack_bitstream_final_time";
2027 case av1_encode_frame_time: return "av1_encode_frame_time";
2028 case av1_compute_global_motion_time:
2029 return "av1_compute_global_motion_time";
2030 case av1_setup_motion_field_time: return "av1_setup_motion_field_time";
2031 case encode_sb_row_time: return "encode_sb_row_time";
2032
2033 case rd_pick_partition_time: return "rd_pick_partition_time";
2034 case rd_use_partition_time: return "rd_use_partition_time";
2035 case choose_var_based_partitioning_time:
2036 return "choose_var_based_partitioning_time";
2037 case av1_prune_partitions_time: return "av1_prune_partitions_time";
2038 case none_partition_search_time: return "none_partition_search_time";
2039 case split_partition_search_time: return "split_partition_search_time";
2040 case rectangular_partition_search_time:
2041 return "rectangular_partition_search_time";
2042 case ab_partitions_search_time: return "ab_partitions_search_time";
2043 case rd_pick_4partition_time: return "rd_pick_4partition_time";
2044 case encode_sb_time: return "encode_sb_time";
2045
2046 case rd_pick_sb_modes_time: return "rd_pick_sb_modes_time";
2047 case av1_rd_pick_intra_mode_sb_time:
2048 return "av1_rd_pick_intra_mode_sb_time";
2049 case av1_rd_pick_inter_mode_sb_time:
2050 return "av1_rd_pick_inter_mode_sb_time";
2051 case set_params_rd_pick_inter_mode_time:
2052 return "set_params_rd_pick_inter_mode_time";
2053 case skip_inter_mode_time: return "skip_inter_mode_time";
2054 case handle_inter_mode_time: return "handle_inter_mode_time";
2055 case evaluate_motion_mode_for_winner_candidates_time:
2056 return "evaluate_motion_mode_for_winner_candidates_time";
2057 case do_tx_search_time: return "do_tx_search_time";
2058 case handle_intra_mode_time: return "handle_intra_mode_time";
2059 case refine_winner_mode_tx_time: return "refine_winner_mode_tx_time";
2060 case av1_search_palette_mode_time: return "av1_search_palette_mode_time";
2061 case handle_newmv_time: return "handle_newmv_time";
2062 case compound_type_rd_time: return "compound_type_rd_time";
2063 case interpolation_filter_search_time:
2064 return "interpolation_filter_search_time";
2065 case motion_mode_rd_time: return "motion_mode_rd_time";
2066
2067 case nonrd_use_partition_time: return "nonrd_use_partition_time";
2068 case pick_sb_modes_nonrd_time: return "pick_sb_modes_nonrd_time";
2069 case hybrid_intra_mode_search_time: return "hybrid_intra_mode_search_time";
2070 case nonrd_pick_inter_mode_sb_time: return "nonrd_pick_inter_mode_sb_time";
2071 case encode_b_nonrd_time: return "encode_b_nonrd_time";
2072
2073 default: assert(0)((void) sizeof ((0) ? 1 : 0), __extension__ ({ if (0) ; else __assert_fail
("0", "/root/firefox-clang/third_party/aom/av1/encoder/encoder.h"
, 2073, __extension__ __PRETTY_FUNCTION__); }))
;
2074 }
2075 return "error";
2076}
2077#endif
2078
2079// The maximum number of internal ARFs except ALTREF_FRAME
2080#define MAX_INTERNAL_ARFS(REF_FRAMES - BWDREF_FRAME - 1) (REF_FRAMES - BWDREF_FRAME - 1)
2081
2082/*!\endcond */
2083
2084/*!
2085 * \brief Parameters related to global motion search
2086 */
2087typedef struct {
2088 /*!
2089 * Flag to indicate if global motion search needs to be rerun.
2090 */
2091 bool_Bool search_done;
2092
2093 /*!
2094 * Array of pointers to the frame buffers holding the reference frames.
2095 * ref_buf[i] stores the pointer to the reference frame of the ith
2096 * reference frame type.
2097 */
2098 YV12_BUFFER_CONFIG *ref_buf[REF_FRAMES];
2099
2100 /*!
2101 * Holds the number of valid reference frames in past and future directions
2102 * w.r.t. the current frame. num_ref_frames[i] stores the total number of
2103 * valid reference frames in 'i' direction.
2104 */
2105 int num_ref_frames[MAX_DIRECTIONS2];
2106
2107 /*!
2108 * Array of structure which stores the valid reference frames in past and
2109 * future directions and their corresponding distance from the source frame.
2110 * reference_frames[i][j] holds the jth valid reference frame type in the
2111 * direction 'i' and its temporal distance from the source frame .
2112 */
2113 FrameDistPair reference_frames[MAX_DIRECTIONS2][REF_FRAMES - 1];
2114
2115 /**
2116 * \name Dimensions for which segment map is allocated.
2117 */
2118 /**@{*/
2119 int segment_map_w; /*!< segment map width */
2120 int segment_map_h; /*!< segment map height */
2121 /**@}*/
2122} GlobalMotionInfo;
2123
2124/*!
2125 * \brief Flags related to interpolation filter search
2126 */
2127typedef struct {
2128 /*!
2129 * Stores the default value of skip flag depending on chroma format
2130 * Set as 1 for monochrome and 3 for other color formats
2131 */
2132 int default_interp_skip_flags;
2133 /*!
2134 * Filter mask to allow certain interp_filter type.
2135 */
2136 uint16_t interp_filter_search_mask;
2137} InterpSearchFlags;
2138
2139/*!
2140 * \brief Parameters for motion vector search process
2141 */
2142typedef struct {
2143 /*!
2144 * Largest MV component used in a frame.
2145 * The value from the previous frame is used to set the full pixel search
2146 * range for the current frame.
2147 */
2148 int max_mv_magnitude;
2149 /*!
2150 * Parameter indicating initial search window to be used in full-pixel search.
2151 * Range [0, MAX_MVSEARCH_STEPS-2]. Lower value indicates larger window.
2152 */
2153 int mv_step_param;
2154 /*!
2155 * Pointer to sub-pixel search function.
2156 * In encoder: av1_find_best_sub_pixel_tree
2157 * av1_find_best_sub_pixel_tree_pruned
2158 * av1_find_best_sub_pixel_tree_pruned_more
2159 * In MV unit test: av1_return_max_sub_pixel_mv
2160 * av1_return_min_sub_pixel_mv
2161 */
2162 fractional_mv_step_fp *find_fractional_mv_step;
2163 /*!
2164 * Search site configuration for full-pel MV search.
2165 * search_site_cfg[SS_CFG_SRC]: Used in tpl, rd/non-rd inter mode loop, simple
2166 * motion search. search_site_cfg[SS_CFG_LOOKAHEAD]: Used in intraBC, temporal
2167 * filter search_site_cfg[SS_CFG_FPF]: Used during first pass and lookahead
2168 */
2169 search_site_config search_site_cfg[SS_CFG_TOTAL][NUM_DISTINCT_SEARCH_METHODS];
2170} MotionVectorSearchParams;
2171
2172/*!
2173 * \brief Refresh frame flags for different type of frames.
2174 *
2175 * If the refresh flag is true for a particular reference frame, after the
2176 * current frame is encoded, the reference frame gets refreshed (updated) to
2177 * be the current frame. Note: Usually at most one flag will be set to true at
2178 * a time. But, for key-frames, all flags are set to true at once.
2179 */
2180typedef struct {
2181 bool_Bool golden_frame; /*!< Refresh flag for golden frame */
2182 bool_Bool bwd_ref_frame; /*!< Refresh flag for bwd-ref frame */
2183 bool_Bool alt_ref_frame; /*!< Refresh flag for alt-ref frame */
2184} RefreshFrameInfo;
2185
2186/*!
2187 * \brief Desired dimensions for an externally triggered resize.
2188 *
2189 * When resize is triggered externally, the desired dimensions are stored in
2190 * this struct until used in the next frame to be coded. These values are
2191 * effective only for one frame and are reset after they are used.
2192 */
2193typedef struct {
2194 int width; /*!< Desired resized width */
2195 int height; /*!< Desired resized height */
2196} ResizePendingParams;
2197
2198/*!
2199 * \brief Refrence frame distance related variables.
2200 */
2201typedef struct {
2202 /*!
2203 * True relative distance of reference frames w.r.t. the current frame.
2204 */
2205 int ref_relative_dist[INTER_REFS_PER_FRAME];
2206 /*!
2207 * The nearest reference w.r.t. current frame in the past.
2208 */
2209 int8_t nearest_past_ref;
2210 /*!
2211 * The nearest reference w.r.t. current frame in the future.
2212 */
2213 int8_t nearest_future_ref;
2214} RefFrameDistanceInfo;
2215
2216/*!
2217 * \brief Parameters used for winner mode processing.
2218 *
2219 * This is a basic two pass approach: in the first pass, we reduce the number of
2220 * transform searches based on some thresholds during the rdopt process to find
2221 * the "winner mode". In the second pass, we perform a more through tx search
2222 * on the winner mode.
2223 * There are some arrays in the struct, and their indices are used in the
2224 * following manner:
2225 * Index 0: Default mode evaluation, Winner mode processing is not applicable
2226 * (Eg : IntraBc).
2227 * Index 1: Mode evaluation.
2228 * Index 2: Winner mode evaluation
2229 * Index 1 and 2 are only used when the respective speed feature is on.
2230 */
2231typedef struct {
2232 /*!
2233 * Threshold to determine if trellis optimization is to be enabled
2234 * based on :
2235 * 0 : dist threshold
2236 * 1 : satd threshold
2237 * Corresponds to enable_winner_mode_for_coeff_opt speed feature.
2238 */
2239 unsigned int coeff_opt_thresholds[MODE_EVAL_TYPES][2];
2240
2241 /*!
2242 * Determines the tx size search method during rdopt.
2243 * Corresponds to enable_winner_mode_for_tx_size_srch speed feature.
2244 */
2245 TX_SIZE_SEARCH_METHOD tx_size_search_methods[MODE_EVAL_TYPES];
2246
2247 /*!
2248 * Controls how often we should approximate prediction error with tx
2249 * coefficients. If it's 0, then never. If 1, then it's during the tx_type
2250 * search only. If 2, then always.
2251 * Corresponds to tx_domain_dist_level speed feature.
2252 */
2253 unsigned int use_transform_domain_distortion[MODE_EVAL_TYPES];
2254
2255 /*!
2256 * Threshold to approximate pixel domain distortion with transform domain
2257 * distortion. This is only used if use_transform_domain_distortion is on.
2258 * Corresponds to enable_winner_mode_for_use_tx_domain_dist speed feature.
2259 */
2260 unsigned int tx_domain_dist_threshold[MODE_EVAL_TYPES];
2261
2262 /*!
2263 * Controls how often we should try to skip the transform process based on
2264 * result from dct.
2265 * Corresponds to use_skip_flag_prediction speed feature.
2266 */
2267 unsigned int skip_txfm_level[MODE_EVAL_TYPES];
2268
2269 /*!
2270 * Predict DC only txfm blocks for default, mode and winner mode evaluation.
2271 * Index 0: Default mode evaluation, Winner mode processing is not applicable.
2272 * Index 1: Mode evaluation, Index 2: Winner mode evaluation
2273 */
2274 unsigned int predict_dc_level[MODE_EVAL_TYPES];
2275} WinnerModeParams;
2276
2277/*!
2278 * \brief Frame refresh flags set by the external interface.
2279 *
2280 * Flags set by external interface to determine which reference buffers are
2281 * refreshed by this frame. When set, the encoder will update the particular
2282 * reference frame buffer with the contents of the current frame.
2283 */
2284typedef struct {
2285 bool_Bool last_frame; /*!< Refresh flag for last frame */
2286 bool_Bool golden_frame; /*!< Refresh flag for golden frame */
2287 bool_Bool bwd_ref_frame; /*!< Refresh flag for bwd-ref frame */
2288 bool_Bool alt2_ref_frame; /*!< Refresh flag for alt2-ref frame */
2289 bool_Bool alt_ref_frame; /*!< Refresh flag for alt-ref frame */
2290 /*!
2291 * Flag indicating if the update of refresh frame flags is pending.
2292 */
2293 bool_Bool update_pending;
2294} ExtRefreshFrameFlagsInfo;
2295
2296/*!
2297 * \brief Flags signalled by the external interface at frame level.
2298 */
2299typedef struct {
2300 /*!
2301 * Bit mask to disable certain reference frame types.
2302 */
2303 int ref_frame_flags;
2304
2305 /*!
2306 * Frame refresh flags set by the external interface.
2307 */
2308 ExtRefreshFrameFlagsInfo refresh_frame;
2309
2310 /*!
2311 * Flag to enable the update of frame contexts at the end of a frame decode.
2312 */
2313 bool_Bool refresh_frame_context;
2314
2315 /*!
2316 * Flag to indicate that update of refresh_frame_context from external
2317 * interface is pending.
2318 */
2319 bool_Bool refresh_frame_context_pending;
2320
2321 /*!
2322 * Flag to enable temporal MV prediction.
2323 */
2324 bool_Bool use_ref_frame_mvs;
2325
2326 /*!
2327 * Indicates whether the current frame is to be coded as error resilient.
2328 */
2329 bool_Bool use_error_resilient;
2330
2331 /*!
2332 * Indicates whether the current frame is to be coded as s-frame.
2333 */
2334 bool_Bool use_s_frame;
2335
2336 /*!
2337 * Indicates whether the current frame's primary_ref_frame is set to
2338 * PRIMARY_REF_NONE.
2339 */
2340 bool_Bool use_primary_ref_none;
2341} ExternalFlags;
2342
2343/*!\cond */
2344
2345typedef struct {
2346 // Some misc info
2347 int high_prec;
2348 int q;
2349 int order;
2350
2351 // MV counters
2352 int inter_count;
2353 int intra_count;
2354 int default_mvs;
2355 int mv_joint_count[4];
2356 int last_bit_zero;
2357 int last_bit_nonzero;
2358
2359 // Keep track of the rates
2360 int total_mv_rate;
2361 int hp_total_mv_rate;
2362 int lp_total_mv_rate;
2363
2364 // Texture info
2365 int horz_text;
2366 int vert_text;
2367 int diag_text;
2368
2369 // Whether the current struct contains valid data
2370 int valid;
2371} MV_STATS;
2372
2373typedef struct WeberStats {
2374 int64_t mb_wiener_variance;
2375 int64_t src_variance;
2376 int64_t rec_variance;
2377 int16_t src_pix_max;
2378 int16_t rec_pix_max;
2379 int64_t distortion;
2380 int64_t satd;
2381 double max_scale;
2382} WeberStats;
2383
2384/*!
2385 * \brief This structure stores different types of frame indices.
2386 */
2387typedef struct {
2388 int show_frame_count;
2389} FRAME_INDEX_SET;
2390
2391typedef struct {
2392 struct loopfilter lf;
2393 CdefInfo cdef_info;
2394 YV12_BUFFER_CONFIG copy_buffer;
2395 RATE_CONTROL rc;
2396 MV_STATS mv_stats;
2397 unsigned int frame_number;
2398 FRAME_INDEX_SET frame_index_set;
2399} CODING_CONTEXT;
2400
2401typedef struct {
2402 int frame_width;
2403 int frame_height;
2404 int mi_rows;
2405 int mi_cols;
2406 int mb_rows;
2407 int mb_cols;
2408 int num_mbs;
2409 aom_bit_depth_t bit_depth;
2410 int subsampling_x;
2411 int subsampling_y;
2412} FRAME_INFO;
2413
2414/*!\endcond */
2415
2416/*!
2417 * \brief Segmentation related information for the current frame.
2418 */
2419typedef struct {
2420 /*!
2421 * 3-bit number containing the segment affiliation for each 4x4 block in the
2422 * frame. map[y * stride + x] contains the segment id of the 4x4 block at
2423 * (x,y) position.
2424 */
2425 uint8_t *map;
2426 /*!
2427 * Flag to indicate if current frame has lossless segments or not.
2428 * 1: frame has at least one lossless segment.
2429 * 0: frame has no lossless segments.
2430 */
2431 bool_Bool has_lossless_segment;
2432} EncSegmentationInfo;
2433
2434/*!
2435 * \brief Frame time stamps.
2436 */
2437typedef struct {
2438 /*!
2439 * Start time stamp of the previous frame
2440 */
2441 int64_t prev_ts_start;
2442 /*!
2443 * End time stamp of the previous frame
2444 */
2445 int64_t prev_ts_end;
2446 /*!
2447 * Start time stamp of the first frame
2448 */
2449 int64_t first_ts_start;
2450} TimeStamps;
2451
2452/*!
2453 * Pointers to the memory allocated for frame level transform coeff related
2454 * info.
2455 */
2456typedef struct {
2457 /*!
2458 * Pointer to the transformed coefficients buffer.
2459 */
2460 tran_low_t *tcoeff;
2461 /*!
2462 * Pointer to the eobs buffer.
2463 */
2464 uint16_t *eobs;
2465 /*!
2466 * Pointer to the entropy_ctx buffer.
2467 */
2468 uint8_t *entropy_ctx;
2469} CoeffBufferPool;
2470
2471#if !CONFIG_REALTIME_ONLY0
2472/*!\cond */
2473// DUCKY_ENCODE_FRAME_MODE is c version of EncodeFrameMode
2474enum {
2475 DUCKY_ENCODE_FRAME_MODE_NONE, // Let native AV1 determine q index and rdmult
2476 DUCKY_ENCODE_FRAME_MODE_QINDEX, // DuckyEncode determines q index and AV1
2477 // determines rdmult
2478 DUCKY_ENCODE_FRAME_MODE_QINDEX_RDMULT, // DuckyEncode determines q index and
2479 // rdmult
2480} UENUM1BYTE(DUCKY_ENCODE_FRAME_MODE); typedef uint8_t DUCKY_ENCODE_FRAME_MODE;
2481
2482enum {
2483 DUCKY_ENCODE_GOP_MODE_NONE, // native AV1 decides GOP
2484 DUCKY_ENCODE_GOP_MODE_RCL, // rate control lib decides GOP
2485} UENUM1BYTE(DUCKY_ENCODE_GOP_MODE); typedef uint8_t DUCKY_ENCODE_GOP_MODE;
2486
2487typedef struct DuckyEncodeFrameInfo {
2488 DUCKY_ENCODE_FRAME_MODE qp_mode;
2489 DUCKY_ENCODE_GOP_MODE gop_mode;
2490 int q_index;
2491 int rdmult;
2492 // These two arrays are equivalent to std::vector<SuperblockEncodeParameters>
2493 int *superblock_encode_qindex;
2494 int *superblock_encode_rdmult;
2495 int delta_q_enabled;
2496} DuckyEncodeFrameInfo;
2497
2498typedef struct DuckyEncodeFrameResult {
2499 int global_order_idx;
2500 int q_index;
2501 int rdmult;
2502 int rate;
2503 int64_t dist;
2504 double psnr;
2505} DuckyEncodeFrameResult;
2506
2507typedef struct DuckyEncodeInfo {
2508 DuckyEncodeFrameInfo frame_info;
2509 DuckyEncodeFrameResult frame_result;
2510} DuckyEncodeInfo;
2511/*!\endcond */
2512#endif
2513
2514/*!\cond */
2515typedef struct RTC_REF {
2516 /*!
2517 * LAST_FRAME (0), LAST2_FRAME(1), LAST3_FRAME(2), GOLDEN_FRAME(3),
2518 * BWDREF_FRAME(4), ALTREF2_FRAME(5), ALTREF_FRAME(6).
2519 */
2520 int reference[INTER_REFS_PER_FRAME];
2521 int ref_idx[INTER_REFS_PER_FRAME];
2522 int refresh[REF_FRAMES];
2523 int set_ref_frame_config;
2524 int non_reference_frame;
2525 int ref_frame_comp[3];
2526 int gld_idx_1layer;
2527 /*!
2528 * Frame number of the last frame that refreshed the buffer slot.
2529 */
2530 unsigned int buffer_time_index[REF_FRAMES];
2531 /*!
2532 * Spatial layer id of the last frame that refreshed the buffer slot.
2533 */
2534 unsigned char buffer_spatial_layer[REF_FRAMES];
2535 /*!
2536 * Flag to indicate whether closest reference was the previous frame.
2537 */
2538 bool_Bool reference_was_previous_frame;
2539 /*!
2540 * Flag to indicate this frame is based on longer term reference only,
2541 * for recovery from past loss, and it should be biased for improved coding.
2542 */
2543 bool_Bool bias_recovery_frame;
2544} RTC_REF;
2545/*!\endcond */
2546
2547/*!
2548 * \brief Structure to hold data corresponding to an encoded frame.
2549 */
2550typedef struct AV1_COMP_DATA {
2551 /*!
2552 * Buffer to store packed bitstream data of a frame.
2553 */
2554 unsigned char *cx_data;
2555
2556 /*!
2557 * Allocated size of the cx_data buffer.
2558 */
2559 size_t cx_data_sz;
2560
2561 /*!
2562 * Size of data written in the cx_data buffer.
2563 */
2564 size_t frame_size;
2565
2566 /*!
2567 * Flags for the frame.
2568 */
2569 unsigned int lib_flags;
2570
2571 /*!
2572 * Time stamp for start of frame.
2573 */
2574 int64_t ts_frame_start;
2575
2576 /*!
2577 * Time stamp for end of frame.
2578 */
2579 int64_t ts_frame_end;
2580
2581 /*!
2582 * Flag to indicate flush call.
2583 */
2584 int flush;
2585
2586 /*!
2587 * Time base for sequence.
2588 */
2589 const aom_rational64_t *timestamp_ratio;
2590
2591 /*!
2592 * Decide to pop the source for this frame from input buffer queue.
2593 */
2594 int pop_lookahead;
2595} AV1_COMP_DATA;
2596
2597/*!
2598 * \brief Top level primary encoder structure
2599 */
2600typedef struct AV1_PRIMARY {
2601 /*!
2602 * Array of frame level encoder stage top level structures
2603 */
2604 struct AV1_COMP *parallel_cpi[MAX_PARALLEL_FRAMES4];
2605
2606 /*!
2607 * Array of structures to hold data of frames encoded in a given parallel
2608 * encode set.
2609 */
2610 struct AV1_COMP_DATA parallel_frames_data[MAX_PARALLEL_FRAMES4 - 1];
2611#if CONFIG_FPMT_TEST0
2612 /*!
2613 * Flag which enables/disables simulation path for fpmt unit test.
2614 * 0 - FPMT integration
2615 * 1 - FPMT simulation
2616 */
2617 FPMT_TEST_ENC_CFG fpmt_unit_test_cfg;
2618
2619 /*!
2620 * Temporary variable simulating the delayed frame_probability update.
2621 */
2622 FrameProbInfo temp_frame_probs;
2623
2624 /*!
2625 * Temporary variable holding the updated frame probability across
2626 * frames. Copy its value to temp_frame_probs for frame_parallel_level 0
2627 * frames or last frame in parallel encode set.
2628 */
2629 FrameProbInfo temp_frame_probs_simulation;
2630
2631 /*!
2632 * Temporary variable simulating the delayed update of valid global motion
2633 * model across frames.
2634 */
2635 int temp_valid_gm_model_found[FRAME_UPDATE_TYPES];
2636#endif // CONFIG_FPMT_TEST
2637 /*!
2638 * Copy of cm->ref_frame_map maintained to facilitate sequential update of
2639 * ref_frame_map by lower layer depth frames encoded ahead of time in a
2640 * parallel encode set.
2641 */
2642 RefCntBuffer *ref_frame_map_copy[REF_FRAMES];
2643
2644 /*!
2645 * Start time stamp of the last encoded show frame
2646 */
2647 int64_t ts_start_last_show_frame;
2648
2649 /*!
2650 * End time stamp of the last encoded show frame
2651 */
2652 int64_t ts_end_last_show_frame;
2653
2654 /*!
2655 * Number of frame level contexts(cpis)
2656 */
2657 int num_fp_contexts;
2658
2659 /*!
2660 * Loopfilter levels of the previous encoded frame.
2661 */
2662 int filter_level[2];
2663
2664 /*!
2665 * Chrominance component loopfilter level of the previous encoded frame.
2666 */
2667 int filter_level_u;
2668
2669 /*!
2670 * Chrominance component loopfilter level of the previous encoded frame.
2671 */
2672 int filter_level_v;
2673
2674 /*!
2675 * Encode stage top level structure
2676 * During frame parallel encode, this is the same as parallel_cpi[0]
2677 */
2678 struct AV1_COMP *cpi;
2679
2680 /*!
2681 * Lookahead processing stage top level structure
2682 */
2683 struct AV1_COMP *cpi_lap;
2684
2685 /*!
2686 * Look-ahead context.
2687 */
2688 struct lookahead_ctx *lookahead;
2689
2690 /*!
2691 * Sequence parameters have been transmitted already and locked
2692 * or not. Once locked av1_change_config cannot change the seq
2693 * parameters. Note that for SVC encoding the sequence parameters
2694 * (operating_points_cnt_minus_1, operating_point_idc[],
2695 * has_nonzero_operating_point_idc) should be updated whenever the
2696 * number of layers is changed. This is done in the
2697 * ctrl_set_svc_params().
2698 */
2699 int seq_params_locked;
2700
2701 /*!
2702 * Pointer to internal utility functions that manipulate aom_codec_* data
2703 * structures.
2704 */
2705 struct aom_codec_pkt_list *output_pkt_list;
2706
2707 /*!
2708 * When set, indicates that internal ARFs are enabled.
2709 */
2710 int internal_altref_allowed;
2711
2712 /*!
2713 * Tell if OVERLAY frame shows existing alt_ref frame.
2714 */
2715 int show_existing_alt_ref;
2716
2717 /*!
2718 * Information related to a gf group.
2719 */
2720 GF_GROUP gf_group;
2721
2722 /*!
2723 * Track prior gf group state.
2724 */
2725 GF_STATE gf_state;
2726
2727 /*!
2728 * Flag indicating whether look ahead processing (LAP) is enabled.
2729 */
2730 int lap_enabled;
2731
2732 /*!
2733 * Parameters for AV1 bitstream levels.
2734 */
2735 AV1LevelParams level_params;
2736
2737 /*!
2738 * Calculates PSNR on each frame when set to 1.
2739 */
2740 int b_calculate_psnr;
2741
2742 /*!
2743 * Number of frames left to be encoded, is 0 if limit is not set.
2744 */
2745 int frames_left;
2746
2747 /*!
2748 * Information related to two pass encoding.
2749 */
2750 TWO_PASS twopass;
2751
2752 /*!
2753 * Rate control related parameters.
2754 */
2755 PRIMARY_RATE_CONTROL p_rc;
2756
2757 /*!
2758 * Info and resources used by temporal filtering.
2759 */
2760 TEMPORAL_FILTER_INFO tf_info;
2761 /*!
2762 * Elements part of the sequence header, that are applicable for all the
2763 * frames in the video.
2764 */
2765 SequenceHeader seq_params;
2766
2767 /*!
2768 * Indicates whether to use SVC.
2769 */
2770 int use_svc;
2771
2772 /*!
2773 * If true, buffer removal times are present.
2774 */
2775 bool_Bool buffer_removal_time_present;
2776
2777 /*!
2778 * Number of temporal layers: may be > 1 for SVC (scalable vector coding).
2779 */
2780 unsigned int number_temporal_layers;
2781
2782 /*!
2783 * Number of spatial layers: may be > 1 for SVC (scalable vector coding).
2784 */
2785 unsigned int number_spatial_layers;
2786
2787 /*!
2788 * Code and details about current error status.
2789 */
2790 struct aom_internal_error_info error;
2791
2792 /*!
2793 * Function pointers to variants of sse/sad/variance computation functions.
2794 * fn_ptr[i] indicates the list of function pointers corresponding to block
2795 * size i.
2796 */
2797 aom_variance_fn_ptr_t fn_ptr[BLOCK_SIZES_ALL];
2798
2799 /*!
2800 * tpl_sb_rdmult_scaling_factors[i] stores the RD multiplier scaling factor of
2801 * the ith 16 x 16 block in raster scan order.
2802 */
2803 double *tpl_sb_rdmult_scaling_factors;
2804
2805 /*!
2806 * Parameters related to tpl.
2807 */
2808 TplParams tpl_data;
2809
2810 /*!
2811 * Motion vector stats of the previous encoded frame.
2812 */
2813 MV_STATS mv_stats;
2814
2815#if CONFIG_INTERNAL_STATS0
2816 /*!\cond */
2817 uint64_t total_time_receive_data;
2818 uint64_t total_time_compress_data;
2819
2820 unsigned int total_mode_chosen_counts[MAX_MODES];
2821
2822 int count[2];
2823 uint64_t total_sq_error[2];
2824 uint64_t total_samples[2];
2825 ImageStat psnr[2];
2826
2827 double total_blockiness;
2828 double worst_blockiness;
2829
2830 uint64_t total_bytes;
2831 double summed_quality;
2832 double summed_weights;
2833 double summed_quality_hbd;
2834 double summed_weights_hbd;
2835 unsigned int total_recode_hits;
2836 double worst_ssim;
2837 double worst_ssim_hbd;
2838
2839 ImageStat fastssim;
2840 ImageStat psnrhvs;
2841
2842 int b_calculate_blockiness;
2843 int b_calculate_consistency;
2844
2845 double total_inconsistency;
2846 double worst_consistency;
2847 Ssimv *ssim_vars;
2848 Metrics metrics;
2849 /*!\endcond */
2850#endif
2851
2852#if CONFIG_ENTROPY_STATS0
2853 /*!
2854 * Aggregates frame counts for the sequence.
2855 */
2856 FRAME_COUNTS aggregate_fc;
2857#endif // CONFIG_ENTROPY_STATS
2858
2859 /*!
2860 * For each type of reference frame, this contains the index of a reference
2861 * frame buffer for a reference frame of the same type. We use this to
2862 * choose our primary reference frame (which is the most recent reference
2863 * frame of the same type as the current frame).
2864 */
2865 int fb_of_context_type[REF_FRAMES];
2866
2867 /*!
2868 * Primary Multi-threading parameters.
2869 */
2870 PrimaryMultiThreadInfo p_mt_info;
2871
2872 /*!
2873 * Probabilities for pruning of various AV1 tools.
2874 */
2875 FrameProbInfo frame_probs;
2876
2877 /*!
2878 * Indicates if a valid global motion model has been found in the different
2879 * frame update types of a GF group.
2880 * valid_gm_model_found[i] indicates if valid global motion model has been
2881 * found in the frame update type with enum value equal to i
2882 */
2883 int valid_gm_model_found[FRAME_UPDATE_TYPES];
2884
2885 /*!
2886 * Struct for the reference structure for RTC.
2887 */
2888 RTC_REF rtc_ref;
2889
2890 /*!
2891 * Struct for all intra mode row multi threading in the preprocess stage
2892 * when --deltaq-mode=3.
2893 */
2894 AV1EncRowMultiThreadSync intra_row_mt_sync;
2895
2896 /*!
2897 * If set to 1, the encoder should not update any internal state after
2898 * completing the encode. E.g. no updates to reference buffers, CDF
2899 * tables or RC state.
2900 */
2901 int b_freeze_internal_state;
2902} AV1_PRIMARY;
2903
2904/*!
2905 * \brief Top level encoder structure.
2906 */
2907typedef struct AV1_COMP {
Excessive padding in 'struct AV1_COMP' (114 padding bytes, where 2 is optimal). Optimal fields order: common, enc_quant_dequant_params, td, ppi, coeff_buffer_base, source, last_source, unscaled_source, unscaled_last_source, unfiltered_source, tpl_rdmult_scaling_factors, cdef_search_ctx, last_show_frame_buf, ambient_err, framerate, cyclic_refresh, tile_data, new_framerate, film_grain_table, denoise_and_model, ssim_rdmult_scaling_factors, consec_zero_mv, mb_weber_stats, prep_rate_estimates, ext_rate_distribution, ext_rate_scale, norm_wiener_variance, mb_delta_q, second_pass_log_stream, src_sad_blk_64x64, rec_sse, mbmi_ext_info, enc_seg, active_map, firstpass_data, extrc_tpl_gop_stats, coeff_buffer_pool, time_stamps, pick_lr_ctxt, twopass_frame, vbp_info, scaled_ref_buf, ducky_encode_info, ext_part_controller, roi, lr_ctxt, gm_info, ext_ratectrl, scaled_source, scaled_last_source, orig_source, last_frame_uf, trial_frame_rst, force_intpel_info, svc, tf_ctx, rc, oxcf, coding_context, sf, mt_info, mv_search_params, token_info, rd, skip_tpl_setup_stats, cb_delta_rdmult_enabled, rt_reduce_num_ref_buffers, ref_frame_flags, speed, all_one_sided_refs, droppable, frame_index_set, data_alloc_width, data_alloc_height, initial_mbs, last_coded_width, last_coded_height, allocated_tiles, vaq_refresh, num_frame_recode, do_update_vbr_bits_off_target_fast, existing_fb_idx_to_show, intrabc_used, prune_ref_frame_mask, keep_single_ref_frame_mask, keep_comp_ref_frame_mask, use_screen_content_tools, is_screen_content_type, frame_header_count, deltaq_used, num_tg, superres_mode, consec_zero_mv_alloc_size, sb_counter, ref_refresh_index, ref_idx_to_skip, src_sad_blk_alloc_size, use_ducky_encode, frames_since_last_update, palette_pixel_num, scaled_last_source_available, resize_pending_params, interp_search_flags, ext_flags, ref_frame_dist_info, noise_estimate, frame_info, do_update_frame_probs_txtype, do_update_frame_probs_obmc, do_update_frame_probs_warp, do_update_frame_probs_interpfilter, winner_mode_params, mv_stats, zeromv_skip_thresh_exit_part, counts, frame_new_probs, gf_frame_index, frame_size_related_setup_done, compressor_stage, last_frame_type, fp_block_size, refresh_idx_available, do_frame_data_update, weber_bsize, is_dropped_frame, alloc_pyramid, do_border_pad, refresh_frame, optimize_seg_arr, consider reordering the fields or adding explicit padding members
2908 /*!
2909 * Pointer to top level primary encoder structure
2910 */
2911 AV1_PRIMARY *ppi;
2912
2913 /*!
2914 * Quantization and dequantization parameters for internal quantizer setup
2915 * in the encoder.
2916 */
2917 EncQuantDequantParams enc_quant_dequant_params;
2918
2919 /*!
2920 * Structure holding thread specific variables.
2921 */
2922 ThreadData td;
2923
2924 /*!
2925 * Statistics collected at frame level.
2926 */
2927 FRAME_COUNTS counts;
2928
2929 /*!
2930 * Holds buffer storing mode information at 4x4/8x8 level.
2931 */
2932 MBMIExtFrameBufferInfo mbmi_ext_info;
2933
2934 /*!
2935 * Buffer holding the transform block related information.
2936 * coeff_buffer_base[i] stores the transform block related information of the
2937 * ith superblock in raster scan order.
2938 */
2939 CB_COEFF_BUFFER *coeff_buffer_base;
2940
2941 /*!
2942 * Structure holding pointers to frame level memory allocated for transform
2943 * block related information.
2944 */
2945 CoeffBufferPool coeff_buffer_pool;
2946
2947 /*!
2948 * Structure holding variables common to encoder and decoder.
2949 */
2950 AV1_COMMON common;
2951
2952 /*!
2953 * Encoder configuration related parameters.
2954 */
2955 AV1EncoderConfig oxcf;
2956
2957 /*!
2958 * Stores the trellis optimization type at segment level.
2959 * optimize_seg_arr[i] stores the trellis opt type for ith segment.
2960 */
2961 TRELLIS_OPT_TYPE optimize_seg_arr[MAX_SEGMENTS8];
2962
2963 /*!
2964 * Pointer to the frame buffer holding the source frame to be used during the
2965 * current stage of encoding. It can be the raw input, temporally filtered
2966 * input or scaled input.
2967 */
2968 YV12_BUFFER_CONFIG *source;
2969
2970 /*!
2971 * Pointer to the frame buffer holding the last raw source frame.
2972 * last_source is NULL for the following cases:
2973 * 1) First frame
2974 * 2) Alt-ref frames
2975 * 3) All frames for all-intra frame encoding.
2976 */
2977 YV12_BUFFER_CONFIG *last_source;
2978
2979 /*!
2980 * Pointer to the frame buffer holding the unscaled source frame.
2981 * It can be either the raw input or temporally filtered input.
2982 */
2983 YV12_BUFFER_CONFIG *unscaled_source;
2984
2985 /*!
2986 * Frame buffer holding the resized source frame (cropping / superres).
2987 */
2988 YV12_BUFFER_CONFIG scaled_source;
2989
2990 /*!
2991 * Pointer to the frame buffer holding the unscaled last source frame.
2992 */
2993 YV12_BUFFER_CONFIG *unscaled_last_source;
2994
2995 /*!
2996 * Frame buffer holding the resized last source frame.
2997 */
2998 YV12_BUFFER_CONFIG scaled_last_source;
2999
3000 /*!
3001 * Pointer to the original source frame. This is used to determine if the
3002 * content is screen.
3003 */
3004 YV12_BUFFER_CONFIG *unfiltered_source;
3005
3006 /*!
3007 * Frame buffer holding the orig source frame for PSNR calculation in rtc tf
3008 * case.
3009 */
3010 YV12_BUFFER_CONFIG orig_source;
3011
3012 /*!
3013 * Skip tpl setup when tpl data from gop length decision can be reused.
3014 */
3015 int skip_tpl_setup_stats;
3016
3017 /*!
3018 * Flag to indicate if RD multiplier modulation is enabled.
3019 */
3020 int cb_delta_rdmult_enabled;
3021
3022 /*!
3023 * Scaling factors used in the RD multiplier modulation.
3024 * TODO(sdeng): consider merge the following arrays.
3025 * tpl_rdmult_scaling_factors is a temporary buffer used to store the
3026 * intermediate scaling factors which are used in the calculation of
3027 * tpl_sb_rdmult_scaling_factors. tpl_rdmult_scaling_factors[i] stores the
3028 * intermediate scaling factor of the ith 16 x 16 block in raster scan order.
3029 */
3030 double *tpl_rdmult_scaling_factors;
3031
3032 /*!
3033 * Temporal filter context.
3034 */
3035 TemporalFilterCtx tf_ctx;
3036
3037 /*!
3038 * Pointer to CDEF search context.
3039 */
3040 CdefSearchCtx *cdef_search_ctx;
3041
3042 /*!
3043 * Variables related to forcing integer mv decisions for the current frame.
3044 */
3045 ForceIntegerMVInfo force_intpel_info;
3046
3047 /*!
3048 * Pointer to the buffer holding the scaled reference frames.
3049 * scaled_ref_buf[i] holds the scaled reference frame of type i.
3050 */
3051 RefCntBuffer *scaled_ref_buf[INTER_REFS_PER_FRAME];
3052
3053 /*!
3054 * Pointer to the buffer holding the last show frame.
3055 */
3056 RefCntBuffer *last_show_frame_buf;
3057
3058 /*!
3059 * Refresh frame flags for golden, bwd-ref and alt-ref frames.
3060 */
3061 RefreshFrameInfo refresh_frame;
3062
3063 /*!
3064 * Flag to reduce the number of reference frame buffers used in rt.
3065 */
3066 int rt_reduce_num_ref_buffers;
3067
3068 /*!
3069 * Flags signalled by the external interface at frame level.
3070 */
3071 ExternalFlags ext_flags;
3072
3073 /*!
3074 * Temporary frame buffer used to store the non-loop filtered reconstructed
3075 * frame during the search of loop filter level.
3076 */
3077 YV12_BUFFER_CONFIG last_frame_uf;
3078
3079 /*!
3080 * Temporary frame buffer used to store the loop restored frame during loop
3081 * restoration search.
3082 */
3083 YV12_BUFFER_CONFIG trial_frame_rst;
3084
3085 /*!
3086 * Ambient reconstruction err target for force key frames.
3087 */
3088 int64_t ambient_err;
3089
3090 /*!
3091 * Parameters related to rate distortion optimization.
3092 */
3093 RD_OPT rd;
3094
3095 /*!
3096 * Temporary coding context used to save and restore when encoding with and
3097 * without super-resolution.
3098 */
3099 CODING_CONTEXT coding_context;
3100
3101 /*!
3102 * Parameters related to global motion search.
3103 */
3104 GlobalMotionInfo gm_info;
3105
3106 /*!
3107 * Parameters related to winner mode processing.
3108 */
3109 WinnerModeParams winner_mode_params;
3110
3111 /*!
3112 * Frame time stamps.
3113 */
3114 TimeStamps time_stamps;
3115
3116 /*!
3117 * Rate control related parameters.
3118 */
3119 RATE_CONTROL rc;
3120
3121 /*!
3122 * Frame rate of the video.
3123 */
3124 double framerate;
3125
3126 /*!
3127 * Bitmask indicating which reference buffers may be referenced by this frame.
3128 */
3129 int ref_frame_flags;
3130
3131 /*!
3132 * speed is passed as a per-frame parameter into the encoder.
3133 */
3134 int speed;
3135
3136 /*!
3137 * sf contains fine-grained config set internally based on speed.
3138 */
3139 SPEED_FEATURES sf;
3140
3141 /*!
3142 * Parameters for motion vector search process.
3143 */
3144 MotionVectorSearchParams mv_search_params;
3145
3146 /*!
3147 * When set, indicates that all reference frames are forward references,
3148 * i.e., all the reference frames are output before the current frame.
3149 */
3150 int all_one_sided_refs;
3151
3152 /*!
3153 * Segmentation related information for current frame.
3154 */
3155 EncSegmentationInfo enc_seg;
3156
3157 /*!
3158 * Parameters related to cyclic refresh aq-mode.
3159 */
3160 CYCLIC_REFRESH *cyclic_refresh;
3161 /*!
3162 * Parameters related to active map. Active maps indicate
3163 * if there is any activity on a 4x4 block basis.
3164 */
3165 ActiveMap active_map;
3166
3167 /*!
3168 * The frame processing order within a GOP.
3169 */
3170 unsigned char gf_frame_index;
3171
3172#if CONFIG_INTERNAL_STATS0
3173 /*!\cond */
3174 uint64_t time_compress_data;
3175
3176 unsigned int mode_chosen_counts[MAX_MODES];
3177 int bytes;
3178 unsigned int frame_recode_hits;
3179 /*!\endcond */
3180#endif
3181
3182#if CONFIG_SPEED_STATS0
3183 /*!
3184 * For debugging: number of transform searches we have performed.
3185 */
3186 unsigned int tx_search_count;
3187#endif // CONFIG_SPEED_STATS
3188
3189 /*!
3190 * When set, indicates that the frame is droppable, i.e., this frame
3191 * does not update any reference buffers.
3192 */
3193 int droppable;
3194
3195 /*!
3196 * Stores the frame parameters during encoder initialization.
3197 */
3198 FRAME_INFO frame_info;
3199
3200 /*!
3201 * Stores different types of frame indices.
3202 */
3203 FRAME_INDEX_SET frame_index_set;
3204
3205 /*!
3206 * Stores the cm->width in the last call of alloc_compressor_data(). Helps
3207 * determine whether compressor data should be reallocated when cm->width
3208 * changes.
3209 */
3210 int data_alloc_width;
3211
3212 /*!
3213 * Stores the cm->height in the last call of alloc_compressor_data(). Helps
3214 * determine whether compressor data should be reallocated when cm->height
3215 * changes.
3216 */
3217 int data_alloc_height;
3218
3219 /*!
3220 * Number of MBs in the full-size frame; to be used to
3221 * normalize the firstpass stats. This will differ from the
3222 * number of MBs in the current frame when the frame is
3223 * scaled.
3224 */
3225 int initial_mbs;
3226
3227 /*!
3228 * Flag to indicate whether the frame size inforamation has been
3229 * setup and propagated to associated allocations.
3230 */
3231 bool_Bool frame_size_related_setup_done;
3232
3233 /*!
3234 * The width of the frame that is lastly encoded.
3235 * It is updated in the function "encoder_encode()".
3236 */
3237 int last_coded_width;
3238
3239 /*!
3240 * The height of the frame that is lastly encoded.
3241 * It is updated in the function "encoder_encode()".
3242 */
3243 int last_coded_height;
3244
3245 /*!
3246 * Resize related parameters.
3247 */
3248 ResizePendingParams resize_pending_params;
3249
3250 /*!
3251 * Pointer to struct holding adaptive data/contexts/models for the tile during
3252 * encoding.
3253 */
3254 TileDataEnc *tile_data;
3255 /*!
3256 * Number of tiles for which memory has been allocated for tile_data.
3257 */
3258 int allocated_tiles;
3259
3260 /*!
3261 * Structure to store the palette token related information.
3262 */
3263 TokenInfo token_info;
3264
3265 /*!
3266 * VARIANCE_AQ segment map refresh.
3267 */
3268 int vaq_refresh;
3269
3270 /*!
3271 * Thresholds for variance based partitioning.
3272 */
3273 VarBasedPartitionInfo vbp_info;
3274
3275 /*!
3276 * Number of recodes in the frame.
3277 */
3278 int num_frame_recode;
3279
3280 /*!
3281 * Current frame probability of parallel frames, across recodes.
3282 */
3283 FrameProbInfo frame_new_probs[NUM_RECODES_PER_FRAME10];
3284
3285 /*!
3286 * Retain condition for transform type frame_probability calculation
3287 */
3288 int do_update_frame_probs_txtype[NUM_RECODES_PER_FRAME10];
3289
3290 /*!
3291 * Retain condition for obmc frame_probability calculation
3292 */
3293 int do_update_frame_probs_obmc[NUM_RECODES_PER_FRAME10];
3294
3295 /*!
3296 * Retain condition for warped motion frame_probability calculation
3297 */
3298 int do_update_frame_probs_warp[NUM_RECODES_PER_FRAME10];
3299
3300 /*!
3301 * Retain condition for interpolation filter frame_probability calculation
3302 */
3303 int do_update_frame_probs_interpfilter[NUM_RECODES_PER_FRAME10];
3304
3305#if CONFIG_FPMT_TEST0
3306 /*!
3307 * Temporary variable for simulation.
3308 * Previous frame's framerate.
3309 */
3310 double temp_framerate;
3311#endif
3312 /*!
3313 * Updated framerate for the current parallel frame.
3314 * cpi->framerate is updated with new_framerate during
3315 * post encode updates for parallel frames.
3316 */
3317 double new_framerate;
3318
3319 /*!
3320 * Retain condition for fast_extra_bits calculation.
3321 */
3322 int do_update_vbr_bits_off_target_fast;
3323
3324 /*!
3325 * Multi-threading parameters.
3326 */
3327 MultiThreadInfo mt_info;
3328
3329 /*!
3330 * Specifies the frame to be output. It is valid only if show_existing_frame
3331 * is 1. When show_existing_frame is 0, existing_fb_idx_to_show is set to
3332 * INVALID_IDX.
3333 */
3334 int existing_fb_idx_to_show;
3335
3336 /*!
3337 * A flag to indicate if intrabc is ever used in current frame.
3338 */
3339 int intrabc_used;
3340
3341 /*!
3342 * Mark which ref frames can be skipped for encoding current frame during RDO.
3343 */
3344 int prune_ref_frame_mask;
3345
3346 /*!
3347 * Mark the single reference frames which are important (based on the temporal
3348 * distance and quality) to prevent pruning the reference frame at block
3349 * level.
3350 */
3351 int keep_single_ref_frame_mask;
3352
3353 /*!
3354 * Mark the compound reference frames which are important (based on the
3355 * temporal distance and quality) to prevent pruning the reference frame pair
3356 * at block level.
3357 */
3358 int keep_comp_ref_frame_mask;
3359
3360 /*!
3361 * Loop Restoration context.
3362 */
3363 AV1LrStruct lr_ctxt;
3364
3365 /*!
3366 * Loop Restoration context used during pick stage.
3367 */
3368 AV1LrPickStruct pick_lr_ctxt;
3369
3370 /*!
3371 * Pointer to list of tables with film grain parameters.
3372 */
3373 aom_film_grain_table_t *film_grain_table;
3374
3375#if CONFIG_DENOISE1
3376 /*!
3377 * Pointer to structure holding the denoised image buffers and the helper
3378 * noise models.
3379 */
3380 struct aom_denoise_and_model_t *denoise_and_model;
3381#endif
3382
3383 /*!
3384 * Flags related to interpolation filter search.
3385 */
3386 InterpSearchFlags interp_search_flags;
3387
3388 /*!
3389 * Turn on screen content tools flag.
3390 * Note that some videos are not screen content videos, but
3391 * screen content tools could also improve coding efficiency.
3392 * For example, videos with large flat regions, gaming videos that look
3393 * like natural videos.
3394 */
3395 int use_screen_content_tools;
3396
3397 /*!
3398 * A flag to indicate "real" screen content videos.
3399 * For example, screen shares, screen editing.
3400 * This type is true indicates |use_screen_content_tools| must be true.
3401 * In addition, rate control strategy is adjusted when this flag is true.
3402 */
3403 int is_screen_content_type;
3404
3405#if CONFIG_COLLECT_PARTITION_STATS0
3406 /*!
3407 * Accumulates the partition timing stat over the whole frame.
3408 */
3409 FramePartitionTimingStats partition_stats;
3410#endif // CONFIG_COLLECT_PARTITION_STATS
3411
3412#if CONFIG_COLLECT_COMPONENT_TIMING0
3413 /*!
3414 * component_time[] are initialized to zero while encoder starts.
3415 */
3416 uint64_t component_time[kTimingComponents];
3417 /*!
3418 * Stores timing for individual components between calls of start_timing()
3419 * and end_timing().
3420 */
3421 struct aom_usec_timer component_timer[kTimingComponents];
3422 /*!
3423 * frame_component_time[] are initialized to zero at beginning of each frame.
3424 */
3425 uint64_t frame_component_time[kTimingComponents];
3426#endif
3427
3428 /*!
3429 * Count the number of OBU_FRAME and OBU_FRAME_HEADER for level calculation.
3430 */
3431 int frame_header_count;
3432
3433 /*!
3434 * Whether any no-zero delta_q was actually used.
3435 */
3436 int deltaq_used;
3437
3438 /*!
3439 * Refrence frame distance related variables.
3440 */
3441 RefFrameDistanceInfo ref_frame_dist_info;
3442
3443 /*!
3444 * ssim_rdmult_scaling_factors[i] stores the RD multiplier scaling factor of
3445 * the ith 16 x 16 block in raster scan order. This scaling factor is used for
3446 * RD multiplier modulation when SSIM tuning is enabled.
3447 */
3448 double *ssim_rdmult_scaling_factors;
3449
3450#if CONFIG_TUNE_VMAF0
3451 /*!
3452 * Parameters for VMAF tuning.
3453 */
3454 TuneVMAFInfo vmaf_info;
3455#endif
3456
3457#if CONFIG_TUNE_BUTTERAUGLI0
3458 /*!
3459 * Parameters for Butteraugli tuning.
3460 */
3461 TuneButteraugliInfo butteraugli_info;
3462#endif
3463
3464 /*!
3465 * Parameters for scalable video coding.
3466 */
3467 SVC svc;
3468
3469 /*!
3470 * Indicates whether current processing stage is encode stage or LAP stage.
3471 */
3472 COMPRESSOR_STAGE compressor_stage;
3473
3474 /*!
3475 * Frame type of the last frame. May be used in some heuristics for speeding
3476 * up the encoding.
3477 */
3478 FRAME_TYPE last_frame_type;
3479
3480 /*!
3481 * Number of tile-groups.
3482 */
3483 int num_tg;
3484
3485 /*!
3486 * Super-resolution mode currently being used by the encoder.
3487 * This may / may not be same as user-supplied mode in oxcf->superres_mode
3488 * (when we are recoding to try multiple options for example).
3489 */
3490 aom_superres_mode superres_mode;
3491
3492 /*!
3493 * First pass related data.
3494 */
3495 FirstPassData firstpass_data;
3496
3497 /*!
3498 * Temporal Noise Estimate
3499 */
3500 NOISE_ESTIMATE noise_estimate;
3501
3502#if CONFIG_AV1_TEMPORAL_DENOISING0
3503 /*!
3504 * Temporal Denoiser
3505 */
3506 AV1_DENOISER denoiser;
3507#endif
3508
3509 /*!
3510 * Count on how many consecutive times a block uses small/zeromv for encoding
3511 * in a scale of 8x8 block.
3512 */
3513 uint8_t *consec_zero_mv;
3514
3515 /*!
3516 * Allocated memory size for |consec_zero_mv|.
3517 */
3518 int consec_zero_mv_alloc_size;
3519
3520 /*!
3521 * Block size of first pass encoding
3522 */
3523 BLOCK_SIZE fp_block_size;
3524
3525 /*!
3526 * The counter of encoded super block, used to differentiate block names.
3527 * This number starts from 0 and increases whenever a super block is encoded.
3528 */
3529 int sb_counter;
3530
3531 /*!
3532 * The controller of the external partition model.
3533 * It is used to do partition type selection based on external models.
3534 */
3535 ExtPartController ext_part_controller;
3536
3537 /*!
3538 * Motion vector stats of the current encoded frame, used to update the
3539 * ppi->mv_stats during postencode.
3540 */
3541 MV_STATS mv_stats;
3542 /*!
3543 * Stores the reference refresh index for the current frame.
3544 */
3545 int ref_refresh_index;
3546
3547 /*!
3548 * A flag to indicate if the reference refresh index is available for the
3549 * current frame.
3550 */
3551 bool_Bool refresh_idx_available;
3552
3553 /*!
3554 * Reference frame index corresponding to the frame to be excluded from being
3555 * used as a reference by frame_parallel_level 2 frame in a parallel
3556 * encode set of lower layer frames.
3557 */
3558 int ref_idx_to_skip;
3559#if CONFIG_FPMT_TEST0
3560 /*!
3561 * Stores the wanted frame buffer index for choosing primary ref frame by a
3562 * frame_parallel_level 2 frame in a parallel encode set of lower layer
3563 * frames.
3564 */
3565
3566 int wanted_fb;
3567#endif // CONFIG_FPMT_TEST
3568
3569 /*!
3570 * A flag to indicate frames that will update their data to the primary
3571 * context at the end of the encode. It is set for non-parallel frames and the
3572 * last frame in encode order in a given parallel encode set.
3573 */
3574 bool_Bool do_frame_data_update;
3575
3576#if CONFIG_RD_COMMAND0
3577 /*!
3578 * A structure for assigning external q_index / rdmult for experiments
3579 */
3580 RD_COMMAND rd_command;
3581#endif // CONFIG_RD_COMMAND
3582
3583 /*!
3584 * Buffer to store MB variance after Wiener filter.
3585 */
3586 WeberStats *mb_weber_stats;
3587
3588 /*!
3589 * Buffer to store rate cost estimates for each macro block (8x8) in the
3590 * preprocessing stage used in allintra mode.
3591 */
3592 int *prep_rate_estimates;
3593
3594 /*!
3595 * Buffer to store rate cost estimates for each 16x16 block read
3596 * from an external file, used in allintra mode.
3597 */
3598 double *ext_rate_distribution;
3599
3600 /*!
3601 * The scale that equals sum_rate_uniform_quantizer / sum_ext_rate.
3602 */
3603 double ext_rate_scale;
3604
3605 /*!
3606 * Buffer to store MB variance after Wiener filter.
3607 */
3608 BLOCK_SIZE weber_bsize;
3609
3610 /*!
3611 * Frame level Wiener filter normalization.
3612 */
3613 int64_t norm_wiener_variance;
3614
3615 /*!
3616 * Buffer to store delta-q values for delta-q mode 4.
3617 */
3618 int *mb_delta_q;
3619
3620 /*!
3621 * Flag to indicate that current frame is dropped.
3622 */
3623 bool_Bool is_dropped_frame;
3624
3625#if CONFIG_BITRATE_ACCURACY0
3626 /*!
3627 * Structure stores information needed for bitrate accuracy experiment.
3628 */
3629 VBR_RATECTRL_INFO vbr_rc_info;
3630#endif
3631
3632#if CONFIG_RATECTRL_LOG0
3633 /*!
3634 * Structure stores information of rate control decisions.
3635 */
3636 RATECTRL_LOG rc_log;
3637#endif // CONFIG_RATECTRL_LOG
3638
3639 /*!
3640 * Frame level twopass status and control data
3641 */
3642 TWO_PASS_FRAME twopass_frame;
3643
3644#if CONFIG_THREE_PASS0
3645 /*!
3646 * Context needed for third pass encoding.
3647 */
3648 THIRD_PASS_DEC_CTX *third_pass_ctx;
3649#endif
3650
3651 /*!
3652 * File pointer to second pass log
3653 */
3654 FILE *second_pass_log_stream;
3655
3656 /*!
3657 * Buffer to store 64x64 SAD
3658 */
3659 uint64_t *src_sad_blk_64x64;
3660
3661 /*!
3662 * Size of allocated buffer to store 64x64 SAD, in units of uint64_t.
3663 */
3664 int src_sad_blk_alloc_size;
3665
3666 /*!
3667 * SSE between the current frame and the reconstructed last frame
3668 * It is only used for CBR mode.
3669 * It is not used if the reference frame has a different frame size.
3670 */
3671 uint64_t rec_sse;
3672
3673 /*!
3674 * A flag to indicate whether the encoder is controlled by DuckyEncode or not.
3675 * 1:yes 0:no
3676 */
3677 int use_ducky_encode;
3678
3679#if !CONFIG_REALTIME_ONLY0
3680 /*! A structure that facilitates the communication between DuckyEncode and AV1
3681 * encoder.
3682 */
3683 DuckyEncodeInfo ducky_encode_info;
3684#endif // CONFIG_REALTIME_ONLY
3685 //
3686 /*!
3687 * Frames since last frame with cdf update.
3688 */
3689 int frames_since_last_update;
3690
3691 /*!
3692 * Block level thresholds to force zeromv-skip at partition level.
3693 */
3694 unsigned int zeromv_skip_thresh_exit_part[BLOCK_SIZES_ALL];
3695
3696 /*!
3697 * Should we allocate a downsampling pyramid for each frame buffer?
3698 * This is currently only used for global motion
3699 */
3700 bool_Bool alloc_pyramid;
3701
3702#if CONFIG_SALIENCY_MAP0
3703 /*!
3704 * Pixel level saliency map for each frame.
3705 */
3706 uint8_t *saliency_map;
3707
3708 /*!
3709 * Superblock level rdmult scaling factor driven by saliency map.
3710 */
3711 double *sm_scaling_factor;
3712#endif
3713
3714 /*!
3715 * Number of pixels that choose palette mode for luma in the
3716 * fast encoding pass in av1_determine_sc_tools_with_encoding().
3717 */
3718 int palette_pixel_num;
3719
3720 /*!
3721 * Flag to indicate scaled_last_source is available,
3722 * so scaling is not needed for last_source.
3723 */
3724 int scaled_last_source_available;
3725
3726 /*!
3727 * ROI map.
3728 */
3729 aom_roi_map_t roi;
3730
3731 /*!
3732 * External rate control.
3733 */
3734 AOM_EXT_RATECTRL ext_ratectrl;
3735
3736 /*!
3737 * Store TPL stats before propagation
3738 */
3739 AomTplGopStats extrc_tpl_gop_stats;
3740
3741 /*!
3742 * If true fills residual pixels outside the actual frame border
3743 */
3744 bool_Bool do_border_pad;
3745} AV1_COMP;
3746
3747/*!
3748 * \brief Input frames and last input frame
3749 */
3750typedef struct EncodeFrameInput {
3751 /*!\cond */
3752 YV12_BUFFER_CONFIG *source;
3753 YV12_BUFFER_CONFIG *last_source;
3754 int64_t ts_duration;
3755 /*!\endcond */
3756} EncodeFrameInput;
3757
3758/*!
3759 * \brief contains per-frame encoding parameters decided upon by
3760 * av1_encode_strategy() and passed down to av1_encode().
3761 */
3762typedef struct EncodeFrameParams {
3763 /*!
3764 * Is error resilient mode enabled
3765 */
3766 int error_resilient_mode;
3767 /*!
3768 * Frame type (eg KF vs inter frame etc)
3769 */
3770 FRAME_TYPE frame_type;
3771
3772 /*!\cond */
3773 int primary_ref_frame;
3774 int order_offset;
3775
3776 /*!\endcond */
3777 /*!
3778 * Should the current frame be displayed after being decoded
3779 */
3780 int show_frame;
3781
3782 /*!\cond */
3783 int refresh_frame_flags;
3784
3785 int show_existing_frame;
3786 int existing_fb_idx_to_show;
3787
3788 /*!\endcond */
3789 /*!
3790 * Bitmask of which reference buffers may be referenced by this frame.
3791 */
3792 int ref_frame_flags;
3793
3794 /*!
3795 * Reference buffer assignment for this frame.
3796 */
3797 int remapped_ref_idx[REF_FRAMES];
3798
3799 /*!
3800 * Flags which determine which reference buffers are refreshed by this
3801 * frame.
3802 */
3803 RefreshFrameInfo refresh_frame;
3804
3805 /*!
3806 * Speed level to use for this frame: Bigger number means faster.
3807 */
3808 int speed;
3809} EncodeFrameParams;
3810
3811/*!\cond */
3812
3813void av1_initialize_enc(unsigned int usage, enum aom_rc_mode end_usage);
3814
3815struct AV1_COMP *av1_create_compressor(struct AV1_PRIMARY *ppi,
3816 const AV1EncoderConfig *oxcf,
3817 struct BufferPool *const pool,
3818 COMPRESSOR_STAGE stage,
3819 int lap_lag_in_frames);
3820
3821struct AV1_PRIMARY *av1_create_primary_compressor(
3822 struct aom_codec_pkt_list *pkt_list_head, int num_lap_buffers,
3823 const AV1EncoderConfig *oxcf);
3824
3825void av1_remove_compressor(AV1_COMP *cpi);
3826
3827void av1_remove_primary_compressor(AV1_PRIMARY *ppi);
3828
3829#if CONFIG_ENTROPY_STATS0
3830void print_entropy_stats(AV1_PRIMARY *const ppi);
3831#endif
3832#if CONFIG_INTERNAL_STATS0
3833void print_internal_stats(AV1_PRIMARY *ppi);
3834#endif
3835
3836void av1_change_config_seq(AV1_PRIMARY *ppi, const AV1EncoderConfig *oxcf,
3837 bool_Bool *sb_size_changed);
3838
3839void av1_change_config(AV1_COMP *cpi, const AV1EncoderConfig *oxcf,
3840 bool_Bool sb_size_changed);
3841
3842aom_codec_err_t av1_check_initial_width(AV1_COMP *cpi, int use_highbitdepth,
3843 int subsampling_x, int subsampling_y);
3844
3845void av1_post_encode_updates(AV1_COMP *const cpi,
3846 const AV1_COMP_DATA *const cpi_data);
3847
3848void av1_release_scaled_references_fpmt(AV1_COMP *cpi);
3849
3850void av1_decrement_ref_counts_fpmt(BufferPool *buffer_pool,
3851 int ref_buffers_used_map);
3852
3853void av1_init_sc_decisions(AV1_PRIMARY *const ppi);
3854
3855AV1_COMP *av1_get_parallel_frame_enc_data(AV1_PRIMARY *const ppi,
3856 AV1_COMP_DATA *const first_cpi_data);
3857
3858int av1_init_parallel_frame_context(const AV1_COMP_DATA *const first_cpi_data,
3859 AV1_PRIMARY *const ppi,
3860 int *ref_buffers_used_map);
3861
3862/*!\endcond */
3863
3864/*!\brief Obtain the raw frame data
3865 *
3866 * \ingroup high_level_algo
3867 * This function receives the raw frame data from input.
3868 *
3869 * \param[in] cpi Top-level encoder structure
3870 * \param[in] frame_flags Flags to decide how to encoding the frame
3871 * \param[in,out] sd Contain raw frame data
3872 * \param[in] time_stamp Time stamp of the frame
3873 * \param[in] end_time_stamp End time stamp
3874 *
3875 * \return Returns a value to indicate if the frame data is received
3876 * successfully.
3877 * \note The caller can assume that a copy of this frame is made and not just a
3878 * copy of the pointer.
3879 */
3880int av1_receive_raw_frame(AV1_COMP *cpi, aom_enc_frame_flags_t frame_flags,
3881 const YV12_BUFFER_CONFIG *sd, int64_t time_stamp,
3882 int64_t end_time_stamp);
3883
3884/*!\brief Encode a frame
3885 *
3886 * \ingroup high_level_algo
3887 * \callgraph
3888 * \callergraph
3889 * This function encodes the raw frame data, and outputs the frame bit stream
3890 * to the designated buffer. The caller should use the output parameters
3891 * cpi_data->ts_frame_start and cpi_data->ts_frame_end only when this function
3892 * returns AOM_CODEC_OK.
3893 *
3894 * \param[in] cpi Top-level encoder structure
3895 * \param[in,out] cpi_data Data corresponding to a frame encode
3896 *
3897 * \return Returns a value to indicate if the encoding is done successfully.
3898 * \retval #AOM_CODEC_OK
3899 * \retval -1
3900 * No frame encoded; more input is required.
3901 * \retval "A nonzero (positive) aom_codec_err_t code"
3902 * The encoding failed with the error. Sets the error code and error message
3903 * in \c cpi->common.error.
3904 */
3905int av1_get_compressed_data(AV1_COMP *cpi, AV1_COMP_DATA *const cpi_data);
3906
3907/*!\brief Run 1-pass/2-pass encoding
3908 *
3909 * \ingroup high_level_algo
3910 * \callgraph
3911 * \callergraph
3912 */
3913int av1_encode(AV1_COMP *const cpi, uint8_t *const dest, size_t dest_size,
3914 const EncodeFrameInput *const frame_input,
3915 const EncodeFrameParams *const frame_params,
3916 size_t *const frame_size);
3917
3918/*!\cond */
3919int av1_get_preview_raw_frame(AV1_COMP *cpi, YV12_BUFFER_CONFIG *dest);
3920
3921int av1_get_last_show_frame(AV1_COMP *cpi, YV12_BUFFER_CONFIG *frame);
3922
3923aom_codec_err_t av1_copy_new_frame_enc(AV1_COMMON *cm,
3924 YV12_BUFFER_CONFIG *new_frame,
3925 YV12_BUFFER_CONFIG *sd);
3926
3927int av1_use_as_reference(int *ext_ref_frame_flags, int ref_frame_flags);
3928
3929int av1_copy_reference_enc(AV1_COMP *cpi, int idx, YV12_BUFFER_CONFIG *sd);
3930
3931int av1_set_reference_enc(AV1_COMP *cpi, int idx, YV12_BUFFER_CONFIG *sd);
3932
3933void av1_set_frame_size(AV1_COMP *cpi, int width, int height);
3934
3935void av1_set_mv_search_params(AV1_COMP *cpi);
3936
3937int av1_set_roi_map(AV1_COMP *cpi, unsigned char *map, unsigned int rows,
3938 unsigned int cols, int delta_q[8], int delta_lf[8],
3939 int skip[8], int ref_frame[8]);
3940
3941int av1_set_active_map(AV1_COMP *cpi, unsigned char *map, int rows, int cols);
3942
3943int av1_get_active_map(AV1_COMP *cpi, unsigned char *map, int rows, int cols);
3944
3945int av1_set_internal_size(AV1EncoderConfig *const oxcf,
3946 ResizePendingParams *resize_pending_params,
3947 AOM_SCALING_MODE horiz_mode,
3948 AOM_SCALING_MODE vert_mode);
3949
3950int av1_get_quantizer(struct AV1_COMP *cpi);
3951
3952// This function assumes that the input buffer contains valid OBUs. It should
3953// not be called on untrusted input.
3954int av1_convert_sect5obus_to_annexb(uint8_t *buffer, size_t buffer_size,
3955 size_t *input_size);
3956
3957void av1_alloc_mb_wiener_var_pred_buf(AV1_COMMON *cm, ThreadData *td);
3958
3959void av1_dealloc_mb_wiener_var_pred_buf(ThreadData *td);
3960
3961uint8_t av1_find_dominant_value(const uint8_t *src, int stride, int rows,
3962 int cols);
3963
3964void av1_dilate_block(const uint8_t *src, int src_stride, uint8_t *dilated,
3965 int dilated_stride, int rows, int cols);
3966
3967// Set screen content options.
3968// This function estimates whether to use screen content tools, by counting
3969// the portion of blocks that have few luma colors.
3970// Modifies:
3971// cpi->commom.features.allow_screen_content_tools
3972// cpi->common.features.allow_intrabc
3973// cpi->use_screen_content_tools
3974// cpi->is_screen_content_type
3975// However, the estimation is not accurate and may misclassify videos.
3976// A slower but more accurate approach that determines whether to use screen
3977// content tools is employed later. See av1_determine_sc_tools_with_encoding().
3978void av1_set_screen_content_options(struct AV1_COMP *cpi,
3979 FeatureFlags *features);
3980
3981void av1_update_frame_size(AV1_COMP *cpi);
3982
3983void av1_set_svc_seq_params(AV1_PRIMARY *const ppi);
3984
3985typedef struct {
3986 int pyr_level;
3987 int disp_order;
3988} RefFrameMapPair;
3989
3990static inline void init_ref_map_pair(
3991 AV1_COMP *cpi, RefFrameMapPair ref_frame_map_pairs[REF_FRAMES]) {
3992 if (cpi->ppi->gf_group.update_type[cpi->gf_frame_index] == KF_UPDATE) {
3993 memset(ref_frame_map_pairs, -1, sizeof(*ref_frame_map_pairs) * REF_FRAMES);
3994 return;
3995 }
3996 memset(ref_frame_map_pairs, 0, sizeof(*ref_frame_map_pairs) * REF_FRAMES);
3997 for (int map_idx = 0; map_idx < REF_FRAMES; map_idx++) {
3998 // Get reference frame buffer.
3999 const RefCntBuffer *const buf = cpi->common.ref_frame_map[map_idx];
4000 if (ref_frame_map_pairs[map_idx].disp_order == -1) continue;
4001 if (buf == NULL((void*)0)) {
4002 ref_frame_map_pairs[map_idx].disp_order = -1;
4003 ref_frame_map_pairs[map_idx].pyr_level = -1;
4004 continue;
4005 } else if (buf->ref_count > 1) {
4006 // Once the keyframe is coded, the slots in ref_frame_map will all
4007 // point to the same frame. In that case, all subsequent pointers
4008 // matching the current are considered "free" slots. This will find
4009 // the next occurrence of the current pointer if ref_count indicates
4010 // there are multiple instances of it and mark it as free.
4011 for (int idx2 = map_idx + 1; idx2 < REF_FRAMES; ++idx2) {
4012 const RefCntBuffer *const buf2 = cpi->common.ref_frame_map[idx2];
4013 if (buf2 == buf) {
4014 ref_frame_map_pairs[idx2].disp_order = -1;
4015 ref_frame_map_pairs[idx2].pyr_level = -1;
4016 }
4017 }
4018 }
4019 ref_frame_map_pairs[map_idx].disp_order = (int)buf->display_order_hint;
4020 ref_frame_map_pairs[map_idx].pyr_level = buf->pyramid_level;
4021 }
4022}
4023
4024#if CONFIG_FPMT_TEST0
4025static inline void calc_frame_data_update_flag(
4026 GF_GROUP *const gf_group, int gf_frame_index,
4027 bool_Bool *const do_frame_data_update) {
4028 *do_frame_data_update = true1;
4029 // Set the flag to false for all frames in a given parallel encode set except
4030 // the last frame in the set with frame_parallel_level = 2.
4031 if (gf_group->frame_parallel_level[gf_frame_index] == 1) {
4032 *do_frame_data_update = false0;
4033 } else if (gf_group->frame_parallel_level[gf_frame_index] == 2) {
4034 // Check if this is the last frame in the set with frame_parallel_level = 2.
4035 for (int i = gf_frame_index + 1; i < gf_group->size; i++) {
4036 if ((gf_group->frame_parallel_level[i] == 0 &&
4037 (gf_group->update_type[i] == ARF_UPDATE ||
4038 gf_group->update_type[i] == INTNL_ARF_UPDATE)) ||
4039 gf_group->frame_parallel_level[i] == 1) {
4040 break;
4041 } else if (gf_group->frame_parallel_level[i] == 2) {
4042 *do_frame_data_update = false0;
4043 break;
4044 }
4045 }
4046 }
4047}
4048#endif
4049
4050// av1 uses 10,000,000 ticks/second as time stamp
4051#define TICKS_PER_SEC10000000LL 10000000LL
4052
4053static inline int64_t timebase_units_to_ticks(
4054 const aom_rational64_t *timestamp_ratio, int64_t n) {
4055 return n * timestamp_ratio->num / timestamp_ratio->den;
4056}
4057
4058static inline int64_t ticks_to_timebase_units(
4059 const aom_rational64_t *timestamp_ratio, int64_t n) {
4060 int64_t round = timestamp_ratio->num / 2;
4061 if (round > 0) --round;
4062 return (n * timestamp_ratio->den + round) / timestamp_ratio->num;
4063}
4064
4065static inline int frame_is_kf_gf_arf(const AV1_COMP *cpi) {
4066 const GF_GROUP *const gf_group = &cpi->ppi->gf_group;
4067 const FRAME_UPDATE_TYPE update_type =
4068 gf_group->update_type[cpi->gf_frame_index];
4069
4070 return frame_is_intra_only(&cpi->common) || update_type == ARF_UPDATE ||
4071 update_type == GF_UPDATE;
4072}
4073
4074// TODO(huisu@google.com, youzhou@microsoft.com): enable hash-me for HBD.
4075static inline int av1_use_hash_me(const AV1_COMP *const cpi) {
4076 return (cpi->common.features.allow_screen_content_tools &&
4077 cpi->common.features.allow_intrabc &&
4078 frame_is_intra_only(&cpi->common));
4079}
4080
4081static inline const YV12_BUFFER_CONFIG *get_ref_frame_yv12_buf(
4082 const AV1_COMMON *const cm, MV_REFERENCE_FRAME ref_frame) {
4083 const RefCntBuffer *const buf = get_ref_frame_buf(cm, ref_frame);
4084 return buf != NULL((void*)0) ? &buf->buf : NULL((void*)0);
4085}
4086
4087static inline void alloc_frame_mvs(AV1_COMMON *const cm, RefCntBuffer *buf) {
4088 assert(buf != NULL)((void) sizeof ((buf != ((void*)0)) ? 1 : 0), __extension__ (
{ if (buf != ((void*)0)) ; else __assert_fail ("buf != NULL",
"/root/firefox-clang/third_party/aom/av1/encoder/encoder.h",
4088, __extension__ __PRETTY_FUNCTION__); }))
;
4089 ensure_mv_buffer(buf, cm);
4090 buf->width = cm->width;
4091 buf->height = cm->height;
4092}
4093
4094// Get the allocated token size for a tile. It does the same calculation as in
4095// the frame token allocation.
4096static inline unsigned int allocated_tokens(const TileInfo *tile,
4097 int sb_size_log2, int num_planes) {
4098 int tile_mb_rows =
4099 ROUND_POWER_OF_TWO(tile->mi_row_end - tile->mi_row_start, 2)(((tile->mi_row_end - tile->mi_row_start) + (((1 <<
(2)) >> 1))) >> (2))
;
4100 int tile_mb_cols =
4101 ROUND_POWER_OF_TWO(tile->mi_col_end - tile->mi_col_start, 2)(((tile->mi_col_end - tile->mi_col_start) + (((1 <<
(2)) >> 1))) >> (2))
;
4102
4103 return get_token_alloc(tile_mb_rows, tile_mb_cols, sb_size_log2, num_planes);
4104}
4105
4106static inline void get_start_tok(AV1_COMP *cpi, int tile_row, int tile_col,
4107 int mi_row, TokenExtra **tok, int sb_size_log2,
4108 int num_planes) {
4109 AV1_COMMON *const cm = &cpi->common;
4110 const int tile_cols = cm->tiles.cols;
4111 TileDataEnc *this_tile = &cpi->tile_data[tile_row * tile_cols + tile_col];
4112 const TileInfo *const tile_info = &this_tile->tile_info;
4113
4114 const int tile_mb_cols =
4115 (tile_info->mi_col_end - tile_info->mi_col_start + 2) >> 2;
4116 const int tile_mb_row = (mi_row - tile_info->mi_row_start + 2) >> 2;
4117
4118 *tok = cpi->token_info.tile_tok[tile_row][tile_col] +
4119 get_token_alloc(tile_mb_row, tile_mb_cols, sb_size_log2, num_planes);
4120}
4121
4122void av1_apply_encoding_flags(AV1_COMP *cpi, aom_enc_frame_flags_t flags);
4123
4124#define ALT_MIN_LAG3 3
4125static inline int is_altref_enabled(int lag_in_frames, bool_Bool enable_auto_arf) {
4126 return lag_in_frames >= ALT_MIN_LAG3 && enable_auto_arf;
4127}
4128
4129static inline int can_disable_altref(const GFConfig *gf_cfg) {
4130 return is_altref_enabled(gf_cfg->lag_in_frames, gf_cfg->enable_auto_arf) &&
4131 (gf_cfg->gf_min_pyr_height == 0);
4132}
4133
4134// Helper function to compute number of blocks on either side of the frame.
4135static inline int get_num_blocks(const int frame_length, const int mb_length) {
4136 return (frame_length + mb_length - 1) / mb_length;
4137}
4138
4139// Check if statistics generation stage
4140static inline int is_stat_generation_stage(const AV1_COMP *const cpi) {
4141 assert(IMPLIES(cpi->compressor_stage == LAP_STAGE,((void) sizeof (((!(cpi->compressor_stage == LAP_STAGE) ||
(cpi->oxcf.pass == AOM_RC_ONE_PASS && cpi->ppi
->lap_enabled))) ? 1 : 0), __extension__ ({ if ((!(cpi->
compressor_stage == LAP_STAGE) || (cpi->oxcf.pass == AOM_RC_ONE_PASS
&& cpi->ppi->lap_enabled))) ; else __assert_fail
("IMPLIES(cpi->compressor_stage == LAP_STAGE, cpi->oxcf.pass == AOM_RC_ONE_PASS && cpi->ppi->lap_enabled)"
, "/root/firefox-clang/third_party/aom/av1/encoder/encoder.h"
, 4142, __extension__ __PRETTY_FUNCTION__); }))
4142 cpi->oxcf.pass == AOM_RC_ONE_PASS && cpi->ppi->lap_enabled))((void) sizeof (((!(cpi->compressor_stage == LAP_STAGE) ||
(cpi->oxcf.pass == AOM_RC_ONE_PASS && cpi->ppi
->lap_enabled))) ? 1 : 0), __extension__ ({ if ((!(cpi->
compressor_stage == LAP_STAGE) || (cpi->oxcf.pass == AOM_RC_ONE_PASS
&& cpi->ppi->lap_enabled))) ; else __assert_fail
("IMPLIES(cpi->compressor_stage == LAP_STAGE, cpi->oxcf.pass == AOM_RC_ONE_PASS && cpi->ppi->lap_enabled)"
, "/root/firefox-clang/third_party/aom/av1/encoder/encoder.h"
, 4142, __extension__ __PRETTY_FUNCTION__); }))
;
4143 return (cpi->oxcf.pass == AOM_RC_FIRST_PASS ||
4144 (cpi->compressor_stage == LAP_STAGE));
4145}
4146// Check if statistics consumption stage
4147static inline int is_stat_consumption_stage_twopass(const AV1_COMP *const cpi) {
4148 return (cpi->oxcf.pass >= AOM_RC_SECOND_PASS);
4149}
4150
4151// Check if statistics consumption stage
4152static inline int is_stat_consumption_stage(const AV1_COMP *const cpi) {
4153 return (is_stat_consumption_stage_twopass(cpi) ||
4154 (cpi->oxcf.pass == AOM_RC_ONE_PASS &&
4155 (cpi->compressor_stage == ENCODE_STAGE) && cpi->ppi->lap_enabled &&
4156 cpi->oxcf.mode != REALTIME));
4157}
4158
4159// Decide whether 'dv_costs' need to be allocated/stored during the encoding.
4160static inline bool_Bool av1_need_dv_costs(const AV1_COMP *const cpi) {
4161 return (!cpi->sf.rt_sf.use_nonrd_pick_mode || cpi->sf.rt_sf.rt_use_intrabc) &&
4162 av1_allow_intrabc(&cpi->common) && !is_stat_generation_stage(cpi);
4163}
4164
4165/*!\endcond */
4166/*!\brief Check if the current stage has statistics
4167 *
4168 *\ingroup two_pass_algo
4169 *
4170 * \param[in] cpi Top - level encoder instance structure
4171 *
4172 * \return 0 if no stats for current stage else 1
4173 */
4174static inline int has_no_stats_stage(const AV1_COMP *const cpi) {
4175 assert(((void) sizeof (((!(!cpi->ppi->lap_enabled) || (cpi->
compressor_stage == ENCODE_STAGE))) ? 1 : 0), __extension__ (
{ if ((!(!cpi->ppi->lap_enabled) || (cpi->compressor_stage
== ENCODE_STAGE))) ; else __assert_fail ("IMPLIES(!cpi->ppi->lap_enabled, cpi->compressor_stage == ENCODE_STAGE)"
, "/root/firefox-clang/third_party/aom/av1/encoder/encoder.h"
, 4176, __extension__ __PRETTY_FUNCTION__); }))
4176 IMPLIES(!cpi->ppi->lap_enabled, cpi->compressor_stage == ENCODE_STAGE))((void) sizeof (((!(!cpi->ppi->lap_enabled) || (cpi->
compressor_stage == ENCODE_STAGE))) ? 1 : 0), __extension__ (
{ if ((!(!cpi->ppi->lap_enabled) || (cpi->compressor_stage
== ENCODE_STAGE))) ; else __assert_fail ("IMPLIES(!cpi->ppi->lap_enabled, cpi->compressor_stage == ENCODE_STAGE)"
, "/root/firefox-clang/third_party/aom/av1/encoder/encoder.h"
, 4176, __extension__ __PRETTY_FUNCTION__); }))
;
4177 return (cpi->oxcf.pass == AOM_RC_ONE_PASS &&
4178 (!cpi->ppi->lap_enabled || cpi->oxcf.mode == REALTIME));
4179}
4180
4181/*!\cond */
4182
4183static inline int is_one_pass_rt_lag_params(const AV1_COMP *cpi) {
4184 return cpi->oxcf.pass == AOM_RC_ONE_PASS &&
4185 cpi->oxcf.gf_cfg.lag_in_frames > 0 && cpi->oxcf.mode == REALTIME;
4186}
4187
4188static inline int is_one_pass_rt_params(const AV1_COMP *cpi) {
4189 return has_no_stats_stage(cpi) && cpi->oxcf.gf_cfg.lag_in_frames == 0 &&
4190 (cpi->oxcf.mode == REALTIME || cpi->svc.number_spatial_layers > 1);
4191}
4192
4193// Use default/internal reference structure for single-layer RTC.
4194static inline int use_rtc_reference_structure_one_layer(const AV1_COMP *cpi) {
4195 return is_one_pass_rt_params(cpi) && cpi->ppi->number_spatial_layers == 1 &&
4196 cpi->ppi->number_temporal_layers == 1 &&
4197 !cpi->ppi->rtc_ref.set_ref_frame_config;
4198}
4199
4200// Check if postencode drop is allowed.
4201static inline int allow_postencode_drop_rtc(const AV1_COMP *cpi) {
4202 const AV1_COMMON *const cm = &cpi->common;
4203 return is_one_pass_rt_params(cpi) && cpi->oxcf.rc_cfg.mode == AOM_CBR &&
4204 cpi->oxcf.rc_cfg.drop_frames_water_mark > 0 &&
4205 !cpi->rc.rtc_external_ratectrl && !frame_is_intra_only(cm) &&
4206 cpi->svc.spatial_layer_id == 0;
4207}
4208
4209// Function return size of frame stats buffer
4210static inline int get_stats_buf_size(int num_lap_buffer, int num_lag_buffer) {
4211 /* if lookahead is enabled return num_lap_buffers else num_lag_buffers */
4212 if (num_lap_buffer > 0) {
4213 return AOMMAX(num_lap_buffer + 1, MAX_GF_LENGTH_LAP + 1)(((num_lap_buffer + 1) > (16 + 1)) ? (num_lap_buffer + 1) :
(16 + 1))
;
4214 }
4215 return num_lag_buffer;
4216}
4217
4218// TODO(zoeliu): To set up cpi->oxcf.gf_cfg.enable_auto_brf
4219
4220static inline void set_ref_ptrs(const AV1_COMMON *cm, MACROBLOCKD *xd,
4221 MV_REFERENCE_FRAME ref0,
4222 MV_REFERENCE_FRAME ref1) {
4223 xd->block_ref_scale_factors[0] =
4224 get_ref_scale_factors_const(cm, ref0 >= LAST_FRAME ? ref0 : 1);
4225 xd->block_ref_scale_factors[1] =
4226 get_ref_scale_factors_const(cm, ref1 >= LAST_FRAME ? ref1 : 1);
4227}
4228
4229static inline int get_chessboard_index(int frame_index) {
4230 return frame_index & 0x1;
4231}
4232
4233static inline const int *cond_cost_list_const(const struct AV1_COMP *cpi,
4234 const int *cost_list) {
4235 const int use_cost_list = cpi->sf.mv_sf.subpel_search_method != SUBPEL_TREE &&
4236 cpi->sf.mv_sf.use_fullpel_costlist;
4237 return use_cost_list ? cost_list : NULL((void*)0);
4238}
4239
4240static inline int *cond_cost_list(const struct AV1_COMP *cpi, int *cost_list) {
4241 const int use_cost_list = cpi->sf.mv_sf.subpel_search_method != SUBPEL_TREE &&
4242 cpi->sf.mv_sf.use_fullpel_costlist;
4243 return use_cost_list ? cost_list : NULL((void*)0);
4244}
4245
4246// Compression ratio of current frame.
4247double av1_get_compression_ratio(const AV1_COMMON *const cm,
4248 size_t encoded_frame_size);
4249
4250void av1_new_framerate(AV1_COMP *cpi, double framerate);
4251
4252void av1_setup_frame_size(AV1_COMP *cpi);
4253
4254#define LAYER_IDS_TO_IDX(sl, tl, num_tl)((sl) * (num_tl) + (tl)) ((sl) * (num_tl) + (tl))
4255
4256// Returns 1 if a frame is scaled and 0 otherwise.
4257static inline int av1_resize_scaled(const AV1_COMMON *cm) {
4258 return cm->superres_upscaled_width != cm->render_width ||
4259 cm->superres_upscaled_height != cm->render_height;
4260}
4261
4262static inline int av1_frame_scaled(const AV1_COMMON *cm) {
4263 return av1_superres_scaled(cm) || av1_resize_scaled(cm);
4264}
4265
4266static inline bool_Bool av1_encode_for_extrc(AOM_EXT_RATECTRL const *ext_rc) {
4267 return ext_rc->ready && (ext_rc->funcs.rc_type & AOM_RC_QP) != 0 &&
4268 ext_rc->funcs.get_encodeframe_decision != NULL((void*)0);
4269}
4270
4271// Don't allow a show_existing_frame to coincide with an error resilient
4272// frame. An exception can be made for a forward keyframe since it has no
4273// previous dependencies.
4274static inline int encode_show_existing_frame(const AV1_COMMON *cm) {
4275 return cm->show_existing_frame && (!cm->features.error_resilient_mode ||
4276 cm->current_frame.frame_type == KEY_FRAME);
4277}
4278
4279// Get index into the 'cpi->mbmi_ext_info.frame_base' array for the given
4280// 'mi_row' and 'mi_col'.
4281static inline int get_mi_ext_idx(const int mi_row, const int mi_col,
4282 const BLOCK_SIZE mi_alloc_bsize,
4283 const int mbmi_ext_stride) {
4284 const int mi_ext_size_1d = mi_size_wide[mi_alloc_bsize];
4285 const int mi_ext_row = mi_row / mi_ext_size_1d;
4286 const int mi_ext_col = mi_col / mi_ext_size_1d;
4287 return mi_ext_row * mbmi_ext_stride + mi_ext_col;
4288}
4289
4290static inline void set_pixels_to_frame_edge(MACROBLOCK *x, int bw, int bh,
4291 int mi_col, int mi_row, int mi_cols,
4292 int mi_rows, int frame_width,
4293 int frame_height,
4294 bool_Bool do_border_pad) {
4295 int total_frame_width = do_border_pad ? frame_width : (mi_cols * 4);
4296 int total_frame_height = do_border_pad ? frame_height : (mi_rows * 4);
4297
4298 x->pix_to_bottom_edge = total_frame_height - ((mi_row + bh) << MI_SIZE_LOG22);
4299 x->pix_to_right_edge = total_frame_width - ((mi_col + bw) << MI_SIZE_LOG22);
4300}
4301
4302// Lighter version of set_offsets that only sets the mode info
4303// pointers.
4304static inline void set_mode_info_offsets(
4305 const CommonModeInfoParams *const mi_params,
4306 const MBMIExtFrameBufferInfo *const mbmi_ext_info, MACROBLOCK *const x,
4307 MACROBLOCKD *const xd, int mi_row, int mi_col) {
4308 set_mi_offsets(mi_params, xd, mi_row, mi_col);
4309 const int ext_idx = get_mi_ext_idx(mi_row, mi_col, mi_params->mi_alloc_bsize,
4310 mbmi_ext_info->stride);
4311 x->mbmi_ext_frame = mbmi_ext_info->frame_base + ext_idx;
4312}
4313
4314// Check to see if the given partition size is allowed for a specified number
4315// of mi block rows and columns remaining in the image.
4316// If not then return the largest allowed partition size
4317static inline BLOCK_SIZE find_partition_size(BLOCK_SIZE bsize, int rows_left,
4318 int cols_left, int *bh, int *bw) {
4319 int int_size = (int)bsize;
4320 if (rows_left <= 0 || cols_left <= 0) {
4321 return AOMMIN(bsize, BLOCK_8X8)(((bsize) < (BLOCK_8X8)) ? (bsize) : (BLOCK_8X8));
4322 } else {
4323 for (; int_size > 0; int_size -= 3) {
4324 *bh = mi_size_high[int_size];
4325 *bw = mi_size_wide[int_size];
4326 if ((*bh <= rows_left) && (*bw <= cols_left)) {
4327 break;
4328 }
4329 }
4330 }
4331 return (BLOCK_SIZE)int_size;
4332}
4333
4334static const uint8_t av1_ref_frame_flag_list[REF_FRAMES] = { 0,
4335 AOM_LAST_FLAG,
4336 AOM_LAST2_FLAG,
4337 AOM_LAST3_FLAG,
4338 AOM_GOLD_FLAG,
4339 AOM_BWD_FLAG,
4340 AOM_ALT2_FLAG,
4341 AOM_ALT_FLAG };
4342
4343// When more than 'max_allowed_refs' are available, we reduce the number of
4344// reference frames one at a time based on this order.
4345static const MV_REFERENCE_FRAME disable_order[] = {
4346 LAST3_FRAME,
4347 LAST2_FRAME,
4348 ALTREF2_FRAME,
4349 BWDREF_FRAME,
4350};
4351
4352static const MV_REFERENCE_FRAME
4353 ref_frame_priority_order[INTER_REFS_PER_FRAME] = {
4354 LAST_FRAME, ALTREF_FRAME, BWDREF_FRAME, GOLDEN_FRAME,
4355 ALTREF2_FRAME, LAST2_FRAME, LAST3_FRAME,
4356 };
4357
4358static inline int get_ref_frame_flags(const SPEED_FEATURES *const sf,
4359 const int use_one_pass_rt_params,
4360 const YV12_BUFFER_CONFIG **ref_frames,
4361 const int ext_ref_frame_flags) {
4362 // cpi->ext_flags.ref_frame_flags allows certain reference types to be
4363 // disabled by the external interface. These are set by
4364 // av1_apply_encoding_flags(). Start with what the external interface allows,
4365 // then suppress any reference types which we have found to be duplicates.
4366 int flags = ext_ref_frame_flags;
4367
4368 for (int i = 1; i < INTER_REFS_PER_FRAME; ++i) {
4369 const YV12_BUFFER_CONFIG *const this_ref = ref_frames[i];
4370 // If this_ref has appeared before, mark the corresponding ref frame as
4371 // invalid. For one_pass_rt mode, only disable GOLDEN_FRAME if it's the
4372 // same as LAST_FRAME or ALTREF_FRAME (if ALTREF is being used in nonrd).
4373 int index =
4374 (use_one_pass_rt_params && ref_frame_priority_order[i] == GOLDEN_FRAME)
4375 ? (1 + sf->rt_sf.use_nonrd_altref_frame)
4376 : i;
4377 for (int j = 0; j < index; ++j) {
4378 // If this_ref has appeared before (same as the reference corresponding
4379 // to lower index j), remove it as a reference only if that reference
4380 // (for index j) is actually used as a reference.
4381 if (this_ref == ref_frames[j] &&
4382 (flags & (1 << (ref_frame_priority_order[j] - 1)))) {
4383 flags &= ~(1 << (ref_frame_priority_order[i] - 1));
4384 break;
4385 }
4386 }
4387 }
4388 return flags;
4389}
4390
4391// Returns a Sequence Header OBU stored in an aom_fixed_buf_t, or NULL upon
4392// failure. When a non-NULL aom_fixed_buf_t pointer is returned by this
4393// function, the memory must be freed by the caller. Both the buf member of the
4394// aom_fixed_buf_t, and the aom_fixed_buf_t pointer itself must be freed. Memory
4395// returned must be freed via call to free().
4396//
4397// Note: The OBU returned is in Low Overhead Bitstream Format. Specifically,
4398// the obu_has_size_field bit is set, and the buffer contains the obu_size
4399// field.
4400aom_fixed_buf_t *av1_get_global_headers(AV1_PRIMARY *ppi);
4401
4402#define MAX_GFUBOOST_FACTOR10.0 10.0
4403#define MIN_GFUBOOST_FACTOR4.0 4.0
4404
4405static inline int is_frame_tpl_eligible(const GF_GROUP *const gf_group,
4406 uint8_t index) {
4407 const FRAME_UPDATE_TYPE update_type = gf_group->update_type[index];
4408 return update_type == ARF_UPDATE || update_type == GF_UPDATE ||
4409 update_type == KF_UPDATE;
4410}
4411
4412static inline int is_frame_eligible_for_ref_pruning(const GF_GROUP *gf_group,
4413 int selective_ref_frame,
4414 int prune_ref_frames,
4415 int gf_index) {
4416 return (selective_ref_frame > 0) && (prune_ref_frames > 0) &&
4417 !is_frame_tpl_eligible(gf_group, gf_index);
4418}
4419
4420// Get update type of the current frame.
4421static inline FRAME_UPDATE_TYPE get_frame_update_type(const GF_GROUP *gf_group,
4422 int gf_frame_index) {
4423 return gf_group->update_type[gf_frame_index];
4424}
4425
4426static inline int av1_pixels_to_mi(int pixels) {
4427 return ALIGN_POWER_OF_TWO(pixels, 3)(((pixels) + ((1 << (3)) - 1)) & ~((1 << (3))
- 1))
>> MI_SIZE_LOG22;
4428}
4429
4430static inline int is_psnr_calc_enabled(const AV1_COMP *cpi) {
4431 const AV1_COMMON *const cm = &cpi->common;
4432
4433 return cpi->ppi->b_calculate_psnr && !is_stat_generation_stage(cpi) &&
4434 cm->show_frame && !cpi->is_dropped_frame;
4435}
4436
4437static inline int is_frame_resize_pending(const AV1_COMP *const cpi) {
4438 const ResizePendingParams *const resize_pending_params =
4439 &cpi->resize_pending_params;
4440 return (resize_pending_params->width && resize_pending_params->height &&
4441 (cpi->common.width != resize_pending_params->width ||
4442 cpi->common.height != resize_pending_params->height));
4443}
4444
4445// Check if loop filter is used.
4446static inline int is_loopfilter_used(const AV1_COMMON *const cm) {
4447 return !cm->features.coded_lossless && !cm->tiles.large_scale;
4448}
4449
4450// Check if CDEF is used.
4451static inline int is_cdef_used(const AV1_COMMON *const cm) {
4452 return cm->seq_params->enable_cdef && !cm->features.coded_lossless &&
4453 !cm->tiles.large_scale;
4454}
4455
4456// Check if loop restoration filter is used.
4457static inline int is_restoration_used(const AV1_COMMON *const cm) {
4458 return cm->seq_params->enable_restoration && !cm->features.all_lossless &&
4459 !cm->tiles.large_scale;
4460}
4461
4462// Checks if post-processing filters need to be applied.
4463// NOTE: This function decides if the application of different post-processing
4464// filters on the reconstructed frame can be skipped at the encoder side.
4465// However the computation of different filter parameters that are signaled in
4466// the bitstream is still required.
4467static inline unsigned int derive_skip_apply_postproc_filters(
4468 const AV1_COMP *cpi, int use_loopfilter, int use_cdef, int use_superres,
4469 int use_restoration) {
4470 // Though CDEF parameter selection should be dependent on
4471 // deblocked/loop-filtered pixels for cdef_pick_method <=
4472 // CDEF_FAST_SEARCH_LVL5, CDEF strength values are calculated based on the
4473 // pixel values that are not loop-filtered in svc real-time encoding mode.
4474 // Hence this case is handled separately using the condition below.
4475 if (cpi->ppi->rtc_ref.non_reference_frame)
4476 return (SKIP_APPLY_LOOPFILTER | SKIP_APPLY_CDEF);
4477
4478 if (!cpi->oxcf.algo_cfg.skip_postproc_filtering || cpi->ppi->b_calculate_psnr)
4479 return 0;
4480 assert(cpi->oxcf.mode == ALLINTRA)((void) sizeof ((cpi->oxcf.mode == ALLINTRA) ? 1 : 0), __extension__
({ if (cpi->oxcf.mode == ALLINTRA) ; else __assert_fail (
"cpi->oxcf.mode == ALLINTRA", "/root/firefox-clang/third_party/aom/av1/encoder/encoder.h"
, 4480, __extension__ __PRETTY_FUNCTION__); }))
;
4481
4482 // The post-processing filters are applied one after the other in the
4483 // following order: deblocking->cdef->superres->restoration. In case of
4484 // ALLINTRA encoding, the reconstructed frame is not used as a reference
4485 // frame. Hence, the application of these filters can be skipped when
4486 // 1. filter parameters of the subsequent stages are not dependent on the
4487 // filtered output of the current stage or
4488 // 2. subsequent filtering stages are disabled
4489 if (use_restoration) return SKIP_APPLY_RESTORATION;
4490 if (use_superres) return SKIP_APPLY_SUPERRES;
4491 if (use_cdef) {
4492 // CDEF parameter selection is not dependent on the deblocked frame if
4493 // cdef_pick_method is CDEF_PICK_FROM_Q. Hence the application of deblocking
4494 // filters and cdef filters can be skipped in this case.
4495 return (cpi->sf.lpf_sf.cdef_pick_method == CDEF_PICK_FROM_Q &&
4496 use_loopfilter)
4497 ? (SKIP_APPLY_LOOPFILTER | SKIP_APPLY_CDEF)
4498 : SKIP_APPLY_CDEF;
4499 }
4500 if (use_loopfilter) return SKIP_APPLY_LOOPFILTER;
4501
4502 // If we reach here, all post-processing stages are disabled, so none need to
4503 // be skipped.
4504 return 0;
4505}
4506
4507static inline void set_postproc_filter_default_params(AV1_COMMON *cm) {
4508 struct loopfilter *const lf = &cm->lf;
4509 CdefInfo *const cdef_info = &cm->cdef_info;
4510 RestorationInfo *const rst_info = cm->rst_info;
4511
4512 lf->filter_level[0] = 0;
4513 lf->filter_level[1] = 0;
4514 lf->backup_filter_level[0] = 0;
4515 lf->backup_filter_level[1] = 0;
4516 cdef_info->cdef_bits = 0;
4517 cdef_info->cdef_strengths[0] = 0;
4518 cdef_info->nb_cdef_strengths = 1;
4519 cdef_info->cdef_uv_strengths[0] = 0;
4520 rst_info[0].frame_restoration_type = RESTORE_NONE;
4521 rst_info[1].frame_restoration_type = RESTORE_NONE;
4522 rst_info[2].frame_restoration_type = RESTORE_NONE;
4523}
4524
4525static inline int is_inter_tx_size_search_level_one(
4526 const TX_SPEED_FEATURES *tx_sf) {
4527 return (tx_sf->inter_tx_size_search_init_depth_rect >= 1 &&
4528 tx_sf->inter_tx_size_search_init_depth_sqr >= 1);
4529}
4530
4531static inline int get_lpf_opt_level(const SPEED_FEATURES *sf) {
4532 int lpf_opt_level = 0;
4533 if (is_inter_tx_size_search_level_one(&sf->tx_sf))
4534 lpf_opt_level = (sf->lpf_sf.lpf_pick == LPF_PICK_FROM_Q) ? 2 : 1;
4535 return lpf_opt_level;
4536}
4537
4538// Enable switchable motion mode only if warp and OBMC tools are allowed
4539static inline bool_Bool is_switchable_motion_mode_allowed(bool_Bool allow_warped_motion,
4540 bool_Bool enable_obmc) {
4541 return (allow_warped_motion || enable_obmc);
4542}
4543
4544static inline int warped_motion_update_num_proj_ref(
4545 const struct AV1_COMP *const cpi, const MB_MODE_INFO *const mi) {
4546 return cpi->oxcf.motion_mode_cfg.allow_warped_motion && is_inter_block(mi) &&
4547 !mi->skip_mode && is_motion_variation_allowed_bsize(mi->bsize) &&
4548 !has_second_ref(mi);
4549}
4550
4551#if CONFIG_AV1_TEMPORAL_DENOISING0
4552static inline int denoise_svc(const struct AV1_COMP *const cpi) {
4553 return (!cpi->ppi->use_svc ||
4554 (cpi->ppi->use_svc &&
4555 cpi->svc.spatial_layer_id >= cpi->svc.first_layer_denoise));
4556}
4557#endif
4558
4559#if CONFIG_COLLECT_PARTITION_STATS0 == 2
4560static inline void av1_print_fr_partition_timing_stats(
4561 const FramePartitionTimingStats *part_stats, const char *filename) {
4562 FILE *f = fopen(filename, "w");
4563 if (!f) {
4564 return;
4565 }
4566
4567 fprintf(f, "bsize,redo,");
4568 for (int part = 0; part < EXT_PARTITION_TYPES; part++) {
4569 fprintf(f, "decision_%d,", part);
4570 }
4571 for (int part = 0; part < EXT_PARTITION_TYPES; part++) {
4572 fprintf(f, "attempt_%d,", part);
4573 }
4574 for (int part = 0; part < EXT_PARTITION_TYPES; part++) {
4575 fprintf(f, "time_%d,", part);
4576 }
4577 fprintf(f, "\n");
4578
4579 static const int bsizes[6] = { 128, 64, 32, 16, 8, 4 };
4580
4581 for (int bsize_idx = 0; bsize_idx < 6; bsize_idx++) {
4582 fprintf(f, "%d,%d,", bsizes[bsize_idx], part_stats->partition_redo);
4583 for (int part = 0; part < EXT_PARTITION_TYPES; part++) {
4584 fprintf(f, "%d,", part_stats->partition_decisions[bsize_idx][part]);
4585 }
4586 for (int part = 0; part < EXT_PARTITION_TYPES; part++) {
4587 fprintf(f, "%d,", part_stats->partition_attempts[bsize_idx][part]);
4588 }
4589 for (int part = 0; part < EXT_PARTITION_TYPES; part++) {
4590 fprintf(f, "%ld,", part_stats->partition_times[bsize_idx][part]);
4591 }
4592 fprintf(f, "\n");
4593 }
4594 fclose(f);
4595}
4596#endif // CONFIG_COLLECT_PARTITION_STATS == 2
4597
4598#if CONFIG_COLLECT_PARTITION_STATS0
4599static inline int av1_get_bsize_idx_for_part_stats(BLOCK_SIZE bsize) {
4600 assert(bsize == BLOCK_128X128 || bsize == BLOCK_64X64 ||((void) sizeof ((bsize == BLOCK_128X128 || bsize == BLOCK_64X64
|| bsize == BLOCK_32X32 || bsize == BLOCK_16X16 || bsize == BLOCK_8X8
|| bsize == BLOCK_4X4) ? 1 : 0), __extension__ ({ if (bsize ==
BLOCK_128X128 || bsize == BLOCK_64X64 || bsize == BLOCK_32X32
|| bsize == BLOCK_16X16 || bsize == BLOCK_8X8 || bsize == BLOCK_4X4
) ; else __assert_fail ("bsize == BLOCK_128X128 || bsize == BLOCK_64X64 || bsize == BLOCK_32X32 || bsize == BLOCK_16X16 || bsize == BLOCK_8X8 || bsize == BLOCK_4X4"
, "/root/firefox-clang/third_party/aom/av1/encoder/encoder.h"
, 4602, __extension__ __PRETTY_FUNCTION__); }))
4601 bsize == BLOCK_32X32 || bsize == BLOCK_16X16 || bsize == BLOCK_8X8 ||((void) sizeof ((bsize == BLOCK_128X128 || bsize == BLOCK_64X64
|| bsize == BLOCK_32X32 || bsize == BLOCK_16X16 || bsize == BLOCK_8X8
|| bsize == BLOCK_4X4) ? 1 : 0), __extension__ ({ if (bsize ==
BLOCK_128X128 || bsize == BLOCK_64X64 || bsize == BLOCK_32X32
|| bsize == BLOCK_16X16 || bsize == BLOCK_8X8 || bsize == BLOCK_4X4
) ; else __assert_fail ("bsize == BLOCK_128X128 || bsize == BLOCK_64X64 || bsize == BLOCK_32X32 || bsize == BLOCK_16X16 || bsize == BLOCK_8X8 || bsize == BLOCK_4X4"
, "/root/firefox-clang/third_party/aom/av1/encoder/encoder.h"
, 4602, __extension__ __PRETTY_FUNCTION__); }))
4602 bsize == BLOCK_4X4)((void) sizeof ((bsize == BLOCK_128X128 || bsize == BLOCK_64X64
|| bsize == BLOCK_32X32 || bsize == BLOCK_16X16 || bsize == BLOCK_8X8
|| bsize == BLOCK_4X4) ? 1 : 0), __extension__ ({ if (bsize ==
BLOCK_128X128 || bsize == BLOCK_64X64 || bsize == BLOCK_32X32
|| bsize == BLOCK_16X16 || bsize == BLOCK_8X8 || bsize == BLOCK_4X4
) ; else __assert_fail ("bsize == BLOCK_128X128 || bsize == BLOCK_64X64 || bsize == BLOCK_32X32 || bsize == BLOCK_16X16 || bsize == BLOCK_8X8 || bsize == BLOCK_4X4"
, "/root/firefox-clang/third_party/aom/av1/encoder/encoder.h"
, 4602, __extension__ __PRETTY_FUNCTION__); }))
;
4603 switch (bsize) {
4604 case BLOCK_128X128: return 0;
4605 case BLOCK_64X64: return 1;
4606 case BLOCK_32X32: return 2;
4607 case BLOCK_16X16: return 3;
4608 case BLOCK_8X8: return 4;
4609 case BLOCK_4X4: return 5;
4610 default: assert(0 && "Invalid bsize for partition_stats.")((void) sizeof ((0 && "Invalid bsize for partition_stats."
) ? 1 : 0), __extension__ ({ if (0 && "Invalid bsize for partition_stats."
) ; else __assert_fail ("0 && \"Invalid bsize for partition_stats.\""
, "/root/firefox-clang/third_party/aom/av1/encoder/encoder.h"
, 4610, __extension__ __PRETTY_FUNCTION__); }))
; return -1;
4611 }
4612}
4613#endif // CONFIG_COLLECT_PARTITION_STATS
4614
4615#if CONFIG_COLLECT_COMPONENT_TIMING0
4616static inline void start_timing(AV1_COMP *cpi, int component) {
4617 aom_usec_timer_start(&cpi->component_timer[component]);
4618}
4619static inline void end_timing(AV1_COMP *cpi, int component) {
4620 aom_usec_timer_mark(&cpi->component_timer[component]);
4621 cpi->frame_component_time[component] +=
4622 aom_usec_timer_elapsed(&cpi->component_timer[component]);
4623}
4624static inline char const *get_frame_type_enum(int type) {
4625 switch (type) {
4626 case 0: return "KEY_FRAME";
4627 case 1: return "INTER_FRAME";
4628 case 2: return "INTRA_ONLY_FRAME";
4629 case 3: return "S_FRAME";
4630 default: assert(0)((void) sizeof ((0) ? 1 : 0), __extension__ ({ if (0) ; else __assert_fail
("0", "/root/firefox-clang/third_party/aom/av1/encoder/encoder.h"
, 4630, __extension__ __PRETTY_FUNCTION__); }))
;
4631 }
4632 return "error";
4633}
4634#endif
4635
4636/*!\endcond */
4637
4638#ifdef __cplusplus
4639} // extern "C"
4640#endif
4641
4642#endif // AOM_AV1_ENCODER_ENCODER_H_