enums.h 20.3 KB
Newer Older
Jingning Han's avatar
Jingning Han committed
1
/*
Yaowu Xu's avatar
Yaowu Xu committed
2
 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
Jingning Han's avatar
Jingning Han committed
3
 *
Yaowu Xu's avatar
Yaowu Xu committed
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_COMMON_ENUMS_H_
#define AV1_COMMON_ENUMS_H_
Jingning Han's avatar
Jingning Han committed
14

Yaowu Xu's avatar
Yaowu Xu committed
15
#include "./aom_config.h"
16
#include "aom/aom_codec.h"
Yaowu Xu's avatar
Yaowu Xu committed
17
#include "aom/aom_integer.h"
Jingning Han's avatar
Jingning Han committed
18 19 20 21 22

#ifdef __cplusplus
extern "C" {
#endif

23 24
#undef MAX_SB_SIZE

25 26
#if CONFIG_NCOBMC_ADAPT_WEIGHT
#define TWO_MODE
27 28 29 30 31
#endif

#if CONFIG_NCOBMC || CONFIG_NCOBMC_ADAPT_WEIGHT
#define NC_MODE_INFO 1
#else
32
#define NC_MODE_INFO 0
33 34
#endif

Geza Lore's avatar
Geza Lore committed
35
// Max superblock size
36
#if CONFIG_EXT_PARTITION
clang-format's avatar
clang-format committed
37
#define MAX_SB_SIZE_LOG2 7
38
#else
clang-format's avatar
clang-format committed
39
#define MAX_SB_SIZE_LOG2 6
40
#endif  // CONFIG_EXT_PARTITION
clang-format's avatar
clang-format committed
41
#define MAX_SB_SIZE (1 << MAX_SB_SIZE_LOG2)
42
#define MAX_SB_SQUARE (MAX_SB_SIZE * MAX_SB_SIZE)
Jingning Han's avatar
Jingning Han committed
43

Geza Lore's avatar
Geza Lore committed
44 45 46
// Min superblock size
#define MIN_SB_SIZE_LOG2 6

47
// Pixels per Mode Info (MI) unit
48 49 50
#if CONFIG_CB4X4
#define MI_SIZE_LOG2 2
#else
clang-format's avatar
clang-format committed
51
#define MI_SIZE_LOG2 3
52
#endif
clang-format's avatar
clang-format committed
53
#define MI_SIZE (1 << MI_SIZE_LOG2)
54

55 56
// MI-units per max superblock (MI Block - MIB)
#define MAX_MIB_SIZE_LOG2 (MAX_SB_SIZE_LOG2 - MI_SIZE_LOG2)
clang-format's avatar
clang-format committed
57
#define MAX_MIB_SIZE (1 << MAX_MIB_SIZE_LOG2)
Jingning Han's avatar
Jingning Han committed
58

Geza Lore's avatar
Geza Lore committed
59 60 61
// MI-units per min superblock
#define MIN_MIB_SIZE_LOG2 (MIN_SB_SIZE_LOG2 - MI_SIZE_LOG2)

62
// Mask to extract MI offset within max MIB
clang-format's avatar
clang-format committed
63
#define MAX_MIB_MASK (MAX_MIB_SIZE - 1)
Jingning Han's avatar
Jingning Han committed
64

65
// Maximum number of tile rows and tile columns
66
#if CONFIG_EXT_TILE
clang-format's avatar
clang-format committed
67 68
#define MAX_TILE_ROWS 1024
#define MAX_TILE_COLS 1024
69
#else
70 71 72 73
#if CONFIG_MAX_TILE
#define MAX_TILE_ROWS 64
#define MAX_TILE_COLS 64
#else
clang-format's avatar
clang-format committed
74 75
#define MAX_TILE_ROWS 4
#define MAX_TILE_COLS 64
76
#endif
77 78
#endif  // CONFIG_EXT_TILE

Jingning Han's avatar
Jingning Han committed
79 80 81 82
#if CONFIG_VAR_TX
#define MAX_VARTX_DEPTH 2
#endif

Cheng Chen's avatar
Cheng Chen committed
83 84
#define MI_SIZE_64X64 (64 >> MI_SIZE_LOG2)

85 86
#if CONFIG_LPF_SB
#define LPF_DELTA_BITS 3
87 88
#define LPF_STEP 2
#define MAX_LPF_OFFSET (LPF_STEP * ((1 << LPF_DELTA_BITS) - 1))
89 90 91 92

// Half of maximum loop filter length (15-tap)
#define FILT_BOUNDARY_OFFSET 8
#define FILT_BOUNDARY_MI_OFFSET (FILT_BOUNDARY_OFFSET >> MI_SIZE_LOG2)
93 94
#endif  // CONFIG_LPF_SB

Jingning Han's avatar
Jingning Han committed
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
// Bitstream profiles indicated by 2-3 bits in the uncompressed header.
// 00: Profile 0.  8-bit 4:2:0 only.
// 10: Profile 1.  8-bit 4:4:4, 4:2:2, and 4:4:0.
// 01: Profile 2.  10-bit and 12-bit color only, with 4:2:0 sampling.
// 110: Profile 3. 10-bit and 12-bit color only, with 4:2:2/4:4:4/4:4:0
//                 sampling.
// 111: Undefined profile.
typedef enum BITSTREAM_PROFILE {
  PROFILE_0,
  PROFILE_1,
  PROFILE_2,
  PROFILE_3,
  MAX_PROFILES
} BITSTREAM_PROFILE;

110 111 112 113
// Note: Some enums use the attribute 'packed' to use smallest possible integer
// type, so that we can save memory when they are used in structs/arrays.

typedef enum ATTRIBUTE_PACKED {
114
#if CONFIG_CHROMA_2X2 || CONFIG_CHROMA_SUB8X8
Jingning Han's avatar
Jingning Han committed
115 116 117 118
  BLOCK_2X2,
  BLOCK_2X4,
  BLOCK_4X2,
#endif
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
  BLOCK_4X4,
  BLOCK_4X8,
  BLOCK_8X4,
  BLOCK_8X8,
  BLOCK_8X16,
  BLOCK_16X8,
  BLOCK_16X16,
  BLOCK_16X32,
  BLOCK_32X16,
  BLOCK_32X32,
  BLOCK_32X64,
  BLOCK_64X32,
  BLOCK_64X64,
#if CONFIG_EXT_PARTITION
  BLOCK_64X128,
  BLOCK_128X64,
  BLOCK_128X128,
#endif  // CONFIG_EXT_PARTITION
137 138 139 140
  BLOCK_4X16,
  BLOCK_16X4,
  BLOCK_8X32,
  BLOCK_32X8,
141 142
  BLOCK_16X64,
  BLOCK_64X16,
143 144 145
  BLOCK_SIZES_ALL,
  BLOCK_SIZES = BLOCK_4X16,
  BLOCK_INVALID = 255,
146 147 148 149
  BLOCK_LARGEST = (BLOCK_SIZES - 1)
} BLOCK_SIZE;

typedef enum {
150 151 152 153
  PARTITION_NONE,
  PARTITION_HORZ,
  PARTITION_VERT,
  PARTITION_SPLIT,
154
#if CONFIG_EXT_PARTITION_TYPES
155 156 157 158
  PARTITION_HORZ_A,  // HORZ split and the top partition is split again
  PARTITION_HORZ_B,  // HORZ split and the bottom partition is split again
  PARTITION_VERT_A,  // VERT split and the left partition is split again
  PARTITION_VERT_B,  // VERT split and the right partition is split again
159 160
  PARTITION_HORZ_4,  // 4:1 horizontal partition
  PARTITION_VERT_4,  // 4:1 vertical partition
161
  EXT_PARTITION_TYPES,
162
#endif  // CONFIG_EXT_PARTITION_TYPES
163
  PARTITION_TYPES = PARTITION_SPLIT + 1,
164
  PARTITION_INVALID = 255
Jingning Han's avatar
Jingning Han committed
165 166 167
} PARTITION_TYPE;

typedef char PARTITION_CONTEXT;
clang-format's avatar
clang-format committed
168
#define PARTITION_PLOFFSET 4  // number of probability models per block size
169 170 171
#define PARTITION_BLOCK_SIZES (4 + CONFIG_EXT_PARTITION)
#define PARTITION_CONTEXTS_PRIMARY (PARTITION_BLOCK_SIZES * PARTITION_PLOFFSET)
#if CONFIG_UNPOISON_PARTITION_CTX
172
#define INVALID_PARTITION_CTX (-1)
173 174
#define PARTITION_CONTEXTS \
  (PARTITION_CONTEXTS_PRIMARY + 2 * PARTITION_BLOCK_SIZES)
175
#else
176 177
#define PARTITION_CONTEXTS PARTITION_CONTEXTS_PRIMARY
#endif
Jingning Han's avatar
Jingning Han committed
178 179

// block transform size
180
typedef enum ATTRIBUTE_PACKED {
181
#if CONFIG_CHROMA_2X2
182 183
  TX_2X2,  // 2x2 transform
#endif
184 185 186 187 188 189 190 191 192 193 194 195 196
  TX_4X4,    // 4x4 transform
  TX_8X8,    // 8x8 transform
  TX_16X16,  // 16x16 transform
  TX_32X32,  // 32x32 transform
#if CONFIG_TX64X64
  TX_64X64,           // 64x64 transform
#endif                // CONFIG_TX64X64
  TX_4X8,             // 4x8 transform
  TX_8X4,             // 8x4 transform
  TX_8X16,            // 8x16 transform
  TX_16X8,            // 16x8 transform
  TX_16X32,           // 16x32 transform
  TX_32X16,           // 32x16 transform
197 198 199 200
  TX_4X16,            // 4x16 transform
  TX_16X4,            // 16x4 transform
  TX_8X32,            // 8x32 transform
  TX_32X8,            // 32x8 transform
201 202 203
  TX_SIZES_ALL,       // Includes rectangular transforms
  TX_SIZES = TX_4X8,  // Does NOT include rectangular transforms
  TX_INVALID = 255    // Invalid transform size
204
} TX_SIZE;
205

206 207 208 209 210 211
#define TX_SIZE_LUMA_MIN (TX_4X4)
/* We don't need to code a transform size unless the allowed size is at least
   one more than the minimum. */
