Changed license to CC0.
[meviz.git] / src / main / java / eu / svjatoslav / meviz / htmlindexer / Utils.java
index 4455992..456649d 100755 (executable)
 /*
- * Meviz - Various tools collection to work with multimedia.
- * Copyright (C) 2012, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of version 2 of the GNU General Public License
- * as published by the Free Software Foundation.
+ * Meviz - Various tools collection to work with multimedia. Author: Svjatoslav Agejenko.
+ * This project is released under Creative Commons Zero (CC0) license.
  */
 
+
 package eu.svjatoslav.meviz.htmlindexer;
 
+import eu.svjatoslav.meviz.htmlindexer.layouts.Layout;
+import eu.svjatoslav.meviz.htmlindexer.layouts.MixedLayout;
+import org.w3c.dom.NamedNodeMap;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+
+import javax.imageio.ImageReader;
+import javax.imageio.metadata.IIOMetadata;
+import javax.imageio.metadata.IIOMetadataNode;
+import java.awt.*;
 import java.awt.image.BufferedImage;
 import java.io.BufferedReader;
 import java.io.File;
-import java.io.FileNotFoundException;
 import java.io.FileReader;
 import java.io.IOException;
-import java.io.UnsupportedEncodingException;
-import java.net.URLEncoder;
+import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.zip.CRC32;
 
