encoder.h 24.1 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
#include "av1/encoder/av1_quantize.h"
27 28 29 30 31 32 33 34 35 36
#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"
Jingning Han's avatar
Jingning Han committed
37

38
#if CONFIG_INTERNAL_STATS
39
#include "aom_dsp/ssim.h"
40
#endif
41
#include "aom_dsp/variance.h"
Yaowu Xu's avatar
Yaowu Xu committed
42 43
#include "aom/internal/aom_codec_internal.h"
#include "aom_util/aom_thread.h"
44

Jingning Han's avatar
Jingning Han committed
45 46 47 48 49
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
50 51 52 53
  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
54
  // 0 = Intra, Last, GF, ARF
55
  int8_t last_ref_lf_deltas[TOTAL_REFS_PER_FRAME];
Jingning Han's avatar
Jingning Han committed
56
  // 0 = ZERO_MV, MV
57
  int8_t last_mode_lf_deltas[MAX_MODE_LF_DELTAS];
Jingning Han's avatar
Jingning Han committed
58 59 60 61

  FRAME_CONTEXT fc;
} CODING_CONTEXT;

62
#if !CONFIG_NO_FRAME_CONTEXT_SIGNALING
63 64 65 66 67 68 69 70 71 72 73
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,
74 75
  // extra alternate reference frame
  EXT_ARF_FRAME = 5
76
} FRAME_CONTEXT_INDEX;
77
#endif
78

Jingning Han's avatar
Jingning Han committed
79
typedef enum {
80 81 82 83
  NORMAL = 0,
  FOURFIVE = 1,
  THREEFIVE = 2,
  ONETWO = 3
Yaowu Xu's avatar
Yaowu Xu committed
84
} AOM_SCALING;
Jingning Han's avatar
Jingning Han committed
85 86 87 88

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
89
  GOOD
Jingning Han's avatar
Jingning Han committed
90 91 92
} MODE;

typedef enum {
93
  FRAMEFLAGS_KEY = 1 << 0,
Jingning Han's avatar
Jingning Han committed
94
  FRAMEFLAGS_GOLDEN = 1 << 1,
95
  FRAMEFLAGS_BWDREF = 1 << 2,
96
  // TODO(zoeliu): To determine whether a frame flag is needed for ALTREF2_FRAME
97
  FRAMEFLAGS_ALTREF = 1 << 3,
Jingning Han's avatar
Jingning Han committed
98 99 100 101 102 103 104
} FRAMETYPE_FLAGS;

typedef enum {
  NO_AQ = 0,
  VARIANCE_AQ = 1,
  COMPLEXITY_AQ = 2,
  CYCLIC_REFRESH_AQ = 3,
105
#if !CONFIG_EXT_DELTA_Q
106 107
  DELTA_AQ = 4,
#endif
Jingning Han's avatar
Jingning Han committed
108 109
  AQ_MODE_COUNT  // This should always be the last member of the enum
} AQ_MODE;
Fangwen Fu's avatar
Fangwen Fu committed
110 111 112 113 114 115 116 117
#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
118
typedef enum {
Yunqing Wang's avatar
Yunqing Wang committed
119
  RESIZE_NONE = 0,    // No frame resizing allowed.
120 121 122
  RESIZE_FIXED = 1,   // All frames are coded at the specified scale.
  RESIZE_RANDOM = 2,  // All frames are coded at a random scale.
  RESIZE_MODES
123
} RESIZE_MODE;
124
#if CONFIG_HORZONLY_FRAME_SUPERRES
125
typedef enum {
126 127 128 129 130 131 132 133
  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
134
} SUPERRES_MODE;
135
#endif  // CONFIG_HORZONLY_FRAME_SUPERRES
Jingning Han's avatar
Jingning Han committed
136

