All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.twelvemonkeys.imageio.plugins.tiff.TIFFImageMetadata Maven / Gradle / Ivy

There is a newer version: 3.11.0
Show newest version
/*
 * Copyright (c) 2015, Harald Kuhr
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.twelvemonkeys.imageio.plugins.tiff;

import static com.twelvemonkeys.imageio.plugins.tiff.TIFFImageReader.guessPhotometricInterpretation;

import java.lang.reflect.Array;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.*;

import javax.imageio.metadata.IIOInvalidTreeException;
import javax.imageio.metadata.IIOMetadataFormatImpl;
import javax.imageio.metadata.IIOMetadataNode;

import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import com.twelvemonkeys.imageio.AbstractMetadata;
import com.twelvemonkeys.imageio.metadata.Directory;
import com.twelvemonkeys.imageio.metadata.Entry;
import com.twelvemonkeys.imageio.metadata.tiff.IFD;
import com.twelvemonkeys.imageio.metadata.tiff.Rational;
import com.twelvemonkeys.imageio.metadata.tiff.TIFF;
import com.twelvemonkeys.imageio.metadata.tiff.TIFFEntry;
import com.twelvemonkeys.lang.Validate;

/**
 * TIFFImageMetadata.
 *
 * @author Harald Kuhr
 * @author last modified by $Author: harald.kuhr$
 * @version $Id: TIFFImageMetadata.java,v 1.0 17/04/15 harald.kuhr Exp$
 */
public final class TIFFImageMetadata extends AbstractMetadata {

    static final int RATIONAL_SCALE_FACTOR = 100000;

    private final Directory original;
    private Directory ifd;

    /**
     * Creates an empty TIFF metadata object.
     *
     * Client code can update or change the metadata using the
     * {@link #setFromTree(String, Node)}
     * or {@link #mergeTree(String, Node)} methods.
     */
    public TIFFImageMetadata() {
        this(new IFD(Collections.emptyList()));
    }

    /**
     * Creates a TIFF metadata object, using the values from the given IFD.
     *
     * Client code can update or change the metadata using the
     * {@link #setFromTree(String, Node)}
     * or {@link #mergeTree(String, Node)} methods.
     */
    public TIFFImageMetadata(final Directory ifd) {
        super(true, TIFFImageMetadataFormat.SUN_NATIVE_IMAGE_METADATA_FORMAT_NAME, TIFFImageMetadataFormat.class.getName(), null, null);
        this.ifd = Validate.notNull(ifd, "IFD");
        this.original = ifd;
    }

    /**
     * Creates a TIFF metadata object, using the values from the given entries.
     *
     * Client code can update or change the metadata using the
     * {@link #setFromTree(String, Node)}
     * or {@link #mergeTree(String, Node)} methods.
     */
    public TIFFImageMetadata(final Collection entries) {
        this(new IFD(entries));
    }

    protected IIOMetadataNode getNativeTree() {
        IIOMetadataNode root = new IIOMetadataNode(nativeMetadataFormatName);
        root.appendChild(asTree(ifd));

        return root;
    }

    private IIOMetadataNode asTree(final Directory ifd) {
        IIOMetadataNode ifdNode = new IIOMetadataNode("TIFFIFD");

        for (Entry tag : ifd) {
            IIOMetadataNode tagNode;
            Object value = tag.getValue();

            if (value instanceof Directory) {
                // TODO: Don't expand non-TIFF IFDs...
                tagNode = asTree((Directory) value);
                tagNode.setAttribute("parentTagNumber", String.valueOf(tag.getIdentifier()));
                String fieldName = tag.getFieldName();
                if (fieldName != null) {
                    tagNode.setAttribute("parentTagName", fieldName);
                }

                // TODO: tagSets is REQUIRED!
            }
            else {
                tagNode = new IIOMetadataNode("TIFFField");
                tagNode.setAttribute("number", String.valueOf(tag.getIdentifier()));

                String fieldName = tag.getFieldName();
                if (fieldName != null) {
                    tagNode.setAttribute("name", fieldName);
                }

                int count = tag.valueCount();

                if (TIFF.TYPE_NAMES[TIFF.TYPE_UNDEFINED].equals(tag.getTypeName())) {
                    // Why does "undefined" need special handling?! It's just a byte array.. :-P
                    // Or maybe rather, why isn't all types implemented like this..?
                    // TODO: Consider handling IPTC, Photoshop/Adobe, XMP and ICC Profile as Undefined always
                    // (even if older software wrote as Byte), as it's more compact?
                    IIOMetadataNode valueNode = new IIOMetadataNode("TIFFUndefined");
                    tagNode.appendChild(valueNode);

                    if (count == 1 && (value == null || !value.getClass().isArray())) {
                        valueNode.setAttribute("value", String.valueOf(value));
                    }
                    else {
                        valueNode.setAttribute("value", Arrays.toString((byte[]) value).replaceAll("\\[?\\]?", ""));
                    }
                }
                else {
                    String arrayTypeName = getMetadataArrayType(tag);
                    IIOMetadataNode valueNode = new IIOMetadataNode(arrayTypeName);
                    tagNode.appendChild(valueNode);

                    boolean unsigned = !isSignedType(tag);
                    String typeName = getMetadataType(tag);

                    // NOTE: ASCII/Strings have count 1, always. This seems consistent with the JAI ImageIO version.
                    if (count == 1 && (value == null || !value.getClass().isArray())) {
                        IIOMetadataNode elementNode = new IIOMetadataNode(typeName);
                        valueNode.appendChild(elementNode);

                        setTIFFNativeValue(value, unsigned, elementNode);
                    }
                    else {
                        for (int i = 0; i < count; i++) {
                            Object val = Array.get(value, i);
                            IIOMetadataNode elementNode = new IIOMetadataNode(typeName);
                            valueNode.appendChild(elementNode);

                            setTIFFNativeValue(val, unsigned, elementNode);
                        }
                    }
                }
            }

            ifdNode.appendChild(tagNode);
        }

        return ifdNode;
    }

    private void setTIFFNativeValue(final Object value, final boolean unsigned, final IIOMetadataNode elementNode) {
        if (unsigned && value instanceof Byte) {
            elementNode.setAttribute("value", String.valueOf((Byte) value & 0xFF));
        }
        else if (unsigned && value instanceof Short) {
            elementNode.setAttribute("value", String.valueOf((Short) value & 0xFFFF));
        }
        else if (unsigned && value instanceof Integer) {
            elementNode.setAttribute("value", String.valueOf((Integer) value & 0xFFFFFFFFL));
        }
        else if (value instanceof Rational) {
            // For compatibility with JAI format, we need denominator
            String rational = String.valueOf(value);
            elementNode.setAttribute("value", rational.indexOf('/') < 0 && !"NaN".equals(rational) ? rational + "/1" : rational);
        }
        else {
            elementNode.setAttribute("value", String.valueOf(value));
        }
    }

