/* Copyright (C) 2001-2025 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 the license contained in the file LICENSE in this distribution.

   Refer to licensing information at http://www.artifex.com or contact

   Artifex Software, Inc.,  39 Mesa Street, Suite 108A, San Francisco,

   CA 94129, USA, for further information.

*/

/* Pattern color mapping for Ghostscript library */

#include "math_.h"

#include "memory_.h"

#include "gx.h"

#include "gp.h"

#include "gserrors.h"

#include "gsstruct.h"

#include "gsutil.h"             /* for gs_next_ids */

#include "gxfixed.h"

#include "gxmatrix.h"

#include "gspath2.h"

#include "gxcspace.h"           /* for gscolor2.h */

#include "gxcolor2.h"

#include "gxdcolor.h"

#include "gxdevice.h"

#include "gxdevmem.h"

#include "gxpcolor.h"

#include "gxp1impl.h"

#include "gxclist.h"

#include "gxcldev.h"

#include "gzstate.h"

#include "gxdevsop.h"

#include "gdevmpla.h"

#include "gdevp14.h"

#include "gxgetbit.h"

#include "gscoord.h"

#include "gsicc_blacktext.h"

#include "gscspace.h"

#if RAW_PATTERN_DUMP

unsigned int global_pat_index = 0;

#endif

/* Define the default size of the Pattern cache. */

#define max_cached_patterns_LARGE 50

#define max_pattern_bits_LARGE 100000

#define max_cached_patterns_SMALL 5

#define max_pattern_bits_SMALL 1000

uint

gx_pat_cache_default_tiles(void)

{

#if ARCH_SMALL_MEMORY

    return max_cached_patterns_SMALL;

#else

#ifdef DEBUG

    return (gs_debug_c('.') ? max_cached_patterns_SMALL :

            max_cached_patterns_LARGE);

#else

    return max_cached_patterns_LARGE;

#endif

#endif

}

ulong

gx_pat_cache_default_bits(void)

{

#if ARCH_SMALL_MEMORY

    return max_pattern_bits_SMALL;

#else

#ifdef DEBUG

    return (gs_debug_c('.') ? max_pattern_bits_SMALL :

            max_pattern_bits_LARGE);

#else

    return max_pattern_bits_LARGE;

#endif

#endif

}

/* Define the structures for Pattern rendering and caching. */

private_st_color_tile();

private_st_color_tile_element();

private_st_pattern_cache();

private_st_device_pattern_accum();

private_st_pattern_trans();

/* ------ Pattern rendering ------ */

/* Device procedures */

static dev_proc_open_device(pattern_accum_open);

static dev_proc_close_device(pattern_accum_close);

static dev_proc_fill_rectangle(pattern_accum_fill_rectangle);

static dev_proc_copy_mono(pattern_accum_copy_mono);

static dev_proc_copy_color(pattern_accum_copy_color);

static dev_proc_copy_planes(pattern_accum_copy_planes);

static dev_proc_get_bits_rectangle(pattern_accum_get_bits_rectangle);

static dev_proc_fill_rectangle_hl_color(pattern_accum_fill_rectangle_hl_color);

/* not static for use by clist_dev_spec_op with pattern-clist */

dev_proc_dev_spec_op(pattern_accum_dev_spec_op);

/* The device descriptor */

static void

pattern_accum_initialize_device_procs(gx_device *dev)

{

    set_dev_proc(dev, open_device, pattern_accum_open);

    set_dev_proc(dev, close_device, pattern_accum_close);

    set_dev_proc(dev, fill_rectangle, pattern_accum_fill_rectangle);

    set_dev_proc(dev, copy_mono, pattern_accum_copy_mono);

    set_dev_proc(dev, copy_color, pattern_accum_copy_color);

    set_dev_proc(dev, get_clipping_box, gx_get_largest_clipping_box);

    set_dev_proc(dev, get_bits_rectangle, pattern_accum_get_bits_rectangle);

    set_dev_proc(dev, fill_rectangle_hl_color, pattern_accum_fill_rectangle_hl_color);

    set_dev_proc(dev, dev_spec_op, pattern_accum_dev_spec_op);

    set_dev_proc(dev, copy_planes, pattern_accum_copy_planes);

    /* It would be much nicer if gx_device_init set the following

     * defaults for us, but that doesn't work for some reason. */

    set_dev_proc(dev, copy_alpha, gx_default_copy_alpha);

    set_dev_proc(dev, fill_path, gx_default_fill_path);

    set_dev_proc(dev, stroke_path, gx_default_stroke_path);

    set_dev_proc(dev, fill_mask, gx_default_fill_mask);

    set_dev_proc(dev, fill_trapezoid, gx_default_fill_trapezoid);

    set_dev_proc(dev, fill_parallelogram, gx_default_fill_parallelogram);

    set_dev_proc(dev, fill_triangle, gx_default_fill_triangle);

    set_dev_proc(dev, draw_thin_line, gx_default_draw_thin_line);

    set_dev_proc(dev, strip_tile_rectangle, gx_default_strip_tile_rectangle);

    set_dev_proc(dev, begin_typed_image, gx_default_begin_typed_image);

    set_dev_proc(dev, composite, gx_default_composite);

    set_dev_proc(dev, text_begin, gx_default_text_begin);

    set_dev_proc(dev, strip_copy_rop2, gx_default_strip_copy_rop2);

    set_dev_proc(dev, strip_tile_rect_devn, gx_default_strip_tile_rect_devn);

    set_dev_proc(dev, transform_pixel_region, gx_default_transform_pixel_region);

    set_dev_proc(dev, fill_stroke_path, gx_default_fill_stroke_path);

    set_dev_proc(dev, lock_pattern, gx_default_lock_pattern);

    set_dev_proc(dev, copy_alpha_hl_color, gx_default_copy_alpha_hl_color);

}

