zxing-cpp 0.5.2

A rust wrapper for the zxing-cpp barcode library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

// Copyright 2026 Axel Waggershauser
// SPDX-License-Identifier: Apache-2.0

#include "ReedSolomon.h"
#include "Version.h"
#include "ZXAlgorithms.h"

#include "librscpp/encode.h"
#include "librscpp/decode.h"

#include <algorithm>
#include <type_traits>
#include <stdexcept>
#include <utility>

namespace ZXing {

namespace rs = librscpp;

using GF2nI = rs::GF2n<>;

const GF2nI& GetGF2n(RSField field)
{
	static GF2nI gf2n_4_1(0x0013, 1);      // x^4 + x + 1
	static GF2nI gf2n_6_1(0x0043, 1);      // x^6 + x + 1
	static GF2nI gf2n_8_5_3_2(0x012D, 1);  // x^8 + x^5 + x^3 + x^2 + 1 : DataMatrix
	static GF2nI gf2n_8_4_3_2(0x011D, 0);  // x^8 + x^4 + x^3 + x^2 + 1 : QRCode
	static GF2nI gf2n_10_3(0x0409, 1);     // x^10 + x^3 + 1
	static GF2nI gf2n_12_6_5_3(0x1069, 1); // x^12 + x^6 + x^5 + x^3 + 1

	switch (field) {
	case RSField::Aztec4: return gf2n_4_1;
	case RSField::Aztec6: return gf2n_6_1;
	case RSField::Aztec8: return gf2n_8_5_3_2;
	case RSField::Aztec10: return gf2n_10_3;
	case RSField::Aztec12: return gf2n_12_6_5_3;
	case RSField::DataMatrix: return gf2n_8_5_3_2;
	case RSField::MaxiCode: return gf2n_6_1;
	case RSField::QRCode: return gf2n_8_4_3_2;
	default: throw std::invalid_argument("Unsupported RSField");
	}
}

const rs::GFp<>& GetGFPDF417()
{
	static rs::GFp<> gf929_3(929, 3, 1);
	return gf929_3;
}

// See ISO/IEC 15415:2024 7.5.9
static std::optional<double> UEC(std::optional<int> usedECC, int numECC)
{
	return usedECC ? std::optional(std::clamp(1.0 - static_cast<double>(*usedECC) / numECC, 0.0, 1.0)) : std::nullopt;
}

#ifdef ZXING_READERS
std::optional<double> ReedSolomonDecode(RSField field, std::span<uint8_t> codeword, int numECC, std::span<const int> erasures)
{
	return UEC(rs::decode(GetGF2n(field), codeword, numECC, erasures), numECC);
}

std::optional<double> ReedSolomonDecode(RSField field, std::span<int> codeword, int numECC, std::span<const int> erasures)
{
	// The number of erasures may at most be numECC - 2 because leaving less than 2 parity symbols for error correction would make it
	// impossible to correct or even detect any errors. See also ISO/IEC 24728-2006 5.7.2
	if (Size(erasures) > numECC - 2)
		return {};

#if ZXING_ENABLE_PDF417
	if (field == RSField::PDF417)
		return UEC(rs::decode(GetGFPDF417(), codeword, numECC, erasures), numECC);
	else
#endif
		return UEC(rs::decode(GetGF2n(field), codeword, numECC, erasures), numECC);
}
#endif

#ifdef ZXING_WRITERS
void ReedSolomonEncode(RSField field, std::span<const uint8_t> data, std::span<uint8_t> parity)
{
	rs::encode(GetGF2n(field), data, parity);
}

void ReedSolomonEncode(RSField field, std::span<uint8_t> codeword, int numECC)
{
	rs::encode_inplace(GetGF2n(field), codeword, numECC);
}

void ReedSolomonEncode(RSField field, std::span<int> codeword, int numECC)
{
#if ZXING_ENABLE_PDF417
	if (field == RSField::PDF417)
		return rs::encode_inplace(GetGFPDF417(), codeword, numECC);
	else
#endif
		rs::encode_inplace(GetGF2n(field), codeword, numECC);
}
#endif

} // namespace ZXing