    private boolean isSignedType(final Entry tag) {
        String typeName = tag.getTypeName();

        // Stupid special cases implementation, until we can access the type id...
        if ("SBYTE".equals(typeName)) {
            return true;
        }
        if ("SSHORT".equals(typeName)) {
            return true;
        }
        if ("SLONG".equals(typeName)) {
            return true;
        }
        if ("SRATIONAL".equals(typeName)) {
            return true;
        }
        if ("FLOAT".equals(typeName)) {
            return true;
        }
        if ("DOUBLE".equals(typeName)) {
            return true;
        }
        if ("SLONG8".equals(typeName)) {
            return true;
        }
        // IFD8 not used

        return false;
    }

    private String getMetadataArrayType(final Entry tag) {
        String typeName = tag.getTypeName();

        // Stupid special cases implementation, until we can access the type id...
        if ("BYTE".equals(typeName)) {
            return "TIFFBytes";
        }
        if ("ASCII".equals(typeName)) {
            return "TIFFAsciis";
        }
        if ("SHORT".equals(typeName)) {
            return "TIFFShorts";
        }
        if ("LONG".equals(typeName)) {
            return "TIFFLongs";
        }
        if ("RATIONAL".equals(typeName)) {
            return "TIFFRationals";
        }
        // UNDEFINED not used...
        if ("SBYTE".equals(typeName)) {
            return "TIFFSBytes";
        }
        if ("SSHORT".equals(typeName)) {
            return "TIFFSShorts";
        }
        if ("SLONG".equals(typeName)) {
            return "TIFFSLongs";
        }
        if ("SRATIONAL".equals(typeName)) {
            return "TIFFSRationals";
        }
        if ("FLOAT".equals(typeName)) {
            return "TIFFFloats";
        }
        if ("DOUBLE".equals(typeName)) {
            return "TIFFDoubles";
        }
        // IFD not used
        if ("LONG8".equals(typeName)) {
            return "TIFFLong8s";
        }
        if ("SLONG8".equals(typeName)) {
            return "TIFFSLong8s";
        }
        // IFD8 not used

        throw new IllegalArgumentException(typeName);
    }

    private String getMetadataType(final Entry tag) {
        String typeName = tag.getTypeName();

        // Stupid special cases implementation, until we can access the type id...
        if ("BYTE".equals(typeName)) {
            return "TIFFByte";
        }
        if ("ASCII".equals(typeName)) {
            return "TIFFAscii";
        }
        if ("SHORT".equals(typeName)) {
            return "TIFFShort";
        }
        if ("LONG".equals(typeName)) {
            return "TIFFLong";
        }
        if ("RATIONAL".equals(typeName)) {
            return "TIFFRational";
        }
        // UNDEFINED not used...
        if ("SBYTE".equals(typeName)) {
            return "TIFFSByte";
        }
        if ("SSHORT".equals(typeName)) {
            return "TIFFSShort";
        }
        if ("SLONG".equals(typeName)) {
            return "TIFFSLong";
        }
        if ("SRATIONAL".equals(typeName)) {
            return "TIFFSRational";
        }
        if ("FLOAT".equals(typeName)) {
            return "TIFFFloat";
        }
        if ("DOUBLE".equals(typeName)) {
            return "TIFFDouble";
        }
        // IFD not used
        if ("LONG8".equals(typeName)) {
            return "TIFFLong8";
        }
        if ("SLONG8".equals(typeName)) {
            return "TIFFSLong8";
        }
        // IFD8 not used

        throw new IllegalArgumentException(typeName);
    }

    // TODO: Candidate superclass method!
    private IIOMetadataNode addChildNode(final IIOMetadataNode parent,
                                         final String name,
                                         final Object object) {
        IIOMetadataNode child = new IIOMetadataNode(name);

        if (object != null) {
            child.setUserObject(object); // TODO: Should we always store user object?!?!
            child.setNodeValue(object.toString()); // TODO: Fix this line
        }

        parent.appendChild(child);

        return child;
    }

    /// Standard metadata
    // See: http://download.java.net/media/jai-imageio/javadoc/1.1/com/sun/media/imageio/plugins/tiff/package-summary.html

    @Override
    protected IIOMetadataNode getStandardChromaNode() {
        IIOMetadataNode chroma = new IIOMetadataNode("Chroma");

        // Handle ColorSpaceType (RGB/CMYK/YCbCr etc)...
        int photometricValue = getPhotometricInterpretationWithFallback(); // No default for this tag!
        int numChannelsValue = getSamplesPerPixelWithFallback();

        IIOMetadataNode colorSpaceType = new IIOMetadataNode("ColorSpaceType");
        chroma.appendChild(colorSpaceType);
        switch (photometricValue) {
            case TIFFBaseline.PHOTOMETRIC_WHITE_IS_ZERO:
            case TIFFBaseline.PHOTOMETRIC_BLACK_IS_ZERO:
            case TIFFBaseline.PHOTOMETRIC_MASK: // It's really a transparency mask/alpha channel, but...
                colorSpaceType.setAttribute("name", "GRAY");
                break;
            case TIFFBaseline.PHOTOMETRIC_RGB:
            case TIFFBaseline.PHOTOMETRIC_PALETTE:
                colorSpaceType.setAttribute("name", "RGB");
                break;
            case TIFFExtension.PHOTOMETRIC_YCBCR:
                colorSpaceType.setAttribute("name", "YCbCr");
                break;
            case TIFFExtension.PHOTOMETRIC_CIELAB:
            case TIFFExtension.PHOTOMETRIC_ICCLAB:
            case TIFFExtension.PHOTOMETRIC_ITULAB:
                colorSpaceType.setAttribute("name", "Lab");
                break;
            case TIFFExtension.PHOTOMETRIC_SEPARATED:
                // TODO: May be CMYK, or something else... Consult InkSet and NumberOfInks!
                if (numChannelsValue == 3) {
                    colorSpaceType.setAttribute("name", "CMY");
                }
                else {
                    colorSpaceType.setAttribute("name", "CMYK");
                }
                break;
            case TIFFCustom.PHOTOMETRIC_LOGL: // ..?
            case TIFFCustom.PHOTOMETRIC_LOGLUV:
                colorSpaceType.setAttribute("name", "Luv");
                break;
            case TIFFCustom.PHOTOMETRIC_CFA:
            case TIFFCustom.PHOTOMETRIC_LINEAR_RAW: // ...or is this RGB?
                colorSpaceType.setAttribute("name", "3CLR");
                break;
            default:
                colorSpaceType.setAttribute("name", Integer.toHexString(numChannelsValue) + "CLR");
                break;
        }

        // NumChannels
        IIOMetadataNode numChannels = new IIOMetadataNode("NumChannels");
        chroma.appendChild(numChannels);
        if (photometricValue == TIFFBaseline.PHOTOMETRIC_PALETTE) {
            numChannels.setAttribute("value", "3");
        }
        else {
            numChannels.setAttribute("value", Integer.toString(numChannelsValue));
        }

        // BlackIsZero (defaults to TRUE)
        IIOMetadataNode blackIsZero = new IIOMetadataNode("BlackIsZero");
        chroma.appendChild(blackIsZero);
        switch (photometricValue) {
            case TIFFBaseline.PHOTOMETRIC_WHITE_IS_ZERO:
                blackIsZero.setAttribute("value", "FALSE");
                break;
            default:
                break;
        }

        Entry colorMapTag = ifd.getEntryById(TIFF.TAG_COLOR_MAP);

        if (colorMapTag != null) {
            int[] colorMapValues = (int[]) colorMapTag.getValue();

            IIOMetadataNode palette = new IIOMetadataNode("Palette");
            chroma.appendChild(palette);

            int count = colorMapValues.length / 3;
            for (int i = 0; i < count; i++) {
                IIOMetadataNode paletteEntry = new IIOMetadataNode("PaletteEntry");
                paletteEntry.setAttribute("index", Integer.toString(i));

                // TODO: See TIFFImageReader createIndexColorModel, to detect 8 bit colorMap
                paletteEntry.setAttribute("red", Integer.toString((colorMapValues[i] >> 8) & 0xff));
                paletteEntry.setAttribute("green", Integer.toString((colorMapValues[i + count] >> 8) & 0xff));
                paletteEntry.setAttribute("blue", Integer.toString((colorMapValues[i + count * 2] >> 8) & 0xff));

                palette.appendChild(paletteEntry);
            }
        }

        return chroma;
    }

