[FOray-commit] SF.net SVN: foray: [8610] trunk/foray

[<vic...@us...>]

Revision: 8610
          http://svn.sourceforge.net/foray/?rev=8610&view=rev
Author:   victormote
Date:     2007-02-06 18:50:07 -0800 (Tue, 06 Feb 2007)

Log Message:
-----------
1. Add the xmlgraphics-commons jar file to lib.
2. Create a superclass for images using the Batik image codecs.
3. Convert PNGGraphic to use the new superclass.

Modified Paths:
--------------
    trunk/foray/foray-graphic/.classpath
    trunk/foray/foray-graphic/src/java/org/foray/graphic/PNGGraphic.java

Added Paths:
-----------
    trunk/foray/foray-graphic/src/java/org/foray/graphic/BatikCodecImage.java
    trunk/foray/lib/xmlgraphics-commons-1.1.jar
    trunk/foray/lib/xmlgraphics-commons.LICENSE.txt

Modified: trunk/foray/foray-graphic/.classpath
===================================================================
--- trunk/foray/foray-graphic/.classpath	2007-02-06 04:00:33 UTC (rev 8609)
+++ trunk/foray/foray-graphic/.classpath	2007-02-07 02:50:07 UTC (rev 8610)
@@ -9,5 +9,7 @@
 	<classpathentry kind="var" path="JAI_HOME/lib/jai_codec.jar"/>
 	<classpathentry kind="var" path="JAI_HOME/lib/jai_core.jar"/>
 	<classpathentry kind="var" path="FORAY_LIB_ROOT/commons-logging.jar"/>
+	<classpathentry kind="var" path="FORAY_LIB_ROOT/xmlgraphics-commons-1.1.jar" sourcepath="/XMLGRAPHICS_COMMONS_HOME/xmlgraphics-commons-1.1-src.zip"/>
+	<classpathentry kind="var" path="FORAY_LIB_ROOT/commons-io-1.2.jar"/>
 	<classpathentry kind="output" path="build/eclipse"/>
 </classpath>