Yaowu Xu's avatar
Yaowu Xu committed
137
typedef struct AV1EncoderConfig {
Jingning Han's avatar
Jingning Han committed
138
  BITSTREAM_PROFILE profile;
Yaowu Xu's avatar
Yaowu Xu committed
139
  aom_bit_depth_t bit_depth;     // Codec bit-depth.
140 141
  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
142
  unsigned int input_bit_depth;  // Input bit depth.
143 144
  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
145 146

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

  // 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
190 191 192
#if CONFIG_EXT_DELTA_Q
  DELTAQ_MODE deltaq_mode;
#endif
193
  int using_cdef;
194
  int using_restoration;
195 196
#if CONFIG_AOM_QM
  int using_qm;
197 198 199 200 201
#if CONFIG_AOM_QM_EXT
  int qm_y;
  int qm_u;
  int qm_v;
#endif
202 203
  int qm_minlevel;
  int qm_maxlevel;
204 205 206
#endif
#if CONFIG_DIST_8X8
  int using_dist_8x8;
207
#endif
208 209
  unsigned int num_tile_groups;
  unsigned int mtu;
Jingning Han's avatar
Jingning Han committed
210

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

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

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

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

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

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

  int max_threads;

Yaowu Xu's avatar
Yaowu Xu committed
279 280
  aom_fixed_buf_t two_pass_stats_in;
  struct aom_codec_pkt_list *output_pkt_list;
Jingning Han's avatar
Jingning Han committed
281 282

#if CONFIG_FP_MB_STATS
Yaowu Xu's avatar
Yaowu Xu committed
283
  aom_fixed_buf_t firstpass_mb_stats_in;
Jingning Han's avatar
Jingning Han committed
284 285
#endif

Yaowu Xu's avatar
Yaowu Xu committed
286 287
  aom_tune_metric tuning;
  aom_tune_content content;
Jingning Han's avatar
Jingning Han committed
288
  int use_highbitdepth;
Andrey Norkin's avatar
Andrey Norkin committed
289 290 291 292 293
#if CONFIG_CICP
  aom_color_primaries_t color_primaries;
  aom_transfer_characteristics_t transfer_characteristics;
  aom_matrix_coefficients_t matrix_coefficients;
#else
Yaowu Xu's avatar
Yaowu Xu committed
294
  aom_color_space_t color_space;
295
  aom_transfer_function_t transfer_function;
Andrey Norkin's avatar
Andrey Norkin committed
296
#endif  // CONFIG_CICP
297
  aom_chroma_sample_position_t chroma_sample_position;
298
  int color_range;
299 300
  int render_width;
  int render_height;
301 302 303 304 305 306 307 308
#if CONFIG_TIMING_INFO_IN_SEQ_HEADERS
  aom_timing_info_t timing_info;
  int timing_info_present;
  uint32_t num_units_in_tick;
  uint32_t time_scale;
  int equal_picture_interval;
  uint32_t num_ticks_per_picture;
#endif
Andrey Norkin's avatar
Andrey Norkin committed
309 310 311
#if CONFIG_FILM_GRAIN
  int film_grain_test_vector;
#endif
312

Hui Su's avatar
Hui Su committed
313 314 315
#if CONFIG_CDF_UPDATE_MODE
  uint8_t cdf_update_mode;
#endif  // CONFIG_CDF_UPDATE_MODE
316
#if CONFIG_EXT_PARTITION
Yaowu Xu's avatar
Yaowu Xu committed
317
  aom_superblock_size_t superblock_size;
318
#endif  // CONFIG_EXT_PARTITION
319
#if CONFIG_EXT_TILE
320 321
  unsigned int large_scale_tile;
  unsigned int single_tile_decoding;
322
#endif  // CONFIG_EXT_TILE
323 324 325
#if CONFIG_MONO_VIDEO
  int monochrome;
#endif  // CONFIG_MONO_VIDEO
Yunqing Wang's avatar
Yunqing Wang committed
326 327

  unsigned int motion_vector_unit_test;
328
  const cfg_options_t *cfg;
Yaowu Xu's avatar
Yaowu Xu committed
329
} AV1EncoderConfig;
Jingning Han's avatar
Jingning Han committed
330

Yaowu Xu's avatar
Yaowu Xu committed
331
static INLINE int is_lossless_requested(const AV1EncoderConfig *cfg) {
Jingning Han's avatar
Jingning Han committed
332 333 334 335 336 337
  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;
338 339
  int thresh_freq_fact[BLOCK_SIZES_ALL][MAX_MODES];
  int mode_map[BLOCK_SIZES_ALL][MAX_MODES];
340 341
  int m_search_count;
  int ex_search_count;
Luc Trudeau's avatar
Luc Trudeau committed
342 343 344
#if CONFIG_CFL
  CFL_CTX cfl;
#endif
345
  DECLARE_ALIGNED(16, FRAME_CONTEXT, tctx);
346
  uint8_t allow_update_cdf;
Jingning Han's avatar
Jingning Han committed
347 348 349 350
} TileDataEnc;

