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