encoder.h 23.7 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
  int8_t last_ref_lf_deltas[TOTAL_REFS_PER_FRAME];
Jingning Han's avatar
Jingning Han committed
63
  // 0 = ZERO_MV, MV
64
  int8_t last_mode_lf_deltas[MAX_MODE_LF_DELTAS];
Jingning Han's avatar
Jingning Han committed
65 66 67 68

  FRAME_CONTEXT fc;
} CODING_CONTEXT;

69
#if !CONFIG_NO_FRAME_CONTEXT_SIGNALING
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,
  // backward reference frame
  BRF_FRAME = 4,
81 82
  // extra alternate reference frame
  EXT_ARF_FRAME = 5
83
} FRAME_CONTEXT_INDEX;
84
#endif
85

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
  FRAMEFLAGS_BWDREF = 1 << 2,
103
  // TODO(zoeliu): To determine whether a frame flag is needed for ALTREF2_FRAME
104
  FRAMEFLAGS_ALTREF = 1 << 3,
Jingning Han's avatar
Jingning Han committed
105 106 107 108 109 110 111
} FRAMETYPE_FLAGS;

typedef enum {
  NO_AQ = 0,
  VARIANCE_AQ = 1,
  COMPLEXITY_AQ = 2,
  CYCLIC_REFRESH_AQ = 3,
112
#if !CONFIG_EXT_DELTA_Q
113 114
  DELTA_AQ = 4,
#endif
Jingning Han's avatar
Jingning Han committed
115 116
  AQ_MODE_COUNT  // This should always be the last member of the enum
} AQ_MODE;
Fangwen Fu's avatar
Fangwen Fu committed
117 118 119 120 121 122 123 124
#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
125
typedef enum {
Yunqing Wang's avatar
Yunqing Wang committed
126
  RESIZE_NONE = 0,    // No frame resizing allowed.
127 128 129
  RESIZE_FIXED = 1,   // All frames are coded at the specified scale.
  RESIZE_RANDOM = 2,  // All frames are coded at a random scale.
  RESIZE_MODES
130
} RESIZE_MODE;
131 132
#if CONFIG_FRAME_SUPERRES
typedef enum {
133 134 135 136 137 138 139 140
  SUPERRES_NONE = 0,     // No frame superres allowed
  SUPERRES_FIXED = 1,    // All frames are coded at the specified scale,
                         // and super-resolved.
  SUPERRES_RANDOM = 2,   // All frames are coded at a random scale,
                         // and super-resolved.
  SUPERRES_QTHRESH = 3,  // Superres scale for a frame is determined based on
                         // q_index
  SUPERRES_MODES
141 142
} SUPERRES_MODE;
#endif  // CONFIG_FRAME_SUPERRES
Jingning Han's avatar
Jingning Han committed
143

