/* * 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.color; import org.apache.pdfbox.cos.COSArray; import org.apache.pdfbox.cos.COSBase; import org.apache.pdfbox.cos.COSDictionary; import org.apache.pdfbox.cos.COSFloat; import org.apache.pdfbox.cos.COSName; import org.apache.pdfbox.pdmodel.common.PDMatrix; import java.awt.Transparency; import java.awt.color.ColorSpace; import java.awt.image.ColorModel; import java.awt.image.ComponentColorModel; import java.awt.image.DataBuffer; import java.io.IOException; /** * This class represents a Cal RGB color space. * * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a> * @version $Revision: 1.3 $ */ public class PDCalRGB extends PDColorSpace { /** * The name of this color space. */ public static final String NAME = "CalRGB"; private COSArray array; private COSDictionary dictionary; /** * Constructor. */ public PDCalRGB() { array = new COSArray(); dictionary = new COSDictionary(); array.add( COSName.CALRGB ); array.add( dictionary ); } /** * Constructor with array. * * @param rgb The underlying color space. */ public PDCalRGB( COSArray rgb ) { array = rgb; dictionary = (COSDictionary)array.getObject( 1 ); } /** * This will get the number of components that this color space is made up of. * * @return The number of components in this color space. * * @throws IOException If there is an error getting the number of color components. */ public int getNumberOfComponents() throws IOException { return 3; } /** * This will return the name of the color space. * * @return The name of the color space. */ public String getName() { return NAME; } /** * Create a Java colorspace for this colorspace. * * @return A color space that can be used for Java AWT operations. */ protected ColorSpace createColorSpace() { return new ColorSpaceCalRGB(getGamma(),getWhitepoint(),getBlackPoint(),getLinearInterpretation()); } /** * Create a Java color model for this colorspace. * * @param bpc The number of bits per component. * * @return A color model that can be used for Java AWT operations. * * @throws IOException If there is an error creating the color model. */ public ColorModel createColorModel( int bpc ) throws IOException { int[] nBits = {bpc, bpc, bpc}; return new ComponentColorModel( getJavaColorSpace(), nBits, false, false, Transparency.OPAQUE, DataBuffer.TYPE_BYTE); } /** * Convert this standard java object to a COS object. * * @return The cos object that matches this Java object. */ public COSBase getCOSObject() { return array; } /** * This will return the whitepoint tristimulus. As this is a required field * this will never return null. A default of 1,1,1 will be returned if the * pdf does not have any values yet. * * @return The whitepoint tristimulus. */ public PDTristimulus getWhitepoint() { COSArray wp = (COSArray)dictionary.getDictionaryObject( COSName.WHITE_POINT ); if( wp == null ) { wp = new COSArray(); wp.add( new COSFloat( 1.0f ) ); wp.add( new COSFloat( 1.0f ) ); wp.add( new COSFloat( 1.0f ) ); dictionary.setItem( COSName.WHITE_POINT, wp ); } return new PDTristimulus( wp ); } /** * This will set the whitepoint tristimulus. As this is a required field * this null should not be passed into this function. * * @param wp The whitepoint tristimulus. */ public void setWhitepoint( PDTristimulus wp ) { COSBase wpArray = wp.getCOSObject(); if( wpArray != null ) { dictionary.setItem( COSName.WHITE_POINT, wpArray ); } } /** * This will return the BlackPoint tristimulus. This is an optional field but * has defaults so this will never return null. * A default of 0,0,0 will be returned if the pdf does not have any values yet. * * @return The blackpoint tristimulus. */ public PDTristimulus getBlackPoint() { COSArray bp = (COSArray)dictionary.getDictionaryObject( COSName.BLACK_POINT ); if( bp == null ) { bp = new COSArray(); bp.add( new COSFloat( 0.0f ) ); bp.add( new COSFloat( 0.0f ) ); bp.add( new COSFloat( 0.0f ) ); dictionary.setItem( COSName.BLACK_POINT, bp ); } return new PDTristimulus( bp ); } /** * This will set the BlackPoint tristimulus. As this is a required field * this null should not be passed into this function. * * @param bp The BlackPoint tristimulus. */ public void setBlackPoint( PDTristimulus bp ) { COSBase bpArray = null; if( bp != null ) { bpArray = bp.getCOSObject(); } dictionary.setItem( COSName.BLACK_POINT, bpArray ); } /** * This will get the gamma value. If none is present then the default of 1,1,1 * will be returned. * * @return The gamma value. */ public PDGamma getGamma() { COSArray gamma = (COSArray)dictionary.getDictionaryObject( COSName.GAMMA ); if( gamma == null ) { gamma = new COSArray(); gamma.add( new COSFloat( 1.0f ) ); gamma.add( new COSFloat( 1.0f ) ); gamma.add( new COSFloat( 1.0f ) ); dictionary.setItem( COSName.GAMMA, gamma ); } return new PDGamma( gamma ); } /** * Set the gamma value. * * @param value The new gamma value. */ public void setGamma( PDGamma value ) { COSArray gamma = null; if( value != null ) { gamma = value.getCOSArray(); } dictionary.setItem( COSName.GAMMA, gamma ); } /** * This will get the linear interpretation array. This is guaranteed to not * return null. If the underlying dictionary contains null then the identity * matrix will be returned. * * @return The linear interpretation matrix. */ public PDMatrix getLinearInterpretation() { PDMatrix retval = null; COSArray matrix = (COSArray)dictionary.getDictionaryObject( COSName.MATRIX ); if( matrix == null ) { retval = new PDMatrix(); setLinearInterpretation( retval ); } else { retval = new PDMatrix( matrix ); } return retval; } /** * This will set the linear interpretation matrix. Passing in null will * clear the matrix. * * @param matrix The new linear interpretation matrix. */ public void setLinearInterpretation( PDMatrix matrix ) { COSArray matrixArray = null; if( matrix != null ) { matrixArray = matrix.getCOSArray(); } dictionary.setItem( COSName.MATRIX, matrixArray ); } }