#define TX_SIZE_CTX_MIN (TX_SIZE_LUMA_MIN + 1)

#define MAX_TX_DEPTH (TX_SIZES - TX_SIZE_CTX_MIN)
Jingning Han's avatar
Jingning Han committed
212

213 214 215 216
#if CONFIG_CTX1D
#define MAX_HVTX_SIZE (1 << 5)
#endif  // CONFIG_CTX1D

217
#define MAX_TX_SIZE_LOG2 (5 + CONFIG_TX64X64)
clang-format's avatar
clang-format committed
218 219 220 221
#define MAX_TX_SIZE (1 << MAX_TX_SIZE_LOG2)
#define MIN_TX_SIZE_LOG2 2
#define MIN_TX_SIZE (1 << MIN_TX_SIZE_LOG2)
#define MAX_TX_SQUARE (MAX_TX_SIZE * MAX_TX_SIZE)
222 223

// Number of maxium size transform blocks in the maximum size superblock
clang-format's avatar
clang-format committed
224
#define MAX_TX_BLOCKS_IN_MAX_SB_LOG2 ((MAX_SB_SIZE_LOG2 - MAX_TX_SIZE_LOG2) * 2)
225 226
#define MAX_TX_BLOCKS_IN_MAX_SB (1 << MAX_TX_BLOCKS_IN_MAX_SB_LOG2)

