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

   1 /*
   2  * Copyright 2008 ZXing authors
   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.BarcodeFormat;
  20 import com.google.zxing.ReaderException;
  21 import com.google.zxing.Result;
  22 import com.google.zxing.ResultPoint;
  23 import com.google.zxing.common.BitArray;
  24 import com.google.zxing.common.GenericResultPoint;
  25
  26 import java.util.Hashtable;
  27
  28 /**
  29  * <p>Decodes Code 128 barcodes.</p>
  30  *
  31  * @author srowen@google.com (Sean Owen)
  32  */
  33 public final class Code128Reader extends AbstractOneDReader {
  34
  35   private static final int[][] CODE_PATTERNS = {
  36       {2, 1, 2, 2, 2, 2}, // 0
  37       {2, 2, 2, 1, 2, 2},
  38       {2, 2, 2, 2, 2, 1},
  39       {1, 2, 1, 2, 2, 3},
  40       {1, 2, 1, 3, 2, 2},
  41       {1, 3, 1, 2, 2, 2}, // 5
  42       {1, 2, 2, 2, 1, 3},
  43       {1, 2, 2, 3, 1, 2},
  44       {1, 3, 2, 2, 1, 2},
  45       {2, 2, 1, 2, 1, 3},
  46       {2, 2, 1, 3, 1, 2}, // 10
  47       {2, 3, 1, 2, 1, 2},
  48       {1, 1, 2, 2, 3, 2},
  49       {1, 2, 2, 1, 3, 2},
  50       {1, 2, 2, 2, 3, 1},
  51       {1, 1, 3, 2, 2, 2}, // 15
  52       {1, 2, 3, 1, 2, 2},
  53       {1, 2, 3, 2, 2, 1},
  54       {2, 2, 3, 2, 1, 1},
  55       {2, 2, 1, 1, 3, 2},
  56       {2, 2, 1, 2, 3, 1}, // 20
  57       {2, 1, 3, 2, 1, 2},
  58       {2, 2, 3, 1, 1, 2},
  59       {3, 1, 2, 1, 3, 1},
  60       {3, 1, 1, 2, 2, 2},
  61       {3, 2, 1, 1, 2, 2}, // 25
  62       {3, 2, 1, 2, 2, 1},
  63       {3, 1, 2, 2, 1, 2},
  64       {3, 2, 2, 1, 1, 2},
  65       {3, 2, 2, 2, 1, 1},
  66       {2, 1, 2, 1, 2, 3}, // 30
  67       {2, 1, 2, 3, 2, 1},
  68       {2, 3, 2, 1, 2, 1},
  69       {1, 1, 1, 3, 2, 3},
  70       {1, 3, 1, 1, 2, 3},
  71       {1, 3, 1, 3, 2, 1}, // 35
  72       {1, 1, 2, 3, 1, 3},
  73       {1, 3, 2, 1, 1, 3},
  74       {1, 3, 2, 3, 1, 1},
  75       {2, 1, 1, 3, 1, 3},
  76       {2, 3, 1, 1, 1, 3}, // 40
  77       {2, 3, 1, 3, 1, 1},
  78       {1, 1, 2, 1, 3, 3},
  79       {1, 1, 2, 3, 3, 1},
  80       {1, 3, 2, 1, 3, 1},
  81       {1, 1, 3, 1, 2, 3}, // 45
  82       {1, 1, 3, 3, 2, 1},
  83       {1, 3, 3, 1, 2, 1},
  84       {3, 1, 3, 1, 2, 1},
  85       {2, 1, 1, 3, 3, 1},
  86       {2, 3, 1, 1, 3, 1}, // 50
  87       {2, 1, 3, 1, 1, 3},
  88       {2, 1, 3, 3, 1, 1},
  89       {2, 1, 3, 1, 3, 1},
  90       {3, 1, 1, 1, 2, 3},
  91       {3, 1, 1, 3, 2, 1}, // 55
  92       {3, 3, 1, 1, 2, 1},
  93       {3, 1, 2, 1, 1, 3},
  94       {3, 1, 2, 3, 1, 1},
  95       {3, 3, 2, 1, 1, 1},
  96       {3, 1, 4, 1, 1, 1}, // 60
  97       {2, 2, 1, 4, 1, 1},
  98       {4, 3, 1, 1, 1, 1},
  99       {1, 1, 1, 2, 2, 4},
 100       {1, 1, 1, 4, 2, 2},
 101       {1, 2, 1, 1, 2, 4}, // 65
 102       {1, 2, 1, 4, 2, 1},
 103       {1, 4, 1, 1, 2, 2},
 104       {1, 4, 1, 2, 2, 1},
 105       {1, 1, 2, 2, 1, 4},
 106       {1, 1, 2, 4, 1, 2}, // 70
 107       {1, 2, 2, 1, 1, 4},
 108       {1, 2, 2, 4, 1, 1},
 109       {1, 4, 2, 1, 1, 2},
 110       {1, 4, 2, 2, 1, 1},
 111       {2, 4, 1, 2, 1, 1}, // 75
 112       {2, 2, 1, 1, 1, 4},
 113       {4, 1, 3, 1, 1, 1},
 114       {2, 4, 1, 1, 1, 2},
 115       {1, 3, 4, 1, 1, 1},
 116       {1, 1, 1, 2, 4, 2}, // 80
 117       {1, 2, 1, 1, 4, 2},
 118       {1, 2, 1, 2, 4, 1},
 119       {1, 1, 4, 2, 1, 2},
 120       {1, 2, 4, 1, 1, 2},
 121       {1, 2, 4, 2, 1, 1}, // 85
 122       {4, 1, 1, 2, 1, 2},
 123       {4, 2, 1, 1, 1, 2},
 124       {4, 2, 1, 2, 1, 1},
 125       {2, 1, 2, 1, 4, 1},
 126       {2, 1, 4, 1, 2, 1}, // 90
 127       {4, 1, 2, 1, 2, 1},
 128       {1, 1, 1, 1, 4, 3},
 129       {1, 1, 1, 3, 4, 1},
 130       {1, 3, 1, 1, 4, 1},
 131       {1, 1, 4, 1, 1, 3}, // 95
 132       {1, 1, 4, 3, 1, 1},
 133       {4, 1, 1, 1, 1, 3},
 134       {4, 1, 1, 3, 1, 1},
 135       {1, 1, 3, 1, 4, 1},
 136       {1, 1, 4, 1, 3, 1}, // 100
 137       {3, 1, 1, 1, 4, 1},
 138       {4, 1, 1, 1, 3, 1},
 139       {2, 1, 1, 4, 1, 2},
 140       {2, 1, 1, 2, 1, 4},
 141       {2, 1, 1, 2, 3, 2}, // 105
 142       {2, 3, 3, 1, 1, 1, 2}
 143   };
 144
 145   private static final int MAX_AVG_VARIANCE = (int) (PATTERN_MATCH_RESULT_SCALE_FACTOR * 0.25f);
 146   private static final int MAX_INDIVIDUAL_VARIANCE = (int) (PATTERN_MATCH_RESULT_SCALE_FACTOR * 0.7f);
 147
 148   private static final int CODE_SHIFT = 98;
 149
 150   private static final int CODE_CODE_C = 99;
 151   private static final int CODE_CODE_B = 100;
 152   private static final int CODE_CODE_A = 101;
 153
 154   private static final int CODE_FNC_1 = 102;
 155   private static final int CODE_FNC_2 = 97;
 156   private static final int CODE_FNC_3 = 96;
 157   private static final int CODE_FNC_4_A = 101;
 158   private static final int CODE_FNC_4_B = 100;
 159
 160   private static final int CODE_START_A = 103;
 161   private static final int CODE_START_B = 104;
 162   private static final int CODE_START_C = 105;
 163   private static final int CODE_STOP = 106;
 164
 165   private static int[] findStartPattern(BitArray row) throws ReaderException {
 166     int width = row.getSize();
 167     int rowOffset = 0;
 168     while (rowOffset < width) {
 169       if (row.get(rowOffset)) {
 170         break;
 171       }
 172       rowOffset++;
 173     }
 174
 175     int counterPosition = 0;
 176     int[] counters = new int[6];
 177     int patternStart = rowOffset;
 178     boolean isWhite = false;
 179     int patternLength = counters.length;
 180
 181     for (int i = rowOffset; i < width; i++) {
 182       boolean pixel = row.get(i);
 183       if ((!pixel && isWhite) || (pixel && !isWhite)) {
 184         counters[counterPosition]++;
 185       } else {
 186         if (counterPosition == patternLength - 1) {
 187           int bestVariance = MAX_AVG_VARIANCE;
 188           int bestMatch = -1;
 189           for (int startCode = CODE_START_A; startCode <= CODE_START_C; startCode++) {
 190             int variance = patternMatchVariance(counters, CODE_PATTERNS[startCode], MAX_INDIVIDUAL_VARIANCE);
 191             if (variance < bestVariance) {
 192               bestVariance = variance;
 193               bestMatch = startCode;
 194             }
 195           }
 196           if (bestMatch >= 0) {
 197             return new int[]{patternStart, i, bestMatch};
 198           }
 199           patternStart += counters[0] + counters[1];
 200           for (int y = 2; y < patternLength; y++) {
 201             counters[y - 2] = counters[y];
 202           }
 203           counters[patternLength - 2] = 0;
 204           counters[patternLength - 1] = 0;
 205           counterPosition--;
 206         } else {
 207           counterPosition++;
 208         }
 209         counters[counterPosition] = 1;
 210         isWhite = !isWhite;
 211       }
 212     }
 213     throw new ReaderException("Can't find pattern");
 214   }
 215
 216   private static int decodeCode(BitArray row, int[] counters, int rowOffset) throws ReaderException {
 217     recordPattern(row, rowOffset, counters);
 218     int bestVariance = MAX_AVG_VARIANCE; // worst variance we'll accept
 219     int bestMatch = -1;
 220     for (int d = 0; d < CODE_PATTERNS.length; d++) {
 221       int[] pattern = CODE_PATTERNS[d];
 222       int variance = patternMatchVariance(counters, pattern, MAX_INDIVIDUAL_VARIANCE);
 223       if (variance < bestVariance) {
 224         bestVariance = variance;
 225         bestMatch = d;
 226       }
 227     }
 228     // TODO We're overlooking the fact that the STOP pattern has 7 values, not 6
 229     if (bestMatch >= 0) {
 230       return bestMatch;
 231     } else {
 232       throw new ReaderException("Could not match any code pattern");
 233     }
 234   }
 235
 236   public Result decodeRow(int rowNumber, BitArray row, Hashtable hints) throws ReaderException {
 237
 238     int[] startPatternInfo = findStartPattern(row);
 239     int startCode = startPatternInfo[2];
 240     int codeSet;
 241     switch (startCode) {
 242       case CODE_START_A:
 243         codeSet = CODE_CODE_A;
 244         break;
 245       case CODE_START_B:
 246         codeSet = CODE_CODE_B;
 247         break;
 248       case CODE_START_C:
 249         codeSet = CODE_CODE_C;
 250         break;
 251       default:
 252         throw new ReaderException("Illegal start code");
 253     }
 254
 255     boolean done = false;
 256     boolean isNextShifted = false;
 257
 258     StringBuffer result = new StringBuffer();
 259     int lastStart = startPatternInfo[0];
 260     int nextStart = startPatternInfo[1];
 261     int[] counters = new int[6];
 262
 263     int lastCode = 0;
 264     int code = 0;
 265     int checksumTotal = startCode;
 266     int multiplier = 0;
 267     boolean lastCharacterWasPrintable = true;
 268
 269     while (!done) {
 270
 271       // Remember whether the last code was printable or not (excluding CODE_STOP)
 272       lastCharacterWasPrintable = true;
 273
 274       boolean unshift = isNextShifted;
 275       isNextShifted = false;
 276
 277       // Save off last code
 278       lastCode = code;
 279
 280       // Decode another code from image
 281       code = decodeCode(row, counters, nextStart);
 282
 283       // Add to checksum computation (if not CODE_STOP of course)
 284       if (code != CODE_STOP) {
 285         multiplier++;
 286         checksumTotal += multiplier * code;
 287       }
 288
 289       // Advance to where the next code will to start
 290       lastStart = nextStart;
 291       for (int i = 0; i < counters.length; i++) {
 292         nextStart += counters[i];
 293       }
 294
 295       // Take care of illegal start codes
 296       switch (code) {
 297         case CODE_START_A:
 298         case CODE_START_B:
 299         case CODE_START_C:
 300           throw new ReaderException("Unexpected start code");
 301       }
 302
 303       switch (codeSet) {
 304
 305         case CODE_CODE_A:
 306           if (code < 64) {
 307             result.append((char) (' ' + code));
 308           } else if (code < 96) {
 309             result.append((char) (code - 64));
 310           } else {
 311             // Don't let CODE_STOP, which always appears, affect whether whether we think the last code
 312             // was printable or not
 313             if (code != CODE_STOP) {
 314               lastCharacterWasPrintable = false;
 315             }
 316             switch (code) {
 317               case CODE_FNC_1:
 318               case CODE_FNC_2:
 319               case CODE_FNC_3:
 320               case CODE_FNC_4_A:
 321                 // do nothing?
 322                 break;
 323               case CODE_SHIFT:
 324                 isNextShifted = true;
 325                 codeSet = CODE_CODE_B;
 326                 break;
 327               case CODE_CODE_B:
 328                 codeSet = CODE_CODE_B;
 329                 break;
 330               case CODE_CODE_C:
 331                 codeSet = CODE_CODE_C;
 332                 break;
 333               case CODE_STOP:
 334                 done = true;
 335                 break;
 336             }
 337           }
 338           break;
 339         case CODE_CODE_B:
 340           if (code < 96) {
 341             result.append((char) (' ' + code));
 342           } else {
 343             if (code != CODE_STOP) {
 344               lastCharacterWasPrintable = false;
 345             }
 346             switch (code) {
 347               case CODE_FNC_1:
 348               case CODE_FNC_2:
 349               case CODE_FNC_3:
 350               case CODE_FNC_4_B:
 351                 // do nothing?
 352                 break;
 353               case CODE_SHIFT:
 354                 isNextShifted = true;
 355                 codeSet = CODE_CODE_C;
 356                 break;
 357               case CODE_CODE_A:
 358                 codeSet = CODE_CODE_A;
 359                 break;
 360               case CODE_CODE_C:
 361                 codeSet = CODE_CODE_C;
 362                 break;
 363               case CODE_STOP:
 364                 done = true;
 365                 break;
 366             }
 367           }
 368           break;
 369         case CODE_CODE_C:
 370           if (code < 100) {
 371             if (code < 10) {
 372               result.append('0');
 373             }
 374             result.append(code);
 375           } else {
 376             if (code != CODE_STOP) {
 377               lastCharacterWasPrintable = false;
 378             }
 379             switch (code) {
 380               case CODE_FNC_1:
 381                 // do nothing?
 382                 break;
 383               case CODE_CODE_A:
 384                 codeSet = CODE_CODE_A;
 385                 break;
 386               case CODE_CODE_B:
 387                 codeSet = CODE_CODE_B;
 388                 break;
 389               case CODE_STOP:
 390                 done = true;
 391                 break;
 392             }
 393           }
 394           break;
 395       }
 396
 397       // Unshift back to another code set if we were shifted
 398       if (unshift) {
 399         switch (codeSet) {
 400           case CODE_CODE_A:
 401             codeSet = CODE_CODE_C;
 402             break;
 403           case CODE_CODE_B:
 404             codeSet = CODE_CODE_A;
 405             break;
 406           case CODE_CODE_C:
 407             codeSet = CODE_CODE_B;
 408             break;
 409         }
 410       }
 411
 412     }
 413
 414     // Pull out from sum the value of the penultimate check code
 415     checksumTotal -= multiplier * lastCode;
 416     // lastCode is the checksum then:
 417     if (checksumTotal % 103 != lastCode) {
 418       throw new ReaderException("Checksum failed");
 419     }
 420
 421     // Need to pull out the check digits from string
 422     int resultLength = result.length();
 423     // Only bother if, well, the result had at least one character, and if the checksum digit happened
 424     // to be a printable character. If it was just interpreted as a control code, nothing to remove
 425     if (resultLength > 0 && lastCharacterWasPrintable) {
 426       if (codeSet == CODE_CODE_C) {
 427         result.delete(resultLength - 2, resultLength);
 428       } else {
 429         result.delete(resultLength - 1, resultLength);
 430       }
 431     }
 432
 433     String resultString = result.toString();
 434
 435     if (resultString.length() == 0) {
 436       // Almost surely a false positive
 437       throw new ReaderException("Empty barcode found; assuming a false positive");
 438     }
 439
 440     float left = (float) (startPatternInfo[1] + startPatternInfo[0]) / 2.0f;
 441     float right = (float) (nextStart + lastStart) / 2.0f;
 442     return new Result(
 443         resultString,
 444         null,
 445         new ResultPoint[]{
 446             new GenericResultPoint(left, (float) rowNumber),
 447             new GenericResultPoint(right, (float) rowNumber)},
 448         BarcodeFormat.CODE_128);
 449
 450   }
 451
 452 }