core/src/com/google/zxing/datamatrix/DataMatrixReader.java

   1 /*
   2  * Copyright 2007 Google Inc.
   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.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.common.BitMatrix;
  27 import com.google.zxing.datamatrix.decoder.Decoder;
  28 import com.google.zxing.datamatrix.detector.Detector;
  29 import com.google.zxing.datamatrix.detector.DetectorResult;
  30
  31 import java.util.Hashtable;
  32
  33 /**
  34  * This implementation can detect and decode Data Matrix codes in an image.
  35  *
  36  * @author bbrown@google.com (Brian Brown)
  37  */
  38 public final class DataMatrixReader implements Reader {
  39
  40   private static final ResultPoint[] NO_POINTS = new ResultPoint[0];
  41
  42   private final Decoder decoder = new Decoder();
  43
  44   /**
  45    * Locates and decodes a Data Matrix code in an image.
  46    *
  47    * @return a String representing the content encoded by the Data Matrix code
  48    * @throws ReaderException if a Data Matrix code cannot be found, or cannot be decoded
  49    */
  50   public Result decode(MonochromeBitmapSource image) throws ReaderException {
  51     return decode(image, null);
  52   }
  53
  54   public Result decode(MonochromeBitmapSource image, Hashtable hints)
  55       throws ReaderException {
  56     String text;
  57     ResultPoint[] points;
  58     //if (hints != null && hints.containsKey(DecodeHintType.PURE_BARCODE)) {
  59       BitMatrix bits = extractPureBits(image);
  60       text = decoder.decode(bits);
  61       points = NO_POINTS;
  62     //} else {
  63     //  DetectorResult result = new Detector(image).detect();
  64     //  text = decoder.decode(result.getBits());
  65     //  points = result.getPoints();
  66     //}
  67     return new Result(text, points, BarcodeFormat.DATAMATRIX);
  68   }
  69
  70   /**
  71    * This method detects a Data Matrix code in a "pure" image -- that is, pure monochrome image
  72    * which contains only an unrotated, unskewed, image of a Data Matrix code, with some white border
  73    * around it. This is a specialized method that works exceptionally fast in this special
  74    * case.
  75    */
  76   private static BitMatrix extractPureBits(MonochromeBitmapSource image)
  77       throws ReaderException {
  78     // Now need to determine module size in pixels
  79
  80         // First, skip white border by tracking diagonally from the top left down and to the right:
  81     int borderWidth = 0;
  82     while (!image.isBlack(borderWidth, borderWidth)) {
  83       borderWidth++;
  84     }
  85     // And then keep tracking across the top-left black module to determine module size
  86     int moduleEnd = borderWidth + 1;
  87     while (image.isBlack(moduleEnd, borderWidth)) {
  88       moduleEnd++;
  89     }
  90     int moduleSize = moduleEnd - borderWidth;
  91
  92     // And now find where the bottommost black module on the first column ends
  93     int columnEndOfSymbol = image.getHeight() - 1;
  94     while (!image.isBlack(borderWidth, columnEndOfSymbol)) {
  95         columnEndOfSymbol--;
  96     }
  97     columnEndOfSymbol++;
  98
  99     // Make sure width of barcode is a multiple of module size
 100     if ((columnEndOfSymbol - borderWidth) % moduleSize != 0) {
 101       throw new ReaderException("Bad module size / width: " + moduleSize +
 102           " / " + (columnEndOfSymbol - borderWidth));
 103     }
 104     int dimension = (columnEndOfSymbol - borderWidth) / moduleSize;
 105
 106     // Push in the "border" by half the module width so that we start
 107     // sampling in the middle of the module. Just in case the image is a
 108     // little off, this will help recover.
 109     borderWidth += moduleSize >> 1;
 110
 111     // Now just read off the bits
 112     BitMatrix bits = new BitMatrix(dimension);
 113     for (int i = 0; i < dimension; i++) {
 114       int iOffset = borderWidth + i * moduleSize;
 115       for (int j = 0; j < dimension; j++) {
 116         if (image.isBlack(borderWidth + j * moduleSize, iOffset)) {
 117           bits.set(i, j);
 118         }
 119       }
 120     }
 121     return bits;
 122   }
 123
 124 }