FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vp8.h
Go to the documentation of this file.
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 FFmpeg.
10  *
11  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 #include "libavutil/thread.h"
31 
32 #include "h264pred.h"
33 #include "thread.h"
34 #include "vp56.h"
35 #include "vp8dsp.h"
36 
37 #define VP8_MAX_QUANT 127
38 
39 enum dct_token {
52 
54 };
55 
56 // used to signal 4x4 intra pred in luma MBs
57 #define MODE_I4x4 4
58 
63 };
64 
66  VP8_SPLITMVMODE_16x8 = 0, ///< 2 16x8 blocks (vertical)
67  VP8_SPLITMVMODE_8x16, ///< 2 8x16 blocks (horizontal)
68  VP8_SPLITMVMODE_8x8, ///< 2x2 blocks of 8x8px each
69  VP8_SPLITMVMODE_4x4, ///< 4x4 blocks of 4x4px each
70  VP8_SPLITMVMODE_NONE, ///< (only used in prediction) no split MVs
71 };
72 
73 typedef struct VP8FilterStrength {
78 
79 typedef struct VP8Macroblock {
81  // TODO: make it possible to check for at least (i4x4 or split_mv)
82  // in one op. are others needed?
91  VP56mv bmv[16];
93 
94 typedef struct VP8ThreadData {
95  DECLARE_ALIGNED(16, int16_t, block)[6][4][16];
96  DECLARE_ALIGNED(16, int16_t, block_dc)[16];
97  /**
98  * This is the index plus one of the last non-zero coeff
99  * for each of the blocks in the current macroblock.
100  * So, 0 -> no coeffs
101  * 1 -> dc-only (special transform)
102  * 2+-> full transform
103  */
105  /**
106  * For coeff decode, we need to know whether the above block had non-zero
107  * coefficients. This means for each macroblock, we need data for 4 luma
108  * blocks, 2 u blocks, 2 v blocks, and the luma dc block, for a total of 9
109  * per macroblock. We keep the last row in top_nnz.
110  */
113 #if HAVE_THREADS
114  pthread_mutex_t lock;
115  pthread_cond_t cond;
116 #endif
117  int thread_mb_pos; // (mb_y << 16) | (mb_x & 0xFFFF)
118  int wait_mb_pos; // What the current thread is waiting on.
119 
120 #define EDGE_EMU_LINESIZE 32
123 } VP8ThreadData;
124 
125 typedef struct VP8Frame {
128 } VP8Frame;
129 
130 typedef struct VP8intmv {
131  int x;
132  int y;
133 } VP8intmv;
134 
135 #define MAX_THREADS 8
136 typedef struct VP8Context {
143 
144  uint16_t mb_width; /* number of horizontal MB */
145  uint16_t mb_height; /* number of vertical MB */
146  int linesize;
148 
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 {
168  int8_t base_quant[4];
169  int8_t filter_level[4]; ///< base loop filter level
170  } segmentation;
171 
172  struct {
176  } filter;
177 
179 
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];
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 implictly 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 {
238  uint8_t token[4][16][3][NUM_DCT_TOKENS - 1];
239  uint8_t mvc[2][19];
241  } prob[2];
242 
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
248 
249  /**
250  * If this flag is not set, all the probability updates
251  * are discarded after this frame is decoded.
252  */
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  */
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 alloced (sliced thread).
275  */
277 
278  void (*decode_mb_row_no_filter)(AVCodecContext *avctx, void *tdata, int jobnr, int threadnr);
279  void (*filter_mb_row)(AVCodecContext *avctx, void *tdata, int jobnr, int threadnr);
280 
281  int vp7;
282 
283  /**
284  * Fade bit present in bitstream (VP7)
285  */
287 
288  /**
289  * Interframe DC prediction (VP7)
290  * [0] VP56_FRAME_PREVIOUS
291  * [1] VP56_FRAME_GOLDEN
292  */
293  uint16_t inter_dc_pred[2][2];
294 
295  /**
296  * Macroblock features (VP7)
297  */
302 } VP8Context;
303 
305 
306 int ff_vp8_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
307  AVPacket *avpkt);
308 
310 
311 #endif /* AVCODEC_VP8_H */
uint8_t golden
Definition: vp8.h:235
Definition: vp8.h:42
uint8_t inner_limit
Definition: vp8.h:75
VP8Macroblock * macroblocks
Definition: vp8.h:178
Definition: vp8.h:50
int ff_vp8_decode_free(AVCodecContext *avctx)
Definition: vp8.c:2696
Definition: vp8.h:43
(only used in prediction) no split MVs
Definition: vp8.h:70
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
VP5 and VP6 compatible video decoder (common features)
int8_t sign_bias[4]
one state [0, 1] per ref frame type
Definition: vp8.h:156
uint8_t feature_value[4][4]
Definition: vp8.h:301
uint8_t * intra4x4_pred_mode_top
Definition: vp8.h:180
uint8_t mbskip_enabled
Definition: vp8.h:151
uint8_t token[4][16][3][NUM_DCT_TOKENS-1]
Definition: vp8.h:238
uint8_t scan[16]
Definition: vp8.h:240
int linesize
Definition: vp8.h:146
#define DECLARE_ALIGNED(n, t, v)
Definition: mem.h:53
VP56mv bmv[16]
Definition: vp8.h:91
uint8_t inner_filter
Definition: vp8.h:76
uint8_t segmentid[3]
Definition: vp8.h:231
uint8_t sharpness
Definition: vp8.h:175
2 16x8 blocks (vertical)
Definition: vp8.h:66
int update_probabilities
If this flag is not set, all the probability updates are discarded after this frame is decoded...
Definition: vp8.h:253
VP8Frame * framep[4]
Definition: vp8.h:139
inter_mvmode
Definition: vp8.h:59
uint8_t(* top_nnz)[9]
Definition: vp8.h:220
int num_jobs
Definition: vp8.h:270
uint8_t pred16x16[4]
Definition: vp8.h:236
uint8_t update_map
Definition: vp8.h:167
uint16_t mb_height
Definition: vp8.h:145
int update_golden
VP56_FRAME_NONE if not updated, or which frame to copy if so.
Definition: vp8.h:246
Definition: vp8.h:130
uint8_t intra4x4_pred_mode_top[4]
Definition: vp8.h:89
HMTX pthread_mutex_t
Definition: os2threads.h:49
uint8_t
Definition: vp8.h:40
struct VP8Context::@107 lf_delta
int fade_present
Fade bit present in bitstream (VP7)
Definition: vp8.h:286
mode
Definition: f_perms.c:27
uint8_t ref_frame
Definition: vp8.h:84
int ff_vp8_decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: vp8.c:2682
Multithreading support functions.
Definition: vp8.h:48
VP8 compatible video decoder.
uint8_t mvc[2][19]
Definition: vp8.h:239
VP56mv mv
Definition: vp8.h:90
int8_t base_quant[4]
Definition: vp8.h:168
Context for storing H.264 prediction functions.
Definition: h264pred.h:92
int update_last
update VP56_FRAME_PREVIOUS with the current one
Definition: vp8.h:245
VP8Frame * prev_frame
Definition: vp8.h:142
int num_coeff_partitions
All coefficients are contained in separate arith coding contexts.
Definition: vp8.h:259
vp8_mc_func put_pixels_tab[3][3][3]
Definition: vp8.h:264
uint8_t feature_index_prob[4][3]
Definition: vp8.h:300
uint8_t intra4x4_pred_mode_mb[16]
Definition: vp8.h:88
uint8_t intra4x4_pred_mode_left[4]
Definition: vp8.h:181
uint8_t colorspace
0 is the only value allowed (meaning bt601)
Definition: vp8.h:267
H264PredContext hpc
Definition: vp8.h:263
struct VP8Context::@108 prob[2]
These are all of the updatable probabilities for binary decisions.
Definition: vp8.h:125
uint8_t absolute_vals
Definition: vp8.h:166
uint16_t mb_width
Definition: vp8.h:144
uint8_t last
Definition: vp8.h:234
uint8_t mode
Definition: vp8.h:83
AVCodecContext * avctx
Definition: vp8.h:138
#define EDGE_EMU_LINESIZE
Definition: vp8.h:120
uint16_t inter_dc_pred[2][2]
Interframe DC prediction (VP7) [0] VP56_FRAME_PREVIOUS [1] VP56_FRAME_GOLDEN.
Definition: vp8.h:293
VideoDSPContext vdsp
Definition: vp8.h:261
VP8Macroblock * macroblocks_base
Definition: vp8.h:243
Definition: vp8.h:45
uint8_t edge_emu_buffer[21 *EDGE_EMU_LINESIZE]
Definition: vp8.h:121
int16_t block[6][4][16]
Definition: vp8.h:95
uint8_t keyframe
Definition: vp8.h:149
int x
Definition: vp8.h:131
int16_t luma_qmul[2]
Definition: vp8.h:190
4x4 blocks of 4x4px each
Definition: vp8.h:69
uint8_t deblock_filter
Definition: vp8.h:150
uint8_t feature_present_prob[4]
Definition: vp8.h:299
uint8_t fullrange
whether we can skip clamping in dsp functions
Definition: vp8.h:268
int16_t block_dc[16]
Definition: vp8.h:96
typedef void(APIENTRY *FF_PFNGLACTIVETEXTUREPROC)(GLenum texture)
uint8_t mbskip
Definition: vp8.h:232
int8_t ref[4]
filter strength adjustment for macroblocks that reference: [0] - intra / VP56_FRAME_CURRENT [1] - VP5...
Definition: vp8.h:216
void(* filter_mb_row)(AVCodecContext *avctx, void *tdata, int jobnr, int threadnr)
Definition: vp8.h:279
void(* vp8_mc_func)(uint8_t *dst, ptrdiff_t dstStride, uint8_t *src, ptrdiff_t srcStride, int h, int x, int y)
Definition: vp8dsp.h:33
int16_t luma_dc_qmul[2]
luma dc-only block quant
Definition: vp8.h:191
int16_t chroma_qmul[2]
Definition: vp8.h:192
uint8_t(* top_border)[16+8+8]
Definition: vp8.h:219
ThreadFrame tf
Definition: vp8.h:126
uint8_t segment
Definition: vp8.h:87
Definition: vp8.h:47
struct VP8Context::@105 filter
VP8Frame * curframe
Definition: vp8.h:141
uint8_t simple
Definition: vp8.h:173
VP8Frame frames[5]
Definition: vp8.h:265
uint8_t level
Definition: vp8.h:174
AVBufferRef * seg_map
Definition: vp8.h:127
Definition: vp8.h:51
main external API structure.
Definition: avcodec.h:1532
VP8Frame * next_framep[4]
Definition: vp8.h:140
int mb_layout
This describes the macroblock memory layout.
Definition: vp8.h:276
uint8_t left_nnz[9]
For coeff decode, we need to know whether the above block had non-zero coefficients.
Definition: vp8.h:111
VP56RangeCoder c
header context, includes mb modes and motion vectors
Definition: vp8.h:222
struct VP8Context::@106 qmat[4]
Macroblocks can have one of 4 different quants in a frame when segmentation is enabled.
int y
Definition: vp8.h:132
VP56RangeCoder coeff_partition[8]
Definition: vp8.h:260
int vp7
Definition: vp8.h:281
VP8FilterStrength * filter_strength
Definition: vp8.h:122
VP8intmv mv_min
Definition: vp8.h:153
uint8_t enabled
whether each mb can have a different strength based on mode/ref
Definition: vp8.h:165
dct_token
Definition: vp8.h:39
refcounted data buffer API
Definition: vp8.h:49
int uvlinesize
Definition: vp8.h:147
Definition: vp8.h:41
H.264 / AVC / MPEG4 prediction functions.
Definition: vp56.h:65
int ff_vp8_decode_init(AVCodecContext *avctx)
Definition: vp8.c:2766
int update_altref
Definition: vp8.h:247
VP8intmv mv_max
Definition: vp8.h:154
uint8_t feature_enabled[4]
Macroblock features (VP7)
Definition: vp8.h:298
2 8x16 blocks (horizontal)
Definition: vp8.h:67
uint8_t pred8x8c[3]
Definition: vp8.h:237
A reference to a data buffer.
Definition: buffer.h:81
Definition: vp8.h:44
uint8_t partitioning
Definition: vp8.h:85
void(* decode_mb_row_no_filter)(AVCodecContext *avctx, void *tdata, int jobnr, int threadnr)
Definition: vp8.h:278
int wait_mb_pos
Definition: vp8.h:118
uint8_t chroma_pred_mode
Definition: vp8.h:86
struct VP8Context::@104 segmentation
Base parameters for segmentation, i.e.
Definition: vp8.h:46
int invisible
Definition: vp8.h:244
int ref_count[3]
Definition: vp8.h:157
#define MODE_I4x4
Definition: vp8.h:57
VP8DSPContext vp8dsp
Definition: vp8.h:262
int thread_nr
Definition: vp8.h:112
inter_splitmvmode
Definition: vp8.h:65
int8_t filter_level[4]
base loop filter level
Definition: vp8.h:169
uint8_t intra
Definition: vp8.h:233
uint8_t non_zero_count_cache[6][4]
This is the index plus one of the last non-zero coeff for each of the blocks in the current macrobloc...
Definition: vp8.h:104
uint8_t skip
Definition: vp8.h:80
This structure stores compressed data.
Definition: avcodec.h:1444
uint8_t profile
Definition: vp8.h:152
VP8ThreadData * thread_data
Definition: vp8.h:137
int thread_mb_pos
Definition: vp8.h:117
2x2 blocks of 8x8px each
Definition: vp8.h:68
uint8_t filter_level
Definition: vp8.h:74