static const gx_device_pattern_accum gs_pattern_accum_device =

{std_device_std_body_type_open(gx_device_pattern_accum,

                               pattern_accum_initialize_device_procs,

                               "pattern accumulator",

                               &st_device_pattern_accum,

                               0, 0, 72, 72)

};

extern dev_proc_open_device(clist_open);

int

pattern_clist_open_device(gx_device *dev)

{

    /* This function is defiled only for clist_init_bands. */

    return clist_open(dev);

}

static dev_proc_create_buf_device(dummy_create_buf_device)

{

    gx_device_memory *mdev = (gx_device_memory *)*pbdev;

    gs_make_mem_device(mdev, gdev_mem_device_for_bits(target->color_info.depth),

                mem, 0, target);

    return 0;

}

static dev_proc_size_buf_device(dummy_size_buf_device)

{

    return 0;

}

static dev_proc_setup_buf_device(dummy_setup_buf_device)

{

    return 0;

}

static dev_proc_destroy_buf_device(dummy_destroy_buf_device)

{

}

/* Attempt to determine the size of a pattern (the approximate amount that will */

/* be needed in the pattern cache). If we end up using the clist, this is only  */

/* a guess -- we use the tile size which will _probably_ be too large.          */

static size_t

gx_pattern_size_estimate(gs_pattern1_instance_t *pinst, bool has_tags)

{

    gx_device *tdev = pinst->saved->device;

    int depth = (pinst->templat.PaintType == 2 ? 1 : tdev->color_info.depth);

    size_t raster;

    size_t size;

    if (pinst->size.x == 0 || pinst->size.y == 0)

        return 0;

    if (pinst->templat.uses_transparency) {

        /* if the device has tags, add in an extra tag byte for the pdf14 compositor */

        raster = ((size_t)pinst->size.x * ((depth/8) + 1 + (has_tags ? 1 : 0)));

    } else {

        raster = ((size_t)pinst->size.x * depth + 7) / 8;

    }

    size = raster > max_size_t / pinst->size.y ? (max_size_t - 0xFFFF) : raster * pinst->size.y;

    return size;

}

static void gx_pattern_accum_finalize_cw(gx_device * dev)

{

    gx_device_clist_writer *cwdev = (gx_device_clist_writer *)dev;

    rc_decrement_only(cwdev->target, "gx_pattern_accum_finalize_cw");

}

bool gx_device_is_pattern_accum(gx_device *dev)

{

    return dev_proc(dev, open_device) == pattern_accum_open;

}

bool gx_device_is_pattern_clist(gx_device *dev)

{

    return dev_proc(dev, open_device) == pattern_clist_open_device;

}

/* Allocate a pattern accumulator, with an initial refct of 0. */

gx_device_forward *

gx_pattern_accum_alloc(gs_memory_t * mem, gs_memory_t * storage_memory,

                       gs_pattern1_instance_t *pinst, client_name_t cname)

