+++ /dev/null
-package tim.prune.drew.jpeg;\r
-\r
-import java.io.File;\r
-import java.util.HashMap;\r
-\r
-/**\r
- * Extracts Exif data from a JPEG header segment\r
- * Based on Drew Noakes' Metadata extractor at http://drewnoakes.com\r
- * which in turn is based on code from Jhead http://www.sentex.net/~mwandel/jhead/\r
- */\r
-public class ExifReader\r
-{\r
- /** The JPEG segment as an array of bytes */\r
- private final byte[] _data;\r
-\r
- /**\r
- * Represents the native byte ordering used in the JPEG segment. If true,\r
- * then we're using Motorola ordering (Big endian), else we're using Intel\r
- * ordering (Little endian).\r
- */\r
- private boolean _isMotorolaByteOrder;\r
-\r
- /** Thumbnail offset */\r
- private int _thumbnailOffset = -1;\r
- /** Thumbnail length */\r
- private int _thumbnailLength = -1;\r
-\r
- /** The number of bytes used per format descriptor */\r
- private static final int[] BYTES_PER_FORMAT = {0, 1, 1, 2, 4, 8, 1, 1, 2, 4, 8, 4, 8};\r
-\r
- /** The number of formats known */\r
- private static final int MAX_FORMAT_CODE = 12;\r
-\r
- // Format types\r
- // Note: Cannot use the DataFormat enumeration in the case statement that uses these tags.\r
- // Is there a better way?\r
- //private static final int FMT_BYTE = 1;\r
- private static final int FMT_STRING = 2;\r
- //private static final int FMT_USHORT = 3;\r
- //private static final int FMT_ULONG = 4;\r
- private static final int FMT_URATIONAL = 5;\r
- //private static final int FMT_SBYTE = 6;\r
- //private static final int FMT_UNDEFINED = 7;\r
- //private static final int FMT_SSHORT = 8;\r
- //private static final int FMT_SLONG = 9;\r
- private static final int FMT_SRATIONAL = 10;\r
- //private static final int FMT_SINGLE = 11;\r
- //private static final int FMT_DOUBLE = 12;\r
-\r
- public static final int TAG_EXIF_OFFSET = 0x8769;\r
- public static final int TAG_INTEROP_OFFSET = 0xA005;\r
- public static final int TAG_GPS_INFO_OFFSET = 0x8825;\r
- public static final int TAG_MAKER_NOTE = 0x927C;\r
-\r
- public static final int TIFF_HEADER_START_OFFSET = 6;\r
-\r
- /** GPS tag version GPSVersionID 0 0 BYTE 4 */\r
- public static final int TAG_GPS_VERSION_ID = 0x0000;\r
- /** North or South Latitude GPSLatitudeRef 1 1 ASCII 2 */\r
- public static final int TAG_GPS_LATITUDE_REF = 0x0001;\r
- /** Latitude GPSLatitude 2 2 RATIONAL 3 */\r
- public static final int TAG_GPS_LATITUDE = 0x0002;\r
- /** East or West Longitude GPSLongitudeRef 3 3 ASCII 2 */\r
- public static final int TAG_GPS_LONGITUDE_REF = 0x0003;\r
- /** Longitude GPSLongitude 4 4 RATIONAL 3 */\r
- public static final int TAG_GPS_LONGITUDE = 0x0004;\r
- /** Altitude reference GPSAltitudeRef 5 5 BYTE 1 */\r
- public static final int TAG_GPS_ALTITUDE_REF = 0x0005;\r
- /** Altitude GPSAltitude 6 6 RATIONAL 1 */\r
- public static final int TAG_GPS_ALTITUDE = 0x0006;\r
- /** GPS time (atomic clock) GPSTimeStamp 7 7 RATIONAL 3 */\r
- public static final int TAG_GPS_TIMESTAMP = 0x0007;\r
- /** GPS date (atomic clock) GPSDateStamp 23 1d RATIONAL 3 */\r
- public static final int TAG_GPS_DATESTAMP = 0x001d;\r
- /** Exif timestamp */\r
- public static final int TAG_DATETIME_ORIGINAL = 0x9003;\r
- /** Thumbnail offset */\r
- private static final int TAG_THUMBNAIL_OFFSET = 0x0201;\r
- /** Thumbnail length */\r
- private static final int TAG_THUMBNAIL_LENGTH = 0x0202;\r
- /** Orientation of image */\r
- private static final int TAG_ORIENTATION = 0x0112;\r
-\r
-\r
- /**\r
- * Creates an ExifReader for a Jpeg file\r
- * @param inFile File object to attempt to read from\r
- * @throws JpegException on failure\r
- */\r
- public ExifReader(File inFile) throws JpegException\r
- {\r
- JpegSegmentData segments = JpegSegmentReader.readSegments(inFile);\r
- _data = segments.getSegment(JpegSegmentReader.SEGMENT_APP1);\r
- }\r
-\r
- /**\r
- * Performs the Exif data extraction\r
- * @return the GPS data found in the file\r
- */\r
- public JpegData extract()\r
- {\r
- JpegData metadata = new JpegData();\r
- if (_data==null)\r
- return metadata;\r
-\r
- // check for the header length\r
- if (_data.length<=14)\r
- {\r
- metadata.addError("Exif data segment must contain at least 14 bytes");\r
- return metadata;\r
- }\r
-\r
- // check for the header preamble\r
- if (!"Exif\0\0".equals(new String(_data, 0, 6)))\r
- {\r
- metadata.addError("Exif data segment doesn't begin with 'Exif'");\r
- return metadata;\r
- }\r
-\r
- // this should be either "MM" or "II"\r
- String byteOrderIdentifier = new String(_data, 6, 2);\r
- if (!setByteOrder(byteOrderIdentifier))\r
- {\r
- metadata.addError("Unclear distinction between Motorola/Intel byte ordering: " + byteOrderIdentifier);\r
- return metadata;\r
- }\r
-\r
- // Check the next two values are 0x2A as expected\r
- if (get16Bits(8)!=0x2a)\r
- {\r
- metadata.addError("Invalid Exif start - should have 0x2A at offset 8 in Exif header");\r
- return metadata;\r
- }\r
-\r
- int firstDirectoryOffset = get32Bits(10) + TIFF_HEADER_START_OFFSET;\r
-\r
- // Check that offset is within range\r
- if (firstDirectoryOffset>=_data.length - 1)\r
- {\r
- metadata.addError("First exif directory offset is beyond end of Exif data segment");\r
- // First directory normally starts 14 bytes in -- try it here and catch another error in the worst case\r
- firstDirectoryOffset = 14;\r
- }\r
-\r
- HashMap<Integer, String> processedDirectoryOffsets = new HashMap<Integer, String>();\r
-\r
- // 0th IFD (we merge with Exif IFD)\r
- processDirectory(metadata, false, processedDirectoryOffsets, firstDirectoryOffset, TIFF_HEADER_START_OFFSET);\r
-\r
- return metadata;\r
- }\r
-\r
-\r
- /**\r
- * Set the byte order identifier\r
- * @param byteOrderIdentifier String from exif\r
- * @return true if recognised, false otherwise\r
- */\r
- private boolean setByteOrder(String byteOrderIdentifier)\r
- {\r
- if ("MM".equals(byteOrderIdentifier)) {\r
- _isMotorolaByteOrder = true;\r
- } else if ("II".equals(byteOrderIdentifier)) {\r
- _isMotorolaByteOrder = false;\r
- } else {\r
- return false;\r
- }\r
- return true;\r
- }\r
-\r
-\r
- /**\r
- * Recursive call to process one of the nested Tiff IFD directories.\r
- * 2 bytes: number of tags\r
- * for each tag\r
- * 2 bytes: tag type\r
- * 2 bytes: format code\r
- * 4 bytes: component count\r
- */\r
- private void processDirectory(JpegData inMetadata, boolean inIsGPS, HashMap<Integer, String> inDirectoryOffsets,\r
- int inDirOffset, int inTiffHeaderOffset)\r
- {\r
- // check for directories we've already visited to avoid stack overflows when recursive/cyclic directory structures exist\r
- if (inDirectoryOffsets.containsKey(Integer.valueOf(inDirOffset)))\r
- return;\r
-\r
- // remember that we've visited this directory so that we don't visit it again later\r
- inDirectoryOffsets.put(Integer.valueOf(inDirOffset), "processed");\r
-\r
- if (inDirOffset >= _data.length || inDirOffset < 0)\r
- {\r
- inMetadata.addError("Ignored directory marked to start outside data segment");\r
- return;\r
- }\r
-\r
- // First two bytes in the IFD are the number of tags in this directory\r
- int dirTagCount = get16Bits(inDirOffset);\r
- // If no tags, exit without complaint\r
- if (dirTagCount == 0) return;\r
-\r
- if (!isDirectoryLengthValid(inDirOffset, inTiffHeaderOffset))\r
- {\r
- inMetadata.addError("Directory length is not valid");\r
- return;\r
- }\r
-\r
- inMetadata.setExifDataPresent();\r
- // Handle each tag in this directory\r
- for (int tagNumber = 0; tagNumber<dirTagCount; tagNumber++)\r
- {\r
- final int tagOffset = calculateTagOffset(inDirOffset, tagNumber);\r
-\r
- // 2 bytes for the tag type\r
- final int tagType = get16Bits(tagOffset);\r
-\r
- // 2 bytes for the format code\r
- final int formatCode = get16Bits(tagOffset + 2);\r
- if (formatCode < 1 || formatCode > MAX_FORMAT_CODE)\r
- {\r
- inMetadata.addError("Invalid format code: " + formatCode);\r
- continue;\r
- }\r
-\r
- // 4 bytes dictate the number of components in this tag's data\r
- final int componentCount = get32Bits(tagOffset + 4);\r
- if (componentCount < 0)\r
- {\r
- inMetadata.addError("Negative component count in EXIF");\r
- continue;\r
- }\r
- // each component may have more than one byte... calculate the total number of bytes\r
- final int byteCount = componentCount * BYTES_PER_FORMAT[formatCode];\r
- final int tagValueOffset = calculateTagValueOffset(byteCount, tagOffset, inTiffHeaderOffset);\r
- if (tagValueOffset < 0 || tagValueOffset > _data.length)\r
- {\r
- inMetadata.addError("Illegal pointer offset value in EXIF");\r
- continue;\r
- }\r
-\r
- // Check that this tag isn't going to allocate outside the bounds of the data array.\r
- // This addresses an uncommon OutOfMemoryError.\r
- if (byteCount < 0 || tagValueOffset + byteCount > _data.length)\r
- {\r
- inMetadata.addError("Illegal number of bytes: " + byteCount);\r
- continue;\r
- }\r
-\r
- // Calculate the value as an offset for cases where the tag represents a directory\r
- final int subdirOffset = inTiffHeaderOffset + get32Bits(tagValueOffset);\r
-\r
- // Look in both basic Exif tags (for timestamp, thumbnail) and Gps tags (for lat, long, altitude, timestamp)\r
- switch (tagType)\r
- {\r
- case TAG_EXIF_OFFSET:\r
- processDirectory(inMetadata, false, inDirectoryOffsets, subdirOffset, inTiffHeaderOffset);\r
- continue;\r
- case TAG_INTEROP_OFFSET:\r
- // ignore\r
- continue;\r
- case TAG_GPS_INFO_OFFSET:\r
- processDirectory(inMetadata, true, inDirectoryOffsets, subdirOffset, inTiffHeaderOffset);\r
- continue;\r
- case TAG_MAKER_NOTE:\r
- // ignore\r
- continue;\r
- default:\r
- // not a known directory, so must just be a normal tag\r
- if (inIsGPS)\r
- {\r
- processGpsTag(inMetadata, tagType, tagValueOffset, componentCount, formatCode);\r
- }\r
- else\r
- {\r
- processExifTag(inMetadata, tagType, tagValueOffset, componentCount, formatCode);\r
- }\r
- break;\r
- }\r
- }\r
-\r
- // at the end of each IFD is an optional link to the next IFD\r
- final int finalTagOffset = calculateTagOffset(inDirOffset, dirTagCount);\r
- int nextDirectoryOffset = get32Bits(finalTagOffset);\r
- if (nextDirectoryOffset != 0)\r
- {\r
- nextDirectoryOffset += inTiffHeaderOffset;\r
- if (nextDirectoryOffset>=_data.length)\r
- {\r
- // Last 4 bytes of IFD reference another IFD with an address that is out of bounds\r
- return;\r
- }\r
- else if (nextDirectoryOffset < inDirOffset)\r
- {\r
- // Last 4 bytes of IFD reference another IFD with an address before the start of this directory\r
- return;\r
- }\r
- // the next directory is of same type as this one\r
- processDirectory(inMetadata, false, inDirectoryOffsets, nextDirectoryOffset, inTiffHeaderOffset);\r
- }\r
- }\r
-\r
-\r
- /**\r
- * Check if the directory length is valid\r
- * @param dirStartOffset start offset for directory\r
- * @param tiffHeaderOffset Tiff header offeset\r
- * @return true if length is valid\r
- */\r
- private boolean isDirectoryLengthValid(int inDirStartOffset, int inTiffHeaderOffset)\r
- {\r
- int dirTagCount = get16Bits(inDirStartOffset);\r
- int dirLength = (2 + (12 * dirTagCount) + 4);\r
- if (dirLength + inDirStartOffset + inTiffHeaderOffset >= _data.length)\r
- {\r
- // Note: Files that had thumbnails trimmed with jhead 1.3 or earlier might trigger this\r
- return false;\r
- }\r
- return true;\r
- }\r
-\r
-\r
- /**\r
- * Process a GPS tag and put the contents in the given metadata\r
- * @param inMetadata metadata holding extracted values\r
- * @param inTagType tag type (eg latitude)\r
- * @param inTagValueOffset start offset in data array\r
- * @param inComponentCount component count for tag\r
- * @param inFormatCode format code, eg byte\r
- */\r
- private void processGpsTag(JpegData inMetadata, int inTagType, int inTagValueOffset,\r
- int inComponentCount, int inFormatCode)\r
- {\r
- // Only interested in tags latref, lat, longref, lon, altref, alt and gps timestamp\r
- switch (inTagType)\r
- {\r
- case TAG_GPS_LATITUDE_REF:\r
- inMetadata.setLatitudeRef(readString(inTagValueOffset, inFormatCode, inComponentCount));\r
- break;\r
- case TAG_GPS_LATITUDE:\r
- inMetadata.setLatitude(readRationalArray(inTagValueOffset, inFormatCode, inComponentCount));\r
- break;\r
- case TAG_GPS_LONGITUDE_REF:\r
- inMetadata.setLongitudeRef(readString(inTagValueOffset, inFormatCode, inComponentCount));\r
- break;\r
- case TAG_GPS_LONGITUDE:\r
- inMetadata.setLongitude(readRationalArray(inTagValueOffset, inFormatCode, inComponentCount));\r
- break;\r
- case TAG_GPS_ALTITUDE_REF:\r
- inMetadata.setAltitudeRef(_data[inTagValueOffset]);\r
- break;\r
- case TAG_GPS_ALTITUDE:\r
- inMetadata.setAltitude(readRational(inTagValueOffset, inFormatCode, inComponentCount));\r
- break;\r
- case TAG_GPS_TIMESTAMP:\r
- inMetadata.setGpsTimestamp(readRationalArray(inTagValueOffset, inFormatCode, inComponentCount));\r
- break;\r
- case TAG_GPS_DATESTAMP:\r
- inMetadata.setGpsDatestamp(readRationalArray(inTagValueOffset, inFormatCode, inComponentCount));\r
- break;\r
- default: // ignore all other tags\r
- }\r
- }\r
-\r
-\r
- /**\r
- * Process a general Exif tag\r
- * @param inMetadata metadata holding extracted values\r
- * @param inTagType tag type (eg latitude)\r
- * @param inTagValueOffset start offset in data array\r
- * @param inComponentCount component count for tag\r
- * @param inFormatCode format code, eg byte\r
- */\r
- private void processExifTag(JpegData inMetadata, int inTagType, int inTagValueOffset,\r
- int inComponentCount, int inFormatCode)\r
- {\r
- // Only interested in original timestamp, thumbnail offset and thumbnail length\r
- if (inTagType == TAG_DATETIME_ORIGINAL)\r
- {\r
- inMetadata.setOriginalTimestamp(readString(inTagValueOffset, inFormatCode, inComponentCount));\r
- }\r
- else if (inTagType == TAG_THUMBNAIL_OFFSET) {\r
- _thumbnailOffset = TIFF_HEADER_START_OFFSET + get16Bits(inTagValueOffset);\r
- extractThumbnail(inMetadata);\r
- }\r
- else if (inTagType == TAG_THUMBNAIL_LENGTH) {\r
- _thumbnailLength = get16Bits(inTagValueOffset);\r
- extractThumbnail(inMetadata);\r
- }\r
- else if (inTagType == TAG_ORIENTATION) {\r
- if (inMetadata.getOrientationCode() < 1) {\r
- inMetadata.setOrientationCode(get16Bits(inTagValueOffset));\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * Attempt to extract the thumbnail image\r
- */\r
- private void extractThumbnail(JpegData inMetadata)\r
- {\r
- if (_thumbnailOffset > 0 && _thumbnailLength > 0 && inMetadata.getThumbnailImage() == null)\r
- {\r
- byte[] thumbnailBytes = new byte[_thumbnailLength];\r
- System.arraycopy(_data, _thumbnailOffset, thumbnailBytes, 0, _thumbnailLength);\r
- inMetadata.setThumbnailImage(thumbnailBytes);\r
- }\r
- }\r
-\r
-\r
- /**\r
- * Calculate the tag value offset\r
- * @param inByteCount\r
- * @param inDirEntryOffset\r
- * @param inTiffHeaderOffset\r
- * @return new offset\r
- */\r
- private int calculateTagValueOffset(int inByteCount, int inDirEntryOffset, int inTiffHeaderOffset)\r
- {\r
- if (inByteCount > 4)\r
- {\r
- // If it's bigger than 4 bytes, the dir entry contains an offset.\r
- // dirEntryOffset must be passed, as some makers (e.g. FujiFilm) incorrectly use an\r
- // offset relative to the start of the makernote itself, not the TIFF segment.\r
- final int offsetVal = get32Bits(inDirEntryOffset + 8);\r
- if (offsetVal + inByteCount > _data.length)\r
- {\r
- // Bogus pointer offset and / or bytecount value\r
- return -1; // signal error\r
- }\r
- return inTiffHeaderOffset + offsetVal;\r
- }\r
- else\r
- {\r
- // 4 bytes or less and value is in the dir entry itself\r
- return inDirEntryOffset + 8;\r
- }\r
- }\r
-\r
-\r
- /**\r
- * Creates a String from the _data buffer starting at the specified offset,\r
- * and ending where byte=='\0' or where length==maxLength.\r
- * @param inOffset start offset\r
- * @param inFormatCode format code - should be string\r
- * @param inMaxLength max length of string\r
- * @return contents of tag, or null if format incorrect\r
- */\r
- private String readString(int inOffset, int inFormatCode, int inMaxLength)\r
- {\r
- if (inFormatCode != FMT_STRING) return null;\r
- // Calculate length\r
- int length = 0;\r
- while ((inOffset + length)<_data.length\r
- && _data[inOffset + length]!='\0'\r
- && length < inMaxLength)\r
- {\r
- length++;\r
- }\r
- return new String(_data, inOffset, length);\r
- }\r
-\r
- /**\r
- * Creates a Rational from the _data buffer starting at the specified offset\r
- * @param inOffset start offset\r
- * @param inFormatCode format code - should be srational or urational\r
- * @param inCount component count - should be 1\r
- * @return contents of tag as a Rational object\r
- */\r
- private Rational readRational(int inOffset, int inFormatCode, int inCount)\r
- {\r
- // Check the format is a single rational as expected\r
- if (inFormatCode != FMT_SRATIONAL && inFormatCode != FMT_URATIONAL\r
- || inCount != 1) return null;\r
- return new Rational(get32Bits(inOffset), get32Bits(inOffset + 4));\r
- }\r
-\r
-\r
- /**\r
- * Creates a Rational array from the _data buffer starting at the specified offset\r
- * @param inOffset start offset\r
- * @param inFormatCode format code - should be srational or urational\r
- * @param inCount component count - number of components\r
- * @return contents of tag as an array of Rational objects\r
- */\r
- private Rational[] readRationalArray(int inOffset, int inFormatCode, int inCount)\r
- {\r
- // Check the format is rational as expected\r
- if (inFormatCode != FMT_SRATIONAL && inFormatCode != FMT_URATIONAL)\r
- return null;\r
- // Build array of Rationals\r
- Rational[] answer = new Rational[inCount];\r
- for (int i=0; i<inCount; i++)\r
- answer[i] = new Rational(get32Bits(inOffset + (8 * i)), get32Bits(inOffset + 4 + (8 * i)));\r
- return answer;\r
- }\r
-\r
-\r
- /**\r
- * Determine the offset at which a given InteropArray entry begins within the specified IFD.\r
- * @param dirStartOffset the offset at which the IFD starts\r
- * @param entryNumber the zero-based entry number\r
- */\r
- private int calculateTagOffset(int dirStartOffset, int entryNumber)\r
- {\r
- // add 2 bytes for the tag count\r
- // each entry is 12 bytes, so we skip 12 * the number seen so far\r
- return dirStartOffset + 2 + (12 * entryNumber);\r
- }\r
-\r
-\r
- /**\r
- * Get a 16 bit value from file's native byte order. Between 0x0000 and 0xFFFF.\r
- */\r
- private int get16Bits(int offset)\r
- {\r
- if (offset<0 || offset+2>_data.length)\r
- throw new ArrayIndexOutOfBoundsException("attempt to read data outside of exif segment (index "\r
- + offset + " where max index is " + (_data.length - 1) + ")");\r
-\r
- if (_isMotorolaByteOrder) {\r
- // Motorola - MSB first\r
- return (_data[offset] << 8 & 0xFF00) | (_data[offset + 1] & 0xFF);\r
- } else {\r
- // Intel ordering - LSB first\r
- return (_data[offset + 1] << 8 & 0xFF00) | (_data[offset] & 0xFF);\r
- }\r
- }\r
-\r
-\r
- /**\r
- * Get a 32 bit value from file's native byte order.\r
- */\r
- private int get32Bits(int offset)\r
- {\r
- if (offset < 0 || offset+4 > _data.length)\r
- throw new ArrayIndexOutOfBoundsException("attempt to read data outside of exif segment (index "\r
- + offset + " where max index is " + (_data.length - 1) + ")");\r
-\r
- if (_isMotorolaByteOrder)\r
- {\r
- // Motorola - MSB first\r
- return (_data[offset] << 24 & 0xFF000000) |\r
- (_data[offset + 1] << 16 & 0xFF0000) |\r
- (_data[offset + 2] << 8 & 0xFF00) |\r
- (_data[offset + 3] & 0xFF);\r
- }\r
- else\r
- {\r
- // Intel ordering - LSB first\r
- return (_data[offset + 3] << 24 & 0xFF000000) |\r
- (_data[offset + 2] << 16 & 0xFF0000) |\r
- (_data[offset + 1] << 8 & 0xFF00) |\r
- (_data[offset] & 0xFF);\r
- }\r
- }\r
-}\r