@woosh/meep-engine 3.28.0 → 3.30.0

package/src/format/image/avif/av1/decode/decode_coefficients.js

@@ -1,259 +1,248 @@
-import {
-    BR_CDF_SIZE,
-    COEFF_BASE_RANGE,
-    DCT_DCT,
-    NUM_BASE_LEVELS,
-    SIG_COEF_CONTEXTS,
-    SIG_COEF_CONTEXTS_EOB,
-    TX_16X64,
-    TX_32X32,
-    TX_64X16,
-    TX_CLASS_2D
-} from "../tables/av1_symbols.js";
-import {
-    ADJUSTED_TX_SIZE,
-    TX_HEIGHT,
-    TX_HEIGHT_LOG2,
-    TX_SIZE_SQR,
-    TX_SIZE_SQR_UP,
-    TX_WIDTH,
-    TX_WIDTH_LOG2
-} from "../tables/block_tables.js";
-import {
-    get_all_zero_ctx,
-    get_coeff_base_ctx,
-    get_coeff_br_ctx,
-    get_dc_sign_ctx
-} from "../entropy/coefficient_context.js";
-import { get_scan } from "./get_scan.js";
-import { compute_tx_type, get_tx_class } from "./transform_type.js";
-import { read_transform_type } from "./read_transform_type.js";
-
-/**
- * Decode the coefficients of one transform block.
- *
- * Fills `ctx.quant` with the quantised levels by raster position within the block and returns the
- * end-of-block position, which is zero when the block is empty. Also updates the level and DC-sign
- * contexts that the next block's `all_zero` and `dc_sign` decisions read.
- *
- * @param {Av1FrameContext} ctx
- * @param {number} plane
- * @param {number} start_x left edge of the transform block in plane samples
- * @param {number} start_y top edge of the transform block in plane samples
- * @param {number} tx_size
- * @returns {number} the end-of-block position
- * @see AV1 spec 5.11.39 "Coefficients syntax"
- *
- * @author Alex Goldring
- * @copyright Company Named Limited (c) 2026
- */
-export function decode_coefficients(ctx, plane, start_x, start_y, tx_size) {
-    const reader = ctx.reader;
-    const cdf = ctx.cdf;
-
-    const x4 = start_x >> 2;
-    const y4 = start_y >> 2;
-    const w4 = TX_WIDTH[tx_size] >> 2;
-    const h4 = TX_HEIGHT[tx_size] >> 2;
-
-    const tx_size_ctx = (TX_SIZE_SQR[tx_size] + TX_SIZE_SQR_UP[tx_size] + 1) >> 1;
-    const plane_type = plane > 0 ? 1 : 0;
-
-    const seg_eob = tx_size === TX_16X64 || tx_size === TX_64X16
-        ? 512
-        : Math.min(1024, TX_WIDTH[tx_size] * TX_HEIGHT[tx_size]);
-
-    const quant = ctx.quant;
-
-    quant.fill(0, 0, seg_eob);
-
-    let eob = 0;
-    let cul_level = 0;
-    let dc_category = 0;
-
-    const all_zero_ctx = get_all_zero_ctx(ctx, plane, x4, y4, w4, h4, tx_size);
-
-    const all_zero = reader.read_symbol(cdf.txb_skip, (tx_size_ctx * 13 + all_zero_ctx) * 3, 2);
-
-    if (all_zero === 1) {
-        if (plane === 0) {
-            for (let i = 0; i < w4; i++) {
-                for (let j = 0; j < h4; j++) {
-                    ctx.tx_types[(y4 + j) * ctx.mi_stride + x4 + i] = DCT_DCT;
-                }
-            }
-        }
-    } else {
-        if (plane === 0) {
-            read_transform_type(ctx, x4, y4, tx_size);
-        }
-
-        const tx_type = compute_tx_type(ctx, plane, tx_size, x4, y4);
-
-        ctx.plane_tx_type = tx_type;
-
-        const tx_class = get_tx_class(tx_type);
-        const scan = get_scan(tx_size, tx_type);
-
-        const eob_multisize = Math.min(TX_WIDTH_LOG2[tx_size], 5) + Math.min(TX_HEIGHT_LOG2[tx_size], 5) - 4;
-
-        const eob_class_ctx = tx_class === TX_CLASS_2D ? 0 : 1;
-
-        let eob_pt;
-
-        if (eob_multisize === 0) {
-            eob_pt = reader.read_symbol(cdf.eob_pt_16, ((plane_type * 2) + eob_class_ctx) * 6, 5) + 1;
-        } else if (eob_multisize === 1) {
-            eob_pt = reader.read_symbol(cdf.eob_pt_32, ((plane_type * 2) + eob_class_ctx) * 7, 6) + 1;
-        } else if (eob_multisize === 2) {
-            eob_pt = reader.read_symbol(cdf.eob_pt_64, ((plane_type * 2) + eob_class_ctx) * 8, 7) + 1;
-        } else if (eob_multisize === 3) {
-            eob_pt = reader.read_symbol(cdf.eob_pt_128, ((plane_type * 2) + eob_class_ctx) * 9, 8) + 1;
-        } else if (eob_multisize === 4) {
-            eob_pt = reader.read_symbol(cdf.eob_pt_256, ((plane_type * 2) + eob_class_ctx) * 10, 9) + 1;
-        } else if (eob_multisize === 5) {
-            eob_pt = reader.read_symbol(cdf.eob_pt_512, plane_type * 11, 10) + 1;
-        } else {
-            eob_pt = reader.read_symbol(cdf.eob_pt_1024, plane_type * 12, 11) + 1;
-        }
-
-        eob = eob_pt < 2 ? eob_pt : (1 << (eob_pt - 2)) + 1;
-
-        let eob_shift = Math.max(-1, eob_pt - 3);
-
-        if (eob_shift >= 0) {
-            const extra = reader.read_symbol(
-                cdf.eob_extra,
-                ((tx_size_ctx * 2 + plane_type) * 9 + (eob_pt - 3)) * 3,
-                2
-            );
-
-            if (extra === 1) {
-                eob += 1 << eob_shift;
-            }
-
-            for (let i = 1; i < Math.max(0, eob_pt - 2); i++) {
-                eob_shift = Math.max(0, eob_pt - 2) - 1 - i;
-
-                if (reader.read_bool() === 1) {
-                    eob += 1 << eob_shift;
-                }
-            }
-        }
-
-        const adjusted = ADJUSTED_TX_SIZE[tx_size];
-        const bwl = TX_WIDTH_LOG2[adjusted];
-        const adjusted_width = 1 << bwl;
-        const adjusted_height = TX_HEIGHT[adjusted];
-
-        const br_cdf_size_ctx = Math.min(tx_size_ctx, TX_32X32);
-
-        for (let c = eob - 1; c >= 0; c--) {
-            const pos = scan[c];
-
-            let level;
-
-            if (c === eob - 1) {
-                const eob_ctx = get_coeff_base_ctx(quant, tx_class, bwl, adjusted_width, adjusted_height, pos, c, 1, tx_size)
-                    - SIG_COEF_CONTEXTS + SIG_COEF_CONTEXTS_EOB;
-
-                level = reader.read_symbol(
-                    cdf.coeff_base_eob,
-                    ((tx_size_ctx * 2 + plane_type) * SIG_COEF_CONTEXTS_EOB + eob_ctx) * 4,
-                    3
-                ) + 1;
-            } else {
-                const base_ctx = get_coeff_base_ctx(quant, tx_class, bwl, adjusted_width, adjusted_height, pos, c, 0, tx_size);
-
-                level = reader.read_symbol(
-                    cdf.coeff_base,
-                    ((tx_size_ctx * 2 + plane_type) * SIG_COEF_CONTEXTS + base_ctx) * 5,
-                    4
-                );
-            }
-
-            if (level > NUM_BASE_LEVELS) {
-                const br_ctx = get_coeff_br_ctx(quant, tx_class, bwl, adjusted_width, adjusted_height, pos);
-
-                for (let idx = 0; idx < COEFF_BASE_RANGE / (BR_CDF_SIZE - 1); idx++) {
-                    const coeff_br = reader.read_symbol(
-                        cdf.coeff_br,
-                        ((br_cdf_size_ctx * 2 + plane_type) * 21 + br_ctx) * 5,
-                        4
-                    );
-
-                    level += coeff_br;
-
-                    if (coeff_br < BR_CDF_SIZE - 1) {
-                        break;
-                    }
-                }
-            }
-
-            quant[pos] = level;
-        }
-
-        const dc_sign_ctx = get_dc_sign_ctx(ctx, plane, x4, y4, w4, h4);
-
-        for (let c = 0; c < eob; c++) {
-            const pos = scan[c];
-
-            let sign = 0;
-
-            if (quant[pos] !== 0) {
-                if (c === 0) {
-                    sign = reader.read_symbol(cdf.dc_sign, (plane_type * 3 + dc_sign_ctx) * 3, 2);
-                } else {
-                    sign = reader.read_bool();
-                }
-            }
-
-            if (quant[pos] > NUM_BASE_LEVELS + COEFF_BASE_RANGE) {
-                let length = 0;
-
-                do {
-                    length++;
-                } while (reader.read_bool() === 0);
-
-                let x = 1;
-
-                for (let i = length - 2; i >= 0; i--) {
-                    x = (x << 1) | reader.read_bool();
-                }
-
-                quant[pos] = x + COEFF_BASE_RANGE + NUM_BASE_LEVELS;
-            }
-
-            if (pos === 0 && quant[pos] > 0) {
-                dc_category = sign !== 0 ? 1 : 2;
-            }
-
-            quant[pos] = quant[pos] & 0xfffff;
-
-            cul_level += quant[pos];
-
-            if (sign !== 0) {
-                quant[pos] = -quant[pos];
-            }
-        }
-
-        cul_level = Math.min(63, cul_level);
-    }
-
-    const above_level = ctx.above_level_context[plane];
-    const above_dc = ctx.above_dc_context[plane];
-    const left_level = ctx.left_level_context[plane];
-    const left_dc = ctx.left_dc_context[plane];
-
-    for (let i = 0; i < w4; i++) {
-        above_level[x4 + i] = cul_level;
-        above_dc[x4 + i] = dc_category;
-    }
-
-    for (let i = 0; i < h4; i++) {
-        left_level[y4 + i] = cul_level;
-        left_dc[y4 + i] = dc_category;
-    }
-
-    return eob;
-}
+import {
+    BR_CDF_SIZE,
+    COEFF_BASE_RANGE,
+    DCT_DCT,
+    NUM_BASE_LEVELS,
+    SIG_COEF_CONTEXTS,
+    SIG_COEF_CONTEXTS_EOB,
+    TX_16X64,
+    TX_32X32,
+    TX_64X16,
+    TX_CLASS_2D
+} from "../tables/av1_symbols.js";
+import {
+    ADJUSTED_TX_SIZE,
+    TX_HEIGHT,
+    TX_HEIGHT_LOG2,
+    TX_SIZE_SQR,
+    TX_SIZE_SQR_UP,
+    TX_WIDTH,
+    TX_WIDTH_LOG2
+} from "../tables/block_tables.js";
+import {
+    get_all_zero_ctx,
+    get_coeff_base_ctx,
+    get_coeff_br_ctx,
+    get_dc_sign_ctx
+} from "../entropy/coefficient_context.js";
+import { get_scan } from "./get_scan.js";
+import { compute_tx_type, get_tx_class } from "./transform_type.js";
+import { read_transform_type } from "./read_transform_type.js";
+import { read_golomb } from "./read_golomb.js";
+
+/**
+ * Decode the coefficients of one transform block.
+ *
+ * Fills `ctx.quant` with the quantised levels by raster position within the block and returns the
+ * end-of-block position, which is zero when the block is empty. Also updates the level and DC-sign
+ * contexts that the next block's `all_zero` and `dc_sign` decisions read.
+ *
+ * @param {Av1FrameContext} ctx
+ * @param {number} plane
+ * @param {number} start_x left edge of the transform block in plane samples
+ * @param {number} start_y top edge of the transform block in plane samples
+ * @param {number} tx_size
+ * @returns {number} the end-of-block position
+ * @see AV1 spec 5.11.39 "Coefficients syntax"
+ *
+ * @author Alex Goldring
+ * @copyright Company Named Limited (c) 2026
+ */
+export function decode_coefficients(ctx, plane, start_x, start_y, tx_size) {
+    const reader = ctx.reader;
+    const cdf = ctx.cdf;
+
+    const x4 = start_x >> 2;
+    const y4 = start_y >> 2;
+    const w4 = TX_WIDTH[tx_size] >> 2;
+    const h4 = TX_HEIGHT[tx_size] >> 2;
+
+    const tx_size_ctx = (TX_SIZE_SQR[tx_size] + TX_SIZE_SQR_UP[tx_size] + 1) >> 1;
+    const plane_type = plane > 0 ? 1 : 0;
+
+    const seg_eob = tx_size === TX_16X64 || tx_size === TX_64X16
+        ? 512
+        : Math.min(1024, TX_WIDTH[tx_size] * TX_HEIGHT[tx_size]);
+
+    const quant = ctx.quant;
+
+    quant.fill(0, 0, seg_eob);
+
+    let eob = 0;
+    let cul_level = 0;
+    let dc_category = 0;
+
+    const all_zero_ctx = get_all_zero_ctx(ctx, plane, x4, y4, w4, h4, tx_size);
+
+    const all_zero = reader.read_symbol(cdf.txb_skip, (tx_size_ctx * 13 + all_zero_ctx) * 3, 2);
+
+    if (all_zero === 1) {
+        if (plane === 0) {
+            for (let i = 0; i < w4; i++) {
+                for (let j = 0; j < h4; j++) {
+                    ctx.tx_types[(y4 + j) * ctx.mi_stride + x4 + i] = DCT_DCT;
+                }
+            }
+        }
+    } else {
+        if (plane === 0) {
+            read_transform_type(ctx, x4, y4, tx_size);
+        }
+
+        const tx_type = compute_tx_type(ctx, plane, tx_size, x4, y4);
+
+        ctx.plane_tx_type = tx_type;
+
+        const tx_class = get_tx_class(tx_type);
+        const scan = get_scan(tx_size, tx_type);
+
+        const eob_multisize = Math.min(TX_WIDTH_LOG2[tx_size], 5) + Math.min(TX_HEIGHT_LOG2[tx_size], 5) - 4;
+
+        const eob_class_ctx = tx_class === TX_CLASS_2D ? 0 : 1;
+
+        let eob_pt;
+
+        if (eob_multisize === 0) {
+            eob_pt = reader.read_symbol(cdf.eob_pt_16, ((plane_type * 2) + eob_class_ctx) * 6, 5) + 1;
+        } else if (eob_multisize === 1) {
+            eob_pt = reader.read_symbol(cdf.eob_pt_32, ((plane_type * 2) + eob_class_ctx) * 7, 6) + 1;
+        } else if (eob_multisize === 2) {
+            eob_pt = reader.read_symbol(cdf.eob_pt_64, ((plane_type * 2) + eob_class_ctx) * 8, 7) + 1;
+        } else if (eob_multisize === 3) {
+            eob_pt = reader.read_symbol(cdf.eob_pt_128, ((plane_type * 2) + eob_class_ctx) * 9, 8) + 1;
+        } else if (eob_multisize === 4) {
+            eob_pt = reader.read_symbol(cdf.eob_pt_256, ((plane_type * 2) + eob_class_ctx) * 10, 9) + 1;
+        } else if (eob_multisize === 5) {
+            eob_pt = reader.read_symbol(cdf.eob_pt_512, plane_type * 11, 10) + 1;
+        } else {
+            eob_pt = reader.read_symbol(cdf.eob_pt_1024, plane_type * 12, 11) + 1;
+        }
+
+        eob = eob_pt < 2 ? eob_pt : (1 << (eob_pt - 2)) + 1;
+
+        let eob_shift = Math.max(-1, eob_pt - 3);
+
+        if (eob_shift >= 0) {
+            const extra = reader.read_symbol(
+                cdf.eob_extra,
+                ((tx_size_ctx * 2 + plane_type) * 9 + (eob_pt - 3)) * 3,
+                2
+            );
+
+            if (extra === 1) {
+                eob += 1 << eob_shift;
+            }
+
+            for (let i = 1; i < Math.max(0, eob_pt - 2); i++) {
+                eob_shift = Math.max(0, eob_pt - 2) - 1 - i;
+
+                if (reader.read_bool() === 1) {
+                    eob += 1 << eob_shift;
+                }
+            }
+        }
+
+        const adjusted = ADJUSTED_TX_SIZE[tx_size];
+        const bwl = TX_WIDTH_LOG2[adjusted];
+        const adjusted_width = 1 << bwl;
+        const adjusted_height = TX_HEIGHT[adjusted];
+
+        const br_cdf_size_ctx = Math.min(tx_size_ctx, TX_32X32);
+
+        for (let c = eob - 1; c >= 0; c--) {
+            const pos = scan[c];
+
+            let level;
+
+            if (c === eob - 1) {
+                const eob_ctx = get_coeff_base_ctx(quant, tx_class, bwl, adjusted_width, adjusted_height, pos, c, 1, tx_size)
+                    - SIG_COEF_CONTEXTS + SIG_COEF_CONTEXTS_EOB;
+
+                level = reader.read_symbol(
+                    cdf.coeff_base_eob,
+                    ((tx_size_ctx * 2 + plane_type) * SIG_COEF_CONTEXTS_EOB + eob_ctx) * 4,
+                    3
+                ) + 1;
+            } else {
+                const base_ctx = get_coeff_base_ctx(quant, tx_class, bwl, adjusted_width, adjusted_height, pos, c, 0, tx_size);
+
+                level = reader.read_symbol(
+                    cdf.coeff_base,
+                    ((tx_size_ctx * 2 + plane_type) * SIG_COEF_CONTEXTS + base_ctx) * 5,
+                    4
+                );
+            }
+
+            if (level > NUM_BASE_LEVELS) {
+                const br_ctx = get_coeff_br_ctx(quant, tx_class, bwl, adjusted_width, adjusted_height, pos);
+
+                for (let idx = 0; idx < COEFF_BASE_RANGE / (BR_CDF_SIZE - 1); idx++) {
+                    const coeff_br = reader.read_symbol(
+                        cdf.coeff_br,
+                        ((br_cdf_size_ctx * 2 + plane_type) * 21 + br_ctx) * 5,
+                        4
+                    );
+
+                    level += coeff_br;
+
+                    if (coeff_br < BR_CDF_SIZE - 1) {
+                        break;
+                    }
+                }
+            }
+
+            quant[pos] = level;
+        }
+
+        const dc_sign_ctx = get_dc_sign_ctx(ctx, plane, x4, y4, w4, h4);
+
+        for (let c = 0; c < eob; c++) {
+            const pos = scan[c];
+
+            let sign = 0;
+
+            if (quant[pos] !== 0) {
+                if (c === 0) {
+                    sign = reader.read_symbol(cdf.dc_sign, (plane_type * 3 + dc_sign_ctx) * 3, 2);
+                } else {
+                    sign = reader.read_bool();
+                }
+            }
+
+            if (quant[pos] > NUM_BASE_LEVELS + COEFF_BASE_RANGE) {
+                quant[pos] = read_golomb(reader) + COEFF_BASE_RANGE + NUM_BASE_LEVELS;
+            }
+
+            if (pos === 0 && quant[pos] > 0) {
+                dc_category = sign !== 0 ? 1 : 2;
+            }
+
+            quant[pos] = quant[pos] & 0xfffff;
+
+            cul_level += quant[pos];
+
+            if (sign !== 0) {
+                quant[pos] = -quant[pos];
+            }
+        }
+
+        cul_level = Math.min(63, cul_level);
+    }
+
+    const above_level = ctx.above_level_context[plane];
+    const above_dc = ctx.above_dc_context[plane];
+    const left_level = ctx.left_level_context[plane];
+    const left_dc = ctx.left_dc_context[plane];
+
+    for (let i = 0; i < w4; i++) {
+        above_level[x4 + i] = cul_level;
+        above_dc[x4 + i] = dc_category;
+    }
+
+    for (let i = 0; i < h4; i++) {
+        left_level[y4 + i] = cul_level;
+        left_dc[y4 + i] = dc_category;
+    }
+
+    return eob;
+}