Added: trunk/foray/foray-graphic/src/java/org/foray/graphic/BatikCodecImage.java
===================================================================
--- trunk/foray/foray-graphic/src/java/org/foray/graphic/BatikCodecImage.java	                        (rev 0)
+++ trunk/foray/foray-graphic/src/java/org/foray/graphic/BatikCodecImage.java	2007-02-07 02:50:07 UTC (rev 8610)
@@ -0,0 +1,233 @@
+/*
+ * Copyright 2007 The FOray Project.
+ *      http://www.foray.org
+ *
+ * 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.
+ *
+ * This work is in part derived from the following work(s), used with the
+ * permission of the licensor:
+ *      Apache FOP, licensed by the Apache Software Foundation
+ *
+ */
+
+/*
+ * $LastChangedRevision$
+ * $LastChangedDate$
+ * $LastChangedBy$
+ */
+
+package org.foray.graphic;
+
+import org.foray.common.WKConstants;
+
+import org.axsl.graphicR.GraphicException;
+
+import org.apache.commons.io.IOUtils;
+import org.apache.xmlgraphics.image.GraphicsUtil;
+import org.apache.xmlgraphics.image.codec.util.FileCacheSeekableStream;
+import org.apache.xmlgraphics.image.codec.util.MemoryCacheSeekableStream;
+import org.apache.xmlgraphics.image.codec.util.SeekableStream;
+import org.apache.xmlgraphics.image.rendered.CachableRed;
+
+import java.awt.Color;
+import java.awt.Transparency;
+import java.awt.image.BufferedImage;
+import java.awt.image.ColorModel;
+import java.awt.image.IndexColorModel;
+import java.awt.image.RenderedImage;
+import java.awt.image.WritableRaster;
+import java.io.BufferedInputStream;
+import java.io.IOException;
+import java.net.URL;
+
+/**
+ * Abstract superclass for graphic types that are handled by the Apache
+ * XML Graphics Commons image codecs.
+ */
+public abstract class BatikCodecImage extends Graphic {
+
+    /** The default bit depth to be used. */
+    private static final int DEFAULT_BIT_DEPTH = 8;
+
+    /** The alpha channel for the image?? */
+    private byte[] softMask = null;
+
+    /** The InputStream wrapped into a SeekableStream for decoding. */
+    private SeekableStream seekableInput = null;
+
+    /** The Batik representation of the image. */
+    private CachableRed cr = null;
+
+    /** Indicates whether this image is transparent or not. */
+    private boolean isTransparent;
+    /* TODO: This essentially overrides a variable in a superclass. Clean this
+     * up. */
+
+    /**
+     * Constructor.
+     * @param server The parent graphic server.
+     * @param url The URL which contains the graphic content.
+     * @param bis The reusable input stream containing the bytes from
+     * <code>url</code>.
+     */
+    public BatikCodecImage(final FOrayGraphicServer server, final URL url,
+            final BufferedInputStream bis) {
+        super(server, url, bis);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public void parseBasics() throws IOException {
+        /* TODO: Check cleanup of resources here. */
+        if (this.getInputStream() == null) {
+            throw new IOException("Input Stream is null: "
+                    + this.getUrl().toExternalForm());
+        }
+
+        try { 
+            seekableInput = new FileCacheSeekableStream(this.getInputStream());
+        } catch (final IOException ioe) {
+            seekableInput = new MemoryCacheSeekableStream(
+                    this.getInputStream());
+        }
+
+        this.setBitDepth(DEFAULT_BIT_DEPTH);
+        this.cr = decodeImage(seekableInput);
+        this.setPixelHeight(cr.getHeight());
+        this.setPixelWidth(cr.getWidth());
+        this.isTransparent = false;
+        this.softMask = null;
+        ColorModel cm = cr.getColorModel();
+
+        final int transparencyType = cm.getTransparency();
+        if (cm instanceof IndexColorModel)  {
+            if (transparencyType == Transparency.BITMASK) {
+                // Use 'transparent color'.
+                final IndexColorModel icm = (IndexColorModel) cm;
+                final int numColor = icm.getMapSize();
+                final byte [] alpha = new byte[numColor];
+                icm.getAlphas(alpha);
+                for (int i = 0; i < numColor; i++) {
+                    if ((alpha[i] & WKConstants.MAX_8_BIT_UNSIGNED_INT) == 0) {
+                        this.isTransparent = true;
+                        final int red = (icm.getRed(i))
+                                & WKConstants.MAX_8_BIT_UNSIGNED_INT;
+                        final int grn = (icm.getGreen(i))
+                                & WKConstants.MAX_8_BIT_UNSIGNED_INT;
+                        final int blu = (icm.getBlue(i))
+                                & WKConstants.MAX_8_BIT_UNSIGNED_INT;
+                        this.setTransparentColor(new Color(red, grn, blu));
+                        break;
+                    }
+                }
+            }
+        } else {
+            cr = GraphicsUtil.convertTosRGB(cr);
+        }
+
+        // Get our current ColorModel
+        cm = cr.getColorModel();
+        this.setColorSpace(cm.getColorSpace());
+    }
+
+    /**
+     * Decodes the image from the stream.
+     * @param stream the stream to read the image from
+     * @return the decoded image
+     * @throws IOException in case an I/O problem occurs
+     */
+    protected abstract CachableRed decodeImage(SeekableStream stream)
+            throws IOException;
+    
+    /**
+     * {@inheritDoc}
+     */
+    protected void loadImage() throws GraphicException {
+        /* TODO: Check cleanup of resources here. */
+
+        this.setTransparent(this.isTransparent);
+        if (cr == null) {
+            throw new IllegalStateException("Can't load the bitmaps data "
+                    + "without the CachableRed instance");
+        }
+                
+        // Get our current ColorModel
+        final ColorModel cm = cr.getColorModel();
+
+        final int qtyPixels = this.pixelWidth() * this.pixelHeight();
+        // It has an alpha channel so generate a soft mask.
+        if (! this.isTransparent
+                && cm.hasAlpha()) {
+            this.softMask = new byte[qtyPixels];
+        }
+
+        final byte[] decodedBytes = new byte[qtyPixels
+                * this.cr.getColorModel().getNumColorComponents()];
+
+        constructBitmaps(cr, decodedBytes, this.softMask);
+        IOUtils.closeQuietly(seekableInput);
+        seekableInput = null;
+        cr = null;
+        this.setContent(decodedBytes);
+    }
+
+    /**
+     * Transfers the decoded image to our internal representation.
+     * @param red The decoded image to be transferred.
+     * @param bitmaps Our internal image representation.
+     * @param softMask The alpha channel.
+     */
+    private static void constructBitmaps(final RenderedImage red,
+            final byte[] bitmaps, final byte[] softMask) {
+        final WritableRaster wr = (WritableRaster) red.getData();
+        final ColorModel cm = red.getColorModel();
+        final BufferedImage bi = new BufferedImage(cm,
+                wr.createWritableTranslatedChild(0, 0),
+                cm.isAlphaPremultiplied(), null);
+        final int width = red.getWidth();
+        final int height = red.getHeight();
+        int [] tmpMap = new int[width];
+        int idx = 0;
+        int sfIdx = 0;
+        for (int y = 0; y < height; y++) {
+            tmpMap = bi.getRGB(0, y, width, 1, tmpMap, 0, width);
+            if (softMask != null) {
+                for (int x = 0; x < width; x++) {
+                    final int pix = tmpMap[x];
+                    softMask[sfIdx++] = (byte)
+                            (pix >>> WKConstants.SHIFT_3_BYTES);
+                    bitmaps[idx++] = (byte)
+                            ((pix >>> WKConstants.SHIFT_2_BYTES)
+                            & WKConstants.MAX_8_BIT_UNSIGNED_INT);
+                    bitmaps[idx++] = (byte)
+                            ((pix >>> WKConstants.SHIFT_1_BYTE)
+                            & WKConstants.MAX_8_BIT_UNSIGNED_INT);
+                    bitmaps[idx++] = (byte)
+                            (pix & WKConstants.MAX_8_BIT_UNSIGNED_INT);
+                }
+            } else {
+                for (int x = 0; x < width; x++) {
+                    final int pix = tmpMap[x];
+                    bitmaps[idx++] = (byte) ((pix >> WKConstants.SHIFT_2_BYTES)
+                            & WKConstants.MAX_8_BIT_UNSIGNED_INT);
+                    bitmaps[idx++] = (byte) ((pix >> WKConstants.SHIFT_1_BYTE)
+                            & WKConstants.MAX_8_BIT_UNSIGNED_INT);
+                    bitmaps[idx++] = (byte) (pix
+                            & WKConstants.MAX_8_BIT_UNSIGNED_INT);
+                }
+            }
+        }
+    }
+
+}


Property changes on: trunk/foray/foray-graphic/src/java/org/foray/graphic/BatikCodecImage.java
___________________________________________________________________
Name: svn:keywords
   + "Author Id Rev Date URL"
Name: svn:eol-style
   + native

Modified: trunk/foray/foray-graphic/src/java/org/foray/graphic/PNGGraphic.java
===================================================================
--- trunk/foray/foray-graphic/src/java/org/foray/graphic/PNGGraphic.java	2007-02-06 04:00:33 UTC (rev 8609)
+++ trunk/foray/foray-graphic/src/java/org/foray/graphic/PNGGraphic.java	2007-02-07 02:50:07 UTC (rev 8610)
@@ -28,10 +28,13 @@
 
 package org.foray.graphic;
 
-import org.foray.common.WKConstants;
-
 import org.axsl.graphicR.GraphicException;
 
+import org.apache.xmlgraphics.image.codec.png.PNGDecodeParam;
+import org.apache.xmlgraphics.image.codec.png.PNGRed;
+import org.apache.xmlgraphics.image.codec.util.SeekableStream;
+import org.apache.xmlgraphics.image.rendered.CachableRed;
+
 import java.io.BufferedInputStream;
 import java.io.IOException;
 import java.net.URL;
@@ -39,7 +42,7 @@
 /**
  * A PNG (Portable Network Graphics) images.
  */
-public class PNGGraphic extends JAIGraphic {
+public class PNGGraphic extends BatikCodecImage {
 
     /** The number of bytes that need to be read to get the basic information
      * for a PNG file. */
@@ -54,6 +57,11 @@
     protected static final byte PIXEL_HEIGHT_STARTS = 20;
 
     /**
+     * Legacy magic number. TODO: Find basis for this number.
+     */
+    private static final float SRGB_GAMMA = 2.2f;
+
+    /**
      * Constructor.
      * @param server The parent graphic server.
      * @param url The URL which contains the graphic content.
@@ -75,19 +83,6 @@
     /**
      * {@inheritDoc}
      */
-    public void parseBasics() throws IOException {
-        final byte[] header = new byte[PNGGraphic.PNG_BASICS_LENGTH];
-        getInputStream().read(header);
-        /* PNG is always big endian. */
-        setPixelWidth((int) WKConstants.unsignedBytesToLongBE(header,
-                PIXEL_WIDTH_STARTS));
-        setPixelHeight((int) WKConstants.unsignedBytesToLongBE(header,
-                PIXEL_HEIGHT_STARTS));
-    }
-
-    /**
-     * {@inheritDoc}
-     */
     public String getName() {
         return null;
     }
@@ -106,4 +101,24 @@
         return Graphic.TYPE_PNG;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    protected CachableRed decodeImage(final SeekableStream stream)
+            throws IOException {
+        final PNGDecodeParam param = new PNGDecodeParam();
+        param.setPerformGammaCorrection(true);
+        param.setDisplayExponent(SRGB_GAMMA);
+        final PNGRed red = new PNGRed(stream, param); 
+//        final String unit = (String) red.getProperty("pixel_units");
+//        if ("Meters".equals(unit)) {
+//            int dpi = ((Integer)red.getProperty(
+//                    "x_pixels_per_unit")).intValue();
+//            this.dpiHorizontal = dpi * 25.4f / 1000f;
+//            dpi = ((Integer)red.getProperty("y_pixels_per_unit")).intValue();
+//            this.dpiVertical = dpi * 25.4f / 1000f;
+//        }
+        return red;
+    }
+
 }

Added: trunk/foray/lib/xmlgraphics-commons-1.1.jar
===================================================================
(Binary files differ)


Property changes on: trunk/foray/lib/xmlgraphics-commons-1.1.jar
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/foray/lib/xmlgraphics-commons.LICENSE.txt
===================================================================
--- trunk/foray/lib/xmlgraphics-commons.LICENSE.txt	                        (rev 0)
+++ trunk/foray/lib/xmlgraphics-commons.LICENSE.txt	2007-02-07 02:50:07 UTC (rev 8610)
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.


Property changes on: trunk/foray/lib/xmlgraphics-commons.LICENSE.txt
___________________________________________________________________
Name: svn:keywords
   + "Author Id Rev Date URL"
Name: svn:eol-style
   + native


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.