227
#if CONFIG_NCOBMC_ADAPT_WEIGHT
228
typedef enum ATTRIBUTE_PACKED {
229
  NCOBMC_MODE_0,
230 231 232 233 234 235 236
  NCOBMC_MODE_1,
  NCOBMC_MODE_2,
  NCOBMC_MODE_3,
  NCOBMC_MODE_4,
  NCOBMC_MODE_5,
  NCOBMC_MODE_6,
  NCOBMC_MODE_7,
237 238 239 240 241
  ALL_NCOBMC_MODES,
#ifdef TWO_MODE
  MAX_NCOBMC_MODES = NCOBMC_MODE_1 + 1,
#else
  MAX_NCOBMC_MODES = ALL_NCOBMC_MODES,
242
#endif
243 244 245 246 247 248 249 250 251 252 253 254
  NO_OVERLAP = MAX_NCOBMC_MODES + 1
} NCOBMC_MODE;

typedef enum {
  ADAPT_OVERLAP_BLOCK_8X8,
  ADAPT_OVERLAP_BLOCK_16X16,
  ADAPT_OVERLAP_BLOCK_32X32,
  ADAPT_OVERLAP_BLOCK_64X64,
  ADAPT_OVERLAP_BLOCKS,
  ADAPT_OVERLAP_BLOCK_INVALID = 255
} ADAPT_OVERLAP_BLOCK;
#endif  // CONFIG_NCOBMC_ADAPT_WEIGHT
255

Jingning Han's avatar
Jingning Han committed
256 257
// frame transform mode
typedef enum {
258 259 260 261 262 263 264 265 266
  ONLY_4X4 = 0,     // only 4x4 transform used
  ALLOW_8X8 = 1,    // allow block transform size up to 8x8
  ALLOW_16X16 = 2,  // allow block transform size up to 16x16
  ALLOW_32X32 = 3,  // allow block transform size up to 32x32
#if CONFIG_TX64X64
  ALLOW_64X64 = 4,  // allow block transform size up to 64x64
#endif
  TX_MODE_SELECT,  // transform specified for each block
  TX_MODES,
Jingning Han's avatar
Jingning Han committed
267 268
} TX_MODE;

269 270 271 272 273 274
// 1D tx types
typedef enum {
  DCT_1D = 0,
  ADST_1D = 1,
  FLIPADST_1D = 2,
  IDTX_1D = 3,
Sarah Parker's avatar
Sarah Parker committed
275 276
  // TODO(sarahparker) need to eventually put something here for the
  // mrc experiment to make this work with the ext-tx pruning functions
277 278 279
  TX_TYPES_1D = 4,
} TX_TYPE_1D;

Jingning Han's avatar
Jingning Han committed
280
typedef enum {
clang-format's avatar
clang-format committed
281 282 283 284
  DCT_DCT = 0,    // DCT  in both horizontal and vertical
  ADST_DCT = 1,   // ADST in vertical, DCT in horizontal
  DCT_ADST = 2,   // DCT  in vertical, ADST in horizontal
  ADST_ADST = 3,  // ADST in both directions
285 286 287 288 289 290
#if CONFIG_EXT_TX
  FLIPADST_DCT = 4,
  DCT_FLIPADST = 5,
  FLIPADST_FLIPADST = 6,
  ADST_FLIPADST = 7,
  FLIPADST_ADST = 8,
291 292 293 294 295 296 297
  IDTX = 9,
  V_DCT = 10,
  H_DCT = 11,
  V_ADST = 12,
  H_ADST = 13,
  V_FLIPADST = 14,
  H_FLIPADST = 15,
298
#endif  // CONFIG_EXT_TX
Sarah Parker's avatar
Sarah Parker committed
299 300 301
#if CONFIG_MRC_TX
  MRC_DCT,  // DCT in both directions with mrc based bitmask
#endif      // CONFIG_MRC_TX
302
  TX_TYPES,
Jingning Han's avatar
Jingning Han committed
303 304
} TX_TYPE;

