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.
  86     int middle = height >> 1;
  87     int rowStep = Math.max(1, height >> 4);
  88     int maxLines;
  89     if (barcodesToSkip > 0) {
  90       maxLines = height; // Look at the whole image; looking for more than one barcode
  91     } else {
  92       maxLines = tryHarder ? 15 : 7; // If "trying harder", examine more lines
  93     }
  94     for (int x = 0; x < maxLines; x++) {
  95
  96       int rowStepsAboveOrBelow = (x + 1) >> 1;
  97       boolean isAbove = (x & 0x01) == 0; // i.e. is x even?
  98       int rowNumber = middle + rowStep * (isAbove ? rowStepsAboveOrBelow : -rowStepsAboveOrBelow);
  99       if (rowNumber < 0 || rowNumber >= height) {
 100         break;
 101       }
 102
 103       image.estimateBlackPoint(BlackPointEstimationMethod.ROW_SAMPLING, rowNumber);
 104       image.getBlackRow(rowNumber, row, 0, width);
 105
 106       try {
 107         Result result = decodeRow(rowNumber, row, hints);
 108         if (barcodesToSkip > 0) { // See if we should skip and keep looking
 109           barcodesToSkip--;
 110         } else {
 111           return result;
 112         }
 113       } catch (ReaderException re) {
 114         if (tryHarder) {
 115           row.reverse(); // try scanning the row backwards
 116           try {
 117             Result result = decodeRow(rowNumber, row, hints);
 118             if (barcodesToSkip > 0) { // See if we should skip and keep looking
 119               barcodesToSkip--;
 120             } else {
 121               // Found it, but upside-down:
 122               result.putMetadata(ResultMetadataType.ORIENTATION, new Integer(180));
 123               return result;
 124             }
 125           } catch (ReaderException re2) {
 126             // continue
 127           }
 128         }
 129       }
 130
 131     }
 132
 133     throw new ReaderException("No barcode found");
 134   }
 135
 136   static void recordPattern(BitArray row, int start, int[] counters) throws ReaderException {
 137     int numCounters = counters.length;
 138     for (int i = 0; i < numCounters; i++) {
 139       counters[i] = 0;
 140     }
 141     int end = row.getSize();
 142     if (start >= end) {
 143       throw new ReaderException("Couldn't fully read a pattern");
 144     }
 145     boolean isWhite = !row.get(start);
 146     int counterPosition = 0;
 147     int i = start;
 148     while (i < end) {
 149       boolean pixel = row.get(i);
 150       if ((!pixel && isWhite) || (pixel && !isWhite)) {
 151         counters[counterPosition]++;
 152       } else {
 153         counterPosition++;
 154         if (counterPosition == numCounters) {
 155           break;
 156         } else {
 157           counters[counterPosition] = 1;
 158           isWhite = !isWhite;
 159         }
 160       }
 161       i++;
 162     }
 163     // If we read fully the last section of pixels and filled up our counters -- or filled
 164     // the last counter but ran off the side of the image, OK. Otherwise, a problem.
 165     if (!(counterPosition == numCounters || (counterPosition == numCounters - 1 && i == end))) {
 166       throw new ReaderException("Couldn't fully read a pattern");
 167     }
 168   }
 169
 170   /**
 171    * Determines how closely a set of observed counts of runs of black/white values matches a given
 172    * target pattern. This is reported as the ratio of the total variance from the expected pattern proportions
 173    * across all pattern elements, to the length of the pattern.
 174    *
 175    * @param counters observed counters
 176    * @param pattern expected pattern
 177    * @return average variance between counters and pattern
 178    */
 179   static float patternMatchVariance(int[] counters, int[] pattern) {
 180     int total = 0;
 181     int numCounters = counters.length;
 182     int patternLength = 0;
 183     for (int i = 0; i < numCounters; i++) {
 184       total += counters[i];
 185       patternLength += pattern[i];
 186     }
 187     float unitBarWidth = (float) total / (float) patternLength;
 188
 189     float totalVariance = 0.0f;
 190     for (int x = 0; x < numCounters; x++) {
 191       float scaledCounter = (float) counters[x] / unitBarWidth;
 192       float width = pattern[x];
 193       float abs = scaledCounter > width ? scaledCounter - width : width - scaledCounter;
 194       totalVariance += abs;
 195     }
 196     return totalVariance / (float) patternLength;
 197   }
 198
 199 }