Merge remote-tracking branch 'qatar/master'
[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 #ifndef AVCODEC_VC1_H
24 #define AVCODEC_VC1_H
25
26 #include "avcodec.h"
27 #include "mpegvideo.h"
28 #include "intrax8.h"
29 #include "vc1dsp.h"
30
31 /** Markers used in VC-1 AP frame data */
32 //@{
33 enum VC1Code {
34     VC1_CODE_RES0       = 0x00000100,
35     VC1_CODE_ENDOFSEQ   = 0x0000010A,
36     VC1_CODE_SLICE,
37     VC1_CODE_FIELD,
38     VC1_CODE_FRAME,
39     VC1_CODE_ENTRYPOINT,
40     VC1_CODE_SEQHDR,
41 };
42 //@}
43
44 #define IS_MARKER(x) (((x) & ~0xFF) == VC1_CODE_RES0)
45
46 /** Available Profiles */
47 //@{
48 enum Profile {
49     PROFILE_SIMPLE,
50     PROFILE_MAIN,
51     PROFILE_COMPLEX, ///< TODO: WMV9 specific
52     PROFILE_ADVANCED
53 };
54 //@}
55
56 /** Sequence quantizer mode */
57 //@{
58 enum QuantMode {
59     QUANT_FRAME_IMPLICIT,    ///< Implicitly specified at frame level
60     QUANT_FRAME_EXPLICIT,    ///< Explicitly specified at frame level
61     QUANT_NON_UNIFORM,       ///< Non-uniform quant used for all frames
62     QUANT_UNIFORM            ///< Uniform quant used for all frames
63 };
64 //@}
65
66 /** Where quant can be changed */
67 //@{
68 enum DQProfile {
69     DQPROFILE_FOUR_EDGES,
70     DQPROFILE_DOUBLE_EDGES,
71     DQPROFILE_SINGLE_EDGE,
72     DQPROFILE_ALL_MBS
73 };
74 //@}
75
76 /** @name Where quant can be changed
77  */
78 //@{
79 enum DQSingleEdge {
80     DQSINGLE_BEDGE_LEFT,
81     DQSINGLE_BEDGE_TOP,
82     DQSINGLE_BEDGE_RIGHT,
83     DQSINGLE_BEDGE_BOTTOM
84 };
85 //@}
86
87 /** Which pair of edges is quantized with ALTPQUANT */
88 //@{
89 enum DQDoubleEdge {
90     DQDOUBLE_BEDGE_TOPLEFT,
91     DQDOUBLE_BEDGE_TOPRIGHT,
92     DQDOUBLE_BEDGE_BOTTOMRIGHT,
93     DQDOUBLE_BEDGE_BOTTOMLEFT
94 };
95 //@}
96
97 /** MV modes for P frames */
98 //@{
99 enum MVModes {
100     MV_PMODE_1MV_HPEL_BILIN,
101     MV_PMODE_1MV,
102     MV_PMODE_1MV_HPEL,
103     MV_PMODE_MIXED_MV,
104     MV_PMODE_INTENSITY_COMP
105 };
106 //@}
107
108 /** MBMODE for interlaced frame P-picture */
109 //@{
110 enum MBModesIntfr {
111     MV_PMODE_INTFR_1MV,
112     MV_PMODE_INTFR_2MV_FIELD,
113     MV_PMODE_INTFR_2MV,
114     MV_PMODE_INTFR_4MV_FIELD,
115     MV_PMODE_INTFR_4MV,
116     MV_PMODE_INTFR_INTRA,
117 };
118 //@}
119
120 /** @name MV types for B frames */
121 //@{
122 enum BMVTypes {
123     BMV_TYPE_BACKWARD,
124     BMV_TYPE_FORWARD,
125     BMV_TYPE_INTERPOLATED,
126     BMV_TYPE_DIRECT
127 };
128 //@}
129
130 /** @name Block types for P/B frames */
131 //@{
132 enum TransformTypes {
133     TT_8X8,
134     TT_8X4_BOTTOM,
135     TT_8X4_TOP,
136     TT_8X4,         // both halves
137     TT_4X8_RIGHT,
138     TT_4X8_LEFT,
139     TT_4X8,         // both halves
140     TT_4X4
141 };
142 //@}
143
144 enum CodingSet {
145     CS_HIGH_MOT_INTRA = 0,
146     CS_HIGH_MOT_INTER,
147     CS_LOW_MOT_INTRA,
148     CS_LOW_MOT_INTER,
149     CS_MID_RATE_INTRA,
150     CS_MID_RATE_INTER,
151     CS_HIGH_RATE_INTRA,
152     CS_HIGH_RATE_INTER
153 };
154
155 /** @name Overlap conditions for Advanced Profile */
156 //@{
157 enum COTypes {
158     CONDOVER_NONE = 0,
159     CONDOVER_ALL,
160     CONDOVER_SELECT
161 };
162 //@}
163
164
165 /** The VC1 Context
166  * @todo Change size wherever another size is more efficient
167  * Many members are only used for Advanced Profile
168  */
169 typedef struct VC1Context{
170     MpegEncContext s;
171     IntraX8Context x8;
172     VC1DSPContext vc1dsp;
173
174     int bits;
175
176     /** Simple/Main Profile sequence header */
177     //@{
178     int res_sprite;       ///< reserved, sprite mode
179     int res_y411;         ///< reserved, old interlaced mode
180     int res_x8;           ///< reserved
181     int multires;         ///< frame-level RESPIC syntax element present
182     int res_fasttx;       ///< reserved, always 1
183     int res_transtab;     ///< reserved, always 0
184     int rangered;         ///< RANGEREDFRM (range reduction) syntax element present
185                           ///< at frame level
186     int res_rtm_flag;     ///< reserved, set to 1
187     int reserved;         ///< reserved
188     //@}
189
190     /** Advanced Profile */
191     //@{
192     int level;            ///< 3bits, for Advanced/Simple Profile, provided by TS layer
193     int chromaformat;     ///< 2bits, 2=4:2:0, only defined
194     int postprocflag;     ///< Per-frame processing suggestion flag present
195     int broadcast;        ///< TFF/RFF present
196     int interlace;        ///< Progressive/interlaced (RPTFTM syntax element)
197     int tfcntrflag;       ///< TFCNTR present
198     int panscanflag;      ///< NUMPANSCANWIN, TOPLEFT{X,Y}, BOTRIGHT{X,Y} present
199     int refdist_flag;     ///< REFDIST syntax element present in II, IP, PI or PP field picture headers
200     int extended_dmv;     ///< Additional extended dmv range at P/B frame-level
201     int color_prim;       ///< 8bits, chroma coordinates of the color primaries
202     int transfer_char;    ///< 8bits, Opto-electronic transfer characteristics
203     int matrix_coef;      ///< 8bits, Color primaries->YCbCr transform matrix
204     int hrd_param_flag;   ///< Presence of Hypothetical Reference
205                           ///< Decoder parameters
206     int psf;              ///< Progressive Segmented Frame
207     //@}
208
209     /** Sequence header data for all Profiles
210      * TODO: choose between ints, uint8_ts and monobit flags
211      */
212     //@{
213     int profile;          ///< 2bits, Profile
214     int frmrtq_postproc;  ///< 3bits,
215     int bitrtq_postproc;  ///< 5bits, quantized framerate-based postprocessing strength
216     int fastuvmc;         ///< Rounding of qpel vector to hpel ? (not in Simple)
217     int extended_mv;      ///< Ext MV in P/B (not in Simple)
218     int dquant;           ///< How qscale varies with MBs, 2bits (not in Simple)
219     int vstransform;      ///< variable-size [48]x[48] transform type + info
220     int overlap;          ///< overlapped transforms in use
221     int quantizer_mode;   ///< 2bits, quantizer mode used for sequence, see QUANT_*
222     int finterpflag;      ///< INTERPFRM present
223     //@}
224
225     /** Frame decoding info for all profiles */
226     //@{
227     uint8_t mv_mode;             ///< MV coding monde
228     uint8_t mv_mode2;            ///< Secondary MV coding mode (B frames)
229     int k_x;                     ///< Number of bits for MVs (depends on MV range)
230     int k_y;                     ///< Number of bits for MVs (depends on MV range)
231     int range_x, range_y;        ///< MV range
232     uint8_t pq, altpq;           ///< Current/alternate frame quantizer scale
233     uint8_t zz_8x8[4][64];       ///< Zigzag table for TT_8x8, permuted for IDCT
234     int left_blk_sh, top_blk_sh; ///< Either 3 or 0, positions of l/t in blk[]
235     const uint8_t* zz_8x4;       ///< Zigzag scan table for TT_8x4 coding mode
236     const uint8_t* zz_4x8;       ///< Zigzag scan table for TT_4x8 coding mode
237     /** pquant parameters */
238     //@{
239     uint8_t dquantfrm;
240     uint8_t dqprofile;
241     uint8_t dqsbedge;
242     uint8_t dqbilevel;
243     //@}
244     /** AC coding set indexes
245      * @see 8.1.1.10, p(1)10
246      */
247     //@{
248     int c_ac_table_index;    ///< Chroma index from ACFRM element
249     int y_ac_table_index;    ///< Luma index from AC2FRM element
250     //@}
251     int ttfrm;               ///< Transform type info present at frame level
252     uint8_t ttmbf;           ///< Transform type flag
253     int *ttblk_base, *ttblk; ///< Transform type at the block level
254     int codingset;           ///< index of current table set from 11.8 to use for luma block decoding
255     int codingset2;          ///< index of current table set from 11.8 to use for chroma block decoding
256     int pqindex;             ///< raw pqindex used in coding set selection
257     int a_avail, c_avail;
258     uint8_t *mb_type_base, *mb_type[3];
259
260
261     /** Luma compensation parameters */
262     //@{
263     uint8_t lumscale;
264     uint8_t lumshift;
265     //@}
266     int16_t bfraction;    ///< Relative position % anchors=> how to scale MVs
267     uint8_t halfpq;       ///< Uniform quant over image and qp+.5
268     uint8_t respic;       ///< Frame-level flag for resized images
269     int buffer_fullness;  ///< HRD info
270     /** Ranges:
271      * -# 0 -> [-64n 63.f] x [-32, 31.f]
272      * -# 1 -> [-128, 127.f] x [-64, 63.f]
273      * -# 2 -> [-512, 511.f] x [-128, 127.f]
274      * -# 3 -> [-1024, 1023.f] x [-256, 255.f]
275      */
276     uint8_t mvrange;                ///< Extended MV range flag
277     uint8_t pquantizer;             ///< Uniform (over sequence) quantizer in use
278     VLC *cbpcy_vlc;                 ///< CBPCY VLC table
279     int tt_index;                   ///< Index for Transform Type tables (to decode TTMB)
280     uint8_t* mv_type_mb_plane;      ///< bitplane for mv_type == (4MV)
281     uint8_t* direct_mb_plane;       ///< bitplane for "direct" MBs
282     uint8_t* forward_mb_plane;      ///< bitplane for "forward" MBs
283     int mv_type_is_raw;             ///< mv type mb plane is not coded
284     int dmb_is_raw;                 ///< direct mb plane is raw
285     int fmb_is_raw;                 ///< forward mb plane is raw
286     int skip_is_raw;                ///< skip mb plane is not coded
287     uint8_t luty[256], lutuv[256];  ///< lookup tables used for intensity compensation
288     int use_ic;                     ///< use intensity compensation in B-frames
289     int rnd;                        ///< rounding control
290
291     /** Frame decoding info for S/M profiles only */
292     //@{
293     uint8_t rangeredfrm;            ///< out_sample = CLIP((in_sample-128)*2+128)
294     uint8_t interpfrm;
295     //@}
296
297     /** Frame decoding info for Advanced profile */
298     //@{
299     uint8_t fcm; ///< 0->Progressive, 2->Frame-Interlace, 3->Field-Interlace
300     uint8_t numpanscanwin;
301     uint8_t tfcntr;
302     uint8_t rptfrm, tff, rff;
303     uint16_t topleftx;
304     uint16_t toplefty;
305     uint16_t bottomrightx;
306     uint16_t bottomrighty;
307     uint8_t uvsamp;
308     uint8_t postproc;
309     int hrd_num_leaky_buckets;
310     uint8_t bit_rate_exponent;
311     uint8_t buffer_size_exponent;
312     uint8_t* acpred_plane;       ///< AC prediction flags bitplane
313     int acpred_is_raw;
314     uint8_t* over_flags_plane;   ///< Overflags bitplane
315     int overflg_is_raw;
316     uint8_t condover;
317     uint16_t *hrd_rate, *hrd_buffer;
318     uint8_t *hrd_fullness;
319     uint8_t range_mapy_flag;
320     uint8_t range_mapuv_flag;
321     uint8_t range_mapy;
322     uint8_t range_mapuv;
323     //@}
324
325     /** Frame decoding info for interlaced picture */
326     uint8_t dmvrange;   ///< Extended differential MV range flag
327     int fourmvswitch;
328     int intcomp;
329     uint8_t lumscale2;  ///< for interlaced field P picture
330     uint8_t lumshift2;
331     uint8_t luty2[256], lutuv2[256]; // lookup tables used for intensity compensation
332     VLC* mbmode_vlc;
333     VLC* imv_vlc;
334     VLC* twomvbp_vlc;
335     VLC* fourmvbp_vlc;
336     uint8_t twomvbp;
337     uint8_t fourmvbp;
338     uint8_t* fieldtx_plane;
339     int fieldtx_is_raw;
340     int8_t zzi_8x8[64];
341     uint8_t *blk_mv_type_base, *blk_mv_type;    ///< 0: frame MV, 1: field MV (interlaced frame)
342     uint8_t *mv_f_base, *mv_f[2];               ///< 0: MV obtained from same field, 1: opposite field
343     uint8_t *mv_f_last_base, *mv_f_last[2];
344     uint8_t *mv_f_next_base, *mv_f_next[2];
345     int field_mode;         ///< 1 for interlaced field pictures
346     int fptype;
347     int second_field;
348     int refdist;            ///< distance of the current picture from reference
349     int numref;             ///< number of past field pictures used as reference
350                             // 0 corresponds to 1 and 1 corresponds to 2 references
351     int reffield;           ///< if numref = 0 (1 reference) then reffield decides which
352                             // field to use among the two fields from previous frame
353     int intcompfield;       ///< which of the two fields to be intensity compensated
354                             // 0: both fields, 1: bottom field, 2: top field
355     int cur_field_type;     ///< 0: top, 1: bottom
356     int ref_field_type[2];  ///< forward and backward reference field type (top or bottom)
357     int blocks_off, mb_off;
358     int qs_last;            ///< if qpel has been used in the previous (tr.) picture
359     int bmvtype;
360     int frfd, brfd;         ///< reference frame distance (forward or backward)
361     int pic_header_flag;
362
363     /** Frame decoding info for sprite modes */
364     //@{
365     int new_sprite;
366     int two_sprites;
367     AVFrame sprite_output_frame;
368     int output_width, output_height, sprite_width, sprite_height;
369     uint8_t* sr_rows[2][2];      ///< Sprite resizer line cache
370     //@}
371
372     int p_frame_skipped;
373     int bi_type;
374     int x8_type;
375
376     DCTELEM (*block)[6][64];
377     int n_allocated_blks, cur_blk_idx, left_blk_idx, topleft_blk_idx, top_blk_idx;
378     uint32_t *cbp_base, *cbp;
379     uint8_t *is_intra_base, *is_intra;
380     int16_t (*luma_mv_base)[2], (*luma_mv)[2];
381     uint8_t bfraction_lut_index; ///< Index for BFRACTION value (see Table 40, reproduced into ff_vc1_bfraction_lut[])
382     uint8_t broken_link;         ///< Broken link flag (BROKEN_LINK syntax element)
383     uint8_t closed_entry;        ///< Closed entry point flag (CLOSED_ENTRY syntax element)
384
385     int parse_only;              ///< Context is used within parser
386
387     int warn_interlaced;
388 } VC1Context;
389
390 /** Find VC-1 marker in buffer
391  * @return position where next marker starts or end of buffer if no marker found
392  */
393 static av_always_inline const uint8_t* find_next_marker(const uint8_t *src, const uint8_t *end)
394 {
395     uint32_t mrk = 0xFFFFFFFF;
396
397     if (end-src < 4)
398         return end;
399     while (src < end) {
400         mrk = (mrk << 8) | *src++;
401         if (IS_MARKER(mrk))
402             return src - 4;
403     }
404     return end;
405 }
406
407 static av_always_inline int vc1_unescape_buffer(const uint8_t *src, int size, uint8_t *dst)
408 {
409     int dsize = 0, i;
410
411     if (size < 4) {
412         for (dsize = 0; dsize < size; dsize++)
413             *dst++ = *src++;
414         return size;
415     }
416     for (i = 0; i < size; i++, src++) {
417         if (src[0] == 3 && i >= 2 && !src[-1] && !src[-2] && i < size-1 && src[1] < 4) {
418             dst[dsize++] = src[1];
419             src++;
420             i++;
421         } else
422             dst[dsize++] = *src;
423     }
424     return dsize;
425 }
426
427 /**
428  * Decode Simple/Main Profiles sequence header
429  * @see Figure 7-8, p16-17
430  * @param avctx Codec context
431  * @param gb GetBit context initialized from Codec context extra_data
432  * @return Status
433  */
434 int vc1_decode_sequence_header(AVCodecContext *avctx, VC1Context *v, GetBitContext *gb);
435
436 int vc1_decode_entry_point(AVCodecContext *avctx, VC1Context *v, GetBitContext *gb);
437
438 int vc1_parse_frame_header    (VC1Context *v, GetBitContext *gb);
439 int vc1_parse_frame_header_adv(VC1Context *v, GetBitContext *gb);
440
441 #endif /* AVCODEC_VC1_H */