encoder.h 25.9 KB
Newer Older
Jingning Han's avatar
Jingning Han committed
1
/*
2
 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
Jingning Han's avatar
Jingning Han committed
3
 *
4 5 6 7 8 9
 * This source code is subject to the terms of the BSD 2 Clause License and
 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
 * was not distributed with this source code in the LICENSE file, you can
 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
 * Media Patent License 1.0 was not distributed with this source code in the
 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
Jingning Han's avatar
Jingning Han committed
10 11
 */

Yaowu Xu's avatar
Yaowu Xu committed
12 13
#ifndef AV1_ENCODER_ENCODER_H_
#define AV1_ENCODER_ENCODER_H_
Jingning Han's avatar
Jingning Han committed
14 15 16

#include <stdio.h>

Yaowu Xu's avatar
Yaowu Xu committed
17 18
#include "./aom_config.h"
#include "aom/aomcx.h"
Jingning Han's avatar
Jingning Han committed
19

20 21 22 23 24
#include "av1/common/alloccommon.h"
#include "av1/common/entropymode.h"
#include "av1/common/thread_common.h"
#include "av1/common/onyxc_int.h"
#include "av1/encoder/aq_cyclicrefresh.h"
25
#if CONFIG_ANS
26
#include "aom_dsp/ans.h"
Alex Converse's avatar
Alex Converse committed
27
#include "aom_dsp/buf_ans.h"
28
#endif
29 30 31 32 33 34 35 36 37 38 39 40
#include "av1/encoder/context_tree.h"
#include "av1/encoder/encodemb.h"
#include "av1/encoder/firstpass.h"
#include "av1/encoder/lookahead.h"
#include "av1/encoder/mbgraph.h"
#include "av1/encoder/mcomp.h"
#include "av1/encoder/quantize.h"
#include "av1/encoder/ratectrl.h"
#include "av1/encoder/rd.h"
#include "av1/encoder/speed_features.h"
#include "av1/encoder/tokenize.h"
#include "av1/encoder/variance_tree.h"
Jingning Han's avatar
Jingning Han committed
41

42
#if CONFIG_INTERNAL_STATS
43
#include "aom_dsp/ssim.h"
44
#endif
45
#include "aom_dsp/variance.h"
Yaowu Xu's avatar
Yaowu Xu committed
46 47
#include "aom/internal/aom_codec_internal.h"
#include "aom_util/aom_thread.h"
48

Jingning Han's avatar
Jingning Han committed
49 50 51 52 53 54 55 56 57
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
  int nmvjointcost[MV_JOINTS];
  int nmvcosts[2][MV_VALS];
  int nmvcosts_hp[2][MV_VALS];

58 59 60 61 62 63
#if CONFIG_REF_MV
  int nmv_vec_cost[NMV_CONTEXTS][MV_JOINTS];
  int nmv_costs[NMV_CONTEXTS][2][MV_VALS];
  int nmv_costs_hp[NMV_CONTEXTS][2][MV_VALS];
#endif

Jingning Han's avatar
Jingning Han committed
64
  // 0 = Intra, Last, GF, ARF
65
  signed char last_ref_lf_deltas[TOTAL_REFS_PER_FRAME];
Jingning Han's avatar
Jingning Han committed
66 67 68 69 70 71
  // 0 = ZERO_MV, MV
  signed char last_mode_lf_deltas[MAX_MODE_LF_DELTAS];

  FRAME_CONTEXT fc;
} CODING_CONTEXT;

72 73 74 75 76 77 78 79 80 81 82 83
typedef enum {
  // regular inter frame
  REGULAR_FRAME = 0,
  // alternate reference frame
  ARF_FRAME = 1,
  // overlay frame
  OVERLAY_FRAME = 2,
  // golden frame
  GLD_FRAME = 3,
#if CONFIG_EXT_REFS
  // backward reference frame
  BRF_FRAME = 4,
84 85
  // extra alternate reference frame
  EXT_ARF_FRAME = 5
86 87 88
#endif
} FRAME_CONTEXT_INDEX;

Jingning Han's avatar
Jingning Han committed
89
typedef enum {
90 91 92 93
  NORMAL = 0,
  FOURFIVE = 1,
  THREEFIVE = 2,
  ONETWO = 3
Yaowu Xu's avatar
Yaowu Xu committed
94
} AOM_SCALING;
Jingning Han's avatar
Jingning Han committed
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112

typedef enum {
  // Good Quality Fast Encoding. The encoder balances quality with the amount of
  // time it takes to encode the output. Speed setting controls how fast.
  GOOD,

  // The encoder places priority on the quality of the output over encoding
  // speed. The output is compressed at the highest possible quality. This
  // option takes the longest amount of time to encode. Speed setting ignored.
  BEST,

  // Realtime/Live Encoding. This mode is optimized for realtime encoding (for
  // example, capturing a television signal or feed from a live camera). Speed
  // setting controls how fast.
  REALTIME
} MODE;

typedef enum {
113
  FRAMEFLAGS_KEY = 1 << 0,
Jingning Han's avatar
Jingning Han committed
114
  FRAMEFLAGS_GOLDEN = 1 << 1,
115
#if CONFIG_EXT_REFS
116 117 118
  FRAMEFLAGS_BWDREF = 1 << 2,
  FRAMEFLAGS_ALTREF = 1 << 3,
#else
Jingning Han's avatar
Jingning Han committed
119
  FRAMEFLAGS_ALTREF = 1 << 2,
120
#endif  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
121 122 123 124 125 126 127
} FRAMETYPE_FLAGS;

typedef enum {
  NO_AQ = 0,
  VARIANCE_AQ = 1,
  COMPLEXITY_AQ = 2,
  CYCLIC_REFRESH_AQ = 3,
128 129 130
#if CONFIG_DELTA_Q
  DELTA_AQ = 4,
#endif
Jingning Han's avatar
Jingning Han committed
131 132 133 134
  AQ_MODE_COUNT  // This should always be the last member of the enum
} AQ_MODE;

