/*

 * Copyright (c) 1999-2000 Image Power, Inc. and the University of

 *   British Columbia.

 * Copyright (c) 2001-2003 Michael David Adams.

 * All rights reserved.

 */

/* __START_OF_JASPER_LICENSE__

 * 

 * JasPer License Version 2.0

 * 

 * Copyright (c) 2001-2006 Michael David Adams

 * Copyright (c) 1999-2000 Image Power, Inc.

 * Copyright (c) 1999-2000 The University of British Columbia

 * 

 * All rights reserved.

 * 

 * Permission is hereby granted, free of charge, to any person (the

 * "User") obtaining a copy of this software and associated documentation

 * files (the "Software"), to deal in the Software without restriction,

 * including without limitation the rights to use, copy, modify, merge,

 * publish, distribute, and/or sell copies of the Software, and to permit

 * persons to whom the Software is furnished to do so, subject to the

 * following conditions:

 * 

 * 1.  The above copyright notices and this permission notice (which

 * includes the disclaimer below) shall be included in all copies or

 * substantial portions of the Software.

 * 

 * 2.  The name of a copyright holder shall not be used to endorse or

 * promote products derived from the Software without specific prior

 * written permission.

 * 

 * THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS

 * LICENSE.  NO USE OF THE SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER

 * THIS DISCLAIMER.  THE SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS

 * "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING

 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A

 * PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.  IN NO

 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL

 * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING

 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,

 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION

 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.  NO ASSURANCES ARE

 * PROVIDED BY THE COPYRIGHT HOLDERS THAT THE SOFTWARE DOES NOT INFRINGE

 * THE PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OF ANY OTHER ENTITY.

 * EACH COPYRIGHT HOLDER DISCLAIMS ANY LIABILITY TO THE USER FOR CLAIMS

 * BROUGHT BY ANY OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL

 * PROPERTY RIGHTS OR OTHERWISE.  AS A CONDITION TO EXERCISING THE RIGHTS

 * GRANTED HEREUNDER, EACH USER HEREBY ASSUMES SOLE RESPONSIBILITY TO SECURE

 * ANY OTHER INTELLECTUAL PROPERTY RIGHTS NEEDED, IF ANY.  THE SOFTWARE

 * IS NOT FAULT-TOLERANT AND IS NOT INTENDED FOR USE IN MISSION-CRITICAL

 * SYSTEMS, SUCH AS THOSE USED IN THE OPERATION OF NUCLEAR FACILITIES,

 * AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL

 * SYSTEMS, DIRECT LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH

 * THE FAILURE OF THE SOFTWARE OR SYSTEM COULD LEAD DIRECTLY TO DEATH,

 * PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH

 * RISK ACTIVITIES").  THE COPYRIGHT HOLDERS SPECIFICALLY DISCLAIM ANY

 * EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES.

 * 

 * __END_OF_JASPER_LICENSE__

 */

/*

 * JP2 Library

 *

 * $Id$

 */

/******************************************************************************\

* Includes.

\******************************************************************************/

#include "jp2_dec.h"

#include "jp2_cod.h"

#include "jasper/jas_image.h"

#include "jasper/jas_stream.h"

#include "jasper/jas_math.h"

#include "jasper/jas_debug.h"

#include "jasper/jas_malloc.h"

#include "jasper/jas_types.h"

#include <assert.h>

#include <stdio.h>

/******************************************************************************\

* Function prototypes.

\******************************************************************************/

static jp2_dec_t *jp2_dec_create(void);

static void jp2_dec_destroy(jp2_dec_t *dec);

static int jp2_getcs(jp2_colr_t *colr);

static int fromiccpcs(int cs);

static int jp2_getct(int colorspace, int type, int assoc);

/******************************************************************************\

* Functions.

\******************************************************************************/

jas_image_t *jp2_decode(jas_stream_t *in, const char *optstr)

