Coverage Report

Created: 2025-06-22 08:04

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