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