{

  jp2_box_t *box;

  int found;

  jas_image_t *image;

  jp2_dec_t *dec;

  bool samedtype;

  int dtype;

  unsigned int i;

  jp2_cmap_t *cmapd;

  jp2_pclr_t *pclrd;

#if 0

  /* The following code appears to no longer be needed. */

  jp2_cdef_t *cdefd;

#endif

  unsigned int channo;

  int newcmptno;

  int_fast32_t *lutents;

#if 0

  jp2_cdefchan_t *cdefent;

  int cmptno;

#endif

  jp2_cmapent_t *cmapent;

  jas_icchdr_t icchdr;

  jas_iccprof_t *iccprof;

  dec = 0;

  box = 0;

  image = 0;

  JAS_LOGDEBUGF(100, "jp2_decode(%p, \"%s\")\n", in, optstr);

  if (!(dec = jp2_dec_create())) {

    goto error;

  }

  /* Get the first box.  This should be a JP box. */

  if (!(box = jp2_box_get(in))) {

    jas_logerrorf("error: cannot get box\n");

    goto error;

  }

  if (box->type != JP2_BOX_JP) {

    jas_logerrorf("error: expecting signature box\n");

    goto error;

  }

  if (box->data.jp.magic != JP2_JP_MAGIC) {

    jas_logerrorf("incorrect magic number (0x%lx != 0x%lx)\n",

      JAS_CAST(unsigned long, box->data.jp.magic),

      JAS_CAST(unsigned long, JP2_JP_MAGIC));

    goto error;

  }

  jp2_box_destroy(box);

  box = 0;

  /* Get the second box.  This should be a FTYP box. */

  if (!(box = jp2_box_get(in))) {

    jas_logerrorf("error: cannot get box\n");

    goto error;

  }

  if (box->type != JP2_BOX_FTYP) {

    jas_logerrorf("expecting file type box\n");

    goto error;

  }

  jp2_box_destroy(box);

  box = 0;

  /* Get more boxes... */

  found = 0;

  while ((box = jp2_box_get(in))) {

    if (jas_get_debug_level() >= 1) {

      jas_logdebugf(1, "got box type %s\n", box->info->name);

    }

    switch (box->type) {

    case JP2_BOX_JP2C:

      found = 1;

      break;

    case JP2_BOX_IHDR:

      if (!dec->ihdr) {

        dec->ihdr = box;

        box = 0;

      }

      break;

    case JP2_BOX_BPCC:

      if (!dec->bpcc) {

        dec->bpcc = box;

        box = 0;

      }

      break;

    case JP2_BOX_CDEF:

      if (!dec->cdef) {

        dec->cdef = box;

        box = 0;

      }

      break;

    case JP2_BOX_PCLR:

      if (!dec->pclr) {

        dec->pclr = box;

        box = 0;

      }

      break;

    case JP2_BOX_CMAP:

      if (!dec->cmap) {

        dec->cmap = box;

        box = 0;

      }

      break;

    case JP2_BOX_COLR:

      if (!dec->colr) {

        dec->colr = box;

        box = 0;

      }

      break;

    }

    if (box) {

      jp2_box_destroy(box);

      box = 0;

    }

    if (found) {

      break;

    }

  }

  if (!found) {

    jas_logerrorf("error: no code stream found\n");

    goto error;

  }

  if (!(dec->image = jpc_decode(in, optstr))) {

    jas_logerrorf("error: cannot decode code stream\n");

    goto error;

  }

  /* An IHDR box must be present. */

  if (!dec->ihdr) {

    jas_logerrorf("error: missing IHDR box\n");

    goto error;

  }

  /* Does the number of components indicated in the IHDR box match

    the value specified in the code stream? */

  if (dec->ihdr->data.ihdr.numcmpts != JAS_CAST(jas_uint,

    jas_image_numcmpts(dec->image))) {

    jas_logerrorf("error: number of components mismatch (IHDR)\n");

    goto error;

  }

  /* At least one component must be present. */

  if (!jas_image_numcmpts(dec->image)) {

    jas_logerrorf("error: no components\n");

    goto error;

  }

  /* Determine if all components have the same data type. */

  samedtype = true;

  dtype = jas_image_cmptdtype(dec->image, 0);

  for (i = 1; i < JAS_CAST(jas_uint, jas_image_numcmpts(dec->image)); ++i) {

    if (jas_image_cmptdtype(dec->image, i) != dtype) {

      samedtype = false;

      break;

    }

  }

  /* Is the component data type indicated in the IHDR box consistent

    with the data in the code stream? */

  if ((samedtype && dec->ihdr->data.ihdr.bpc != JP2_DTYPETOBPC(dtype)) ||

    (!samedtype && dec->ihdr->data.ihdr.bpc != JP2_IHDR_BPCNULL)) {

    jas_logerrorf("error: component data type mismatch (IHDR)\n");

    goto error;

  }

  /* Is the compression type supported? */

  if (dec->ihdr->data.ihdr.comptype != JP2_IHDR_COMPTYPE) {

    jas_logerrorf("error: unsupported compression type\n");

    goto error;

  }

  if (dec->bpcc) {

    /* Is the number of components indicated in the BPCC box

      consistent with the code stream data? */

    if (dec->bpcc->data.bpcc.numcmpts !=

      JAS_CAST(jas_uint, jas_image_numcmpts(dec->image))) {

      jas_logerrorf("error: number of components mismatch (BPCC)\n");

      goto error;

    }

    /* Is the component data type information indicated in the BPCC

      box consistent with the code stream data? */

    if (!samedtype) {

      for (i = 0; i < JAS_CAST(jas_uint, jas_image_numcmpts(dec->image));

        ++i) {

        if (jas_image_cmptdtype(dec->image, i) !=

          JP2_BPCTODTYPE(dec->bpcc->data.bpcc.bpcs[i])) {

          jas_logerrorf("error: component data type mismatch (BPCC)\n");

            goto error;

        }

      }

    } else {

      jas_logwarnf("warning: superfluous BPCC box\n");

    }

  }

  /* A COLR box must be present. */

  if (!dec->colr) {

    jas_logerrorf("error: no COLR box\n");

    goto error;

  }

  switch (dec->colr->data.colr.method) {

  case JP2_COLR_ENUM:

    jas_image_setclrspc(dec->image, jp2_getcs(&dec->colr->data.colr));

    break;

  case JP2_COLR_ICC:

    iccprof = jas_iccprof_createfrombuf(dec->colr->data.colr.iccp,

      dec->colr->data.colr.iccplen);

    if (!iccprof) {

      jas_logerrorf("error: failed to parse ICC profile\n");

      goto error;

    }

    jas_iccprof_gethdr(iccprof, &icchdr);

    JAS_LOGDEBUGF(2, "ICC Profile CS %08x\n", icchdr.colorspc);

    dec->image->cmprof_ = jas_cmprof_createfromiccprof(iccprof);

    if (!dec->image->cmprof_) {

      jas_image_setclrspc(dec->image, JAS_CLRSPC_UNKNOWN);

      jas_logwarnf("warning: cannot create CM profile from ICC profile\n");

    } else {

      jas_image_setclrspc(dec->image, fromiccpcs(icchdr.colorspc));

    }

    jas_iccprof_destroy(iccprof);

    break;

  }

  /* If a CMAP box is present, a PCLR box must also be present. */

  if (dec->cmap && !dec->pclr) {

    jas_logwarnf("warning: missing PCLR box or superfluous CMAP box\n");

    jp2_box_destroy(dec->cmap);

    dec->cmap = 0;

  }

  /* If a CMAP box is not present, a PCLR box must not be present. */

  if (!dec->cmap && dec->pclr) {

    jas_logwarnf("warning: missing CMAP box or superfluous PCLR box\n");

    jp2_box_destroy(dec->pclr);

    dec->pclr = 0;

  }

  /* Determine the number of channels (which is essentially the number

    of components after any palette mappings have been applied). */

  dec->numchans = dec->cmap ? dec->cmap->data.cmap.numchans :

    JAS_CAST(jas_uint, jas_image_numcmpts(dec->image));

  /* Perform a basic sanity check on the CMAP box if present. */

  if (dec->cmap) {

    for (i = 0; i < dec->numchans; ++i) {

      /* Is the component number reasonable? */

      if (dec->cmap->data.cmap.ents[i].cmptno >= JAS_CAST(jas_uint,

        jas_image_numcmpts(dec->image))) {

        jas_logerrorf("error: invalid component number in CMAP box\n");

        goto error;

      }

      /* Is the LUT index reasonable? */

      if (dec->cmap->data.cmap.ents[i].pcol >=

        dec->pclr->data.pclr.numchans) {

        jas_logerrorf("error: invalid CMAP LUT index\n");

        goto error;

      }

    }

  }

  /* Allocate space for the channel-number to component-number LUT. */

  if (!(dec->chantocmptlut = jas_alloc2(dec->numchans,

    sizeof(uint_fast16_t)))) {

    jas_logerrorf("error: no memory\n");

    goto error;

  }

  if (!dec->cmap) {

    for (i = 0; i < dec->numchans; ++i) {

      dec->chantocmptlut[i] = i;

    }

  } else {

    /* Check to ensure that CMAP/PCLR were initialized. */

    if (!dec->cmap || !dec->pclr) {

      jas_logerrorf("missing CMAP/PCLR box\n");

      goto error;

    }

    cmapd = &dec->cmap->data.cmap;

    pclrd = &dec->pclr->data.pclr;

#if 0

    /* The following code appears to no longer be needed. */

    cdefd = &dec->cdef->data.cdef;

#endif

    for (channo = 0; channo < cmapd->numchans; ++channo) {

      cmapent = &cmapd->ents[channo];

      if (cmapent->map == JP2_CMAP_DIRECT) {

        dec->chantocmptlut[channo] = channo;

      } else if (cmapent->map == JP2_CMAP_PALETTE) {

        if (!pclrd->numlutents) {

          jas_logerrorf("error: empty LUT\n");

          goto error;

        }

        if (!(lutents = jas_alloc2(pclrd->numlutents,

          sizeof(int_fast32_t)))) {

          jas_logerrorf("error: cannot allocate LUT\n");

          goto error;

        }

        for (i = 0; i < pclrd->numlutents; ++i) {

          lutents[i] = pclrd->lutdata[cmapent->pcol + i * pclrd->numchans];

        }

        newcmptno = jas_image_numcmpts(dec->image);

        if (jas_image_depalettize(dec->image, cmapent->cmptno,

          pclrd->numlutents, lutents,

          JP2_BPCTODTYPE(pclrd->bpc[cmapent->pcol]), newcmptno)) {

          jas_logerrorf("jas_image_depalettize failed\n");

          jas_free(lutents);

          jas_logerrorf("error: depalettize failed\n");

          goto error;

        }

        dec->chantocmptlut[channo] = newcmptno;

        jas_free(lutents);

#if 0

        /* The following code appears to no longer be needed. */

        if (dec->cdef) {

          cdefent = jp2_cdef_lookup(cdefd, channo);

          if (!cdefent) {

            abort();

          }

        jas_image_setcmpttype(dec->image, newcmptno, jp2_getct(jas_image_clrspc(dec->image), cdefent->type, cdefent->assoc));

        } else {

        jas_image_setcmpttype(dec->image, newcmptno, jp2_getct(jas_image_clrspc(dec->image), 0, channo + 1));

        }

#endif

      } else {

        jas_logerrorf("error: invalid MTYP in CMAP box\n");

        goto error;

      }

    }

  }

#if 0

  /* The following code appears to no longer be needed. */

  /* Ensure that the number of channels being used by the decoder

    matches the number of image components. */

  if (dec->numchans != jas_image_numcmpts(dec->image)) {

    jas_logerrorf("error: mismatch in number of components (%d != %d)\n",

      dec->numchans, jas_image_numcmpts(dec->image));

    goto error;

  }

#endif

  /* Mark all components as being of unknown type. */

  for (i = 0; i < JAS_CAST(jas_uint, jas_image_numcmpts(dec->image)); ++i) {

    jas_image_setcmpttype(dec->image, i, JAS_IMAGE_CT_UNKNOWN);

  }

  /* Determine the type of each component. */

  if (dec->cdef) {

    for (i = 0; i < dec->cdef->data.cdef.numchans; ++i) {

      uint_fast16_t channo = dec->cdef->data.cdef.ents[i].channo;

      /* Is the channel number reasonable? */

      if (channo >= dec->numchans) {

        jas_logerrorf("error: invalid channel number in CDEF box (%d)\n",

          channo);

        goto error;

      }

      unsigned compno = dec->chantocmptlut[channo];

      if (compno >= jas_image_numcmpts(dec->image)) {

        jas_logerrorf(

          "error: invalid component reference in CDEF box (%d)\n",

          compno);

        goto error;

      }

      jas_image_setcmpttype(dec->image, compno,

        jp2_getct(jas_image_clrspc(dec->image),

        dec->cdef->data.cdef.ents[i].type,

        dec->cdef->data.cdef.ents[i].assoc));

    }

  } else {

    for (i = 0; i < dec->numchans; ++i) {

      unsigned compno = dec->chantocmptlut[i];

      if (compno >= jas_image_numcmpts(dec->image)) {

        jas_logerrorf(

          "error: invalid component reference (%d)\n", compno);

        goto error;

      }

      jas_image_setcmpttype(dec->image, compno,

        jp2_getct(jas_image_clrspc(dec->image), 0, i + 1));

    }

  }

  /* Delete any components that are not of interest. */

  for (i = jas_image_numcmpts(dec->image); i > 0; --i) {

    if (jas_image_cmpttype(dec->image, i - 1) == JAS_IMAGE_CT_UNKNOWN) {

      jas_image_delcmpt(dec->image, i - 1);

    }

  }

  /* Ensure that some components survived. */

  if (!jas_image_numcmpts(dec->image)) {

    jas_logerrorf("error: no components\n");

    goto error;

  }

  /* Prevent the image from being destroyed later. */

  image = dec->image;

  dec->image = 0;

  jp2_dec_destroy(dec);

  return image;

error:

  if (image) {

    jas_image_destroy(image);

  }

  if (box) {

    jp2_box_destroy(box);

  }

  if (dec) {

    jp2_dec_destroy(dec);

  }

  return 0;

}

