From 12f7ad82bde7dafbffa9711e9f39b2ae8815fd05 Mon Sep 17 00:00:00 2001 From: "valery.bokov" Date: Sat, 29 Aug 2026 18:58:37 +0200 Subject: [PATCH] fix swapped error messages in CCITTFactory.extractFromTiff method. See: TIFFExtension.GROUP3OPT_UNCOMPRESSED, TIFFExtension.GROUP3OPT_FILLBITS) --- .../pdmodel/graphics/image/CCITTFactory.java | 1040 ++++++++--------- 1 file changed, 520 insertions(+), 520 deletions(-) diff --git a/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/CCITTFactory.java b/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/CCITTFactory.java index e25d667af3c..9ea301f2ac2 100644 --- a/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/CCITTFactory.java +++ b/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/CCITTFactory.java @@ -1,520 +1,520 @@ -/* - * Licensed to the Apache Software Foundation (ASF) 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 org.apache.pdfbox.pdmodel.graphics.image; - -import java.awt.image.BufferedImage; -import java.io.ByteArrayInputStream; -import java.io.ByteArrayOutputStream; -import java.io.File; -import java.io.IOException; -import java.io.OutputStream; -import javax.imageio.stream.MemoryCacheImageOutputStream; -import org.apache.pdfbox.cos.COSDictionary; -import org.apache.pdfbox.cos.COSName; -import org.apache.pdfbox.filter.Filter; -import org.apache.pdfbox.filter.FilterFactory; -import org.apache.pdfbox.io.RandomAccessReadBuffer; -import org.apache.pdfbox.io.RandomAccessReadBufferedFile; -import org.apache.pdfbox.io.RandomAccessRead; -import org.apache.pdfbox.pdmodel.PDDocument; -import org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace; -import org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray; - -/** - * Factory for creating a PDImageXObject containing a CCITT Fax compressed TIFF image. - * - * @author Ben Litchfield - * @author Paul King - */ -public final class CCITTFactory -{ - private CCITTFactory() - { - } - - /** - * Creates a new CCITT group 4 (T6) compressed image XObject from a b/w BufferedImage. This - * compression technique usually results in smaller images than those produced by {@link LosslessFactory#createFromImage(PDDocument, BufferedImage) - * }. - * - * @param document the document to create the image as part of. - * @param image the image. - * @return a new image XObject. - * @throws IOException if there is an error creating the image. - * @throws IllegalArgumentException if the BufferedImage is not a b/w image. - */ - public static PDImageXObject createFromImage(PDDocument document, BufferedImage image) - throws IOException - { - if (image.getType() != BufferedImage.TYPE_BYTE_BINARY && image.getColorModel().getPixelSize() != 1) - { - throw new IllegalArgumentException("Only 1-bit b/w images supported"); - } - - int height = image.getHeight(); - int width = image.getWidth(); - - ByteArrayOutputStream bos = new ByteArrayOutputStream(Math.max(32, (width + 1) * height)); - try (MemoryCacheImageOutputStream mcios = new MemoryCacheImageOutputStream(bos)) - { - for (int y = 0; y < height; ++y) - { - for (int x = 0; x < width; ++x) - { - // flip bit to avoid having to set /BlackIs1 - mcios.writeBits(~(image.getRGB(x, y) & 1), 1); - } - int bitOffset = mcios.getBitOffset(); - if (bitOffset != 0) - { - mcios.writeBits(0, 8 - bitOffset); - } - } - mcios.flush(); - } - - return prepareImageXObject(document, bos.toByteArray(), width, height, PDDeviceGray.INSTANCE); - } - - /** - * Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored - * in a byte array. Only single-strip CCITT T4 or T6 compressed TIFF files are supported. If - * you're not sure what TIFF files you have, use - * {@link LosslessFactory#createFromImage(PDDocument, BufferedImage) } - * or {@link CCITTFactory#createFromImage(PDDocument, BufferedImage) } - * instead. - * - * @param document the document to create the image as part of. - * @param byteArray the TIFF file in a byte array which contains a suitable CCITT compressed - * image - * @return a new Image XObject - * @throws IOException if there is an error reading the TIFF data. - */ - public static PDImageXObject createFromByteArray(PDDocument document, byte[] byteArray) - throws IOException - { - return createFromByteArray(document, byteArray, 0); - } - - /** - * Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored - * in a byte array. Only single-strip CCITT T4 or T6 compressed TIFF files are supported. If - * you're not sure what TIFF files you have, use - * {@link LosslessFactory#createFromImage(PDDocument, BufferedImage) } - * or {@link CCITTFactory#createFromImage(PDDocument, BufferedImage) } - * instead. - * - * @param document the document to create the image as part of. - * @param byteArray the TIFF file in a byte array which contains a suitable CCITT compressed - * image - * @param number TIFF image number, starting from 0 - * @return a new Image XObject - * @throws IOException if there is an error reading the TIFF data. - */ - public static PDImageXObject createFromByteArray(PDDocument document, byte[] byteArray, int number) - throws IOException - { - try (RandomAccessRead raf = new RandomAccessReadBuffer(byteArray)) - { - return createFromRandomAccessImpl(document, raf, number); - } - } - - private static PDImageXObject prepareImageXObject(PDDocument document, - byte[] byteArray, int width, int height, - PDColorSpace initColorSpace) throws IOException - { - ByteArrayOutputStream baos = new ByteArrayOutputStream(); - - Filter filter = FilterFactory.INSTANCE.getFilter(COSName.CCITTFAX_DECODE); - COSDictionary dict = new COSDictionary(); - dict.setInt(COSName.COLUMNS, width); - dict.setInt(COSName.ROWS, height); - filter.encode(new ByteArrayInputStream(byteArray), baos, dict, 0); - - ByteArrayInputStream encodedByteStream = new ByteArrayInputStream(baos.toByteArray()); - PDImageXObject image = new PDImageXObject(document, encodedByteStream, COSName.CCITTFAX_DECODE, - width, height, 1, initColorSpace); - dict.setInt(COSName.K, -1); - image.getCOSObject().setItem(COSName.DECODE_PARMS, dict); - return image; - } - - /** - * Creates a new CCITT Fax compressed image XObject from the first image of a TIFF file. Only - * single-strip CCITT T4 or T6 compressed TIFF files are supported. If you're not sure what TIFF - * files you have, use - * {@link LosslessFactory#createFromImage(org.apache.pdfbox.pdmodel.PDDocument, java.awt.image.BufferedImage)} - * or {@link CCITTFactory#createFromImage(PDDocument, BufferedImage) } - * instead. - * - * @param document the document to create the image as part of. - * @param file the TIFF file which contains a suitable CCITT compressed image - * @return a new Image XObject - * @throws IOException if there is an error reading the TIFF data. - */ - public static PDImageXObject createFromFile(PDDocument document, File file) - throws IOException - { - return createFromFile(document, file, 0); - } - - /** - * Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file. Only - * single-strip CCITT T4 or T6 compressed TIFF files are supported. If you're not sure what TIFF - * files you have, use - * {@link LosslessFactory#createFromImage(PDDocument, BufferedImage) } - * or {@link CCITTFactory#createFromImage(PDDocument, BufferedImage) } - * instead. - * - * @param document the document to create the image as part of. - * @param file the TIFF file which contains a suitable CCITT compressed image - * @param number TIFF image number, starting from 0 - * @return a new Image XObject - * @throws IOException if there is an error reading the TIFF data. - */ - public static PDImageXObject createFromFile(PDDocument document, File file, int number) - throws IOException - { - try (RandomAccessRead raf = new RandomAccessReadBufferedFile(file)) - { - return createFromRandomAccessImpl(document, raf, number); - } - } - - /** - * Creates a new CCITT Fax compressed image XObject from a TIFF file. - * - * @param document the document to create the image as part of. - * @param reader the random access TIFF file which contains a suitable CCITT - * compressed image - * @param number TIFF image number, starting from 0 - * @return a new Image XObject, or null if no such page - * @throws IOException if there is an error reading the TIFF data. - */ - private static PDImageXObject createFromRandomAccessImpl(PDDocument document, - RandomAccessRead reader, - int number) throws IOException - { - COSDictionary decodeParms = new COSDictionary(); - ByteArrayOutputStream bos = new ByteArrayOutputStream(); - extractFromTiff(reader, bos, decodeParms, number); - if (bos.size() == 0) - { - return null; - } - ByteArrayInputStream encodedByteStream = new ByteArrayInputStream(bos.toByteArray()); - PDImageXObject pdImage = new PDImageXObject(document, - encodedByteStream, - COSName.CCITTFAX_DECODE, - decodeParms.getInt(COSName.COLUMNS), - decodeParms.getInt(COSName.ROWS), - 1, - PDDeviceGray.INSTANCE); - - COSDictionary dict = pdImage.getCOSObject(); - dict.setItem(COSName.DECODE_PARMS, decodeParms); - return pdImage; - } - - // extracts the CCITT stream from the TIFF file - private static void extractFromTiff(RandomAccessRead reader, - OutputStream os, - COSDictionary params, int number) throws IOException - { - // First check the basic tiff header - reader.seek(0); - char endianess = (char) reader.read(); - if ((char) reader.read() != endianess) - { - throw new IOException("Not a valid tiff file"); - } - // ensure that endianess is either M or I - if (endianess != 'M' && endianess != 'I') - { - throw new IOException("Not a valid tiff file"); - } - int magicNumber = readshort(endianess, reader); - if (magicNumber != 42) - { - throw new IOException("Not a valid tiff file"); - - // 43 is bigtiff. If we need to support this in the future, look here: - // https://web.archive.org/web/20240706160214/https://www.awaresystems.be/imaging/tiff/bigtiff.html - } - - // Relocate to the first set of tags - long address = readlong(endianess, reader); - reader.seek(address); - - // If some higher page number is required, skip this page's tags, - // then read the next page's address - for (int i = 0; i < number; i++) - { - int numtags = readshort(endianess, reader); - if (numtags > 50) - { - throw new IOException("Not a valid tiff file"); - } - reader.seek(address + 2 + numtags * 12L); - address = readlong(endianess, reader); - if (address == 0) - { - return; - } - reader.seek(address); - } - - int numtags = readshort(endianess, reader); - - // The number 50 is somewhat arbitrary, it just stops us load up junk from somewhere - // and tramping on - if (numtags > 50) - { - throw new IOException("Not a valid tiff file"); - } - - // Loop through the tags, some will convert to items in the params dictionary - // Other point us to where to find the data stream. - // The only param which might change as a result of other TIFF tags is K, so - // we'll deal with that differently. - - // Default value to detect error - int k = -1000; - - int dataoffset = 0; - int datalength = 0; - int fillorder = 1; - - for (int i = 0; i < numtags; i++) - { - int tag = readshort(endianess, reader); - int type = readshort(endianess, reader); - int count = (int) readlong(endianess, reader); - int val; - // Note that when the type is shorter than 4 bytes, the rest can be garbage - // and must be ignored. E.g. short (2 bytes) from "01 00 38 32" (little endian) - // is 1, not 842530817 (seen in a real-life TIFF image). - switch (type) - { - case 1: // byte value - val = reader.read(); - reader.read(); - reader.read(); - reader.read(); - break; - case 3: // short value - val = readshort(endianess, reader); - reader.read(); - reader.read(); - break; - default: // long and other types - val = (int) readlong(endianess, reader); - break; - } - switch (tag) - { - case 256: - { - params.setInt(COSName.COLUMNS, val); - break; - } - case 257: - { - params.setInt(COSName.ROWS, val); - break; - } - case 259: - { - if (val == 4) - { - k = -1; - } - if (val == 3) - { - k = 0; - } - break; // T6/T4 Compression - } - case 262: - { - if (val == 1) - { - params.setBoolean(COSName.BLACK_IS_1, true); - } - break; - } - case 266: - { - // http://www.awaresystems.be/imaging/tiff/tifftags/fillorder.html - if (val != 1 && val != 2) - { - throw new IOException("FillOrder " + val + " is not supported"); - } - fillorder = val; - break; - } - case 273: - { - if (count == 1) - { - dataoffset = val; - } - break; - } - case 274: - { - // http://www.awaresystems.be/imaging/tiff/tifftags/orientation.html - if (val != 1) - { - throw new IOException("Orientation " + val + " is not supported"); - } - break; - } - case 279: - { - if (count == 1) - { - datalength = val; - } - break; - } - case 292: - { - if ((val & 1) != 0) - { - // T4 2D - arbitrary positive K value - k = 50; - } - // http://www.awaresystems.be/imaging/tiff/tifftags/t4options.html - if ((val & 4) != 0) - { - throw new IOException("CCITT Group 3 'uncompressed mode' is not supported"); - } - if ((val & 2) != 0) - { - throw new IOException("CCITT Group 3 'fill bits before EOL' is not supported"); - } - break; - } - case 324: - { - if (count == 1) - { - dataoffset = val; - } - break; - } - case 325: - { - if (count == 1) - { - datalength = val; - } - break; - } - default: - { - // do nothing - } - } - } - - if (k == -1000) - { - throw new IOException("First image in tiff is not CCITT T4 or T6 compressed"); - } - if (dataoffset == 0) - { - throw new IOException("First image in tiff is not a single tile/strip"); - } - - params.setInt(COSName.K, k); - - reader.seek(dataoffset); - - byte[] buf = new byte[8192]; - int amountRead; - while ((amountRead = reader.read(buf, 0, Math.min(8192, datalength))) > 0) - { - datalength -= amountRead; - if (fillorder == 2) - { - for (int x = 0; x < amountRead; x++) - { - buf[x] = fliptable[buf[x] & 0xFF]; - } - } - os.write(buf, 0, amountRead); - } - } - - static int readshort(char endianess, RandomAccessRead raf) throws IOException - { - if (endianess == 'I') - { - return raf.read() | (raf.read() << 8); - } - return (raf.read() << 8) | raf.read(); - } - - static long readlong(char endianess, RandomAccessRead raf) throws IOException - { - // TIFF LONG is an unsigned 32-bit value; mask so it widens correctly - if (endianess == 'I') - { - return (raf.read() | (raf.read() << 8) | (raf.read() << 16) | (raf.read() << 24)) & 0xFFFFFFFFL; - } - return ((raf.read() << 24) | (raf.read() << 16) | (raf.read() << 8) | raf.read()) & 0xFFFFFFFFL; - } - - private static final byte[] fliptable = new byte[] - { - (byte) 0x00, (byte) 0x80, (byte) 0x40, (byte) 0xc0, (byte) 0x20, (byte) 0xa0, (byte) 0x60, (byte) 0xe0, - (byte) 0x10, (byte) 0x90, (byte) 0x50, (byte) 0xd0, (byte) 0x30, (byte) 0xb0, (byte) 0x70, (byte) 0xf0, - (byte) 0x08, (byte) 0x88, (byte) 0x48, (byte) 0xc8, (byte) 0x28, (byte) 0xa8, (byte) 0x68, (byte) 0xe8, - (byte) 0x18, (byte) 0x98, (byte) 0x58, (byte) 0xd8, (byte) 0x38, (byte) 0xb8, (byte) 0x78, (byte) 0xf8, - (byte) 0x04, (byte) 0x84, (byte) 0x44, (byte) 0xc4, (byte) 0x24, (byte) 0xa4, (byte) 0x64, (byte) 0xe4, - (byte) 0x14, (byte) 0x94, (byte) 0x54, (byte) 0xd4, (byte) 0x34, (byte) 0xb4, (byte) 0x74, (byte) 0xf4, - (byte) 0x0c, (byte) 0x8c, (byte) 0x4c, (byte) 0xcc, (byte) 0x2c, (byte) 0xac, (byte) 0x6c, (byte) 0xec, - (byte) 0x1c, (byte) 0x9c, (byte) 0x5c, (byte) 0xdc, (byte) 0x3c, (byte) 0xbc, (byte) 0x7c, (byte) 0xfc, - (byte) 0x02, (byte) 0x82, (byte) 0x42, (byte) 0xc2, (byte) 0x22, (byte) 0xa2, (byte) 0x62, (byte) 0xe2, - (byte) 0x12, (byte) 0x92, (byte) 0x52, (byte) 0xd2, (byte) 0x32, (byte) 0xb2, (byte) 0x72, (byte) 0xf2, - (byte) 0x0a, (byte) 0x8a, (byte) 0x4a, (byte) 0xca, (byte) 0x2a, (byte) 0xaa, (byte) 0x6a, (byte) 0xea, - (byte) 0x1a, (byte) 0x9a, (byte) 0x5a, (byte) 0xda, (byte) 0x3a, (byte) 0xba, (byte) 0x7a, (byte) 0xfa, - (byte) 0x06, (byte) 0x86, (byte) 0x46, (byte) 0xc6, (byte) 0x26, (byte) 0xa6, (byte) 0x66, (byte) 0xe6, - (byte) 0x16, (byte) 0x96, (byte) 0x56, (byte) 0xd6, (byte) 0x36, (byte) 0xb6, (byte) 0x76, (byte) 0xf6, - (byte) 0x0e, (byte) 0x8e, (byte) 0x4e, (byte) 0xce, (byte) 0x2e, (byte) 0xae, (byte) 0x6e, (byte) 0xee, - (byte) 0x1e, (byte) 0x9e, (byte) 0x5e, (byte) 0xde, (byte) 0x3e, (byte) 0xbe, (byte) 0x7e, (byte) 0xfe, - (byte) 0x01, (byte) 0x81, (byte) 0x41, (byte) 0xc1, (byte) 0x21, (byte) 0xa1, (byte) 0x61, (byte) 0xe1, - (byte) 0x11, (byte) 0x91, (byte) 0x51, (byte) 0xd1, (byte) 0x31, (byte) 0xb1, (byte) 0x71, (byte) 0xf1, - (byte) 0x09, (byte) 0x89, (byte) 0x49, (byte) 0xc9, (byte) 0x29, (byte) 0xa9, (byte) 0x69, (byte) 0xe9, - (byte) 0x19, (byte) 0x99, (byte) 0x59, (byte) 0xd9, (byte) 0x39, (byte) 0xb9, (byte) 0x79, (byte) 0xf9, - (byte) 0x05, (byte) 0x85, (byte) 0x45, (byte) 0xc5, (byte) 0x25, (byte) 0xa5, (byte) 0x65, (byte) 0xe5, - (byte) 0x15, (byte) 0x95, (byte) 0x55, (byte) 0xd5, (byte) 0x35, (byte) 0xb5, (byte) 0x75, (byte) 0xf5, - (byte) 0x0d, (byte) 0x8d, (byte) 0x4d, (byte) 0xcd, (byte) 0x2d, (byte) 0xad, (byte) 0x6d, (byte) 0xed, - (byte) 0x1d, (byte) 0x9d, (byte) 0x5d, (byte) 0xdd, (byte) 0x3d, (byte) 0xbd, (byte) 0x7d, (byte) 0xfd, - (byte) 0x03, (byte) 0x83, (byte) 0x43, (byte) 0xc3, (byte) 0x23, (byte) 0xa3, (byte) 0x63, (byte) 0xe3, - (byte) 0x13, (byte) 0x93, (byte) 0x53, (byte) 0xd3, (byte) 0x33, (byte) 0xb3, (byte) 0x73, (byte) 0xf3, - (byte) 0x0b, (byte) 0x8b, (byte) 0x4b, (byte) 0xcb, (byte) 0x2b, (byte) 0xab, (byte) 0x6b, (byte) 0xeb, - (byte) 0x1b, (byte) 0x9b, (byte) 0x5b, (byte) 0xdb, (byte) 0x3b, (byte) 0xbb, (byte) 0x7b, (byte) 0xfb, - (byte) 0x07, (byte) 0x87, (byte) 0x47, (byte) 0xc7, (byte) 0x27, (byte) 0xa7, (byte) 0x67, (byte) 0xe7, - (byte) 0x17, (byte) 0x97, (byte) 0x57, (byte) 0xd7, (byte) 0x37, (byte) 0xb7, (byte) 0x77, (byte) 0xf7, - (byte) 0x0f, (byte) 0x8f, (byte) 0x4f, (byte) 0xcf, (byte) 0x2f, (byte) 0xaf, (byte) 0x6f, (byte) 0xef, - (byte) 0x1f, (byte) 0x9f, (byte) 0x5f, (byte) 0xdf, (byte) 0x3f, (byte) 0xbf, (byte) 0x7f, (byte) 0xff, - }; -} +/* + * Licensed to the Apache Software Foundation (ASF) 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 org.apache.pdfbox.pdmodel.graphics.image; + +import java.awt.image.BufferedImage; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.IOException; +import java.io.OutputStream; +import javax.imageio.stream.MemoryCacheImageOutputStream; +import org.apache.pdfbox.cos.COSDictionary; +import org.apache.pdfbox.cos.COSName; +import org.apache.pdfbox.filter.Filter; +import org.apache.pdfbox.filter.FilterFactory; +import org.apache.pdfbox.io.RandomAccessReadBuffer; +import org.apache.pdfbox.io.RandomAccessReadBufferedFile; +import org.apache.pdfbox.io.RandomAccessRead; +import org.apache.pdfbox.pdmodel.PDDocument; +import org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace; +import org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray; + +/** + * Factory for creating a PDImageXObject containing a CCITT Fax compressed TIFF image. + * + * @author Ben Litchfield + * @author Paul King + */ +public final class CCITTFactory +{ + private CCITTFactory() + { + } + + /** + * Creates a new CCITT group 4 (T6) compressed image XObject from a b/w BufferedImage. This + * compression technique usually results in smaller images than those produced by {@link LosslessFactory#createFromImage(PDDocument, BufferedImage) + * }. + * + * @param document the document to create the image as part of. + * @param image the image. + * @return a new image XObject. + * @throws IOException if there is an error creating the image. + * @throws IllegalArgumentException if the BufferedImage is not a b/w image. + */ + public static PDImageXObject createFromImage(PDDocument document, BufferedImage image) + throws IOException + { + if (image.getType() != BufferedImage.TYPE_BYTE_BINARY && image.getColorModel().getPixelSize() != 1) + { + throw new IllegalArgumentException("Only 1-bit b/w images supported"); + } + + int height = image.getHeight(); + int width = image.getWidth(); + + ByteArrayOutputStream bos = new ByteArrayOutputStream(Math.max(32, (width + 1) * height)); + try (MemoryCacheImageOutputStream mcios = new MemoryCacheImageOutputStream(bos)) + { + for (int y = 0; y < height; ++y) + { + for (int x = 0; x < width; ++x) + { + // flip bit to avoid having to set /BlackIs1 + mcios.writeBits(~(image.getRGB(x, y) & 1), 1); + } + int bitOffset = mcios.getBitOffset(); + if (bitOffset != 0) + { + mcios.writeBits(0, 8 - bitOffset); + } + } + mcios.flush(); + } + + return prepareImageXObject(document, bos.toByteArray(), width, height, PDDeviceGray.INSTANCE); + } + + /** + * Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored + * in a byte array. Only single-strip CCITT T4 or T6 compressed TIFF files are supported. If + * you're not sure what TIFF files you have, use + * {@link LosslessFactory#createFromImage(PDDocument, BufferedImage) } + * or {@link CCITTFactory#createFromImage(PDDocument, BufferedImage) } + * instead. + * + * @param document the document to create the image as part of. + * @param byteArray the TIFF file in a byte array which contains a suitable CCITT compressed + * image + * @return a new Image XObject + * @throws IOException if there is an error reading the TIFF data. + */ + public static PDImageXObject createFromByteArray(PDDocument document, byte[] byteArray) + throws IOException + { + return createFromByteArray(document, byteArray, 0); + } + + /** + * Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored + * in a byte array. Only single-strip CCITT T4 or T6 compressed TIFF files are supported. If + * you're not sure what TIFF files you have, use + * {@link LosslessFactory#createFromImage(PDDocument, BufferedImage) } + * or {@link CCITTFactory#createFromImage(PDDocument, BufferedImage) } + * instead. + * + * @param document the document to create the image as part of. + * @param byteArray the TIFF file in a byte array which contains a suitable CCITT compressed + * image + * @param number TIFF image number, starting from 0 + * @return a new Image XObject + * @throws IOException if there is an error reading the TIFF data. + */ + public static PDImageXObject createFromByteArray(PDDocument document, byte[] byteArray, int number) + throws IOException + { + try (RandomAccessRead raf = new RandomAccessReadBuffer(byteArray)) + { + return createFromRandomAccessImpl(document, raf, number); + } + } + + private static PDImageXObject prepareImageXObject(PDDocument document, + byte[] byteArray, int width, int height, + PDColorSpace initColorSpace) throws IOException + { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + + Filter filter = FilterFactory.INSTANCE.getFilter(COSName.CCITTFAX_DECODE); + COSDictionary dict = new COSDictionary(); + dict.setInt(COSName.COLUMNS, width); + dict.setInt(COSName.ROWS, height); + filter.encode(new ByteArrayInputStream(byteArray), baos, dict, 0); + + ByteArrayInputStream encodedByteStream = new ByteArrayInputStream(baos.toByteArray()); + PDImageXObject image = new PDImageXObject(document, encodedByteStream, COSName.CCITTFAX_DECODE, + width, height, 1, initColorSpace); + dict.setInt(COSName.K, -1); + image.getCOSObject().setItem(COSName.DECODE_PARMS, dict); + return image; + } + + /** + * Creates a new CCITT Fax compressed image XObject from the first image of a TIFF file. Only + * single-strip CCITT T4 or T6 compressed TIFF files are supported. If you're not sure what TIFF + * files you have, use + * {@link LosslessFactory#createFromImage(org.apache.pdfbox.pdmodel.PDDocument, java.awt.image.BufferedImage)} + * or {@link CCITTFactory#createFromImage(PDDocument, BufferedImage) } + * instead. + * + * @param document the document to create the image as part of. + * @param file the TIFF file which contains a suitable CCITT compressed image + * @return a new Image XObject + * @throws IOException if there is an error reading the TIFF data. + */ + public static PDImageXObject createFromFile(PDDocument document, File file) + throws IOException + { + return createFromFile(document, file, 0); + } + + /** + * Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file. Only + * single-strip CCITT T4 or T6 compressed TIFF files are supported. If you're not sure what TIFF + * files you have, use + * {@link LosslessFactory#createFromImage(PDDocument, BufferedImage) } + * or {@link CCITTFactory#createFromImage(PDDocument, BufferedImage) } + * instead. + * + * @param document the document to create the image as part of. + * @param file the TIFF file which contains a suitable CCITT compressed image + * @param number TIFF image number, starting from 0 + * @return a new Image XObject + * @throws IOException if there is an error reading the TIFF data. + */ + public static PDImageXObject createFromFile(PDDocument document, File file, int number) + throws IOException + { + try (RandomAccessRead raf = new RandomAccessReadBufferedFile(file)) + { + return createFromRandomAccessImpl(document, raf, number); + } + } + + /** + * Creates a new CCITT Fax compressed image XObject from a TIFF file. + * + * @param document the document to create the image as part of. + * @param reader the random access TIFF file which contains a suitable CCITT + * compressed image + * @param number TIFF image number, starting from 0 + * @return a new Image XObject, or null if no such page + * @throws IOException if there is an error reading the TIFF data. + */ + private static PDImageXObject createFromRandomAccessImpl(PDDocument document, + RandomAccessRead reader, + int number) throws IOException + { + COSDictionary decodeParms = new COSDictionary(); + ByteArrayOutputStream bos = new ByteArrayOutputStream(); + extractFromTiff(reader, bos, decodeParms, number); + if (bos.size() == 0) + { + return null; + } + ByteArrayInputStream encodedByteStream = new ByteArrayInputStream(bos.toByteArray()); + PDImageXObject pdImage = new PDImageXObject(document, + encodedByteStream, + COSName.CCITTFAX_DECODE, + decodeParms.getInt(COSName.COLUMNS), + decodeParms.getInt(COSName.ROWS), + 1, + PDDeviceGray.INSTANCE); + + COSDictionary dict = pdImage.getCOSObject(); + dict.setItem(COSName.DECODE_PARMS, decodeParms); + return pdImage; + } + + // extracts the CCITT stream from the TIFF file + private static void extractFromTiff(RandomAccessRead reader, + OutputStream os, + COSDictionary params, int number) throws IOException + { + // First check the basic tiff header + reader.seek(0); + char endianess = (char) reader.read(); + if ((char) reader.read() != endianess) + { + throw new IOException("Not a valid tiff file"); + } + // ensure that endianess is either M or I + if (endianess != 'M' && endianess != 'I') + { + throw new IOException("Not a valid tiff file"); + } + int magicNumber = readshort(endianess, reader); + if (magicNumber != 42) + { + throw new IOException("Not a valid tiff file"); + + // 43 is bigtiff. If we need to support this in the future, look here: + // https://web.archive.org/web/20240706160214/https://www.awaresystems.be/imaging/tiff/bigtiff.html + } + + // Relocate to the first set of tags + long address = readlong(endianess, reader); + reader.seek(address); + + // If some higher page number is required, skip this page's tags, + // then read the next page's address + for (int i = 0; i < number; i++) + { + int numtags = readshort(endianess, reader); + if (numtags > 50) + { + throw new IOException("Not a valid tiff file"); + } + reader.seek(address + 2 + numtags * 12L); + address = readlong(endianess, reader); + if (address == 0) + { + return; + } + reader.seek(address); + } + + int numtags = readshort(endianess, reader); + + // The number 50 is somewhat arbitrary, it just stops us load up junk from somewhere + // and tramping on + if (numtags > 50) + { + throw new IOException("Not a valid tiff file"); + } + + // Loop through the tags, some will convert to items in the params dictionary + // Other point us to where to find the data stream. + // The only param which might change as a result of other TIFF tags is K, so + // we'll deal with that differently. + + // Default value to detect error + int k = -1000; + + int dataoffset = 0; + int datalength = 0; + int fillorder = 1; + + for (int i = 0; i < numtags; i++) + { + int tag = readshort(endianess, reader); + int type = readshort(endianess, reader); + int count = (int) readlong(endianess, reader); + int val; + // Note that when the type is shorter than 4 bytes, the rest can be garbage + // and must be ignored. E.g. short (2 bytes) from "01 00 38 32" (little endian) + // is 1, not 842530817 (seen in a real-life TIFF image). + switch (type) + { + case 1: // byte value + val = reader.read(); + reader.read(); + reader.read(); + reader.read(); + break; + case 3: // short value + val = readshort(endianess, reader); + reader.read(); + reader.read(); + break; + default: // long and other types + val = (int) readlong(endianess, reader); + break; + } + switch (tag) + { + case 256: + { + params.setInt(COSName.COLUMNS, val); + break; + } + case 257: + { + params.setInt(COSName.ROWS, val); + break; + } + case 259: + { + if (val == 4) + { + k = -1; + } + if (val == 3) + { + k = 0; + } + break; // T6/T4 Compression + } + case 262: + { + if (val == 1) + { + params.setBoolean(COSName.BLACK_IS_1, true); + } + break; + } + case 266: + { + // http://www.awaresystems.be/imaging/tiff/tifftags/fillorder.html + if (val != 1 && val != 2) + { + throw new IOException("FillOrder " + val + " is not supported"); + } + fillorder = val; + break; + } + case 273: + { + if (count == 1) + { + dataoffset = val; + } + break; + } + case 274: + { + // http://www.awaresystems.be/imaging/tiff/tifftags/orientation.html + if (val != 1) + { + throw new IOException("Orientation " + val + " is not supported"); + } + break; + } + case 279: + { + if (count == 1) + { + datalength = val; + } + break; + } + case 292: + { + if ((val & 1) != 0) + { + // T4 2D - arbitrary positive K value + k = 50; + } + // http://www.awaresystems.be/imaging/tiff/tifftags/t4options.html + if ((val & 4) != 0) + { + throw new IOException("CCITT Group 3 'fill bits before EOL' is not supported"); + } + if ((val & 2) != 0) + { + throw new IOException("CCITT Group 3 'uncompressed mode' is not supported"); + } + break; + } + case 324: + { + if (count == 1) + { + dataoffset = val; + } + break; + } + case 325: + { + if (count == 1) + { + datalength = val; + } + break; + } + default: + { + // do nothing + } + } + } + + if (k == -1000) + { + throw new IOException("First image in tiff is not CCITT T4 or T6 compressed"); + } + if (dataoffset == 0) + { + throw new IOException("First image in tiff is not a single tile/strip"); + } + + params.setInt(COSName.K, k); + + reader.seek(dataoffset); + + byte[] buf = new byte[8192]; + int amountRead; + while ((amountRead = reader.read(buf, 0, Math.min(8192, datalength))) > 0) + { + datalength -= amountRead; + if (fillorder == 2) + { + for (int x = 0; x < amountRead; x++) + { + buf[x] = fliptable[buf[x] & 0xFF]; + } + } + os.write(buf, 0, amountRead); + } + } + + static int readshort(char endianess, RandomAccessRead raf) throws IOException + { + if (endianess == 'I') + { + return raf.read() | (raf.read() << 8); + } + return (raf.read() << 8) | raf.read(); + } + + static long readlong(char endianess, RandomAccessRead raf) throws IOException + { + // TIFF LONG is an unsigned 32-bit value; mask so it widens correctly + if (endianess == 'I') + { + return (raf.read() | (raf.read() << 8) | (raf.read() << 16) | (raf.read() << 24)) & 0xFFFFFFFFL; + } + return ((raf.read() << 24) | (raf.read() << 16) | (raf.read() << 8) | raf.read()) & 0xFFFFFFFFL; + } + + private static final byte[] fliptable = new byte[] + { + (byte) 0x00, (byte) 0x80, (byte) 0x40, (byte) 0xc0, (byte) 0x20, (byte) 0xa0, (byte) 0x60, (byte) 0xe0, + (byte) 0x10, (byte) 0x90, (byte) 0x50, (byte) 0xd0, (byte) 0x30, (byte) 0xb0, (byte) 0x70, (byte) 0xf0, + (byte) 0x08, (byte) 0x88, (byte) 0x48, (byte) 0xc8, (byte) 0x28, (byte) 0xa8, (byte) 0x68, (byte) 0xe8, + (byte) 0x18, (byte) 0x98, (byte) 0x58, (byte) 0xd8, (byte) 0x38, (byte) 0xb8, (byte) 0x78, (byte) 0xf8, + (byte) 0x04, (byte) 0x84, (byte) 0x44, (byte) 0xc4, (byte) 0x24, (byte) 0xa4, (byte) 0x64, (byte) 0xe4, + (byte) 0x14, (byte) 0x94, (byte) 0x54, (byte) 0xd4, (byte) 0x34, (byte) 0xb4, (byte) 0x74, (byte) 0xf4, + (byte) 0x0c, (byte) 0x8c, (byte) 0x4c, (byte) 0xcc, (byte) 0x2c, (byte) 0xac, (byte) 0x6c, (byte) 0xec, + (byte) 0x1c, (byte) 0x9c, (byte) 0x5c, (byte) 0xdc, (byte) 0x3c, (byte) 0xbc, (byte) 0x7c, (byte) 0xfc, + (byte) 0x02, (byte) 0x82, (byte) 0x42, (byte) 0xc2, (byte) 0x22, (byte) 0xa2, (byte) 0x62, (byte) 0xe2, + (byte) 0x12, (byte) 0x92, (byte) 0x52, (byte) 0xd2, (byte) 0x32, (byte) 0xb2, (byte) 0x72, (byte) 0xf2, + (byte) 0x0a, (byte) 0x8a, (byte) 0x4a, (byte) 0xca, (byte) 0x2a, (byte) 0xaa, (byte) 0x6a, (byte) 0xea, + (byte) 0x1a, (byte) 0x9a, (byte) 0x5a, (byte) 0xda, (byte) 0x3a, (byte) 0xba, (byte) 0x7a, (byte) 0xfa, + (byte) 0x06, (byte) 0x86, (byte) 0x46, (byte) 0xc6, (byte) 0x26, (byte) 0xa6, (byte) 0x66, (byte) 0xe6, + (byte) 0x16, (byte) 0x96, (byte) 0x56, (byte) 0xd6, (byte) 0x36, (byte) 0xb6, (byte) 0x76, (byte) 0xf6, + (byte) 0x0e, (byte) 0x8e, (byte) 0x4e, (byte) 0xce, (byte) 0x2e, (byte) 0xae, (byte) 0x6e, (byte) 0xee, + (byte) 0x1e, (byte) 0x9e, (byte) 0x5e, (byte) 0xde, (byte) 0x3e, (byte) 0xbe, (byte) 0x7e, (byte) 0xfe, + (byte) 0x01, (byte) 0x81, (byte) 0x41, (byte) 0xc1, (byte) 0x21, (byte) 0xa1, (byte) 0x61, (byte) 0xe1, + (byte) 0x11, (byte) 0x91, (byte) 0x51, (byte) 0xd1, (byte) 0x31, (byte) 0xb1, (byte) 0x71, (byte) 0xf1, + (byte) 0x09, (byte) 0x89, (byte) 0x49, (byte) 0xc9, (byte) 0x29, (byte) 0xa9, (byte) 0x69, (byte) 0xe9, + (byte) 0x19, (byte) 0x99, (byte) 0x59, (byte) 0xd9, (byte) 0x39, (byte) 0xb9, (byte) 0x79, (byte) 0xf9, + (byte) 0x05, (byte) 0x85, (byte) 0x45, (byte) 0xc5, (byte) 0x25, (byte) 0xa5, (byte) 0x65, (byte) 0xe5, + (byte) 0x15, (byte) 0x95, (byte) 0x55, (byte) 0xd5, (byte) 0x35, (byte) 0xb5, (byte) 0x75, (byte) 0xf5, + (byte) 0x0d, (byte) 0x8d, (byte) 0x4d, (byte) 0xcd, (byte) 0x2d, (byte) 0xad, (byte) 0x6d, (byte) 0xed, + (byte) 0x1d, (byte) 0x9d, (byte) 0x5d, (byte) 0xdd, (byte) 0x3d, (byte) 0xbd, (byte) 0x7d, (byte) 0xfd, + (byte) 0x03, (byte) 0x83, (byte) 0x43, (byte) 0xc3, (byte) 0x23, (byte) 0xa3, (byte) 0x63, (byte) 0xe3, + (byte) 0x13, (byte) 0x93, (byte) 0x53, (byte) 0xd3, (byte) 0x33, (byte) 0xb3, (byte) 0x73, (byte) 0xf3, + (byte) 0x0b, (byte) 0x8b, (byte) 0x4b, (byte) 0xcb, (byte) 0x2b, (byte) 0xab, (byte) 0x6b, (byte) 0xeb, + (byte) 0x1b, (byte) 0x9b, (byte) 0x5b, (byte) 0xdb, (byte) 0x3b, (byte) 0xbb, (byte) 0x7b, (byte) 0xfb, + (byte) 0x07, (byte) 0x87, (byte) 0x47, (byte) 0xc7, (byte) 0x27, (byte) 0xa7, (byte) 0x67, (byte) 0xe7, + (byte) 0x17, (byte) 0x97, (byte) 0x57, (byte) 0xd7, (byte) 0x37, (byte) 0xb7, (byte) 0x77, (byte) 0xf7, + (byte) 0x0f, (byte) 0x8f, (byte) 0x4f, (byte) 0xcf, (byte) 0x2f, (byte) 0xaf, (byte) 0x6f, (byte) 0xef, + (byte) 0x1f, (byte) 0x9f, (byte) 0x5f, (byte) 0xdf, (byte) 0x3f, (byte) 0xbf, (byte) 0x7f, (byte) 0xff, + }; +}