{

    gx_device *tdev = pinst->saved->device;

    bool has_tags = device_encodes_tags(tdev);

    size_t size = gx_pattern_size_estimate(pinst, has_tags);

    gx_device_forward *fdev;

    int force_no_clist = 0;

    size_t max_pattern_bitmap = tdev->MaxPatternBitmap == 0 ? MaxPatternBitmap_DEFAULT :

                                tdev->MaxPatternBitmap;

    pinst->num_planar_planes = tdev->num_planar_planes;

    /*

     * If the target device can accumulate a pattern stream and the language

     * client supports high level patterns (ps and pdf only) we don't need a

     * raster or clist representation for the pattern, but the code goes

     * through the motions of creating the device anyway.  Later when the

     * pattern paint procedure is called  an error is returned and whatever

     * has been set up here is destroyed.  We try to make sure the same path

     * is taken in the code even though the device is never used because

     * there are pathological problems (see Bug689851.pdf) where the pattern

     * is so large we can't even allocate the memory for the device and the

     * dummy clist path must be used.  None of this discussion is relevant if

     * the client language does not support high level patterns or the device

     * cannot accumulate the pattern stream.

     */

    if (pinst->saved->have_pattern_streams == 0 && (*dev_proc(pinst->saved->device,

        dev_spec_op))((gx_device *)pinst->saved->device,

        gxdso_pattern_can_accum, pinst, 0) == 1)

        force_no_clist = 1; /* Set only for first time through */

    /* If the blend mode in use is not Normal, then we CANNOT use a tile. What

     * if the blend mode changes half way through the tile? We simply must use

     * a clist. */

    if (force_no_clist ||

        (((size < max_pattern_bitmap && !pinst->is_clist)

           || pinst->templat.PaintType != 1) && !pinst->templat.BM_Not_Normal)) {

        gx_device_pattern_accum *adev = gs_alloc_struct_immovable(mem, gx_device_pattern_accum,

                        &st_device_pattern_accum, cname);

        if (adev == 0)

            return 0;

#ifdef DEBUG

        if (pinst->is_clist)

            emprintf(mem, "not using clist even though clist is requested\n");

#endif

        pinst->is_clist = false;

        (void)gx_device_init((gx_device *)adev,

                             (const gx_device *)&gs_pattern_accum_device,

                             mem, true);

        adev->instance = pinst;

        adev->bitmap_memory = storage_memory;

        fdev = (gx_device_forward *)adev;

    } else {

        gx_device_buf_procs_t buf_procs = {dummy_create_buf_device,

        dummy_size_buf_device, dummy_setup_buf_device, dummy_destroy_buf_device};

        gx_device_clist *cdev;

        gx_device_clist_writer *cwdev;

        const int data_size = 1024*128;

        gx_band_params_t band_params = { 0 };

        byte *data  = gs_alloc_bytes(mem->non_gc_memory, data_size, cname);

        if (data == NULL)

            return 0;

        pinst->is_clist = true;

        /* NB: band_params.page_uses_transparency is set in clist_make_accum_device */

        band_params.BandWidth = pinst->size.x;

        band_params.BandHeight = pinst->size.y;

        band_params.BandBufferSpace = 0;

        cdev = clist_make_accum_device(mem, tdev, "pattern-clist", data, data_size,

                                       &buf_procs, &band_params, true, /* use_memory_clist */

                                       pinst->templat.uses_transparency, pinst);

        if (cdev == 0) {

            gs_free_object(tdev->memory->non_gc_memory, data, cname);

            return 0;

        }

        cwdev = (gx_device_clist_writer *)cdev;

        cwdev->finalize = gx_pattern_accum_finalize_cw;

        set_dev_proc(cwdev, open_device, pattern_clist_open_device);

        fdev = (gx_device_forward *)cdev;

    }

    fdev->log2_align_mod = tdev->log2_align_mod;

    fdev->pad = tdev->pad;

    fdev->num_planar_planes = tdev->num_planar_planes;

    fdev->graphics_type_tag = tdev->graphics_type_tag;

    fdev->interpolate_control = tdev->interpolate_control;

    fdev->non_strict_bounds = tdev->non_strict_bounds;

    gx_device_forward_fill_in_procs(fdev);

    return fdev;

}

gx_pattern_trans_t*

new_pattern_trans_buff(gs_memory_t *mem)

{

    gx_pattern_trans_t *result;

    /* Allocate structure that we will use for the trans pattern */

    result = gs_alloc_struct(mem, gx_pattern_trans_t, &st_pattern_trans, "new_pattern_trans_buff");

    if (result != NULL) {

        result->transbytes = NULL;

        result->pdev14 = NULL;

        result->mem = NULL;

        result->fill_trans_buffer = NULL;

        result->buf = NULL;

        result->n_chan = 0;

    }

    return(result);

}

/*

 * Initialize a pattern accumulator.

 * Client must already have set instance and bitmap_memory.

 *

 * Note that mask and bits accumulators are only created if necessary.

 */

static int

pattern_accum_open(gx_device * dev)

