Fix corner case - pure barcode, 1 pixel module
[zxing.git] / core / src / com / google / zxing / qrcode / QRCodeReader.java
index 25ecece..2a12c6d 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright 2007 Google Inc.
+ * Copyright 2007 ZXing authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 package com.google.zxing.qrcode;
 
 import com.google.zxing.BarcodeFormat;
+import com.google.zxing.BinaryBitmap;
+import com.google.zxing.ChecksumException;
 import com.google.zxing.DecodeHintType;
-import com.google.zxing.MonochromeBitmapSource;
+import com.google.zxing.FormatException;
+import com.google.zxing.NotFoundException;
 import com.google.zxing.Reader;
-import com.google.zxing.ReaderException;
 import com.google.zxing.Result;
+import com.google.zxing.ResultMetadataType;
 import com.google.zxing.ResultPoint;
 import com.google.zxing.common.BitMatrix;
+import com.google.zxing.common.DecoderResult;
 import com.google.zxing.common.DetectorResult;
 import com.google.zxing.qrcode.decoder.Decoder;
 import com.google.zxing.qrcode.detector.Detector;
@@ -33,38 +37,56 @@ import java.util.Hashtable;
 /**
  * This implementation can detect and decode QR Codes in an image.
  *
- * @author srowen@google.com (Sean Owen)
+ * @author Sean Owen
  */
