com.nervousync.utils.ImageUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nervousync-utils Show documentation
Show all versions of nervousync-utils Show documentation
Java Utils collections, development by Nervousync Studio (NSYC)
/*
* Licensed to the Nervousync Studio (NSYC) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
package com.nervousync.utils;
import java.awt.AlphaComposite;
import java.awt.Font;
import java.awt.Graphics2D;
import java.awt.image.BufferedImage;
import javax.imageio.ImageIO;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.nervousync.commons.beans.image.CutOptions;
import com.nervousync.commons.beans.image.MarkOptions;
import com.nervousync.commons.beans.image.MarkOptions.MarkPosition;
import com.nervousync.commons.core.Globals;
/**
* Image utils
* implements:
* Resize image by ratio
* Resize image to target width/height
* Retrieve image width value
* Retrieve image height value
* Cut image
* @author Steven Wee [email protected]
* @version $Revision: 1.0 $ $Date: May 1, 2018 1:49:46 PM $
*/
public final class ImageUtils {
private static final Logger LOGGER = LoggerFactory.getLogger(ImageUtils.class);
/**
* Read image width
* @param imagePath
* @return image width value
*/
public static int imageWidth(String imagePath) {
if (FileUtils.isExists(imagePath) && FileUtils.isPicture(imagePath)) {
try {
BufferedImage srcImage = ImageIO.read(FileUtils.getFile(imagePath));
return srcImage.getWidth(null);
} catch (Exception e) {
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Read picture error! ", e);
}
}
}
return Globals.DEFAULT_VALUE_INT;
}
/**
* Read image height
* @param imagePath
* @return image height value
*/
public static int imageHeight(String imagePath) {
if (FileUtils.isExists(imagePath) && FileUtils.isPicture(imagePath)) {
try {
BufferedImage srcImage = ImageIO.read(FileUtils.getFile(imagePath));
return srcImage.getHeight(null);
} catch (Exception e) {
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Read picture error! ", e);
}
}
}
return Globals.DEFAULT_VALUE_INT;
}
/**
* Cut image
* @param origPath original image file path
* @param destPath target output file path
* @param cutOptions cut options
* @return truesuccess falsefailed
*/
public static boolean cutImage(String origPath, String destPath, CutOptions cutOptions) {
if (origPath != null && FileUtils.isExists(origPath) && cutOptions != null) {
if (cutOptions.getPositionX() + cutOptions.getCutWidth() > ImageUtils.imageWidth(origPath)) {
LOGGER.error("Width is out of original file");
return Globals.DEFAULT_VALUE_BOOLEAN;
}
if (cutOptions.getPositionY() + cutOptions.getCutHeight() > ImageUtils.imageHeight(origPath)) {
LOGGER.error("Height is out of original file");
return Globals.DEFAULT_VALUE_BOOLEAN;
}
try {
BufferedImage srcImage = ImageIO.read(FileUtils.getFile(origPath));
BufferedImage bufferedImage =
new BufferedImage(cutOptions.getCutWidth(), cutOptions.getCutHeight(),
BufferedImage.TYPE_INT_RGB);
for (int i = 0 ; i < cutOptions.getCutWidth() ; i++) {
for (int j = 0 ; j < cutOptions.getCutHeight() ; j++) {
bufferedImage.setRGB(i, j,
srcImage.getRGB(cutOptions.getPositionX() + i, cutOptions.getPositionY() + j));
}
}
ImageIO.write(bufferedImage, StringUtils.getFilenameExtension(destPath), FileUtils.getFile(destPath));
} catch (Exception e) {
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Read picture error! ", e);
}
}
}
return Globals.DEFAULT_VALUE_BOOLEAN;
}
/**
* Resize picture by given ratio
* @param origPath original picture file path
* @param destPath target picture file path
* @param ratio resize ratio
* @return truesuccess falsefailed
*/
public static boolean resizeByRatio(String origPath, String destPath, double ratio) {
return ImageUtils.resizeByRatio(origPath, destPath, ratio, null);
}
/**
* Resize picture by given ratio
* @param origPath original picture file path
* @param destPath target picture file path
* @param ratio resize ratio
* @param markPath mark file path
* @param alpha between 0 and 1
* @return truesuccess falsefailed
*/
public static boolean resizeByRatio(String origPath, String destPath, double ratio,
MarkOptions markOptions) {
if (FileUtils.isExists(origPath) && FileUtils.isPicture(origPath) && ratio > 0) {
try {
BufferedImage srcImage = ImageIO.read(FileUtils.getFile(origPath));
int origWidth = srcImage.getWidth(null);
int origHeight = srcImage.getHeight(null);
int targetWidth = Double.valueOf(origWidth * ratio).intValue();
int targetHeight = Double.valueOf(origHeight * ratio).intValue();
return resizeImage(srcImage, destPath, targetWidth, targetHeight, markOptions);
} catch (Exception e) {
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Resize picture error! ", e);
}
}
}
return Globals.DEFAULT_VALUE_BOOLEAN;
}
/**
* Resize picture with given width and height
* @param origPath original picture file path
* @param destPath target picture file path
* @param targetWidth target width (if -1 width will auto set by height ratio)
* @param targetHeight target height (if -1 height will auto set by width ratio)
* @return truesuccess falsefailed
*/
public static boolean resizeTo(String origPath, String destPath,
int targetWidth, int targetHeight) {
return ImageUtils.resizeTo(origPath, destPath, targetWidth, targetHeight, null);
}
/**
* Resize picture with given width and height
* @param origPath original picture file path
* @param destPath target picture file path
* @param targetWidth target width (if -1 width will auto set by height ratio)
* @param targetHeight target height (if -1 height will auto set by width ratio)
* @param markPath mark file path
* @param alpha between 0 and 1
* @return truesuccess falsefailed
*/
public static boolean resizeTo(String origPath, String destPath,
int targetWidth, int targetHeight, MarkOptions markOptions) {
if (FileUtils.isExists(origPath) && FileUtils.isPicture(origPath)
&& (targetWidth > 0 || targetHeight > 0)) {
try {
BufferedImage srcImage = ImageIO.read(FileUtils.getFile(origPath));
if (targetWidth == Globals.DEFAULT_VALUE_INT
|| targetHeight == Globals.DEFAULT_VALUE_INT) {
int origWidth = srcImage.getWidth(null);
int origHeight = srcImage.getHeight(null);
if (targetWidth == Globals.DEFAULT_VALUE_INT) {
double ratio = targetHeight * 1.0 / origHeight;
targetWidth = Double.valueOf(ratio * origWidth).intValue();
} else if (targetHeight == Globals.DEFAULT_VALUE_INT) {
double ratio = targetWidth * 1.0 / origWidth;
targetHeight = Double.valueOf(ratio * origHeight).intValue();
}
}
return resizeImage(srcImage, destPath, targetWidth, targetHeight, markOptions);
} catch (Exception e) {
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Resize picture error! ", e);
}
}
}
return Globals.DEFAULT_VALUE_BOOLEAN;
}
public static boolean markImage(String filePath, String targetPath, MarkOptions markOptions) {
int imageWidth = ImageUtils.imageWidth(filePath);
int imageHeight = ImageUtils.imageHeight(filePath);
try {
BufferedImage srcImage = ImageIO.read(FileUtils.getFile(filePath));
BufferedImage bufferedImage =
new BufferedImage(imageWidth, imageHeight, BufferedImage.TYPE_INT_RGB);
Graphics2D graphics = bufferedImage.createGraphics();
graphics.drawImage(srcImage, 0, 0, imageWidth, imageHeight, null);
if (markOptions != null) {
markImage(graphics, imageWidth, imageHeight, markOptions);
}
graphics.dispose();
return ImageIO.write(bufferedImage, StringUtils.getFilenameExtension(targetPath),
FileUtils.getFile(targetPath));
} catch (Exception e) {
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Mark picture error! ", e);
}
}
return Globals.DEFAULT_VALUE_BOOLEAN;
}
/**
* Process image mark
* @param graphics target image graphics object
* @param width image width
* @param height image height
* @param markOptions image mark options
*/
private static void markImage(Graphics2D graphics, int width, int height, MarkOptions markOptions) {
MarkPosition markPosition = markOptions.retrievePosition(width, height);
if (markPosition != null) {
switch (markOptions.getMarkType()) {
case ICON:
try {
BufferedImage iconImg = ImageIO.read(FileUtils.getFile(markOptions.getMarkPath()));
if (iconImg != null && markOptions.getTransparency() >= 0
&& markOptions.getTransparency() <= 1) {
graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP,
markOptions.getTransparency()));
graphics.drawImage(iconImg, markPosition.getPositionX(), markPosition.getPositionY(), null);
graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER));
}
} catch (Exception e) {
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Read icon file error! ", e);
}
}
break;
case TEXT:
if (markOptions.getMarkText() != null && markOptions.getFontName() != null
&& markOptions.getFontSize() > 0) {
graphics.setColor(markOptions.getColor());
graphics.setFont(new Font(markOptions.getFontName(), Font.PLAIN, markOptions.getFontSize()));
graphics.drawString(markOptions.getMarkText(), markPosition.getPositionX(), markPosition.getPositionY());
}
break;
}
}
}
/**
* Process image resize operate
* @param srcImage original image object
* @param destPath target output path
* @param targetWidth target width
* @param targetHeight target height
* @param markOptions image mark options
* @return truesuccess falsefailed
*/
private static boolean resizeImage(BufferedImage srcImage, String destPath,
int targetWidth, int targetHeight, MarkOptions markOptions) {
if (srcImage != null && destPath != null && targetWidth > 0 && targetHeight > 0) {
try {
BufferedImage bufferedImage =
new BufferedImage(targetWidth, targetHeight, BufferedImage.TYPE_INT_RGB);
Graphics2D graphics = bufferedImage.createGraphics();
graphics.drawImage(srcImage, 0, 0, targetWidth, targetHeight, null);
if (markOptions != null) {
markImage(graphics, targetWidth, targetHeight, markOptions);
}
graphics.dispose();
return ImageIO.write(bufferedImage, StringUtils.getFilenameExtension(destPath),
FileUtils.getFile(destPath));
} catch (Exception e) {
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Resize picture error! ", e);
}
}
}
return Globals.DEFAULT_VALUE_BOOLEAN;
}
}