{

    gx_device_pattern_accum *const padev = (gx_device_pattern_accum *) dev;

    const gs_pattern1_instance_t *pinst = padev->instance;

    gs_memory_t *mem = padev->bitmap_memory;

    gx_device_memory *mask = 0;

    gx_device_memory *bits = 0;

    /*

     * The client should preset the target, because the device for which the

     * pattern is being rendered may not (in general, will not) be the same

     * as the one that was current when the pattern was instantiated.

     */

    gx_device *target =

        (padev->target == 0 ? gs_currentdevice(pinst->saved) :

         padev->target);

    int width = pinst->size.x;

    int height = pinst->size.y;

    int code = 0;

    bool mask_open = false;

    /*

     * C's bizarre coercion rules force us to copy HWResolution in pieces

     * rather than using a single assignment.

     */

#define PDSET(dev)\

  ((dev)->width = width, (dev)->height = height,\

   /*(dev)->HWResolution = target->HWResolution*/\

   (dev)->HWResolution[0] = target->HWResolution[0],\

   (dev)->HWResolution[1] = target->HWResolution[1])

    PDSET(padev);

    padev->color_info = target->color_info;

    /* Bug 689737: If PaintType == 2 (Uncolored tiling pattern), pattern is

     * 1bpp bitmap. No antialiasing in this case! */

    if (pinst->templat.PaintType == 2) {

        padev->color_info.anti_alias.text_bits = 1;

        padev->color_info.anti_alias.graphics_bits = 1;

    }

    /* If we have transparency, then fix the color info

       now so that the mem device allocates the proper

       buffer space for the pattern template.  We can

       do this since the transparency code all */

    if (pinst->templat.uses_transparency) {

        /* Allocate structure that we will use for the trans pattern */

        padev->transbuff = new_pattern_trans_buff(mem);

        if (padev->transbuff == NULL)

            return_error(gs_error_VMerror);

    } else {

        padev->transbuff = NULL;

    }

    if (pinst->uses_mask) {

        mask = gs_alloc_struct( mem,

                                gx_device_memory,

                                &st_device_memory,

                                "pattern_accum_open(mask)"

                                );

        if (mask == 0)

            return_error(gs_error_VMerror);

        gs_make_mem_mono_device(mask, mem, 0);

        PDSET(mask);

        mask->bitmap_memory = mem;

        mask->base = 0;

        code = (*dev_proc(mask, open_device)) ((gx_device *) mask);

        if (code >= 0) {

            mask_open = true;

            memset(mask->base, 0, (size_t)mask->raster * mask->height);

        }

    }

    if (code >= 0) {

        if (pinst->templat.uses_transparency) {

            /* In this case, we will grab the buffer created

               by the graphic state's device (which is pdf14) and

               we will be tiling that into a transparency group buffer

               to blend with the pattern accumulator's target.  Since

               all the transparency stuff is planar format, it is

               best just to keep the data in that form */

            gx_device_set_target((gx_device_forward *)padev, target);

        } else {

            switch (pinst->templat.PaintType) {

            case 2:             /* uncolored */

                gx_device_set_target((gx_device_forward *)padev, target);

                break;

            case 1:             /* colored */

                bits = gs_alloc_struct(mem, gx_device_memory,

                                       &st_device_memory,

                                       "pattern_accum_open(bits)");

                if (bits == 0)

                    code = gs_note_error(gs_error_VMerror);

                else {

                    gs_make_mem_device(bits,

                            gdev_mem_device_for_bits(padev->color_info.depth),

                                       mem, -1, target);

                    PDSET(bits);

#undef PDSET

                    bits->color_info = padev->color_info;

                    bits->bitmap_memory = mem;

                    if (target->num_planar_planes > 0)

                    {

                        gx_render_plane_t planes[GX_DEVICE_COLOR_MAX_COMPONENTS];

                        uchar num_comp = padev->num_planar_planes;

                        uchar i;

                        int depth = target->color_info.depth / num_comp;

                        for (i = 0; i < num_comp; i++)

                        {

                            planes[i].shift = depth * (num_comp - 1 - i);

                            planes[i].depth = depth;

                            planes[i].index = i;

                        }

                        code = gdev_mem_set_planar(bits, num_comp, planes);

                    }

                    if (code >= 0) {

                        code = (*dev_proc(bits, open_device)) ((gx_device *) bits);

                        gx_device_set_target((gx_device_forward *)padev,

                                             (gx_device *)bits);

                        /* The update_spot_equivalent_color proc for the bits device

                           should forward to the real target device.  This will ensure

                           that the target device can get equivalent CMYK values for

                           spot colors if we are using a separation device and the spot

                           color occurs only in patterns on the page. */

                        bits->procs.update_spot_equivalent_colors = gx_forward_update_spot_equivalent_colors;

                    }

                }

            }

        }

    }

    if (code < 0) {

        if (bits != 0)

            gs_free_object(mem, bits, "pattern_accum_open(bits)");

        if (mask != 0) {

            if (mask_open)

                (*dev_proc(mask, close_device)) ((gx_device *) mask);

            gs_free_object(mem, mask, "pattern_accum_open(mask)");

        }

        return code;

    }

    padev->mask = mask;

    padev->bits = bits;

    /* Retain the device, so it will survive anomalous grestores. */

    gx_device_retain(dev, true);

    return code;

}