typedef enum {
Yunqing Wang's avatar
Yunqing Wang committed
135
  RESIZE_NONE = 0,    // No frame resizing allowed.
Jingning Han's avatar
Jingning Han committed
136 137 138 139
  RESIZE_FIXED = 1,   // All frames are coded at the specified dimension.
  RESIZE_DYNAMIC = 2  // Coded size of each frame is determined by the codec.
} RESIZE_TYPE;

Yaowu Xu's avatar
Yaowu Xu committed
140
typedef struct AV1EncoderConfig {
Jingning Han's avatar
Jingning Han committed
141
  BITSTREAM_PROFILE profile;
Yaowu Xu's avatar
Yaowu Xu committed
142
  aom_bit_depth_t bit_depth;     // Codec bit-depth.
143 144
  int width;                     // width of data passed to the compressor
  int height;                    // height of data passed to the compressor
Jingning Han's avatar
Jingning Han committed
145
  unsigned int input_bit_depth;  // Input bit depth.
146 147
  double init_framerate;         // set to passed in framerate
  int64_t target_bandwidth;      // bandwidth to be used in bits per second
Jingning Han's avatar
Jingning Han committed
148 149

  int noise_sensitivity;  // pre processing blur: recommendation 0
150
  int sharpness;          // sharpening output: recommendation 0:
Jingning Han's avatar
Jingning Han committed
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
  int speed;
  // maximum allowed bitrate for any intra frame in % of bitrate target.
  unsigned int rc_max_intra_bitrate_pct;
  // maximum allowed bitrate for any inter frame in % of bitrate target.
  unsigned int rc_max_inter_bitrate_pct;
  // percent of rate boost for golden frame in CBR mode.
  unsigned int gf_cbr_boost_pct;

  MODE mode;
  int pass;

  // Key Framing Operations
  int auto_key;  // autodetect cut scenes and set the keyframes
  int key_freq;  // maximum distance to key frame.

  int lag_in_frames;  // how many frames lag before we start encoding

  // ----------------------------------------------------------------
  // DATARATE CONTROL OPTIONS

  // vbr, cbr, constrained quality or constant quality
Yaowu Xu's avatar
Yaowu Xu committed
172
  enum aom_rc_mode rc_mode;
Jingning Han's avatar
Jingning Han committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191

  // buffer targeting aggressiveness
  int under_shoot_pct;
  int over_shoot_pct;

  // buffering parameters
  int64_t starting_buffer_level_ms;
  int64_t optimal_buffer_level_ms;
  int64_t maximum_buffer_size_ms;

  // Frame drop threshold.
  int drop_frames_water_mark;

  // controlling quality
  int fixed_q;
  int worst_allowed_q;
  int best_allowed_q;
  int cq_level;
  AQ_MODE aq_mode;  // Adaptive Quantization mode
192 193 194 195 196
#if CONFIG_AOM_QM
  int using_qm;
  int qm_minlevel;
  int qm_maxlevel;
#endif
197 198 199 200
#if CONFIG_TILE_GROUPS
  unsigned int num_tile_groups;
  unsigned int mtu;
#endif
Jingning Han's avatar
Jingning Han committed
201 202 203 204 205 206 207 208 209 210

  // Internal frame size scaling.
  RESIZE_TYPE resize_mode;
  int scaled_frame_width;
  int scaled_frame_height;

  // Enable feature to reduce the frame quantization every x frames.
  int frame_periodic_boost;

  // two pass datarate control
211
  int two_pass_vbrbias;  // two pass datarate control tweaks
Jingning Han's avatar
Jingning Han committed
212 213 214 215 216 217
  int two_pass_vbrmin_section;
  int two_pass_vbrmax_section;
  // END DATARATE CONTROL OPTIONS
  // ----------------------------------------------------------------

  int enable_auto_arf;
218
#if CONFIG_EXT_REFS
219
  int enable_auto_brf;  // (b)ackward (r)ef (f)rame
220
#endif                  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241

  /* Bitfield defining the error resiliency features to enable.
   * Can provide decodable frames after losses in previous
   * frames and decodable partitions after losses in the same frame.
   */
  unsigned int error_resilient_mode;

  /* Bitfield defining the parallel decoding mode where the
   * decoding in successive frames may be conducted in parallel
   * just by decoding the frame headers.
   */
  unsigned int frame_parallel_decoding_mode;

  int arnr_max_frames;
  int arnr_strength;

  int min_gf_interval;
  int max_gf_interval;

  int tile_columns;
  int tile_rows;
242 243 244
#if CONFIG_DEBLOCKING_ACROSS_TILES
  int loop_filter_across_tiles_enabled;
#endif  // CONFIG_DEBLOCKING_ACROSS_TILES
Jingning Han's avatar
Jingning Han committed
245 246 247

  int max_threads;

Yaowu Xu's avatar
Yaowu Xu committed
248 249
  aom_fixed_buf_t two_pass_stats_in;
  struct aom_codec_pkt_list *output_pkt_list;
Jingning Han's avatar
Jingning Han committed
250 251

#if CONFIG_FP_MB_STATS
Yaowu Xu's avatar
Yaowu Xu committed
252
  aom_fixed_buf_t firstpass_mb_stats_in;
Jingning Han's avatar
Jingning Han committed
253 254
#endif

Yaowu Xu's avatar
Yaowu Xu committed
255 256 257
  aom_tune_metric tuning;
  aom_tune_content content;
#if CONFIG_AOM_HIGHBITDEPTH
Jingning Han's avatar
Jingning Han committed
258 259
  int use_highbitdepth;
#endif
Yaowu Xu's avatar
Yaowu Xu committed
260
  aom_color_space_t color_space;
261
  int color_range;
262 263
  int render_width;
  int render_height;
264 265

#if CONFIG_EXT_PARTITION
Yaowu Xu's avatar
Yaowu Xu committed
266
  aom_superblock_size_t superblock_size;
267
#endif  // CONFIG_EXT_PARTITION
268 269 270
#if CONFIG_ANS && ANS_MAX_SYMBOLS
  int ans_window_size_log2;
#endif  // CONFIG_ANS && ANS_MAX_SYMBOLS
Yaowu Xu's avatar
Yaowu Xu committed
271
} AV1EncoderConfig;
Jingning Han's avatar
Jingning Han committed
272