typedef struct RD_COUNTS {
  int64_t comp_pred_diff[REFERENCE_MODES];
351 352
  // Stores number of 4x4 blocks using global motion per reference frame.
  int global_motion_used[TOTAL_REFS_PER_FRAME];
353
  int compound_ref_used_flag;
354 355 356
#if CONFIG_EXT_SKIP
  int skip_mode_used_flag;
#endif  // CONFIG_EXT_SKIP
Jingning Han's avatar
Jingning Han committed
357 358 359 360 361 362 363
} 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
364
  PC_TREE *pc_root[MAX_MIB_SIZE_LOG2 - MIN_MIB_SIZE_LOG2 + 1];
365 366 367 368
  int32_t *wsrc_buf;
  int32_t *mask_buf;
  uint8_t *above_pred_buf;
  uint8_t *left_pred_buf;
369
  PALETTE_BUFFER *palette_buffer;
370 371 372
#if CONFIG_INTRABC
  int intrabc_used_this_tile;
#endif  // CONFIG_INTRABC
Jingning Han's avatar
Jingning Han committed
373 374 375 376 377 378 379 380 381 382
} ThreadData;

struct EncWorkerData;

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

383
#define NUM_STAT_TYPES 4  // types of stats: Y, U, V and ALL
Jingning Han's avatar
Jingning Han committed
384 385

typedef struct IMAGE_STAT {
386
  double stat[NUM_STAT_TYPES];
Jingning Han's avatar
Jingning Han committed
387 388 389
  double worst;
} ImageStat;

390 391
#undef NUM_STAT_TYPES

392 393 394 395 396
typedef struct {
  int ref_count;
  YV12_BUFFER_CONFIG buf;
} EncRefCntBuffer;

397 398 399 400 401
typedef struct TileBufferEnc {
  uint8_t *data;
  size_t size;
} TileBufferEnc;