package/src/format/image/avif/av1/decode/read_golomb.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Exp-Golomb escape for coefficient levels above `NUM_BASE_LEVELS + COEFF_BASE_RANGE`: a unary
+ * length prefix, then that many suffix bits.
+ *
+ * The length loop is bounded, and that is the whole point of this function existing. Once a
+ * {@link SymbolReader} runs past the end of its payload, `symbol_max_bits` goes negative, the reader
+ * stops consuming bytes and `read_bits` returns 0, which pins the symbol value to the half of the
+ * interval that `read_bool` decodes as 0 — so an unbounded `do { length++ } while (read_bool() === 0)`
+ * spins forever, with no allocation and no I/O for anything else to notice. A tile cut short by a
+ * partial download or a fuzzer is enough, and this is the entry point for untrusted image data.
+ *
+ * @param {SymbolReader} reader
+ * @returns {number}
+ * @throws {Error} if the length prefix runs past {@link MAX_LENGTH}, which means the stream is corrupt
+ * @see AV1 spec 5.11.39 "Coefficients syntax"
+ *
+ * @author Alex Goldring
+ * @copyright Company Named Limited (c) 2026
+ */
+export function read_golomb(reader: SymbolReader): number;
+//# sourceMappingURL=read_golomb.d.ts.map

