@sythos/js_barcode_universal 1.0.0 → 1.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +16 -17
- package/NOTICE.md +24 -22
- package/README.md +137 -60
- package/bundle/sythos-barcode.esm.js +3380 -216
- package/bundle/sythos-barcode.js +3368 -216
- package/examples/create.html +2 -0
- package/examples/read.html +341 -341
- package/licenses/README.md +58 -29
- package/licenses/aztec-code.license +74 -0
- package/licenses/codabar.license +9 -9
- package/licenses/code-11.license +9 -9
- package/licenses/code-128.license +6 -6
- package/licenses/code-39.license +6 -6
- package/licenses/code-93.license +7 -7
- package/licenses/data-matrix.license +11 -11
- package/licenses/ean-13.license +6 -6
- package/licenses/ean-8.license +6 -6
- package/licenses/gs1-128.license +6 -6
- package/licenses/isbn.license +7 -7
- package/licenses/itf-14.license +6 -6
- package/licenses/itf.license +6 -6
- package/licenses/micropdf417.license +96 -0
- package/licenses/msi-plessey.license +7 -7
- package/licenses/pdf417.license +37 -0
- package/licenses/pharmacode.license +7 -7
- package/licenses/qr-code.license +6 -6
- package/licenses/upc-a.license +7 -7
- package/licenses/upc-e.license +6 -6
- package/package.json +13 -3
- package/src/aztec/decoder.js +317 -0
- package/src/aztec/detector.js +224 -0
- package/src/aztec/encoder.js +257 -0
- package/src/aztec/high-level.js +211 -0
- package/src/aztec/index.js +45 -0
- package/src/aztec/tables.js +210 -0
- package/src/core/galois-field.js +3 -0
- package/src/core/reed-solomon.js +64 -50
- package/src/datamatrix/decoder.js +262 -262
- package/src/datamatrix/detector.js +225 -225
- package/src/datamatrix/encoder.js +191 -191
- package/src/datamatrix/index.js +42 -42
- package/src/datamatrix/tables.js +123 -123
- package/src/index.js +113 -3
- package/src/micropdf417/compaction.js +116 -0
- package/src/micropdf417/decoder.js +183 -0
- package/src/micropdf417/detector.js +149 -0
- package/src/micropdf417/encoder.js +209 -0
- package/src/micropdf417/error-correction.js +55 -0
- package/src/micropdf417/index.js +49 -0
- package/src/micropdf417/tables.js +184 -0
- package/src/pdf417/compaction.js +298 -0
- package/src/pdf417/decoder.js +75 -0
- package/src/pdf417/detector.js +468 -0
- package/src/pdf417/encoder.js +91 -0
- package/src/pdf417/error-correction.js +47 -0
- package/src/pdf417/index.js +6 -0
- package/src/pdf417/tables.js +317 -0
|
@@ -0,0 +1,317 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Sythos Barcode Suite
|
|
3
|
+
*
|
|
4
|
+
* MIT License
|
|
5
|
+
*
|
|
6
|
+
* Copyright (c) 2026 Sythos
|
|
7
|
+
*
|
|
8
|
+
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
9
|
+
* of this software and associated documentation files (the "Software"), to deal
|
|
10
|
+
* in the Software without restriction, including without limitation the rights
|
|
11
|
+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
12
|
+
* copies of the Software, and to permit persons to whom the Software is
|
|
13
|
+
* furnished to do so, subject to the following conditions:
|
|
14
|
+
*
|
|
15
|
+
* The above copyright notice and this permission notice shall be included in all
|
|
16
|
+
* copies or substantial portions of the Software.
|
|
17
|
+
*
|
|
18
|
+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
19
|
+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
20
|
+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
21
|
+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
22
|
+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
23
|
+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
24
|
+
* SOFTWARE.
|
|
25
|
+
*
|
|
26
|
+
* SPDX-License-Identifier: MIT
|
|
27
|
+
*
|
|
28
|
+
* Original work. No code from any other barcode implementation.
|
|
29
|
+
*/
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Decoder for a sampled Aztec symbol.
|
|
33
|
+
*
|
|
34
|
+
* This module deliberately accepts only a square, module-aligned BitMatrix.
|
|
35
|
+
* Locating a bull's-eye in a photograph and perspective sampling are detector
|
|
36
|
+
* concerns. Keeping the two stages apart makes all bit order and ECC rules
|
|
37
|
+
* testable without image-processing noise.
|
|
38
|
+
*
|
|
39
|
+
* Contract with tables.js:
|
|
40
|
+
* - aztecSymbolForLayers(compact, layers) returns the nominal symbol data;
|
|
41
|
+
* - aztecWordSizeForLayers(layers) returns 6, 8, 10 or 12;
|
|
42
|
+
* - aztecFieldForLayers(layers) returns the matching binary Galois field;
|
|
43
|
+
* - aztecMatrixSize(compact, layers) returns the rendered square size.
|
|
44
|
+
*
|
|
45
|
+
* @module aztec/decoder
|
|
46
|
+
*/
|
|
47
|
+
|
|
48
|
+
import { FormatError } from '../core/errors.js';
|
|
49
|
+
import { rsDecode } from '../core/reed-solomon.js';
|
|
50
|
+
import {
|
|
51
|
+
aztecLayer as aztecSymbolForLayers,
|
|
52
|
+
wordSizeForLayers as aztecWordSizeForLayers,
|
|
53
|
+
fieldForLayers as aztecFieldForLayers,
|
|
54
|
+
fieldForWordSize,
|
|
55
|
+
aztecSymbolSize as aztecMatrixSize,
|
|
56
|
+
} from './tables.js';
|
|
57
|
+
|
|
58
|
+
const UPPER = ['CTRL_PS', ' ', ...'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'CTRL_LL', 'CTRL_ML', 'CTRL_DL', 'CTRL_BS'];
|
|
59
|
+
const LOWER = ['CTRL_PS', ' ', ...'abcdefghijklmnopqrstuvwxyz', 'CTRL_US', 'CTRL_ML', 'CTRL_DL', 'CTRL_BS'];
|
|
60
|
+
const MIXED = [
|
|
61
|
+
'CTRL_PS', ' ', '\x01', '\x02', '\x03', '\x04', '\x05', '\x06', '\x07', '\b', '\t', '\n', '\x0b', '\f', '\r', '\x1b',
|
|
62
|
+
'\x1c', '\x1d', '\x1e', '\x1f', '@', '\\', '^', '_', '`', '|', '~', '\x7f', 'CTRL_LL', 'CTRL_UL', 'CTRL_PL', 'CTRL_BS',
|
|
63
|
+
];
|
|
64
|
+
const PUNCT = ['FLG(n)', '\r', '\r\n', '. ', ', ', ': ', '!', '"', '#', '$', '%', '&', "'", '(', ')', '*', '+', ',', '-', '.', '/', ':', ';', '<', '=', '>', '?', '[', ']', '{', '}', 'CTRL_UL'];
|
|
65
|
+
const DIGIT = ['CTRL_PS', ' ', ...'0123456789', ',', '.', 'CTRL_UL'];
|
|
66
|
+
const TABLES = { UPPER, LOWER, MIXED, PUNCT, DIGIT };
|
|
67
|
+
|
|
68
|
+
/** @param {boolean[]} bits @param {number} offset @param {number} count */
|
|
69
|
+
function readBits(bits, offset, count) {
|
|
70
|
+
if (offset + count > bits.length) throw new FormatError('Aztec: truncated high-level stream');
|
|
71
|
+
let value = 0;
|
|
72
|
+
for (let i = 0; i < count; i++) value = (value << 1) | (bits[offset + i] ? 1 : 0);
|
|
73
|
+
return value;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/** @param {number} value @param {number} count @param {boolean[]} out */
|
|
77
|
+
function appendBits(value, count, out) {
|
|
78
|
+
for (let i = count - 1; i >= 0; i--) out.push(((value >>> i) & 1) !== 0);
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Decode an Aztec high-level bit stream to its exact byte payload.
|
|
83
|
+
*
|
|
84
|
+
* Text tables contribute their ISO-8859-1 byte values; Binary Shift appends
|
|
85
|
+
* raw bytes. ECI markers are consumed but intentionally not emitted: callers
|
|
86
|
+
* receive the transported byte payload and may select their own charset.
|
|
87
|
+
*
|
|
88
|
+
* @param {boolean[]} bits
|
|
89
|
+
* @returns {Uint8Array}
|
|
90
|
+
*/
|
|
91
|
+
export function decodeHighLevelBits(bits) {
|
|
92
|
+
const output = [];
|
|
93
|
+
let latch = 'UPPER';
|
|
94
|
+
let shift = 'UPPER';
|
|
95
|
+
let offset = 0;
|
|
96
|
+
|
|
97
|
+
while (offset < bits.length) {
|
|
98
|
+
if (shift === 'BINARY') {
|
|
99
|
+
if (offset + 5 > bits.length) break; // legal trailing pad
|
|
100
|
+
let length = readBits(bits, offset, 5);
|
|
101
|
+
offset += 5;
|
|
102
|
+
if (length === 0) {
|
|
103
|
+
if (offset + 11 > bits.length) throw new FormatError('Aztec: truncated Binary Shift length');
|
|
104
|
+
length = readBits(bits, offset, 11) + 31;
|
|
105
|
+
offset += 11;
|
|
106
|
+
}
|
|
107
|
+
if (offset + length * 8 > bits.length) throw new FormatError('Aztec: truncated Binary Shift data');
|
|
108
|
+
for (let i = 0; i < length; i++) {
|
|
109
|
+
output.push(readBits(bits, offset, 8));
|
|
110
|
+
offset += 8;
|
|
111
|
+
}
|
|
112
|
+
shift = latch;
|
|
113
|
+
continue;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
const size = shift === 'DIGIT' ? 4 : 5;
|
|
117
|
+
if (offset + size > bits.length) break; // trailing pad after unstuffing
|
|
118
|
+
const code = readBits(bits, offset, size);
|
|
119
|
+
offset += size;
|
|
120
|
+
const table = TABLES[shift];
|
|
121
|
+
const token = table[code];
|
|
122
|
+
if (token === undefined) throw new FormatError(`Aztec: invalid ${shift} code ${code}`);
|
|
123
|
+
|
|
124
|
+
if (token === 'FLG(n)') {
|
|
125
|
+
if (offset + 3 > bits.length) throw new FormatError('Aztec: truncated FLG(n)');
|
|
126
|
+
const count = readBits(bits, offset, 3);
|
|
127
|
+
offset += 3;
|
|
128
|
+
if (count === 0) output.push(0x1d); // FNC1 / GS
|
|
129
|
+
else if (count <= 6) {
|
|
130
|
+
// ECI assignment number, encoded as count decimal digits. It changes
|
|
131
|
+
// interpretation, not the wire bytes, so consume it without output.
|
|
132
|
+
for (let i = 0; i < count; i++) {
|
|
133
|
+
if (offset + 4 > bits.length) throw new FormatError('Aztec: truncated ECI');
|
|
134
|
+
const digit = readBits(bits, offset, 4);
|
|
135
|
+
offset += 4;
|
|
136
|
+
if (digit < 2 || digit > 11) throw new FormatError('Aztec: invalid ECI digit');
|
|
137
|
+
}
|
|
138
|
+
} else {
|
|
139
|
+
throw new FormatError(`Aztec: unsupported FLG(${count})`);
|
|
140
|
+
}
|
|
141
|
+
shift = latch;
|
|
142
|
+
continue;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
if (token.startsWith('CTRL_')) {
|
|
146
|
+
const targetCode = token.slice(5, -1);
|
|
147
|
+
const latchMode = token.endsWith('L');
|
|
148
|
+
const target = ({ P: 'PUNCT', L: 'LOWER', M: 'MIXED', D: 'DIGIT', U: 'UPPER', B: 'BINARY' })[targetCode];
|
|
149
|
+
if (!target) throw new FormatError(`Aztec: invalid control ${token}`);
|
|
150
|
+
shift = target;
|
|
151
|
+
if (latchMode) latch = shift;
|
|
152
|
+
continue;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
for (let i = 0; i < token.length; i++) output.push(token.charCodeAt(i));
|
|
156
|
+
shift = latch;
|
|
157
|
+
}
|
|
158
|
+
return Uint8Array.from(output);
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
/** @param {boolean} compact @param {number} layers */
|
|
162
|
+
function alignmentMap(compact, layers) {
|
|
163
|
+
const baseSize = (compact ? 11 : 14) + layers * 4;
|
|
164
|
+
if (compact) return Array.from({ length: baseSize }, (_, i) => i);
|
|
165
|
+
const size = aztecMatrixSize(layers, false);
|
|
166
|
+
const map = new Array(baseSize);
|
|
167
|
+
const baseCenter = baseSize >> 1;
|
|
168
|
+
const center = size >> 1;
|
|
169
|
+
for (let i = 0; i < baseCenter; i++) {
|
|
170
|
+
const offset = i + Math.floor(i / 15);
|
|
171
|
+
map[baseCenter - i - 1] = center - offset - 1;
|
|
172
|
+
map[baseCenter + i] = center + offset + 1;
|
|
173
|
+
}
|
|
174
|
+
return map;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* Read the four sides of the parameter message. The order mirrors the
|
|
179
|
+
* clockwise write order and is independent of the data spiral.
|
|
180
|
+
*
|
|
181
|
+
* @param {import('../core/bit-matrix.js').BitMatrix} matrix
|
|
182
|
+
* @param {boolean} compact
|
|
183
|
+
* @returns {boolean[]}
|
|
184
|
+
*/
|
|
185
|
+
function readModeBits(matrix, compact) {
|
|
186
|
+
const center = matrix.width >> 1;
|
|
187
|
+
const side = compact ? 7 : 10;
|
|
188
|
+
const offset = compact ? 5 : 7;
|
|
189
|
+
// Full symbols skip the reference grid line through the bull's-eye. This
|
|
190
|
+
// exact sequence is also used by drawModeMessage() in encoder.js.
|
|
191
|
+
const positions = Array.from(
|
|
192
|
+
{ length: side },
|
|
193
|
+
(_, i) => compact ? center - 3 + i : center - 5 + i + Math.floor(i / 5),
|
|
194
|
+
);
|
|
195
|
+
const bits = [];
|
|
196
|
+
for (let i = 0; i < side; i++) bits.push(matrix.get(positions[i], center - offset));
|
|
197
|
+
for (let i = 0; i < side; i++) bits.push(matrix.get(center + offset, positions[i]));
|
|
198
|
+
for (let i = 0; i < side; i++) bits.push(matrix.get(positions[side - 1 - i], center + offset));
|
|
199
|
+
for (let i = 0; i < side; i++) bits.push(matrix.get(center - offset, positions[side - 1 - i]));
|
|
200
|
+
return bits;
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
/** @param {boolean[]} bits @param {boolean} compact */
|
|
204
|
+
function decodeModeMessage(bits, compact) {
|
|
205
|
+
const total = compact ? 7 : 10;
|
|
206
|
+
const dataWords = compact ? 2 : 4;
|
|
207
|
+
const words = new Array(total);
|
|
208
|
+
for (let i = 0; i < total; i++) words[i] = readBits(bits, i * 4, 4);
|
|
209
|
+
const corrections = rsDecode(words, total - dataWords, fieldForWordSize(4), 1);
|
|
210
|
+
let data = 0;
|
|
211
|
+
for (let i = 0; i < dataWords; i++) data = (data << 4) | words[i];
|
|
212
|
+
const layers = compact ? (data >>> 6) + 1 : (data >>> 11) + 1;
|
|
213
|
+
const dataCodewords = compact ? (data & 0x3f) + 1 : (data & 0x7ff) + 1;
|
|
214
|
+
return { layers, dataCodewords, corrections };
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
/** @param {boolean} compact @param {number} layers */
|
|
218
|
+
function totalBitsInLayers(compact, layers) {
|
|
219
|
+
return ((compact ? 88 : 112) + 16 * layers) * layers;
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* Extract raw, stuffed codeword bits in logical ring order.
|
|
224
|
+
* @param {import('../core/bit-matrix.js').BitMatrix} matrix
|
|
225
|
+
* @param {boolean} compact @param {number} layers
|
|
226
|
+
* @returns {boolean[]}
|
|
227
|
+
*/
|
|
228
|
+
function extractBits(matrix, compact, layers) {
|
|
229
|
+
const baseSize = (compact ? 11 : 14) + layers * 4;
|
|
230
|
+
const map = alignmentMap(compact, layers);
|
|
231
|
+
const raw = new Array(totalBitsInLayers(compact, layers));
|
|
232
|
+
let offset = 0;
|
|
233
|
+
for (let layer = 0; layer < layers; layer++) {
|
|
234
|
+
const rowSize = (layers - layer) * 4 + (compact ? 9 : 12);
|
|
235
|
+
for (let j = 0; j < rowSize; j++) {
|
|
236
|
+
const col = j * 2;
|
|
237
|
+
for (let k = 0; k < 2; k++) {
|
|
238
|
+
raw[offset + col + k] = matrix.get(map[layer * 2 + k], map[layer * 2 + j]);
|
|
239
|
+
raw[offset + rowSize * 2 + col + k] = matrix.get(map[layer * 2 + j], map[baseSize - 1 - layer * 2 - k]);
|
|
240
|
+
raw[offset + rowSize * 4 + col + k] = matrix.get(map[baseSize - 1 - layer * 2 - k], map[baseSize - 1 - layer * 2 - j]);
|
|
241
|
+
raw[offset + rowSize * 6 + col + k] = matrix.get(map[baseSize - 1 - layer * 2 - j], map[layer * 2 + k]);
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
offset += rowSize * 8;
|
|
245
|
+
}
|
|
246
|
+
return raw;
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
/** @param {boolean[]} raw @param {number} layers @param {number} dataCodewords */
|
|
250
|
+
function correctAndUnstuff(raw, layers, dataCodewords) {
|
|
251
|
+
const wordSize = aztecWordSizeForLayers(layers);
|
|
252
|
+
const totalWords = Math.floor(raw.length / wordSize);
|
|
253
|
+
if (dataCodewords <= 0 || dataCodewords > totalWords) throw new FormatError('Aztec: invalid data word count');
|
|
254
|
+
const start = raw.length % wordSize;
|
|
255
|
+
const words = new Array(totalWords);
|
|
256
|
+
for (let i = 0; i < totalWords; i++) words[i] = readBits(raw, start + i * wordSize, wordSize);
|
|
257
|
+
const corrections = rsDecode(words, totalWords - dataCodewords, aztecFieldForLayers(layers), 1);
|
|
258
|
+
const mask = (1 << wordSize) - 1;
|
|
259
|
+
const corrected = [];
|
|
260
|
+
for (let i = 0; i < dataCodewords; i++) {
|
|
261
|
+
const word = words[i];
|
|
262
|
+
if (word === 0 || word === mask) throw new FormatError('Aztec: invalid stuffed codeword');
|
|
263
|
+
if (word === 1 || word === mask - 1) {
|
|
264
|
+
for (let j = 0; j < wordSize - 1; j++) corrected.push(word === mask - 1);
|
|
265
|
+
} else {
|
|
266
|
+
appendBits(word, wordSize, corrected);
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
return { bits: corrected, corrections };
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
/** @param {Uint8Array} bytes */
|
|
273
|
+
function bytesToText(bytes) {
|
|
274
|
+
try { return new TextDecoder('utf-8', { fatal: true }).decode(bytes); }
|
|
275
|
+
catch { return new TextDecoder('latin1').decode(bytes); }
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* Decode a square Aztec symbol with one bit per module and no quiet zone.
|
|
280
|
+
* The matrix must already be oriented with the mode message at the top.
|
|
281
|
+
*
|
|
282
|
+
* @param {import('../core/bit-matrix.js').BitMatrix} matrix
|
|
283
|
+
* @returns {{text: string, bytes: Uint8Array, compact: boolean, layers: number, corrections: number, eccPercent: number}}
|
|
284
|
+
*/
|
|
285
|
+
export function decodeAztec(matrix) {
|
|
286
|
+
if (!matrix || matrix.width !== matrix.height) throw new FormatError('Aztec: expected a square BitMatrix');
|
|
287
|
+
let compact;
|
|
288
|
+
let mode;
|
|
289
|
+
// Compact and full dimensions are disjoint; trying both also makes malformed
|
|
290
|
+
// candidate handling deterministic for the future image detector.
|
|
291
|
+
for (const candidate of [true, false]) {
|
|
292
|
+
try {
|
|
293
|
+
const value = decodeModeMessage(readModeBits(matrix, candidate), candidate);
|
|
294
|
+
if (value.layers < 1 || value.layers > (candidate ? 4 : 32)) continue;
|
|
295
|
+
if (aztecMatrixSize(value.layers, candidate) !== matrix.width) continue;
|
|
296
|
+
compact = candidate;
|
|
297
|
+
mode = value;
|
|
298
|
+
break;
|
|
299
|
+
} catch { /* Try the other family. */ }
|
|
300
|
+
}
|
|
301
|
+
if (compact === undefined || !mode) throw new FormatError('Aztec: invalid mode message or dimensions');
|
|
302
|
+
// Ensure the declared layer data agrees with the table module, so a future
|
|
303
|
+
// tables refactor cannot silently make decoder capacity calculations stale.
|
|
304
|
+
aztecSymbolForLayers(mode.layers, compact);
|
|
305
|
+
const raw = extractBits(matrix, compact, mode.layers);
|
|
306
|
+
const payload = correctAndUnstuff(raw, mode.layers, mode.dataCodewords);
|
|
307
|
+
const bytes = decodeHighLevelBits(payload.bits);
|
|
308
|
+
const totalWords = Math.floor(raw.length / aztecWordSizeForLayers(mode.layers));
|
|
309
|
+
return {
|
|
310
|
+
text: bytesToText(bytes),
|
|
311
|
+
bytes,
|
|
312
|
+
compact,
|
|
313
|
+
layers: mode.layers,
|
|
314
|
+
corrections: mode.corrections + payload.corrections,
|
|
315
|
+
eccPercent: Math.round(((totalWords - mode.dataCodewords) * 100) / totalWords),
|
|
316
|
+
};
|
|
317
|
+
}
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Sythos Barcode Suite
|
|
3
|
+
*
|
|
4
|
+
* MIT License
|
|
5
|
+
*
|
|
6
|
+
* Copyright (c) 2026 Sythos
|
|
7
|
+
*
|
|
8
|
+
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
9
|
+
* of this software and associated documentation files (the "Software"), to deal
|
|
10
|
+
* in the Software without restriction, including without limitation the rights
|
|
11
|
+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
12
|
+
* copies of the Software, and to permit persons to whom the Software is
|
|
13
|
+
* furnished to do so, subject to the following conditions:
|
|
14
|
+
*
|
|
15
|
+
* The above copyright notice and this permission notice shall be included in all
|
|
16
|
+
* copies or substantial portions of the Software.
|
|
17
|
+
*
|
|
18
|
+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
19
|
+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
20
|
+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
21
|
+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
22
|
+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
23
|
+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
24
|
+
* SOFTWARE.
|
|
25
|
+
*
|
|
26
|
+
* SPDX-License-Identifier: MIT
|
|
27
|
+
*
|
|
28
|
+
* Original work. No code from any other barcode implementation.
|
|
29
|
+
*/
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Aztec image detection.
|
|
33
|
+
*
|
|
34
|
+
* Aztec has no finder pattern at its outer border. Its reliable geometric
|
|
35
|
+
* anchor is instead the alternating square bull's-eye in the centre: five
|
|
36
|
+
* rings in Compact symbols, seven rings in Full symbols. The detector finds
|
|
37
|
+
* isolated central modules, verifies those rings at module centres, then
|
|
38
|
+
* samples each legal symbol dimension. The decoder is deliberately the final
|
|
39
|
+
* arbiter: its mode-message Reed--Solomon check rejects accidental concentric
|
|
40
|
+
* artwork and tells us which of the compact/full dimensions is real.
|
|
41
|
+
*
|
|
42
|
+
* Sampling uses a quadrilateral, not a cropped bitmap, so the detected
|
|
43
|
+
* rotation is corrected before decoding. The ring search covers arbitrary
|
|
44
|
+
* in-plane rotations (four-degree coarse search; at normal camera scales its
|
|
45
|
+
* positional error remains well inside a module). The optional inverse pass
|
|
46
|
+
* supports light modules on a dark field.
|
|
47
|
+
*
|
|
48
|
+
* @module aztec/detector
|
|
49
|
+
*/
|
|
50
|
+
|
|
51
|
+
import { NotFoundError } from '../core/errors.js';
|
|
52
|
+
import { sampleQuad } from '../image/grid-sampler.js';
|
|
53
|
+
import { decodeAztec } from './decoder.js';
|
|
54
|
+
|
|
55
|
+
/** @typedef {{x:number, y:number}} Point */
|
|
56
|
+
/** @typedef {{corners: Point[], dimension: number, compact: boolean, moduleSize: number, matrix: import('../core/bit-matrix.js').BitMatrix}} Detection */
|
|
57
|
+
|
|
58
|
+
// Compact: 11 + 4 layers. Full symbols add reference-grid rows/columns every
|
|
59
|
+
// 15 modules measured from their central 14-module base, not every 15 layers.
|
|
60
|
+
const DIMENSIONS = [
|
|
61
|
+
...[1, 2, 3, 4].map((layers) => ({ compact: true, dimension: 11 + 4 * layers })),
|
|
62
|
+
...Array.from({ length: 32 }, (_, index) => {
|
|
63
|
+
const layers = index + 1;
|
|
64
|
+
return { compact: false, dimension: 15 + 4 * layers + 2 * Math.floor((2 * layers + 6) / 15) };
|
|
65
|
+
}),
|
|
66
|
+
];
|
|
67
|
+
|
|
68
|
+
function pixel(image, x, y) {
|
|
69
|
+
const ix = Math.round(x);
|
|
70
|
+
const iy = Math.round(y);
|
|
71
|
+
return ix >= 0 && iy >= 0 && ix < image.width && iy < image.height && image.get(ix, iy);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
/** Connected components of either polarity, retaining only plausible modules. */
|
|
75
|
+
function components(image, value) {
|
|
76
|
+
const seen = new Uint8Array(image.width * image.height);
|
|
77
|
+
const out = [];
|
|
78
|
+
const maximumArea = Math.max(4, Math.floor(image.width * image.height * 0.08));
|
|
79
|
+
for (let y = 0; y < image.height; y++) for (let x = 0; x < image.width; x++) {
|
|
80
|
+
const start = y * image.width + x;
|
|
81
|
+
if (seen[start] || image.get(x, y) !== value) continue;
|
|
82
|
+
const xs = [x];
|
|
83
|
+
const ys = [y];
|
|
84
|
+
seen[start] = 1;
|
|
85
|
+
let head = 0;
|
|
86
|
+
let minX = x; let maxX = x; let minY = y; let maxY = y;
|
|
87
|
+
while (head < xs.length) {
|
|
88
|
+
const px = xs[head]; const py = ys[head++];
|
|
89
|
+
if (px < minX) minX = px; if (px > maxX) maxX = px;
|
|
90
|
+
if (py < minY) minY = py; if (py > maxY) maxY = py;
|
|
91
|
+
for (const [nx, ny] of [[px - 1, py], [px + 1, py], [px, py - 1], [px, py + 1]]) {
|
|
92
|
+
if (nx < 0 || ny < 0 || nx >= image.width || ny >= image.height) continue;
|
|
93
|
+
const at = ny * image.width + nx;
|
|
94
|
+
if (!seen[at] && image.get(nx, ny) === value) {
|
|
95
|
+
seen[at] = 1; xs.push(nx); ys.push(ny);
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
const width = maxX - minX + 1;
|
|
100
|
+
const height = maxY - minY + 1;
|
|
101
|
+
const area = width * height;
|
|
102
|
+
// The central module is solid and approximately square. This filter is
|
|
103
|
+
// intentionally permissive because a rotated raster module is diamond-ish.
|
|
104
|
+
if (xs.length <= maximumArea && Math.abs(width - height) <= Math.max(1, Math.ceil(Math.max(width, height) * 0.35)) &&
|
|
105
|
+
xs.length >= area * 0.45) {
|
|
106
|
+
out.push({ x: (minX + maxX) / 2, y: (minY + maxY) / 2, width, height, pixels: xs.length });
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
return out.sort((a, b) => b.pixels - a.pixels).slice(0, 2000);
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
function expectedDark(ring, inverted) {
|
|
113
|
+
return inverted ? (ring & 1) === 1 : (ring & 1) === 0;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/** Score one square bull's-eye at an angle and a candidate module pitch. */
|
|
117
|
+
function ringScore(image, centre, pitch, angle, inverted, rings) {
|
|
118
|
+
const cos = Math.cos(angle);
|
|
119
|
+
const sin = Math.sin(angle);
|
|
120
|
+
let correct = 0;
|
|
121
|
+
let total = 0;
|
|
122
|
+
for (let ring = 0; ring < rings; ring++) {
|
|
123
|
+
const wanted = expectedDark(ring, inverted);
|
|
124
|
+
for (let j = -ring; j <= ring; j++) for (let i = -ring; i <= ring; i++) {
|
|
125
|
+
if (ring && Math.abs(i) !== ring && Math.abs(j) !== ring) continue;
|
|
126
|
+
const x = centre.x + (i * cos - j * sin) * pitch;
|
|
127
|
+
const y = centre.y + (i * sin + j * cos) * pitch;
|
|
128
|
+
if (pixel(image, x, y) === wanted) correct++;
|
|
129
|
+
total++;
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
return correct / total;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
function rotateCorners(corners, turn) {
|
|
136
|
+
return corners.slice(turn).concat(corners.slice(0, turn));
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
function invert(matrix) {
|
|
140
|
+
const out = matrix.clone();
|
|
141
|
+
for (let y = 0; y < out.height; y++) for (let x = 0; x < out.width; x++) out.flip(x, y);
|
|
142
|
+
return out;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
function cornersFor(centre, pitch, angle, dimension) {
|
|
146
|
+
const half = dimension * pitch / 2;
|
|
147
|
+
const cos = Math.cos(angle);
|
|
148
|
+
const sin = Math.sin(angle);
|
|
149
|
+
const point = (x, y) => ({ x: centre.x + x * cos - y * sin, y: centre.y + x * sin + y * cos });
|
|
150
|
+
return [point(-half, -half), point(half, -half), point(half, half), point(-half, half)];
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* Find an Aztec symbol in a binarized image.
|
|
155
|
+
*
|
|
156
|
+
* The returned matrix is in the orientation accepted by the Aztec decoder.
|
|
157
|
+
* A valid mode message is required before a geometric candidate is returned,
|
|
158
|
+
* making false positives from decorative concentric squares very unlikely.
|
|
159
|
+
*
|
|
160
|
+
* @param {import('../core/bit-matrix.js').BitMatrix} binaryImage Set bit = dark.
|
|
161
|
+
* @returns {Detection | null}
|
|
162
|
+
*/
|
|
163
|
+
export function detectAztec(binaryImage) {
|
|
164
|
+
if (!binaryImage || !binaryImage.width || !binaryImage.height) {
|
|
165
|
+
throw new NotFoundError('detectAztec: no image supplied');
|
|
166
|
+
}
|
|
167
|
+
const candidates = [];
|
|
168
|
+
for (const inverted of [false, true]) {
|
|
169
|
+
for (const core of components(binaryImage, !inverted)) {
|
|
170
|
+
// A non-rotated one-module component directly gives its pitch. For
|
|
171
|
+
// rotated modules its bounding box grows by |sin| + |cos|, compensated
|
|
172
|
+
// below for every tested angle.
|
|
173
|
+
for (let degrees = 0; degrees < 180; degrees += 4) {
|
|
174
|
+
const angle = degrees * Math.PI / 180;
|
|
175
|
+
const scale = Math.abs(Math.cos(angle)) + Math.abs(Math.sin(angle));
|
|
176
|
+
const pitch = ((core.width + core.height) / 2) / scale;
|
|
177
|
+
if (pitch < 0.8) continue;
|
|
178
|
+
// Test Full first: its seven rings also exclude Compact candidates.
|
|
179
|
+
const fullScore = ringScore(binaryImage, core, pitch, angle, inverted, 7);
|
|
180
|
+
const rings = fullScore >= 0.88 ? 7 : 5;
|
|
181
|
+
const score = rings === 7 ? fullScore : ringScore(binaryImage, core, pitch, angle, inverted, 5);
|
|
182
|
+
if (score < 0.91) continue;
|
|
183
|
+
const symbolKinds = rings === 7 ? DIMENSIONS.filter((item) => !item.compact) : DIMENSIONS.filter((item) => item.compact);
|
|
184
|
+
for (const kind of symbolKinds) {
|
|
185
|
+
const baseCorners = cornersFor(core, pitch, angle, kind.dimension);
|
|
186
|
+
for (let turn = 0; turn < 4; turn++) {
|
|
187
|
+
const corners = rotateCorners(baseCorners, turn);
|
|
188
|
+
let matrix;
|
|
189
|
+
try { matrix = sampleQuad(binaryImage, kind.dimension, corners); } catch (e) { continue; }
|
|
190
|
+
if (inverted) matrix = invert(matrix);
|
|
191
|
+
try {
|
|
192
|
+
// The decoder verifies the mode-message ECC and exact geometry.
|
|
193
|
+
// We do not expose its result here so callers can use pure
|
|
194
|
+
// detection without treating payload decoding as an API contract.
|
|
195
|
+
decodeAztec(matrix);
|
|
196
|
+
candidates.push({ corners, dimension: kind.dimension, compact: kind.compact,
|
|
197
|
+
moduleSize: pitch, matrix, score });
|
|
198
|
+
} catch (e) { /* Not an Aztec mode message at this dimension. */ }
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
candidates.sort((a, b) => b.score - a.score || b.moduleSize - a.moduleSize);
|
|
205
|
+
const best = candidates[0];
|
|
206
|
+
if (!best) return null;
|
|
207
|
+
delete best.score;
|
|
208
|
+
return best;
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* Detect then decode an Aztec symbol. Detection failure is a normal result for
|
|
213
|
+
* images without an Aztec code, therefore invalid candidates return null.
|
|
214
|
+
*
|
|
215
|
+
* @param {import('../core/bit-matrix.js').BitMatrix} binaryImage
|
|
216
|
+
* @returns {(import('./decoder.js').DecodeResult & {corners: Point[]}) | null}
|
|
217
|
+
*/
|
|
218
|
+
export function detectAndDecodeAztec(binaryImage) {
|
|
219
|
+
let detection;
|
|
220
|
+
try { detection = detectAztec(binaryImage); } catch (e) { return null; }
|
|
221
|
+
if (!detection) return null;
|
|
222
|
+
try { return Object.assign({ corners: detection.corners }, decodeAztec(detection.matrix)); }
|
|
223
|
+
catch (e) { return null; }
|
|
224
|
+
}
|