/*

 * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

#include <stdio.h>

#include <stdlib.h>

#include "awt_parseImage.h"

#include "imageInitIDs.h"

#include "java_awt_Transparency.h"

#include "java_awt_image_BufferedImage.h"

#include "sun_awt_image_IntegerComponentRaster.h"

#include "sun_awt_image_ImagingLib.h"

#include "java_awt_color_ColorSpace.h"

#include "awt_Mlib.h"

#include "safe_alloc.h"

#include "safe_math.h"

static int setHints(JNIEnv *env, BufImageS_t *imageP);

/* Parse the buffered image.  All of the raster information is returned in the

 * imagePP structure.

 *

 * The handleCustom parameter specifies whether or not the caller

 * can use custom channels.  If it is false and a custom channel

 * is encountered, the returned value will be 0 and all structures

 * will be deallocated.

 *

 * Return value:

 *    -1:     Exception

 *     0:     Can't do it.

 *     1:     Success

 */

int awt_parseImage(JNIEnv *env, jobject jimage, BufImageS_t **imagePP,

                   int handleCustom) {

    BufImageS_t *imageP;

    int status;

    jobject jraster;

    jobject jcmodel;

    /* Make sure the image exists */

    if (JNU_IsNull(env, jimage)) {

        JNU_ThrowNullPointerException(env, "null BufferedImage object");

        return -1;

    }

    if ((imageP = (BufImageS_t *) calloc(1, sizeof(BufImageS_t))) == NULL) {

        JNU_ThrowOutOfMemoryError(env, "Out of memory");

        return -1;

    }

    imageP->jimage = jimage;

    /* Retrieve the raster */

    if ((jraster = (*env)->GetObjectField(env, jimage,

                                          g_BImgRasterID)) == NULL) {

        free((void *) imageP);

        JNU_ThrowNullPointerException(env, "null Raster object");

        return 0;

    }

    /* Retrieve the image type */

    imageP->imageType = (*env)->GetIntField(env, jimage, g_BImgTypeID);

    /* Parse the raster */

    if ((status = awt_parseRaster(env, jraster, &imageP->raster)) <= 0) {

        free((void *)imageP);

        return status;

    }

    /* Retrieve the color model */

    if ((jcmodel = (*env)->GetObjectField(env, jimage, g_BImgCMID)) == NULL) {

        free((void *) imageP);

        JNU_ThrowNullPointerException(env, "null Raster object");

        return 0;

    }

    /* Parse the color model */

    if ((status = awt_parseColorModel(env, jcmodel, imageP->imageType,

                                      &imageP->cmodel)) <= 0) {

        awt_freeParsedRaster(&imageP->raster, FALSE);

        free((void *)imageP);

        return 0;

    }

    /* Set hints  */

    if ((status = setHints(env, imageP)) <= 0) {

        awt_freeParsedImage(imageP, TRUE);

        return 0;

    }

    *imagePP = imageP;

    return status;

}

/* Verifies whether the channel offsets are sane and correspond to the type of

 * the raster.

 *

 * Return value:

 *     0: Failure: channel offsets are invalid

 *     1: Success

 */

static int checkChannelOffsets(RasterS_t *rasterP, int dataArrayLength) {

    int i, lastPixelOffset, lastScanOffset;

    switch (rasterP->rasterType) {

    case COMPONENT_RASTER_TYPE:

        if (!SAFE_TO_MULT(rasterP->height, rasterP->scanlineStride)) {

            return 0;

        }

        if (!SAFE_TO_MULT(rasterP->width, rasterP->pixelStride)) {

            return 0;

        }

        lastScanOffset = (rasterP->height - 1) * rasterP->scanlineStride;

        lastPixelOffset = (rasterP->width - 1) * rasterP->pixelStride;

        if (!SAFE_TO_ADD(lastPixelOffset, lastScanOffset)) {

            return 0;

        }

        lastPixelOffset += lastScanOffset;

        for (i = 0; i < rasterP->numDataElements; i++) {

            int off = rasterP->chanOffsets[i];

            int size = lastPixelOffset + off;

            if (off < 0 || !SAFE_TO_ADD(lastPixelOffset, off)) {

                return 0;

            }

            if (size < lastPixelOffset || size >= dataArrayLength) {

                // an overflow, or insufficient buffer capacity

                return 0;

            }

        }

        return 1;

    case BANDED_RASTER_TYPE:

        // NB:caller does not support the banded rasters yet,

        // so this branch of the code must be re-defined in

        // order to provide valid criteria for the data offsets

        // verification, when/if banded rasters will be supported.

        // At the moment, we prohibit banded rasters as well.

        return 0;

    default:

        // PACKED_RASTER_TYPE: does not support channel offsets

        // UNKNOWN_RASTER_TYPE: should not be used, likely indicates an error

        return 0;

    }

}

