1 /*
2  *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
3  *
4  *  Use of this source code is governed by a BSD-style license
5  *  that can be found in the LICENSE file in the root of the source
6  *  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.
9  */
10 
11 #ifndef VPX_VP9_COMMON_VP9_ENTROPY_H_
12 #define VPX_VP9_COMMON_VP9_ENTROPY_H_
13 
14 #define INLINE __inline
15 
16 #include <stdint.h>
17 #include "mem.h"
18 #include "vp9_enums.h"
19 #include "prob.h"
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24 
25 #define DIFF_UPDATE_PROB 252
26 
27 // Coefficient token alphabet
28 #define ZERO_TOKEN 0        // 0     Extra Bits 0+0
29 #define ONE_TOKEN 1         // 1     Extra Bits 0+1
30 #define TWO_TOKEN 2         // 2     Extra Bits 0+1
31 #define THREE_TOKEN 3       // 3     Extra Bits 0+1
32 #define FOUR_TOKEN 4        // 4     Extra Bits 0+1
33 #define CATEGORY1_TOKEN 5   // 5-6   Extra Bits 1+1
34 #define CATEGORY2_TOKEN 6   // 7-10  Extra Bits 2+1
35 #define CATEGORY3_TOKEN 7   // 11-18 Extra Bits 3+1
36 #define CATEGORY4_TOKEN 8   // 19-34 Extra Bits 4+1
37 #define CATEGORY5_TOKEN 9   // 35-66 Extra Bits 5+1
38 #define CATEGORY6_TOKEN 10  // 67+   Extra Bits 14+1
39 #define EOB_TOKEN 11        // EOB   Extra Bits 0+0
40 
41 #define ENTROPY_TOKENS 12
42 
43 #define ENTROPY_NODES 11
44 
45 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_pt_energy_class[ENTROPY_TOKENS]);
46 
47 #define CAT1_MIN_VAL 5
48 #define CAT2_MIN_VAL 7
49 #define CAT3_MIN_VAL 11
50 #define CAT4_MIN_VAL 19
51 #define CAT5_MIN_VAL 35
52 #define CAT6_MIN_VAL 67
53 
54 // Extra bit probabilities.
55 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat1_prob[1]);
56 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat2_prob[2]);
57 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat3_prob[3]);
58 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat4_prob[4]);
59 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat5_prob[5]);
60 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat6_prob[14]);
61 
62 #if CONFIG_VP9_HIGHBITDEPTH
63 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat1_prob_high10[1]);
64 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat2_prob_high10[2]);
65 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat3_prob_high10[3]);
66 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat4_prob_high10[4]);
67 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat5_prob_high10[5]);
68 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat6_prob_high10[16]);
69 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat1_prob_high12[1]);
70 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat2_prob_high12[2]);
71 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat3_prob_high12[3]);
72 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat4_prob_high12[4]);
73 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat5_prob_high12[5]);
74 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_cat6_prob_high12[18]);
75 #endif  // CONFIG_VP9_HIGHBITDEPTH
76 
77 #define EOB_MODEL_TOKEN 3
78 
79 #define DCT_MAX_VALUE 16384
80 #if CONFIG_VP9_HIGHBITDEPTH
81 #define DCT_MAX_VALUE_HIGH10 65536
82 #define DCT_MAX_VALUE_HIGH12 262144
83 #endif  // CONFIG_VP9_HIGHBITDEPTH
84 
85 /* Coefficients are predicted via a 3-dimensional probability table. */
86 
87 #define REF_TYPES 2  // intra=0, inter=1
88 
89 /* Middle dimension reflects the coefficient position within the transform. */
90 #define COEF_BANDS 6
91 
92 /* Inside dimension is measure of nearby complexity, that reflects the energy
93    of nearby coefficients are nonzero.  For the first coefficient (DC, unless
94    block type is 0), we look at the (already encoded) blocks above and to the
95    left of the current block.  The context index is then the number (0,1,or 2)
96    of these blocks having nonzero coefficients.
97    After decoding a coefficient, the measure is determined by the size of the
98    most recently decoded coefficient.
99    Note that the intuitive meaning of this measure changes as coefficients
100    are decoded, e.g., prior to the first token, a zero means that my neighbors
101    are empty while, after the first token, because of the use of end-of-block,
102    a zero means we just decoded a zero and hence guarantees that a non-zero
103    coefficient will appear later in this block.  However, this shift
104    in meaning is perfectly OK because our context depends also on the
105    coefficient band (and since zigzag positions 0, 1, and 2 are in
106    distinct bands). */
107 
108 #define COEFF_CONTEXTS 6
109 #define BAND_COEFF_CONTEXTS(band) ((band) == 0 ? 3 : COEFF_CONTEXTS)
110 
111 // #define ENTROPY_STATS
112 
113 typedef unsigned int vp9_coeff_count[REF_TYPES][COEF_BANDS][COEFF_CONTEXTS]
114                                     [ENTROPY_TOKENS];
115 typedef unsigned int vp9_coeff_stats[REF_TYPES][COEF_BANDS][COEFF_CONTEXTS]
116                                     [ENTROPY_NODES][2];
117 
118 #define SUBEXP_PARAM 4   /* Subexponential code parameter */
119 #define MODULUS_PARAM 13 /* Modulus parameter */
120 
121 struct VP9Common;
122 void eb_vp9_default_coef_probs(struct VP9Common *cm);
123 void eb_vp9_adapt_coef_probs(struct VP9Common *cm);
124 
125 // This is the index in the scan order beyond which all coefficients for
126 // 8x8 transform and above are in the top band.
127 // This macro is currently unused but may be used by certain implementations
128 #define MAXBAND_INDEX 21
129 
130 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_coefband_trans_8x8plus[1024]);
131 DECLARE_ALIGNED(16, extern const uint8_t, eb_vp9_coefband_trans_4x4[16]);
132 
get_band_translate(TX_SIZE tx_size)133 static INLINE const uint8_t *get_band_translate(TX_SIZE tx_size) {
134   return tx_size == TX_4X4 ? eb_vp9_coefband_trans_4x4
135                            : eb_vp9_coefband_trans_8x8plus;
136 }
137 
138 // 128 lists of probabilities are stored for the following ONE node probs:
139 // 1, 3, 5, 7, ..., 253, 255
140 // In between probabilities are interpolated linearly
141 #define COEFF_PROB_MODELS 255
142 
143 #define UNCONSTRAINED_NODES 3
144 
145 #define PIVOT_NODE 2  // which node is pivot
146 
147 #define MODEL_NODES (ENTROPY_NODES - UNCONSTRAINED_NODES)
148 extern const vpx_tree_index eb_vp9_coef_con_tree[TREE_SIZE(ENTROPY_TOKENS)];
149 extern const vpx_prob eb_vp9_pareto8_full[COEFF_PROB_MODELS][MODEL_NODES];
150 
151 typedef vpx_prob vp9_coeff_probs_model[REF_TYPES][COEF_BANDS][COEFF_CONTEXTS]
152                                       [UNCONSTRAINED_NODES];
153 
154 typedef unsigned int vp9_coeff_count_model[REF_TYPES][COEF_BANDS]
155                                           [COEFF_CONTEXTS]
156                                           [UNCONSTRAINED_NODES + 1];
157 
158 void eb_vp9_model_to_full_probs(const vpx_prob *model, vpx_prob *full);
159 
160 typedef char ENTROPY_CONTEXT;
161 
combine_entropy_contexts(ENTROPY_CONTEXT a,ENTROPY_CONTEXT b)162 static INLINE int combine_entropy_contexts(ENTROPY_CONTEXT a,
163                                            ENTROPY_CONTEXT b) {
164   return (a != 0) + (b != 0);
165 }
166 
get_entropy_context(TX_SIZE tx_size,const ENTROPY_CONTEXT * a,const ENTROPY_CONTEXT * l)167 static INLINE int get_entropy_context(TX_SIZE tx_size, const ENTROPY_CONTEXT *a,
168                                       const ENTROPY_CONTEXT *l) {
169   ENTROPY_CONTEXT above_ec = 0, left_ec = 0;
170 
171   switch (tx_size) {
172     case TX_4X4:
173       above_ec = a[0] != 0;
174       left_ec = l[0] != 0;
175       break;
176     case TX_8X8:
177       above_ec = !!*(const uint16_t *)a;
178       left_ec = !!*(const uint16_t *)l;
179       break;
180     case TX_16X16:
181       above_ec = !!*(const uint32_t *)a;
182       left_ec = !!*(const uint32_t *)l;
183       break;
184     case TX_32X32:
185       above_ec = !!*(const uint64_t *)a;
186       left_ec = !!*(const uint64_t *)l;
187       break;
188     default: assert(0 && "Invalid transform size."); break;
189   }
190 
191   return combine_entropy_contexts(above_ec, left_ec);
192 }
193 
194 #ifdef __cplusplus
195 }  // extern "C"
196 #endif
197 
198 #endif  // VPX_VP9_COMMON_VP9_ENTROPY_H_
199