encoder.h 23.8 KB
Newer Older
Jingning Han's avatar
Jingning Han committed
1
/*
2
 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
Jingning Han's avatar
Jingning Han committed
3
 *
4 5 6 7 8 9
 * This source code is subject to the terms of the BSD 2 Clause License and
 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
 * was not distributed with this source code in the LICENSE file, you can
 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
 * Media Patent License 1.0 was not distributed with this source code in the
 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
Jingning Han's avatar
Jingning Han committed
10 11
 */

Yaowu Xu's avatar
Yaowu Xu committed
12 13
#ifndef AV1_ENCODER_ENCODER_H_
#define AV1_ENCODER_ENCODER_H_
Jingning Han's avatar
Jingning Han committed
14 15 16

#include <stdio.h>

Yaowu Xu's avatar
Yaowu Xu committed
17 18
#include "./aom_config.h"
#include "aom/aomcx.h"
Jingning Han's avatar
Jingning Han committed
19

20 21 22 23
#include "av1/common/alloccommon.h"
#include "av1/common/entropymode.h"
#include "av1/common/thread_common.h"
#include "av1/common/onyxc_int.h"
24
#include "av1/common/resize.h"
25
#include "av1/encoder/aq_cyclicrefresh.h"
26
#if CONFIG_ANS
27
#include "aom_dsp/ans.h"
Alex Converse's avatar
Alex Converse committed
28
#include "aom_dsp/buf_ans.h"
29
#endif
30
#include "av1/encoder/av1_quantize.h"
31 32 33 34 35 36 37 38 39 40
#include "av1/encoder/context_tree.h"
#include "av1/encoder/encodemb.h"
#include "av1/encoder/firstpass.h"
#include "av1/encoder/lookahead.h"
#include "av1/encoder/mbgraph.h"
#include "av1/encoder/mcomp.h"
#include "av1/encoder/ratectrl.h"
#include "av1/encoder/rd.h"
#include "av1/encoder/speed_features.h"
#include "av1/encoder/tokenize.h"
41 42 43
#if CONFIG_XIPHRC
#include "av1/encoder/ratectrl_xiph.h"
#endif
Jingning Han's avatar
Jingning Han committed
44

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

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

typedef struct {
57 58 59 60
  int nmv_vec_cost[NMV_CONTEXTS][MV_JOINTS];
  int nmv_costs[NMV_CONTEXTS][2][MV_VALS];
  int nmv_costs_hp[NMV_CONTEXTS][2][MV_VALS];

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

  FRAME_CONTEXT fc;
} CODING_CONTEXT;

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

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

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

typedef enum {
102
  FRAMEFLAGS_KEY = 1 << 0,
Jingning Han's avatar
Jingning Han committed
103
  FRAMEFLAGS_GOLDEN = 1 << 1,
104
#if CONFIG_EXT_REFS
105
  FRAMEFLAGS_BWDREF = 1 << 2,
106
  // TODO(zoeliu): To determine whether a frame flag is needed for ALTREF2_FRAME
107
  FRAMEFLAGS_ALTREF = 1 << 3,
Zoe Liu's avatar
Zoe Liu committed
108
#else   // !CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
109
  FRAMEFLAGS_ALTREF = 1 << 2,
110
#endif  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
111 112 113 114 115 116 117
} FRAMETYPE_FLAGS;

typedef enum {
  NO_AQ = 0,
  VARIANCE_AQ = 1,
  COMPLEXITY_AQ = 2,
  CYCLIC_REFRESH_AQ = 3,
118
#if !CONFIG_EXT_DELTA_Q
119 120
  DELTA_AQ = 4,
#endif
Jingning Han's avatar
Jingning Han committed
121 122
  AQ_MODE_COUNT  // This should always be the last member of the enum
} AQ_MODE;
Fangwen Fu's avatar
Fangwen Fu committed
123 124 125 126 127 128 129 130
#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
131
typedef enum {
Yunqing Wang's avatar
Yunqing Wang committed
132
  RESIZE_NONE = 0,    // No frame resizing allowed.
133 134 135
  RESIZE_FIXED = 1,   // All frames are coded at the specified scale.
  RESIZE_RANDOM = 2,  // All frames are coded at a random scale.
  RESIZE_MODES
136
} RESIZE_MODE;
137 138
#if CONFIG_FRAME_SUPERRES
typedef enum {
139 140 141 142 143 144 145 146
  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
147 148
} SUPERRES_MODE;
#endif  // CONFIG_FRAME_SUPERRES
Jingning Han's avatar
Jingning Han committed
149

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

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

  // 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
