2021SC@SDUSC Zxing开源代码（六）QR码的编码（三）——MatrixUtil详解

最新推荐文章于 2021-11-24 15:37:04 发布

番茄炒蛋不加蛋！

最新推荐文章于 2021-11-24 15:37:04 发布

阅读量474

点赞数 1

分类专栏：山东大学软件工程应用与实践文章标签： java

本文链接：https://blog.csdn.net/m0_52100140/article/details/120772531

版权

山东大学软件工程应用与实践专栏收录该内容

17 篇文章 4 订阅

订阅专栏

2021SC@SDUSC

前言：本篇博客继续对QR码的生成代码进行分析。主要对MatrixUtil类的代码进行详细分析。

一、QR回顾

首先，我们回顾一下QR码的基本结构，二、三部分的代码分析可参考下图，有助于理解。
在这里插入图片描述

二、MatrixUtil成员变量

MatrixUtil类中首先定义了几个二维数组（矩阵）：POSITION_DETECTION_PATTERN、POSITION_ADJUSTMENT_PATTERN、POSITION_ADJUSTMENT_PATTERN_COORDINATE_TABLE和TYPE_INFO_COORDINATES。

POSITION_DETECTION_PATTERN：定位图案，用于标记二维码的矩形大小。

private static final int[][] POSITION_DETECTION_PATTERN = {
      {1, 1, 1, 1, 1, 1, 1},
      {1, 0, 0, 0, 0, 0, 1},
      {1, 0, 1, 1, 1, 0, 1},
      {1, 0, 1, 1, 1, 0, 1},
      {1, 0, 1, 1, 1, 0, 1},
      {1, 0, 0, 0, 0, 0, 1},
      {1, 1, 1, 1, 1, 1, 1},
  };

POSITION_ADJUSTMENT_PATTERN：用于定位校正图形。

private static final int[][] POSITION_ADJUSTMENT_PATTERN = {
      {1, 1, 1, 1, 1},
      {1, 0, 0, 0, 1},
      {1, 0, 1, 0, 1},
      {1, 0, 0, 0, 1},
      {1, 1, 1, 1, 1},
  };

POSITION_ADJUSTMENT_PATTERN_COORDINATE_TABLE：40个版本定位图案的坐标位置。

private static final int[][] POSITION_ADJUSTMENT_PATTERN_COORDINATE_TABLE = {
      {-1, -1, -1, -1,  -1,  -1,  -1},  // Version 1
      { 6, 18, -1, -1,  -1,  -1,  -1},  // Version 2
      { 6, 22, -1, -1,  -1,  -1,  -1},  // Version 3
      { 6, 26, -1, -1,  -1,  -1,  -1},  // Version 4
      { 6, 30, -1, -1,  -1,  -1,  -1},  // Version 5
      // …………………………
      { 6, 24, 50, 76, 102, 128, 154},  // Version 36
      { 6, 28, 54, 80, 106, 132, 158},  // Version 37
      { 6, 32, 58, 84, 110, 136, 162},  // Version 38
      { 6, 26, 54, 82, 110, 138, 166},  // Version 39
      { 6, 30, 58, 86, 114, 142, 170},  // Version 40
  };

TYPE_INFO_COORDINATES：在二维码左上角输入单元格信息坐标。

  private static final int[][] TYPE_INFO_COORDINATES = {
      {8, 0},{8, 1},{8, 2},
      {8, 3},{8, 4},{8, 5},
      {8, 7},{8, 8},{7, 8},
      {5, 8},{4, 8},{3, 8},
      {2, 8},{1, 8},{0, 8},
  };

MatrixUtil类还定义了另外几个成员变量：VERSION_INFO_POLY、TYPE_INFO_POLY和TYPE_INFO_MASK_PATTERN，分别来表示二维码的版本信息、类型信息和掩码信息。

  // From Appendix D in JISX0510:2004 (p. 67)
  private static final int VERSION_INFO_POLY = 0x1f25;  // 0001 1111 0010 0101
  // From Appendix C in JISX0510:2004 (p.65).
  private static final int TYPE_INFO_POLY = 0x537; // 0101 0011 0111
  private static final int TYPE_INFO_MASK_PATTERN = 0x5412; // 0101 0100 0001 0010

三、MatrixUtil成员函数

3.1 clearMatrix

将所有单元格设置为-1（-1表示单元格为空）。但是在实际应用中，我们根本不需要这么做。应该重写代码，以开始编码，并将ByteMatrix全部初始化为零。

static void clearMatrix(ByteMatrix matrix) {
    matrix.clear((byte) -1);
  }

3.2 buildMatrix

