Add Code 93 support. Update tests to reflect new (better) number of successes.
[zxing.git] / core / src / com / google / zxing / oned / Code39Reader.java
index fe93251..0bc66bf 100644 (file)
@@ -17,7 +17,9 @@
 package com.google.zxing.oned;
 
 import com.google.zxing.BarcodeFormat;
-import com.google.zxing.ReaderException;
+import com.google.zxing.ChecksumException;
+import com.google.zxing.FormatException;
+import com.google.zxing.NotFoundException;
 import com.google.zxing.Result;
 import com.google.zxing.ResultPoint;
 import com.google.zxing.common.BitArray;
@@ -28,10 +30,11 @@ import java.util.Hashtable;
  * <p>Decodes Code 39 barcodes. This does not support "Full ASCII Code 39" yet.</p>
  *
  * @author Sean Owen
+ * @see Code93Reader
  */
-public final class Code39Reader extends AbstractOneDReader {
+public final class Code39Reader extends OneDReader {
 
-  private static final String ALPHABET_STRING = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ-. *$/+%";
+  static final String ALPHABET_STRING = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ-. *$/+%";
   private static final char[] ALPHABET = ALPHABET_STRING.toCharArray();
 
   /**
@@ -39,7 +42,7 @@ public final class Code39Reader extends AbstractOneDReader {
    * The 9 least-significant bits of each int correspond to the pattern of wide and narrow,
    * with 1s representing "wide" and 0s representing narrow.
    */
-  private static final int[] CHARACTER_ENCODINGS = {
+  static final int[] CHARACTER_ENCODINGS = {
       0x034, 0x121, 0x061, 0x160, 0x031, 0x130, 0x070, 0x025, 0x124, 0x064, // 0-9
       0x109, 0x049, 0x148, 0x019, 0x118, 0x058, 0x00D, 0x10C, 0x04C, 0x01C, // A-J
       0x103, 0x043, 0x142, 0x013, 0x112, 0x052, 0x007, 0x106, 0x046, 0x016, // K-T
@@ -88,7 +91,8 @@ public final class Code39Reader extends AbstractOneDReader {
     this.extendedMode = extendedMode;
   }
 
-  public Result decodeRow(int rowNumber, BitArray row, Hashtable hints) throws ReaderException {
+  public Result decodeRow(int rowNumber, BitArray row, Hashtable hints)
+      throws NotFoundException, ChecksumException, FormatException {
 
     int[] start = findAsteriskPattern(row);
     int nextStart = start[1];
@@ -99,13 +103,16 @@ public final class Code39Reader extends AbstractOneDReader {
       nextStart++;
     }
 
-    StringBuffer result = new StringBuffer();
+    StringBuffer result = new StringBuffer(20);
     int[] counters = new int[9];
     char decodedChar;
     int lastStart;
     do {
       recordPattern(row, nextStart, counters);
       int pattern = toNarrowWidePattern(counters);
+      if (pattern < 0) {
+        throw NotFoundException.getNotFoundInstance();
+      }
       decodedChar = patternToChar(pattern);
       result.append(decodedChar);
       lastStart = nextStart;
@@ -128,7 +135,7 @@ public final class Code39Reader extends AbstractOneDReader {
     // If 50% of last pattern size, following last pattern, is not whitespace, fail
     // (but if it's whitespace to the very end of the image, that's OK)
     if (nextStart != end && whiteSpaceAfterEnd / 2 < lastPatternSize) {
-      throw ReaderException.getInstance();
+      throw NotFoundException.getNotFoundInstance();
     }
 
     if (usingCheckDigit) {
@@ -137,20 +144,22 @@ public final class Code39Reader extends AbstractOneDReader {
       for (int i = 0; i < max; i++) {
         total += ALPHABET_STRING.indexOf(result.charAt(i));
       }
-      if (total % 43 != ALPHABET_STRING.indexOf(result.charAt(max))) {
-        throw ReaderException.getInstance();
+      if (result.charAt(max) != ALPHABET[total % 43]) {
+        throw ChecksumException.getChecksumInstance();
       }
       result.deleteCharAt(max);
     }
 
-    String resultString = result.toString();
-    if (extendedMode) {
-      resultString = decodeExtended(resultString);
+    if (result.length() == 0) {
+      // Almost surely a false positive
+      throw NotFoundException.getNotFoundInstance();
     }
 
-    if (resultString.length() == 0) {
-      // Almost surely a false positive
-      throw ReaderException.getInstance();
+    String resultString;
+    if (extendedMode) {
+      resultString = decodeExtended(result);
+    } else {
+      resultString = result.toString();
     }
 
     float left = (float) (start[1] + start[0]) / 2.0f;
@@ -165,7 +174,7 @@ public final class Code39Reader extends AbstractOneDReader {
 
   }
 
-  private static int[] findAsteriskPattern(BitArray row) throws ReaderException {
+  private static int[] findAsteriskPattern(BitArray row) throws NotFoundException {
     int width = row.getSize();
     int rowOffset = 0;
     while (rowOffset < width) {
@@ -187,15 +196,11 @@ public final class Code39Reader extends AbstractOneDReader {
         counters[counterPosition]++;
       } else {
         if (counterPosition == patternLength - 1) {
-          try {
-            if (toNarrowWidePattern(counters) == ASTERISK_ENCODING) {
-              // Look for whitespace before start pattern, >= 50% of width of start pattern
-              if (row.isRange(Math.max(0, patternStart - (i - patternStart) / 2), patternStart, false)) {
-                return new int[]{patternStart, i};
-              }
+          if (toNarrowWidePattern(counters) == ASTERISK_ENCODING) {
+            // Look for whitespace before start pattern, >= 50% of width of start pattern
+            if (row.isRange(Math.max(0, patternStart - (i - patternStart) / 2), patternStart, false)) {
+              return new int[]{patternStart, i};
             }
-          } catch (ReaderException re) {
-            // no match, continue
           }
           patternStart += counters[0] + counters[1];
           for (int y = 2; y < patternLength; y++) {
@@ -208,13 +213,15 @@ public final class Code39Reader extends AbstractOneDReader {
           counterPosition++;
         }
         counters[counterPosition] = 1;
-        isWhite ^= true; // isWhite = !isWhite;
+        isWhite = !isWhite;
       }
     }
-    throw ReaderException.getInstance();
+    throw NotFoundException.getNotFoundInstance();
   }
 
-  private static int toNarrowWidePattern(int[] counters) throws ReaderException {
+  // For efficiency, returns -1 on failure. Not throwing here saved as many as 700 exceptions
+  // per image when using some of our blackbox images.
+  private static int toNarrowWidePattern(int[] counters) {
     int numCounters = counters.length;
     int maxNarrowCounter = 0;
     int wideCounters;
@@ -248,26 +255,26 @@ public final class Code39Reader extends AbstractOneDReader {
             wideCounters--;
             // totalWideCountersWidth = 3 * average, so this checks if counter >= 3/2 * average
             if ((counter << 1) >= totalWideCountersWidth) {
-              throw ReaderException.getInstance();
+              return -1;
             }
           }
         }
         return pattern;
       }
     } while (wideCounters > 3);
-    throw ReaderException.getInstance();
+    return -1;
   }
 
-  private static char patternToChar(int pattern) throws ReaderException {
+  private static char patternToChar(int pattern) throws NotFoundException {
     for (int i = 0; i < CHARACTER_ENCODINGS.length; i++) {
       if (CHARACTER_ENCODINGS[i] == pattern) {
         return ALPHABET[i];
       }
     }
-    throw ReaderException.getInstance();
+    throw NotFoundException.getNotFoundInstance();
   }
 
-  private static String decodeExtended(String encoded) throws ReaderException {
+  private static String decodeExtended(StringBuffer encoded) throws FormatException {
     int length = encoded.length();
     StringBuffer decoded = new StringBuffer(length);
     for (int i = 0; i < length; i++) {
@@ -281,7 +288,7 @@ public final class Code39Reader extends AbstractOneDReader {
             if (next >= 'A' && next <= 'Z') {
               decodedChar = (char) (next + 32);
             } else {
-              throw ReaderException.getInstance();
+              throw FormatException.getFormatInstance();
             }
             break;
           case '$':
@@ -289,7 +296,7 @@ public final class Code39Reader extends AbstractOneDReader {
             if (next >= 'A' && next <= 'Z') {
               decodedChar = (char) (next - 64);
             } else {
-              throw ReaderException.getInstance();
+              throw FormatException.getFormatInstance();
             }
             break;
           case '%':
@@ -299,7 +306,7 @@ public final class Code39Reader extends AbstractOneDReader {
             } else if (next >= 'F' && next <= 'W') {
               decodedChar = (char) (next - 11);
             } else {
-              throw ReaderException.getInstance();
+              throw FormatException.getFormatInstance();
             }
             break;
           case '/':
@@ -309,7 +316,7 @@ public final class Code39Reader extends AbstractOneDReader {
             } else if (next == 'Z') {
               decodedChar = ':';
             } else {
-              throw ReaderException.getInstance();
+              throw FormatException.getFormatInstance();
             }
             break;
         }