#define JP2_VALIDATE_LEN JAS_MIN(JP2_JP_LEN + 4, JAS_STREAM_MAXPUTBACK)

int jp2_validate(jas_stream_t *in)

{

  unsigned char buf[JP2_VALIDATE_LEN];

  /* Read the validation data (i.e., the data used for detecting

    the format). */

  assert(sizeof(buf) <= JAS_STREAM_MAXPUTBACK);

  if (jas_stream_peek(in, buf, sizeof(buf)) != sizeof(buf)) {

    return -1;

  }

  /* Is the box type correct? */

  assert(JP2_VALIDATE_LEN >= 8);

  if (((JAS_CAST(uint_least32_t, buf[4]) << 24) |

    (JAS_CAST(uint_least32_t, buf[5]) << 16) |

    (JAS_CAST(uint_least32_t, buf[6] << 8)) |

    (JAS_CAST(uint_least32_t, buf[7]))) !=

    JP2_BOX_JP) {

    return -1;

  }

  return 0;

}

static jp2_dec_t *jp2_dec_create(void)

{

  jp2_dec_t *dec;

  if (!(dec = jas_malloc(sizeof(jp2_dec_t)))) {

    return 0;

  }

  dec->ihdr = 0;

  dec->bpcc = 0;

  dec->cdef = 0;

  dec->pclr = 0;

  dec->image = 0;

  dec->chantocmptlut = 0;

  dec->cmap = 0;

  dec->colr = 0;

  return dec;

}

