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.MonochromeBitmapSource;
  21 import com.google.zxing.ReaderException;
  22 import com.google.zxing.Result;
  23 import com.google.zxing.common.BitArray;
  24
  25 import java.util.Hashtable;
  26
  27 /**
  28  * <p>Encapsulates functionality and implementation that is common to all families
  29  * of one-dimensional barcodes.</p>
  30  *
  31  * @author dswitkin@google.com (Daniel Switkin)
  32  * @author srowen@google.com (Sean Owen)
  33  */
  34 public abstract class AbstractOneDReader implements OneDReader {
  35
  36   public final Result decode(MonochromeBitmapSource image) throws ReaderException {
  37     return decode(image, null);
  38   }
  39
  40   public final Result decode(MonochromeBitmapSource image, Hashtable hints) throws ReaderException {
  41
  42     int width = image.getWidth();
  43     int height = image.getHeight();
  44
  45     BitArray row = new BitArray(width);
  46
  47     // We're going to examine rows from the middle outward, searching alternately above and below the middle,
  48     // and farther out each time. rowStep is the number of rows between each successive attempt above and below
  49     // the middle. So we'd scan row middle, then middle - rowStep, then middle + rowStep,
  50     // then middle - 2*rowStep, etc.
  51     // rowStep is bigger as the image is taller, but is always at least 1. We've somewhat arbitrarily decided
  52     // that moving up and down by about 1/16 of the image is pretty good.
  53     int middle = height >> 1;
  54     int rowStep = Math.max(1, height >> 4);
  55     for (int x = 0; x < 7; x++) {
  56
  57       int rowStepsAboveOrBelow = (x + 1) >> 1;
  58       boolean isAbove = (x & 0x01) == 0; // i.e. is x even?
  59       int rowNumber = middle + rowStep * (isAbove ? rowStepsAboveOrBelow : -rowStepsAboveOrBelow);
  60       if (rowNumber < 0 || rowNumber >= height) {
  61         break;
  62       }
  63
  64       image.estimateBlackPoint(BlackPointEstimationMethod.ROW_SAMPLING, rowNumber);
  65       image.getBlackRow(rowNumber, row, 0, width);
  66
  67       try {
  68         return decodeRow(rowNumber, row);
  69       } catch (ReaderException re) {
  70         // TODO re-enable this in a "try harder" mode?
  71         //row.reverse(); // try scanning the row backwards
  72         //try {
  73         //  return decodeRow(rowNumber, row);
  74         //} catch (ReaderException re2) {
  75         // continue
  76         //}
  77       }
  78
  79     }
  80
  81     throw new ReaderException("No barcode found");
  82   }
  83
  84   protected static void recordPattern(BitArray row, int start, int[] counters) throws ReaderException {
  85     for (int i = 0; i < counters.length; i++) {
  86       counters[i] = 0;
  87     }
  88     int end = row.getSize();
  89     if (start >= end) {
  90       throw new ReaderException("Couldn't fully read a pattern");
  91     }
  92     boolean isWhite = !row.get(start);
  93     int counterPosition = 0;
  94     int i = start;
  95     while (i < end) {
  96       boolean pixel = row.get(i);
  97       if ((!pixel && isWhite) || (pixel && !isWhite)) {
  98         counters[counterPosition]++;
  99       } else {
 100         counterPosition++;
 101         if (counterPosition == counters.length) {
 102           break;
 103         } else {
 104           counters[counterPosition] = 1;
 105           isWhite = !isWhite;
 106         }
 107       }
 108       i++;
 109     }
 110     // If we read fully the last section of pixels and filled up our counters -- or filled
 111     // the last counter but ran off the side of the image, OK. Otherwise, a problem.
 112     if (!(counterPosition == counters.length || (counterPosition == counters.length - 1 && i == end))) {
 113       throw new ReaderException("Couldn't fully read a pattern");
 114     }
 115   }
 116
 117   /**
 118    * Determines how closely a set of observed counts of runs of black/white values matches a given
 119    * target pattern. This is reported as the ratio of the total variance from the expected pattern proportions
 120    * across all pattern elements, to the length of the pattern.
 121    *
 122    * @param counters observed counters
 123    * @param pattern expected pattern
 124    * @return average variance between counters and pattern
 125    */
 126   protected static float patternMatchVariance(int[] counters, int[] pattern) {
 127     int total = 0;
 128     int numCounters = counters.length;
 129     int patternLength = 0;
 130     for (int i = 0; i < numCounters; i++) {
 131       total += counters[i];
 132       patternLength += pattern[i];
 133     }
 134     float unitBarWidth = (float) total / (float) patternLength;
 135
 136     float totalVariance = 0.0f;
 137     for (int x = 0; x < numCounters; x++) {
 138       float scaledCounter = (float) counters[x] / unitBarWidth;
 139       float width = pattern[x];
 140       float abs = scaledCounter > width ? scaledCounter - width : width - scaledCounter;
 141       totalVariance += abs;
 142     }
 143     return totalVariance / (float) patternLength;
 144   }
 145
 146   /**
 147    * Fast round method.
 148    *
 149    * @return argument rounded to nearest int
 150    */
 151   protected static int round(float f) {
 152     return (int) (f + 0.5f);
 153   }
 154
 155 }