qrencode  4.1.1
About: libqrencode is a fast and compact library and command-line utility for encoding data in a QR Code symbol.
  Fossies Dox: qrencode-4.1.1.tar.bz2  ("unofficial" and yet experimental doxygen-generated source code documentation)  

qrspec.h
Go to the documentation of this file.
1/*
2 * qrencode - QR Code encoder
3 *
4 * QR Code specification in convenient format.
5 * Copyright (C) 2006-2017 Kentaro Fukuchi <kentaro@fukuchi.org>
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22#ifndef QRSPEC_H
23#define QRSPEC_H
24
25#include "qrencode.h"
26
27/******************************************************************************
28 * Version and capacity
29 *****************************************************************************/
30
31/**
32 * Maximum width of a symbol
33 */
34#define QRSPEC_WIDTH_MAX 177
35
36/**
37 * Return maximum data code length (bytes) for the version.
38 * @param version version of the symbol
39 * @param level error correction level
40 * @return maximum size (bytes)
41 */
43
44/**
45 * Return maximum error correction code length (bytes) for the version.
46 * @param version version of the symbol
47 * @param level error correction level
48 * @return ECC size (bytes)
49 */
51
52/**
53 * Return a version number that satisfies the input code length.
54 * @param size input code length (byte)
55 * @param level error correction level
56 * @return version number
57 */
59
60/**
61 * Return the width of the symbol for the version.
62 * @param version vesion of the symbol
63 * @return width of the symbol
64 */
65extern int QRspec_getWidth(int version);
66
67/**
68 * Return the numer of remainder bits.
69 * @param version vesion of the symbol
70 * @return number of remainder bits
71 */
72extern int QRspec_getRemainder(int version);
73
74/******************************************************************************
75 * Length indicator
76 *****************************************************************************/
77
78/**
79 * Return the size of length indicator for the mode and version.
80 * @param mode encode mode
81 * @param version vesion of the symbol
82 * @return the size of the appropriate length indicator (bits).
83 */
84extern int QRspec_lengthIndicator(QRencodeMode mode, int version);
85
86/**
87 * Return the maximum length for the mode and version.
88 * @param mode encode mode
89 * @param version vesion of the symbol
90 * @return the maximum length (bytes)
91 */
92extern int QRspec_maximumWords(QRencodeMode mode, int version);
93
94/******************************************************************************
95 * Error correction code
96 *****************************************************************************/
97
98/**
99 * Return an array of ECC specification.
100 * @param version version of the symbol
101 * @param level error correction level
102 * @param spec an array of ECC specification contains as following:
103 * {# of type1 blocks, # of data code, # of ecc code,
104 * # of type2 blocks, # of data code}
105 */
106void QRspec_getEccSpec(int version, QRecLevel level, int spec[5]);
107
108#define QRspec_rsBlockNum(__spec__) (__spec__[0] + __spec__[3])
109#define QRspec_rsBlockNum1(__spec__) (__spec__[0])
110#define QRspec_rsDataCodes1(__spec__) (__spec__[1])
111#define QRspec_rsEccCodes1(__spec__) (__spec__[2])
112#define QRspec_rsBlockNum2(__spec__) (__spec__[3])
113#define QRspec_rsDataCodes2(__spec__) (__spec__[4])
114#define QRspec_rsEccCodes2(__spec__) (__spec__[2])
115
116#define QRspec_rsDataLength(__spec__) \
117 ((QRspec_rsBlockNum1(__spec__) * QRspec_rsDataCodes1(__spec__)) + \
118 (QRspec_rsBlockNum2(__spec__) * QRspec_rsDataCodes2(__spec__)))
119#define QRspec_rsEccLength(__spec__) \
120 (QRspec_rsBlockNum(__spec__) * QRspec_rsEccCodes1(__spec__))
121
122/******************************************************************************
123 * Version information pattern
124 *****************************************************************************/
125
126/**
127 * Return BCH encoded version information pattern that is used for the symbol
128 * of version 7 or greater. Use lower 18 bits.
129 * @param version version of the symbol
130 * @return BCH encoded version information pattern
131 */
132extern unsigned int QRspec_getVersionPattern(int version);
133
134/******************************************************************************
135 * Format information
136 *****************************************************************************/
137
138/**
139 * Return BCH encoded format information pattern.
140 * @param mask mask number
141 * @param level error correction level
142 * @return BCH encoded format information pattern
143 */
144extern unsigned int QRspec_getFormatInfo(int mask, QRecLevel level);
145
146/******************************************************************************
147 * Frame
148 *****************************************************************************/
149
150/**
151 * Return a copy of initialized frame.
152 * @param version version of the symbol
153 * @return Array of unsigned char. You can free it by free().
154 */
155extern unsigned char *QRspec_newFrame(int version);
156
157/******************************************************************************
158 * Mode indicator
159 *****************************************************************************/
160
161/**
162 * Mode indicator. See Table 2 of JIS X0510:2004, pp.16.
163 */
164#define QRSPEC_MODEID_ECI 7
165#define QRSPEC_MODEID_NUM 1
166#define QRSPEC_MODEID_AN 2
167#define QRSPEC_MODEID_8 4
168#define QRSPEC_MODEID_KANJI 8
169#define QRSPEC_MODEID_FNC1FIRST 5
170#define QRSPEC_MODEID_FNC1SECOND 9
171#define QRSPEC_MODEID_STRUCTURE 3
172#define QRSPEC_MODEID_TERMINATOR 0
173
174#endif /* QRSPEC_H */
static int size
Definition: qrenc.c:41
static QRecLevel level
Definition: qrenc.c:50
static int version
Definition: qrenc.c:40
QRecLevel
Level of error correction.
Definition: qrencode.h:124
QRencodeMode
Encoding mode.
Definition: qrencode.h:109
int QRspec_getRemainder(int version)
Return the numer of remainder bits.
Definition: qrspec.c:126
unsigned char * QRspec_newFrame(int version)
Frame.
Definition: qrspec.c:509
int QRspec_getMinimumVersion(int size, QRecLevel level)
Return a version number that satisfies the input code length.
Definition: qrspec.c:108
int QRspec_getWidth(int version)
Return the width of the symbol for the version.
Definition: qrspec.c:121
unsigned int QRspec_getVersionPattern(int version)
Version information pattern.
Definition: qrspec.c:364
int QRspec_getECCLength(int version, QRecLevel level)
Return maximum error correction code length (bytes) for the version.
Definition: qrspec.c:103
int QRspec_maximumWords(QRencodeMode mode, int version)
Return the maximum length for the mode and version.
Definition: qrspec.c:158
unsigned int QRspec_getFormatInfo(int mask, QRecLevel level)
Format information.
Definition: qrspec.c:383
int QRspec_lengthIndicator(QRencodeMode mode, int version)
Length indicator.
Definition: qrspec.c:142
void QRspec_getEccSpec(int version, QRecLevel level, int spec[5])
Error correction code.
Definition: qrspec.c:234
int QRspec_getDataLength(int version, QRecLevel level)
Return maximum data code length (bytes) for the version.
Definition: qrspec.c:98