ab2b231cce91d0af50c0e00bef9a0608640ccc81
[ffmpeg.git] / libavcodec / vc1.h
1 /*
2  * VC-1 and WMV3 decoder
3  * Copyright (c) 2006-2007 Konstantin Shishkov
4  * Partly based on vc9.c (c) 2005 Anonymous, Alex Beregszaszi, Michael Niedermayer
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /** Markers used in VC-1 AP frame data */
24 //@{
25 enum VC1Code{
26     VC1_CODE_RES0       = 0x00000100,
27     VC1_CODE_ENDOFSEQ   = 0x0000010A,
28     VC1_CODE_SLICE,
29     VC1_CODE_FIELD,
30     VC1_CODE_FRAME,
31     VC1_CODE_ENTRYPOINT,
32     VC1_CODE_SEQHDR,
33 };
34 //@}
35
36 #define IS_MARKER(x) (((x) & ~0xFF) == VC1_CODE_RES0)
37
38 #ifndef VC1_PARSER_ONLY
39 /** Available Profiles */
40 //@{
41 enum Profile {
42     PROFILE_SIMPLE,
43     PROFILE_MAIN,
44     PROFILE_COMPLEX, ///< TODO: WMV9 specific
45     PROFILE_ADVANCED
46 };
47 //@}
48
49 /** Sequence quantizer mode */
50 //@{
51 enum QuantMode {
52     QUANT_FRAME_IMPLICIT,    ///< Implicitly specified at frame level
53     QUANT_FRAME_EXPLICIT,    ///< Explicitly specified at frame level
54     QUANT_NON_UNIFORM,       ///< Non-uniform quant used for all frames
55     QUANT_UNIFORM            ///< Uniform quant used for all frames
56 };
57 //@}
58
59 /** Where quant can be changed */
60 //@{
61 enum DQProfile {
62     DQPROFILE_FOUR_EDGES,
63     DQPROFILE_DOUBLE_EDGES,
64     DQPROFILE_SINGLE_EDGE,
65     DQPROFILE_ALL_MBS
66 };
67 //@}
68
69 /** @name Where quant can be changed
70  */
71 //@{
72 enum DQSingleEdge {
73     DQSINGLE_BEDGE_LEFT,
74     DQSINGLE_BEDGE_TOP,
75     DQSINGLE_BEDGE_RIGHT,
76     DQSINGLE_BEDGE_BOTTOM
77 };
78 //@}
79
80 /** Which pair of edges is quantized with ALTPQUANT */
81 //@{
82 enum DQDoubleEdge {
83     DQDOUBLE_BEDGE_TOPLEFT,
84     DQDOUBLE_BEDGE_TOPRIGHT,
85     DQDOUBLE_BEDGE_BOTTOMRIGHT,
86     DQDOUBLE_BEDGE_BOTTOMLEFT
87 };
88 //@}
89
90 /** MV modes for P frames */
91 //@{
92 enum MVModes {
93     MV_PMODE_1MV_HPEL_BILIN,
94     MV_PMODE_1MV,
95     MV_PMODE_1MV_HPEL,
96     MV_PMODE_MIXED_MV,
97     MV_PMODE_INTENSITY_COMP
98 };
99 //@}
100
101 /** @name MV types for B frames */
102 //@{
103 enum BMVTypes {
104     BMV_TYPE_BACKWARD,
105     BMV_TYPE_FORWARD,
106     BMV_TYPE_INTERPOLATED
107 };
108 //@}
109
110 /** @name Block types for P/B frames */
111 //@{
112 enum TransformTypes {
113     TT_8X8,
114     TT_8X4_BOTTOM,
115     TT_8X4_TOP,
116     TT_8X4, //Both halves
117     TT_4X8_RIGHT,
118     TT_4X8_LEFT,
119     TT_4X8, //Both halves
120     TT_4X4
121 };
122 //@}
123
124 /** One more frame type */
125 #define BI_TYPE 7
126
127 enum CodingSet {
128     CS_HIGH_MOT_INTRA = 0,
129     CS_HIGH_MOT_INTER,
130     CS_LOW_MOT_INTRA,
131     CS_LOW_MOT_INTER,
132     CS_MID_RATE_INTRA,
133     CS_MID_RATE_INTER,
134     CS_HIGH_RATE_INTRA,
135     CS_HIGH_RATE_INTER
136 };
137
138 /** @name Overlap conditions for Advanced Profile */
139 //@{
140 enum COTypes {
141     CONDOVER_NONE = 0,
142     CONDOVER_ALL,
143     CONDOVER_SELECT
144 };
145 //@}
146
147
148 /** The VC1 Context
149  * @fixme Change size wherever another size is more efficient
150  * Many members are only used for Advanced Profile
151  */
152 typedef struct VC1Context{
153     MpegEncContext s;
154
155     int bits;
156
157     /** Simple/Main Profile sequence header */
158     //@{
159     int res_sm;           ///< reserved, 2b
160     int res_x8;           ///< reserved
161     int multires;         ///< frame-level RESPIC syntax element present
162     int res_fasttx;       ///< reserved, always 1
163     int res_transtab;     ///< reserved, always 0
164     int rangered;         ///< RANGEREDFRM (range reduction) syntax element present
165                           ///< at frame level
166     int res_rtm_flag;     ///< reserved, set to 1
167     int reserved;         ///< reserved
168     //@}
169
170     /** Advanced Profile */
171     //@{
172     int level;            ///< 3bits, for Advanced/Simple Profile, provided by TS layer
173     int chromaformat;     ///< 2bits, 2=4:2:0, only defined
174     int postprocflag;     ///< Per-frame processing suggestion flag present
175     int broadcast;        ///< TFF/RFF present
176     int interlace;        ///< Progressive/interlaced (RPTFTM syntax element)
177     int tfcntrflag;       ///< TFCNTR present
178     int panscanflag;      ///< NUMPANSCANWIN, TOPLEFT{X,Y}, BOTRIGHT{X,Y} present
179     int extended_dmv;     ///< Additional extended dmv range at P/B frame-level
180     int color_prim;       ///< 8bits, chroma coordinates of the color primaries
181     int transfer_char;    ///< 8bits, Opto-electronic transfer characteristics
182     int matrix_coef;      ///< 8bits, Color primaries->YCbCr transform matrix
183     int hrd_param_flag;   ///< Presence of Hypothetical Reference
184                           ///< Decoder parameters
185     int psf;              ///< Progressive Segmented Frame
186     //@}
187
188     /** Sequence header data for all Profiles
189      * TODO: choose between ints, uint8_ts and monobit flags
190      */
191     //@{
192     int profile;          ///< 2bits, Profile
193     int frmrtq_postproc;  ///< 3bits,
194     int bitrtq_postproc;  ///< 5bits, quantized framerate-based postprocessing strength
195     int fastuvmc;         ///< Rounding of qpel vector to hpel ? (not in Simple)
196     int extended_mv;      ///< Ext MV in P/B (not in Simple)
197     int dquant;           ///< How qscale varies with MBs, 2bits (not in Simple)
198     int vstransform;      ///< variable-size [48]x[48] transform type + info
199     int overlap;          ///< overlapped transforms in use
200     int quantizer_mode;   ///< 2bits, quantizer mode used for sequence, see QUANT_*
201     int finterpflag;      ///< INTERPFRM present
202     //@}
203
204     /** Frame decoding info for all profiles */
205     //@{
206     uint8_t mv_mode;      ///< MV coding monde
207     uint8_t mv_mode2;     ///< Secondary MV coding mode (B frames)
208     int k_x;              ///< Number of bits for MVs (depends on MV range)
209     int k_y;              ///< Number of bits for MVs (depends on MV range)
210     int range_x, range_y; ///< MV range
211     uint8_t pq, altpq;    ///< Current/alternate frame quantizer scale
212     /** pquant parameters */
213     //@{
214     uint8_t dquantfrm;
215     uint8_t dqprofile;
216     uint8_t dqsbedge;
217     uint8_t dqbilevel;
218     //@}
219     /** AC coding set indexes
220      * @see 8.1.1.10, p(1)10
221      */
222     //@{
223     int c_ac_table_index; ///< Chroma index from ACFRM element
224     int y_ac_table_index; ///< Luma index from AC2FRM element
225     //@}
226     int ttfrm;            ///< Transform type info present at frame level
227     uint8_t ttmbf;        ///< Transform type flag
228     uint8_t ttblk4x4;     ///< Value of ttblk which indicates a 4x4 transform
229     int codingset;        ///< index of current table set from 11.8 to use for luma block decoding
230     int codingset2;       ///< index of current table set from 11.8 to use for chroma block decoding
231     int pqindex;          ///< raw pqindex used in coding set selection
232     int a_avail, c_avail;
233     uint8_t *mb_type_base, *mb_type[3];
234
235
236     /** Luma compensation parameters */
237     //@{
238     uint8_t lumscale;
239     uint8_t lumshift;
240     //@}
241     int16_t bfraction;    ///< Relative position % anchors=> how to scale MVs
242     uint8_t halfpq;       ///< Uniform quant over image and qp+.5
243     uint8_t respic;       ///< Frame-level flag for resized images
244     int buffer_fullness;  ///< HRD info
245     /** Ranges:
246      * -# 0 -> [-64n 63.f] x [-32, 31.f]
247      * -# 1 -> [-128, 127.f] x [-64, 63.f]
248      * -# 2 -> [-512, 511.f] x [-128, 127.f]
249      * -# 3 -> [-1024, 1023.f] x [-256, 255.f]
250      */
251     uint8_t mvrange;
252     uint8_t pquantizer;           ///< Uniform (over sequence) quantizer in use
253     VLC *cbpcy_vlc;               ///< CBPCY VLC table
254     int tt_index;                 ///< Index for Transform Type tables
255     uint8_t* mv_type_mb_plane;    ///< bitplane for mv_type == (4MV)
256     uint8_t* direct_mb_plane;     ///< bitplane for "direct" MBs
257     int mv_type_is_raw;           ///< mv type mb plane is not coded
258     int dmb_is_raw;               ///< direct mb plane is raw
259     int skip_is_raw;              ///< skip mb plane is not coded
260     uint8_t luty[256], lutuv[256]; // lookup tables used for intensity compensation
261     int use_ic;                   ///< use intensity compensation in B-frames
262     int rnd;                      ///< rounding control
263
264     /** Frame decoding info for S/M profiles only */
265     //@{
266     uint8_t rangeredfrm; ///< out_sample = CLIP((in_sample-128)*2+128)
267     uint8_t interpfrm;
268     //@}
269
270     /** Frame decoding info for Advanced profile */
271     //@{
272     uint8_t fcm; ///< 0->Progressive, 2->Frame-Interlace, 3->Field-Interlace
273     uint8_t numpanscanwin;
274     uint8_t tfcntr;
275     uint8_t rptfrm, tff, rff;
276     uint16_t topleftx;
277     uint16_t toplefty;
278     uint16_t bottomrightx;
279     uint16_t bottomrighty;
280     uint8_t uvsamp;
281     uint8_t postproc;
282     int hrd_num_leaky_buckets;
283     uint8_t bit_rate_exponent;
284     uint8_t buffer_size_exponent;
285     uint8_t* acpred_plane;       ///< AC prediction flags bitplane
286     int acpred_is_raw;
287     uint8_t* over_flags_plane;   ///< Overflags bitplane
288     int overflg_is_raw;
289     uint8_t condover;
290     uint16_t *hrd_rate, *hrd_buffer;
291     uint8_t *hrd_fullness;
292     uint8_t range_mapy_flag;
293     uint8_t range_mapuv_flag;
294     uint8_t range_mapy;
295     uint8_t range_mapuv;
296     //@}
297
298     int p_frame_skipped;
299     int bi_type;
300 } VC1Context;
301 #endif