import BitMatrix from '../../common/BitMatrix';
|
import Version from './Version';
|
import FormatException from '../../FormatException';
|
import IllegalArgumentException from '../../IllegalArgumentException';
|
/*
|
* Copyright 2007 ZXing authors
|
*
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
* you may not use this file except in compliance with the License.
|
* You may obtain a copy of the License at
|
*
|
* http://www.apache.org/licenses/LICENSE-2.0
|
*
|
* Unless required by applicable law or agreed to in writing, software
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
* See the License for the specific language governing permissions and
|
* limitations under the License.
|
*/
|
/**
|
* @author bbrown@google.com (Brian Brown)
|
*/
|
export default class BitMatrixParser {
|
/**
|
* @param bitMatrix {@link BitMatrix} to parse
|
* @throws FormatException if dimension is < 8 or > 144 or not 0 mod 2
|
*/
|
constructor(bitMatrix) {
|
const dimension = bitMatrix.getHeight();
|
if (dimension < 8 || dimension > 144 || (dimension & 0x01) !== 0) {
|
throw new FormatException();
|
}
|
this.version = BitMatrixParser.readVersion(bitMatrix);
|
this.mappingBitMatrix = this.extractDataRegion(bitMatrix);
|
this.readMappingMatrix = new BitMatrix(this.mappingBitMatrix.getWidth(), this.mappingBitMatrix.getHeight());
|
}
|
getVersion() {
|
return this.version;
|
}
|
/**
|
* <p>Creates the version object based on the dimension of the original bit matrix from
|
* the datamatrix code.</p>
|
*
|
* <p>See ISO 16022:2006 Table 7 - ECC 200 symbol attributes</p>
|
*
|
* @param bitMatrix Original {@link BitMatrix} including alignment patterns
|
* @return {@link Version} encapsulating the Data Matrix Code's "version"
|
* @throws FormatException if the dimensions of the mapping matrix are not valid
|
* Data Matrix dimensions.
|
*/
|
static readVersion(bitMatrix) {
|
const numRows = bitMatrix.getHeight();
|
const numColumns = bitMatrix.getWidth();
|
return Version.getVersionForDimensions(numRows, numColumns);
|
}
|
/**
|
* <p>Reads the bits in the {@link BitMatrix} representing the mapping matrix (No alignment patterns)
|
* in the correct order in order to reconstitute the codewords bytes contained within the
|
* Data Matrix Code.</p>
|
*
|
* @return bytes encoded within the Data Matrix Code
|
* @throws FormatException if the exact number of bytes expected is not read
|
*/
|
readCodewords() {
|
const result = new Int8Array(this.version.getTotalCodewords());
|
let resultOffset = 0;
|
let row = 4;
|
let column = 0;
|
const numRows = this.mappingBitMatrix.getHeight();
|
const numColumns = this.mappingBitMatrix.getWidth();
|
let corner1Read = false;
|
let corner2Read = false;
|
let corner3Read = false;
|
let corner4Read = false;
|
// Read all of the codewords
|
do {
|
// Check the four corner cases
|
if ((row === numRows) && (column === 0) && !corner1Read) {
|
result[resultOffset++] = this.readCorner1(numRows, numColumns) & 0xff;
|
row -= 2;
|
column += 2;
|
corner1Read = true;
|
}
|
else if ((row === numRows - 2) && (column === 0) && ((numColumns & 0x03) !== 0) && !corner2Read) {
|
result[resultOffset++] = this.readCorner2(numRows, numColumns) & 0xff;
|
row -= 2;
|
column += 2;
|
corner2Read = true;
|
}
|
else if ((row === numRows + 4) && (column === 2) && ((numColumns & 0x07) === 0) && !corner3Read) {
|
result[resultOffset++] = this.readCorner3(numRows, numColumns) & 0xff;
|
row -= 2;
|
column += 2;
|
corner3Read = true;
|
}
|
else if ((row === numRows - 2) && (column === 0) && ((numColumns & 0x07) === 4) && !corner4Read) {
|
result[resultOffset++] = this.readCorner4(numRows, numColumns) & 0xff;
|
row -= 2;
|
column += 2;
|
corner4Read = true;
|
}
|
else {
|
// Sweep upward diagonally to the right
|
do {
|
if ((row < numRows) && (column >= 0) && !this.readMappingMatrix.get(column, row)) {
|
result[resultOffset++] = this.readUtah(row, column, numRows, numColumns) & 0xff;
|
}
|
row -= 2;
|
column += 2;
|
} while ((row >= 0) && (column < numColumns));
|
row += 1;
|
column += 3;
|
// Sweep downward diagonally to the left
|
do {
|
if ((row >= 0) && (column < numColumns) && !this.readMappingMatrix.get(column, row)) {
|
result[resultOffset++] = this.readUtah(row, column, numRows, numColumns) & 0xff;
|
}
|
row += 2;
|
column -= 2;
|
} while ((row < numRows) && (column >= 0));
|
row += 3;
|
column += 1;
|
}
|
} while ((row < numRows) || (column < numColumns));
|
if (resultOffset !== this.version.getTotalCodewords()) {
|
throw new FormatException();
|
}
|
return result;
|
}
|
/**
|
* <p>Reads a bit of the mapping matrix accounting for boundary wrapping.</p>
|
*
|
* @param row Row to read in the mapping matrix
|
* @param column Column to read in the mapping matrix
|
* @param numRows Number of rows in the mapping matrix
|
* @param numColumns Number of columns in the mapping matrix
|
* @return value of the given bit in the mapping matrix
|
*/
|
readModule(row, column, numRows, numColumns) {
|
// Adjust the row and column indices based on boundary wrapping
|
if (row < 0) {
|
row += numRows;
|
column += 4 - ((numRows + 4) & 0x07);
|
}
|
if (column < 0) {
|
column += numColumns;
|
row += 4 - ((numColumns + 4) & 0x07);
|
}
|
this.readMappingMatrix.set(column, row);
|
return this.mappingBitMatrix.get(column, row);
|
}
|
/**
|
* <p>Reads the 8 bits of the standard Utah-shaped pattern.</p>
|
*
|
* <p>See ISO 16022:2006, 5.8.1 Figure 6</p>
|
*
|
* @param row Current row in the mapping matrix, anchored at the 8th bit (LSB) of the pattern
|
* @param column Current column in the mapping matrix, anchored at the 8th bit (LSB) of the pattern
|
* @param numRows Number of rows in the mapping matrix
|
* @param numColumns Number of columns in the mapping matrix
|
* @return byte from the utah shape
|
*/
|
readUtah(row, column, numRows, numColumns) {
|
let currentByte = 0;
|
if (this.readModule(row - 2, column - 2, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(row - 2, column - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(row - 1, column - 2, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(row - 1, column - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(row - 1, column, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(row, column - 2, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(row, column - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(row, column, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
return currentByte;
|
}
|
/**
|
* <p>Reads the 8 bits of the special corner condition 1.</p>
|
*
|
* <p>See ISO 16022:2006, Figure F.3</p>
|
*
|
* @param numRows Number of rows in the mapping matrix
|
* @param numColumns Number of columns in the mapping matrix
|
* @return byte from the Corner condition 1
|
*/
|
readCorner1(numRows, numColumns) {
|
let currentByte = 0;
|
if (this.readModule(numRows - 1, 0, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(numRows - 1, 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(numRows - 1, 2, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(0, numColumns - 2, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(0, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(1, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(2, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(3, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
return currentByte;
|
}
|
/**
|
* <p>Reads the 8 bits of the special corner condition 2.</p>
|
*
|
* <p>See ISO 16022:2006, Figure F.4</p>
|
*
|
* @param numRows Number of rows in the mapping matrix
|
* @param numColumns Number of columns in the mapping matrix
|
* @return byte from the Corner condition 2
|
*/
|
readCorner2(numRows, numColumns) {
|
let currentByte = 0;
|
if (this.readModule(numRows - 3, 0, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(numRows - 2, 0, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(numRows - 1, 0, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(0, numColumns - 4, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(0, numColumns - 3, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(0, numColumns - 2, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(0, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(1, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
return currentByte;
|
}
|
/**
|
* <p>Reads the 8 bits of the special corner condition 3.</p>
|
*
|
* <p>See ISO 16022:2006, Figure F.5</p>
|
*
|
* @param numRows Number of rows in the mapping matrix
|
* @param numColumns Number of columns in the mapping matrix
|
* @return byte from the Corner condition 3
|
*/
|
readCorner3(numRows, numColumns) {
|
let currentByte = 0;
|
if (this.readModule(numRows - 1, 0, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(numRows - 1, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(0, numColumns - 3, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(0, numColumns - 2, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(0, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(1, numColumns - 3, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(1, numColumns - 2, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(1, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
return currentByte;
|
}
|
/**
|
* <p>Reads the 8 bits of the special corner condition 4.</p>
|
*
|
* <p>See ISO 16022:2006, Figure F.6</p>
|
*
|
* @param numRows Number of rows in the mapping matrix
|
* @param numColumns Number of columns in the mapping matrix
|
* @return byte from the Corner condition 4
|
*/
|
readCorner4(numRows, numColumns) {
|
let currentByte = 0;
|
if (this.readModule(numRows - 3, 0, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(numRows - 2, 0, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(numRows - 1, 0, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(0, numColumns - 2, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(0, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(1, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(2, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
currentByte <<= 1;
|
if (this.readModule(3, numColumns - 1, numRows, numColumns)) {
|
currentByte |= 1;
|
}
|
return currentByte;
|
}
|
/**
|
* <p>Extracts the data region from a {@link BitMatrix} that contains
|
* alignment patterns.</p>
|
*
|
* @param bitMatrix Original {@link BitMatrix} with alignment patterns
|
* @return BitMatrix that has the alignment patterns removed
|
*/
|
extractDataRegion(bitMatrix) {
|
const symbolSizeRows = this.version.getSymbolSizeRows();
|
const symbolSizeColumns = this.version.getSymbolSizeColumns();
|
if (bitMatrix.getHeight() !== symbolSizeRows) {
|
throw new IllegalArgumentException('Dimension of bitMatrix must match the version size');
|
}
|
const dataRegionSizeRows = this.version.getDataRegionSizeRows();
|
const dataRegionSizeColumns = this.version.getDataRegionSizeColumns();
|
const numDataRegionsRow = symbolSizeRows / dataRegionSizeRows | 0;
|
const numDataRegionsColumn = symbolSizeColumns / dataRegionSizeColumns | 0;
|
const sizeDataRegionRow = numDataRegionsRow * dataRegionSizeRows;
|
const sizeDataRegionColumn = numDataRegionsColumn * dataRegionSizeColumns;
|
const bitMatrixWithoutAlignment = new BitMatrix(sizeDataRegionColumn, sizeDataRegionRow);
|
for (let dataRegionRow = 0; dataRegionRow < numDataRegionsRow; ++dataRegionRow) {
|
const dataRegionRowOffset = dataRegionRow * dataRegionSizeRows;
|
for (let dataRegionColumn = 0; dataRegionColumn < numDataRegionsColumn; ++dataRegionColumn) {
|
const dataRegionColumnOffset = dataRegionColumn * dataRegionSizeColumns;
|
for (let i = 0; i < dataRegionSizeRows; ++i) {
|
const readRowOffset = dataRegionRow * (dataRegionSizeRows + 2) + 1 + i;
|
const writeRowOffset = dataRegionRowOffset + i;
|
for (let j = 0; j < dataRegionSizeColumns; ++j) {
|
const readColumnOffset = dataRegionColumn * (dataRegionSizeColumns + 2) + 1 + j;
|
if (bitMatrix.get(readColumnOffset, readRowOffset)) {
|
const writeColumnOffset = dataRegionColumnOffset + j;
|
bitMatrixWithoutAlignment.set(writeColumnOffset, writeRowOffset);
|
}
|
}
|
}
|
}
|
}
|
return bitMatrixWithoutAlignment;
|
}
|
}
|
