core/test/src/com/google/zxing/qrcode/encoder/MaskUtilTestCase.java

   1 /*
   2  * Copyright 2008 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.encoder;
  18
  19 import org.junit.Assert;
  20 import org.junit.Test;
  21
  22 /**
  23  * @author satorux@google.com (Satoru Takabayashi) - creator
  24  * @author mysen@google.com (Chris Mysen) - ported from C++
  25  */
  26
  27 public final class MaskUtilTestCase extends Assert {
  28
  29   @Test
  30   public void testApplyMaskPenaltyRule1() {
  31     {
  32       ByteMatrix matrix = new ByteMatrix(4, 1);
  33       matrix.set(0, 0, 0);
  34       matrix.set(1, 0, 0);
  35       matrix.set(2, 0, 0);
  36       matrix.set(3, 0, 0);
  37       assertEquals(0, MaskUtil.applyMaskPenaltyRule1(matrix));
  38     }
  39     {  // Horizontal.
  40       ByteMatrix matrix = new ByteMatrix(6, 1);
  41       matrix.set(0, 0, 0);
  42       matrix.set(1, 0, 0);
  43       matrix.set(2, 0, 0);
  44       matrix.set(3, 0, 0);
  45       matrix.set(4, 0, 0);
  46       matrix.set(5, 0, 1);
  47       assertEquals(3, MaskUtil.applyMaskPenaltyRule1(matrix));
  48       matrix.set(5, 0, 0);
  49       assertEquals(4, MaskUtil.applyMaskPenaltyRule1(matrix));
  50     }
  51     {  // Vertical.
  52       ByteMatrix matrix = new ByteMatrix(1, 6);
  53       matrix.set(0, 0, 0);
  54       matrix.set(0, 1, 0);
  55       matrix.set(0, 2, 0);
  56       matrix.set(0, 3, 0);
  57       matrix.set(0, 4, 0);
  58       matrix.set(0, 5, 1);
  59       assertEquals(3, MaskUtil.applyMaskPenaltyRule1(matrix));
  60       matrix.set(0, 5, 0);
  61       assertEquals(4, MaskUtil.applyMaskPenaltyRule1(matrix));
  62     }
  63   }
  64
  65   @Test
  66   public void testApplyMaskPenaltyRule2() {
  67     {
  68       ByteMatrix matrix = new ByteMatrix(1, 1);
  69       matrix.set(0, 0, 0);
  70       assertEquals(0, MaskUtil.applyMaskPenaltyRule2(matrix));
  71     }
  72     {
  73       ByteMatrix matrix = new ByteMatrix(2, 2);
  74       matrix.set(0, 0, 0);
  75       matrix.set(1, 0, 0);
  76       matrix.set(0, 1, 0);
  77       matrix.set(1, 1, 1);
  78       assertEquals(0, MaskUtil.applyMaskPenaltyRule2(matrix));
  79     }
  80     {
  81       ByteMatrix matrix = new ByteMatrix(2, 2);
  82       matrix.set(0, 0, 0);
  83       matrix.set(1, 0, 0);
  84       matrix.set(0, 1, 0);
  85       matrix.set(1, 1, 0);
  86       assertEquals(3, MaskUtil.applyMaskPenaltyRule2(matrix));
  87     }
  88     {
  89       ByteMatrix matrix = new ByteMatrix(3, 3);
  90       matrix.set(0, 0, 0);
  91       matrix.set(1, 0, 0);
  92       matrix.set(2, 0, 0);
  93       matrix.set(0, 1, 0);
  94       matrix.set(1, 1, 0);
  95       matrix.set(2, 1, 0);
  96       matrix.set(0, 2, 0);
  97       matrix.set(1, 2, 0);
  98       matrix.set(2, 2, 0);
  99       // Four instances of 2x2 blocks.
 100       assertEquals(3 * 4, MaskUtil.applyMaskPenaltyRule2(matrix));
 101     }
 102   }
 103
 104   @Test
 105   public void testApplyMaskPenaltyRule3() {
 106     {
 107       // Horizontal 00001011101.
 108       ByteMatrix matrix = new ByteMatrix(11, 1);
 109       matrix.set(0, 0, 0);
 110       matrix.set(1, 0, 0);
 111       matrix.set(2, 0, 0);
 112       matrix.set(3, 0, 0);
 113       matrix.set(4, 0, 1);
 114       matrix.set(5, 0, 0);
 115       matrix.set(6, 0, 1);
 116       matrix.set(7, 0, 1);
 117       matrix.set(8, 0, 1);
 118       matrix.set(9, 0, 0);
 119       matrix.set(10, 0, 1);
 120       assertEquals(40, MaskUtil.applyMaskPenaltyRule3(matrix));
 121     }
 122     {
 123       // Horizontal 10111010000.
 124       ByteMatrix matrix = new ByteMatrix(11, 1);
 125       matrix.set(0, 0, 1);
 126       matrix.set(1, 0, 0);
 127       matrix.set(2, 0, 1);
 128       matrix.set(3, 0, 1);
 129       matrix.set(4, 0, 1);
 130       matrix.set(5, 0, 0);
 131       matrix.set(6, 0, 1);
 132       matrix.set(7, 0, 0);
 133       matrix.set(8, 0, 0);
 134       matrix.set(9, 0, 0);
 135       matrix.set(10, 0, 0);
 136       assertEquals(40, MaskUtil.applyMaskPenaltyRule3(matrix));
 137     }
 138     {
 139       // Vertical 00001011101.
 140       ByteMatrix matrix = new ByteMatrix(1, 11);
 141       matrix.set(0, 0, 0);
 142       matrix.set(0, 1, 0);
 143       matrix.set(0, 2, 0);
 144       matrix.set(0, 3, 0);
 145       matrix.set(0, 4, 1);
 146       matrix.set(0, 5, 0);
 147       matrix.set(0, 6, 1);
 148       matrix.set(0, 7, 1);
 149       matrix.set(0, 8, 1);
 150       matrix.set(0, 9, 0);
 151       matrix.set(0, 10, 1);
 152       assertEquals(40, MaskUtil.applyMaskPenaltyRule3(matrix));
 153     }
 154     {
 155       // Vertical 10111010000.
 156       ByteMatrix matrix = new ByteMatrix(1, 11);
 157       matrix.set(0, 0, 1);
 158       matrix.set(0, 1, 0);
 159       matrix.set(0, 2, 1);
 160       matrix.set(0, 3, 1);
 161       matrix.set(0, 4, 1);
 162       matrix.set(0, 5, 0);
 163       matrix.set(0, 6, 1);
 164       matrix.set(0, 7, 0);
 165       matrix.set(0, 8, 0);
 166       matrix.set(0, 9, 0);
 167       matrix.set(0, 10, 0);
 168       assertEquals(40, MaskUtil.applyMaskPenaltyRule3(matrix));
 169     }
 170   }
 171
 172   @Test
 173   public void testApplyMaskPenaltyRule4() {
 174     {
 175       // Dark cell ratio = 0%
 176       ByteMatrix matrix = new ByteMatrix(1, 1);
 177       matrix.set(0, 0, 0);
 178       assertEquals(100, MaskUtil.applyMaskPenaltyRule4(matrix));
 179     }
 180     {
 181       // Dark cell ratio = 5%
 182       ByteMatrix matrix = new ByteMatrix(2, 1);
 183       matrix.set(0, 0, 0);
 184       matrix.set(0, 0, 1);
 185       assertEquals(0, MaskUtil.applyMaskPenaltyRule4(matrix));
 186     }
 187     {
 188       // Dark cell ratio = 66.67%
 189       ByteMatrix matrix = new ByteMatrix(6, 1);
 190       matrix.set(0, 0, 0);
 191       matrix.set(1, 0, 1);
 192       matrix.set(2, 0, 1);
 193       matrix.set(3, 0, 1);
 194       matrix.set(4, 0, 1);
 195       matrix.set(5, 0, 0);
 196       assertEquals(30, MaskUtil.applyMaskPenaltyRule4(matrix));
 197     }
 198   }
 199
 200   private static boolean TestGetDataMaskBitInternal(int maskPattern,
 201                                          int[][] expected) {
 202     for (int x = 0; x < 6; ++x) {
 203       for (int y = 0; y < 6; ++y) {
 204         if ((expected[y][x] == 1) !=
 205             MaskUtil.getDataMaskBit(maskPattern, x, y)) {
 206           return false;
 207         }
 208       }
 209     }
 210     return true;
 211   }
 212
 213   // See mask patterns on the page 43 of JISX0510:2004.
 214   @Test
 215   public void testGetDataMaskBit() {
 216     int[][] mask0 = {
 217       {1, 0, 1, 0, 1, 0},
 218       {0, 1, 0, 1, 0, 1},
 219       {1, 0, 1, 0, 1, 0},
 220       {0, 1, 0, 1, 0, 1},
 221       {1, 0, 1, 0, 1, 0},
 222       {0, 1, 0, 1, 0, 1},
 223     };
 224     assertTrue(TestGetDataMaskBitInternal(0,  mask0));
 225     int[][] mask1 = {
 226       {1, 1, 1, 1, 1, 1},
 227       {0, 0, 0, 0, 0, 0},
 228       {1, 1, 1, 1, 1, 1},
 229       {0, 0, 0, 0, 0, 0},
 230       {1, 1, 1, 1, 1, 1},
 231       {0, 0, 0, 0, 0, 0},
 232     };
 233     assertTrue(TestGetDataMaskBitInternal(1,  mask1));
 234     int[][] mask2 = {
 235       {1, 0, 0, 1, 0, 0},
 236       {1, 0, 0, 1, 0, 0},
 237       {1, 0, 0, 1, 0, 0},
 238       {1, 0, 0, 1, 0, 0},
 239       {1, 0, 0, 1, 0, 0},
 240       {1, 0, 0, 1, 0, 0},
 241     };
 242     assertTrue(TestGetDataMaskBitInternal(2, mask2));
 243     int[][] mask3 = {
 244       {1, 0, 0, 1, 0, 0},
 245       {0, 0, 1, 0, 0, 1},
 246       {0, 1, 0, 0, 1, 0},
 247       {1, 0, 0, 1, 0, 0},
 248       {0, 0, 1, 0, 0, 1},
 249       {0, 1, 0, 0, 1, 0},
 250     };
 251     assertTrue(TestGetDataMaskBitInternal(3, mask3));
 252     int[][] mask4 = {
 253       {1, 1, 1, 0, 0, 0},
 254       {1, 1, 1, 0, 0, 0},
 255       {0, 0, 0, 1, 1, 1},
 256       {0, 0, 0, 1, 1, 1},
 257       {1, 1, 1, 0, 0, 0},
 258       {1, 1, 1, 0, 0, 0},
 259     };
 260     assertTrue(TestGetDataMaskBitInternal(4, mask4));
 261     int[][] mask5 = {
 262       {1, 1, 1, 1, 1, 1},
 263       {1, 0, 0, 0, 0, 0},
 264       {1, 0, 0, 1, 0, 0},
 265       {1, 0, 1, 0, 1, 0},
 266       {1, 0, 0, 1, 0, 0},
 267       {1, 0, 0, 0, 0, 0},
 268     };
 269     assertTrue(TestGetDataMaskBitInternal(5, mask5));
 270     int[][] mask6 = {
 271       {1, 1, 1, 1, 1, 1},
 272       {1, 1, 1, 0, 0, 0},
 273       {1, 1, 0, 1, 1, 0},
 274       {1, 0, 1, 0, 1, 0},
 275       {1, 0, 1, 1, 0, 1},
 276       {1, 0, 0, 0, 1, 1},
 277     };
 278     assertTrue(TestGetDataMaskBitInternal(6, mask6));
 279     int[][] mask7 = {
 280       {1, 0, 1, 0, 1, 0},
 281       {0, 0, 0, 1, 1, 1},
 282       {1, 0, 0, 0, 1, 1},
 283       {0, 1, 0, 1, 0, 1},
 284       {1, 1, 1, 0, 0, 0},
 285       {0, 1, 1, 1, 0, 0},
 286     };
 287     assertTrue(TestGetDataMaskBitInternal(7, mask7));
 288   }
 289 }