@blockcast/mmt-wasm 0.3.0 → 0.4.0-main.2654dbc2ed6d

package/pkg-no-modules/mmt_wasm.js

@@ -529,6 +529,25 @@ let wasm_bindgen;
         set blocks_delivery_failed(arg0) {
             wasm.__wbg_set_fecstats_blocks_delivery_failed(this.__wbg_ptr, arg0);
         }
+        /**
+         * `iso-ssbg1-v1` held sources evicted, oldest arrival first, because the
+         * unplaced pool was at its `(interleave_depth + 1) * K` cap: no sweep
+         * (`cleanup_by_ss_start` / `retire_unplaced`) retired them first.
+         * @returns {bigint}
+         */
+        get unplaced_evicted() {
+            const ret = wasm.__wbg_get_fecstats_unplaced_evicted(this.__wbg_ptr);
+            return BigInt.asUintN(64, ret);
+        }
+        /**
+         * `iso-ssbg1-v1` held sources evicted, oldest arrival first, because the
+         * unplaced pool was at its `(interleave_depth + 1) * K` cap: no sweep
+         * (`cleanup_by_ss_start` / `retire_unplaced`) retired them first.
+         * @param {bigint} arg0
+         */
+        set unplaced_evicted(arg0) {
+            wasm.__wbg_set_fecstats_unplaced_evicted(this.__wbg_ptr, arg0);
+        }
         /**
          * Recovery rate as percentage (0-100)
          * Counts all blocks: complete + recovered + FEC-failed + delivery-failed
@@ -672,27 +691,15 @@ let wasm_bindgen;
         /**
          * Add a repair symbol per ISO 23008-1 §C.5.3.
          *
-         * Repair carries (SS_Start, SSB_length, RS_ID).
-         * SS_Start = SS_ID of first source in block = SBN * K.
-         * SSB_length = the authored source-symbol count in this block (1..=K).
-         * SBN = SS_Start / configured K.
-         * Repair ESI = K + RS_ID.
-         *
-         * The decoder's configured K is the fixed RaptorQ geometry. A short
-         * authored block (`SSB_length < K`) is the producer's K-symbol RaptorQ
-         * block with ESIs `SSB_length..K` zero-filled and never transmitted
-         * (fec-raptorq `InterleavedEncoder::force_complete`). The block records
-         * `SSB_length`, completes once that many source symbols arrived, and
-         * recovers from `SSB_length` received symbols by supplying the known
-         * padding itself. A conflicting `SSB_length` for one block is rejected
-         * without changing that block.
-         *
-         * Under `iso-ssbg1-v1` the block is `[SS_Start, SS_Start + SSB_length)`
-         * with `1 <= SSB_length <= K` (K is only the maximum), its RaptorQ geometry
-         * is K' = SSB_length with no padding, and repair ESI = SSB_length + RS_ID
-         * (C.5.3). The first repair defines the block and claims every held source
-         * in range. A conflicting SSB_length, or a range overlapping a different
-         * known block, is refused without changing any block. Output is the K'*T
+         * Repair carries (SS_Start, SSB_length, RS_ID). The block is
+         * `[SS_Start, SS_Start + SSB_length)` with `1 <= SSB_length <= K` (the
+         * configured K is only the maximum), its RaptorQ geometry is
+         * K' = SSB_length with no padding, and repair ESI = SSB_length + RS_ID.
+         * The first repair defines the block and claims every held source in
+         * range. A conflicting SSB_length, a range overlapping a different known
+         * block, or a start more than `interleave_depth` blocks behind the last
+         * `cleanup_by_ss_start`'s `current` (`iso_blocks_behind_lower_bound`), is
+         * refused without changing any block. Output is the K'*T
          * concatenated ssbg_mode1 symbols: split by T and trim by the length field.
          * @param {number} ss_start
          * @param {number} ssb_length
@@ -721,13 +728,12 @@ let wasm_bindgen;
          * SS_ID is a flat 32-bit counter. An unconfigured decoder rejects the
          * packet.
          *
-         * - `k-padded-v1`: derives SBN = floor(SS_ID / K), ESI = SS_ID % K and
-         *   zero-pads `data` to T.
-         * - `iso-ssbg1-v1`: builds the C.3.3 ssbg_mode1 symbol
-         *   `u16be(len) || data || zero padding` (refusing `len + 2 > T`) and
-         *   places it at ESI = serial distance from the start of the known block
-         *   whose `[SS_Start, SS_Start + SSB_length)` contains SS_ID. A source
-         *   whose block no repair has defined yet is held by SS_ID until one does.
+         * Builds the C.3.3 ssbg_mode1 symbol `u16be(len) || data || zero padding`
+         * (refusing `len + 2 > T`) and places it at ESI = serial distance from the
+         * start of the known block whose `[SS_Start, SS_Start + SSB_length)`
+         * contains SS_ID. A source whose block no repair has defined yet is held
+         * by SS_ID until one does; at most `(interleave_depth + 1) * K` are held, and
+         * the oldest arrival is evicted first (`FecStats::unplaced_evicted`).
          *
          * # Arguments
          * * `ss_id` - Source symbol ID (32-bit monotonic counter)
@@ -769,28 +775,6 @@ let wasm_bindgen;
             }
             return ret[0];
         }
-        /**
-         * `k-padded-v1` only: cleanup blocks more than `interleave_depth` blocks
-         * behind `current_sbn`. Refused under `iso-ssbg1-v1`, which has no SBN
-         * (use `cleanup_by_ss_start`).
-         *
-         * Blocks are ordered by RFC 1982 serial comparison of their first SS_ID
-         * (`sbn * K mod 2^32`, ISO/IEC 23008-1 C.5.2; BLO-35597 iso:5). For a
-         * stream that has not wrapped SS_ID that is exactly the old
-         * `sbn < current_sbn - interleave_depth`; after the wrap it still retires
-         * the pre-wrap blocks instead of keeping them forever.
-         * @param {number} current_sbn
-         * @returns {Uint32Array}
-         */
-        cleanup_by_sbn(current_sbn) {
-            const ret = wasm.mmtfecdecoder_cleanup_by_sbn(this.__wbg_ptr, current_sbn);
-            if (ret[3]) {
-                throw takeFromExternrefTable0(ret[2]);
-            }
-            var v1 = getArrayU32FromWasm0(ret[0], ret[1]).slice();
-            wasm.__wbindgen_free(ret[0], ret[1] * 4, 4);
-            return v1;
-        }
         /**
          * Get sub-blocks (N) parameter from OTI
          * @returns {number}
@@ -822,11 +806,11 @@ let wasm_bindgen;
             return ret[0];
         }
         /**
-         * `iso-ssbg1-v1` only: retire the held source symbols that no repair can
-         * place any more, by the same rule as `cleanup_by_ss_start`, without
-         * retiring any block. For a caller that retires blocks itself, by their
-         * deadlines (`cleanup_blocks_detailed`), and needs only this half. Returns
-         * how many it retired.
+         * Retire the held source symbols that no repair can place any more, by
+         * the same rule as `cleanup_by_ss_start`, without retiring any block. For
+         * a caller that retires blocks itself, by their deadlines
+         * (`cleanup_blocks_detailed`), and needs only this half. Returns how many
+         * it retired.
          * @param {number} current
          * @returns {number}
          */