    private int getPhotometricInterpretationWithFallback() {
        Entry photometricTag = ifd.getEntryById(TIFF.TAG_PHOTOMETRIC_INTERPRETATION);

        return photometricTag != null ? getValueAsInt(photometricTag)
                                      : guessPhotometricInterpretation(getCompression(), getSamplesPerPixelWithFallback(), ifd.getEntryById(TIFF.TAG_EXTRA_SAMPLES), ifd.getEntryById(TIFF.TAG_COLOR_MAP));
    }

    private int getSamplesPerPixelWithFallback() {
        // SamplePerPixel defaults to 1, but we'll check BitsPerSample to be sure
        Entry samplesPerPixelTag = ifd.getEntryById(TIFF.TAG_SAMPLES_PER_PIXEL);
        Entry bitsPerSampleTag = ifd.getEntryById(TIFF.TAG_BITS_PER_SAMPLE);

        return samplesPerPixelTag != null
                               ? getValueAsInt(samplesPerPixelTag)
                               : bitsPerSampleTag != null ? bitsPerSampleTag.valueCount() : 1;
    }

    private int getCompression() {
        Entry compressionTag = ifd.getEntryById(TIFF.TAG_COMPRESSION);
        return compressionTag == null
               ? TIFFBaseline.COMPRESSION_NONE
               : getValueAsInt(compressionTag);
    }

    @Override
    protected IIOMetadataNode getStandardCompressionNode() {
        IIOMetadataNode compression = new IIOMetadataNode("Compression");
        IIOMetadataNode compressionTypeName = addChildNode(compression, "CompressionTypeName", null);

        int compressionValue = getCompression();

        // Naming is identical to JAI ImageIO metadata as far as possible
        switch (compressionValue) {
            case TIFFBaseline.COMPRESSION_NONE:
                compressionTypeName.setAttribute("value", "None");
                break;
            case TIFFBaseline.COMPRESSION_CCITT_MODIFIED_HUFFMAN_RLE:
                compressionTypeName.setAttribute("value", "CCITT RLE");
                break;
            case TIFFExtension.COMPRESSION_CCITT_T4:
                compressionTypeName.setAttribute("value", "CCITT T4");
                break;
            case TIFFExtension.COMPRESSION_CCITT_T6:
                compressionTypeName.setAttribute("value", "CCITT T6");
                break;
            case TIFFExtension.COMPRESSION_LZW:
                compressionTypeName.setAttribute("value", "LZW");
                break;
            case TIFFExtension.COMPRESSION_OLD_JPEG:
                compressionTypeName.setAttribute("value", "Old JPEG");
                break;
            case TIFFExtension.COMPRESSION_JPEG:
                compressionTypeName.setAttribute("value", "JPEG");
                break;
            case TIFFExtension.COMPRESSION_ZLIB:
                compressionTypeName.setAttribute("value", "ZLib");
                break;
            case TIFFExtension.COMPRESSION_DEFLATE:
                compressionTypeName.setAttribute("value", "Deflate");
                break;
            case TIFFBaseline.COMPRESSION_PACKBITS:
                compressionTypeName.setAttribute("value", "PackBits");
                break;
            case TIFFCustom.COMPRESSION_CCITTRLEW:
                compressionTypeName.setAttribute("value", "CCITT RLEW");
                break;
            case TIFFCustom.COMPRESSION_DCS:
                compressionTypeName.setAttribute("value", "DCS");
                break;
            case TIFFCustom.COMPRESSION_IT8BL:
                compressionTypeName.setAttribute("value", "IT8BL");
                break;
            case TIFFCustom.COMPRESSION_IT8CTPAD:
                compressionTypeName.setAttribute("value", "IT8CTPAD");
                break;
            case TIFFCustom.COMPRESSION_IT8LW:
                compressionTypeName.setAttribute("value", "IT8LW");
                break;
            case TIFFCustom.COMPRESSION_IT8MP:
                compressionTypeName.setAttribute("value", "IT8MP");
                break;
            case TIFFCustom.COMPRESSION_JBIG:
                compressionTypeName.setAttribute("value", "JBIG");
                break;
            case TIFFCustom.COMPRESSION_JPEG2000:
                compressionTypeName.setAttribute("value", "JPEG 2000");
                break;
            case TIFFCustom.COMPRESSION_NEXT:
                compressionTypeName.setAttribute("value", "NEXT");
                break;
            case TIFFCustom.COMPRESSION_PIXARFILM:
                compressionTypeName.setAttribute("value", "Pixar Film");
                break;
            case TIFFCustom.COMPRESSION_PIXARLOG:
                compressionTypeName.setAttribute("value", "Pixar Log");
                break;
            case TIFFCustom.COMPRESSION_SGILOG:
                compressionTypeName.setAttribute("value", "SGI Log");
                break;
            case TIFFCustom.COMPRESSION_SGILOG24:
                compressionTypeName.setAttribute("value", "SGI Log24");
                break;
            case TIFFCustom.COMPRESSION_THUNDERSCAN:
                compressionTypeName.setAttribute("value", "ThunderScan");
                break;
            default:
                compressionTypeName.setAttribute("value", "Unknown " + compressionValue);
                break;
        }

        if (compressionValue != TIFFBaseline.COMPRESSION_NONE) {
            // Lossless (defaults to TRUE)
            IIOMetadataNode lossless = new IIOMetadataNode("Lossless");
            compression.appendChild(lossless);

            switch (compressionValue) {
                case TIFFExtension.COMPRESSION_OLD_JPEG:
                case TIFFExtension.COMPRESSION_JPEG:
                case TIFFCustom.COMPRESSION_JBIG:
                case TIFFCustom.COMPRESSION_JPEG2000:
                    lossless.setAttribute("value", "FALSE");
                    break;
                default:
                    break;
            }
        }

        return compression;
    }

