Reorganized TextureIO classes to enable code sharing between desktop

and mobile platforms


git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/svn-server-sync/jogl/branches/JOGL_2_SANDBOX@1723 232f8b59-042b-4e1e-8c03-345bb8c30851

3 files changed, 384 insertions, 0 deletions

diff --git a/src/classes/com/sun/opengl/util/texture/spi/TextureProvider.java b/src/classes/com/sun/opengl/util/texture/spi/TextureProvider.java
new file mode 100755
index 000000000..1c822ef02
--- /dev/null
+++ b/src/classes/com/sun/opengl/util/texture/spi/TextureProvider.java
@@ -0,0 +1,165 @@
+/*
+ * Copyright (c) 2005 Sun Microsystems, Inc. All Rights Reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * 
+ * - Redistribution of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * 
+ * - Redistribution in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * 
+ * Neither the name of Sun Microsystems, Inc. or the names of
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * 
+ * This software is provided "AS IS," without a warranty of any kind. ALL
+ * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
+ * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
+ * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
+ * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
+ * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
+ * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
+ * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
+ * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
+ * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
+ * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
+ * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+ * 
+ * You acknowledge that this software is not designed or intended for use
+ * in the design, construction, operation or maintenance of any nuclear
+ * facility.
+ * 
+ * Sun gratefully acknowledges that this software was originally authored
+ * and developed by Kenneth Bradley Russell and Christopher John Kline.
+ */
+
+package com.sun.opengl.util.texture.spi;
+
+import java.io.*;
+import java.net.*;
+
+import com.sun.opengl.util.texture.*;
+
+/** Plug-in interface to TextureIO to support reading OpenGL textures
+    from new file formats. For all methods, either internalFormat or
+    pixelFormat may be 0 in which case they must be inferred as
+    e.g. RGB or RGBA depending on the file contents.
+*/
+
+public interface TextureProvider {
+
+  /**
+   * Produces a TextureData object from a file, or returns null if the
+   * file format was not supported by this TextureProvider. Does not
+   * do any OpenGL-related work. The resulting TextureData can be
+   * converted into an OpenGL texture in a later step.
+   *
+   * @param file         the file from which to read the texture data
+   *
+   * @param internalFormat the OpenGL internal format to be used for
+   *                       the texture, or 0 if it should be inferred
+   *                       from the file's contents
+   *
+   * @param pixelFormat    the OpenGL pixel format to be used for
+   *                       the texture, or 0 if it should be inferred
+   *                       from the file's contents
+   *
+   * @param mipmap     whether mipmaps should be produced for this
+   *                   texture either by autogenerating them or
+   *                   reading them from the file. Some file formats
+   *                   support multiple mipmaps in a single file in
+   *                   which case those mipmaps will be used rather
+   *                   than generating them.
+   *
+   * @param fileSuffix     the file suffix to be used as a hint to the
+   *                       provider to more quickly decide whether it
+   *                       can handle the file, or null if the
+   *                       provider should infer the type from the
+   *                       file's contents
+   *
+   * @throws IOException if an error occurred while reading the file
+   */
+  public TextureData newTextureData(File file,
+                                    int internalFormat,
+                                    int pixelFormat,
+                                    boolean mipmap,
+                                    String fileSuffix) throws IOException;
+
+  /**
+   * Produces a TextureData object from a stream, or returns null if
+   * the file format was not supported by this TextureProvider. Does
+   * not do any OpenGL-related work. The resulting TextureData can be
+   * converted into an OpenGL texture in a later step.
+   *
+   * @param stream       the stream from which to read the texture data
+   *
+   * @param internalFormat the OpenGL internal format to be used for
+   *                       the texture, or 0 if it should be inferred
+   *                       from the file's contents
+   *
+   * @param pixelFormat    the OpenGL pixel format to be used for
+   *                       the texture, or 0 if it should be inferred
+   *                       from the file's contents
+   *
+   * @param mipmap     whether mipmaps should be produced for this
+   *                   texture either by autogenerating them or
+   *                   reading them from the file. Some file formats
+   *                   support multiple mipmaps in a single file in
+   *                   which case those mipmaps will be used rather
+   *                   than generating them.
+   *
+   * @param fileSuffix     the file suffix to be used as a hint to the
+   *                       provider to more quickly decide whether it
+   *                       can handle the file, or null if the
+   *                       provider should infer the type from the
+   *                       file's contents
+   *
+   * @throws IOException if an error occurred while reading the stream
+   */
+  public TextureData newTextureData(InputStream stream,
+                                    int internalFormat,
+                                    int pixelFormat,
+                                    boolean mipmap,
+                                    String fileSuffix) throws IOException;
+
+  /**
+   * Produces a TextureData object from a URL, or returns null if the
+   * file format was not supported by this TextureProvider. Does not
+   * do any OpenGL-related work. The resulting TextureData can be
+   * converted into an OpenGL texture in a later step.
+   *
+   * @param url          the URL from which to read the texture data
+   *
+   * @param internalFormat the OpenGL internal format to be used for
+   *                       the texture, or 0 if it should be inferred
+   *                       from the file's contents
+   *
+   * @param pixelFormat    the OpenGL pixel format to be used for
+   *                       the texture, or 0 if it should be inferred
+   *                       from the file's contents
+   *
+   * @param mipmap     whether mipmaps should be produced for this
+   *                   texture either by autogenerating them or
+   *                   reading them from the file. Some file formats
+   *                   support multiple mipmaps in a single file in
+   *                   which case those mipmaps will be used rather
+   *                   than generating them.
+   *
+   * @param fileSuffix     the file suffix to be used as a hint to the
+   *                       provider to more quickly decide whether it
+   *                       can handle the file, or null if the
+   *                       provider should infer the type from the
+   *                       file's contents
+   *
+   * @throws IOException if an error occurred while reading the URL
+   */
+  public TextureData newTextureData(URL url,
+                                    int internalFormat,
+                                    int pixelFormat,
+                                    boolean mipmap,
+                                    String fileSuffix) throws IOException;
+}
diff --git a/src/classes/com/sun/opengl/util/texture/spi/awt/IIOTextureProvider.java b/src/classes/com/sun/opengl/util/texture/spi/awt/IIOTextureProvider.java
new file mode 100644
index 000000000..0244db285
--- /dev/null
+++ b/src/classes/com/sun/opengl/util/texture/spi/awt/IIOTextureProvider.java
@@ -0,0 +1,100 @@
+/*
+ * Copyright (c) 2005 Sun Microsystems, Inc. All Rights Reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * 
+ * - Redistribution of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * 
+ * - Redistribution in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * 
+ * Neither the name of Sun Microsystems, Inc. or the names of
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * 
+ * This software is provided "AS IS," without a warranty of any kind. ALL
+ * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
+ * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
+ * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
+ * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
+ * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
+ * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
+ * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
+ * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
+ * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
+ * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
+ * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+ * 
+ * You acknowledge that this software is not designed or intended for use
+ * in the design, construction, operation or maintenance of any nuclear
+ * facility.
+ * 
+ * Sun gratefully acknowledges that this software was originally authored
+ * and developed by Kenneth Bradley Russell and Christopher John Kline.
+ */
+
+package com.sun.opengl.util.texture.spi.awt;
+
+import java.awt.Graphics;
+import java.awt.image.*;
+import java.io.*;
+import java.net.*;
+import javax.imageio.*;
+
+import com.sun.opengl.impl.Debug;
+import com.sun.opengl.util.texture.*;
+import com.sun.opengl.util.texture.awt.*;
+import com.sun.opengl.util.texture.spi.*;
+
+public class IIOTextureProvider implements TextureProvider {
+    private static final boolean DEBUG = Debug.debug("TextureIO");
+
+    public TextureData newTextureData(File file,
+                                      int internalFormat,
+                                      int pixelFormat,
+                                      boolean mipmap,
+                                      String fileSuffix) throws IOException {
+        BufferedImage img = ImageIO.read(file);
+        if (img == null) {
+            return null;
+        }
+        if (DEBUG) {
+            System.out.println("TextureIO.newTextureData(): BufferedImage type for " + file + " = " +
+                               img.getType());
+        }
+        return new AWTTextureData(internalFormat, pixelFormat, mipmap, img);
+    }
+
+    public TextureData newTextureData(InputStream stream,
+                                      int internalFormat,
+                                      int pixelFormat,
+                                      boolean mipmap,
+                                      String fileSuffix) throws IOException {
+        BufferedImage img = ImageIO.read(stream);
+        if (img == null) {
+            return null;
+        }
+        if (DEBUG) {
+            System.out.println("TextureIO.newTextureData(): BufferedImage type for stream = " +
+                               img.getType());
+        }
+        return new AWTTextureData(internalFormat, pixelFormat, mipmap, img);
+    }
+
+    public TextureData newTextureData(URL url,
+                                      int internalFormat,
+                                      int pixelFormat,
+                                      boolean mipmap,
+                                      String fileSuffix) throws IOException {
+        InputStream stream = url.openStream();
+        try {
+            return newTextureData(stream, internalFormat, pixelFormat, mipmap, fileSuffix);
+        } finally {
+            stream.close();
+        }
+    }
+}
diff --git a/src/classes/com/sun/opengl/util/texture/spi/awt/IIOTextureWriter.java b/src/classes/com/sun/opengl/util/texture/spi/awt/IIOTextureWriter.java
new file mode 100644
index 000000000..b45793e2b
--- /dev/null
+++ b/src/classes/com/sun/opengl/util/texture/spi/awt/IIOTextureWriter.java
@@ -0,0 +1,119 @@
+/*
+ * Copyright (c) 2005 Sun Microsystems, Inc. All Rights Reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * 
+ * - Redistribution of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * 
+ * - Redistribution in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * 
+ * Neither the name of Sun Microsystems, Inc. or the names of
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * 
+ * This software is provided "AS IS," without a warranty of any kind. ALL
+ * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
+ * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
+ * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
+ * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
+ * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
+ * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
+ * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
+ * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
+ * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
+ * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
+ * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+ * 
+ * You acknowledge that this software is not designed or intended for use
+ * in the design, construction, operation or maintenance of any nuclear
+ * facility.
+ * 
+ * Sun gratefully acknowledges that this software was originally authored
+ * and developed by Kenneth Bradley Russell and Christopher John Kline.
+ */
+
+package com.sun.opengl.util.texture.spi.awt;
+
+import java.awt.Graphics;
+import java.awt.image.*;
+import java.io.*;
+import java.net.*;
+import java.nio.*;
+import javax.imageio.*;
+
+import javax.media.opengl.*;
+import com.sun.opengl.util.awt.*;
+import com.sun.opengl.util.io.*;
+import com.sun.opengl.util.texture.*;
+import com.sun.opengl.util.texture.spi.*;
+
+public class IIOTextureWriter implements TextureWriter {
+    public boolean write(File file,
+                         TextureData data) throws IOException {
+        int pixelFormat = data.getPixelFormat();
+        int pixelType   = data.getPixelType();
+        if ((pixelFormat == GL.GL_RGB ||
+             pixelFormat == GL.GL_RGBA) &&
+            (pixelType == GL.GL_BYTE ||
+             pixelType == GL.GL_UNSIGNED_BYTE)) {
+            // Convert TextureData to appropriate BufferedImage
+            // FIXME: almost certainly not obeying correct pixel order
+            BufferedImage image = new BufferedImage(data.getWidth(), data.getHeight(),
+                                                    (pixelFormat == GL.GL_RGB) ?
+                                                    BufferedImage.TYPE_3BYTE_BGR :
+                                                    BufferedImage.TYPE_4BYTE_ABGR);
+            byte[] imageData = ((DataBufferByte) image.getRaster().getDataBuffer()).getData();
+            ByteBuffer buf = (ByteBuffer) data.getBuffer();
+            if (buf == null) {
+                buf = (ByteBuffer) data.getMipmapData()[0];
+            }
+            buf.rewind();
+            buf.get(imageData);
+            buf.rewind();
+
+            // Swizzle image components to be correct
+            if (pixelFormat == GL.GL_RGB) {
+                for (int i = 0; i < imageData.length; i += 3) {
+                    byte red  = imageData[i + 0];
+                    byte blue = imageData[i + 2];
+                    imageData[i + 0] = blue;
+                    imageData[i + 2] = red;
+                }
+            } else {
+                for (int i = 0; i < imageData.length; i += 4) {
+                    byte red   = imageData[i + 0];
+                    byte green = imageData[i + 1];
+                    byte blue  = imageData[i + 2];
+                    byte alpha = imageData[i + 3];
+                    imageData[i + 0] = alpha;
+                    imageData[i + 1] = blue;
+                    imageData[i + 2] = green;
+                    imageData[i + 3] = red;
+                }
+            }
+
+            // Flip image vertically for the user's convenience
+            ImageUtil.flipImageVertically(image);
+
+            // Happened to notice that writing RGBA images to JPEGS is broken
+            if (TextureIO.JPG.equals(FileUtil.getFileSuffix(file)) &&
+                image.getType() == BufferedImage.TYPE_4BYTE_ABGR) {
+                BufferedImage tmpImage = new BufferedImage(image.getWidth(), image.getHeight(),
+                                                           BufferedImage.TYPE_3BYTE_BGR);
+                Graphics g = tmpImage.getGraphics();
+                g.drawImage(image, 0, 0, null);
+                g.dispose();
+                image = tmpImage;
+            }
+
+            return ImageIO.write(image, FileUtil.getFileSuffix(file), file);
+        }
+      
+        throw new IOException("ImageIO writer doesn't support this pixel format / type (only GL_RGB/A + bytes)");
+    }
+}