2 * qrencode - QR Code encoder
4 * QR Code specification in convenient format.
5 * Copyright (C) 2006, 2007, 2008, 2009 Kentaro Fukuchi <fukuchi@megaui.net>
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.
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.
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
27 /******************************************************************************
28 * Version and capacity
29 *****************************************************************************/
32 * Maximum version (size) of QR-code symbol.
34 #define QRSPEC_VERSION_MAX 40
37 * Maximum width of a symbol
39 #define QRSPEC_WIDTH_MAX 177
42 * Return maximum data code length (bytes) for the version.
45 * @return maximum size (bytes)
47 extern int QRspec_getDataLength(int version, QRecLevel level);
50 * Return maximum error correction code length (bytes) for the version.
53 * @return ECC size (bytes)
55 extern int QRspec_getECCLength(int version, QRecLevel level);
58 * Return a version number that satisfies the input code length.
59 * @param size input code length (byte)
61 * @return version number
63 extern int QRspec_getMinimumVersion(int size, QRecLevel level);
66 * Return the width of the symbol for the version.
70 extern int QRspec_getWidth(int version);
73 * Return the numer of remainder bits.
75 * @return number of remainder bits
77 extern int QRspec_getRemainder(int version);
79 /******************************************************************************
81 *****************************************************************************/
84 * Return the size of lenght indicator for the mode and version.
87 * @return the size of the appropriate length indicator (bits).
89 extern int QRspec_lengthIndicator(QRencodeMode mode, int version);
92 * Return the maximum length for the mode and version.
95 * @return the maximum length (bytes)
97 extern int QRspec_maximumWords(QRencodeMode mode, int version);
99 /******************************************************************************
100 * Error correction code
101 *****************************************************************************/
104 * Return an array of ECC specification.
107 * @param spec an array of ECC specification contains as following:
108 * {# of type1 blocks, # of data code, # of ecc code,
109 * # of type2 blocks, # of data code}
111 void QRspec_getEccSpec(int version, QRecLevel level, int spec[5]);
113 #define QRspec_rsBlockNum(__spec__) (__spec__[0] + __spec__[3])
114 #define QRspec_rsBlockNum1(__spec__) (__spec__[0])
115 #define QRspec_rsDataCodes1(__spec__) (__spec__[1])
116 #define QRspec_rsEccCodes1(__spec__) (__spec__[2])
117 #define QRspec_rsBlockNum2(__spec__) (__spec__[3])
118 #define QRspec_rsDataCodes2(__spec__) (__spec__[4])
119 #define QRspec_rsEccCodes2(__spec__) (__spec__[2])
121 #define QRspec_rsDataLength(__spec__) \
122 ((QRspec_rsBlockNum1(__spec__) * QRspec_rsDataCodes1(__spec__)) + \
123 (QRspec_rsBlockNum2(__spec__) * QRspec_rsDataCodes2(__spec__)))
124 #define QRspec_rsEccLength(__spec__) \
125 (QRspec_rsBlockNum(__spec__) * QRspec_rsEccCodes1(__spec__))
127 /******************************************************************************
128 * Version information pattern
129 *****************************************************************************/
132 * Return BCH encoded version information pattern that is used for the symbol
133 * of version 7 or greater. Use lower 18 bits.
135 * @return BCH encoded version information pattern
137 extern unsigned int QRspec_getVersionPattern(int version);
139 /******************************************************************************
141 *****************************************************************************/
144 * Return BCH encoded format information pattern.
147 * @return BCH encoded format information pattern
149 extern unsigned int QRspec_getFormatInfo(int mask, QRecLevel level);
151 /******************************************************************************
153 *****************************************************************************/
156 * Return a copy of initialized frame.
157 * When the same version is requested twice or more, a copy of cached frame
159 * WARNING: Thread unsafe!!!
161 * @return Array of unsigned char. You can free it by free().
163 extern unsigned char *QRspec_newFrame(int version);
166 * Clear the frame cache. Typically for debug.
167 * WARNING: Thread unsafe!!!
169 extern void QRspec_clearCache(void);
171 #endif /* __QRSPEC_H__ */