Updated copyright message.
[meviz.git] / 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 -- 2018, 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 2 of the GNU General Public License
7  * 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 public class Picture extends AbstractFile {
31
32     private static final long serialVersionUID = -4156533490858298387L;
33     /**
34      * Picture dimensions.
35      */
36     private Dimension dimensions;
37
38     public Picture(final File parentDirectory, final String fileName)
39             throws Exception {
40         super(parentDirectory, fileName);
41     }
42
43     private static void ensureNonzeroImageArea(final java.awt.Dimension result) {
44         if (result.width < 1)
45             result.width = 1;
46         if (result.height < 1)
47             result.height = 1;
48     }
49
50     /**
51      * Actual returned target thumbnail size will be adjusted from desired one
52      * by attempting to generate as large as possible thumbnail, while not
53      * exceeding provided thumbnail width and height, and preserving aspect
54      * ratio of original image.
55      */
56     private static java.awt.Dimension getTargetThumbnailDimension(
57             final java.awt.Dimension originalImageDimension,
58             final java.awt.Dimension desiredTargetDimension) {
59
60         final double thumbWidthToHeightRatio = (double) desiredTargetDimension.width
61                 / (double) desiredTargetDimension.height;
62         final double inputImageWidthToHeightRatio = (double) originalImageDimension.width
63                 / (double) originalImageDimension.height;
64
65         if (thumbWidthToHeightRatio < inputImageWidthToHeightRatio) {
66
67             final java.awt.Dimension result = new java.awt.Dimension(
68                     desiredTargetDimension.width,
69                     (int) (desiredTargetDimension.width / inputImageWidthToHeightRatio));
70
71             ensureNonzeroImageArea(result);
72
73             return result;
74         } else {
75
76             final java.awt.Dimension result = new java.awt.Dimension(
77                     (int) (desiredTargetDimension.height * inputImageWidthToHeightRatio),
78                     desiredTargetDimension.height);
79
80             ensureNonzeroImageArea(result);
81
82             return result;
83         }
84     }
85
86     /**
87      * Propose list of thumbnail dimensions.
88      */
89     public static List<Dimension> getThumbnailDimensions(Dimension current) {
90         final ArrayList<Dimension> result = new ArrayList<>();
91         result.add(current);
92
93         while (current.getArea() > 1000000) {
94             current = current.getScaled(0.5d);
95             result.add(current);
96         }
97
98         return result;
99
100     }
101
102     public static void makeThumbnail(final File inputFile,
103                                      final File outputFile,
104                                      final java.awt.Dimension preferredTargetDimensions) {
105
106         try {
107
108             final BufferedImage inputImage = Utils.getBufferedImage(inputFile);
109
110             final java.awt.Dimension sourceImageDimension = new java.awt.Dimension(
111                     inputImage.getWidth(), inputImage.getHeight());
112
113             final java.awt.Dimension targetDimensions = getTargetThumbnailDimension(
114                     sourceImageDimension, preferredTargetDimensions);
115
116             final OutputStream out = new FileOutputStream(outputFile);
117
118             final Image scaledImage = scaleImage(inputImage,
119                     targetDimensions.width, targetDimensions.height);
120
121             final BufferedImage bufferedImage = new BufferedImage(
122                     scaledImage.getWidth(null), scaledImage.getHeight(null),
123                     BufferedImage.TYPE_INT_RGB);
124
125             final Graphics2D g = bufferedImage.createGraphics();
126             g.drawImage(scaledImage, 0, 0, null);
127             g.dispose();
128
129             ImageIO.write(bufferedImage, "jpg", out);
130             out.close();
131
132         } catch (final Exception exception) {
133             System.out.println(exception.toString());
134             exception.printStackTrace();
135         }
136     }
137
138     /**
139      * @return new image scaled to desired dimensions
140      */
141     private static Image scaleImage(final Image srcImage, final int width,
142                                     final int height) {
143
144         final ImageFilter filter = new java.awt.image.AreaAveragingScaleFilter(
145                 width, height);
146
147         final ImageProducer prod = new FilteredImageSource(
148                 srcImage.getSource(), filter);
149
150         final Image newImage = Toolkit.getDefaultToolkit().createImage(prod);
151
152         return new ImageIcon(newImage).getImage();
153     }
154
155     private String computeThumbnailHash(final Dimension targetDimension) {
156
157         // compute new thumbnails hash number
158         final String forMagicHash = fileName + " "
159                 + String.valueOf(targetDimension.width) + " "
160                 + String.valueOf(targetDimension.height) + " "
161                 + String.valueOf(getFileLength()) + " "
162                 + Constants.THUMBNAIL_VERSION;
163
164         // System.out.println("Computing hash from: " + forMagicHash);
165         return Utils.getStringCrcAsHex(forMagicHash);
166     }
167
168     public Dimension getDimensions() {
169         return dimensions;
170     }
171
172     /**
173      * Get thumbnail file name for this image and desired thumbnail dimensions
174      * relative to designated thumbnails directory within parent directory.
175      */
176     public String getRelativeThumbnailFileName(final Dimension targetDimension) {
177         return FilePathParser.getFileNameWithoutExtension(fileName) + " ("
178                 + computeThumbnailHash(targetDimension) + ").jpeg";
179     }
180
181     @Override
182     public void updateFileMetainfo(final File parentDirectory) throws Exception {
183         final BufferedImage image = Utils
184                 .getBufferedImage(getFile(parentDirectory));
185         dimensions = new Dimension(image.getWidth(), image.getHeight());
186     }
187
188 }