305
#if CONFIG_EXT_TX
Hui Su's avatar
Hui Su committed
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
typedef enum {
  // DCT only
  EXT_TX_SET_DCTONLY = 0,
  // DCT + Identity only
  EXT_TX_SET_DCT_IDTX,
#if CONFIG_MRC_TX
  // DCT + MRC_DCT
  EXT_TX_SET_MRC_DCT,
  // DCT + MRC_DCT + IDTX
  EXT_TX_SET_MRC_DCT_IDTX,
#endif  // CONFIG_MRC_TX
  // Discrete Trig transforms w/o flip (4) + Identity (1)
  EXT_TX_SET_DTT4_IDTX,
  // Discrete Trig transforms w/o flip (4) + Identity (1) + 1D Hor/vert DCT (2)
  EXT_TX_SET_DTT4_IDTX_1DDCT,
  // Discrete Trig transforms w/ flip (9) + Identity (1) + 1D Hor/Ver DCT (2)
  EXT_TX_SET_DTT9_IDTX_1DDCT,
  // Discrete Trig transforms w/ flip (9) + Identity (1) + 1D Hor/Ver (6)
  EXT_TX_SET_ALL16,
  EXT_TX_SET_TYPES
} TxSetType;

328 329 330 331 332
#define IS_2D_TRANSFORM(tx_type) (tx_type < IDTX)
#else
#define IS_2D_TRANSFORM(tx_type) 1
#endif

333 334 335 336 337
typedef enum {
  TILE_LEFT_BOUNDARY = 1,
  TILE_RIGHT_BOUNDARY = 2,
  TILE_ABOVE_BOUNDARY = 4,
  TILE_BOTTOM_BOUNDARY = 8,
338 339 340 341 342
  FRAME_LEFT_BOUNDARY = 16,
  FRAME_RIGHT_BOUNDARY = 32,
  FRAME_ABOVE_BOUNDARY = 64,
  FRAME_BOTTOM_BOUNDARY = 128,
} BOUNDARY_TYPE;
343

344
#if CONFIG_EXT_TX
345
#if CONFIG_CHROMA_2X2
346 347
#define EXT_TX_SIZES 5  // number of sizes that use extended transforms
#else
Sarah Parker's avatar
Sarah Parker committed
348 349 350 351 352 353
#define EXT_TX_SIZES 4  // number of sizes that use extended transforms
#endif                  // CONFIG_CHROMA_2X2
#if CONFIG_MRC_TX
#define EXT_TX_SETS_INTER 5  // Sets of transform selections for INTER
#define EXT_TX_SETS_INTRA 4  // Sets of transform selections for INTRA
#else                        // CONFIG_MRC_TX
clang-format's avatar
clang-format committed
354 355
#define EXT_TX_SETS_INTER 4  // Sets of transform selections for INTER
#define EXT_TX_SETS_INTRA 3  // Sets of transform selections for INTRA
Sarah Parker's avatar
Sarah Parker committed
356
#endif                       // CONFIG_MRC_TX
357
#else
358
#if CONFIG_CHROMA_2X2
359 360
#define EXT_TX_SIZES 4  // number of sizes that use extended transforms
#else
clang-format's avatar
clang-format committed
361
#define EXT_TX_SIZES 3  // number of sizes that use extended transforms
362 363
#endif
#endif  // CONFIG_EXT_TX
364

Jingning Han's avatar
Jingning Han committed
365
typedef enum {
Yaowu Xu's avatar
Yaowu Xu committed
366
  AOM_LAST_FLAG = 1 << 0,
367
#if CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
368 369 370 371
  AOM_LAST2_FLAG = 1 << 1,
  AOM_LAST3_FLAG = 1 << 2,
  AOM_GOLD_FLAG = 1 << 3,
  AOM_BWD_FLAG = 1 << 4,
372 373 374 375
  AOM_ALT2_FLAG = 1 << 5,
  AOM_ALT_FLAG = 1 << 6,
  AOM_REFFRAME_ALL = (1 << 7) - 1
#else   // !CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
376 377 378
  AOM_GOLD_FLAG = 1 << 1,
  AOM_ALT_FLAG = 1 << 2,
  AOM_REFFRAME_ALL = (1 << 3) - 1
379
#endif  // CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
380
} AOM_REFFRAME;
Jingning Han's avatar
Jingning Han committed
381

Zoe Liu's avatar
Zoe Liu committed
382 383 384 385 386 387 388 389 390 391 392 393
#if CONFIG_EXT_COMP_REFS
#define USE_UNI_COMP_REFS 1

typedef enum {
  UNIDIR_COMP_REFERENCE = 0,
  BIDIR_COMP_REFERENCE = 1,
  COMP_REFERENCE_TYPES = 2,
} COMP_REFERENCE_TYPE;
#else  // !CONFIG_EXT_COMP_REFS
#define USE_UNI_COMP_REFS 0
#endif  // CONFIG_EXT_COMP_REFS