-import javax.imageio.ImageIO;
-
-import eu.svjatoslav.meviz.htmlindexer.layouts.MixedLayout;
+import static org.openimaj.image.ImageUtilities.createBufferedImage;
+import static org.openimaj.image.ImageUtilities.readMBF;
 
 public class Utils {
-
-       private static File lastLoadedFile;
-       private static final String UTF_8 = "UTF-8";
-
-       private static BufferedImage lastLoadedBufferedImage;
-
-       /**
-        * Load image into {@link BufferedImage} and return it. Caches last loaded
-        * image to speed up subsequent loading attempts.
-        *
-        * @throws ImageFormatError
-        * @throws IOException
-        */
-       public static BufferedImage getBufferedImage(final File file)
-                       throws ImageFormatError, IOException {
-               if (file.equals(lastLoadedFile))
-                       return lastLoadedBufferedImage;
-
-               System.out.println("Loading image: " + file.getPath());
-               lastLoadedBufferedImage = ImageIO.read(file);
-               lastLoadedFile = file;
-
-               if (lastLoadedBufferedImage == null) {
-                       System.out.println("Error reading image: " + file);
-                       throw new ImageFormatError("File: " + file
-                                       + " is not a valid image.");
-
-               }
-
-               return lastLoadedBufferedImage;
-       }
-
-       public static File getLayoutIndexFile(final Layout layout,
-                       final File directoryToIndex) {
-
-               final String indexFilePath = directoryToIndex.getAbsolutePath()
-                               + "/index" + layout.getFileNameSuffix() + ".html";
-
-               return new File(indexFilePath);
-       }
-
-       public static HashSet<Layout> getLayouts() {
-               final HashSet<Layout> layouts = new HashSet<Layout>();
-               layouts.add(new MixedLayout());
-               return layouts;
-       }
-
-       public static String getStringCrcAsHex(final String input) {
-
-               // create a new CRC-calculating object
-               final CRC32 crc = new CRC32();
-
-               // loop, calculating CRC for each byte of the string
-               // There is no CRC16.update(byte[]) method.
-               for (final byte b : input.getBytes())
-                       crc.update(b);
-
-               // note use crc.value, not crc.getValue()
-               final String hex = Integer.toHexString((int) crc.getValue())
-                               .toUpperCase();
-
-               // System.out.println("Input string: " + input);
-               // System.out.println("Result: " + hex);
-
-               return hex;
-       }
-
-       public static File getThumbnailsDirectory(final File directoryToIndex) {
-               return new File(getThumbnailsDirectoryPath(directoryToIndex));
-       }
-
-       public static String getThumbnailsDirectoryPath(final File directoryToIndex) {
-               return directoryToIndex.getAbsolutePath() + "/"
-                               + Constants.THUMBNAILS_DIRECTORY_NAME + "/";
-       }
-
-       public static boolean isMevizGeneratedIndexFile(final File indexFile)
-                       throws FileNotFoundException, IOException {
-
-               boolean isMevizFile = false;
-
-               final FileReader fileReader = new FileReader(indexFile);
-               final BufferedReader reader = new BufferedReader(fileReader);
-
-               parseFile: {
-                       while (true) {
-                               final String line = reader.readLine();
-
-                               if (line == null)
-                                       break parseFile;
-
-                               if (line.contains(Constants.HTML_MAGIC_STRING)) {
-                                       isMevizFile = true;
-                                       break parseFile;
-                               }
-                       }
-               }
-
-               reader.close();
-               fileReader.close();
-               return isMevizFile;
-       }
-
-       public static String urlEncode(String string) {
-               try {
-                       return URLEncoder.encode(string, UTF_8);
-               } catch (UnsupportedEncodingException e) {
-                       throw new RuntimeException(e);
-               }
-       }
-
+    private static File lastLoadedFile;
+    private static BufferedImage lastLoadedBufferedImage;
+
+    /**
+     * Load image into {@link BufferedImage} and return it. Caches last loaded
+     * image to speed up subsequent loading attempts.
+     *
+     * @throws ImageFormatError
+     * @throws IOException
+     */
+    public static BufferedImage getBufferedImage(final File file)
+            throws ImageFormatError, IOException {
+        if (file.equals(lastLoadedFile))
+            return lastLoadedBufferedImage;
+
+        lastLoadedBufferedImage = createBufferedImage(readMBF(file));
+        lastLoadedFile = file;
+
+        if (lastLoadedBufferedImage == null) {
+            System.out.println("Error reading image: " + file);
+            throw new ImageFormatError("File: " + file
+                    + " is not a valid image.");
+
+        }
+
+        return lastLoadedBufferedImage;
+    }
+
+    public static File getLayoutIndexFile(final Layout layout,
+                                          final File directoryToIndex) {
+
+        final String indexFilePath = directoryToIndex.getAbsolutePath()
+                + "/index" + layout.getFileNameSuffix() + ".html";
+
+        return new File(indexFilePath);
+    }
+
+    public static HashSet<Layout> getLayouts() {
+        final HashSet<Layout> layouts = new HashSet<>();
+        layouts.add(new MixedLayout());
+        return layouts;
+    }
+
+    public static String getStringCrcAsHex(final String input) {
+
+        // create a new CRC-calculating object
+        final CRC32 crc = new CRC32();
+
+        // loop, calculating CRC for each byte of the string
+        // There is no CRC16.update(byte[]) method.
+        for (final byte b : input.getBytes())
+            crc.update(b);
+
+        // note use crc.value, not crc.getValue()
+
+        return Integer.toHexString((int) crc.getValue())
+                .toUpperCase();
+    }
+
+    public static File getThumbnailsDirectory(final File directoryToIndex) {
+        return new File(getThumbnailsDirectoryPath(directoryToIndex));
+    }
+
+    public static String getThumbnailsDirectoryPath(final File directoryToIndex) {
+        return directoryToIndex.getAbsolutePath() + "/"
+                + Constants.THUMBNAILS_DIRECTORY_NAME + "/";
+    }
+
+    public static boolean isMevizGeneratedIndexFile(final File indexFile)
+            throws IOException {
+
+        boolean isMevizFile = false;
+
+        final FileReader fileReader = new FileReader(indexFile);
+        final BufferedReader reader = new BufferedReader(fileReader);
+
+        parseFile:
+        {
+            while (true) {
+                final String line = reader.readLine();
+
+                if (line == null)
+                    break parseFile;
+
+                if (line.contains(Constants.HTML_MAGIC_STRING)) {
+                    isMevizFile = true;
+                    break parseFile;
+                }
+            }
+        }
+
+        reader.close();
+        fileReader.close();
+        return isMevizFile;
+    }
+
+    /**
+     * TODO: URL path component is encoded differently from URL query parameter.
+     * Also some URL encoding might work for HTML on local filesystem, while other
+     * stuff works for web. Things must be cleared up here. Currently they are mixed and
+     * hacked together.
+     */
+    public static String urlEncode(String string) {
+        if (string.startsWith("./"))
+            string = string.substring(2);
+
+        // TODO: get rid of UrlParamEncoder.
+        return UrlParamEncoder.encode(string);
+        //
+//        try {
+//            return URLEncoder.encode(string, UTF_8).replace("+", "%20");
+//        } catch (UnsupportedEncodingException e) {
+//            throw new RuntimeException(e);
+//        }
+    }
+
+    public static ImageFrame[] readGIF(ImageReader reader) throws IOException {
+        ArrayList<ImageFrame> frames = new ArrayList<ImageFrame>(2);
+
+        int width = -1;
+        int height = -1;
+
+        IIOMetadata metadata = reader.getStreamMetadata();
+        if (metadata != null) {
+            IIOMetadataNode globalRoot = (IIOMetadataNode) metadata.getAsTree(metadata.getNativeMetadataFormatName());
+
+            NodeList globalScreenDescriptor = globalRoot.getElementsByTagName("LogicalScreenDescriptor");
+
+            if (globalScreenDescriptor != null && globalScreenDescriptor.getLength() > 0) {
+                IIOMetadataNode screenDescriptor = (IIOMetadataNode) globalScreenDescriptor.item(0);
+
+                if (screenDescriptor != null) {
+                    width = Integer.parseInt(screenDescriptor.getAttribute("logicalScreenWidth"));
+                    height = Integer.parseInt(screenDescriptor.getAttribute("logicalScreenHeight"));
+                }
+            }
+        }
+
+        BufferedImage master = null;
+        Graphics2D masterGraphics = null;
+
+        for (int frameIndex = 0;; frameIndex++) {
+            BufferedImage image;
+            try {
+                image = reader.read(frameIndex);
+            } catch (IndexOutOfBoundsException io) {
+                break;
+            }
+
+            if (width == -1 || height == -1) {
+                width = image.getWidth();
+                height = image.getHeight();
+            }
+
+            IIOMetadataNode root = (IIOMetadataNode) reader.getImageMetadata(frameIndex).getAsTree("javax_imageio_gif_image_1.0");
+            IIOMetadataNode gce = (IIOMetadataNode) root.getElementsByTagName("GraphicControlExtension").item(0);
+            int delay = Integer.valueOf(gce.getAttribute("delayTime"));
+            String disposal = gce.getAttribute("disposalMethod");
+
+            int x = 0;
+            int y = 0;
+
+            if (master == null) {
+                master = new BufferedImage(width, height, BufferedImage.TYPE_INT_ARGB);
+                masterGraphics = master.createGraphics();
+                masterGraphics.setBackground(new Color(0, 0, 0, 0));
+            } else {
+                NodeList children = root.getChildNodes();
+                for (int nodeIndex = 0; nodeIndex < children.getLength(); nodeIndex++) {
+                    Node nodeItem = children.item(nodeIndex);
+                    if (nodeItem.getNodeName().equals("ImageDescriptor")) {
+                        NamedNodeMap map = nodeItem.getAttributes();
+                        x = Integer.valueOf(map.getNamedItem("imageLeftPosition").getNodeValue());
+                        y = Integer.valueOf(map.getNamedItem("imageTopPosition").getNodeValue());
+                    }
+                }
+            }
+            masterGraphics.drawImage(image, x, y, null);
+
+            BufferedImage copy = new BufferedImage(master.getColorModel(), master.copyData(null), master.isAlphaPremultiplied(), null);
+            frames.add(new ImageFrame(copy, delay, disposal));
+
+            if (disposal.equals("restoreToPrevious")) {
+                BufferedImage from = null;
+                for (int i = frameIndex - 1; i >= 0; i--) {
+                    if (!frames.get(i).getDisposal().equals("restoreToPrevious") || frameIndex == 0) {
+                        from = frames.get(i).image;
+                        break;
+                    }
+                }
+
+                master = new BufferedImage(from.getColorModel(), from.copyData(null), from.isAlphaPremultiplied(), null);
+                masterGraphics = master.createGraphics();
+                masterGraphics.setBackground(new Color(0, 0, 0, 0));
+            } else if (disposal.equals("restoreToBackgroundColor")) {
+                masterGraphics.clearRect(x, y, image.getWidth(), image.getHeight());
+            }
+        }
+        reader.dispose();
+
+        return frames.toArray(new ImageFrame[frames.size()]);
+    }
+
+    public static class ImageFrame {
+        private final int delay;
+        public BufferedImage image;
+        private final String disposal;
+
+        public ImageFrame(BufferedImage image, int delay, String disposal) {
+            this.image = image;
+            this.delay = delay;
+            this.disposal = disposal;
+        }
+
+        public int getDelay() {
+            return delay;
+        }
+
+        public String getDisposal() {
+            return disposal;
+        }
+    }
 }