FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vp56.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2006 Aurelien Jacobs <aurel@gnuage.org>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 /**
22  * @file
23  * VP5 and VP6 compatible video decoder (common features)
24  */
25 
26 #ifndef AVCODEC_VP56_H
27 #define AVCODEC_VP56_H
28 
29 #include "avcodec.h"
30 #include "get_bits.h"
31 #include "hpeldsp.h"
32 #include "bytestream.h"
33 #include "h264chroma.h"
34 #include "videodsp.h"
35 #include "vp3dsp.h"
36 #include "vp56dsp.h"
37 
38 typedef struct vp56_context VP56Context;
39 
40 typedef enum {
46 } VP56Frame;
47 
48 typedef enum {
49  VP56_MB_INTER_NOVEC_PF = 0, /**< Inter MB, no vector, from previous frame */
50  VP56_MB_INTRA = 1, /**< Intra MB */
51  VP56_MB_INTER_DELTA_PF = 2, /**< Inter MB, above/left vector + delta, from previous frame */
52  VP56_MB_INTER_V1_PF = 3, /**< Inter MB, first vector, from previous frame */
53  VP56_MB_INTER_V2_PF = 4, /**< Inter MB, second vector, from previous frame */
54  VP56_MB_INTER_NOVEC_GF = 5, /**< Inter MB, no vector, from golden frame */
55  VP56_MB_INTER_DELTA_GF = 6, /**< Inter MB, above/left vector + delta, from golden frame */
56  VP56_MB_INTER_4V = 7, /**< Inter MB, 4 vectors, from previous frame */
57  VP56_MB_INTER_V1_GF = 8, /**< Inter MB, first vector, from golden frame */
58  VP56_MB_INTER_V2_GF = 9, /**< Inter MB, second vector, from golden frame */
59 } VP56mb;
60 
61 typedef struct VP56Tree {
62  int8_t val;
63  int8_t prob_idx;
64 } VP56Tree;
65 
66 typedef struct VP56mv {
67  DECLARE_ALIGNED(4, int16_t, x);
68  int16_t y;
69 } VP56mv;
70 
71 #define VP56_SIZE_CHANGE 1
72 
73 typedef void (*VP56ParseVectorAdjustment)(VP56Context *s,
74  VP56mv *vect);
75 typedef void (*VP56Filter)(VP56Context *s, uint8_t *dst, uint8_t *src,
76  int offset1, int offset2, ptrdiff_t stride,
77  VP56mv mv, int mask, int select, int luma);
78 typedef int (*VP56ParseCoeff)(VP56Context *s);
79 typedef void (*VP56DefaultModelsInit)(VP56Context *s);
80 typedef void (*VP56ParseVectorModels)(VP56Context *s);
81 typedef int (*VP56ParseCoeffModels)(VP56Context *s);
82 typedef int (*VP56ParseHeader)(VP56Context *s, const uint8_t *buf,
83  int buf_size);
84 
85 typedef struct VP56RangeCoder {
86  int high;
87  int bits; /* stored negated (i.e. negative "bits" is a positive number of
88  bits left) in order to eliminate a negate in cache refilling */
89  const uint8_t *buffer;
90  const uint8_t *end;
91  unsigned int code_word;
93 
94 typedef struct VP56RefDc {
97  int16_t dc_coeff;
98 } VP56RefDc;
99 
100 typedef struct VP56Macroblock {
104 
105 typedef struct VP56Model {
106  uint8_t coeff_reorder[64]; /* used in vp6 only */
107  uint8_t coeff_index_to_pos[64]; /* used in vp6 only */
108  uint8_t vector_sig[2]; /* delta sign */
109  uint8_t vector_dct[2]; /* delta coding types */
110  uint8_t vector_pdi[2][2]; /* predefined delta init */
111  uint8_t vector_pdv[2][7]; /* predefined delta values */
112  uint8_t vector_fdv[2][8]; /* 8 bit delta value definition */
113  uint8_t coeff_dccv[2][11]; /* DC coeff value */
114  uint8_t coeff_ract[2][3][6][11]; /* Run/AC coding type and AC coeff value */
115  uint8_t coeff_acct[2][3][3][6][5];/* vp5 only AC coding type for coding group < 3 */
116  uint8_t coeff_dcct[2][36][5]; /* DC coeff coding type */
117  uint8_t coeff_runv[2][14]; /* run value (vp6 only) */
118  uint8_t mb_type[3][10][10]; /* model for decoding MB type */
119  uint8_t mb_types_stats[3][10][2];/* contextual, next MB type stats */
120 } VP56Model;
121 
122 struct vp56_context {
137 
138  /* frame info */
140  int plane_width[4];
141  int plane_height[4];
142  int mb_width; /* number of horizontal MB */
143  int mb_height; /* number of vertical MB */
144  int block_offset[6];
145 
147  uint16_t dequant_dc;
148  uint16_t dequant_ac;
149 
150  /* DC predictors management */
154  int16_t prev_dc[3][3]; /* [plan][ref_frame] */
155 
156  /* blocks / macroblock */
159  DECLARE_ALIGNED(16, int16_t, block_coeff)[6][64];
160 
161  /* motion vectors */
162  VP56mv mv[6]; /* vectors for each block in MB */
165 
166  /* filtering hints */
167  int filter_header; /* used in vp6 only */
173 
174  uint8_t coeff_ctx[4][64]; /* used in vp5 only */
175  uint8_t coeff_ctx_last[4]; /* used in vp5 only */
176 
178 
179  /* upside-down flipping hints */
180  int flip; /* are we flipping ? */
181  int frbi; /* first row block index in MB */
182  int srbi; /* second row block index in MB */
183  ptrdiff_t stride[4]; /* stride for each plan */
184 
193 
194  /* for "slice" parallelism between YUV and A */
195  VP56Context *alpha_context;
196 
199 
200  /* huffman decoding */
205  VLC ract_vlc[2][3][6];
206  unsigned int nb_null[2][2]; /* number of consecutive NULL DC/AC */
207 
210 };
211 
212 
213 int ff_vp56_init(AVCodecContext *avctx, int flip, int has_alpha);
214 int ff_vp56_init_context(AVCodecContext *avctx, VP56Context *s,
215  int flip, int has_alpha);
216 int ff_vp56_free(AVCodecContext *avctx);
217 int ff_vp56_free_context(VP56Context *s);
218 void ff_vp56_init_dequant(VP56Context *s, int quantizer);
219 int ff_vp56_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
220  AVPacket *avpkt);
221 
222 
223 /**
224  * vp56 specific range coder implementation
225  */
226 
227 extern const uint8_t ff_vp56_norm_shift[256];
228 int ff_vp56_init_range_decoder(VP56RangeCoder *c, const uint8_t *buf, int buf_size);
229 
230 /**
231  * vp5689 returns 1 if the end of the stream has been reached, 0 otherwise.
232  */
234 {
235  return c->end <= c->buffer && c->bits >= 0;
236 }
237 
239 {
240  int shift = ff_vp56_norm_shift[c->high];
241  int bits = c->bits;
242  unsigned int code_word = c->code_word;
243 
244  c->high <<= shift;
245  code_word <<= shift;
246  bits += shift;
247  if(bits >= 0 && c->buffer < c->end) {
248  code_word |= bytestream_get_be16(&c->buffer) << bits;
249  bits -= 16;
250  }
251  c->bits = bits;
252  return code_word;
253 }
254 
255 #if ARCH_ARM
256 #include "arm/vp56_arith.h"
257 #elif ARCH_X86
258 #include "x86/vp56_arith.h"
259 #endif
260 
261 #ifndef vp56_rac_get_prob
262 #define vp56_rac_get_prob vp56_rac_get_prob
264 {
265  unsigned int code_word = vp56_rac_renorm(c);
266  unsigned int low = 1 + (((c->high - 1) * prob) >> 8);
267  unsigned int low_shift = low << 16;
268  int bit = code_word >= low_shift;
269 
270  c->high = bit ? c->high - low : low;
271  c->code_word = bit ? code_word - low_shift : code_word;
272 
273  return bit;
274 }
275 #endif
276 
277 #ifndef vp56_rac_get_prob_branchy
278 // branchy variant, to be used where there's a branch based on the bit decoded
280 {
281  unsigned long code_word = vp56_rac_renorm(c);
282  unsigned low = 1 + (((c->high - 1) * prob) >> 8);
283  unsigned low_shift = low << 16;
284 
285  if (code_word >= low_shift) {
286  c->high -= low;
287  c->code_word = code_word - low_shift;
288  return 1;
289  }
290 
291  c->high = low;
292  c->code_word = code_word;
293  return 0;
294 }
295 #endif
296 
298 {
299  unsigned int code_word = vp56_rac_renorm(c);
300  /* equiprobable */
301  int low = (c->high + 1) >> 1;
302  unsigned int low_shift = low << 16;
303  int bit = code_word >= low_shift;
304  if (bit) {
305  c->high -= low;
306  code_word -= low_shift;
307  } else {
308  c->high = low;
309  }
310 
311  c->code_word = code_word;
312  return bit;
313 }
314 
315 // rounding is different than vp56_rac_get, is vp56_rac_get wrong?
317 {
318  return vp56_rac_get_prob(c, 128);
319 }
320 
321 static int vp56_rac_gets(VP56RangeCoder *c, int bits)
322 {
323  int value = 0;
324 
325  while (bits--) {
326  value = (value << 1) | vp56_rac_get(c);
327  }
328 
329  return value;
330 }
331 
332 static int vp8_rac_get_uint(VP56RangeCoder *c, int bits)
333 {
334  int value = 0;
335 
336  while (bits--) {
337  value = (value << 1) | vp8_rac_get(c);
338  }
339 
340  return value;
341 }
342 
343 // fixme: add 1 bit to all the calls to this?
345 {
346  int v;
347 
348  if (!vp8_rac_get(c))
349  return 0;
350 
351  v = vp8_rac_get_uint(c, bits);
352 
353  if (vp8_rac_get(c))
354  v = -v;
355 
356  return v;
357 }
358 
359 // P(7)
361 {
362  int v = vp56_rac_gets(c, 7) << 1;
363  return v + !v;
364 }
365 
367 {
368  int v = vp8_rac_get_uint(c, 7) << 1;
369  return v + !v;
370 }
371 
372 static av_always_inline
374  const VP56Tree *tree,
375  const uint8_t *probs)
376 {
377  while (tree->val > 0) {
378  if (vp56_rac_get_prob_branchy(c, probs[tree->prob_idx]))
379  tree += tree->val;
380  else
381  tree++;
382  }
383  return -tree->val;
384 }
385 
386 // how probabilities are associated with decisions is different I think
387 // well, the new scheme fits in the old but this way has one fewer branches per decision
388 static av_always_inline int vp8_rac_get_tree(VP56RangeCoder *c, const int8_t (*tree)[2],
389  const uint8_t *probs)
390 {
391  int i = 0;
392 
393  do {
394  i = tree[i][vp56_rac_get_prob(c, probs[i])];
395  } while (i > 0);
396 
397  return -i;
398 }
399 
400 // DCTextra
402 {
403  int v = 0;
404 
405  do {
406  v = (v<<1) + vp56_rac_get_prob(c, *prob++);
407  } while (*prob);
408 
409  return v;
410 }
411 
412 #endif /* AVCODEC_VP56_H */
AVFrame * frames[4]
Definition: vp56.h:130
VP56mb mb_type
Definition: vp56.h:157
void(* VP56Filter)(VP56Context *s, uint8_t *dst, uint8_t *src, int offset1, int offset2, ptrdiff_t stride, VP56mv mv, int mask, int select, int luma)
Definition: vp56.h:75
uint8_t coeff_ract[2][3][6][11]
Definition: vp56.h:114
static int shift(int a, int b)
Definition: sonic.c:82
unsigned int code_word
Definition: vp56.h:91
uint8_t coeff_index_to_pos[64]
Definition: vp56.h:107
This structure describes decoded (raw) audio or video data.
Definition: frame.h:226
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
int(* VP56ParseCoeff)(VP56Context *s)
Definition: vp56.h:78
static av_always_inline int vp8_rac_get_tree(VP56RangeCoder *c, const int8_t(*tree)[2], const uint8_t *probs)
Definition: vp56.h:388
int deblock_filtering
Definition: vp56.h:168
uint8_t coeff_dccv[2][11]
Definition: vp56.h:113
VP3DSPContext vp3dsp
Definition: vp56.h:127
uint8_t mb_types_stats[3][10][2]
Definition: vp56.h:119
uint8_t vector_sig[2]
Definition: vp56.h:108
int vector_candidate_pos
Definition: vp56.h:164
Inter MB, no vector, from previous frame.
Definition: vp56.h:49
uint8_t vector_fdv[2][8]
Definition: vp56.h:112
VP56ParseVectorAdjustment parse_vector_adjustment
Definition: vp56.h:186
int use_huffman
Definition: vp56.h:201
void(* VP56DefaultModelsInit)(VP56Context *s)
Definition: vp56.h:79
uint16_t dequant_ac
Definition: vp56.h:148
#define src
Definition: vp8dsp.c:254
VP56ParseCoeffModels parse_coeff_models
Definition: vp56.h:191
VP56ParseVectorModels parse_vector_models
Definition: vp56.h:190
int ff_vp56_init(AVCodecContext *avctx, int flip, int has_alpha)
Definition: vp56.c:752
int16_t y
Definition: vp56.h:68
int mb_height
Definition: vp56.h:143
uint8_t
uint16_t dequant_dc
Definition: vp56.h:147
int mb_width
Definition: vp56.h:142
unsigned int nb_null[2][2]
Definition: vp56.h:206
VP56DSPContext vp56dsp
Definition: vp56.h:128
#define DECLARE_ALIGNED(n, t, v)
Declare a variable that is aligned in memory.
Definition: mem.h:112
void ff_vp56_init_dequant(VP56Context *s, int quantizer)
Definition: vp56.c:34
bitstream reader API header.
static av_always_inline int vpX_rac_is_end(VP56RangeCoder *c)
vp5689 returns 1 if the end of the stream has been reached, 0 otherwise.
Definition: vp56.h:233
uint8_t * edge_emu_buffer
Definition: vp56.h:132
static av_always_inline int vp56_rac_get_tree(VP56RangeCoder *c, const VP56Tree *tree, const uint8_t *probs)
Definition: vp56.h:373
uint8_t coeff_reorder[64]
Definition: vp56.h:106
Inter MB, second vector, from golden frame.
Definition: vp56.h:58
VP56ParseCoeff parse_coeff
Definition: vp56.h:188
#define prob(name, subs,...)
Definition: cbs_vp9.c:374
static const uint16_t mask[17]
Definition: lzw.c:38
static void flip(AVCodecContext *avctx, AVFrame *frame)
Definition: rawdec.c:136
static av_always_inline int vp56_rac_get(VP56RangeCoder *c)
Definition: vp56.h:297
VLC runv_vlc[2]
Definition: vp56.h:204
VP56mb
Definition: vp56.h:48
Definition: vp56.h:94
uint8_t type
Definition: vp56.h:101
VLC dccv_vlc[2]
Definition: vp56.h:203
Inter MB, first vector, from previous frame.
Definition: vp56.h:52
int frbi
Definition: vp56.h:181
VP56mv mv[6]
Definition: vp56.h:162
Definition: vlc.h:26
const uint8_t * end
Definition: vp56.h:90
Intra MB.
Definition: vp56.h:50
VP56RangeCoder cc
Definition: vp56.h:134
VP56Frame
Definition: vp56.h:40
VP56RangeCoder * ccp
Definition: vp56.h:135
int ff_vp56_init_range_decoder(VP56RangeCoder *c, const uint8_t *buf, int buf_size)
Definition: vp56rac.c:40
static av_unused int vp56_rac_gets_nn(VP56RangeCoder *c, int bits)
Definition: vp56.h:360
int block_offset[6]
Definition: vp56.h:144
Definition: vp56.h:61
VP56Context * alpha_context
Definition: vp56.h:195
Inter MB, first vector, from golden frame.
Definition: vp56.h:57
Half-pel DSP context.
Definition: hpeldsp.h:45
int8_t prob_idx
Definition: vp56.h:63
VP56RangeCoder c
Definition: vp56.h:133
uint8_t vector_pdi[2][2]
Definition: vp56.h:110
static av_unused int vp8_rac_get_sint(VP56RangeCoder *c, int bits)
Definition: vp56.h:344
typedef void(APIENTRY *FF_PFNGLACTIVETEXTUREPROC)(GLenum texture)
GLsizei GLboolean const GLfloat * value
Definition: opengl_enc.c:109
int(* VP56ParseCoeffModels)(VP56Context *s)
Definition: vp56.h:81
uint8_t idct_scantable[64]
Definition: vp56.h:129
VP56ParseHeader parse_header
Definition: vp56.h:192
#define s(width, name)
Definition: cbs_vp9.c:257
VLC ract_vlc[2][3][6]
Definition: vp56.h:205
int filter_selection
Definition: vp56.h:169
#define vp56_rac_get_prob
Definition: vp56.h:262
int plane_height[4]
Definition: vp56.h:141
VP56Macroblock * macroblocks
Definition: vp56.h:158
VP56RefDc * above_blocks
Definition: vp56.h:151
uint8_t coeff_ctx[4][64]
Definition: vp56.h:174
VP56Frame ref_frame
Definition: vp56.h:96
uint8_t coeff_runv[2][14]
Definition: vp56.h:117
static const int8_t mv[256][2]
Definition: 4xm.c:77
static av_always_inline int vp56_rac_get_prob_branchy(VP56RangeCoder *c, int prob)
Definition: vp56.h:279
Inter MB, 4 vectors, from previous frame.
Definition: vp56.h:56
int plane_width[4]
Definition: vp56.h:140
int quantizer
Definition: vp56.h:146
int discard_frame
Definition: vp56.h:209
Half-pel DSP functions.
Inter MB, no vector, from golden frame.
Definition: vp56.h:54
int ff_vp56_init_context(AVCodecContext *avctx, VP56Context *s, int flip, int has_alpha)
Definition: vp56.c:758
Libavcodec external API header.
Inter MB, second vector, from previous frame.
Definition: vp56.h:53
main external API structure.
Definition: avcodec.h:1533
static av_always_inline unsigned int vp56_rac_renorm(VP56RangeCoder *c)
Definition: vp56.h:238
int ff_vp56_free(AVCodecContext *avctx)
Definition: vp56.c:811
void(* VP56ParseVectorAdjustment)(VP56Context *s, VP56mv *vect)
Definition: vp56.h:73
uint8_t mb_type[3][10][10]
Definition: vp56.h:118
uint8_t not_null_dc
Definition: vp56.h:95
int sub_version
Definition: vp56.h:136
void * buf
Definition: avisynth_c.h:690
int bits
Definition: vp56.h:87
VP56DefaultModelsInit default_models_init
Definition: vp56.h:189
uint8_t coeff_dcct[2][36][5]
Definition: vp56.h:116
int have_undamaged_frame
Definition: vp56.h:208
int8_t val
Definition: vp56.h:62
Inter MB, above/left vector + delta, from previous frame.
Definition: vp56.h:51
static av_always_inline int vp8_rac_get_coeff(VP56RangeCoder *c, const uint8_t *prob)
Definition: vp56.h:401
int sample_variance_threshold
Definition: vp56.h:172
int ff_vp56_free_context(VP56Context *s)
Definition: vp56.c:817
VideoDSPContext vdsp
Definition: vp56.h:126
const uint8_t ff_vp56_norm_shift[256]
vp56 specific range coder implementation
Definition: vp56rac.c:25
static int vp8_rac_get_uint(VP56RangeCoder *c, int bits)
Definition: vp56.h:332
uint8_t coeff_acct[2][3][3][6][5]
Definition: vp56.h:115
Definition: vp56.h:66
int ff_vp56_decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: vp56.c:544
uint8_t coeff_ctx_last[4]
Definition: vp56.h:175
int srbi
Definition: vp56.h:182
const uint8_t * vp56_coord_div
Definition: vp56.h:185
int max_vector_length
Definition: vp56.h:171
GLint GLenum GLboolean GLsizei stride
Definition: opengl_enc.c:105
int
VP56mv mv
Definition: vp56.h:102
int filter_mode
Definition: vp56.h:170
int16_t x
Definition: vp56.h:67
static double c[64]
int(* VP56ParseHeader)(VP56Context *s, const uint8_t *buf, int buf_size)
Definition: vp56.h:82
int golden_frame
Definition: vp56.h:139
static av_always_inline int vp8_rac_get(VP56RangeCoder *c)
Definition: vp56.h:316
VP56Filter filter
Definition: vp56.h:187
Core video DSP helper functions.
int filter_header
Definition: vp56.h:167
int16_t dc_coeff
Definition: vp56.h:97
HpelDSPContext hdsp
Definition: vp56.h:125
Inter MB, above/left vector + delta, from golden frame.
Definition: vp56.h:55
VP56Model * modelp
Definition: vp56.h:197
int has_alpha
Definition: vp56.h:177
int above_block_idx[6]
Definition: vp56.h:153
int flip
Definition: vp56.h:180
VP56Model model
Definition: vp56.h:198
uint8_t vector_pdv[2][7]
Definition: vp56.h:111
uint8_t * edge_emu_buffer_alloc
Definition: vp56.h:131
static av_unused int vp8_rac_get_nn(VP56RangeCoder *c)
Definition: vp56.h:366
const uint8_t * buffer
Definition: vp56.h:89
#define av_always_inline
Definition: attributes.h:39
AVCodecContext * avctx
Definition: vp56.h:123
int high
Definition: vp56.h:86
VP56RefDc left_block[4]
Definition: vp56.h:152
#define stride
int16_t prev_dc[3][3]
Definition: vp56.h:154
This structure stores compressed data.
Definition: avcodec.h:1422
VP56mv vector_candidate[2]
Definition: vp56.h:163
void(* VP56ParseVectorModels)(VP56Context *s)
Definition: vp56.h:80
uint8_t vector_dct[2]
Definition: vp56.h:109
#define av_unused
Definition: attributes.h:125
H264ChromaContext h264chroma
Definition: vp56.h:124
static int vp56_rac_gets(VP56RangeCoder *c, int bits)
Definition: vp56.h:321
GetBitContext gb
Definition: vp56.h:202
int16_t block_coeff[6][64]
Definition: vp56.h:159