Coverage Report

Created: 2025-07-23 08:18

/src/libjxl/lib/jxl/enc_context_map.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
// Library to encode the context map.
7
8
#include "lib/jxl/enc_context_map.h"
9
10
#include <jxl/memory_manager.h>
11
#include <jxl/types.h>
12
13
#include <algorithm>
14
#include <cstddef>
15
#include <cstdint>
16
#include <vector>
17
18
#include "lib/jxl/ac_context.h"
19
#include "lib/jxl/base/bits.h"
20
#include "lib/jxl/base/status.h"
21
#include "lib/jxl/enc_ans.h"
22
#include "lib/jxl/enc_ans_params.h"
23
#include "lib/jxl/enc_aux_out.h"
24
#include "lib/jxl/entropy_coder.h"
25
#include "lib/jxl/fields.h"
26
#include "lib/jxl/pack_signed.h"
27
28
namespace jxl {
29
30
namespace {
31
32
5.95M
size_t IndexOf(const std::vector<uint8_t>& v, uint8_t value) {
33
5.95M
  size_t i = 0;
34
19.0M
  for (; i < v.size(); ++i) {
35
19.0M
    if (v[i] == value) return i;
36
19.0M
  }
37
0
  return i;
38
5.95M
}
39
40
5.95M
void MoveToFront(std::vector<uint8_t>* v, size_t index) {
41
5.95M
  uint8_t value = (*v)[index];
42
19.0M
  for (size_t i = index; i != 0; --i) {
43
13.0M
    (*v)[i] = (*v)[i - 1];
44
13.0M
  }
45
5.95M
  (*v)[0] = value;
46
5.95M
}
47
48
9.39k
std::vector<uint8_t> MoveToFrontTransform(const std::vector<uint8_t>& v) {
49
9.39k
  if (v.empty()) return v;
50
9.39k
  uint8_t max_value = *std::max_element(v.begin(), v.end());
51
9.39k
  std::vector<uint8_t> mtf(max_value + 1);
52
134k
  for (size_t i = 0; i <= max_value; ++i) mtf[i] = i;
53
9.39k
  std::vector<uint8_t> result(v.size());
54
5.96M
  for (size_t i = 0; i < v.size(); ++i) {
55
5.95M
    size_t index = IndexOf(mtf, v[i]);
56
5.95M
    JXL_DASSERT(index < mtf.size());
57
5.95M
    result[i] = static_cast<uint8_t>(index);
58
5.95M
    MoveToFront(&mtf, index);
59
5.95M
  }
60
9.39k
  return result;
61
9.39k
}
62
63
}  // namespace
64
65
Status EncodeContextMap(const std::vector<uint8_t>& context_map,
66
                        size_t num_histograms, BitWriter* writer,
67
13.7k
                        LayerType layer, AuxOut* aux_out) {
68
13.7k
  if (num_histograms == 1) {
69
    // Simple code
70
4.34k
    writer->Write(1, 1);
71
    // 0 bits per entry.
72
4.34k
    writer->Write(2, 0);
73
4.34k
    return true;
74
4.34k
  }
75
76
9.39k
  JxlMemoryManager* memory_manager = writer->memory_manager();
77
9.39k
  std::vector<uint8_t> transformed_symbols = MoveToFrontTransform(context_map);
78
9.39k
  std::vector<std::vector<Token>> tokens(1);
79
9.39k
  std::vector<std::vector<Token>> mtf_tokens(1);
80
5.95M
  for (const uint8_t& ctx : context_map) {
81
5.95M
    tokens[0].emplace_back(0, ctx);
82
5.95M
  }
83
5.95M
  for (const uint8_t& sym : transformed_symbols) {
84
5.95M
    mtf_tokens[0].emplace_back(0, sym);
85
5.95M
  }
86
9.39k
  HistogramParams params;
87
9.39k
  params.uint_method = HistogramParams::HybridUintMethod::kContextMap;
88
9.39k
  size_t ans_cost;
89
9.39k
  size_t mtf_cost;
90
9.39k
  {
91
9.39k
    EntropyEncodingData codes;
92
9.39k
    JXL_ASSIGN_OR_RETURN(
93
9.39k
        ans_cost, BuildAndEncodeHistograms(memory_manager, params, 1, tokens,
94
9.39k
                                           &codes, nullptr, LayerType::Header,
95
9.39k
                                           /*aux_out*/ nullptr));
96
9.39k
  }
97
0
  {
98
9.39k
    EntropyEncodingData codes;
99
9.39k
    JXL_ASSIGN_OR_RETURN(
100
9.39k
        mtf_cost, BuildAndEncodeHistograms(
101
9.39k
                      memory_manager, params, 1, mtf_tokens, &codes, nullptr,
102
9.39k
                      LayerType::Header, /*aux_out*/ nullptr));
103
9.39k
  }
104
0
  bool use_mtf = mtf_cost < ans_cost;
105
  // Rebuild token list.
106
9.39k
  tokens[0].clear();
107
5.96M
  for (size_t i = 0; i < transformed_symbols.size(); i++) {
108
5.95M
    tokens[0].emplace_back(0,
109
5.95M
                           use_mtf ? transformed_symbols[i] : context_map[i]);
110
5.95M
  }
111
9.39k
  size_t entry_bits = CeilLog2Nonzero(num_histograms);
112
9.39k
  size_t simple_cost = entry_bits * context_map.size();
113
9.39k
  if (entry_bits < 4 && simple_cost < ans_cost && simple_cost < mtf_cost) {
114
4.53k
    JXL_RETURN_IF_ERROR(writer->WithMaxBits(
115
4.53k
        3 + entry_bits * context_map.size(), layer, aux_out, [&] {
116
4.53k
          writer->Write(1, 1);
117
4.53k
          writer->Write(2, entry_bits);
118
4.53k
          for (uint8_t entry : context_map) {
119
4.53k
            writer->Write(entry_bits, entry);
120
4.53k
          }
121
4.53k
          return true;
122
4.53k
        }));
123
4.85k
  } else {
124
4.85k
    JXL_RETURN_IF_ERROR(writer->WithMaxBits(
125
4.85k
        2 + tokens[0].size() * 24, layer, aux_out, [&]() -> Status {
126
4.85k
          writer->Write(1, 0);
127
4.85k
          writer->Write(1, TO_JXL_BOOL(use_mtf));  // Use/don't use MTF.
128
4.85k
          EntropyEncodingData codes;
129
4.85k
          JXL_ASSIGN_OR_RETURN(
130
4.85k
              size_t cost,
131
4.85k
              BuildAndEncodeHistograms(memory_manager, params, 1, tokens,
132
4.85k
                                       &codes, writer, layer, aux_out));
133
4.85k
          (void)cost;
134
4.85k
          WriteTokens(tokens[0], codes, 0, writer);
135
4.85k
          return true;
136
4.85k
        }));
137
4.85k
  }
138
9.39k
  return true;
139
9.39k
}
140
141
Status EncodeBlockCtxMap(const BlockCtxMap& block_ctx_map, BitWriter* writer,
142
2.13k
                         AuxOut* aux_out) {
143
2.13k
  const auto& dct = block_ctx_map.dc_thresholds;
144
2.13k
  const auto& qft = block_ctx_map.qf_thresholds;
145
2.13k
  const auto& ctx_map = block_ctx_map.ctx_map;
146
2.13k
  return writer->WithMaxBits(
147
2.13k
      (dct[0].size() + dct[1].size() + dct[2].size() + qft.size()) * 34 + 1 +
148
2.13k
          4 + 4 + ctx_map.size() * 10 + 1024,
149
2.13k
      LayerType::Ac, aux_out, [&]() -> Status {
150
2.13k
        if (dct[0].empty() && dct[1].empty() && dct[2].empty() && qft.empty() &&
151
2.13k
            ctx_map.size() == 21 &&
152
2.13k
            std::equal(ctx_map.begin(), ctx_map.end(),
153
0
                       BlockCtxMap::kDefaultCtxMap)) {
154
0
          writer->Write(1, 1);  // default
155
0
          return true;
156
0
        }
157
2.13k
        writer->Write(1, 0);
158
6.39k
        for (int j : {0, 1, 2}) {
159
6.39k
          writer->Write(4, dct[j].size());
160
6.39k
          for (int i : dct[j]) {
161
0
            JXL_RETURN_IF_ERROR(
162
0
                U32Coder::Write(kDCThresholdDist, PackSigned(i), writer));
163
0
          }
164
6.39k
        }
165
2.13k
        writer->Write(4, qft.size());
166
2.13k
        for (uint32_t i : qft) {
167
0
          JXL_RETURN_IF_ERROR(U32Coder::Write(kQFThresholdDist, i - 1, writer));
168
0
        }
169
2.13k
        JXL_RETURN_IF_ERROR(EncodeContextMap(ctx_map, block_ctx_map.num_ctxs,
170
2.13k
                                             writer, LayerType::Ac, aux_out));
171
2.13k
        return true;
172
2.13k
      });
173
2.13k
}
174
175
}  // namespace jxl