Demos of a custom buffered image operation
/*
* Copyright (c) 2007, Romain Guy
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* * Neither the name of the TimingFramework project nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.GraphicsConfiguration;
import java.awt.GraphicsEnvironment;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.Rectangle;
import java.awt.RenderingHints;
import java.awt.Transparency;
import java.awt.geom.Point2D;
import java.awt.geom.Rectangle2D;
import java.awt.image.BufferedImage;
import java.awt.image.BufferedImageOp;
import java.awt.image.ColorModel;
import java.awt.image.DirectColorModel;
import java.awt.image.Raster;
import java.awt.image.WritableRaster;
import java.io.IOException;
import java.net.URL;
import javax.imageio.ImageIO;
import javax.swing.JComponent;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JSlider;
import javax.swing.SwingUtilities;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
/**
* <p>
* Demos of a custom buffered image operation.
* </p>
*
* @author Romain Guy <romain.guy@mac.com>
*/
public class ImageOpByRomain extends JFrame {
private BufferedImage sourceImage;
private ImagePanel imagePanel;
private JSlider redSlider;
private JSlider greenSlider;
private JSlider blueSlider;
private JSlider alphaSlider;
public ImageOpByRomain() {
super("Custom Image Op Demo");
loadSourceImage();
buildContent();
pack();
setLocationRelativeTo(null);
setResizable(false);
setDefaultCloseOperation(EXIT_ON_CLOSE);
}
public static void main(String... args) {
SwingUtilities.invokeLater(new Runnable() {
public void run() {
new ImageOpByRomain().setVisible(true);
}
});
}
private void buildContent() {
buildImagePanel();
buildControlsPanel();
}
private void loadSourceImage() {
try {
sourceImage = GraphicsUtilities.loadCompatibleImage(getClass()
.getResource("A.jpg"));
} catch (IOException ex) {
ex.printStackTrace();
}
}
private void buildImagePanel() {
add(imagePanel = new ImagePanel());
}
private void buildControlsPanel() {
JPanel controls = new JPanel(new GridBagLayout());
// red component
controls.add(new JLabel("Red: 0"), new GridBagConstraints(0, 0, 1, 1, 1.0,
1.0, GridBagConstraints.LINE_END, GridBagConstraints.NONE, new Insets(
0, 0, 0, 0), 0, 0));
controls.add(redSlider = new JSlider(0, 255, 255), new GridBagConstraints(
1, 0, 1, 1, 1.0, 1.0, GridBagConstraints.CENTER,
GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0));
controls.add(new JLabel("255"), new GridBagConstraints(2, 0, 1, 1, 1.0,
1.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE,
new Insets(0, 0, 0, 0), 0, 0));
// green component
controls.add(new JLabel("Green: 0"), new GridBagConstraints(0, 1, 1, 1,
1.0, 1.0, GridBagConstraints.LINE_END, GridBagConstraints.NONE,
new Insets(0, 0, 0, 0), 0, 0));
controls.add(greenSlider = new JSlider(0, 255, 255),
new GridBagConstraints(1, 1, 1, 1, 1.0, 1.0, GridBagConstraints.CENTER,
GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0));
controls.add(new JLabel("255"), new GridBagConstraints(2, 1, 1, 1, 1.0,
1.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE,
new Insets(0, 0, 0, 0), 0, 0));
// blue component
controls.add(new JLabel("Blue: 0"), new GridBagConstraints(0, 2, 1, 1, 1.0,
1.0, GridBagConstraints.LINE_END, GridBagConstraints.NONE, new Insets(
0, 0, 0, 0), 0, 0));
controls.add(blueSlider = new JSlider(0, 255, 255), new GridBagConstraints(
1, 2, 1, 1, 1.0, 1.0, GridBagConstraints.CENTER,
GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0));
controls.add(new JLabel("255"), new GridBagConstraints(2, 2, 1, 1, 1.0,
1.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE,
new Insets(0, 0, 0, 0), 0, 0));
// mix value
controls.add(new JLabel("Mix: 0%"), new GridBagConstraints(0, 3, 1, 1, 1.0,
1.0, GridBagConstraints.LINE_END, GridBagConstraints.NONE, new Insets(
0, 0, 0, 0), 0, 0));
controls.add(alphaSlider = new JSlider(0, 100, 50), new GridBagConstraints(
1, 3, 1, 1, 1.0, 1.0, GridBagConstraints.CENTER,
GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0));
controls.add(new JLabel("100%"), new GridBagConstraints(2, 3, 1, 1, 1.0,
1.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE,
new Insets(0, 0, 0, 0), 0, 0));
// change listener
ChangeListener colorChange = new ChangeListener() {
public void stateChanged(ChangeEvent e) {
imagePanel.setColor(new Color(redSlider.getValue(), greenSlider
.getValue(), blueSlider.getValue()));
}
};
redSlider.addChangeListener(colorChange);
greenSlider.addChangeListener(colorChange);
blueSlider.addChangeListener(colorChange);
// alpha listener
alphaSlider.addChangeListener(new ChangeListener() {
public void stateChanged(ChangeEvent e) {
imagePanel.setMix((float) alphaSlider.getValue() / 100.0f);
}
});
add(controls, BorderLayout.SOUTH);
}
private class ImagePanel extends JComponent {
private ColorTintFilter op = new ColorTintFilter(Color.WHITE, 0.5f);
private BufferedImage cache;
private boolean damaged;
private ImagePanel() {
cache = GraphicsUtilities.createCompatibleImage(sourceImage);
damaged = true;
}
public void setColor(Color color) {
op = new ColorTintFilter(color, op.getMixValue());
damaged = true;
repaint();
}
public void setMix(float mix) {
op = new ColorTintFilter(op.getMixColor(), mix);
damaged = true;
repaint();
}
@Override
public Dimension getPreferredSize() {
return new Dimension(sourceImage.getWidth(), sourceImage.getHeight());
}
@Override
protected void paintComponent(Graphics g) {
Graphics2D g2 = (Graphics2D) g;
if (damaged) {
op.filter(sourceImage, cache);
}
int x = (getWidth() - cache.getWidth()) / 2;
int y = (getHeight() - cache.getHeight()) / 2;
g2.drawImage(cache, x, y, null);
}
}
}
/*
* $Id: AbstractFilter.java,v 1.1 2006/11/05 15:40:51 gfx Exp $
*
* Dual-licensed under LGPL (Sun and Romain Guy) and BSD (Romain Guy).
*
* Copyright 2005 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* California 95054, U.S.A. All rights reserved.
*
* Copyright (c) 2006 Romain Guy <romain.guy@mac.com> All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer. 2. Redistributions in
* binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution. 3. The name of the author may not
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* <p>
* Provides an abstract implementation of the <code>BufferedImageOp</code>
* interface. This class can be used to created new image filters based on
* <code>BufferedImageOp</code>.
* </p>
*
* @author Romain Guy <romain.guy@mac.com>
*/
abstract class AbstractFilter implements BufferedImageOp {
public abstract BufferedImage filter(BufferedImage src, BufferedImage dest);
/**
* {@inheritDoc}
*/
public Rectangle2D getBounds2D(BufferedImage src) {
return new Rectangle(0, 0, src.getWidth(), src.getHeight());
}
/**
* {@inheritDoc}
*/
public BufferedImage createCompatibleDestImage(BufferedImage src,
ColorModel destCM) {
if (destCM == null) {
destCM = src.getColorModel();
}
return new BufferedImage(destCM, destCM.createCompatibleWritableRaster(src
.getWidth(), src.getHeight()), destCM.isAlphaPremultiplied(), null);
}
/**
* {@inheritDoc}
*/
public Point2D getPoint2D(Point2D srcPt, Point2D dstPt) {
return (Point2D) srcPt.clone();
}
/**
* {@inheritDoc}
*/
public RenderingHints getRenderingHints() {
return null;
}
}
/*
* $Id: ColorTintFilter.java,v 1.5 2007/02/10 03:21:54 gfx Exp $
*
* Dual-licensed under LGPL (Sun and Romain Guy) and BSD (Romain Guy).
*
* Copyright 2005 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* California 95054, U.S.A. All rights reserved.
*
* Copyright (c) 2006 Romain Guy <romain.guy@mac.com> All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer. 2. Redistributions in
* binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution. 3. The name of the author may not
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* <p>
* A color tint filter can be used to mix a solid color to an image. The result
* is an image tinted by the specified color. The force of the effect can be
* controlled with the <code>mixValue</code>, a number between 0.0 and 1.0
* that can be seen as the percentage of the mix (0.0 does not affect the source
* image and 1.0 replaces all the pixels by the solid color).
* </p>
* <p>
* The color of the pixels in the resulting image is computed as follows:
* </p>
*
* <pre>
* cR = cS * (1 - mixValue) + cM * mixValue
* </pre>
*
* <p>
* Definition of the parameters:
* </p>
* <ul>
* <li><code>cR</code>: color of the resulting pixel</li>
* <li><code>cS</code>: color of the source pixel</li>
* <li><code>cM</code>: the solid color to mix with the source image</li>
* <li><code>mixValue</code>: strength of the mix, a value between 0.0 and
* 1.0</li>
* </ul>
*
* @author Romain Guy <romain.guy@mac.com>
*/
class ColorTintFilter extends AbstractFilter {
private final Color mixColor;
private final float mixValue;
private int[] preMultipliedRed;
private int[] preMultipliedGreen;
private int[] preMultipliedBlue;
/**
* <p>
* Creates a new color mixer filter. The specified color will be used to tint
* the source image, with a mixing strength defined by <code>mixValue</code>.
* </p>
*
* @param mixColor
* the solid color to mix with the source image
* @param mixValue
* the strength of the mix, between 0.0 and 1.0; if the specified
* value lies outside this range, it is clamped
* @throws IllegalArgumentException
* if <code>mixColor</code> is null
*/
public ColorTintFilter(Color mixColor, float mixValue) {
if (mixColor == null) {
throw new IllegalArgumentException("mixColor cannot be null");
}
this.mixColor = mixColor;
if (mixValue < 0.0f) {
mixValue = 0.0f;
} else if (mixValue > 1.0f) {
mixValue = 1.0f;
}
this.mixValue = mixValue;
int mix_r = (int) (mixColor.getRed() * mixValue);
int mix_g = (int) (mixColor.getGreen() * mixValue);
int mix_b = (int) (mixColor.getBlue() * mixValue);
// Since we use only lookup tables to apply the filter, this filter
// could be implemented as a LookupOp.
float factor = 1.0f - mixValue;
preMultipliedRed = new int[256];
preMultipliedGreen = new int[256];
preMultipliedBlue = new int[256];
for (int i = 0; i < 256; i++) {
int value = (int) (i * factor);
preMultipliedRed[i] = value + mix_r;
preMultipliedGreen[i] = value + mix_g;
preMultipliedBlue[i] = value + mix_b;
}
}
/**
* <p>
* Returns the mix value of this filter.
* </p>
*
* @return the mix value, between 0.0 and 1.0
*/
public float getMixValue() {
return mixValue;
}
/**
* <p>
* Returns the solid mix color of this filter.
* </p>
*
* @return the solid color used for mixing
*/
public Color getMixColor() {
return mixColor;
}
/**
* {@inheritDoc}
*/
@Override
public BufferedImage filter(BufferedImage src, BufferedImage dst) {
if (dst == null) {
DirectColorModel directCM = new DirectColorModel(32, 0x00FF0000,
0x0000FF00, 0x000000FF, 0xFF000000);
dst = createCompatibleDestImage(src, directCM);
}
int width = src.getWidth();
int height = src.getHeight();
int[] pixels = new int[width * height];
GraphicsUtilities.getPixels(src, 0, 0, width, height, pixels);
mixColor(pixels);
GraphicsUtilities.setPixels(dst, 0, 0, width, height, pixels);
return dst;
}
private void mixColor(int[] pixels) {
for (int i = 0; i < pixels.length; i++) {
int argb = pixels[i];
pixels[i] = (argb & 0xFF000000)
| preMultipliedRed[(argb >> 16) & 0xFF] << 16
| preMultipliedGreen[(argb >> 8) & 0xFF] << 8
| preMultipliedBlue[argb & 0xFF];
}
}
}
/*
* $Id: GraphicsUtilities.java,v 1.1 2006/11/05 15:40:51 gfx Exp $
*
* Dual-licensed under LGPL (Sun and Romain Guy) and BSD (Romain Guy).
*
* Copyright 2005 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* California 95054, U.S.A. All rights reserved.
*
* Copyright (c) 2006 Romain Guy <romain.guy@mac.com> All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer. 2. Redistributions in
* binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution. 3. The name of the author may not
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* <p>
* <code>GraphicsUtilities</code> contains a set of tools to perform common
* graphics operations easily. These operations are divided into several themes,
* listed below.
* </p>
* <h2>Compatible Images</h2>
* <p>
* Compatible images can, and should, be used to increase drawing performance.
* This class provides a number of methods to load compatible images directly
* from files or to convert existing images to compatibles images.
* </p>
* <h2>Creating Thumbnails</h2>
* <p>
* This class provides a number of methods to easily scale down images. Some of
* these methods offer a trade-off between speed and result quality and shouuld
* be used all the time. They also offer the advantage of producing compatible
* images, thus automatically resulting into better runtime performance.
* </p>
* <p>
* All these methodes are both faster than
* {@link java.awt.Image#getScaledInstance(int, int, int)} and produce
* better-looking results than the various <code>drawImage()</code> methods in
* {@link java.awt.Graphics}, which can be used for image scaling.
* </p>
* <h2>Image Manipulation</h2>
* <p>
* This class provides two methods to get and set pixels in a buffered image.
* These methods try to avoid unmanaging the image in order to keep good
* performance.
* </p>
*
* @author Romain Guy <romain.guy@mac.com>
*/
class GraphicsUtilities {
private static final GraphicsConfiguration CONFIGURATION = GraphicsEnvironment
.getLocalGraphicsEnvironment().getDefaultScreenDevice()
.getDefaultConfiguration();
private GraphicsUtilities() {
}
/**
* <p>
* Returns a new <code>BufferedImage</code> using the same color model as
* the image passed as a parameter. The returned image is only compatible with
* the image passed as a parameter. This does not mean the returned image is
* compatible with the hardware.
* </p>
*
* @param image
* the reference image from which the color model of the new image
* is obtained
* @return a new <code>BufferedImage</code>, compatible with the color
* model of <code>image</code>
*/
public static BufferedImage createColorModelCompatibleImage(
BufferedImage image) {
ColorModel cm = image.getColorModel();
return new BufferedImage(cm, cm.createCompatibleWritableRaster(image
.getWidth(), image.getHeight()), cm.isAlphaPremultiplied(), null);
}
/**
* <p>
* Returns a new compatible image with the same width, height and transparency
* as the image specified as a parameter.
* </p>
*
* @see java.awt.Transparency
* @see #createCompatibleImage(int, int)
* @see #createCompatibleImage(java.awt.image.BufferedImage, int, int)
* @see #createTranslucentCompatibleImage(int, int)
* @see #loadCompatibleImage(java.net.URL)
* @see #toCompatibleImage(java.awt.image.BufferedImage)
* @param image
* the reference image from which the dimension and the
* transparency of the new image are obtained
* @return a new compatible <code>BufferedImage</code> with the same
* dimension and transparency as <code>image</code>
*/
public static BufferedImage createCompatibleImage(BufferedImage image) {
return createCompatibleImage(image, image.getWidth(), image.getHeight());
}
/**
* <p>
* Returns a new compatible image of the specified width and height, and the
* same transparency setting as the image specified as a parameter.
* </p>
*
* @see java.awt.Transparency
* @see #createCompatibleImage(java.awt.image.BufferedImage)
* @see #createCompatibleImage(int, int)
* @see #createTranslucentCompatibleImage(int, int)
* @see #loadCompatibleImage(java.net.URL)
* @see #toCompatibleImage(java.awt.image.BufferedImage)
* @param width
* the width of the new image
* @param height
* the height of the new image
* @param image
* the reference image from which the transparency of the new image
* is obtained
* @return a new compatible <code>BufferedImage</code> with the same
* transparency as <code>image</code> and the specified dimension
*/
public static BufferedImage createCompatibleImage(BufferedImage image,
int width, int height) {
return CONFIGURATION.createCompatibleImage(width, height, image
.getTransparency());
}
/**
* <p>
* Returns a new opaque compatible image of the specified width and height.
* </p>
*
* @see #createCompatibleImage(java.awt.image.BufferedImage)
* @see #createCompatibleImage(java.awt.image.BufferedImage, int, int)
* @see #createTranslucentCompatibleImage(int, int)
* @see #loadCompatibleImage(java.net.URL)
* @see #toCompatibleImage(java.awt.image.BufferedImage)
* @param width
* the width of the new image
* @param height
* the height of the new image
* @return a new opaque compatible <code>BufferedImage</code> of the
* specified width and height
*/
public static BufferedImage createCompatibleImage(int width, int height) {
return CONFIGURATION.createCompatibleImage(width, height);
}
/**
* <p>
* Returns a new translucent compatible image of the specified width and
* height.
* </p>
*
* @see #createCompatibleImage(java.awt.image.BufferedImage)
* @see #createCompatibleImage(java.awt.image.BufferedImage, int, int)
* @see #createCompatibleImage(int, int)
* @see #loadCompatibleImage(java.net.URL)
* @see #toCompatibleImage(java.awt.image.BufferedImage)
* @param width
* the width of the new image
* @param height
* the height of the new image
* @return a new translucent compatible <code>BufferedImage</code> of the
* specified width and height
*/
public static BufferedImage createTranslucentCompatibleImage(int width,
int height) {
return CONFIGURATION.createCompatibleImage(width, height,
Transparency.TRANSLUCENT);
}
/**
* <p>
* Returns a new compatible image from a URL. The image is loaded from the
* specified location and then turned, if necessary into a compatible image.
* </p>
*
* @see #createCompatibleImage(java.awt.image.BufferedImage)
* @see #createCompatibleImage(java.awt.image.BufferedImage, int, int)
* @see #createCompatibleImage(int, int)
* @see #createTranslucentCompatibleImage(int, int)
* @see #toCompatibleImage(java.awt.image.BufferedImage)
* @param resource
* the URL of the picture to load as a compatible image
* @return a new translucent compatible <code>BufferedImage</code> of the
* specified width and height
* @throws java.io.IOException
* if the image cannot be read or loaded
*/
public static BufferedImage loadCompatibleImage(URL resource)
throws IOException {
BufferedImage image = ImageIO.read(resource);
return toCompatibleImage(image);
}
/**
* <p>
* Return a new compatible image that contains a copy of the specified image.
* This method ensures an image is compatible with the hardware, and therefore
* optimized for fast blitting operations.
* </p>
*
* @see #createCompatibleImage(java.awt.image.BufferedImage)
* @see #createCompatibleImage(java.awt.image.BufferedImage, int, int)
* @see #createCompatibleImage(int, int)
* @see #createTranslucentCompatibleImage(int, int)
* @see #loadCompatibleImage(java.net.URL)
* @param image
* the image to copy into a new compatible image
* @return a new compatible copy, with the same width and height and
* transparency and content, of <code>image</code>
*/
public static BufferedImage toCompatibleImage(BufferedImage image) {
if (image.getColorModel().equals(CONFIGURATION.getColorModel())) {
return image;
}
BufferedImage compatibleImage = CONFIGURATION.createCompatibleImage(image
.getWidth(), image.getHeight(), image.getTransparency());
Graphics g = compatibleImage.getGraphics();
g.drawImage(image, 0, 0, null);
g.dispose();
return compatibleImage;
}
/**
* <p>
* Returns a thumbnail of a source image. <code>newSize</code> defines the
* length of the longest dimension of the thumbnail. The other dimension is
* then computed according to the dimensions ratio of the original picture.
* </p>
* <p>
* This method favors speed over quality. When the new size is less than half
* the longest dimension of the source image,
* {@link #createThumbnail(BufferedImage, int)} or
* {@link #createThumbnail(BufferedImage, int, int)} should be used instead to
* ensure the quality of the result without sacrificing too much performance.
* </p>
*
* @see #createThumbnailFast(java.awt.image.BufferedImage, int, int)
* @see #createThumbnail(java.awt.image.BufferedImage, int)
* @see #createThumbnail(java.awt.image.BufferedImage, int, int)
* @param image
* the source image
* @param newSize
* the length of the largest dimension of the thumbnail
* @return a new compatible <code>BufferedImage</code> containing a
* thumbnail of <code>image</code>
* @throws IllegalArgumentException
* if <code>newSize</code> is larger than the largest dimension
* of <code>image</code> or <= 0
*/
public static BufferedImage createThumbnailFast(BufferedImage image,
int newSize) {
float ratio;
int width = image.getWidth();
int height = image.getHeight();
if (width > height) {
if (newSize >= width) {
throw new IllegalArgumentException("newSize must be lower than"
+ " the image width");
} else if (newSize <= 0) {
throw new IllegalArgumentException("newSize must"
+ " be greater than 0");
}
ratio = (float) width / (float) height;
width = newSize;
height = (int) (newSize / ratio);
} else {
if (newSize >= height) {
throw new IllegalArgumentException("newSize must be lower than"
+ " the image height");
} else if (newSize <= 0) {
throw new IllegalArgumentException("newSize must"
+ " be greater than 0");
}
ratio = (float) height / (float) width;
height = newSize;
width = (int) (newSize / ratio);
}
BufferedImage temp = createCompatibleImage(image, width, height);
Graphics2D g2 = temp.createGraphics();
g2.setRenderingHint(RenderingHints.KEY_INTERPOLATION,
RenderingHints.VALUE_INTERPOLATION_BILINEAR);
g2.drawImage(image, 0, 0, temp.getWidth(), temp.getHeight(), null);
g2.dispose();
return temp;
}
/**
* <p>
* Returns a thumbnail of a source image.
* </p>
* <p>
* This method favors speed over quality. When the new size is less than half
* the longest dimension of the source image,
* {@link #createThumbnail(BufferedImage, int)} or
* {@link #createThumbnail(BufferedImage, int, int)} should be used instead to
* ensure the quality of the result without sacrificing too much performance.
* </p>
*
* @see #createThumbnailFast(java.awt.image.BufferedImage, int)
* @see #createThumbnail(java.awt.image.BufferedImage, int)
* @see #createThumbnail(java.awt.image.BufferedImage, int, int)
* @param image
* the source image
* @param newWidth
* the width of the thumbnail
* @param newHeight
* the height of the thumbnail
* @return a new compatible <code>BufferedImage</code> containing a
* thumbnail of <code>image</code>
* @throws IllegalArgumentException
* if <code>newWidth</code> is larger than the width of
* <code>image</code> or if code>newHeight</code> is larger
* than the height of <code>image</code> or if one of the
* dimensions is <= 0
*/
public static BufferedImage createThumbnailFast(BufferedImage image,
int newWidth, int newHeight) {
if (newWidth >= image.getWidth() || newHeight >= image.getHeight()) {
throw new IllegalArgumentException("newWidth and newHeight cannot"
+ " be greater than the image" + " dimensions");
} else if (newWidth <= 0 || newHeight <= 0) {
throw new IllegalArgumentException("newWidth and newHeight must"
+ " be greater than 0");
}
BufferedImage temp = createCompatibleImage(image, newWidth, newHeight);
Graphics2D g2 = temp.createGraphics();
g2.setRenderingHint(RenderingHints.KEY_INTERPOLATION,
RenderingHints.VALUE_INTERPOLATION_BILINEAR);
g2.drawImage(image, 0, 0, temp.getWidth(), temp.getHeight(), null);
g2.dispose();
return temp;
}
/**
* <p>
* Returns a thumbnail of a source image. <code>newSize</code> defines the
* length of the longest dimension of the thumbnail. The other dimension is
* then computed according to the dimensions ratio of the original picture.
* </p>
* <p>
* This method offers a good trade-off between speed and quality. The result
* looks better than
* {@link #createThumbnailFast(java.awt.image.BufferedImage, int)} when the
* new size is less than half the longest dimension of the source image, yet
* the rendering speed is almost similar.
* </p>
*
* @see #createThumbnailFast(java.awt.image.BufferedImage, int, int)
* @see #createThumbnailFast(java.awt.image.BufferedImage, int)
* @see #createThumbnail(java.awt.image.BufferedImage, int, int)
* @param image
* the source image
* @param newSize
* the length of the largest dimension of the thumbnail
* @return a new compatible <code>BufferedImage</code> containing a
* thumbnail of <code>image</code>
* @throws IllegalArgumentException
* if <code>newSize</code> is larger than the largest dimension
* of <code>image</code> or <= 0
*/
public static BufferedImage createThumbnail(BufferedImage image, int newSize) {
int width = image.getWidth();
int height = image.getHeight();
boolean isWidthGreater = width > height;
if (isWidthGreater) {
if (newSize >= width) {
throw new IllegalArgumentException("newSize must be lower than"
+ " the image width");
}
} else if (newSize >= height) {
throw new IllegalArgumentException("newSize must be lower than"
+ " the image height");
}
if (newSize <= 0) {
throw new IllegalArgumentException("newSize must" + " be greater than 0");
}
float ratioWH = (float) width / (float) height;
float ratioHW = (float) height / (float) width;
BufferedImage thumb = image;
do {
if (isWidthGreater) {
width /= 2;
if (width < newSize) {
width = newSize;
}
height = (int) (width / ratioWH);
} else {
height /= 2;
if (height < newSize) {
height = newSize;
}
width = (int) (height / ratioHW);
}
BufferedImage temp = createCompatibleImage(image, width, height);
Graphics2D g2 = temp.createGraphics();
g2.setRenderingHint(RenderingHints.KEY_INTERPOLATION,
RenderingHints.VALUE_INTERPOLATION_BILINEAR);
g2.drawImage(thumb, 0, 0, temp.getWidth(), temp.getHeight(), null);
g2.dispose();
thumb = temp;
} while (newSize != (isWidthGreater ? width : height));
return thumb;
}
/**
* <p>
* Returns a thumbnail of a source image.
* </p>
* <p>
* This method offers a good trade-off between speed and quality. The result
* looks better than
* {@link #createThumbnailFast(java.awt.image.BufferedImage, int)} when the
* new size is less than half the longest dimension of the source image, yet
* the rendering speed is almost similar.
* </p>
*
* @see #createThumbnailFast(java.awt.image.BufferedImage, int)
* @see #createThumbnailFast(java.awt.image.BufferedImage, int, int)
* @see #createThumbnail(java.awt.image.BufferedImage, int)
* @param image
* the source image
* @param newWidth
* the width of the thumbnail
* @param newHeight
* the height of the thumbnail
* @return a new compatible <code>BufferedImage</code> containing a
* thumbnail of <code>image</code>
* @throws IllegalArgumentException
* if <code>newWidth</code> is larger than the width of
* <code>image</code> or if code>newHeight</code> is larger
* than the height of <code>image or if one the dimensions is not
* > 0</code>
*/
public static BufferedImage createThumbnail(BufferedImage image,
int newWidth, int newHeight) {
int width = image.getWidth();
int height = image.getHeight();
if (newWidth >= width || newHeight >= height) {
throw new IllegalArgumentException("newWidth and newHeight cannot"
+ " be greater than the image" + " dimensions");
} else if (newWidth <= 0 || newHeight <= 0) {
throw new IllegalArgumentException("newWidth and newHeight must"
+ " be greater than 0");
}
BufferedImage thumb = image;
do {
if (width > newWidth) {
width /= 2;
if (width < newWidth) {
width = newWidth;
}
}
if (height > newHeight) {
height /= 2;
if (height < newHeight) {
height = newHeight;
}
}
BufferedImage temp = createCompatibleImage(image, width, height);
Graphics2D g2 = temp.createGraphics();
g2.setRenderingHint(RenderingHints.KEY_INTERPOLATION,
RenderingHints.VALUE_INTERPOLATION_BILINEAR);
g2.drawImage(thumb, 0, 0, temp.getWidth(), temp.getHeight(), null);
g2.dispose();
thumb = temp;
} while (width != newWidth || height != newHeight);
return thumb;
}
/**
* <p>
* Returns an array of pixels, stored as integers, from a
* <code>BufferedImage</code>. The pixels are grabbed from a rectangular
* area defined by a location and two dimensions. Calling this method on an
* image of type different from <code>BufferedImage.TYPE_INT_ARGB</code> and
* <code>BufferedImage.TYPE_INT_RGB</code> will unmanage the image.
* </p>
*
* @param img
* the source image
* @param x
* the x location at which to start grabbing pixels
* @param y
* the y location at which to start grabbing pixels
* @param w
* the width of the rectangle of pixels to grab
* @param h
* the height of the rectangle of pixels to grab
* @param pixels
* a pre-allocated array of pixels of size w*h; can be null
* @return <code>pixels</code> if non-null, a new array of integers
* otherwise
* @throws IllegalArgumentException
* is <code>pixels</code> is non-null and of length < w*h
*/
public static int[] getPixels(BufferedImage img, int x, int y, int w, int h,
int[] pixels) {
if (w == 0 || h == 0) {
return new int[0];
}
if (pixels == null) {
pixels = new int[w * h];
} else if (pixels.length < w * h) {
throw new IllegalArgumentException("pixels array must have a length"
+ " >= w*h");
}
int imageType = img.getType();
if (imageType == BufferedImage.TYPE_INT_ARGB
|| imageType == BufferedImage.TYPE_INT_RGB) {
Raster raster = img.getRaster();
return (int[]) raster.getDataElements(x, y, w, h, pixels);
}
// Unmanages the image
return img.getRGB(x, y, w, h, pixels, 0, w);
}
/**
* <p>
* Writes a rectangular area of pixels in the destination
* <code>BufferedImage</code>. Calling this method on an image of type
* different from <code>BufferedImage.TYPE_INT_ARGB</code> and
* <code>BufferedImage.TYPE_INT_RGB</code> will unmanage the image.
* </p>
*
* @param img
* the destination image
* @param x
* the x location at which to start storing pixels
* @param y
* the y location at which to start storing pixels
* @param w
* the width of the rectangle of pixels to store
* @param h
* the height of the rectangle of pixels to store
* @param pixels
* an array of pixels, stored as integers
* @throws IllegalArgumentException
* is <code>pixels</code> is non-null and of length < w*h
*/
public static void setPixels(BufferedImage img, int x, int y, int w, int h,
int[] pixels) {
if (pixels == null || w == 0 || h == 0) {
return;
} else if (pixels.length < w * h) {
throw new IllegalArgumentException("pixels array must have a length"
+ " >= w*h");
}
int imageType = img.getType();
if (imageType == BufferedImage.TYPE_INT_ARGB
|| imageType == BufferedImage.TYPE_INT_RGB) {
WritableRaster raster = img.getRaster();
raster.setDataElements(x, y, w, h, pixels);
} else {
// Unmanages the image
img.setRGB(x, y, w, h, pixels, 0, w);
}
}
}
Related examples in the same category
