encoder.h 22.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
#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
#if !CONFIG_NO_FRAME_CONTEXT_SIGNALING
74 75 76 77 78 79 80 81 82 83 84 85
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,
86 87
  // extra alternate reference frame
  EXT_ARF_FRAME = 5
88 89
#endif
} FRAME_CONTEXT_INDEX;
90
#endif
91

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

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

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

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

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

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

  // 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
199 200 201
#if CONFIG_EXT_DELTA_Q
  DELTAQ_MODE deltaq_mode;
#endif
202 203 204 205 206
#if CONFIG_AOM_QM
  int using_qm;
  int qm_minlevel;
  int qm_maxlevel;
#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 215
  RESIZE_MODE resize_mode;
  uint8_t resize_scale_numerator;
216
  uint8_t resize_kf_scale_numerator;
Jingning Han's avatar
Jingning Han committed
217

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

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

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

  int enable_auto_arf;
236
#if CONFIG_EXT_REFS
237
  int enable_auto_brf;  // (b)ackward (r)ef (f)rame
238
#endif                  // CONFIG_EXT_REFS
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 261 262
#if CONFIG_DEPENDENT_HORZTILES
  int dependent_horz_tiles;
#endif
263
#if CONFIG_LOOPFILTERING_ACROSS_TILES
264
  int loop_filter_across_tiles_enabled;
265
#endif  // CONFIG_LOOPFILTERING_ACROSS_TILES
Jingning Han's avatar
Jingning Han committed
266 267 268

  int max_threads;

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

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

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

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

  unsigned int motion_vector_unit_test;
Yaowu Xu's avatar
Yaowu Xu committed
302
} AV1EncoderConfig;
Jingning Han's avatar
Jingning Han committed
303

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

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

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

struct EncWorkerData;

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

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

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

370 371
#undef NUM_STAT_TYPES

372 373 374 375 376
typedef struct {
  int ref_count;
  YV12_BUFFER_CONFIG buf;
} EncRefCntBuffer;

377 378 379 380 381
typedef struct TileBufferEnc {
  uint8_t *data;
  size_t size;
} TileBufferEnc;

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

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

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

414 415
  int last_show_frame_buf_idx;  // last show frame buffer index

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

  int ext_refresh_frame_flags_pending;
424
  int ext_refresh_last_frame;
Jingning Han's avatar
Jingning Han committed
425 426 427 428 429 430 431
  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
432 433
#if CONFIG_LOOP_RESTORATION
  YV12_BUFFER_CONFIG last_frame_db;
434
  YV12_BUFFER_CONFIG trial_frame_rst;
435 436 437
  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
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 449 450
#if CONFIG_GLOBAL_MOTION
  int gmtype_cost[TRANS_TYPES];
  int gmparams_cost[TOTAL_REFS_PER_FRAME];
#endif  // CONFIG_GLOBAL_MOTION

451 452
  int nmv_costs[NMV_CONTEXTS][2][MV_VALS];
  int nmv_costs_hp[NMV_CONTEXTS][2][MV_VALS];
453

Jingning Han's avatar
Jingning Han committed
454 455 456 457 458
  int64_t last_time_stamp_seen;
  int64_t last_end_time_stamp_seen;
  int64_t first_time_stamp_ever;

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

464 465 466 467
  // 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
468

Yaowu Xu's avatar
Yaowu Xu committed
469
  struct aom_codec_pkt_list *output_pkt_list;
Jingning Han's avatar
Jingning Han committed
470 471

  MBGRAPH_FRAME_STATS mbgraph_stats[MAX_LAG_BUFFERS];
472 473
  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
474 475 476 477 478 479 480 481 482
  int ref_frame_flags;

  SPEED_FEATURES sf;

  unsigned int max_mv_magnitude;
  int mv_step_param;

  int allow_comp_inter_inter;

483
  uint8_t *segmentation_map;
Jingning Han's avatar
Jingning Han committed
484 485 486 487 488

  CYCLIC_REFRESH *cyclic_refresh;
  ActiveMap active_map;

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

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

  double total_blockiness;
  double worst_blockiness;

516
  int bytes;
Jingning Han's avatar
Jingning Han committed
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 546 547
  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;

548 549 550
  int multi_arf_allowed;
  int multi_arf_enabled;
  int multi_arf_last_grp_enabled;
551 552 553 554 555 556 557 558 559

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

Geza Lore's avatar
Geza Lore committed
565 566 567
  // VARIANCE_AQ segment map refresh
  int vaq_refresh;

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

#if CONFIG_SPEED_REFS
  int sb_scanning_pass_idx;
#endif  // CONFIG_SPEED_REFS
596 597 598 599 600

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

Yaowu Xu's avatar
Yaowu Xu committed
603
void av1_initialize_enc(void);
Jingning Han's avatar
Jingning Han committed
604

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

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

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

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

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

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

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

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

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

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

Yaowu Xu's avatar
Yaowu Xu committed
637
int av1_set_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
int av1_get_active_map(AV1_COMP *cpi, unsigned char *map, int rows, int cols);
Jingning Han's avatar
Jingning Han committed
640

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

644 645
// 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
646

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

Yaowu Xu's avatar
Yaowu Xu committed
649 650
void av1_full_to_model_counts(av1_coeff_count_model *model_count,
                              av1_coeff_count *full_count);
hui su's avatar
hui su 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 CONFIG_EXT_REFS
660
  if (ref_frame >= LAST_FRAME && ref_frame <= LAST3_FRAME)
661 662
    return cpi->lst_fb_idxes[ref_frame - 1];
#else
663
  if (ref_frame == LAST_FRAME) return cpi->lst_fb_idx;
664
#endif  // CONFIG_EXT_REFS
665
  else if (ref_frame == GOLDEN_FRAME)
Jingning Han's avatar
Jingning Han committed
666
    return cpi->gld_fb_idx;
667
#if CONFIG_EXT_REFS
668 669
  else if (ref_frame == BWDREF_FRAME)
    return cpi->bwd_fb_idx;
670
#endif  // CONFIG_EXT_REFS
671
  else
Jingning Han's avatar
Jingning Han committed
672 673 674
    return cpi->alt_fb_idx;
}

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

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

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

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

  return get_token_alloc(tile_mb_rows, tile_mb_cols);
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

794 795 796 797 798 799
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
800 801
}

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

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