/* Close an accumulator and free the bits. */

static int

pattern_accum_close(gx_device * dev)

{

    gx_device_pattern_accum *const padev = (gx_device_pattern_accum *) dev;

    gs_memory_t *mem = padev->bitmap_memory;

    /*

     * If bits != 0, it is the target of the device; reference counting

     * will close and free it.

     */

    gx_device_set_target((gx_device_forward *)padev, NULL);

    padev->bits = 0;

    if (padev->mask != 0) {

        (*dev_proc(padev->mask, close_device)) ((gx_device *) padev->mask);

        gs_free_object(mem, padev->mask, "pattern_accum_close(mask)");

        padev->mask = 0;

    }

    if (padev->transbuff != 0) {

        gs_free_object(mem,padev->target,"pattern_accum_close(transbuff)");

        padev->transbuff = NULL;

    }

    /* Un-retain the device now, so reference counting will free it. */

    gx_device_retain(dev, false);

    return 0;

}

/* _hl_color */

static int

pattern_accum_fill_rectangle_hl_color(gx_device *dev, const gs_fixed_rect *rect,

                                      const gs_gstate *pgs,

                                      const gx_drawing_color *pdcolor,

                                      const gx_clip_path *pcpath)

{

    gx_device_pattern_accum *const padev = (gx_device_pattern_accum *) dev;

    int code;

    if (padev->bits) {

        code = (*dev_proc(padev->target, fill_rectangle_hl_color))

            (padev->target, rect, pgs, pdcolor, pcpath);

        if (code < 0)

            return code;

    }

    if (padev->mask) {

        int x, y, w, h;

        x = fixed2int(rect->p.x);

        y = fixed2int(rect->p.y);

        w = fixed2int(rect->q.x) - x;

        h = fixed2int(rect->q.y) - y;

        return (*dev_proc(padev->mask, fill_rectangle))

            ((gx_device *) padev->mask, x, y, w, h, (gx_color_index) 1);

    }

    return 0;

}

/* Fill a rectangle */

static int

pattern_accum_fill_rectangle(gx_device * dev, int x, int y, int w, int h,

                             gx_color_index color)

{

    gx_device_pattern_accum *const padev = (gx_device_pattern_accum *) dev;

    if (padev->bits)

        (*dev_proc(padev->target, fill_rectangle))

            (padev->target, x, y, w, h, color);

    if (padev->mask)

        return (*dev_proc(padev->mask, fill_rectangle))

            ((gx_device *) padev->mask, x, y, w, h, (gx_color_index) 1);

     else

        return 0;

}

/* Copy a monochrome bitmap. */

static int

pattern_accum_copy_mono(gx_device * dev, const byte * data, int data_x,

                    int raster, gx_bitmap_id id, int x, int y, int w, int h,

                        gx_color_index color0, gx_color_index color1)

{

    gx_device_pattern_accum *const padev = (gx_device_pattern_accum *) dev;

    /* opt out early if nothing to render (some may think this a bug) */

    if (color0 == gx_no_color_index && color1 == gx_no_color_index)

        return 0;

    if (padev->bits)

        (*dev_proc(padev->target, copy_mono))

            (padev->target, data, data_x, raster, id, x, y, w, h,

             color0, color1);

    if (padev->mask) {

        if (color0 != gx_no_color_index)

            color0 = 1;

        if (color1 != gx_no_color_index)

            color1 = 1;

        if (color0 == 1 && color1 == 1)

            return (*dev_proc(padev->mask, fill_rectangle))

                ((gx_device *) padev->mask, x, y, w, h, (gx_color_index) 1);

        else

            return (*dev_proc(padev->mask, copy_mono))

                ((gx_device *) padev->mask, data, data_x, raster, id, x, y, w, h,

                 color0, color1);

    } else

        return 0;

}

/* Copy a color bitmap. */

static int

pattern_accum_copy_color(gx_device * dev, const byte * data, int data_x,

                    int raster, gx_bitmap_id id, int x, int y, int w, int h)

{

    gx_device_pattern_accum *const padev = (gx_device_pattern_accum *) dev;

    if (padev->bits)

        (*dev_proc(padev->target, copy_color))

            (padev->target, data, data_x, raster, id, x, y, w, h);

    if (padev->mask)

        return (*dev_proc(padev->mask, fill_rectangle))

            ((gx_device *) padev->mask, x, y, w, h, (gx_color_index) 1);

    else

        return 0;

}

