code128barcode.cpp

/*
    SPDX-FileCopyrightText: 2018 Volker Krause <vkrause@kde.org>
 
    SPDX-License-Identifier: MIT
*/
 
#include "code128barcode_p.h"
 
#include "barcodeutil_p.h"
#include "bitvector_p.h"
#include "prison_debug.h"
 
#include <QImage>
#include <QPainter>
 
using namespace Prison;
 
enum {
    SymbolSize = 11,
    StopPatternSize = 13,
    StopPattern = 108,
    QuietZone = 10,
};
 
enum CodeSet : uint8_t {
    CodeSetA = 0,
    CodeSetB = 1,
    CodeSetC = 2,
    CodeSetUnknown = 3,
};
 
enum CodeSetOp : uint8_t {
    None = 255,
    StartA = 103,
    StartB = 104,
    StartC = 105,
    Shift = 98,
    LatchA = 101,
    LatchB = 100,
    LatchC = 99,
};
 
Code128Barcode::Code128Barcode()
    : AbstractBarcodePrivate(Barcode::OneDimension)
{
}
Code128Barcode::~Code128Barcode() = default;
 
QImage Code128Barcode::paintImage()
{
    const auto bits = encode(BarCodeUtil::asLatin1ByteArray(m_data));
    const auto width = bits.size() + 2 * QuietZone;
 
    QImage img(width, 1, QImage::Format_ARGB32);
    img.fill(m_background);
    QPainter p(&img);
    for (int i = 0; i < bits.size(); ++i) {
        if (bits.at(i)) {
            img.setPixel(QuietZone + i, 0, m_foreground.rgb());
        }
    }
 
    return img;
}
 
// Code 128 symbol table
static const uint16_t code128_symbols[] = {
    0b11011001100, // 0
    0b11001101100,
    0b11001100110,
    0b10010011000,
    0b10010001100,
    0b10001001100,
    0b10011001000,
    0b10011000100,
    0b10001100100,
    0b11001001000,
    0b11001000100, // 10
    0b11000100100,
    0b10110011100,
    0b10011011100,
    0b10011001110,
    0b10111001100,
    0b10011101100,
    0b10011100110,
    0b11001110010,
    0b11001011100,
    0b11001001110, // 20
    0b11011100100,
    0b11001110100,
    0b11101101110,
    0b11101001100,
    0b11100101100,
    0b11100100110,
    0b11101100100,
    0b11100110100,
    0b11100110010,
    0b11011011000, // 30
    0b11011000110,
    0b11000110110,
    0b10100011000,
    0b10001011000,
    0b10001000110,
    0b10110001000,
    0b10001101000,
    0b10001100010,
    0b11010001000,
    0b11000101000, // 40
    0b11000100010,
    0b10110111000,
    0b10110001110,
    0b10001101110,
    0b10111011000,
    0b10111000110,
    0b10001110110,
    0b11101110110,
    0b11010001110,
    0b11000101110, // 50
    0b11011101000,
    0b11011100010,
    0b11011101110,
    0b11101011000,
    0b11101000110,
    0b11100010110,
    0b11101101000,
    0b11101100010,
    0b11100011010,
    0b11101111010, // 60
    0b11001000010,
    0b11110001010,
    0b10100110000,
    0b10100001100,
    0b10010110000,
    0b10010000110,
    0b10000101100,
    0b10000100110,
    0b10110010000,
    0b10110000100, // 70
    0b10011010000,
    0b10011000010,
    0b10000110100,
    0b10000110010,
    0b11000010010,
    0b11001010000,
    0b11110111010,
    0b11000010100,
    0b10001111010,
    0b10100111100, // 80
    0b10010111100,
    0b10010011110,
    0b10111100100,
    0b10011110100,
    0b10011110010,
    0b11110100100,
    0b11110010100,
    0b11110010010,
    0b11011011110,
    0b11011110110, // 90
    0b11110110110,
    0b10101111000,
    0b10100011110,
    0b10001011110,
    0b10111101000,
    0b10111100010,
    0b11110101000,
    0b11110100010,
    0b10111011110,
    0b10111101110, // 100
    0b11101011110,
    0b11110101110,
    0b11010000100,
    0b11010010000,
    0b11010011100,
    0b11000111010,
    0b11010111000,
    0b1100011101011,
};
 
static uint8_t symbolForCharacter(const QByteArray &data, int index, CodeSet set)
{
    const auto c1 = data.at(index);
    switch (set) {
    case CodeSetA:
        return (c1 < ' ') ? c1 + 64 : c1 - ' ';
    case CodeSetB:
        return c1 - ' ';
    case CodeSetC: {
        const auto c2 = data.at(index + 1);
        return ((c1 - '0') * 10) + c2 - '0';
    }
    case CodeSetUnknown:
        Q_UNREACHABLE();
    }
 
    Q_UNREACHABLE();
    return {};
}
 
struct CodeSetChange {
    CodeSet set;
    CodeSetOp symbol;
};
 
static bool isInCodeSetA(char c)
{
    return c <= 95;
}
 
