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         // How many characters will follow, encoded in this mode?
  71         int count = bits.readBits(mode.getCharacterCountBits(version));
  72         if (mode.equals(Mode.NUMERIC)) {
  73           decodeNumericSegment(bits, result, count);
  74         } else if (mode.equals(Mode.ALPHANUMERIC)) {
  75           decodeAlphanumericSegment(bits, result, count);
  76         } else if (mode.equals(Mode.BYTE)) {
  77           decodeByteSegment(bits, result, count);
  78         } else if (mode.equals(Mode.KANJI)) {
  79           decodeKanjiSegment(bits, result, count);
  80         } else {
  81           throw new ReaderException("Unsupported mode indicator");
  82         }
  83       }
  84     } while (!mode.equals(Mode.TERMINATOR));
  85
  86     // I thought it wasn't allowed to leave extra bytes after the terminator but it happens
  87     /*
  88     int bitsLeft = bits.available();
  89     if (bitsLeft > 0) {
  90       if (bitsLeft > 6 || bits.readBits(bitsLeft) != 0) {
  91         throw new ReaderException("Excess bits or non-zero bits after terminator mode indicator");
  92       }
  93     }
  94      */
  95     return result.toString();
  96   }
  97
  98   private static void decodeKanjiSegment(BitSource bits,
  99                                          StringBuffer result,
 100                                          int count) throws ReaderException {
 101     // Each character will require 2 bytes. Read the characters as 2-byte pairs
 102     // and decode as Shift_JIS afterwards
 103     byte[] buffer = new byte[2 * count];
 104     int offset = 0;
 105     while (count > 0) {
 106       // Each 13 bits encodes a 2-byte character
 107       int twoBytes = bits.readBits(13);
 108       int assembledTwoBytes = ((twoBytes / 0x0C0) << 8) | (twoBytes % 0x0C0);
 109       if (assembledTwoBytes < 0x01F00) {
 110         // In the 0x8140 to 0x9FFC range
 111         assembledTwoBytes += 0x08140;
 112       } else {
 113         // In the 0xE040 to 0xEBBF range
 114         assembledTwoBytes += 0x0C140;
 115       }
 116       buffer[offset] = (byte) (assembledTwoBytes >> 8);
 117       buffer[offset + 1] = (byte) assembledTwoBytes;
 118       offset += 2;
 119       count--;
 120     }
 121     // Shift_JIS may not be supported in some environments:
 122     try {
 123       result.append(new String(buffer, SHIFT_JIS));
 124     } catch (UnsupportedEncodingException uee) {
 125       throw new ReaderException(SHIFT_JIS + " encoding is not supported on this device");
 126     }
 127   }
 128
 129   private static void decodeByteSegment(BitSource bits,
 130                                         StringBuffer result,
 131                                         int count) throws ReaderException {
 132     byte[] readBytes = new byte[count];
 133     if (count << 3 > bits.available()) {
 134       throw new ReaderException("Count too large: " + count);
 135     }
 136     for (int i = 0; i < count; i++) {
 137       readBytes[i] = (byte) bits.readBits(8);
 138     }
 139     // The spec isn't clear on this mode; see
 140     // section 6.4.5: t does not say which encoding to assuming
 141     // upon decoding. I have seen ISO-8859-1 used as well as
 142     // Shift_JIS -- without anything like an ECI designator to
 143     // give a hint.
 144     String encoding = guessEncoding(readBytes);
 145     try {
 146       result.append(new String(readBytes, encoding));
 147     } catch (UnsupportedEncodingException uce) {
 148       throw new ReaderException(uce.toString());
 149     }
 150   }
 151
 152   private static void decodeAlphanumericSegment(BitSource bits,
 153                                                 StringBuffer result,
 154                                                 int count) {
 155     // Read two characters at a time
 156     while (count > 1) {
 157       int nextTwoCharsBits = bits.readBits(11);
 158       result.append(ALPHANUMERIC_CHARS[nextTwoCharsBits / 45]);
 159       result.append(ALPHANUMERIC_CHARS[nextTwoCharsBits % 45]);
 160       count -= 2;
 161     }
 162     if (count == 1) {
 163       // special case: one character left
 164       result.append(ALPHANUMERIC_CHARS[bits.readBits(6)]);
 165     }
 166   }
 167
 168   private static void decodeNumericSegment(BitSource bits,
 169                                            StringBuffer result,
 170                                            int count) throws ReaderException {
 171     // Read three digits at a time
 172     while (count >= 3) {
 173       // Each 10 bits encodes three digits
 174       int threeDigitsBits = bits.readBits(10);
 175       if (threeDigitsBits >= 1000) {
 176         throw new ReaderException("Illegal value for 3-digit unit: " + threeDigitsBits);
 177       }
 178       result.append(ALPHANUMERIC_CHARS[threeDigitsBits / 100]);
 179       result.append(ALPHANUMERIC_CHARS[(threeDigitsBits / 10) % 10]);
 180       result.append(ALPHANUMERIC_CHARS[threeDigitsBits % 10]);
 181       count -= 3;
 182     }
 183     if (count == 2) {
 184       // Two digits left over to read, encoded in 7 bits
 185       int twoDigitsBits = bits.readBits(7);
 186       if (twoDigitsBits >= 100) {
 187         throw new ReaderException("Illegal value for 2-digit unit: " + twoDigitsBits);
 188       }
 189       result.append(ALPHANUMERIC_CHARS[twoDigitsBits / 10]);
 190       result.append(ALPHANUMERIC_CHARS[twoDigitsBits % 10]);
 191     } else if (count == 1) {
 192       // One digit left over to read
 193       int digitBits = bits.readBits(4);
 194       if (digitBits >= 10) {
 195         throw new ReaderException("Illegal value for digit unit: " + digitBits);
 196       }
 197       result.append(ALPHANUMERIC_CHARS[digitBits]);
 198     }
 199   }
 200
 201   private static String guessEncoding(byte[] bytes) {
 202     if (ASSUME_SHIFT_JIS) {
 203       return SHIFT_JIS;
 204     }
 205     // Does it start with the UTF-8 byte order mark? then guess it's UTF-8
 206     if (bytes.length > 3 && bytes[0] == (byte) 0xEF && bytes[1] == (byte) 0xBB && bytes[2] == (byte) 0xBF) {
 207       return UTF8;
 208     }
 209     // For now, merely tries to distinguish ISO-8859-1, UTF-8 and Shift_JIS,
 210     // which should be by far the most common encodings. ISO-8859-1
 211     // should not have bytes in the 0x80 - 0x9F range, while Shift_JIS
 212     // uses this as a first byte of a two-byte character. If we see this
 213     // followed by a valid second byte in Shift_JIS, assume it is Shift_JIS.
 214     // If we see something else in that second byte, we'll make the risky guess
 215     // that it's UTF-8.
 216     int length = bytes.length;
 217     boolean canBeISO88591 = true;
 218     boolean lastWasPossibleDoubleByteStart = false;
 219     for (int i = 0; i < length; i++) {
 220       int value = bytes[i] & 0xFF;
 221       if (value >= 0x80 && value <= 0x9F && i < length - 1) {
 222         canBeISO88591 = false;
 223         // ISO-8859-1 shouldn't use this, but before we decide it is Shift_JIS,
 224         // just double check that it is followed by a byte that's valid in
 225         // the Shift_JIS encoding
 226         if (lastWasPossibleDoubleByteStart) {
 227           // If we just checked this and the last byte for being a valid double-byte
 228           // char, don't check starting on this byte. If the this and the last byte
 229           // formed a valid pair, then this shouldn't be checked to see if it starts
 230           // a double byte pair of course.
 231           lastWasPossibleDoubleByteStart = false;
 232         } else {
 233           // ... otherwise do check to see if this plus the next byte form a valid
 234           // double byte pair encoding a character.
 235           lastWasPossibleDoubleByteStart = true;
 236           int nextValue = bytes[i + 1] & 0xFF;
 237           if ((value & 0x1) == 0) {
 238             // if even, next value should be in [0x9F,0xFC]
 239             // if not, we'll guess UTF-8
 240             if (nextValue < 0x9F || nextValue > 0xFC) {
 241               return UTF8;
 242             }
 243           } else {
 244             // if odd, next value should be in [0x40,0x9E]
 245             // if not, we'll guess UTF-8
 246             if (nextValue < 0x40 || nextValue > 0x9E) {
 247               return UTF8;
 248             }
 249           }
 250         }
 251       }
 252     }
 253     return canBeISO88591 ? ISO88591 : SHIFT_JIS;
 254   }
 255
 256 }