core/src/com/google/zxing/qrcode/QRCodeReader.java

   1 /*
   2  * Copyright 2007 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;
  18
  19 import com.google.zxing.BarcodeFormat;
  20 import com.google.zxing.DecodeHintType;
  21 import com.google.zxing.MonochromeBitmapSource;
  22 import com.google.zxing.Reader;
  23 import com.google.zxing.ReaderException;
  24 import com.google.zxing.Result;
  25 import com.google.zxing.ResultPoint;
  26 import com.google.zxing.ResultMetadataType;
  27 import com.google.zxing.common.BitMatrix;
  28 import com.google.zxing.common.DecoderResult;
  29 import com.google.zxing.common.DetectorResult;
  30 import com.google.zxing.qrcode.decoder.Decoder;
  31 import com.google.zxing.qrcode.detector.Detector;
  32
  33 import java.util.Hashtable;
  34
  35 /**
  36  * This implementation can detect and decode QR Codes in an image.
  37  *
  38  * @author Sean Owen
  39  */
  40 public final class QRCodeReader implements Reader {
  41
  42   private static final ResultPoint[] NO_POINTS = new ResultPoint[0];
  43
  44   private final Decoder decoder = new Decoder();
  45
  46   /**
  47    * Locates and decodes a QR code in an image.
  48    *
  49    * @return a String representing the content encoded by the QR code
  50    * @throws ReaderException if a QR code cannot be found, or cannot be decoded
  51    */
  52   public Result decode(MonochromeBitmapSource image) throws ReaderException {
  53     return decode(image, null);
  54   }
  55
  56   public Result decode(MonochromeBitmapSource image, Hashtable hints)
  57       throws ReaderException {
  58     DecoderResult decoderResult;
  59     ResultPoint[] points;
  60     if (hints != null && hints.containsKey(DecodeHintType.PURE_BARCODE)) {
  61       BitMatrix bits = extractPureBits(image);
  62       decoderResult = decoder.decode(bits);
  63       points = NO_POINTS;
  64     } else {
  65       DetectorResult detectorResult = new Detector(image).detect(hints);
  66       decoderResult = decoder.decode(detectorResult.getBits());
  67       points = detectorResult.getPoints();
  68     }
  69
  70     Result result = new Result(decoderResult.getText(), decoderResult.getRawBytes(), points, BarcodeFormat.QR_CODE);
  71     if (decoderResult.getByteSegments() != null) {
  72       result.putMetadata(ResultMetadataType.BYTE_SEGMENTS, decoderResult.getByteSegments());
  73     }
  74     return result;
  75   }
  76
  77   /**
  78    * This method detects a barcode in a "pure" image -- that is, pure monochrome image
  79    * which contains only an unrotated, unskewed, image of a barcode, with some white border
  80    * around it. This is a specialized method that works exceptionally fast in this special
  81    * case.
  82    */
  83   private static BitMatrix extractPureBits(MonochromeBitmapSource image) throws ReaderException {
  84     // Now need to determine module size in pixels
  85
  86     int height = image.getHeight();
  87     int width = image.getWidth();
  88     int minDimension = Math.min(height, width);
  89
  90     // First, skip white border by tracking diagonally from the top left down and to the right:
  91     int borderWidth = 0;
  92     while (borderWidth < minDimension && !image.isBlack(borderWidth, borderWidth)) {
  93       borderWidth++;
  94     }
  95     if (borderWidth == minDimension) {
  96       throw new ReaderException("No black pixels found along diagonal");
  97     }
  98
  99     // And then keep tracking across the top-left black module to determine module size
 100     int moduleEnd = borderWidth;
 101     while (moduleEnd < minDimension && image.isBlack(moduleEnd, moduleEnd)) {
 102       moduleEnd++;
 103     }
 104     if (moduleEnd == minDimension) {
 105       throw new ReaderException("No end to black pixels found along diagonal");
 106     }
 107
 108     int moduleSize = moduleEnd - borderWidth;
 109
 110     // And now find where the rightmost black module on the first row ends
 111     int rowEndOfSymbol = width - 1;
 112     while (rowEndOfSymbol >= 0 && !image.isBlack(rowEndOfSymbol, borderWidth)) {
 113       rowEndOfSymbol--;
 114     }
 115     if (rowEndOfSymbol < 0) {
 116       throw new ReaderException("Can't find end of rightmost black module");
 117     }
 118     rowEndOfSymbol++;
 119
 120     // Make sure width of barcode is a multiple of module size
 121     if ((rowEndOfSymbol - borderWidth) % moduleSize != 0) {
 122       throw new ReaderException("Bad module size / width: " + moduleSize +
 123           " / " + (rowEndOfSymbol - borderWidth));
 124     }
 125     int dimension = (rowEndOfSymbol - borderWidth) / moduleSize;
 126
 127     // Push in the "border" by half the module width so that we start
 128     // sampling in the middle of the module. Just in case the image is a
 129     // little off, this will help recover.
 130     borderWidth += moduleSize >> 1;
 131
 132     int sampleDimension = borderWidth + (dimension - 1) * moduleSize;
 133     if (sampleDimension >= width || sampleDimension >= height) {
 134       throw new ReaderException("Estimated pure image size is beyond image boundaries");
 135     }
 136
 137     // Now just read off the bits
 138     BitMatrix bits = new BitMatrix(dimension);
 139     for (int i = 0; i < dimension; i++) {
 140       int iOffset = borderWidth + i * moduleSize;
 141       for (int j = 0; j < dimension; j++) {
 142         if (image.isBlack(borderWidth + j * moduleSize, iOffset)) {
 143           bits.set(i, j);
 144         }
 145       }
 146     }
 147     return bits;
 148   }
 149
 150 }