enums.h 11.7 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

Geza Lore's avatar
Geza Lore committed
25
// Max superblock size
26
#if CONFIG_EXT_PARTITION
clang-format's avatar
clang-format committed
27
#define MAX_SB_SIZE_LOG2 7
28
#else
clang-format's avatar
clang-format committed
29
#define MAX_SB_SIZE_LOG2 6
30
#endif  // CONFIG_EXT_PARTITION
clang-format's avatar
clang-format committed
31
#define MAX_SB_SIZE (1 << MAX_SB_SIZE_LOG2)
32
#define MAX_SB_SQUARE (MAX_SB_SIZE * MAX_SB_SIZE)
Jingning Han's avatar
Jingning Han committed
33

Geza Lore's avatar
Geza Lore committed
34 35 36
// Min superblock size
#define MIN_SB_SIZE_LOG2 6

37
// Pixels per Mode Info (MI) unit
clang-format's avatar
clang-format committed
38 39
#define MI_SIZE_LOG2 3
#define MI_SIZE (1 << MI_SIZE_LOG2)
40

41 42
// 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
43
#define MAX_MIB_SIZE (1 << MAX_MIB_SIZE_LOG2)
Jingning Han's avatar
Jingning Han committed
44

Geza Lore's avatar
Geza Lore committed
45 46 47
// MI-units per min superblock
#define MIN_MIB_SIZE_LOG2 (MIN_SB_SIZE_LOG2 - MI_SIZE_LOG2)

48
// Mask to extract MI offset within max MIB
clang-format's avatar
clang-format committed
49 50
#define MAX_MIB_MASK (MAX_MIB_SIZE - 1)
#define MAX_MIB_MASK_2 (MAX_MIB_SIZE * 2 - 1)
Jingning Han's avatar
Jingning Han committed
51

52
// Maximum number of tile rows and tile columns
53
#if CONFIG_EXT_TILE
clang-format's avatar
clang-format committed
54 55
#define MAX_TILE_ROWS 1024
#define MAX_TILE_COLS 1024
56
#else
clang-format's avatar
clang-format committed
57 58
#define MAX_TILE_ROWS 4
#define MAX_TILE_COLS 64
59 60
#endif  // CONFIG_EXT_TILE

Jingning Han's avatar
Jingning Han committed
61 62 63 64
#if CONFIG_VAR_TX
#define MAX_VARTX_DEPTH 2
#endif

Jingning Han's avatar
Jingning Han committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
// 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;

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
// 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 {
  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
Jingning Han's avatar
Jingning Han committed
102

103 104 105 106 107 108
  BLOCK_SIZES,
  BLOCK_INVALID = BLOCK_SIZES,
  BLOCK_LARGEST = (BLOCK_SIZES - 1)
} BLOCK_SIZE;

typedef enum {
109 110 111 112
  PARTITION_NONE,
  PARTITION_HORZ,
  PARTITION_VERT,
  PARTITION_SPLIT,
113
#if CONFIG_EXT_PARTITION_TYPES
114 115 116 117 118
  PARTITION_HORZ_A,  // HORZ split and the left partition is split again
  PARTITION_HORZ_B,  // HORZ split and the right partition is split again
  PARTITION_VERT_A,  // VERT split and the top partition is split again
  PARTITION_VERT_B,  // VERT split and the bottom partition is split again
  EXT_PARTITION_TYPES,
119
#endif  // CONFIG_EXT_PARTITION_TYPES
120
  PARTITION_TYPES = PARTITION_SPLIT + 1,
121
  PARTITION_INVALID = 255
Jingning Han's avatar
Jingning Han committed
122 123 124
} PARTITION_TYPE;

typedef char PARTITION_CONTEXT;
clang-format's avatar
clang-format committed
125
#define PARTITION_PLOFFSET 4  // number of probability models per block size
126
#if CONFIG_EXT_PARTITION
clang-format's avatar
clang-format committed
127
#define PARTITION_CONTEXTS (5 * PARTITION_PLOFFSET)
128
#else
clang-format's avatar
clang-format committed
129
#define PARTITION_CONTEXTS (4 * PARTITION_PLOFFSET)
130
#endif  // CONFIG_EXT_PARTITION
Jingning Han's avatar
Jingning Han committed
131 132

