Source for file qrcode.php
Documentation is available at qrcode.php
//============================================================+
// File name : qrcode.php
// Last Update : 2010-08-30
// Author : Nicola Asuni - Tecnick.com S.r.l - Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
// Copyright (C) 2010-2010 Nicola Asuni - Tecnick.com S.r.l.
// This file is part of TCPDF software library.
// TCPDF is free software: you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
// TCPDF is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
// You should have received a copy of the GNU Lesser General Public License
// along with TCPDF. If not, see <http://www.gnu.org/licenses/>.
// See LICENSE.TXT file for more information.
// -------------------------------------------------------------------
// Class to create QR-code arrays for TCPDF class.
// QR Code symbol is a 2D barcode that can be scanned by
// handy terminals such as a mobile phone with CCD.
// The capacity of QR Code is up to 7000 digits or 4000
// characters, and has high robustness.
// This class supports QR Code model 2, described in
// JIS (Japanese Industrial Standards) X0510:2004
// Currently the following features are not supported:
// ECI and FNC1 mode, Micro QR Code, QR Code model 1,
// This class is derived from the following projects:
// ---------------------------------------------------------
// Copyright (C) 2010 by Dominik Dzienia <deltalab at poczta dot fm>
// http://phpqrcode.sourceforge.net/
// https://sourceforge.net/projects/phpqrcode/
// The "PHP QR Code encoder" is based on
// "C libqrencode library" (ver. 3.1.1)
// Copyright (C) 2006-2010 by Kentaro Fukuchi
// http://megaui.net/fukuchi/works/qrencode/index.en.html
// Reed-Solomon code encoder is written by Phil Karn, KA9Q.
// Copyright (C) 2002-2006 Phil Karn, KA9Q
// QR Code is registered trademark of DENSO WAVE INCORPORATED
// http://www.denso-wave.com/qrcode/index-e.html
// ---------------------------------------------------------
//============================================================+
* Class to create QR-code arrays for TCPDF class.
* QR Code symbol is a 2D barcode that can be scanned by handy terminals such as a mobile phone with CCD.
* The capacity of QR Code is up to 7000 digits or 4000 characters, and has high robustness.
* This class supports QR Code model 2, described in JIS (Japanese Industrial Standards) X0510:2004 or ISO/IEC 18004.
* Currently the following features are not supported: ECI and FNC1 mode, Micro QR Code, QR Code model 1, Structured mode.
* This class is derived from "PHP QR Code encoder" by Dominik Dzienia (http://phpqrcode.sourceforge.net/) based on "libqrencode C library 3.1.1." by Kentaro Fukuchi (http://megaui.net/fukuchi/works/qrencode/index.en.html), contains Reed-Solomon code written by Phil Karn, KA9Q. QR Code is registered trademark of DENSO WAVE INCORPORATED (http://www.denso-wave.com/qrcode/index-e.html).
* Please read comments on this class source file for full copyright and license information.
* @package com.tecnick.tcpdf
* @abstract Class for generating QR-code array for TCPDF.
* @copyright 2010-2010 Nicola Asuni - Tecnick.com S.r.l (www.tecnick.com) Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
* @link http://www.tcpdf.org
* @license http://www.gnu.org/copyleft/lesser.html LGPL
* Indicate that definitions for this class are set
// -----------------------------------------------------
// Encoding modes (characters which can be encoded in QRcode)
* Encoding mode numeric (0-9). 3 characters are encoded to 10bit length. In theory, 7089 characters or less can be stored in a QRcode.
* Encoding mode alphanumeric (0-9A-Z $%*+-./:) 45characters. 2 characters are encoded to 11bit length. In theory, 4296 characters or less can be stored in a QRcode.
* Encoding mode 8bit byte data. In theory, 2953 characters or less can be stored in a QRcode.
* Encoding mode KANJI. A KANJI character (multibyte character) is encoded to 13bit length. In theory, 1817 characters or less can be stored in a QRcode.
* Encoding mode STRUCTURED (currently unsupported)
// -----------------------------------------------------
// Levels of error correction.
// QRcode has a function of an error correcting for miss reading that white is black.
// Error correcting is defined in 4 level as below.
* Error correction level L : About 7% or less errors can be corrected.
* Error correction level M : About 15% or less errors can be corrected.
* Error correction level Q : About 25% or less errors can be corrected.
* Error correction level H : About 30% or less errors can be corrected.
// -----------------------------------------------------
// Version. Size of QRcode is defined as version.
// Version is from 1 to 40.
// Version 1 is 21*21 matrix. And 4 modules increases whenever 1 version increases.
// So version 40 is 177*177 matrix.
* Maximum QR Code version.
define('QRSPEC_VERSION_MAX', 40);
* Maximum matrix size for maximum version (version 40 is 177*177 matrix).
define('QRSPEC_WIDTH_MAX', 177);
// -----------------------------------------------------
* Matrix index to get width from $capacity array.
* Matrix index to get number of words from $capacity array.
* Matrix index to get remainder from $capacity array.
* Matrix index to get error correction level from $capacity array.
// -----------------------------------------------------
// Structure (currently usupported)
* Number of header bits for structured mode
define('STRUCTURE_HEADER_BITS', 20);
* Max number of symbols for structured mode
define('MAX_STRUCTURED_SYMBOLS', 16);
// -----------------------------------------------------
* Down point base value for case 1 mask pattern (concatenation of same color in a line or a column)
* Down point base value for case 2 mask pattern (module block of same color)
* Down point base value for case 3 mask pattern (1:1:3:1:1(dark:bright:dark:bright:dark)pattern in a line or a column)
* Down point base value for case 4 mask pattern (ration of dark modules in whole)
// -----------------------------------------------------
* if true, estimates best mask (spec. default, but extremally slow; set to false to significant performance boost but (propably) worst quality code
define('QR_FIND_BEST_MASK', true);
* if false, checks all masks available, otherwise value tells count of masks need to be checked, mask id are got randomly
define('QR_FIND_FROM_RANDOM', 2);
* when QR_FIND_BEST_MASK === false
// -----------------------------------------------------
// #*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#
// for compatibility with PHP4
* Convert a string to an array (needed for PHP4 compatibility)
* @param string $string The input string.
* @param int $split_length Maximum length of the chunk.
* @return If the optional split_length parameter is specified, the returned array will be broken down into chunks with each being split_length in length, otherwise each chunk will be one character in length. FALSE is returned if split_length is less than 1. If the split_length length exceeds the length of string , the entire string is returned as the first (and only) array element.
function str_split($string, $split_length= 1) {
if ((strlen($string) > $split_length) OR (!$split_length)) {
$parts[] = substr($string, 0, $split_length);
$string = substr($string, $split_length);
} while ($string !== false);
// #####################################################
* Class to create QR-code arrays for TCPDF class.
* QR Code symbol is a 2D barcode that can be scanned by handy terminals such as a mobile phone with CCD.
* The capacity of QR Code is up to 7000 digits or 4000 characters, and has high robustness.
* This class supports QR Code model 2, described in JIS (Japanese Industrial Standards) X0510:2004 or ISO/IEC 18004.
* Currently the following features are not supported: ECI and FNC1 mode, Micro QR Code, QR Code model 1, Structured mode.
* This class is derived from "PHP QR Code encoder" by Dominik Dzienia (http://phpqrcode.sourceforge.net/) based on "libqrencode C library 3.1.1." by Kentaro Fukuchi (http://megaui.net/fukuchi/works/qrencode/index.en.html), contains Reed-Solomon code written by Phil Karn, KA9Q. QR Code is registered trademark of DENSO WAVE INCORPORATED (http://www.denso-wave.com/qrcode/index-e.html).
* Please read comments on this class source file for full copyright and license information.
* @package com.tecnick.tcpdf
* @abstract Class for generating QR-code array for TCPDF.
* @copyright 2010-2010 Nicola Asuni - Tecnick.com S.r.l (www.tecnick.com) Via Della Pace, 11 - 09044 - Quartucciu (CA) - ITALY - www.tecnick.com - info@tecnick.com
* @link http://www.tcpdf.org
* @license http://www.gnu.org/copyleft/lesser.html LGPL
* @var barcode array to be returned which is readable by TCPDF
* @var QR code version. Size of QRcode is defined as version. Version is from 1 to 40. Version 1 is 21*21 matrix. And 4 modules increases whenever 1 version increases. So version 40 is 177*177 matrix.
* @var Levels of error correction. See definitions for possible values.
protected $level = QR_ECLEVEL_L;
protected $hint = QR_MODE_8B;
* @var if true the input string will be converted to uppercase
* @var structured QR code (not supported yet)
* @var error correction code
* @var Reed-Solomon blocks
* @var error correction length
* @var Reed-Solomon items
* @var alphabet-numeric convesion table
- 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, //
- 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, //
36, - 1, - 1, - 1, 37, 38, - 1, - 1, - 1, - 1, 39, 40, - 1, 41, 42, 43, //
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 44, - 1, - 1, - 1, - 1, - 1, //
- 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, //
25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, - 1, - 1, - 1, - 1, - 1, //
- 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, //
- 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1, - 1 //
* @var array Table of the capacity of symbols
* See Table 1 (pp.13) and Table 12-16 (pp.30-36), JIS X0510:2004.
array( 0, 0, 0, array( 0, 0, 0, 0)), //
array( 21, 26, 0, array( 7, 10, 13, 17)), // 1
array( 25, 44, 7, array( 10, 16, 22, 28)), //
array( 29, 70, 7, array( 15, 26, 36, 44)), //
array( 33, 100, 7, array( 20, 36, 52, 64)), //
array( 37, 134, 7, array( 26, 48, 72, 88)), // 5
array( 41, 172, 7, array( 36, 64, 96, 112)), //
array( 45, 196, 0, array( 40, 72, 108, 130)), //
array( 49, 242, 0, array( 48, 88, 132, 156)), //
array( 53, 292, 0, array( 60, 110, 160, 192)), //
array( 57, 346, 0, array( 72, 130, 192, 224)), // 10
array( 61, 404, 0, array( 80, 150, 224, 264)), //
array( 65, 466, 0, array( 96, 176, 260, 308)), //
array( 69, 532, 0, array( 104, 198, 288, 352)), //
array( 73, 581, 3, array( 120, 216, 320, 384)), //
array( 77, 655, 3, array( 132, 240, 360, 432)), // 15
array( 81, 733, 3, array( 144, 280, 408, 480)), //
array( 85, 815, 3, array( 168, 308, 448, 532)), //
array( 89, 901, 3, array( 180, 338, 504, 588)), //
array( 93, 991, 3, array( 196, 364, 546, 650)), //
array( 97, 1085, 3, array( 224, 416, 600, 700)), // 20
array(101, 1156, 4, array( 224, 442, 644, 750)), //
array(105, 1258, 4, array( 252, 476, 690, 816)), //
array(109, 1364, 4, array( 270, 504, 750, 900)), //
array(113, 1474, 4, array( 300, 560, 810, 960)), //
array(117, 1588, 4, array( 312, 588, 870, 1050)), // 25
array(121, 1706, 4, array( 336, 644, 952, 1110)), //
array(125, 1828, 4, array( 360, 700, 1020, 1200)), //
array(129, 1921, 3, array( 390, 728, 1050, 1260)), //
array(133, 2051, 3, array( 420, 784, 1140, 1350)), //
array(137, 2185, 3, array( 450, 812, 1200, 1440)), // 30
array(141, 2323, 3, array( 480, 868, 1290, 1530)), //
array(145, 2465, 3, array( 510, 924, 1350, 1620)), //
array(149, 2611, 3, array( 540, 980, 1440, 1710)), //
array(153, 2761, 3, array( 570, 1036, 1530, 1800)), //
array(157, 2876, 0, array( 570, 1064, 1590, 1890)), // 35
array(161, 3034, 0, array( 600, 1120, 1680, 1980)), //
array(165, 3196, 0, array( 630, 1204, 1770, 2100)), //
array(169, 3362, 0, array( 660, 1260, 1860, 2220)), //
array(173, 3532, 0, array( 720, 1316, 1950, 2310)), //
array(177, 3706, 0, array( 750, 1372, 2040, 2430)) // 40
* @var array Length indicator
* @var array Table of the error correction code (Reed-Solomon block)
* See Table 12-16 (pp.30-36), JIS X0510:2004.
array(array( 0, 0), array( 0, 0), array( 0, 0), array( 0, 0)), //
array(array( 1, 0), array( 1, 0), array( 1, 0), array( 1, 0)), // 1
array(array( 1, 0), array( 1, 0), array( 1, 0), array( 1, 0)), //
array(array( 1, 0), array( 1, 0), array( 2, 0), array( 2, 0)), //
array(array( 1, 0), array( 2, 0), array( 2, 0), array( 4, 0)), //
array(array( 1, 0), array( 2, 0), array( 2, 2), array( 2, 2)), // 5
array(array( 2, 0), array( 4, 0), array( 4, 0), array( 4, 0)), //
array(array( 2, 0), array( 4, 0), array( 2, 4), array( 4, 1)), //
array(array( 2, 0), array( 2, 2), array( 4, 2), array( 4, 2)), //
array(array( 2, 0), array( 3, 2), array( 4, 4), array( 4, 4)), //
array(array( 2, 2), array( 4, 1), array( 6, 2), array( 6, 2)), // 10
array(array( 4, 0), array( 1, 4), array( 4, 4), array( 3, 8)), //
array(array( 2, 2), array( 6, 2), array( 4, 6), array( 7, 4)), //
array(array( 4, 0), array( 8, 1), array( 8, 4), array(12, 4)), //
array(array( 3, 1), array( 4, 5), array(11, 5), array(11, 5)), //
array(array( 5, 1), array( 5, 5), array( 5, 7), array(11, 7)), // 15
array(array( 5, 1), array( 7, 3), array(15, 2), array( 3, 13)), //
array(array( 1, 5), array(10, 1), array( 1, 15), array( 2, 17)), //
array(array( 5, 1), array( 9, 4), array(17, 1), array( 2, 19)), //
array(array( 3, 4), array( 3, 11), array(17, 4), array( 9, 16)), //
array(array( 3, 5), array( 3, 13), array(15, 5), array(15, 10)), // 20
array(array( 4, 4), array(17, 0), array(17, 6), array(19, 6)), //
array(array( 2, 7), array(17, 0), array( 7, 16), array(34, 0)), //
array(array( 4, 5), array( 4, 14), array(11, 14), array(16, 14)), //
array(array( 6, 4), array( 6, 14), array(11, 16), array(30, 2)), //
array(array( 8, 4), array( 8, 13), array( 7, 22), array(22, 13)), // 25
array(array(10, 2), array(19, 4), array(28, 6), array(33, 4)), //
array(array( 8, 4), array(22, 3), array( 8, 26), array(12, 28)), //
array(array( 3, 10), array( 3, 23), array( 4, 31), array(11, 31)), //
array(array( 7, 7), array(21, 7), array( 1, 37), array(19, 26)), //
array(array( 5, 10), array(19, 10), array(15, 25), array(23, 25)), // 30
array(array(13, 3), array( 2, 29), array(42, 1), array(23, 28)), //
array(array(17, 0), array(10, 23), array(10, 35), array(19, 35)), //
array(array(17, 1), array(14, 21), array(29, 19), array(11, 46)), //
array(array(13, 6), array(14, 23), array(44, 7), array(59, 1)), //
array(array(12, 7), array(12, 26), array(39, 14), array(22, 41)), // 35
array(array( 6, 14), array( 6, 34), array(46, 10), array( 2, 64)), //
array(array(17, 4), array(29, 14), array(49, 10), array(24, 46)), //
array(array( 4, 18), array(13, 32), array(48, 14), array(42, 32)), //
array(array(20, 4), array(40, 7), array(43, 22), array(10, 67)), //
array(array(19, 6), array(18, 31), array(34, 34), array(20, 61)) // 40
* @var array Positions of alignment patterns.
* This array includes only the second and the third position of the alignment patterns. Rest of them can be calculated from the distance between them.
* See Table 1 in Appendix E (pp.71) of JIS X0510:2004.
array( 0, 0), array(18, 0), array(22, 0), array(26, 0), array(30, 0), // 1- 5
array(34, 0), array(22, 38), array(24, 42), array(26, 46), array(28, 50), // 6-10
array(30, 54), array(32, 58), array(34, 62), array(26, 46), array(26, 48), // 11-15
array(26, 50), array(30, 54), array(30, 56), array(30, 58), array(34, 62), // 16-20
array(28, 50), array(26, 50), array(30, 54), array(28, 54), array(32, 58), // 21-25
array(30, 58), array(34, 62), array(26, 50), array(30, 54), array(26, 52), // 26-30
array(30, 56), array(34, 60), array(30, 58), array(34, 62), array(30, 54), // 31-35
array(24, 50), array(28, 54), array(32, 58), array(26, 54), array(30, 58) // 35-40
* @var array Version information pattern (BCH coded).
* See Table 1 in Appendix D (pp.68) of JIS X0510:2004.
* size: [QRSPEC_VERSION_MAX - 6]
0x07c94, 0x085bc, 0x09a99, 0x0a4d3, 0x0bbf6, 0x0c762, 0x0d847, 0x0e60d, //
0x0f928, 0x10b78, 0x1145d, 0x12a17, 0x13532, 0x149a6, 0x15683, 0x168c9, //
0x177ec, 0x18ec4, 0x191e1, 0x1afab, 0x1b08e, 0x1cc1a, 0x1d33f, 0x1ed75, //
0x1f250, 0x209d5, 0x216f0, 0x228ba, 0x2379f, 0x24b0b, 0x2542e, 0x26a64, //
* @var array Format information
array(0x77c4, 0x72f3, 0x7daa, 0x789d, 0x662f, 0x6318, 0x6c41, 0x6976), //
array(0x5412, 0x5125, 0x5e7c, 0x5b4b, 0x45f9, 0x40ce, 0x4f97, 0x4aa0), //
array(0x355f, 0x3068, 0x3f31, 0x3a06, 0x24b4, 0x2183, 0x2eda, 0x2bed), //
array(0x1689, 0x13be, 0x1ce7, 0x19d0, 0x0762, 0x0255, 0x0d0c, 0x083b) //
// -------------------------------------------------
// -------------------------------------------------
* This is the class constructor.
* Creates a QRcode object
* @param string $code code to represent using QRcode
* @param string $eclevel error level: <ul><li>L : About 7% or less errors can be corrected.</li><li>M : About 15% or less errors can be corrected.</li><li>Q : About 25% or less errors can be corrected.</li><li>H : About 30% or less errors can be corrected.</li></ul>
$barcode_array = array();
if ((is_null($code)) OR ($code == '\0') OR ($code == '')) {
// set error correction level
if ($this->level === false) {
$barcode_array['num_rows'] = $size;
$barcode_array['num_cols'] = $size;
$barcode_array['bcode'] = array();
foreach ($qrTab as $line) {
$arrAdd[] = ($char== '1')? 1: 0;
$barcode_array['bcode'][] = $arrAdd;
* Returns a barcode array which is readable by TCPDF
* @return array barcode array readable by TCPDF;
* Convert the frame in binary form
* @param array $frame array to binarize
* @return array frame in binary form
// the frame is square (width = height)
foreach ($frame as &$frameLine) {
for ($i= 0; $i< $len; $i++ ) {
$frameLine[$i] = (ord($frameLine[$i])&1)? '1': '0';
* Encode the input string to QR code
* @param string $string input string to encode
* @param int $mask masking mode
$spec = array(0, 0, 0, 0, 0);
$ret = $this->init($spec);
// inteleaved data and ecc codes
$this->setFrameAt($addr, 0x02 | (($bit & $code) != 0));
for ($i= 0; $i< $j; $i++ ) {
// - - - - - - - - - - - - - - - - - - - - - - - - -
* Set frame value at specified position
* @param array $at x,y position
* @param int $val value of the character to set
$this->frame[$at['y']][$at['x']] = chr($val);
* Get frame value at specified position
* @param array $at x,y position
* @return value at specified position
return ord($this->frame[$at['y']][$at['x']]);
* Return the next frame position
* @return array of x,y coordinates
return array('x'=> $this->x, 'y'=> $this->y);
if (($x < 0) OR ($y < 0)) {
} while(ord($this->frame[$y][$x]) & 0x80);
return array('x'=> $x, 'y'=> $y);
// - - - - - - - - - - - - - - - - - - - - - - - - -
* @param array $spec array of ECC specification
* @return 0 in case of success, -1 in case of error
protected function init($spec) {
$rs = $this->init_rs(8, 0x11d, 0, 1, $el, 255 - $dl - $el);
for ($i= 0; $i < $endfor; ++ $i) {
$this->rsblocks[$blockNo]['dataLength'] = $dl;
$this->rsblocks[$blockNo]['eccLength'] = $el;
$this->rsblocks[$blockNo]['ecc'] = $ecc;
$rs = $this->init_rs(8, 0x11d, 0, 1, $el, 255 - $dl - $el);
for ($i= 0; $i < $endfor; ++ $i) {
$this->rsblocks[$blockNo]['dataLength'] = $dl;
$this->rsblocks[$blockNo]['eccLength'] = $el;
$this->rsblocks[$blockNo]['ecc'] = $ecc;
* Return Reed-Solomon block code.
if ($col >= $this->rsblocks[0]['dataLength']) {
$ret = $this->rsblocks[$row]['data'][$col];
$ret = $this->rsblocks[$row]['ecc'][$col];
// - - - - - - - - - - - - - - - - - - - - - - - - -
* Write Format Information on frame and returns the number of black bits
* @param int $width frame width
* @param array $frame frame
* @param array $mask masking mode
* @param int $level error correction level
$frame[8][$width - 1 - $i] = chr($v);
$frame[$i + 1][8] = chr($v);
$frame[$width - 7 + $i][8] = chr($v);
$frame[8][6 - $i] = chr($v);
* @param int $x X position
* @param int $y Y position
protected function mask0($x, $y) {
* @param int $x X position
* @param int $y Y position
protected function mask1($x, $y) {
* @param int $x X position
* @param int $y Y position
protected function mask2($x, $y) {
* @param int $x X position
* @param int $y Y position
protected function mask3($x, $y) {
* @param int $x X position
* @param int $y Y position
protected function mask4($x, $y) {
return (((int) ($y / 2)) + ((int) ($x / 3))) & 1;
* @param int $x X position
* @param int $y Y position
protected function mask5($x, $y) {
return (($x * $y) & 1) + ($x * $y) % 3;
* @param int $x X position
* @param int $y Y position
protected function mask6($x, $y) {
return ((($x * $y) & 1) + ($x * $y) % 3) & 1;
* @param int $x X position
* @param int $y Y position
protected function mask7($x, $y) {
return ((($x * $y) % 3) + (($x + $y) & 1)) & 1;
* @param int $maskNo mask number
* @param int $width width
* @param array $frame frame
for ($y= 0; $y< $width; ++ $y) {
for ($x= 0; $x< $width; ++ $x) {
if (ord($frame[$y][$x]) & 0x80) {
$bitMask[$y][$x] = ($maskFunc == 0)? 1: 0;
* @param boolean $maskGenOnly
protected function makeMaskNo($maskNo, $width, $s, &$d, $maskGenOnly= false) {
for ($y= 0; $y< $width; ++ $y) {
for ($x= 0; $x< $width; ++ $x) {
if ($bitMask[$y][$x] == 1) {
$d[$y][$x] = chr(ord($s[$y][$x]) ^ (int) $bitMask[$y][$x]);
$b += (int) (ord($d[$y][$x]) & 1);
protected function makeMask($width, $frame, $maskNo, $level) {
$this->makeMaskNo($maskNo, $width, $frame, $masked);
for ($i= 0; $i< $length; ++ $i) {
if (($i >= 3) AND ($i < ($length- 2)) AND ($this->runLength[$i] % 3 == 0)) {
} elseif ((($i+ 3) >= $length) OR ($this->runLength[$i+ 3] >= (4 * $fact))) {
for ($y= 0; $y< $width; ++ $y) {
for ($x= 0; $x< $width; ++ $x) {
if (($x > 0) AND ($y > 0)) {
$b22 = ord($frameY[$x]) & ord($frameY[$x- 1]) & ord($frameYM[$x]) & ord($frameYM[$x- 1]);
$w22 = ord($frameY[$x]) | ord($frameY[$x- 1]) | ord($frameYM[$x]) | ord($frameYM[$x- 1]);
if (($b22 | ($w22 ^ 1)) & 1) {
if (($x == 0) AND (ord($frameY[$x]) & 1)) {
if ((ord($frameY[$x]) ^ ord($frameY[$x- 1])) & 1) {
for ($x= 0; $x< $width; ++ $x) {
for ($y= 0; $y< $width; ++ $y) {
if (($y == 0) AND (ord($frame[$y][$x]) & 1)) {
if ((ord($frame[$y][$x]) ^ ord($frame[$y- 1][$x])) & 1) {
* @return array best mask
protected function mask($width, $frame, $level) {
$minDemerit = PHP_INT_MAX;
$checked_masks = array(0, 1, 2, 3, 4, 5, 6, 7);
for ($i = 0; $i < $howManuOut; ++ $i) {
unset ($checked_masks[$remPos]);
foreach ($checked_masks as $i) {
$blacks = $this->makeMaskNo($i, $width, $frame, $mask);
$blacks = (int) (100 * $blacks / ($width * $width));
$demerit = (int) ((int) (abs($blacks - 50) / 5) * N4);
if ($demerit < $minDemerit) {
// - - - - - - - - - - - - - - - - - - - - - - - - -
* Return true if the character at specified position is a number
* @param string $str string
* @param int $pos characted position
* @return boolean true of false
return ((ord($str[$pos]) >= ord('0'))&& (ord($str[$pos]) <= ord('9')));
* Return true if the character at specified position is an alphanumeric character
* @param string $str string
* @param int $pos characted position
* @return boolean true of false
$word = (ord($c) << 8) | ord($d);
if (($word >= 0x8140 && $word <= 0x9ffc) OR ($word >= 0xe040 && $word <= 0xebbf)) {
protected function eatAn() {
protected function eat8() {
while($p < $dataStrLen) {
$length = $this->eatAn();
while ($p < $stringLen) {
// - - - - - - - - - - - - - - - - - - - - - - - - -
* @return array input item
protected function newInputItem($mode, $size, $data, $bstream= null) {
if (count($setData) < $size) {
if (!$this->check($mode, $size, $setData)) {
$inputitem['mode'] = $mode;
$inputitem['size'] = $size;
$inputitem['data'] = $setData;
$inputitem['bstream'] = $bstream;
* @param array $inputitem
* @return array input item
$words = (int) ($inputitem['size'] / 3);
$inputitem['bstream'] = array();
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, $val);
for ($i= 0; $i < $words; ++ $i) {
$val = (ord($inputitem['data'][$i* 3 ]) - ord('0')) * 100;
$val += (ord($inputitem['data'][$i* 3+ 1]) - ord('0')) * 10;
$val += (ord($inputitem['data'][$i* 3+ 2]) - ord('0'));
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 10, $val);
if ($inputitem['size'] - $words * 3 == 1) {
$val = ord($inputitem['data'][$words* 3]) - ord('0');
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, $val);
} elseif (($inputitem['size'] - ($words * 3)) == 2) {
$val = (ord($inputitem['data'][$words* 3 ]) - ord('0')) * 10;
$val += (ord($inputitem['data'][$words* 3+ 1]) - ord('0'));
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 7, $val);
* @param array $inputitem
* @return array input item
$words = (int) ($inputitem['size'] / 2);
$inputitem['bstream'] = array();
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x02);
for ($i= 0; $i < $words; ++ $i) {
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 11, $val);
if ($inputitem['size'] & 1) {
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 6, $val);
* @param array $inputitem
* @return array input item
$inputitem['bstream'] = array();
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x4);
for ($i= 0; $i < $inputitem['size']; ++ $i) {
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 8, ord($inputitem['data'][$i]));
* @param array $inputitem
* @return array input item
$inputitem['bstream'] = array();
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x8);
for ($i= 0; $i< $inputitem['size']; $i+= 2) {
$val = (ord($inputitem['data'][$i]) << 8) | ord($inputitem['data'][$i+ 1]);
$val = ($val & 0xff) + $h;
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 13, $val);
* @param array $inputitem
* @return array input item
$inputitem['bstream'] = array();
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, 0x03);
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, ord($inputitem['data'][1]) - 1);
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 4, ord($inputitem['data'][0]) - 1);
$inputitem['bstream'] = $this->appendNum($inputitem['bstream'], 8, ord($inputitem['data'][2]));
* @param array $inputitem
* @return array input item
$inputitem['bstream'] = array();
if ($inputitem['size'] > $words) {
$st1 = $this->newInputItem($inputitem['mode'], $words, $inputitem['data']);
$st2 = $this->newInputItem($inputitem['mode'], $inputitem['size'] - $words, array_slice($inputitem['data'], $words));
$inputitem['bstream'] = array();
$inputitem['bstream'] = $this->appendBitstream($inputitem['bstream'], $st1['bstream']);
$inputitem['bstream'] = $this->appendBitstream($inputitem['bstream'], $st2['bstream']);
switch($inputitem['mode']) {
// - - - - - - - - - - - - - - - - - - - - - - - - -
* Append data to an input object.
* The data is copied and appended to the input object.
* @param array items input items
* @param int $mode encoding mode.
* @param int $size size of data (byte).
* @param array $data array of input data.
* insertStructuredAppendHeader
$buf = array($size, $index, $parity);
foreach ($items as $item) {
for ($i= $item['size']- 1; $i>= 0; -- $i) {
$parity ^= $item['data'][$i];
* @return boolean true or false
for ($i= 0; $i< $size; ++ $i) {
if ((ord($data[$i]) < ord('0')) OR (ord($data[$i]) > ord('9'))){
* @return int number of bits
* Look up the alphabet-numeric convesion table (see JIS X0510:2004, pp.19).
* @param int $c character value
return (($c > 127)?- 1: $this->anTable[$c]);
* @return boolean true or false
for ($i= 0; $i< $size; ++ $i) {
* @return int number of bits
* @return int number of bits
* @return int number of bits
return (int) (($size / 2) * 13);
* @return boolean true or false
for ($i= 0; $i< $size; $i+= 2) {
$val = (ord($data[$i]) << 8) | ord($data[$i+ 1]);
if (($val < 0x8140) OR (($val > 0x9ffc) AND ($val < 0xe040)) OR ($val > 0xebbf)) {
* Validate the input data.
* @param int $mode encoding mode.
* @param int $size size of data (byte).
* @param array data data to validate
* @return boolean true in case of valid data, false otherwise
protected function check($mode, $size, $data) {
foreach ($items as $item) {
$num = (int) (($item['size'] + $m - 1) / $m);
$bits += $num * (4 + $l);
} while ($version > $prev);
$chunks = (int) ($payload / 10);
$remain = $payload - $chunks * 10;
} elseif ($remain >= 4) {
$chunks = (int) ($payload / 11);
$remain = $payload - $chunks * 11;
$size = (int) ($payload / 8);
$size = (int) (($payload / 13) * 2);
$size = (int) ($payload / 8);
* @return array of items and total bits
foreach ($items as $key => $item) {
$bits = count($items[$key]['bstream']);
return array($items, $total);
* Append Padding Bit to bitstream
* @return array bitstream
$maxbits = $maxwords * 8;
if ($maxbits - $bits < 5) {
return $this->appendNum($bstream, $maxbits - $bits, 0);
$words = (int) (($bits + 7) / 8);
$padding = $this->appendNum($padding, $words * 8 - $bits + 4, 0);
$padlen = $maxwords - $words;
for ($i= 0; $i< $padlen; ++ $i) {
$padbuf[$i] = ($i&1)? 0x11: 0xec;
$padding = $this->appendBytes($padding, $padlen, $padbuf);
* @return array bitstream
foreach ($items as $item) {
* Returns a stream of bits.
* @return array padded merged byte stream
* Pack all bit streams padding bits into a byte array.
* @return array padded merged byte stream
// - - - - - - - - - - - - - - - - - - - - - - - - -
* Return an array with zeros
* @param int $setLength array size
protected function allocate($setLength) {
* Return new bitstream from number
* @param int $bits number of bits
* @return array bitstream
$mask = 1 << ($bits - 1);
for ($i= 0; $i< $bits; ++ $i) {
* Return new bitstream from bytes
* @param array $data bytes
* @return array bitstream
for ($i= 0; $i< $size; ++ $i) {
* Append one bitstream to another
* @param array $bitstream original bitstream
* @param array $append bitstream to append
* @return array bitstream
if (count($bitstream) == 0) {
* Append one bitstream created from number to another
* @param array $bitstream original bitstream
* @param int $bits number of bits
* @return array bitstream
protected function appendNum($bitstream, $bits, $num) {
* Append one bitstream created from bytes to another
* @param array $bitstream original bitstream
* @param array $data bytes
* @return array bitstream
protected function appendBytes($bitstream, $size, $data) {
* Convert bitstream to bytes
* @param array $bitstream original bitstream
$bytes = (int) ($size / 8);
for ($i= 0; $i< $bytes; $i++ ) {
for ($j= 0; $j< ($size & 7); $j++ ) {
// - - - - - - - - - - - - - - - - - - - - - - - - -
* Replace a value on the array at the specified position
* @param int $x X position
* @param int $y Y position
* @param string $repl value to replace
* @param int $replLen length of the repl string
protected function qrstrset($srctab, $x, $y, $repl, $replLen= false) {
$srctab[$y] = substr_replace($srctab[$y], ($replLen !== false)? substr($repl,0,$replLen): $repl, $x, ($replLen !== false)? $replLen: strlen($repl));
* Return maximum data code length (bytes) for the version.
* @param int $version version
* @param int $level error correction level
* @return int maximum size (bytes)
* Return maximum error correction code length (bytes) for the version.
* @param int $version version
* @param int $level error correction level
* @return int ECC size (bytes)
* Return the width of the symbol for the version.
* @param int $version version
* Return the numer of remainder bits.
* @param int $version version
* @return int number of remainder bits
* Return a version number that satisfies the input code length.
* @param int $size input code length (byte)
* @param int $level error correction level
* @return int version number
* Return the size of length indicator for the mode and version.
* @param int $mode encoding mode
* @param int $version version
* @return int the size of the appropriate length indicator (bits).
} elseif ($version <= 26) {
* Return the maximum length for the mode and version.
* @param int $mode encoding mode
* @param int $version version
* @return int the maximum length (bytes)
} else if ($version <= 26) {
$words = (1 << $bits) - 1;
$words *= 2; // the number of bytes is required
* Return an array of ECC specification.
* @param int $version version
* @param int $level error correction level
* @param array $spec an array of ECC specification contains as following: {# of type1 blocks, # of data code, # of ecc code, # of type2 blocks, # of data code}
protected function getEccSpec($version, $level, $spec) {
$spec = array(0, 0, 0, 0, 0);
$b1 = $this->eccTable[$version][$level][0];
$b2 = $this->eccTable[$version][$level][1];
$spec[1] = (int) ($data / $b1);
$spec[2] = (int) ($ecc / $b1);
$spec[1] = (int) ($data / ($b1 + $b2));
$spec[2] = (int) ($ecc / ($b1 + $b2));
* Put an alignment marker.
* @param array $frame frame
* @param int $width width
* @param int $ox X center coordinate of the pattern
* @param int $oy Y center coordinate of the pattern
for ($y= 0; $y < 5; $y++ ) {
$frame = $this->qrstrset($frame, $xStart, $yStart+ $y, $finder[$y]);
* Put an alignment pattern.
* @param int $version version
* @param array $fram frame
* @param int $width width
for ($x= 1; $x < $wo; ++ $x) {
for ($y= 0; $y < $wo; ++ $y) {
for ($x= 0; $x < $wo; ++ $x) {
* Return BCH encoded version information pattern that is used for the symbol of version 7 or greater. Use lower 18 bits.
* @param int $version version
* @return BCH encoded version information pattern
* Return BCH encoded format information pattern.
* @param int $level error correction level
* @return BCH encoded format information pattern
if (($mask < 0) OR ($mask > 7)) {
if (($level < 0) OR ($level > 3)) {
* @param array $frame frame
* @param int $width width
* @param int $ox X center coordinate of the pattern
* @param int $oy Y center coordinate of the pattern
"\xc1\xc1\xc1\xc1\xc1\xc1\xc1",
"\xc1\xc0\xc0\xc0\xc0\xc0\xc1",
"\xc1\xc0\xc1\xc1\xc1\xc0\xc1",
"\xc1\xc0\xc1\xc1\xc1\xc0\xc1",
"\xc1\xc0\xc1\xc1\xc1\xc0\xc1",
"\xc1\xc0\xc0\xc0\xc0\xc0\xc1",
"\xc1\xc1\xc1\xc1\xc1\xc1\xc1"
for ($y= 0; $y < 7; $y++ ) {
$frame = $this->qrstrset($frame, $ox, ($oy + $y), $finder[$y]);
* Return a copy of initialized frame.
* @param int $version version
* @return Array of unsigned char.
for ($y= 0; $y < 7; ++ $y) {
$frame[$y][$width - 8] = "\xc0";
$frame[$yOffset][7] = "\xc0";
$frame = $this->qrstrset($frame, 0, 7, $setPattern);
$frame = $this->qrstrset($frame, $width- 8, 7, $setPattern);
$frame = $this->qrstrset($frame, 0, $width - 8, $setPattern);
$frame = $this->qrstrset($frame, 0, 8, $setPattern);
$frame = $this->qrstrset($frame, $width - 8, 8, $setPattern, 8);
for ($y= 0; $y < 8; ++ $y,++ $yOffset) {
$frame[$yOffset][8] = "\x84";
for ($i= 1; $i < $wo; ++ $i) {
$frame[6][7+ $i] = chr(0x90 | ($i & 1));
$frame[7+ $i][6] = chr(0x90 | ($i & 1));
$frame[($width - 11)+ $y][$x] = chr(0x88 | ($v & 1));
$frame[$y][$x+ ($width - 11)] = chr(0x88 | ($v & 1));
$frame[$width - 8][8] = "\x81";
* Set new frame for the specified version.
* @param int $version version
* @return Array of unsigned char.
if (!isset ($this->frames[$version])) {
return $this->frames[$version];
return ($spec[0] + $spec[3]);
return ($spec[0] * $spec[1]) + ($spec[3] * $spec[4]);
return ($spec[0] + $spec[3]) * $spec[2];
// - - - - - - - - - - - - - - - - - - - - - - - - -
* Initialize a Reed-Solomon codec and add it to existing rsitems
* @param int $symsize symbol size, bits
* @param int $gfpoly Field generator polynomial coefficients
* @param int $fcr first root of RS code generator polynomial, index form
* @param int $prim primitive element to generate polynomial roots
* @param int $nroots RS code generator polynomial degree (number of roots)
* @param int $pad padding bytes at front of shortened block
* @return array Array of RS values:<ul><li>mm = Bits per symbol;</li><li>nn = Symbols per block;</li><li>alpha_to = log lookup table array;</li><li>index_of = Antilog lookup table array;</li><li>genpoly = Generator polynomial array;</li><li>nroots = Number of generator;</li><li>roots = number of parity symbols;</li><li>fcr = First consecutive root, index form;</li><li>prim = Primitive element, index form;</li><li>iprim = prim-th root of 1, index form;</li><li>pad = Padding bytes in shortened block;</li><li>gfpoly</ul>.
protected function init_rs($symsize, $gfpoly, $fcr, $prim, $nroots, $pad) {
if (($rs['pad'] != $pad) OR ($rs['nroots'] != $nroots) OR ($rs['mm'] != $symsize)
OR ($rs['gfpoly'] != $gfpoly) OR ($rs['fcr'] != $fcr) OR ($rs['prim'] != $prim)) {
$rs = $this->init_rs_char($symsize, $gfpoly, $fcr, $prim, $nroots, $pad);
// - - - - - - - - - - - - - - - - - - - - - - - - -
* @param int $x X position
protected function modnn($rs, $x) {
while ($x >= $rs['nn']) {
$x = ($x >> $rs['mm']) + ($x & $rs['nn']);
* Initialize a Reed-Solomon codec and returns an array of values.
* @param int $symsize symbol size, bits
* @param int $gfpoly Field generator polynomial coefficients
* @param int $fcr first root of RS code generator polynomial, index form
* @param int $prim primitive element to generate polynomial roots
* @param int $nroots RS code generator polynomial degree (number of roots)
* @param int $pad padding bytes at front of shortened block
* @return array Array of RS values:<ul><li>mm = Bits per symbol;</li><li>nn = Symbols per block;</li><li>alpha_to = log lookup table array;</li><li>index_of = Antilog lookup table array;</li><li>genpoly = Generator polynomial array;</li><li>nroots = Number of generator;</li><li>roots = number of parity symbols;</li><li>fcr = First consecutive root, index form;</li><li>prim = Primitive element, index form;</li><li>iprim = prim-th root of 1, index form;</li><li>pad = Padding bytes in shortened block;</li><li>gfpoly</ul>.
protected function init_rs_char($symsize, $gfpoly, $fcr, $prim, $nroots, $pad) {
// Based on Reed solomon encoder by Phil Karn, KA9Q (GNU-LGPLv2)
// Check parameter ranges
if (($symsize < 0) OR ($symsize > 8)) {
if (($fcr < 0) OR ($fcr >= (1<< $symsize))) {
if (($prim <= 0) OR ($prim >= (1<< $symsize))) {
if (($nroots < 0) OR ($nroots >= (1<< $symsize))) {
if (($pad < 0) OR ($pad >= ((1<< $symsize) - 1 - $nroots))) {
$rs['nn'] = (1 << $symsize) - 1;
$rs['alpha_to'] = array_fill(0, ($rs['nn'] + 1), 0);
$rs['index_of'] = array_fill(0, ($rs['nn'] + 1), 0);
// PHP style macro replacement ;)
// Generate Galois field lookup tables
$rs['index_of'][0] = $A0; // log(zero) = -inf
$rs['alpha_to'][$A0] = 0; // alpha**-inf = 0
for ($i= 0; $i< $rs['nn']; ++ $i) {
$rs['index_of'][$sr] = $i;
$rs['alpha_to'][$i] = $sr;
if ($sr & (1 << $symsize)) {
// field generator polynomial is not primitive!
// Form RS code generator polynomial from its roots
// Find prim-th root of 1, used in decoding
for ($iprim= 1; ($iprim % $prim) != 0; $iprim += $rs['nn']) {
; // intentional empty-body loop!
$rs['iprim'] = (int) ($iprim / $prim);
for ($i = 0,$root= $fcr* $prim; $i < $nroots; $i++ , $root += $prim) {
$rs['genpoly'][$i+ 1] = 1;
// Multiply rs->genpoly[] by @**(root + x)
for ($j = $i; $j > 0; -- $j) {
if ($rs['genpoly'][$j] != 0) {
$rs['genpoly'][$j] = $rs['genpoly'][$j- 1] ^ $rs['alpha_to'][$this->modnn($rs, $rs['index_of'][$rs['genpoly'][$j]] + $root)];
$rs['genpoly'][$j] = $rs['genpoly'][$j- 1];
// rs->genpoly[0] can never be zero
$rs['genpoly'][0] = $rs['alpha_to'][$this->modnn($rs, $rs['index_of'][$rs['genpoly'][0]] + $root)];
// convert rs->genpoly[] to index form for quicker encoding
for ($i = 0; $i <= $nroots; ++ $i) {
$rs['genpoly'][$i] = $rs['index_of'][$rs['genpoly'][$i]];
* Encode a Reed-Solomon codec and returns the parity array
* @param array $rs RS values
* @param array $data data
* @param array $parity parity
$MM = & $rs['mm']; // bits per symbol
$NN = & $rs['nn']; // the total number of symbols in a RS block
$ALPHA_TO = & $rs['alpha_to']; // the address of an array of NN elements to convert Galois field elements in index (log) form to polynomial form
$INDEX_OF = & $rs['index_of']; // the address of an array of NN elements to convert Galois field elements in polynomial form to index (log) form
$GENPOLY = & $rs['genpoly']; // an array of NROOTS+1 elements containing the generator polynomial in index form
$NROOTS = & $rs['nroots']; // the number of roots in the RS code generator polynomial, which is the same as the number of parity symbols in a block
$FCR = & $rs['fcr']; // first consecutive root, index form
$PRIM = & $rs['prim']; // primitive element, index form
$IPRIM = & $rs['iprim']; // prim-th root of 1, index form
$PAD = & $rs['pad']; // the number of pad symbols in a block
for ($i= 0; $i < ($NN - $NROOTS - $PAD); $i++ ) {
$feedback = $INDEX_OF[$data[$i] ^ $parity[0]];
// feedback term is non-zero
// This line is unnecessary when GENPOLY[NROOTS] is unity, as it must
// always be for the polynomials constructed by init_rs()
$feedback = $this->modnn($rs, $NN - $GENPOLY[$NROOTS] + $feedback);
for ($j= 1; $j < $NROOTS; ++ $j) {
$parity[$j] ^= $ALPHA_TO[$this->modnn($rs, $feedback + $GENPOLY[($NROOTS - $j)])];
array_push($parity, $ALPHA_TO[$this->modnn($rs, $feedback + $GENPOLY[0])]);
} // END OF "class_exists QRcode"
//============================================================+
//============================================================+
|