vp9_entropy.h 8.42 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

John Koleszar's avatar
John Koleszar committed
19
20
/* Coefficient token alphabet */

21
22
23
24
25
26
27
#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 */
28
29
30
#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 */
31
#define DCT_VAL_CATEGORY6       10      /* 67+       Extra Bits 14+1 */
32
#define DCT_EOB_TOKEN           11      /* EOB       Extra Bits 0+0 */
33
34
#define MAX_ENTROPY_TOKENS      12
#define ENTROPY_NODES           11
35
#define EOSB_TOKEN              127     /* Not signalled, encoder only */
John Koleszar's avatar
John Koleszar committed
36

37
38
#define INTER_MODE_CONTEXTS     7

39
extern const vp9_tree_index vp9_coef_tree[];
John Koleszar's avatar
John Koleszar committed
40

41
42
43
#define DCT_EOB_MODEL_TOKEN     3      /* EOB       Extra Bits 0+0 */
extern const vp9_tree_index vp9_coefmodel_tree[];

44
extern struct vp9_token vp9_coef_encodings[MAX_ENTROPY_TOKENS];
John Koleszar's avatar
John Koleszar committed
45

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

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

#define PROB_UPDATE_BASELINE_COST   7

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

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

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

66
67
68
69
70
71
72
73
74
75
/* 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
76
77
78
79
80
81
82
83
84
   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). */

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

88
// #define ENTROPY_STATS
89

90
typedef unsigned int vp9_coeff_count[REF_TYPES][COEF_BANDS][PREV_COEF_CONTEXTS]
91
                                    [MAX_ENTROPY_TOKENS];
92
typedef unsigned int vp9_coeff_stats[REF_TYPES][COEF_BANDS][PREV_COEF_CONTEXTS]
93
                                    [ENTROPY_NODES][2];
94
typedef vp9_prob vp9_coeff_probs[REF_TYPES][COEF_BANDS][PREV_COEF_CONTEXTS]
95
96
                                [ENTROPY_NODES];

97
98
#define SUBEXP_PARAM                4   /* Subexponential code parameter */
#define MODULUS_PARAM               13  /* Modulus parameter */
99

100
101
struct VP9Common;
void vp9_default_coef_probs(struct VP9Common *);
Paul Wilkins's avatar
Paul Wilkins committed
102
extern DECLARE_ALIGNED(16, const int, vp9_default_scan_4x4[16]);
Jingning Han's avatar
Jingning Han committed
103

104
105
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
106

Paul Wilkins's avatar
Paul Wilkins committed
107
extern DECLARE_ALIGNED(64, const int, vp9_default_scan_8x8[64]);
108
109
110
111

extern DECLARE_ALIGNED(16, const int, vp9_col_scan_8x8[64]);
extern DECLARE_ALIGNED(16, const int, vp9_row_scan_8x8[64]);

Paul Wilkins's avatar
Paul Wilkins committed
112
extern DECLARE_ALIGNED(16, const int, vp9_default_scan_16x16[256]);
113
114
115
116

extern DECLARE_ALIGNED(16, const int, vp9_col_scan_16x16[256]);
extern DECLARE_ALIGNED(16, const int, vp9_row_scan_16x16[256]);

Paul Wilkins's avatar
Paul Wilkins committed
117
extern DECLARE_ALIGNED(16, const int, vp9_default_scan_32x32[1024]);
118

119
void vp9_coef_tree_initialize(void);
120
void vp9_adapt_coef_probs(struct VP9Common *);
Daniel Kang's avatar
Daniel Kang committed
121

122
123
static INLINE void vp9_reset_sb_tokens_context(MACROBLOCKD* const xd,
                                               BLOCK_SIZE_TYPE bsize) {
124
  /* Clear entropy contexts */
125
126
127
128
129
130
131
132
133
  const int bw = 1 << b_width_log2(bsize);
  const int bh = 1 << b_height_log2(bsize);
  int i;
  for (i = 0; i < MAX_MB_PLANE; i++) {
    vpx_memset(xd->plane[i].above_context, 0,
               sizeof(ENTROPY_CONTEXT) * bw >> xd->plane[i].subsampling_x);
    vpx_memset(xd->plane[i].left_context, 0,
               sizeof(ENTROPY_CONTEXT) * bh >> xd->plane[i].subsampling_y);
  }
134
135
}

