enums.h 11.6 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 16
#include "./aom_config.h"
#include "aom/aom_integer.h"
Jingning Han's avatar
Jingning Han committed
17 18 19 20 21

#ifdef __cplusplus
extern "C" {
#endif

22 23
#undef MAX_SB_SIZE

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

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

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

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

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

47
// Mask to extract MI offset within max MIB
clang-format's avatar
clang-format committed
48 49
#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
50

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

Jingning Han's avatar
Jingning Han committed
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
// 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;

clang-format's avatar
clang-format committed
75 76 77 78 79 80 81 82 83 84 85 86 87
#define BLOCK_4X4 0
#define BLOCK_4X8 1
#define BLOCK_8X4 2
#define BLOCK_8X8 3
#define BLOCK_8X16 4
#define BLOCK_16X8 5
#define BLOCK_16X16 6
#define BLOCK_16X32 7
#define BLOCK_32X16 8
#define BLOCK_32X32 9
#define BLOCK_32X64 10
#define BLOCK_64X32 11
#define BLOCK_64X64 12
88
#if !CONFIG_EXT_PARTITION
clang-format's avatar
clang-format committed
89
#define BLOCK_SIZES 13
90
#else
clang-format's avatar
clang-format committed
91 92 93 94
#define BLOCK_64X128 13
#define BLOCK_128X64 14
#define BLOCK_128X128 15
#define BLOCK_SIZES 16
95 96
#endif  // !CONFIG_EXT_PARTITION
#define BLOCK_INVALID BLOCK_SIZES
97
#define BLOCK_LARGEST (BLOCK_SIZES - 1)
Jingning Han's avatar
Jingning Han committed
98 99
typedef uint8_t BLOCK_SIZE;

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
#if CONFIG_EXT_PARTITION_TYPES
typedef enum PARTITION_TYPE {
  PARTITION_NONE,
  PARTITION_HORZ,
  PARTITION_VERT,
  PARTITION_SPLIT,
  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,
  PARTITION_TYPES = PARTITION_SPLIT + 1,
  PARTITION_INVALID = EXT_PARTITION_TYPES
} PARTITION_TYPE;
#else
Jingning Han's avatar
Jingning Han committed
115 116 117 118 119 120 121 122
typedef enum PARTITION_TYPE {
  PARTITION_NONE,
  PARTITION_HORZ,
  PARTITION_VERT,
  PARTITION_SPLIT,
  PARTITION_TYPES,
  PARTITION_INVALID = PARTITION_TYPES
} PARTITION_TYPE;
123
#endif  // CONFIG_EXT_PARTITION_TYPES
Jingning Han's avatar
Jingning Han committed
124 125

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

// block transform size
typedef uint8_t TX_SIZE;
clang-format's avatar
clang-format committed
135 136 137 138
#define TX_4X4 ((TX_SIZE)0)    // 4x4 transform
#define TX_8X8 ((TX_SIZE)1)    // 8x8 transform
#define TX_16X16 ((TX_SIZE)2)  // 16x16 transform
#define TX_32X32 ((TX_SIZE)3)  // 32x32 transform
Jingning Han's avatar
Jingning Han committed
139
#define TX_SIZES ((TX_SIZE)4)
140
#define TX_INVALID ((TX_SIZE)255)  // Invalid transform size
Jingning Han's avatar
Jingning Han committed
141

142
#if CONFIG_EXT_TX
clang-format's avatar
clang-format committed
143 144 145 146 147 148
#define TX_4X8 ((TX_SIZE)4)         // 4x8 transform
#define TX_8X4 ((TX_SIZE)5)         // 8x4 transform
#define TX_8X16 ((TX_SIZE)6)        // 8x16 transform
#define TX_16X8 ((TX_SIZE)7)        // 16x8 transform
#define TX_16X32 ((TX_SIZE)8)       // 16x32 transform
#define TX_32X16 ((TX_SIZE)9)       // 32x16 transform
149
#define TX_SIZES_ALL ((TX_SIZE)10)  // Includes rectangular transforms
150 151 152 153
#else
#define TX_SIZES_ALL ((TX_SIZE)4)
#endif  // CONFIG_EXT_TX

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
clang-format's avatar
clang-format committed
212 213
#define EXT_TX_SIZES 3  // number of sizes that use extended transforms
#endif                  // CONFIG_EXT_TX
214

Jingning Han's avatar
Jingning Han committed
215
typedef enum {
Yaowu Xu's avatar
Yaowu Xu committed
216
  AOM_LAST_FLAG = 1 << 0,
217
#if CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
218 219 220 221 222 223
  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
224
#else
Yaowu Xu's avatar
Yaowu Xu committed
225 226 227
  AOM_GOLD_FLAG = 1 << 1,
  AOM_ALT_FLAG = 1 << 2,
  AOM_REFFRAME_ALL = (1 << 3) - 1
228
#endif  // CONFIG_EXT_REFS
Yaowu Xu's avatar
Yaowu Xu committed
229
} AOM_REFFRAME;
Jingning Han's avatar
Jingning Han committed
230

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

hui su's avatar
hui su committed
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
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;

clang-format's avatar
clang-format committed
256 257 258 259 260 261 262 263 264 265
#define DC_PRED 0    // Average of above and left pixels
#define V_PRED 1     // Vertical
#define H_PRED 2     // Horizontal
#define D45_PRED 3   // Directional 45  deg = round(arctan(1/1) * 180/pi)
#define D135_PRED 4  // Directional 135 deg = 180 - 45
#define D117_PRED 5  // Directional 117 deg = 180 - 63
#define D153_PRED 6  // Directional 153 deg = 180 - 27
#define D207_PRED 7  // Directional 207 deg = 180 + 27
#define D63_PRED 8   // Directional 63  deg = round(arctan(2/1) * 180/pi)
#define TM_PRED 9    // True-motion
Jingning Han's avatar
Jingning Han committed
266
#define NEARESTMV 10
clang-format's avatar
clang-format committed
267 268 269
#define NEARMV 11
#define ZEROMV 12
#define NEWMV 13
Yue Chen's avatar
Yue Chen committed
270
#if CONFIG_EXT_INTER
clang-format's avatar
clang-format committed
271
#define NEWFROMNEARMV 14
272
#define NEAREST_NEARESTMV 15
clang-format's avatar
clang-format committed
273 274 275 276 277 278 279 280 281 282
#define NEAREST_NEARMV 16
#define NEAR_NEARESTMV 17
#define NEAR_NEARMV 18
#define NEAREST_NEWMV 19
#define NEW_NEARESTMV 20
#define NEAR_NEWMV 21
#define NEW_NEARMV 22
#define ZERO_ZEROMV 23
#define NEW_NEWMV 24
#define MB_MODE_COUNT 25
Yue Chen's avatar
Yue Chen committed
283
#else
clang-format's avatar
clang-format committed
284
#define MB_MODE_COUNT 14
Yue Chen's avatar
Yue Chen committed
285
#endif  // CONFIG_EXT_INTER
Jingning Han's avatar
Jingning Han committed
286 287 288 289
typedef uint8_t PREDICTION_MODE;

#define INTRA_MODES (TM_PRED + 1)

290 291 292
typedef enum {
  SIMPLE_TRANSLATION = 0,
#if CONFIG_OBMC
clang-format's avatar
clang-format committed
293 294
  OBMC_CAUSAL,  // 2-sided OBMC
#endif          // CONFIG_OBMC
295 296
#if CONFIG_WARPED_MOTION
  WARPED_CAUSAL,  // 2-sided WARPED
clang-format's avatar
clang-format committed
297
#endif            // CONFIG_WARPED_MOTION
298 299 300
  MOTION_VARIATIONS
} MOTION_VARIATION;

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
#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

318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
#if CONFIG_EXT_INTRA
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,
  EXT_INTRA_MODES,
} EXT_INTRA_MODE;

