path: root/gs/base/sjpx.c

/* Copyright (C) 2001-2008 Artifex Software, Inc.
   All Rights Reserved.

   This software is provided AS-IS with no warranty, either express or
   implied.

   This software is distributed under license and may not be copied, modified
   or distributed except as expressly authorized under the terms of that
   license.  Refer to licensing information at http://www.artifex.com/
   or contact Artifex Software, Inc.,  7 Mt. Lassen Drive - Suite A-134,
   San Rafael, CA  94903, U.S.A., +1(415)492-9861, for further information.
*/

/* $Id$ */
/* JPXDecode filter implementation -- hooks in libjasper */

#include "memory_.h"
#include "gserror.h"
#include "gdebug.h"
#include "strimpl.h"
#include "gsmalloc.h"
#include "sjpx.h"

static void s_jpxd_set_defaults(stream_state *ss);

/* stream implementation */

/* As with the /JBIG2Decode filter, we let the library do its own
   memory management through malloc() etc. and rely on our release()
   proc being called to deallocate state.
*/

private_st_jpxd_state(); /* creates a gc object for our state,
                            defined in sjpx.h */

/* error reporting callback for the jpx library */
static void
s_jpx_jas_error_cb(jas_error_t err, char *msg)
{
  dprintf2("jasper (code %d) %s", (int)err, msg);
}


/* initialize the steam.
   this involves allocating the stream and image structures, and
   initializing the decoder.
 */
static int
s_jpxd_init(stream_state * ss)
{
    stream_jpxd_state *const state = (stream_jpxd_state *) ss;
    int status = 0;

    if (state->jpx_memory == NULL) {
        state->jpx_memory = ss->memory->non_gc_memory;
    }

    status = jas_init();
    jas_set_error_cb(s_jpx_jas_error_cb);
#ifdef JPX_DEBUG
    /* raise the error reporting threshold from the default (0) */
    jas_setdbglevel(1);
#endif

    if (!status) {
        state->buffer = gs_malloc(state->jpx_memory, 4096, 1, "JPXDecode temp buffer");
        status = (state->buffer == NULL);
    }
    if (!status)
        state->bufsize = 4096;

    return status;
}

#ifdef DEBUG
/* dump information from a jasper image struct for debugging */
static int
dump_jas_image(jas_image_t *image)
{
    int i, numcmpts = jas_image_numcmpts(image);
    int clrspc = jas_image_clrspc(image);
    const char *csname = "unrecognized vendor space";

    if (image == NULL) return 1;

    if_debug2('w', "[w]JPX image is %d x %d\n",
        (int)jas_image_width(image), (int)jas_image_height(image));

    /* sort the colorspace */
    if jas_clrspc_isunknown(clrspc) csname = "unknown";
    else switch (clrspc) {
        case JAS_CLRSPC_CIEXYZ: csname = "CIE XYZ"; break;
        case JAS_CLRSPC_CIELAB: csname = "CIE Lab"; break;
        case JAS_CLRSPC_SGRAY: csname = "calibrated grayscale"; break;
        case JAS_CLRSPC_SRGB: csname = "sRGB"; break;
        case JAS_CLRSPC_SYCBCR: csname = "calibrated YCbCr"; break;
        case JAS_CLRSPC_GENGRAY: csname = "generic gray"; break;
        case JAS_CLRSPC_GENRGB: csname = "generic RGB"; break;
        case JAS_CLRSPC_GENYCBCR: csname = "generic YCbCr"; break;
    }
    if_debug3('w',"[w]  colorspace is %s (family %d, member %d)\n",
        csname, jas_clrspc_fam(clrspc), jas_clrspc_mbr(clrspc));

    for (i = 0; i < numcmpts; i++) {
        int type = jas_image_cmpttype(image, i);
        const char *opacity = (type & JAS_IMAGE_CT_OPACITY) ? " opacity" : "";
        const char *name = "unrecognized";
        const char *issigned = "";
        if (jas_clrspc_fam(clrspc) == JAS_CLRSPC_FAM_GRAY)
            name = "gray";
        else if (jas_clrspc_fam(clrspc) == JAS_CLRSPC_FAM_RGB)
            switch (JAS_IMAGE_CT_COLOR(type)) {
                case JAS_IMAGE_CT_RGB_R: name = "red"; break;
                case JAS_IMAGE_CT_RGB_G: name = "green"; break;
                case JAS_IMAGE_CT_RGB_B: name = "blue"; break;
                case JAS_IMAGE_CT_UNKNOWN:
                default:
                    name = "unknown";
            }
        else if (jas_clrspc_fam(clrspc) == JAS_CLRSPC_FAM_YCBCR)
            switch (JAS_IMAGE_CT_COLOR(type)) {
                case JAS_IMAGE_CT_YCBCR_Y: name = "luminance Y"; break;
                case JAS_IMAGE_CT_YCBCR_CB: name = "chrominance Cb"; break;
                case JAS_IMAGE_CT_YCBCR_CR: name = "chrominance Cr"; break;
                case JAS_IMAGE_CT_UNKNOWN:
                default:
                    name = "unknown";
            }
        if (jas_image_cmptsgnd(image, i))
            issigned = ", signed";
        if_debug6('w', "[w]  component %d: type %d '%s%s' (%d bits%s)",
            i, type, name, opacity, jas_image_cmptprec(image, i), issigned);
        if_debug4('w', " grid step (%d,%d) offset (%d,%d)\n",
            (int)jas_image_cmpthstep(image, i), (int)jas_image_cmptvstep(image, i),
            (int)jas_image_cmpttlx(image, i), (int)jas_image_cmpttly(image, i));
    }

    return 0;
}