/* Copy a color plane. */

static int

pattern_accum_copy_planes(gx_device * dev, const byte * data, int data_x,

                          int raster, gx_bitmap_id id,

                          int x, int y, int w, int h, int plane_height)

{

    gx_device_pattern_accum *const padev = (gx_device_pattern_accum *) dev;

    if (padev->bits)

        (*dev_proc(padev->target, copy_planes))

            (padev->target, data, data_x, raster, id, x, y, w, h, plane_height);

    if (padev->mask)

        return (*dev_proc(padev->mask, fill_rectangle))

            ((gx_device *) padev->mask, x, y, w, h, (gx_color_index) 1);

    else

        return 0;

}

static int

blank_unmasked_bits(gx_device * mask,

                    int polarity,

                    int num_comps,

                    int depth,

                    const gs_int_rect *prect,

                    gs_get_bits_params_t *p)

{

    static const int required_options = GB_COLORS_NATIVE

                       | GB_ALPHA_NONE

                       | GB_RETURN_COPY

                       | GB_ALIGN_STANDARD

                       | GB_OFFSET_0

                       | GB_RASTER_STANDARD;

    int raster = p->raster;

    byte *min;

    int x0 = prect->p.x;

    int y0 = prect->p.y;

    int x, y;

    int w = prect->q.x - x0;

    int h = prect->q.y - y0;

    int code = 0;

    byte *ptr;

    int blank = (polarity == GX_CINFO_POLARITY_ADDITIVE ? 255 : 0);

    gs_int_rect rect;

    gs_get_bits_params_t params;

    if ((p->options & required_options) != required_options)

        return_error(gs_error_rangecheck);

    min = gs_alloc_bytes(mask->memory, (w+7)>>3, "blank_unmasked_bits");

    if (min == NULL)

        return_error(gs_error_VMerror);

    rect.p.x = 0;

    rect.q.x = mask->width;

    params.x_offset = 0;

    params.raster = bitmap_raster(mask->width * mask->color_info.depth);

    if (p->options & GB_PACKING_CHUNKY)

    {

        if ((depth & 7) != 0 || depth > 64) {

            code = gs_note_error(gs_error_rangecheck);

            goto fail;

        }

        ptr = p->data[0];

        depth >>= 3;

        raster -= w*depth;

        for (y = 0; y < h; y++)

        {

            byte *mine;

            rect.p.y = y+y0;

            rect.q.y = y+y0+1;

            params.options = (GB_ALIGN_ANY |

                              (GB_RETURN_COPY | GB_RETURN_POINTER) |

                              GB_OFFSET_0 |

                              GB_RASTER_STANDARD | GB_PACKING_CHUNKY |

                              GB_COLORS_NATIVE | GB_ALPHA_NONE);

            params.data[0] = min;

            code = (*dev_proc(mask, get_bits_rectangle))(mask, &rect,

                                                         &params);

            if (code < 0)

                goto fail;

            mine = params.data[0];

            for (x = 0; x < w; x++)

            {

                int xx = x+x0;

                if (((mine[xx>>3]<<(x&7)) & 128) == 0) {

                    switch (depth)

                    {

                    case 8:

                        *ptr++ = blank;

                    case 7:

                        *ptr++ = blank;

                    case 6:

                        *ptr++ = blank;

                    case 5:

                        *ptr++ = blank;

                    case 4:

                        *ptr++ = blank;

                    case 3:

                        *ptr++ = blank;

                    case 2:

                        *ptr++ = blank;

                    case 1:

                        *ptr++ = blank;

                        break;

                    }

                } else {

                    ptr += depth;

                }

            }

            ptr += raster;

        }

    } else {

        /* Planar, only handle 8 or 16 bits */

        int bytes_per_component = (depth/num_comps) >> 3;

        if (depth/num_comps != 8 && depth/num_comps != 16) {

            code = gs_note_error(gs_error_rangecheck);

            goto fail;

        }

        for (y = 0; y < h; y++)

        {

            int c;

            byte *mine;

            rect.p.y = y+y0;

            rect.q.y = y+y0+1;

            params.options = (GB_ALIGN_ANY |

                              (GB_RETURN_COPY | GB_RETURN_POINTER) |

                              GB_OFFSET_0 |

                              GB_RASTER_STANDARD | GB_PACKING_CHUNKY |

                              GB_COLORS_NATIVE | GB_ALPHA_NONE);

            params.data[0] = min;

            code = (*dev_proc(mask, get_bits_rectangle))(mask, &rect,

                                                         &params);

            if (code < 0)

                goto fail;

            mine = params.data[0];

            for (c = 0; c < num_comps; c++)

            {

                if (p->data[c] == NULL)

                    continue;

                ptr = p->data[c] + raster * y;

                for (x = 0; x < w; x++)

                {

                    int xx = x+x0;

                    if (((mine[xx>>3]>>(x&7)) & 1) == 0) {

                        *ptr++ = blank;

                        if (bytes_per_component > 1)

                            *ptr++ = blank;

                    } else {

                        ptr += bytes_per_component;

                    }

                }

            }

        }

    }

fail:

    gs_free_object(mask->memory, min, "blank_unmasked_bits");

    return code;

}