clang-format's avatar
clang-format committed
394
typedef enum { PLANE_TYPE_Y = 0, PLANE_TYPE_UV = 1, PLANE_TYPES } PLANE_TYPE;
Jingning Han's avatar
Jingning Han committed
395

396
#if CONFIG_CFL
397 398 399 400 401
#define CFL_ALPHABET_SIZE_LOG2 4
#define CFL_ALPHABET_SIZE (1 << CFL_ALPHABET_SIZE_LOG2)
#define CFL_MAGS_SIZE ((2 << CFL_ALPHABET_SIZE_LOG2) + 1)
#define CFL_IDX_U(idx) (idx >> CFL_ALPHABET_SIZE_LOG2)
#define CFL_IDX_V(idx) (idx & (CFL_ALPHABET_SIZE - 1))
Luc Trudeau's avatar
Luc Trudeau committed
402

403
typedef enum { CFL_PRED_U = 0, CFL_PRED_V = 1, CFL_PRED_PLANES } CFL_PRED_TYPE;
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425

typedef enum {
  CFL_SIGN_ZERO = 0,
  CFL_SIGN_NEG = 1,
  CFL_SIGN_POS = 2,
  CFL_SIGNS
} CFL_SIGN_TYPE;

// CFL_SIGN_ZERO,CFL_SIGN_ZERO is invalid
#define CFL_JOINT_SIGNS (CFL_SIGNS * CFL_SIGNS - 1)
// CFL_SIGN_U is equivalent to (js + 1) / 3 for js in 0 to 8
#define CFL_SIGN_U(js) (((js + 1) * 11) >> 5)
// CFL_SIGN_V is equivalent to (js + 1) % 3 for js in 0 to 8
#define CFL_SIGN_V(js) ((js + 1) - CFL_SIGNS * CFL_SIGN_U(js))

// There is no context when the alpha for a given plane is zero.
// So there are 2 fewer contexts than joint signs.
#define CFL_ALPHA_CONTEXTS (CFL_JOINT_SIGNS + 1 - CFL_SIGNS)
#define CFL_CONTEXT_U(js) (js + 1 - CFL_SIGNS)
// Also, the contexts are symmetric under swapping the planes.
#define CFL_CONTEXT_V(js) \
  (CFL_SIGN_V(js) * CFL_SIGNS + CFL_SIGN_U(js) - CFL_SIGNS)
426 427
#endif

428 429 430 431 432 433 434 435
typedef enum {
  PALETTE_MAP,
#if CONFIG_MRC_TX
  MRC_MAP,
#endif  // CONFIG_MRC_TX
  COLOR_MAP_TYPES,
} COLOR_MAP_TYPE;

hui su's avatar
hui su committed
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
typedef enum {
  TWO_COLORS,
  THREE_COLORS,
  FOUR_COLORS,
  FIVE_COLORS,
  SIX_COLORS,
  SEVEN_COLORS,
  EIGHT_COLORS,
  PALETTE_SIZES
} PALETTE_SIZE;

typedef enum {
  PALETTE_COLOR_ONE,
  PALETTE_COLOR_TWO,
  PALETTE_COLOR_THREE,
  PALETTE_COLOR_FOUR,
  PALETTE_COLOR_FIVE,
  PALETTE_COLOR_SIX,
  PALETTE_COLOR_SEVEN,
  PALETTE_COLOR_EIGHT,
  PALETTE_COLORS
} PALETTE_COLOR;

459 460
// Note: All directional predictors must be between V_PRED and D63_PRED (both
// inclusive).
461
typedef enum ATTRIBUTE_PACKED {
Urvang Joshi's avatar
Urvang Joshi committed
462 463 464 465 466 467 468 469 470
  DC_PRED,      // Average of above and left pixels
  V_PRED,       // Vertical
  H_PRED,       // Horizontal
  D45_PRED,     // Directional 45  deg = round(arctan(1/1) * 180/pi)
  D135_PRED,    // Directional 135 deg = 180 - 45
  D117_PRED,    // Directional 117 deg = 180 - 63
  D153_PRED,    // Directional 153 deg = 180 - 27
  D207_PRED,    // Directional 207 deg = 180 + 27
  D63_PRED,     // Directional 63  deg = round(arctan(2/1) * 180/pi)
471
  SMOOTH_PRED,  // Combination of horizontal and vertical interpolation
Urvang Joshi's avatar
Urvang Joshi committed
472 473 474 475 476
#if CONFIG_SMOOTH_HV
  SMOOTH_V_PRED,  // Vertical interpolation
  SMOOTH_H_PRED,  // Horizontal interpolation
#endif            // CONFIG_SMOOTH_HV
  TM_PRED,        // True-motion
477 478 479 480
  NEARESTMV,
  NEARMV,
  ZEROMV,
  NEWMV,
Yue Chen's avatar
Yue Chen committed
481
#if CONFIG_EXT_INTER
482 483 484
#if CONFIG_COMPOUND_SINGLEREF
  // Single ref compound modes
  SR_NEAREST_NEARMV,
485
  // SR_NEAREST_NEWMV,
486 487 488 489 490
  SR_NEAR_NEWMV,
  SR_ZERO_NEWMV,
  SR_NEW_NEWMV,
#endif  // CONFIG_COMPOUND_SINGLEREF
  // Compound ref compound modes
491 492 493 494 495 496 497 498
  NEAREST_NEARESTMV,
  NEAR_NEARMV,
  NEAREST_NEWMV,
  NEW_NEARESTMV,
  NEAR_NEWMV,
  NEW_NEARMV,
  ZERO_ZEROMV,
  NEW_NEWMV,
Yue Chen's avatar
Yue Chen committed
499
#endif  // CONFIG_EXT_INTER
500
  MB_MODE_COUNT,
hui su's avatar
hui su committed
501
  INTRA_MODES = TM_PRED + 1,     // TM_PRED has to be the last intra mode.
502
  INTRA_INVALID = MB_MODE_COUNT  // For uv_mode in inter blocks
503
} PREDICTION_MODE;
Jingning Han's avatar
Jingning Han committed
504

