aom_dsp/binary_codes_writer.h

   1 /*
   2  * Copyright (c) 2017, Alliance for Open Media. All rights reserved
   3  *
   4  * This source code is subject to the terms of the BSD 2 Clause License and
   5  * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
   6  * was not distributed with this source code in the LICENSE file, you can
   7  * obtain it at www.aomedia.org/license/software. If the Alliance for Open
   8  * Media Patent License 1.0 was not distributed with this source code in the
   9  * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
  10  */
  11
  12 #ifndef AOM_AOM_DSP_BINARY_CODES_WRITER_H_
  13 #define AOM_AOM_DSP_BINARY_CODES_WRITER_H_
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 #include <assert.h>
  20 #include "config/aom_config.h"
  21
  22 #include "aom/aom_integer.h"
  23 #include "aom_dsp/bitwriter.h"
  24 #include "aom_dsp/bitwriter_buffer.h"
  25
  26 // Codes a symbol v in [-2^mag_bits, 2^mag_bits]
  27 // mag_bits is number of bits for magnitude. The alphabet is of size
  28 // 2 * 2^mag_bits + 1, symmetric around 0, where one bit is used to
  29 // indicate 0 or non-zero, mag_bits bits are used to indicate magnitide
  30 // and 1 more bit for the sign if non-zero.
  31 void aom_write_primitive_symmetric(aom_writer *w, int16_t v,
  32                                    unsigned int mag_bits);
  33
  34 // Encodes a value v in [0, n-1] quasi-uniformly
  35 void aom_write_primitive_quniform(aom_writer *w, uint16_t n, uint16_t v);
  36
  37 // Finite subexponential code that codes a symbol v in [0, n-1] with parameter k
  38 void aom_write_primitive_subexpfin(aom_writer *w, uint16_t n, uint16_t k,
  39                                    uint16_t v);
  40
  41 // Finite subexponential code that codes a symbol v in [0, n-1] with parameter k
  42 // based on a reference ref also in [0, n-1].
  43 void aom_write_primitive_refsubexpfin(aom_writer *w, uint16_t n, uint16_t k,
  44                                       uint16_t ref, uint16_t v);
  45
  46 // Finite subexponential code that codes a symbol v in [-(n-1), n-1] with
  47 // parameter k based on a reference ref also in [-(n-1), n-1].
  48 void aom_write_signed_primitive_refsubexpfin(aom_writer *w, uint16_t n,
  49                                              uint16_t k, int16_t ref,
  50                                              int16_t v);
  51
  52 // Functions that counts bits for the above primitives
  53 int aom_count_primitive_symmetric(int16_t v, unsigned int mag_bits);
  54 int aom_count_primitive_quniform(uint16_t n, uint16_t v);
  55 int aom_count_primitive_subexpfin(uint16_t n, uint16_t k, uint16_t v);
  56 int aom_count_primitive_refsubexpfin(uint16_t n, uint16_t k, uint16_t ref,
  57                                      uint16_t v);
  58 int aom_count_signed_primitive_refsubexpfin(uint16_t n, uint16_t k, int16_t ref,
  59                                             int16_t v);
  60
  61 #ifdef __cplusplus
  62 }  // extern "C"
  63 #endif
  64
  65 #endif  // AOM_AOM_DSP_BINARY_CODES_WRITER_H_