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     if (tryHarder) {
  92       maxLines = height; // Look at the whole image; looking for more than one barcode
  93     } else {
  94       maxLines = 7;
  95     }
  96
  97     //Result lastResult = null;
  98
  99     for (int x = 0; x < maxLines; x++) {
 100
 101       // Scanning from the middle out. Determine which row we're looking at next:
 102       int rowStepsAboveOrBelow = (x + 1) >> 1;
 103       boolean isAbove = (x & 0x01) == 0; // i.e. is x even?
 104       int rowNumber = middle + rowStep * (isAbove ? rowStepsAboveOrBelow : -rowStepsAboveOrBelow);
 105       if (rowNumber < 0 || rowNumber >= height) {
 106         // Oops, if we run off the top or bottom, stop
 107         break;
 108       }
 109
 110       // Estimate black point for this row and load it:
 111       try {
 112         image.estimateBlackPoint(BlackPointEstimationMethod.ROW_SAMPLING, rowNumber);
 113       } catch (ReaderException re) {
 114         continue;
 115       }
 116       image.getBlackRow(rowNumber, row, 0, width);
 117
 118       // We may try twice for each row, if "trying harder":
 119       for (int attempt = 0; attempt < 2; attempt++) {
 120
 121         if (attempt == 1) { // trying again?
 122           if (tryHarder) { // only if "trying harder"
 123             row.reverse(); // reverse the row and continue
 124           } else {
 125             break;
 126           }
 127         }
 128
 129         try {
 130
 131           // Look for a barcode
 132           Result result = decodeRow(rowNumber, row, hints);
 133
 134           //if (lastResult != null && lastResult.getText().equals(result.getText())) {
 135             // Just saw the last barcode again, proceed
 136             //continue;
 137           //}
 138
 139           //if (barcodesToSkip > 0) { // See if we should skip and keep looking
 140           //  barcodesToSkip--;
 141           //  lastResult = result; // Remember what we just saw
 142           //} else {
 143             // We found our barcode
 144             if (attempt == 1) {
 145               // But it was upside down, so note that
 146               result.putMetadata(ResultMetadataType.ORIENTATION, new Integer(180));
 147             }
 148             return result;
 149           //}
 150
 151         } catch (ReaderException re) {
 152           // continue -- just couldn't decode this row
 153         }
 154
 155       }
 156     }
 157
 158     throw new ReaderException("No barcode found");
 159   }
 160
 161   static void recordPattern(BitArray row, int start, int[] counters) throws ReaderException {
 162     int numCounters = counters.length;
 163     for (int i = 0; i < numCounters; i++) {
 164       counters[i] = 0;
 165     }
 166     int end = row.getSize();
 167     if (start >= end) {
 168       throw new ReaderException("Couldn't fully read a pattern");
 169     }
 170     boolean isWhite = !row.get(start);
 171     int counterPosition = 0;
 172     int i = start;
 173     while (i < end) {
 174       boolean pixel = row.get(i);
 175       if ((!pixel && isWhite) || (pixel && !isWhite)) {
 176         counters[counterPosition]++;
 177       } else {
 178         counterPosition++;
 179         if (counterPosition == numCounters) {
 180           break;
 181         } else {
 182           counters[counterPosition] = 1;
 183           isWhite = !isWhite;
 184         }
 185       }
 186       i++;
 187     }
 188     // If we read fully the last section of pixels and filled up our counters -- or filled
 189     // the last counter but ran off the side of the image, OK. Otherwise, a problem.
 190     if (!(counterPosition == numCounters || (counterPosition == numCounters - 1 && i == end))) {
 191       throw new ReaderException("Couldn't fully read a pattern");
 192     }
 193   }
 194
 195   /**
 196    * Determines how closely a set of observed counts of runs of black/white values matches a given
 197    * target pattern. This is reported as the ratio of the total variance from the expected pattern proportions
 198    * across all pattern elements, to the length of the pattern.
 199    *
 200    * @param counters observed counters
 201    * @param pattern expected pattern
 202    * @return average variance between counters and pattern
 203    */
 204   static float patternMatchVariance(int[] counters, int[] pattern) {
 205     int total = 0;
 206     int numCounters = counters.length;
 207     int patternLength = 0;
 208     for (int i = 0; i < numCounters; i++) {
 209       total += counters[i];
 210       patternLength += pattern[i];
 211     }
 212     float unitBarWidth = (float) total / (float) patternLength;
 213
 214     float totalVariance = 0.0f;
 215     for (int x = 0; x < numCounters; x++) {
 216       float scaledCounter = (float) counters[x] / unitBarWidth;
 217       float width = pattern[x];
 218       float abs = scaledCounter > width ? scaledCounter - width : width - scaledCounter;
 219       totalVariance += abs;
 220     }
 221     return totalVariance / (float) patternLength;
 222   }
 223
 224 }