/* dump the external colorspace from the interpreter for debugging */
static int
dump_jpxd_colorspace(const stream_jpxd_state * state)
{
  const char *cspace;

  if (state->colorspace == gs_jpx_cs_unset) {
    if_debug0('w', "[w]JPX image has no external color space set\n");
    return 0;
  }

  switch (state->colorspace) {
    case gs_jpx_cs_gray: cspace = "Grayscale based"; break;
    case gs_jpx_cs_rgb: cspace = "RGB based"; break;
    case gs_jpx_cs_cmyk: cspace = "CMYK based"; break;
    case gs_jpx_cs_indexed: cspace = "indexed"; break;
    default: cspace = "unknown"; break;
  }

  if_debug1('w', "[w]Interpreter has set an external %s color space\n",
        cspace);

  return 0;
}
#endif /* DEBUG */

static int
copy_row_gray(byte *dest, jas_image_t *image,
        int x, int y, int bytes)
{
    int i, p;
    int v;
    int shift, bits;

    v = jas_image_getcmptbytype(image, JAS_IMAGE_CT_GRAY_Y);
    if (v < 0) return 0; /* no matching component */

    bits = jas_image_cmptprec(image, v);
    if (bits >= 8) {
        /* shift down to 8 bpp */
        shift = max(jas_image_cmptprec(image, v) - 8, 0);

        for (i = 1; i <= bytes; i++) {
            p = jas_image_readcmptsample(image, v, x++, y);
            dest[i] = p >> shift;
        }
   } else if (bits == 4) {
        /* return two packed pixels per byte */
        for (i = 1; i <= bytes; i++) {
            p = jas_image_readcmptsample(image, v, x++, y) << 4;
            p |= jas_image_readcmptsample(image, v, x++, y);
            dest[i] = p;
        }
    } else {
        /* todo: handle other bit depths */
        memset(dest + 1, 0x80, bytes);
    }

    return bytes;
}

static int
copy_row_rgb(byte *dest, jas_image_t *image,
        int x, int y, int bytes)
{
    int i, p;
    int r = jas_image_getcmptbytype(image, JAS_IMAGE_CT_RGB_R);
    int g = jas_image_getcmptbytype(image, JAS_IMAGE_CT_RGB_G);
    int b = jas_image_getcmptbytype(image, JAS_IMAGE_CT_RGB_B);
    int shift = max(jas_image_cmptprec(image, 0) - 8, 0);
    int count = (bytes/3) * 3;

    /* check if we found indexes for all three components */
    if (r < 0 || g < 0 || b < 0) return 0;

    for (i = 1; i <= count; i+=3) {
        p = jas_image_readcmptsample(image, r, x, y);
        dest[i] = p >> shift;
        p = jas_image_readcmptsample(image, g, x, y);
        dest[i+1] = p >> shift;
        p = jas_image_readcmptsample(image, b, x, y);
        dest[i+2] = p >> shift;
        x++;
    }

    return count;
}

