Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2022 iText Group NV
Authors: Bruno Lowagie, Paulo Soares, et al.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License version 3
as published by the Free Software Foundation with the addition of the
following permission added to Section 15 as permitted in Section 7(a):
FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
OF THIRD PARTY RIGHTS
This program 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program; if not, see http://www.gnu.org/licenses or write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA, 02110-1301 USA, or download the license from the following URL:
http://itextpdf.com/terms-of-use/
The interactive user interfaces in modified source and object code versions
of this program must display Appropriate Legal Notices, as required under
Section 5 of the GNU Affero General Public License.
In accordance with Section 7(b) of the GNU Affero General Public License,
a covered work must retain the producer line in every PDF that is created
or manipulated using iText.
You can be released from the requirements of the license by purchasing
a commercial license. Buying such a license is mandatory as soon as you
develop commercial activities involving the iText software without
disclosing the source code of your own applications.
These activities include: offering paid services to customers as an ASP,
serving PDFs on the fly in a web application, shipping iText with a closed
source product.
For more information, please contact iText Software Corp. at this
address: [email protected]
*/
package com.itextpdf.kernel.pdf.xobject;
import com.itextpdf.io.logs.IoLogMessageConstant;
import com.itextpdf.io.colors.IccProfile;
import com.itextpdf.io.font.PdfEncodings;
import com.itextpdf.io.image.ImageData;
import com.itextpdf.io.image.ImageType;
import com.itextpdf.io.image.PngChromaticities;
import com.itextpdf.io.image.PngImageHelperConstants;
import com.itextpdf.io.image.PngImageData;
import com.itextpdf.io.image.RawImageData;
import com.itextpdf.io.image.RawImageHelper;
import com.itextpdf.kernel.exceptions.PdfException;
import com.itextpdf.kernel.exceptions.KernelExceptionMessageConstant;
import com.itextpdf.kernel.pdf.CompressionConstants;
import com.itextpdf.kernel.pdf.PdfArray;
import com.itextpdf.kernel.pdf.PdfBoolean;
import com.itextpdf.kernel.pdf.PdfDictionary;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfLiteral;
import com.itextpdf.kernel.pdf.PdfName;
import com.itextpdf.kernel.pdf.PdfNumber;
import com.itextpdf.kernel.pdf.PdfObject;
import com.itextpdf.kernel.pdf.PdfReader;
import com.itextpdf.kernel.pdf.PdfStream;
import com.itextpdf.kernel.pdf.PdfString;
import com.itextpdf.kernel.pdf.canvas.wmf.WmfImageData;
import com.itextpdf.kernel.pdf.colorspace.PdfCieBasedCs;
import com.itextpdf.kernel.pdf.colorspace.PdfColorSpace;
import com.itextpdf.kernel.pdf.colorspace.PdfSpecialCs;
import com.itextpdf.kernel.pdf.filters.DoNothingFilter;
import com.itextpdf.kernel.pdf.filters.FilterHandlers;
import com.itextpdf.kernel.pdf.filters.IFilterHandler;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import org.slf4j.LoggerFactory;
/**
* A wrapper for Image XObject. ISO 32000-1, 8.9 Images.
*/
public class PdfImageXObject extends PdfXObject {
private float width;
private float height;
private boolean mask;
private boolean softMask;
/**
* Creates Image XObject by image.
*
* @param image {@link ImageData} with actual image data.
*/
public PdfImageXObject(ImageData image) {
this(image, null);
}
/**
* Creates Image XObject by image.
*
* @param image {@link ImageData} with actual image data.
* @param imageMask {@link PdfImageXObject} with image mask.
*/
public PdfImageXObject(ImageData image, PdfImageXObject imageMask) {
this(createPdfStream(checkImageType(image), imageMask));
mask = image.isMask();
softMask = image.isSoftMask();
}
/**
* Create {@link PdfImageXObject} instance by {@link PdfStream}.
* Note, this constructor doesn't perform any additional checks
*
* @param pdfStream {@link PdfStream} with Image XObject.
* @see PdfXObject#makeXObject(PdfStream)
*/
public PdfImageXObject(PdfStream pdfStream) {
super(pdfStream);
if (!pdfStream.isFlushed()) {
initWidthField();
initHeightField();
}
}
/**
* Gets width of image, {@code Width} key.
*
* @return float value.
*/
@Override
public float getWidth() {
return width;
}
/**
* Gets height of image, {@code Height} key.
*
* @return float value.
*/
@Override
public float getHeight() {
return height;
}
/**
* To manually flush a {@code PdfObject} behind this wrapper, you have to ensure
* that this object is added to the document, i.e. it has an indirect reference.
* Basically this means that before flushing you need to explicitly call {@link #makeIndirect(PdfDocument)}.
* For example: wrapperInstance.makeIndirect(document).flush();
* Note, that not every wrapper require this, only those that have such warning in documentation.
*/
@Override
public void flush() {
super.flush();
}
/**
* Copy Image XObject to the specified document.
*
* @param document target document
* @return just created instance of {@link PdfImageXObject}.
*/
public PdfImageXObject copyTo(PdfDocument document) {
PdfImageXObject image = new PdfImageXObject((PdfStream) getPdfObject().copyTo(document));
image.mask = mask;
image.softMask = softMask;
return image;
}
/**
* Gets decoded image bytes.
*
* @return byte array.
*/
public byte[] getImageBytes() {
return getImageBytes(true);
}
/**
* Gets image bytes.
* Note, {@link PdfName#DCTDecode}, {@link PdfName#JBIG2Decode} and {@link PdfName#JPXDecode}
* filters will be ignored.
*
* @param decoded if {@code true}, decodes stream bytes.
* @return byte array.
*/
public byte[] getImageBytes(boolean decoded) {
// TODO: DEVSIX-1792 replace `.getBytes(false)` with `getBytes(true) and remove manual decoding
byte[] bytes = getPdfObject().getBytes(false);
if (decoded) {
Map filters = new HashMap<>(FilterHandlers.getDefaultFilterHandlers());
filters.put(PdfName.JBIG2Decode, new DoNothingFilter());
bytes = PdfReader.decodeBytes(bytes, getPdfObject(), filters);
ImageType imageType = identifyImageType();
if (imageType == ImageType.TIFF || imageType == ImageType.PNG) {
try {
bytes = new ImagePdfBytesInfo(this).decodeTiffAndPngBytes(bytes);
} catch (IOException e) {
throw new RuntimeException("IO exception in PdfImageXObject", e);
}
}
}
return bytes;
}
/**
* Identifies the type of the image that is stored in the bytes of this {@link PdfImageXObject}.
* Note that this has nothing to do with the original type of the image. For instance, the return value
* of this method will never be {@link ImageType#PNG} as we lose this information when converting a
* PNG image into something that can be put into a PDF file.
* The possible values are: {@link ImageType#JPEG}, {@link ImageType#JPEG2000}, {@link ImageType#JBIG2},
* {@link ImageType#TIFF}, {@link ImageType#PNG}
*
* @return the identified type of image
*/
public ImageType identifyImageType() {
PdfObject filter = getPdfObject().get(PdfName.Filter);
PdfArray filters = new PdfArray();
if (filter != null) {
if (filter.getType() == PdfObject.NAME) {
filters.add(filter);
} else if (filter.getType() == PdfObject.ARRAY) {
filters = ((PdfArray) filter);
}
}
for (int i = filters.size() - 1; i >= 0; i--) {
PdfName filterName = (PdfName) filters.get(i);
if (PdfName.DCTDecode.equals(filterName)) {
return ImageType.JPEG;
} else if (PdfName.JBIG2Decode.equals(filterName)) {
return ImageType.JBIG2;
} else if (PdfName.JPXDecode.equals(filterName)) {
return ImageType.JPEG2000;
}
}
// None of the previous types match
ImagePdfBytesInfo imageInfo = new ImagePdfBytesInfo(this);
if (imageInfo.getPngColorType() < 0) {
return ImageType.TIFF;
} else {
return ImageType.PNG;
}
}
/**
* Identifies recommended file extension to store the bytes of this {@link PdfImageXObject}.
* Possible values are: 'png', 'jpg', 'jp2', 'tif', 'jbig2'.
* This extension can later be used together with the result of {@link #getImageBytes()}.
*
* @return a {@link String} with recommended file extension
* @see #identifyImageType()
*/
public String identifyImageFileExtension() {
ImageType bytesType = identifyImageType();
switch (bytesType) {
case PNG:
return "png";
case JPEG:
return "jpg";
case JPEG2000:
return "jp2";
case TIFF:
return "tif";
case JBIG2:
return "jbig2";
default:
throw new IllegalStateException("Should have never happened. This type of image is not allowed for ImageXObject");
}
}
/**
* Puts the value into Image XObject dictionary and associates it with the specified key.
* If the key is already present, it will override the old value with the specified one.
*
* @param key key to insert or to override
* @param value the value to associate with the specified key
* @return object itself.
*/
public PdfImageXObject put(PdfName key, PdfObject value) {
getPdfObject().put(key, value);
return this;
}
private float initWidthField() {
PdfNumber wNum = getPdfObject().getAsNumber(PdfName.Width);
if (wNum != null) {
width = wNum.floatValue();
}
return width;
}
private float initHeightField() {
PdfNumber hNum = getPdfObject().getAsNumber(PdfName.Height);
if (hNum != null) {
height = hNum.floatValue();
}
return height;
}
private static PdfStream createPdfStream(ImageData image, PdfImageXObject imageMask) {
PdfStream stream;
if (image.getOriginalType() == ImageType.RAW) {
RawImageHelper.updateImageAttributes((RawImageData) image, null);
}
stream = new PdfStream(image.getData());
String filter = image.getFilter();
if (filter != null && "JPXDecode".equals(filter) && image.getColorEncodingComponentsNumber() <= 0) {
stream.setCompressionLevel(CompressionConstants.NO_COMPRESSION);
image.setBpc(0);
}
stream.put(PdfName.Type, PdfName.XObject);
stream.put(PdfName.Subtype, PdfName.Image);
PdfDictionary decodeParms = createDictionaryFromMap(stream, image.getDecodeParms());
if (decodeParms != null) {
stream.put(PdfName.DecodeParms, decodeParms);
}
if (!(image instanceof PngImageData)) {
PdfName colorSpace;
switch (image.getColorEncodingComponentsNumber()) {
case 1:
colorSpace = PdfName.DeviceGray;
break;
case 3:
colorSpace = PdfName.DeviceRGB;
break;
default:
colorSpace = PdfName.DeviceCMYK;
}
stream.put(PdfName.ColorSpace, colorSpace);
}
if (image.getBpc() != 0) {
stream.put(PdfName.BitsPerComponent, new PdfNumber(image.getBpc()));
}
if (image.getFilter() != null) {
stream.put(PdfName.Filter, new PdfName(image.getFilter()));
}
if (image.getColorEncodingComponentsNumber() == -1) {
stream.remove(PdfName.ColorSpace);
}
PdfDictionary additional = null;
if (image instanceof PngImageData) {
PngImageData pngImage = (PngImageData) image;
if (pngImage.isIndexed()) {
PdfArray colorspace = new PdfArray();
colorspace.add(PdfName.Indexed);
colorspace.add(getColorSpaceInfo(pngImage));
if ((pngImage.getColorPalette() != null) && (pngImage.getColorPalette().length > 0)) {
//Each palette entry is a three-byte series, so the number of entries is calculated as the length
//of the stream divided by 3. The number below specifies the maximum valid index value (starting from 0 up)
colorspace.add(new PdfNumber(pngImage.getColorPalette().length / 3 - 1));
}
if (pngImage.getColorPalette() != null) {
colorspace.add(new PdfString(PdfEncodings
.convertToString(pngImage.getColorPalette(), null)));
}
stream.put(PdfName.ColorSpace, colorspace);
} else {
stream.put(PdfName.ColorSpace, getColorSpaceInfo(pngImage));
}
}
additional = createDictionaryFromMap(stream, image.getImageAttributes());
if (additional != null) {
stream.putAll(additional);
}
IccProfile iccProfile = image.getProfile();
if (iccProfile != null) {
PdfStream iccProfileStream = PdfCieBasedCs.IccBased.getIccProfileStream(iccProfile);
PdfArray iccBasedColorSpace = new PdfArray();
iccBasedColorSpace.add(PdfName.ICCBased);
iccBasedColorSpace.add(iccProfileStream);
PdfObject colorSpaceObject = stream.get(PdfName.ColorSpace);
boolean iccProfileShouldBeApplied = true;
if (colorSpaceObject != null) {
PdfColorSpace cs = PdfColorSpace.makeColorSpace(colorSpaceObject);
if (cs == null) {
LoggerFactory.getLogger(PdfImageXObject.class)
.error(IoLogMessageConstant.IMAGE_HAS_INCORRECT_OR_UNSUPPORTED_COLOR_SPACE_OVERRIDDEN_BY_ICC_PROFILE);
} else if (cs instanceof PdfSpecialCs.Indexed) {
PdfColorSpace baseCs = ((PdfSpecialCs.Indexed) cs).getBaseCs();
if (baseCs == null) {
LoggerFactory.getLogger(PdfImageXObject.class)
.error(IoLogMessageConstant.IMAGE_HAS_INCORRECT_OR_UNSUPPORTED_BASE_COLOR_SPACE_IN_INDEXED_COLOR_SPACE_OVERRIDDEN_BY_ICC_PROFILE);
} else if (baseCs.getNumberOfComponents() != iccProfile.getNumComponents()) {
LoggerFactory.getLogger(PdfImageXObject.class)
.error(IoLogMessageConstant.IMAGE_HAS_ICC_PROFILE_WITH_INCOMPATIBLE_NUMBER_OF_COLOR_COMPONENTS_COMPARED_TO_BASE_COLOR_SPACE_IN_INDEXED_COLOR_SPACE);
iccProfileShouldBeApplied = false;
} else {
iccProfileStream.put(PdfName.Alternate, baseCs.getPdfObject());
}
if (iccProfileShouldBeApplied) {
((PdfArray) colorSpaceObject).set(1, iccBasedColorSpace);
iccProfileShouldBeApplied = false;
}
} else if (cs.getNumberOfComponents() != iccProfile.getNumComponents()) {
LoggerFactory.getLogger(PdfImageXObject.class)
.error(IoLogMessageConstant.IMAGE_HAS_ICC_PROFILE_WITH_INCOMPATIBLE_NUMBER_OF_COLOR_COMPONENTS_COMPARED_TO_COLOR_SPACE);
iccProfileShouldBeApplied = false;
} else {
iccProfileStream.put(PdfName.Alternate, colorSpaceObject);
}
}
if (iccProfileShouldBeApplied) {
stream.put(PdfName.ColorSpace, iccBasedColorSpace);
}
}
if (image.isMask() && (image.getBpc() == 1 || image.getBpc() > 0xff)) {
stream.put(PdfName.ImageMask, PdfBoolean.TRUE);
}
if (imageMask != null) {
if (imageMask.softMask) {
stream.put(PdfName.SMask, imageMask.getPdfObject());
} else if (imageMask.mask) {
stream.put(PdfName.Mask, imageMask.getPdfObject());
}
}
ImageData mask = image.getImageMask();
if (mask != null) {
if (mask.isSoftMask()) {
stream.put(PdfName.SMask, new PdfImageXObject(image.getImageMask()).getPdfObject());
} else if (mask.isMask()) {
stream.put(PdfName.Mask, new PdfImageXObject(image.getImageMask()).getPdfObject());
}
}
if (image.getDecode() != null) {
stream.put(PdfName.Decode, new PdfArray(image.getDecode()));
}
if (image.isMask() && image.isInverted()) {
stream.put(PdfName.Decode, new PdfArray(new float[] {1, 0}));
}
if (image.isInterpolation()) {
stream.put(PdfName.Interpolate, PdfBoolean.TRUE);
}
// deal with transparency
int[] transparency = image.getTransparency();
if (transparency != null && !image.isMask() && imageMask == null) {
PdfArray t = new PdfArray();
for (int transparencyItem : transparency) {
t.add(new PdfNumber(transparencyItem));
}
stream.put(PdfName.Mask, t);
}
stream.put(PdfName.Width, new PdfNumber(image.getWidth()));
stream.put(PdfName.Height, new PdfNumber(image.getHeight()));
return stream;
}
private static PdfDictionary createDictionaryFromMap(PdfStream stream, Map parms) {
if (parms != null) {
PdfDictionary dictionary = new PdfDictionary();
for (Map.Entry entry : parms.entrySet()) {
Object value = entry.getValue();
String key = entry.getKey();
if (value instanceof Integer) {
dictionary.put(new PdfName(key), new PdfNumber((int) value));
} else if (value instanceof Float) {
dictionary.put(new PdfName(key), new PdfNumber((float) value));
} else if (value instanceof String) {
if (value.equals(PngImageHelperConstants.MASK)) {
dictionary.put(PdfName.Mask, new PdfLiteral((String) value));
} else {
String str = (String) value;
if (str.indexOf('/') == 0) {
dictionary.put(new PdfName(key), new PdfName(str.substring(1)));
} else {
dictionary.put(new PdfName(key), new PdfString(str));
}
}
} else if (value instanceof byte[]) {
PdfStream globalsStream = new PdfStream();
globalsStream.getOutputStream().writeBytes((byte[]) value);
dictionary.put(PdfName.JBIG2Globals, globalsStream);
} else if (value instanceof Boolean) {
dictionary.put(new PdfName(key), PdfBoolean.valueOf((boolean) value));
} else if (value instanceof Object[]) {
dictionary.put(new PdfName(key), createArray(stream, (Object[]) value));
} else if (value instanceof float[]) {
dictionary.put(new PdfName(key), new PdfArray((float[]) value));
} else if (value instanceof int[]) {
dictionary.put(new PdfName(key), new PdfArray((int[]) value));
}
}
return dictionary;
}
return null;
}
private static PdfArray createArray(PdfStream stream, Object[] objects) {
PdfArray array = new PdfArray();
for (Object obj : objects) {
if (obj instanceof String) {
String str = (String) obj;
if (str.indexOf('/') == 0) {
array.add(new PdfName(str.substring(1)));
} else {
array.add(new PdfString(str));
}
} else if (obj instanceof Integer) {
array.add(new PdfNumber((int) obj));
} else if (obj instanceof Float) {
array.add(new PdfNumber((float) obj));
} else if (obj instanceof Object[]) {
array.add(createArray(stream, (Object[]) obj));
} else {
array.add(createDictionaryFromMap(stream, (Map) obj));
}
}
return array;
}
private static ImageData checkImageType(ImageData image) {
if (image instanceof WmfImageData) {
throw new PdfException(KernelExceptionMessageConstant.CANNOT_CREATE_PDF_IMAGE_XOBJECT_BY_WMF_IMAGE);
}
return image;
}
private static PdfObject getColorSpaceInfo(PngImageData pngImageData) {
if (pngImageData.getProfile() != null) {
if (pngImageData.isGrayscaleImage()) {
return PdfName.DeviceGray;
} else {
return PdfName.DeviceRGB;
}
}
if (pngImageData.getGamma() == 1f && !pngImageData.isHasCHRM()) {
if (pngImageData.isGrayscaleImage()) {
return PdfName.DeviceGray;
} else {
return PdfName.DeviceRGB;
}
} else {
PdfArray array = new PdfArray();
PdfDictionary map = new PdfDictionary();
if (pngImageData.isGrayscaleImage()) {
if (pngImageData.getGamma() == 1f) {
return PdfName.DeviceGray;
}
array.add(PdfName.CalGray);
map.put(PdfName.Gamma, new PdfNumber(pngImageData.getGamma()));
map.put(PdfName.WhitePoint, new PdfArray(new int[] {1, 1, 1}));
} else {
float[] wp = new float[] {1, 1, 1};
array.add(PdfName.CalRGB);
float gamma = pngImageData.getGamma();
if (gamma != 1f) {
float[] gm = new float[3];
gm[0] = gamma;
gm[1] = gamma;
gm[2] = gamma;
map.put(PdfName.Gamma, new PdfArray(gm));
}
if (pngImageData.isHasCHRM()) {
PngChromaticitiesHelper helper = new PngChromaticitiesHelper();
helper.constructMatrix(pngImageData);
wp = helper.wp;
map.put(PdfName.Matrix, new PdfArray(helper.matrix));
}
map.put(PdfName.WhitePoint, new PdfArray(wp));
}
array.add(map);
return array;
}
}
private static class PngChromaticitiesHelper {
float[] matrix = new float[9];
float[] wp = new float[3];
public void constructMatrix(PngImageData pngImageData) {
PngChromaticities pngChromaticities = pngImageData.getPngChromaticities();
float z = pngChromaticities.getYW() *
((pngChromaticities.getXG() - pngChromaticities.getXB()) * pngChromaticities.getYR() -
(pngChromaticities.getXR() - pngChromaticities.getXB()) * pngChromaticities.getYG() +
(pngChromaticities.getXR() - pngChromaticities.getXG()) * pngChromaticities.getYB());
float YA = pngChromaticities.getYR() *
((pngChromaticities.getXG() - pngChromaticities.getXB()) * pngChromaticities.getYW() -
(pngChromaticities.getXW() - pngChromaticities.getXB()) * pngChromaticities.getYG() +
(pngChromaticities.getXW() - pngChromaticities.getXG()) * pngChromaticities.getYB()) / z;
float XA = YA * pngChromaticities.getXR() / pngChromaticities.getYR();
float ZA = YA * ((1 - pngChromaticities.getXR()) / pngChromaticities.getYR() - 1);
float YB = -pngChromaticities.getYG() *
((pngChromaticities.getXR() - pngChromaticities.getXB()) * pngChromaticities.getYW() -
(pngChromaticities.getXW() - pngChromaticities.getXB()) * pngChromaticities.getYR() +
(pngChromaticities.getXW() - pngChromaticities.getXR()) * pngChromaticities.getYB()) / z;
float XB = YB * pngChromaticities.getXG() / pngChromaticities.getYG();
float ZB = YB * ((1 - pngChromaticities.getXG()) / pngChromaticities.getYG() - 1);
float YC = pngChromaticities.getYB() *
((pngChromaticities.getXR() - pngChromaticities.getXG()) * pngChromaticities.getYW() -
(pngChromaticities.getXW() - pngChromaticities.getXG()) * pngChromaticities.getYW() +
(pngChromaticities.getXW() - pngChromaticities.getXR()) * pngChromaticities.getYG()) / z;
float XC = YC * pngChromaticities.getXB() / pngChromaticities.getYB();
float ZC = YC * ((1 - pngChromaticities.getXB()) / pngChromaticities.getYB() - 1);
float XW = XA + XB + XC;
float YW = 1;
float ZW = ZA + ZB + ZC;
float[] wpa = new float[3];
wpa[0] = XW;
wpa[1] = YW;
wpa[2] = ZW;
this.wp = Arrays.copyOf(wpa, 3);
float[] matrix = new float[9];
matrix[0] = XA;
matrix[1] = YA;
matrix[2] = ZA;
matrix[3] = XB;
matrix[4] = YB;
matrix[5] = ZB;
matrix[6] = XC;
matrix[7] = YC;
matrix[8] = ZC;
this.matrix = Arrays.copyOf(matrix, 9);
}
}
}