// block transform size
133
typedef enum ATTRIBUTE_PACKED {
134 135 136
#if CONFIG_CB4X4
  TX_2X2,  // 2x2 transform
#endif
Jingning Han's avatar
Jingning Han committed
137 138 139 140
  TX_4X4,                   // 4x4 transform
  TX_8X8,                   // 8x8 transform
  TX_16X16,                 // 16x16 transform
  TX_32X32,                 // 32x32 transform
141 142 143 144 145 146 147 148 149 150
  TX_4X8,                   // 4x8 transform
  TX_8X4,                   // 8x4 transform
  TX_8X16,                  // 8x16 transform
  TX_16X8,                  // 16x8 transform
  TX_16X32,                 // 16x32 transform
  TX_32X16,                 // 32x16 transform
  TX_SIZES_ALL,             // Includes rectangular transforms
  TX_SIZES = TX_32X32 + 1,  // Does NOT include rectangular transforms
  TX_INVALID = 255          // Invalid transform size
} TX_SIZE;
151

Jingning Han's avatar
Jingning Han committed
152 153
#define MAX_TX_DEPTH (TX_32X32 - TX_4X4)

clang-format's avatar
clang-format committed
154 155 156 157 158
#define MAX_TX_SIZE_LOG2 5
#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)
159 160

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

clang-format's avatar
clang-format committed
164
#define MAX_NUM_TXB (1 << (MAX_SB_SIZE_LOG2 - MIN_TX_SIZE_LOG2))
Jingning Han's avatar
Jingning Han committed
165

Jingning Han's avatar
Jingning Han committed
166 167
// frame transform mode
typedef enum {
clang-format's avatar
clang-format committed
168 169 170 171 172 173
  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
  TX_MODE_SELECT = 4,  // transform specified for each block
  TX_MODES = 5,
Jingning Han's avatar
Jingning Han committed
174 175
} TX_MODE;

176 177 178 179 180 181 182 183 184
// 1D tx types
typedef enum {
  DCT_1D = 0,
  ADST_1D = 1,
  FLIPADST_1D = 2,
  IDTX_1D = 3,
  TX_TYPES_1D = 4,
} TX_TYPE_1D;

Jingning Han's avatar
Jingning Han committed
185
typedef enum {
clang-format's avatar
clang-format committed
186 187 188 189
  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
190 191 192 193 194 195
#if CONFIG_EXT_TX
  FLIPADST_DCT = 4,
  DCT_FLIPADST = 5,
  FLIPADST_FLIPADST = 6,
  ADST_FLIPADST = 7,
  FLIPADST_ADST = 8,
196 197 198 199 200 201 202
  IDTX = 9,
  V_DCT = 10,
  H_DCT = 11,
  V_ADST = 12,
  H_ADST = 13,
  V_FLIPADST = 14,
  H_FLIPADST = 15,
203
#endif  // CONFIG_EXT_TX
204
  TX_TYPES,
Jingning Han's avatar
Jingning Han committed
205 206
} TX_TYPE;

207
#if CONFIG_EXT_TX
clang-format's avatar
clang-format committed
208 209 210
#define EXT_TX_SIZES 4       // number of sizes that use extended transforms
#define EXT_TX_SETS_INTER 4  // Sets of transform selections for INTER
#define EXT_TX_SETS_INTRA 3  // Sets of transform selections for INTRA
211
#else
212 213 214
#if CONFIG_CB4X4
#define EXT_TX_SIZES 4  // number of sizes that use extended transforms
#else
clang-format's avatar
clang-format committed
215
#define EXT_TX_SIZES 3  // number of sizes that use extended transforms
216 217
#endif
#endif  // CONFIG_EXT_TX
218

Jingning Han's avatar
Jingning Han committed
219
typedef enum {
Yaowu Xu's avatar
Yaowu Xu committed
220
  AOM_LAST_FLAG = 1 << 0,
221
#if CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
222 223 224 225 226 227
  AOM_LAST2_FLAG = 1 << 1,
  AOM_LAST3_FLAG = 1 << 2,
  AOM_GOLD_FLAG = 1 << 3,
  AOM_BWD_FLAG = 1 << 4,
  AOM_ALT_FLAG = 1 << 5,
  AOM_REFFRAME_ALL = (1 << 6) - 1
228
#else
Yaowu Xu's avatar
Yaowu Xu committed
229 230 231
  AOM_GOLD_FLAG = 1 << 1,
  AOM_ALT_FLAG = 1 << 2,
  AOM_REFFRAME_ALL = (1 << 3) - 1
232
#endif  // CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
233
} AOM_REFFRAME;
Jingning Han's avatar
Jingning Han committed
234

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