    @Override
    protected IIOMetadataNode getStandardDataNode() {
        IIOMetadataNode node = new IIOMetadataNode("Data");

        IIOMetadataNode planarConfiguration = new IIOMetadataNode("PlanarConfiguration");
        Entry planarConfigurationTag = ifd.getEntryById(TIFF.TAG_PLANAR_CONFIGURATION);
        int planarConfigurationValue = planarConfigurationTag == null
                                       ? TIFFBaseline.PLANARCONFIG_CHUNKY
                                       : getValueAsInt(planarConfigurationTag);

        switch (planarConfigurationValue) {
            case TIFFBaseline.PLANARCONFIG_CHUNKY:
                planarConfiguration.setAttribute("value", "PixelInterleaved");
                break;
            case TIFFExtension.PLANARCONFIG_PLANAR:
                planarConfiguration.setAttribute("value", "PlaneInterleaved");
                break;
            default:
                planarConfiguration.setAttribute("value", "Unknown " + planarConfigurationValue);
        }
        node.appendChild(planarConfiguration);

        Entry photometricInterpretationTag = ifd.getEntryById(TIFF.TAG_PHOTOMETRIC_INTERPRETATION);
        int photometricInterpretationValue = photometricInterpretationTag == null
                                             ? TIFFBaseline.PHOTOMETRIC_WHITE_IS_ZERO
                                             : getValueAsInt(photometricInterpretationTag);

        Entry samleFormatTag = ifd.getEntryById(TIFF.TAG_SAMPLE_FORMAT);
        // TODO: Fix for sampleformat 1 1 1 (as int[]) ??!?!?
        int sampleFormatValue = samleFormatTag == null
                                ? TIFFBaseline.SAMPLEFORMAT_UINT
                                : getValueAsInt(samleFormatTag);
        IIOMetadataNode sampleFormat = new IIOMetadataNode("SampleFormat");
        node.appendChild(sampleFormat);

        switch (sampleFormatValue) {
            case TIFFBaseline.SAMPLEFORMAT_UINT:
                if (photometricInterpretationValue == TIFFBaseline.PHOTOMETRIC_PALETTE) {
                    sampleFormat.setAttribute("value", "Index");
                }
                else {
                    sampleFormat.setAttribute("value", "UnsignedIntegral");
                }
                break;
            case TIFFExtension.SAMPLEFORMAT_INT:
                sampleFormat.setAttribute("value", "SignedIntegral");
                break;
            case TIFFExtension.SAMPLEFORMAT_FP:
                sampleFormat.setAttribute("value", "Real");
                break;
            default:
                sampleFormat.setAttribute("value", "Unknown " + sampleFormatValue);
                break;
        }

        // TODO: See TIFFImageReader.getBitsPerSample + fix the metadata to have getAsXxxArray methods.
        // BitsPerSample (not required field for Class B/Bilevel, defaults to 1)
        Entry bitsPerSampleTag = ifd.getEntryById(TIFF.TAG_BITS_PER_SAMPLE);
        String bitsPerSampleValue = bitsPerSampleTag == null
                                    ? "1"
                                    : bitsPerSampleTag.getValueAsString().replaceAll("\\[?\\]?,?", "");

        IIOMetadataNode bitsPerSample = new IIOMetadataNode("BitsPerSample");
        node.appendChild(bitsPerSample);
        bitsPerSample.setAttribute("value", bitsPerSampleValue);

        int numChannelsValue = getSamplesPerPixelWithFallback();

        // SampleMSB
        Entry fillOrderTag = ifd.getEntryById(TIFF.TAG_FILL_ORDER);
        int fillOrder = fillOrderTag != null
                        ? getValueAsInt(fillOrderTag)
                        : TIFFBaseline.FILL_LEFT_TO_RIGHT;
        IIOMetadataNode sampleMSB = new IIOMetadataNode("SampleMSB");
        node.appendChild(sampleMSB);
        if (fillOrder == TIFFBaseline.FILL_LEFT_TO_RIGHT) {
            sampleMSB.setAttribute("value", createListValue(numChannelsValue, "0"));
        }
        else {
            if ("1".equals(bitsPerSampleValue)) {
                sampleMSB.setAttribute("value", createListValue(numChannelsValue, "7"));
            }
            else {
                // TODO: FixMe for bitsPerSample > 8
                sampleMSB.setAttribute("value", createListValue(numChannelsValue, "7"));
            }
        }

        return node;
    }

    private static int getValueAsInt(final Entry entry) {
        Object value = entry.getValue();

        if (value instanceof Number) {
            return ((Number) value).intValue();
        }
        else if (value instanceof short[]) {
            return ((short[]) value)[0];
        }
        else if (value instanceof int[]) {
            return ((int[]) value)[0];
        }

        throw new IllegalArgumentException("Unsupported type: " + entry);
    }

    // TODO: Candidate superclass method!
    private String createListValue(final int itemCount, final String... values) {
        StringBuilder buffer = new StringBuilder();

        for (int i = 0; i < itemCount; i++) {
            if (buffer.length() > 0) {
                buffer.append(' ');
            }

            buffer.append(values[i % values.length]);
        }

        return buffer.toString();
    }

