com.alkacon.simapi.RenderSettings Maven / Gradle / Ivy
Show all versions of alkacon-simapi Show documentation
/*
* File : $Source: /alkacon/cvs/AlkaconSimapi/src/com/alkacon/simapi/RenderSettings.java,v $
* Date : $Date: 2007/11/20 15:59:13 $
* Version: $Revision: 1.6 $
*
* Copyright (c) 2007 Alkacon Software GmbH (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH, please see the
* company website: http://www.alkacon.com
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package com.alkacon.simapi;
import java.awt.Color;
import java.awt.RenderingHints;
import java.awt.image.ImageFilter;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
/**
* Provides rendering hints of different quality for the image processing.
*
* @author Alexander Kandzior
*/
public class RenderSettings {
/** Rendering hints for the default MEDIUM render settigns. */
protected static final RenderingHints HINTS_MEDIUM = initHints(Simapi.RENDER_MEDIUM);
/** Rendering hints for the default QUALITY render settigns. */
protected static final RenderingHints HINTS_QUALITY = initHints(Simapi.RENDER_QUALITY);
/** Rendering hints for the default SPEED render settigns. */
protected static final RenderingHints HINTS_SPEED = initHints(Simapi.RENDER_SPEED);
/** The image save quality, used for JPEG images (and other formats that support such a setting). */
private float m_compressionQuality;
/** The rendering hints of this settings object. */
private RenderingHints m_hints;
/** The internal list of image filters to apply to the image. */
private List m_imageFilters;
/** Used to control if blur is applied when downscaling an image. */
private boolean m_isUseBlur;
/** The maxmimum image size to apply blur-before-scale (to avoid "out of memory" issues). */
private int m_maximumBlurSize;
/** Thread priority for image operations. */
private int m_threadNicePriority;
/** Stored old thread priority. */
private int m_threadOldPriority;
/** The backgound color replacement for the transparent color, used if transparency is not supported by the selected image format. */
private Color m_transparentReplaceColor;
/**
* Create a new set of render settings, based on the given constant base mode.
*
* @param baseMode the base mode of the settings, for example {@link Simapi#RENDER_QUALITY}
*/
public RenderSettings(int baseMode) {
this(baseMode, null);
}
/**
* Create a new set of render settings, based on the given constant base mode and the provided
* special rendering hints.
*
* @param baseMode the base mode of the settings, for example {@link Simapi#RENDER_QUALITY}
* @param hints the special rendering hints to use for image processing operations like scaling etc.
*/
public RenderSettings(int baseMode, RenderingHints hints) {
switch (baseMode) {
case Simapi.RENDER_SPEED:
m_hints = HINTS_SPEED;
m_compressionQuality = 0.35f;
m_isUseBlur = false;
break;
case Simapi.RENDER_MEDIUM:
m_hints = HINTS_MEDIUM;
m_compressionQuality = 0.5f;
m_isUseBlur = false;
break;
case Simapi.RENDER_QUALITY:
default:
m_hints = HINTS_QUALITY;
m_compressionQuality = 0.7f;
m_isUseBlur = true;
break;
}
if (hints != null) {
// must create a new object to modify, otherwise constant values would be affected
RenderingHints newHints = new RenderingHints(null);
newHints.add(m_hints);
newHints.add(hints);
m_hints = newHints;
}
m_transparentReplaceColor = Color.WHITE;
m_imageFilters = new ArrayList();
m_maximumBlurSize = (2500 * 2500);
m_threadNicePriority = Thread.MIN_PRIORITY;
}
/**
* Initializes the default values for the rendering hints.
*
* @param mode the quality mode to use
*
* @return the rendering hints
*/
private static RenderingHints initHints(int mode) {
// transformation rendering hints
HashMap hints = new HashMap();
switch (mode) {
case Simapi.RENDER_SPEED:
hints.put(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_NEAREST_NEIGHBOR);
hints.put(RenderingHints.KEY_ALPHA_INTERPOLATION, RenderingHints.VALUE_ALPHA_INTERPOLATION_SPEED);
hints.put(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_SPEED);
hints.put(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_OFF);
hints.put(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_OFF);
hints.put(RenderingHints.KEY_COLOR_RENDERING, RenderingHints.VALUE_COLOR_RENDER_SPEED);
hints.put(RenderingHints.KEY_DITHERING, RenderingHints.VALUE_DITHER_DEFAULT);
hints.put(RenderingHints.KEY_FRACTIONALMETRICS, RenderingHints.VALUE_FRACTIONALMETRICS_ON);
hints.put(RenderingHints.KEY_STROKE_CONTROL, RenderingHints.VALUE_STROKE_DEFAULT);
break;
case Simapi.RENDER_MEDIUM:
case Simapi.RENDER_QUALITY:
hints.put(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BILINEAR);
hints.put(RenderingHints.KEY_ALPHA_INTERPOLATION, RenderingHints.VALUE_ALPHA_INTERPOLATION_QUALITY);
hints.put(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY);
hints.put(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
hints.put(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
hints.put(RenderingHints.KEY_COLOR_RENDERING, RenderingHints.VALUE_COLOR_RENDER_QUALITY);
hints.put(RenderingHints.KEY_DITHERING, RenderingHints.VALUE_DITHER_ENABLE);
hints.put(RenderingHints.KEY_FRACTIONALMETRICS, RenderingHints.VALUE_FRACTIONALMETRICS_ON);
hints.put(RenderingHints.KEY_STROKE_CONTROL, RenderingHints.VALUE_STROKE_DEFAULT);
break;
default: // ignore
}
return new RenderingHints(hints);
}
/**
* Adds a new image filter to the filter processing list.
*
* @param filter the image filter to add
*/
public void addImageFilter(ImageFilter filter) {
m_imageFilters.add(filter);
}
/**
* Returns the image save compression quality, used for JPEG images (and other formats that support such a setting).
*
* This is used only if the image type supports different qualities.
* For example, this it is used when writing JPEG images.
* A quality of 0.1 is very poor, 0.75 is ok, 1.0 is maximum.
*
* @return the image save quality, used for JPEG images (and other formats that support such a setting)
*/
public float getCompressionQuality() {
return m_compressionQuality;
}
/**
* Returns a copy of the list of image filters that should be applied to the ?rocessed image.
*
* @return a copy of the list of image filters that should be applied to the ?rocessed image
*/
public List getImageFilters() {
return new ArrayList(m_imageFilters);
}
/**
* Returns the maximum size of an image that is blurred before applying a downscaling operation.
*
* If the image size is to big, "out of memory" errors may occur.
* The default is 2500 x 2500 pixel.
*
*
* @return the maximum size of an image that is blurred before apply a downscaling operation
*/
public int getMaximumBlurSize() {
return m_maximumBlurSize;
}
/**
* Returns the backgound color replacement for the transparent color.
*
* This is used if transparency is not supported by the selected image format.
*
* The default color is {@link Color#WHITE}.
*
* @return the backgound color replacement for the transparent color
*/
public Color getTransparentReplaceColor() {
return m_transparentReplaceColor;
}
/**
* Returns true if blur is used when downscaling an image to a thumbnail.
*
* This improves the thumbnail quality, but uses a lot more CPU and memory resources.
*
* @return true if blur is used when downscaling an image to a thumbnail
*/
public boolean isUseBlur() {
return m_isUseBlur;
}
/**
* Sets the image save compression quality, used for JPEG images (and other formats that support such a setting).
*
* This is used only if the image type supports different qualities.
* For example, this it is used when writing JPEG images.
* A quality of 0.1 is very poor, 0.75 is ok, 1.0 is maximum.
*
* @param compressionQuality the compression quality to set (must be between 0 and 1)
*/
public void setCompressionQuality(float compressionQuality) {
if ((compressionQuality < 0f) || (compressionQuality > 1f)) {
throw new IllegalArgumentException("compression quality must be between 0.0f and 1.0f");
}
m_compressionQuality = compressionQuality;
}
/**
* Sets the maximum size of an image that is blurred before applying a downscaling operation.
*
* @param maximumBlurSize the maximum size of an image to set
*/
public void setMaximumBlurSize(int maximumBlurSize) {
m_maximumBlurSize = maximumBlurSize;
}
/**
* Sets the backgound color replacement for the transparent color.
*
* This is used if transparency is not supported by the selected image format.
*
* @param transparentColor the backgound color replacement for the transparent color to set
*/
public void setTransparentReplaceColor(Color transparentColor) {
m_transparentReplaceColor = transparentColor;
}
/**
* Returns the image rendering hints to to be used for image scaling etc.
*
* This method is protected to avoid changes to the constant values defined in this class.
*
* @return the image rendering hints to to be used for image scaling etc.
*/
protected RenderingHints getRenderingHints() {
return m_hints;
}
/**
* Returns the thread priority to use for image operations that require a lot of CPU power.
*
* @return the thread priority to use for image operations that require a lot of CPU power
*/
protected int getThreadNicePriority() {
return m_threadNicePriority;
}
/**
* Returns the stored thread priority used.
*
* @return the stored thread priority used
*/
protected int getThreadOldPriority() {
if (m_threadOldPriority <= 0) {
m_threadOldPriority = Thread.NORM_PRIORITY;
}
return m_threadOldPriority;
}
/**
* Sets the thread priority to use for image operations that require a lot of CPU power.
*
* @param threadNicePriority the thread priority to set
*/
protected void setThreadNicePriority(int threadNicePriority) {
m_threadNicePriority = threadNicePriority;
}
/**
* Sets the stored thread priority.
*
* @param threadOldPriority the thread priority to store
*/
protected void setThreadOldPriority(int threadOldPriority) {
m_threadOldPriority = threadOldPriority;
}
}