PdfImage.java

/*
 * $Id: PdfImage.java 4067 2009-09-19 12:56:50Z psoares33 $
 *
 * Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
 *
 * The contents of this file are subject to the Mozilla Public License Version 1.1
 * (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the License.
 *
 * The Original Code is 'iText, a free JAVA-PDF library'.
 *
 * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
 * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
 * All Rights Reserved.
 * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
 * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
 *
 * Contributor(s): all the names of the contributors are added in the source code
 * where applicable.
 *
 * Alternatively, the contents of this file may be used under the terms of the
 * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
 * provisions of LGPL are applicable instead of those above.  If you wish to
 * allow use of your version of this file only under the terms of the LGPL
 * License and not to allow others to use your version of this file under
 * the MPL, indicate your decision by deleting the provisions above and
 * replace them with the notice and other provisions required by the LGPL.
 * If you do not delete the provisions above, a recipient may use your version
 * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the MPL as stated above or under the terms of the GNU
 * Library General Public License as published by the Free Software Foundation;
 * either version 2 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
 * details.
 *
 * If you didn't download this code from the following link, you should check if
 * you aren't using an obsolete version:
 * https://github.com/LibrePDF/OpenPDF
 */

package org.openpdf.text.pdf;

import org.openpdf.text.Image;
import org.openpdf.text.error_messages.MessageLocalization;

/**
 * <CODE>PdfImage</CODE> is a <CODE>PdfStream</CODE> containing an image-<CODE>Dictionary</CODE> and -stream.
 */

public class PdfImage extends PdfStream {

    // membervariables

    /**
     * This is the <CODE>PdfName</CODE> of the image.
     */
    protected PdfName name = null;

    // constructor

    /**
     * Constructs a <CODE>PdfImage</CODE>-object.
     *
     * @param image   the <CODE>Image</CODE>-object
     * @param name    the <CODE>PdfName</CODE> for this image
     * @param maskRef the <CODE>PdfIndirectReference</CODE>
     * @throws BadPdfFormatException on error
     */

    public PdfImage(Image image, String name, PdfIndirectReference maskRef) throws BadPdfFormatException {
        super();
        this.name = new PdfName(name);
        put(PdfName.TYPE, PdfName.XOBJECT);
        put(PdfName.SUBTYPE, PdfName.IMAGE);
        put(PdfName.WIDTH, new PdfNumber(image.getWidth()));
        put(PdfName.HEIGHT, new PdfNumber(image.getHeight()));
        if (image.isMask() && (image.getBpc() == 1 || image.getBpc() > 0xff)) {
            put(PdfName.IMAGEMASK, PdfBoolean.PDFTRUE);
        }
        if (maskRef != null) {
            if (image.isSmask()) {
                put(PdfName.SMASK, maskRef);
            } else {
                put(PdfName.MASK, maskRef);
            }
        }
        if (image.isMask() && image.isInverted()) {
            put(PdfName.DECODE, new PdfLiteral("[1 0]"));
        }
        if (image.isInterpolation()) {
            put(PdfName.INTERPOLATE, PdfBoolean.PDFTRUE);
        }
        // Raw Image data
        if (image.isImgRaw()) {
            // will also have the CCITT parameters
            int colorspace = image.getColorspace();
            int[] transparency = image.getTransparency();
            if (transparency != null && !image.isMask() && maskRef == null) {
                String s = "[";
                for (int i : transparency) {
                    s += i + " ";
                }
                s += "]";
                put(PdfName.MASK, new PdfLiteral(s));
            }
            bytes = image.getRawData();
            put(PdfName.LENGTH, new PdfNumber(bytes.length));
            int bpc = image.getBpc();
            if (bpc > 0xff) {
                if (!image.isMask()) {
                    put(PdfName.COLORSPACE, PdfName.DEVICEGRAY);
                }
                put(PdfName.BITSPERCOMPONENT, new PdfNumber(1));
                put(PdfName.FILTER, PdfName.CCITTFAXDECODE);
                int k = bpc - Image.CCITTG3_1D;
                PdfDictionary decodeparms = new PdfDictionary();
                if (k != 0) {
                    decodeparms.put(PdfName.K, new PdfNumber(k));
                }
                if ((colorspace & Image.CCITT_BLACKIS1) != 0) {
                    decodeparms.put(PdfName.BLACKIS1, PdfBoolean.PDFTRUE);
                }
                if ((colorspace & Image.CCITT_ENCODEDBYTEALIGN) != 0) {
                    decodeparms.put(PdfName.ENCODEDBYTEALIGN, PdfBoolean.PDFTRUE);
                }
                if ((colorspace & Image.CCITT_ENDOFLINE) != 0) {
                    decodeparms.put(PdfName.ENDOFLINE, PdfBoolean.PDFTRUE);
                }
                if ((colorspace & Image.CCITT_ENDOFBLOCK) != 0) {
                    decodeparms.put(PdfName.ENDOFBLOCK, PdfBoolean.PDFFALSE);
                }
                decodeparms.put(PdfName.COLUMNS, new PdfNumber(image.getWidth()));
                decodeparms.put(PdfName.ROWS, new PdfNumber(image.getHeight()));
                put(PdfName.DECODEPARMS, decodeparms);
            } else {
                switch (colorspace) {
                    case 1:
                        put(PdfName.COLORSPACE, PdfName.DEVICEGRAY);
                        if (image.isInverted()) {
                            put(PdfName.DECODE, new PdfLiteral("[1 0]"));
                        }
                        break;
                    case 3:
                        put(PdfName.COLORSPACE, PdfName.DEVICERGB);
                        if (image.isInverted()) {
                            put(PdfName.DECODE, new PdfLiteral("[1 0 1 0 1 0]"));
                        }
                        break;
                    case 4:
                    default:
                        put(PdfName.COLORSPACE, PdfName.DEVICECMYK);
                        if (image.isInverted()) {
                            put(PdfName.DECODE, new PdfLiteral("[1 0 1 0 1 0 1 0]"));
                        }
                }
                PdfDictionary additional = image.getAdditional();
                if (additional != null) {
                    putAll(additional);
                }
                if (image.isMask() && (image.getBpc() == 1 || image.getBpc() > 8)) {
                    remove(PdfName.COLORSPACE);
                }
                put(PdfName.BITSPERCOMPONENT, new PdfNumber(image.getBpc()));
                if (image.isDeflated()) {
                    put(PdfName.FILTER, PdfName.FLATEDECODE);
                } else {
                    flateCompress(image.getCompressionLevel());
                }
            }
            return;
        }
        // This pruned OpenPDF only knows raw images (see Image.getInstance(int, int, int, int, byte[]))
        throw new BadPdfFormatException(
                MessageLocalization.getComposedMessage("1.is.an.unknown.image.format", "Not a raw image"));
    }

    /**
     * Returns the <CODE>PdfName</CODE> of the image.
     *
     * @return the name
     */

    public PdfName name() {
        return name;
    }

}