Coverage Report

Created: 2026-02-14 07:11

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