从带有纠错等级、版本和“遮罩模式的数据比特构建二维二维码矩阵。成功后，将结果存储在矩阵中并返回true。

static void buildMatrix(BitArray dataBits,
                          ErrorCorrectionLevel ecLevel,
                          Version version,
                          int maskPattern,
                          ByteMatrix matrix) throws WriterException {
    clearMatrix(matrix);
    embedBasicPatterns(version, matrix);
    // 任何版本都会显示类型信息。
    embedTypeInfo(ecLevel, maskPattern, matrix);
    // 如果版本>=7，则显示版本信息。
    maybeEmbedVersionInfo(version, matrix);
    // 数据应该嵌入在末尾。
    embedDataBits(dataBits, maskPattern, matrix);
  }

3.3 embedBasicPatterns

嵌入基本模式。成功后，修改矩阵并返回true。
基本模式是：位置检测模式、计时模式、左下角的黑点、位置调整模式（如果需要的话）

static void embedBasicPatterns(Version version, ByteMatrix matrix) throws WriterException {
    // 首先，在拐角处嵌入大正方形。
    embedPositionDetectionPatternsAndSeparators(matrix);
    // 然后，在左下角嵌入黑点。
    embedDarkDotAtLeftBottomCorner(matrix);

    // 如果版本>=2，则会出现位置调整模式。
    maybeEmbedPositionAdjustmentPatterns(version, matrix);
    // 位置调整后应嵌入计时模式。
    embedTimingPatterns(matrix);
  }

3.4 embedTypeInfo

嵌入类型信息。成功后，修改矩阵。

  static void embedTypeInfo(ErrorCorrectionLevel ecLevel, int maskPattern, ByteMatrix matrix)
      throws WriterException {
    BitArray typeInfoBits = new BitArray();
    makeTypeInfoBits(ecLevel, maskPattern, typeInfoBits);

    for (int i = 0; i < typeInfoBits.getSize(); ++i) {
      // 按LSB到MSB的顺序放置位。LSB（最低有效位）是“类型信息位”中的最后一个值。
      boolean bit = typeInfoBits.get(typeInfoBits.getSize() - 1 - i);
      // 在左上角键入信息位。
      int[] coordinates = TYPE_INFO_COORDINATES[i];
      int x1 = coordinates[0];
      int y1 = coordinates[1];
      matrix.set(x1, y1, bit);

      int x2;
      int y2;
      if (i < 8) {
        // 右上角
        x2 = matrix.getWidth() - i - 1;
        y2 = 8;
      } else {
        // 左下角
        x2 = 8;
        y2 = matrix.getHeight() - 7 + (i - 8);
      }
      matrix.set(x2, y2, bit);
    }
  }

3.5 maybeEmbedVersionInfo

如果需要，嵌入版本信息。成功后，修改矩阵并返回true。

  static void maybeEmbedVersionInfo(Version version, ByteMatrix matrix) throws WriterException {
    if (version.getVersionNumber() < 7) {  // 如果版本>=7，则需要版本信息。
      return;  // 不需要版本信息。
    }
    BitArray versionInfoBits = new BitArray();
    makeVersionInfoBits(version, versionInfoBits);

    int bitIndex = 6 * 3 - 1;  // 它将从17降至0。
    for (int i = 0; i < 6; ++i) {
      for (int j = 0; j < 3; ++j) {
        // 将LSB（最低有效位）中的位按MSB顺序排列。
        boolean bit = versionInfoBits.get(bitIndex);
        bitIndex--;
        // 左下角
        matrix.set(i, matrix.getHeight() - 11 + j, bit);
        // 右下角
        matrix.set(matrix.getHeight() - 11 + j, i, bit);
      }
    }
  }

3.6 embedDataBits

使用“getMaskPattern”嵌入“dataBits”。成功后，修改矩阵并返回true。
出于调试目的，如果“getMaskPattern”为-1，它将跳过屏蔽过程。

  static void embedDataBits(BitArray dataBits, int maskPattern, ByteMatrix matrix)
      throws WriterException {
    int bitIndex = 0;
    int direction = -1;
    // 从右下单元格开始。
    int x = matrix.getWidth() - 1;
    int y = matrix.getHeight() - 1;
    while (x > 0) {
      // 跳过垂直计时模式。
      if (x == 6) {
        x -= 1;
      }
      while (y >= 0 && y < matrix.getHeight()) {
        for (int i = 0; i < 2; ++i) {
          int xx = x - i;
          // 如果单元格不是空的，则跳过该单元格。
          if (!isEmpty(matrix.get(xx, y))) {
            continue;
          }
          boolean bit;
          if (bitIndex < dataBits.getSize()) {
            bit = dataBits.get(bitIndex);
            ++bitIndex;
          } else {
            // 填充位。如果没有剩余的位，我们将用0填充左侧单元格。
            bit = false;
          }
          // 如果遮罩模式为-1，则跳过遮罩。
          if (maskPattern != -1 && MaskUtil.getDataMaskBit(maskPattern, xx, y)) {
            bit = !bit;
          }
          matrix.set(xx, y, bit);
        }
        y += direction;
      }
      direction = -direction;  // 改变方向。
      y += direction;
      x -= 2;  // 向左移动。
    }
    // 所有位都应该被用掉。
    if (bitIndex != dataBits.getSize()) {
      throw new WriterException("Not all bits consumed: " + bitIndex + '/' + dataBits.getSize());
    }
  }