Yaowu Xu's avatar
Yaowu Xu committed
273
static INLINE int is_lossless_requested(const AV1EncoderConfig *cfg) {
Jingning Han's avatar
Jingning Han committed
274 275 276 277 278 279 280 281
  return cfg->best_allowed_q == 0 && cfg->worst_allowed_q == 0;
}

// TODO(jingning) All spatially adaptive variables should go to TileDataEnc.
typedef struct TileDataEnc {
  TileInfo tile_info;
  int thresh_freq_fact[BLOCK_SIZES][MAX_MODES];
  int mode_map[BLOCK_SIZES][MAX_MODES];
282 283
  int m_search_count;
  int ex_search_count;
284 285 286
#if CONFIG_PVQ
  PVQ_QUEUE pvq_q;
#endif
287 288 289
#if CONFIG_EC_ADAPT
  FRAME_CONTEXT tctx;
#endif
Jingning Han's avatar
Jingning Han committed
290 291 292
} TileDataEnc;

typedef struct RD_COUNTS {
Yaowu Xu's avatar
Yaowu Xu committed
293
  av1_coeff_count coef_counts[TX_SIZES][PLANE_TYPES];
Jingning Han's avatar
Jingning Han committed
294 295 296 297 298 299 300 301 302 303
  int64_t comp_pred_diff[REFERENCE_MODES];
} RD_COUNTS;

typedef struct ThreadData {
  MACROBLOCK mb;
  RD_COUNTS rd_counts;
  FRAME_COUNTS *counts;

  PICK_MODE_CONTEXT *leaf_tree;
  PC_TREE *pc_tree;
Geza Lore's avatar
Geza Lore committed
304
  PC_TREE *pc_root[MAX_MIB_SIZE_LOG2 - MIN_MIB_SIZE_LOG2 + 1];
305 306 307

  VAR_TREE *var_tree;
  VAR_TREE *var_root[MAX_MIB_SIZE_LOG2 - MIN_MIB_SIZE_LOG2 + 1];
Jingning Han's avatar
Jingning Han committed
308 309 310 311 312 313 314 315 316 317
} ThreadData;

struct EncWorkerData;

typedef struct ActiveMap {
  int enabled;
  int update;
  unsigned char *map;
} ActiveMap;

318
#define NUM_STAT_TYPES 4  // types of stats: Y, U, V and ALL
Jingning Han's avatar
Jingning Han committed
319 320

typedef struct IMAGE_STAT {
321
  double stat[NUM_STAT_TYPES];
Jingning Han's avatar
Jingning Han committed
322 323 324
  double worst;
} ImageStat;

325 326
#undef NUM_STAT_TYPES

327 328 329 330 331
typedef struct {
  int ref_count;
  YV12_BUFFER_CONFIG buf;
} EncRefCntBuffer;

hui su's avatar
hui su committed
332 333
#if CONFIG_ENTROPY
typedef struct SUBFRAME_STATS {
Yaowu Xu's avatar
Yaowu Xu committed
334 335
  av1_coeff_probs_model coef_probs_buf[COEF_PROBS_BUFS][TX_SIZES][PLANE_TYPES];
  av1_coeff_count coef_counts_buf[COEF_PROBS_BUFS][TX_SIZES][PLANE_TYPES];
336 337
  unsigned int eob_counts_buf[COEF_PROBS_BUFS][TX_SIZES][PLANE_TYPES][REF_TYPES]
                             [COEF_BANDS][COEFF_CONTEXTS];
Yaowu Xu's avatar
Yaowu Xu committed
338
  av1_coeff_probs_model enc_starting_coef_probs[TX_SIZES][PLANE_TYPES];
hui su's avatar
hui su committed
339 340 341
} SUBFRAME_STATS;
#endif  // CONFIG_ENTROPY

342 343 344 345 346
typedef struct TileBufferEnc {
  uint8_t *data;
  size_t size;
} TileBufferEnc;