static void jp2_dec_destroy(jp2_dec_t *dec)

{

  if (dec->ihdr) {

    jp2_box_destroy(dec->ihdr);

  }

  if (dec->bpcc) {

    jp2_box_destroy(dec->bpcc);

  }

  if (dec->cdef) {

    jp2_box_destroy(dec->cdef);

  }

  if (dec->pclr) {

    jp2_box_destroy(dec->pclr);

  }

  if (dec->image) {

    jas_image_destroy(dec->image);

  }

  if (dec->cmap) {

    jp2_box_destroy(dec->cmap);

  }

  if (dec->colr) {

    jp2_box_destroy(dec->colr);

  }

  if (dec->chantocmptlut) {

    jas_free(dec->chantocmptlut);

  }

  jas_free(dec);

}

static int jp2_getct(int colorspace, int type, int assoc)

{

  if (type == 1 && assoc == 0) {

    return JAS_IMAGE_CT_OPACITY;

  }

  if (type == 0 && assoc >= 1 && assoc <= 65534) {

    switch (colorspace) {

    case JAS_CLRSPC_FAM_RGB:

      switch (assoc) {

      case JP2_CDEF_RGB_R:

        return JAS_IMAGE_CT_COLOR(JAS_CLRSPC_CHANIND_RGB_R);

      case JP2_CDEF_RGB_G:

        return JAS_IMAGE_CT_COLOR(JAS_CLRSPC_CHANIND_RGB_G);

      case JP2_CDEF_RGB_B:

        return JAS_IMAGE_CT_COLOR(JAS_CLRSPC_CHANIND_RGB_B);

      }

      break;

    case JAS_CLRSPC_FAM_YCBCR:

      switch (assoc) {

      case JP2_CDEF_YCBCR_Y:

        return JAS_IMAGE_CT_COLOR(JAS_CLRSPC_CHANIND_YCBCR_Y);

      case JP2_CDEF_YCBCR_CB:

        return JAS_IMAGE_CT_COLOR(JAS_CLRSPC_CHANIND_YCBCR_CB);

      case JP2_CDEF_YCBCR_CR:

        return JAS_IMAGE_CT_COLOR(JAS_CLRSPC_CHANIND_YCBCR_CR);

      }

      break;

    case JAS_CLRSPC_FAM_GRAY:

      switch (assoc) {

      case JP2_CDEF_GRAY_Y:

        return JAS_IMAGE_CT_COLOR(JAS_CLRSPC_CHANIND_GRAY_Y);

      }

      break;

    default:

      return JAS_IMAGE_CT_COLOR(assoc - 1);

    }

  }

  return JAS_IMAGE_CT_UNKNOWN;

}

static int jp2_getcs(jp2_colr_t *colr)

{

  if (colr->method == JP2_COLR_ENUM) {

    switch (colr->csid) {

    case JP2_COLR_SRGB:

      return JAS_CLRSPC_SRGB;

    case JP2_COLR_SYCC:

      return JAS_CLRSPC_SYCBCR;

    case JP2_COLR_SGRAY:

      return JAS_CLRSPC_SGRAY;

    }

  }

  return JAS_CLRSPC_UNKNOWN;

}

static int fromiccpcs(int cs)

{

  switch (cs) {

  case ICC_CS_RGB:

    return JAS_CLRSPC_GENRGB;

  case ICC_CS_YCBCR:

    return JAS_CLRSPC_GENYCBCR;

  case ICC_CS_GRAY:

    return JAS_CLRSPC_GENGRAY;

  }

  return JAS_CLRSPC_UNKNOWN;

}