fb7a7e84d64b0689a21fb160ef9c814c29cf4759
[zxing.git] / core / src / com / google / zxing / qrcode / detector / FinderPatternFinder.java
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 \r
17 package com.google.zxing.qrcode.detector;\r
18 \r
19 import com.google.zxing.DecodeHintType;\r
20 import com.google.zxing.MonochromeBitmapSource;\r
21 import com.google.zxing.ReaderException;\r
22 import com.google.zxing.ResultPoint;\r
23 import com.google.zxing.common.BitArray;\r
24 import com.google.zxing.common.Collections;\r
25 import com.google.zxing.common.Comparator;\r
26 \r
27 import java.util.Hashtable;\r
28 import java.util.Vector;\r
29 \r
30 /**\r
31  * <p>This class attempts to find finder patterns in a QR Code. Finder patterns are the square\r
32  * markers at three corners of a QR Code.</p>\r
33  *\r
34  * <p>This class is not thread-safe and should not be reused.</p>\r
35  *\r
36  * @author Sean Owen\r
37  */\r
38 public class FinderPatternFinder {\r
39 \r
40   private static final int CENTER_QUORUM = 2;\r
41   protected static final int MIN_SKIP = 3; // 1 pixel/module times 3 modules/center\r
42   protected static final int MAX_MODULES = 57; // support up to version 10 for mobile clients\r
43   private static final int INTEGER_MATH_SHIFT = 8;\r
44 \r
45   private final MonochromeBitmapSource image;\r
46   private final Vector possibleCenters;\r
47   private boolean hasSkipped;\r
48   private final int[] crossCheckStateCount;\r
49 \r
50   /**\r
51    * <p>Creates a finder that will search the image for three finder patterns.</p>\r
52    *\r
53    * @param image image to search\r
54    */\r
55   public FinderPatternFinder(MonochromeBitmapSource image) {\r
56     this.image = image;\r
57     this.possibleCenters = new Vector();\r
58     this.crossCheckStateCount = new int[5];\r
59   }\r
60 \r
61   protected MonochromeBitmapSource getImage() {\r
62     return image;\r
63   }\r
64 \r
65   protected Vector getPossibleCenters() {\r
66     return possibleCenters;\r
67   }\r
68 \r
69   FinderPatternInfo find(Hashtable hints) throws ReaderException {\r
70     boolean tryHarder = hints != null && hints.containsKey(DecodeHintType.TRY_HARDER);\r
71     int maxI = image.getHeight();\r
72     int maxJ = image.getWidth();\r
73     // We are looking for black/white/black/white/black modules in\r
74     // 1:1:3:1:1 ratio; this tracks the number of such modules seen so far\r
75 \r
76     // Let's assume that the maximum version QR Code we support takes up 1/4 the height of the\r
77     // image, and then account for the center being 3 modules in size. This gives the smallest\r
78     // number of pixels the center could be, so skip this often. When trying harder, look for all\r
79     // QR versions regardless of how dense they are.\r
80     int iSkip = (int) (maxI / (MAX_MODULES * 4.0f) * 3);\r
81     if (iSkip < MIN_SKIP || tryHarder) {\r
82       iSkip = MIN_SKIP;\r
83     }\r
84 \r
85     boolean done = false;\r
86     int[] stateCount = new int[5];\r
87     BitArray blackRow = new BitArray(maxJ);\r
88     for (int i = iSkip - 1; i < maxI && !done; i += iSkip) {\r
89       // Get a row of black/white values\r
90       blackRow = image.getBlackRow(i, blackRow, 0, maxJ);\r
91       stateCount[0] = 0;\r
92       stateCount[1] = 0;\r
93       stateCount[2] = 0;\r
94       stateCount[3] = 0;\r
95       stateCount[4] = 0;\r
96       int currentState = 0;\r
97       for (int j = 0; j < maxJ; j++) {\r
98         if (blackRow.get(j)) {\r
99           // Black pixel\r
100           if ((currentState & 1) == 1) { // Counting white pixels\r
101             currentState++;\r
102           }\r
103           stateCount[currentState]++;\r
104         } else { // White pixel\r
105           if ((currentState & 1) == 0) { // Counting black pixels\r
106             if (currentState == 4) { // A winner?\r
107               if (foundPatternCross(stateCount)) { // Yes\r
108                 boolean confirmed = handlePossibleCenter(stateCount, i, j);\r
109                 if (confirmed) {\r
110                   // Start examining every other line. Checking each line turned out to be too\r
111                   // expensive and didn't improve performance.\r
112                   iSkip = 2;\r
113                   if (hasSkipped) {\r
114                     done = haveMulitplyConfirmedCenters();\r
115                   } else {\r
116                     int rowSkip = findRowSkip();\r
117                     if (rowSkip > stateCount[2]) {\r
118                       // Skip rows between row of lower confirmed center\r
119                       // and top of presumed third confirmed center\r
120                       // but back up a bit to get a full chance of detecting\r
121                       // it, entire width of center of finder pattern\r
122 \r
123                       // Skip by rowSkip, but back off by stateCount[2] (size of last center\r
124                       // of pattern we saw) to be conservative, and also back off by iSkip which\r
125                       // is about to be re-added\r
126                       i += rowSkip - stateCount[2] - iSkip;\r
127                       j = maxJ - 1;\r
128                     }\r
129                   }\r
130                 } else {\r
131                   // Advance to next black pixel\r
132                   do {\r
133                     j++;\r
134                   } while (j < maxJ && !blackRow.get(j));\r
135                   j--; // back up to that last white pixel\r
136                 }\r
137                 // Clear state to start looking again\r
138                 currentState = 0;\r
139                 stateCount[0] = 0;\r
140                 stateCount[1] = 0;\r
141                 stateCount[2] = 0;\r
142                 stateCount[3] = 0;\r
143                 stateCount[4] = 0;\r
144               } else { // No, shift counts back by two\r
145                 stateCount[0] = stateCount[2];\r
146                 stateCount[1] = stateCount[3];\r
147                 stateCount[2] = stateCount[4];\r
148                 stateCount[3] = 1;\r
149                 stateCount[4] = 0;\r
150                 currentState = 3;\r
151               }\r
152             } else {\r
153               stateCount[++currentState]++;\r
154             }\r
155           } else { // Counting white pixels\r
156             stateCount[currentState]++;\r
157           }\r
158         }\r
159       }\r
160       if (foundPatternCross(stateCount)) {\r
161         boolean confirmed = handlePossibleCenter(stateCount, i, maxJ);\r
162         if (confirmed) {\r
163           iSkip = stateCount[0];\r
164           if (hasSkipped) {\r
165             // Found a third one\r
166             done = haveMulitplyConfirmedCenters();\r
167           }\r
168         }\r
169       }\r
170     }\r
171 \r
172     FinderPattern[] patternInfo = selectBestPatterns();\r
173     ResultPoint.orderBestPatterns(patternInfo);\r
174 \r
175     return new FinderPatternInfo(patternInfo);\r
176   }\r
177 \r
178   /**\r
179    * Given a count of black/white/black/white/black pixels just seen and an end position,\r
180    * figures the location of the center of this run.\r
181    */\r
182   private static float centerFromEnd(int[] stateCount, int end) {\r
183     return (float) (end - stateCount[4] - stateCount[3]) - stateCount[2] / 2.0f;\r
184   }\r
185 \r
186   /**\r
187    * @param stateCount count of black/white/black/white/black pixels just read\r
188    * @return true iff the proportions of the counts is close enough to the 1/1/3/1/1 ratios\r
189    *         used by finder patterns to be considered a match\r
190    */\r
191   protected static boolean foundPatternCross(int[] stateCount) {\r
192     int totalModuleSize = 0;\r
193     for (int i = 0; i < 5; i++) {\r
194       int count = stateCount[i];\r
195       if (count == 0) {\r
196         return false;\r
197       }\r
198       totalModuleSize += count;\r
199     }\r
200     if (totalModuleSize < 7) {\r
201       return false;\r
202     }\r
203     int moduleSize = (totalModuleSize << INTEGER_MATH_SHIFT) / 7;\r
204     int maxVariance = moduleSize / 2;\r
205     // Allow less than 50% variance from 1-1-3-1-1 proportions\r
206     return Math.abs(moduleSize - (stateCount[0] << INTEGER_MATH_SHIFT)) < maxVariance &&\r
207         Math.abs(moduleSize - (stateCount[1] << INTEGER_MATH_SHIFT)) < maxVariance &&\r
208         Math.abs(3 * moduleSize - (stateCount[2] << INTEGER_MATH_SHIFT)) < 3 * maxVariance &&\r
209         Math.abs(moduleSize - (stateCount[3] << INTEGER_MATH_SHIFT)) < maxVariance &&\r
210         Math.abs(moduleSize - (stateCount[4] << INTEGER_MATH_SHIFT)) < maxVariance;\r
211   }\r
212 \r
213   private int[] getCrossCheckStateCount() {\r
214     crossCheckStateCount[0] = 0;\r
215     crossCheckStateCount[1] = 0;\r
216     crossCheckStateCount[2] = 0;\r
217     crossCheckStateCount[3] = 0;\r
218     crossCheckStateCount[4] = 0;\r
219     return crossCheckStateCount;\r
220   }\r
221 \r
222   /**\r
223    * <p>After a horizontal scan finds a potential finder pattern, this method\r
224    * "cross-checks" by scanning down vertically through the center of the possible\r
225    * finder pattern to see if the same proportion is detected.</p>\r
226    *\r
227    * @param startI row where a finder pattern was detected\r
228    * @param centerJ center of the section that appears to cross a finder pattern\r
229    * @param maxCount maximum reasonable number of modules that should be\r
230    * observed in any reading state, based on the results of the horizontal scan\r
231    * @return vertical center of finder pattern, or {@link Float#NaN} if not found\r
232    */\r
233   private float crossCheckVertical(int startI, int centerJ, int maxCount, int originalStateCountTotal) {\r
234     MonochromeBitmapSource image = this.image;\r
235 \r
236     int maxI = image.getHeight();\r
237     int[] stateCount = getCrossCheckStateCount();\r
238 \r
239     // Start counting up from center\r
240     int i = startI;\r
241     while (i >= 0 && image.isBlack(centerJ, i)) {\r
242       stateCount[2]++;\r
243       i--;\r
244     }\r
245     if (i < 0) {\r
246       return Float.NaN;\r
247     }\r
248     while (i >= 0 && !image.isBlack(centerJ, i) && stateCount[1] <= maxCount) {\r
249       stateCount[1]++;\r
250       i--;\r
251     }\r
252     // If already too many modules in this state or ran off the edge:\r
253     if (i < 0 || stateCount[1] > maxCount) {\r
254       return Float.NaN;\r
255     }\r
256     while (i >= 0 && image.isBlack(centerJ, i) && stateCount[0] <= maxCount) {\r
257       stateCount[0]++;\r
258       i--;\r
259     }\r
260     if (stateCount[0] > maxCount) {\r
261       return Float.NaN;\r
262     }\r
263 \r
264     // Now also count down from center\r
265     i = startI + 1;\r
266     while (i < maxI && image.isBlack(centerJ, i)) {\r
267       stateCount[2]++;\r
268       i++;\r
269     }\r
270     if (i == maxI) {\r
271       return Float.NaN;\r
272     }\r
273     while (i < maxI && !image.isBlack(centerJ, i) && stateCount[3] < maxCount) {\r
274       stateCount[3]++;\r
275       i++;\r
276     }\r
277     if (i == maxI || stateCount[3] >= maxCount) {\r
278       return Float.NaN;\r
279     }\r
280     while (i < maxI && image.isBlack(centerJ, i) && stateCount[4] < maxCount) {\r
281       stateCount[4]++;\r
282       i++;\r
283     }\r
284     if (stateCount[4] >= maxCount) {\r
285       return Float.NaN;\r
286     }\r
287 \r
288     // If we found a finder-pattern-like section, but its size is more than 20% different than\r
289     // the original, assume it's a false positive\r
290     int stateCountTotal = stateCount[0] + stateCount[1] + stateCount[2] + stateCount[3] + stateCount[4];\r
291     if (5 * Math.abs(stateCountTotal - originalStateCountTotal) >= originalStateCountTotal) {\r
292       return Float.NaN;\r
293     }\r
294 \r
295     return foundPatternCross(stateCount) ? centerFromEnd(stateCount, i) : Float.NaN;\r
296   }\r
297 \r
298   /**\r
299    * <p>Like {@link #crossCheckVertical(int, int, int, int)}, and in fact is basically identical,\r
300    * except it reads horizontally instead of vertically. This is used to cross-cross\r
301    * check a vertical cross check and locate the real center of the alignment pattern.</p>\r
302    */\r
303   private float crossCheckHorizontal(int startJ, int centerI, int maxCount, int originalStateCountTotal) {\r
304     MonochromeBitmapSource image = this.image;\r
305 \r
306     int maxJ = image.getWidth();\r
307     int[] stateCount = getCrossCheckStateCount();\r
308 \r
309     int j = startJ;\r
310     while (j >= 0 && image.isBlack(j, centerI)) {\r
311       stateCount[2]++;\r
312       j--;\r
313     }\r
314     if (j < 0) {\r
315       return Float.NaN;\r
316     }\r
317     while (j >= 0 && !image.isBlack(j, centerI) && stateCount[1] <= maxCount) {\r
318       stateCount[1]++;\r
319       j--;\r
320     }\r
321     if (j < 0 || stateCount[1] > maxCount) {\r
322       return Float.NaN;\r
323     }\r
324     while (j >= 0 && image.isBlack(j, centerI) && stateCount[0] <= maxCount) {\r
325       stateCount[0]++;\r
326       j--;\r
327     }\r
328     if (stateCount[0] > maxCount) {\r
329       return Float.NaN;\r
330     }\r
331 \r
332     j = startJ + 1;\r
333     while (j < maxJ && image.isBlack(j, centerI)) {\r
334       stateCount[2]++;\r
335       j++;\r
336     }\r
337     if (j == maxJ) {\r
338       return Float.NaN;\r
339     }\r
340     while (j < maxJ && !image.isBlack(j, centerI) && stateCount[3] < maxCount) {\r
341       stateCount[3]++;\r
342       j++;\r
343     }\r
344     if (j == maxJ || stateCount[3] >= maxCount) {\r
345       return Float.NaN;\r
346     }\r
347     while (j < maxJ && image.isBlack(j, centerI) && stateCount[4] < maxCount) {\r
348       stateCount[4]++;\r
349       j++;\r
350     }\r
351     if (stateCount[4] >= maxCount) {\r
352       return Float.NaN;\r
353     }\r
354 \r
355     // If we found a finder-pattern-like section, but its size is significantly different than\r
356     // the original, assume it's a false positive\r
357     int stateCountTotal = stateCount[0] + stateCount[1] + stateCount[2] + stateCount[3] + stateCount[4];\r
358     if (5 * Math.abs(stateCountTotal - originalStateCountTotal) >= originalStateCountTotal) {\r
359       return Float.NaN;\r
360     }\r
361 \r
362     return foundPatternCross(stateCount) ? centerFromEnd(stateCount, j) : Float.NaN;\r
363   }\r
364 \r
365   /**\r
366    * <p>This is called when a horizontal scan finds a possible alignment pattern. It will\r
367    * cross check with a vertical scan, and if successful, will, ah, cross-cross-check\r
368    * with another horizontal scan. This is needed primarily to locate the real horizontal\r
369    * center of the pattern in cases of extreme skew.</p>\r
370    *\r
371    * <p>If that succeeds the finder pattern location is added to a list that tracks\r
372    * the number of times each location has been nearly-matched as a finder pattern.\r
373    * Each additional find is more evidence that the location is in fact a finder\r
374    * pattern center\r
375    *\r
376    * @param stateCount reading state module counts from horizontal scan\r
377    * @param i row where finder pattern may be found\r
378    * @param j end of possible finder pattern in row\r
379    * @return true if a finder pattern candidate was found this time\r
380    */\r
381   protected boolean handlePossibleCenter(int[] stateCount,\r
382                                        int i,\r
383                                        int j) {\r
384     int stateCountTotal = stateCount[0] + stateCount[1] + stateCount[2] + stateCount[3] + stateCount[4];\r
385     float centerJ = centerFromEnd(stateCount, j);\r
386     float centerI = crossCheckVertical(i, (int) centerJ, stateCount[2], stateCountTotal);\r
387     if (!Float.isNaN(centerI)) {\r
388       // Re-cross check\r
389       centerJ = crossCheckHorizontal((int) centerJ, (int) centerI, stateCount[2], stateCountTotal);\r
390       if (!Float.isNaN(centerJ)) {\r
391         float estimatedModuleSize = (float) stateCountTotal / 7.0f;\r
392         boolean found = false;\r
393         int max = possibleCenters.size();\r
394         for (int index = 0; index < max; index++) {\r
395           FinderPattern center = (FinderPattern) possibleCenters.elementAt(index);\r
396           // Look for about the same center and module size:\r
397           if (center.aboutEquals(estimatedModuleSize, centerI, centerJ)) {\r
398             center.incrementCount();\r
399             found = true;\r
400             break;\r
401           }\r
402         }\r
403         if (!found) {\r
404           possibleCenters.addElement(new FinderPattern(centerJ, centerI, estimatedModuleSize));\r
405         }\r
406         return true;\r
407       }\r
408     }\r
409     return false;\r
410   }\r
411 \r
412   /**\r
413    * @return number of rows we could safely skip during scanning, based on the first\r
414    *         two finder patterns that have been located. In some cases their position will\r
415    *         allow us to infer that the third pattern must lie below a certain point farther\r
416    *         down in the image.\r
417    */\r
418   private int findRowSkip() {\r
419     int max = possibleCenters.size();\r
420     if (max <= 1) {\r
421       return 0;\r
422     }\r
423     FinderPattern firstConfirmedCenter = null;\r
424     for (int i = 0; i < max; i++) {\r
425       FinderPattern center = (FinderPattern) possibleCenters.elementAt(i);\r
426       if (center.getCount() >= CENTER_QUORUM) {\r
427         if (firstConfirmedCenter == null) {\r
428           firstConfirmedCenter = center;\r
429         } else {\r
430           // We have two confirmed centers\r
431           // How far down can we skip before resuming looking for the next\r
432           // pattern? In the worst case, only the difference between the\r
433           // difference in the x / y coordinates of the two centers.\r
434           // This is the case where you find top left last.\r
435           hasSkipped = true;\r
436           return (int) (Math.abs(firstConfirmedCenter.getX() - center.getX()) -\r
437               Math.abs(firstConfirmedCenter.getY() - center.getY())) / 2;\r
438         }\r
439       }\r
440     }\r
441     return 0;\r
442   }\r
443 \r
444   /**\r
445    * @return true iff we have found at least 3 finder patterns that have been detected\r
446    *         at least {@link #CENTER_QUORUM} times each, and, the estimated module size of the\r
447    *         candidates is "pretty similar"\r
448    */\r
449   private boolean haveMulitplyConfirmedCenters() {\r
450     int confirmedCount = 0;\r
451     float totalModuleSize = 0.0f;\r
452     int max = possibleCenters.size();\r
453     for (int i = 0; i < max; i++) {\r
454       FinderPattern pattern = (FinderPattern) possibleCenters.elementAt(i);\r
455       if (pattern.getCount() >= CENTER_QUORUM) {\r
456         confirmedCount++;\r
457         totalModuleSize += pattern.getEstimatedModuleSize();\r
458       }\r
459     }\r
460     if (confirmedCount < 3) {\r
461       return false;\r
462     }\r
463     // OK, we have at least 3 confirmed centers, but, it's possible that one is a "false positive"\r
464     // and that we need to keep looking. We detect this by asking if the estimated module sizes\r
465     // vary too much. We arbitrarily say that when the total deviation from average exceeds\r
466     // 15% of the total module size estimates, it's too much.\r
467     float average = totalModuleSize / max;\r
468     float totalDeviation = 0.0f;\r
469     for (int i = 0; i < max; i++) {\r
470       FinderPattern pattern = (FinderPattern) possibleCenters.elementAt(i);\r
471       totalDeviation += Math.abs(pattern.getEstimatedModuleSize() - average);\r
472     }\r
473     return totalDeviation <= 0.05f * totalModuleSize;\r
474   }\r
475 \r
476   /**\r
477    * @return the 3 best {@link FinderPattern}s from our list of candidates. The "best" are\r
478    *         those that have been detected at least {@link #CENTER_QUORUM} times, and whose module\r
479    *         size differs from the average among those patterns the least\r
480    * @throws ReaderException if 3 such finder patterns do not exist\r
481    */\r
482   private FinderPattern[] selectBestPatterns() throws ReaderException {\r
483     Collections.insertionSort(possibleCenters, new CenterComparator());\r
484     int size = 0;\r
485     int max = possibleCenters.size();\r
486     while (size < max) {\r
487       if (((FinderPattern) possibleCenters.elementAt(size)).getCount() < CENTER_QUORUM) {\r
488         break;\r
489       }\r
490       size++;\r
491     }\r
492 \r
493     if (size < 3) {\r
494       // Couldn't find enough finder patterns\r
495       throw ReaderException.getInstance();\r
496     }\r
497 \r
498     if (size > 3) {\r
499       // Throw away all but those first size candidate points we found.\r
500       possibleCenters.setSize(size);\r
501       //  We need to pick the best three. Find the most\r
502       // popular ones whose module size is nearest the average\r
503       float averageModuleSize = 0.0f;\r
504       for (int i = 0; i < size; i++) {\r
505         averageModuleSize += ((FinderPattern) possibleCenters.elementAt(i)).getEstimatedModuleSize();\r
506       }\r
507       averageModuleSize /= (float) size;\r
508       // We don't have java.util.Collections in J2ME\r
509       Collections.insertionSort(possibleCenters, new ClosestToAverageComparator(averageModuleSize));\r
510     }\r
511 \r
512     return new FinderPattern[]{\r
513         (FinderPattern) possibleCenters.elementAt(0),\r
514         (FinderPattern) possibleCenters.elementAt(1),\r
515         (FinderPattern) possibleCenters.elementAt(2)\r
516     };\r
517   }\r
518 \r
519   /**\r
520    * <p>Orders by {@link FinderPattern#getCount()}, descending.</p>\r
521    */\r
522   private static class CenterComparator implements Comparator {\r
523     public int compare(Object center1, Object center2) {\r
524       return ((FinderPattern) center2).getCount() - ((FinderPattern) center1).getCount();\r
525     }\r
526   }\r
527 \r
528   /**\r
529    * <p>Orders by variance from average module size, ascending.</p>\r
530    */\r
531   private static class ClosestToAverageComparator implements Comparator {\r
532     private final float averageModuleSize;\r
533 \r
534     private ClosestToAverageComparator(float averageModuleSize) {\r
535       this.averageModuleSize = averageModuleSize;\r
536     }\r
537 \r
538     public int compare(Object center1, Object center2) {\r
539       return Math.abs(((FinderPattern) center1).getEstimatedModuleSize() - averageModuleSize) <\r
540           Math.abs(((FinderPattern) center2).getEstimatedModuleSize() - averageModuleSize) ?\r
541           -1 :\r
542           1;\r
543     }\r
544   }\r
545 \r
546 }\r