Luc Trudeau's avatar
Luc Trudeau committed
505 506 507 508
#if CONFIG_CFL
// TODO(ltrudeau) Do we really want to pack this?
// TODO(ltrudeau) Do we match with PREDICTION_MODE?
typedef enum ATTRIBUTE_PACKED {
Urvang Joshi's avatar
Urvang Joshi committed
509 510 511 512 513 514 515 516 517
  UV_DC_PRED,      // Average of above and left pixels
  UV_V_PRED,       // Vertical
  UV_H_PRED,       // Horizontal
  UV_D45_PRED,     // Directional 45  deg = round(arctan(1/1) * 180/pi)
  UV_D135_PRED,    // Directional 135 deg = 180 - 45
  UV_D117_PRED,    // Directional 117 deg = 180 - 63
  UV_D153_PRED,    // Directional 153 deg = 180 - 27
  UV_D207_PRED,    // Directional 207 deg = 180 + 27
  UV_D63_PRED,     // Directional 63  deg = round(arctan(2/1) * 180/pi)
Luc Trudeau's avatar
Luc Trudeau committed
518 519 520 521 522 523
  UV_SMOOTH_PRED,  // Combination of horizontal and vertical interpolation
#if CONFIG_SMOOTH_HV
  UV_SMOOTH_V_PRED,  // Vertical interpolation
  UV_SMOOTH_H_PRED,  // Horizontal interpolation
#endif               // CONFIG_SMOOTH_HV
  UV_TM_PRED,        // True-motion
524
  UV_CFL_PRED,       // Chroma-from-Luma
Luc Trudeau's avatar
Luc Trudeau committed
525 526 527 528 529 530 531 532 533 534
  UV_INTRA_MODES,
  UV_MODE_INVALID,  // For uv_mode in inter blocks
} UV_PREDICTION_MODE;
#else
#define UV_INTRA_MODES (INTRA_MODES)
#define UV_PREDICTION_MODE PREDICTION_MODE
#define UV_DC_PRED (DC_PRED)
#define UV_MODE_INVALID (INTRA_INVALID)
#endif  // CONFIG_CFL

535 536
typedef enum {
  SIMPLE_TRANSLATION = 0,
Yue Chen's avatar
Yue Chen committed
537
#if CONFIG_MOTION_VAR
clang-format's avatar
clang-format committed
538
  OBMC_CAUSAL,  // 2-sided OBMC
Wei-Ting Lin's avatar
Wei-Ting Lin committed
539 540 541 542
#if CONFIG_NCOBMC_ADAPT_WEIGHT
  NCOBMC_ADAPT_WEIGHT,
#endif  // CONFIG_NCOBMC_ADAPT_WEIGHT
#endif  // CONFIG_MOTION_VAR
543 544
#if CONFIG_WARPED_MOTION
  WARPED_CAUSAL,  // 2-sided WARPED
clang-format's avatar
clang-format committed
545
#endif            // CONFIG_WARPED_MOTION
Yue Chen's avatar
Yue Chen committed
546
  MOTION_MODES
547 548 549 550
#if CONFIG_NCOBMC_ADAPT_WEIGHT && CONFIG_WARPED_MOTION
  ,
  OBMC_FAMILY_MODES = NCOBMC_ADAPT_WEIGHT + 1
#endif
Yue Chen's avatar
Yue Chen committed
551
} MOTION_MODE;
552

553
#if CONFIG_EXT_INTER
554 555 556 557 558 559 560 561 562
#if CONFIG_INTERINTRA
typedef enum {
  II_DC_PRED = 0,
  II_V_PRED,
  II_H_PRED,
  II_SMOOTH_PRED,
  INTERINTRA_MODES
} INTERINTRA_MODE;
#endif
563

564 565
typedef enum {
  COMPOUND_AVERAGE = 0,
566
#if CONFIG_WEDGE
567
  COMPOUND_WEDGE,
568
#endif  // CONFIG_WEDGE
569 570 571
#if CONFIG_COMPOUND_SEGMENT
  COMPOUND_SEG,
#endif  // CONFIG_COMPOUND_SEGMENT
572 573
  COMPOUND_TYPES,
} COMPOUND_TYPE;
574 575
#endif  // CONFIG_EXT_INTER

