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

   1 /*
   2  * Copyright 2007 Google Inc.
   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
  22 import java.io.UnsupportedEncodingException;
  23
  24 /**
  25  * <p>QR Codes can encode text as bits in one of several modes, and can use multiple modes
  26  * in one QR Code. This class decodes the bits back into text.</p>
  27  *
  28  * <p>See ISO 18004:2006, 6.4.3 - 6.4.7</p>
  29  *
  30  * @author srowen@google.com (Sean Owen)
  31  */
  32 final class DecodedBitStreamParser {
  33
  34   /**
  35    * See ISO 18004:2006, 6.4.4 Table 5
  36    */
  37   private static final char[] ALPHANUMERIC_CHARS = {
  38       '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B',
  39       'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N',
  40       'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
  41       ' ', '$', '%', '*', '+', '-', '.', '/', ':'
  42   };
  43   private static final String SHIFT_JIS = "Shift_JIS";
  44   private static final String EUC_JP = "EUC-JP";
  45   private static final boolean ASSUME_SHIFT_JIS;
  46   private static final String UTF8 = "UTF-8";
  47   private static final String ISO88591 = "ISO-8859-1";
  48
  49   static {
  50     String platformDefault = System.getProperty("file.encoding");
  51     ASSUME_SHIFT_JIS = SHIFT_JIS.equalsIgnoreCase(platformDefault) || EUC_JP.equalsIgnoreCase(platformDefault);
  52   }
  53
  54   private DecodedBitStreamParser() {
  55   }
  56
  57   static String decode(byte[] bytes, Version version) throws ReaderException {
  58     BitSource bits = new BitSource(bytes);
  59     StringBuffer result = new StringBuffer();
  60     Mode mode;
  61     do {
  62       // While still another segment to read...
  63       if (bits.available() == 0) {
  64         // OK, assume we're done. Really, a TERMINATOR mode should have been recorded here
  65         mode = Mode.TERMINATOR;
  66       } else {
  67         mode = Mode.forBits(bits.readBits(4)); // mode is encoded by 4 bits
  68       }
  69       if (!mode.equals(Mode.TERMINATOR)) {
  70         if (mode.equals(Mode.ECI)) {
  71           // Count doesn't apply to ECI
  72           parseECI(bits);
  73           // We don't currently do anything with ECI, since there seems to be no reference
  74           // defining what each value means. AIM's "Extended Channel Interpretations" does
  75           // not define it. I have never observed a QR Code using it. So for now, we at least
  76           // parse it but don't know how to take action on it.
  77         } else {
  78           // How many characters will follow, encoded in this mode?
  79          int count = bits.readBits(mode.getCharacterCountBits(version));
  80           if (mode.equals(Mode.NUMERIC)) {
  81             decodeNumericSegment(bits, result, count);
  82           } else if (mode.equals(Mode.ALPHANUMERIC)) {
  83             decodeAlphanumericSegment(bits, result, count);
  84           } else if (mode.equals(Mode.BYTE)) {
  85             decodeByteSegment(bits, result, count);
  86           } else if (mode.equals(Mode.KANJI)) {
  87             decodeKanjiSegment(bits, result, count);
  88           } else {
  89             throw new ReaderException("Unsupported mode indicator");
  90           }
  91         }
  92       }
  93     } while (!mode.equals(Mode.TERMINATOR));
  94
  95     // I thought it wasn't allowed to leave extra bytes after the terminator but it happens
  96     /*
  97     int bitsLeft = bits.available();
  98     if (bitsLeft > 0) {
  99       if (bitsLeft > 6 || bits.readBits(bitsLeft) != 0) {
 100         throw new ReaderException("Excess bits or non-zero bits after terminator mode indicator");
 101       }
 102     }
 103      */
 104     return result.toString();
 105   }
 106
 107   private static int parseECI(BitSource bits) {
 108     int firstByte = bits.readBits(8);
 109     if ((firstByte & 0x80) == 0) {
 110       // just one byte
 111       return firstByte & 0x7F;
 112     } else if ((firstByte & 0xC0) == 0x80) {
 113       // two bytes
 114       int secondByte = bits.readBits(8);
 115       return ((firstByte & 0x3F) << 8) | secondByte;
 116     } else if ((firstByte & 0xE0) == 0xC0) {
 117       // three bytes
 118       int secondByte = bits.readBits(8);
 119       int thirdByte = bits.readBits(8);
 120       return ((firstByte & 0x1F) << 16) | (secondByte << 8) | thirdByte;
 121     }
 122     // FIXME: What should we return here?
 123     return 0;
 124   }
 125
 126   private static void decodeKanjiSegment(BitSource bits,
 127                                          StringBuffer result,
 128                                          int count) throws ReaderException {
 129     // Each character will require 2 bytes. Read the characters as 2-byte pairs
 130     // and decode as Shift_JIS afterwards
 131     byte[] buffer = new byte[2 * count];
 132     int offset = 0;
 133     while (count > 0) {
 134       // Each 13 bits encodes a 2-byte character
 135       int twoBytes = bits.readBits(13);
 136       int assembledTwoBytes = ((twoBytes / 0x0C0) << 8) | (twoBytes % 0x0C0);
 137       if (assembledTwoBytes < 0x01F00) {
 138         // In the 0x8140 to 0x9FFC range
 139         assembledTwoBytes += 0x08140;
 140       } else {
 141         // In the 0xE040 to 0xEBBF range
 142         assembledTwoBytes += 0x0C140;
 143       }
 144       buffer[offset] = (byte) (assembledTwoBytes >> 8);
 145       buffer[offset + 1] = (byte) assembledTwoBytes;
 146       offset += 2;
 147       count--;
 148     }
 149     // Shift_JIS may not be supported in some environments:
 150     try {
 151       result.append(new String(buffer, SHIFT_JIS));
 152     } catch (UnsupportedEncodingException uee) {
 153       throw new ReaderException(SHIFT_JIS + " encoding is not supported on this device");
 154     }
 155   }
 156
 157   private static void decodeByteSegment(BitSource bits,
 158                                         StringBuffer result,
 159                                         int count) throws ReaderException {
 160     byte[] readBytes = new byte[count];
 161     if (count << 3 > bits.available()) {
 162       throw new ReaderException("Count too large: " + count);
 163     }
 164     for (int i = 0; i < count; i++) {
 165       readBytes[i] = (byte) bits.readBits(8);
 166     }
 167     // The spec isn't clear on this mode; see
 168     // section 6.4.5: t does not say which encoding to assuming
 169     // upon decoding. I have seen ISO-8859-1 used as well as
 170     // Shift_JIS -- without anything like an ECI designator to
 171     // give a hint.
 172     String encoding = guessEncoding(readBytes);
 173     try {
 174       result.append(new String(readBytes, encoding));
 175     } catch (UnsupportedEncodingException uce) {
 176       throw new ReaderException(uce.toString());
 177     }
 178   }
 179
 180   private static void decodeAlphanumericSegment(BitSource bits,
 181                                                 StringBuffer result,
 182                                                 int count) {
 183     // Read two characters at a time
 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   }
 195
 196   private static void decodeNumericSegment(BitSource bits,
 197                                            StringBuffer result,
 198                                            int count) throws ReaderException {
 199     // Read three digits at a time
 200     while (count >= 3) {
 201       // Each 10 bits encodes three digits
 202       int threeDigitsBits = bits.readBits(10);
 203       if (threeDigitsBits >= 1000) {
 204         throw new ReaderException("Illegal value for 3-digit unit: " + threeDigitsBits);
 205       }
 206       result.append(ALPHANUMERIC_CHARS[threeDigitsBits / 100]);
 207       result.append(ALPHANUMERIC_CHARS[(threeDigitsBits / 10) % 10]);
 208       result.append(ALPHANUMERIC_CHARS[threeDigitsBits % 10]);
 209       count -= 3;
 210     }
 211     if (count == 2) {
 212       // Two digits left over to read, encoded in 7 bits
 213       int twoDigitsBits = bits.readBits(7);
 214       if (twoDigitsBits >= 100) {
 215         throw new ReaderException("Illegal value for 2-digit unit: " + twoDigitsBits);
 216       }
 217       result.append(ALPHANUMERIC_CHARS[twoDigitsBits / 10]);
 218       result.append(ALPHANUMERIC_CHARS[twoDigitsBits % 10]);
 219     } else if (count == 1) {
 220       // One digit left over to read
 221       int digitBits = bits.readBits(4);
 222       if (digitBits >= 10) {
 223         throw new ReaderException("Illegal value for digit unit: " + digitBits);
 224       }
 225       result.append(ALPHANUMERIC_CHARS[digitBits]);
 226     }
 227   }
 228
 229   private static String guessEncoding(byte[] bytes) {
 230     if (ASSUME_SHIFT_JIS) {
 231       return SHIFT_JIS;
 232     }
 233     // Does it start with the UTF-8 byte order mark? then guess it's UTF-8
 234     if (bytes.length > 3 && bytes[0] == (byte) 0xEF && bytes[1] == (byte) 0xBB && bytes[2] == (byte) 0xBF) {
 235       return UTF8;
 236     }
 237     // For now, merely tries to distinguish ISO-8859-1, UTF-8 and Shift_JIS,
 238     // which should be by far the most common encodings. ISO-8859-1
 239     // should not have bytes in the 0x80 - 0x9F range, while Shift_JIS
 240     // uses this as a first byte of a two-byte character. If we see this
 241     // followed by a valid second byte in Shift_JIS, assume it is Shift_JIS.
 242     // If we see something else in that second byte, we'll make the risky guess
 243     // that it's UTF-8.
 244     int length = bytes.length;
 245     boolean canBeISO88591 = true;
 246     boolean lastWasPossibleDoubleByteStart = false;
 247     for (int i = 0; i < length; i++) {
 248       int value = bytes[i] & 0xFF;
 249       if (value >= 0x80 && value <= 0x9F && i < length - 1) {
 250         canBeISO88591 = false;
 251         // ISO-8859-1 shouldn't use this, but before we decide it is Shift_JIS,
 252         // just double check that it is followed by a byte that's valid in
 253         // the Shift_JIS encoding
 254         if (lastWasPossibleDoubleByteStart) {
 255           // If we just checked this and the last byte for being a valid double-byte
 256           // char, don't check starting on this byte. If the this and the last byte
 257           // formed a valid pair, then this shouldn't be checked to see if it starts
 258           // a double byte pair of course.
 259           lastWasPossibleDoubleByteStart = false;
 260         } else {
 261           // ... otherwise do check to see if this plus the next byte form a valid
 262           // double byte pair encoding a character.
 263           lastWasPossibleDoubleByteStart = true;
 264           int nextValue = bytes[i + 1] & 0xFF;
 265           if ((value & 0x1) == 0) {
 266             // if even, next value should be in [0x9F,0xFC]
 267             // if not, we'll guess UTF-8
 268             if (nextValue < 0x9F || nextValue > 0xFC) {
 269               return UTF8;
 270             }
 271           } else {
 272             // if odd, next value should be in [0x40,0x9E]
 273             // if not, we'll guess UTF-8
 274             if (nextValue < 0x40 || nextValue > 0x9E) {
 275               return UTF8;
 276             }
 277           }
 278         }
 279       }
 280     }
 281     return canBeISO88591 ? ISO88591 : SHIFT_JIS;
 282   }
 283
 284 }