static bool isInCodeSetB(char c)
{
    // ### this does not consider FNC4 high byte encoding
    return c >= 32;
}
 
static CodeSetChange opForData(const QByteArray &data, int index, CodeSet currentSet)
{
    // determine if Code C makes sense at this point
    int codeC = 0;
    for (int i = index; i < data.size(); ++i, ++codeC) {
        if (data.at(i) < '0' || data.at(i) > '9') {
            break;
        }
    }
    if (currentSet == CodeSetC && codeC >= 2) { // already in C
        return {CodeSetC, None};
    }
    if (codeC >= 6 // that's always good enough
        || (index == 0 && codeC >= 4) // beginning of data
        || (index + codeC == data.size() && codeC >= 4) // end of data
        || (codeC == data.size() && codeC == 2) // 2 ...
        || (codeC == data.size() && codeC == 4)) // ... or 4 as the entire data
    {
        return currentSet == CodeSetUnknown ? CodeSetChange{CodeSetC, StartC} : CodeSetChange{CodeSetC, LatchC};
    }
 
    // if we are in Code A or Code B, check if we need to switch for the next char
    // this is a shortcut to prevent the below more extensive search from making this O(n²) in the common case
    if ((currentSet == CodeSetA && isInCodeSetA(data.at(index))) || (currentSet == CodeSetB && isInCodeSetB(data.at(index)))) {
        return {currentSet, None};
    }
 
    // we need to switch to A or B, select which one, and select whether to use start, shift or latch
    const auto nextA = isInCodeSetA(data.at(index));
    const auto nextB = isInCodeSetB(data.at(index));
 
    // count how many following characters we could encode in A or B
    int countA = 0;
    for (int i = index + 1; i < data.size(); ++i, ++countA) {
        if (!isInCodeSetA(data.at(i))) {
            break;
        }
    }
    int countB = 0;
    for (int i = index + 1; i < data.size(); ++i, ++countB) {
        if (!isInCodeSetB(data.at(i))) {
            break;
        }
    }
 
    // select how we want to switch to Code A or Code B, biased to B as that's the more useful one in general
    switch (currentSet) {
    case CodeSetUnknown:
        // if we are at the start, take whichever code will get us further, or the only one that works
        if (nextA && nextB) {
            return countA > countB ? CodeSetChange{CodeSetA, StartA} : CodeSetChange{CodeSetB, StartB};
        }
        return nextA ? CodeSetChange{CodeSetA, StartA} : CodeSetChange{CodeSetB, StartB};
    case CodeSetC:
        // same for Code C
        if (nextA && nextB) {
            return countA > countB ? CodeSetChange{CodeSetA, LatchA} : CodeSetChange{CodeSetB, LatchB};
        }
        return nextA ? CodeSetChange{CodeSetA, LatchA} : CodeSetChange{CodeSetB, LatchB};
    case CodeSetA:
        // switch or latch to B?
        return CodeSetChange{CodeSetB, countB >= countA ? LatchB : Shift};
    case CodeSetB:
        // switch or latch to A?
        return CodeSetChange{CodeSetA, countA > countB ? LatchA : Shift};
    }
 
    Q_UNREACHABLE();
    return CodeSetChange{currentSet, None};
}
 
BitVector Code128Barcode::encode(const QByteArray &data) const
{
    BitVector v;
    if (data.isEmpty()) {
        return v;
    }
 
    // determine code set for start
    const auto op = opForData(data, 0, CodeSetUnknown);
    auto currentSet = op.set;
 
    // write start code
    qCDebug(Log) << "start symbol:" << op.symbol << code128_symbols[op.symbol];
    v.appendMSB(code128_symbols[op.symbol], SymbolSize);
 
    uint32_t checksum = op.symbol;
    uint32_t checksumWeight = 1;
 
    for (int i = 0; i < data.size(); i += currentSet == CodeSetC ? 2 : 1) {
        if (static_cast<uint8_t>(data.at(i)) > 127) { // FNC4 encoding not implemented yet
            continue;
        }
 
        // perform code switch if needed
        const auto op = opForData(data, i, currentSet);
        if (op.symbol != None) {
            qCDebug(Log) << "op symbol:" << op.symbol << code128_symbols[op.symbol];
            v.appendMSB(code128_symbols[op.symbol], SymbolSize);
            checksum += op.symbol * checksumWeight++;
        }
 
        // encode current symbol
        const auto symbol = symbolForCharacter(data, i, op.set);
        qCDebug(Log) << "data symbol:" << symbol << code128_symbols[symbol];
        v.appendMSB(code128_symbols[symbol], SymbolSize);
        checksum += symbol * checksumWeight++;
 
        // update current code set
        if (op.symbol != Shift) {
            currentSet = op.set;
        }
    }
 
    // encode checksum
    qCDebug(Log) << "checksum:" << checksum << code128_symbols[checksum % 103];
    v.appendMSB(code128_symbols[checksum % 103], SymbolSize);
 
    // add stop pattern
    v.appendMSB(code128_symbols[StopPattern], StopPatternSize);
    return v;
}