com.drew.metadata.heif.HeifPictureHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of metadata-extractor Show documentation
Java library for extracting EXIF, IPTC, XMP, ICC and other metadata from image and video files.
The newest version!
/*
 * Copyright 2002-2019 Drew Noakes and contributors
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 *
 * More information about this project is available at:
 *
 *    https://drewnoakes.com/code/exif/
 *    https://github.com/drewnoakes/metadata-extractor
 */
package com.drew.metadata.heif;

import com.drew.imaging.heif.HeifHandler;
import com.drew.lang.RandomAccessStreamReader;
import com.drew.lang.SequentialByteArrayReader;
import com.drew.lang.SequentialReader;
import com.drew.lang.annotations.NotNull;
import com.drew.metadata.Metadata;
import com.drew.metadata.exif.ExifReader;
import com.drew.metadata.heif.boxes.*;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

/**
 * @author Payton Garland
 */
public class HeifPictureHandler extends HeifHandler
{
    private static final Set boxesCanProcess = new HashSet(Arrays.asList(
        HeifBoxTypes.BOX_ITEM_PROTECTION,
        HeifBoxTypes.BOX_PRIMARY_ITEM,
        HeifBoxTypes.BOX_ITEM_INFO,
        HeifBoxTypes.BOX_ITEM_LOCATION,
        HeifBoxTypes.BOX_IMAGE_SPATIAL_EXTENTS,
        HeifBoxTypes.BOX_AUXILIARY_TYPE_PROPERTY,
        HeifBoxTypes.BOX_IMAGE_ROTATION,
        HeifBoxTypes.BOX_COLOUR_INFO,
        HeifBoxTypes.BOX_PIXEL_INFORMATION
    ));

    private static final Set itemsCanProcess = new HashSet(Collections.singletonList(
        HeifItemTypes.ITEM_EXIF
    ));

    private static final Set containersCanProcess = new HashSet(Arrays.asList(
        HeifContainerTypes.BOX_IMAGE_PROPERTY,
        HeifContainerTypes.BOX_ITEM_PROPERTY,
        HeifContainerTypes.BOX_MEDIA_DATA
    ));

    ItemProtectionBox itemProtectionBox;
    PrimaryItemBox primaryItemBox;
    ItemInfoBox itemInfoBox;
    ItemLocationBox itemLocationBox;

    public HeifPictureHandler(Metadata metadata)
    {
        super(metadata);
    }

    @Override
    protected boolean shouldAcceptBox(@NotNull Box box)
    {
        return boxesCanProcess.contains(box.type);
    }

    @Override
    protected boolean shouldAcceptContainer(@NotNull Box box)
    {
        return containersCanProcess.contains(box.type);
    }

    @Override
    protected HeifHandler processBox(@NotNull Box box, @NotNull byte[] payload) throws IOException
    {
        SequentialReader reader = new SequentialByteArrayReader(payload);
        if (box.type.equals(HeifBoxTypes.BOX_ITEM_PROTECTION)) {
            itemProtectionBox = new ItemProtectionBox(reader, box);
        } else if (box.type.equals(HeifBoxTypes.BOX_PRIMARY_ITEM)) {
            primaryItemBox = new PrimaryItemBox(reader, box);
        } else if (box.type.equals(HeifBoxTypes.BOX_ITEM_INFO)) {
            itemInfoBox = new ItemInfoBox(reader, box);
            itemInfoBox.addMetadata(directory);
        } else if (box.type.equals(HeifBoxTypes.BOX_ITEM_LOCATION)) {
            itemLocationBox = new ItemLocationBox(reader, box);
        } else if (box.type.equals(HeifBoxTypes.BOX_IMAGE_SPATIAL_EXTENTS)) {
            ImageSpatialExtentsProperty imageSpatialExtentsProperty = new ImageSpatialExtentsProperty(reader, box);
            imageSpatialExtentsProperty.addMetadata(directory);
        } else if (box.type.equals(HeifBoxTypes.BOX_AUXILIARY_TYPE_PROPERTY)) {
            AuxiliaryTypeProperty auxiliaryTypeProperty = new AuxiliaryTypeProperty(reader, box);
        } else if (box.type.equals(HeifBoxTypes.BOX_IMAGE_ROTATION)) {
            ImageRotationBox imageRotationBox = new ImageRotationBox(reader, box);
            imageRotationBox.addMetadata(directory);
        } else if (box.type.equals(HeifBoxTypes.BOX_COLOUR_INFO)) {
            ColourInformationBox colourInformationBox = new ColourInformationBox(reader, box, metadata);
            colourInformationBox.addMetadata(directory);
        } else if (box.type.equals(HeifBoxTypes.BOX_PIXEL_INFORMATION)) {
            PixelInformationBox pixelInformationBox = new PixelInformationBox(reader, box);
            pixelInformationBox.addMetadata(directory);
        }
        return this;
    }

    @Override
    protected void processContainer(@NotNull Box box, @NotNull SequentialReader reader) throws IOException
    {
        if (box.type.equals(HeifContainerTypes.BOX_MEDIA_DATA) && itemInfoBox != null && itemLocationBox != null) {
            // We've reached the media data box, this contains all the items referred to by the info/location boxes

            // Extents should already be sorted, this way we know we can traverse the one direction stream correctly
            for (ItemLocationBox.Extent extent : itemLocationBox.getExtents()) {
                ItemInfoBox.ItemInfoEntry infoEntry = itemInfoBox.getEntry(extent.getItemId());
                long bytesToSkip = extent.getOffset() - reader.getPosition();
                if (bytesToSkip > 0) {
                    reader.skip(bytesToSkip);
                }
                if (shouldHandleItem(infoEntry)) {
                    handleItem(infoEntry, new SequentialByteArrayReader(reader.getBytes((int) extent.getLength())));
                }
            }
        }
    }

    private boolean shouldHandleItem(ItemInfoBox.ItemInfoEntry infoEntry) {
        return itemsCanProcess.contains(infoEntry.getItemType());
    }

    private void handleItem(@NotNull ItemInfoBox.ItemInfoEntry entry,
                            @NotNull SequentialByteArrayReader payloadReader) throws IOException {
        if (entry.getItemType().equals(HeifItemTypes.ITEM_EXIF)) {
            // ISO/IEC 23008-12:2017 Annex A: First 4 bytes will ALWAYS be an offset to the Tiff header in the payload
            long tiffHeaderOffset = payloadReader.getUInt32();
            if (tiffHeaderOffset > payloadReader.available()) {
                // This Exif item is not laid out according to spec
                return;
            }
            payloadReader.skip(tiffHeaderOffset);
            ByteArrayInputStream tiffStream = new ByteArrayInputStream(payloadReader.getBytes(payloadReader.available()));
            new ExifReader().extract(new RandomAccessStreamReader(tiffStream), metadata);
        }
    }

    @Override
    protected HeifDirectory getDirectory()
    {
        return new HeifDirectory();
    }
}