Yaowu Xu's avatar
Yaowu Xu committed
347
typedef struct AV1_COMP {
Jingning Han's avatar
Jingning Han committed
348 349 350
  QUANTS quants;
  ThreadData td;
  MB_MODE_INFO_EXT *mbmi_ext_base;
351 352
  DECLARE_ALIGNED(16, int16_t, y_dequant[QINDEX_RANGE][8]);   // 8: SIMD width
  DECLARE_ALIGNED(16, int16_t, uv_dequant[QINDEX_RANGE][8]);  // 8: SIMD width
353 354
#if CONFIG_NEW_QUANT
  DECLARE_ALIGNED(16, dequant_val_type_nuq,
355
                  y_dequant_val_nuq[QUANT_PROFILES][QINDEX_RANGE][COEF_BANDS]);
356
  DECLARE_ALIGNED(16, dequant_val_type_nuq,
357
                  uv_dequant_val_nuq[QUANT_PROFILES][QINDEX_RANGE][COEF_BANDS]);
358
#endif  // CONFIG_NEW_QUANT
Yaowu Xu's avatar
Yaowu Xu committed
359 360
  AV1_COMMON common;
  AV1EncoderConfig oxcf;
361 362
  struct lookahead_ctx *lookahead;
  struct lookahead_entry *alt_ref_source;
Jingning Han's avatar
Jingning Han committed
363 364 365 366 367 368 369 370

  YV12_BUFFER_CONFIG *Source;
  YV12_BUFFER_CONFIG *Last_Source;  // NULL for first frame and alt_ref frames
  YV12_BUFFER_CONFIG *un_scaled_source;
  YV12_BUFFER_CONFIG scaled_source;
  YV12_BUFFER_CONFIG *unscaled_last_source;
  YV12_BUFFER_CONFIG scaled_last_source;

371
  // Up-sampled reference buffers
372 373 374 375 376
  // NOTE(zoeliu): It is needed to allocate sufficient space to the up-sampled
  // reference buffers, which should include the up-sampled version of all the
  // possibly stored references plus the currently coded frame itself.
  EncRefCntBuffer upsampled_ref_bufs[REF_FRAMES + 1];
  int upsampled_ref_idx[REF_FRAMES + 1];
377

Jingning Han's avatar
Jingning Han committed
378 379 380
  // For a still frame, this flag is set to 1 to skip partition search.
  int partition_search_skippable_frame;

381
  int scaled_ref_idx[TOTAL_REFS_PER_FRAME];
382
#if CONFIG_EXT_REFS
383
  int lst_fb_idxes[LAST_REF_FRAMES];
384
#else
385
  int lst_fb_idx;
386
#endif  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
387
  int gld_fb_idx;
388
#if CONFIG_EXT_REFS
389
  int bwd_fb_idx;  // BWD_REF_FRAME
390
#endif             // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
391 392
  int alt_fb_idx;

393 394
  int last_show_frame_buf_idx;  // last show frame buffer index

395
  int refresh_last_frame;
Jingning Han's avatar
Jingning Han committed
396
  int refresh_golden_frame;
397
#if CONFIG_EXT_REFS
398
  int refresh_bwd_ref_frame;
399
#endif  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
400 401 402
  int refresh_alt_ref_frame;

  int ext_refresh_frame_flags_pending;
403
  int ext_refresh_last_frame;
Jingning Han's avatar
Jingning Han committed
404 405 406 407 408 409 410
  int ext_refresh_golden_frame;
  int ext_refresh_alt_ref_frame;

  int ext_refresh_frame_context_pending;
  int ext_refresh_frame_context;

  YV12_BUFFER_CONFIG last_frame_uf;
Debargha Mukherjee's avatar
Debargha Mukherjee committed
411 412
#if CONFIG_LOOP_RESTORATION
  YV12_BUFFER_CONFIG last_frame_db;
413
  YV12_BUFFER_CONFIG trial_frame_rst;
414 415 416
  uint8_t *extra_rstbuf;  // Extra buffers used in restoration search
  RestorationInfo rst_search[MAX_MB_PLANE];  // Used for encoder side search
#endif                                       // CONFIG_LOOP_RESTORATION
Jingning Han's avatar
Jingning Han committed
417 418 419 420 421 422 423 424

  // Ambient reconstruction err target for force key frames
  int64_t ambient_err;

  RD_OPT rd;

  CODING_CONTEXT coding_context;

425
#if CONFIG_REF_MV
426 427
  int nmv_costs[NMV_CONTEXTS][2][MV_VALS];
  int nmv_costs_hp[NMV_CONTEXTS][2][MV_VALS];
428 429
#endif

430 431 432 433
  int nmvcosts[2][MV_VALS];
  int nmvcosts_hp[2][MV_VALS];
  int nmvsadcosts[2][MV_VALS];
  int nmvsadcosts_hp[2][MV_VALS];
Jingning Han's avatar
Jingning Han committed
434 435 436 437 438 439 440 441

  int64_t last_time_stamp_seen;
  int64_t last_end_time_stamp_seen;
  int64_t first_time_stamp_ever;

  RATE_CONTROL rc;
  double framerate;

442 443 444 445
  // NOTE(zoeliu): Any inter frame allows maximum of REF_FRAMES inter
  // references; Plus the currently coded frame itself, it is needed to allocate
  // sufficient space to the size of the maximum possible number of frames.
  int interp_filter_selected[REF_FRAMES + 1][SWITCHABLE];
Jingning Han's avatar
Jingning Han committed
446

Yaowu Xu's avatar
Yaowu Xu committed
447
  struct aom_codec_pkt_list *output_pkt_list;
Jingning Han's avatar
Jingning Han committed
448 449

  MBGRAPH_FRAME_STATS mbgraph_stats[MAX_LAG_BUFFERS];
450 451
  int mbgraph_n_frames;  // number of frames filled in the above
  int static_mb_pct;     // % forced skip mbs by segmentation
Jingning Han's avatar
Jingning Han committed
452 453 454 455 456 457 458 459 460
  int ref_frame_flags;

  SPEED_FEATURES sf;

  unsigned int max_mv_magnitude;
  int mv_step_param;

  int allow_comp_inter_inter;

461
  uint8_t *segmentation_map;
Jingning Han's avatar
Jingning Han committed
462 463 464 465 466

  CYCLIC_REFRESH *cyclic_refresh;
  ActiveMap active_map;

  fractional_mv_step_fp *find_fractional_mv_step;
Yaowu Xu's avatar
Yaowu Xu committed
467 468 469
  av1_full_search_fn_t full_search_sad;  // It is currently unused.
  av1_diamond_search_fn_t diamond_search_sad;
  aom_variance_fn_ptr_t fn_ptr[BLOCK_SIZES];
Jingning Han's avatar
Jingning Han committed
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
  uint64_t time_receive_data;
  uint64_t time_compress_data;
  uint64_t time_pick_lpf;
  uint64_t time_encode_sb_row;

#if CONFIG_FP_MB_STATS
  int use_fp_mb_stats;
#endif

  TWO_PASS twopass;

  YV12_BUFFER_CONFIG alt_ref_buffer;

#if CONFIG_INTERNAL_STATS
  unsigned int mode_chosen_counts[MAX_MODES];

486
  int count;
Jingning Han's avatar
Jingning Han committed
487 488 489 490 491 492 493
  uint64_t total_sq_error;
  uint64_t total_samples;
  ImageStat psnr;

  double total_blockiness;
  double worst_blockiness;

494
  int bytes;
Jingning Han's avatar
Jingning Han committed
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
  double summed_quality;
  double summed_weights;
  unsigned int tot_recode_hits;
  double worst_ssim;

  ImageStat fastssim;
  ImageStat psnrhvs;

  int b_calculate_blockiness;
  int b_calculate_consistency;

  double total_inconsistency;
  double worst_consistency;
  Ssimv *ssim_vars;
  Metrics metrics;
#endif
  int b_calculate_psnr;

  int droppable;

  int initial_width;
  int initial_height;
  int initial_mbs;  // Number of MBs in the full-size frame; to be used to
                    // normalize the firstpass stats. This will differ from the
                    // number of MBs in the current frame when the frame is
                    // scaled.

  // Store frame variance info in SOURCE_VAR_BASED_PARTITION search type.
523
  DIFF *source_diff_var;
Jingning Han's avatar
Jingning Han committed
524 525 526 527 528 529 530 531
  // The threshold used in SOURCE_VAR_BASED_PARTITION search type.
  unsigned int source_var_thresh;
  int frames_till_next_var_check;

  int frame_flags;

  search_site_config ss_cfg;

532
  int mbmode_cost[BLOCK_SIZE_GROUPS][INTRA_MODES];
533 534 535 536
#if CONFIG_REF_MV
  int newmv_mode_cost[NEWMV_MODE_CONTEXTS][2];
  int zeromv_mode_cost[ZEROMV_MODE_CONTEXTS][2];
  int refmv_mode_cost[REFMV_MODE_CONTEXTS][2];
537
  int drl_mode_cost0[DRL_MODE_CONTEXTS][2];
Yue Chen's avatar
Yue Chen committed
538 539 540
#if CONFIG_EXT_INTER
  int new2mv_mode_cost[2];
#endif  // CONFIG_EXT_INTER
541 542
#endif

Jingning Han's avatar
Jingning Han committed
543
  unsigned int inter_mode_cost[INTER_MODE_CONTEXTS][INTER_MODES];
544
#if CONFIG_EXT_INTER
clang-format's avatar
clang-format committed
545 546
  unsigned int inter_compound_mode_cost[INTER_MODE_CONTEXTS]
                                       [INTER_COMPOUND_MODES];
547
  unsigned int interintra_mode_cost[BLOCK_SIZE_GROUPS][INTERINTRA_MODES];
548
#endif  // CONFIG_EXT_INTER
Yue Chen's avatar
Yue Chen committed
549 550
#if CONFIG_MOTION_VAR || CONFIG_WARPED_MOTION
  int motion_mode_cost[BLOCK_SIZES][MOTION_MODES];
Yue Chen's avatar
Yue Chen committed
551 552 553
#if CONFIG_MOTION_VAR && CONFIG_WARPED_MOTION
  int motion_mode_cost1[BLOCK_SIZES][2];
#endif  // CONFIG_MOTION_VAR && CONFIG_WARPED_MOTION
Yue Chen's avatar
Yue Chen committed
554
#endif  // CONFIG_MOTION_VAR || CONFIG_WARPED_MOTION
555
  int intra_uv_mode_cost[INTRA_MODES][INTRA_MODES];
Jingning Han's avatar
Jingning Han committed
556 557
  int y_mode_costs[INTRA_MODES][INTRA_MODES][INTRA_MODES];
  int switchable_interp_costs[SWITCHABLE_FILTER_CONTEXTS][SWITCHABLE_FILTERS];
558
#if CONFIG_EXT_PARTITION_TYPES
559 560
  int partition_cost[PARTITION_CONTEXTS + CONFIG_UNPOISON_PARTITION_CTX]
                    [EXT_PARTITION_TYPES];
561
#else
562 563
  int partition_cost[PARTITION_CONTEXTS + CONFIG_UNPOISON_PARTITION_CTX]
                    [PARTITION_TYPES];
564
#endif
565
#if CONFIG_PALETTE
hui su's avatar
hui su committed
566 567
  int palette_y_size_cost[PALETTE_BLOCK_SIZES][PALETTE_SIZES];
  int palette_uv_size_cost[PALETTE_BLOCK_SIZES][PALETTE_SIZES];
clang-format's avatar
clang-format committed
568 569 570 571
  int palette_y_color_cost[PALETTE_MAX_SIZE - 1][PALETTE_COLOR_CONTEXTS]
                          [PALETTE_COLORS];
  int palette_uv_color_cost[PALETTE_MAX_SIZE - 1][PALETTE_COLOR_CONTEXTS]
                           [PALETTE_COLORS];
572
#endif  // CONFIG_PALETTE
573
  int tx_size_cost[TX_SIZES - 1][TX_SIZE_CONTEXTS][TX_SIZES];
574
#if CONFIG_EXT_TX
575 576
  int inter_tx_type_costs[EXT_TX_SETS_INTER][EXT_TX_SIZES][TX_TYPES];
  int intra_tx_type_costs[EXT_TX_SETS_INTRA][EXT_TX_SIZES][INTRA_MODES]
577
                         [TX_TYPES];
578
#else
579 580
  int intra_tx_type_costs[EXT_TX_SIZES][TX_TYPES][TX_TYPES];
  int inter_tx_type_costs[EXT_TX_SIZES][TX_TYPES];
581
#endif  // CONFIG_EXT_TX
582
#if CONFIG_EXT_INTRA
hui su's avatar
hui su committed
583
#if CONFIG_INTRA_INTERP
584
  int intra_filter_cost[INTRA_FILTERS + 1][INTRA_FILTERS];
hui su's avatar
hui su committed
585
#endif  // CONFIG_INTRA_INTERP
586
#endif  // CONFIG_EXT_INTRA
587 588 589
#if CONFIG_LOOP_RESTORATION
  int switchable_restore_cost[RESTORE_SWITCHABLE_TYPES];
#endif  // CONFIG_LOOP_RESTORATION
590 591 592
#if CONFIG_GLOBAL_MOTION
  int gmtype_cost[TRANS_TYPES];
#endif  // CONFIG_GLOBAL_MOTION
593 594 595 596

  int multi_arf_allowed;
  int multi_arf_enabled;
  int multi_arf_last_grp_enabled;
597 598 599 600 601 602 603 604 605

  TileDataEnc *tile_data;
  int allocated_tiles;  // Keep track of memory allocated for tiles.

  TOKENEXTRA *tile_tok[MAX_TILE_ROWS][MAX_TILE_COLS];
  unsigned int tok_count[MAX_TILE_ROWS][MAX_TILE_COLS];

  TileBufferEnc tile_buffers[MAX_TILE_ROWS][MAX_TILE_COLS];

Jingning Han's avatar
Jingning Han committed
606 607 608 609 610 611 612 613 614
  int resize_pending;
  int resize_state;
  int resize_scale_num;
  int resize_scale_den;
  int resize_avg_qp;
  int resize_buffer_underflow;
  int resize_count;

  // VAR_BASED_PARTITION thresholds
615 616 617 618 619 620
  // 0 - threshold_128x128;
  // 1 - threshold_64x64;
  // 2 - threshold_32x32;
  // 3 - threshold_16x16;
  // 4 - threshold_8x8;
  int64_t vbp_thresholds[5];
Jingning Han's avatar
Jingning Han committed
621 622 623 624
  int64_t vbp_threshold_minmax;
  int64_t vbp_threshold_sad;
  BLOCK_SIZE vbp_bsize_min;

Geza Lore's avatar
Geza Lore committed
625 626 627
  // VARIANCE_AQ segment map refresh
  int vaq_refresh;

Jingning Han's avatar
Jingning Han committed
628 629
  // Multi-threading
  int num_workers;
Yaowu Xu's avatar
Yaowu Xu committed
630
  AVxWorker *workers;
Jingning Han's avatar
Jingning Han committed
631
  struct EncWorkerData *tile_thr_data;
Yaowu Xu's avatar
Yaowu Xu committed
632
  AV1LfSync lf_row_sync;
hui su's avatar
hui su committed
633 634
#if CONFIG_ENTROPY
  SUBFRAME_STATS subframe_stats;
635 636
  // TODO(yaowu): minimize the size of count buffers
  SUBFRAME_STATS wholeframe_stats;
Yaowu Xu's avatar
Yaowu Xu committed
637
  av1_coeff_stats branch_ct_buf[COEF_PROBS_BUFS][TX_SIZES][PLANE_TYPES];
hui su's avatar
hui su committed
638
#endif  // CONFIG_ENTROPY
639 640 641
#if CONFIG_ANS
  struct BufAnsCoder buf_ans;
#endif
642
#if CONFIG_EXT_REFS
643 644
  int refresh_frame_mask;
  int existing_fb_idx_to_show;
645 646 647
  int is_arf_filter_off[MAX_EXT_ARFS + 1];
  int num_extra_arfs;
  int arf_map[MAX_EXT_ARFS + 1];
648
#endif  // CONFIG_EXT_REFS
649
#if CONFIG_GLOBAL_MOTION
Debargha Mukherjee's avatar
Debargha Mukherjee committed
650 651 652
  // Stores number of prediction blocks using global motion and the
  // number of 4x4 blocks using it per reference frame.
  int global_motion_used[TOTAL_REFS_PER_FRAME][2];
653
  int global_motion_search_done;
654
#endif
655 656 657
#if CONFIG_REFERENCE_BUFFER
  SequenceHeader seq_params;
#endif
Yaowu Xu's avatar
Yaowu Xu committed
658
} AV1_COMP;
Jingning Han's avatar
Jingning Han committed
659