202 203 204
#if CONFIG_EXT_DELTA_Q
  DELTAQ_MODE deltaq_mode;
#endif
205 206 207 208
#if CONFIG_AOM_QM
  int using_qm;
  int qm_minlevel;
  int qm_maxlevel;
209 210 211
#endif
#if CONFIG_DIST_8X8
  int using_dist_8x8;
212
#endif
213 214
  unsigned int num_tile_groups;
  unsigned int mtu;
Jingning Han's avatar
Jingning Han committed
215

216 217 218
#if CONFIG_TEMPMV_SIGNALING
  unsigned int disable_tempmv;
#endif
Jingning Han's avatar
Jingning Han committed
219
  // Internal frame size scaling.
220
  RESIZE_MODE resize_mode;
221 222
  uint8_t resize_scale_denominator;
  uint8_t resize_kf_scale_denominator;
Jingning Han's avatar
Jingning Han committed
223

224
#if CONFIG_FRAME_SUPERRES
225 226
  // Frame Super-Resolution size scaling.
  SUPERRES_MODE superres_mode;
227 228
  uint8_t superres_scale_denominator;
  uint8_t superres_kf_scale_denominator;
229 230
  int superres_qthresh;
  int superres_kf_qthresh;
231 232
#endif  // CONFIG_FRAME_SUPERRES

Jingning Han's avatar
Jingning Han committed
233 234 235 236
  // Enable feature to reduce the frame quantization every x frames.
  int frame_periodic_boost;

  // two pass datarate control
237
  int two_pass_vbrbias;  // two pass datarate control tweaks
Jingning Han's avatar
Jingning Han committed
238 239 240 241 242 243
  int two_pass_vbrmin_section;
  int two_pass_vbrmax_section;
  // END DATARATE CONTROL OPTIONS
  // ----------------------------------------------------------------

  int enable_auto_arf;
244
#if CONFIG_EXT_REFS
245
  int enable_auto_brf;  // (b)ackward (r)ef (f)rame