/* Read back a rectangle of bits. */

/****** SHOULD USE MASK TO DEFINE UNREAD AREA *****/

static int

pattern_accum_get_bits_rectangle(gx_device * dev, const gs_int_rect * prect,

                       gs_get_bits_params_t * params)

{

    gx_device_pattern_accum *const padev = (gx_device_pattern_accum *) dev;

    int code;

    gs_get_bits_params_t params2 = *params;

    if (padev->bits) {

        if (padev->mask)

            params2.options &= ~GB_RETURN_POINTER;

        code = (*dev_proc(padev->target, get_bits_rectangle))

            (padev->target, prect, &params2);

        /* If we have a mask, then unmarked pixels of the bits

         * will be undefined. Strictly speaking it makes no

         * sense for us to return any value here, but the only

         * caller of this currently is the overprint code, which

         * uses the the values to parrot back to us. Let's

         * make sure they are set to the default 'empty' values.

         */

        if (code >= 0 && padev->mask)

            code = blank_unmasked_bits((gx_device *)padev->mask,

                                       padev->target->color_info.polarity,

                                       padev->target->color_info.num_components,

                                       padev->target->color_info.depth,

                                       prect, &params2);

        return code;

    }

    return_error(gs_error_Fatal); /* shouldn't happen */

}

/* ------ Color space implementation ------ */

/* Free all entries in a pattern cache. */

static bool

pattern_cache_choose_all(gx_color_tile * ctile, void *proc_data)

{

    return true;

}

static void

pattern_cache_free_all(gx_pattern_cache * pcache)

{

    gx_pattern_cache_winnow(pcache, pattern_cache_choose_all, NULL);

}

/* Allocate a Pattern cache. */

gx_pattern_cache *

gx_pattern_alloc_cache(gs_memory_t * mem, uint num_tiles, ulong max_bits)

{

    gx_pattern_cache *pcache =

    gs_alloc_struct(mem, gx_pattern_cache, &st_pattern_cache,

                    "gx_pattern_alloc_cache(struct)");

    gx_color_tile *tiles =

    gs_alloc_struct_array(mem, num_tiles, gx_color_tile,

                          &st_color_tile_element,

                          "gx_pattern_alloc_cache(tiles)");

    uint i;

    if (pcache == 0 || tiles == 0) {

        gs_free_object(mem, tiles, "gx_pattern_alloc_cache(tiles)");

        gs_free_object(mem, pcache, "gx_pattern_alloc_cache(struct)");

        return 0;

    }

    pcache->memory = mem;

    pcache->tiles = tiles;

    pcache->num_tiles = num_tiles;

    pcache->tiles_used = 0;

    pcache->next = 0;

    pcache->bits_used = 0;

    pcache->max_bits = max_bits;

    pcache->free_all = pattern_cache_free_all;

    for (i = 0; i < num_tiles; tiles++, i++) {

        tiles->id = gx_no_bitmap_id;

        /* Clear the pointers to pacify the GC. */

        uid_set_invalid(&tiles->uid);

        tiles->bits_used = 0;

#ifdef PACIFY_VALGRIND

        /* The following memsets are required to avoid a valgrind warning

         * in:

         *   gs -I./gs/lib -sOutputFile=out.pgm -dMaxBitmap=10000

         *      -sDEVICE=pgmraw -r300 -Z: -sDEFAULTPAPERSIZE=letter

         *      -dNOPAUSE -dBATCH -K2000000 -dClusterJob -dJOBSERVER

         *      tests_private/ps/ps3cet/11-14.PS

         * Setting the individual elements of the structures directly is

         * not enough, which leads me to believe that we are writing the

         * entire structs out, padding and all.

         */

        memset(&tiles->tbits, 0, sizeof(tiles->tbits));

        memset(&tiles->tmask, 0, sizeof(tiles->tmask));

#else

        tiles->tbits.data = 0;

        tiles->tmask.data = 0;

#endif

        tiles->index = i;

        tiles->cdev = NULL;

        tiles->ttrans = NULL;

        tiles->num_planar_planes = 0;

    }

    return pcache;

}