static int
copy_row_yuv(byte *dest, jas_image_t *image,
        int x, int y, int bytes)
{
    int i,j;
    int count = (bytes/3) * 3;
    int shift[3];
    int clut[3];
    int hstep[3],vstep[3];
    int p[3],q[3];

    /* get the component mapping */
    clut[0] = jas_image_getcmptbytype(image, JAS_IMAGE_CT_YCBCR_Y);
    clut[1] = jas_image_getcmptbytype(image, JAS_IMAGE_CT_YCBCR_CB);
    clut[2] = jas_image_getcmptbytype(image, JAS_IMAGE_CT_YCBCR_CR);

    /* check if we found indexes for all components */
    if (clut[0] < 0 || clut[1] < 0 || clut[2] < 0) return 0;

    for (i = 0; i < 3; i++) {
        /* shift each component up to 16 bits */
        shift[i] = 16 - jas_image_cmptprec(image, clut[i]);
        /* repeat subsampled pixels */
        hstep[i] = jas_image_cmpthstep(image, clut[i]);
        vstep[i] = jas_image_cmptvstep(image, clut[i]);
    }
    for (i = 1; i <= count; i+=3) {
        /* read the sample values */
        for (j = 0; j < 3; j++) {
            p[j] = jas_image_readcmptsample(image, clut[j], x/hstep[j], y/vstep[j]);
            p[j] <<= shift[j];
        }
        /* center chroma channels if necessary */
        if (!jas_image_cmptsgnd(image, clut[1])) p[1] -= 0x8000;
        if (!jas_image_cmptsgnd(image, clut[2])) p[2] -= 0x8000;
        /* rotate to RGB */
#ifdef JPX_USE_IRT
        q[1] = p[0] - ((p[1] + p[2])>>2);
        q[0] = p[1] + q[1];
        q[2] = p[2] + q[1];
#else
        q[0] = (int)((double)p[0] + 1.402 * p[2]);
        q[1] = (int)((double)p[0] - 0.34413 * p[1] - 0.71414 * p[2]);
        q[2] = (int)((double)p[0] + 1.772 * p[1]);
#endif
        /* clamp */
        for (j = 0; j < 3; j++){
          if (q[j] < 0) q[j] = 0;
          else if (q[j] > 0xFFFF) q[j] = 0xFFFF;
        }
        /* write out the pixel */
        dest[i] = q[0] >> 8;
        dest[i+1] = q[1] >> 8;
        dest[i+2] = q[2] >> 8;
        x++;
    }

    return count;
}


static inline bool 
is_color_component(jas_image_t *image, int n)
{
    int k = jas_image_cmpttype(image, n) & (JAS_IMAGE_CT_UNKNOWN | JAS_IMAGE_CT_OPACITY);
    return !k;
}

static int color_cmpts(jas_image_t *image)
{
     int cnt = 0;
     int n = jas_image_numcmpts(image);

     while(--n >= 0) {
        if (is_color_component(image, n))
            cnt++;
    }
    return cnt;
}

static int
copy_row_default(byte *dest, jas_image_t *image,
        int x, int y, int bytes)
{
    int i, c, d, n, clr;
    int count;

    n = jas_image_numcmpts(image);
    clr = color_cmpts(image);
    count = (bytes/clr) * clr;
    for (i = 1; i <= count; i += clr) {
        for (c = d = 0; c < n; c++) {
            if (is_color_component(image, c)) {
                dest[i + d++] = jas_image_readcmptsample(image, c, x, y);
            }
        }
        x++;
    }
    return count;
}

/* This is really inefficient and needs some work but at least
   now we will get 16 bit data out correctly when it is in a non standard
   color space. Note that indexing into dest (stream buffer) starts at +1. */
static int
copy_row_default16(byte *dest, jas_image_t *image,
        int x, int y, int bytes)
{
    int c, n, clr;
    int count;
    int pixel_width;
    byte *curr_ptr = dest+1;  /* The offset */
    int value;

    n = jas_image_numcmpts(image);
    clr = color_cmpts(image);
    count = bytes;
    pixel_width = clr*sizeof(unsigned short);

    while (count >= pixel_width) {
        for (c = 0; c < n; c++) {
            if (is_color_component(image, c)) {
                value = jas_image_readcmptsample(image, c, x, y);
                /* endian issues here? */
                *curr_ptr++ = ((value >> 8) & 0xff);
                *curr_ptr++ = (value & 0xff);
            }
        }
        x++;
        count =  count - pixel_width;
    }
    return bytes-count;
}

static int
copy_row_gray16(byte *dest, jas_image_t *image,
        int x, int y, int bytes, int bits)
{
    int count;
    int pixel_width;
    byte *curr_ptr = dest+1; /* The offset */
    int shift;
    int p, v;
    unsigned short value;

    v = jas_image_getcmptbytype(image, JAS_IMAGE_CT_GRAY_Y);
    if (v < 0) return 0; /* no matching component */

    count = bytes;
    pixel_width = 2;
    shift = max(16 - bits, 0);

    while (count >= pixel_width) {
        p = jas_image_readcmptsample(image, v, x, y);
        value = p << shift;
        /* endian issues here? */
        *curr_ptr++ = ((value >> 8) & 0xff);
        *curr_ptr++ = (value & 0xff);
        x++;
        count =  count - pixel_width;
    }
    return bytes-count;
}


