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 
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_OS2THREADS
39 # include "compat/os2threads.h"
40 #elif HAVE_W32THREADS
41 # include "compat/w32pthreads.h"
42 #endif
43 
44 #define VP8_MAX_QUANT 127
45 
46 enum dct_token {
59 
61 };
62 
63 // used to signal 4x4 intra pred in luma MBs
64 #define MODE_I4x4 4
65 
70 };
71 
73  VP8_SPLITMVMODE_16x8 = 0, ///< 2 16x8 blocks (vertical)
74  VP8_SPLITMVMODE_8x16, ///< 2 8x16 blocks (horizontal)
75  VP8_SPLITMVMODE_8x8, ///< 2x2 blocks of 8x8px each
76  VP8_SPLITMVMODE_4x4, ///< 4x4 blocks of 4x4px each
77  VP8_SPLITMVMODE_NONE, ///< (only used in prediction) no split MVs
78 };
79 
80 typedef struct VP8FilterStrength {
85 
86 typedef struct VP8Macroblock {
88  // TODO: make it possible to check for at least (i4x4 or split_mv)
89  // in one op. are others needed?
98  VP56mv bmv[16];
100 
101 typedef struct VP8ThreadData {
102  DECLARE_ALIGNED(16, int16_t, block)[6][4][16];
103  DECLARE_ALIGNED(16, int16_t, block_dc)[16];
104  /**
105  * This is the index plus one of the last non-zero coeff
106  * for each of the blocks in the current macroblock.
107  * So, 0 -> no coeffs
108  * 1 -> dc-only (special transform)
109  * 2+-> full transform
110  */
112  /**
113  * For coeff decode, we need to know whether the above block had non-zero
114  * coefficients. This means for each macroblock, we need data for 4 luma
115  * blocks, 2 u blocks, 2 v blocks, and the luma dc block, for a total of 9
116  * per macroblock. We keep the last row in top_nnz.
117  */
120 #if HAVE_THREADS
121  pthread_mutex_t lock;
122  pthread_cond_t cond;
123 #endif
124  int thread_mb_pos; // (mb_y << 16) | (mb_x & 0xFFFF)
125  int wait_mb_pos; // What the current thread is waiting on.
126 
127 #define EDGE_EMU_LINESIZE 32
130 } VP8ThreadData;
131 
132 typedef struct VP8Frame {
135 } VP8Frame;
136 
137 typedef struct VP8intmv {
138  int x;
139  int y;
140 } VP8intmv;
141 
142 #define MAX_THREADS 8
143 typedef struct VP8Context {
150 
151  uint16_t mb_width; /* number of horizontal MB */
152  uint16_t mb_height; /* number of vertical MB */
153  int linesize;
155 
162 
163  int8_t sign_bias[4]; ///< one state [0, 1] per ref frame type
164  int ref_count[3];
165 
166  /**
167  * Base parameters for segmentation, i.e. per-macroblock parameters.
168  * These must be kept unchanged even if segmentation is not used for
169  * a frame, since the values persist between interframes.
170  */
171  struct {
175  int8_t base_quant[4];
176  int8_t filter_level[4]; ///< base loop filter level
177  } segmentation;
178 
179  struct {
183  } filter;
184 
186 
189 
190  /**
191  * Macroblocks can have one of 4 different quants in a frame when
192  * segmentation is enabled.
193  * If segmentation is disabled, only the first segment's values are used.
194  */
195  struct {
196  // [0] - DC qmul [1] - AC qmul
197  int16_t luma_qmul[2];
198  int16_t luma_dc_qmul[2]; ///< luma dc-only block quant
199  int16_t chroma_qmul[2];
200  } qmat[4];
201 
202  struct {
203  uint8_t enabled; ///< whether each mb can have a different strength based on mode/ref
204 
205  /**
206  * filter strength adjustment for the following macroblock modes:
207  * [0-3] - i16x16 (always zero)
208  * [4] - i4x4
209  * [5] - zero mv
210  * [6] - inter modes except for zero or split mv
211  * [7] - split mv
212  * i16x16 modes never have any adjustment
213  */
214  int8_t mode[VP8_MVMODE_SPLIT + 1];
215 
216  /**
217  * filter strength adjustment for macroblocks that reference:
218  * [0] - intra / VP56_FRAME_CURRENT
219  * [1] - VP56_FRAME_PREVIOUS
220  * [2] - VP56_FRAME_GOLDEN
221  * [3] - altref / VP56_FRAME_GOLDEN2
222  */
223  int8_t ref[4];
224  } lf_delta;
225 
226  uint8_t (*top_border)[16 + 8 + 8];
228 
229  VP56RangeCoder c; ///< header context, includes mb modes and motion vectors
230 
231  /**
232  * These are all of the updatable probabilities for binary decisions.
233  * They are only implictly reset on keyframes, making it quite likely
234  * for an interframe to desync if a prior frame's header was corrupt
235  * or missing outright!
236  */
237  struct {
245  uint8_t token[4][16][3][NUM_DCT_TOKENS - 1];
246  uint8_t mvc[2][19];
248  } prob[2];
249 
252  int update_last; ///< update VP56_FRAME_PREVIOUS with the current one
253  int update_golden; ///< VP56_FRAME_NONE if not updated, or which frame to copy if so
255 
256  /**
257  * If this flag is not set, all the probability updates
258  * are discarded after this frame is decoded.
259  */
261 
262  /**
263  * All coefficients are contained in separate arith coding contexts.
264  * There can be 1, 2, 4, or 8 of these after the header context.
265  */
273 
274  uint8_t colorspace; ///< 0 is the only value allowed (meaning bt601)
275  uint8_t fullrange; ///< whether we can skip clamping in dsp functions
276 
277  int num_jobs;
278  /**
279  * This describes the macroblock memory layout.
280  * 0 -> Only width+height*2+1 macroblocks allocated (frame/single thread).
281  * 1 -> Macroblocks for entire frame alloced (sliced thread).
282  */
284 
285  void (*decode_mb_row_no_filter)(AVCodecContext *avctx, void *tdata, int jobnr, int threadnr);
286  void (*filter_mb_row)(AVCodecContext *avctx, void *tdata, int jobnr, int threadnr);
287 
288  int vp7;
289 
290  /**
291  * Fade bit present in bitstream (VP7)
292  */
294 
295  /**
296  * Interframe DC prediction (VP7)
297  * [0] VP56_FRAME_PREVIOUS
298  * [1] VP56_FRAME_GOLDEN
299  */
300  uint16_t inter_dc_pred[2][2];
301 
302  /**
303  * Macroblock features (VP7)
304  */
309 } VP8Context;
310 
312 
313 int ff_vp8_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
314  AVPacket *avpkt);
315 
317 
318 #endif /* AVCODEC_VP8_H */
uint8_t golden
Definition: vp8.h:242
Definition: vp8.h:49
uint8_t inner_limit
Definition: vp8.h:82
VP8Macroblock * macroblocks
Definition: vp8.h:185
Definition: vp8.h:57
int ff_vp8_decode_free(AVCodecContext *avctx)
Definition: vp8.c:2687
Definition: vp8.h:50
(only used in prediction) no split MVs
Definition: vp8.h:77
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:163
uint8_t feature_value[4][4]
Definition: vp8.h:308
uint8_t * intra4x4_pred_mode_top
Definition: vp8.h:187
uint8_t mbskip_enabled
Definition: vp8.h:158
uint8_t token[4][16][3][NUM_DCT_TOKENS-1]
Definition: vp8.h:245
uint8_t scan[16]
Definition: vp8.h:247
int linesize
Definition: vp8.h:153
#define DECLARE_ALIGNED(n, t, v)
Definition: mem.h:53
os2threads to pthreads wrapper
VP56mv bmv[16]
Definition: vp8.h:98
uint8_t inner_filter
Definition: vp8.h:83
struct VP8Context::@94 qmat[4]
Macroblocks can have one of 4 different quants in a frame when segmentation is enabled.
uint8_t segmentid[3]
Definition: vp8.h:238
uint8_t sharpness
Definition: vp8.h:182
2 16x8 blocks (vertical)
Definition: vp8.h:73
int update_probabilities
If this flag is not set, all the probability updates are discarded after this frame is decoded...
Definition: vp8.h:260
VP8Frame * framep[4]
Definition: vp8.h:146
inter_mvmode
Definition: vp8.h:66
uint8_t(* top_nnz)[9]
Definition: vp8.h:227
int num_jobs
Definition: vp8.h:277
uint8_t pred16x16[4]
Definition: vp8.h:243
uint8_t update_map
Definition: vp8.h:174
uint16_t mb_height
Definition: vp8.h:152
int update_golden
VP56_FRAME_NONE if not updated, or which frame to copy if so.
Definition: vp8.h:253
Definition: vp8.h:137
uint8_t intra4x4_pred_mode_top[4]
Definition: vp8.h:96
HMTX pthread_mutex_t
Definition: os2threads.h:40
uint8_t
Definition: vp8.h:47
int fade_present
Fade bit present in bitstream (VP7)
Definition: vp8.h:293
mode
Definition: f_perms.c:27
uint8_t ref_frame
Definition: vp8.h:91
int ff_vp8_decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: vp8.c:2673
Multithreading support functions.
Definition: vp8.h:55
VP8 compatible video decoder.
uint8_t mvc[2][19]
Definition: vp8.h:246
VP56mv mv
Definition: vp8.h:97
int8_t base_quant[4]
Definition: vp8.h:175
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:252
VP8Frame * prev_frame
Definition: vp8.h:149
int num_coeff_partitions
All coefficients are contained in separate arith coding contexts.
Definition: vp8.h:266
vp8_mc_func put_pixels_tab[3][3][3]
Definition: vp8.h:271
uint8_t feature_index_prob[4][3]
Definition: vp8.h:307
uint8_t intra4x4_pred_mode_mb[16]
Definition: vp8.h:95
uint8_t intra4x4_pred_mode_left[4]
Definition: vp8.h:188
uint8_t colorspace
0 is the only value allowed (meaning bt601)
Definition: vp8.h:274
H264PredContext hpc
Definition: vp8.h:270
Definition: vp8.h:132
uint8_t absolute_vals
Definition: vp8.h:173
uint16_t mb_width
Definition: vp8.h:151
uint8_t last
Definition: vp8.h:241
uint8_t mode
Definition: vp8.h:90
AVCodecContext * avctx
Definition: vp8.h:145
#define EDGE_EMU_LINESIZE
Definition: vp8.h:127
uint16_t inter_dc_pred[2][2]
Interframe DC prediction (VP7) [0] VP56_FRAME_PREVIOUS [1] VP56_FRAME_GOLDEN.
Definition: vp8.h:300
VideoDSPContext vdsp
Definition: vp8.h:268
VP8Macroblock * macroblocks_base
Definition: vp8.h:250
Definition: vp8.h:52
uint8_t edge_emu_buffer[21 *EDGE_EMU_LINESIZE]
Definition: vp8.h:128
int16_t block[6][4][16]
Definition: vp8.h:102
uint8_t keyframe
Definition: vp8.h:156
int x
Definition: vp8.h:138
struct VP8Context::@93 filter
int16_t luma_qmul[2]
Definition: vp8.h:197
4x4 blocks of 4x4px each
Definition: vp8.h:76
uint8_t deblock_filter
Definition: vp8.h:157
uint8_t feature_present_prob[4]
Definition: vp8.h:306
uint8_t fullrange
whether we can skip clamping in dsp functions
Definition: vp8.h:275
struct VP8Context::@95 lf_delta
int16_t block_dc[16]
Definition: vp8.h:103
typedef void(APIENTRY *FF_PFNGLACTIVETEXTUREPROC)(GLenum texture)
uint8_t mbskip
Definition: vp8.h:239
int8_t ref[4]
filter strength adjustment for macroblocks that reference: [0] - intra / VP56_FRAME_CURRENT [1] - VP5...
Definition: vp8.h:223
void(* filter_mb_row)(AVCodecContext *avctx, void *tdata, int jobnr, int threadnr)
Definition: vp8.h:286
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:198
int16_t chroma_qmul[2]
Definition: vp8.h:199
uint8_t(* top_border)[16+8+8]
Definition: vp8.h:226
struct VP8Context::@92 segmentation
Base parameters for segmentation, i.e.
ThreadFrame tf
Definition: vp8.h:133
struct VP8Context::@96 prob[2]
These are all of the updatable probabilities for binary decisions.
uint8_t segment
Definition: vp8.h:94
Definition: vp8.h:54
VP8Frame * curframe
Definition: vp8.h:148
uint8_t simple
Definition: vp8.h:180
VP8Frame frames[5]
Definition: vp8.h:272
uint8_t level
Definition: vp8.h:181
AVBufferRef * seg_map
Definition: vp8.h:134
Definition: vp8.h:58
main external API structure.
Definition: avcodec.h:1241
VP8Frame * next_framep[4]
Definition: vp8.h:147
int mb_layout
This describes the macroblock memory layout.
Definition: vp8.h:283
uint8_t left_nnz[9]
For coeff decode, we need to know whether the above block had non-zero coefficients.
Definition: vp8.h:118
VP56RangeCoder c
header context, includes mb modes and motion vectors
Definition: vp8.h:229
int y
Definition: vp8.h:139
VP56RangeCoder coeff_partition[8]
Definition: vp8.h:267
int vp7
Definition: vp8.h:288
VP8FilterStrength * filter_strength
Definition: vp8.h:129
VP8intmv mv_min
Definition: vp8.h:160
uint8_t enabled
whether each mb can have a different strength based on mode/ref
Definition: vp8.h:172
dct_token
Definition: vp8.h:46
refcounted data buffer API
Definition: vp8.h:56
int uvlinesize
Definition: vp8.h:154
Definition: vp8.h:48
H.264 / AVC / MPEG4 prediction functions.
Definition: vp56.h:65
int ff_vp8_decode_init(AVCodecContext *avctx)
Definition: vp8.c:2754
int update_altref
Definition: vp8.h:254
VP8intmv mv_max
Definition: vp8.h:161
uint8_t feature_enabled[4]
Macroblock features (VP7)
Definition: vp8.h:305
2 8x16 blocks (horizontal)
Definition: vp8.h:74
uint8_t pred8x8c[3]
Definition: vp8.h:244
A reference to a data buffer.
Definition: buffer.h:81
Definition: vp8.h:51
uint8_t partitioning
Definition: vp8.h:92
void(* decode_mb_row_no_filter)(AVCodecContext *avctx, void *tdata, int jobnr, int threadnr)
Definition: vp8.h:285
int wait_mb_pos
Definition: vp8.h:125
uint8_t chroma_pred_mode
Definition: vp8.h:93
Definition: vp8.h:53
int invisible
Definition: vp8.h:251
int ref_count[3]
Definition: vp8.h:164
#define MODE_I4x4
Definition: vp8.h:64
VP8DSPContext vp8dsp
Definition: vp8.h:269
int thread_nr
Definition: vp8.h:119
inter_splitmvmode
Definition: vp8.h:72
w32threads to pthreads wrapper
int8_t filter_level[4]
base loop filter level
Definition: vp8.h:176
uint8_t intra
Definition: vp8.h:240
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:111
uint8_t skip
Definition: vp8.h:87
This structure stores compressed data.
Definition: avcodec.h:1139
uint8_t profile
Definition: vp8.h:159
VP8ThreadData * thread_data
Definition: vp8.h:144
int thread_mb_pos
Definition: vp8.h:124
2x2 blocks of 8x8px each
Definition: vp8.h:75
uint8_t filter_level
Definition: vp8.h:81