Yaowu Xu's avatar
Yaowu Xu committed
402
typedef struct AV1_COMP {
Jingning Han's avatar
Jingning Han committed
403 404 405
  QUANTS quants;
  ThreadData td;
  MB_MODE_INFO_EXT *mbmi_ext_base;
406
  CB_COEFF_BUFFER *coeff_buffer_base;
407
  Dequants dequants;
Yaowu Xu's avatar
Yaowu Xu committed
408 409
  AV1_COMMON common;
  AV1EncoderConfig oxcf;
410 411
  struct lookahead_ctx *lookahead;
  struct lookahead_entry *alt_ref_source;
Jingning Han's avatar
Jingning Han committed
412

413 414
  YV12_BUFFER_CONFIG *source;
  YV12_BUFFER_CONFIG *last_source;  // NULL for first frame and alt_ref frames
415
  YV12_BUFFER_CONFIG *unscaled_source;
Jingning Han's avatar
Jingning Han committed
416 417 418 419 420 421
  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
422 423 424 425 426 427 428 429 430
#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
431

432
  int scaled_ref_idx[TOTAL_REFS_PER_FRAME];
433
  int lst_fb_idxes[LAST_REF_FRAMES];
Jingning Han's avatar
Jingning Han committed
434
  int gld_fb_idx;
435
  int bwd_fb_idx;   // BWDREF_FRAME
Zoe Liu's avatar
Zoe Liu committed
436
  int alt2_fb_idx;  // ALTREF2_FRAME
Jingning Han's avatar
Jingning Han committed
437
  int alt_fb_idx;
438 439
  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
440

441 442
  int last_show_frame_buf_idx;  // last show frame buffer index

443
  int refresh_last_frame;
Jingning Han's avatar
Jingning Han committed
444
  int refresh_golden_frame;
445
  int refresh_bwd_ref_frame;
Zoe Liu's avatar
Zoe Liu committed
446
  int refresh_alt2_ref_frame;
Jingning Han's avatar
Jingning Han committed
447 448 449
  int refresh_alt_ref_frame;

  int ext_refresh_frame_flags_pending;
450
  int ext_refresh_last_frame;
Jingning Han's avatar
Jingning Han committed
451
  int ext_refresh_golden_frame;
452 453
  int ext_refresh_bwd_ref_frame;
  int ext_refresh_alt2_ref_frame;
Jingning Han's avatar
Jingning Han committed
454 455 456 457 458 459
  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
460
#if CONFIG_LOOP_RESTORATION
461
  YV12_BUFFER_CONFIG trial_frame_rst;
462
#endif
Jingning Han's avatar
Jingning Han committed
463 464 465 466 467 468 469 470

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

  RD_OPT rd;

  CODING_CONTEXT coding_context;

471 472 473
  int gmtype_cost[TRANS_TYPES];
  int gmparams_cost[TOTAL_REFS_PER_FRAME];

474 475 476
  int nmv_costs[NMV_CONTEXTS][2][MV_VALS];
  int nmv_costs_hp[NMV_CONTEXTS][2][MV_VALS];

Jingning Han's avatar
Jingning Han committed
477 478 479 480 481 482 483
  int64_t last_time_stamp_seen;
  int64_t last_end_time_stamp_seen;
  int64_t first_time_stamp_ever;

  RATE_CONTROL rc;
  double framerate;

484 485 486 487
  // 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
488

Yaowu Xu's avatar
Yaowu Xu committed
489
  struct aom_codec_pkt_list *output_pkt_list;
Jingning Han's avatar
Jingning Han committed
490 491

  MBGRAPH_FRAME_STATS mbgraph_stats[MAX_LAG_BUFFERS];
492 493
  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
494
  int ref_frame_flags;
495
  int ext_ref_frame_flags;
496
  RATE_FACTOR_LEVEL frame_rf_level[FRAME_BUFFERS];
Jingning Han's avatar
Jingning Han committed
497 498 499 500 501 502 503

  SPEED_FEATURES sf;

  unsigned int max_mv_magnitude;
  int mv_step_param;

  int allow_comp_inter_inter;
504
  int all_one_sided_refs;
Jingning Han's avatar
Jingning Han committed
505

506
  uint8_t *segmentation_map;
Jingning Han's avatar
Jingning Han committed
507 508 509 510 511

  CYCLIC_REFRESH *cyclic_refresh;
  ActiveMap active_map;

  fractional_mv_step_fp *find_fractional_mv_step;
Yaowu Xu's avatar
Yaowu Xu committed
512 513
  av1_full_search_fn_t full_search_sad;  // It is currently unused.
  av1_diamond_search_fn_t diamond_search_sad;
514
  aom_variance_fn_ptr_t fn_ptr[BLOCK_SIZES_ALL];
Jingning Han's avatar
Jingning Han committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
  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];

531
  int count;
Jingning Han's avatar
Jingning Han committed
532 533 534 535 536 537 538
  uint64_t total_sq_error;
  uint64_t total_samples;
  ImageStat psnr;

  double total_blockiness;
  double worst_blockiness;

539
  int bytes;
Jingning Han's avatar
Jingning Han committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
  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.

567 568 569 570 571 572 573
  // 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
574 575 576 577
  int frame_flags;

  search_site_config ss_cfg;

578 579 580
  int multi_arf_allowed;
  int multi_arf_enabled;
  int multi_arf_last_grp_enabled;
581 582 583 584 585 586 587 588 589

  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
590 591 592 593 594
  int resize_state;
  int resize_avg_qp;
  int resize_buffer_underflow;
  int resize_count;

Geza Lore's avatar
Geza Lore committed
595 596 597
  // VARIANCE_AQ segment map refresh
  int vaq_refresh;

Jingning Han's avatar
Jingning Han committed
598 599
  // Multi-threading
  int num_workers;
Yaowu Xu's avatar
Yaowu Xu committed
600
  AVxWorker *workers;
Jingning Han's avatar
Jingning Han committed
601
  struct EncWorkerData *tile_thr_data;
Yaowu Xu's avatar
Yaowu Xu committed
602
  AV1LfSync lf_row_sync;
603 604
  int refresh_frame_mask;
  int existing_fb_idx_to_show;
605 606 607
  int is_arf_filter_off[MAX_EXT_ARFS + 1];
  int num_extra_arfs;
  int arf_map[MAX_EXT_ARFS + 1];
608 609
  int arf_pos_in_gf[MAX_EXT_ARFS + 1];
  int arf_pos_for_ovrly[MAX_EXT_ARFS + 1];
610
  int global_motion_search_done;
611
  tran_low_t *tcoeff_buf[MAX_MB_PLANE];
Zoe Liu's avatar
Zoe Liu committed
612