package/src/format/image/avif/av1/decode/read_golomb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"read_golomb.d.ts","sourceRoot":"","sources":["../../../../../../../src/format/image/avif/av1/decode/read_golomb.js"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;;;;;;GAkBG;AACH,mDAPa,MAAM,CAyBlB"}

package/src/format/image/avif/av1/decode/read_golomb.js

@@ -0,0 +1,49 @@
+/**
+ * Upper bound on the unary length prefix, matching libaom's `read_golomb`.
+ *
+ * The specification leaves the bound as a conformance requirement on the encoder, which a decoder
+ * reading untrusted bytes cannot assume. libaom caps the same loop at 20 and raises
+ * `AOM_CODEC_CORRUPT_FRAME`; a coefficient level needs nowhere near that many bits, so the cap
+ * rejects only streams that are already malformed.
+ * @type {number}
+ */
+const MAX_LENGTH = 20;
+
+/**
+ * Exp-Golomb escape for coefficient levels above `NUM_BASE_LEVELS + COEFF_BASE_RANGE`: a unary
+ * length prefix, then that many suffix bits.
+ *
+ * The length loop is bounded, and that is the whole point of this function existing. Once a
+ * {@link SymbolReader} runs past the end of its payload, `symbol_max_bits` goes negative, the reader
+ * stops consuming bytes and `read_bits` returns 0, which pins the symbol value to the half of the
+ * interval that `read_bool` decodes as 0 — so an unbounded `do { length++ } while (read_bool() === 0)`
+ * spins forever, with no allocation and no I/O for anything else to notice. A tile cut short by a
+ * partial download or a fuzzer is enough, and this is the entry point for untrusted image data.
+ *
+ * @param {SymbolReader} reader
+ * @returns {number}
+ * @throws {Error} if the length prefix runs past {@link MAX_LENGTH}, which means the stream is corrupt
+ * @see AV1 spec 5.11.39 "Coefficients syntax"
+ *
+ * @author Alex Goldring
+ * @copyright Company Named Limited (c) 2026
+ */
+export function read_golomb(reader) {
+    let length = 0;
+
+    do {
+        length++;
+
+        if (length > MAX_LENGTH) {
+            throw new Error(`golomb length prefix exceeded ${MAX_LENGTH} bits, stream is corrupt`);
+        }
+    } while (reader.read_bool() === 0);
+
+    let x = 1;
+
+    for (let i = length - 2; i >= 0; i--) {
+        x = (x << 1) | reader.read_bool();
+    }
+
+    return x;
+}