3.7 findMSBSet

返回“值”中设置的最高有效位的位置（至1）。最高有效位是位置32。如果未设置位，则返回0。示例：
findMSBSet(0) => 0
findMSBSet(1) => 1
findMSBSet(255) => 8

  static int findMSBSet(int value) {
    return 32 - Integer.numberOfLeadingZeros(value);
  }

3.8 calculateBCHCode

使用多项式“poly”计算“value”的BCH（Bose Chaudhuri-Hocquenghem）代码。BCH代码用于编码类型信息和版本信息。

示例：计算版本7的信息。
f(x) 是从 7 创建的
7 = 000111 （6位）
f(x) = x^2 + x^1 + x^0
g(x) 由标准给出
g(x) = x^12 + x^11 + x^10 + x^9 + x^8 + x^5 + x^2 + 1
用 f(x) 乘以 x^(18 - 6)
f’(x) = f(x) * x^(18 - 6)
f’(x) = x^14 + x^13 + x^12
计算 f’(x) / g(x)的余数
由于多项式中的所有系数都是1或0，我们可以通过位运算进行计算。我们不在乎系数是正还是负。
计算出余数为 x^11 + x^10 + x^7 + x^4 + x^2
用二进制编码为： 110010010100
返回值为 0xc94 (1100 1001 0100)

  static int calculateBCHCode(int value, int poly) {
    if (poly == 0) {
      throw new IllegalArgumentException("0 polynomial");
    }
    // 如果poly为“111100100101”（版本信息poly），则msbSetInPoly为13。13减去1等于12。
    int msbSetInPoly = findMSBSet(poly);
    value <<= msbSetInPoly - 1;
    // 执行异或操作
    while (findMSBSet(value) >= msbSetInPoly) {
      value ^= poly << (findMSBSet(value) - msbSetInPoly);
    }
    // 现在“值”是余数（即 BCH code）
    return value;
  }

3.9 makeTypeInfoBits

生成类型信息（编码纠错级别和掩码模式）的位向量。成功后，将结果存储在“bits”中并返回true。

  static void makeTypeInfoBits(ErrorCorrectionLevel ecLevel, int maskPattern, BitArray bits)
      throws WriterException {
    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);

    BitArray maskBits = new BitArray();
    maskBits.appendBits(TYPE_INFO_MASK_PATTERN, 15);
    bits.xor(maskBits);

    if (bits.getSize() != 15) {  // 以防万一
      throw new WriterException("should not happen but we got: " + bits.getSize());
    }
  }

3.10 makeVersionInfoBits

生成版本信息的位向量。成功后，将结果存储在“bits”中并返回true。

static void makeVersionInfoBits(Version version, BitArray bits) throws WriterException {
    bits.appendBits(version.getVersionNumber(), 6);
    int bchCode = calculateBCHCode(version.getVersionNumber(), VERSION_INFO_POLY);
    bits.appendBits(bchCode, 12);

    if (bits.getSize() != 18) {  // 以防万一
      throw new WriterException("should not happen but we got: " + bits.getSize());
    }
  }

3.11 isEmpty

检查value是否为空。

  private static boolean isEmpty(int value) {
    return value == -1;
  }

3.12 embedTimingPatterns

嵌入计时模式。

  private static void embedTimingPatterns(ByteMatrix matrix) {
    // 8用于跳过位置检测模式（尺寸7）和两个水平/垂直分离模式（尺寸1）。因此，8=7+1。
    for (int i = 8; i < matrix.getWidth() - 8; ++i) {
      int bit = (i + 1) % 2;
      // 水平线
      if (isEmpty(matrix.get(i, 6))) {
        matrix.set(i, 6, bit);
      }
      // 垂直线
      if (isEmpty(matrix.get(6, i))) {
        matrix.set(6, i, bit);
      }
    }
  }

