soleilpqd/qrmatrix.cpp

QR Code encoder

QRMatrix

This is a library to encode binary string data into QR Code, following the ISO 18004. It supports all 4 encoding modes (Numeric, AlphaNumeric, Kanji, Byte); other QR features: ECI protocol, MicroQR, Structured Append, FNC1.

This lib is made in C++, not required any 3rd library.

It's a bit low level. It does not include text processing or drawing features. It takes your binary string data as input, encodes them into a 2D bytes array representing the QR Code symbol. You may have to implement a small drawing process to turn it into an image (please check the examples).

Usage

Source code

For a quick starting, you import the folder QRMatrix into your project.

Create QR code

You only need to include one header file:

#include "QRMatrix/qrmatrixencoder.h"

Let's assume we have an UTF-8 C string as input, we will create a QR code with mode Byte and Error Correction level High:

const char* inputText = "some text in UTF-8"; // length = 18 bytes
// Create a data segment
QRMatrixSegment segment(EncodingMode::byte, (const UnsignedByte*)inputText, 18);
QRMatrixSegment segments[] = {segment1};
try {
    // Create QR code
    QRMatrixBoard board = QRMatrixEncoder::encode(segments, 1, ErrorCorrectionLevel::high);
    // Drawing QR code
    for (unsigned int row = 0; row < board.dimension(); row += 1) {
        for (unsigned int column = 0; column < board.dimension(); column += 1) {
            UnsignedByte cell = data[row][column];
            UnsignedByte low = cell & BoardCell::lowMask;
            if (low == BoardCell::set) {
                // This is a QR black module
            }
        }
    }
} catch (QRMatrixException error) {
    // Fail to create QR code
}

For more detail please check Detail Manual.

You can find some examples project inside folder Examples. The description about those examples is here. Available examples: SVG, PNG, QT, iOS, MacOS, Android.

Reference

These are documents I used to make this library:

• Thonky QR Code Tutorial.
• Wikipedia.
• Reed-Solomon Error Correction.
• ISO 18004 2000 (Version 1).
• ISO 18004 2006 (Version 2) ~ TCVN 7322:2009.
• ISO 18004 2015 (Version 3).

License

MIT.

QRMatrix - QR pixels presentation. Copyright © 2023 duongpq/soleilpqd.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can check in LICENSE file or on each source code header.