    @Override
    protected IIOMetadataNode getStandardDimensionNode() {
        IIOMetadataNode dimension = new IIOMetadataNode("Dimension");

        // PixelAspectRatio
        Entry xResTag = ifd.getEntryById(TIFF.TAG_X_RESOLUTION);
        Entry yResTag = ifd.getEntryById(TIFF.TAG_Y_RESOLUTION);
        double xSizeValue = 1 / (xResTag == null ? 72.0 : ((Number) xResTag.getValue()).doubleValue());
        double ySizeValue = 1 / (xResTag == null ? 72.0 : ((Number) yResTag.getValue()).doubleValue());

        IIOMetadataNode pixelAspectRatio = new IIOMetadataNode("PixelAspectRatio");
        dimension.appendChild(pixelAspectRatio);
        pixelAspectRatio.setAttribute("value", String.valueOf(xSizeValue / ySizeValue));

        // ImageOrientation
        Entry orientationTag = ifd.getEntryById(TIFF.TAG_ORIENTATION);
        if (orientationTag != null) {
            int orientationValue = getValueAsInt(orientationTag);

            String value = null;
            switch (orientationValue) {
                case TIFFBaseline.ORIENTATION_TOPLEFT:
                    value = "Normal";
                    break;
                case TIFFExtension.ORIENTATION_TOPRIGHT:
                    value = "FlipH";
                    break;
                case TIFFExtension.ORIENTATION_BOTRIGHT:
                    value = "Rotate180";
                    break;
                case TIFFExtension.ORIENTATION_BOTLEFT:
                    value = "FlipV";
                    break;
                case TIFFExtension.ORIENTATION_LEFTTOP:
                    value = "FlipHRotate90";
                    break;
                case TIFFExtension.ORIENTATION_RIGHTTOP:
                    value = "Rotate270";
                    break;
                case TIFFExtension.ORIENTATION_RIGHTBOT:
                    value = "FlipVRotate90";
                    break;
                case TIFFExtension.ORIENTATION_LEFTBOT:
                    value = "Rotate90";
                    break;
            }

            if (value != null) {
                IIOMetadataNode imageOrientation = new IIOMetadataNode("ImageOrientation");
                dimension.appendChild(imageOrientation);
                imageOrientation.setAttribute("value", value);
            }

        }

        Entry resUnitTag = ifd.getEntryById(TIFF.TAG_RESOLUTION_UNIT);
        int resUnitValue = resUnitTag == null ? TIFFBaseline.RESOLUTION_UNIT_DPI : getValueAsInt(resUnitTag);
        if (resUnitValue == TIFFBaseline.RESOLUTION_UNIT_CENTIMETER || resUnitValue == TIFFBaseline.RESOLUTION_UNIT_DPI) {
            // 10 mm in 1 cm or 25.4 mm in 1 inch
            double scale = resUnitValue == TIFFBaseline.RESOLUTION_UNIT_CENTIMETER ? 10 : 25.4;

            // HorizontalPixelSize
            // VerticalPixelSize
            IIOMetadataNode horizontalPixelSize = new IIOMetadataNode("HorizontalPixelSize");
            dimension.appendChild(horizontalPixelSize);
            horizontalPixelSize.setAttribute("value", String.valueOf(xSizeValue * scale));

            IIOMetadataNode verticalPixelSize = new IIOMetadataNode("VerticalPixelSize");
            dimension.appendChild(verticalPixelSize);
            verticalPixelSize.setAttribute("value", String.valueOf(ySizeValue * scale));

            // HorizontalPosition
            // VerticalPosition
            Entry xPosTag = ifd.getEntryById(TIFF.TAG_X_POSITION);
            Entry yPosTag = ifd.getEntryById(TIFF.TAG_Y_POSITION);

            if (xPosTag != null && yPosTag != null) {
                double xPosValue = ((Number) xPosTag.getValue()).doubleValue();
                double yPosValue = ((Number) yPosTag.getValue()).doubleValue();

                IIOMetadataNode horizontalPosition = new IIOMetadataNode("HorizontalPosition");
                dimension.appendChild(horizontalPosition);
                horizontalPosition.setAttribute("value", String.valueOf(xPosValue * scale));

                IIOMetadataNode verticalPosition = new IIOMetadataNode("VerticalPosition");
                dimension.appendChild(verticalPosition);
                verticalPosition.setAttribute("value", String.valueOf(yPosValue * scale));
            }
        }

        return dimension;
    }

    @Override
    protected IIOMetadataNode getStandardTransparencyNode() {
        // Consult ExtraSamples
        Entry extraSamplesTag = ifd.getEntryById(TIFF.TAG_EXTRA_SAMPLES);

        if (extraSamplesTag != null) {
            int extraSamplesValue = (extraSamplesTag.getValue() instanceof Number)
                                    ? getValueAsInt(extraSamplesTag)
                                    : ((Number) Array.get(extraSamplesTag.getValue(), 0)).intValue();

            // Other values exists, these are not alpha
            if (extraSamplesValue == TIFFBaseline.EXTRASAMPLE_ASSOCIATED_ALPHA || extraSamplesValue == TIFFBaseline.EXTRASAMPLE_UNASSOCIATED_ALPHA) {
                IIOMetadataNode transparency = new IIOMetadataNode("Transparency");
                IIOMetadataNode alpha = new IIOMetadataNode("Alpha");
                transparency.appendChild(alpha);

                alpha.setAttribute("value", extraSamplesValue == TIFFBaseline.EXTRASAMPLE_ASSOCIATED_ALPHA
                                            ? "premultiplied"
                                            : "nonpremultiplied");

                return transparency;
            }
        }

        return null;

    }

    @Override
    protected IIOMetadataNode getStandardDocumentNode() {
        IIOMetadataNode document = new IIOMetadataNode("Document");

        // FormatVersion, hardcoded to 6.0 (the current TIFF specification version),
        // as there's no format information in the TIFF structure.
        IIOMetadataNode formatVersion = new IIOMetadataNode("FormatVersion");
        document.appendChild(formatVersion);
        formatVersion.setAttribute("value", "6.0");

        // SubImageInterpretation from SubImageInterpretation (if applicable)
        Entry subFileTypeTag = ifd.getEntryById(TIFF.TAG_SUBFILE_TYPE);
        if (subFileTypeTag != null) {
            // NOTE: The JAI metadata is somewhat broken here, as these are bit flags, not values...
            String value = null;
            int subFileTypeValue = getValueAsInt(subFileTypeTag);
            if ((subFileTypeValue & TIFFBaseline.FILETYPE_MASK) != 0) {
                value = "TransparencyMask";
            }
            else if ((subFileTypeValue & TIFFBaseline.FILETYPE_REDUCEDIMAGE) != 0) {
                value = "ReducedResolution";
            }
            else if ((subFileTypeValue & TIFFBaseline.FILETYPE_PAGE) != 0) {
                value = "SinglePage";
            }

            // If no flag is set, we don't know...
            if (value != null) {
                IIOMetadataNode subImageInterpretation = new IIOMetadataNode("SubImageInterpretation");
                document.appendChild(subImageInterpretation);
                subImageInterpretation.setAttribute("value", value);
            }
        }

        // ImageCreationTime from DateTime
        Entry dateTimeTag = ifd.getEntryById(TIFF.TAG_DATE_TIME);
        if (dateTimeTag != null) {
            DateFormat format = new SimpleDateFormat("yyyy:MM:dd hh:mm:ss");

            try {
                IIOMetadataNode imageCreationTime = new IIOMetadataNode("ImageCreationTime");
                document.appendChild(imageCreationTime);

                Calendar date = Calendar.getInstance();
                date.setTime(format.parse(dateTimeTag.getValueAsString()));

                imageCreationTime.setAttribute("year", String.valueOf(date.get(Calendar.YEAR)));
                imageCreationTime.setAttribute("month", String.valueOf(date.get(Calendar.MONTH) + 1));
                imageCreationTime.setAttribute("day", String.valueOf(date.get(Calendar.DAY_OF_MONTH)));
                imageCreationTime.setAttribute("hour", String.valueOf(date.get(Calendar.HOUR_OF_DAY)));
                imageCreationTime.setAttribute("minute", String.valueOf(date.get(Calendar.MINUTE)));
                imageCreationTime.setAttribute("second", String.valueOf(date.get(Calendar.SECOND)));
            }
            catch (ParseException ignore) {
                // Bad format...
            }
        }

        return document;
    }

