core/src/com/google/zxing/oned/AbstractOneDReader.java

   1 /*
   2  * Copyright 2008 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.oned;
  18
  19 import com.google.zxing.BlackPointEstimationMethod;
  20 import com.google.zxing.DecodeHintType;
  21 import com.google.zxing.MonochromeBitmapSource;
  22 import com.google.zxing.ReaderException;
  23 import com.google.zxing.Result;
  24 import com.google.zxing.ResultMetadataType;
  25 import com.google.zxing.common.BitArray;
  26
  27 import java.util.Hashtable;
  28
  29 /**
  30  * <p>Encapsulates functionality and implementation that is common to all families
  31  * of one-dimensional barcodes.</p>
  32  *
  33  * @author dswitkin@google.com (Daniel Switkin)
  34  * @author srowen@google.com (Sean Owen)
  35  */
  36 public abstract class AbstractOneDReader implements OneDReader {
  37
  38   public final Result decode(MonochromeBitmapSource image) throws ReaderException {
  39     return decode(image, null);
  40   }
  41
  42   public final Result decode(MonochromeBitmapSource image, Hashtable hints) throws ReaderException {
  43     boolean tryHarder = hints != null && hints.containsKey(DecodeHintType.TRY_HARDER);
  44     try {
  45       return doDecode(image, hints, tryHarder);
  46     } catch (ReaderException re) {
  47       if (tryHarder && image.isRotateSupported()) {
  48         MonochromeBitmapSource rotatedImage = image.rotateCounterClockwise();
  49         Result result = doDecode(rotatedImage, hints, tryHarder);
  50         // Record that we found it rotated 90 degrees CCW / 270 degrees CW
  51         Hashtable metadata = result.getResultMetadata();
  52         int orientation = 270;
  53         if (metadata != null && metadata.containsKey(ResultMetadataType.ORIENTATION)) {
  54           // But if we found it reversed in doDecode(), add in that result here:
  55           orientation = (orientation + ((Integer) metadata.get(ResultMetadataType.ORIENTATION)).intValue()) % 360;
  56         }
  57         result.putMetadata(ResultMetadataType.ORIENTATION, new Integer(orientation));
  58         return result;
  59       } else {
  60         throw re;
  61       }
  62     }
  63   }
  64
  65   private Result doDecode(MonochromeBitmapSource image, Hashtable hints, boolean tryHarder) throws ReaderException {
  66
  67     int width = image.getWidth();
  68     int height = image.getHeight();
  69
  70     BitArray row = new BitArray(width);
  71
  72     int barcodesToSkip = 0;
  73     if (hints != null) {
  74       Integer number = (Integer) hints.get(DecodeHintType.SKIP_N_BARCODES);
  75       if (number != null) {
  76         barcodesToSkip = number.intValue();
  77       }
  78     }
  79
  80     // We're going to examine rows from the middle outward, searching alternately above and below the middle,
  81     // and farther out each time. rowStep is the number of rows between each successive attempt above and below
  82     // the middle. So we'd scan row middle, then middle - rowStep, then middle + rowStep,
  83     // then middle - 2*rowStep, etc.
  84     // rowStep is bigger as the image is taller, but is always at least 1. We've somewhat arbitrarily decided
  85     // that moving up and down by about 1/16 of the image is pretty good; we try more of the image if
  86     // "trying harder"
  87     int middle = height >> 1;
  88     int rowStep = Math.max(1, height >> (tryHarder ? 7 : 4));
  89     int maxLines;
  90     if (tryHarder || barcodesToSkip > 0) {
  91       maxLines = height; // Look at the whole image; looking for more than one barcode
  92     } else {
  93       maxLines = 7;
  94     }
  95
  96     Result lastResult = null;
  97
  98     for (int x = 0; x < maxLines; x++) {
  99
 100       int rowStepsAboveOrBelow = (x + 1) >> 1;
 101       boolean isAbove = (x & 0x01) == 0; // i.e. is x even?
 102       int rowNumber = middle + rowStep * (isAbove ? rowStepsAboveOrBelow : -rowStepsAboveOrBelow);
 103       if (rowNumber < 0 || rowNumber >= height) {
 104         break;
 105       }
 106
 107       try {
 108         image.estimateBlackPoint(BlackPointEstimationMethod.ROW_SAMPLING, rowNumber);
 109       } catch (ReaderException re) {
 110         continue;
 111       }
 112       image.getBlackRow(rowNumber, row, 0, width);
 113
 114       for (int attempt = 0; attempt < 2; attempt++) {
 115         if (attempt == 1) { // trying again?
 116           if (tryHarder) { // only if "trying harder"
 117             row.reverse(); // reverse the row and continue
 118           } else {
 119             break;
 120           }
 121         }
 122         try {
 123           Result result = decodeRow(rowNumber, row, hints);
 124           if (lastResult == null || !lastResult.getText().equals(result.getText())) {
 125             // Found new barcode, not just the last one again
 126             if (barcodesToSkip > 0) { // See if we should skip and keep looking
 127               barcodesToSkip--;
 128               lastResult = result; // Remember what we just saw
 129             } else {
 130               if (attempt == 1) {
 131                 // Found it, but upside-down:
 132                 result.putMetadata(ResultMetadataType.ORIENTATION, new Integer(180));
 133               }
 134               return result;
 135             }
 136           }
 137         } catch (ReaderException re) {
 138           // continue
 139         }
 140       }
 141     }
 142
 143     throw new ReaderException("No barcode found");
 144   }
 145
 146   static void recordPattern(BitArray row, int start, int[] counters) throws ReaderException {
 147     int numCounters = counters.length;
 148     for (int i = 0; i < numCounters; i++) {
 149       counters[i] = 0;
 150     }
 151     int end = row.getSize();
 152     if (start >= end) {
 153       throw new ReaderException("Couldn't fully read a pattern");
 154     }
 155     boolean isWhite = !row.get(start);
 156     int counterPosition = 0;
 157     int i = start;
 158     while (i < end) {
 159       boolean pixel = row.get(i);
 160       if ((!pixel && isWhite) || (pixel && !isWhite)) {
 161         counters[counterPosition]++;
 162       } else {
 163         counterPosition++;
 164         if (counterPosition == numCounters) {
 165           break;
 166         } else {
 167           counters[counterPosition] = 1;
 168           isWhite = !isWhite;
 169         }
 170       }
 171       i++;
 172     }
 173     // If we read fully the last section of pixels and filled up our counters -- or filled
 174     // the last counter but ran off the side of the image, OK. Otherwise, a problem.
 175     if (!(counterPosition == numCounters || (counterPosition == numCounters - 1 && i == end))) {
 176       throw new ReaderException("Couldn't fully read a pattern");
 177     }
 178   }
 179
 180   /**
 181    * Determines how closely a set of observed counts of runs of black/white values matches a given
 182    * target pattern. This is reported as the ratio of the total variance from the expected pattern proportions
 183    * across all pattern elements, to the length of the pattern.
 184    *
 185    * @param counters observed counters
 186    * @param pattern expected pattern
 187    * @return average variance between counters and pattern
 188    */
 189   static float patternMatchVariance(int[] counters, int[] pattern) {
 190     int total = 0;
 191     int numCounters = counters.length;
 192     int patternLength = 0;
 193     for (int i = 0; i < numCounters; i++) {
 194       total += counters[i];
 195       patternLength += pattern[i];
 196     }
 197     float unitBarWidth = (float) total / (float) patternLength;
 198
 199     float totalVariance = 0.0f;
 200     for (int x = 0; x < numCounters; x++) {
 201       float scaledCounter = (float) counters[x] / unitBarWidth;
 202       float width = pattern[x];
 203       float abs = scaledCounter > width ? scaledCounter - width : width - scaledCounter;
 204       totalVariance += abs;
 205     }
 206     return totalVariance / (float) patternLength;
 207   }
 208
 209 }