bit_reader_utils.c 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. // Copyright 2010 Google Inc. All Rights Reserved.
  2. //
  3. // Use of this source code is governed by a BSD-style license
  4. // that can be found in the COPYING file in the root of the source
  5. // tree. An additional intellectual property rights grant can be found
  6. // in the file PATENTS. All contributing project authors may
  7. // be found in the AUTHORS file in the root of the source tree.
  8. // -----------------------------------------------------------------------------
  9. //
  10. // Boolean decoder non-inlined methods
  11. //
  12. // Author: Skal (pascal.massimino@gmail.com)
  13. #ifdef HAVE_CONFIG_H
  14. #include "../webp/config.h"
  15. #endif
  16. #include "./bit_reader_inl_utils.h"
  17. #include "./utils.h"
  18. //------------------------------------------------------------------------------
  19. // VP8BitReader
  20. void VP8BitReaderSetBuffer(VP8BitReader* const br,
  21. const uint8_t* const start,
  22. size_t size) {
  23. br->buf_ = start;
  24. br->buf_end_ = start + size;
  25. br->buf_max_ =
  26. (size >= sizeof(lbit_t)) ? start + size - sizeof(lbit_t) + 1
  27. : start;
  28. }
  29. void VP8InitBitReader(VP8BitReader* const br,
  30. const uint8_t* const start, size_t size) {
  31. assert(br != NULL);
  32. assert(start != NULL);
  33. assert(size < (1u << 31)); // limit ensured by format and upstream checks
  34. br->range_ = 255 - 1;
  35. br->value_ = 0;
  36. br->bits_ = -8; // to load the very first 8bits
  37. br->eof_ = 0;
  38. VP8BitReaderSetBuffer(br, start, size);
  39. VP8LoadNewBytes(br);
  40. }
  41. void VP8RemapBitReader(VP8BitReader* const br, ptrdiff_t offset) {
  42. if (br->buf_ != NULL) {
  43. br->buf_ += offset;
  44. br->buf_end_ += offset;
  45. br->buf_max_ += offset;
  46. }
  47. }
  48. const uint8_t kVP8Log2Range[128] = {
  49. 7, 6, 6, 5, 5, 5, 5, 4, 4, 4, 4, 4, 4, 4, 4,
  50. 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3,
  51. 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  52. 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  53. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
  54. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
  55. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
  56. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
  57. 0
  58. };
  59. // range = ((range - 1) << kVP8Log2Range[range]) + 1
  60. const uint8_t kVP8NewRange[128] = {
  61. 127, 127, 191, 127, 159, 191, 223, 127,
  62. 143, 159, 175, 191, 207, 223, 239, 127,
  63. 135, 143, 151, 159, 167, 175, 183, 191,
  64. 199, 207, 215, 223, 231, 239, 247, 127,
  65. 131, 135, 139, 143, 147, 151, 155, 159,
  66. 163, 167, 171, 175, 179, 183, 187, 191,
  67. 195, 199, 203, 207, 211, 215, 219, 223,
  68. 227, 231, 235, 239, 243, 247, 251, 127,
  69. 129, 131, 133, 135, 137, 139, 141, 143,
  70. 145, 147, 149, 151, 153, 155, 157, 159,
  71. 161, 163, 165, 167, 169, 171, 173, 175,
  72. 177, 179, 181, 183, 185, 187, 189, 191,
  73. 193, 195, 197, 199, 201, 203, 205, 207,
  74. 209, 211, 213, 215, 217, 219, 221, 223,
  75. 225, 227, 229, 231, 233, 235, 237, 239,
  76. 241, 243, 245, 247, 249, 251, 253, 127
  77. };
  78. void VP8LoadFinalBytes(VP8BitReader* const br) {
  79. assert(br != NULL && br->buf_ != NULL);
  80. // Only read 8bits at a time
  81. if (br->buf_ < br->buf_end_) {
  82. br->bits_ += 8;
  83. br->value_ = (bit_t)(*br->buf_++) | (br->value_ << 8);
  84. } else if (!br->eof_) {
  85. br->value_ <<= 8;
  86. br->bits_ += 8;
  87. br->eof_ = 1;
  88. } else {
  89. br->bits_ = 0; // This is to avoid undefined behaviour with shifts.
  90. }
  91. }
  92. //------------------------------------------------------------------------------
  93. // Higher-level calls
  94. uint32_t VP8GetValue(VP8BitReader* const br, int bits, const char label[]) {
  95. uint32_t v = 0;
  96. while (bits-- > 0) {
  97. v |= VP8GetBit(br, 0x80, label) << bits;
  98. }
  99. return v;
  100. }
  101. int32_t VP8GetSignedValue(VP8BitReader* const br, int bits,
  102. const char label[]) {
  103. const int value = VP8GetValue(br, bits, label);
  104. return VP8Get(br, label) ? -value : value;
  105. }
  106. //------------------------------------------------------------------------------
  107. // VP8LBitReader
  108. #define VP8L_LOG8_WBITS 4 // Number of bytes needed to store VP8L_WBITS bits.
  109. #if defined(__arm__) || defined(_M_ARM) || defined(__aarch64__) || \
  110. defined(__i386__) || defined(_M_IX86) || \
  111. defined(__x86_64__) || defined(_M_X64)
  112. #define VP8L_USE_FAST_LOAD
  113. #endif
  114. static const uint32_t kBitMask[VP8L_MAX_NUM_BIT_READ + 1] = {
  115. 0,
  116. 0x000001, 0x000003, 0x000007, 0x00000f,
  117. 0x00001f, 0x00003f, 0x00007f, 0x0000ff,
  118. 0x0001ff, 0x0003ff, 0x0007ff, 0x000fff,
  119. 0x001fff, 0x003fff, 0x007fff, 0x00ffff,
  120. 0x01ffff, 0x03ffff, 0x07ffff, 0x0fffff,
  121. 0x1fffff, 0x3fffff, 0x7fffff, 0xffffff
  122. };
  123. void VP8LInitBitReader(VP8LBitReader* const br, const uint8_t* const start,
  124. size_t length) {
  125. size_t i;
  126. vp8l_val_t value = 0;
  127. assert(br != NULL);
  128. assert(start != NULL);
  129. assert(length < 0xfffffff8u); // can't happen with a RIFF chunk.
  130. br->len_ = length;
  131. br->val_ = 0;
  132. br->bit_pos_ = 0;
  133. br->eos_ = 0;
  134. if (length > sizeof(br->val_)) {
  135. length = sizeof(br->val_);
  136. }
  137. for (i = 0; i < length; ++i) {
  138. value |= (vp8l_val_t)start[i] << (8 * i);
  139. }
  140. br->val_ = value;
  141. br->pos_ = length;
  142. br->buf_ = start;
  143. }
  144. void VP8LBitReaderSetBuffer(VP8LBitReader* const br,
  145. const uint8_t* const buf, size_t len) {
  146. assert(br != NULL);
  147. assert(buf != NULL);
  148. assert(len < 0xfffffff8u); // can't happen with a RIFF chunk.
  149. br->buf_ = buf;
  150. br->len_ = len;
  151. // pos_ > len_ should be considered a param error.
  152. br->eos_ = (br->pos_ > br->len_) || VP8LIsEndOfStream(br);
  153. }
  154. static void VP8LSetEndOfStream(VP8LBitReader* const br) {
  155. br->eos_ = 1;
  156. br->bit_pos_ = 0; // To avoid undefined behaviour with shifts.
  157. }
  158. // If not at EOS, reload up to VP8L_LBITS byte-by-byte
  159. static void ShiftBytes(VP8LBitReader* const br) {
  160. while (br->bit_pos_ >= 8 && br->pos_ < br->len_) {
  161. br->val_ >>= 8;
  162. br->val_ |= ((vp8l_val_t)br->buf_[br->pos_]) << (VP8L_LBITS - 8);
  163. ++br->pos_;
  164. br->bit_pos_ -= 8;
  165. }
  166. if (VP8LIsEndOfStream(br)) {
  167. VP8LSetEndOfStream(br);
  168. }
  169. }
  170. void VP8LDoFillBitWindow(VP8LBitReader* const br) {
  171. assert(br->bit_pos_ >= VP8L_WBITS);
  172. #if defined(VP8L_USE_FAST_LOAD)
  173. if (br->pos_ + sizeof(br->val_) < br->len_) {
  174. br->val_ >>= VP8L_WBITS;
  175. br->bit_pos_ -= VP8L_WBITS;
  176. br->val_ |= (vp8l_val_t)HToLE32(WebPMemToUint32(br->buf_ + br->pos_)) <<
  177. (VP8L_LBITS - VP8L_WBITS);
  178. br->pos_ += VP8L_LOG8_WBITS;
  179. return;
  180. }
  181. #endif
  182. ShiftBytes(br); // Slow path.
  183. }
  184. uint32_t VP8LReadBits(VP8LBitReader* const br, int n_bits) {
  185. assert(n_bits >= 0);
  186. // Flag an error if end_of_stream or n_bits is more than allowed limit.
  187. if (!br->eos_ && n_bits <= VP8L_MAX_NUM_BIT_READ) {
  188. const uint32_t val = VP8LPrefetchBits(br) & kBitMask[n_bits];
  189. const int new_bits = br->bit_pos_ + n_bits;
  190. br->bit_pos_ = new_bits;
  191. ShiftBytes(br);
  192. return val;
  193. } else {
  194. VP8LSetEndOfStream(br);
  195. return 0;
  196. }
  197. }
  198. //------------------------------------------------------------------------------
  199. // Bit-tracing tool
  200. #if (BITTRACE > 0)
  201. #include <stdlib.h> // for atexit()
  202. #include <stdio.h>
  203. #include <string.h>
  204. #define MAX_NUM_LABELS 32
  205. static struct {
  206. const char* label;
  207. int size;
  208. int count;
  209. } kLabels[MAX_NUM_LABELS];
  210. static int last_label = 0;
  211. static int last_pos = 0;
  212. static const uint8_t* buf_start = NULL;
  213. static int init_done = 0;
  214. static void PrintBitTraces(void) {
  215. int i;
  216. int scale = 1;
  217. int total = 0;
  218. const char* units = "bits";
  219. #if (BITTRACE == 2)
  220. scale = 8;
  221. units = "bytes";
  222. #endif
  223. for (i = 0; i < last_label; ++i) total += kLabels[i].size;
  224. if (total < 1) total = 1; // avoid rounding errors
  225. printf("=== Bit traces ===\n");
  226. for (i = 0; i < last_label; ++i) {
  227. const int skip = 16 - (int)strlen(kLabels[i].label);
  228. const int value = (kLabels[i].size + scale - 1) / scale;
  229. assert(skip > 0);
  230. printf("%s \%*s: %6d %s \t[%5.2f%%] [count: %7d]\n",
  231. kLabels[i].label, skip, "", value, units,
  232. 100.f * kLabels[i].size / total,
  233. kLabels[i].count);
  234. }
  235. total = (total + scale - 1) / scale;
  236. printf("Total: %d %s\n", total, units);
  237. }
  238. void BitTrace(const struct VP8BitReader* const br, const char label[]) {
  239. int i, pos;
  240. if (!init_done) {
  241. memset(kLabels, 0, sizeof(kLabels));
  242. atexit(PrintBitTraces);
  243. buf_start = br->buf_;
  244. init_done = 1;
  245. }
  246. pos = (int)(br->buf_ - buf_start) * 8 - br->bits_;
  247. // if there's a too large jump, we've changed partition -> reset counter
  248. if (abs(pos - last_pos) > 32) {
  249. buf_start = br->buf_;
  250. pos = 0;
  251. last_pos = 0;
  252. }
  253. if (br->range_ >= 0x7f) pos += kVP8Log2Range[br->range_ - 0x7f];
  254. for (i = 0; i < last_label; ++i) {
  255. if (!strcmp(label, kLabels[i].label)) break;
  256. }
  257. if (i == MAX_NUM_LABELS) abort(); // overflow!
  258. kLabels[i].label = label;
  259. kLabels[i].size += pos - last_pos;
  260. kLabels[i].count += 1;
  261. if (i == last_label) ++last_label;
  262. last_pos = pos;
  263. }
  264. #endif // BITTRACE > 0
  265. //------------------------------------------------------------------------------