576
// TODO(huisu): Consider adding FILTER_SMOOTH_PRED to "FILTER_INTRA_MODE".
577
#if CONFIG_FILTER_INTRA
578 579 580 581 582 583 584 585 586 587 588
typedef enum {
  FILTER_DC_PRED,
  FILTER_V_PRED,
  FILTER_H_PRED,
  FILTER_D45_PRED,
  FILTER_D135_PRED,
  FILTER_D117_PRED,
  FILTER_D153_PRED,
  FILTER_D207_PRED,
  FILTER_D63_PRED,
  FILTER_TM_PRED,
589 590 591
  FILTER_INTRA_MODES,
} FILTER_INTRA_MODE;
#endif  // CONFIG_FILTER_INTRA
592

593
#if CONFIG_EXT_INTRA
594
#define DIRECTIONAL_MODES 8
595 596
#endif  // CONFIG_EXT_INTRA

Jingning Han's avatar
Jingning Han committed
597 598
#define INTER_MODES (1 + NEWMV - NEARESTMV)

599
#if CONFIG_EXT_INTER
600 601 602 603
#if CONFIG_COMPOUND_SINGLEREF
#define INTER_SINGLEREF_COMP_MODES (1 + SR_NEW_NEWMV - SR_NEAREST_NEARMV)
#endif  // CONFIG_COMPOUND_SINGLEREF

604 605 606
#define INTER_COMPOUND_MODES (1 + NEW_NEWMV - NEAREST_NEARESTMV)
#endif  // CONFIG_EXT_INTER

Jingning Han's avatar
Jingning Han committed
607
#define SKIP_CONTEXTS 3
608

609
#define NMV_CONTEXTS 3
610

clang-format's avatar
clang-format committed
611
#define NEWMV_MODE_CONTEXTS 7
612
#define ZEROMV_MODE_CONTEXTS 2
clang-format's avatar
clang-format committed
613 614
#define REFMV_MODE_CONTEXTS 9
#define DRL_MODE_CONTEXTS 5
615 616

#define ZEROMV_OFFSET 3
clang-format's avatar
clang-format committed
617
#define REFMV_OFFSET 4
618 619 620

#define NEWMV_CTX_MASK ((1 << ZEROMV_OFFSET) - 1)
#define ZEROMV_CTX_MASK ((1 << (REFMV_OFFSET - ZEROMV_OFFSET)) - 1)
621 622
#define REFMV_CTX_MASK ((1 << (8 - REFMV_OFFSET)) - 1)

clang-format's avatar
clang-format committed
623 624 625
#define ALL_ZERO_FLAG_OFFSET 8
#define SKIP_NEARESTMV_OFFSET 9
#define SKIP_NEARMV_OFFSET 10
626
#define SKIP_NEARESTMV_SUB8X8_OFFSET 11
627

Jingning Han's avatar
Jingning Han committed
628
#define INTER_MODE_CONTEXTS 7
629
#define DELTA_Q_SMALL 3
630
#define DELTA_Q_PROBS (DELTA_Q_SMALL)
631
#define DEFAULT_DELTA_Q_RES 4
Fangwen Fu's avatar
Fangwen Fu committed
632 633 634 635 636
#if CONFIG_EXT_DELTA_Q
#define DELTA_LF_SMALL 3
#define DELTA_LF_PROBS (DELTA_LF_SMALL)
#define DEFAULT_DELTA_LF_RES 2
#endif
Jingning Han's avatar
Jingning Han committed
637 638 639

/* Segment Feature Masks */
#define MAX_MV_REF_CANDIDATES 2
640

641
#define MAX_REF_MV_STACK_SIZE 16
642 643 644
#if CONFIG_EXT_PARTITION
#define REF_CAT_LEVEL 640
#else
645
#define REF_CAT_LEVEL 255
646
#endif  // CONFIG_EXT_PARTITION
Jingning Han's avatar
Jingning Han committed
647 648 649 650

#define INTRA_INTER_CONTEXTS 4
#define COMP_INTER_CONTEXTS 5
#define REF_CONTEXTS 5
Zoe Liu's avatar
Zoe Liu committed
651 652 653

#if CONFIG_EXT_COMP_REFS
#define COMP_REF_TYPE_CONTEXTS 5
654
#define UNI_COMP_REF_CONTEXTS 3
Zoe Liu's avatar
Zoe Liu committed
655 656
#endif  // CONFIG_EXT_COMP_REFS

657 658 659
#if CONFIG_EXT_INTER && CONFIG_COMPOUND_SINGLEREF
#define COMP_INTER_MODE_CONTEXTS 4
#endif  // CONFIG_EXT_INTER && CONFIG_COMPOUND_SINGLEREF
Jingning Han's avatar
Jingning Han committed
660

661
#if CONFIG_VAR_TX
662
#define TXFM_PARTITION_CONTEXTS ((TX_SIZES - TX_8X8) * 6 - 2)
663
typedef uint8_t TXFM_CONTEXT;
664 665
#endif