246
#endif                  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267

  /* 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;
268
#if CONFIG_MAX_TILE
269 270 271 272
  int tile_width_count;
  int tile_height_count;
  int tile_widths[MAX_TILE_COLS];
  int tile_heights[MAX_TILE_ROWS];
273
#endif
274 275 276
#if CONFIG_DEPENDENT_HORZTILES
  int dependent_horz_tiles;
#endif
277
#if CONFIG_LOOPFILTERING_ACROSS_TILES
278
  int loop_filter_across_tiles_enabled;
279
#endif  // CONFIG_LOOPFILTERING_ACROSS_TILES
Jingning Han's avatar
Jingning Han committed
280 281 282

  int max_threads;

Yaowu Xu's avatar
Yaowu Xu committed
283 284
  aom_fixed_buf_t two_pass_stats_in;
  struct aom_codec_pkt_list *output_pkt_list;
Jingning Han's avatar
Jingning Han committed
285 286

#if CONFIG_FP_MB_STATS
Yaowu Xu's avatar
Yaowu Xu committed
287
  aom_fixed_buf_t firstpass_mb_stats_in;
Jingning Han's avatar
Jingning Han committed
288 289
#endif

Yaowu Xu's avatar
Yaowu Xu committed
290 291
  aom_tune_metric tuning;
  aom_tune_content content;
292
#if CONFIG_HIGHBITDEPTH
Jingning Han's avatar
Jingning Han committed
293 294
  int use_highbitdepth;
#endif
Yaowu Xu's avatar
Yaowu Xu committed
295
  aom_color_space_t color_space;
296 297
  aom_transfer_function_t transfer_function;
  aom_chroma_sample_position_t chroma_sample_position;
298
  int color_range;
299 300
  int render_width;
  int render_height;
301 302

#if CONFIG_EXT_PARTITION
Yaowu Xu's avatar
Yaowu Xu committed
303
  aom_superblock_size_t superblock_size;
304
#endif  // CONFIG_EXT_PARTITION
305 306 307
#if CONFIG_ANS && ANS_MAX_SYMBOLS
  int ans_window_size_log2;
#endif  // CONFIG_ANS && ANS_MAX_SYMBOLS
308
#if CONFIG_EXT_TILE
309 310
  unsigned int large_scale_tile;
  unsigned int single_tile_decoding;
311
#endif  // CONFIG_EXT_TILE
Yunqing Wang's avatar
Yunqing Wang committed
312 313

  unsigned int motion_vector_unit_test;
Yaowu Xu's avatar
Yaowu Xu committed
314
} AV1EncoderConfig;
Jingning Han's avatar
Jingning Han committed
315

Yaowu Xu's avatar
Yaowu Xu committed
316
static INLINE int is_lossless_requested(const AV1EncoderConfig *cfg) {
Jingning Han's avatar
Jingning Han committed
317 318 319 320 321 322
  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;
323 324
  int thresh_freq_fact[BLOCK_SIZES_ALL][MAX_MODES];
  int mode_map[BLOCK_SIZES_ALL][MAX_MODES];
325 326
  int m_search_count;
  int ex_search_count;
327 328 329
#if CONFIG_PVQ
  PVQ_QUEUE pvq_q;
#endif
Luc Trudeau's avatar
Luc Trudeau committed
330 331 332
#if CONFIG_CFL
  CFL_CTX cfl;
#endif
333
  DECLARE_ALIGNED(16, FRAME_CONTEXT, tctx);
Jingning Han's avatar
Jingning Han committed
334 335 336 337
} TileDataEnc;

typedef struct RD_COUNTS {
  int64_t comp_pred_diff[REFERENCE_MODES];
338 339 340 341
#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
342 343
  int single_ref_used_flag;
  int compound_ref_used_flag;
Jingning Han's avatar
Jingning Han committed
344 345 346 347 348 349
} RD_COUNTS;

typedef struct ThreadData {
  MACROBLOCK mb;
  RD_COUNTS rd_counts;
  FRAME_COUNTS *counts;
350
#if !CONFIG_CB4X4
Jingning Han's avatar
Jingning Han committed
351
  PICK_MODE_CONTEXT *leaf_tree;
352
#endif
Jingning Han's avatar
Jingning Han committed
353
  PC_TREE *pc_tree;
Geza Lore's avatar
Geza Lore committed
354
  PC_TREE *pc_root[MAX_MIB_SIZE_LOG2 - MIN_MIB_SIZE_LOG2 + 1];
355 356 357 358 359 360
#if CONFIG_MOTION_VAR
  int32_t *wsrc_buf;
  int32_t *mask_buf;
  uint8_t *above_pred_buf;
  uint8_t *left_pred_buf;
#endif
361

362
  PALETTE_BUFFER *palette_buffer;
Jingning Han's avatar
Jingning Han committed
363 364 365 366 367 368 369 370 371 372
} ThreadData;

struct EncWorkerData;

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

373
#define NUM_STAT_TYPES 4  // types of stats: Y, U, V and ALL
Jingning Han's avatar
Jingning Han committed
374 375

typedef struct IMAGE_STAT {
376
  double stat[NUM_STAT_TYPES];
Jingning Han's avatar
Jingning Han committed
377 378 379
  double worst;
} ImageStat;

380 381
#undef NUM_STAT_TYPES

382 383 384 385 386
typedef struct {
  int ref_count;
  YV12_BUFFER_CONFIG buf;
} EncRefCntBuffer;

387 388 389 390 391
typedef struct TileBufferEnc {
  uint8_t *data;
  size_t size;
} TileBufferEnc;

Yaowu Xu's avatar
Yaowu Xu committed
392
typedef struct AV1_COMP {
Jingning Han's avatar
Jingning Han committed
393 394 395
  QUANTS quants;
  ThreadData td;
  MB_MODE_INFO_EXT *mbmi_ext_base;
396 397 398
#if CONFIG_LV_MAP
  CB_COEFF_BUFFER *coeff_buffer_base;
#endif
399
  Dequants dequants;
Yaowu Xu's avatar
Yaowu Xu committed
400 401
  AV1_COMMON common;
  AV1EncoderConfig oxcf;
402 403
  struct lookahead_ctx *lookahead;
  struct lookahead_entry *alt_ref_source;
Jingning Han's avatar
Jingning Han committed
404

405 406
  YV12_BUFFER_CONFIG *source;
  YV12_BUFFER_CONFIG *last_source;  // NULL for first frame and alt_ref frames
407
  YV12_BUFFER_CONFIG *unscaled_source;
Jingning Han's avatar
Jingning Han committed
408 409 410 411 412 413
  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
414 415 416 417 418 419 420 421 422
#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
423

424
  int scaled_ref_idx[TOTAL_REFS_PER_FRAME];
425
#if CONFIG_EXT_REFS
426
  int lst_fb_idxes[LAST_REF_FRAMES];
427
#else
428
  int lst_fb_idx;
429
#endif  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
430
  int gld_fb_idx;
431
#if CONFIG_EXT_REFS
432
  int bwd_fb_idx;   // BWDREF_FRAME
Zoe Liu's avatar
Zoe Liu committed
433 434
  int alt2_fb_idx;  // ALTREF2_FRAME
#endif              // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
435
  int alt_fb_idx;
436 437 438 439
#if CONFIG_EXT_REFS
  int ext_fb_idx;      // extra ref frame buffer index
  int refresh_fb_idx;  // ref frame buffer index to refresh
#endif                 // CONFIG_EXT_REFS
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
#if CONFIG_EXT_REFS
446
  int refresh_bwd_ref_frame;
Zoe Liu's avatar
Zoe Liu committed
447
  int refresh_alt2_ref_frame;
448
#endif  // CONFIG_EXT_REFS
Jingning Han's avatar
Jingning Han committed
449 450 451
  int refresh_alt_ref_frame;

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

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

  RD_OPT rd;

  CODING_CONTEXT coding_context;

474 475 476 477 478
#if CONFIG_GLOBAL_MOTION
  int gmtype_cost[TRANS_TYPES];
  int gmparams_cost[TOTAL_REFS_PER_FRAME];
#endif  // CONFIG_GLOBAL_MOTION

479 480 481
  int nmv_costs[NMV_CONTEXTS][2][MV_VALS];
  int nmv_costs_hp[NMV_CONTEXTS][2][MV_VALS];

Jingning Han's avatar
Jingning Han committed
482 483 484 485 486
  int64_t last_time_stamp_seen;
  int64_t last_end_time_stamp_seen;
  int64_t first_time_stamp_ever;

  RATE_CONTROL rc;
487 488 489
#if CONFIG_XIPHRC
  od_rc_state od_rc;
#endif
Jingning Han's avatar
Jingning Han committed
490 491
  double framerate;

492 493 494 495
  // 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
496

Yaowu Xu's avatar
Yaowu Xu committed
497
  struct aom_codec_pkt_list *output_pkt_list;
Jingning Han's avatar
Jingning Han committed
498 499

  MBGRAPH_FRAME_STATS mbgraph_stats[MAX_LAG_BUFFERS];
500 501
  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
502 503 504 505 506 507 508 509 510
  int ref_frame_flags;

  SPEED_FEATURES sf;

  unsigned int max_mv_magnitude;
  int mv_step_param;

  int allow_comp_inter_inter;

511
  uint8_t *segmentation_map;
Jingning Han's avatar
Jingning Han committed
512 513 514 515 516

  CYCLIC_REFRESH *cyclic_refresh;
  ActiveMap active_map;

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

536
  int count;
Jingning Han's avatar
Jingning Han committed
537 538 539 540 541 542 543
  uint64_t total_sq_error;
  uint64_t total_samples;
  ImageStat psnr;

  double total_blockiness;
  double worst_blockiness;

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

572 573 574 575 576 577 578
  // 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
579 580 581 582
  int frame_flags;

  search_site_config ss_cfg;

583 584 585
  int multi_arf_allowed;
  int multi_arf_enabled;
  int multi_arf_last_grp_enabled;
586 587 588 589 590 591 592 593 594

  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
595 596 597 598 599
  int resize_state;
  int resize_avg_qp;
  int resize_buffer_underflow;
  int resize_count;

Geza Lore's avatar
Geza Lore committed
600 601 602
  // VARIANCE_AQ segment map refresh
  int vaq_refresh;

Jingning Han's avatar
Jingning Han committed
603 604
  // Multi-threading
  int num_workers;
Yaowu Xu's avatar
Yaowu Xu committed
605
  AVxWorker *workers;
Jingning Han's avatar
Jingning Han committed
606
  struct EncWorkerData *tile_thr_data;
Yaowu Xu's avatar
Yaowu Xu committed
607
  AV1LfSync lf_row_sync;
608 609 610
#if CONFIG_ANS
  struct BufAnsCoder buf_ans;
#endif
611
#if CONFIG_EXT_REFS
612 613
  int refresh_frame_mask;
  int existing_fb_idx_to_show;
614 615 616
  int is_arf_filter_off[MAX_EXT_ARFS + 1];
  int num_extra_arfs;
  int arf_map[MAX_EXT_ARFS + 1];
617 618
  int arf_pos_in_gf[MAX_EXT_ARFS + 1];
  int arf_pos_for_ovrly[MAX_EXT_ARFS + 1];
619
#endif  // CONFIG_EXT_REFS
620
#if CONFIG_GLOBAL_MOTION
621
  int global_motion_search_done;
622
#endif
623 624 625
#if CONFIG_LV_MAP
  tran_low_t *tcoeff_buf[MAX_MB_PLANE];
#endif
Zoe Liu's avatar
Zoe Liu committed
626

627
#if CONFIG_EXT_REFS
628 629
  int extra_arf_allowed;
  int bwd_ref_allowed;
630
#endif  // CONFIG_EXT_REFS
631 632 633 634

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

Yaowu Xu's avatar
Yaowu Xu committed
637
void av1_initialize_enc(void);
Jingning Han's avatar
Jingning Han committed
638

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

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

645 646
// 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..
647
int av1_receive_raw_frame(AV1_COMP *cpi, aom_enc_frame_flags_t frame_flags,
Yaowu Xu's avatar
Yaowu Xu committed
648 649
                          YV12_BUFFER_CONFIG *sd, int64_t time_stamp,
                          int64_t end_time_stamp);
Jingning Han's avatar
Jingning Han committed
650

Yaowu Xu's avatar
Yaowu Xu committed
651 652 653
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
654

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

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

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

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

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

665
int av1_set_reference_enc(AV1_COMP *cpi, int idx, YV12_BUFFER_CONFIG *sd);
Yaowu Xu's avatar
Yaowu Xu committed
666 667

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

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

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

Yaowu Xu's avatar
Yaowu Xu committed
673 674
int av1_set_internal_size(AV1_COMP *cpi, AOM_SCALING horiz_mode,
                          AOM_SCALING vert_mode);
Jingning Han's avatar
Jingning Han committed
675

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

Yaowu Xu's avatar
Yaowu Xu committed
678
static INLINE int frame_is_kf_gf_arf(const AV1_COMP *cpi) {
679
  return frame_is_intra_only(&cpi->common) || cpi->refresh_alt_ref_frame ||
Jingning Han's avatar
Jingning Han committed
680 681 682
         (cpi->refresh_golden_frame && !cpi->rc.is_src_frame_alt_ref);
}

Yaowu Xu's avatar
Yaowu Xu committed
683
static INLINE int get_ref_frame_map_idx(const AV1_COMP *cpi,
Jingning Han's avatar
Jingning Han committed
684
                                        MV_REFERENCE_FRAME ref_frame) {
685
#if CONFIG_EXT_REFS
686
  if (ref_frame >= LAST_FRAME && ref_frame <= LAST3_FRAME)
687 688
    return cpi->lst_fb_idxes[ref_frame - 1];
#else
689
  if (ref_frame == LAST_FRAME) return cpi->lst_fb_idx;
690
#endif  // CONFIG_EXT_REFS
691
  else if (ref_frame == GOLDEN_FRAME)
Jingning Han's avatar
Jingning Han committed
692
    return cpi->gld_fb_idx;
693
#if CONFIG_EXT_REFS
694 695
  else if (ref_frame == BWDREF_FRAME)
    return cpi->bwd_fb_idx;
Zoe Liu's avatar
Zoe Liu committed
696 697
  else if (ref_frame == ALTREF2_FRAME)
    return cpi->alt2_fb_idx;
698
#endif  // CONFIG_EXT_REFS
699
  else
Jingning Han's avatar
Jingning Han committed
700 701 702
    return cpi->alt_fb_idx;
}

703
static INLINE int get_ref_frame_buf_idx(const AV1_COMP *cpi,
704
                                        MV_REFERENCE_FRAME ref_frame) {
Yaowu Xu's avatar
Yaowu Xu committed
705
  const AV1_COMMON *const cm = &cpi->common;
Jingning Han's avatar
Jingning Han committed
706 707 708 709
  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;
}

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

729
#if CONFIG_EXT_REFS || CONFIG_TEMPMV_SIGNALING
Yaowu Xu's avatar
Yaowu Xu committed
730
static INLINE int enc_is_ref_frame_buf(AV1_COMP *cpi, RefCntBuffer *frame_buf) {
731
  MV_REFERENCE_FRAME ref_frame;
Yaowu Xu's avatar
Yaowu Xu committed
732
  AV1_COMMON *const cm = &cpi->common;
733 734 735 736 737 738 739
  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);
}
740
#endif  // CONFIG_EXT_REFS
741

742
static INLINE unsigned int get_token_alloc(int mb_rows, int mb_cols) {
743 744 745 746
  // 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
747 748 749 750
}

// Get the allocated token size for a tile. It does the same calculation as in
// the frame token allocation.
751
static INLINE unsigned int allocated_tokens(TileInfo tile) {
752 753 754 755
#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
756 757
  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;
758
#endif
Jingning Han's avatar
Jingning Han committed
759 760 761 762

  return get_token_alloc(tile_mb_rows, tile_mb_cols);
}

763 764 765
#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
766

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

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

773 774
// TODO(zoeliu): To set up cpi->oxcf.enable_auto_brf
#if 0 && CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
775
static INLINE int is_bwdref_enabled(const AV1_COMP *const cpi) {
776 777 778 779
  // 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;
780
}
781
#endif  // CONFIG_EXT_REFS
782

783
static INLINE void set_ref_ptrs(const AV1_COMMON *cm, MACROBLOCKD *xd,
Jingning Han's avatar
Jingning Han committed
784 785
                                MV_REFERENCE_FRAME ref0,
                                MV_REFERENCE_FRAME ref1) {
786 787 788 789
  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
790 791
}

792
static INLINE int get_chessboard_index(int frame_index) {
Jingning Han's avatar
Jingning Han committed
793 794 795
  return frame_index & 0x1;
}

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

Yaowu Xu's avatar
Yaowu Xu committed
800
void av1_new_framerate(AV1_COMP *cpi, double framerate);
Jingning Han's avatar
Jingning Han committed
801 802 803

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

804 805 806 807 808 809 810 811 812 813 814 815
// 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++;
}

816
// Returns 1 if a frame is unscaled and 0 otherwise.
817 818 819 820 821 822 823
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
824 825
}

826 827 828 829 830 831
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
832 833
}

Yunqing Wang's avatar
Yunqing Wang committed
834 835 836 837
#ifdef __cplusplus
}  // extern "C"
#endif

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