/* buffer the input stream into our state */
static int
s_jpxd_buffer_input(stream_jpxd_state *const state, stream_cursor_read *pr,
                       long bytes)
{
    /* grow internal buffer if necessary */
    if (bytes > state->bufsize - state->buffill) {
        int newsize = state->bufsize;
        byte *newbuf = NULL;
        while (newsize - state->buffill < bytes)
            newsize <<= 1;
        newbuf = (byte *)gs_malloc(state->jpx_memory, newsize, 1,
                                            "JPXDecode temp buffer");
        /* TODO: check for allocation failure */
        memcpy(newbuf, state->buffer, state->buffill);
        gs_free(state->jpx_memory, state->buffer, state->bufsize, 1,
                "JPXDecode temp buffer");
        state->buffer = newbuf;
        state->bufsize = newsize;
    }

    /* copy requested amount of data and return */
    memcpy(state->buffer + state->buffill, pr->ptr + 1, bytes);
    state->buffill += bytes;
    pr->ptr += bytes;
    return bytes;
}

/* decode the compressed image data saved in our state */
static int
s_jpxd_decode_image(stream_jpxd_state * state)
{
    jas_stream_t *stream = NULL;
    jas_image_t *image = NULL;
    char *optstr = NULL;

    /* if the external Colorspace key is indexed, we need to ask
       for raw index values so the external palette can be applied */
    if (state->colorspace == gs_jpx_cs_indexed) {
        if_debug0('w', "[w] got indexed colorspace in s_jpxd_decode_image\n");
        optstr = (char *)"raw";
    }
    /* wrap our buffer in a jas_stream */
    stream = jas_stream_memopen((char*)state->buffer, state->buffill);
    if (stream == NULL) {
        dprintf("unable to create stream for JPX image data.\n");
        return ERRC;
    }
    /* decode an image */
    image = jas_image_decode(stream, -1, optstr);
    if (image == NULL) {
        dprintf("unable to decode JPX image data.\n");
        return ERRC;
    }
#ifdef JPX_USE_JASPER_CM
        /* convert non-rgb multicomponent colorspaces to sRGB */
        if (jas_image_numcmpts(image) > 1 &&
            jas_clrspc_fam(jas_image_clrspc(image)) != JAS_CLRSPC_FAM_RGB) {
            jas_cmprof_t *outprof;
            jas_image_t *rgbimage = NULL;
            outprof = jas_cmprof_createfromclrspc(JAS_CLRSPC_SRGB);
            if (outprof != NULL)
                rgbimage = jas_image_chclrspc(image, outprof, JAS_CMXFORM_INTENT_PER);
            if (rgbimage != NULL) {
                jas_image_destroy(image);
                image = rgbimage;
            }
        }
#endif
    state->image = image;
    state->offset = 0;
    jas_stream_close(stream);

#ifdef DEBUG
        dump_jas_image(image);
        dump_jpxd_colorspace(state);
#endif

    return 0;
}

/* process a secton of the input and return any decoded data.
   see strimpl.h for return codes.
 */
