encoder.h 22.6 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
#ifdef __cplusplus
extern "C" {
#endif

Zoe Liu's avatar
Zoe Liu committed
56 57 58 59
#if CONFIG_SPEED_REFS
#define MIN_SPEED_REFS_BLKSIZE BLOCK_16X16
#endif  // CONFIG_SPEED_REFS

Jingning Han's avatar
Jingning Han committed
60
typedef struct {
61 62 63 64
  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
65
  // 0 = Intra, Last, GF, ARF
66
  signed char last_ref_lf_deltas[TOTAL_REFS_PER_FRAME];
Jingning Han's avatar
Jingning Han committed
67 68 69 70 71 72
  // 0 = ZERO_MV, MV
  signed char last_mode_lf_deltas[MAX_MODE_LF_DELTAS];

  FRAME_CONTEXT fc;
} CODING_CONTEXT;

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

Jingning Han's avatar
Jingning Han committed
90
typedef enum {
91 92 93 94
  NORMAL = 0,
  FOURFIVE = 1,
  THREEFIVE = 2,
  ONETWO = 3
Yaowu Xu's avatar
Yaowu Xu committed
95
} AOM_SCALING;
Jingning Han's avatar
Jingning Han committed
96 97 98 99

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
100
  GOOD
Jingning Han's avatar
Jingning Han committed
101 102 103
} MODE;

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

typedef enum {
  NO_AQ = 0,
  VARIANCE_AQ = 1,
  COMPLEXITY_AQ = 2,
  CYCLIC_REFRESH_AQ = 3,
Fangwen Fu's avatar
Fangwen Fu committed
119
#if CONFIG_DELTA_Q && !CONFIG_EXT_DELTA_Q
120 121
  DELTA_AQ = 4,
#endif
Jingning Han's avatar
Jingning Han committed
122 123
  AQ_MODE_COUNT  // This should always be the last member of the enum
} AQ_MODE;
Fangwen Fu's avatar
Fangwen Fu committed
124 125 126 127 128 129 130 131
#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
132
typedef enum {
Yunqing Wang's avatar
Yunqing Wang committed
133
  RESIZE_NONE = 0,    // No frame resizing allowed.
Jingning Han's avatar
Jingning Han committed
134 135
  RESIZE_FIXED = 1,   // All frames are coded at the specified dimension.
  RESIZE_DYNAMIC = 2  // Coded size of each frame is determined by the codec.
136
} RESIZE_MODE;
137 138 139 140 141 142 143
#if CONFIG_FRAME_SUPERRES
typedef enum {
  SUPERRES_NONE = 0,
  SUPERRES_FIXED = 1,
  SUPERRES_DYNAMIC = 2
} SUPERRES_MODE;
#endif  // CONFIG_FRAME_SUPERRES
Jingning Han's avatar
Jingning Han committed
144

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

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

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

208 209 210
#if CONFIG_TEMPMV_SIGNALING
  unsigned int disable_tempmv;
#endif
Jingning Han's avatar
Jingning Han committed
211
  // Internal frame size scaling.
212 213
  RESIZE_MODE resize_mode;
  uint8_t resize_scale_numerator;
214
  uint8_t resize_kf_scale_numerator;
Jingning Han's avatar
Jingning Han committed
215

216
#if CONFIG_FRAME_SUPERRES
217 218 219
  // Frame Super-Resolution size scaling.
  SUPERRES_MODE superres_mode;
  uint8_t superres_scale_numerator;
220
  uint8_t superres_kf_scale_numerator;
221 222
#endif  // CONFIG_FRAME_SUPERRES

