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());
}
}
/**
* 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");
}
}
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());
}
}
/**
* Interleave "bits" with corresponding error correction bytes. On success, store the result in
* "result". The interleave rule is complicated. See 8.6 of JISX0510:2004 (p.37) for details.
*/
private static void InterleaveWithECBytes(BitVector bits, int numTotalBytes,
int numDataBytes, int numRSBlocks, BitVector result)
{
// "bits" must have "getNumDataBytes" bytes of data.
if (bits.SizeInBytes() != numDataBytes)
{
throw new WriterException("Number of bits and data bytes does not match");
}
// Step 1. Divide data bytes into blocks and generate error correction bytes for them. We'll
// store the divided data bytes blocks and error correction bytes blocks into "blocks".
var dataBytesOffset = 0;
var maxNumDataBytes = 0;
var maxNumEcBytes = 0;
// Since, we know the number of reedsolmon blocks, we can initialize the vector with the number.
var blocks = new List <BlockPair>(numRSBlocks);
for (var i = 0; i < numRSBlocks; ++i)
{
var numDataBytesInBlock = new int[1];
var numEcBytesInBlock = new int[1];
GetNumDataBytesAndNumECBytesForBlockID(
numTotalBytes, numDataBytes, numRSBlocks, i,
numDataBytesInBlock, numEcBytesInBlock);
var dataBytes = new ByteArray();
dataBytes.Set(bits.GetArray(), dataBytesOffset, numDataBytesInBlock[0]);
var ecBytes = GenerateECBytes(dataBytes, numEcBytesInBlock[0]);
blocks.Add(new BlockPair(dataBytes, ecBytes));
maxNumDataBytes = Math.Max(maxNumDataBytes, dataBytes.Size());
maxNumEcBytes = Math.Max(maxNumEcBytes, ecBytes.Size());
dataBytesOffset += numDataBytesInBlock[0];
}
if (numDataBytes != dataBytesOffset)
{
throw new WriterException("Data bytes does not match offset");
}
// First, place data blocks.
for (var i = 0; i < maxNumDataBytes; ++i)
{
for (var j = 0; j < blocks.Count; ++j)
{
var dataBytes = blocks[j].GetDataBytes();
if (i < dataBytes.Size())
{
result.AppendBits(dataBytes.At(i), 8);
}
}
}
// Then, place error correction blocks.
for (var i = 0; i < maxNumEcBytes; ++i)
{
for (var j = 0; j < blocks.Count; ++j)
{
var ecBytes = blocks[j].GetErrorCorrectionBytes();
if (i < ecBytes.Size())
{
result.AppendBits(ecBytes.At(i), 8);
}
}
}
if (numTotalBytes != result.SizeInBytes())
{ // Should be same.
throw new WriterException("Interleaving error: " + numTotalBytes + " and " +
result.SizeInBytes() + " differ.");
}
}
/**
* Interleave "bits" with corresponding error correction bytes. On success, store the result in
* "result". The interleave rule is complicated. See 8.6 of JISX0510:2004 (p.37) for details.
*/
static void InterleaveWithECBytes(BitVector bits, int numTotalBytes,
int numDataBytes, int numRSBlocks, BitVector result) {
// "bits" must have "getNumDataBytes" bytes of data.
if (bits.SizeInBytes() != numDataBytes) {
throw new WriterException("Number of bits and data bytes does not match");
}
// Step 1. Divide data bytes into blocks and generate error correction bytes for them. We'll
// store the divided data bytes blocks and error correction bytes blocks into "blocks".
int dataBytesOffset = 0;
int maxNumDataBytes = 0;
int maxNumEcBytes = 0;
// Since, we know the number of reedsolmon blocks, we can initialize the vector with the number.
List<BlockPair> blocks = new List<BlockPair>(numRSBlocks);
for (int i = 0; i < numRSBlocks; ++i) {
int[] numDataBytesInBlock = new int[1];
int[] numEcBytesInBlock = new int[1];
GetNumDataBytesAndNumECBytesForBlockID(
numTotalBytes, numDataBytes, numRSBlocks, i,
numDataBytesInBlock, numEcBytesInBlock);
ByteArray dataBytes = new ByteArray();
dataBytes.Set(bits.GetArray(), dataBytesOffset, numDataBytesInBlock[0]);
ByteArray ecBytes = GenerateECBytes(dataBytes, numEcBytesInBlock[0]);
blocks.Add(new BlockPair(dataBytes, ecBytes));
maxNumDataBytes = Math.Max(maxNumDataBytes, dataBytes.Size());
maxNumEcBytes = Math.Max(maxNumEcBytes, ecBytes.Size());
dataBytesOffset += numDataBytesInBlock[0];
}
if (numDataBytes != dataBytesOffset) {
throw new WriterException("Data bytes does not match offset");
}
// First, place data blocks.
for (int i = 0; i < maxNumDataBytes; ++i) {
for (int j = 0; j < blocks.Count; ++j) {
ByteArray dataBytes = blocks[j].GetDataBytes();
if (i < dataBytes.Size()) {
result.AppendBits(dataBytes.At(i), 8);
}
}
}
// Then, place error correction blocks.
for (int i = 0; i < maxNumEcBytes; ++i) {
for (int j = 0; j < blocks.Count; ++j) {
ByteArray ecBytes = blocks[j].GetErrorCorrectionBytes();
if (i < ecBytes.Size()) {
result.AppendBits(ecBytes.At(i), 8);
}
}
}
if (numTotalBytes != result.SizeInBytes()) { // Should be same.
throw new WriterException("Interleaving error: " + numTotalBytes + " and " +
result.SizeInBytes() + " differ.");
}
}
/**
* 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");
}
}
