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