@@ -880,11 +864,11 @@ let wasm_bindgen;
             return ret[0];
         }
         /**
-         * `iso-ssbg1-v1` only: retire every block, and every held source symbol,
-         * lying more than `interleave_depth` blocks behind SS_ID `current`, the
-         * newest SS_ID the caller has seen (no block start or held source follows
-         * it). A block start or held source that `current` has moved at least
-         * half the SS_ID space past no longer precedes it and is retired too
+         * Retire every block, and every held source symbol, lying more than
+         * `interleave_depth` blocks behind SS_ID `current`, the newest SS_ID the
+         * caller has seen (no block start or held source follows it). A block
+         * start or held source that `current` has moved at least half the SS_ID
+         * space past no longer precedes it and is retired too
          * (`iso_past_horizon`).
          *
          * Blocks have no SBN under ssbg_mode1, so distance is measured on the
@@ -914,16 +898,16 @@ let wasm_bindgen;
             return ret >>> 0;
         }
         /**
-         * Finalize only the source blocks whose host-owned deadlines fired.
-         * Keys are SBNs under `k-padded-v1` and SS_Starts under `iso-ssbg1-v1`.
+         * Finalize only the source blocks whose host-owned deadlines fired,
+         * named by their SS_Starts.
          *
          * The JavaScript FEC manager owns per-block repair grace. A timeout for one
          * block must therefore not run the decoder's global age scan and evict a
          * peer block that is still waiting for fetched repair.
-         * @param {Uint32Array} sbns
+         * @param {Uint32Array} ss_starts
          */