/* Parse the raster.  All of the raster information is returned in the

 * rasterP structure.

 *

 * Return value:

 *    -1:     Exception

 *     0:     Can't do it (Custom channel)

 *     1:     Success

 */

int awt_parseRaster(JNIEnv *env, jobject jraster, RasterS_t *rasterP) {

    jobject joffs = NULL;

    /* int status;*/

    if (JNU_IsNull(env, jraster)) {

        JNU_ThrowNullPointerException(env, "null Raster object");

        return -1;

    }

    rasterP->jraster = jraster;

    rasterP->width   = (*env)->GetIntField(env, jraster, g_RasterWidthID);

    rasterP->height  = (*env)->GetIntField(env, jraster, g_RasterHeightID);

    rasterP->numDataElements = (*env)->GetIntField(env, jraster,

                                                   g_RasterNumDataElementsID);

    rasterP->numBands = (*env)->GetIntField(env, jraster,

                                            g_RasterNumBandsID);

    rasterP->baseOriginX = (*env)->GetIntField(env, jraster,

                                               g_RasterBaseOriginXID);

    rasterP->baseOriginY = (*env)->GetIntField(env, jraster,

                                               g_RasterBaseOriginYID);

    rasterP->minX = (*env)->GetIntField(env, jraster, g_RasterMinXID);

    rasterP->minY = (*env)->GetIntField(env, jraster, g_RasterMinYID);

    rasterP->jsampleModel = (*env)->GetObjectField(env, jraster,

                                                   g_RasterSampleModelID);

    if (JNU_IsNull(env, rasterP->jsampleModel)) {

        JNU_ThrowNullPointerException(env, "null Raster object");

        return -1;

    }

    // make sure that the raster type is initialized

    rasterP->rasterType = UNKNOWN_RASTER_TYPE;

    if (rasterP->numBands <= 0 ||

        rasterP->numBands > MAX_NUMBANDS)

    {

        /*

         * we can't handle such kind of rasters due to limitations

         * of SPPSampleModelS_t structure and expand/set methods.

         */

        return 0;

    }

    rasterP->sppsm.isUsed = 0;

    if ((*env)->IsInstanceOf(env, rasterP->jsampleModel,

       (*env)->FindClass(env,"java/awt/image/SinglePixelPackedSampleModel"))) {

        jobject jmask, joffs, jnbits;

        rasterP->sppsm.isUsed = 1;

        rasterP->sppsm.maxBitSize = (*env)->GetIntField(env,

                                                        rasterP->jsampleModel,

                                                        g_SPPSMmaxBitID);

        jmask = (*env)->GetObjectField(env, rasterP->jsampleModel,

                                       g_SPPSMmaskArrID);

        joffs = (*env)->GetObjectField(env, rasterP->jsampleModel,

                                       g_SPPSMmaskOffID);

        jnbits = (*env)->GetObjectField(env, rasterP->jsampleModel,

                                        g_SPPSMnBitsID);

        if (jmask == NULL || joffs == NULL || jnbits == NULL ||

            rasterP->sppsm.maxBitSize < 0)

        {

            JNU_ThrowInternalError(env, "Can't grab SPPSM fields");

            return -1;

        }

        (*env)->GetIntArrayRegion(env, jmask, 0,

                                  rasterP->numBands, rasterP->sppsm.maskArray);

        (*env)->GetIntArrayRegion(env, joffs, 0,

                                  rasterP->numBands, rasterP->sppsm.offsets);

        (*env)->GetIntArrayRegion(env, jnbits, 0,

                                  rasterP->numBands, rasterP->sppsm.nBits);

    }

    rasterP->baseRasterWidth = (*env)->GetIntField(env, rasterP->jsampleModel,

                                                   g_SMWidthID);

    rasterP->baseRasterHeight = (*env)->GetIntField(env,

                                                    rasterP->jsampleModel,

                                                    g_SMHeightID);

    if ((*env)->IsInstanceOf(env, jraster,

         (*env)->FindClass(env, "sun/awt/image/IntegerComponentRaster"))){

        rasterP->jdata = (*env)->GetObjectField(env, jraster, g_ICRdataID);

        rasterP->dataType = INT_DATA_TYPE;

        rasterP->dataSize = 4;

        rasterP->dataIsShared = TRUE;

        rasterP->rasterType = COMPONENT_RASTER_TYPE;

        rasterP->type = (*env)->GetIntField(env, jraster, g_ICRtypeID);

        rasterP->scanlineStride = (*env)->GetIntField(env, jraster, g_ICRscanstrID);

        rasterP->pixelStride = (*env)->GetIntField(env, jraster, g_ICRpixstrID);

        joffs = (*env)->GetObjectField(env, jraster, g_ICRdataOffsetsID);

    }

    else if ((*env)->IsInstanceOf(env, jraster,

            (*env)->FindClass(env, "sun/awt/image/ByteComponentRaster"))){

        rasterP->jdata = (*env)->GetObjectField(env, jraster, g_BCRdataID);

        rasterP->dataType = BYTE_DATA_TYPE;

        rasterP->dataSize = 1;

        rasterP->dataIsShared = TRUE;

        rasterP->rasterType = COMPONENT_RASTER_TYPE;

        rasterP->type = (*env)->GetIntField(env, jraster, g_BCRtypeID);

        rasterP->scanlineStride = (*env)->GetIntField(env, jraster, g_BCRscanstrID);

        rasterP->pixelStride = (*env)->GetIntField(env, jraster, g_BCRpixstrID);

        joffs = (*env)->GetObjectField(env, jraster, g_BCRdataOffsetsID);

    }

    else if ((*env)->IsInstanceOf(env, jraster,

            (*env)->FindClass(env, "sun/awt/image/ShortComponentRaster"))){

        rasterP->jdata = (*env)->GetObjectField(env, jraster, g_SCRdataID);

        rasterP->dataType = SHORT_DATA_TYPE;

        rasterP->dataSize = 2;

        rasterP->dataIsShared = TRUE;

        rasterP->rasterType = COMPONENT_RASTER_TYPE;

        rasterP->type = (*env)->GetIntField(env, jraster, g_SCRtypeID);

        rasterP->scanlineStride = (*env)->GetIntField(env, jraster, g_SCRscanstrID);

        rasterP->pixelStride = (*env)->GetIntField(env, jraster, g_SCRpixstrID);

        joffs = (*env)->GetObjectField(env, jraster, g_SCRdataOffsetsID);

    }

    else if ((*env)->IsInstanceOf(env, jraster,

            (*env)->FindClass(env, "sun/awt/image/BytePackedRaster"))){

        rasterP->rasterType = PACKED_RASTER_TYPE;

        rasterP->dataType = BYTE_DATA_TYPE;

        rasterP->dataSize = 1;

        rasterP->scanlineStride = (*env)->GetIntField(env, jraster, g_BPRscanstrID);

        rasterP->pixelStride = (*env)->GetIntField(env, jraster, g_BPRpixstrID);

        rasterP->jdata = (*env)->GetObjectField(env, jraster, g_BPRdataID);

        rasterP->type = (*env)->GetIntField(env, jraster, g_BPRtypeID);

        rasterP->chanOffsets = NULL;

        if (SAFE_TO_ALLOC_2(rasterP->numDataElements, sizeof(jint))) {

            rasterP->chanOffsets =

                (jint *)malloc(rasterP->numDataElements * sizeof(jint));

        }

        if (rasterP->chanOffsets == NULL) {

            /* Out of memory */

            JNU_ThrowOutOfMemoryError(env, "Out of memory");

            return -1;

        }

        rasterP->chanOffsets[0] = (*env)->GetIntField(env, jraster, g_BPRdataBitOffsetID);

        rasterP->dataType = BYTE_DATA_TYPE;

    }

    else {

        rasterP->type = sun_awt_image_IntegerComponentRaster_TYPE_CUSTOM;

        rasterP->dataType = UNKNOWN_DATA_TYPE;

        rasterP->rasterType = UNKNOWN_RASTER_TYPE;

        rasterP->chanOffsets = NULL;

        /* Custom raster */

        return 0;

    }

    // do basic validation of the raster structure

    if (rasterP->width <= 0 || rasterP->height <= 0 ||

        rasterP->pixelStride <= 0 || rasterP->scanlineStride <= 0)

    {

        // invalid raster

        return -1;

    }

    // channel (data) offsets

    switch (rasterP->rasterType) {

    case COMPONENT_RASTER_TYPE:

    case BANDED_RASTER_TYPE: // note that this routine does not support banded rasters at the moment

        // get channel (data) offsets

        rasterP->chanOffsets = NULL;

        if (SAFE_TO_ALLOC_2(rasterP->numDataElements, sizeof(jint))) {

            rasterP->chanOffsets =

                (jint *)malloc(rasterP->numDataElements * sizeof(jint));

        }

        if (rasterP->chanOffsets == NULL) {

            /* Out of memory */

            JNU_ThrowOutOfMemoryError(env, "Out of memory");

            return -1;

        }

        (*env)->GetIntArrayRegion(env, joffs, 0, rasterP->numDataElements,

                                  rasterP->chanOffsets);

        if (rasterP->jdata == NULL) {

            // unable to verify the raster

            return -1;

        }

        // verify whether channel offsets look sane

        if (!checkChannelOffsets(rasterP, (*env)->GetArrayLength(env, rasterP->jdata))) {

            return -1;

        }

        break;

    default:

        ; // PACKED_RASTER_TYPE does not use the channel offsets.

    }

    /* additional check for sppsm fields validity: make sure that

     * size of raster samples doesn't exceed the data type capacity.

     */

    if (rasterP->dataType > UNKNOWN_DATA_TYPE && /* data type has been recognized */

        rasterP->sppsm.maxBitSize > 0 && /* raster has SPP sample model */

        rasterP->sppsm.maxBitSize > (rasterP->dataSize * 8))

    {

        JNU_ThrowInternalError(env, "Raster samples are too big");

        return -1;

    }

#if 0

    fprintf(stderr,"---------------------\n");

    fprintf(stderr,"Width  : %d\n",rasterP->width);

    fprintf(stderr,"Height : %d\n",rasterP->height);

    fprintf(stderr,"X      : %d\n",rasterP->x);

    fprintf(stderr,"Y      : %d\n",rasterP->y);

    fprintf(stderr,"numC   : %d\n",rasterP->numDataElements);

    fprintf(stderr,"SS     : %d\n",rasterP->scanlineStride);

    fprintf(stderr,"PS     : %d\n",rasterP->pixelStride);

    fprintf(stderr,"CO     : %d\n",rasterP->chanOffsets);

    fprintf(stderr,"shared?: %d\n",rasterP->dataIsShared);

    fprintf(stderr,"RasterT: %d\n",rasterP->rasterType);

    fprintf(stderr,"DataT  : %d\n",rasterP->dataType);

    fprintf(stderr,"---------------------\n");

#endif

    return 1;

}

