core/src/com/google/zxing/qrcode/decoder/DecodedBitStreamParser.java

   1 /*
   2  * Copyright 2007 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.qrcode.decoder;
  18
  19 import com.google.zxing.ReaderException;
  20 import com.google.zxing.common.BitSource;
  21 import com.google.zxing.common.CharacterSetECI;
  22 import com.google.zxing.common.DecoderResult;
  23
  24 import java.io.UnsupportedEncodingException;
  25 import java.util.Vector;
  26
  27 /**
  28  * <p>QR Codes can encode text as bits in one of several modes, and can use multiple modes
  29  * in one QR Code. This class decodes the bits back into text.</p>
  30  *
  31  * <p>See ISO 18004:2006, 6.4.3 - 6.4.7</p>
  32  *
  33  * @author Sean Owen
  34  */
  35 final class DecodedBitStreamParser {
  36
  37   /**
  38    * See ISO 18004:2006, 6.4.4 Table 5
  39    */
  40   private static final char[] ALPHANUMERIC_CHARS = {
  41       '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B',
  42       'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N',
  43       'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
  44       ' ', '$', '%', '*', '+', '-', '.', '/', ':'
  45   };
  46   private static final String SHIFT_JIS = "SJIS";
  47   private static final String EUC_JP = "EUC_JP";
  48   private static final boolean ASSUME_SHIFT_JIS;
  49   private static final String UTF8 = "UTF8";
  50   private static final String ISO88591 = "ISO8859_1";
  51
  52   static {
  53     String platformDefault = System.getProperty("file.encoding");
  54     ASSUME_SHIFT_JIS = SHIFT_JIS.equalsIgnoreCase(platformDefault) || EUC_JP.equalsIgnoreCase(platformDefault);
  55   }
  56
  57   private DecodedBitStreamParser() {
  58   }
  59
  60   static DecoderResult decode(byte[] bytes, Version version) throws ReaderException {
  61     BitSource bits = new BitSource(bytes);
  62     StringBuffer result = new StringBuffer();
  63     CharacterSetECI currentCharacterSetECI = null;
  64     boolean fc1InEffect = false;
  65     Vector byteSegments = new Vector(1);
  66     Mode mode;
  67     do {
  68       // While still another segment to read...
  69       if (bits.available() < 4) {
  70         // OK, assume we're done. Really, a TERMINATOR mode should have been recorded here
  71         mode = Mode.TERMINATOR;
  72       } else {
  73         try {
  74           mode = Mode.forBits(bits.readBits(4)); // mode is encoded by 4 bits
  75         } catch (IllegalArgumentException iae) {
  76           throw ReaderException.getInstance();
  77         }
  78       }
  79       if (!mode.equals(Mode.TERMINATOR)) {
  80         if (mode.equals(Mode.FNC1_FIRST_POSITION) || mode.equals(Mode.FNC1_SECOND_POSITION)) {
  81           // We do little with FNC1 except alter the parsed result a bit according to the spec
  82           fc1InEffect = true;
  83         } else if (mode.equals(Mode.ECI)) {
  84           // Count doesn't apply to ECI
  85           try {
  86             int value = parseECIValue(bits);
  87             currentCharacterSetECI = CharacterSetECI.getCharacterSetECIByValue(value);
  88           } catch (IllegalArgumentException iae) {
  89             throw ReaderException.getInstance();
  90           }
  91         } else {
  92           // How many characters will follow, encoded in this mode?
  93           int count = bits.readBits(mode.getCharacterCountBits(version));
  94           if (mode.equals(Mode.NUMERIC)) {
  95             decodeNumericSegment(bits, result, count);
  96           } else if (mode.equals(Mode.ALPHANUMERIC)) {
  97             decodeAlphanumericSegment(bits, result, count, fc1InEffect);
  98           } else if (mode.equals(Mode.BYTE)) {
  99             decodeByteSegment(bits, result, count, currentCharacterSetECI, byteSegments);
 100           } else if (mode.equals(Mode.KANJI)) {
 101             decodeKanjiSegment(bits, result, count);
 102           } else {
 103             throw ReaderException.getInstance();
 104           }
 105         }
 106       }
 107     } while (!mode.equals(Mode.TERMINATOR));
 108
 109     return new DecoderResult(bytes, result.toString(), byteSegments.isEmpty() ? null : byteSegments);
 110   }
 111
 112   private static void decodeKanjiSegment(BitSource bits,
 113                                          StringBuffer result,
 114                                          int count) throws ReaderException {
 115     // Each character will require 2 bytes. Read the characters as 2-byte pairs
 116     // and decode as Shift_JIS afterwards
 117     byte[] buffer = new byte[2 * count];
 118     int offset = 0;
 119     while (count > 0) {
 120       // Each 13 bits encodes a 2-byte character
 121       int twoBytes = bits.readBits(13);
 122       int assembledTwoBytes = ((twoBytes / 0x0C0) << 8) | (twoBytes % 0x0C0);
 123       if (assembledTwoBytes < 0x01F00) {
 124         // In the 0x8140 to 0x9FFC range
 125         assembledTwoBytes += 0x08140;
 126       } else {
 127         // In the 0xE040 to 0xEBBF range
 128         assembledTwoBytes += 0x0C140;
 129       }
 130       buffer[offset] = (byte) (assembledTwoBytes >> 8);
 131       buffer[offset + 1] = (byte) assembledTwoBytes;
 132       offset += 2;
 133       count--;
 134     }
 135     // Shift_JIS may not be supported in some environments:
 136     try {
 137       result.append(new String(buffer, SHIFT_JIS));
 138     } catch (UnsupportedEncodingException uee) {
 139       throw ReaderException.getInstance();
 140     }
 141   }
 142
 143   private static void decodeByteSegment(BitSource bits,
 144                                         StringBuffer result,
 145                                         int count,
 146                                         CharacterSetECI currentCharacterSetECI,
 147                                         Vector byteSegments) throws ReaderException {
 148     byte[] readBytes = new byte[count];
 149     if (count << 3 > bits.available()) {
 150       throw ReaderException.getInstance();
 151     }
 152     for (int i = 0; i < count; i++) {
 153       readBytes[i] = (byte) bits.readBits(8);
 154     }
 155     String encoding;
 156     if (currentCharacterSetECI == null) {
 157     // The spec isn't clear on this mode; see
 158     // section 6.4.5: t does not say which encoding to assuming
 159     // upon decoding. I have seen ISO-8859-1 used as well as
 160     // Shift_JIS -- without anything like an ECI designator to
 161     // give a hint.
 162       encoding = guessEncoding(readBytes);
 163     } else {
 164       encoding = currentCharacterSetECI.getEncodingName();
 165     }
 166     try {
 167       result.append(new String(readBytes, encoding));
 168     } catch (UnsupportedEncodingException uce) {
 169       throw ReaderException.getInstance();
 170     }
 171     byteSegments.addElement(readBytes);
 172   }
 173
 174   private static void decodeAlphanumericSegment(BitSource bits,
 175                                                 StringBuffer result,
 176                                                 int count,
 177                                                 boolean fc1InEffect) {
 178     // Read two characters at a time
 179     int start = result.length();
 180     while (count > 1) {
 181       int nextTwoCharsBits = bits.readBits(11);
 182       result.append(ALPHANUMERIC_CHARS[nextTwoCharsBits / 45]);
 183       result.append(ALPHANUMERIC_CHARS[nextTwoCharsBits % 45]);
 184       count -= 2;
 185     }
 186     if (count == 1) {
 187       // special case: one character left
 188       result.append(ALPHANUMERIC_CHARS[bits.readBits(6)]);
 189     }
 190     // See section 6.4.8.1, 6.4.8.2
 191     if (fc1InEffect) {
 192       // We need to massage the result a bit if in an FNC1 mode:
 193       for (int i = start; i < result.length(); i++) {
 194         if (result.charAt(i) == '%') {
 195           if (i < result.length() - 1 && result.charAt(i + 1) == '%') {
 196             // %% is rendered as %
 197             result.deleteCharAt(i + 1);
 198           } else {
 199             // In alpha mode, % should be converted to FNC1 separator 0x1D
 200             result.setCharAt(i, (char) 0x1D);
 201           }
 202         }
 203       }
 204     }
 205   }
 206
 207   private static void decodeNumericSegment(BitSource bits,
 208                                            StringBuffer result,
 209                                            int count) throws ReaderException {
 210     // Read three digits at a time
 211     while (count >= 3) {
 212       // Each 10 bits encodes three digits
 213       int threeDigitsBits = bits.readBits(10);
 214       if (threeDigitsBits >= 1000) {
 215         throw ReaderException.getInstance();
 216       }
 217       result.append(ALPHANUMERIC_CHARS[threeDigitsBits / 100]);
 218       result.append(ALPHANUMERIC_CHARS[(threeDigitsBits / 10) % 10]);
 219       result.append(ALPHANUMERIC_CHARS[threeDigitsBits % 10]);
 220       count -= 3;
 221     }
 222     if (count == 2) {
 223       // Two digits left over to read, encoded in 7 bits
 224       int twoDigitsBits = bits.readBits(7);
 225       if (twoDigitsBits >= 100) {
 226         throw ReaderException.getInstance();
 227       }
 228       result.append(ALPHANUMERIC_CHARS[twoDigitsBits / 10]);
 229       result.append(ALPHANUMERIC_CHARS[twoDigitsBits % 10]);
 230     } else if (count == 1) {
 231       // One digit left over to read
 232       int digitBits = bits.readBits(4);
 233       if (digitBits >= 10) {
 234         throw ReaderException.getInstance();
 235       }
 236       result.append(ALPHANUMERIC_CHARS[digitBits]);
 237     }
 238   }
 239
 240   private static String guessEncoding(byte[] bytes) {
 241     if (ASSUME_SHIFT_JIS) {
 242       return SHIFT_JIS;
 243     }
 244     // Does it start with the UTF-8 byte order mark? then guess it's UTF-8
 245     if (bytes.length > 3 && bytes[0] == (byte) 0xEF && bytes[1] == (byte) 0xBB && bytes[2] == (byte) 0xBF) {
 246       return UTF8;
 247     }
 248     // For now, merely tries to distinguish ISO-8859-1, UTF-8 and Shift_JIS,
 249     // which should be by far the most common encodings. ISO-8859-1
 250     // should not have bytes in the 0x80 - 0x9F range, while Shift_JIS
 251     // uses this as a first byte of a two-byte character. If we see this
 252     // followed by a valid second byte in Shift_JIS, assume it is Shift_JIS.
 253     // If we see something else in that second byte, we'll make the risky guess
 254     // that it's UTF-8.
 255     int length = bytes.length;
 256     boolean canBeISO88591 = true;
 257     boolean canBeShiftJIS = true;
 258     boolean sawDoubleByteStart = false;
 259     int maybeSingleByteKatakanaCount = 0;
 260     boolean sawLatin1Supplement = false;
 261     boolean lastWasPossibleDoubleByteStart = false;
 262     for (int i = 0; i < length && (canBeISO88591 || canBeShiftJIS); i++) {
 263       int value = bytes[i] & 0xFF;
 264       if (value == 0xC2 || value == 0xC3 && i < length - 1) {
 265         // This is really a poor hack. The slightly more exotic characters people might want to put in
 266         // a QR Code, by which I mean the Latin-1 supplement characters (e.g. u-umlaut) have encodings
 267         // that start with 0xC2 followed by [0xA0,0xBF], or start with 0xC3 followed by [0x80,0xBF].
 268         int nextValue = bytes[i + 1] & 0xFF;
 269         if (nextValue <= 0xBF && ((value == 0xC2 && nextValue >= 0xA0) || (value == 0xC3 && nextValue >= 0x80))) {
 270           sawLatin1Supplement = true;
 271         }
 272       }
 273       if (value >= 0x7F && value <= 0x9F) {
 274         canBeISO88591 = false;
 275       }
 276       if (value >= 0xA1 && value <= 0xDF) {
 277         // count the number of characters that might be a Shift_JIS single-byte Katakana character
 278         if (!lastWasPossibleDoubleByteStart) {
 279           maybeSingleByteKatakanaCount++;
 280         }
 281       }
 282       if (!lastWasPossibleDoubleByteStart && ((value >= 0xF0 && value <= 0xFF) || value == 0x80 || value == 0xA0)) {
 283         canBeShiftJIS = false;
 284       }
 285       if (((value >= 0x81 && value <= 0x9F) || (value >= 0xE0 && value <= 0xEF)) && i < length - 1) {
 286         // These start double-byte characters in Shift_JIS. Let's see if it's followed by a valid
 287         // second byte.
 288         sawDoubleByteStart = true;
 289         if (lastWasPossibleDoubleByteStart) {
 290           // If we just checked this and the last byte for being a valid double-byte
 291           // char, don't check starting on this byte. If this and the last byte
 292           // formed a valid pair, then this shouldn't be checked to see if it starts
 293           // a double byte pair of course.
 294           lastWasPossibleDoubleByteStart = false;
 295         } else {
 296           // ... otherwise do check to see if this plus the next byte form a valid
 297           // double byte pair encoding a character.
 298           lastWasPossibleDoubleByteStart = true;
 299           int nextValue = bytes[i + 1] & 0xFF;
 300           if (nextValue < 0x40 || nextValue > 0xFC) {
 301             canBeShiftJIS = false;
 302           }
 303           // There is some conflicting information out there about which bytes can follow which in
 304           // double-byte Shift_JIS characters. The rule above seems to be the one that matches practice.
 305         }
 306       } else {
 307         lastWasPossibleDoubleByteStart = false;
 308       }
 309     }
 310     // Distinguishing Shift_JIS and ISO-8859-1 can be a little tough. The crude heuristic is:
 311     // - If we saw
 312     //   - at least one byte that starts a double-byte value (bytes that are rare in ISO-8859-1), or
 313     //   - over 5% of bytes that could be single-byte Katakana (also rare in ISO-8859-1),
 314     // - and, saw no sequences that are invalid in Shift_JIS, then we conclude Shift_JIS
 315     if (canBeShiftJIS && (sawDoubleByteStart || 20 * maybeSingleByteKatakanaCount > length)) {
 316       return SHIFT_JIS;
 317     }
 318     // Otherwise, we default to ISO-8859-1 unless we know it can't be
 319     if (!sawLatin1Supplement && canBeISO88591) {
 320       return ISO88591;
 321     }
 322     // Otherwise, we take a wild guess with UTF-8
 323     return UTF8;
 324   }
 325
 326   private static int parseECIValue(BitSource bits) {
 327     int firstByte = bits.readBits(8);
 328     if ((firstByte & 0x80) == 0) {
 329       // just one byte
 330       return firstByte & 0x7F;
 331     } else if ((firstByte & 0xC0) == 0x80) {
 332       // two bytes
 333       int secondByte = bits.readBits(8);
 334       return ((firstByte & 0x3F) << 8) | secondByte;
 335     } else if ((firstByte & 0xE0) == 0xC0) {
 336       // three bytes
 337       int secondThirdBytes = bits.readBits(16);
 338       return ((firstByte & 0x1F) << 16) | secondThirdBytes;
 339     }
 340     throw new IllegalArgumentException("Bad ECI bits starting with byte " + firstByte);
 341   }
 342
 343 }