src/third_party/libvpx/source/libvpx/vp9/common/vp9_entropy.h

   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 VP9_COMMON_VP9_ENTROPY_H_
  12 #define VP9_COMMON_VP9_ENTROPY_H_
  13
  14 #include "vpx/vpx_integer.h"
  15
  16 #include "vp9/common/vp9_blockd.h"
  17 #include "vp9/common/vp9_common.h"
  18 #include "vp9/common/vp9_scan.h"
  19
  20 #ifdef __cplusplus
  21 extern "C" {
  22 #endif
  23
  24 #define DIFF_UPDATE_PROB 252
  25
  26 // Coefficient token alphabet
  27 #define ZERO_TOKEN      0   // 0     Extra Bits 0+0
  28 #define ONE_TOKEN       1   // 1     Extra Bits 0+1
  29 #define TWO_TOKEN       2   // 2     Extra Bits 0+1
  30 #define THREE_TOKEN     3   // 3     Extra Bits 0+1
  31 #define FOUR_TOKEN      4   // 4     Extra Bits 0+1
  32 #define CATEGORY1_TOKEN 5   // 5-6   Extra Bits 1+1
  33 #define CATEGORY2_TOKEN 6   // 7-10  Extra Bits 2+1
  34 #define CATEGORY3_TOKEN 7   // 11-18 Extra Bits 3+1
  35 #define CATEGORY4_TOKEN 8   // 19-34 Extra Bits 4+1
  36 #define CATEGORY5_TOKEN 9   // 35-66 Extra Bits 5+1
  37 #define CATEGORY6_TOKEN 10  // 67+   Extra Bits 14+1
  38 #define EOB_TOKEN       11  // EOB   Extra Bits 0+0
  39
  40 #define ENTROPY_TOKENS 12
  41
  42 #define ENTROPY_NODES 11
  43
  44 DECLARE_ALIGNED(16, extern const uint8_t, vp9_pt_energy_class[ENTROPY_TOKENS]);
  45
  46 #define CAT1_MIN_VAL    5
  47 #define CAT2_MIN_VAL    7
  48 #define CAT3_MIN_VAL   11
  49 #define CAT4_MIN_VAL   19
  50 #define CAT5_MIN_VAL   35
  51 #define CAT6_MIN_VAL   67
  52
  53 // Extra bit probabilities.
  54 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat1_prob[1]);
  55 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat2_prob[2]);
  56 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat3_prob[3]);
  57 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat4_prob[4]);
  58 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat5_prob[5]);
  59 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat6_prob[14]);
  60
  61 #if CONFIG_VP9_HIGHBITDEPTH
  62 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat1_prob_high10[1]);
  63 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat2_prob_high10[2]);
  64 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat3_prob_high10[3]);
  65 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat4_prob_high10[4]);
  66 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat5_prob_high10[5]);
  67 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat6_prob_high10[16]);
  68 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat1_prob_high12[1]);
  69 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat2_prob_high12[2]);
  70 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat3_prob_high12[3]);
  71 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat4_prob_high12[4]);
  72 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat5_prob_high12[5]);
  73 DECLARE_ALIGNED(16, extern const uint8_t, vp9_cat6_prob_high12[18]);
  74 #endif  // CONFIG_VP9_HIGHBITDEPTH
  75
  76 #define EOB_MODEL_TOKEN 3
  77 extern const vp9_tree_index vp9_coefmodel_tree[];
  78
  79 typedef struct {
  80   const vp9_tree_index *tree;
  81   const vp9_prob *prob;
  82   int len;
  83   int base_val;
  84 } vp9_extra_bit;
  85
  86 // indexed by token value
  87 extern const vp9_extra_bit vp9_extra_bits[ENTROPY_TOKENS];
  88 #if CONFIG_VP9_HIGHBITDEPTH
  89 extern const vp9_extra_bit vp9_extra_bits_high10[ENTROPY_TOKENS];
  90 extern const vp9_extra_bit vp9_extra_bits_high12[ENTROPY_TOKENS];
  91 #endif  // CONFIG_VP9_HIGHBITDEPTH
  92
  93 #define DCT_MAX_VALUE           16384
  94 #if CONFIG_VP9_HIGHBITDEPTH
  95 #define DCT_MAX_VALUE_HIGH10    65536
  96 #define DCT_MAX_VALUE_HIGH12   262144
  97 #endif  // CONFIG_VP9_HIGHBITDEPTH
  98
  99 /* Coefficients are predicted via a 3-dimensional probability table. */
 100
 101 #define REF_TYPES 2  // intra=0, inter=1
 102
 103 /* Middle dimension reflects the coefficient position within the transform. */
 104 #define COEF_BANDS 6
 105
 106 /* Inside dimension is measure of nearby complexity, that reflects the energy
 107    of nearby coefficients are nonzero.  For the first coefficient (DC, unless
 108    block type is 0), we look at the (already encoded) blocks above and to the
 109    left of the current block.  The context index is then the number (0,1,or 2)
 110    of these blocks having nonzero coefficients.
 111    After decoding a coefficient, the measure is determined by the size of the
 112    most recently decoded coefficient.
 113    Note that the intuitive meaning of this measure changes as coefficients
 114    are decoded, e.g., prior to the first token, a zero means that my neighbors
 115    are empty while, after the first token, because of the use of end-of-block,
 116    a zero means we just decoded a zero and hence guarantees that a non-zero
 117    coefficient will appear later in this block.  However, this shift
 118    in meaning is perfectly OK because our context depends also on the
 119    coefficient band (and since zigzag positions 0, 1, and 2 are in
 120    distinct bands). */
 121
 122 #define COEFF_CONTEXTS 6
 123 #define BAND_COEFF_CONTEXTS(band) ((band) == 0 ? 3 : COEFF_CONTEXTS)
 124
 125 // #define ENTROPY_STATS
 126
 127 typedef unsigned int vp9_coeff_count[REF_TYPES][COEF_BANDS][COEFF_CONTEXTS]
 128                                     [ENTROPY_TOKENS];
 129 typedef unsigned int vp9_coeff_stats[REF_TYPES][COEF_BANDS][COEFF_CONTEXTS]
 130                                     [ENTROPY_NODES][2];
 131
 132 #define SUBEXP_PARAM                4   /* Subexponential code parameter */
 133 #define MODULUS_PARAM               13  /* Modulus parameter */
 134
 135 struct VP9Common;
 136 void vp9_default_coef_probs(struct VP9Common *cm);
 137 void vp9_adapt_coef_probs(struct VP9Common *cm);
 138
 139 static INLINE void reset_skip_context(MACROBLOCKD *xd, BLOCK_SIZE bsize) {
 140   int i;
 141   for (i = 0; i < MAX_MB_PLANE; i++) {
 142     struct macroblockd_plane *const pd = &xd->plane[i];
 143     const BLOCK_SIZE plane_bsize = get_plane_block_size(bsize, pd);
 144     vpx_memset(pd->above_context, 0, sizeof(ENTROPY_CONTEXT) *
 145                    num_4x4_blocks_wide_lookup[plane_bsize]);
 146     vpx_memset(pd->left_context, 0, sizeof(ENTROPY_CONTEXT) *
 147                    num_4x4_blocks_high_lookup[plane_bsize]);
 148   }
 149 }
 150
 151 // This is the index in the scan order beyond which all coefficients for
 152 // 8x8 transform and above are in the top band.
 153 // This macro is currently unused but may be used by certain implementations
 154 #define MAXBAND_INDEX 21
 155
 156 DECLARE_ALIGNED(16, extern const uint8_t, vp9_coefband_trans_8x8plus[1024]);
 157 DECLARE_ALIGNED(16, extern const uint8_t, vp9_coefband_trans_4x4[16]);
 158
 159 static INLINE const uint8_t *get_band_translate(TX_SIZE tx_size) {
 160   return tx_size == TX_4X4 ? vp9_coefband_trans_4x4
 161                            : vp9_coefband_trans_8x8plus;
 162 }
 163
 164 // 128 lists of probabilities are stored for the following ONE node probs:
 165 // 1, 3, 5, 7, ..., 253, 255
 166 // In between probabilities are interpolated linearly
 167
 168 #define COEFF_PROB_MODELS 256
 169
 170 #define UNCONSTRAINED_NODES         3
 171
 172 #define PIVOT_NODE                  2   // which node is pivot
 173
 174 #define MODEL_NODES (ENTROPY_NODES - UNCONSTRAINED_NODES)
 175 extern const vp9_prob vp9_pareto8_full[COEFF_PROB_MODELS][MODEL_NODES];
 176
 177 typedef vp9_prob vp9_coeff_probs_model[REF_TYPES][COEF_BANDS]
 178                                       [COEFF_CONTEXTS][UNCONSTRAINED_NODES];
 179
 180 typedef unsigned int vp9_coeff_count_model[REF_TYPES][COEF_BANDS]
 181                                           [COEFF_CONTEXTS]
 182                                           [UNCONSTRAINED_NODES + 1];
 183
 184 void vp9_model_to_full_probs(const vp9_prob *model, vp9_prob *full);
 185
 186 static INLINE int get_entropy_context(TX_SIZE tx_size, const ENTROPY_CONTEXT *a,
 187                                       const ENTROPY_CONTEXT *l) {
 188   ENTROPY_CONTEXT above_ec = 0, left_ec = 0;
 189
 190   switch (tx_size) {
 191     case TX_4X4:
 192       above_ec = a[0] != 0;
 193       left_ec = l[0] != 0;
 194       break;
 195     case TX_8X8:
 196       above_ec = !!*(const uint16_t *)a;
 197       left_ec  = !!*(const uint16_t *)l;
 198       break;
 199     case TX_16X16:
 200       above_ec = !!*(const uint32_t *)a;
 201       left_ec  = !!*(const uint32_t *)l;
 202       break;
 203     case TX_32X32:
 204       above_ec = !!*(const uint64_t *)a;
 205       left_ec  = !!*(const uint64_t *)l;
 206       break;
 207     default:
 208       assert(0 && "Invalid transform size.");
 209       break;
 210   }
 211
 212   return combine_entropy_contexts(above_ec, left_ec);
 213 }
 214
 215 static INLINE const scan_order *get_scan(const MACROBLOCKD *xd, TX_SIZE tx_size,
 216                                          PLANE_TYPE type, int block_idx) {
 217   const MODE_INFO *const mi = xd->mi[0].src_mi;
 218
 219   if (is_inter_block(&mi->mbmi) || type != PLANE_TYPE_Y || xd->lossless) {
 220     return &vp9_default_scan_orders[tx_size];
 221   } else {
 222     const PREDICTION_MODE mode = get_y_mode(mi, block_idx);
 223     return &vp9_scan_orders[tx_size][intra_mode_to_tx_type_lookup[mode]];
 224   }
 225 }
 226
 227 #ifdef __cplusplus
 228 }  // extern "C"
 229 #endif
 230
 231 #endif  // VP9_COMMON_VP9_ENTROPY_H_