237
#if CONFIG_PALETTE
hui su's avatar
hui su committed
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
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;
260
#endif  // CONFIG_PALETTE
hui su's avatar
hui su committed
261

262 263 264 265 266 267 268 269 270 271
#ifdef CONFIG_CLPF
#define CLPF_NOFLAG -1
typedef enum {
  CLPF_NOSIZE = 0,
  CLPF_32X32 = 1,
  CLPF_64X64 = 2,
  CLPF_128X128 = 3
} CLPF_BLOCK_SIZE;
#endif

272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
typedef enum ATTRIBUTE_PACKED {
  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)
  TM_PRED,    // True-motion
  NEARESTMV,
  NEARMV,
  ZEROMV,
  NEWMV,
Yue Chen's avatar
Yue Chen committed
287
#if CONFIG_EXT_INTER
288 289 290 291 292 293 294 295 296 297 298
  NEWFROMNEARMV,
  NEAREST_NEARESTMV,
  NEAREST_NEARMV,
  NEAR_NEARESTMV,
  NEAR_NEARMV,
  NEAREST_NEWMV,
  NEW_NEARESTMV,
  NEAR_NEWMV,
  NEW_NEARMV,
  ZERO_ZEROMV,
  NEW_NEWMV,
Yue Chen's avatar
Yue Chen committed
299
#endif  // CONFIG_EXT_INTER
300 301 302
  MB_MODE_COUNT,
  INTRA_MODES = TM_PRED + 1
} PREDICTION_MODE;
Jingning Han's avatar
Jingning Han committed
303

304 305
typedef enum {
  SIMPLE_TRANSLATION = 0,
Yue Chen's avatar
Yue Chen committed
306
#if CONFIG_MOTION_VAR
clang-format's avatar
clang-format committed
307
  OBMC_CAUSAL,  // 2-sided OBMC
Yue Chen's avatar
Yue Chen committed
308
#endif          // CONFIG_MOTION_VAR
309 310
#if CONFIG_WARPED_MOTION
  WARPED_CAUSAL,  // 2-sided WARPED
clang-format's avatar
clang-format committed
311
#endif            // CONFIG_WARPED_MOTION
Yue Chen's avatar
Yue Chen committed
312 313
  MOTION_MODES
} MOTION_MODE;
314

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
#if CONFIG_EXT_INTER
typedef enum {
  II_DC_PRED = 0,
  II_V_PRED,
  II_H_PRED,
  II_D45_PRED,
  II_D135_PRED,
  II_D117_PRED,
  II_D153_PRED,
  II_D207_PRED,
  II_D63_PRED,
  II_TM_PRED,
  INTERINTRA_MODES
} INTERINTRA_MODE;

#endif  // CONFIG_EXT_INTER

332
#if CONFIG_FILTER_INTRA
333 334 335 336 337 338 339 340 341 342 343
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,
344 345 346
  FILTER_INTRA_MODES,
} FILTER_INTRA_MODE;
#endif  // CONFIG_FILTER_INTRA
347

348
#if CONFIG_EXT_INTRA
349 350 351
#define DIRECTIONAL_MODES (INTRA_MODES - 2)
#endif  // CONFIG_EXT_INTRA

Yue Chen's avatar
Yue Chen committed
352 353 354
#if CONFIG_EXT_INTER
#define INTER_MODES (1 + NEWFROMNEARMV - NEARESTMV)
#else
Jingning Han's avatar
Jingning Han committed
355
#define INTER_MODES (1 + NEWMV - NEARESTMV)
Yue Chen's avatar
Yue Chen committed
356
#endif  // CONFIG_EXT_INTER
Jingning Han's avatar
Jingning Han committed
357

358 359 360 361
#if CONFIG_EXT_INTER
#define INTER_COMPOUND_MODES (1 + NEW_NEWMV - NEAREST_NEARESTMV)
#endif  // CONFIG_EXT_INTER

Jingning Han's avatar
Jingning Han committed
362
#define SKIP_CONTEXTS 3
363 364

#if CONFIG_REF_MV
365
#define NMV_CONTEXTS 3
366

clang-format's avatar
clang-format committed
367
#define NEWMV_MODE_CONTEXTS 7
368
#define ZEROMV_MODE_CONTEXTS 2
clang-format's avatar
clang-format committed
369 370
#define REFMV_MODE_CONTEXTS 9
#define DRL_MODE_CONTEXTS 5
371 372

