Coverage Report

Created: 2026-01-20 07:37

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/libjxl/lib/jxl/dec_huffman.cc
Line
Count
Source
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
10
#include <cstdint>
11
#include <cstring> /* for memset */
12
#include <vector>
13
14
#include "lib/jxl/ans_params.h"
15
#include "lib/jxl/base/bits.h"
16
#include "lib/jxl/base/compiler_specific.h"
17
#include "lib/jxl/dec_bit_reader.h"
18
#include "lib/jxl/huffman_table.h"
19
20
namespace jxl {
21
22
static const int kCodeLengthCodes = 18;
23
static const uint8_t kCodeLengthCodeOrder[kCodeLengthCodes] = {
24
    1, 2, 3, 4, 0, 5, 17, 6, 16, 7, 8, 9, 10, 11, 12, 13, 14, 15,
25
};
26
static const uint8_t kDefaultCodeLength = 8;
27
static const uint8_t kCodeLengthRepeatCode = 16;
28
29
JXL_BOOL ReadHuffmanCodeLengths(const uint8_t* code_length_code_lengths,
30
                                int num_symbols, uint8_t* code_lengths,
31
10.8k
                                BitReader* br) {
32
10.8k
  int symbol = 0;
33
10.8k
  uint8_t prev_code_len = kDefaultCodeLength;
34
10.8k
  int repeat = 0;
35
10.8k
  uint8_t repeat_code_len = 0;
36
10.8k
  int space = 32768;
37
10.8k
  HuffmanCode table[32];
38
39
10.8k
  uint16_t counts[16] = {0};
40
205k
  for (int i = 0; i < kCodeLengthCodes; ++i) {
41
195k
    ++counts[code_length_code_lengths[i]];
42
195k
  }
43
10.8k
  if (!BuildHuffmanTable(table, 5, code_length_code_lengths, kCodeLengthCodes,
44
10.8k
                         &counts[0])) {
45
0
    return JXL_FALSE;
46
0
  }
47
48
3.76M
  while (symbol < num_symbols && space > 0) {
49
3.75M
    const HuffmanCode* p = table;
50
3.75M
    uint8_t code_len;
51
3.75M
    br->Refill();
52
3.75M
    p += br->PeekFixedBits<5>();
53
3.75M
    br->Consume(p->bits);
54
3.75M
    code_len = static_cast<uint8_t>(p->value);
55
3.75M
    if (code_len < kCodeLengthRepeatCode) {
56
3.73M
      repeat = 0;
57
3.73M
      code_lengths[symbol++] = code_len;
58
3.73M
      if (code_len != 0) {
59
2.94M
        prev_code_len = code_len;
60
2.94M
        space -= 32768u >> code_len;
61
2.94M
      }
62
3.73M
    } else {
63
15.9k
      const int extra_bits = code_len - 14;
64
15.9k
      int old_repeat;
65
15.9k
      int repeat_delta;
66
15.9k
      uint8_t new_len = 0;
67
15.9k
      if (code_len == kCodeLengthRepeatCode) {
68
9.44k
        new_len = prev_code_len;
69
9.44k
      }
70
15.9k
      if (repeat_code_len != new_len) {
71
3.81k
        repeat = 0;
72
3.81k
        repeat_code_len = new_len;
73
3.81k
      }
74
15.9k
      old_repeat = repeat;
75
15.9k
      if (repeat > 0) {
76
3.00k
        repeat -= 2;
77
3.00k
        repeat <<= extra_bits;
78
3.00k
      }
79
15.9k
      repeat += static_cast<int>(br->ReadBits(extra_bits) + 3);
80
15.9k
      repeat_delta = repeat - old_repeat;
81
15.9k
      if (symbol + repeat_delta > num_symbols) {
82
421
        return 0;
83
421
      }
84
15.4k
      memset(&code_lengths[symbol], repeat_code_len,
85
15.4k
             static_cast<size_t>(repeat_delta));
86
15.4k
      symbol += repeat_delta;
87
15.4k
      if (repeat_code_len != 0) {
88
9.17k
        space -= repeat_delta << (15 - repeat_code_len);
89
9.17k
      }
90
15.4k
    }
91
3.75M
  }
92
10.4k
  if (space != 0) {
93
884
    return JXL_FALSE;
94
884
  }
95
9.53k
  memset(&code_lengths[symbol], 0, static_cast<size_t>(num_symbols - symbol));
96
9.53k
  return JXL_TRUE;
97
10.4k
}
98
99
static JXL_INLINE bool ReadSimpleCode(size_t alphabet_size, BitReader* br,
100
12.2k
                                      HuffmanCode* table) {
101
12.2k
  size_t max_bits =
102
12.2k
      (alphabet_size > 1u) ? FloorLog2Nonzero(alphabet_size - 1u) + 1 : 0;
103
104
12.2k
  size_t num_symbols = br->ReadFixedBits<2>() + 1;
105
106
12.2k
  uint16_t symbols[4] = {0};
107
48.3k
  for (size_t i = 0; i < num_symbols; ++i) {
108
36.2k
    uint16_t symbol = br->ReadBits(max_bits);
109
36.2k
    if (symbol >= alphabet_size) {
110
199
      return false;
111
199
    }
112
36.0k
    symbols[i] = symbol;
113
36.0k
  }
114
115
35.1k
  for (size_t i = 0; i < num_symbols - 1; ++i) {
116
64.2k
    for (size_t j = i + 1; j < num_symbols; ++j) {
117
41.2k
      if (symbols[i] == symbols[j]) return false;
118
41.2k
    }
119
23.2k
  }
120
121
  // 4 symbols have to option to encode.
122
11.8k
  if (num_symbols == 4) num_symbols += br->ReadFixedBits<1>();
123
124
11.8k
  const auto swap_symbols = [&symbols](size_t i, size_t j) {
125
3.44k
    uint16_t t = symbols[j];
126
3.44k
    symbols[j] = symbols[i];
127
3.44k
    symbols[i] = t;
128
3.44k
  };
129
130
11.8k
  size_t table_size = 1;
131
11.8k
  switch (num_symbols) {
132
1.65k
    case 1:
133
1.65k
      table[0] = {0, symbols[0]};
134
1.65k
      break;
135
2.37k
    case 2:
136
2.37k
      if (symbols[0] > symbols[1]) swap_symbols(0, 1);
137
2.37k
      table[0] = {1, symbols[0]};
138
2.37k
      table[1] = {1, symbols[1]};
139
2.37k
      table_size = 2;
140
2.37k
      break;
141
2.73k
    case 3:
142
2.73k
      if (symbols[1] > symbols[2]) swap_symbols(1, 2);
143
2.73k
      table[0] = {1, symbols[0]};
144
2.73k
      table[2] = {1, symbols[0]};
145
2.73k
      table[1] = {2, symbols[1]};
146
2.73k
      table[3] = {2, symbols[2]};
147
2.73k
      table_size = 4;
148
2.73k
      break;
149
606
    case 4: {
150
2.42k
      for (size_t i = 0; i < 3; ++i) {
151
5.45k
        for (size_t j = i + 1; j < 4; ++j) {
152
3.63k
          if (symbols[i] > symbols[j]) swap_symbols(i, j);
153
3.63k
        }
154
1.81k
      }
155
606
      table[0] = {2, symbols[0]};
156
606
      table[2] = {2, symbols[1]};
157
606
      table[1] = {2, symbols[2]};
158
606
      table[3] = {2, symbols[3]};
159
606
      table_size = 4;
160
606
      break;
161
0
    }
162
4.43k
    case 5: {
163
4.43k
      if (symbols[2] > symbols[3]) swap_symbols(2, 3);
164
4.43k
      table[0] = {1, symbols[0]};
165
4.43k
      table[1] = {2, symbols[1]};
166
4.43k
      table[2] = {1, symbols[0]};
167
4.43k
      table[3] = {3, symbols[2]};
168
4.43k
      table[4] = {1, symbols[0]};
169
4.43k
      table[5] = {2, symbols[1]};
170
4.43k
      table[6] = {1, symbols[0]};
171
4.43k
      table[7] = {3, symbols[3]};
172
4.43k
      table_size = 8;
173
4.43k
      break;
174
0
    }
175
0
    default: {
176
      // Unreachable.
177
0
      return false;
178
0
    }
179
11.8k
  }
180
181
11.8k
  const uint32_t goal_size = 1u << kHuffmanTableBits;
182
83.9k
  while (table_size != goal_size) {
183
72.0k
    memcpy(&table[table_size], &table[0],
184
72.0k
           static_cast<size_t>(table_size) * sizeof(table[0]));
185
72.0k
    table_size <<= 1;
186
72.0k
  }
187
188
11.8k
  return true;
189
11.8k
}
190
191
bool HuffmanDecodingData::ReadFromBitStream(size_t alphabet_size,
192
29.7k
                                            BitReader* br) {
193
29.7k
  if (alphabet_size > (1 << PREFIX_MAX_BITS)) return false;
194
195
  /* simple_code_or_skip is used as follows:
196
     1 for simple code;
197
     0 for no skipping, 2 skips 2 code lengths, 3 skips 3 code lengths */
198
29.7k
  uint32_t simple_code_or_skip = br->ReadFixedBits<2>();
199
29.7k
  if (simple_code_or_skip == 1u) {
200
12.2k
    table_.resize(1u << kHuffmanTableBits);
201
12.2k
    return ReadSimpleCode(alphabet_size, br, table_.data());
202
12.2k
  }
203
204
17.4k
  std::vector<uint8_t> code_lengths(alphabet_size, 0);
205
17.4k
  uint8_t code_length_code_lengths[kCodeLengthCodes] = {0};
206
17.4k
  int space = 32;
207
17.4k
  int num_codes = 0;
208
  /* Static Huffman code for the code length code lengths */
209
17.4k
  static const HuffmanCode huff[16] = {
210
17.4k
      {2, 0}, {2, 4}, {2, 3}, {3, 2}, {2, 0}, {2, 4}, {2, 3}, {4, 1},
211
17.4k
      {2, 0}, {2, 4}, {2, 3}, {3, 2}, {2, 0}, {2, 4}, {2, 3}, {4, 5},
212
17.4k
  };
213
211k
  for (size_t i = simple_code_or_skip; i < kCodeLengthCodes && space > 0; ++i) {
214
193k
    const int code_len_idx = kCodeLengthCodeOrder[i];
215
193k
    const HuffmanCode* p = huff;
216
193k
    uint8_t v;
217
193k
    br->Refill();
218
193k
    p += br->PeekFixedBits<4>();
219
193k
    br->Consume(p->bits);
220
193k
    v = static_cast<uint8_t>(p->value);
221
193k
    code_length_code_lengths[code_len_idx] = v;
222
193k
    if (v != 0) {
223
84.8k
      space -= (32u >> v);
224
84.8k
      ++num_codes;
225
84.8k
    }
226
193k
  }
227
17.4k
  bool ok =
228
17.4k
      (num_codes == 1 || space == 0) &&
229
10.8k
      FROM_JXL_BOOL(ReadHuffmanCodeLengths(
230
17.4k
          code_length_code_lengths, alphabet_size, code_lengths.data(), br));
231
232
17.4k
  if (!ok) return false;
233
9.53k
  uint16_t counts[16] = {0};
234
11.5M
  for (size_t i = 0; i < alphabet_size; ++i) {
235
11.5M
    ++counts[code_lengths[i]];
236
11.5M
  }
237
9.53k
  table_.resize(alphabet_size + 376);
238
9.53k
  uint32_t table_size =
239
9.53k
      BuildHuffmanTable(table_.data(), kHuffmanTableBits, code_lengths.data(),
240
9.53k
                        alphabet_size, &counts[0]);
241
9.53k
  table_.resize(table_size);
242
9.53k
  return (table_size > 0);
243
17.4k
}
244
245
}  // namespace jxl