vp9_entropy.h 10.7 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
John Koleszar's avatar
John Koleszar committed
3
 *
4
 *  Use of this source code is governed by a BSD-style license
5 6
 *  that can be found in the LICENSE file in the root of the source
 *  tree. An additional intellectual property rights grant can be found
7
 *  in the file PATENTS.  All contributing project authors may
8
 *  be found in the AUTHORS file in the root of the source tree.
John Koleszar's avatar
John Koleszar committed
9 10
 */

11 12
#ifndef VP9_COMMON_VP9_ENTROPY_H_
#define VP9_COMMON_VP9_ENTROPY_H_
John Koleszar's avatar
John Koleszar committed
13

14
#include "vpx/vpx_integer.h"
15 16 17
#include "vp9/common/vp9_treecoder.h"
#include "vp9/common/vp9_blockd.h"
#include "vp9/common/vp9_common.h"
18

19
extern const int vp9_i8x8_block[4];
20

John Koleszar's avatar
John Koleszar committed
21 22
/* Coefficient token alphabet */

23 24 25 26 27 28 29
#define ZERO_TOKEN              0       /* 0         Extra Bits 0+0 */
#define ONE_TOKEN               1       /* 1         Extra Bits 0+1 */
#define TWO_TOKEN               2       /* 2         Extra Bits 0+1 */
#define THREE_TOKEN             3       /* 3         Extra Bits 0+1 */
#define FOUR_TOKEN              4       /* 4         Extra Bits 0+1 */
#define DCT_VAL_CATEGORY1       5       /* 5-6       Extra Bits 1+1 */
#define DCT_VAL_CATEGORY2       6       /* 7-10      Extra Bits 2+1 */
30 31 32
#define DCT_VAL_CATEGORY3       7       /* 11-18     Extra Bits 3+1 */
#define DCT_VAL_CATEGORY4       8       /* 19-34     Extra Bits 4+1 */
#define DCT_VAL_CATEGORY5       9       /* 35-66     Extra Bits 5+1 */
33
#define DCT_VAL_CATEGORY6       10      /* 67+       Extra Bits 14+1 */
34
#define DCT_EOB_TOKEN           11      /* EOB       Extra Bits 0+0 */
35 36
#define MAX_ENTROPY_TOKENS      12
#define ENTROPY_NODES           11
37
#define EOSB_TOKEN              127     /* Not signalled, encoder only */
John Koleszar's avatar
John Koleszar committed
38

39 40
#define INTER_MODE_CONTEXTS     7

41
extern const vp9_tree_index vp9_coef_tree[];
John Koleszar's avatar
John Koleszar committed
42

43
extern struct vp9_token_struct vp9_coef_encodings[MAX_ENTROPY_TOKENS];
John Koleszar's avatar
John Koleszar committed
44

John Koleszar's avatar
John Koleszar committed
45
typedef struct {
46 47
  vp9_tree_p tree;
  const vp9_prob *prob;
John Koleszar's avatar
John Koleszar committed
48 49
  int Len;
  int base_val;
50
} vp9_extra_bit_struct;
John Koleszar's avatar
John Koleszar committed
51

52
extern vp9_extra_bit_struct vp9_extra_bits[12];    /* indexed by token value */
John Koleszar's avatar
John Koleszar committed
53 54 55 56

#define PROB_UPDATE_BASELINE_COST   7

#define MAX_PROB                255
57
#define DCT_MAX_VALUE           16384
John Koleszar's avatar
John Koleszar committed
58 59 60

/* Coefficients are predicted via a 3-dimensional probability table. */

61
/* Outside dimension.  0 = Y with DC, 1 = UV */
62 63
#define BLOCK_TYPES 2
#define REF_TYPES 2  // intra=0, inter=1
64

65 66 67 68 69 70 71 72 73 74
/* Middle dimension reflects the coefficient position within the transform. */
#define COEF_BANDS 6

/* Inside dimension is measure of nearby complexity, that reflects the energy
   of nearby coefficients are nonzero.  For the first coefficient (DC, unless
   block type is 0), we look at the (already encoded) blocks above and to the
   left of the current block.  The context index is then the number (0,1,or 2)
   of these blocks having nonzero coefficients.
   After decoding a coefficient, the measure is determined by the size of the
   most recently decoded coefficient.
John Koleszar's avatar
John Koleszar committed
75 76 77 78 79 80 81 82 83
   Note that the intuitive meaning of this measure changes as coefficients
   are decoded, e.g., prior to the first token, a zero means that my neighbors
   are empty while, after the first token, because of the use of end-of-block,
   a zero means we just decoded a zero and hence guarantees that a non-zero
   coefficient will appear later in this block.  However, this shift
   in meaning is perfectly OK because our context depends also on the
   coefficient band (and since zigzag positions 0, 1, and 2 are in
   distinct bands). */

84
/*# define DC_TOKEN_CONTEXTS        3*/ /* 00, 0!0, !0!0 */
85
#define PREV_COEF_CONTEXTS          6
86