Emil Keyder's avatar
Emil Keyder committed
666
#define NONE_FRAME -1
clang-format's avatar
clang-format committed
667 668
#define INTRA_FRAME 0
#define LAST_FRAME 1
669

670
#if CONFIG_EXT_REFS
clang-format's avatar
clang-format committed
671 672 673 674
#define LAST2_FRAME 2
#define LAST3_FRAME 3
#define GOLDEN_FRAME 4
#define BWDREF_FRAME 5
675 676
#define ALTREF2_FRAME 6
#define ALTREF_FRAME 7
677
#define LAST_REF_FRAMES (LAST3_FRAME - LAST_FRAME + 1)
678
#else  // !CONFIG_EXT_REFS
clang-format's avatar
clang-format committed
679 680
#define GOLDEN_FRAME 2
#define ALTREF_FRAME 3
681 682
#endif  // CONFIG_EXT_REFS

683 684 685
#define INTER_REFS_PER_FRAME (ALTREF_FRAME - LAST_FRAME + 1)
#define TOTAL_REFS_PER_FRAME (ALTREF_FRAME - INTRA_FRAME + 1)

686 687 688 689 690 691 692 693
#define FWD_REFS (GOLDEN_FRAME - LAST_FRAME + 1)
#define FWD_RF_OFFSET(ref) (ref - LAST_FRAME)
#if CONFIG_EXT_REFS
#define BWD_REFS (ALTREF_FRAME - BWDREF_FRAME + 1)
#define BWD_RF_OFFSET(ref) (ref - BWDREF_FRAME)
#else
#define BWD_REFS 1
#define BWD_RF_OFFSET(ref) (ref - ALTREF_FRAME)
694
#endif  // CONFIG_EXT_REFS
695 696

#define SINGLE_REFS (FWD_REFS + BWD_REFS)
Zoe Liu's avatar
Zoe Liu committed
697 698 699
#if CONFIG_EXT_COMP_REFS
typedef enum {
  LAST_LAST2_FRAMES,     // { LAST_FRAME, LAST2_FRAME }
700
  LAST_LAST3_FRAMES,     // { LAST_FRAME, LAST3_FRAME }
Zoe Liu's avatar
Zoe Liu committed
701 702 703 704 705 706
  LAST_GOLDEN_FRAMES,    // { LAST_FRAME, GOLDEN_FRAME }
  BWDREF_ALTREF_FRAMES,  // { BWDREF_FRAME, ALTREF_FRAME }
  UNIDIR_COMP_REFS
} UNIDIR_COMP_REF;
#define COMP_REFS (FWD_REFS * BWD_REFS + UNIDIR_COMP_REFS)
#else  // !CONFIG_EXT_COMP_REFS
clang-format's avatar
clang-format committed
707
#define COMP_REFS (FWD_REFS * BWD_REFS)
Zoe Liu's avatar
Zoe Liu committed
708
#endif  // CONFIG_EXT_COMP_REFS
709

710
#define MODE_CTX_REF_FRAMES (TOTAL_REFS_PER_FRAME + COMP_REFS)
711

712 713 714 715 716
#if CONFIG_SUPERTX
#define PARTITION_SUPERTX_CONTEXTS 2
#define MAX_SUPERTX_BLOCK_SIZE BLOCK_32X32
#endif  // CONFIG_SUPERTX

717 718
#if CONFIG_LOOP_RESTORATION
typedef enum {
719
  RESTORE_NONE = 0,
720 721
  RESTORE_WIENER = 1,
  RESTORE_SGRPROJ = 2,
722
  RESTORE_SWITCHABLE,
723 724 725
  RESTORE_SWITCHABLE_TYPES = RESTORE_SWITCHABLE,
  RESTORE_TYPES,
} RestorationType;
726 727
#endif  // CONFIG_LOOP_RESTORATION

728
#if CONFIG_FRAME_SUPERRES
729 730
#define SUPERRES_SCALE_BITS 3
#define SUPERRES_SCALE_NUMERATOR_MIN 8
731
#endif  // CONFIG_FRAME_SUPERRES
732

Cheng Chen's avatar
Cheng Chen committed
733 734 735 736 737 738 739 740 741 742 743 744 745
#if CONFIG_LPF_DIRECT
typedef enum {
  VERT_HORZ,
  DEGREE_30,
  DEGREE_45,
  DEGREE_60,
  DEGREE_120,
  DEGREE_135,
  DEGREE_150,
  FILTER_DEGREES,
} FILTER_DEGREE;
#endif  // CONFIG_LPF_DIRECT

746 747 748 749 750 751 752 753 754 755 756 757
#if CONFIG_OBU
// R19
typedef enum {
  OBU_SEQUENCE_HEADER = 1,
  OBU_TD = 2,
  OBU_FRAME_HEADER = 3,
  OBU_TILE_GROUP = 4,
  OBU_METADATA = 5,
  OBU_PADDING = 15,
} OBU_TYPE;
#endif

Jingning Han's avatar
Jingning Han committed
758 759 760 761
#ifdef __cplusplus
}  // extern "C"
#endif

Yaowu Xu's avatar
Yaowu Xu committed
762
#endif  // AV1_COMMON_ENUMS_H_