engine/src/blender/com/jme3/scene/plugins/blender/textures/ImageLoader.java

/*
 * Copyright (c) 2009-2010 jMonkeyEngine
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions 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 'jMonkeyEngine' nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.jme3.scene.plugins.blender.textures;

import com.jme3.scene.plugins.blender.file.BlenderInputStream;
import com.jme3.texture.Image;
import com.jme3.texture.plugins.AWTLoader;
import com.jme3.texture.plugins.DDSLoader;
import com.jme3.texture.plugins.TGALoader;
import java.io.InputStream;
import java.util.logging.Logger;

/**
 * An image loader class. It uses three loaders (AWTLoader, TGALoader and DDSLoader) in an attempt to load the image from the given
 * input stream.
 * 
 * @author Marcin Roguski (Kaelthas)
 */
/*package*/ class ImageLoader extends AWTLoader {
	private static final Logger	LOGGER		= Logger.getLogger(ImageLoader.class.getName());

	protected DDSLoader			ddsLoader	= new DDSLoader();									// DirectX image loader

	/**
	 * This method loads the image from the blender file itself. It tries each loader to load the image.
	 * 
	 * @param inputStream
	 *        blender input stream
	 * @param startPosition
	 *        position in the stream where the image data starts
	 * @param flipY
	 *        if the image should be flipped (does not work with DirectX image)
	 * @return loaded image or null if it could not be loaded
	 */
	public Image loadImage(BlenderInputStream inputStream, int startPosition, boolean flipY) {
		// loading using AWT loader
		inputStream.setPosition(startPosition);
		Image result = this.loadImage(inputStream, ImageType.AWT, flipY);
		// loading using TGA loader
		if (result == null) {
			inputStream.setPosition(startPosition);
			result = this.loadImage(inputStream, ImageType.TGA, flipY);
		}
		// loading using DDS loader
		if (result == null) {
			inputStream.setPosition(startPosition);
			result = this.loadImage(inputStream, ImageType.DDS, flipY);
		}

		if (result == null) {
			LOGGER.warning("Image could not be loaded by none of available loaders!");
		}

		return result;
	}

	/**
	 * This method loads an image of a specified type from the given input stream.
	 * 
	 * @param inputStream
	 *        the input stream we read the image from
	 * @param imageType
	 *        the type of the image {@link ImageType}
	 * @param flipY
	 *        if the image should be flipped (does not work with DirectX image)
	 * @return loaded image or null if it could not be loaded
	 */
	public Image loadImage(InputStream inputStream, ImageType imageType, boolean flipY) {
		Image result = null;
		switch (imageType) {
			case AWT:
				try {
					result = this.load(inputStream, flipY);
				} catch (Exception e) {
					LOGGER.info("Unable to load image using AWT loader!");
				}
				break;
			case DDS:
				try {
					result = ddsLoader.load(inputStream);
				} catch (Exception e) {
					LOGGER.info("Unable to load image using DDS loader!");
				}
				break;
			case TGA:
				try {
					result = TGALoader.load(inputStream, flipY);
				} catch (Exception e) {
					LOGGER.info("Unable to load image using TGA loader!");
				}
				break;
			default:
				throw new IllegalStateException("Unknown image type: " + imageType);
		}
		return result;
	}
	
	/**
	 * Image types that can be loaded. AWT: png, jpg, jped or bmp TGA: tga DDS: DirectX image files
	 * 
	 * @author Marcin Roguski (Kaelthas)
	 */
	private static enum ImageType {
		AWT, TGA, DDS;
	}
}