Yaowu Xu's avatar
Yaowu Xu committed
660
void av1_initialize_enc(void);
Jingning Han's avatar
Jingning Han committed
661

Yaowu Xu's avatar
Yaowu Xu committed
662 663 664
struct AV1_COMP *av1_create_compressor(AV1EncoderConfig *oxcf,
                                       BufferPool *const pool);
void av1_remove_compressor(AV1_COMP *cpi);
Jingning Han's avatar
Jingning Han committed
665

Yaowu Xu's avatar
Yaowu Xu committed
666
void av1_change_config(AV1_COMP *cpi, const AV1EncoderConfig *oxcf);
Jingning Han's avatar
Jingning Han committed
667

668 669
// receive a frames worth of data. caller can assume that a copy of this
// frame is made and not just a copy of the pointer..
Yaowu Xu's avatar
Yaowu Xu committed
670 671 672
int av1_receive_raw_frame(AV1_COMP *cpi, unsigned int frame_flags,
                          YV12_BUFFER_CONFIG *sd, int64_t time_stamp,
                          int64_t end_time_stamp);
Jingning Han's avatar
Jingning Han committed
673

Yaowu Xu's avatar
Yaowu Xu committed
674 675 676
int av1_get_compressed_data(AV1_COMP *cpi, unsigned int *frame_flags,
                            size_t *size, uint8_t *dest, int64_t *time_stamp,
                            int64_t *time_end, int flush);
