encoder.h 25.2 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
#include "av1/common/alloccommon.h"
#include "av1/common/entropymode.h"
#include "av1/common/thread_common.h"
#include "av1/common/onyxc_int.h"
24
#include "av1/common/resize.h"
25
#include "av1/encoder/aq_cyclicrefresh.h"
26
#if CONFIG_ANS
27
#include "aom_dsp/ans.h"
Alex Converse's avatar
Alex Converse committed
28
#include "aom_dsp/buf_ans.h"
29
#endif
30
#include "av1/encoder/av1_quantize.h"
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/ratectrl.h"
#include "av1/encoder/rd.h"
#include "av1/encoder/speed_features.h"
#include "av1/encoder/tokenize.h"
41 42 43
#if CONFIG_XIPHRC
#include "av1/encoder/ratectrl_xiph.h"
#endif
Jingning Han's avatar
Jingning Han committed
44

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

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

typedef struct {
57 58 59 60
  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];

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

  FRAME_CONTEXT fc;
} CODING_CONTEXT;

69 70 71 72 73 74 75 76 77 78 79 80
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,
81 82
  // extra alternate reference frame
  EXT_ARF_FRAME = 5
83 84 85
#endif
} FRAME_CONTEXT_INDEX;

Jingning Han's avatar
Jingning Han committed
86
typedef enum {
87 88 89 90
  NORMAL = 0,
  FOURFIVE = 1,
  THREEFIVE = 2,
  ONETWO = 3
Yaowu Xu's avatar
Yaowu Xu committed
91
} AOM_SCALING;
Jingning Han's avatar
Jingning Han committed
92 93 94 95

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.
Thomas Daede's avatar
Thomas Daede committed
96
  GOOD
Jingning Han's avatar
Jingning Han committed
97 98 99
} MODE;

typedef enum {
100
  FRAMEFLAGS_KEY = 1 << 0,
Jingning Han's avatar
Jingning Han committed
101
  FRAMEFLAGS_GOLDEN = 1 << 1,
102
#if CONFIG_EXT_REFS
103 104 105
  FRAMEFLAGS_BWDREF = 1 << 2,
  FRAMEFLAGS_ALTREF = 1 << 3,
#else
Jingning Han's avatar
Jingning Han committed
106
  FRAMEFLAGS_ALTREF = 1 << 2,
107
#endif  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
108 109 110 111 112 113 114
} FRAMETYPE_FLAGS;

