// The mask penalty calculation is complicated. See Table 21 of JISX0510:2004 (p.45) for details.
// Basically it applies four rules and summate all penalties.
private static int CalculateMaskPenalty(ByteMatrix matrix) {
int penalty = 0;
penalty += MaskUtil.ApplyMaskPenaltyRule1(matrix);
penalty += MaskUtil.ApplyMaskPenaltyRule2(matrix);
penalty += MaskUtil.ApplyMaskPenaltyRule3(matrix);
penalty += MaskUtil.ApplyMaskPenaltyRule4(matrix);
return penalty;
}
public QRCode() {
mode = null;
ecLevel = null;
version = -1;
matrixWidth = -1;
maskPattern = -1;
numTotalBytes = -1;
numDataBytes = -1;
numECBytes = -1;
numRSBlocks = -1;
matrix = null;
}
// Apply mask penalty rule 3 and return the penalty. Find consecutive cells of 00001011101 or
// 10111010000, and give penalty to them. If we find patterns like 000010111010000, we give
// penalties twice (i.e. 40 * 2).
public static int ApplyMaskPenaltyRule3(ByteMatrix matrix)
{
int penalty = 0;
sbyte[][] array = matrix.GetArray();
int width = matrix.GetWidth();
int height = matrix.GetHeight();
for (int y = 0; y < height; ++y) {
for (int x = 0; x < width; ++x) {
// Tried to simplify following conditions but failed.
if (x + 6 < width &&
array[y][x] == 1 &&
array[y][x + 1] == 0 &&
array[y][x + 2] == 1 &&
array[y][x + 3] == 1 &&
array[y][x + 4] == 1 &&
array[y][x + 5] == 0 &&
array[y][x + 6] == 1 &&
((x + 10 < width &&
array[y][x + 7] == 0 &&
array[y][x + 8] == 0 &&
array[y][x + 9] == 0 &&
array[y][x + 10] == 0) ||
(x - 4 >= 0 &&
array[y][x - 1] == 0 &&
array[y][x - 2] == 0 &&
array[y][x - 3] == 0 &&
array[y][x - 4] == 0))) {
penalty += 40;
}
if (y + 6 < height &&
array[y][x] == 1 &&
array[y + 1][x] == 0 &&
array[y + 2][x] == 1 &&
array[y + 3][x] == 1 &&
array[y + 4][x] == 1 &&
array[y + 5][x] == 0 &&
array[y + 6][x] == 1 &&
((y + 10 < height &&
array[y + 7][x] == 0 &&
array[y + 8][x] == 0 &&
array[y + 9][x] == 0 &&
array[y + 10][x] == 0) ||
(y - 4 >= 0 &&
array[y - 1][x] == 0 &&
array[y - 2][x] == 0 &&
array[y - 3][x] == 0 &&
array[y - 4][x] == 0))) {
penalty += 40;
}
}
}
return penalty;
}
// Apply mask penalty rule 2 and return the penalty. Find 2x2 blocks with the same color and give
// penalty to them.
public static int ApplyMaskPenaltyRule2(ByteMatrix matrix) {
int penalty = 0;
sbyte[][] array = matrix.GetArray();
int width = matrix.GetWidth();
int height = matrix.GetHeight();
for (int y = 0; y < height - 1; ++y) {
for (int x = 0; x < width - 1; ++x) {
int value = array[y][x];
if (value == array[y][x + 1] && value == array[y + 1][x] && value == array[y + 1][x + 1]) {
penalty += 3;
}
}
}
return penalty;
}
private static int ChooseMaskPattern(BitVector bits, ErrorCorrectionLevel ecLevel, int version,
ByteMatrix matrix)
{
var minPenalty = int.MaxValue; // Lower penalty is better.
var bestMaskPattern = -1;
// We try all mask patterns to choose the best one.
for (var maskPattern = 0; maskPattern < QRCode.NUM_MASK_PATTERNS; maskPattern++)
{
MatrixUtil.BuildMatrix(bits, ecLevel, version, maskPattern, matrix);
var penalty = CalculateMaskPenalty(matrix);
if (penalty < minPenalty)
{
minPenalty = penalty;
bestMaskPattern = maskPattern;
}
}
return(bestMaskPattern);
}
// Note that we cannot unify the function with EmbedPositionDetectionPattern() despite they are
// almost identical, since we cannot write a function that takes 2D arrays in different sizes in
// C/C++. We should live with the fact.
private static void EmbedPositionAdjustmentPattern(int xStart, int yStart,
ByteMatrix matrix)
{
// We know the width and height.
if (POSITION_ADJUSTMENT_PATTERN[0].Length != 5 || POSITION_ADJUSTMENT_PATTERN.GetLength(0) != 5)
{
throw new WriterException("Bad position adjustment");
}
for (int y = 0; y < 5; ++y)
{
for (int x = 0; x < 5; ++x)
{
if (!IsEmpty(matrix.Get(xStart + x, yStart + y)))
{
throw new WriterException();
}
matrix.Set(xStart + x, yStart + y, POSITION_ADJUSTMENT_PATTERN[y][x]);
}
}
}
// Apply mask penalty rule 2 and return the penalty. Find 2x2 blocks with the same color and give
// penalty to them.
public static int ApplyMaskPenaltyRule2(ByteMatrix matrix)
{
var penalty = 0;
var array = matrix.GetArray();
var width = matrix.GetWidth();
var height = matrix.GetHeight();
for (var y = 0; y < height - 1; ++y)
{
for (var x = 0; x < width - 1; ++x)
{
int value = array[y][x];
if (value == array[y][x + 1] && value == array[y + 1][x] && value == array[y + 1][x + 1])
{
penalty += 3;
}
}
}
return(penalty);
}
private static void EmbedPositionDetectionPattern(int xStart, int yStart,
ByteMatrix matrix)
{
// We know the width and height.
if (POSITION_DETECTION_PATTERN[0].Length != 7 || POSITION_DETECTION_PATTERN.GetLength(0) != 7)
{
throw new WriterException("Bad position detection pattern");
}
for (int y = 0; y < 7; ++y)
{
for (int x = 0; x < 7; ++x)
{
if (!IsEmpty(matrix.Get(xStart + x, yStart + y)))
{
throw new WriterException();
}
matrix.Set(xStart + x, yStart + y, POSITION_DETECTION_PATTERN[y][x]);
}
}
}
// Apply mask penalty rule 4 and return the penalty. Calculate the ratio of dark cells and give
// penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. Examples:
// - 0% => 100
// - 40% => 20
// - 45% => 10
// - 50% => 0
// - 55% => 10
// - 55% => 20
// - 100% => 100
public static int ApplyMaskPenaltyRule4(ByteMatrix matrix)
{
var numDarkCells = 0;
var array = matrix.GetArray();
var width = matrix.GetWidth();
var height = matrix.GetHeight();
for (var y = 0; y < height; ++y)
{
for (var x = 0; x < width; ++x)
{
if (array[y][x] == 1)
{
numDarkCells += 1;
}
}
}
var numTotalCells = matrix.GetHeight() * matrix.GetWidth();
var darkRatio = (double)numDarkCells / numTotalCells;
return(Math.Abs((int)(darkRatio * 100 - 50)) / 5 * 10);
}
// Embed basic patterns. On success, modify the matrix and return true.
// The basic patterns are:
// - Position detection patterns
// - Timing patterns
// - Dark dot at the left bottom corner
// - Position adjustment patterns, if need be
public static void EmbedBasicPatterns(int version, ByteMatrix matrix)
{
// Let's get started with embedding big squares at corners.
EmbedPositionDetectionPatternsAndSeparators(matrix);
// Then, embed the dark dot at the left bottom corner.
EmbedDarkDotAtLeftBottomCorner(matrix);
// Position adjustment patterns appear if version >= 2.
MaybeEmbedPositionAdjustmentPatterns(version, matrix);
// Timing patterns should be embedded after position adj. patterns.
EmbedTimingPatterns(matrix);
}
// Embed the lonely dark dot at left bottom corner. JISX0510:2004 (p.46)
private static void EmbedDarkDotAtLeftBottomCorner(ByteMatrix matrix)
{
if (matrix.Get(8, matrix.GetHeight() - 8) == 0) {
throw new WriterException();
}
matrix.Set(8, matrix.GetHeight() - 8, 1);
}
// Apply mask penalty rule 1 and return the penalty. Find repetitive cells with the same color and
// give penalty to them. Example: 00000 or 11111.
public static int ApplyMaskPenaltyRule1(ByteMatrix matrix) {
return ApplyMaskPenaltyRule1Internal(matrix, true) + ApplyMaskPenaltyRule1Internal(matrix, false);
}
// Note that we cannot unify the function with EmbedPositionDetectionPattern() despite they are
// almost identical, since we cannot write a function that takes 2D arrays in different sizes in
// C/C++. We should live with the fact.
private static void EmbedPositionAdjustmentPattern(int xStart, int yStart,
ByteMatrix matrix)
{
// We know the width and height.
if (POSITION_ADJUSTMENT_PATTERN[0].Length != 5 || POSITION_ADJUSTMENT_PATTERN.GetLength(0) != 5) {
throw new WriterException("Bad position adjustment");
}
for (int y = 0; y < 5; ++y) {
for (int x = 0; x < 5; ++x) {
if (!IsEmpty(matrix.Get(xStart + x, yStart + y))) {
throw new WriterException();
}
matrix.Set(xStart + x, yStart + y, POSITION_ADJUSTMENT_PATTERN[y][x]);
}
}
}
// Apply mask penalty rule 1 and return the penalty. Find repetitive cells with the same color and
// give penalty to them. Example: 00000 or 11111.
public static int ApplyMaskPenaltyRule1(ByteMatrix matrix)
{
return(ApplyMaskPenaltyRule1Internal(matrix, true) + ApplyMaskPenaltyRule1Internal(matrix, false));
}
// Note that the input matrix uses 0 == white, 1 == black, while the output matrix uses
// 0 == black, 255 == white (i.e. an 8 bit greyscale bitmap).
private static ByteMatrix RenderResult(QRCode code, int width, int height) {
ByteMatrix input = code.GetMatrix();
int inputWidth = input.GetWidth();
int inputHeight = input.GetHeight();
int qrWidth = inputWidth + (QUIET_ZONE_SIZE << 1);
int qrHeight = inputHeight + (QUIET_ZONE_SIZE << 1);
int outputWidth = Math.Max(width, qrWidth);
int outputHeight = Math.Max(height, qrHeight);
int multiple = Math.Min(outputWidth / qrWidth, outputHeight / qrHeight);
// Padding includes both the quiet zone and the extra white pixels to accommodate the requested
// dimensions. For example, if input is 25x25 the QR will be 33x33 including the quiet zone.
// If the requested size is 200x160, the multiple will be 4, for a QR of 132x132. These will
// handle all the padding from 100x100 (the actual QR) up to 200x160.
int leftPadding = (outputWidth - (inputWidth * multiple)) / 2;
int topPadding = (outputHeight - (inputHeight * multiple)) / 2;
ByteMatrix output = new ByteMatrix(outputWidth, outputHeight);
sbyte[][] outputArray = output.GetArray();
// We could be tricky and use the first row in each set of multiple as the temporary storage,
// instead of allocating this separate array.
sbyte[] row = new sbyte[outputWidth];
// 1. Write the white lines at the top
for (int y = 0; y < topPadding; y++) {
SetRowColor(outputArray[y], (sbyte)-1);
}
// 2. Expand the QR image to the multiple
sbyte[][] inputArray = input.GetArray();
for (int y = 0; y < inputHeight; y++) {
// a. Write the white pixels at the left of each row
for (int x = 0; x < leftPadding; x++) {
row[x] = (sbyte)-1;
}
// b. Write the contents of this row of the barcode
int offset = leftPadding;
for (int x = 0; x < inputWidth; x++) {
sbyte value = (inputArray[y][x] == 1) ? (sbyte)0 : (sbyte)-1;
for (int z = 0; z < multiple; z++) {
row[offset + z] = value;
}
offset += multiple;
}
// c. Write the white pixels at the right of each row
offset = leftPadding + (inputWidth * multiple);
for (int x = offset; x < outputWidth; x++) {
row[x] = (sbyte)-1;
}
// d. Write the completed row multiple times
offset = topPadding + (y * multiple);
for (int z = 0; z < multiple; z++) {
System.Array.Copy(row, 0, outputArray[offset + z], 0, outputWidth);
}
}
// 3. Write the white lines at the bottom
int offset2 = topPadding + (inputHeight * multiple);
for (int y = offset2; y < outputHeight; y++) {
SetRowColor(outputArray[y], (sbyte)-1);
}
return output;
}
private static int ChooseMaskPattern(BitVector bits, ErrorCorrectionLevel ecLevel, int version,
ByteMatrix matrix) {
int minPenalty = int.MaxValue; // Lower penalty is better.
int bestMaskPattern = -1;
// We try all mask patterns to choose the best one.
for (int maskPattern = 0; maskPattern < QRCode.NUM_MASK_PATTERNS; maskPattern++) {
MatrixUtil.BuildMatrix(bits, ecLevel, version, maskPattern, matrix);
int penalty = CalculateMaskPenalty(matrix);
if (penalty < minPenalty) {
minPenalty = penalty;
bestMaskPattern = maskPattern;
}
}
return bestMaskPattern;
}
// Set all cells to -1. -1 means that the cell is empty (not set yet).
//
// JAVAPORT: We shouldn't need to do this at all. The code should be rewritten to begin encoding
// with the ByteMatrix initialized all to zero.
public static void ClearMatrix(ByteMatrix matrix)
{
matrix.Clear((sbyte)-1);
}
// Embed type information. On success, modify the matrix.
public static void EmbedTypeInfo(ErrorCorrectionLevel ecLevel, int maskPattern, ByteMatrix matrix)
{
BitVector typeInfoBits = new BitVector();
MakeTypeInfoBits(ecLevel, maskPattern, typeInfoBits);
for (int i = 0; i < typeInfoBits.Size(); ++i)
{
// Place bits in LSB to MSB order. LSB (least significant bit) is the last value in
// "typeInfoBits".
int bit = typeInfoBits.At(typeInfoBits.Size() - 1 - i);
// Type info bits at the left top corner. See 8.9 of JISX0510:2004 (p.46).
int x1 = TYPE_INFO_COORDINATES[i][0];
int y1 = TYPE_INFO_COORDINATES[i][1];
matrix.Set(x1, y1, bit);
if (i < 8)
{
// Right top corner.
int x2 = matrix.GetWidth() - i - 1;
int y2 = 8;
matrix.Set(x2, y2, bit);
}
else
{
// Left bottom corner.
int x2 = 8;
int y2 = matrix.GetHeight() - 7 + (i - 8);
matrix.Set(x2, y2, bit);
}
}
}
private static void EmbedVerticalSeparationPattern(int xStart, int yStart,
ByteMatrix matrix)
{
// We know the width and height.
if (VERTICAL_SEPARATION_PATTERN[0].Length != 1 || VERTICAL_SEPARATION_PATTERN.GetLength(0) != 7) {
throw new WriterException("Bad vertical separation pattern");
}
for (int y = 0; y < 7; ++y) {
if (!IsEmpty(matrix.Get(xStart, yStart + y))) {
throw new WriterException();
}
matrix.Set(xStart, yStart + y, VERTICAL_SEPARATION_PATTERN[y][0]);
}
}
// Embed position adjustment patterns if need be.
private static void MaybeEmbedPositionAdjustmentPatterns(int version, ByteMatrix matrix)
{
if (version < 2) { // The patterns appear if version >= 2
return;
}
int index = version - 1;
int[] coordinates = POSITION_ADJUSTMENT_PATTERN_COORDINATE_TABLE[index];
int numCoordinates = POSITION_ADJUSTMENT_PATTERN_COORDINATE_TABLE[index].Length;
for (int i = 0; i < numCoordinates; ++i) {
for (int j = 0; j < numCoordinates; ++j) {
int y = coordinates[i];
int x = coordinates[j];
if (x == -1 || y == -1) {
continue;
}
// If the cell is unset, we embed the position adjustment pattern here.
if (IsEmpty(matrix.Get(x, y))) {
// -2 is necessary since the x/y coordinates point to the center of the pattern, not the
// left top corner.
EmbedPositionAdjustmentPattern(x - 2, y - 2, matrix);
}
}
}
}
private static void EmbedTimingPatterns(ByteMatrix matrix)
{
// -8 is for skipping position detection patterns (size 7), and two horizontal/vertical
// separation patterns (size 1). Thus, 8 = 7 + 1.
for (int i = 8; i < matrix.GetWidth() - 8; ++i) {
int bit = (i + 1) % 2;
// Horizontal line.
if (!IsValidValue(matrix.Get(i, 6))) {
throw new WriterException();
}
if (IsEmpty(matrix.Get(i, 6))) {
matrix.Set(i, 6, bit);
}
// Vertical line.
if (!IsValidValue(matrix.Get(6, i))) {
throw new WriterException();
}
if (IsEmpty(matrix.Get(6, i))) {
matrix.Set(6, i, bit);
}
}
}
// Embed position detection patterns and surrounding vertical/horizontal separators.
private static void EmbedPositionDetectionPatternsAndSeparators(ByteMatrix matrix)
{
// Embed three big squares at corners.
int pdpWidth = POSITION_DETECTION_PATTERN[0].Length;
// Left top corner.
EmbedPositionDetectionPattern(0, 0, matrix);
// Right top corner.
EmbedPositionDetectionPattern(matrix.GetWidth() - pdpWidth, 0, matrix);
// Left bottom corner.
EmbedPositionDetectionPattern(0, matrix.GetWidth() - pdpWidth, matrix);
// Embed horizontal separation patterns around the squares.
int hspWidth = HORIZONTAL_SEPARATION_PATTERN[0].Length;
// Left top corner.
EmbedHorizontalSeparationPattern(0, hspWidth - 1, matrix);
// Right top corner.
EmbedHorizontalSeparationPattern(matrix.GetWidth() - hspWidth,
hspWidth - 1, matrix);
// Left bottom corner.
EmbedHorizontalSeparationPattern(0, matrix.GetWidth() - hspWidth, matrix);
// Embed vertical separation patterns around the squares.
int vspSize = VERTICAL_SEPARATION_PATTERN.Length;
// Left top corner.
EmbedVerticalSeparationPattern(vspSize, 0, matrix);
// Right top corner.
EmbedVerticalSeparationPattern(matrix.GetHeight() - vspSize - 1, 0, matrix);
// Left bottom corner.
EmbedVerticalSeparationPattern(vspSize, matrix.GetHeight() - vspSize,
matrix);
}
private static void EmbedPositionDetectionPattern(int xStart, int yStart,
ByteMatrix matrix)
{
// We know the width and height.
if (POSITION_DETECTION_PATTERN[0].Length != 7 || POSITION_DETECTION_PATTERN.GetLength(0) != 7) {
throw new WriterException("Bad position detection pattern");
}
for (int y = 0; y < 7; ++y) {
for (int x = 0; x < 7; ++x) {
if (!IsEmpty(matrix.Get(xStart + x, yStart + y))) {
throw new WriterException();
}
matrix.Set(xStart + x, yStart + y, POSITION_DETECTION_PATTERN[y][x]);
}
}
}
// Note that the input matrix uses 0 == white, 1 == black, while the output matrix uses
// 0 == black, 255 == white (i.e. an 8 bit greyscale bitmap).
private static ByteMatrix RenderResult(QRCode code, int width, int height)
{
ByteMatrix input = code.GetMatrix();
int inputWidth = input.GetWidth();
int inputHeight = input.GetHeight();
int qrWidth = inputWidth + (QUIET_ZONE_SIZE << 1);
int qrHeight = inputHeight + (QUIET_ZONE_SIZE << 1);
int outputWidth = Math.Max(width, qrWidth);
int outputHeight = Math.Max(height, qrHeight);
int multiple = Math.Min(outputWidth / qrWidth, outputHeight / qrHeight);
// Padding includes both the quiet zone and the extra white pixels to accommodate the requested
// dimensions. For example, if input is 25x25 the QR will be 33x33 including the quiet zone.
// If the requested size is 200x160, the multiple will be 4, for a QR of 132x132. These will
// handle all the padding from 100x100 (the actual QR) up to 200x160.
int leftPadding = (outputWidth - (inputWidth * multiple)) / 2;
int topPadding = (outputHeight - (inputHeight * multiple)) / 2;
ByteMatrix output = new ByteMatrix(outputWidth, outputHeight);
sbyte[][] outputArray = output.GetArray();
// We could be tricky and use the first row in each set of multiple as the temporary storage,
// instead of allocating this separate array.
sbyte[] row = new sbyte[outputWidth];
// 1. Write the white lines at the top
for (int y = 0; y < topPadding; y++)
{
SetRowColor(outputArray[y], (sbyte)-1);
}
// 2. Expand the QR image to the multiple
sbyte[][] inputArray = input.GetArray();
for (int y = 0; y < inputHeight; y++)
{
// a. Write the white pixels at the left of each row
for (int x = 0; x < leftPadding; x++)
{
row[x] = (sbyte)-1;
}
// b. Write the contents of this row of the barcode
int offset = leftPadding;
for (int x = 0; x < inputWidth; x++)
{
sbyte value = (inputArray[y][x] == 1) ? (sbyte)0 : (sbyte)-1;
for (int z = 0; z < multiple; z++)
{
row[offset + z] = value;
}
offset += multiple;
}
// c. Write the white pixels at the right of each row
offset = leftPadding + (inputWidth * multiple);
for (int x = offset; x < outputWidth; x++)
{
row[x] = (sbyte)-1;
}
// d. Write the completed row multiple times
offset = topPadding + (y * multiple);
for (int z = 0; z < multiple; z++)
{
System.Array.Copy(row, 0, outputArray[offset + z], 0, outputWidth);
}
}
// 3. Write the white lines at the bottom
int offset2 = topPadding + (inputHeight * multiple);
for (int y = offset2; y < outputHeight; y++)
{
SetRowColor(outputArray[y], (sbyte)-1);
}
return(output);
}
// Embed type information. On success, modify the matrix.
public static void EmbedTypeInfo(ErrorCorrectionLevel ecLevel, int maskPattern, ByteMatrix matrix)
{
BitVector typeInfoBits = new BitVector();
MakeTypeInfoBits(ecLevel, maskPattern, typeInfoBits);
for (int i = 0; i < typeInfoBits.Size(); ++i) {
// Place bits in LSB to MSB order. LSB (least significant bit) is the last value in
// "typeInfoBits".
int bit = typeInfoBits.At(typeInfoBits.Size() - 1 - i);
// Type info bits at the left top corner. See 8.9 of JISX0510:2004 (p.46).
int x1 = TYPE_INFO_COORDINATES[i][0];
int y1 = TYPE_INFO_COORDINATES[i][1];
matrix.Set(x1, y1, bit);
if (i < 8) {
// Right top corner.
int x2 = matrix.GetWidth() - i - 1;
int y2 = 8;
matrix.Set(x2, y2, bit);
}
else {
// Left bottom corner.
int x2 = 8;
int y2 = matrix.GetHeight() - 7 + (i - 8);
matrix.Set(x2, y2, bit);
}
}
}
// This takes ownership of the 2D array.
public void SetMatrix(ByteMatrix value)
{
matrix = value;
}
public static void Encode(String content, ErrorCorrectionLevel ecLevel, IDictionary<EncodeHintType, Object> hints,
QRCode qrCode) {
String encoding = null;
if (hints != null && hints.ContainsKey(EncodeHintType.CHARACTER_SET))
encoding = (string)hints[EncodeHintType.CHARACTER_SET];
if (encoding == null) {
encoding = DEFAULT_BYTE_MODE_ENCODING;
}
// Step 1: Choose the mode (encoding).
Mode mode = ChooseMode(content, encoding);
// Step 2: Append "bytes" into "dataBits" in appropriate encoding.
BitVector dataBits = new BitVector();
AppendBytes(content, mode, dataBits, encoding);
// Step 3: Initialize QR code that can contain "dataBits".
int numInputBytes = dataBits.SizeInBytes();
InitQRCode(numInputBytes, ecLevel, mode, qrCode);
// Step 4: Build another bit vector that contains header and data.
BitVector headerAndDataBits = new BitVector();
// Step 4.5: Append ECI message if applicable
if (mode == Mode.BYTE && !DEFAULT_BYTE_MODE_ENCODING.Equals(encoding)) {
CharacterSetECI eci = CharacterSetECI.GetCharacterSetECIByName(encoding);
if (eci != null) {
AppendECI(eci, headerAndDataBits);
}
}
AppendModeInfo(mode, headerAndDataBits);
int numLetters = mode.Equals(Mode.BYTE) ? dataBits.SizeInBytes() : content.Length;
AppendLengthInfo(numLetters, qrCode.GetVersion(), mode, headerAndDataBits);
headerAndDataBits.AppendBitVector(dataBits);
// Step 5: Terminate the bits properly.
TerminateBits(qrCode.GetNumDataBytes(), headerAndDataBits);
// Step 6: Interleave data bits with error correction code.
BitVector finalBits = new BitVector();
InterleaveWithECBytes(headerAndDataBits, qrCode.GetNumTotalBytes(), qrCode.GetNumDataBytes(),
qrCode.GetNumRSBlocks(), finalBits);
// Step 7: Choose the mask pattern and set to "qrCode".
ByteMatrix matrix = new ByteMatrix(qrCode.GetMatrixWidth(), qrCode.GetMatrixWidth());
qrCode.SetMaskPattern(ChooseMaskPattern(finalBits, qrCode.GetECLevel(), qrCode.GetVersion(),
matrix));
// Step 8. Build the matrix and set it to "qrCode".
MatrixUtil.BuildMatrix(finalBits, qrCode.GetECLevel(), qrCode.GetVersion(),
qrCode.GetMaskPattern(), matrix);
qrCode.SetMatrix(matrix);
// Step 9. Make sure we have a valid QR Code.
if (!qrCode.IsValid()) {
throw new WriterException("Invalid QR code: " + qrCode.ToString());
}
}
/**
* Creates the QR barcode. The barcode is always created with the smallest possible size and is then stretched
* to the width and height given. Set the width and height to 1 to get an unscaled barcode.
* @param content the text to be encoded
* @param width the barcode width
* @param height the barcode height
* @param hints modifiers to change the way the barcode is create. They can be EncodeHintType.ERROR_CORRECTION
* and EncodeHintType.CHARACTER_SET. For EncodeHintType.ERROR_CORRECTION the values can be ErrorCorrectionLevel.L, M, Q, H.
* For EncodeHintType.CHARACTER_SET the values are strings and can be Cp437, Shift_JIS and ISO-8859-1 to ISO-8859-16. The default value is
* ISO-8859-1.
* @throws WriterException
*/
public BarcodeQRCode(String content, int width, int height, IDictionary<EncodeHintType, Object> hints) {
QRCodeWriter qc = new QRCodeWriter();
bm = qc.Encode(content, width, height, hints);
}
public static void Encode(string content, ErrorCorrectionLevel ecLevel, IDictionary <EncodeHintType, object> hints,
QRCode qrCode)
{
string encoding = null;
if (hints != null && hints.ContainsKey(EncodeHintType.CHARACTER_SET))
{
encoding = (string)hints[EncodeHintType.CHARACTER_SET];
}
if (encoding == null)
{
encoding = DEFAULT_BYTE_MODE_ENCODING;
}
// Step 1: Choose the mode (encoding).
var mode = ChooseMode(content, encoding);
// Step 2: Append "bytes" into "dataBits" in appropriate encoding.
var dataBits = new BitVector();
AppendBytes(content, mode, dataBits, encoding);
// Step 3: Initialize QR code that can contain "dataBits".
var numInputBytes = dataBits.SizeInBytes();
InitQRCode(numInputBytes, ecLevel, mode, qrCode);
// Step 4: Build another bit vector that contains header and data.
var headerAndDataBits = new BitVector();
// Step 4.5: Append ECI message if applicable
if (mode == Mode.BYTE && !DEFAULT_BYTE_MODE_ENCODING.Equals(encoding))
{
var eci = CharacterSetECI.GetCharacterSetECIByName(encoding);
if (eci != null)
{
AppendECI(eci, headerAndDataBits);
}
}
AppendModeInfo(mode, headerAndDataBits);
var numLetters = mode.Equals(Mode.BYTE) ? dataBits.SizeInBytes() : content.Length;
AppendLengthInfo(numLetters, qrCode.GetVersion(), mode, headerAndDataBits);
headerAndDataBits.AppendBitVector(dataBits);
// Step 5: Terminate the bits properly.
TerminateBits(qrCode.GetNumDataBytes(), headerAndDataBits);
// Step 6: Interleave data bits with error correction code.
var finalBits = new BitVector();
InterleaveWithECBytes(headerAndDataBits, qrCode.GetNumTotalBytes(), qrCode.GetNumDataBytes(),
qrCode.GetNumRSBlocks(), finalBits);
// Step 7: Choose the mask pattern and set to "qrCode".
var matrix = new ByteMatrix(qrCode.GetMatrixWidth(), qrCode.GetMatrixWidth());
qrCode.SetMaskPattern(ChooseMaskPattern(finalBits, qrCode.GetECLevel(), qrCode.GetVersion(),
matrix));
// Step 8. Build the matrix and set it to "qrCode".
MatrixUtil.BuildMatrix(finalBits, qrCode.GetECLevel(), qrCode.GetVersion(),
qrCode.GetMaskPattern(), matrix);
qrCode.SetMatrix(matrix);
// Step 9. Make sure we have a valid QR Code.
if (!qrCode.IsValid())
{
throw new WriterException("Invalid QR code: " + qrCode.ToString());
}
}
// Set all cells to -1. -1 means that the cell is empty (not set yet).
//
// JAVAPORT: We shouldn't need to do this at all. The code should be rewritten to begin encoding
// with the ByteMatrix initialized all to zero.
public static void ClearMatrix(ByteMatrix matrix)
{
matrix.Clear((sbyte)-1);
}
private static void EmbedHorizontalSeparationPattern(int xStart, int yStart,
ByteMatrix matrix)
{
// We know the width and height.
if (HORIZONTAL_SEPARATION_PATTERN[0].Length != 8 || HORIZONTAL_SEPARATION_PATTERN.GetLength(0) != 1) {
throw new WriterException("Bad horizontal separation pattern");
}
for (int x = 0; x < 8; ++x) {
if (!IsEmpty(matrix.Get(xStart + x, yStart))) {
throw new WriterException();
}
matrix.Set(xStart + x, yStart, HORIZONTAL_SEPARATION_PATTERN[0][x]);
}
}
// Build 2D matrix of QR Code from "dataBits" with "ecLevel", "version" and "getMaskPattern". On
// success, store the result in "matrix" and return true.
public static void BuildMatrix(BitVector dataBits, ErrorCorrectionLevel ecLevel, int version,
int maskPattern, ByteMatrix matrix)
{
ClearMatrix(matrix);
EmbedBasicPatterns(version, matrix);
// Type information appear with any version.
EmbedTypeInfo(ecLevel, maskPattern, matrix);
// Version info appear if version >= 7.
MaybeEmbedVersionInfo(version, matrix);
// Data should be embedded at end.
EmbedDataBits(dataBits, maskPattern, matrix);
}
// Embed "dataBits" using "getMaskPattern". On success, modify the matrix and return true.
// For debugging purposes, it skips masking process if "getMaskPattern" is -1.
// See 8.7 of JISX0510:2004 (p.38) for how to embed data bits.
public static void EmbedDataBits(BitVector dataBits, int maskPattern, ByteMatrix matrix)
{
int bitIndex = 0;
int direction = -1;
// Start from the right bottom cell.
int x = matrix.GetWidth() - 1;
int y = matrix.GetHeight() - 1;
while (x > 0) {
// Skip the vertical timing pattern.
if (x == 6) {
x -= 1;
}
while (y >= 0 && y < matrix.GetHeight()) {
for (int i = 0; i < 2; ++i) {
int xx = x - i;
// Skip the cell if it's not empty.
if (!IsEmpty(matrix.Get(xx, y))) {
continue;
}
int bit;
if (bitIndex < dataBits.Size()) {
bit = dataBits.At(bitIndex);
++bitIndex;
}
else {
// Padding bit. If there is no bit left, we'll fill the left cells with 0, as described
// in 8.4.9 of JISX0510:2004 (p. 24).
bit = 0;
}
// Skip masking if mask_pattern is -1.
if (maskPattern != -1) {
if (MaskUtil.GetDataMaskBit(maskPattern, xx, y)) {
bit ^= 0x1;
}
}
matrix.Set(xx, y, bit);
}
y += direction;
}
direction = -direction; // Reverse the direction.
y += direction;
x -= 2; // Move to the left.
}
// All bits should be consumed.
if (bitIndex != dataBits.Size()) {
throw new WriterException("Not all bits consumed: " + bitIndex + '/' + dataBits.Size());
}
}
// Apply mask penalty rule 4 and return the penalty. Calculate the ratio of dark cells and give
// penalty if the ratio is far from 50%. It gives 10 penalty for 5% distance. Examples:
// - 0% => 100
// - 40% => 20
// - 45% => 10
// - 50% => 0
// - 55% => 10
// - 55% => 20
// - 100% => 100
public static int ApplyMaskPenaltyRule4(ByteMatrix matrix) {
int numDarkCells = 0;
sbyte[][] array = matrix.GetArray();
int width = matrix.GetWidth();
int height = matrix.GetHeight();
for (int y = 0; y < height; ++y) {
for (int x = 0; x < width; ++x) {
if (array[y][x] == 1) {
numDarkCells += 1;
}
}
}
int numTotalCells = matrix.GetHeight() * matrix.GetWidth();
double darkRatio = (double)numDarkCells / numTotalCells;
return Math.Abs((int)(darkRatio * 100 - 50)) / 5 * 10;
}
// Helper function for applyMaskPenaltyRule1. We need this for doing this calculation in both
// vertical and horizontal orders respectively.
private static int ApplyMaskPenaltyRule1Internal(ByteMatrix matrix, bool isHorizontal) {
int penalty = 0;
int numSameBitCells = 0;
int prevBit = -1;
// Horizontal mode:
// for (int i = 0; i < matrix.Height(); ++i) {
// for (int j = 0; j < matrix.Width(); ++j) {
// int bit = matrix.Get(i, j);
// Vertical mode:
// for (int i = 0; i < matrix.Width(); ++i) {
// for (int j = 0; j < matrix.Height(); ++j) {
// int bit = matrix.Get(j, i);
int iLimit = isHorizontal ? matrix.GetHeight() : matrix.GetWidth();
int jLimit = isHorizontal ? matrix.GetWidth() : matrix.GetHeight();
sbyte[][] array = matrix.GetArray();
for (int i = 0; i < iLimit; ++i) {
for (int j = 0; j < jLimit; ++j) {
int bit = isHorizontal ? array[i][j] : array[j][i];
if (bit == prevBit) {
numSameBitCells += 1;
// Found five repetitive cells with the same color (bit).
// We'll give penalty of 3.
if (numSameBitCells == 5) {
penalty += 3;
}
else if (numSameBitCells > 5) {
// After five repetitive cells, we'll add the penalty one
// by one.
penalty += 1;
}
}
else {
numSameBitCells = 1; // Include the cell itself.
prevBit = bit;
}
}
numSameBitCells = 0; // Clear at each row/column.
}
return penalty;
}
// This takes ownership of the 2D array.
public void SetMatrix(ByteMatrix value)
{
matrix = value;
}
// Embed version information if need be. On success, modify the matrix and return true.
// See 8.10 of JISX0510:2004 (p.47) for how to embed version information.
public static void MaybeEmbedVersionInfo(int version, ByteMatrix matrix)
{
if (version < 7) { // Version info is necessary if version >= 7.
return; // Don't need version info.
}
BitVector versionInfoBits = new BitVector();
MakeVersionInfoBits(version, versionInfoBits);
int bitIndex = 6 * 3 - 1; // It will decrease from 17 to 0.
for (int i = 0; i < 6; ++i) {
for (int j = 0; j < 3; ++j) {
// Place bits in LSB (least significant bit) to MSB order.
int bit = versionInfoBits.At(bitIndex);
bitIndex--;
// Left bottom corner.
matrix.Set(i, matrix.GetHeight() - 11 + j, bit);
// Right bottom corner.
matrix.Set(matrix.GetHeight() - 11 + j, i, bit);
}
}
}