613 614
  int extra_arf_allowed;
  int bwd_ref_allowed;
615

616 617 618
#if CONFIG_INTRABC
  // A flag to indicate if intrabc is ever used in current frame.
  int intrabc_used;
Hui Su's avatar
Hui Su committed
619 620 621
  int dv_cost[2][MV_VALS];
  // TODO(huisu@google.com): we can update dv_joint_cost per SB.
  int dv_joint_cost[MV_JOINTS];
622
#endif  // CONFIG_INTRABC
Yaowu Xu's avatar
Yaowu Xu committed
623
} AV1_COMP;
Jingning Han's avatar
Jingning Han committed
624

Yaowu Xu's avatar
Yaowu Xu committed
625
void av1_initialize_enc(void);
Jingning Han's avatar
Jingning Han committed
626

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

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

633 634
// 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..
635
int av1_receive_raw_frame(AV1_COMP *cpi, aom_enc_frame_flags_t frame_flags,
Yaowu Xu's avatar
Yaowu Xu committed
636 637
                          YV12_BUFFER_CONFIG *sd, int64_t time_stamp,
                          int64_t end_time_stamp);
Jingning Han's avatar
Jingning Han committed
638

Yaowu Xu's avatar
Yaowu Xu committed
639 640 641
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
642

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

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

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

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

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

653
int av1_set_reference_enc(AV1_COMP *cpi, int idx, YV12_BUFFER_CONFIG *sd);
Yaowu Xu's avatar
Yaowu Xu committed
654 655

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

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

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

Yaowu Xu's avatar
Yaowu Xu committed
661 662
int av1_set_internal_size(AV1_COMP *cpi, AOM_SCALING horiz_mode,
                          AOM_SCALING vert_mode);
Jingning Han's avatar
Jingning Han committed
663

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

Yaowu Xu's avatar
Yaowu Xu committed
666
static INLINE int frame_is_kf_gf_arf(const AV1_COMP *cpi) {
667
  return frame_is_intra_only(&cpi->common) || cpi->refresh_alt_ref_frame ||
Jingning Han's avatar
Jingning Han committed
668 669 670
         (cpi->refresh_golden_frame && !cpi->rc.is_src_frame_alt_ref);
}

Yaowu Xu's avatar
Yaowu Xu committed
671
static INLINE int get_ref_frame_map_idx(const AV1_COMP *cpi,
Jingning Han's avatar
Jingning Han committed
672
                                        MV_REFERENCE_FRAME ref_frame) {
673
  if (ref_frame >= LAST_FRAME && ref_frame <= LAST3_FRAME)
674 675
    return cpi->lst_fb_idxes[ref_frame - 1];
  else if (ref_frame == GOLDEN_FRAME)
Jingning Han's avatar
Jingning Han committed
676
    return cpi->gld_fb_idx;
677 678
  else if (ref_frame == BWDREF_FRAME)
    return cpi->bwd_fb_idx;
Zoe Liu's avatar
Zoe Liu committed
679 680
  else if (ref_frame == ALTREF2_FRAME)
    return cpi->alt2_fb_idx;
681
  else
Jingning Han's avatar
Jingning Han committed
682 683 684
    return cpi->alt_fb_idx;
}

685
static INLINE int get_ref_frame_buf_idx(const AV1_COMP *cpi,
686
                                        MV_REFERENCE_FRAME ref_frame) {
Yaowu Xu's avatar
Yaowu Xu committed
687
  const AV1_COMMON *const cm = &cpi->common;
Jingning Han's avatar
Jingning Han committed
688 689 690 691
  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;
}

692 693 694 695 696 697 698 699 700 701 702
#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
703
static INLINE YV12_BUFFER_CONFIG *get_ref_frame_buffer(
704 705
    const AV1_COMP *cpi, MV_REFERENCE_FRAME ref_frame) {
  const AV1_COMMON *const cm = &cpi->common;
Jingning Han's avatar
Jingning Han committed
706
  const int buf_idx = get_ref_frame_buf_idx(cpi, ref_frame);
707 708
  return buf_idx != INVALID_IDX ? &cm->buffer_pool->frame_bufs[buf_idx].buf
                                : NULL;
Jingning Han's avatar
Jingning Han committed
709 710
}

