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