// 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());
}
}
// 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);
}
}
}
// Make bit vector of version information. On success, store the result in "bits" and return true.
// See 8.10 of JISX0510:2004 (p.45) for details.
public static void MakeVersionInfoBits(int version, BitVector bits)
{
bits.AppendBits(version, 6);
int bchCode = CalculateBCHCode(version, VERSION_INFO_POLY);
bits.AppendBits(bchCode, 12);
if (bits.Size() != 18) // Just in case.
{
throw new WriterException("should not happen but we got: " + bits.Size());
}
}
// Append "bits".
public void AppendBitVector(BitVector bits)
{
int size = bits.Size();
for (int i = 0; i < size; ++i)
{
AppendBit(bits.At(i));
}
}
// Modify the bit vector by XOR'ing with "other"
public void Xor(BitVector other)
{
if (sizeInBits != other.Size())
{
throw new ArgumentException("BitVector sizes don't match");
}
int sizeInBytes = (sizeInBits + 7) >> 3;
for (int i = 0; i < sizeInBytes; ++i)
{
// The last byte could be incomplete (i.e. not have 8 bits in
// it) but there is no problem since 0 XOR 0 == 0.
array[i] ^= other.array[i];
}
}
// Make bit vector of type information. On success, store the result in "bits" and return true.
// Encode error correction level and mask pattern. See 8.9 of
// JISX0510:2004 (p.45) for details.
public static void MakeTypeInfoBits(ErrorCorrectionLevel ecLevel, int maskPattern, BitVector bits)
{
if (!QRCode.IsValidMaskPattern(maskPattern))
{
throw new WriterException("Invalid mask pattern");
}
int typeInfo = (ecLevel.GetBits() << 3) | maskPattern;
bits.AppendBits(typeInfo, 5);
int bchCode = CalculateBCHCode(typeInfo, TYPE_INFO_POLY);
bits.AppendBits(bchCode, 10);
BitVector maskBits = new BitVector();
maskBits.AppendBits(TYPE_INFO_MASK_PATTERN, 15);
bits.Xor(maskBits);
if (bits.Size() != 15) // Just in case.
{
throw new WriterException("should not happen but we got: " + bits.Size());
}
}
/**
* Terminate bits as described in 8.4.8 and 8.4.9 of JISX0510:2004 (p.24).
*/
private static void TerminateBits(int numDataBytes, BitVector bits)
{
var capacity = numDataBytes << 3;
if (bits.Size() > capacity)
{
throw new WriterException("data bits cannot fit in the QR Code" + bits.Size() + " > " +
capacity);
}
// Append termination bits. See 8.4.8 of JISX0510:2004 (p.24) for details.
// TODO: srowen says we can remove this for loop, since the 4 terminator bits are optional if
// the last byte has less than 4 bits left. So it amounts to padding the last byte with zeroes
// either way.
for (var i = 0; i < 4 && bits.Size() < capacity; ++i)
{
bits.AppendBit(0);
}
var numBitsInLastByte = bits.Size() % 8;
// If the last byte isn't 8-bit aligned, we'll add padding bits.
if (numBitsInLastByte > 0)
{
var numPaddingBits = 8 - numBitsInLastByte;
for (var i = 0; i < numPaddingBits; ++i)
{
bits.AppendBit(0);
}
}
// Should be 8-bit aligned here.
if (bits.Size() % 8 != 0)
{
throw new WriterException("Number of bits is not a multiple of 8");
}
// If we have more space, we'll fill the space with padding patterns defined in 8.4.9 (p.24).
var numPaddingBytes = numDataBytes - bits.SizeInBytes();
for (var i = 0; i < numPaddingBytes; ++i)
{
if (i % 2 == 0)
{
bits.AppendBits(0xec, 8);
}
else
{
bits.AppendBits(0x11, 8);
}
}
if (bits.Size() != capacity)
{
throw new WriterException("Bits size does not equal capacity");
}
}
/**
* Terminate bits as described in 8.4.8 and 8.4.9 of JISX0510:2004 (p.24).
*/
static void TerminateBits(int numDataBytes, BitVector bits) {
int capacity = numDataBytes << 3;
if (bits.Size() > capacity) {
throw new WriterException("data bits cannot fit in the QR Code" + bits.Size() + " > " +
capacity);
}
// Append termination bits. See 8.4.8 of JISX0510:2004 (p.24) for details.
// TODO: srowen says we can remove this for loop, since the 4 terminator bits are optional if
// the last byte has less than 4 bits left. So it amounts to padding the last byte with zeroes
// either way.
for (int i = 0; i < 4 && bits.Size() < capacity; ++i) {
bits.AppendBit(0);
}
int numBitsInLastByte = bits.Size() % 8;
// If the last byte isn't 8-bit aligned, we'll add padding bits.
if (numBitsInLastByte > 0) {
int numPaddingBits = 8 - numBitsInLastByte;
for (int i = 0; i < numPaddingBits; ++i) {
bits.AppendBit(0);
}
}
// Should be 8-bit aligned here.
if (bits.Size() % 8 != 0) {
throw new WriterException("Number of bits is not a multiple of 8");
}
// If we have more space, we'll fill the space with padding patterns defined in 8.4.9 (p.24).
int numPaddingBytes = numDataBytes - bits.SizeInBytes();
for (int i = 0; i < numPaddingBytes; ++i) {
if (i % 2 == 0) {
bits.AppendBits(0xec, 8);
}
else {
bits.AppendBits(0x11, 8);
}
}
if (bits.Size() != capacity) {
throw new WriterException("Bits size does not equal capacity");
}
}
// Modify the bit vector by XOR'ing with "other"
public void Xor(BitVector other) {
if (sizeInBits != other.Size()) {
throw new ArgumentException("BitVector sizes don't match");
}
int sizeInBytes = (sizeInBits + 7) >> 3;
for (int i = 0; i < sizeInBytes; ++i) {
// The last byte could be incomplete (i.e. not have 8 bits in
// it) but there is no problem since 0 XOR 0 == 0.
array[i] ^= other.array[i];
}
}
// Append "bits".
public void AppendBitVector(BitVector bits) {
int size = bits.Size();
for (int i = 0; i < size; ++i) {
AppendBit(bits.At(i));
}
}
// Make bit vector of version information. On success, store the result in "bits" and return true.
// See 8.10 of JISX0510:2004 (p.45) for details.
public static void MakeVersionInfoBits(int version, BitVector bits)
{
bits.AppendBits(version, 6);
int bchCode = CalculateBCHCode(version, VERSION_INFO_POLY);
bits.AppendBits(bchCode, 12);
if (bits.Size() != 18) { // Just in case.
throw new WriterException("should not happen but we got: " + bits.Size());
}
}
// Make bit vector of type information. On success, store the result in "bits" and return true.
// Encode error correction level and mask pattern. See 8.9 of
// JISX0510:2004 (p.45) for details.
public static void MakeTypeInfoBits(ErrorCorrectionLevel ecLevel, int maskPattern, BitVector bits)
{
if (!QRCode.IsValidMaskPattern(maskPattern)) {
throw new WriterException("Invalid mask pattern");
}
int typeInfo = (ecLevel.GetBits() << 3) | maskPattern;
bits.AppendBits(typeInfo, 5);
int bchCode = CalculateBCHCode(typeInfo, TYPE_INFO_POLY);
bits.AppendBits(bchCode, 10);
BitVector maskBits = new BitVector();
maskBits.AppendBits(TYPE_INFO_MASK_PATTERN, 15);
bits.Xor(maskBits);
if (bits.Size() != 15) { // Just in case.
throw new WriterException("should not happen but we got: " + bits.Size());
}
}
// 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);
}
}
}
// 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());
}
}
