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

   1 /*\r
   2  * Copyright 2008 ZXing authors\r
   3  *\r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *      http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 package com.google.zxing.oned;\r
  18 \r
  19 import com.google.zxing.BarcodeFormat;\r
  20 import com.google.zxing.ReaderException;\r
  21 import com.google.zxing.Result;\r
  22 import com.google.zxing.ResultPoint;\r
  23 import com.google.zxing.DecodeHintType;\r
  24 import com.google.zxing.common.BitArray;\r
  25 import com.google.zxing.common.GenericResultPoint;\r
  26 \r
  27 import java.util.Hashtable;\r
  28 \r
  29 /**\r
  30  * <p>Implements decoding of the ITF format.</p>\r
  31  *\r
  32  * <p>"ITF" stands for Interleaved Two of Five. This Reader will scan ITF barcode with 6, 10 or 14 digits.\r
  33  * The checksum is optional and is not applied by this Reader. The consumer of the decoded value\r
  34  * will have to apply a checksum if required.</p>\r
  35  *\r
  36  * <p><a href="http://en.wikipedia.org/wiki/Interleaved_2_of_5">http://en.wikipedia.org/wiki/Interleaved_2_of_5</a>\r
  37  * is a great reference for Interleaved 2 of 5 information.</p>\r
  38  *\r
  39  * @author kevin.osullivan@sita.aero, SITA Lab.\r
  40  */\r
  41 public final class ITFReader extends AbstractOneDReader {\r
  42 \r
  43   private static final int MAX_AVG_VARIANCE = (int) (PATTERN_MATCH_RESULT_SCALE_FACTOR * 0.42f);\r
  44   private static final int MAX_INDIVIDUAL_VARIANCE = (int) (PATTERN_MATCH_RESULT_SCALE_FACTOR * 0.8f);\r
  45 \r
  46   private static final int W = 3; // Pixel width of a wide line\r
  47   private static final int N = 1; // Pixed width of a narrow line\r
  48 \r
  49   private static final int[] DEFAULT_ALLOWED_LENGTHS = { 6, 10, 14 };\r
  50 \r
  51   // Stores the actual narrow line width of the image being decoded.\r
  52   private int narrowLineWidth = -1;\r
  53 \r
  54   /**\r
  55    * Start/end guard pattern.\r
  56    *\r
  57    * Note: The end pattern is reversed because the row is reversed before\r
  58    * searching for the END_PATTERN\r
  59    */\r
  60   private static final int[] START_PATTERN = {N, N, N, N};\r
  61   private static final int[] END_PATTERN_REVERSED = {N, N, W};\r
  62 \r
  63   /**\r
  64    * Patterns of Wide / Narrow lines to indicate each digit\r
  65    */\r
  66   private static final int[][] PATTERNS = {\r
  67       {N, N, W, W, N}, // 0\r
  68       {W, N, N, N, W}, // 1\r
  69       {N, W, N, N, W}, // 2\r
  70       {W, W, N, N, N}, // 3\r
  71       {N, N, W, N, W}, // 4\r
  72       {W, N, W, N, N}, // 5\r
  73       {N, W, W, N, N}, // 6\r
  74       {N, N, N, W, W}, // 7\r
  75       {W, N, N, W, N}, // 8\r
  76       {N, W, N, W, N}  // 9\r
  77   };\r
  78 \r
  79   public Result decodeRow(int rowNumber, BitArray row, Hashtable hints) throws ReaderException {\r
  80 \r
  81     StringBuffer result = new StringBuffer(20);\r
  82 \r
  83     // Find out where the Middle section (payload) starts & ends\r
  84     int[] startRange = decodeStart(row);\r
  85     int[] endRange = decodeEnd(row);\r
  86 \r
  87     decodeMiddle(row, startRange[1], endRange[0], result);\r
  88 \r
  89     String resultString = result.toString();\r
  90 \r
  91     int[] allowedLengths = null;\r
  92     if (hints != null) {\r
  93       allowedLengths = (int[]) hints.get(DecodeHintType.ALLOWED_LENGTHS);\r
  94 \r
  95     }\r
  96     if (allowedLengths == null) {\r
  97       allowedLengths = DEFAULT_ALLOWED_LENGTHS;\r
  98     }\r
  99 \r
 100     // To avoid false positives with 2D barcodes (and other patterns), make\r
 101     // an assumption that the decoded string must be 6, 10 or 14 digits.\r
 102     int length = resultString.length();\r
 103     boolean lengthOK = false;\r
 104     for (int i = 0; i < allowedLengths.length; i++) {\r
 105       if (length == allowedLengths[i]) {\r
 106         lengthOK = true;\r
 107         break;\r
 108       }\r
 109 \r
 110     }\r
 111     if (!lengthOK) {\r
 112       throw ReaderException.getInstance();\r
 113     }\r
 114 \r
 115     return new Result(\r
 116         resultString,\r
 117         null, // no natural byte representation for these barcodes\r
 118         new ResultPoint[] { new GenericResultPoint(startRange[1], (float) rowNumber),\r
 119                             new GenericResultPoint(endRange[0], (float) rowNumber)},\r
 120         BarcodeFormat.ITF);\r
 121   }\r
 122 \r
 123   /**\r
 124    * @param row          row of black/white values to search\r
 125    * @param payloadStart offset of start pattern\r
 126    * @param resultString {@link StringBuffer} to append decoded chars to\r
 127    * @throws ReaderException if decoding could not complete successfully\r
 128    */\r
 129   static void decodeMiddle(BitArray row, int payloadStart, int payloadEnd, StringBuffer resultString) throws ReaderException {\r
 130 \r
 131     // Digits are interleaved in pairs - 5 black lines for one digit, and the\r
 132     // 5\r
 133     // interleaved white lines for the second digit.\r
 134     // Therefore, need to scan 10 lines and then\r
 135     // split these into two arrays\r
 136     int[] counterDigitPair = new int[10];\r
 137     int[] counterBlack = new int[5];\r
 138     int[] counterWhite = new int[5];\r
 139 \r
 140     while (payloadStart < payloadEnd) {\r
 141 \r
 142       // Get 10 runs of black/white.\r
 143       recordPattern(row, payloadStart, counterDigitPair);\r
 144       // Split them into each array\r
 145       for (int k = 0; k < 5; k++) {\r
 146         int twoK = k << 1;\r
 147         counterBlack[k] = counterDigitPair[twoK];\r
 148         counterWhite[k] = counterDigitPair[twoK + 1];\r
 149       }\r
 150 \r
 151       int bestMatch = decodeDigit(counterBlack);\r
 152       resultString.append((char) ('0' + bestMatch));\r
 153       bestMatch = decodeDigit(counterWhite);\r
 154       resultString.append((char) ('0' + bestMatch));\r
 155 \r
 156       for (int i = 0; i < counterDigitPair.length; i++) {\r
 157         payloadStart += counterDigitPair[i];\r
 158       }\r
 159     }\r
 160   }\r
 161 \r
 162   /**\r
 163    * Identify where the start of the middle / payload section starts.\r
 164    *\r
 165    * @param row row of black/white values to search\r
 166    * @return Array, containing index of start of 'start block' and end of\r
 167    *         'start block'\r
 168    * @throws ReaderException\r
 169    */\r
 170   int[] decodeStart(BitArray row) throws ReaderException {\r
 171     int endStart = skipWhiteSpace(row);\r
 172     int[] startPattern = findGuardPattern(row, endStart, START_PATTERN);\r
 173 \r
 174     // Determine the width of a narrow line in pixels. We can do this by\r
 175     // getting the width of the start pattern and dividing by 4 because its\r
 176     // made up of 4 narrow lines.\r
 177     this.narrowLineWidth = (startPattern[1] - startPattern[0]) >> 2;\r
 178 \r
 179     validateQuietZone(row, startPattern[0]);\r
 180 \r
 181     return startPattern;\r
 182   }\r
 183 \r
 184   /**\r
 185    * The start & end patterns must be pre/post fixed by a quiet zone. This\r
 186    * zone must be at least 10 times the width of a narrow line.  Scan back until\r
 187    * we either get to the start of the barcode or match the necessary number of\r
 188    * quiet zone pixels.\r
 189    *\r
 190    * Note: Its assumed the row is reversed when using this method to find\r
 191    * quiet zone after the end pattern.\r
 192    *\r
 193    * ref: http://www.barcode-1.net/i25code.html\r
 194    *\r
 195    * @param row bit array representing the scanned barcode.\r
 196    * @param startPattern index into row of the start or end pattern.\r
 197    * @throws ReaderException if the quiet zone cannot be found, a ReaderException is thrown.\r
 198    */\r
 199   private void validateQuietZone(BitArray row, int startPattern) throws ReaderException {\r
 200 \r
 201     int quietCount = this.narrowLineWidth * 10;  // expect to find this many pixels of quiet zone\r
 202 \r
 203     for (int i = startPattern - 1; quietCount > 0 && i >= 0; i--) {\r
 204       if (row.get(i)) {\r
 205         break;\r
 206       }\r
 207       quietCount--;\r
 208     }\r
 209     if (quietCount != 0) {\r
 210       // Unable to find the necessary number of quiet zone pixels.\r
 211       throw ReaderException.getInstance();\r
 212     }\r
 213   }\r
 214 \r
 215   /**\r
 216    * Skip all whitespace until we get to the first black line.\r
 217    *\r
 218    * @param row row of black/white values to search\r
 219    * @return index of the first black line.\r
 220    * @throws ReaderException Throws exception if no black lines are found in the row\r
 221    */\r
 222   private static int skipWhiteSpace(BitArray row) throws ReaderException {\r
 223     int width = row.getSize();\r
 224     int endStart = 0;\r
 225     while (endStart < width) {\r
 226       if (row.get(endStart)) {\r
 227         break;\r
 228       }\r
 229       endStart++;\r
 230     }\r
 231     if (endStart == width) {\r
 232       throw ReaderException.getInstance();\r
 233     }\r
 234 \r
 235     return endStart;\r
 236   }\r
 237 \r
 238   /**\r
 239    * Identify where the end of the middle / payload section ends.\r
 240    *\r
 241    * @param row row of black/white values to search\r
 242    * @return Array, containing index of start of 'end block' and end of 'end\r
 243    *         block'\r
 244    * @throws ReaderException\r
 245    */\r
 246 \r
 247   int[] decodeEnd(BitArray row) throws ReaderException {\r
 248 \r
 249     // For convenience, reverse the row and then\r
 250     // search from 'the start' for the end block\r
 251     row.reverse();\r
 252     try {\r
 253       int endStart = skipWhiteSpace(row);\r
 254       int[] endPattern = findGuardPattern(row, endStart, END_PATTERN_REVERSED);\r
 255 \r
 256       // The start & end patterns must be pre/post fixed by a quiet zone. This\r
 257       // zone must be at least 10 times the width of a narrow line.\r
 258       // ref: http://www.barcode-1.net/i25code.html\r
 259       validateQuietZone(row, endPattern[0]);\r
 260 \r
 261       // Now recalc the indicies of where the 'endblock' starts & stops to\r
 262       // accomodate\r
 263       // the reversed nature of the search\r
 264       int temp = endPattern[0];\r
 265       endPattern[0] = row.getSize() - endPattern[1];\r
 266       endPattern[1] = row.getSize() - temp;\r
 267 \r
 268       return endPattern;\r
 269     } finally {\r
 270       // Put the row back the righ way.\r
 271       row.reverse();\r
 272     }\r
 273   }\r
 274 \r
 275   /**\r
 276    * @param row       row of black/white values to search\r
 277    * @param rowOffset position to start search\r
 278    * @param pattern   pattern of counts of number of black and white pixels that are\r
 279    *                  being searched for as a pattern\r
 280    * @return start/end horizontal offset of guard pattern, as an array of two\r
 281    *         ints\r
 282    * @throws ReaderException if pattern is not found\r
 283    */\r
 284   static int[] findGuardPattern(BitArray row, int rowOffset, int[] pattern) throws ReaderException {\r
 285 \r
 286     // TODO: This is very similar to implementation in AbstractUPCEANReader. Consider if they can be merged to\r
 287     // a single method.\r
 288 \r
 289     int patternLength = pattern.length;\r
 290     int[] counters = new int[patternLength];\r
 291     int width = row.getSize();\r
 292     boolean isWhite = false;\r
 293 \r
 294     int counterPosition = 0;\r
 295     int patternStart = rowOffset;\r
 296     for (int x = rowOffset; x < width; x++) {\r
 297       boolean pixel = row.get(x);\r
 298       if (pixel ^ isWhite) {\r
 299         counters[counterPosition]++;\r
 300       } else {\r
 301         if (counterPosition == patternLength - 1) {\r
 302           if (patternMatchVariance(counters, pattern, MAX_INDIVIDUAL_VARIANCE) < MAX_AVG_VARIANCE) {\r
 303             return new int[]{patternStart, x};\r
 304           }\r
 305           patternStart += counters[0] + counters[1];\r
 306           for (int y = 2; y < patternLength; y++) {\r
 307             counters[y - 2] = counters[y];\r
 308           }\r
 309           counters[patternLength - 2] = 0;\r
 310           counters[patternLength - 1] = 0;\r
 311           counterPosition--;\r
 312         } else {\r
 313           counterPosition++;\r
 314         }\r
 315         counters[counterPosition] = 1;\r
 316         isWhite ^= true; // isWhite = !isWhite;\r
 317       }\r
 318     }\r
 319     throw ReaderException.getInstance();\r
 320   }\r
 321 \r
 322   /**\r
 323    * Attempts to decode a sequence of ITF black/white lines into single\r
 324    * digit.\r
 325    *\r
 326    * @param counters the counts of runs of observed black/white/black/... values\r
 327    * @return The decoded digit\r
 328    * @throws ReaderException if digit cannot be decoded\r
 329    */\r
 330   private static int decodeDigit(int[] counters) throws ReaderException {\r
 331 \r
 332     int bestVariance = MAX_AVG_VARIANCE; // worst variance we'll accept\r
 333     int bestMatch = -1;\r
 334     int max = PATTERNS.length;\r
 335     for (int i = 0; i < max; i++) {\r
 336       int[] pattern = PATTERNS[i];\r
 337       int variance = patternMatchVariance(counters, pattern, MAX_INDIVIDUAL_VARIANCE);\r
 338       if (variance < bestVariance) {\r
 339         bestVariance = variance;\r
 340         bestMatch = i;\r
 341       }\r
 342     }\r
 343     if (bestMatch >= 0) {\r
 344       return bestMatch;\r
 345                 } else {\r
 346                         throw ReaderException.getInstance();\r
 347                 }\r
 348         }\r
 349 \r
 350 }