    @Override
    protected IIOMetadataNode getStandardTextNode() {
        IIOMetadataNode text = new IIOMetadataNode("Text");

        // DocumentName, ImageDescription, Make, Model, PageName, Software, Artist, HostComputer, InkNames, Copyright:
        // /Text/TextEntry@keyword = field name, /Text/TextEntry@value = field value.
        addTextEntryIfPresent(text, TIFF.TAG_DOCUMENT_NAME);
        addTextEntryIfPresent(text, TIFF.TAG_IMAGE_DESCRIPTION);
        addTextEntryIfPresent(text, TIFF.TAG_MAKE);
        addTextEntryIfPresent(text, TIFF.TAG_MODEL);
        addTextEntryIfPresent(text, TIFF.TAG_PAGE_NAME);
        addTextEntryIfPresent(text, TIFF.TAG_SOFTWARE);
        addTextEntryIfPresent(text, TIFF.TAG_ARTIST);
        addTextEntryIfPresent(text, TIFF.TAG_HOST_COMPUTER);
        addTextEntryIfPresent(text, TIFF.TAG_INK_NAMES);
        addTextEntryIfPresent(text, TIFF.TAG_COPYRIGHT);

        return text.hasChildNodes() ? text : null;
    }

    private void addTextEntryIfPresent(final IIOMetadataNode text, final int tag) {
        Entry entry = ifd.getEntryById(tag);
        if (entry != null) {
            IIOMetadataNode node = new IIOMetadataNode("TextEntry");
            text.appendChild(node);
            node.setAttribute("keyword", entry.getFieldName());
            node.setAttribute("value", entry.getValueAsString());
        }
    }

    @Override
    protected IIOMetadataNode getStandardTileNode() {
        // TODO! Woot?! This node is not documented in the DTD (although the page mentions a "tile" node)..?
        // See http://docs.oracle.com/javase/7/docs/api/javax/imageio/metadata/doc-files/standard_metadata.html
        // See http://stackoverflow.com/questions/30910719/javax-imageio-1-0-standard-plug-in-neutral-metadata-format-tiling-information
        return super.getStandardTileNode();
    }

    /// Mutation

    @Override
    public boolean isReadOnly() {
        return false;
    }

    public void setFromTree(final String formatName, final Node root) throws IIOInvalidTreeException {
        // Standard validation
        super.setFromTree(formatName, root);

        // Set by "merging" with empty map
        LinkedHashMap entries = new LinkedHashMap<>();
        mergeEntries(formatName, root, entries);

        // TODO: Consistency validation?

        // Finally create a new IFD from merged values
        ifd = new IFD(entries.values());
    }

    @Override
    public void mergeTree(final String formatName, final Node root) throws IIOInvalidTreeException {
        // Standard validation
        super.mergeTree(formatName, root);

        // Clone entries (shallow clone, as entries themselves are immutable)
        LinkedHashMap entries = new LinkedHashMap<>(ifd.size() + 10);

        for (Entry entry : ifd) {
            entries.put((Integer) entry.getIdentifier(), entry);
        }

        mergeEntries(formatName, root, entries);

        // TODO: Consistency validation?

        // Finally create a new IFD from merged values
        ifd = new IFD(entries.values());
    }

    private void mergeEntries(final String formatName, final Node root, final Map entries) throws IIOInvalidTreeException {
        // Merge from both native and standard trees
        if (getNativeMetadataFormatName().equals(formatName)) {
            mergeNativeTree(root, entries);
        }
        else if (IIOMetadataFormatImpl.standardMetadataFormatName.equals(formatName)) {
            mergeStandardTree(root, entries);
        }
        else {
            // Should already be checked for
            throw new AssertionError();
        }
    }

    private void mergeStandardTree(final Node root, final Map entries) throws IIOInvalidTreeException {
        NodeList nodes = root.getChildNodes();

        // Merge selected values from standard tree
        for (int i = 0; i < nodes.getLength(); i++) {
            Node node = nodes.item(i);

            if ("Dimension".equals(node.getNodeName())) {
                mergeFromStandardDimensionNode(node, entries);
            }
            else if ("Document".equals(node.getNodeName())) {
                mergeFromStandardDocumentNode(node, entries);
            }
            else if ("Text".equals(node.getNodeName())) {
                mergeFromStandardTextNode(node, entries);
            }
        }
    }