Yaowu Xu's avatar
Yaowu Xu committed
711
static INLINE int enc_is_ref_frame_buf(AV1_COMP *cpi, RefCntBuffer *frame_buf) {
712
  MV_REFERENCE_FRAME ref_frame;
Yaowu Xu's avatar
Yaowu Xu committed
713
  AV1_COMMON *const cm = &cpi->common;
714 715 716 717 718 719 720 721
  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);
}

722
static INLINE unsigned int get_token_alloc(int mb_rows, int mb_cols,
723 724
                                           int sb_size_log2,
                                           const int num_planes) {
725
  // Calculate the maximum number of max superblocks in the image.
726 727 728
  const int shift = sb_size_log2 - 4;
  const int sb_size = 1 << sb_size_log2;
  const int sb_size_square = sb_size * sb_size;
729 730 731
  const int sb_rows = ALIGN_POWER_OF_TWO(mb_rows, shift) >> shift;
  const int sb_cols = ALIGN_POWER_OF_TWO(mb_cols, shift) >> shift;

732
  // For transform coefficients, assume planes with no subsampling. We assume
733 734
  // 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.
735 736
  const int sb_coeff_toks =
      num_planes * (sb_size_square + (sb_size_square / 16) + 1);
737 738 739 740 741

  // 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.
742
  const int sb_palette_toks = 2 * (1 + 64) * (sb_size_square / 64);
743 744

  return sb_rows * sb_cols * (sb_coeff_toks + sb_palette_toks);
Jingning Han's avatar
Jingning Han committed
745 746 747 748
}

// Get the allocated token size for a tile. It does the same calculation as in
// the frame token allocation.
749 750
static INLINE unsigned int allocated_tokens(TileInfo tile, int sb_size_log2,
                                            int num_planes) {
751 752
  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
753

754
  return get_token_alloc(tile_mb_rows, tile_mb_cols, sb_size_log2, num_planes);
Jingning Han's avatar
Jingning Han committed
755 756
}

757
void av1_set_temporal_mv_prediction(AV1_COMP *cpi, int allow_tempmv_prediction);
Jingning Han's avatar
Jingning Han committed
758

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

Yaowu Xu's avatar
Yaowu Xu committed
761
#define ALT_MIN_LAG 3
Yaowu Xu's avatar
Yaowu Xu committed
762
static INLINE int is_altref_enabled(const AV1_COMP *const cpi) {
Yaowu Xu's avatar
Yaowu Xu committed
763
  return cpi->oxcf.lag_in_frames >= ALT_MIN_LAG && cpi->oxcf.enable_auto_arf;
Jingning Han's avatar
Jingning Han committed
764 765
}

766
// TODO(zoeliu): To set up cpi->oxcf.enable_auto_brf
767

768
static INLINE void set_ref_ptrs(const AV1_COMMON *cm, MACROBLOCKD *xd,
Jingning Han's avatar
Jingning Han committed
769 770
                                MV_REFERENCE_FRAME ref0,
                                MV_REFERENCE_FRAME ref1) {
771 772 773 774
  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
775 776
}

777
static INLINE int get_chessboard_index(int frame_index) {
Jingning Han's avatar
Jingning Han committed
778 779 780
  return frame_index & 0x1;
}

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

Yaowu Xu's avatar
Yaowu Xu committed
785
void av1_new_framerate(AV1_COMP *cpi, double framerate);
Jingning Han's avatar
Jingning Han committed
786 787 788

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

789 790 791 792 793 794 795 796 797 798 799 800
// 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++;
}

801
// Returns 1 if a frame is unscaled and 0 otherwise.
802
static INLINE int av1_resize_unscaled(const AV1_COMMON *cm) {
803
#if CONFIG_HORZONLY_FRAME_SUPERRES
804 805 806 807
  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;
808
#endif  // CONFIG_HORZONLY_FRAME_SUPERRES
809 810
}

811
static INLINE int av1_frame_unscaled(const AV1_COMMON *cm) {
812
#if CONFIG_HORZONLY_FRAME_SUPERRES
813 814 815
  return av1_superres_unscaled(cm) && av1_resize_unscaled(cm);
#else
  return av1_resize_unscaled(cm);
816
#endif  // CONFIG_HORZONLY_FRAME_SUPERRES
817 818
}

Yunqing Wang's avatar
Yunqing Wang committed
819 820 821 822
#ifdef __cplusplus
}  // extern "C"
#endif

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