src/main/java/eu/svjatoslav/meviz/htmlindexer/metadata/fileTypes/Picture.java

   1 /*
   2  * Meviz - Various tools collection to work with multimedia.
   3  * Copyright (C) 2012 -- 2019, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of version 3 of the GNU Lesser General Public License
   7  * or later as published by the Free Software Foundation.
   8 */
   9
  10 package eu.svjatoslav.meviz.htmlindexer.metadata.fileTypes;
  11
  12 import eu.svjatoslav.commons.file.FilePathParser;
  13 import eu.svjatoslav.meviz.htmlindexer.Constants;
  14 import eu.svjatoslav.meviz.htmlindexer.Utils;
  15 import eu.svjatoslav.meviz.htmlindexer.metadata.Dimension;
  16
  17 import javax.imageio.ImageIO;
  18 import javax.swing.*;
  19 import java.awt.*;
  20 import java.awt.image.BufferedImage;
  21 import java.awt.image.FilteredImageSource;
  22 import java.awt.image.ImageFilter;
  23 import java.awt.image.ImageProducer;
  24 import java.io.File;
  25 import java.io.FileOutputStream;
  26 import java.io.OutputStream;
  27 import java.util.ArrayList;
  28 import java.util.List;
  29
  30 import static eu.svjatoslav.meviz.htmlindexer.Utils.getBufferedImage;
  31 import static java.awt.image.BufferedImage.TYPE_INT_RGB;
  32
  33 public class Picture extends AbstractFile {
  34
  35     private static final long serialVersionUID = -4156533490858298387L;
  36     /**
  37      * Picture dimensions.
  38      */
  39     private Dimension dimensions;
  40
  41     public Picture(final File parentDirectory, final String fileName)
  42             throws Exception {
  43         super(parentDirectory, fileName);
  44     }
  45
  46     private static void ensureNonzeroImageArea(final java.awt.Dimension result) {
  47         if (result.width < 1)
  48             result.width = 1;
  49         if (result.height < 1)
  50             result.height = 1;
  51     }
  52
  53     /**
  54      * Actual returned target thumbnail size will be adjusted from desired one
  55      * by attempting to generate as large as possible thumbnail, while not
  56      * exceeding provided thumbnail width and height, and preserving aspect
  57      * ratio of original image.
  58      */
  59     private static java.awt.Dimension getTargetThumbnailDimension(
  60             final java.awt.Dimension originalImageDimension,
  61             final java.awt.Dimension desiredTargetDimension) {
  62
  63         final double thumbWidthToHeightRatio = (double) desiredTargetDimension.width
  64                 / (double) desiredTargetDimension.height;
  65         final double inputImageWidthToHeightRatio = (double) originalImageDimension.width
  66                 / (double) originalImageDimension.height;
  67
  68         if (thumbWidthToHeightRatio < inputImageWidthToHeightRatio) {
  69
  70             final java.awt.Dimension result = new java.awt.Dimension(
  71                     desiredTargetDimension.width,
  72                     (int) (desiredTargetDimension.width / inputImageWidthToHeightRatio));
  73
  74             ensureNonzeroImageArea(result);
  75
  76             return result;
  77         } else {
  78
  79             final java.awt.Dimension result = new java.awt.Dimension(
  80                     (int) (desiredTargetDimension.height * inputImageWidthToHeightRatio),
  81                     desiredTargetDimension.height);
  82
  83             ensureNonzeroImageArea(result);
  84
  85             return result;
  86         }
  87     }
  88
  89     /**
  90      * Propose list of thumbnail dimensions.
  91      */
  92     public static List<Dimension> getThumbnailDimensions(Dimension current) {
  93         final ArrayList<Dimension> result = new ArrayList<>();
  94         result.add(current);
  95
  96         while (current.getArea() > 1000000) {
  97             current = current.getScaled(0.5d);
  98             result.add(current);
  99         }
 100
 101         return result;
 102
 103     }
 104
 105     public static void makeThumbnail(final File inputFile,
 106                                      final File outputFile,
 107                                      final java.awt.Dimension preferredTargetDimensions) {
 108
 109         try {
 110
 111             final BufferedImage inputImage = getBufferedImage(inputFile);
 112
 113             final java.awt.Dimension sourceImageDimension = new java.awt.Dimension(
 114                     inputImage.getWidth(), inputImage.getHeight());
 115
 116             final java.awt.Dimension targetDimensions = getTargetThumbnailDimension(
 117                     sourceImageDimension, preferredTargetDimensions);
 118
 119             final OutputStream out = new FileOutputStream(outputFile);
 120
 121             final Image scaledImage = scaleImage(inputImage,
 122                     targetDimensions.width, targetDimensions.height);
 123
 124             final BufferedImage bufferedImage = new BufferedImage(
 125                     scaledImage.getWidth(null), scaledImage.getHeight(null),
 126                     TYPE_INT_RGB);
 127
 128             final Graphics2D g = bufferedImage.createGraphics();
 129             g.drawImage(scaledImage, 0, 0, null);
 130             g.dispose();
 131
 132             ImageIO.write(bufferedImage, "jpg", out);
 133             out.close();
 134
 135         } catch (final Exception exception) {
 136             System.out.println(exception.toString());
 137             exception.printStackTrace();
 138         }
 139     }
 140
 141     /**
 142      * @return new image scaled to desired dimensions
 143      */
 144     private static Image scaleImage(final Image srcImage, final int width,
 145                                     final int height) {
 146
 147         final ImageFilter filter = new java.awt.image.AreaAveragingScaleFilter(
 148                 width, height);
 149
 150         final ImageProducer prod = new FilteredImageSource(
 151                 srcImage.getSource(), filter);
 152
 153         final Image newImage = Toolkit.getDefaultToolkit().createImage(prod);
 154
 155         return new ImageIcon(newImage).getImage();
 156     }
 157
 158     private String computeThumbnailHash(final Dimension targetDimension) {
 159
 160         // compute new thumbnails hash number
 161         final String forMagicHash = fileName + " "
 162                 + targetDimension.width + " "
 163                 + targetDimension.height + " "
 164                 + getFileLength() + " "
 165                 + Constants.THUMBNAIL_VERSION;
 166
 167         // System.out.println("Computing hash from: " + forMagicHash);
 168         return Utils.getStringCrcAsHex(forMagicHash);
 169     }
 170
 171     public Dimension getDimensions() {
 172         return dimensions;
 173     }
 174
 175     /**
 176      * Get thumbnail file name for this image and desired thumbnail dimensions
 177      * relative to designated thumbnails directory within parent directory.
 178      */
 179     public String getRelativeThumbnailFileName(final Dimension targetDimension) {
 180         return FilePathParser.getFileNameWithoutExtension(fileName) + " ("
 181                 + computeThumbnailHash(targetDimension) + ")." + getFileExtension();
 182     }
 183
 184     @Override
 185     public void updateFileMetadata(final File parentDirectory) throws Exception {
 186         final BufferedImage image = getBufferedImage(getFile(parentDirectory));
 187         dimensions = new Dimension(image.getWidth(), image.getHeight());
 188     }
 189
 190 }