#define ZEROMV_OFFSET 3
clang-format's avatar
clang-format committed
373
#define REFMV_OFFSET 4
374 375 376

#define NEWMV_CTX_MASK ((1 << ZEROMV_OFFSET) - 1)
#define ZEROMV_CTX_MASK ((1 << (REFMV_OFFSET - ZEROMV_OFFSET)) - 1)
377 378
#define REFMV_CTX_MASK ((1 << (8 - REFMV_OFFSET)) - 1)

clang-format's avatar
clang-format committed
379 380 381
#define ALL_ZERO_FLAG_OFFSET 8
#define SKIP_NEARESTMV_OFFSET 9
#define SKIP_NEARMV_OFFSET 10
382
#define SKIP_NEARESTMV_SUB8X8_OFFSET 11
383 384
#endif

Jingning Han's avatar
Jingning Han committed
385
#define INTER_MODE_CONTEXTS 7
386 387 388 389 390
#if CONFIG_DELTA_Q
#define DELTA_Q_SMALL 3
#define DELTA_Q_CONTEXTS (DELTA_Q_SMALL)
#define DEFAULT_DELTA_Q_RES 4
#endif
Jingning Han's avatar
Jingning Han committed
391 392 393

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

395 396
#if CONFIG_REF_MV
#define MAX_REF_MV_STACK_SIZE 16
397 398 399 400 401 402
#if CONFIG_EXT_PARTITION
#define REF_CAT_LEVEL 640
#else
#define REF_CAT_LEVEL 160
#endif  // CONFIG_EXT_PARTITION
#endif  // CONFIG_REF_MV
Jingning Han's avatar
Jingning Han committed
403 404 405 406 407

#define INTRA_INTER_CONTEXTS 4
#define COMP_INTER_CONTEXTS 5
#define REF_CONTEXTS 5

408
#if CONFIG_VAR_TX
409
#define TXFM_PARTITION_CONTEXTS 16
410
typedef uint8_t TXFM_CONTEXT;
411 412
#endif

clang-format's avatar
clang-format committed
413 414 415
#define NONE -1
#define INTRA_FRAME 0
#define LAST_FRAME 1
416

417
#if CONFIG_EXT_REFS
clang-format's avatar
clang-format committed
418 419 420 421 422
#define LAST2_FRAME 2
#define LAST3_FRAME 3
#define GOLDEN_FRAME 4
#define BWDREF_FRAME 5
#define ALTREF_FRAME 6
423
#define LAST_REF_FRAMES (LAST3_FRAME - LAST_FRAME + 1)
424
#else
clang-format's avatar
clang-format committed
425 426
#define GOLDEN_FRAME 2
#define ALTREF_FRAME 3
427 428
#endif  // CONFIG_EXT_REFS

429 430 431
#define INTER_REFS_PER_FRAME (ALTREF_FRAME - LAST_FRAME + 1)
#define TOTAL_REFS_PER_FRAME (ALTREF_FRAME - INTRA_FRAME + 1)

432 433 434 435 436 437 438 439
#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)
440
#endif  // CONFIG_EXT_REFS
441 442

#define SINGLE_REFS (FWD_REFS + BWD_REFS)
clang-format's avatar
clang-format committed
443
#define COMP_REFS (FWD_REFS * BWD_REFS)
444 445

#if CONFIG_REF_MV
446
#define MODE_CTX_REF_FRAMES (TOTAL_REFS_PER_FRAME + COMP_REFS)
447
#else
448
#define MODE_CTX_REF_FRAMES TOTAL_REFS_PER_FRAME
449 450
#endif

451 452 453 454 455
#if CONFIG_SUPERTX
#define PARTITION_SUPERTX_CONTEXTS 2
#define MAX_SUPERTX_BLOCK_SIZE BLOCK_32X32
#endif  // CONFIG_SUPERTX

456 457 458 459 460 461 462 463 464 465
#if CONFIG_LOOP_RESTORATION
typedef enum {
  RESTORE_NONE,
  RESTORE_BILATERAL,
  RESTORE_WIENER,
  RESTORE_SWITCHABLE,
  RESTORE_SWITCHABLE_TYPES = RESTORE_SWITCHABLE,
  RESTORE_TYPES,
} RestorationType;
#endif  // CONFIG_LOOP_RESTORATION
Jingning Han's avatar
Jingning Han committed
466 467 468 469
#ifdef __cplusplus
}  // extern "C"
#endif

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