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 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) {
 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             // Look for whitespace before start pattern, >= 50% of width of start pattern
 198             if (row.isRange(Math.max(0, patternStart - (i - patternStart) / 2), patternStart, false)) {
 199               return new int[]{patternStart, i, bestMatch};
 200             }
 201           }
 202           patternStart += counters[0] + counters[1];
 203           for (int y = 2; y < patternLength; y++) {
 204             counters[y - 2] = counters[y];
 205           }
 206           counters[patternLength - 2] = 0;
 207           counters[patternLength - 1] = 0;
 208           counterPosition--;
 209         } else {
 210           counterPosition++;
 211         }
 212         counters[counterPosition] = 1;
 213         isWhite ^= true; // isWhite = !isWhite;
 214       }
 215     }
 216     throw ReaderException.getInstance();
 217   }
 218
 219   private static int decodeCode(BitArray row, int[] counters, int rowOffset) throws ReaderException {
 220     recordPattern(row, rowOffset, counters);
 221     int bestVariance = MAX_AVG_VARIANCE; // worst variance we'll accept
 222     int bestMatch = -1;
 223     for (int d = 0; d < CODE_PATTERNS.length; d++) {
 224       int[] pattern = CODE_PATTERNS[d];
 225       int variance = patternMatchVariance(counters, pattern, MAX_INDIVIDUAL_VARIANCE);
 226       if (variance < bestVariance) {
 227         bestVariance = variance;
 228         bestMatch = d;
 229       }
 230     }
 231     // TODO We're overlooking the fact that the STOP pattern has 7 values, not 6
 232     if (bestMatch >= 0) {
 233       return bestMatch;
 234     } else {
 235       throw ReaderException.getInstance();
 236     }
 237   }
 238
 239   public Result decodeRow(int rowNumber, BitArray row, Hashtable hints) throws ReaderException {
 240
 241     int[] startPatternInfo = findStartPattern(row);
 242     int startCode = startPatternInfo[2];
 243     int codeSet;
 244     switch (startCode) {
 245       case CODE_START_A:
 246         codeSet = CODE_CODE_A;
 247         break;
 248       case CODE_START_B:
 249         codeSet = CODE_CODE_B;
 250         break;
 251       case CODE_START_C:
 252         codeSet = CODE_CODE_C;
 253         break;
 254       default:
 255         throw ReaderException.getInstance();
 256     }
 257
 258     boolean done = false;
 259     boolean isNextShifted = false;
 260
 261     StringBuffer result = new StringBuffer();
 262     int lastStart = startPatternInfo[0];
 263     int nextStart = startPatternInfo[1];
 264     int[] counters = new int[6];
 265
 266     int lastCode = 0;
 267     int code = 0;
 268     int checksumTotal = startCode;
 269     int multiplier = 0;
 270     boolean lastCharacterWasPrintable = true;
 271
 272     while (!done) {
 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       // Remember whether the last code was printable or not (excluding CODE_STOP)
 284       if (code != CODE_STOP) {
 285         lastCharacterWasPrintable = true;
 286       }
 287
 288       // Add to checksum computation (if not CODE_STOP of course)
 289       if (code != CODE_STOP) {
 290         multiplier++;
 291         checksumTotal += multiplier * code;
 292       }
 293
 294       // Advance to where the next code will to start
 295       lastStart = nextStart;
 296       for (int i = 0; i < counters.length; i++) {
 297         nextStart += counters[i];
 298       }
 299
 300       // Take care of illegal start codes
 301       switch (code) {
 302         case CODE_START_A:
 303         case CODE_START_B:
 304         case CODE_START_C:
 305           throw ReaderException.getInstance();
 306       }
 307
 308       switch (codeSet) {
 309
 310         case CODE_CODE_A:
 311           if (code < 64) {
 312             result.append((char) (' ' + code));
 313           } else if (code < 96) {
 314             result.append((char) (code - 64));
 315           } else {
 316             // Don't let CODE_STOP, which always appears, affect whether whether we think the last code
 317             // was printable or not
 318             if (code != CODE_STOP) {
 319               lastCharacterWasPrintable = false;
 320             }
 321             switch (code) {
 322               case CODE_FNC_1:
 323               case CODE_FNC_2:
 324               case CODE_FNC_3:
 325               case CODE_FNC_4_A:
 326                 // do nothing?
 327                 break;
 328               case CODE_SHIFT:
 329                 isNextShifted = true;
 330                 codeSet = CODE_CODE_B;
 331                 break;
 332               case CODE_CODE_B:
 333                 codeSet = CODE_CODE_B;
 334                 break;
 335               case CODE_CODE_C:
 336                 codeSet = CODE_CODE_C;
 337                 break;
 338               case CODE_STOP:
 339                 done = true;
 340                 break;
 341             }
 342           }
 343           break;
 344         case CODE_CODE_B:
 345           if (code < 96) {
 346             result.append((char) (' ' + code));
 347           } else {
 348             if (code != CODE_STOP) {
 349               lastCharacterWasPrintable = false;
 350             }
 351             switch (code) {
 352               case CODE_FNC_1:
 353               case CODE_FNC_2:
 354               case CODE_FNC_3:
 355               case CODE_FNC_4_B:
 356                 // do nothing?
 357                 break;
 358               case CODE_SHIFT:
 359                 isNextShifted = true;
 360                 codeSet = CODE_CODE_C;
 361                 break;
 362               case CODE_CODE_A:
 363                 codeSet = CODE_CODE_A;
 364                 break;
 365               case CODE_CODE_C:
 366                 codeSet = CODE_CODE_C;
 367                 break;
 368               case CODE_STOP:
 369                 done = true;
 370                 break;
 371             }
 372           }
 373           break;
 374         case CODE_CODE_C:
 375           if (code < 100) {
 376             if (code < 10) {
 377               result.append('0');
 378             }
 379             result.append(code);
 380           } else {
 381             if (code != CODE_STOP) {
 382               lastCharacterWasPrintable = false;
 383             }
 384             switch (code) {
 385               case CODE_FNC_1:
 386                 // do nothing?
 387                 break;
 388               case CODE_CODE_A:
 389                 codeSet = CODE_CODE_A;
 390                 break;
 391               case CODE_CODE_B:
 392                 codeSet = CODE_CODE_B;
 393                 break;
 394               case CODE_STOP:
 395                 done = true;
 396                 break;
 397             }
 398           }
 399           break;
 400       }
 401
 402       // Unshift back to another code set if we were shifted
 403       if (unshift) {
 404         switch (codeSet) {
 405           case CODE_CODE_A:
 406             codeSet = CODE_CODE_C;
 407             break;
 408           case CODE_CODE_B:
 409             codeSet = CODE_CODE_A;
 410             break;
 411           case CODE_CODE_C:
 412             codeSet = CODE_CODE_B;
 413             break;
 414         }
 415       }
 416
 417     }
 418
 419     // Check for ample whitespice following pattern, but, to do this we first need to remember that we
 420     // fudged decoding CODE_STOP since it actually has 7 bars, not 6. There is a black bar left to read off.
 421     // Would be slightly better to properly read. Here we just skip it:
 422     while (row.get(nextStart)) {
 423       nextStart++;
 424     }
 425     if (!row.isRange(nextStart, Math.min(row.getSize(), nextStart + (nextStart - lastStart) / 2), false)) {
 426       throw ReaderException.getInstance();
 427     }
 428
 429     // Pull out from sum the value of the penultimate check code
 430     checksumTotal -= multiplier * lastCode;
 431     // lastCode is the checksum then:
 432     if (checksumTotal % 103 != lastCode) {
 433       throw ReaderException.getInstance();
 434     }
 435
 436     // Need to pull out the check digits from string
 437     int resultLength = result.length();
 438     // Only bother if, well, the result had at least one character, and if the checksum digit happened
 439     // to be a printable character. If it was just interpreted as a control code, nothing to remove
 440     if (resultLength > 0 && lastCharacterWasPrintable) {
 441       if (codeSet == CODE_CODE_C) {
 442         result.delete(resultLength - 2, resultLength);
 443       } else {
 444         result.delete(resultLength - 1, resultLength);
 445       }
 446     }
 447
 448     String resultString = result.toString();
 449
 450     if (resultString.length() == 0) {
 451       // Almost surely a false positive
 452       throw ReaderException.getInstance();
 453     }
 454
 455     float left = (float) (startPatternInfo[1] + startPatternInfo[0]) / 2.0f;
 456     float right = (float) (nextStart + lastStart) / 2.0f;
 457     return new Result(
 458         resultString,
 459         null,
 460         new ResultPoint[]{
 461             new GenericResultPoint(left, (float) rowNumber),
 462             new GenericResultPoint(right, (float) rowNumber)},
 463         BarcodeFormat.CODE_128);
 464
 465   }
 466
 467 }