Jingning Han's avatar
Jingning Han committed
677

Yaowu Xu's avatar
Yaowu Xu committed
678
int av1_get_preview_raw_frame(AV1_COMP *cpi, YV12_BUFFER_CONFIG *dest);
Jingning Han's avatar
Jingning Han committed
679

Yaowu Xu's avatar
Yaowu Xu committed
680
int av1_get_last_show_frame(AV1_COMP *cpi, YV12_BUFFER_CONFIG *frame);
681

Yaowu Xu's avatar
Yaowu Xu committed
682
int av1_use_as_reference(AV1_COMP *cpi, int ref_frame_flags);
Jingning Han's avatar
Jingning Han committed
683

Yaowu Xu's avatar
Yaowu Xu committed
684
void av1_update_reference(AV1_COMP *cpi, int ref_frame_flags);
Jingning Han's avatar
Jingning Han committed
685

Yaowu Xu's avatar
Yaowu Xu committed
686
int av1_copy_reference_enc(AV1_COMP *cpi, AOM_REFFRAME ref_frame_flag,
687
                           YV12_BUFFER_CONFIG *sd);
Jingning Han's avatar
Jingning Han committed
688

Yaowu Xu's avatar
Yaowu Xu committed
689 690 691 692
int av1_set_reference_enc(AV1_COMP *cpi, AOM_REFFRAME ref_frame_flag,
                          YV12_BUFFER_CONFIG *sd);