/* Ensure that an imager has a Pattern cache. */

static int

ensure_pattern_cache(gs_gstate * pgs)

{

    if (pgs->pattern_cache == 0) {

        gx_pattern_cache *pcache =

        gx_pattern_alloc_cache(pgs->memory,

                               gx_pat_cache_default_tiles(),

                               gx_pat_cache_default_bits());

        if (pcache == 0)

            return_error(gs_error_VMerror);

        pgs->pattern_cache = pcache;

    }

    return 0;

}

/* Free pattern cache and its components. */

void

gx_pattern_cache_free(gx_pattern_cache *pcache)

{

    if (pcache == NULL)

        return;

    pattern_cache_free_all(pcache);

    gs_free_object(pcache->memory, pcache->tiles, "gx_pattern_cache_free");

    pcache->tiles = NULL;

    gs_free_object(pcache->memory, pcache, "gx_pattern_cache_free");

}

/* Get and set the Pattern cache in a gstate. */

gx_pattern_cache *

gstate_pattern_cache(gs_gstate * pgs)

{

    return pgs->pattern_cache;

}

void

gstate_set_pattern_cache(gs_gstate * pgs, gx_pattern_cache * pcache)

{

    pgs->pattern_cache = pcache;

}

/* Free a Pattern cache entry. */

/* This will not free a pattern if it is 'locked' which should only be for */

/* a stroke pattern during fill_stroke_path.                               */

static void

gx_pattern_cache_free_entry(gx_pattern_cache * pcache, gx_color_tile * ctile, bool free_dummy)

{

    gx_device *temp_device;

    if ((ctile->id != gx_no_bitmap_id) && (!ctile->is_dummy || free_dummy) && !ctile->is_locked) {

        gs_memory_t *mem = pcache->memory;

        /*

         * We must initialize the memory device properly, even though

         * we aren't using it for drawing.

         */

        if (ctile->tmask.data != 0) {

            gs_free_object(mem, ctile->tmask.data,

                           "free_pattern_cache_entry(mask data)");

            ctile->tmask.data = 0;      /* for GC */

        }

        if (ctile->tbits.data != 0) {

            gs_free_object(mem, ctile->tbits.data,

                           "free_pattern_cache_entry(bits data)");

            ctile->tbits.data = 0;      /* for GC */

        }

        if (ctile->cdev != NULL) {

            ctile->cdev->common.do_not_open_or_close_bandfiles = false;  /* make sure memfile gets freed/closed */

            dev_proc(&ctile->cdev->common, close_device)((gx_device *)&ctile->cdev->common);

            /* Free up the icc based stuff in the clist device.  I am puzzled

               why the other objects are not released */

            clist_free_icc_table(ctile->cdev->common.icc_table,

                            ctile->cdev->common.memory);

            ctile->cdev->common.icc_table = NULL;

            rc_decrement(ctile->cdev->common.icc_cache_cl,

                            "gx_pattern_cache_free_entry");

            ctile->cdev->common.icc_cache_cl = NULL;

            ctile->cdev->writer.pinst = NULL;

            gs_free_object(ctile->cdev->common.memory->non_gc_memory, ctile->cdev->common.cache_chunk, "free tile cache for clist");

            ctile->cdev->common.cache_chunk = 0;

            temp_device = (gx_device *)ctile->cdev;

            gx_device_retain(temp_device, false);

            ctile->cdev = NULL;

        }

        if (ctile->ttrans != NULL) {

            if_debug2m('v', mem,

                       "[v*] Freeing trans pattern from cache, uid = %ld id = %ld\n",

                       ctile->uid.id, ctile->id);

            if ( ctile->ttrans->pdev14 == NULL) {

                /* This can happen if we came from the clist */

                if (ctile->ttrans->mem != NULL)

                    gs_free_object(ctile->ttrans->mem ,ctile->ttrans->transbytes,

                                   "free_pattern_cache_entry(transbytes)");

                gs_free_object(mem,ctile->ttrans->fill_trans_buffer,

                                "free_pattern_cache_entry(fill_trans_buffer)");

                ctile->ttrans->transbytes = NULL;

                ctile->ttrans->fill_trans_buffer = NULL;

            } else {

                dev_proc(ctile->ttrans->pdev14, close_device)((gx_device *)ctile->ttrans->pdev14);

                temp_device = (gx_device *)(ctile->ttrans->pdev14);

                gx_device_retain(temp_device, false);

                rc_decrement(temp_device,"gx_pattern_cache_free_entry");

                ctile->ttrans->pdev14 = NULL;

                ctile->ttrans->transbytes = NULL;  /* should be ok due to pdf14_close */

                ctile->ttrans->fill_trans_buffer = NULL; /* This is always freed */