zxing-cpp 0.5.2

A rust wrapper for the zxing-cpp barcode library.
Documentation
/*
 * Copyright 2026 Axel Waggershauser
 */
// SPDX-License-Identifier: Apache-2.0

#include "ODTelepenReader.h"

#include "BarcodeData.h"
#include "SymbologyIdentifier.h"
#include "ZXAlgorithms.h"

#include <cstdint>
#include <ranges>

#ifndef PRINT_DEBUG
#define printf(...){}
#endif

// This code is based on the AIM Europe USS Telepen (1991) specification and ISO/IEC 15424:2025.
// See also https://advanova.co.uk/wp-content/uploads/2022/05/Barcode-Symbology-information-and-History.pdf

namespace ZXing::OneD {

static std::string DecodeNumeric(std::string_view encoded)
{
	std::string decoded;
	decoded.reserve(encoded.size() * 2);

	for (uint8_t codeword : encoded) {
		if (codeword < 16 || codeword == 127)
			decoded += codeword; // control characters
		else if (17 <= codeword && codeword < 27)
			(decoded += ToDigit(codeword - 17)) += 'X';
		else if (27 <= codeword && codeword < 127)
			decoded += ToString(codeword - 27, 2);
		else // (codeword == 16): 16/DLE is the "shift to alpha" codeword and can't appear twice
			return {};
	}

	return decoded;
}

BarcodeData TelepenReader::decodePattern(int rowNumber, PatternView& next, std::unique_ptr<RowReader::DecodingState>&) const
{
	constexpr int minCharCount = 1; // TODO
	constexpr int minQuietZone = 5; // spec requires 10
	constexpr int minCharLength = 16 / 3;
	constexpr FixedPattern<12, 16> startPatterns[3] = {
		{1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 3, 3}, // START 1: "Full ASCII" in AIM Spec
		{1, 1, 1, 1, 1, 1, 1, 1, 3, 1, 1, 3}, // START 2: "Compressed Numeric (+ Full ASCII)" in AIM Spec
		{1, 1, 1, 1, 1, 1, 3, 1, 1, 1, 1, 3}  // START 3: "Full ASCII + Compressed Numeric" in AIM Spec
	};
	constexpr FixedPattern<6, 6> prefixPattern = {1, 1, 1, 1, 1, 1};
	constexpr FixedPattern<11, 15> endPatterns[3] = {
		{3, 3, 1, 1, 1, 1, 1, 1, 1, 1, 1}, // STOP 1
		{3, 1, 1, 3, 1, 1, 1, 1, 1, 1, 1}, // STOP 2
		{3, 1, 1, 1, 1, 3, 1, 1, 1, 1, 1}  // STOP 3
	};

	// Note: In the real-world there are symbols with START 1 + STOP 1 patterns that may contain "Compressed Numeric (+ Full ASCII)"
	// data, see guess-work below.

#if 0 // use fast 1:1:1:1 start pattern plausibility check, then E2E check for the whole start pattern
	next = FindLeftGuard<12>(next, 2 * 12 + minCharCount * minCharLength, [=](const PatternView& view, int spaceInPixel) {
		// find min/max of 4 consecutive bars/spaces and make sure they are close together
		auto mB = view[0], mS = view[1], MB = view[2], MS = view[3];
		if (mB > MB)
			std::swap(mB, MB);
		if (mS > MS)
			std::swap(mS, MS);
		return MB <= mB * 4 / 3 + 1 && MS <= mS * 4 / 3 + 1 && MB < 2 * mS + 1 && MS < 2 * mB + 1
			   && IsPattern<true>(view, startPattern, spaceInPixel, minQuietZone);
	});
#else
	next = FindLeftGuard<true>(next, 2 * 12 + minCharCount * minCharLength, prefixPattern, minQuietZone);
#endif
	if (!next.isValid())
		return {};

	int startChar = 1;
	for (; startChar < 4; ++startChar)
		if (IsPattern<true>(next, startPatterns[startChar - 1], next.spaceInFront(), minQuietZone))
			break;
	if (startChar == 4 || (startChar > 1 && !readNumeric))
		return {};

	const auto &startPattern = startPatterns[startChar - 1];
	const auto &endPattern = endPatterns[startChar - 1];

	int xStart = next.pixelsInFront();
	next = next.subView(0, startPattern.size());

	// get threshold from start pattern
	auto threshold = NarrowWideThreshold(next);
	if (!threshold.isValid())
		return {};

	next = next.subView(startPattern.size(), endPattern.size());
	std::string raw;
	while (next.isValid() && !IsRightGuard<true>(next, endPattern, minQuietZone)) {
		BitArray ba;
		bool inBlock = false;
		BarAndSpace<int> wSum, wNum, nSum, nNum;
		while (next.isValid() && ba.size() < 8) {
			if (next[0] > threshold[0] * 3 || next[1] > threshold[1] * 3)
				return {};
			BarAndSpace<bool> wide = {next[0] > threshold[0], next[1] > threshold[1]};
			if (!wide.bar && !wide.space)     // narrow bar, narrow space
				ba.appendBit(1);
			else if (!wide.bar && wide.space) // narrow bar, wide space
				// trailing 10 | leading 01
				ba.appendBits(std::exchange(inBlock, !inBlock) ? 0b10 : 0b01, 2);
			else if (wide.bar && !wide.space) // wide bar, narrow space
				ba.appendBits(0b00, 2);
			else if (wide.bar && wide.space)  // wide bar, wide space
				ba.appendBits(0b010, 3);

			for (int i = 0; i < 2; ++i) {
				if (next[i] > threshold[i]) {
					wSum[i] += next[i];
					++wNum[i];
				} else {
					nSum[i] += next[i];
					++nNum[i];
				}
			}

			next.skipPair();
		}
		if (ba.size() != 8 || std::ranges::count(ba, false) % 2 != 0) // even parity check
			return {};
		ba.reverse();
		raw += ToInt<char>(ba) & 0x7f; // drop the parity bit

		printf("line: %d, threshold: %2d, %2d, wSum: %2d, %2d, wNum: %d, %d, nSum: %2d, %2d, nNum: %d, %d -> %c ends at: %d\n", rowNumber,
			   threshold[0], threshold[1], wSum[0], wSum[1], wNum[0], wNum[1], nSum[0], nSum[1], nNum[0], nNum[1],
			   raw.back(), next.pixelsInFront());

		for (int i = 0; i < 2; ++i)
			threshold[i] = wNum[i] && nNum[i] ? (wSum[i] / wNum[i] + nSum[i] / nNum[i]) / 2
						   : nNum[i]          ? 2 * nSum[i] / nNum[i]
											  : threshold[i];
	}

	if (raw.size() < minCharCount + 1 || !IsRightGuard<true>(next, endPattern, minQuietZone))
		return {};

	auto txt = raw.substr(0, raw.size() - 1); // drop checksum character
	auto checkSum = (127 - (Reduce(txt, 0) % 127)) % 127;
	char modifier = 0;
	Error error;

	if (checkSum != raw.back()) {
		error = Error::Checksum;
	} else {
		if (startChar == 1 && readNumeric) { // "Full ASCII" in AIM Spec or "Compressed Numeric (+ Full ASCII)" in "the wild"
			// Apply guesswork to determine whether to treat as "Full ASCII" or "Compressed Numeric (+ Full ASCII)"
			// Num+Alpha (startChar is 2) is likely if there is at most one DLE that is not the first character and there are
			// non-printable ASCII characters but none that are not used in "Compressed Numeric" to encode digits.
			if (!readAlpha
				|| (std::ranges::count(txt, '\x10') <= 1 && txt.front() != '\x10'
					&& std::ranges::any_of(txt, [](uint8_t c) { return c < 32; })
					&& std::ranges::none_of(txt, [](uint8_t c) { return c < 16; })))
				startChar = 2;
		}

		const auto dle = IndexOf(txt, '\x10'); // DLE (== 16) is the "shift" codeword for switching between alpha and numeric modes
		// see ISO/IEC 15424:2025 4.4.3
		if (startChar == 1) {
			modifier = '0'; // Full ASCII mode
		} else if (startChar == 2 && dle != 0) {
			auto num = dle == -1 ? DecodeNumeric(txt) : DecodeNumeric(txt.substr(0, dle));
			auto alpha = dle == -1 ? std::string() : txt.substr(dle + 1);
			if (num.empty())
				error = Error::Format; // invalid numeric encoding
			else
				txt = num + alpha;
			modifier = dle == -1 ? '1' : '2'; // Double density numeric: only (1) / followed by full ASCII (2)
		} else if (startChar == 3 && dle != 0) {
			auto alpha = dle == -1 ? txt : txt.substr(0, dle);
			auto num = dle == -1 ? std::string() : DecodeNumeric(txt.substr(dle + 1));
			if (dle != -1 && num.empty())
				error = Error::Format; // invalid numeric encoding
			else
				txt = alpha + num;
			modifier = dle == -1 ? '0' : '4'; // Full ASCII: only (0) / followed by double density numeric (4)
		} else
			error = Error::Format; // DLE as first character is not allowed
	}

	int xStop = next.pixelsTillEnd();
	SymbologyIdentifier symbologyIdentifier = {'B', modifier};
	auto format = modifier == '1' ? BarcodeFormat::TelepenNumeric : BarcodeFormat::TelepenAlpha;
	printf("line: %d, raw: %s, txt: %s, checksum: %d\n", rowNumber, raw.c_str(), txt.c_str(), checkSum);

	return LinearBarcode(format, txt, rowNumber, xStart, xStop, symbologyIdentifier, error);
}

} // namespace ZXing::OneD