Jingning Han's avatar
Jingning Han committed
223 224 225 226
  // Enable feature to reduce the frame quantization every x frames.
  int frame_periodic_boost;

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

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

  /* 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;
258 259 260
#if CONFIG_DEPENDENT_HORZTILES
  int dependent_horz_tiles;
#endif
261
#if CONFIG_LOOPFILTERING_ACROSS_TILES
262
  int loop_filter_across_tiles_enabled;
263
#endif  // CONFIG_LOOPFILTERING_ACROSS_TILES
Jingning Han's avatar
Jingning Han committed
264 265 266

  int max_threads;

Yaowu Xu's avatar
Yaowu Xu committed
267 268
  aom_fixed_buf_t two_pass_stats_in;
  struct aom_codec_pkt_list *output_pkt_list;
Jingning Han's avatar
Jingning Han committed
269 270

#if CONFIG_FP_MB_STATS
Yaowu Xu's avatar
Yaowu Xu committed
271
  aom_fixed_buf_t firstpass_mb_stats_in;
Jingning Han's avatar
Jingning Han committed
272 273
#endif

Yaowu Xu's avatar
Yaowu Xu committed
274 275
  aom_tune_metric tuning;
  aom_tune_content content;
276
#if CONFIG_HIGHBITDEPTH
Jingning Han's avatar
Jingning Han committed
277 278
  int use_highbitdepth;
#endif
Yaowu Xu's avatar
Yaowu Xu committed
279
  aom_color_space_t color_space;
280 281 282 283
#if CONFIG_COLORSPACE_HEADERS
  aom_transfer_function_t transfer_function;
  aom_chroma_sample_position_t chroma_sample_position;
#endif
284
  int color_range;
285 286
  int render_width;
  int render_height;
287 288

#if CONFIG_EXT_PARTITION
Yaowu Xu's avatar
Yaowu Xu committed
289
  aom_superblock_size_t superblock_size;
290
#endif  // CONFIG_EXT_PARTITION
291 292 293
#if CONFIG_ANS && ANS_MAX_SYMBOLS
  int ans_window_size_log2;
#endif  // CONFIG_ANS && ANS_MAX_SYMBOLS
294
#if CONFIG_EXT_TILE
295 296
  unsigned int large_scale_tile;
  unsigned int single_tile_decoding;
297
#endif  // CONFIG_EXT_TILE
Yunqing Wang's avatar
Yunqing Wang committed
298 299

  unsigned int motion_vector_unit_test;
Yaowu Xu's avatar
Yaowu Xu committed
300
} AV1EncoderConfig;
Jingning Han's avatar
Jingning Han committed
301

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

typedef struct RD_COUNTS {
Yaowu Xu's avatar
Yaowu Xu committed
323
  av1_coeff_count coef_counts[TX_SIZES][PLANE_TYPES];
Jingning Han's avatar
Jingning Han committed
324
  int64_t comp_pred_diff[REFERENCE_MODES];
325 326 327 328
#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
329 330
  int single_ref_used_flag;
  int compound_ref_used_flag;
Jingning Han's avatar
Jingning Han committed
331 332 333 334 335 336 337 338 339
} 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
340
  PC_TREE *pc_root[MAX_MIB_SIZE_LOG2 - MIN_MIB_SIZE_LOG2 + 1];
341 342 343 344 345 346
#if CONFIG_MOTION_VAR
  int32_t *wsrc_buf;
  int32_t *mask_buf;
  uint8_t *above_pred_buf;
  uint8_t *left_pred_buf;
#endif
347

348 349 350
#if CONFIG_PALETTE
  PALETTE_BUFFER *palette_buffer;
#endif  // CONFIG_PALETTE
Jingning Han's avatar
Jingning Han committed
351 352 353 354 355 356 357 358 359 360
} ThreadData;

struct EncWorkerData;

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

361
#define NUM_STAT_TYPES 4  // types of stats: Y, U, V and ALL
Jingning Han's avatar
Jingning Han committed
362 363

typedef struct IMAGE_STAT {
364
  double stat[NUM_STAT_TYPES];
Jingning Han's avatar
Jingning Han committed
365 366 367
  double worst;
} ImageStat;

368 369
#undef NUM_STAT_TYPES

370 371 372 373 374
typedef struct {
  int ref_count;
  YV12_BUFFER_CONFIG buf;
} EncRefCntBuffer;

375 376 377 378 379
typedef struct TileBufferEnc {
  uint8_t *data;
  size_t size;
} TileBufferEnc;

Yaowu Xu's avatar
Yaowu Xu committed
380
typedef struct AV1_COMP {
Jingning Han's avatar
Jingning Han committed
381 382 383
  QUANTS quants;
  ThreadData td;
  MB_MODE_INFO_EXT *mbmi_ext_base;
384
  Dequants dequants;
Yaowu Xu's avatar
Yaowu Xu committed
385 386
  AV1_COMMON common;
  AV1EncoderConfig oxcf;
387 388
  struct lookahead_ctx *lookahead;
  struct lookahead_entry *alt_ref_source;
Jingning Han's avatar
Jingning Han committed
389

390 391
  YV12_BUFFER_CONFIG *source;
  YV12_BUFFER_CONFIG *last_source;  // NULL for first frame and alt_ref frames
392
  YV12_BUFFER_CONFIG *unscaled_source;
Jingning Han's avatar
Jingning Han committed
393 394 395 396 397 398 399
  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;

400
  int scaled_ref_idx[TOTAL_REFS_PER_FRAME];
401
#if CONFIG_EXT_REFS
402
  int lst_fb_idxes[LAST_REF_FRAMES];
403
#else
404
  int lst_fb_idx;
405
#endif  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
406
  int gld_fb_idx;
407
#if CONFIG_EXT_REFS
408
  int bwd_fb_idx;  // BWD_REF_FRAME
409
#endif             // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
410 411
  int alt_fb_idx;

412 413
  int last_show_frame_buf_idx;  // last show frame buffer index

414
  int refresh_last_frame;
Jingning Han's avatar
Jingning Han committed
415
  int refresh_golden_frame;
416
#if CONFIG_EXT_REFS
417
  int refresh_bwd_ref_frame;
418
#endif  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
419 420 421
  int refresh_alt_ref_frame;

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

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

  RD_OPT rd;

  CODING_CONTEXT coding_context;

444 445 446 447 448
#if CONFIG_GLOBAL_MOTION
  int gmtype_cost[TRANS_TYPES];
  int gmparams_cost[TOTAL_REFS_PER_FRAME];
#endif  // CONFIG_GLOBAL_MOTION

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

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 473 474 475 476 477 478 479 480
  int ref_frame_flags;

  SPEED_FEATURES sf;

  unsigned int max_mv_magnitude;
  int mv_step_param;

  int allow_comp_inter_inter;

481
  uint8_t *segmentation_map;
Jingning Han's avatar
Jingning Han committed
482 483 484 485 486

  CYCLIC_REFRESH *cyclic_refresh;
  ActiveMap active_map;

  fractional_mv_step_fp *find_fractional_mv_step;
Yaowu Xu's avatar
Yaowu Xu committed
487 488
  av1_full_search_fn_t full_search_sad;  // It is currently unused.
  av1_diamond_search_fn_t diamond_search_sad;
489
  aom_variance_fn_ptr_t fn_ptr[BLOCK_SIZES_ALL];
Jingning Han's avatar
Jingning Han committed
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
  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];

506
  int count;
Jingning Han's avatar
Jingning Han committed
507 508 509 510 511 512 513
  uint64_t total_sq_error;
  uint64_t total_samples;
  ImageStat psnr;

  double total_blockiness;
  double worst_blockiness;

514
  int bytes;
Jingning Han's avatar
Jingning Han committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
  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;

546 547 548
  int multi_arf_allowed;
  int multi_arf_enabled;
  int multi_arf_last_grp_enabled;
549 550 551 552 553 554 555 556 557

  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
558 559 560 561 562
  int resize_state;
  int resize_avg_qp;
  int resize_buffer_underflow;
  int resize_count;

Geza Lore's avatar
Geza Lore committed
563 564 565
  // VARIANCE_AQ segment map refresh
  int vaq_refresh;

Jingning Han's avatar
Jingning Han committed
566 567
  // Multi-threading
  int num_workers;
Yaowu Xu's avatar
Yaowu Xu committed
568
  AVxWorker *workers;
Jingning Han's avatar
Jingning Han committed
569
  struct EncWorkerData *tile_thr_data;
Yaowu Xu's avatar
Yaowu Xu committed
570
  AV1LfSync lf_row_sync;
571 572 573
#if CONFIG_ANS
  struct BufAnsCoder buf_ans;
#endif
574
#if CONFIG_EXT_REFS
575 576
  int refresh_frame_mask;
  int existing_fb_idx_to_show;
577 578 579
  int is_arf_filter_off[MAX_EXT_ARFS + 1];
  int num_extra_arfs;
  int arf_map[MAX_EXT_ARFS + 1];
580
#endif  // CONFIG_EXT_REFS
581
#if CONFIG_GLOBAL_MOTION
582
  int global_motion_search_done;
583
#endif
584 585 586
#if CONFIG_REFERENCE_BUFFER
  SequenceHeader seq_params;
#endif
587 588 589
#if CONFIG_LV_MAP
  tran_low_t *tcoeff_buf[MAX_MB_PLANE];
#endif
Zoe Liu's avatar
Zoe Liu committed
590 591 592 593

#if CONFIG_SPEED_REFS
  int sb_scanning_pass_idx;
#endif  // CONFIG_SPEED_REFS
594 595 596 597 598

#if CONFIG_FLEX_REFS
  int extra_arf_allowed;
  int bwd_ref_allowed;
#endif  // CONFIG_FLEX_REFS
Yaowu Xu's avatar
Yaowu Xu committed
599
} AV1_COMP;
Jingning Han's avatar
Jingning Han committed
600

Yaowu Xu's avatar
Yaowu Xu committed
601
void av1_initialize_enc(void);
Jingning Han's avatar
Jingning Han committed
602

Yaowu Xu's avatar
Yaowu Xu committed
603 604 605
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
606

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

609 610
// 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..
611
int av1_receive_raw_frame(AV1_COMP *cpi, aom_enc_frame_flags_t frame_flags,
Yaowu Xu's avatar
Yaowu Xu committed
612 613
                          YV12_BUFFER_CONFIG *sd, int64_t time_stamp,
                          int64_t end_time_stamp);
Jingning Han's avatar
Jingning Han committed
614

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

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

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

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

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

Yaowu Xu's avatar
Yaowu Xu committed
627
int av1_copy_reference_enc(AV1_COMP *cpi, AOM_REFFRAME ref_frame_flag,
628
                           YV12_BUFFER_CONFIG *sd);
Jingning Han's avatar
Jingning Han committed
629

Yaowu Xu's avatar
Yaowu Xu committed
630 631 632 633
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
634

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

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

Yaowu Xu's avatar
Yaowu Xu committed
639 640
int av1_set_internal_size(AV1_COMP *cpi, AOM_SCALING horiz_mode,
                          AOM_SCALING vert_mode);
Jingning Han's avatar
Jingning Han committed
641

642 643
// 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
644

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

Yaowu Xu's avatar
Yaowu Xu committed
647 648
void av1_full_to_model_counts(av1_coeff_count_model *model_count,
                              av1_coeff_count *full_count);
hui su's avatar
hui su committed
649

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

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

673
static INLINE int get_ref_frame_buf_idx(const AV1_COMP *cpi,
674
                                        MV_REFERENCE_FRAME ref_frame) {
Yaowu Xu's avatar
Yaowu Xu committed
675
  const AV1_COMMON *const cm = &cpi->common;
Jingning Han's avatar
Jingning Han committed
676 677 678 679 680
  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(
681 682
    const AV1_COMP *cpi, MV_REFERENCE_FRAME ref_frame) {
  const AV1_COMMON *const cm = &cpi->common;
Jingning Han's avatar
Jingning Han committed
683
  const int buf_idx = get_ref_frame_buf_idx(cpi, ref_frame);
684 685
  return buf_idx != INVALID_IDX ? &cm->buffer_pool->frame_bufs[buf_idx].buf
                                : NULL;
Jingning Han's avatar
Jingning Han committed
686 687
}

688
#if CONFIG_EXT_REFS || CONFIG_TEMPMV_SIGNALING
Yaowu Xu's avatar
Yaowu Xu committed
689
static INLINE int enc_is_ref_frame_buf(AV1_COMP *cpi, RefCntBuffer *frame_buf) {
690
  MV_REFERENCE_FRAME ref_frame;
Yaowu Xu's avatar
Yaowu Xu committed
691
  AV1_COMMON *const cm = &cpi->common;
692 693 694 695 696 697 698
  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);
}
699
#endif  // CONFIG_EXT_REFS
700

701
static INLINE unsigned int get_token_alloc(int mb_rows, int mb_cols) {
702 703 704 705
  // 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
706 707 708 709
}

// Get the allocated token size for a tile. It does the same calculation as in
// the frame token allocation.
710
static INLINE unsigned int allocated_tokens(TileInfo tile) {
711 712 713 714
#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
715 716
  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;
717
#endif
Jingning Han's avatar
Jingning Han committed
718 719 720 721

  return get_token_alloc(tile_mb_rows, tile_mb_cols);
}

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

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

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

Yaowu Xu's avatar
Yaowu Xu committed
728
void av1_set_high_precision_mv(AV1_COMP *cpi, int allow_high_precision_mv);
729 730 731
#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
732

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

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

739 740
// TODO(zoeliu): To set up cpi->oxcf.enable_auto_brf
#if 0 && CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
741
static INLINE int is_bwdref_enabled(const AV1_COMP *const cpi) {
742 743 744 745
  // 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;
746
}
747
#endif  // CONFIG_EXT_REFS
748

749
static INLINE void set_ref_ptrs(const AV1_COMMON *cm, MACROBLOCKD *xd,
Jingning Han's avatar
Jingning Han committed
750 751
                                MV_REFERENCE_FRAME ref0,
                                MV_REFERENCE_FRAME ref1) {
752 753 754 755
  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
756 757
}

758
static INLINE int get_chessboard_index(int frame_index) {
Jingning Han's avatar
Jingning Han committed
759 760 761
  return frame_index & 0x1;
}

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

Yaowu Xu's avatar
Yaowu Xu committed
766
void av1_new_framerate(AV1_COMP *cpi, double framerate);
Jingning Han's avatar
Jingning Han committed
767 768 769

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

770 771 772 773 774 775 776 777 778 779 780 781
// 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++;
}

782
// Returns 1 if a frame is unscaled and 0 otherwise.
783 784 785 786 787 788 789
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
790 791
}

792 793 794 795 796 797
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
798 799
}

Yunqing Wang's avatar
Yunqing Wang committed
800 801 802 803
#ifdef __cplusplus
}  // extern "C"
#endif

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