Debian Codegraph @

src/Common/Version.php

raw
1 <?php
2 declare(strict_types = 1);
3
4 namespace BaconQrCode\Common;
5
6 use BaconQrCode\Exception\InvalidArgumentException;
7 use SplFixedArray;
8
9 /**
10 * Version representation.
11 */
12 final class Version
13 {
14 private const VERSION_DECODE_INFO = [
15 0x07c94,
16 0x085bc,
17 0x09a99,
18 0x0a4d3,
19 0x0bbf6,
20 0x0c762,
21 0x0d847,
22 0x0e60d,
23 0x0f928,
24 0x10b78,
25 0x1145d,
26 0x12a17,
27 0x13532,
28 0x149a6,
29 0x15683,
30 0x168c9,
31 0x177ec,
32 0x18ec4,
33 0x191e1,
34 0x1afab,
35 0x1b08e,
36 0x1cc1a,
37 0x1d33f,
38 0x1ed75,
39 0x1f250,
40 0x209d5,
41 0x216f0,
42 0x228ba,
43 0x2379f,
44 0x24b0b,
45 0x2542e,
46 0x26a64,
47 0x27541,
48 0x28c69,
49 ];
50
51 /**
52 * Version number of this version.
53 */
54 private int $versionNumber;
55
56 /**
57 * Alignment pattern centers.
58 *
59 * @var SplFixedArray|array
60 */
61 private SplFixedArray|array $alignmentPatternCenters;
62
63 /**
64 * Error correction blocks.
65 *
66 * @var EcBlocks[]
67 */
68 private array $ecBlocks;
69
70 /**
71 * Total number of codewords.
72 */
73 private null|int|float $totalCodewords;
74
75 /**
76 * Cached version instances.
77 *
78 * @var array<int, self>|null
79 */
80 private static ?array $versions = null;
81
82 /**
83 * @param int[] $alignmentPatternCenters
84 */
85 private function __construct(
86 int $versionNumber,
87 array $alignmentPatternCenters,
88 EcBlocks ...$ecBlocks
89 ) {
90 $this->versionNumber = $versionNumber;
91 $this->alignmentPatternCenters = $alignmentPatternCenters;
92 $this->ecBlocks = $ecBlocks;
93
94 $totalCodewords = 0;
95 $ecCodewords = $ecBlocks[0]->getEcCodewordsPerBlock();
96
97 foreach ($ecBlocks[0]->getEcBlocks() as $ecBlock) {
98 $totalCodewords += $ecBlock->getCount() * ($ecBlock->getDataCodewords() + $ecCodewords);
99 }
100
101 $this->totalCodewords = $totalCodewords;
102 }
103
104 /**
105 * Returns the version number.
106 */
107 public function getVersionNumber() : int
108 {
109 return $this->versionNumber;
110 }
111
112 /**
113 * Returns the alignment pattern centers.
114 *
115 * @return int[]
116 */
117 public function getAlignmentPatternCenters() : array
118 {
119 return $this->alignmentPatternCenters;
120 }
121
122 /**
123 * Returns the total number of codewords.
124 */
125 public function getTotalCodewords() : int
126 {
127 return $this->totalCodewords;
128 }
129
130 /**
131 * Calculates the dimension for the current version.
132 */
133 public function getDimensionForVersion() : int
134 {
135 return 17 + 4 * $this->versionNumber;
136 }
137
138 /**
139 * Returns the number of EC blocks for a specific EC level.
140 */
141 public function getEcBlocksForLevel(ErrorCorrectionLevel $ecLevel) : EcBlocks
142 {
143 return $this->ecBlocks[$ecLevel->ordinal()];
144 }
145
146 /**
147 * Gets a provisional version number for a specific dimension.
148 *
149 * @throws InvalidArgumentException if dimension is not 1 mod 4
150 */
151 public static function getProvisionalVersionForDimension(int $dimension) : self
152 {
153 if (1 !== $dimension % 4) {
154 throw new InvalidArgumentException('Dimension is not 1 mod 4');
155 }
156
157 return self::getVersionForNumber(intdiv($dimension - 17, 4));
158 }
159
160 /**
161 * Gets a version instance for a specific version number.
162 *
163 * @throws InvalidArgumentException if version number is out of range
164 */
165 public static function getVersionForNumber(int $versionNumber) : self
166 {
167 if ($versionNumber < 1 || $versionNumber > 40) {
168 throw new InvalidArgumentException('Version number must be between 1 and 40');
169 }
170
171 return self::versions()[$versionNumber - 1];
172 }
173
174 /**
175 * Decodes version information from an integer and returns the version.
176 */
177 public static function decodeVersionInformation(int $versionBits) : ?self
178 {
179 $bestDifference = PHP_INT_MAX;
180 $bestVersion = 0;
181
182 foreach (self::VERSION_DECODE_INFO as $i => $targetVersion) {
183 if ($targetVersion === $versionBits) {
184 return self::getVersionForNumber($i + 7);
185 }
186
187 $bitsDifference = FormatInformation::numBitsDiffering($versionBits, $targetVersion);
188
189 if ($bitsDifference < $bestDifference) {
190 $bestVersion = $i + 7;
191 $bestDifference = $bitsDifference;
192 }
193 }
194
195 if ($bestDifference <= 3) {
196 return self::getVersionForNumber($bestVersion);
197 }
198
199 return null;
200 }
201
202 /**
203 * Builds the function pattern for the current version.
204 */
205 public function buildFunctionPattern() : BitMatrix
206 {
207 $dimension = $this->getDimensionForVersion();
208 $bitMatrix = new BitMatrix($dimension);
209
210 // Top left finder pattern + separator + format
211 $bitMatrix->setRegion(0, 0, 9, 9);
212 // Top right finder pattern + separator + format
213 $bitMatrix->setRegion($dimension - 8, 0, 8, 9);
214 // Bottom left finder pattern + separator + format
215 $bitMatrix->setRegion(0, $dimension - 8, 9, 8);
216
217 // Alignment patterns
218 $max = count($this->alignmentPatternCenters);
219
220 for ($x = 0; $x < $max; ++$x) {
221 $i = $this->alignmentPatternCenters[$x] - 2;
222
223 for ($y = 0; $y < $max; ++$y) {
224 if (($x === 0 && ($y === 0 || $y === $max - 1)) || ($x === $max - 1 && $y === 0)) {
225 // No alignment patterns near the three finder paterns
226 continue;
227 }
228
229 $bitMatrix->setRegion($this->alignmentPatternCenters[$y] - 2, $i, 5, 5);
230 }
231 }
232
233 // Vertical timing pattern
234 $bitMatrix->setRegion(6, 9, 1, $dimension - 17);
235 // Horizontal timing pattern
236 $bitMatrix->setRegion(9, 6, $dimension - 17, 1);
237
238 if ($this->versionNumber > 6) {
239 // Version info, top right
240 $bitMatrix->setRegion($dimension - 11, 0, 3, 6);
241 // Version info, bottom left
242 $bitMatrix->setRegion(0, $dimension - 11, 6, 3);
243 }
244
245 return $bitMatrix;
246 }
247
248 /**
249 * Returns a string representation for the version.
250 */
251 public function __toString() : string
252 {
253 return (string) $this->versionNumber;
254 }
255
256 /**
257 * Build and cache a specific version.
258 *
259 * See ISO 18004:2006 6.5.1 Table 9.
260 *
261 * @return array<int, self>
262 */
263 private static function versions() : array
264 {
265 if (null !== self::$versions) {
266 return self::$versions;
267 }
268
269 return self::$versions = [
270 new self(
271 1,
272 [],
273 new EcBlocks(7, new EcBlock(1, 19)),
274 new EcBlocks(10, new EcBlock(1, 16)),
275 new EcBlocks(13, new EcBlock(1, 13)),
276 new EcBlocks(17, new EcBlock(1, 9))
277 ),
278 new self(
279 2,
280 [6, 18],
281 new EcBlocks(10, new EcBlock(1, 34)),
282 new EcBlocks(16, new EcBlock(1, 28)),
283 new EcBlocks(22, new EcBlock(1, 22)),
284 new EcBlocks(28, new EcBlock(1, 16))
285 ),
286 new self(
287 3,
288 [6, 22],
289 new EcBlocks(15, new EcBlock(1, 55)),
290 new EcBlocks(26, new EcBlock(1, 44)),
291 new EcBlocks(18, new EcBlock(2, 17)),
292 new EcBlocks(22, new EcBlock(2, 13))
293 ),
294 new self(
295 4,
296 [6, 26],
297 new EcBlocks(20, new EcBlock(1, 80)),
298 new EcBlocks(18, new EcBlock(2, 32)),
299 new EcBlocks(26, new EcBlock(2, 24)),
300 new EcBlocks(16, new EcBlock(4, 9))
301 ),
302 new self(
303 5,
304 [6, 30],
305 new EcBlocks(26, new EcBlock(1, 108)),
306 new EcBlocks(24, new EcBlock(2, 43)),
307 new EcBlocks(18, new EcBlock(2, 15), new EcBlock(2, 16)),
308 new EcBlocks(22, new EcBlock(2, 11), new EcBlock(2, 12))
309 ),
310 new self(
311 6,
312 [6, 34],
313 new EcBlocks(18, new EcBlock(2, 68)),
314 new EcBlocks(16, new EcBlock(4, 27)),
315 new EcBlocks(24, new EcBlock(4, 19)),
316 new EcBlocks(28, new EcBlock(4, 15))
317 ),
318 new self(
319 7,
320 [6, 22, 38],
321 new EcBlocks(20, new EcBlock(2, 78)),
322 new EcBlocks(18, new EcBlock(4, 31)),
323 new EcBlocks(18, new EcBlock(2, 14), new EcBlock(4, 15)),
324 new EcBlocks(26, new EcBlock(4, 13), new EcBlock(1, 14))
325 ),
326 new self(
327 8,
328 [6, 24, 42],
329 new EcBlocks(24, new EcBlock(2, 97)),
330 new EcBlocks(22, new EcBlock(2, 38), new EcBlock(2, 39)),
331 new EcBlocks(22, new EcBlock(4, 18), new EcBlock(2, 19)),
332 new EcBlocks(26, new EcBlock(4, 14), new EcBlock(2, 15))
333 ),
334 new self(
335 9,
336 [6, 26, 46],
337 new EcBlocks(30, new EcBlock(2, 116)),
338 new EcBlocks(22, new EcBlock(3, 36), new EcBlock(2, 37)),
339 new EcBlocks(20, new EcBlock(4, 16), new EcBlock(4, 17)),
340 new EcBlocks(24, new EcBlock(4, 12), new EcBlock(4, 13))
341 ),
342 new self(
343 10,
344 [6, 28, 50],
345 new EcBlocks(18, new EcBlock(2, 68), new EcBlock(2, 69)),
346 new EcBlocks(26, new EcBlock(4, 43), new EcBlock(1, 44)),
347 new EcBlocks(24, new EcBlock(6, 19), new EcBlock(2, 20)),
348 new EcBlocks(28, new EcBlock(6, 15), new EcBlock(2, 16))
349 ),
350 new self(
351 11,
352 [6, 30, 54],
353 new EcBlocks(20, new EcBlock(4, 81)),
354 new EcBlocks(30, new EcBlock(1, 50), new EcBlock(4, 51)),
355 new EcBlocks(28, new EcBlock(4, 22), new EcBlock(4, 23)),
356 new EcBlocks(24, new EcBlock(3, 12), new EcBlock(8, 13))
357 ),
358 new self(
359 12,
360 [6, 32, 58],
361 new EcBlocks(24, new EcBlock(2, 92), new EcBlock(2, 93)),
362 new EcBlocks(22, new EcBlock(6, 36), new EcBlock(2, 37)),
363 new EcBlocks(26, new EcBlock(4, 20), new EcBlock(6, 21)),
364 new EcBlocks(28, new EcBlock(7, 14), new EcBlock(4, 15))
365 ),
366 new self(
367 13,
368 [6, 34, 62],
369 new EcBlocks(26, new EcBlock(4, 107)),
370 new EcBlocks(22, new EcBlock(8, 37), new EcBlock(1, 38)),
371 new EcBlocks(24, new EcBlock(8, 20), new EcBlock(4, 21)),
372 new EcBlocks(22, new EcBlock(12, 11), new EcBlock(4, 12))
373 ),
374 new self(
375 14,
376 [6, 26, 46, 66],
377 new EcBlocks(30, new EcBlock(3, 115), new EcBlock(1, 116)),
378 new EcBlocks(24, new EcBlock(4, 40), new EcBlock(5, 41)),
379 new EcBlocks(20, new EcBlock(11, 16), new EcBlock(5, 17)),
380 new EcBlocks(24, new EcBlock(11, 12), new EcBlock(5, 13))
381 ),
382 new self(
383 15,
384 [6, 26, 48, 70],
385 new EcBlocks(22, new EcBlock(5, 87), new EcBlock(1, 88)),
386 new EcBlocks(24, new EcBlock(5, 41), new EcBlock(5, 42)),
387 new EcBlocks(30, new EcBlock(5, 24), new EcBlock(7, 25)),
388 new EcBlocks(24, new EcBlock(11, 12), new EcBlock(7, 13))
389 ),
390 new self(
391 16,
392 [6, 26, 50, 74],
393 new EcBlocks(24, new EcBlock(5, 98), new EcBlock(1, 99)),
394 new EcBlocks(28, new EcBlock(7, 45), new EcBlock(3, 46)),
395 new EcBlocks(24, new EcBlock(15, 19), new EcBlock(2, 20)),
396 new EcBlocks(30, new EcBlock(3, 15), new EcBlock(13, 16))
397 ),
398 new self(
399 17,
400 [6, 30, 54, 78],
401 new EcBlocks(28, new EcBlock(1, 107), new EcBlock(5, 108)),
402 new EcBlocks(28, new EcBlock(10, 46), new EcBlock(1, 47)),
403 new EcBlocks(28, new EcBlock(1, 22), new EcBlock(15, 23)),
404 new EcBlocks(28, new EcBlock(2, 14), new EcBlock(17, 15))
405 ),
406 new self(
407 18,
408 [6, 30, 56, 82],
409 new EcBlocks(30, new EcBlock(5, 120), new EcBlock(1, 121)),
410 new EcBlocks(26, new EcBlock(9, 43), new EcBlock(4, 44)),
411 new EcBlocks(28, new EcBlock(17, 22), new EcBlock(1, 23)),
412 new EcBlocks(28, new EcBlock(2, 14), new EcBlock(19, 15))
413 ),
414 new self(
415 19,
416 [6, 30, 58, 86],
417 new EcBlocks(28, new EcBlock(3, 113), new EcBlock(4, 114)),
418 new EcBlocks(26, new EcBlock(3, 44), new EcBlock(11, 45)),
419 new EcBlocks(26, new EcBlock(17, 21), new EcBlock(4, 22)),
420 new EcBlocks(26, new EcBlock(9, 13), new EcBlock(16, 14))
421 ),
422 new self(
423 20,
424 [6, 34, 62, 90],
425 new EcBlocks(28, new EcBlock(3, 107), new EcBlock(5, 108)),
426 new EcBlocks(26, new EcBlock(3, 41), new EcBlock(13, 42)),
427 new EcBlocks(30, new EcBlock(15, 24), new EcBlock(5, 25)),
428 new EcBlocks(28, new EcBlock(15, 15), new EcBlock(10, 16))
429 ),
430 new self(
431 21,
432 [6, 28, 50, 72, 94],
433 new EcBlocks(28, new EcBlock(4, 116), new EcBlock(4, 117)),
434 new EcBlocks(26, new EcBlock(17, 42)),
435 new EcBlocks(28, new EcBlock(17, 22), new EcBlock(6, 23)),
436 new EcBlocks(30, new EcBlock(19, 16), new EcBlock(6, 17))
437 ),
438 new self(
439 22,
440 [6, 26, 50, 74, 98],
441 new EcBlocks(28, new EcBlock(2, 111), new EcBlock(7, 112)),
442 new EcBlocks(28, new EcBlock(17, 46)),
443 new EcBlocks(30, new EcBlock(7, 24), new EcBlock(16, 25)),
444 new EcBlocks(24, new EcBlock(34, 13))
445 ),
446 new self(
447 23,
448 [6, 30, 54, 78, 102],
449 new EcBlocks(30, new EcBlock(4, 121), new EcBlock(5, 122)),
450 new EcBlocks(28, new EcBlock(4, 47), new EcBlock(14, 48)),
451 new EcBlocks(30, new EcBlock(11, 24), new EcBlock(14, 25)),
452 new EcBlocks(30, new EcBlock(16, 15), new EcBlock(14, 16))
453 ),
454 new self(
455 24,
456 [6, 28, 54, 80, 106],
457 new EcBlocks(30, new EcBlock(6, 117), new EcBlock(4, 118)),
458 new EcBlocks(28, new EcBlock(6, 45), new EcBlock(14, 46)),
459 new EcBlocks(30, new EcBlock(11, 24), new EcBlock(16, 25)),
460 new EcBlocks(30, new EcBlock(30, 16), new EcBlock(2, 17))
461 ),
462 new self(
463 25,
464 [6, 32, 58, 84, 110],
465 new EcBlocks(26, new EcBlock(8, 106), new EcBlock(4, 107)),
466 new EcBlocks(28, new EcBlock(8, 47), new EcBlock(13, 48)),
467 new EcBlocks(30, new EcBlock(7, 24), new EcBlock(22, 25)),
468 new EcBlocks(30, new EcBlock(22, 15), new EcBlock(13, 16))
469 ),
470 new self(
471 26,
472 [6, 30, 58, 86, 114],
473 new EcBlocks(28, new EcBlock(10, 114), new EcBlock(2, 115)),
474 new EcBlocks(28, new EcBlock(19, 46), new EcBlock(4, 47)),
475 new EcBlocks(28, new EcBlock(28, 22), new EcBlock(6, 23)),
476 new EcBlocks(30, new EcBlock(33, 16), new EcBlock(4, 17))
477 ),
478 new self(
479 27,
480 [6, 34, 62, 90, 118],
481 new EcBlocks(30, new EcBlock(8, 122), new EcBlock(4, 123)),
482 new EcBlocks(28, new EcBlock(22, 45), new EcBlock(3, 46)),
483 new EcBlocks(30, new EcBlock(8, 23), new EcBlock(26, 24)),
484 new EcBlocks(30, new EcBlock(12, 15), new EcBlock(28, 16))
485 ),
486 new self(
487 28,
488 [6, 26, 50, 74, 98, 122],
489 new EcBlocks(30, new EcBlock(3, 117), new EcBlock(10, 118)),
490 new EcBlocks(28, new EcBlock(3, 45), new EcBlock(23, 46)),
491 new EcBlocks(30, new EcBlock(4, 24), new EcBlock(31, 25)),
492 new EcBlocks(30, new EcBlock(11, 15), new EcBlock(31, 16))
493 ),
494 new self(
495 29,
496 [6, 30, 54, 78, 102, 126],
497 new EcBlocks(30, new EcBlock(7, 116), new EcBlock(7, 117)),
498 new EcBlocks(28, new EcBlock(21, 45), new EcBlock(7, 46)),
499 new EcBlocks(30, new EcBlock(1, 23), new EcBlock(37, 24)),
500 new EcBlocks(30, new EcBlock(19, 15), new EcBlock(26, 16))
501 ),
502 new self(
503 30,
504 [6, 26, 52, 78, 104, 130],
505 new EcBlocks(30, new EcBlock(5, 115), new EcBlock(10, 116)),
506 new EcBlocks(28, new EcBlock(19, 47), new EcBlock(10, 48)),
507 new EcBlocks(30, new EcBlock(15, 24), new EcBlock(25, 25)),
508 new EcBlocks(30, new EcBlock(23, 15), new EcBlock(25, 16))
509 ),
510 new self(
511 31,
512 [6, 30, 56, 82, 108, 134],
513 new EcBlocks(30, new EcBlock(13, 115), new EcBlock(3, 116)),
514 new EcBlocks(28, new EcBlock(2, 46), new EcBlock(29, 47)),
515 new EcBlocks(30, new EcBlock(42, 24), new EcBlock(1, 25)),
516 new EcBlocks(30, new EcBlock(23, 15), new EcBlock(28, 16))
517 ),
518 new self(
519 32,
520 [6, 34, 60, 86, 112, 138],
521 new EcBlocks(30, new EcBlock(17, 115)),
522 new EcBlocks(28, new EcBlock(10, 46), new EcBlock(23, 47)),
523 new EcBlocks(30, new EcBlock(10, 24), new EcBlock(35, 25)),
524 new EcBlocks(30, new EcBlock(19, 15), new EcBlock(35, 16))
525 ),
526 new self(
527 33,
528 [6, 30, 58, 86, 114, 142],
529 new EcBlocks(30, new EcBlock(17, 115), new EcBlock(1, 116)),
530 new EcBlocks(28, new EcBlock(14, 46), new EcBlock(21, 47)),
531 new EcBlocks(30, new EcBlock(29, 24), new EcBlock(19, 25)),
532 new EcBlocks(30, new EcBlock(11, 15), new EcBlock(46, 16))
533 ),
534 new self(
535 34,
536 [6, 34, 62, 90, 118, 146],
537 new EcBlocks(30, new EcBlock(13, 115), new EcBlock(6, 116)),
538 new EcBlocks(28, new EcBlock(14, 46), new EcBlock(23, 47)),
539 new EcBlocks(30, new EcBlock(44, 24), new EcBlock(7, 25)),
540 new EcBlocks(30, new EcBlock(59, 16), new EcBlock(1, 17))
541 ),
542 new self(
543 35,
544 [6, 30, 54, 78, 102, 126, 150],
545 new EcBlocks(30, new EcBlock(12, 121), new EcBlock(7, 122)),
546 new EcBlocks(28, new EcBlock(12, 47), new EcBlock(26, 48)),
547 new EcBlocks(30, new EcBlock(39, 24), new EcBlock(14, 25)),
548 new EcBlocks(30, new EcBlock(22, 15), new EcBlock(41, 16))
549 ),
550 new self(
551 36,
552 [6, 24, 50, 76, 102, 128, 154],
553 new EcBlocks(30, new EcBlock(6, 121), new EcBlock(14, 122)),
554 new EcBlocks(28, new EcBlock(6, 47), new EcBlock(34, 48)),
555 new EcBlocks(30, new EcBlock(46, 24), new EcBlock(10, 25)),
556 new EcBlocks(30, new EcBlock(2, 15), new EcBlock(64, 16))
557 ),
558 new self(
559 37,
560 [6, 28, 54, 80, 106, 132, 158],
561 new EcBlocks(30, new EcBlock(17, 122), new EcBlock(4, 123)),
562 new EcBlocks(28, new EcBlock(29, 46), new EcBlock(14, 47)),
563 new EcBlocks(30, new EcBlock(49, 24), new EcBlock(10, 25)),
564 new EcBlocks(30, new EcBlock(24, 15), new EcBlock(46, 16))
565 ),
566 new self(
567 38,
568 [6, 32, 58, 84, 110, 136, 162],
569 new EcBlocks(30, new EcBlock(4, 122), new EcBlock(18, 123)),
570 new EcBlocks(28, new EcBlock(13, 46), new EcBlock(32, 47)),
571 new EcBlocks(30, new EcBlock(48, 24), new EcBlock(14, 25)),
572 new EcBlocks(30, new EcBlock(42, 15), new EcBlock(32, 16))
573 ),
574 new self(
575 39,
576 [6, 26, 54, 82, 110, 138, 166],
577 new EcBlocks(30, new EcBlock(20, 117), new EcBlock(4, 118)),
578 new EcBlocks(28, new EcBlock(40, 47), new EcBlock(7, 48)),
579 new EcBlocks(30, new EcBlock(43, 24), new EcBlock(22, 25)),
580 new EcBlocks(30, new EcBlock(10, 15), new EcBlock(67, 16))
581 ),
582 new self(
583 40,
584 [6, 30, 58, 86, 114, 142, 170],
585 new EcBlocks(30, new EcBlock(19, 118), new EcBlock(6, 119)),
586 new EcBlocks(28, new EcBlock(18, 47), new EcBlock(31, 48)),
587 new EcBlocks(30, new EcBlock(34, 24), new EcBlock(34, 25)),
588 new EcBlocks(30, new EcBlock(20, 15), new EcBlock(61, 16))
589 ),
590 ];
591 }
592 }