int av1_update_entropy(AV1_COMP *cpi, int update);
Jingning Han's avatar
Jingning Han committed
693

Yaowu Xu's avatar
Yaowu Xu committed
694
int av1_set_active_map(AV1_COMP *cpi, unsigned char *map, int rows, int cols);
Jingning Han's avatar
Jingning Han committed
695

Yaowu Xu's avatar
Yaowu Xu committed
696
int av1_get_active_map(AV1_COMP *cpi, unsigned char *map, int rows, int cols);
Jingning Han's avatar
Jingning Han committed
697

Yaowu Xu's avatar
Yaowu Xu committed
698 699
int av1_set_internal_size(AV1_COMP *cpi, AOM_SCALING horiz_mode,
                          AOM_SCALING vert_mode);
Jingning Han's avatar
Jingning Han committed
700

Yaowu Xu's avatar
Yaowu Xu committed
701 702
int av1_set_size_literal(AV1_COMP *cpi, unsigned int width,
                         unsigned int height);
Jingning Han's avatar
Jingning Han committed
703

Yaowu Xu's avatar
Yaowu Xu committed
704
int av1_get_quantizer(struct AV1_COMP *cpi);
Jingning Han's avatar
Jingning Han committed
705

Yaowu Xu's avatar
Yaowu Xu committed
706 707
void av1_full_to_model_counts(av1_coeff_count_model *model_count,
                              av1_coeff_count *full_count);
hui su's avatar
hui su committed
708

Yaowu Xu's avatar
Yaowu Xu committed
709
static INLINE int frame_is_kf_gf_arf(const AV1_COMP *cpi) {
710
  return frame_is_intra_only(&cpi->common) || cpi->refresh_alt_ref_frame ||
Jingning Han's avatar
Jingning Han committed
711 712 713
         (cpi->refresh_golden_frame && !cpi->rc.is_src_frame_alt_ref);
}

Yaowu Xu's avatar
Yaowu Xu committed
714
static INLINE int get_ref_frame_map_idx(const AV1_COMP *cpi,
Jingning Han's avatar
Jingning Han committed
715
                                        MV_REFERENCE_FRAME ref_frame) {
716
#if CONFIG_EXT_REFS
717
  if (ref_frame >= LAST_FRAME && ref_frame <= LAST3_FRAME)
718 719
    return cpi->lst_fb_idxes[ref_frame - 1];
#else
720
  if (ref_frame == LAST_FRAME) return cpi->lst_fb_idx;
721
#endif  // CONFIG_EXT_REFS
722
  else if (ref_frame == GOLDEN_FRAME)
Jingning Han's avatar
Jingning Han committed
723
    return cpi->gld_fb_idx;
724
#if CONFIG_EXT_REFS
725 726
  else if (ref_frame == BWDREF_FRAME)
    return cpi->bwd_fb_idx;
727
#endif  // CONFIG_EXT_REFS
728
  else
Jingning Han's avatar
Jingning Han committed
729 730 731
    return cpi->alt_fb_idx;
}

732
static INLINE int get_ref_frame_buf_idx(const AV1_COMP *cpi,
733
                                        MV_REFERENCE_FRAME ref_frame) {
Yaowu Xu's avatar
Yaowu Xu committed
734
  const AV1_COMMON *const cm = &cpi->common;
Jingning Han's avatar
Jingning Han committed
735 736 737 738 739
  const int map_idx = get_ref_frame_map_idx(cpi, ref_frame);
  return (map_idx != INVALID_IDX) ? cm->ref_frame_map[map_idx] : INVALID_IDX;
}

static INLINE YV12_BUFFER_CONFIG *get_ref_frame_buffer(
740 741
    const AV1_COMP *cpi, MV_REFERENCE_FRAME ref_frame) {
  const AV1_COMMON *const cm = &cpi->common;
Jingning Han's avatar
Jingning Han committed
742
  const int buf_idx = get_ref_frame_buf_idx(cpi, ref_frame);
743 744
  return buf_idx != INVALID_IDX ? &cm->buffer_pool->frame_bufs[buf_idx].buf
                                : NULL;
Jingning Han's avatar
Jingning Han committed
745 746
}

747
static INLINE const YV12_BUFFER_CONFIG *get_upsampled_ref(
748
    const AV1_COMP *cpi, const MV_REFERENCE_FRAME ref_frame) {
749 750 751 752 753 754
  // Use up-sampled reference frames.
  const int buf_idx =
      cpi->upsampled_ref_idx[get_ref_frame_map_idx(cpi, ref_frame)];
  return &cpi->upsampled_ref_bufs[buf_idx].buf;
}

755
#if CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
756
static INLINE int enc_is_ref_frame_buf(AV1_COMP *cpi, RefCntBuffer *frame_buf) {
757
  MV_REFERENCE_FRAME ref_frame;
Yaowu Xu's avatar
Yaowu Xu committed
758
  AV1_COMMON *const cm = &cpi->common;
759 760 761 762 763 764 765
  for (ref_frame = LAST_FRAME; ref_frame <= ALTREF_FRAME; ++ref_frame) {
    const int buf_idx = get_ref_frame_buf_idx(cpi, ref_frame);
    if (buf_idx == INVALID_IDX) continue;
    if (frame_buf == &cm->buffer_pool->frame_bufs[buf_idx]) break;
  }
  return (ref_frame <= ALTREF_FRAME);
}
766
#endif  // CONFIG_EXT_REFS
767