Paul Wilkins's avatar
Paul Wilkins committed
136
137
138
139
140
141
// This is the index in the scan order beyond which all coefficients for
// 8x8 transform and above are in the top band.
// For 4x4 blocks the index is less but to keep things common the lookup
// table for 4x4 is padded out to this index.
#define MAXBAND_INDEX 21

Paul Wilkins's avatar
Paul Wilkins committed
142
143
144
145
extern const uint8_t vp9_coefband_trans_8x8plus[MAXBAND_INDEX + 1];
extern const uint8_t vp9_coefband_trans_4x4[MAXBAND_INDEX + 1];


Paul Wilkins's avatar
Paul Wilkins committed
146
147
148
static int get_coef_band(const uint8_t * band_translate, int coef_index) {
  return (coef_index > MAXBAND_INDEX)
    ? (COEF_BANDS-1) : band_translate[coef_index];
149
}
Paul Wilkins's avatar
Paul Wilkins committed
150

151
152
153
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);
154

155

156
157
// 128 lists of probabilities are stored for the following ONE node probs:
// 1, 3, 5, 7, ..., 253, 255
158
159
// In between probabilities are interpolated linearly

160
#define COEFPROB_MODELS             128
161

162
163
#define UNCONSTRAINED_NODES         3
#define MODEL_NODES                 (ENTROPY_NODES - UNCONSTRAINED_NODES)
164

165
#define PIVOT_NODE                  2   // which node is pivot
166
167

typedef vp9_prob vp9_coeff_probs_model[REF_TYPES][COEF_BANDS]
168
169
170
171
172
173
174
175
176
                                      [PREV_COEF_CONTEXTS]
                                      [UNCONSTRAINED_NODES];

typedef unsigned int vp9_coeff_count_model[REF_TYPES][COEF_BANDS]
                                          [PREV_COEF_CONTEXTS]
                                          [UNCONSTRAINED_NODES + 1];
typedef unsigned int vp9_coeff_stats_model[REF_TYPES][COEF_BANDS]
                                          [PREV_COEF_CONTEXTS]
                                          [UNCONSTRAINED_NODES][2];
177
178
extern void vp9_full_to_model_count(unsigned int *model_count,
                                    unsigned int *full_count);
179
180
181
extern void vp9_full_to_model_counts(
    vp9_coeff_count_model *model_count, vp9_coeff_count *full_count);

182
void vp9_model_to_full_probs(const vp9_prob *model, vp9_prob *full);
183
184
185
186
187

void vp9_model_to_full_probs_sb(
    vp9_prob model[COEF_BANDS][PREV_COEF_CONTEXTS][UNCONSTRAINED_NODES],
    vp9_prob full[COEF_BANDS][PREV_COEF_CONTEXTS][ENTROPY_NODES]);

188
189
extern const vp9_prob vp9_modelcoefprobs[COEFPROB_MODELS][ENTROPY_NODES - 1];

190
191
192
193
194
195
196
static INLINE const int* get_scan_4x4(TX_TYPE tx_type) {
  switch (tx_type) {
    case ADST_DCT:
      return vp9_row_scan_4x4;
    case DCT_ADST:
      return vp9_col_scan_4x4;
    default:
Paul Wilkins's avatar
Paul Wilkins committed
197
      return vp9_default_scan_4x4;
198
199
200
201
202
203
204
205
206
207
  }
}

static INLINE const int* get_scan_8x8(TX_TYPE tx_type) {
  switch (tx_type) {
    case ADST_DCT:
      return vp9_row_scan_8x8;
    case DCT_ADST:
      return vp9_col_scan_8x8;
    default:
Paul Wilkins's avatar
Paul Wilkins committed
208
      return vp9_default_scan_8x8;
209
210
211
212
213
214
215
216
217
218
  }
}

static INLINE const int* get_scan_16x16(TX_TYPE tx_type) {
  switch (tx_type) {
    case ADST_DCT:
      return vp9_row_scan_16x16;
    case DCT_ADST:
      return vp9_col_scan_16x16;
    default:
Paul Wilkins's avatar
Paul Wilkins committed
219
      return vp9_default_scan_16x16;
220
221
222
  }
}

223
enum { VP9_COEF_UPDATE_PROB = 252 };
224

225
#endif  // VP9_COMMON_VP9_ENTROPY_H_