Coverage Report

Created: 2026-09-14 07:15

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
8.60k
                                BitReader* br) {
32
8.60k
  int symbol = 0;
33
8.60k
  uint8_t prev_code_len = kDefaultCodeLength;
34
8.60k
  int repeat = 0;
35
8.60k
  uint8_t repeat_code_len = 0;
36
8.60k
  int space = 32768;
37
8.60k
  HuffmanCode table[32];
38
39
8.60k
  uint16_t counts[16] = {0};
40
163k
  for (int i = 0; i < kCodeLengthCodes; ++i) {
41
154k
    ++counts[code_length_code_lengths[i]];
42
154k
  }
43
8.60k
  if (!BuildHuffmanTable(table, 5, code_length_code_lengths, kCodeLengthCodes,
44
8.60k
                         &counts[0])) {
45
0
    return JXL_FALSE;
46
0
  }
47
48
409k
  while (symbol < num_symbols && space > 0) {
49
400k
    const HuffmanCode* p = table;
50
400k
    uint8_t code_len;
51
400k
    br->Refill();
52
400k
    p += br->PeekFixedBits<5>();
53
400k
    br->Consume(p->bits);
54
400k
    code_len = static_cast<uint8_t>(p->value);
55
400k
    if (code_len < kCodeLengthRepeatCode) {
56
393k
      repeat = 0;
57
393k
      code_lengths[symbol++] = code_len;
58
393k
      if (code_len != 0) {
59
246k
        prev_code_len = code_len;
60
246k
        space -= 32768u >> code_len;
61
246k
      }
62
393k
    } else {
63
7.11k
      const int extra_bits = code_len - 14;
64
7.11k
      int old_repeat;
65
7.11k
      int repeat_delta;
66
7.11k
      uint8_t new_len = 0;
67
7.11k
      if (code_len == kCodeLengthRepeatCode) {
68
388
        new_len = prev_code_len;
69
388
      }
70
7.11k
      if (repeat_code_len != new_len) {
71
398
        repeat = 0;
72
398
        repeat_code_len = new_len;
73
398
      }
74
7.11k
      old_repeat = repeat;
75
7.11k
      if (repeat > 0) {
76
4.35k
        repeat -= 2;
77
4.35k
        repeat <<= extra_bits;
78
4.35k
      }
79
7.11k
      repeat += static_cast<int>(br->ReadBits(extra_bits) + 3);
80
7.11k
      repeat_delta = repeat - old_repeat;
81
7.11k
      if (symbol + repeat_delta > num_symbols) {
82
5
        return 0;
83
5
      }
84
7.10k
      memset(&code_lengths[symbol], repeat_code_len,
85
7.10k
             static_cast<size_t>(repeat_delta));
86
7.10k
      symbol += repeat_delta;
87
7.10k
      if (repeat_code_len != 0) {
88
388
        space -= repeat_delta << (15 - repeat_code_len);
89
388
      }
90
7.10k
    }
91
400k
  }
92
8.60k
  if (space != 0) {
93
9
    return JXL_FALSE;
94
9
  }
95
8.59k
  memset(&code_lengths[symbol], 0, static_cast<size_t>(num_symbols - symbol));
96
8.59k
  return JXL_TRUE;
97
8.60k
}
98
99
static JXL_INLINE bool ReadSimpleCode(size_t alphabet_size, BitReader* br,
100
9.64k
                                      HuffmanCode* table) {
101
9.64k
  size_t max_bits =
102
9.64k
      (alphabet_size > 1u) ? FloorLog2Nonzero(alphabet_size - 1u) + 1 : 0;
103
104
9.64k
  size_t num_symbols = br->ReadFixedBits<2>() + 1;
105
106
9.64k
  uint16_t symbols[4] = {0};
107
35.0k
  for (size_t i = 0; i < num_symbols; ++i) {
108
25.4k
    uint16_t symbol = br->ReadBits(max_bits);
109
25.4k
    if (symbol >= alphabet_size) {
110
2
      return false;
111
2
    }
112
25.4k
    symbols[i] = symbol;
113
25.4k
  }
114
115
25.3k
  for (size_t i = 0; i < num_symbols - 1; ++i) {
116
39.8k
    for (size_t j = i + 1; j < num_symbols; ++j) {
117
24.1k
      if (symbols[i] == symbols[j]) return false;
118
24.1k
    }
119
15.7k
  }
120
121
  // 4 symbols have to option to encode.
122
9.62k
  if (num_symbols == 4) num_symbols += br->ReadFixedBits<1>();
123
124
9.62k
  const auto swap_symbols = [&symbols](size_t i, size_t j) {
125
5.73k
    uint16_t t = symbols[j];
126
5.73k
    symbols[j] = symbols[i];
127
5.73k
    symbols[i] = t;
128
5.73k
  };
129
130
9.62k
  size_t table_size = 1;
131
9.62k
  switch (num_symbols) {
132
1.40k
    case 1:
133
1.40k
      table[0] = {0, symbols[0]};
134
1.40k
      break;
135
1.60k
    case 2:
136
1.60k
      if (symbols[0] > symbols[1]) swap_symbols(0, 1);
137
1.60k
      table[0] = {1, symbols[0]};
138
1.60k
      table[1] = {1, symbols[1]};
139
1.60k
      table_size = 2;
140
1.60k
      break;
141
5.71k
    case 3:
142
5.71k
      if (symbols[1] > symbols[2]) swap_symbols(1, 2);
143
5.71k
      table[0] = {1, symbols[0]};
144
5.71k
      table[2] = {1, symbols[0]};
145
5.71k
      table[1] = {2, symbols[1]};
146
5.71k
      table[3] = {2, symbols[2]};
147
5.71k
      table_size = 4;
148
5.71k
      break;
149
23
    case 4: {
150
92
      for (size_t i = 0; i < 3; ++i) {
151
207
        for (size_t j = i + 1; j < 4; ++j) {
152
138
          if (symbols[i] > symbols[j]) swap_symbols(i, j);
153
138
        }
154
69
      }
155
23
      table[0] = {2, symbols[0]};
156
23
      table[2] = {2, symbols[1]};
157
23
      table[1] = {2, symbols[2]};
158
23
      table[3] = {2, symbols[3]};
159
23
      table_size = 4;
160
23
      break;
161
0
    }
162
877
    case 5: {
163
877
      if (symbols[2] > symbols[3]) swap_symbols(2, 3);
164
877
      table[0] = {1, symbols[0]};
165
877
      table[1] = {2, symbols[1]};
166
877
      table[2] = {1, symbols[0]};
167
877
      table[3] = {3, symbols[2]};
168
877
      table[4] = {1, symbols[0]};
169
877
      table[5] = {2, symbols[1]};
170
877
      table[6] = {1, symbols[0]};
171
877
      table[7] = {3, symbols[3]};
172
877
      table_size = 8;
173
877
      break;
174
0
    }
175
0
    default: {
176
      // Unreachable.
177
0
      return false;
178
0
    }
179
9.62k
  }
180
181
9.61k
  const uint32_t goal_size = 1u << kHuffmanTableBits;
182
70.8k
  while (table_size != goal_size) {
183
61.2k
    memcpy(&table[table_size], &table[0],
184
61.2k
           static_cast<size_t>(table_size) * sizeof(table[0]));
185
61.2k
    table_size <<= 1;
186
61.2k
  }
187
188
9.61k
  return true;
189
9.62k
}
190
191
bool HuffmanDecodingData::ReadFromBitStream(size_t alphabet_size,
192
18.2k
                                            BitReader* br) {
193
18.2k
  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
18.2k
  uint32_t simple_code_or_skip = br->ReadFixedBits<2>();
199
18.2k
  if (simple_code_or_skip == 1u) {
200
9.64k
    table_.resize(1u << kHuffmanTableBits);
201
9.64k
    return ReadSimpleCode(alphabet_size, br, table_.data());
202
9.64k
  }
203
204
8.63k
  std::vector<uint8_t> code_lengths(alphabet_size, 0);
205
8.63k
  uint8_t code_length_code_lengths[kCodeLengthCodes] = {0};
206
8.63k
  int space = 32;
207
8.63k
  int num_codes = 0;
208
  /* Static Huffman code for the code length code lengths */
209
8.63k
  static const HuffmanCode huff[16] = {
210
8.63k
      {2, 0}, {2, 4}, {2, 3}, {3, 2}, {2, 0}, {2, 4}, {2, 3}, {4, 1},
211
8.63k
      {2, 0}, {2, 4}, {2, 3}, {3, 2}, {2, 0}, {2, 4}, {2, 3}, {4, 5},
212
8.63k
  };
213
81.4k
  for (size_t i = simple_code_or_skip; i < kCodeLengthCodes && space > 0; ++i) {
214
72.8k
    const int code_len_idx = kCodeLengthCodeOrder[i];
215
72.8k
    const HuffmanCode* p = huff;
216
72.8k
    uint8_t v;
217
72.8k
    br->Refill();
218
72.8k
    p += br->PeekFixedBits<4>();
219
72.8k
    br->Consume(p->bits);
220
72.8k
    v = static_cast<uint8_t>(p->value);
221
72.8k
    code_length_code_lengths[code_len_idx] = v;
222
72.8k
    if (v != 0) {
223
49.7k
      space -= (32u >> v);
224
49.7k
      ++num_codes;
225
49.7k
    }
226
72.8k
  }
227
8.63k
  bool ok =
228
8.63k
      (num_codes == 1 || space == 0) &&
229
8.60k
      FROM_JXL_BOOL(ReadHuffmanCodeLengths(
230
8.63k
          code_length_code_lengths, alphabet_size, code_lengths.data(), br));
231
232
8.63k
  if (!ok) return false;
233
8.60k
  uint16_t counts[16] = {0};
234
4.43M
  for (size_t i = 0; i < alphabet_size; ++i) {
235
4.42M
    ++counts[code_lengths[i]];
236
4.42M
  }
237
8.60k
  table_.resize(alphabet_size + 376);
238
8.60k
  uint32_t table_size =
239
8.60k
      BuildHuffmanTable(table_.data(), kHuffmanTableBits, code_lengths.data(),
240
8.60k
                        alphabet_size, &counts[0]);
241
8.60k
  table_.resize(table_size);
242
8.60k
  return (table_size > 0);
243
8.63k
}
244
245
}  // namespace jxl