-public final class QRCodeReader implements Reader {
+public class QRCodeReader implements Reader {
 
   private static final ResultPoint[] NO_POINTS = new ResultPoint[0];
 
   private final Decoder decoder = new Decoder();
 
+  protected Decoder getDecoder() {
+    return decoder;
+  }
+
   /**
    * Locates and decodes a QR code in an image.
    *
    * @return a String representing the content encoded by the QR code
-   * @throws ReaderException if a QR code cannot be found, or cannot be decoded
+   * @throws NotFoundException if a QR code cannot be found
+   * @throws FormatException if a QR code cannot be decoded
+   * @throws ChecksumException if error correction fails
    */
-  public Result decode(MonochromeBitmapSource image) throws ReaderException {
+  public Result decode(BinaryBitmap image) throws NotFoundException, ChecksumException, FormatException {
     return decode(image, null);
   }
 
-  public Result decode(MonochromeBitmapSource image, Hashtable hints)
-      throws ReaderException {
-    String text;
+  public Result decode(BinaryBitmap image, Hashtable hints)
+      throws NotFoundException, ChecksumException, FormatException {
+    DecoderResult decoderResult;
     ResultPoint[] points;
     if (hints != null && hints.containsKey(DecodeHintType.PURE_BARCODE)) {
-      BitMatrix bits = extractPureBits(image);
-      text = decoder.decode(bits);
+      BitMatrix bits = extractPureBits(image.getBlackMatrix());
+      decoderResult = decoder.decode(bits, hints);
       points = NO_POINTS;
     } else {
-      DetectorResult result = new Detector(image).detect();
-      text = decoder.decode(result.getBits());
-      points = result.getPoints();
+      DetectorResult detectorResult = new Detector(image.getBlackMatrix()).detect(hints);
+      decoderResult = decoder.decode(detectorResult.getBits(), hints);
+      points = detectorResult.getPoints();
+    }
+
+    Result result = new Result(decoderResult.getText(), decoderResult.getRawBytes(), points, BarcodeFormat.QR_CODE);
+    if (decoderResult.getByteSegments() != null) {
+      result.putMetadata(ResultMetadataType.BYTE_SEGMENTS, decoderResult.getByteSegments());
     }
-    return new Result(text, points, BarcodeFormat.QR_CODE);
+    if (decoderResult.getECLevel() != null) {
+      result.putMetadata(ResultMetadataType.ERROR_CORRECTION_LEVEL, decoderResult.getECLevel().toString());
+    }
+    return result;
+  }
+
+  public void reset() {
+    // do nothing
   }
 
   /**
@@ -73,64 +95,72 @@ public final class QRCodeReader implements Reader {
    * around it. This is a specialized method that works exceptionally fast in this special
    * case.
    */
-  private static BitMatrix extractPureBits(MonochromeBitmapSource image) throws ReaderException {
-    // Now need to determine module size in pixels
+  public static BitMatrix extractPureBits(BitMatrix image) throws NotFoundException {
 
-    int minDimension = Math.min(image.getHeight(), image.getWidth());
-
-    // First, skip white border by tracking diagonally from the top left down and to the right:
-    int borderWidth = 0;
-    while (borderWidth < minDimension && !image.isBlack(borderWidth, borderWidth)) {
-      borderWidth++;
-    }
-    if (borderWidth == minDimension) {
-      throw new ReaderException("No black pixels found along diagonal");
-    }
+    int height = image.getHeight();
+    int width = image.getWidth();
+    int minDimension = Math.min(height, width);
 
     // And then keep tracking across the top-left black module to determine module size
-    int moduleEnd = borderWidth;
-    while (moduleEnd < minDimension && image.isBlack(moduleEnd, moduleEnd)) {
-      moduleEnd++;
+    //int moduleEnd = borderWidth;
+    int[] leftTopBlack = image.getTopLeftOnBit();
+    if (leftTopBlack == null) {
+      throw NotFoundException.getNotFoundInstance();
     }
-    if (moduleEnd == minDimension) {
-      throw new ReaderException("No end to black pixels found along diagonal");
+    int x = leftTopBlack[0];
+    int y = leftTopBlack[1];
+    while (x < minDimension && y < minDimension && image.get(x, y)) {
+      x++;
+      y++;
+    }
+    if (x == minDimension || y == minDimension) {
+      throw NotFoundException.getNotFoundInstance();
     }
 
-    int moduleSize = moduleEnd - borderWidth;
+    int moduleSize = x - leftTopBlack[0];
+    if (moduleSize == 0) {
+      throw NotFoundException.getNotFoundInstance();
+    }
 
     // And now find where the rightmost black module on the first row ends
-    int rowEndOfSymbol = image.getWidth() - 1;
-    while (rowEndOfSymbol >= 0 && !image.isBlack(rowEndOfSymbol, borderWidth)) {
+    int rowEndOfSymbol = width - 1;
+    while (rowEndOfSymbol > x && !image.get(rowEndOfSymbol, y)) {
       rowEndOfSymbol--;
     }
-    if (rowEndOfSymbol < 0) {
-      throw new ReaderException("Can't find end of rightmost black module");
+    if (rowEndOfSymbol <= x) {
+      throw NotFoundException.getNotFoundInstance();
     }
     rowEndOfSymbol++;
 
     // Make sure width of barcode is a multiple of module size
-    if ((rowEndOfSymbol - borderWidth) % moduleSize != 0) {
-      throw new ReaderException("Bad module size / width: " + moduleSize +
-          " / " + (rowEndOfSymbol - borderWidth));
+    if ((rowEndOfSymbol - x) % moduleSize != 0) {
+      throw NotFoundException.getNotFoundInstance();
     }
-    int dimension = (rowEndOfSymbol - borderWidth) / moduleSize;
+    int dimension = 1 + ((rowEndOfSymbol - x) / moduleSize);
 
     // Push in the "border" by half the module width so that we start
     // sampling in the middle of the module. Just in case the image is a
-    // little off, this will help recover.
-    borderWidth += moduleSize >> 1;
+    // little off, this will help recover. Need to back up at least 1.
+    int backOffAmount = moduleSize == 1 ? 1 : moduleSize >> 1;
+    x -= backOffAmount;
+    y -= backOffAmount;
+
+    if ((x + (dimension - 1) * moduleSize) >= width ||
+        (y + (dimension - 1) * moduleSize) >= height) {
+      throw NotFoundException.getNotFoundInstance();
+    }
 
     // Now just read off the bits
     BitMatrix bits = new BitMatrix(dimension);
     for (int i = 0; i < dimension; i++) {
-      int iOffset = borderWidth + i * moduleSize;
+      int iOffset = y + i * moduleSize;
       for (int j = 0; j < dimension; j++) {
-        if (image.isBlack(borderWidth + j * moduleSize, iOffset)) {
-          bits.set(i, j);
+        if (image.get(x + j * moduleSize, iOffset)) {
+          bits.set(j, i);
         }
       }
     }
     return bits;
   }
 
-}
\ No newline at end of file
+}