Coverage Report

Created: 2025-09-08 07:52

/src/libjxl/lib/jxl/dec_huffman.cc
Line
Count
Source (jump to first uncovered line)
1
// Copyright (c) the JPEG XL Project Authors. All rights reserved.
2
//
3
// Use of this source code is governed by a BSD-style
4
// license that can be found in the LICENSE file.
5
6
#include "lib/jxl/dec_huffman.h"
7
8
#include <jxl/types.h>
9
#include <string.h> /* for memset */
10
11
#include <vector>
12
13
#include "lib/jxl/ans_params.h"
14
#include "lib/jxl/base/bits.h"
15
#include "lib/jxl/huffman_table.h"
16
17
namespace jxl {
18
19
static const int kCodeLengthCodes = 18;
20
static const uint8_t kCodeLengthCodeOrder[kCodeLengthCodes] = {
21
    1, 2, 3, 4, 0, 5, 17, 6, 16, 7, 8, 9, 10, 11, 12, 13, 14, 15,
22
};
23
static const uint8_t kDefaultCodeLength = 8;
24
static const uint8_t kCodeLengthRepeatCode = 16;
25
26
JXL_BOOL ReadHuffmanCodeLengths(const uint8_t* code_length_code_lengths,
27
                                int num_symbols, uint8_t* code_lengths,
28
4.92k
                                BitReader* br) {
29
4.92k
  int symbol = 0;
30
4.92k
  uint8_t prev_code_len = kDefaultCodeLength;
31
4.92k
  int repeat = 0;
32
4.92k
  uint8_t repeat_code_len = 0;
33
4.92k
  int space = 32768;
34
4.92k
  HuffmanCode table[32];
35
36
4.92k
  uint16_t counts[16] = {0};
37
93.4k
  for (int i = 0; i < kCodeLengthCodes; ++i) {
38
88.5k
    ++counts[code_length_code_lengths[i]];
39
88.5k
  }
40
4.92k
  if (!BuildHuffmanTable(table, 5, code_length_code_lengths, kCodeLengthCodes,
41
4.92k
                         &counts[0])) {
42
0
    return JXL_FALSE;
43
0
  }
44
45
98.2k
  while (symbol < num_symbols && space > 0) {
46
93.3k
    const HuffmanCode* p = table;
47
93.3k
    uint8_t code_len;
48
93.3k
    br->Refill();
49
93.3k
    p += br->PeekFixedBits<5>();
50
93.3k
    br->Consume(p->bits);
51
93.3k
    code_len = static_cast<uint8_t>(p->value);
52
93.3k
    if (code_len < kCodeLengthRepeatCode) {
53
86.9k
      repeat = 0;
54
86.9k
      code_lengths[symbol++] = code_len;
55
86.9k
      if (code_len != 0) {
56
61.2k
        prev_code_len = code_len;
57
61.2k
        space -= 32768u >> code_len;
58
61.2k
      }
59
86.9k
    } else {
60
6.43k
      const int extra_bits = code_len - 14;
61
6.43k
      int old_repeat;
62
6.43k
      int repeat_delta;
63
6.43k
      uint8_t new_len = 0;
64
6.43k
      if (code_len == kCodeLengthRepeatCode) {
65
126
        new_len = prev_code_len;
66
126
      }
67
6.43k
      if (repeat_code_len != new_len) {
68
141
        repeat = 0;
69
141
        repeat_code_len = new_len;
70
141
      }
71
6.43k
      old_repeat = repeat;
72
6.43k
      if (repeat > 0) {
73
4.18k
        repeat -= 2;
74
4.18k
        repeat <<= extra_bits;
75
4.18k
      }
76
6.43k
      repeat += static_cast<int>(br->ReadBits(extra_bits) + 3);
77
6.43k
      repeat_delta = repeat - old_repeat;
78
6.43k
      if (symbol + repeat_delta > num_symbols) {
79
0
        return 0;
80
0
      }
81
6.43k
      memset(&code_lengths[symbol], repeat_code_len,
82
6.43k
             static_cast<size_t>(repeat_delta));
83
6.43k
      symbol += repeat_delta;
84
6.43k
      if (repeat_code_len != 0) {
85
126
        space -= repeat_delta << (15 - repeat_code_len);
86
126
      }
87
6.43k
    }
88
93.3k
  }
89
4.92k
  if (space != 0) {
90
0
    return JXL_FALSE;
91
0
  }
92
4.92k
  memset(&code_lengths[symbol], 0, static_cast<size_t>(num_symbols - symbol));
93
4.92k
  return JXL_TRUE;
94
4.92k
}
95
96
static JXL_INLINE bool ReadSimpleCode(size_t alphabet_size, BitReader* br,
97
7.07k
                                      HuffmanCode* table) {
98
7.07k
  size_t max_bits =
99
7.07k
      (alphabet_size > 1u) ? FloorLog2Nonzero(alphabet_size - 1u) + 1 : 0;
100
101
7.07k
  size_t num_symbols = br->ReadFixedBits<2>() + 1;
102
103
7.07k
  uint16_t symbols[4] = {0};
104
27.2k
  for (size_t i = 0; i < num_symbols; ++i) {
105
20.1k
    uint16_t symbol = br->ReadBits(max_bits);
106
20.1k
    if (symbol >= alphabet_size) {
107
0
      return false;
108
0
    }
109
20.1k
    symbols[i] = symbol;
110
20.1k
  }
111
112
19.8k
  for (size_t i = 0; i < num_symbols - 1; ++i) {
113
31.8k
    for (size_t j = i + 1; j < num_symbols; ++j) {
114
19.0k
      if (symbols[i] == symbols[j]) return false;
115
19.0k
    }
116
12.9k
  }
117
118
  // 4 symbols have to option to encode.
119
6.93k
  if (num_symbols == 4) num_symbols += br->ReadFixedBits<1>();
120
121
6.93k
  const auto swap_symbols = [&symbols](size_t i, size_t j) {
122
6.05k
    uint16_t t = symbols[j];
123
6.05k
    symbols[j] = symbols[i];
124
6.05k
    symbols[i] = t;
125
6.05k
  };
126
127
6.93k
  size_t table_size = 1;
128
6.93k
  switch (num_symbols) {
129
196
    case 1:
130
196
      table[0] = {0, symbols[0]};
131
196
      break;
132
838
    case 2:
133
838
      if (symbols[0] > symbols[1]) swap_symbols(0, 1);
134
838
      table[0] = {1, symbols[0]};
135
838
      table[1] = {1, symbols[1]};
136
838
      table_size = 2;
137
838
      break;
138
5.89k
    case 3:
139
5.89k
      if (symbols[1] > symbols[2]) swap_symbols(1, 2);
140
5.89k
      table[0] = {1, symbols[0]};
141
5.89k
      table[2] = {1, symbols[0]};
142
5.89k
      table[1] = {2, symbols[1]};
143
5.89k
      table[3] = {2, symbols[2]};
144
5.89k
      table_size = 4;
145
5.89k
      break;
146
0
    case 4: {
147
0
      for (size_t i = 0; i < 3; ++i) {
148
0
        for (size_t j = i + 1; j < 4; ++j) {
149
0
          if (symbols[i] > symbols[j]) swap_symbols(i, j);
150
0
        }
151
0
      }
152
0
      table[0] = {2, symbols[0]};
153
0
      table[2] = {2, symbols[1]};
154
0
      table[1] = {2, symbols[2]};
155
0
      table[3] = {2, symbols[3]};
156
0
      table_size = 4;
157
0
      break;
158
0
    }
159
0
    case 5: {
160
0
      if (symbols[2] > symbols[3]) swap_symbols(2, 3);
161
0
      table[0] = {1, symbols[0]};
162
0
      table[1] = {2, symbols[1]};
163
0
      table[2] = {1, symbols[0]};
164
0
      table[3] = {3, symbols[2]};
165
0
      table[4] = {1, symbols[0]};
166
0
      table[5] = {2, symbols[1]};
167
0
      table[6] = {1, symbols[0]};
168
0
      table[7] = {3, symbols[3]};
169
0
      table_size = 8;
170
0
      break;
171
0
    }
172
0
    default: {
173
      // Unreachable.
174
0
      return false;
175
0
    }
176
6.93k
  }
177
178
6.92k
  const uint32_t goal_size = 1u << kHuffmanTableBits;
179
49.7k
  while (table_size != goal_size) {
180
42.7k
    memcpy(&table[table_size], &table[0],
181
42.7k
           static_cast<size_t>(table_size) * sizeof(table[0]));
182
42.7k
    table_size <<= 1;
183
42.7k
  }
184
185
6.92k
  return true;
186
6.93k
}
187
188
bool HuffmanDecodingData::ReadFromBitStream(size_t alphabet_size,
189
12.0k
                                            BitReader* br) {
190
12.0k
  if (alphabet_size > (1 << PREFIX_MAX_BITS)) return false;
191
192
  /* simple_code_or_skip is used as follows:
193
     1 for simple code;
194
     0 for no skipping, 2 skips 2 code lengths, 3 skips 3 code lengths */
195
12.0k
  uint32_t simple_code_or_skip = br->ReadFixedBits<2>();
196
12.0k
  if (simple_code_or_skip == 1u) {
197
7.07k
    table_.resize(1u << kHuffmanTableBits);
198
7.07k
    return ReadSimpleCode(alphabet_size, br, table_.data());
199
7.07k
  }
200
201
4.92k
  std::vector<uint8_t> code_lengths(alphabet_size, 0);
202
4.92k
  uint8_t code_length_code_lengths[kCodeLengthCodes] = {0};
203
4.92k
  int space = 32;
204
4.92k
  int num_codes = 0;
205
  /* Static Huffman code for the code length code lengths */
206
4.92k
  static const HuffmanCode huff[16] = {
207
4.92k
      {2, 0}, {2, 4}, {2, 3}, {3, 2}, {2, 0}, {2, 4}, {2, 3}, {4, 1},
208
4.92k
      {2, 0}, {2, 4}, {2, 3}, {3, 2}, {2, 0}, {2, 4}, {2, 3}, {4, 5},
209
4.92k
  };
210
45.7k
  for (size_t i = simple_code_or_skip; i < kCodeLengthCodes && space > 0; ++i) {
211
40.8k
    const int code_len_idx = kCodeLengthCodeOrder[i];
212
40.8k
    const HuffmanCode* p = huff;
213
40.8k
    uint8_t v;
214
40.8k
    br->Refill();
215
40.8k
    p += br->PeekFixedBits<4>();
216
40.8k
    br->Consume(p->bits);
217
40.8k
    v = static_cast<uint8_t>(p->value);
218
40.8k
    code_length_code_lengths[code_len_idx] = v;
219
40.8k
    if (v != 0) {
220
31.5k
      space -= (32u >> v);
221
31.5k
      ++num_codes;
222
31.5k
    }
223
40.8k
  }
224
4.92k
  bool ok =
225
4.92k
      (num_codes == 1 || space == 0) &&
226
4.92k
      FROM_JXL_BOOL(ReadHuffmanCodeLengths(
227
4.92k
          code_length_code_lengths, alphabet_size, code_lengths.data(), br));
228
229
4.92k
  if (!ok) return false;
230
4.92k
  uint16_t counts[16] = {0};
231
1.40M
  for (size_t i = 0; i < alphabet_size; ++i) {
232
1.39M
    ++counts[code_lengths[i]];
233
1.39M
  }
234
4.92k
  table_.resize(alphabet_size + 376);
235
4.92k
  uint32_t table_size =
236
4.92k
      BuildHuffmanTable(table_.data(), kHuffmanTableBits, code_lengths.data(),
237
4.92k
                        alphabet_size, &counts[0]);
238
4.92k
  table_.resize(table_size);
239
4.92k
  return (table_size > 0);
240
4.92k
}
241
242
// Decodes the next Huffman coded symbol from the bit-stream.
243
85.8M
uint16_t HuffmanDecodingData::ReadSymbol(BitReader* br) const {
244
85.8M
  size_t n_bits;
245
85.8M
  const HuffmanCode* table = table_.data();
246
85.8M
  table += br->PeekBits(kHuffmanTableBits);
247
85.8M
  n_bits = table->bits;
248
85.8M
  if (n_bits > kHuffmanTableBits) {
249
122k
    br->Consume(kHuffmanTableBits);
250
122k
    n_bits -= kHuffmanTableBits;
251
122k
    table += table->value;
252
122k
    table += br->PeekBits(n_bits);
253
122k
  }
254
85.8M
  br->Consume(table->bits);
255
85.8M
  return table->value;
256
85.8M
}
257
258
}  // namespace jxl