/**
* Copyright 2013 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``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 JogAmp Community 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.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
*/
package com.jogamp.nativewindow.awt;
import java.awt.Point;
import java.awt.color.ColorSpace;
import java.awt.image.BufferedImage;
import java.awt.image.ColorModel;
import java.awt.image.DataBuffer;
import java.awt.image.DirectColorModel;
import java.awt.image.SampleModel;
import java.awt.image.SinglePixelPackedSampleModel;
import java.awt.image.WritableRaster;
import java.nio.ByteBuffer;
import java.nio.IntBuffer;
import java.util.Hashtable;
import com.jogamp.common.nio.Buffers;
/**
* {@link DataBuffer} specialization using NIO direct buffer of type {@link DataBuffer#TYPE_INT} as storage.
*/
public final class DirectDataBufferInt extends DataBuffer {
public static class DirectWritableRaster extends WritableRaster {
protected DirectWritableRaster(final SampleModel sampleModel, final DirectDataBufferInt dataBuffer, final Point origin) {
super(sampleModel, dataBuffer, origin);
}
}
public static class BufferedImageInt extends BufferedImage {
final int customImageType;
final DirectDataBufferInt dataBuffer;
public BufferedImageInt (final int customImageType, final ColorModel cm,
final DirectDataBufferInt dataBuffer, final WritableRaster raster, final Hashtable<?,?> properties) {
super(cm, raster, false /* isRasterPremultiplied */, properties);
this.customImageType = customImageType;
this.dataBuffer = dataBuffer;
}
/**
* @return one of the custom image-type values {@link BufferedImage#TYPE_INT_ARGB TYPE_INT_ARGB},
* {@link BufferedImage#TYPE_INT_ARGB_PRE TYPE_INT_ARGB_PRE},
* {@link BufferedImage#TYPE_INT_RGB TYPE_INT_RGB} or {@link BufferedImage#TYPE_INT_BGR TYPE_INT_BGR}.
*/
public int getCustomType() {
return customImageType;
}
/**
* Returns the underlying {@link DirectDataBufferInt} associated with this instance via {@link Raster} {@link #getRaster() instance}.
*/
public DirectDataBufferInt getDataBuffer() { return dataBuffer; }
@Override
public String toString() {
return "BufferedImageInt@"+Integer.toHexString(hashCode())
+": custom/internal type = "+customImageType+"/"+getType()
+" "+getColorModel()+" "+getRaster();
}
}
/**
* Creates a {@link BufferedImageInt} using a {@link DirectColorModel direct color model} in {@link ColorSpace#CS_sRGB sRGB color space}.<br>
* It uses a {@link DirectWritableRaster} utilizing {@link DirectDataBufferInt} storage.
* <p>
* Note that due to using the custom storage type {@link DirectDataBufferInt}, the resulting
* {@link BufferedImage}'s {@link BufferedImage#getType() image-type} is of {@link BufferedImage#TYPE_CUSTOM TYPE_CUSTOM}.
* We are not able to change this detail, since the AWT image implementation associates the {@link BufferedImage#getType() image-type}
* with a build-in storage-type.
* Use {@link BufferedImageInt#getCustomType()} to retrieve the custom image-type, which will return the <code>imageType</code>
* value passed here.
* </p>
*
* @param width
* @param height
* @param imageType one of {@link BufferedImage#TYPE_INT_ARGB TYPE_INT_ARGB}, {@link BufferedImage#TYPE_INT_ARGB_PRE TYPE_INT_ARGB_PRE},
* {@link BufferedImage#TYPE_INT_RGB TYPE_INT_RGB} or {@link BufferedImage#TYPE_INT_BGR TYPE_INT_BGR}.
* @param location origin, if <code>null</code> 0/0 is assumed.
* @param properties <code>Hashtable</code> of
* <code>String</code>/<code>Object</code> pairs. Used for {@link BufferedImage#getProperty(String)} etc.
* @return
*/
public static BufferedImageInt createBufferedImage(final int width, final int height, final int imageType, Point location, final Hashtable<?,?> properties) {
final ColorSpace colorSpace = ColorSpace.getInstance(ColorSpace.CS_sRGB);
final int transferType = DataBuffer.TYPE_INT;
final int bpp, rmask, gmask, bmask, amask;
final boolean alphaPreMul;
switch( imageType ) {
case BufferedImage.TYPE_INT_ARGB:
bpp = 32;
rmask = 0x00ff0000;
gmask = 0x0000ff00;
bmask = 0x000000ff;
amask = 0xff000000;
alphaPreMul = false;
break;
case BufferedImage.TYPE_INT_ARGB_PRE:
bpp = 32;
rmask = 0x00ff0000;
gmask = 0x0000ff00;
bmask = 0x000000ff;
amask = 0xff000000;
alphaPreMul = true;
break;
case BufferedImage.TYPE_INT_RGB:
bpp = 24;
rmask = 0x00ff0000;
gmask = 0x0000ff00;
bmask = 0x000000ff;
amask = 0x0;
alphaPreMul = false;
break;
case BufferedImage.TYPE_INT_BGR:
bpp = 24;
rmask = 0x000000ff;
gmask = 0x0000ff00;
bmask = 0x00ff0000;
amask = 0x0;
alphaPreMul = false;
break;
default:
throw new IllegalArgumentException("Unsupported imageType, must be [INT_ARGB, INT_ARGB_PRE, INT_RGB, INT_BGR], has "+imageType);
}
final ColorModel colorModel = new DirectColorModel(colorSpace, bpp, rmask, gmask, bmask, amask, alphaPreMul, transferType);
final int[] bandMasks;
if ( 0 != amask ) {
bandMasks = new int[4];
bandMasks[3] = amask;
}
else {
bandMasks = new int[3];
}
bandMasks[0] = rmask;
bandMasks[1] = gmask;
bandMasks[2] = bmask;
final DirectDataBufferInt dataBuffer = new DirectDataBufferInt(width*height);
if( null == location ) {
location = new Point(0,0);
}
final SinglePixelPackedSampleModel sppsm = new SinglePixelPackedSampleModel(dataBuffer.getDataType(),
width, height, width /* scanLineStride */, bandMasks);
// IntegerComponentRasters must haveinteger DataBuffers:
// final WritableRaster raster = new IntegerInterleavedRaster(sppsm, dataBuffer, location);
// Not public:
// final WritableRaster raster = new SunWritableRaster(sppsm, dataBuffer, location);
final WritableRaster raster = new DirectWritableRaster(sppsm, dataBuffer, location);
return new BufferedImageInt(imageType, colorModel, dataBuffer, raster, properties);
}
/** Default NIO data bank storage, {@link ByteBuffer} representation. */
private final ByteBuffer dataBytes;
/** Default NIO data bank storage, {@link IntBuffer} representation. */
private final IntBuffer dataInts;
/** All NIO data banks, {@link ByteBuffer} representation. */
private final ByteBuffer bankdataBytes[];
/** All NIO data banks, {@link IntBuffer} representation. */
private final IntBuffer bankdataInts[];
/**
* Constructs an nio integer-based {@link DataBuffer} with a single bank
* and the specified size.
*
* @param size The size of the {@link DataBuffer}.
*/
public DirectDataBufferInt(final int size) {
super(TYPE_INT, size);
dataBytes = Buffers.newDirectByteBuffer(size * Buffers.SIZEOF_INT);
dataInts = dataBytes.asIntBuffer();
bankdataBytes = new ByteBuffer[1];
bankdataInts = new IntBuffer[1];
bankdataBytes[0] = dataBytes;
bankdataInts[0] = dataInts;
}
/**
* Constructs an nio integer-based {@link DataBuffer} with the specified number of
* banks, all of which are the specified size.
*
* @param size The size of the banks in the {@link DataBuffer}.
* @param numBanks The number of banks in the a{@link DataBuffer}.
*/
public DirectDataBufferInt(final int size, final int numBanks) {
super(TYPE_INT,size,numBanks);
bankdataBytes = new ByteBuffer[numBanks];
bankdataInts = new IntBuffer[numBanks];
for (int i= 0; i < numBanks; i++) {
bankdataBytes[i] = Buffers.newDirectByteBuffer(size * Buffers.SIZEOF_INT);
bankdataInts[i] = bankdataBytes[i].asIntBuffer();
}
dataBytes = bankdataBytes[0];
dataInts = bankdataInts[0];
}
/**
* Constructs an nio integer-based {@link DataBuffer} with a single bank using the
* specified array.
* <p>
* Only the first <code>size</code> elements should be used by accessors of
* this {@link DataBuffer}. <code>dataArray</code> must be large enough to
* hold <code>size</code> elements.
* </p>
*
* @param dataArray The NIO {@link ByteBuffer} array, holding the integer data for the {@link DataBuffer}.
* @param size The size of the {@link DataBuffer} bank.
*/
public DirectDataBufferInt(final ByteBuffer dataArray, final int size) {
super(TYPE_INT,size);
dataBytes = Buffers.nativeOrder(dataArray);
dataInts = dataBytes.asIntBuffer();
bankdataBytes = new ByteBuffer[1];
bankdataInts = new IntBuffer[1];
bankdataBytes[0] = dataBytes;
bankdataInts[0] = dataInts;
}
/**
* Returns the default (first) int data array in {@link DataBuffer} as an {@link IntBuffer} representation.
*
* @return The first integer data array.
* @see #getDataBytes()
*/
public IntBuffer getData() {
return dataInts;
}
/**
* Returns the default (first) int data array in {@link DataBuffer} as a {@link ByteBuffer} representation.
*
* @return The first integer data array.
* @see #getData()
*/
public ByteBuffer getDataBytes() {
return dataBytes;
}
/**
* Returns the data array for the specified bank as an {@link IntBuffer} representation.
*
* @param bank The bank whose data array you want to get.
* @return The data array for the specified bank.
* @see #getDataBytes(int)
*/
public IntBuffer getData(final int bank) {
return bankdataInts[bank];
}
/**
* Returns the data array for the specified bank as a {@link ByteBuffer} representation.
*
* @param bank The bank whose data array you want to get.
* @return The data array for the specified bank.
* @see #getData(int)
*/
public ByteBuffer getDataBytes(final int bank) {
return bankdataBytes[bank];
}
/**
* Returns the requested data array element from the first (default) bank.
*
* @param i The data array element you want to get.
* @return The requested data array element as an integer.
* @see #setElem(int, int)
* @see #setElem(int, int, int)
*/
@Override
public int getElem(final int i) {
return dataInts.get(i+offset);
}
/**
* Returns the requested data array element from the specified bank.
*
* @param bank The bank from which you want to get a data array element.
* @param i The data array element you want to get.
* @return The requested data array element as an integer.
* @see #setElem(int, int)
* @see #setElem(int, int, int)
*/
@Override
public int getElem(final int bank, final int i) {
return bankdataInts[bank].get(i+offsets[bank]);
}
/**
* Sets the requested data array element in the first (default) bank
* to the specified value.
*
* @param i The data array element you want to set.
* @param val The integer value to which you want to set the data array element.
* @see #getElem(int)
* @see #getElem(int, int)
*/
@Override
public void setElem(final int i, final int val) {
dataInts.put(i+offset, val);
}
/**
* Sets the requested data array element in the specified bank
* to the integer value <code>i</code>.
* @param bank The bank in which you want to set the data array element.
* @param i The data array element you want to set.
* @param val The integer value to which you want to set the specified data array element.
* @see #getElem(int)
* @see #getElem(int, int)
*/
@Override
public void setElem(final int bank, final int i, final int val) {
bankdataInts[bank].put(i+offsets[bank], val);
}
}