Yaowu Xu's avatar
Yaowu Xu committed
144
typedef struct AV1EncoderConfig {
Jingning Han's avatar
Jingning Han committed
145
  BITSTREAM_PROFILE profile;
Yaowu Xu's avatar
Yaowu Xu committed
146
  aom_bit_depth_t bit_depth;     // Codec bit-depth.
147 148
  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
149
  unsigned int input_bit_depth;  // Input bit depth.
150 151
  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
152 153

  int noise_sensitivity;  // pre processing blur: recommendation 0
154
  int sharpness;          // sharpening output: recommendation 0:
Jingning Han's avatar
Jingning Han committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
  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
176
  enum aom_rc_mode rc_mode;
Jingning Han's avatar
Jingning Han committed
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195

  // 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
196 197 198
#if CONFIG_EXT_DELTA_Q
  DELTAQ_MODE deltaq_mode;
#endif
199 200 201 202
#if CONFIG_AOM_QM
  int using_qm;
  int qm_minlevel;
  int qm_maxlevel;
203 204 205
#endif
#if CONFIG_DIST_8X8
  int using_dist_8x8;
206
#endif
207 208
  unsigned int num_tile_groups;
  unsigned int mtu;
Jingning Han's avatar
Jingning Han committed
209

210 211 212
#if CONFIG_TEMPMV_SIGNALING
  unsigned int disable_tempmv;
#endif
Jingning Han's avatar
Jingning Han committed
213
  // Internal frame size scaling.
214
  RESIZE_MODE resize_mode;
215 216
  uint8_t resize_scale_denominator;
  uint8_t resize_kf_scale_denominator;
Jingning Han's avatar
Jingning Han committed
217

218
#if CONFIG_FRAME_SUPERRES
219 220
  // Frame Super-Resolution size scaling.
  SUPERRES_MODE superres_mode;
221 222
  uint8_t superres_scale_denominator;
  uint8_t superres_kf_scale_denominator;
223 224
  int superres_qthresh;
  int superres_kf_qthresh;
225 226
#endif  // CONFIG_FRAME_SUPERRES

Jingning Han's avatar
Jingning Han committed
227 228 229 230
  // Enable feature to reduce the frame quantization every x frames.
  int frame_periodic_boost;

  // two pass datarate control
231
  int two_pass_vbrbias;  // two pass datarate control tweaks
Jingning Han's avatar
Jingning Han committed
232 233 234 235 236 237
  int two_pass_vbrmin_section;
  int two_pass_vbrmax_section;
  // END DATARATE CONTROL OPTIONS
  // ----------------------------------------------------------------

  int enable_auto_arf;
238
  int enable_auto_brf;  // (b)ackward (r)ef (f)rame
Jingning Han's avatar
Jingning Han committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259

  /* 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;
260
#if CONFIG_MAX_TILE
261 262 263 264
  int tile_width_count;
  int tile_height_count;
  int tile_widths[MAX_TILE_COLS];
  int tile_heights[MAX_TILE_ROWS];
265
#endif
266 267 268
#if CONFIG_DEPENDENT_HORZTILES
  int dependent_horz_tiles;
#endif
269
#if CONFIG_LOOPFILTERING_ACROSS_TILES
270
  int loop_filter_across_tiles_enabled;
271
#endif  // CONFIG_LOOPFILTERING_ACROSS_TILES
Jingning Han's avatar
Jingning Han committed
272 273 274

  int max_threads;

Yaowu Xu's avatar
Yaowu Xu committed
275 276
  aom_fixed_buf_t two_pass_stats_in;
  struct aom_codec_pkt_list *output_pkt_list;
Jingning Han's avatar
Jingning Han committed
277 278

#if CONFIG_FP_MB_STATS
Yaowu Xu's avatar
Yaowu Xu committed
279
  aom_fixed_buf_t firstpass_mb_stats_in;
Jingning Han's avatar
Jingning Han committed
280 281
#endif

Yaowu Xu's avatar
Yaowu Xu committed
282 283
  aom_tune_metric tuning;
  aom_tune_content content;
284
#if CONFIG_HIGHBITDEPTH
Jingning Han's avatar
Jingning Han committed
285 286
  int use_highbitdepth;
#endif
Yaowu Xu's avatar
Yaowu Xu committed
287
  aom_color_space_t color_space;
288 289
  aom_transfer_function_t transfer_function;
  aom_chroma_sample_position_t chroma_sample_position;
290
  int color_range;
291 292
  int render_width;
  int render_height;
293 294

#if CONFIG_EXT_PARTITION
Yaowu Xu's avatar
Yaowu Xu committed
295
  aom_superblock_size_t superblock_size;
296
#endif  // CONFIG_EXT_PARTITION
297 298 299
#if CONFIG_ANS && ANS_MAX_SYMBOLS
  int ans_window_size_log2;
#endif  // CONFIG_ANS && ANS_MAX_SYMBOLS
300
#if CONFIG_EXT_TILE
301 302
  unsigned int large_scale_tile;
  unsigned int single_tile_decoding;
303
#endif  // CONFIG_EXT_TILE
Yunqing Wang's avatar
Yunqing Wang committed
304 305

  unsigned int motion_vector_unit_test;
Yaowu Xu's avatar
Yaowu Xu committed
306
} AV1EncoderConfig;
Jingning Han's avatar
Jingning Han committed
307

Yaowu Xu's avatar
Yaowu Xu committed
308
static INLINE int is_lossless_requested(const AV1EncoderConfig *cfg) {
Jingning Han's avatar
Jingning Han committed
309 310 311 312 313 314
  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;
315 316
  int thresh_freq_fact[BLOCK_SIZES_ALL][MAX_MODES];
  int mode_map[BLOCK_SIZES_ALL][MAX_MODES];
317 318
  int m_search_count;
  int ex_search_count;
Luc Trudeau's avatar
Luc Trudeau committed
319 320 321
#if CONFIG_CFL
  CFL_CTX cfl;
#endif
322
  DECLARE_ALIGNED(16, FRAME_CONTEXT, tctx);
323
  uint8_t allow_update_cdf;
Jingning Han's avatar
Jingning Han committed
324 325 326 327
} TileDataEnc;

typedef struct RD_COUNTS {
  int64_t comp_pred_diff[REFERENCE_MODES];
328 329
  // Stores number of 4x4 blocks using global motion per reference frame.
  int global_motion_used[TOTAL_REFS_PER_FRAME];
330 331
  int single_ref_used_flag;
  int compound_ref_used_flag;
Jingning Han's avatar
Jingning Han committed
332 333 334 335 336 337 338
} RD_COUNTS;

typedef struct ThreadData {
  MACROBLOCK mb;
  RD_COUNTS rd_counts;
  FRAME_COUNTS *counts;
  PC_TREE *pc_tree;
Geza Lore's avatar
Geza Lore committed
339
  PC_TREE *pc_root[MAX_MIB_SIZE_LOG2 - MIN_MIB_SIZE_LOG2 + 1];
340 341 342 343
  int32_t *wsrc_buf;
  int32_t *mask_buf;
  uint8_t *above_pred_buf;
  uint8_t *left_pred_buf;
344

345
  PALETTE_BUFFER *palette_buffer;
Jingning Han's avatar
Jingning Han committed
346 347 348 349 350 351 352 353 354 355
} ThreadData;

struct EncWorkerData;

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

356
#define NUM_STAT_TYPES 4  // types of stats: Y, U, V and ALL
Jingning Han's avatar
Jingning Han committed
357 358

typedef struct IMAGE_STAT {
359
  double stat[NUM_STAT_TYPES];
Jingning Han's avatar
Jingning Han committed
360 361 362
  double worst;
} ImageStat;

363 364
#undef NUM_STAT_TYPES

365 366 367 368 369
typedef struct {
  int ref_count;
  YV12_BUFFER_CONFIG buf;
} EncRefCntBuffer;

370 371 372 373 374
typedef struct TileBufferEnc {
  uint8_t *data;
  size_t size;
} TileBufferEnc;

Yaowu Xu's avatar
Yaowu Xu committed
375
typedef struct AV1_COMP {
Jingning Han's avatar
Jingning Han committed
376 377 378
  QUANTS quants;
  ThreadData td;
  MB_MODE_INFO_EXT *mbmi_ext_base;
379 380 381
#if CONFIG_LV_MAP
  CB_COEFF_BUFFER *coeff_buffer_base;
#endif
382
  Dequants dequants;
Yaowu Xu's avatar
Yaowu Xu committed
383 384
  AV1_COMMON common;
  AV1EncoderConfig oxcf;
385 386
  struct lookahead_ctx *lookahead;
  struct lookahead_entry *alt_ref_source;
Jingning Han's avatar
Jingning Han committed
387

388 389
  YV12_BUFFER_CONFIG *source;
  YV12_BUFFER_CONFIG *last_source;  // NULL for first frame and alt_ref frames
390
  YV12_BUFFER_CONFIG *unscaled_source;
Jingning Han's avatar
Jingning Han committed
391 392 393 394 395 396
  YV12_BUFFER_CONFIG scaled_source;
  YV12_BUFFER_CONFIG *unscaled_last_source;
  YV12_BUFFER_CONFIG scaled_last_source;

  // For a still frame, this flag is set to 1 to skip partition search.
  int partition_search_skippable_frame;
RogerZhou's avatar
RogerZhou committed
397 398 399 400 401 402 403 404 405
#if CONFIG_AMVR
  double csm_rate_array[32];
  double m_rate_array[32];
  int rate_size;
  int rate_index;
  hash_table *previsou_hash_table;
  int previsous_index;
  int cur_poc;  // DebugInfo
#endif
Jingning Han's avatar
Jingning Han committed
406

407
  int scaled_ref_idx[TOTAL_REFS_PER_FRAME];
408
  int lst_fb_idxes[LAST_REF_FRAMES];
Jingning Han's avatar
Jingning Han committed
409
  int gld_fb_idx;
410
  int bwd_fb_idx;   // BWDREF_FRAME
Zoe Liu's avatar
Zoe Liu committed
411
  int alt2_fb_idx;  // ALTREF2_FRAME
Jingning Han's avatar
Jingning Han committed
412
  int alt_fb_idx;
413 414
  int ext_fb_idx;      // extra ref frame buffer index
  int refresh_fb_idx;  // ref frame buffer index to refresh
Jingning Han's avatar
Jingning Han committed
415

416 417
  int last_show_frame_buf_idx;  // last show frame buffer index

418
  int refresh_last_frame;
Jingning Han's avatar
Jingning Han committed
419
  int refresh_golden_frame;
420
  int refresh_bwd_ref_frame;
Zoe Liu's avatar
Zoe Liu committed
421
  int refresh_alt2_ref_frame;
Jingning Han's avatar
Jingning Han committed
422 423 424
  int refresh_alt_ref_frame;

  int ext_refresh_frame_flags_pending;
425
  int ext_refresh_last_frame;
Jingning Han's avatar
Jingning Han committed
426
  int ext_refresh_golden_frame;
427 428
  int ext_refresh_bwd_ref_frame;
  int ext_refresh_alt2_ref_frame;
Jingning Han's avatar
Jingning Han committed
429 430 431 432 433 434
  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
435
#if CONFIG_LOOP_RESTORATION
436
  YV12_BUFFER_CONFIG trial_frame_rst;
437
#endif
Jingning Han's avatar
Jingning Han committed
438 439 440 441 442 443 444 445

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

  RD_OPT rd;

  CODING_CONTEXT coding_context;

446 447 448
  int gmtype_cost[TRANS_TYPES];
  int gmparams_cost[TOTAL_REFS_PER_FRAME];

449 450 451
  int nmv_costs[NMV_CONTEXTS][2][MV_VALS];
  int nmv_costs_hp[NMV_CONTEXTS][2][MV_VALS];

Jingning Han's avatar
Jingning Han committed
452 453 454 455 456
  int64_t last_time_stamp_seen;
  int64_t last_end_time_stamp_seen;
  int64_t first_time_stamp_ever;

  RATE_CONTROL rc;
457 458 459
#if CONFIG_XIPHRC
  od_rc_state od_rc;
#endif
Jingning Han's avatar
Jingning Han committed
460 461
  double framerate;

462 463 464 465
  // 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
466

Yaowu Xu's avatar
Yaowu Xu committed
467
  struct aom_codec_pkt_list *output_pkt_list;
Jingning Han's avatar
Jingning Han committed
468 469

  MBGRAPH_FRAME_STATS mbgraph_stats[MAX_LAG_BUFFERS];
470 471
  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
472
  int ref_frame_flags;
473
  int ext_ref_frame_flags;
474 475 476
#if CONFIG_FRAME_MARKER
  RATE_FACTOR_LEVEL frame_rf_level[FRAME_BUFFERS];
#endif  // CONFIG_FRAME_MARKER
Jingning Han's avatar
Jingning Han committed
477 478 479 480 481 482 483

  SPEED_FEATURES sf;

  unsigned int max_mv_magnitude;
  int mv_step_param;

  int allow_comp_inter_inter;
484 485 486
#if CONFIG_FRAME_MARKER
  int all_one_sided_refs;
#endif  // CONFIG_FARME_MARKER
Jingning Han's avatar
Jingning Han committed
487

488
  uint8_t *segmentation_map;
489 490 491
#if CONFIG_Q_SEGMENTATION
  uint8_t *q_seg_encoding_map;  // Must be allocated and set by AQs
#endif
Jingning Han's avatar
Jingning Han committed
492 493 494 495 496

  CYCLIC_REFRESH *cyclic_refresh;
  ActiveMap active_map;

  fractional_mv_step_fp *find_fractional_mv_step;
Yaowu Xu's avatar
Yaowu Xu committed
497 498
  av1_full_search_fn_t full_search_sad;  // It is currently unused.
  av1_diamond_search_fn_t diamond_search_sad;
499
  aom_variance_fn_ptr_t fn_ptr[BLOCK_SIZES_ALL];
Jingning Han's avatar
Jingning Han committed
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
  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];

516
  int count;
Jingning Han's avatar
Jingning Han committed
517 518 519 520 521 522 523
  uint64_t total_sq_error;
  uint64_t total_samples;
  ImageStat psnr;

  double total_blockiness;
  double worst_blockiness;

524
  int bytes;
Jingning Han's avatar
Jingning Han committed
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
  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.

552 553 554 555 556 557 558
  // When resize is triggered through external control, the desired width/height
  // are stored here until use in the next frame coded. They are effective only
  // for
  // one frame and are reset after use.
  int resize_pending_width;
  int resize_pending_height;

Jingning Han's avatar
Jingning Han committed
559 560 561 562
  int frame_flags;

  search_site_config ss_cfg;

563 564 565
  int multi_arf_allowed;
  int multi_arf_enabled;
  int multi_arf_last_grp_enabled;
566 567 568 569 570 571 572 573 574

  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
575 576 577 578 579
  int resize_state;
  int resize_avg_qp;
  int resize_buffer_underflow;
  int resize_count;

Geza Lore's avatar
Geza Lore committed
580 581 582
  // VARIANCE_AQ segment map refresh
  int vaq_refresh;

Jingning Han's avatar
Jingning Han committed
583 584
  // Multi-threading
  int num_workers;
Yaowu Xu's avatar
Yaowu Xu committed
585
  AVxWorker *workers;
Jingning Han's avatar
Jingning Han committed
586
  struct EncWorkerData *tile_thr_data;
Yaowu Xu's avatar
Yaowu Xu committed
587
  AV1LfSync lf_row_sync;
588 589 590
#if CONFIG_ANS
  struct BufAnsCoder buf_ans;
#endif
591 592
  int refresh_frame_mask;
  int existing_fb_idx_to_show;
593 594 595
  int is_arf_filter_off[MAX_EXT_ARFS + 1];
  int num_extra_arfs;
  int arf_map[MAX_EXT_ARFS + 1];
596 597
  int arf_pos_in_gf[MAX_EXT_ARFS + 1];
  int arf_pos_for_ovrly[MAX_EXT_ARFS + 1];
598
  int global_motion_search_done;
599 600 601
#if CONFIG_LV_MAP
  tran_low_t *tcoeff_buf[MAX_MB_PLANE];
#endif
Zoe Liu's avatar
Zoe Liu committed
602

603 604
  int extra_arf_allowed;
  int bwd_ref_allowed;
605 606 607 608

#if CONFIG_BGSPRITE
  int bgsprite_allowed;
#endif  // CONFIG_BGSPRITE
Yaowu Xu's avatar
Yaowu Xu committed
609
} AV1_COMP;
Jingning Han's avatar
Jingning Han committed
610

Yaowu Xu's avatar
Yaowu Xu committed
611
void av1_initialize_enc(void);
Jingning Han's avatar
Jingning Han committed
612

Yaowu Xu's avatar
Yaowu Xu committed
613 614 615
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
616

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

619 620
// 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..
621
int av1_receive_raw_frame(AV1_COMP *cpi, aom_enc_frame_flags_t frame_flags,
Yaowu Xu's avatar
Yaowu Xu committed
622 623
                          YV12_BUFFER_CONFIG *sd, int64_t time_stamp,
                          int64_t end_time_stamp);
Jingning Han's avatar
Jingning Han committed
624

Yaowu Xu's avatar
Yaowu Xu committed
625 626 627
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
628

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

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

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

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

637
int av1_copy_reference_enc(AV1_COMP *cpi, int idx, YV12_BUFFER_CONFIG *sd);
Jingning Han's avatar
Jingning Han committed
638

639
int av1_set_reference_enc(AV1_COMP *cpi, int idx, YV12_BUFFER_CONFIG *sd);
Yaowu Xu's avatar
Yaowu Xu committed
640 641

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

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

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

Yaowu Xu's avatar
Yaowu Xu committed
647 648
int av1_set_internal_size(AV1_COMP *cpi, AOM_SCALING horiz_mode,
                          AOM_SCALING vert_mode);
Jingning Han's avatar
Jingning Han committed
649

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

Yaowu Xu's avatar
Yaowu Xu committed
652
static INLINE int frame_is_kf_gf_arf(const AV1_COMP *cpi) {
653
  return frame_is_intra_only(&cpi->common) || cpi->refresh_alt_ref_frame ||
Jingning Han's avatar
Jingning Han committed
654 655 656
         (cpi->refresh_golden_frame && !cpi->rc.is_src_frame_alt_ref);
}

Yaowu Xu's avatar
Yaowu Xu committed
657
static INLINE int get_ref_frame_map_idx(const AV1_COMP *cpi,
Jingning Han's avatar
Jingning Han committed
658
                                        MV_REFERENCE_FRAME ref_frame) {
659
  if (ref_frame >= LAST_FRAME && ref_frame <= LAST3_FRAME)
660 661
    return cpi->lst_fb_idxes[ref_frame - 1];
  else if (ref_frame == GOLDEN_FRAME)
Jingning Han's avatar
Jingning Han committed
662
    return cpi->gld_fb_idx;
663 664
  else if (ref_frame == BWDREF_FRAME)
    return cpi->bwd_fb_idx;
Zoe Liu's avatar
Zoe Liu committed
665 666
  else if (ref_frame == ALTREF2_FRAME)
    return cpi->alt2_fb_idx;
667
  else
Jingning Han's avatar
Jingning Han committed
668 669 670
    return cpi->alt_fb_idx;
}

671
static INLINE int get_ref_frame_buf_idx(const AV1_COMP *cpi,
672
                                        MV_REFERENCE_FRAME ref_frame) {
Yaowu Xu's avatar
Yaowu Xu committed
673
  const AV1_COMMON *const cm = &cpi->common;
Jingning Han's avatar
Jingning Han committed
674 675 676 677
  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;
}

678 679 680 681 682 683 684 685 686 687 688
#if CONFIG_HASH_ME
static INLINE hash_table *get_ref_frame_hash_map(const AV1_COMP *cpi,
                                                 MV_REFERENCE_FRAME ref_frame) {
  const AV1_COMMON *const cm = &cpi->common;
  const int buf_idx = get_ref_frame_buf_idx(cpi, ref_frame);
  return buf_idx != INVALID_IDX
             ? &cm->buffer_pool->frame_bufs[buf_idx].hash_table
             : NULL;
}
#endif

Jingning Han's avatar
Jingning Han committed
689
static INLINE YV12_BUFFER_CONFIG *get_ref_frame_buffer(
690 691
    const AV1_COMP *cpi, MV_REFERENCE_FRAME ref_frame) {
  const AV1_COMMON *const cm = &cpi->common;
Jingning Han's avatar
Jingning Han committed
692
  const int buf_idx = get_ref_frame_buf_idx(cpi, ref_frame);
693 694
  return buf_idx != INVALID_IDX ? &cm->buffer_pool->frame_bufs[buf_idx].buf
                                : NULL;
Jingning Han's avatar
Jingning Han committed
695 696
}

Yaowu Xu's avatar
Yaowu Xu committed
697
static INLINE int enc_is_ref_frame_buf(AV1_COMP *cpi, RefCntBuffer *frame_buf) {
698
  MV_REFERENCE_FRAME ref_frame;
Yaowu Xu's avatar
Yaowu Xu committed
699
  AV1_COMMON *const cm = &cpi->common;
700 701 702 703 704 705 706 707
  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);
}

708 709
static INLINE unsigned int get_token_alloc(int mb_rows, int mb_cols,
                                           int sb_size_log2) {
710
  // Calculate the maximum number of max superblocks in the image.
711 712 713
  const int shift = sb_size_log2 - 4;
  const int sb_size = 1 << sb_size_log2;
  const int sb_size_square = sb_size * sb_size;
714 715 716 717 718 719
  const int sb_rows = ALIGN_POWER_OF_TWO(mb_rows, shift) >> shift;
  const int sb_cols = ALIGN_POWER_OF_TWO(mb_cols, shift) >> shift;

  // For transform coefficients, assume 3 planes with no subsampling. 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.
720
  const int sb_coeff_toks = 3 * (sb_size_square + (sb_size_square / 16) + 1);
721 722 723 724 725

  // For palette coefficients, there can be at most one palette for each 8x8
  // block. If w, h are the width and height of the block, the palette has at
  // most 1 + h * w tokens (65 for an 8x8 block) without (see
  // cost_and_tokenize_map). At most, there can be palettes on two planes.
726
  const int sb_palette_toks = 2 * (1 + 64) * (sb_size_square / 64);
727 728

  return sb_rows * sb_cols * (sb_coeff_toks + sb_palette_toks);
Jingning Han's avatar
Jingning Han committed
729 730 731 732
}

// Get the allocated token size for a tile. It does the same calculation as in
// the frame token allocation.
733
static INLINE unsigned int allocated_tokens(TileInfo tile, int sb_size_log2) {
734 735
  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;
Jingning Han's avatar
Jingning Han committed
736

737
  return get_token_alloc(tile_mb_rows, tile_mb_cols, sb_size_log2);
Jingning Han's avatar
Jingning Han committed
738 739
}

740 741 742
#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
743

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

Yaowu Xu's avatar
Yaowu Xu committed
746
#define ALT_MIN_LAG 3
Yaowu Xu's avatar
Yaowu Xu committed
747
static INLINE int is_altref_enabled(const AV1_COMP *const cpi) {
Yaowu Xu's avatar
Yaowu Xu committed
748
  return cpi->oxcf.lag_in_frames >= ALT_MIN_LAG && cpi->oxcf.enable_auto_arf;
Jingning Han's avatar
Jingning Han committed
749 750
}

751 752
// TODO(zoeliu): To set up cpi->oxcf.enable_auto_brf
#if 0 && CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
753
static INLINE int is_bwdref_enabled(const AV1_COMP *const cpi) {
754 755 756 757
  // 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;
758
}
759
#endif  // CONFIG_EXT_REFS
760

761
static INLINE void set_ref_ptrs(const AV1_COMMON *cm, MACROBLOCKD *xd,
Jingning Han's avatar
Jingning Han committed
762 763
                                MV_REFERENCE_FRAME ref0,
                                MV_REFERENCE_FRAME ref1) {
764 765 766 767
  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
768 769
}

770
static INLINE int get_chessboard_index(int frame_index) {
Jingning Han's avatar
Jingning Han committed
771 772 773
  return frame_index & 0x1;
}

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

Yaowu Xu's avatar
Yaowu Xu committed
778
void av1_new_framerate(AV1_COMP *cpi, double framerate);
Jingning Han's avatar
Jingning Han committed
779 780 781

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

782 783 784 785 786 787 788 789 790 791 792 793
// 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++;
}

794
// Returns 1 if a frame is unscaled and 0 otherwise.
795 796 797 798 799 800 801
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
802 803
}

804 805 806 807 808 809
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
810 811
}

Yunqing Wang's avatar
Yunqing Wang committed
812 813 814 815
#ifdef __cplusplus
}  // extern "C"
#endif

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