3.13 embedDarkDotAtLeftBottomCorner

在左下角嵌入单独的黑点。

  private static void embedDarkDotAtLeftBottomCorner(ByteMatrix matrix) throws WriterException {
    if (matrix.get(8, matrix.getHeight() - 8) == 0) {
      throw new WriterException();
    }
    matrix.set(8, matrix.getHeight() - 8, 1);
  }

3.14 embedHorizontalSeparationPattern、embedVerticalSeparationPattern

嵌入水平、垂直分隔图案。

  private static void embedHorizontalSeparationPattern(int xStart,
                                                       int yStart,
                                                       ByteMatrix matrix) throws WriterException {
    for (int x = 0; x < 8; ++x) {
      if (!isEmpty(matrix.get(xStart + x, yStart))) {
        throw new WriterException();
      }
      matrix.set(xStart + x, yStart, 0);
    }
  }

  private static void embedVerticalSeparationPattern(int xStart,
                                                     int yStart,
                                                     ByteMatrix matrix) throws WriterException {
    for (int y = 0; y < 7; ++y) {
      if (!isEmpty(matrix.get(xStart, yStart + y))) {
        throw new WriterException();
      }
      matrix.set(xStart, yStart + y, 0);
    }
  }

3.15 embedPositionAdjustmentPattern、embedPositionDetectionPattern

嵌入位置调整、检测模式。

  private static void embedPositionAdjustmentPattern(int xStart, int yStart, ByteMatrix matrix) {
    for (int y = 0; y < 5; ++y) {
      int[] patternY = POSITION_ADJUSTMENT_PATTERN[y];
      for (int x = 0; x < 5; ++x) {
        matrix.set(xStart + x, yStart + y, patternY[x]);
      }
    }
  }

  private static void embedPositionDetectionPattern(int xStart, int yStart, ByteMatrix matrix) {
    for (int y = 0; y < 7; ++y) {
      int[] patternY = POSITION_DETECTION_PATTERN[y];
      for (int x = 0; x < 7; ++x) {
        matrix.set(xStart + x, yStart + y, patternY[x]);
      }
    }
  }

3.16 embedPositionDetectionPatternsAndSeparators

嵌入位置检测模式和周围的垂直/水平分隔符。

  private static void embedPositionDetectionPatternsAndSeparators(ByteMatrix matrix) throws WriterException {
    // 在拐角处嵌入三个大正方形。
    int pdpWidth = POSITION_DETECTION_PATTERN[0].length;
    // 左上角
    embedPositionDetectionPattern(0, 0, matrix);
    // 右上角
    embedPositionDetectionPattern(matrix.getWidth() - pdpWidth, 0, matrix);
    // 左下角
    embedPositionDetectionPattern(0, matrix.getWidth() - pdpWidth, matrix);

    // 在正方形周围嵌入水平分隔图案。
    int hspWidth = 8;
    // 左上角
    embedHorizontalSeparationPattern(0, hspWidth - 1, matrix);
    // 右上角
    embedHorizontalSeparationPattern(matrix.getWidth() - hspWidth,
        hspWidth - 1, matrix);
    // 左下角
    embedHorizontalSeparationPattern(0, matrix.getWidth() - hspWidth, matrix);

    // 在正方形周围嵌入垂直分隔图案。
    int vspSize = 7;
    // 左上角
    embedVerticalSeparationPattern(vspSize, 0, matrix);
    // 右上角
    embedVerticalSeparationPattern(matrix.getHeight() - vspSize - 1, 0, matrix);
    // 左下角
    embedVerticalSeparationPattern(vspSize, matrix.getHeight() - vspSize,
        matrix);
  }

3.17 maybeEmbedPositionAdjustmentPatterns

如果需要，嵌入位置调整模式。

  private static void maybeEmbedPositionAdjustmentPatterns(Version version, ByteMatrix matrix) {
    if (version.getVersionNumber() < 2) {  // 如果版本>=2，则显示模式
      return;
    }
    int index = version.getVersionNumber() - 1;
    int[] coordinates = POSITION_ADJUSTMENT_PATTERN_COORDINATE_TABLE[index];
    for (int y : coordinates) {
      if (y >= 0) {
        for (int x : coordinates) {
          if (x >= 0 && isEmpty(matrix.get(x, y))) {
            // 如果单元未设置，我们将在此处嵌入位置调整模式
            //2是必需的，因为x/y坐标指向图案的中心，而不是左上角。
            embedPositionAdjustmentPattern(x - 2, y - 2, matrix);
          }
        }
      }
    }
  }