libavcodec/vp56.h

   1 /*
   2  * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
   3  *
   4  * This file is part of Libav.
   5  *
   6  * Libav 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  * Libav 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 Libav; 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 "vp56data.h"
  30 #include "dsputil.h"
  31 #include "get_bits.h"
  32 #include "bytestream.h"
  33 #include "cabac.h"
  34 #include "vp56dsp.h"
  35
  36 typedef struct vp56_context VP56Context;
  37
  38 typedef struct {
  39     int16_t x;
  40     int16_t y;
  41 } DECLARE_ALIGNED(4, , VP56mv);
  42
  43 typedef void (*VP56ParseVectorAdjustment)(VP56Context *s,
  44                                           VP56mv *vect);
  45 typedef void (*VP56Filter)(VP56Context *s, uint8_t *dst, uint8_t *src,
  46                            int offset1, int offset2, int stride,
  47                            VP56mv mv, int mask, int select, int luma);
  48 typedef void (*VP56ParseCoeff)(VP56Context *s);
  49 typedef void (*VP56DefaultModelsInit)(VP56Context *s);
  50 typedef void (*VP56ParseVectorModels)(VP56Context *s);
  51 typedef void (*VP56ParseCoeffModels)(VP56Context *s);
  52 typedef int  (*VP56ParseHeader)(VP56Context *s, const uint8_t *buf,
  53                                 int buf_size, int *golden_frame);
  54
  55 typedef struct {
  56     int high;
  57     int bits; /* stored negated (i.e. negative "bits" is a positive number of
  58                  bits left) in order to eliminate a negate in cache refilling */
  59     const uint8_t *buffer;
  60     const uint8_t *end;
  61     unsigned int code_word;
  62 } VP56RangeCoder;
  63
  64 typedef struct {
  65     uint8_t not_null_dc;
  66     VP56Frame ref_frame;
  67     DCTELEM dc_coeff;
  68 } VP56RefDc;
  69
  70 typedef struct {
  71     uint8_t type;
  72     VP56mv mv;
  73 } VP56Macroblock;
  74
  75 typedef struct {
  76     uint8_t coeff_reorder[64];       /* used in vp6 only */
  77     uint8_t coeff_index_to_pos[64];  /* used in vp6 only */
  78     uint8_t vector_sig[2];           /* delta sign */
  79     uint8_t vector_dct[2];           /* delta coding types */
  80     uint8_t vector_pdi[2][2];        /* predefined delta init */
  81     uint8_t vector_pdv[2][7];        /* predefined delta values */
  82     uint8_t vector_fdv[2][8];        /* 8 bit delta value definition */
  83     uint8_t coeff_dccv[2][11];       /* DC coeff value */
  84     uint8_t coeff_ract[2][3][6][11]; /* Run/AC coding type and AC coeff value */
  85     uint8_t coeff_acct[2][3][3][6][5];/* vp5 only AC coding type for coding group < 3 */
  86     uint8_t coeff_dcct[2][36][5];    /* DC coeff coding type */
  87     uint8_t coeff_runv[2][14];       /* run value (vp6 only) */
  88     uint8_t mb_type[3][10][10];      /* model for decoding MB type */
  89     uint8_t mb_types_stats[3][10][2];/* contextual, next MB type stats */
  90 } VP56Model;
  91
  92 struct vp56_context {
  93     AVCodecContext *avctx;
  94     DSPContext dsp;
  95     VP56DSPContext vp56dsp;
  96     ScanTable scantable;
  97     AVFrame frames[4];
  98     AVFrame *framep[6];
  99     uint8_t *edge_emu_buffer_alloc;
 100     uint8_t *edge_emu_buffer;
 101     VP56RangeCoder c;
 102     VP56RangeCoder cc;
 103     VP56RangeCoder *ccp;
 104     int sub_version;
 105
 106     /* frame info */
 107     int plane_width[4];
 108     int plane_height[4];
 109     int mb_width;   /* number of horizontal MB */
 110     int mb_height;  /* number of vertical MB */
 111     int block_offset[6];
 112
 113     int quantizer;
 114     uint16_t dequant_dc;
 115     uint16_t dequant_ac;
 116     int8_t *qscale_table;
 117
 118     /* DC predictors management */
 119     VP56RefDc *above_blocks;
 120     VP56RefDc left_block[4];
 121     int above_block_idx[6];
 122     DCTELEM prev_dc[3][3];    /* [plan][ref_frame] */
 123
 124     /* blocks / macroblock */
 125     VP56mb mb_type;
 126     VP56Macroblock *macroblocks;
 127     DECLARE_ALIGNED(16, DCTELEM, block_coeff)[6][64];
 128
 129     /* motion vectors */
 130     VP56mv mv[6];  /* vectors for each block in MB */
 131     VP56mv vector_candidate[2];
 132     int vector_candidate_pos;
 133
 134     /* filtering hints */
 135     int filter_header;               /* used in vp6 only */
 136     int deblock_filtering;
 137     int filter_selection;
 138     int filter_mode;
 139     int max_vector_length;
 140     int sample_variance_threshold;
 141
 142     uint8_t coeff_ctx[4][64];              /* used in vp5 only */
 143     uint8_t coeff_ctx_last[4];             /* used in vp5 only */
 144
 145     int has_alpha;
 146
 147     /* upside-down flipping hints */
 148     int flip;  /* are we flipping ? */
 149     int frbi;  /* first row block index in MB */
 150     int srbi;  /* second row block index in MB */
 151     int stride[4];  /* stride for each plan */
 152
 153     const uint8_t *vp56_coord_div;
 154     VP56ParseVectorAdjustment parse_vector_adjustment;
 155     VP56Filter filter;
 156     VP56ParseCoeff parse_coeff;
 157     VP56DefaultModelsInit default_models_init;
 158     VP56ParseVectorModels parse_vector_models;
 159     VP56ParseCoeffModels parse_coeff_models;
 160     VP56ParseHeader parse_header;
 161
 162     VP56Model *modelp;
 163     VP56Model models[2];
 164
 165     /* huffman decoding */
 166     int use_huffman;
 167     GetBitContext gb;
 168     VLC dccv_vlc[2];
 169     VLC runv_vlc[2];
 170     VLC ract_vlc[2][3][6];
 171     unsigned int nb_null[2][2];       /* number of consecutive NULL DC/AC */
 172 };
 173
 174
 175 void ff_vp56_init(AVCodecContext *avctx, int flip, int has_alpha);
 176 int ff_vp56_free(AVCodecContext *avctx);
 177 void ff_vp56_init_dequant(VP56Context *s, int quantizer);
 178 int ff_vp56_decode_frame(AVCodecContext *avctx, void *data, int *data_size,
 179                          AVPacket *avpkt);
 180
 181
 182 /**
 183  * vp56 specific range coder implementation
 184  */
 185
 186 extern const uint8_t ff_vp56_norm_shift[256];
 187 void ff_vp56_init_range_decoder(VP56RangeCoder *c, const uint8_t *buf, int buf_size);
 188
 189 static av_always_inline unsigned int vp56_rac_renorm(VP56RangeCoder *c)
 190 {
 191     int shift = ff_vp56_norm_shift[c->high];
 192     int bits = c->bits;
 193     unsigned int code_word = c->code_word;
 194
 195     c->high   <<= shift;
 196     code_word <<= shift;
 197     bits       += shift;
 198     if(bits >= 0 && c->buffer < c->end) {
 199         code_word |= bytestream_get_be16(&c->buffer) << bits;
 200         bits -= 16;
 201     }
 202     c->bits = bits;
 203     return code_word;
 204 }
 205
 206 #if   ARCH_ARM
 207 #include "arm/vp56_arith.h"
 208 #elif ARCH_X86
 209 #include "x86/vp56_arith.h"
 210 #endif
 211
 212 #ifndef vp56_rac_get_prob
 213 #define vp56_rac_get_prob vp56_rac_get_prob
 214 static av_always_inline int vp56_rac_get_prob(VP56RangeCoder *c, uint8_t prob)
 215 {
 216     unsigned int code_word = vp56_rac_renorm(c);
 217     unsigned int low = 1 + (((c->high - 1) * prob) >> 8);
 218     unsigned int low_shift = low << 16;
 219     int bit = code_word >= low_shift;
 220
 221     c->high = bit ? c->high - low : low;
 222     c->code_word = bit ? code_word - low_shift : code_word;
 223
 224     return bit;
 225 }
 226 #endif
 227
 228 #ifndef vp56_rac_get_prob_branchy
 229 // branchy variant, to be used where there's a branch based on the bit decoded
 230 static av_always_inline int vp56_rac_get_prob_branchy(VP56RangeCoder *c, int prob)
 231 {
 232     unsigned long code_word = vp56_rac_renorm(c);
 233     unsigned low = 1 + (((c->high - 1) * prob) >> 8);
 234     unsigned low_shift = low << 16;
 235
 236     if (code_word >= low_shift) {
 237         c->high     -= low;
 238         c->code_word = code_word - low_shift;
 239         return 1;
 240     }
 241
 242     c->high = low;
 243     c->code_word = code_word;
 244     return 0;
 245 }
 246 #endif
 247
 248 static av_always_inline int vp56_rac_get(VP56RangeCoder *c)
 249 {
 250     unsigned int code_word = vp56_rac_renorm(c);
 251     /* equiprobable */
 252     int low = (c->high + 1) >> 1;
 253     unsigned int low_shift = low << 16;
 254     int bit = code_word >= low_shift;
 255     if (bit) {
 256         c->high   -= low;
 257         code_word -= low_shift;
 258     } else {
 259         c->high = low;
 260     }
 261
 262     c->code_word = code_word;
 263     return bit;
 264 }
 265
 266 // rounding is different than vp56_rac_get, is vp56_rac_get wrong?
 267 static av_always_inline int vp8_rac_get(VP56RangeCoder *c)
 268 {
 269     return vp56_rac_get_prob(c, 128);
 270 }
 271
 272 static av_unused int vp56_rac_gets(VP56RangeCoder *c, int bits)
 273 {
 274     int value = 0;
 275
 276     while (bits--) {
 277         value = (value << 1) | vp56_rac_get(c);
 278     }
 279
 280     return value;
 281 }
 282
 283 static av_unused int vp8_rac_get_uint(VP56RangeCoder *c, int bits)
 284 {
 285     int value = 0;
 286
 287     while (bits--) {
 288         value = (value << 1) | vp8_rac_get(c);
 289     }
 290
 291     return value;
 292 }
 293
 294 // fixme: add 1 bit to all the calls to this?
 295 static av_unused int vp8_rac_get_sint(VP56RangeCoder *c, int bits)
 296 {
 297     int v;
 298
 299     if (!vp8_rac_get(c))
 300         return 0;
 301
 302     v = vp8_rac_get_uint(c, bits);
 303
 304     if (vp8_rac_get(c))
 305         v = -v;
 306
 307     return v;
 308 }
 309
 310 // P(7)
 311 static av_unused int vp56_rac_gets_nn(VP56RangeCoder *c, int bits)
 312 {
 313     int v = vp56_rac_gets(c, 7) << 1;
 314     return v + !v;
 315 }
 316
 317 static av_unused int vp8_rac_get_nn(VP56RangeCoder *c)
 318 {
 319     int v = vp8_rac_get_uint(c, 7) << 1;
 320     return v + !v;
 321 }
 322
 323 static av_always_inline
 324 int vp56_rac_get_tree(VP56RangeCoder *c,
 325                       const VP56Tree *tree,
 326                       const uint8_t *probs)
 327 {
 328     while (tree->val > 0) {
 329         if (vp56_rac_get_prob(c, probs[tree->prob_idx]))
 330             tree += tree->val;
 331         else
 332             tree++;
 333     }
 334     return -tree->val;
 335 }
 336
 337 /**
 338  * This is identical to vp8_rac_get_tree except for the possibility of starting
 339  * on a node other than the root node, needed for coeff decode where this is
 340  * used to save a bit after a 0 token (by disallowing EOB to immediately follow.)
 341  */
 342 static av_always_inline
 343 int vp8_rac_get_tree_with_offset(VP56RangeCoder *c, const int8_t (*tree)[2],
 344                                  const uint8_t *probs, int i)
 345 {
 346     do {
 347         i = tree[i][vp56_rac_get_prob(c, probs[i])];
 348     } while (i > 0);
 349
 350     return -i;
 351 }
 352
 353 // how probabilities are associated with decisions is different I think
 354 // well, the new scheme fits in the old but this way has one fewer branches per decision
 355 static av_always_inline
 356 int vp8_rac_get_tree(VP56RangeCoder *c, const int8_t (*tree)[2],
 357                      const uint8_t *probs)
 358 {
 359     return vp8_rac_get_tree_with_offset(c, tree, probs, 0);
 360 }
 361
 362 // DCTextra
 363 static av_always_inline int vp8_rac_get_coeff(VP56RangeCoder *c, const uint8_t *prob)
 364 {
 365     int v = 0;
 366
 367     do {
 368         v = (v<<1) + vp56_rac_get_prob(c, *prob++);
 369     } while (*prob);
 370
 371     return v;
 372 }
 373
 374 #endif /* AVCODEC_VP56_H */