    private void mergeFromStandardDimensionNode(final Node dimensionNode, final Map entries) {
        // Dimension: xRes/yRes
        //      - If set, set res unit to pixels per cm as this better reflects values?
        //      - Or, convert to DPI, if we already had values in DPI??
        //      Also, if we have only aspect, set these values, and use unknown as unit?
        NodeList children = dimensionNode.getChildNodes();

        Float aspect = null;
        Float xRes = null;
        Float yRes = null;
        Integer orientation = null;

        for (int i = 0; i < children.getLength(); i++) {
            Node child = children.item(i);
            String nodeName = child.getNodeName();

            if ("PixelAspectRatio".equals(nodeName)) {
                aspect = Float.parseFloat(getAttribute(child, "value"));
            }
            else if ("HorizontalPixelSize".equals(nodeName)) {
                xRes = Float.parseFloat(getAttribute(child, "value"));
            }
            else if ("VerticalPixelSize".equals(nodeName)) {
                yRes = Float.parseFloat(getAttribute(child, "value"));
            }
            else if ("ImageOrientation".equals(nodeName)) {
                orientation = toTIFFOrientation(getAttribute(child, "value"));
            }
        }

        // If we have one size compute the other
        if (xRes == null && yRes != null) {
            xRes = yRes * (aspect != null ? aspect : 1f);
        }
        else if (yRes == null && xRes != null) {
            yRes = xRes / (aspect != null ? aspect : 1f);
        }

        // If we have resolution
        if (xRes != null && yRes != null) {
            // If old unit was DPI, convert values and keep DPI, otherwise use PPCM
            Entry resUnitEntry = entries.get(TIFF.TAG_RESOLUTION_UNIT);
            int resUnitValue = resUnitEntry != null && resUnitEntry.getValue() != null
                                       && ((Number) resUnitEntry.getValue()).intValue() == TIFFBaseline.RESOLUTION_UNIT_DPI
                               ? TIFFBaseline.RESOLUTION_UNIT_DPI
                               : TIFFBaseline.RESOLUTION_UNIT_CENTIMETER;

            // Units from standard format are pixels per mm, convert to cm or inches
            float scale = resUnitValue == TIFFBaseline.RESOLUTION_UNIT_CENTIMETER ? 10 : 25.4f;

            int x = Math.round(xRes * scale * RATIONAL_SCALE_FACTOR);
            int y = Math.round(yRes * scale * RATIONAL_SCALE_FACTOR);

            entries.put(TIFF.TAG_X_RESOLUTION, new TIFFEntry(TIFF.TAG_X_RESOLUTION, new Rational(x, RATIONAL_SCALE_FACTOR)));
            entries.put(TIFF.TAG_Y_RESOLUTION, new TIFFEntry(TIFF.TAG_Y_RESOLUTION, new Rational(y, RATIONAL_SCALE_FACTOR)));
            entries.put(TIFF.TAG_RESOLUTION_UNIT,
                    new TIFFEntry(TIFF.TAG_RESOLUTION_UNIT, TIFF.TYPE_SHORT, resUnitValue));
        }
        else if (aspect != null) {
            if (aspect >= 1) {
                int v = Math.round(aspect * RATIONAL_SCALE_FACTOR);
                entries.put(TIFF.TAG_X_RESOLUTION, new TIFFEntry(TIFF.TAG_X_RESOLUTION, new Rational(v, RATIONAL_SCALE_FACTOR)));
                entries.put(TIFF.TAG_Y_RESOLUTION, new TIFFEntry(TIFF.TAG_Y_RESOLUTION, new Rational(1)));
            }
            else {
                int v = Math.round(RATIONAL_SCALE_FACTOR / aspect);
                entries.put(TIFF.TAG_X_RESOLUTION, new TIFFEntry(TIFF.TAG_X_RESOLUTION, new Rational(1)));
                entries.put(TIFF.TAG_Y_RESOLUTION, new TIFFEntry(TIFF.TAG_Y_RESOLUTION, new Rational(v, RATIONAL_SCALE_FACTOR)));
            }

            entries.put(TIFF.TAG_RESOLUTION_UNIT,
                    new TIFFEntry(TIFF.TAG_RESOLUTION_UNIT, TIFF.TYPE_SHORT, TIFFBaseline.RESOLUTION_UNIT_NONE));
        }
        // Else give up...

        if (orientation != null) {
            entries.put(TIFF.TAG_ORIENTATION,
                    new TIFFEntry(TIFF.TAG_ORIENTATION, TIFF.TYPE_SHORT, orientation.shortValue()));
        }
    }

    private void mergeFromStandardDocumentNode(final Node documentNode, final Map entries) {
        // Document: SubfileType, CreationDate
        NodeList children = documentNode.getChildNodes();

        for (int i = 0; i < children.getLength(); i++) {
            Node child = children.item(i);
            String nodeName = child.getNodeName();

            if ("SubimageInterpretation".equals(nodeName)) {
                // TODO: SubFileType
            }
            else if ("ImageCreationTime".equals(nodeName)) {
                // TODO: CreationDate
            }
        }
    }

    private void mergeFromStandardTextNode(final Node textNode, final Map entries) throws IIOInvalidTreeException {
        NodeList textEntries = textNode.getChildNodes();

        for (int i = 0; i < textEntries.getLength(); i++) {
            Node textEntry = textEntries.item(i);

            if (!"TextEntry".equals(textEntry.getNodeName())) {
                throw new IIOInvalidTreeException("Text node should only contain TextEntry nodes", textNode);
            }

            String keyword = getAttribute(textEntry, "keyword");
            String value = getAttribute(textEntry, "value");

            // DocumentName, ImageDescription, Make, Model, PageName,
            // Software, Artist, HostComputer, InkNames, Copyright
            if (value != null && !value.isEmpty() && keyword != null) {
                // We do all comparisons in lower case, for compatibility
                keyword = keyword.toLowerCase();

                TIFFEntry entry;

                if ("documentname".equals(keyword)) {
                    entry = new TIFFEntry(TIFF.TAG_DOCUMENT_NAME, TIFF.TYPE_ASCII, value);
                }
                else if ("imagedescription".equals(keyword)) {
                    entry = new TIFFEntry(TIFF.TAG_IMAGE_DESCRIPTION, TIFF.TYPE_ASCII, value);
                }
                else if ("make".equals(keyword)) {
                    entry = new TIFFEntry(TIFF.TAG_MAKE, TIFF.TYPE_ASCII, value);
                }
                else if ("model".equals(keyword)) {
                    entry = new TIFFEntry(TIFF.TAG_MODEL, TIFF.TYPE_ASCII, value);
                }
                else if ("pagename".equals(keyword)) {
                    entry = new TIFFEntry(TIFF.TAG_PAGE_NAME, TIFF.TYPE_ASCII, value);
                }
                else if ("software".equals(keyword)) {
                    entry = new TIFFEntry(TIFF.TAG_SOFTWARE, TIFF.TYPE_ASCII, value);
                }
                else if ("artist".equals(keyword)) {
                    entry = new TIFFEntry(TIFF.TAG_ARTIST, TIFF.TYPE_ASCII, value);
                }
                else if ("hostcomputer".equals(keyword)) {
                    entry = new TIFFEntry(TIFF.TAG_HOST_COMPUTER, TIFF.TYPE_ASCII, value);
                }
                else if ("inknames".equals(keyword)) {
                    entry = new TIFFEntry(TIFF.TAG_INK_NAMES, TIFF.TYPE_ASCII, value);
                }
                else if ("copyright".equals(keyword)) {
                    entry = new TIFFEntry(TIFF.TAG_COPYRIGHT, TIFF.TYPE_ASCII, value);
                }
                else {
                    continue;
                }

                entries.put((Integer) entry.getIdentifier(), entry);
            }
        }
    }

    private void mergeNativeTree(final Node root, final Map entries) throws IIOInvalidTreeException {
        Directory ifd = toIFD(root.getFirstChild());

        // Merge (overwrite) entries with entries from IFD
        for (Entry entry : ifd) {
            entries.put((Integer) entry.getIdentifier(), entry);
        }
    }

    private Directory toIFD(final Node ifdNode) throws IIOInvalidTreeException {
        if (ifdNode == null || !ifdNode.getNodeName().equals("TIFFIFD")) {
            throw new IIOInvalidTreeException("Expected \"TIFFIFD\" node", ifdNode);
        }

        NodeList nodes = ifdNode.getChildNodes();

        final int size = nodes.getLength();
        List entries = new ArrayList<>(size);
        for (int i = 0; i < size; i++) {
            entries.add(toEntry(nodes.item(i)));
        }

        return new IFD(entries);
    }

