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.STRUCTURED_APPEND)) {
  84           // not really supported; all we do is ignore it
  85           // Read next 8 bits (symbol sequence #) and 8 bits (parity data), then continue
  86           bits.readBits(16);
  87         } else if (mode.equals(Mode.ECI)) {
  88           // Count doesn't apply to ECI
  89           try {
  90             int value = parseECIValue(bits);
  91             currentCharacterSetECI = CharacterSetECI.getCharacterSetECIByValue(value);
  92           } catch (IllegalArgumentException iae) {
  93             throw ReaderException.getInstance();
  94           }
  95         } else {
  96           // How many characters will follow, encoded in this mode?
  97           int count = bits.readBits(mode.getCharacterCountBits(version));
  98           if (mode.equals(Mode.NUMERIC)) {
  99             decodeNumericSegment(bits, result, count);
 100           } else if (mode.equals(Mode.ALPHANUMERIC)) {
 101             decodeAlphanumericSegment(bits, result, count, fc1InEffect);
 102           } else if (mode.equals(Mode.BYTE)) {
 103             decodeByteSegment(bits, result, count, currentCharacterSetECI, byteSegments);
 104           } else if (mode.equals(Mode.KANJI)) {
 105             decodeKanjiSegment(bits, result, count);
 106           } else {
 107             throw ReaderException.getInstance();
 108           }
 109         }
 110       }
 111     } while (!mode.equals(Mode.TERMINATOR));
 112
 113     return new DecoderResult(bytes, result.toString(), byteSegments.isEmpty() ? null : byteSegments);
 114   }
 115
 116   private static void decodeKanjiSegment(BitSource bits,
 117                                          StringBuffer result,
 118                                          int count) throws ReaderException {
 119     // Each character will require 2 bytes. Read the characters as 2-byte pairs
 120     // and decode as Shift_JIS afterwards
 121     byte[] buffer = new byte[2 * count];
 122     int offset = 0;
 123     while (count > 0) {
 124       // Each 13 bits encodes a 2-byte character
 125       int twoBytes = bits.readBits(13);
 126       int assembledTwoBytes = ((twoBytes / 0x0C0) << 8) | (twoBytes % 0x0C0);
 127       if (assembledTwoBytes < 0x01F00) {
 128         // In the 0x8140 to 0x9FFC range
 129         assembledTwoBytes += 0x08140;
 130       } else {
 131         // In the 0xE040 to 0xEBBF range
 132         assembledTwoBytes += 0x0C140;
 133       }
 134       buffer[offset] = (byte) (assembledTwoBytes >> 8);
 135       buffer[offset + 1] = (byte) assembledTwoBytes;
 136       offset += 2;
 137       count--;
 138     }
 139     // Shift_JIS may not be supported in some environments:
 140     try {
 141       result.append(new String(buffer, SHIFT_JIS));
 142     } catch (UnsupportedEncodingException uee) {
 143       throw ReaderException.getInstance();
 144     }
 145   }
 146
 147   private static void decodeByteSegment(BitSource bits,
 148                                         StringBuffer result,
 149                                         int count,
 150                                         CharacterSetECI currentCharacterSetECI,
 151                                         Vector byteSegments) throws ReaderException {
 152     byte[] readBytes = new byte[count];
 153     if (count << 3 > bits.available()) {
 154       throw ReaderException.getInstance();
 155     }
 156     for (int i = 0; i < count; i++) {
 157       readBytes[i] = (byte) bits.readBits(8);
 158     }
 159     String encoding;
 160     if (currentCharacterSetECI == null) {
 161     // The spec isn't clear on this mode; see
 162     // section 6.4.5: t does not say which encoding to assuming
 163     // upon decoding. I have seen ISO-8859-1 used as well as
 164     // Shift_JIS -- without anything like an ECI designator to
 165     // give a hint.
 166       encoding = guessEncoding(readBytes);
 167     } else {
 168       encoding = currentCharacterSetECI.getEncodingName();
 169     }
 170     try {
 171       result.append(new String(readBytes, encoding));
 172     } catch (UnsupportedEncodingException uce) {
 173       throw ReaderException.getInstance();
 174     }
 175     byteSegments.addElement(readBytes);
 176   }
 177
 178   private static void decodeAlphanumericSegment(BitSource bits,
 179                                                 StringBuffer result,
 180                                                 int count,
 181                                                 boolean fc1InEffect) {
 182     // Read two characters at a time
 183     int start = result.length();
 184     while (count > 1) {
 185       int nextTwoCharsBits = bits.readBits(11);
 186       result.append(ALPHANUMERIC_CHARS[nextTwoCharsBits / 45]);
 187       result.append(ALPHANUMERIC_CHARS[nextTwoCharsBits % 45]);
 188       count -= 2;
 189     }
 190     if (count == 1) {
 191       // special case: one character left
 192       result.append(ALPHANUMERIC_CHARS[bits.readBits(6)]);
 193     }
 194     // See section 6.4.8.1, 6.4.8.2
 195     if (fc1InEffect) {
 196       // We need to massage the result a bit if in an FNC1 mode:
 197       for (int i = start; i < result.length(); i++) {
 198         if (result.charAt(i) == '%') {
 199           if (i < result.length() - 1 && result.charAt(i + 1) == '%') {
 200             // %% is rendered as %
 201             result.deleteCharAt(i + 1);
 202           } else {
 203             // In alpha mode, % should be converted to FNC1 separator 0x1D
 204             result.setCharAt(i, (char) 0x1D);
 205           }
 206         }
 207       }
 208     }
 209   }
 210
 211   private static void decodeNumericSegment(BitSource bits,
 212                                            StringBuffer result,
 213                                            int count) throws ReaderException {
 214     // Read three digits at a time
 215     while (count >= 3) {
 216       // Each 10 bits encodes three digits
 217       int threeDigitsBits = bits.readBits(10);
 218       if (threeDigitsBits >= 1000) {
 219         throw ReaderException.getInstance();
 220       }
 221       result.append(ALPHANUMERIC_CHARS[threeDigitsBits / 100]);
 222       result.append(ALPHANUMERIC_CHARS[(threeDigitsBits / 10) % 10]);
 223       result.append(ALPHANUMERIC_CHARS[threeDigitsBits % 10]);
 224       count -= 3;
 225     }
 226     if (count == 2) {
 227       // Two digits left over to read, encoded in 7 bits
 228       int twoDigitsBits = bits.readBits(7);
 229       if (twoDigitsBits >= 100) {
 230         throw ReaderException.getInstance();
 231       }
 232       result.append(ALPHANUMERIC_CHARS[twoDigitsBits / 10]);
 233       result.append(ALPHANUMERIC_CHARS[twoDigitsBits % 10]);
 234     } else if (count == 1) {
 235       // One digit left over to read
 236       int digitBits = bits.readBits(4);
 237       if (digitBits >= 10) {
 238         throw ReaderException.getInstance();
 239       }
 240       result.append(ALPHANUMERIC_CHARS[digitBits]);
 241     }
 242   }
 243
 244   private static String guessEncoding(byte[] bytes) {
 245     if (ASSUME_SHIFT_JIS) {
 246       return SHIFT_JIS;
 247     }
 248     // Does it start with the UTF-8 byte order mark? then guess it's UTF-8
 249     if (bytes.length > 3 && bytes[0] == (byte) 0xEF && bytes[1] == (byte) 0xBB && bytes[2] == (byte) 0xBF) {
 250       return UTF8;
 251     }
 252     // For now, merely tries to distinguish ISO-8859-1, UTF-8 and Shift_JIS,
 253     // which should be by far the most common encodings. ISO-8859-1
 254     // should not have bytes in the 0x80 - 0x9F range, while Shift_JIS
 255     // uses this as a first byte of a two-byte character. If we see this
 256     // followed by a valid second byte in Shift_JIS, assume it is Shift_JIS.
 257     // If we see something else in that second byte, we'll make the risky guess
 258     // that it's UTF-8.
 259     int length = bytes.length;
 260     boolean canBeISO88591 = true;
 261     boolean canBeShiftJIS = true;
 262     boolean sawDoubleByteStart = false;
 263     int maybeSingleByteKatakanaCount = 0;
 264     boolean sawLatin1Supplement = false;
 265     boolean lastWasPossibleDoubleByteStart = false;
 266     for (int i = 0; i < length && (canBeISO88591 || canBeShiftJIS); i++) {
 267       int value = bytes[i] & 0xFF;
 268       if (value == 0xC2 || value == 0xC3 && i < length - 1) {
 269         // This is really a poor hack. The slightly more exotic characters people might want to put in
 270         // a QR Code, by which I mean the Latin-1 supplement characters (e.g. u-umlaut) have encodings
 271         // that start with 0xC2 followed by [0xA0,0xBF], or start with 0xC3 followed by [0x80,0xBF].
 272         int nextValue = bytes[i + 1] & 0xFF;
 273         if (nextValue <= 0xBF && ((value == 0xC2 && nextValue >= 0xA0) || (value == 0xC3 && nextValue >= 0x80))) {
 274           sawLatin1Supplement = true;
 275         }
 276       }
 277       if (value >= 0x7F && value <= 0x9F) {
 278         canBeISO88591 = false;
 279       }
 280       if (value >= 0xA1 && value <= 0xDF) {
 281         // count the number of characters that might be a Shift_JIS single-byte Katakana character
 282         if (!lastWasPossibleDoubleByteStart) {
 283           maybeSingleByteKatakanaCount++;
 284         }
 285       }
 286       if (!lastWasPossibleDoubleByteStart && ((value >= 0xF0 && value <= 0xFF) || value == 0x80 || value == 0xA0)) {
 287         canBeShiftJIS = false;
 288       }
 289       if (((value >= 0x81 && value <= 0x9F) || (value >= 0xE0 && value <= 0xEF)) && i < length - 1) {
 290         // These start double-byte characters in Shift_JIS. Let's see if it's followed by a valid
 291         // second byte.
 292         sawDoubleByteStart = true;
 293         if (lastWasPossibleDoubleByteStart) {
 294           // If we just checked this and the last byte for being a valid double-byte
 295           // char, don't check starting on this byte. If this and the last byte
 296           // formed a valid pair, then this shouldn't be checked to see if it starts
 297           // a double byte pair of course.
 298           lastWasPossibleDoubleByteStart = false;
 299         } else {
 300           // ... otherwise do check to see if this plus the next byte form a valid
 301           // double byte pair encoding a character.
 302           lastWasPossibleDoubleByteStart = true;
 303           int nextValue = bytes[i + 1] & 0xFF;
 304           if (nextValue < 0x40 || nextValue > 0xFC) {
 305             canBeShiftJIS = false;
 306           }
 307           // There is some conflicting information out there about which bytes can follow which in
 308           // double-byte Shift_JIS characters. The rule above seems to be the one that matches practice.
 309         }
 310       } else {
 311         lastWasPossibleDoubleByteStart = false;
 312       }
 313     }
 314     // Distinguishing Shift_JIS and ISO-8859-1 can be a little tough. The crude heuristic is:
 315     // - If we saw
 316     //   - at least one byte that starts a double-byte value (bytes that are rare in ISO-8859-1), or
 317     //   - over 5% of bytes that could be single-byte Katakana (also rare in ISO-8859-1),
 318     // - and, saw no sequences that are invalid in Shift_JIS, then we conclude Shift_JIS
 319     if (canBeShiftJIS && (sawDoubleByteStart || 20 * maybeSingleByteKatakanaCount > length)) {
 320       return SHIFT_JIS;
 321     }
 322     // Otherwise, we default to ISO-8859-1 unless we know it can't be
 323     if (!sawLatin1Supplement && canBeISO88591) {
 324       return ISO88591;
 325     }
 326     // Otherwise, we take a wild guess with UTF-8
 327     return UTF8;
 328   }
 329
 330   private static int parseECIValue(BitSource bits) {
 331     int firstByte = bits.readBits(8);
 332     if ((firstByte & 0x80) == 0) {
 333       // just one byte
 334       return firstByte & 0x7F;
 335     } else if ((firstByte & 0xC0) == 0x80) {
 336       // two bytes
 337       int secondByte = bits.readBits(8);
 338       return ((firstByte & 0x3F) << 8) | secondByte;
 339     } else if ((firstByte & 0xE0) == 0xC0) {
 340       // three bytes
 341       int secondThirdBytes = bits.readBits(16);
 342       return ((firstByte & 0x1F) << 16) | secondThirdBytes;
 343     }
 344     throw new IllegalArgumentException("Bad ECI bits starting with byte " + firstByte);
 345   }
 346
 347 }