-        cleanup_blocks_detailed(sbns) {
-            const ptr0 = passArray32ToWasm0(sbns, wasm.__wbindgen_malloc);
+        cleanup_blocks_detailed(ss_starts) {
+            const ptr0 = passArray32ToWasm0(ss_starts, wasm.__wbindgen_malloc);
             const len0 = WASM_VECTOR_LEN;
             wasm.mmtfecdecoder_cleanup_blocks_detailed(this.__wbg_ptr, ptr0, len0);
         }
@@ -932,8 +916,8 @@ let wasm_bindgen;
          *
          * # Arguments
          * * `interleave_depth` - Explicit positive number of interleaved blocks.
-         * * `block_profile` - Catalog `fec.blockProfile`: `"k-padded-v1"` or
-         *   `"iso-ssbg1-v1"`. Required; any other value is refused.
+         * * `block_profile` - Catalog `fec.blockProfile`: `"iso-ssbg1-v1"`.
+         *   Required; any other value is refused.
          * @param {number} interleave_depth
          * @param {string} block_profile
          */
@@ -969,7 +953,8 @@ let wasm_bindgen;
          * Configure FEC from 12-byte OTI
          *
          * # Arguments
-         * * `oti` - 12-byte Object Transmission Information from S-TSID fecOTI
+         * * `oti` - 12-byte RFC 6330 Common FEC OTI: decoder geometry per
+         *   draft-fec-01 Section 4.2 (Z = 1, N = 1, Al = 8)
          * @param {Uint8Array} oti
          */
         configure(oti) {
@@ -1014,21 +999,16 @@ let wasm_bindgen;
      * [SS_Start:4][RSB_length:3][RS_ID:3][SSB_length:3][repair symbol: T]
      * ```
      *
-     * with, for a block with Source Block Number `sbn` and `K` source symbols:
-     * - `SS_Start  = sbn * K` (32-bit) — first SS_ID of the block. The decoder
-     *   derives `SBN = SS_Start / K`, so this MUST be `sbn * K`.
+     * with, for an `iso-ssbg1-v1` block of K' ssbg_mode1 source symbols
+     * (ISO/IEC 23008-1 C.3.3, C.5.2, C.5.3):
+     * - `SS_Start  = ` the block's first SS_ID (SS_IDs are consecutive, 32-bit)
      * - `RSB_length = P`       (repair count for this block)
-     * - `RS_ID      = i`       (0-based repair index) ⇒ RaptorQ ESI = `K + i`
-     * - `SSB_length <= K`      (authored source symbols in this block)
-     *
-     * OTI (Z=1, N=1, Al=8) is delivered out-of-band via the catalog / AL-FEC
-     * signaling message — see [`MmtFecEncoder::oti`] — never per-packet.
+     * - `RS_ID      = i`       (0-based repair index) ⇒ RaptorQ ESI = `K' + i`
+     * - `SSB_length = K'`      (`1..=K`; the configured K is only the maximum)
      *
-     * That framing is the `k-padded-v1` profile. Under `iso-ssbg1-v1` the same
-     * fields carry ISO/IEC 23008-1 C.5.3 semantics: `SS_Start` is the first SS_ID
-     * of a block of consecutive SS_IDs, `SSB_length = K'` (`1..=K`), the RaptorQ
-     * block is K' symbols with no padding (F = K'*T), and RS_ID `i` is ESI
-     * `K' + i`.
+     * The RaptorQ block is K' symbols with no padding (F = K'*T). The configured
+     * OTI (F = K*T, Z=1, N=1, Al=8) is delivered out-of-band via the catalog /
+     * AL-FEC signaling message — see [`MmtFecEncoder::oti`] — never per-packet.
      */
     class MmtFecEncoder {
         __destroy_into_raw() {
@@ -1073,29 +1053,24 @@ let wasm_bindgen;
          * `[SS_Start:4][RSB_length:3][RS_ID:3][SSB_length:3][symbol: T]`.
          * Callers split on that stride; `entry i` is at `i * (13 + T)`.
          *
-         * `k-padded-v1`: `block` is the Source Block Number and `source_block`
-         * MUST be exactly `K * symbol_size` bytes — the caller pads the final
-         * (short) block with zeros, mirroring `InterleavedEncoder` and the FFmpeg
-         * path. `SS_Start = block * K` (wrapping), `SSB_length = K`.
-         *
-         * `iso-ssbg1-v1`: `block` is the SS_Start (the block's first SS_ID) and
-         * `source_block` is the block's K' ssbg_mode1 symbols (`1 <= K' <= K`,
-         * `len % T == 0`, each a well-formed C.3.3 symbol). RaptorQ runs over K'
-         * symbols (F = K'*T) and `SSB_length = K'`.
+         * `ss_start` is the block's first SS_ID and `source_block` is the
+         * block's K' ssbg_mode1 symbols (`1 <= K' <= K`, `len % T == 0`, each a
+         * well-formed C.3.3 symbol). RaptorQ runs over K' symbols (F = K'*T) and
+         * `SSB_length = K'`.
          *
          * # Arguments
-         * * `block`        - SBN (`k-padded-v1`) or SS_Start (`iso-ssbg1-v1`).
+         * * `ss_start`     - SS_Start: the block's first SS_ID.
          * * `source_block` - The block's source symbols, as described above.
          * * `repair_count` - Number of repair symbols (P) to generate.
-         * @param {number} block
+         * @param {number} ss_start
          * @param {Uint8Array} source_block
          * @param {number} repair_count
          * @returns {Uint8Array}
          */
-        encode_repair(block, source_block, repair_count) {
+        encode_repair(ss_start, source_block, repair_count) {
             const ptr0 = passArray8ToWasm0(source_block, wasm.__wbindgen_malloc);
             const len0 = WASM_VECTOR_LEN;
-            const ret = wasm.mmtfecencoder_encode_repair(this.__wbg_ptr, block, ptr0, len0, repair_count);
+            const ret = wasm.mmtfecencoder_encode_repair(this.__wbg_ptr, ss_start, ptr0, len0, repair_count);
             if (ret[3]) {
                 throw takeFromExternrefTable0(ret[2]);
             }
@@ -1115,13 +1090,13 @@ let wasm_bindgen;
          * Create an encoder for a fixed `(K, symbol_size)` block geometry.
          *
          * Builds the OTI as `ObjectTransmissionInformation::new(K*T, T, 1, 1, 8)`
-         * (single source block, single sub-block, byte alignment) — matching the
-         * decoder's recovery model in [`FecBlock::try_decode`] — and pre-computes
-         * the shared `SourceBlockEncodingPlan` so per-block encoding is cheap.
+         * (single source block, single sub-block, byte alignment) — the geometry
+         * [`MmtFecDecoder::configure`] reads back. K is the maximum SSB_length;
+         * each block is encoded over its own K' symbols (see
+         * [`MmtFecEncoder::encode_repair`]).
          *
-         * `block_profile` is the catalog `fec.blockProfile` (`"k-padded-v1"` or
-         * `"iso-ssbg1-v1"`); any other value is refused. Under `iso-ssbg1-v1`, K
-         * is the maximum SSB_length.
+         * `block_profile` is the catalog `fec.blockProfile` (`"iso-ssbg1-v1"`);
+         * any other value is refused.
          * @param {number} k
          * @param {number} symbol_size
          * @param {string} block_profile
@@ -2300,14 +2275,14 @@ let wasm_bindgen;
          * @returns {bigint}
          */
         get ambiguous_fallback_fragments() {
-            const ret = wasm.__wbg_get_reassemblerstatsjs_ambiguous_fallback_fragments(this.__wbg_ptr);
+            const ret = wasm.__wbg_get_fecstats_unplaced_evicted(this.__wbg_ptr);
             return BigInt.asUintN(64, ret);
         }
         /**
          * @param {bigint} arg0
          */
         set ambiguous_fallback_fragments(arg0) {
-            wasm.__wbg_set_reassemblerstatsjs_ambiguous_fallback_fragments(this.__wbg_ptr, arg0);
+            wasm.__wbg_set_fecstats_unplaced_evicted(this.__wbg_ptr, arg0);
         }
     }
     if (Symbol.dispose) ReassemblerStatsJs.prototype[Symbol.dispose] = ReassemblerStatsJs.prototype.free;
@@ -2353,7 +2328,7 @@ let wasm_bindgen;
          * @returns {number}
          */
         get fec_set_index() {
-            const ret = wasm.recoveredset_fec_set_index(this.__wbg_ptr);
+            const ret = wasm.mmtfecencoder_k(this.__wbg_ptr);
             return ret >>> 0;
         }
         /**

package/pkg-no-modules/mmt_wasm_bg.wasm.d.ts

@@ -10,7 +10,7 @@ export const __wbg_get_fecstats_blocks_recovered: (a: number) => bigint;
 export const __wbg_get_fecstats_bytes_recovered: (a: number) => bigint;
 export const __wbg_get_fecstats_repair_packets: (a: number) => bigint;
 export const __wbg_get_fecstats_source_packets: (a: number) => bigint;
-export const __wbg_get_reassemblerstatsjs_ambiguous_fallback_fragments: (a: number) => bigint;
+export const __wbg_get_fecstats_unplaced_evicted: (a: number) => bigint;
 export const __wbg_mfufragmentjs_free: (a: number, b: number) => void;
 export const __wbg_mmtfecdecoder_free: (a: number, b: number) => void;
 export const __wbg_mmtfecencoder_free: (a: number, b: number) => void;
@@ -23,7 +23,6 @@ export const __wbg_moqfecdecoder_free: (a: number, b: number) => void;
 export const __wbg_moqfecencoder_free: (a: number, b: number) => void;
 export const __wbg_moqfecstatsjs_free: (a: number, b: number) => void;
 export const __wbg_reassembledmfujs_free: (a: number, b: number) => void;
-export const __wbg_reassemblerstatsjs_free: (a: number, b: number) => void;
 export const __wbg_recoveredset_free: (a: number, b: number) => void;
 export const __wbg_samplecombinerstatsjs_free: (a: number, b: number) => void;
 export const __wbg_set_fecstats_blocks_complete: (a: number, b: bigint) => void;
@@ -33,7 +32,7 @@ export const __wbg_set_fecstats_blocks_recovered: (a: number, b: bigint) => void
 export const __wbg_set_fecstats_bytes_recovered: (a: number, b: bigint) => void;
 export const __wbg_set_fecstats_repair_packets: (a: number, b: bigint) => void;
 export const __wbg_set_fecstats_source_packets: (a: number, b: bigint) => void;
-export const __wbg_set_reassemblerstatsjs_ambiguous_fallback_fragments: (a: number, b: bigint) => void;
+export const __wbg_set_fecstats_unplaced_evicted: (a: number, b: bigint) => void;
 export const __wbg_shredfecbuffer_free: (a: number, b: number) => void;
 export const __wbg_shredreassembler_free: (a: number, b: number) => void;
 export const annexb_access_unit_is_keyframe: (a: number, b: number, c: number, d: number) => [number, number, number];
@@ -64,7 +63,6 @@ export const mfufragmentjs_with_sample_identity: (a: number, b: number, c: numbe
 export const mmtfecdecoder_add_repair: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number, number];
 export const mmtfecdecoder_add_source: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
 export const mmtfecdecoder_cleanup_blocks_detailed: (a: number, b: number, c: number) => void;
-export const mmtfecdecoder_cleanup_by_sbn: (a: number, b: number) => [number, number, number, number];
 export const mmtfecdecoder_cleanup_by_ss_start: (a: number, b: number) => [number, number, number, number];
 export const mmtfecdecoder_configure: (a: number, b: number, c: number) => [number, number];
 export const mmtfecdecoder_configure_params: (a: number, b: number, c: number) => [number, number];
@@ -159,7 +157,6 @@ export const reassembledmfujs_repaired_packet_sequence_numbers: (a: number) => [
 export const reassembledmfujs_sample_number: (a: number) => number;
 export const reassembledmfujs_stream_identity: (a: number) => number;
 export const reassembledmfujs_timestamp: (a: number) => number;
-export const recoveredset_fec_set_index: (a: number) => number;
 export const recoveredset_payload: (a: number) => [number, number];
 export const recoveredset_slot: (a: number) => bigint;
 export const shredfecbuffer_add_shred: (a: number, b: bigint, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => [number, number];
@@ -176,7 +173,9 @@ export const moqencodedblock_p: (a: number) => number;
 export const moqfecstatsjs_blocksComplete: (a: number) => number;
 export const moqfecstatsjs_blocksIncomplete: (a: number) => number;
 export const moqfecstatsjs_totalSymbolsReceived: (a: number) => number;
+export const recoveredset_fec_set_index: (a: number) => number;
 export const shredreassembler_pending_fec_sets: (a: number) => number;
+export const __wbg_get_reassemblerstatsjs_ambiguous_fallback_fragments: (a: number) => bigint;
 export const __wbg_get_reassemblerstatsjs_duplicate_fragments: (a: number) => bigint;
 export const __wbg_get_reassemblerstatsjs_evicted_data_units: (a: number) => bigint;
 export const __wbg_get_reassemblerstatsjs_evicted_memory_limit: (a: number) => bigint;
@@ -188,6 +187,8 @@ export const __wbg_get_samplecombinerstatsjs_combined_samples: (a: number) => bi
 export const __wbg_get_samplecombinerstatsjs_evicted_samples: (a: number) => bigint;
 export const __wbg_get_samplecombinerstatsjs_passthrough_samples: (a: number) => bigint;
 export const __wbg_get_samplecombinerstatsjs_timed_out_samples: (a: number) => bigint;
+export const __wbg_reassemblerstatsjs_free: (a: number, b: number) => void;
+export const __wbg_set_reassemblerstatsjs_ambiguous_fallback_fragments: (a: number, b: bigint) => void;
 export const __wbg_set_reassemblerstatsjs_duplicate_fragments: (a: number, b: bigint) => void;
 export const __wbg_set_reassemblerstatsjs_evicted_data_units: (a: number, b: bigint) => void;
 export const __wbg_set_reassemblerstatsjs_evicted_memory_limit: (a: number, b: bigint) => void;