static int getColorModelType(JNIEnv *env, jobject jcmodel) {

    int type = UNKNOWN_CM_TYPE;

    if ((*env)->IsInstanceOf(env, jcmodel,

                 (*env)->FindClass(env, "java/awt/image/IndexColorModel")))

    {

        type = INDEX_CM_TYPE;

    } else if ((*env)->IsInstanceOf(env, jcmodel,

                 (*env)->FindClass(env, "java/awt/image/PackedColorModel")))

    {

        if  ((*env)->IsInstanceOf(env, jcmodel,

                (*env)->FindClass(env, "java/awt/image/DirectColorModel"))) {

            type = DIRECT_CM_TYPE;

        }

        else {

            type = PACKED_CM_TYPE;

        }

    }

    else if ((*env)->IsInstanceOf(env, jcmodel,

                 (*env)->FindClass(env, "java/awt/image/ComponentColorModel")))

    {

        type = COMPONENT_CM_TYPE;

    }

    return type;

}

int awt_parseColorModel (JNIEnv *env, jobject jcmodel, int imageType,

                         ColorModelS_t *cmP) {

    /*jmethodID jID;   */

    jobject jnBits;

    jsize   nBitsLength;

    int i;

    static jobject s_jdefCM = NULL;

    if (JNU_IsNull(env, jcmodel)) {

        JNU_ThrowNullPointerException(env, "null ColorModel object");

        return -1;

    }

    cmP->jcmodel = jcmodel;

    cmP->jcspace = (*env)->GetObjectField(env, jcmodel, g_CMcspaceID);

    cmP->numComponents = (*env)->GetIntField(env, jcmodel,

                                             g_CMnumComponentsID);

    cmP->supportsAlpha = (*env)->GetBooleanField(env, jcmodel,

                                                 g_CMsuppAlphaID);

    cmP->isAlphaPre = (*env)->GetBooleanField(env,jcmodel,

                                              g_CMisAlphaPreID);

    cmP->transparency = (*env)->GetIntField(env, jcmodel,

                                            g_CMtransparencyID);

    jnBits = (*env)->GetObjectField(env, jcmodel, g_CMnBitsID);

    if (jnBits == NULL) {

        JNU_ThrowNullPointerException(env, "null nBits structure in CModel");

        return -1;

    }

    nBitsLength = (*env)->GetArrayLength(env, jnBits);

    if (nBitsLength != cmP->numComponents) {

        // invalid number of components?

        return -1;

    }

    cmP->nBits = NULL;

    if (SAFE_TO_ALLOC_2(cmP->numComponents, sizeof(jint))) {

        cmP->nBits = (jint *)malloc(cmP->numComponents * sizeof(jint));

    }

    if (cmP->nBits == NULL){

        JNU_ThrowOutOfMemoryError(env, "Out of memory");

        return -1;

    }

    (*env)->GetIntArrayRegion(env, jnBits, 0, cmP->numComponents,

                              cmP->nBits);

    cmP->maxNbits = 0;

    for (i=0; i < cmP->numComponents; i++) {

        if (cmP->maxNbits < cmP->nBits[i]) {

            cmP->maxNbits = cmP->nBits[i];

        }

    }

    cmP->is_sRGB = (*env)->GetBooleanField(env, cmP->jcmodel, g_CMis_sRGBID);

    cmP->csType = (*env)->GetIntField(env, cmP->jcmodel, g_CMcsTypeID);

    cmP->cmType = getColorModelType(env, jcmodel);

    cmP->isDefaultCM = FALSE;

    cmP->isDefaultCompatCM = FALSE;

    /* look for standard cases */

    if (imageType == java_awt_image_BufferedImage_TYPE_INT_ARGB) {

        cmP->isDefaultCM = TRUE;

        cmP->isDefaultCompatCM = TRUE;

    } else if (imageType == java_awt_image_BufferedImage_TYPE_INT_ARGB_PRE ||

               imageType == java_awt_image_BufferedImage_TYPE_INT_RGB ||

               imageType == java_awt_image_BufferedImage_TYPE_INT_BGR ||

               imageType == java_awt_image_BufferedImage_TYPE_4BYTE_ABGR ||

               imageType == java_awt_image_BufferedImage_TYPE_4BYTE_ABGR_PRE)

    {

        cmP->isDefaultCompatCM = TRUE;

    }

    else {

        /* Figure out if this is the default CM */

        if (s_jdefCM == NULL) {

            jobject defCM;

            jclass jcm = (*env)->FindClass(env, "java/awt/image/ColorModel");

            defCM = (*env)->CallStaticObjectMethod(env, jcm,

                                                   g_CMgetRGBdefaultMID, NULL);

            s_jdefCM = (*env)->NewGlobalRef(env, defCM);

            if (defCM == NULL || s_jdefCM == NULL) {

                JNU_ThrowNullPointerException(env,

                                              "Unable to find default CM");