csharp/qrcode/decoder/DataMask.cs

   1 /*\r
   2 * Copyright 2007 ZXing authors\r
   3 *\r
   4 * Licensed under the Apache License, Version 2.0 (the "License");\r
   5 * you may not use this file except in compliance with the License.\r
   6 * You may obtain a copy of the License at\r
   7 *\r
   8 *      http://www.apache.org/licenses/LICENSE-2.0\r
   9 *\r
  10 * Unless required by applicable law or agreed to in writing, software\r
  11 * distributed under the License is distributed on an "AS IS" BASIS,\r
  12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13 * See the License for the specific language governing permissions and\r
  14 * limitations under the License.\r
  15 */\r
  16 using System;\r
  17 using BitMatrix = com.google.zxing.common.BitMatrix;\r
  18 namespace com.google.zxing.qrcode.decoder\r
  19 {\r
  20         \r
  21         /// <summary> <p>Encapsulates data masks for the data bits in a QR code, per ISO 18004:2006 6.8. Implementations\r
  22         /// of this class can un-mask a raw BitMatrix. For simplicity, they will unmask the entire BitMatrix,\r
  23         /// including areas used for finder patterns, timing patterns, etc. These areas should be unused\r
  24         /// after the point they are unmasked anyway.</p>\r
  25         /// \r
  26         /// <p>Note that the diagram in section 6.8.1 is misleading since it indicates that i is column position\r
  27         /// and j is row position. In fact, as the text says, i is row position and j is column position.</p>\r
  28         /// \r
  29         /// </summary>\r
  30         /// <author>  Sean Owen\r
  31         /// </author>\r
  32         /// <author>www.Redivivus.in (suraj.supekar@redivivus.in) - Ported from ZXING Java Source \r
  33         /// </author>\r
  34         abstract class DataMask\r
  35         {\r
  36                 \r
  37                 /// <summary> See ISO 18004:2006 6.8.1</summary>\r
  38                 //UPGRADE_NOTE: Final was removed from the declaration of 'DATA_MASKS '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"\r
  39                 private static readonly DataMask[] DATA_MASKS = new DataMask[]{new DataMask000(), new DataMask001(), new DataMask010(), new DataMask011(), new DataMask100(), new DataMask101(), new DataMask110(), new DataMask111()};\r
  40                 \r
  41                 private DataMask()\r
  42                 {\r
  43                 }\r
  44                 \r
  45                 /// <summary> <p>Implementations of this method reverse the data masking process applied to a QR Code and\r
  46                 /// make its bits ready to read.</p>\r
  47                 /// \r
  48                 /// </summary>\r
  49                 /// <param name="bits">representation of QR Code bits\r
  50                 /// </param>\r
  51                 /// <param name="dimension">dimension of QR Code, represented by bits, being unmasked\r
  52                 /// </param>\r
  53                 internal void  unmaskBitMatrix(BitMatrix bits, int dimension)\r
  54                 {\r
  55                         for (int i = 0; i < dimension; i++)\r
  56                         {\r
  57                                 for (int j = 0; j < dimension; j++)\r
  58                                 {\r
  59                                         if (isMasked(i, j))\r
  60                                         {\r
  61                                                 bits.flip(j, i);\r
  62                                         }\r
  63                                 }\r
  64                         }\r
  65                 }\r
  66                 \r
  67                 internal abstract bool isMasked(int i, int j);\r
  68                 \r
  69                 /// <param name="reference">a value between 0 and 7 indicating one of the eight possible\r
  70                 /// data mask patterns a QR Code may use\r
  71                 /// </param>\r
  72                 /// <returns> {@link DataMask} encapsulating the data mask pattern\r
  73                 /// </returns>\r
  74                 internal static DataMask forReference(int reference)\r
  75                 {\r
  76                         if (reference < 0 || reference > 7)\r
  77                         {\r
  78                                 throw new System.ArgumentException();\r
  79                         }\r
  80                         return DATA_MASKS[reference];\r
  81                 }\r
  82                 \r
  83                 /// <summary> 000: mask bits for which (x + y) mod 2 == 0</summary>\r
  84                 private class DataMask000:DataMask\r
  85                 {\r
  86                         internal override bool isMasked(int i, int j)\r
  87                         {\r
  88                                 return ((i + j) & 0x01) == 0;\r
  89                         }\r
  90                 }\r
  91                 \r
  92                 /// <summary> 001: mask bits for which x mod 2 == 0</summary>\r
  93                 private class DataMask001:DataMask\r
  94                 {\r
  95                         internal override bool isMasked(int i, int j)\r
  96                         {\r
  97                                 return (i & 0x01) == 0;\r
  98                         }\r
  99                 }\r
 100                 \r
 101                 /// <summary> 010: mask bits for which y mod 3 == 0</summary>\r
 102                 private class DataMask010:DataMask\r
 103                 {\r
 104                         internal override bool isMasked(int i, int j)\r
 105                         {\r
 106                                 return j % 3 == 0;\r
 107                         }\r
 108                 }\r
 109                 \r
 110                 /// <summary> 011: mask bits for which (x + y) mod 3 == 0</summary>\r
 111                 private class DataMask011:DataMask\r
 112                 {\r
 113                         internal override bool isMasked(int i, int j)\r
 114                         {\r
 115                                 return (i + j) % 3 == 0;\r
 116                         }\r
 117                 }\r
 118                 \r
 119                 /// <summary> 100: mask bits for which (x/2 + y/3) mod 2 == 0</summary>\r
 120                 private class DataMask100:DataMask\r
 121                 {\r
 122                         internal override bool isMasked(int i, int j)\r
 123                         {\r
 124                                 return (((SupportClass.URShift(i, 1)) + (j / 3)) & 0x01) == 0;\r
 125                         }\r
 126                 }\r
 127                 \r
 128                 /// <summary> 101: mask bits for which xy mod 2 + xy mod 3 == 0</summary>\r
 129                 private class DataMask101:DataMask\r
 130                 {\r
 131                         internal override bool isMasked(int i, int j)\r
 132                         {\r
 133                                 int temp = i * j;\r
 134                                 return (temp & 0x01) + (temp % 3) == 0;\r
 135                         }\r
 136                 }\r
 137                 \r
 138                 /// <summary> 110: mask bits for which (xy mod 2 + xy mod 3) mod 2 == 0</summary>\r
 139                 private class DataMask110:DataMask\r
 140                 {\r
 141                         internal override bool isMasked(int i, int j)\r
 142                         {\r
 143                                 int temp = i * j;\r
 144                                 return (((temp & 0x01) + (temp % 3)) & 0x01) == 0;\r
 145                         }\r
 146                 }\r
 147                 \r
 148                 /// <summary> 111: mask bits for which ((x+y)mod 2 + xy mod 3) mod 2 == 0</summary>\r
 149                 private class DataMask111:DataMask\r
 150                 {\r
 151                         internal override bool isMasked(int i, int j)\r
 152                         {\r
 153                                 return ((((i + j) & 0x01) + ((i * j) % 3)) & 0x01) == 0;\r
 154                         }\r
 155                 }\r
 156         }\r
 157 }