core/src/com/google/zxing/qrcode/decoder/FormatInformation.java

   1 /*
   2  * Copyright 2007 Google Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package com.google.zxing.qrcode.decoder;
  18
  19 /**
  20  * <p>Encapsulates a QR Code's format information, including the data mask used and
  21  * error correction level.</p>
  22  *
  23  * @author srowen@google.com (Sean Owen)
  24  * @see DataMask
  25  * @see ErrorCorrectionLevel
  26  */
  27 final class FormatInformation {
  28
  29   private static final int FORMAT_INFO_MASK_QR = 0x5412;
  30
  31   /**
  32    * See ISO 18004:2006, Annex C, Table C.1
  33    */
  34   private static final int[][] FORMAT_INFO_DECODE_LOOKUP = new int[][]{
  35       {0x5412, 0x00},
  36       {0x5125, 0x01},
  37       {0x5E7C, 0x02},
  38       {0x5B4B, 0x03},
  39       {0x45F9, 0x04},
  40       {0x40CE, 0x05},
  41       {0x4F97, 0x06},
  42       {0x4AA0, 0x07},
  43       {0x77C4, 0x08},
  44       {0x72F3, 0x09},
  45       {0x7DAA, 0x0A},
  46       {0x789D, 0x0B},
  47       {0x662F, 0x0C},
  48       {0x6318, 0x0D},
  49       {0x6C41, 0x0E},
  50       {0x6976, 0x0F},
  51       {0x1689, 0x10},
  52       {0x13BE, 0x11},
  53       {0x1CE7, 0x12},
  54       {0x19D0, 0x13},
  55       {0x0762, 0x14},
  56       {0x0255, 0x15},
  57       {0x0D0C, 0x16},
  58       {0x083B, 0x17},
  59       {0x355F, 0x18},
  60       {0x3068, 0x19},
  61       {0x3F31, 0x1A},
  62       {0x3A06, 0x1B},
  63       {0x24B4, 0x1C},
  64       {0x2183, 0x1D},
  65       {0x2EDA, 0x1E},
  66       {0x2BED, 0x1F},
  67   };
  68
  69   /** Offset i holds the number of 1 bits in the binary representation of i */
  70   private static final int[] BITS_SET_IN_HALF_BYTE =
  71       new int[]{0, 1, 1, 2, 1, 2, 2, 3, 1, 2, 2, 3, 2, 3, 3, 4};
  72
  73   private final ErrorCorrectionLevel errorCorrectionLevel;
  74   private final byte dataMask;
  75
  76   private FormatInformation(int formatInfo) {
  77     // Bits 3,4
  78     errorCorrectionLevel = ErrorCorrectionLevel.forBits((formatInfo >> 3) & 0x03);
  79     // Bottom 3 bits
  80     dataMask = (byte) (formatInfo & 0x07);
  81   }
  82
  83   static int numBitsDiffering(int a, int b) {
  84     a ^= b; // a now has a 1 bit exactly where its bit differs with b's
  85     // Count bits set quickly with a series of lookups:
  86     return  BITS_SET_IN_HALF_BYTE[a & 0x0F] +
  87             BITS_SET_IN_HALF_BYTE[(a >>> 4 & 0x0F)] +
  88             BITS_SET_IN_HALF_BYTE[(a >>> 8 & 0x0F)] +
  89             BITS_SET_IN_HALF_BYTE[(a >>> 12 & 0x0F)] +
  90             BITS_SET_IN_HALF_BYTE[(a >>> 16 & 0x0F)] +
  91             BITS_SET_IN_HALF_BYTE[(a >>> 20 & 0x0F)] +
  92             BITS_SET_IN_HALF_BYTE[(a >>> 24 & 0x0F)] +
  93             BITS_SET_IN_HALF_BYTE[(a >>> 28 & 0x0F)];
  94   }
  95
  96   /**
  97    *
  98    * @param rawFormatInfo
  99    * @return
 100    */
 101   static FormatInformation decodeFormatInformation(int rawFormatInfo) {
 102     FormatInformation formatInfo = doDecodeFormatInformation(rawFormatInfo);
 103     if (formatInfo != null) {
 104       return formatInfo;
 105     }
 106     // Should return null, but, some QR codes apparently
 107     // do not mask this info. Try again, first masking the raw bits so
 108     // the function will unmask
 109     return doDecodeFormatInformation(rawFormatInfo ^ FORMAT_INFO_MASK_QR);
 110   }
 111
 112   private static FormatInformation doDecodeFormatInformation(int rawFormatInfo) {
 113     // Unmask:
 114     int unmaskedFormatInfo = rawFormatInfo ^ FORMAT_INFO_MASK_QR;
 115     // Find the int in FORMAT_INFO_DECODE_LOOKUP with fewest bits differing
 116     int bestDifference = Integer.MAX_VALUE;
 117     int bestFormatInfo = 0;
 118     for (int i = 0; i < FORMAT_INFO_DECODE_LOOKUP.length; i++) {
 119       int[] decodeInfo = FORMAT_INFO_DECODE_LOOKUP[i];
 120       int targetInfo = decodeInfo[0];
 121       if (targetInfo == unmaskedFormatInfo) {
 122         // Found an exact match
 123         return new FormatInformation(decodeInfo[1]);
 124       }
 125       int bitsDifference = numBitsDiffering(unmaskedFormatInfo, targetInfo);
 126       if (bitsDifference < bestDifference) {
 127         bestFormatInfo = decodeInfo[1];
 128         bestDifference = bitsDifference;
 129       }
 130     }
 131     if (bestDifference <= 3) {
 132       return new FormatInformation(bestFormatInfo);
 133     }
 134     return null;
 135   }
 136
 137   ErrorCorrectionLevel getErrorCorrectionLevel() {
 138     return errorCorrectionLevel;
 139   }
 140
 141   byte getDataMask() {
 142     return dataMask;
 143   }
 144
 145   public int hashCode() {
 146     return (errorCorrectionLevel.ordinal() << 3) | (int) dataMask;
 147   }
 148
 149   public boolean equals(Object o) {
 150     if (!(o instanceof FormatInformation)) {
 151       return false;
 152     }
 153     FormatInformation other = (FormatInformation) o;
 154     return this.errorCorrectionLevel == other.errorCorrectionLevel &&
 155         this.dataMask == other.dataMask;
 156   }
 157
 158 }