#define FILTER_INTRA_MODES (FILTER_TM_PRED + 1)
#define DIRECTIONAL_MODES (INTRA_MODES - 2)
#endif  // CONFIG_EXT_INTRA

Yue Chen's avatar
Yue Chen committed
337 338 339
#if CONFIG_EXT_INTER
#define INTER_MODES (1 + NEWFROMNEARMV - NEARESTMV)
#else
Jingning Han's avatar
Jingning Han committed
340
#define INTER_MODES (1 + NEWMV - NEARESTMV)
Yue Chen's avatar
Yue Chen committed
341
#endif  // CONFIG_EXT_INTER
Jingning Han's avatar
Jingning Han committed
342

343 344 345 346
#if CONFIG_EXT_INTER
#define INTER_COMPOUND_MODES (1 + NEW_NEWMV - NEAREST_NEARESTMV)
#endif  // CONFIG_EXT_INTER

Jingning Han's avatar
Jingning Han committed
347
#define SKIP_CONTEXTS 3
348 349

#if CONFIG_REF_MV
350
#define NMV_CONTEXTS 3
351

clang-format's avatar
clang-format committed
352
#define NEWMV_MODE_CONTEXTS 7
353
#define ZEROMV_MODE_CONTEXTS 2
clang-format's avatar
clang-format committed
354 355
#define REFMV_MODE_CONTEXTS 9
#define DRL_MODE_CONTEXTS 5
356 357

#define ZEROMV_OFFSET 3
clang-format's avatar
clang-format committed
358
#define REFMV_OFFSET 4
359 360 361

#define NEWMV_CTX_MASK ((1 << ZEROMV_OFFSET) - 1)
#define ZEROMV_CTX_MASK ((1 << (REFMV_OFFSET - ZEROMV_OFFSET)) - 1)
362 363
#define REFMV_CTX_MASK ((1 << (8 - REFMV_OFFSET)) - 1)

clang-format's avatar
clang-format committed
364 365 366
#define ALL_ZERO_FLAG_OFFSET 8
#define SKIP_NEARESTMV_OFFSET 9
#define SKIP_NEARMV_OFFSET 10
367
#define SKIP_NEARESTMV_SUB8X8_OFFSET 11
368 369
#endif

Jingning Han's avatar
Jingning Han committed
370 371 372 373
#define INTER_MODE_CONTEXTS 7

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

375 376
#if CONFIG_REF_MV
#define MAX_REF_MV_STACK_SIZE 16
377 378 379 380 381 382
#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
383 384 385 386 387

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

388 389 390 391 392
#if CONFIG_VAR_TX
#define TXFM_PARTITION_CONTEXTS 9
typedef TX_SIZE TXFM_CONTEXT;
#endif

clang-format's avatar
clang-format committed
393 394 395
#define NONE -1
#define INTRA_FRAME 0
#define LAST_FRAME 1
396

397
#if CONFIG_EXT_REFS
clang-format's avatar
clang-format committed
398 399 400 401 402
#define LAST2_FRAME 2
#define LAST3_FRAME 3
#define GOLDEN_FRAME 4
#define BWDREF_FRAME 5
#define ALTREF_FRAME 6
403
#define LAST_REF_FRAMES (LAST3_FRAME - LAST_FRAME + 1)
404
#else
clang-format's avatar
clang-format committed
405 406
#define GOLDEN_FRAME 2
#define ALTREF_FRAME 3
407 408
#endif  // CONFIG_EXT_REFS

409 410 411
#define INTER_REFS_PER_FRAME (ALTREF_FRAME - LAST_FRAME + 1)
#define TOTAL_REFS_PER_FRAME (ALTREF_FRAME - INTRA_FRAME + 1)

412 413 414 415 416 417 418 419
#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)
420
#endif  // CONFIG_EXT_REFS
421 422

#define SINGLE_REFS (FWD_REFS + BWD_REFS)
clang-format's avatar
clang-format committed
423
#define COMP_REFS (FWD_REFS * BWD_REFS)
424 425

#if CONFIG_REF_MV
426
#define MODE_CTX_REF_FRAMES (TOTAL_REFS_PER_FRAME + COMP_REFS)
427
#else
428
#define MODE_CTX_REF_FRAMES TOTAL_REFS_PER_FRAME
429 430
#endif

431 432 433 434 435
#if CONFIG_SUPERTX
#define PARTITION_SUPERTX_CONTEXTS 2
#define MAX_SUPERTX_BLOCK_SIZE BLOCK_32X32
#endif  // CONFIG_SUPERTX

436 437 438 439 440 441 442 443 444 445
#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
446 447 448 449
#ifdef __cplusplus
}  // extern "C"
#endif

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