com.sksamuel.scrimage.metadata.ImageMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scrimage-core Show documentation
JVM Image Library
There is a newer version: 4.2.0
package com.sksamuel.scrimage.metadata;

import com.drew.imaging.ImageMetadataReader;
import com.drew.imaging.ImageProcessingException;
import com.drew.metadata.Metadata;
import com.sksamuel.scrimage.ImmutableImage;
import com.sksamuel.scrimage.nio.ImageSource;
import com.sksamuel.scrimage.nio.InputStreamImageSource;
import com.sksamuel.scrimage.nio.PngWriter;

import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.Optional;
import java.util.function.Predicate;
import java.util.stream.StreamSupport;

public class ImageMetadata {

   public static ImageMetadata empty = new ImageMetadata(new Directory[0]);

   public static ImageMetadata load(ImageSource source) throws IOException {
      try {
         return fromMetadata(ImageMetadataReader.readMetadata(new ByteArrayInputStream(source.read())));
      } catch (ImageProcessingException e) {
         return ImageMetadata.empty;
      }
   }

   public static ImageMetadata fromImage(ImmutableImage image) throws IOException {
      try (ByteArrayInputStream stream = new ByteArrayInputStream(image.bytes(PngWriter.NoCompression))) {
         Metadata metadata = ImageMetadataReader.readMetadata(stream);
         return fromMetadata(metadata);
      } catch (ImageProcessingException e) {
         throw new IOException(e);
      }
   }

   public static ImageMetadata fromPath(Path path) throws IOException {
      return fromFile(path.toFile());
   }

   public static ImageMetadata fromFile(File file) throws IOException {
      try (InputStream in = Files.newInputStream(file.toPath())) {
         return fromStream(in);
      }
   }

   public static ImageMetadata fromResource(String resource) throws IOException {
      try (InputStream in = ImageMetadata.class.getResourceAsStream(resource)) {
         return fromStream(in);
      }
   }

   public static ImageMetadata fromStream(InputStream in) throws IOException {
      return load(new InputStreamImageSource(in));
   }

   public static ImageMetadata fromBytes(byte[] bytes) throws IOException {
      return fromStream(new ByteArrayInputStream(bytes));
   }

   public static ImageMetadata fromMetadata(Metadata metadata) {
      Directory[] dirs = StreamSupport.stream(metadata.getDirectories().spliterator(), false).map(dir -> {
         Tag[] tags = dir.getTags().stream().map(tag ->
            new Tag(tag.getTagName(), tag.getTagType(), dir.getString(tag.getTagType()), tag.getDescription())
         ).toArray(Tag[]::new);
         return new Directory(dir.getName(), tags);
      }).toArray(Directory[]::new);
      return new ImageMetadata(dirs);
   }

   private final Directory[] directories;

   public Directory[] getDirectories() {
      return directories;
   }

   @Override
   public boolean equals(Object o) {
      if (this == o) return true;
      if (o == null || getClass() != o.getClass()) return false;

      ImageMetadata that = (ImageMetadata) o;

      // Probably incorrect - comparing Object[] arrays with Arrays.equals
      return Arrays.equals(directories, that.directories);
   }

   @Override
   public int hashCode() {
      return Arrays.hashCode(directories);
   }

   public ImageMetadata(Directory[] directories) {
      this.directories = directories;
   }

   public Tag[] tagsBy(Predicate f) {
      return Arrays.stream(tags()).filter(f).toArray(Tag[]::new);
   }

   public Tag[] tags() {
      return Arrays.stream(directories).flatMap(dir -> Arrays.stream(dir.getTags())).toArray(Tag[]::new);
   }

   public Optional getOrientation() {
      return OrientationTools.imageOrientationsOf(this).stream().findFirst();
   }
}