diff mupdf-source/thirdparty/jbig2dec/jbig2_halftone.c @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mupdf-source/thirdparty/jbig2dec/jbig2_halftone.c	Mon Sep 15 11:43:07 2025 +0200
@@ -0,0 +1,661 @@
+/* Copyright (C) 2001-2023 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.
+*/
+
+/*
+    jbig2dec
+*/
+
+/* JBIG2 Pattern Dictionary and Halftone Region decoding */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+#include "os_types.h"
+
+#include <string.h>             /* memset() */
+
+#include "jbig2.h"
+#include "jbig2_priv.h"
+#include "jbig2_arith.h"
+#include "jbig2_generic.h"
+#include "jbig2_image.h"
+#include "jbig2_halftone.h"
+#include "jbig2_mmr.h"
+#include "jbig2_page.h"
+#include "jbig2_segment.h"
+
+/**
+ * jbig2_hd_new: create a new dictionary from a collective bitmap
+ */
+static Jbig2PatternDict *
+jbig2_hd_new(Jbig2Ctx *ctx, const Jbig2PatternDictParams *params, Jbig2Image *image)
+{
+    Jbig2PatternDict *new;
+    const uint32_t N = params->GRAYMAX + 1;
+    const uint32_t HPW = params->HDPW;
+    const uint32_t HPH = params->HDPH;
+    int code;
+    uint32_t i, j;
+
+    if (N == 0) {
+        /* We've wrapped. */
+        jbig2_error(ctx, JBIG2_SEVERITY_WARNING, JBIG2_UNKNOWN_SEGMENT_NUMBER, "params->GRAYMAX out of range");
+        return NULL;
+    }
+
+    /* allocate a new struct */
+    new = jbig2_new(ctx, Jbig2PatternDict, 1);
+    if (new != NULL) {
+        new->patterns = jbig2_new(ctx, Jbig2Image *, N);
+        if (new->patterns == NULL) {
+            jbig2_error(ctx, JBIG2_SEVERITY_FATAL, JBIG2_UNKNOWN_SEGMENT_NUMBER, "failed to allocate pattern in collective bitmap dictionary");
+            jbig2_free(ctx->allocator, new);
+            return NULL;
+        }
+        new->n_patterns = N;
+        new->HPW = HPW;
+        new->HPH = HPH;
+
+        /* 6.7.5(4) - copy out the individual pattern images */
+        for (i = 0; i < N; i++) {
+            new->patterns[i] = jbig2_image_new(ctx, HPW, HPH);
+            if (new->patterns[i] == NULL) {
+                jbig2_error(ctx, JBIG2_SEVERITY_WARNING, JBIG2_UNKNOWN_SEGMENT_NUMBER, "failed to allocate pattern element image");
+                /* new->patterns[i] above did not succeed, so releasing patterns 0..i-1 is enough */
+                for (j = 0; j < i; j++)
+                    jbig2_image_release(ctx, new->patterns[j]);
+                jbig2_free(ctx->allocator, new->patterns);
+                jbig2_free(ctx->allocator, new);
+                return NULL;
+            }
+            /* compose with the REPLACE operator; the source
+               will be clipped to the destination, selecting the
+               proper sub image */
+            code = jbig2_image_compose(ctx, new->patterns[i], image, -i * (int32_t) HPW, 0, JBIG2_COMPOSE_REPLACE);
+            if (code < 0) {
+                jbig2_error(ctx, JBIG2_SEVERITY_WARNING, JBIG2_UNKNOWN_SEGMENT_NUMBER, "failed to compose image into collective bitmap dictionary");
+                /* new->patterns[i] above succeeded, so release all patterns 0..i */
+                for (j = 0; j <= i; j++)
+                    jbig2_image_release(ctx, new->patterns[j]);
+                jbig2_free(ctx->allocator, new->patterns);
+                jbig2_free(ctx->allocator, new);
+                return NULL;
+            }
+        }
+    } else {
+        jbig2_error(ctx, JBIG2_SEVERITY_FATAL, JBIG2_UNKNOWN_SEGMENT_NUMBER, "failed to allocate collective bitmap dictionary");
+    }
+
+    return new;
+}
+
+/**
+ * jbig2_hd_release: release a pattern dictionary
+ */
+void
+jbig2_hd_release(Jbig2Ctx *ctx, Jbig2PatternDict *dict)
+{
+    int i;
+
+    if (dict == NULL)
+        return;
+    if (dict->patterns != NULL)
+        for (i = 0; i < dict->n_patterns; i++)
+            jbig2_image_release(ctx, dict->patterns[i]);
+    jbig2_free(ctx->allocator, dict->patterns);
+    jbig2_free(ctx->allocator, dict);
+}
+
+/**
+ * jbig2_decode_pattern_dict: decode pattern dictionary data
+ *
+ * @ctx: jbig2 decoder context
+ * @segment: jbig2 segment (header) structure
+ * @params: parameters from the pattern dictionary header
+ * @data: pointer to text region data to be decoded
+ * @size: length of text region data
+ * @GB_stats: arithmetic coding context to use
+ *
+ * Implements the pattern dictionary decoding procedure
+ * described in section 6.7 of the JBIG2 spec.
+ *
+ * returns: a pointer to the resulting dictionary on success
+ * returns: 0 on failure
+ **/
+static Jbig2PatternDict *
+jbig2_decode_pattern_dict(Jbig2Ctx *ctx, Jbig2Segment *segment,
+                          const Jbig2PatternDictParams *params, const byte *data, const size_t size, Jbig2ArithCx *GB_stats)
+{
+    Jbig2PatternDict *hd = NULL;
+    Jbig2Image *image = NULL;
+    Jbig2GenericRegionParams rparams;
+    int code = 0;
+
+    /* allocate the collective image */
+    image = jbig2_image_new(ctx, params->HDPW * (params->GRAYMAX + 1), params->HDPH);
+    if (image == NULL) {
+        jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate collective bitmap for halftone dictionary");
+        return NULL;
+    }
+
+    /* fill out the generic region decoder parameters */
+    rparams.MMR = params->HDMMR;
+    rparams.GBTEMPLATE = params->HDTEMPLATE;
+    rparams.TPGDON = 0;         /* not used if HDMMR = 1 */
+    rparams.USESKIP = 0;
+    rparams.gbat[0] = -(int8_t) params->HDPW;
+    rparams.gbat[1] = 0;
+    rparams.gbat[2] = -3;
+    rparams.gbat[3] = -1;
+    rparams.gbat[4] = 2;
+    rparams.gbat[5] = -2;
+    rparams.gbat[6] = -2;
+    rparams.gbat[7] = -2;
+
+    if (params->HDMMR) {
+        code = jbig2_decode_generic_mmr(ctx, segment, &rparams, data, size, image);
+    } else {
+        Jbig2WordStream *ws = jbig2_word_stream_buf_new(ctx, data, size);
+
+        if (ws != NULL) {
+            Jbig2ArithState *as = jbig2_arith_new(ctx, ws);
+
+            if (as != NULL) {
+                code = jbig2_decode_generic_region(ctx, segment, &rparams, as, image, GB_stats);
+            } else {
+                code = jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate arithmetic coding state when handling halftone dictionary");
+            }
+
+            jbig2_free(ctx->allocator, as);
+            jbig2_word_stream_buf_free(ctx, ws);
+        } else {
+            code = jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate word stream when handling halftone dictionary");
+        }
+    }
+
+    if (code == 0)
+        hd = jbig2_hd_new(ctx, params, image);
+    else
+        jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to decode immediate generic region");
+    jbig2_image_release(ctx, image);
+
+    return hd;
+}
+
+/* 7.4.4 */
+int
+jbig2_pattern_dictionary(Jbig2Ctx *ctx, Jbig2Segment *segment, const byte *segment_data)
+{
+    Jbig2PatternDictParams params;
+    Jbig2ArithCx *GB_stats = NULL;
+    byte flags;
+    int offset = 0;
+
+    /* 7.4.4.1 - Data header */
+    if (segment->data_length < 7) {
+        return jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "segment too short");
+    }
+    flags = segment_data[0];
+    params.HDMMR = flags & 1;
+    params.HDTEMPLATE = (flags & 6) >> 1;
+    params.HDPW = segment_data[1];
+    params.HDPH = segment_data[2];
+    params.GRAYMAX = jbig2_get_uint32(segment_data + 3);
+    offset += 7;
+
+    jbig2_error(ctx, JBIG2_SEVERITY_INFO, segment->number,
+                "pattern dictionary, flags=%02x, %d grays (%dx%d cell)", flags, params.GRAYMAX + 1, params.HDPW, params.HDPH);
+
+    if (params.HDMMR && params.HDTEMPLATE) {
+        jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "HDTEMPLATE is %d when HDMMR is %d, contrary to spec", params.HDTEMPLATE, params.HDMMR);
+    }
+    if (flags & 0xf8) {
+        jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "reserved flag bits non-zero");
+    }
+
+    /* 7.4.4.2 */
+    if (!params.HDMMR) {
+        /* allocate and zero arithmetic coding stats */
+        int stats_size = jbig2_generic_stats_size(ctx, params.HDTEMPLATE);
+
+        GB_stats = jbig2_new(ctx, Jbig2ArithCx, stats_size);
+        if (GB_stats == NULL)
+            return jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate arithmetic coding state when handling pattern dictionary");
+        memset(GB_stats, 0, stats_size);
+    }
+
+    segment->result = jbig2_decode_pattern_dict(ctx, segment, &params, segment_data + offset, segment->data_length - offset, GB_stats);
+
+    /* todo: retain GB_stats? */
+    if (!params.HDMMR) {
+        jbig2_free(ctx->allocator, GB_stats);
+    }
+
+    return (segment->result != NULL) ? 0 : -1;
+}
+
+/**
+ * jbig2_decode_gray_scale_image: decode gray-scale image
+ *
+ * @ctx: jbig2 decoder context
+ * @segment: jbig2 segment (header) structure
+ * @data: pointer to text region data to be decoded
+ * @size: length of text region data
+ * @GSMMR: if MMR is used
+ * @GSW: width of gray-scale image
+ * @GSH: height of gray-scale image
+ * @GSBPP: number of bitplanes/Jbig2Images to use
+ * @GSKIP: mask indicating which values should be skipped
+ * @GSTEMPLATE: template used to code the gray-scale bitplanes
+ * @GB_stats: arithmetic coding context to use
+ *
+ * Implements the decoding a gray-scale image described in
+ * annex C.5. This is part of the halftone region decoding.
+ *
+ * returns: array of gray-scale values with GSW x GSH width/height
+ *          0 on failure
+ **/
+static uint16_t **
+jbig2_decode_gray_scale_image(Jbig2Ctx *ctx, Jbig2Segment *segment,
+                              const byte *data, const size_t size,
+                              bool GSMMR, uint32_t GSW, uint32_t GSH,
+                              uint32_t GSBPP, bool GSUSESKIP, Jbig2Image *GSKIP, int GSTEMPLATE, Jbig2ArithCx *GB_stats)
+{
+    uint16_t **GSVALS = NULL;
+    size_t consumed_bytes = 0;
+    uint32_t i, j, stride, x, y;
+    int code;
+    Jbig2Image **GSPLANES;
+    Jbig2GenericRegionParams rparams;
+    Jbig2WordStream *ws = NULL;
+    Jbig2ArithState *as = NULL;
+
+    /* allocate GSPLANES */
+    GSPLANES = jbig2_new(ctx, Jbig2Image *, GSBPP);
+    if (GSPLANES == NULL) {
+        jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "failed to allocate %d bytes for GSPLANES", GSBPP);
+        return NULL;
+    }
+
+    for (i = 0; i < GSBPP; ++i) {
+        GSPLANES[i] = jbig2_image_new(ctx, GSW, GSH);
+        if (GSPLANES[i] == NULL) {
+            jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate %dx%d image for GSPLANES", GSW, GSH);
+            /* free already allocated */
+            for (j = i; j > 0;)
+                jbig2_image_release(ctx, GSPLANES[--j]);
+            jbig2_free(ctx->allocator, GSPLANES);
+            return NULL;
+        }
+    }
+
+    /* C.5 step 1. Decode GSPLANES[GSBPP-1] */
+    /* fill generic region decoder parameters */
+    rparams.MMR = GSMMR;
+    rparams.GBTEMPLATE = GSTEMPLATE;
+    rparams.TPGDON = 0;
+    rparams.USESKIP = GSUSESKIP;
+    rparams.SKIP = GSKIP;
+    rparams.gbat[0] = (GSTEMPLATE <= 1 ? 3 : 2);
+    rparams.gbat[1] = -1;
+    rparams.gbat[2] = -3;
+    rparams.gbat[3] = -1;
+    rparams.gbat[4] = 2;
+    rparams.gbat[5] = -2;
+    rparams.gbat[6] = -2;
+    rparams.gbat[7] = -2;
+
+    if (GSMMR) {
+        code = jbig2_decode_halftone_mmr(ctx, &rparams, data, size, GSPLANES[GSBPP - 1], &consumed_bytes);
+    } else {
+        ws = jbig2_word_stream_buf_new(ctx, data, size);
+        if (ws == NULL) {
+            jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate word stream when decoding gray scale image");
+            goto cleanup;
+        }
+
+        as = jbig2_arith_new(ctx, ws);
+        if (as == NULL) {
+            jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate arithmetic coding state when decoding gray scale image");
+            goto cleanup;
+        }
+
+        code = jbig2_decode_generic_region(ctx, segment, &rparams, as, GSPLANES[GSBPP - 1], GB_stats);
+    }
+    if (code < 0) {
+        jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "error decoding GSPLANES for halftone image");
+        goto cleanup;
+    }
+
+    /* C.5 step 2. Set j = GSBPP-2 */
+    j = GSBPP - 1;
+    /* C.5 step 3. decode loop */
+    while (j > 0) {
+        j--;
+        /*  C.5 step 3. (a) */
+        if (GSMMR) {
+            code = jbig2_decode_halftone_mmr(ctx, &rparams, data + consumed_bytes, size - consumed_bytes, GSPLANES[j], &consumed_bytes);
+        } else {
+            code = jbig2_decode_generic_region(ctx, segment, &rparams, as, GSPLANES[j], GB_stats);
+        }
+        if (code < 0) {
+            jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to decode GSPLANES for halftone image");
+            goto cleanup;
+        }
+
+        /* C.5 step 3. (b):
+         * for each [x,y]
+         * GSPLANES[j][x][y] = GSPLANES[j+1][x][y] XOR GSPLANES[j][x][y] */
+        stride = GSPLANES[j]->stride;
+        for (i = 0; i < stride * GSH; ++i)
+            GSPLANES[j]->data[i] ^= GSPLANES[j + 1]->data[i];
+
+        /*  C.5 step 3. (c) */
+    }
+
+    /* allocate GSVALS */
+    GSVALS = jbig2_new(ctx, uint16_t *, GSW);
+    if (GSVALS == NULL) {
+        jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "failed to allocate GSVALS: %d bytes", GSW);
+        goto cleanup;
+    }
+    for (i = 0; i < GSW; ++i) {
+        GSVALS[i] = jbig2_new(ctx, uint16_t, GSH);
+        if (GSVALS[i] == NULL) {
+            jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "failed to allocate GSVALS: %d bytes", GSH * GSW);
+            /* free already allocated */
+            for (j = i; j > 0;)
+                jbig2_free(ctx->allocator, GSVALS[--j]);
+            jbig2_free(ctx->allocator, GSVALS);
+            GSVALS = NULL;
+            goto cleanup;
+        }
+    }
+
+    /*  C.5 step 4.  */
+    for (x = 0; x < GSW; ++x) {
+        for (y = 0; y < GSH; ++y) {
+            GSVALS[x][y] = 0;
+
+            for (j = 0; j < GSBPP; ++j)
+                GSVALS[x][y] += jbig2_image_get_pixel(GSPLANES[j], x, y) << j;
+        }
+    }
+
+cleanup:
+    /* free memory */
+    if (!GSMMR) {
+        jbig2_free(ctx->allocator, as);
+        jbig2_word_stream_buf_free(ctx, ws);
+    }
+    for (i = 0; i < GSBPP; ++i)
+        jbig2_image_release(ctx, GSPLANES[i]);
+
+    jbig2_free(ctx->allocator, GSPLANES);
+
+    return GSVALS;
+}
+
+/**
+ * jbig2_decode_ht_region_get_hpats: get pattern dictionary
+ *
+ * @ctx: jbig2 decoder context
+ * @segment: jbig2 halftone region segment
+ *
+ * Returns the first referred pattern dictionary of segment
+ *
+ * returns: pattern dictionary
+ *          0 if search failed
+ **/
+static Jbig2PatternDict *
+jbig2_decode_ht_region_get_hpats(Jbig2Ctx *ctx, Jbig2Segment *segment)
+{
+    int index = 0;
+    Jbig2PatternDict *pattern_dict = NULL;
+    Jbig2Segment *rsegment = NULL;
+
+    /* loop through all referred segments */
+    while (!pattern_dict && segment->referred_to_segment_count > index) {
+        rsegment = jbig2_find_segment(ctx, segment->referred_to_segments[index]);
+        if (rsegment) {
+            /* segment type is pattern dictionary and result is not empty */
+            if ((rsegment->flags & 0x3f) == 16 && rsegment->result) {
+                pattern_dict = (Jbig2PatternDict *) rsegment->result;
+                return pattern_dict;
+            }
+        }
+        index++;
+    }
+    return pattern_dict;
+}
+
+/**
+ * jbig2_decode_halftone_region: decode a halftone region
+ *
+ * @ctx: jbig2 decoder context
+ * @segment: jbig2 halftone region segment
+ * @params: parameters
+ * @data: pointer to halftone region data to be decoded
+ * @size: length of halftone region data
+ * @GB_stats: arithmetic coding context to use
+ *
+ * Implements the halftone region decoding procedure
+ * described in section 6.6.5 of the JBIG2 spec.
+ *
+ * returns: 0 on success
+ *         <0 on failure
+ **/
+static int
+jbig2_decode_halftone_region(Jbig2Ctx *ctx, Jbig2Segment *segment,
+                             Jbig2HalftoneRegionParams *params, const byte *data, const size_t size, Jbig2Image *image, Jbig2ArithCx *GB_stats)
+{
+    uint32_t HBPP;
+    uint32_t HNUMPATS;
+    uint16_t **GI = NULL;
+    Jbig2Image *HSKIP = NULL;
+    Jbig2PatternDict *HPATS;
+    uint32_t i;
+    uint32_t mg, ng;
+    uint16_t gray_val;
+    int code = 0;
+
+    /* We need the patterns used in this region, get them from the referred pattern dictionary */
+    HPATS = jbig2_decode_ht_region_get_hpats(ctx, segment);
+    if (!HPATS) {
+        code = jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "no pattern dictionary found, skipping halftone image");
+        goto cleanup;
+    }
+
+    /* 6.6.5 point 1. Fill bitmap with HDEFPIXEL */
+    memset(image->data, params->HDEFPIXEL, image->stride * image->height);
+
+    /* 6.6.5 point 2. compute HSKIP according to 6.6.5.1 */
+    if (params->HENABLESKIP == 1) {
+        HSKIP = jbig2_image_new(ctx, params->HGW, params->HGH);
+        if (HSKIP == NULL)
+            return jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate skip image");
+
+        for (mg = 0; mg < params->HGH; ++mg) {
+            for (ng = 0; ng < params->HGW; ++ng) {
+                int64_t x = ((int64_t) params->HGX + mg * params->HRY + ng * params->HRX) >> 8;
+                int64_t y = ((int64_t) params->HGY + mg * params->HRX - ng * params->HRY) >> 8;
+
+                if (x + HPATS->HPW <= 0 || x >= image->width || y + HPATS->HPH <= 0 || y >= image->height) {
+                    jbig2_image_set_pixel(HSKIP, ng, mg, 1);
+                } else {
+                    jbig2_image_set_pixel(HSKIP, ng, mg, 0);
+                }
+            }
+        }
+    }
+
+    /* 6.6.5 point 3. set HBPP to ceil(log2(HNUMPATS)): */
+    HNUMPATS = HPATS->n_patterns;
+    HBPP = 0;
+    while (HNUMPATS > (1U << ++HBPP));
+    if (HBPP > 16) {
+        code = jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "HBPP is larger than supported (%u)", HBPP);
+        goto cleanup;
+    }
+
+    /* 6.6.5 point 4. decode gray-scale image as mentioned in annex C */
+    GI = jbig2_decode_gray_scale_image(ctx, segment, data, size,
+                                       params->HMMR, params->HGW, params->HGH, HBPP, params->HENABLESKIP, HSKIP, params->HTEMPLATE, GB_stats);
+    if (!GI) {
+        code = jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "unable to acquire gray-scale image, skipping halftone image");
+        goto cleanup;
+    }
+
+    /* 6.6.5 point 5. place patterns with procedure mentioned in 6.6.5.2 */
+    for (mg = 0; mg < params->HGH; ++mg) {
+        for (ng = 0; ng < params->HGW; ++ng) {
+            int64_t x = ((int64_t) params->HGX + mg * params->HRY + ng * params->HRX) >> 8;
+            int64_t y = ((int64_t) params->HGY + mg * params->HRX - ng * params->HRY) >> 8;
+
+            /* prevent pattern index >= HNUMPATS */
+            gray_val = GI[ng][mg];
+            if (gray_val >= HNUMPATS) {
+                jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "gray-scale index %d out of range, using largest index", gray_val);
+                /* use highest available pattern */
+                gray_val = HNUMPATS - 1;
+            }
+            code = jbig2_image_compose(ctx, image, HPATS->patterns[gray_val], x, y, params->HCOMBOP);
+            if (code < 0) {
+                code = jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to compose pattern with gray-scale image");
+                goto cleanup;
+            }
+        }
+    }
+
+cleanup:
+    if (GI) {
+        for (i = 0; i < params->HGW; ++i) {
+            jbig2_free(ctx->allocator, GI[i]);
+        }
+    }
+    jbig2_free(ctx->allocator, GI);
+    jbig2_image_release(ctx, HSKIP);
+
+    return code;
+}
+
+/**
+ * jbig2_halftone_region: read a halftone region segment header
+ **/
+int
+jbig2_halftone_region(Jbig2Ctx *ctx, Jbig2Segment *segment, const byte *segment_data)
+{
+    int offset = 0;
+    Jbig2RegionSegmentInfo region_info;
+    Jbig2HalftoneRegionParams params;
+    Jbig2Image *image = NULL;
+    Jbig2ArithCx *GB_stats = NULL;
+    int code = 0;
+
+    /* 7.4.5.1 */
+    if (segment->data_length < 17)
+        goto too_short;
+    jbig2_get_region_segment_info(&region_info, segment_data);
+    offset += 17;
+
+    if (segment->data_length < 18)
+        goto too_short;
+
+    /* 7.4.5.1.1 Figure 42 */
+    params.flags = segment_data[offset];
+    params.HMMR = params.flags & 1;
+    params.HTEMPLATE = (params.flags & 6) >> 1;
+    params.HENABLESKIP = (params.flags & 8) >> 3;
+    params.HCOMBOP = (Jbig2ComposeOp)((params.flags & 0x70) >> 4);
+    params.HDEFPIXEL = (params.flags & 0x80) >> 7;
+    offset += 1;
+
+    jbig2_error(ctx, JBIG2_SEVERITY_INFO, segment->number,
+                "halftone region: %u x %u @ (%u, %u), flags = %02x", region_info.width, region_info.height, region_info.x, region_info.y, params.flags);
+
+    if (params.HMMR && params.HTEMPLATE) {
+        jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "HTEMPLATE is %d when HMMR is %d, contrary to spec", params.HTEMPLATE, params.HMMR);
+    }
+    if (params.HMMR && params.HENABLESKIP) {
+        jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "HENABLESKIP is %d when HMMR is %d, contrary to spec", params.HENABLESKIP, params.HMMR);
+    }
+
+    /* 7.4.5.1.2 Figure 43 */
+    if (segment->data_length - offset < 16)
+        goto too_short;
+    params.HGW = jbig2_get_uint32(segment_data + offset);
+    params.HGH = jbig2_get_uint32(segment_data + offset + 4);
+    params.HGX = jbig2_get_int32(segment_data + offset + 8);
+    params.HGY = jbig2_get_int32(segment_data + offset + 12);
+    offset += 16;
+
+    /* 7.4.5.1.3 Figure 44 */
+    if (segment->data_length - offset < 4)
+        goto too_short;
+    params.HRX = jbig2_get_uint16(segment_data + offset);
+    params.HRY = jbig2_get_uint16(segment_data + offset + 2);
+    offset += 4;
+
+    jbig2_error(ctx, JBIG2_SEVERITY_INFO, segment->number,
+                "grid %d x %d @ (%d.%d,%d.%d) vector (%d.%d,%d.%d)",
+                params.HGW, params.HGH,
+                params.HGX >> 8, params.HGX & 0xff,
+                params.HGY >> 8, params.HGY & 0xff,
+                params.HRX >> 8, params.HRX & 0xff,
+                params.HRY >> 8, params.HRY & 0xff);
+
+    /* 7.4.5.2 */
+    if (!params.HMMR) {
+        /* allocate and zero arithmetic coding stats */
+        int stats_size = jbig2_generic_stats_size(ctx, params.HTEMPLATE);
+
+        GB_stats = jbig2_new(ctx, Jbig2ArithCx, stats_size);
+        if (GB_stats == NULL) {
+            return jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "failed to allocate arithmetic decoder states in halftone region");
+        }
+        memset(GB_stats, 0, stats_size);
+    }
+
+    image = jbig2_image_new(ctx, region_info.width, region_info.height);
+    if (image == NULL) {
+        jbig2_free(ctx->allocator, GB_stats);
+        return jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate halftone image");
+    }
+
+    code = jbig2_decode_halftone_region(ctx, segment, &params, segment_data + offset, segment->data_length - offset, image, GB_stats);
+    if (code < 0) {
+        jbig2_image_release(ctx, image);
+        jbig2_free(ctx->allocator, GB_stats);
+        return jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to decode halftone region");
+    }
+
+    /* todo: retain GB_stats? */
+    if (!params.HMMR) {
+        jbig2_free(ctx->allocator, GB_stats);
+    }
+
+    code = jbig2_page_add_result(ctx, &ctx->pages[ctx->current_page], image, region_info.x, region_info.y, region_info.op);
+    if (code < 0) {
+        jbig2_image_release(ctx, image);
+        return jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "unable to add halftone region to page");
+    }
+
+    jbig2_image_release(ctx, image);
+
+    return code;
+
+too_short:
+    return jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "segment too short");
+}