vp8: Change type of stride parameters to ptrdiff_t
[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 Fiona Glaser
7 * Copyright (C) 2012 Daniel Kang
8 *
9 * This file is part of Libav.
10 *
11 * Libav is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; either
14 * version 2.1 of the License, or (at your option) any later version.
15 *
16 * Libav is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
20 *
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with Libav; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 */
25
26 #ifndef AVCODEC_VP8_H
27 #define AVCODEC_VP8_H
28
29 #include "libavutil/buffer.h"
30
31 #include "h264pred.h"
32 #include "thread.h"
33 #include "vp56.h"
34 #include "vp8dsp.h"
35
36 #if HAVE_PTHREADS
37 # include <pthread.h>
38 #elif HAVE_W32THREADS
39 # include "compat/w32pthreads.h"
40 #endif
41
42 #define VP8_MAX_QUANT 127
43
44 enum dct_token {
45 DCT_0,
46 DCT_1,
47 DCT_2,
48 DCT_3,
49 DCT_4,
50 DCT_CAT1,
51 DCT_CAT2,
52 DCT_CAT3,
53 DCT_CAT4,
54 DCT_CAT5,
55 DCT_CAT6,
56 DCT_EOB,
57
58 NUM_DCT_TOKENS
59 };
60
61 // used to signal 4x4 intra pred in luma MBs
62 #define MODE_I4x4 4
63
64 enum inter_mvmode {
65 VP8_MVMODE_ZERO = MODE_I4x4 + 1,
66 VP8_MVMODE_MV,
67 VP8_MVMODE_SPLIT
68 };
69
70 enum inter_splitmvmode {
71 VP8_SPLITMVMODE_16x8 = 0, ///< 2 16x8 blocks (vertical)
72 VP8_SPLITMVMODE_8x16, ///< 2 8x16 blocks (horizontal)
73 VP8_SPLITMVMODE_8x8, ///< 2x2 blocks of 8x8px each
74 VP8_SPLITMVMODE_4x4, ///< 4x4 blocks of 4x4px each
75 VP8_SPLITMVMODE_NONE, ///< (only used in prediction) no split MVs
76 };
77
78 typedef struct VP8FilterStrength {
79 uint8_t filter_level;
80 uint8_t inner_limit;
81 uint8_t inner_filter;
82 } VP8FilterStrength;
83
84 typedef struct VP8Macroblock {
85 uint8_t skip;
86 // TODO: make it possible to check for at least (i4x4 or split_mv)
87 // in one op. are others needed?
88 uint8_t mode;
89 uint8_t ref_frame;
90 uint8_t partitioning;
91 uint8_t chroma_pred_mode;
92 uint8_t segment;
93 uint8_t intra4x4_pred_mode_mb[16];
94 DECLARE_ALIGNED(4, uint8_t, intra4x4_pred_mode_top)[4];
95 VP56mv mv;
96 VP56mv bmv[16];
97 } VP8Macroblock;
98
99 typedef struct VP8ThreadData {
100 DECLARE_ALIGNED(16, int16_t, block)[6][4][16];
101 DECLARE_ALIGNED(16, int16_t, block_dc)[16];
102 /**
103 * This is the index plus one of the last non-zero coeff
104 * for each of the blocks in the current macroblock.
105 * So, 0 -> no coeffs
106 * 1 -> dc-only (special transform)
107 * 2+-> full transform
108 */
109 DECLARE_ALIGNED(16, uint8_t, non_zero_count_cache)[6][4];
110 /**
111 * For coeff decode, we need to know whether the above block had non-zero
112 * coefficients. This means for each macroblock, we need data for 4 luma
113 * blocks, 2 u blocks, 2 v blocks, and the luma dc block, for a total of 9
114 * per macroblock. We keep the last row in top_nnz.
115 */
116 DECLARE_ALIGNED(8, uint8_t, left_nnz)[9];
117 int thread_nr;
118 #if HAVE_THREADS
119 pthread_mutex_t lock;
120 pthread_cond_t cond;
121 #endif
122 int thread_mb_pos; // (mb_y << 16) | (mb_x & 0xFFFF)
123 int wait_mb_pos; // What the current thread is waiting on.
124
125 #define EDGE_EMU_LINESIZE 32
126 DECLARE_ALIGNED(16, uint8_t, edge_emu_buffer)[21 * EDGE_EMU_LINESIZE];
127 VP8FilterStrength *filter_strength;
128 } VP8ThreadData;
129
130 typedef struct VP8Frame {
131 ThreadFrame tf;
132 AVBufferRef *seg_map;
133 } VP8Frame;
134
135 #define MAX_THREADS 8
136 typedef struct VP8Context {
137 VP8ThreadData *thread_data;
138 AVCodecContext *avctx;
139 VP8Frame *framep[4];
140 VP8Frame *next_framep[4];
141 VP8Frame *curframe;
142 VP8Frame *prev_frame;
143
144 uint16_t mb_width; /* number of horizontal MB */
145 uint16_t mb_height; /* number of vertical MB */
146 ptrdiff_t linesize;
147 ptrdiff_t uvlinesize;
148
149 uint8_t keyframe;
150 uint8_t deblock_filter;
151 uint8_t mbskip_enabled;
152 uint8_t profile;
153 VP56mv mv_min;
154 VP56mv mv_max;
155
156 int8_t sign_bias[4]; ///< one state [0, 1] per ref frame type
157 int ref_count[3];
158
159 /**
160 * Base parameters for segmentation, i.e. per-macroblock parameters.
161 * These must be kept unchanged even if segmentation is not used for
162 * a frame, since the values persist between interframes.
163 */
164 struct {
165 uint8_t enabled;
166 uint8_t absolute_vals;
167 uint8_t update_map;
168 int8_t base_quant[4];
169 int8_t filter_level[4]; ///< base loop filter level
170 } segmentation;
171
172 struct {
173 uint8_t simple;
174 uint8_t level;
175 uint8_t sharpness;
176 } filter;
177
178 VP8Macroblock *macroblocks;
179
180 uint8_t *intra4x4_pred_mode_top;
181 uint8_t intra4x4_pred_mode_left[4];
182
183 /**
184 * Macroblocks can have one of 4 different quants in a frame when
185 * segmentation is enabled.
186 * If segmentation is disabled, only the first segment's values are used.
187 */
188 struct {
189 // [0] - DC qmul [1] - AC qmul
190 int16_t luma_qmul[2];
191 int16_t luma_dc_qmul[2]; ///< luma dc-only block quant
192 int16_t chroma_qmul[2];
193 } qmat[4];
194
195 struct {
196 uint8_t enabled; ///< whether each mb can have a different strength based on mode/ref
197
198 /**
199 * filter strength adjustment for the following macroblock modes:
200 * [0-3] - i16x16 (always zero)
201 * [4] - i4x4
202 * [5] - zero mv
203 * [6] - inter modes except for zero or split mv
204 * [7] - split mv
205 * i16x16 modes never have any adjustment
206 */
207 int8_t mode[VP8_MVMODE_SPLIT + 1];
208
209 /**
210 * filter strength adjustment for macroblocks that reference:
211 * [0] - intra / VP56_FRAME_CURRENT
212 * [1] - VP56_FRAME_PREVIOUS
213 * [2] - VP56_FRAME_GOLDEN
214 * [3] - altref / VP56_FRAME_GOLDEN2
215 */
216 int8_t ref[4];
217 } lf_delta;
218
219 uint8_t (*top_border)[16 + 8 + 8];
220 uint8_t (*top_nnz)[9];
221
222 VP56RangeCoder c; ///< header context, includes mb modes and motion vectors
223
224 /**
225 * These are all of the updatable probabilities for binary decisions.
226 * They are only implicitly reset on keyframes, making it quite likely
227 * for an interframe to desync if a prior frame's header was corrupt
228 * or missing outright!
229 */
230 struct {
231 uint8_t segmentid[3];
232 uint8_t mbskip;
233 uint8_t intra;
234 uint8_t last;
235 uint8_t golden;
236 uint8_t pred16x16[4];
237 uint8_t pred8x8c[3];
238 uint8_t token[4][16][3][NUM_DCT_TOKENS - 1];
239 uint8_t mvc[2][19];
240 uint8_t scan[16];
241 } prob[2];
242
243 VP8Macroblock *macroblocks_base;
244 int invisible;
245 int update_last; ///< update VP56_FRAME_PREVIOUS with the current one
246 int update_golden; ///< VP56_FRAME_NONE if not updated, or which frame to copy if so
247 int update_altref;
248
249 /**
250 * If this flag is not set, all the probability updates
251 * are discarded after this frame is decoded.
252 */
253 int update_probabilities;
254
255 /**
256 * All coefficients are contained in separate arith coding contexts.
257 * There can be 1, 2, 4, or 8 of these after the header context.
258 */
259 int num_coeff_partitions;
260 VP56RangeCoder coeff_partition[8];
261 VideoDSPContext vdsp;
262 VP8DSPContext vp8dsp;
263 H264PredContext hpc;
264 vp8_mc_func put_pixels_tab[3][3][3];
265 VP8Frame frames[5];
266
267 uint8_t colorspace; ///< 0 is the only value allowed (meaning bt601)
268 uint8_t fullrange; ///< whether we can skip clamping in dsp functions
269
270 int num_jobs;
271 /**
272 * This describes the macroblock memory layout.
273 * 0 -> Only width+height*2+1 macroblocks allocated (frame/single thread).
274 * 1 -> Macroblocks for entire frame allocated (sliced thread).
275 */
276 int mb_layout;
277
278 /**
279 * Fade bit present in bitstream (VP7)
280 */
281 int fade_present;
282
283 /**
284 * Interframe DC prediction (VP7)
285 * [0] VP56_FRAME_PREVIOUS
286 * [1] VP56_FRAME_GOLDEN
287 */
288 uint16_t inter_dc_pred[2][2];
289
290 /**
291 * Macroblock features (VP7)
292 */
293 uint8_t feature_enabled[4];
294 uint8_t feature_present_prob[4];
295 uint8_t feature_index_prob[4][3];
296 uint8_t feature_value[4][4];
297 } VP8Context;
298
299 int ff_vp8_decode_init(AVCodecContext *avctx);
300
301 int ff_vp8_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
302 AVPacket *avpkt);
303
304 int ff_vp8_decode_free(AVCodecContext *avctx);
305
306 #endif /* AVCODEC_VP8_H */