87
typedef unsigned int vp9_coeff_count[REF_TYPES][COEF_BANDS][PREV_COEF_CONTEXTS]
88
                                    [MAX_ENTROPY_TOKENS];
89
typedef unsigned int vp9_coeff_stats[REF_TYPES][COEF_BANDS][PREV_COEF_CONTEXTS]
90
                                    [ENTROPY_NODES][2];
91
typedef vp9_prob vp9_coeff_probs[REF_TYPES][COEF_BANDS][PREV_COEF_CONTEXTS]
92 93
                                [ENTROPY_NODES];

94 95
#define SUBEXP_PARAM                4   /* Subexponential code parameter */
#define MODULUS_PARAM               13  /* Modulus parameter */
96

97 98
struct VP9Common;
void vp9_default_coef_probs(struct VP9Common *);
99
extern DECLARE_ALIGNED(16, const int, vp9_default_zig_zag1d_4x4[16]);
Jingning Han's avatar
Jingning Han committed
100

101 102
extern DECLARE_ALIGNED(16, const int, vp9_col_scan_4x4[16]);
extern DECLARE_ALIGNED(16, const int, vp9_row_scan_4x4[16]);
Jingning Han's avatar
Jingning Han committed
103

104
extern DECLARE_ALIGNED(64, const int, vp9_default_zig_zag1d_8x8[64]);
105 106 107
extern DECLARE_ALIGNED(16, const int, vp9_default_zig_zag1d_16x16[256]);
extern DECLARE_ALIGNED(16, const int, vp9_default_zig_zag1d_32x32[1024]);

108
void vp9_coef_tree_initialize(void);
109
void vp9_adapt_coef_probs(struct VP9Common *);
Daniel Kang's avatar
Daniel Kang committed
110

111
static INLINE void vp9_reset_mb_tokens_context(MACROBLOCKD* const xd) {
Yaowu Xu's avatar
Yaowu Xu committed
112
  /* Clear entropy contexts */
113 114
  vpx_memset(xd->above_context, 0, sizeof(ENTROPY_CONTEXT_PLANES));
  vpx_memset(xd->left_context, 0, sizeof(ENTROPY_CONTEXT_PLANES));
Yaowu Xu's avatar
Yaowu Xu committed
115 116
}

117 118 119 120 121 122 123 124 125 126 127 128
static INLINE void vp9_reset_sb_tokens_context(MACROBLOCKD* const xd) {
  /* Clear entropy contexts */
  vpx_memset(xd->above_context, 0, sizeof(ENTROPY_CONTEXT_PLANES) * 2);
  vpx_memset(xd->left_context, 0, sizeof(ENTROPY_CONTEXT_PLANES) * 2);
}

static INLINE void vp9_reset_sb64_tokens_context(MACROBLOCKD* const xd) {
  /* Clear entropy contexts */
  vpx_memset(xd->above_context, 0, sizeof(ENTROPY_CONTEXT_PLANES) * 4);
  vpx_memset(xd->left_context, 0, sizeof(ENTROPY_CONTEXT_PLANES) * 4);
}

129
extern const int vp9_coef_bands8x8[64];
130 131
extern const int vp9_coef_bands4x4[16];

132
static int get_coef_band(const int *scan, TX_SIZE tx_size, int coef_index) {
133
  if (tx_size == TX_4X4) {
134
    return vp9_coef_bands4x4[scan[coef_index]];
135
  } else {
136 137 138 139
    const int pos = scan[coef_index];
    const int sz = 1 << (2 + tx_size);
    const int x = pos & (sz - 1), y = pos >> (2 + tx_size);
    if (x >= 8 || y >= 8)
140
      return 5;
141 142
    else
      return vp9_coef_bands8x8[y * 8 + x];
143
  }
144
}
145 146 147
extern int vp9_get_coef_context(const int *scan, const int *neighbors,
                                int nb_pad, uint8_t *token_cache, int c, int l);
const int *vp9_get_coef_neighbors_handle(const int *scan, int *pad);
148

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
#if CONFIG_MODELCOEFPROB
#define COEFPROB_BITS               8
#define COEFPROB_MODELS             (1 << COEFPROB_BITS)

// 2 => EOB and Zero nodes are unconstrained, rest are modeled
// 3 => EOB, Zero and One nodes are unconstrained, rest are modeled
#define UNCONSTRAINED_NODES         3   // Choose one of 2 or 3

// whether forward updates are model-based
#define MODEL_BASED_UPDATE          0
// if model-based how many nodes are unconstrained
#define UNCONSTRAINED_UPDATE_NODES  3
// whether backward updates are model-based
#define MODEL_BASED_ADAPT           0
#define UNCONSTRAINED_ADAPT_NODES   3

// whether to adjust the coef probs for key frames based on qindex
#define ADJUST_KF_COEF_PROBS        0

typedef vp9_prob vp9_coeff_probs_model[REF_TYPES][COEF_BANDS]
                                      [PREV_COEF_CONTEXTS][2];
