core/src/com/google/zxing/oned/AbstractUPCEANReader.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.oned;
  18
  19 import com.google.zxing.BarcodeFormat;
  20 import com.google.zxing.ReaderException;
  21 import com.google.zxing.Result;
  22 import com.google.zxing.ResultPoint;
  23 import com.google.zxing.common.BitArray;
  24 import com.google.zxing.common.GenericResultPoint;
  25
  26 import java.util.Hashtable;
  27
  28 /**
  29  * <p>Encapsulates functionality and implementation that is common to UPC and EAN families
  30  * of one-dimensional barcodes.</p>
  31  *
  32  * @author dswitkin@google.com (Daniel Switkin)
  33  * @author srowen@google.com (Sean Owen)
  34  * @author alasdair@google.com (Alasdair Mackintosh)
  35  */
  36 public abstract class AbstractUPCEANReader extends AbstractOneDReader implements UPCEANReader {
  37
  38   private static final int MAX_AVG_VARIANCE = (int) (PATTERN_MATCH_RESULT_SCALE_FACTOR * 0.42f);
  39   private static final int MAX_INDIVIDUAL_VARIANCE = (int) (PATTERN_MATCH_RESULT_SCALE_FACTOR * 0.7f);
  40
  41   /**
  42    * Start/end guard pattern.
  43    */
  44   private static final int[] START_END_PATTERN = {1, 1, 1,};
  45
  46   /**
  47    * Pattern marking the middle of a UPC/EAN pattern, separating the two halves.
  48    */
  49   static final int[] MIDDLE_PATTERN = {1, 1, 1, 1, 1};
  50
  51   /**
  52    * "Odd", or "L" patterns used to encode UPC/EAN digits.
  53    */
  54   static final int[][] L_PATTERNS = {
  55       {3, 2, 1, 1}, // 0
  56       {2, 2, 2, 1}, // 1
  57       {2, 1, 2, 2}, // 2
  58       {1, 4, 1, 1}, // 3
  59       {1, 1, 3, 2}, // 4
  60       {1, 2, 3, 1}, // 5
  61       {1, 1, 1, 4}, // 6
  62       {1, 3, 1, 2}, // 7
  63       {1, 2, 1, 3}, // 8
  64       {3, 1, 1, 2}  // 9
  65   };
  66
  67   /**
  68    * As above but also including the "even", or "G" patterns used to encode UPC/EAN digits.
  69    */
  70   static final int[][] L_AND_G_PATTERNS;
  71
  72   static {
  73     L_AND_G_PATTERNS = new int[20][];
  74     for (int i = 0; i < 10; i++) {
  75       L_AND_G_PATTERNS[i] = L_PATTERNS[i];
  76     }
  77     for (int i = 10; i < 20; i++) {
  78       int[] widths = L_PATTERNS[i - 10];
  79       int[] reversedWidths = new int[widths.length];
  80       for (int j = 0; j < widths.length; j++) {
  81         reversedWidths[j] = widths[widths.length - j - 1];
  82       }
  83       L_AND_G_PATTERNS[i] = reversedWidths;
  84     }
  85   }
  86
  87   static int[] findStartGuardPattern(BitArray row) throws ReaderException {
  88     boolean foundStart = false;
  89     int[] startRange = null;
  90     int nextStart = 0;
  91     while (!foundStart) {
  92       startRange = findGuardPattern(row, nextStart, false, START_END_PATTERN);
  93       int start = startRange[0];
  94       nextStart = startRange[1];
  95       // Make sure there is a quiet zone at least as big as the start pattern before the barcode. If
  96       // this check would run off the left edge of the image, do not accept this barcode, as it is
  97       // very likely to be a false positive.
  98       int quietStart = start - (nextStart - start);
  99       if (quietStart >= 0) {
 100         foundStart = row.isRange(quietStart, start, false);
 101       }
 102     }
 103     return startRange;
 104   }
 105
 106   public final Result decodeRow(int rowNumber, BitArray row, Hashtable hints) throws ReaderException {
 107     return decodeRow(rowNumber, row, findStartGuardPattern(row));
 108   }
 109
 110   public final Result decodeRow(int rowNumber, BitArray row, int[] startGuardRange) throws ReaderException {
 111     StringBuffer result = new StringBuffer(20);
 112     int endStart = decodeMiddle(row, startGuardRange, result);
 113     int[] endRange = decodeEnd(row, endStart);
 114
 115     // Make sure there is a quiet zone at least as big as the end pattern after the barcode. The
 116     // spec might want more whitespace, but in practice this is the maximum we can count on.
 117     int end = endRange[1];
 118     int quietEnd = end + (end - endRange[0]);
 119     if (quietEnd >= row.getSize() || !row.isRange(end, quietEnd, false)) {
 120       throw new ReaderException("Pattern not followed by whitespace");
 121     }
 122
 123     String resultString = result.toString();
 124     if (!checkChecksum(resultString)) {
 125       throw new ReaderException("Checksum failed");
 126     }
 127
 128     float left = (float) (startGuardRange[1] + startGuardRange[0]) / 2.0f;
 129     float right = (float) (endRange[1] + endRange[0]) / 2.0f;
 130     return new Result(resultString,
 131         null, // no natural byte representation for these barcodes
 132         new ResultPoint[]{
 133             new GenericResultPoint(left, (float) rowNumber),
 134             new GenericResultPoint(right, (float) rowNumber)},
 135         getBarcodeFormat());
 136   }
 137
 138   abstract BarcodeFormat getBarcodeFormat();
 139
 140   /**
 141    * Computes the UPC/EAN checksum on a string of digits, and reports
 142    * whether the checksum is correct or not.
 143    *
 144    * @param s string of digits to check
 145    * @return true iff string of digits passes the UPC/EAN checksum algorithm
 146    * @throws ReaderException if the string does not contain only digits
 147    */
 148   boolean checkChecksum(String s) throws ReaderException {
 149     int length = s.length();
 150     if (length == 0) {
 151       return false;
 152     }
 153
 154     int sum = 0;
 155     for (int i = length - 2; i >= 0; i -= 2) {
 156       int digit = (int) s.charAt(i) - (int) '0';
 157       if (digit < 0 || digit > 9) {
 158         throw new ReaderException("Illegal character during checksum");
 159       }
 160       sum += digit;
 161     }
 162     sum *= 3;
 163     for (int i = length - 1; i >= 0; i -= 2) {
 164       int digit = (int) s.charAt(i) - (int) '0';
 165       if (digit < 0 || digit > 9) {
 166         throw new ReaderException("Illegal character during checksum");
 167       }
 168       sum += digit;
 169     }
 170     return sum % 10 == 0;
 171   }
 172
 173   /**
 174    * Subclasses override this to decode the portion of a barcode between the start and end guard patterns.
 175    *
 176    * @param row row of black/white values to search
 177    * @param startRange start/end offset of start guard pattern
 178    * @param resultString {@link StringBuffer} to append decoded chars to
 179    * @return horizontal offset of first pixel after the "middle" that was decoded
 180    * @throws ReaderException if decoding could not complete successfully
 181    */
 182   protected abstract int decodeMiddle(BitArray row, int[] startRange, StringBuffer resultString)
 183       throws ReaderException;
 184
 185   int[] decodeEnd(BitArray row, int endStart) throws ReaderException {
 186     return findGuardPattern(row, endStart, false, START_END_PATTERN);
 187   }
 188
 189   /**
 190    * @param row row of black/white values to search
 191    * @param rowOffset position to start search
 192    * @param whiteFirst if true, indicates that the pattern specifies white/black/white/...
 193    * pixel counts, otherwise, it is interpreted as black/white/black/...
 194    * @param pattern pattern of counts of number of black and white pixels that are being
 195    * searched for as a pattern
 196    * @return start/end horizontal offset of guard pattern, as an array of two ints
 197    * @throws ReaderException if pattern is not found
 198    */
 199   static int[] findGuardPattern(BitArray row, int rowOffset, boolean whiteFirst, int[] pattern)
 200       throws ReaderException {
 201     int patternLength = pattern.length;
 202     int[] counters = new int[patternLength];
 203     int width = row.getSize();
 204     boolean isWhite = false;
 205     while (rowOffset < width) {
 206       isWhite = !row.get(rowOffset);
 207       if (whiteFirst == isWhite) {
 208         break;
 209       }
 210       rowOffset++;
 211     }
 212
 213     int counterPosition = 0;
 214     int patternStart = rowOffset;
 215     for (int x = rowOffset; x < width; x++) {
 216       boolean pixel = row.get(x);
 217       if ((!pixel && isWhite) || (pixel && !isWhite)) {
 218         counters[counterPosition]++;
 219       } else {
 220         if (counterPosition == patternLength - 1) {
 221           if (patternMatchVariance(counters, pattern, MAX_INDIVIDUAL_VARIANCE) < MAX_AVG_VARIANCE) {
 222             return new int[]{patternStart, x};
 223           }
 224           patternStart += counters[0] + counters[1];
 225           for (int y = 2; y < patternLength; y++) {
 226             counters[y - 2] = counters[y];
 227           }
 228           counters[patternLength - 2] = 0;
 229           counters[patternLength - 1] = 0;
 230           counterPosition--;
 231         } else {
 232           counterPosition++;
 233         }
 234         counters[counterPosition] = 1;
 235         isWhite = !isWhite;
 236       }
 237     }
 238     throw new ReaderException("Can't find pattern");
 239   }
 240
 241   /**
 242    * Attempts to decode a single UPC/EAN-encoded digit.
 243    *
 244    * @param row row of black/white values to decode
 245    * @param counters the counts of runs of observed black/white/black/... values
 246    * @param rowOffset horizontal offset to start decoding from
 247    * @param patterns the set of patterns to use to decode -- sometimes different encodings
 248    * for the digits 0-9 are used, and this indicates the encodings for 0 to 9 that should
 249    * be used
 250    * @return horizontal offset of first pixel beyond the decoded digit
 251    * @throws ReaderException if digit cannot be decoded
 252    */
 253   static int decodeDigit(BitArray row, int[] counters, int rowOffset, int[][] patterns)
 254       throws ReaderException {
 255     recordPattern(row, rowOffset, counters);
 256     int bestVariance = MAX_AVG_VARIANCE; // worst variance we'll accept
 257     int bestMatch = -1;
 258     int max = patterns.length;
 259     for (int i = 0; i < max; i++) {
 260       int[] pattern = patterns[i];
 261       int variance = patternMatchVariance(counters, pattern, MAX_INDIVIDUAL_VARIANCE);
 262       if (variance < bestVariance) {
 263         bestVariance = variance;
 264         bestMatch = i;
 265       }
 266     }
 267     if (bestMatch >= 0) {
 268       return bestMatch;
 269     } else {
 270       throw new ReaderException("Could not match any digit in pattern");
 271     }
 272   }
 273
 274 }