/*
* Copyright 2014 The Apache Software Foundation.
*
* Licensed 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 org.apache.pdfbox.pdmodel.graphics.xobject;
import java.awt.Color;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.GraphicsConfiguration;
import java.awt.Transparency;
import java.awt.geom.AffineTransform;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.Random;
import javax.imageio.ImageIO;
import static junit.framework.Assert.assertTrue;
import junit.framework.TestCase;
import org.apache.pdfbox.exceptions.COSVisitorException;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.edit.PDPageContentStream;
import org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray;
import org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB;
import static org.apache.pdfbox.pdmodel.graphics.xobject.PDUtils.colorCount;
import org.apache.pdfbox.util.ImageIOUtil;
/**
*
* @author Tilman Hausherr
*/
public class PDPixelMapTest extends TestCase
{
private final File testResultsDir = new File("target/test-output/graphics");
@Override
protected void setUp() throws Exception
{
super.setUp();
testResultsDir.mkdirs();
}
/**
* Tests RGB PDPixelMapTest() with color, gray and bitonal image
*
* @throws java.io.IOException
*/
public void testCreateLosslessFromImageRGB() throws IOException
{
PDDocument document = new PDDocument();
BufferedImage image = ImageIO.read(this.getClass().getResourceAsStream("png.png"));
PDXObjectImage ximage = new PDPixelMap(document, image);
validate(ximage, 8, image.getWidth(), image.getHeight(), "png", PDDeviceRGB.NAME);
checkIdent(image, ximage.getRGBImage());
assertNull(ximage.getSMaskImage());
// Create a grayscale image
BufferedImage grayImage = new BufferedImage(image.getWidth(), image.getHeight(), BufferedImage.TYPE_BYTE_GRAY);
Graphics g = grayImage.getGraphics();
g.drawImage(image, 0, 0, null);
g.dispose();
ximage = new PDPixelMap(document, grayImage);
validate(ximage, 8, grayImage.getWidth(), grayImage.getHeight(), "png", PDDeviceGray.NAME);
checkIdent(grayImage, ximage.getRGBImage());
assertNull(ximage.getSMaskImage());
// Create a bitonal image
BufferedImage bitonalImage = new BufferedImage(image.getWidth(), image.getHeight(), BufferedImage.TYPE_BYTE_BINARY);
g = bitonalImage.getGraphics();
g.drawImage(image, 0, 0, null);
g.dispose();
ximage = new PDPixelMap(document, bitonalImage);
checkIdent(bitonalImage, ximage.getRGBImage());
validate(ximage, 1, bitonalImage.getWidth(), bitonalImage.getHeight(), "png", PDDeviceGray.NAME);
assertNull(ximage.getSMaskImage());
document.close();
}
public void testCreateLosslessFromImageGray() throws IOException
{
PDDocument document = new PDDocument();
BufferedImage image = new BufferedImage(256, 256, BufferedImage.TYPE_BYTE_GRAY);
int w = image.getWidth();
int h = image.getHeight();
for (int x = 0; x < w; ++x)
{
for (int y = 0; y < h; ++y)
{
int color = ((x + y) / 2) & 0xFF;
color += (color << 8) + (color << 16);
image.setRGB(x, y, color);
}
}
PDXObjectImage ximage = new PDPixelMap(document, image);
validate(ximage, 8, w, h, "png", PDDeviceGray.NAME);
checkIdent(image, ximage.getRGBImage());
assertNull(ximage.getSMaskImage());
document.close();
}
/**
* Tests RGB PDPixelMapTest() with image from a bitonal GIF
*
* @throws java.io.IOException
*/
public void testCreateLosslessFromBitonalGIF() throws IOException
{
PDDocument document = new PDDocument();
BufferedImage imageFromBitonalGif = ImageIO.read(this.getClass().getResourceAsStream("bitonal.gif"));
PDXObjectImage ximage = new PDPixelMap(document, imageFromBitonalGif);
checkIdent(imageFromBitonalGif, ximage.getRGBImage());
validate(ximage, 1, imageFromBitonalGif.getWidth(), imageFromBitonalGif.getHeight(), "png", PDDeviceGray.NAME);
assertNull(ximage.getSMaskImage());
document.close();
}
/**
* Tests RGB PDPixelMapTest() with TYPE_4BYTE_ABGR image.
*
* @throws java.io.IOException
* @throws org.apache.pdfbox.exceptions.COSVisitorException
*/
public void testCreateLossless4BYTE_ABGR() throws IOException, COSVisitorException
{
PDDocument document = new PDDocument();
BufferedImage awtImage = createInterestingImage(BufferedImage.TYPE_4BYTE_ABGR);
for (int x = 0; x < awtImage.getWidth(); ++x)
{
for (int y = 0; y < awtImage.getHeight(); ++y)
{
awtImage.setRGB(x, y, (awtImage.getRGB(x, y) & 0xFFFFFF) | ((y / 10 * 10) << 24));
}
}
PDPixelMap ximage = new PDPixelMap(document, awtImage);
validate(ximage, 8, awtImage.getWidth(), awtImage.getHeight(), "png", PDDeviceRGB.NAME);
checkIdent(awtImage, ximage.getRGBImage());
validate(ximage.getSMaskImage(), 8, awtImage.getWidth(), awtImage.getHeight(), "png", PDDeviceGray.NAME);
assertTrue(colorCount(ximage.getSMaskImage().getRGBImage()) > awtImage.getHeight() / 10);
// This part isn't really needed because this test doesn't break
// if the mask has the wrong colorspace (PDFBOX-2057), but it is still useful
// if something goes wrong in the future and we want to have a PDF to open.
PDPage page = new PDPage();
document.addPage(page);
PDPageContentStream contentStream = new PDPageContentStream(document, page, true, false);
contentStream.drawXObject(ximage, 150, 300, ximage.getWidth(), ximage.getHeight());
contentStream.drawXObject(ximage, 200, 350, ximage.getWidth(), ximage.getHeight());
contentStream.close();
File pdfFile = new File(testResultsDir, "4babgr.pdf");
document.save(pdfFile);
document.close();
document = PDDocument.loadNonSeq(pdfFile, null);
List<PDPage> pdPages = document.getDocumentCatalog().getAllPages();
pdPages.get(0).convertToImage();
document.close();
}
/**
* Tests RGB PDPixelMapTest() with TYPE_INT_ARGB image.
*
* @throws java.io.IOException
* @throws org.apache.pdfbox.exceptions.COSVisitorException
*/
public void testCreateLosslessINT_ARGB() throws IOException, COSVisitorException
{
PDDocument document = new PDDocument();
BufferedImage awtImage = createInterestingImage(BufferedImage.TYPE_INT_ARGB);
for (int x = 0; x < awtImage.getWidth(); ++x)
{
for (int y = 0; y < awtImage.getHeight(); ++y)
{
awtImage.setRGB(x, y, (awtImage.getRGB(x, y) & 0xFFFFFF) | ((y / 10 * 10) << 24));
}
}
PDPixelMap ximage = new PDPixelMap(document, awtImage);
validate(ximage, 8, awtImage.getWidth(), awtImage.getHeight(), "png", PDDeviceRGB.NAME);
checkIdent(awtImage, ximage.getRGBImage());
validate(ximage.getSMaskImage(), 8, awtImage.getWidth(), awtImage.getHeight(), "png", PDDeviceGray.NAME);
assertTrue(colorCount(ximage.getSMaskImage().getRGBImage()) > awtImage.getHeight() / 10);
// This part isn't really needed because this test doesn't break
// if the mask has the wrong colorspace (PDFBOX-2057), but it is still useful
// if something goes wrong in the future and we want to have a PDF to open.
PDPage page = new PDPage();
document.addPage(page);
PDPageContentStream contentStream = new PDPageContentStream(document, page, true, false);
contentStream.drawXObject(ximage, 150, 300, ximage.getWidth(), ximage.getHeight());
contentStream.drawXObject(ximage, 200, 350, ximage.getWidth(), ximage.getHeight());
contentStream.close();
File pdfFile = new File(testResultsDir, "intargb.pdf");
document.save(pdfFile);
document.close();
document = PDDocument.loadNonSeq(pdfFile, null);
List<PDPage> pdPages = document.getDocumentCatalog().getAllPages();
pdPages.get(0).convertToImage();
document.close();
}
/**
* Tests RGB PDPixelMapTest() with TYPE_INT_RGB image.
*
* @throws java.io.IOException
* @throws org.apache.pdfbox.exceptions.COSVisitorException
*/
public void testCreateLosslessINT_RGB() throws IOException, COSVisitorException
{
PDDocument document = new PDDocument();
BufferedImage awtImage = createInterestingImage(BufferedImage.TYPE_INT_RGB);
PDPixelMap ximage = new PDPixelMap(document, awtImage);
validate(ximage, 8, awtImage.getWidth(), awtImage.getHeight(), "png", PDDeviceRGB.NAME);
checkIdent(awtImage, ximage.getRGBImage());
assertNull(ximage.getSMaskImage());
// This part isn't really needed because this test doesn't break
// if the mask has the wrong colorspace (PDFBOX-2057), but it is still useful
// if something goes wrong in the future and we want to have a PDF to open.
PDPage page = new PDPage();
document.addPage(page);
PDPageContentStream contentStream = new PDPageContentStream(document, page, true, false);
contentStream.drawXObject(ximage, 150, 300, ximage.getWidth(), ximage.getHeight());
contentStream.drawXObject(ximage, 200, 350, ximage.getWidth(), ximage.getHeight());
// Example to use rotation, also posted to
// http://stackoverflow.com/a/23876858/535646
AffineTransform at = new AffineTransform(ximage.getWidth() / 4, 0, 0, ximage.getHeight() / 4, 100, 600);
at.rotate(Math.toRadians(10));
contentStream.drawXObject(ximage, at);
contentStream.close();
File pdfFile = new File(testResultsDir, "intrgb.pdf");
document.save(pdfFile);
document.close();
document = PDDocument.loadNonSeq(pdfFile, null);
List<PDPage> pdPages = document.getDocumentCatalog().getAllPages();
pdPages.get(0).convertToImage();
document.close();
}
/**
* Tests RGB PDPixelMapTest() with TYPE_INT_BGR image.
*
* @throws java.io.IOException
* @throws org.apache.pdfbox.exceptions.COSVisitorException
*/
public void testCreateLosslessINT_BGR() throws IOException, COSVisitorException
{
PDDocument document = new PDDocument();
BufferedImage awtImage = createInterestingImage(BufferedImage.TYPE_INT_BGR);
PDPixelMap ximage = new PDPixelMap(document, awtImage);
validate(ximage, 8, awtImage.getWidth(), awtImage.getHeight(), "png", PDDeviceRGB.NAME);
checkIdent(awtImage, ximage.getRGBImage());
assertNull(ximage.getSMaskImage());
// This part isn't really needed because this test doesn't break
// if the mask has the wrong colorspace (PDFBOX-2057), but it is still useful
// if something goes wrong in the future and we want to have a PDF to open.
PDPage page = new PDPage();
document.addPage(page);
PDPageContentStream contentStream = new PDPageContentStream(document, page, true, false);
contentStream.drawXObject(ximage, 150, 300, ximage.getWidth(), ximage.getHeight());
contentStream.drawXObject(ximage, 200, 350, ximage.getWidth(), ximage.getHeight());
contentStream.close();
File pdfFile = new File(testResultsDir, "intbgr.pdf");
document.save(pdfFile);
document.close();
document = PDDocument.loadNonSeq(pdfFile, null);
List<PDPage> pdPages = document.getDocumentCatalog().getAllPages();
pdPages.get(0).convertToImage();
document.close();
}
/**
* Tests RGB PDPixelMapTest() with image from a color GIF
*
* @throws java.io.IOException
*/
public void testCreateLosslessFromColorGIF() throws IOException
{
PDDocument document = new PDDocument();
BufferedImage imageFromColorGif = ImageIO.read(this.getClass().getResourceAsStream("color.gif"));
PDXObjectImage ximage = new PDPixelMap(document, imageFromColorGif);
checkIdent(imageFromColorGif, ximage.getRGBImage());
validate(ximage, 8, 344, 287, "png", PDDeviceRGB.NAME);
assertNull(ximage.getSMaskImage());
document.close();
}
/**
* Tests INT_ARGB LosslessFactoryTest#createFromImage(PDDocument document,
* BufferedImage image) with BITMASK transparency
*
* @throws java.io.IOException
*/
public void testCreateLosslessFromImageBITMASK_INT_ARGB() throws IOException, COSVisitorException
{
doBitmaskTransparencyTest(BufferedImage.TYPE_INT_ARGB, "bitmaskintargb.pdf");
}
/**
* Tests 4BYTE_ABGR LosslessFactoryTest#createFromImage(PDDocument document,
* BufferedImage image) with BITMASK transparency
*
* @throws java.io.IOException
*/
public void testCreateLosslessFromImageBITMASK4BYTE_ABGR() throws IOException, COSVisitorException
{
doBitmaskTransparencyTest(BufferedImage.TYPE_INT_ARGB, "bitmask4babgr.pdf");
}
private void doBitmaskTransparencyTest(int imageType, String pdfFilename) throws IOException, COSVisitorException
{
PDDocument document = new PDDocument();
int width = 256;
int height = 256;
// create an ARGB image
BufferedImage argbImage = new BufferedImage(width, height, imageType);
// from there, create an image with Transparency.BITMASK
Graphics2D g = argbImage.createGraphics();
GraphicsConfiguration gc = g.getDeviceConfiguration();
argbImage = gc.createCompatibleImage(width, height, Transparency.BITMASK);
g.dispose();
// create a red rectangle
g = argbImage.createGraphics();
g.setColor(Color.red);
g.fillRect(0, 0, width, height);
g.dispose();
Random random = new Random();
random.setSeed(12345);
// create a transparency cross: only pixels in the
// interval max/2 - max/8 ... max/2 + max/8 will be visible
int startX = width / 2 - width / 8;
int endX = width / 2 + width / 8;
int startY = height / 2 - height / 8;
int endY = height / 2 + height / 8;
for (int x = 0; x < width; ++x)
{
for (int y = 0; y < height; ++y)
{
// create pseudorandom alpha values, but those within the cross
// must be >= 128 and those outside must be < 128
int alpha;
if ((x >= startX && x <= endX) || y >= startY && y <= endY)
{
alpha = 128 + (int) (random.nextFloat() * 127);
assertTrue(alpha >= 128);
argbImage.setRGB(x, y, (argbImage.getRGB(x, y) & 0xFFFFFF) | (alpha << 24));
assertEquals(255, argbImage.getRGB(x, y) >>> 24);
}
else
{
alpha = (int) (random.nextFloat() * 127);
assertTrue(alpha < 128);
argbImage.setRGB(x, y, (argbImage.getRGB(x, y) & 0xFFFFFF) | (alpha << 24));
assertEquals(0, argbImage.getRGB(x, y) >>> 24);
}
}
}
PDXObjectImage ximage = new PDPixelMap(document, argbImage);
validate(ximage, 8, width, height, "png", PDDeviceRGB.INSTANCE.getName());
checkIdent(argbImage, ximage.getRGBImage());
assertNotNull(ximage.getSMaskImage());
validate(ximage.getSMaskImage(), 1, width, height, "png", PDDeviceGray.NAME);
assertEquals(2, colorCount(ximage.getSMaskImage().getRGBImage()));
// check whether the mask is a b/w cross
BufferedImage maskImage = ximage.getSMaskImage().getRGBImage();
// returns Transparency.BITMASK in 1.8
//assertEquals(Transparency.OPAQUE, maskImage.getTransparency());
for (int x = 0; x < width; ++x)
{
for (int y = 0; y < height; ++y)
{
if ((x >= startX && x <= endX) || y >= startY && y <= endY)
{
assertEquals(0xFFFFFF, maskImage.getRGB(x, y) & 0xFFFFFF);
}
else
{
assertEquals(0, maskImage.getRGB(x, y) & 0xFFFFFF);
}
}
}
// This part isn't really needed because this test doesn't break
// if the mask has the wrong colorspace (PDFBOX-2057), but it is still useful
// if something goes wrong in the future and we want to have a PDF to open.
// Create a rectangle
BufferedImage rectImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
g = rectImage.createGraphics();
g.setColor(Color.blue);
g.fillRect(0, 0, width, height);
g.dispose();
PDXObjectImage ximage2 = new PDPixelMap(document, rectImage);
PDPage page = new PDPage();
document.addPage(page);
PDPageContentStream contentStream = new PDPageContentStream(document, page, true, false);
contentStream.drawXObject(ximage2, 150, 300, ximage2.getWidth(), ximage2.getHeight());
contentStream.drawXObject(ximage, 150, 300, ximage.getWidth(), ximage.getHeight());
contentStream.drawXObject(ximage.getSMaskImage(), 150, 0, ximage.getSMaskImage().getWidth(), ximage.getSMaskImage().getHeight());
contentStream.close();
File pdfFile = new File(testResultsDir, pdfFilename);
document.save(pdfFile);
document.close();
document = PDDocument.loadNonSeq(pdfFile, null);
List<PDPage> pdPages = document.getDocumentCatalog().getAllPages();
pdPages.get(0).convertToImage();
document.close();
}
static public void validate(PDXObjectImage ximage, int bpc, int width, int height, String format, String colorSpaceName) throws IOException
{
// check the dictionary
assertNotNull(ximage);
assertNotNull(ximage.getCOSStream());
assertTrue(ximage.getCOSStream().getFilteredLength() > 0);
assertEquals(bpc, ximage.getBitsPerComponent());
assertEquals(width, ximage.getWidth());
assertEquals(height, ximage.getHeight());
assertEquals(format, ximage.getSuffix());
assertEquals(colorSpaceName, ximage.getColorSpace().getName());
// check the image
assertNotNull(ximage.getRGBImage());
assertEquals(ximage.getWidth(), ximage.getRGBImage().getWidth());
assertEquals(ximage.getHeight(), ximage.getRGBImage().getHeight());
boolean writeOk = ImageIOUtil.writeImage(ximage.getRGBImage(), format, new NullOutputStream());
assertTrue(writeOk);
}
/**
* Check whether images are identical.
*
* @param expectedImage
* @param actualImage
*/
private void checkIdent(BufferedImage expectedImage, BufferedImage actualImage)
{
String errMsg = "";
int w = expectedImage.getWidth();
int h = expectedImage.getHeight();
for (int y = 0; y < h; ++y)
{
for (int x = 0; x < w; ++x)
{
if ((expectedImage.getRGB(x, y) & 0xFFFFFF) != (actualImage.getRGB(x, y) & 0xFFFFFF))
{
errMsg = String.format("(%d,%d) %X != %X", x, y, expectedImage.getRGB(x, y) & 0xFFFFFF, actualImage.getRGB(x, y) & 0xFFFFFF);
}
assertEquals(errMsg, expectedImage.getRGB(x, y) & 0xFFFFFF, actualImage.getRGB(x, y) & 0xFFFFFF);
}
}
}
private BufferedImage createInterestingImage(int type)
{
BufferedImage awtImage = new BufferedImage(256, 256, type);
Graphics g = awtImage.getGraphics();
g.setColor(Color.blue);
g.fillRect(0, 0, awtImage.getWidth() / 3, awtImage.getHeight() - 1);
g.setColor(Color.white);
g.fillRect(awtImage.getWidth() / 3, 0, awtImage.getWidth() / 3, awtImage.getHeight() - 1);
g.setColor(Color.red);
g.fillRect(awtImage.getWidth() / 3 * 2, 0, awtImage.getWidth() / 3, awtImage.getHeight() - 1);
g.setColor(Color.black);
g.drawRect(0, 0, awtImage.getWidth() - 1, awtImage.getHeight() - 1);
g.dispose();
return awtImage;
}
}