libavcodec/vp56.h

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