• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1QR Code generator library - C
2=============================
3
4
5Introduction
6------------
7
8This project aims to be the best, clearest QR Code generator library. The primary goals are flexible options and absolute correctness. Secondary goals are compact implementation size and good documentation comments.
9
10Home page with live JavaScript demo, extensive descriptions, and competitor comparisons: https://www.nayuki.io/page/qr-code-generator-library
11
12
13Features
14--------
15
16Core features:
17
18* Significantly shorter code but more documentation comments compared to competing libraries
19* Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard
20* Output format: Raw modules/pixels of the QR symbol
21* Detects finder-like penalty patterns more accurately than other implementations
22* Encodes numeric and special-alphanumeric text in less space than general text
23* Completely avoids heap allocation (`malloc()`), instead relying on suitably sized buffers from the caller and fixed-size stack allocations
24* Coded carefully to prevent memory corruption, integer overflow, platform-dependent inconsistencies, and undefined behavior; tested rigorously to confirm safety
25* Open-source code under the permissive MIT License
26
27Manual parameters:
28
29* User can specify minimum and maximum version numbers allowed, then library will automatically choose smallest version in the range that fits the data
30* User can specify mask pattern manually, otherwise library will automatically evaluate all 8 masks and select the optimal one
31* User can specify absolute error correction level, or allow the library to boost it if it doesn't increase the version number
32* User can create a list of data segments manually and add ECI segments
33
34More information about QR Code technology and this library's design can be found on the project home page.
35
36
37Examples
38--------
39
40```c
41#include <stdbool.h>
42#include <stdint.h>
43#include "qrcodegen.h"
44
45// Text data
46uint8_t qr0[qrcodegen_BUFFER_LEN_MAX];
47uint8_t tempBuffer[qrcodegen_BUFFER_LEN_MAX];
48bool ok = qrcodegen_encodeText("Hello, world!",
49    tempBuffer, qr0, qrcodegen_Ecc_MEDIUM,
50    qrcodegen_VERSION_MIN, qrcodegen_VERSION_MAX,
51    qrcodegen_Mask_AUTO, true);
52if (!ok)
53    return;
54
55int size = qrcodegen_getSize(qr0);
56for (int y = 0; y < size; y++) {
57    for (int x = 0; x < size; x++) {
58        (... paint qrcodegen_getModule(qr0, x, y) ...)
59    }
60}
61
62// Binary data
63uint8_t dataAndTemp[qrcodegen_BUFFER_LEN_FOR_VERSION(7)]
64    = {0xE3, 0x81, 0x82};
65uint8_t qr1[qrcodegen_BUFFER_LEN_FOR_VERSION(7)];
66ok = qrcodegen_encodeBinary(dataAndTemp, 3, qr1,
67    qrcodegen_Ecc_HIGH, 2, 7, qrcodegen_Mask_4, false);
68```
69
70More complete set of examples: https://github.com/nayuki/QR-Code-generator/blob/master/c/qrcodegen-demo.c .
71