    private Entry toEntry(final Node node) throws IIOInvalidTreeException {
        String name = node.getNodeName();

        if (name.equals("TIFFIFD")) {
            int tag = Integer.parseInt(getAttribute(node, "parentTagNumber"));
            Directory subIFD = toIFD(node);

            return new TIFFEntry(tag, TIFF.TYPE_IFD, subIFD);
        }
        else if (name.equals("TIFFField")) {
            int tag = Integer.parseInt(getAttribute(node, "number"));
            short type = getTIFFType(node);
            Object value = getValue(node, type);

            return value != null ? new TIFFEntry(tag, type, value) : null;
        }
        else {
            throw new IIOInvalidTreeException("Expected \"TIFFIFD\" or \"TIFFField\" node: " + name, node);
        }
    }

    private Integer toTIFFOrientation(String imageOrientation) {
        if (imageOrientation == null) {
            // malformed, empty or not readable value
            return null;
        }
        switch (imageOrientation.toLowerCase()) {
            case "normal":
                return TIFFBaseline.ORIENTATION_TOPLEFT;
            case "fliph":
                return TIFFExtension.ORIENTATION_TOPRIGHT;
            case "rotate180":
                return TIFFExtension.ORIENTATION_BOTRIGHT;
            case "flipv":
                return TIFFExtension.ORIENTATION_BOTLEFT;
            case "fliphrotate90":
                return TIFFExtension.ORIENTATION_LEFTTOP;
            case "rotate270":
                return TIFFExtension.ORIENTATION_RIGHTTOP;
            case "flipvrotate90":
                return TIFFExtension.ORIENTATION_RIGHTBOT;
            case "rotate90":
                return TIFFExtension.ORIENTATION_LEFTBOT;
            default:
                // malformed, invalid value
                return null;
        }
    }

    private short getTIFFType(final Node node) throws IIOInvalidTreeException {
        Node containerNode = node.getFirstChild();
        if (containerNode == null) {
            throw new IIOInvalidTreeException("Missing value wrapper node", node);
        }

        String nodeName = containerNode.getNodeName();
        if (!nodeName.startsWith("TIFF")) {
            throw new IIOInvalidTreeException("Unexpected value wrapper node, expected type", containerNode);
        }

        String typeName = nodeName.substring(4);

        if (typeName.equals("Undefined")) {
            return TIFF.TYPE_UNDEFINED;
        }

        typeName = typeName.substring(0, typeName.length() - 1).toUpperCase();

        for (int i = 1; i < TIFF.TYPE_NAMES.length; i++) {
            if (typeName.equals(TIFF.TYPE_NAMES[i])) {
                return (short) i;
            }
        }

        throw new IIOInvalidTreeException("Unknown TIFF type: " + typeName, containerNode);
    }

    private Object getValue(final Node node, final short type) throws IIOInvalidTreeException {
        Node child = node.getFirstChild();

        if (child != null) {
            String typeName = child.getNodeName();

            if (type == TIFF.TYPE_UNDEFINED) {
                String values = getAttribute(child, "value");
                String[] vals = values.split(",\\s?");

                byte[] bytes = new byte[vals.length];
                for (int i = 0; i < vals.length; i++) {
                    bytes[i] = Byte.parseByte(vals[i]);
                }

                return bytes;
            }
            else {
                NodeList valueNodes = child.getChildNodes();

                // Create array for each type
                int count = valueNodes.getLength();
                Object value = createArrayForType(type, count);

                // Parse each value
                for (int i = 0; i < count; i++) {
                    Node valueNode = valueNodes.item(i);

                    if (!typeName.startsWith(valueNode.getNodeName())) {
                        throw new IIOInvalidTreeException("Value node does not match container node", child);
                    }

                    String stringValue = getAttribute(valueNode, "value");

                    // NOTE: The reason for parsing "wider" type, is to allow for unsigned values
                    switch (type) {
                        case TIFF.TYPE_BYTE:
                        case TIFF.TYPE_SBYTE:
                            ((byte[]) value)[i] = (byte) Short.parseShort(stringValue);
                            break;
                        case TIFF.TYPE_ASCII:
                            ((String[]) value)[i] = stringValue;
                            break;
                        case TIFF.TYPE_SHORT:
                        case TIFF.TYPE_SSHORT:
                            ((short[]) value)[i] = (short) Integer.parseInt(stringValue);
                            break;
                        case TIFF.TYPE_LONG:
                        case TIFF.TYPE_SLONG:
                            ((int[]) value)[i] = (int) Long.parseLong(stringValue);
                            break;
                        case TIFF.TYPE_RATIONAL:
                        case TIFF.TYPE_SRATIONAL:
                            String[] numDenom = stringValue.split("/");
                            ((Rational[]) value)[i] = numDenom.length > 1
                                                      ? new Rational(Long.parseLong(numDenom[0]), Long.parseLong(numDenom[1]))
                                                      : new Rational(Long.parseLong(numDenom[0]));
                            break;
                        case TIFF.TYPE_FLOAT:
                            ((float[]) value)[i] = Float.parseFloat(stringValue);
                            break;
                        case TIFF.TYPE_DOUBLE:
                            ((double[]) value)[i] = Double.parseDouble(stringValue);
                            break;
                        default:
                            throw new AssertionError("Unsupported TIFF type: " + type);
                    }
                }

                // Normalize value
                if (count == 0) {
                    return null;
                }
                if (count == 1) {
                    return Array.get(value, 0);
                }

                return value;
            }
        }

        throw new IIOInvalidTreeException("Empty TIFField node", node);
    }

    private Object createArrayForType(final short type, final int length) {
        switch (type) {
            case TIFF.TYPE_ASCII:
                return new String[length];
            case TIFF.TYPE_BYTE:
            case TIFF.TYPE_SBYTE:
            case TIFF.TYPE_UNDEFINED: // Not used here, but for completeness
                return new byte[length];
            case TIFF.TYPE_SHORT:
            case TIFF.TYPE_SSHORT:
                return new short[length];
            case TIFF.TYPE_LONG:
            case TIFF.TYPE_SLONG:
                return new int[length];
            case TIFF.TYPE_IFD:
                return new long[length];
            case TIFF.TYPE_RATIONAL:
            case TIFF.TYPE_SRATIONAL:
                return new Rational[length];
            case TIFF.TYPE_FLOAT:
                return new float[length];
            case TIFF.TYPE_DOUBLE:
                return new double[length];
            default:
                throw new AssertionError("Unsupported TIFF type: " + type);
        }
    }

    private String getAttribute(final Node node, final String attribute) {
        return node instanceof Element ? ((Element) node).getAttribute(attribute) : null;
    }

    @Override
    public void reset() {
        super.reset();

        ifd = original;
    }

    Directory getIFD() {
        return ifd;
    }

    /**
     * Returns an Entry which contains the data of the requested TIFF field.
     *
     * @param tagNumber Tag number of the TIFF field.
     *
     * @return the TIFF field, or null.
     */
    public Entry getTIFFField(final int tagNumber) {
        return ifd.getEntryById(tagNumber);
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy