xref: /third_party/ffmpeg/libavcodec/av1.h (revision cabdff1a)
1/*
2 * This file is part of FFmpeg.
3 *
4 * FFmpeg is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * FFmpeg is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19/**
20 * @file
21 * AV1 common definitions
22 */
23
24#ifndef AVCODEC_AV1_H
25#define AVCODEC_AV1_H
26
27// OBU types (section 6.2.2).
28typedef enum {
29    // 0 reserved.
30    AV1_OBU_SEQUENCE_HEADER        = 1,
31    AV1_OBU_TEMPORAL_DELIMITER     = 2,
32    AV1_OBU_FRAME_HEADER           = 3,
33    AV1_OBU_TILE_GROUP             = 4,
34    AV1_OBU_METADATA               = 5,
35    AV1_OBU_FRAME                  = 6,
36    AV1_OBU_REDUNDANT_FRAME_HEADER = 7,
37    AV1_OBU_TILE_LIST              = 8,
38    // 9-14 reserved.
39    AV1_OBU_PADDING                = 15,
40} AV1_OBU_Type;
41
42// Metadata types (section 6.7.1).
43enum {
44    AV1_METADATA_TYPE_HDR_CLL     = 1,
45    AV1_METADATA_TYPE_HDR_MDCV    = 2,
46    AV1_METADATA_TYPE_SCALABILITY = 3,
47    AV1_METADATA_TYPE_ITUT_T35    = 4,
48    AV1_METADATA_TYPE_TIMECODE    = 5,
49};
50
51// Frame types (section 6.8.2).
52enum {
53    AV1_FRAME_KEY        = 0,
54    AV1_FRAME_INTER      = 1,
55    AV1_FRAME_INTRA_ONLY = 2,
56    AV1_FRAME_SWITCH     = 3,
57};
58
59// Reference frames (section 6.10.24).
60enum {
61    AV1_REF_FRAME_INTRA   = 0,
62    AV1_REF_FRAME_LAST    = 1,
63    AV1_REF_FRAME_LAST2   = 2,
64    AV1_REF_FRAME_LAST3   = 3,
65    AV1_REF_FRAME_GOLDEN  = 4,
66    AV1_REF_FRAME_BWDREF  = 5,
67    AV1_REF_FRAME_ALTREF2 = 6,
68    AV1_REF_FRAME_ALTREF  = 7,
69};
70
71// Constants (section 3).
72enum {
73    AV1_MAX_OPERATING_POINTS = 32,
74
75    AV1_MAX_SB_SIZE    = 128,
76    AV1_MI_SIZE        = 4,
77
78    AV1_MAX_TILE_WIDTH = 4096,
79    AV1_MAX_TILE_AREA  = 4096 * 2304,
80    AV1_MAX_TILE_ROWS  = 64,
81    AV1_MAX_TILE_COLS  = 64,
82
83    AV1_NUM_REF_FRAMES       = 8,
84    AV1_REFS_PER_FRAME       = 7,
85    AV1_TOTAL_REFS_PER_FRAME = 8,
86    AV1_PRIMARY_REF_NONE     = 7,
87
88    AV1_MAX_SEGMENTS = 8,
89    AV1_SEG_LVL_MAX  = 8,
90
91    AV1_SEG_LVL_ALT_Q      = 0,
92    AV1_SEG_LVL_ALT_LF_Y_V = 1,
93    AV1_SEG_LVL_REF_FRAME  = 5,
94    AV1_SEG_LVL_SKIP       = 6,
95    AV1_SEG_LVL_GLOBAL_MV  = 7,
96
97    AV1_SELECT_SCREEN_CONTENT_TOOLS = 2,
98    AV1_SELECT_INTEGER_MV           = 2,
99
100    AV1_SUPERRES_NUM       = 8,
101    AV1_SUPERRES_DENOM_MIN = 9,
102
103    AV1_INTERPOLATION_FILTER_SWITCHABLE = 4,
104
105    AV1_GM_ABS_ALPHA_BITS       = 12,
106    AV1_GM_ALPHA_PREC_BITS      = 15,
107    AV1_GM_ABS_TRANS_ONLY_BITS  = 9,
108    AV1_GM_TRANS_ONLY_PREC_BITS = 3,
109    AV1_GM_ABS_TRANS_BITS       = 12,
110    AV1_GM_TRANS_PREC_BITS      = 6,
111    AV1_WARPEDMODEL_PREC_BITS   = 16,
112
113    AV1_WARP_MODEL_IDENTITY    = 0,
114    AV1_WARP_MODEL_TRANSLATION = 1,
115    AV1_WARP_MODEL_ROTZOOM     = 2,
116    AV1_WARP_MODEL_AFFINE      = 3,
117    AV1_WARP_PARAM_REDUCE_BITS = 6,
118
119    AV1_DIV_LUT_BITS      = 8,
120    AV1_DIV_LUT_PREC_BITS = 14,
121    AV1_DIV_LUT_NUM       = 257,
122
123    AV1_MAX_LOOP_FILTER = 63,
124};
125
126
127// The main colour configuration information uses the same ISO/IEC 23001-8
128// (H.273) enums as FFmpeg does, so separate definitions are not required.
129
130// Chroma sample position.
131enum {
132    AV1_CSP_UNKNOWN   = 0,
133    AV1_CSP_VERTICAL  = 1, // -> AVCHROMA_LOC_LEFT.
134    AV1_CSP_COLOCATED = 2, // -> AVCHROMA_LOC_TOPLEFT.
135};
136
137// Scalability modes (section 6.7.5)
138enum {
139    AV1_SCALABILITY_L1T2 = 0,
140    AV1_SCALABILITY_L1T3 = 1,
141    AV1_SCALABILITY_L2T1 = 2,
142    AV1_SCALABILITY_L2T2 = 3,
143    AV1_SCALABILITY_L2T3 = 4,
144    AV1_SCALABILITY_S2T1 = 5,
145    AV1_SCALABILITY_S2T2 = 6,
146    AV1_SCALABILITY_S2T3 = 7,
147    AV1_SCALABILITY_L2T1h = 8,
148    AV1_SCALABILITY_L2T2h = 9,
149    AV1_SCALABILITY_L2T3h = 10,
150    AV1_SCALABILITY_S2T1h = 11,
151    AV1_SCALABILITY_S2T2h = 12,
152    AV1_SCALABILITY_S2T3h = 13,
153    AV1_SCALABILITY_SS = 14,
154    AV1_SCALABILITY_L3T1 = 15,
155    AV1_SCALABILITY_L3T2 = 16,
156    AV1_SCALABILITY_L3T3 = 17,
157    AV1_SCALABILITY_S3T1 = 18,
158    AV1_SCALABILITY_S3T2 = 19,
159    AV1_SCALABILITY_S3T3 = 20,
160    AV1_SCALABILITY_L3T2_KEY = 21,
161    AV1_SCALABILITY_L3T3_KEY = 22,
162    AV1_SCALABILITY_L4T5_KEY = 23,
163    AV1_SCALABILITY_L4T7_KEY = 24,
164    AV1_SCALABILITY_L3T2_KEY_SHIFT = 25,
165    AV1_SCALABILITY_L3T3_KEY_SHIFT = 26,
166    AV1_SCALABILITY_L4T5_KEY_SHIFT = 27,
167    AV1_SCALABILITY_L4T7_KEY_SHIFT = 28,
168};
169
170// Frame Restoration types (section 6.10.15)
171enum {
172    AV1_RESTORE_NONE       = 0,
173    AV1_RESTORE_WIENER     = 1,
174    AV1_RESTORE_SGRPROJ    = 2,
175    AV1_RESTORE_SWITCHABLE = 3,
176};
177
178// Sequence Headers are actually unbounded because one can use
179// an arbitrary number of leading zeroes when encoding via uvlc.
180// The following estimate is based around using the lowest number
181// of bits for uvlc encoding.
182#define AV1_SANE_SEQUENCE_HEADER_MAX_BITS           3138
183
184#endif /* AVCODEC_AV1_H */
185