768
static INLINE unsigned int get_token_alloc(int mb_rows, int mb_cols) {
769 770 771 772
  // We assume 3 planes all at full resolution. We assume up to 1 token per
  // pixel, and then allow a head room of 1 EOSB token per 4x4 block per plane,
  // plus EOSB_TOKEN per plane.
  return mb_rows * mb_cols * (16 * 16 + 17) * 3;
Jingning Han's avatar
Jingning Han committed
773 774 775 776
}

// Get the allocated token size for a tile. It does the same calculation as in
// the frame token allocation.
777
static INLINE unsigned int allocated_tokens(TileInfo tile) {
Jingning Han's avatar
Jingning Han committed
778 779 780 781 782 783
  int tile_mb_rows = (tile.mi_row_end - tile.mi_row_start + 1) >> 1;
  int tile_mb_cols = (tile.mi_col_end - tile.mi_col_start + 1) >> 1;

  return get_token_alloc(tile_mb_rows, tile_mb_cols);
}

Yaowu Xu's avatar
Yaowu Xu committed
784
void av1_alloc_compressor_data(AV1_COMP *cpi);
Jingning Han's avatar
Jingning Han committed
785

Yaowu Xu's avatar
Yaowu Xu committed
786
void av1_scale_references(AV1_COMP *cpi);
Jingning Han's avatar
Jingning Han committed
787

Yaowu Xu's avatar
Yaowu Xu committed
788
void av1_update_reference_frames(AV1_COMP *cpi);
Jingning Han's avatar
Jingning Han committed
789

Yaowu Xu's avatar
Yaowu Xu committed
790
void av1_set_high_precision_mv(AV1_COMP *cpi, int allow_high_precision_mv);
Jingning Han's avatar
Jingning Han committed
791

Yaowu Xu's avatar
Yaowu Xu committed
792 793 794
YV12_BUFFER_CONFIG *av1_scale_if_required_fast(AV1_COMMON *cm,
                                               YV12_BUFFER_CONFIG *unscaled,
                                               YV12_BUFFER_CONFIG *scaled);
Jingning Han's avatar
Jingning Han committed
795

Yaowu Xu's avatar
Yaowu Xu committed
796 797 798
YV12_BUFFER_CONFIG *av1_scale_if_required(AV1_COMMON *cm,
                                          YV12_BUFFER_CONFIG *unscaled,
                                          YV12_BUFFER_CONFIG *scaled);
Jingning Han's avatar
Jingning Han committed
799

Yaowu Xu's avatar
Yaowu Xu committed
800
void av1_apply_encoding_flags(AV1_COMP *cpi, aom_enc_frame_flags_t flags);
Jingning Han's avatar
Jingning Han committed
801

Yaowu Xu's avatar
Yaowu Xu committed
802
static INLINE int is_altref_enabled(const AV1_COMP *const cpi) {
Jingning Han's avatar
Jingning Han committed
803
  return cpi->oxcf.mode != REALTIME && cpi->oxcf.lag_in_frames > 0 &&
Yunqing Wang's avatar
Yunqing Wang committed
804
         cpi->oxcf.enable_auto_arf;
Jingning Han's avatar
Jingning Han committed
805 806
}

807 808
// TODO(zoeliu): To set up cpi->oxcf.enable_auto_brf
#if 0 && CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
809
static INLINE int is_bwdref_enabled(const AV1_COMP *const cpi) {
810 811 812 813
  // NOTE(zoeliu): The enabling of bi-predictive frames depends on the use of
  //               alt_ref, and now will be off when the alt_ref interval is
  //               not sufficiently large.
  return is_altref_enabled(cpi) && cpi->oxcf.enable_auto_brf;
814
}
815
#endif  // CONFIG_EXT_REFS
816

817
static INLINE void set_ref_ptrs(const AV1_COMMON *cm, MACROBLOCKD *xd,
Jingning Han's avatar
Jingning Han committed
818 819
                                MV_REFERENCE_FRAME ref0,
                                MV_REFERENCE_FRAME ref1) {
820 821 822 823
  xd->block_refs[0] =
      &cm->frame_refs[ref0 >= LAST_FRAME ? ref0 - LAST_FRAME : 0];
  xd->block_refs[1] =
      &cm->frame_refs[ref1 >= LAST_FRAME ? ref1 - LAST_FRAME : 0];
Jingning Han's avatar
Jingning Han committed
824 825 826 827 828 829
}

static INLINE int get_chessboard_index(const int frame_index) {
  return frame_index & 0x1;
}

Yaowu Xu's avatar
Yaowu Xu committed
830
static INLINE int *cond_cost_list(const struct AV1_COMP *cpi, int *cost_list) {
Jingning Han's avatar
Jingning Han committed
831 832 833
  return cpi->sf.mv.subpel_search_method != SUBPEL_TREE ? cost_list : NULL;
}

Yaowu Xu's avatar
Yaowu Xu committed
834
void av1_new_framerate(AV1_COMP *cpi, double framerate);
Jingning Han's avatar
Jingning Han committed
835 836 837

#define LAYER_IDS_TO_IDX(sl, tl, num_tl) ((sl) * (num_tl) + (tl))

838 839 840 841 842 843 844 845 846 847 848 849
// Update up-sampled reference frame index.
static INLINE void uref_cnt_fb(EncRefCntBuffer *ubufs, int *uidx,
                               int new_uidx) {
  const int ref_index = *uidx;

  if (ref_index >= 0 && ubufs[ref_index].ref_count > 0)
    ubufs[ref_index].ref_count--;

  *uidx = new_uidx;
  ubufs[new_uidx].ref_count++;
}

Yunqing Wang's avatar
Yunqing Wang committed
850 851 852 853
#ifdef __cplusplus
}  // extern "C"
#endif

Yaowu Xu's avatar
Yaowu Xu committed
854
#endif  // AV1_ENCODER_ENCODER_H_