typedef enum {
  NO_AQ = 0,
  VARIANCE_AQ = 1,
  COMPLEXITY_AQ = 2,
  CYCLIC_REFRESH_AQ = 3,
Fangwen Fu's avatar
Fangwen Fu committed
115
#if CONFIG_DELTA_Q && !CONFIG_EXT_DELTA_Q
116 117
  DELTA_AQ = 4,
#endif
Jingning Han's avatar
Jingning Han committed
118 119
  AQ_MODE_COUNT  // This should always be the last member of the enum
} AQ_MODE;
Fangwen Fu's avatar
Fangwen Fu committed
120 121 122 123 124 125 126 127
#if CONFIG_EXT_DELTA_Q
typedef enum {
  NO_DELTA_Q = 0,
  DELTA_Q_ONLY = 1,
  DELTA_Q_LF = 2,
  DELTAQ_MODE_COUNT  // This should always be the last member of the enum
} DELTAQ_MODE;
#endif
Jingning Han's avatar
Jingning Han committed
128
typedef enum {
Yunqing Wang's avatar
Yunqing Wang committed
129
  RESIZE_NONE = 0,    // No frame resizing allowed.
Jingning Han's avatar
Jingning Han committed
130 131 132 133
  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
134
typedef struct AV1EncoderConfig {
Jingning Han's avatar
Jingning Han committed
135
  BITSTREAM_PROFILE profile;
Yaowu Xu's avatar
Yaowu Xu committed
136
  aom_bit_depth_t bit_depth;     // Codec bit-depth.
137 138
  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
139
  unsigned int input_bit_depth;  // Input bit depth.
140 141
  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
142 143

  int noise_sensitivity;  // pre processing blur: recommendation 0
144
  int sharpness;          // sharpening output: recommendation 0:
Jingning Han's avatar
Jingning Han committed
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
  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
166
  enum aom_rc_mode rc_mode;
Jingning Han's avatar
Jingning Han committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

  // 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
Fangwen Fu's avatar
Fangwen Fu committed
186 187 188
#if CONFIG_EXT_DELTA_Q
  DELTAQ_MODE deltaq_mode;
#endif
189 190 191 192 193
#if CONFIG_AOM_QM
  int using_qm;
  int qm_minlevel;
  int qm_maxlevel;
#endif
194 195 196 197
#if CONFIG_TILE_GROUPS
  unsigned int num_tile_groups;
  unsigned int mtu;
#endif
Jingning Han's avatar
Jingning Han committed
198

199 200 201
#if CONFIG_TEMPMV_SIGNALING
  unsigned int disable_tempmv;
#endif
Jingning Han's avatar
Jingning Han committed
202 203 204 205 206
  // Internal frame size scaling.
  RESIZE_TYPE resize_mode;
  int scaled_frame_width;
  int scaled_frame_height;

207 208 209 210 211
#if CONFIG_FRAME_SUPERRES
  // Frame Super-Resolution size scaling
  int superres_enabled;
#endif  // CONFIG_FRAME_SUPERRES

Jingning Han's avatar
Jingning Han committed
212 213 214 215
  // Enable feature to reduce the frame quantization every x frames.
  int frame_periodic_boost;

  // two pass datarate control
216
  int two_pass_vbrbias;  // two pass datarate control tweaks
Jingning Han's avatar
Jingning Han committed
217 218 219 220 221 222
  int two_pass_vbrmin_section;
  int two_pass_vbrmax_section;
  // END DATARATE CONTROL OPTIONS
  // ----------------------------------------------------------------

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

  /* 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;
247 248 249
#if CONFIG_DEPENDENT_HORZTILES
  int dependent_horz_tiles;
#endif
250
#if CONFIG_LOOPFILTERING_ACROSS_TILES
251
  int loop_filter_across_tiles_enabled;
252
#endif  // CONFIG_LOOPFILTERING_ACROSS_TILES
Jingning Han's avatar
Jingning Han committed
253 254 255

  int max_threads;

Yaowu Xu's avatar
Yaowu Xu committed
256 257
  aom_fixed_buf_t two_pass_stats_in;
  struct aom_codec_pkt_list *output_pkt_list;
Jingning Han's avatar
Jingning Han committed
258 259

#if CONFIG_FP_MB_STATS
Yaowu Xu's avatar
Yaowu Xu committed
260
  aom_fixed_buf_t firstpass_mb_stats_in;
Jingning Han's avatar
Jingning Han committed
261 262
#endif

Yaowu Xu's avatar
Yaowu Xu committed
263 264
  aom_tune_metric tuning;
  aom_tune_content content;
265
#if CONFIG_HIGHBITDEPTH
Jingning Han's avatar
Jingning Han committed
266 267
  int use_highbitdepth;
#endif
Yaowu Xu's avatar
Yaowu Xu committed
268
  aom_color_space_t color_space;
269
  int color_range;
270 271
  int render_width;
  int render_height;
272 273

#if CONFIG_EXT_PARTITION
Yaowu Xu's avatar
Yaowu Xu committed
274
  aom_superblock_size_t superblock_size;
275
#endif  // CONFIG_EXT_PARTITION
276 277 278
#if CONFIG_ANS && ANS_MAX_SYMBOLS
  int ans_window_size_log2;
#endif  // CONFIG_ANS && ANS_MAX_SYMBOLS
279 280 281
#if CONFIG_EXT_TILE
  unsigned int tile_encoding_mode;
#endif  // CONFIG_EXT_TILE
Yunqing Wang's avatar
Yunqing Wang committed
282 283

  unsigned int motion_vector_unit_test;
Yaowu Xu's avatar
Yaowu Xu committed
284
} AV1EncoderConfig;
Jingning Han's avatar
Jingning Han committed
285

Yaowu Xu's avatar
Yaowu Xu committed
286
static INLINE int is_lossless_requested(const AV1EncoderConfig *cfg) {
Jingning Han's avatar
Jingning Han committed
287 288 289 290 291 292 293 294
  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];
295 296
  int m_search_count;
  int ex_search_count;
297 298 299
#if CONFIG_PVQ
  PVQ_QUEUE pvq_q;
#endif
Luc Trudeau's avatar
Luc Trudeau committed
300 301 302
#if CONFIG_CFL
  CFL_CTX cfl;
#endif
303
#if CONFIG_EC_ADAPT
304
  DECLARE_ALIGNED(16, FRAME_CONTEXT, tctx);
305
#endif
Jingning Han's avatar
Jingning Han committed
306 307 308
} TileDataEnc;

typedef struct RD_COUNTS {
Yaowu Xu's avatar
Yaowu Xu committed
309
  av1_coeff_count coef_counts[TX_SIZES][PLANE_TYPES];
Jingning Han's avatar
Jingning Han committed
310
  int64_t comp_pred_diff[REFERENCE_MODES];
311 312 313 314
#if CONFIG_GLOBAL_MOTION
  // Stores number of 4x4 blocks using global motion per reference frame.
  int global_motion_used[TOTAL_REFS_PER_FRAME];
#endif  // CONFIG_GLOBAL_MOTION
Jingning Han's avatar
Jingning Han committed
315 316 317 318 319 320 321 322 323
} 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
324
  PC_TREE *pc_root[MAX_MIB_SIZE_LOG2 - MIN_MIB_SIZE_LOG2 + 1];
325 326 327 328 329 330
#if CONFIG_MOTION_VAR
  int32_t *wsrc_buf;
  int32_t *mask_buf;
  uint8_t *above_pred_buf;
  uint8_t *left_pred_buf;
#endif
331

332 333 334
#if CONFIG_PALETTE
  PALETTE_BUFFER *palette_buffer;
#endif  // CONFIG_PALETTE
Jingning Han's avatar
Jingning Han committed
335 336 337 338 339 340 341 342 343 344
} ThreadData;

struct EncWorkerData;

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

345
#define NUM_STAT_TYPES 4  // types of stats: Y, U, V and ALL
Jingning Han's avatar
Jingning Han committed
346 347

typedef struct IMAGE_STAT {
348
  double stat[NUM_STAT_TYPES];
Jingning Han's avatar
Jingning Han committed
349 350 351
  double worst;
} ImageStat;

352 353
#undef NUM_STAT_TYPES

354 355 356 357 358
typedef struct {
  int ref_count;
  YV12_BUFFER_CONFIG buf;
} EncRefCntBuffer;

359 360 361 362 363
typedef struct TileBufferEnc {
  uint8_t *data;
  size_t size;
} TileBufferEnc;

Yaowu Xu's avatar
Yaowu Xu committed
364
typedef struct AV1_COMP {
Jingning Han's avatar
Jingning Han committed
365 366 367
  QUANTS quants;
  ThreadData td;
  MB_MODE_INFO_EXT *mbmi_ext_base;
368
  Dequants dequants;
Yaowu Xu's avatar
Yaowu Xu committed
369 370
  AV1_COMMON common;
  AV1EncoderConfig oxcf;
371 372
  struct lookahead_ctx *lookahead;
  struct lookahead_entry *alt_ref_source;
Jingning Han's avatar
Jingning Han committed
373

374 375
  YV12_BUFFER_CONFIG *source;
  YV12_BUFFER_CONFIG *last_source;  // NULL for first frame and alt_ref frames
376
  YV12_BUFFER_CONFIG *unscaled_source;
Jingning Han's avatar
Jingning Han committed
377 378 379 380
  YV12_BUFFER_CONFIG scaled_source;
  YV12_BUFFER_CONFIG *unscaled_last_source;
  YV12_BUFFER_CONFIG scaled_last_source;

381
  // Up-sampled reference buffers
382 383 384 385 386
  // 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];
387

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

391
  int scaled_ref_idx[TOTAL_REFS_PER_FRAME];
392
#if CONFIG_EXT_REFS
393
  int lst_fb_idxes[LAST_REF_FRAMES];
394
#else
395
  int lst_fb_idx;
396
#endif  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
397
  int gld_fb_idx;
398
#if CONFIG_EXT_REFS
399
  int bwd_fb_idx;  // BWD_REF_FRAME
400
#endif             // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
401 402
  int alt_fb_idx;

403 404
  int last_show_frame_buf_idx;  // last show frame buffer index

405
  int refresh_last_frame;
Jingning Han's avatar
Jingning Han committed
406
  int refresh_golden_frame;
407
#if CONFIG_EXT_REFS
408
  int refresh_bwd_ref_frame;
409
#endif  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
410 411 412
  int refresh_alt_ref_frame;

  int ext_refresh_frame_flags_pending;
413
  int ext_refresh_last_frame;
Jingning Han's avatar
Jingning Han committed
414 415 416 417 418 419 420
  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
421 422
#if CONFIG_LOOP_RESTORATION
  YV12_BUFFER_CONFIG last_frame_db;
423
  YV12_BUFFER_CONFIG trial_frame_rst;
424 425 426
  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
427 428 429 430 431 432 433 434

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

  RD_OPT rd;

  CODING_CONTEXT coding_context;

435 436
  int nmv_costs[NMV_CONTEXTS][2][MV_VALS];
  int nmv_costs_hp[NMV_CONTEXTS][2][MV_VALS];
437

Jingning Han's avatar
Jingning Han committed
438 439 440 441 442
  int64_t last_time_stamp_seen;
  int64_t last_end_time_stamp_seen;
  int64_t first_time_stamp_ever;

  RATE_CONTROL rc;
443 444 445
#if CONFIG_XIPHRC
  od_rc_state od_rc;
#endif
Jingning Han's avatar
Jingning Han committed
446 447
  double framerate;

448 449 450 451
  // 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
452

Yaowu Xu's avatar
Yaowu Xu committed
453
  struct aom_codec_pkt_list *output_pkt_list;
Jingning Han's avatar
Jingning Han committed
454 455

  MBGRAPH_FRAME_STATS mbgraph_stats[MAX_LAG_BUFFERS];
456 457
  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
458 459 460 461 462 463 464 465 466
  int ref_frame_flags;

  SPEED_FEATURES sf;

  unsigned int max_mv_magnitude;
  int mv_step_param;

  int allow_comp_inter_inter;

467
  uint8_t *segmentation_map;
Jingning Han's avatar
Jingning Han committed
468 469 470 471 472

  CYCLIC_REFRESH *cyclic_refresh;
  ActiveMap active_map;

  fractional_mv_step_fp *find_fractional_mv_step;
Yaowu Xu's avatar
Yaowu Xu committed
473 474 475
  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
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
  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];

492
  int count;
Jingning Han's avatar
Jingning Han committed
493 494 495 496 497 498 499
  uint64_t total_sq_error;
  uint64_t total_samples;
  ImageStat psnr;

  double total_blockiness;
  double worst_blockiness;

500
  int bytes;
Jingning Han's avatar
Jingning Han committed
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
  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.

  int frame_flags;

  search_site_config ss_cfg;

532
  int mbmode_cost[BLOCK_SIZE_GROUPS][INTRA_MODES];
533 534 535
  int newmv_mode_cost[NEWMV_MODE_CONTEXTS][2];
  int zeromv_mode_cost[ZEROMV_MODE_CONTEXTS][2];
  int refmv_mode_cost[REFMV_MODE_CONTEXTS][2];
536
  int drl_mode_cost0[DRL_MODE_CONTEXTS][2];
537

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

  int multi_arf_allowed;
  int multi_arf_enabled;
  int multi_arf_last_grp_enabled;
599 600 601 602 603 604 605 606 607

  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
608 609 610 611 612
  int resize_state;
  int resize_avg_qp;
  int resize_buffer_underflow;
  int resize_count;

Geza Lore's avatar
Geza Lore committed
613 614 615
  // VARIANCE_AQ segment map refresh
  int vaq_refresh;

Jingning Han's avatar
Jingning Han committed
616 617
  // Multi-threading
  int num_workers;
Yaowu Xu's avatar
Yaowu Xu committed
618
  AVxWorker *workers;
Jingning Han's avatar
Jingning Han committed
619
  struct EncWorkerData *tile_thr_data;
Yaowu Xu's avatar
Yaowu Xu committed
620
  AV1LfSync lf_row_sync;
621 622 623
#if CONFIG_ANS
  struct BufAnsCoder buf_ans;
#endif
624
#if CONFIG_EXT_REFS
625 626
  int refresh_frame_mask;
  int existing_fb_idx_to_show;
627 628 629
  int is_arf_filter_off[MAX_EXT_ARFS + 1];
  int num_extra_arfs;
  int arf_map[MAX_EXT_ARFS + 1];
630
#endif  // CONFIG_EXT_REFS
631
#if CONFIG_GLOBAL_MOTION
632
  int global_motion_search_done;
633
#endif
634 635 636
#if CONFIG_REFERENCE_BUFFER
  SequenceHeader seq_params;
#endif
637 638 639
#if CONFIG_LV_MAP
  tran_low_t *tcoeff_buf[MAX_MB_PLANE];
#endif
Yaowu Xu's avatar
Yaowu Xu committed
640
} AV1_COMP;
Jingning Han's avatar
Jingning Han committed
641

Yaowu Xu's avatar
Yaowu Xu committed
642
void av1_initialize_enc(void);
Jingning Han's avatar
Jingning Han committed
643

Yaowu Xu's avatar
Yaowu Xu committed
644 645 646
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
647

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

650 651
// 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..
652
int av1_receive_raw_frame(AV1_COMP *cpi, aom_enc_frame_flags_t frame_flags,
Yaowu Xu's avatar
Yaowu Xu committed
653 654
                          YV12_BUFFER_CONFIG *sd, int64_t time_stamp,
                          int64_t end_time_stamp);
Jingning Han's avatar
Jingning Han committed
655

Yaowu Xu's avatar
Yaowu Xu committed
656 657 658
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
659

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

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

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

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

Yaowu Xu's avatar
Yaowu Xu committed
668
int av1_copy_reference_enc(AV1_COMP *cpi, AOM_REFFRAME ref_frame_flag,
669
                           YV12_BUFFER_CONFIG *sd);
Jingning Han's avatar
Jingning Han committed
670

Yaowu Xu's avatar
Yaowu Xu committed
671 672 673 674
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
675

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

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

Yaowu Xu's avatar
Yaowu Xu committed
680 681
int av1_set_internal_size(AV1_COMP *cpi, AOM_SCALING horiz_mode,
                          AOM_SCALING vert_mode);
Jingning Han's avatar
Jingning Han committed
682

683 684
// Returns 1 if the assigned width or height was <= 0.
int av1_set_size_literal(AV1_COMP *cpi, int width, int height);
Jingning Han's avatar
Jingning Han committed
685

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

Yaowu Xu's avatar
Yaowu Xu committed
688 689
void av1_full_to_model_counts(av1_coeff_count_model *model_count,
                              av1_coeff_count *full_count);
hui su's avatar
hui su committed
690

Yaowu Xu's avatar
Yaowu Xu committed
691
static INLINE int frame_is_kf_gf_arf(const AV1_COMP *cpi) {
692
  return frame_is_intra_only(&cpi->common) || cpi->refresh_alt_ref_frame ||
Jingning Han's avatar
Jingning Han committed
693 694 695
         (cpi->refresh_golden_frame && !cpi->rc.is_src_frame_alt_ref);
}

Yaowu Xu's avatar
Yaowu Xu committed
696
static INLINE int get_ref_frame_map_idx(const AV1_COMP *cpi,
Jingning Han's avatar
Jingning Han committed
697
                                        MV_REFERENCE_FRAME ref_frame) {
698
#if CONFIG_EXT_REFS
699
  if (ref_frame >= LAST_FRAME && ref_frame <= LAST3_FRAME)
700 701
    return cpi->lst_fb_idxes[ref_frame - 1];
#else
702
  if (ref_frame == LAST_FRAME) return cpi->lst_fb_idx;
703
#endif  // CONFIG_EXT_REFS
704
  else if (ref_frame == GOLDEN_FRAME)
Jingning Han's avatar
Jingning Han committed
705
    return cpi->gld_fb_idx;
706
#if CONFIG_EXT_REFS
707 708
  else if (ref_frame == BWDREF_FRAME)
    return cpi->bwd_fb_idx;
709
#endif  // CONFIG_EXT_REFS
710
  else
Jingning Han's avatar
Jingning Han committed
711 712 713
    return cpi->alt_fb_idx;
}

714
static INLINE int get_ref_frame_buf_idx(const AV1_COMP *cpi,
715
                                        MV_REFERENCE_FRAME ref_frame) {
Yaowu Xu's avatar
Yaowu Xu committed
716
  const AV1_COMMON *const cm = &cpi->common;
Jingning Han's avatar
Jingning Han committed
717 718 719 720 721
  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(
722 723
    const AV1_COMP *cpi, MV_REFERENCE_FRAME ref_frame) {
  const AV1_COMMON *const cm = &cpi->common;
Jingning Han's avatar
Jingning Han committed
724
  const int buf_idx = get_ref_frame_buf_idx(cpi, ref_frame);
725 726
  return buf_idx != INVALID_IDX ? &cm->buffer_pool->frame_bufs[buf_idx].buf
                                : NULL;
Jingning Han's avatar
Jingning Han committed
727 728
}

729
static INLINE const YV12_BUFFER_CONFIG *get_upsampled_ref(
730
    const AV1_COMP *cpi, const MV_REFERENCE_FRAME ref_frame) {
731 732 733 734 735 736
  // 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;
}

737
#if CONFIG_EXT_REFS || CONFIG_TEMPMV_SIGNALING
Yaowu Xu's avatar
Yaowu Xu committed
738
static INLINE int enc_is_ref_frame_buf(AV1_COMP *cpi, RefCntBuffer *frame_buf) {
739
  MV_REFERENCE_FRAME ref_frame;
Yaowu Xu's avatar
Yaowu Xu committed
740
  AV1_COMMON *const cm = &cpi->common;
741 742 743 744 745 746 747
  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);
}
748
#endif  // CONFIG_EXT_REFS
749

750
static INLINE unsigned int get_token_alloc(int mb_rows, int mb_cols) {
751 752 753 754
  // 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
755 756 757 758
}

// Get the allocated token size for a tile. It does the same calculation as in
// the frame token allocation.
759
static INLINE unsigned int allocated_tokens(TileInfo tile) {
760 761 762 763
#if CONFIG_CB4X4
  int tile_mb_rows = (tile.mi_row_end - tile.mi_row_start + 2) >> 2;
  int tile_mb_cols = (tile.mi_col_end - tile.mi_col_start + 2) >> 2;
#else
Jingning Han's avatar
Jingning Han committed
764 765
  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;
766
#endif
Jingning Han's avatar
Jingning Han committed
767 768 769 770

  return get_token_alloc(tile_mb_rows, tile_mb_cols);
}

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

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

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

Yaowu Xu's avatar
Yaowu Xu committed
777
void av1_set_high_precision_mv(AV1_COMP *cpi, int allow_high_precision_mv);
778 779 780
#if CONFIG_TEMPMV_SIGNALING
void av1_set_temporal_mv_prediction(AV1_COMP *cpi, int allow_tempmv_prediction);
#endif
Jingning Han's avatar
Jingning Han committed
781

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

Yaowu Xu's avatar
Yaowu Xu committed
784
static INLINE int is_altref_enabled(const AV1_COMP *const cpi) {
Thomas Daede's avatar
Thomas Daede committed
785
  return cpi->oxcf.lag_in_frames > 0 && cpi->oxcf.enable_auto_arf;
Jingning Han's avatar
Jingning Han committed
786 787
}

788 789
// TODO(zoeliu): To set up cpi->oxcf.enable_auto_brf
#if 0 && CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
790
static INLINE int is_bwdref_enabled(const AV1_COMP *const cpi) {
791 792 793 794
  // 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;
795
}
796
#endif  // CONFIG_EXT_REFS
797

798
static INLINE void set_ref_ptrs(const AV1_COMMON *cm, MACROBLOCKD *xd,
Jingning Han's avatar
Jingning Han committed
799 800
                                MV_REFERENCE_FRAME ref0,
                                MV_REFERENCE_FRAME ref1) {
801 802 803 804
  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
805 806
}

807
static INLINE int get_chessboard_index(int frame_index) {
Jingning Han's avatar
Jingning Han committed
808 809 810
  return frame_index & 0x1;
}

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

Yaowu Xu's avatar
Yaowu Xu committed
815
void av1_new_framerate(AV1_COMP *cpi, double framerate);
Jingning Han's avatar
Jingning Han committed
816 817 818

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

819 820 821 822 823 824 825 826 827 828 829 830
// 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++;
}

831
// Returns 1 if a frame is unscaled and 0 otherwise.
832 833 834 835 836 837 838
static INLINE int av1_resize_unscaled(const AV1_COMMON *cm) {
#if CONFIG_FRAME_SUPERRES
  return cm->superres_upscaled_width == cm->render_width &&
         cm->superres_upscaled_height == cm->render_height;
#else
  return cm->width == cm->render_width && cm->height == cm->render_height;
#endif  // CONFIG_FRAME_SUPERRES
839 840
}

841 842 843 844 845 846
static INLINE int av1_frame_unscaled(const AV1_COMMON *cm) {
#if CONFIG_FRAME_SUPERRES
  return av1_superres_unscaled(cm) && av1_resize_unscaled(cm);
#else
  return av1_resize_unscaled(cm);
#endif  // CONFIG_FRAME_SUPERRES
847 848
}

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

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