vp8: move data from VP8Context->VP8Macroblock
[libav.git] / libavcodec / vp8.h
1 /*
2 * VP8 compatible video decoder
3 *
4 * Copyright (C) 2010 David Conrad
5 * Copyright (C) 2010 Ronald S. Bultje
6 * Copyright (C) 2010 Jason Garrett-Glaser
7 *
8 * This file is part of Libav.
9 *
10 * Libav is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
14 *
15 * Libav is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with Libav; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 */
24
25 #ifndef AVCODEC_VP8_H
26 #define AVCODEC_VP8_H
27
28 #include "vp56.h"
29 #include "vp56data.h"
30 #include "vp8dsp.h"
31 #include "h264pred.h"
32
33 #define VP8_MAX_QUANT 127
34
35 enum dct_token {
36 DCT_0,
37 DCT_1,
38 DCT_2,
39 DCT_3,
40 DCT_4,
41 DCT_CAT1,
42 DCT_CAT2,
43 DCT_CAT3,
44 DCT_CAT4,
45 DCT_CAT5,
46 DCT_CAT6,
47 DCT_EOB,
48
49 NUM_DCT_TOKENS
50 };
51
52 // used to signal 4x4 intra pred in luma MBs
53 #define MODE_I4x4 4
54
55 enum inter_mvmode {
56 VP8_MVMODE_ZERO = MODE_I4x4 + 1,
57 VP8_MVMODE_MV,
58 VP8_MVMODE_SPLIT
59 };
60
61 enum inter_splitmvmode {
62 VP8_SPLITMVMODE_16x8 = 0, ///< 2 16x8 blocks (vertical)
63 VP8_SPLITMVMODE_8x16, ///< 2 8x16 blocks (horizontal)
64 VP8_SPLITMVMODE_8x8, ///< 2x2 blocks of 8x8px each
65 VP8_SPLITMVMODE_4x4, ///< 4x4 blocks of 4x4px each
66 VP8_SPLITMVMODE_NONE, ///< (only used in prediction) no split MVs
67 };
68
69 typedef struct {
70 uint8_t filter_level;
71 uint8_t inner_limit;
72 uint8_t inner_filter;
73 } VP8FilterStrength;
74
75 typedef struct {
76 uint8_t skip;
77 // todo: make it possible to check for at least (i4x4 or split_mv)
78 // in one op. are others needed?
79 uint8_t mode;
80 uint8_t ref_frame;
81 uint8_t partitioning;
82 uint8_t chroma_pred_mode;
83 uint8_t segment;
84 uint8_t intra4x4_pred_mode_mb[16];
85 uint8_t intra4x4_pred_mode_top[4];
86 VP56mv mv;
87 VP56mv bmv[16];
88 } VP8Macroblock;
89
90 typedef struct {
91 AVCodecContext *avctx;
92 AVFrame *framep[4];
93 AVFrame *next_framep[4];
94 uint8_t *edge_emu_buffer;
95
96 uint16_t mb_width; /* number of horizontal MB */
97 uint16_t mb_height; /* number of vertical MB */
98 int linesize;
99 int uvlinesize;
100
101 uint8_t keyframe;
102 uint8_t deblock_filter;
103 uint8_t mbskip_enabled;
104 uint8_t profile;
105 VP56mv mv_min;
106 VP56mv mv_max;
107
108 int8_t sign_bias[4]; ///< one state [0, 1] per ref frame type
109 int ref_count[3];
110
111 /**
112 * Base parameters for segmentation, i.e. per-macroblock parameters.
113 * These must be kept unchanged even if segmentation is not used for
114 * a frame, since the values persist between interframes.
115 */
116 struct {
117 uint8_t enabled;
118 uint8_t absolute_vals;
119 uint8_t update_map;
120 int8_t base_quant[4];
121 int8_t filter_level[4]; ///< base loop filter level
122 } segmentation;
123
124 struct {
125 uint8_t simple;
126 uint8_t level;
127 uint8_t sharpness;
128 } filter;
129
130 VP8Macroblock *macroblocks;
131 VP8FilterStrength *filter_strength;
132
133 uint8_t *intra4x4_pred_mode_top;
134 uint8_t intra4x4_pred_mode_left[4];
135
136 /**
137 * Macroblocks can have one of 4 different quants in a frame when
138 * segmentation is enabled.
139 * If segmentation is disabled, only the first segment's values are used.
140 */
141 struct {
142 // [0] - DC qmul [1] - AC qmul
143 int16_t luma_qmul[2];
144 int16_t luma_dc_qmul[2]; ///< luma dc-only block quant
145 int16_t chroma_qmul[2];
146 } qmat[4];
147
148 struct {
149 uint8_t enabled; ///< whether each mb can have a different strength based on mode/ref
150
151 /**
152 * filter strength adjustment for the following macroblock modes:
153 * [0-3] - i16x16 (always zero)
154 * [4] - i4x4
155 * [5] - zero mv
156 * [6] - inter modes except for zero or split mv
157 * [7] - split mv
158 * i16x16 modes never have any adjustment
159 */
160 int8_t mode[VP8_MVMODE_SPLIT+1];
161
162 /**
163 * filter strength adjustment for macroblocks that reference:
164 * [0] - intra / VP56_FRAME_CURRENT
165 * [1] - VP56_FRAME_PREVIOUS
166 * [2] - VP56_FRAME_GOLDEN
167 * [3] - altref / VP56_FRAME_GOLDEN2
168 */
169 int8_t ref[4];
170 } lf_delta;
171
172 /**
173 * Cache of the top row needed for intra prediction
174 * 16 for luma, 8 for each chroma plane
175 */
176 uint8_t (*top_border)[16+8+8];
177
178 /**
179 * For coeff decode, we need to know whether the above block had non-zero
180 * coefficients. This means for each macroblock, we need data for 4 luma
181 * blocks, 2 u blocks, 2 v blocks, and the luma dc block, for a total of 9
182 * per macroblock. We keep the last row in top_nnz.
183 */
184 uint8_t (*top_nnz)[9];
185 DECLARE_ALIGNED(8, uint8_t, left_nnz)[9];
186
187 /**
188 * This is the index plus one of the last non-zero coeff
189 * for each of the blocks in the current macroblock.
190 * So, 0 -> no coeffs
191 * 1 -> dc-only (special transform)
192 * 2+-> full transform
193 */
194 DECLARE_ALIGNED(16, uint8_t, non_zero_count_cache)[6][4];
195 VP56RangeCoder c; ///< header context, includes mb modes and motion vectors
196 DECLARE_ALIGNED(16, DCTELEM, block)[6][4][16];
197 DECLARE_ALIGNED(16, DCTELEM, block_dc)[16];
198
199 /**
200 * These are all of the updatable probabilities for binary decisions.
201 * They are only implictly reset on keyframes, making it quite likely
202 * for an interframe to desync if a prior frame's header was corrupt
203 * or missing outright!
204 */
205 struct {
206 uint8_t segmentid[3];
207 uint8_t mbskip;
208 uint8_t intra;
209 uint8_t last;
210 uint8_t golden;
211 uint8_t pred16x16[4];
212 uint8_t pred8x8c[3];
213 uint8_t token[4][16][3][NUM_DCT_TOKENS-1];
214 uint8_t mvc[2][19];
215 } prob[2];
216
217 VP8Macroblock *macroblocks_base;
218 int invisible;
219 int update_last; ///< update VP56_FRAME_PREVIOUS with the current one
220 int update_golden; ///< VP56_FRAME_NONE if not updated, or which frame to copy if so
221 int update_altref;
222
223 /**
224 * If this flag is not set, all the probability updates
225 * are discarded after this frame is decoded.
226 */
227 int update_probabilities;
228
229 /**
230 * All coefficients are contained in separate arith coding contexts.
231 * There can be 1, 2, 4, or 8 of these after the header context.
232 */
233 int num_coeff_partitions;
234 VP56RangeCoder coeff_partition[8];
235 DSPContext dsp;
236 VP8DSPContext vp8dsp;
237 H264PredContext hpc;
238 vp8_mc_func put_pixels_tab[3][3][3];
239 AVFrame frames[5];
240
241 /**
242 * A list of segmentation_map buffers that are to be free()'ed in
243 * the next decoding iteration. We can't free() them right away
244 * because the map may still be used by subsequent decoding threads.
245 * Unused if frame threading is off.
246 */
247 uint8_t *segmentation_maps[5];
248 int num_maps_to_be_freed;
249 int maps_are_invalid;
250 } VP8Context;
251
252 #endif /* AVCODEC_VP8_H */