Pileus Git - ~andy/freeotp/blob - src/com/google/zxing/qrcode/decoder/DataMask.java

   1 /*
   2  * Copyright 2007 ZXing authors
   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 import com.google.zxing.common.BitMatrix;
  20
  21 /**
  22  * <p>Encapsulates data masks for the data bits in a QR code, per ISO 18004:2006 6.8. Implementations
  23  * of this class can un-mask a raw BitMatrix. For simplicity, they will unmask the entire BitMatrix,
  24  * including areas used for finder patterns, timing patterns, etc. These areas should be unused
  25  * after the point they are unmasked anyway.</p>
  26  *
  27  * <p>Note that the diagram in section 6.8.1 is misleading since it indicates that i is column position
  28  * and j is row position. In fact, as the text says, i is row position and j is column position.</p>
  29  *
  30  * @author Sean Owen
  31  */
  32 abstract class DataMask {
  33
  34   /**
  35    * See ISO 18004:2006 6.8.1
  36    */
  37   private static final DataMask[] DATA_MASKS = {
  38       new DataMask000(),
  39       new DataMask001(),
  40       new DataMask010(),
  41       new DataMask011(),
  42       new DataMask100(),
  43       new DataMask101(),
  44       new DataMask110(),
  45       new DataMask111(),
  46   };
  47
  48   private DataMask() {
  49   }
  50
  51   /**
  52    * <p>Implementations of this method reverse the data masking process applied to a QR Code and
  53    * make its bits ready to read.</p>
  54    *
  55    * @param bits representation of QR Code bits
  56    * @param dimension dimension of QR Code, represented by bits, being unmasked
  57    */
  58   final void unmaskBitMatrix(BitMatrix bits, int dimension) {
  59     for (int i = 0; i < dimension; i++) {
  60       for (int j = 0; j < dimension; j++) {
  61         if (isMasked(i, j)) {
  62           bits.flip(j, i);
  63         }
  64       }
  65     }
  66   }
  67
  68   abstract boolean isMasked(int i, int j);
  69
  70   /**
  71    * @param reference a value between 0 and 7 indicating one of the eight possible
  72    * data mask patterns a QR Code may use
  73    * @return DataMask encapsulating the data mask pattern
  74    */
  75   static DataMask forReference(int reference) {
  76     if (reference < 0 || reference > 7) {
  77       throw new IllegalArgumentException();
  78     }
  79     return DATA_MASKS[reference];
  80   }
  81
  82   /**
  83    * 000: mask bits for which (x + y) mod 2 == 0
  84    */
  85   private static final class DataMask000 extends DataMask {
  86     @Override
  87     boolean isMasked(int i, int j) {
  88       return ((i + j) & 0x01) == 0;
  89     }
  90   }
  91
  92   /**
  93    * 001: mask bits for which x mod 2 == 0
  94    */
  95   private static final class DataMask001 extends DataMask {
  96     @Override
  97     boolean isMasked(int i, int j) {
  98       return (i & 0x01) == 0;
  99     }
 100   }
 101
 102   /**
 103    * 010: mask bits for which y mod 3 == 0
 104    */
 105   private static final class DataMask010 extends DataMask {
 106     @Override
 107     boolean isMasked(int i, int j) {
 108       return j % 3 == 0;
 109     }
 110   }
 111
 112   /**
 113    * 011: mask bits for which (x + y) mod 3 == 0
 114    */
 115   private static final class DataMask011 extends DataMask {
 116     @Override
 117     boolean isMasked(int i, int j) {
 118       return (i + j) % 3 == 0;
 119     }
 120   }
 121
 122   /**
 123    * 100: mask bits for which (x/2 + y/3) mod 2 == 0
 124    */
 125   private static final class DataMask100 extends DataMask {
 126     @Override
 127     boolean isMasked(int i, int j) {
 128       return (((i >>> 1) + (j /3)) & 0x01) == 0;
 129     }
 130   }
 131
 132   /**
 133    * 101: mask bits for which xy mod 2 + xy mod 3 == 0
 134    */
 135   private static final class DataMask101 extends DataMask {
 136     @Override
 137     boolean isMasked(int i, int j) {
 138       int temp = i * j;
 139       return (temp & 0x01) + (temp % 3) == 0;
 140     }
 141   }
 142
 143   /**
 144    * 110: mask bits for which (xy mod 2 + xy mod 3) mod 2 == 0
 145    */
 146   private static final class DataMask110 extends DataMask {
 147     @Override
 148     boolean isMasked(int i, int j) {
 149       int temp = i * j;
 150       return (((temp & 0x01) + (temp % 3)) & 0x01) == 0;
 151     }
 152   }
 153
 154   /**
 155    * 111: mask bits for which ((x+y)mod 2 + xy mod 3) mod 2 == 0
 156    */
 157   private static final class DataMask111 extends DataMask {
 158     @Override
 159     boolean isMasked(int i, int j) {
 160       return ((((i + j) & 0x01) + ((i * j) % 3)) & 0x01) == 0;
 161     }
 162   }
 163 }