static int
s_jpxd_process(stream_state * ss, stream_cursor_read * pr,
                 stream_cursor_write * pw, bool last)
{
    stream_jpxd_state *const state = (stream_jpxd_state *) ss;
    long in_size = pr->limit - pr->ptr;
    long out_size = pw->limit - pw->ptr;
    int status = 0;

    /* note that the gs stream library expects offset-by-one
       indexing of its buffers while we use zero indexing */

    /* JasPer has its own stream library, but there's no public
       api for handing it pieces. We need to add some plumbing
       to convert between gs and jasper streams. In the meantime
       just buffer the entire stream, since it can handle that
       as input. */

    /* pass all available input to the decoder */
    if (in_size > 0) {
        s_jpxd_buffer_input(state, pr, in_size);
    }
    if (last) {
      if (state->image == NULL) {
        status = s_jpxd_decode_image(state);
      }
      if (state->image != NULL) {
        jas_image_t *image = state->image;
        int numcmpts = color_cmpts(image);
        int bits = jas_image_cmptprec(image, 0);
        int stride, image_size;
        int clrspc = jas_image_clrspc(image);
        int x, y;
        long usable, done;

        stride = numcmpts*jas_image_width(image);

        if (bits > 8)  stride = 2*numcmpts*jas_image_width(image);
        if (bits == 4) stride = (stride + 1)/2;

        image_size = stride*jas_image_height(image);
        /* copy data out of the decoded image data */
        /* be lazy and only write the rest of the current row */
        y = state->offset / stride;
        x = state->offset - y*stride; /* bytes, not samples */
        usable = min(out_size, stride - x);
        /* now samples */
        if (bits > 8) {
            x = x/(numcmpts*2);               
        } else {
            x = x/numcmpts;     
        }
        /* Make sure we can return a full pixel.
           This can fail if we get the colorspace wrong. */
        if (usable < numcmpts) return ERRC;

        if (state->colorspace != gs_jpx_cs_unset)
          /* An external colorspace from the interpreter overrides */
          switch (state->colorspace) {
            case gs_jpx_cs_gray:
            case gs_jpx_cs_indexed:
            /* we've passed 'raw' but the palette is the same pixel
               format as a grayscale image. The PDF interpreter will
               know to handle it differently. */
              done = copy_row_gray(pw->ptr, image, x, y, usable);
              break;
            case gs_jpx_cs_rgb:
              done = copy_row_rgb(pw->ptr, image, x, y, usable);
              break;
            case gs_jpx_cs_cmyk:
            default:
              done = copy_row_default(pw->ptr, image, x, y, usable);
              break;
          }
        else /* use the stream's colorspace */
          switch (jas_clrspc_fam(clrspc)) {
                case JAS_CLRSPC_FAM_GRAY:
                    if (bits > 8) {
                        done = copy_row_gray16(pw->ptr, image, x, y, usable, bits);
                    } else {
                        done = copy_row_gray(pw->ptr, image, x, y, usable);
                    }
                    break;
                case JAS_CLRSPC_FAM_RGB:
                    if (bits == 16) {
                        /* This will have issues if we have mixed compononents
                           with different bps. Unlikely, but it could happen */
                        done = copy_row_default16(pw->ptr, image, x, y, usable);
                    } else {
                        done = copy_row_rgb(pw->ptr, image, x, y, usable);
                    }
                    break;
                case JAS_CLRSPC_FAM_YCBCR:
                    done = copy_row_yuv(pw->ptr, image, x, y, usable);
                    break;
                case JAS_CLRSPC_FAM_XYZ:
                case JAS_CLRSPC_FAM_LAB:
                case JAS_CLRSPC_FAM_UNKNOWN:
                default:
                    if (bits == 16) {
                        /* This will have issues if we have mixed compononents
                           with different bps. Unlikely, but it could happen */
                        done = copy_row_default16(pw->ptr, image, x, y, usable);
                    } else {
                        done = copy_row_default(pw->ptr, image, x, y, usable);
                    }
                    break;
         }
        /* advance pointers for returned data */
        pw->ptr += done;
        state->offset += done;
        status = (state->offset < image_size) ? 1 : EOFC;
        /* return an error if we failed to advance decoding */
        if (done <= 0) status = ERRC;
      } /* image != NULL */
    } /* last */

    return status;
}

/* stream release.
   free all our decoder state.
 */
static void
s_jpxd_release(stream_state *ss)
{
    stream_jpxd_state *const state = (stream_jpxd_state *) ss;

    if (state) {
        if (state->image) jas_image_destroy(state->image);
        if (state->buffer) gs_free(state->jpx_memory, state->buffer, state->bufsize, 1,
                                "JPXDecode temp buffer");
    }
}

/* set stream defaults.
   This hook exists to avoid confusing the gc with bogus
   pointers. We also set a default for client-settable
   parameters like the requested output colorspace.
 */
static void
s_jpxd_set_defaults(stream_state *ss)
{
    stream_jpxd_state *const state = (stream_jpxd_state *) ss;

    state->image = NULL;
    state->offset = 0;
    state->buffer = NULL;
    state->bufsize = 0;
    state->buffill = 0;
    /* the following can be set by the client before calling init() */
    state->colorspace = gs_jpx_cs_unset;
    state->alpha = false;
}


/* stream template */
const stream_template s_jpxd_template = {
    &st_jpxd_state,
    s_jpxd_init,
    s_jpxd_process,
    1, 1, /* min in and out buffer sizes we can handle
                     should be ~32k,64k for efficiency? */
    s_jpxd_release,
    s_jpxd_set_defaults
};