extern const vp9_prob vp9_modelcoefprobs[COEFPROB_MODELS][ENTROPY_NODES - 1];
void vp9_get_model_distribution(vp9_prob model, vp9_prob *tree_probs,
                                int b, int r);
void vp9_adjust_default_coef_probs(struct VP9Common *cm);
#endif  // CONFIG_MODELCOEFPROB

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
#if CONFIG_CODE_NONZEROCOUNT
/* Alphabet for number of non-zero symbols in block */
#define NZC_0                   0       /* Used for all blocks */
#define NZC_1                   1       /* Used for all blocks */
#define NZC_2                   2       /* Used for all blocks */
#define NZC_3TO4                3       /* Used for all blocks */
#define NZC_5TO8                4       /* Used for all blocks */
#define NZC_9TO16               5       /* Used for all blocks */
#define NZC_17TO32              6       /* Used for 8x8 and larger blocks */
#define NZC_33TO64              7       /* Used for 8x8 and larger blocks */
#define NZC_65TO128             8       /* Used for 16x16 and larger blocks */
#define NZC_129TO256            9       /* Used for 16x16 and larger blocks */
#define NZC_257TO512           10       /* Used for 32x32 and larger blocks */
#define NZC_513TO1024          11       /* Used for 32x32 and larger blocks */

/* Number of tokens for each block size */
#define NZC4X4_TOKENS           6
#define NZC8X8_TOKENS           8
#define NZC16X16_TOKENS        10
#define NZC32X32_TOKENS        12

/* Number of nodes for each block size */
#define NZC4X4_NODES            5
#define NZC8X8_NODES            7
#define NZC16X16_NODES          9
#define NZC32X32_NODES         11

/* Max number of tokens with extra bits */
#define NZC_TOKENS_EXTRA        9

/* Max number of extra bits */
#define NZC_BITS_EXTRA          9

209 210 211
/* Tokens without extra bits */
#define NZC_TOKENS_NOEXTRA      (NZC32X32_TOKENS - NZC_TOKENS_EXTRA)

212 213
#define MAX_NZC_CONTEXTS        3

214 215 216
/* whether to update extra bit probabilities */
#define NZC_PCAT_UPDATE

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
/* nzc trees */
extern const vp9_tree_index    vp9_nzc4x4_tree[];
extern const vp9_tree_index    vp9_nzc8x8_tree[];
extern const vp9_tree_index    vp9_nzc16x16_tree[];
extern const vp9_tree_index    vp9_nzc32x32_tree[];

/* nzc encodings */
extern struct vp9_token_struct  vp9_nzc4x4_encodings[NZC4X4_TOKENS];
extern struct vp9_token_struct  vp9_nzc8x8_encodings[NZC8X8_TOKENS];
extern struct vp9_token_struct  vp9_nzc16x16_encodings[NZC16X16_TOKENS];
extern struct vp9_token_struct  vp9_nzc32x32_encodings[NZC32X32_TOKENS];

#define codenzc(x) (\
  (x) <= 3 ? (x) : (x) <= 4 ? 3 : (x) <= 8 ? 4 : \
  (x) <= 16 ? 5 : (x) <= 32 ? 6 : (x) <= 64 ? 7 :\
  (x) <= 128 ? 8 : (x) <= 256 ? 9 : (x) <= 512 ? 10 : 11)

int vp9_get_nzc_context_y_sb64(struct VP9Common *cm, MODE_INFO *cur,
                               int mb_row, int mb_col, int block);
int vp9_get_nzc_context_y_sb32(struct VP9Common *cm, MODE_INFO *cur,
                               int mb_row, int mb_col, int block);
int vp9_get_nzc_context_y_mb16(struct VP9Common *cm, MODE_INFO *cur,
                               int mb_row, int mb_col, int block);
int vp9_get_nzc_context_uv_sb64(struct VP9Common *cm, MODE_INFO *cur,
                                int mb_row, int mb_col, int block);
int vp9_get_nzc_context_uv_sb32(struct VP9Common *cm, MODE_INFO *cur,
                                int mb_row, int mb_col, int block);
int vp9_get_nzc_context_uv_mb16(struct VP9Common *cm, MODE_INFO *cur,
                                int mb_row, int mb_col, int block);
int vp9_get_nzc_context(struct VP9Common *cm, MACROBLOCKD *xd, int block);
void vp9_update_nzc_counts(struct VP9Common *cm, MACROBLOCKD *xd,
                           int mb_row, int mb_col);
void vp9_adapt_nzc_probs(struct VP9Common *cm);

251 252 253 254 255
/* Extra bits array */
extern const int vp9_extranzcbits[NZC32X32_TOKENS];

/* Base nzc values */
extern const int vp9_basenzcvalue[NZC32X32_TOKENS];
256 257

#endif  // CONFIG_CODE_NONZEROCOUNT
258 259 260

#include "vp9/common/vp9_coefupdateprobs.h"

261
#endif  // VP9_COMMON_VP9_ENTROPY_H_