@forgeax/engine-codec 0.1.2

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,268 @@
+# @forgeax/engine-codec
+
+> `@forgeax/engine-codec` provides zstd decode/encode, KTX2 container parse,
+> Basis transcode, block-format lookup, and build-time Basis encode --
+> a single package covering the full runtime codec surface for the forgeax
+> asset pipeline.
+
+> [!IMPORTANT]
+> This package uses **subpath-level encode/decode separation** (D-1). The main entry
+(`@forgeax/engine-codec`) exports runtime-safe decode + transcode + block-format
+functions. The `/encode` subpath (`@forgeax/engine-codec/encode`) exports
+build-time encode (zstd + Basis). Runtime code must never import from `/encode` --
+this is enforced by `check-image-pipeline-isolation.mjs` path d (AC-09).
+
+## WASM provisioning
+
+> [!IMPORTANT]
+> In a contributor checkout, `pkg/` is an Emscripten build artifact and is
+> **not committed to git**. It contains the runtime transcoder and build-time
+> encoder bundles, so a fresh checkout must hydrate it before using Basis KTX2
+> paths.
+
+> [!NOTE]
+> A source tree containing `.forgeax-public-distribution` is the public SDK
+> source mode. It already carries the checked `pkg/` closure, so ordinary SDK
+> install/build work must not fetch WASM or require Emscripten. Run `build:wasm`
+> only when the codec WASM source or its toolchain changes.
+
+| Path | Command | Use |
+|:--|:--|:--|
+| Pre-built release | `pnpm -F @forgeax/engine-codec fetch-wasm` | Fast setup without Emscripten |
+| Local build | `pnpm -F @forgeax/engine-codec build:wasm` | Rebuild with the Emscripten toolchain |
+| Opt out | `FORGEAX_SKIP_CODEC_WASM_FETCH=1 pnpm install` | Toolchain owners provisioning separately |
+
+<details>
+<summary>Release selection, fallback, and recovery</summary>
+
+The pre-built bundle is published under the `wasm-artifacts` GitHub Release tag
+as `basis-wasm-pkg-{sha8}.tar.gz`. The content key is the first eight characters
+of `SHA256(fetch-basis.mjs + build-wasm.mjs)`, shared by the consumer and the CI
+publisher. The tarball contains the whole `pkg/` tree:
+
+- `basis_transcoder.mjs` + `basis_transcoder.wasm` for runtime transcode;
+- `encode/basis_encoder.mjs` + `encode/basis_encoder.wasm` for build-time encode.
+
+The shared downloader tries Node `fetch` first, then authenticated `gh` and
+platform-native `curl` (`curl.exe` on Windows) when the Node TLS/network
+handshake fails. All paths remain pinned to the current repository, the
+`wasm-artifacts` tag, and the exact content-keyed asset. Authentication uses
+`GITHUB_TOKEN`/`GH_TOKEN` or `gh auth login`.
+
+`postinstall` uses the same fetch path on a best-effort basis: an unavailable
+release does not fail a bare install, while a later build or typecheck reports
+that `pkg/` still needs provisioning. Use `build:wasm` when no matching release
+exists; it runs `fetch-basis.mjs` and `build-wasm.mjs` and requires `emcc`.
+
+</details>
+
+## API
+
+### Runtime-safe decode (main entry)
+
+| Export | Signature | Description |
+|:--|:--|:--|
+| `decompressZstd` | `(bytes: Uint8Array) => Promise<CodecResult<Uint8Array>>` | Decompress a zstd-compressed byte buffer. Lazy-init singleton (fzstd pure JS, zero WASM); concurrent first calls share the same init promise (AC-12). Returns `CodecOk<Uint8Array>` on success, `CodecError` on failure. |
+| `parseKtx2` | `(bytes: Uint8Array) => Promise<CodecResult<Ktx2Parsed>>` | Parse a KTX2 2.0 container (12B magic validation). Returns header, index, level index, DFD, KV metadata, and SGD descriptor -- all five parts per AC-03. Does **not** interpret block-compressed payload content (OOS-6, Loop 2). Async -- `await` the result. |
+| `ktx2LevelsToRGBA` | `(parsed: Ktx2Parsed, level?: number) => Promise<CodecResult<Uint8Array>>` | Extract RGBA bytes from a parsed KTX2 container. Handles scheme=0 (uncompressed, pass-through) and scheme=2 (zstd supercompression, reuses `decompressZstd` per AC-04). The optional `level` parameter selects a mip level (default: 0). Returns the level's RGBA bytes as a flat `Uint8Array`. |
+| `selectTranscodeTarget` | `(dfdModel: number, srgb: boolean, channels: number, caps: TranscodeCaps) => GPUTextureFormat \| null` | Pure-function priority chain (node-safe, zero DOM): given a DFD color model, srgb flag, channel count, and device caps, returns the best native block format. The chain is LDR RGBA: `ASTC4x4 -> BC7 -> ETC2 -> RGBA8` (with srgb variants); single-channel R: `BC4 -> EAC-R11 -> R8`; two-channel RG: `BC5 -> EAC-RG11 -> RG8`; HDR: `BC6H -> rgba16float`. BC-first rule: when BC and ETC2/ASTC coexist, the chain selects BC (D-4 Mesa guard). Input `TranscodeCaps { bc, etc2, astc }` is a local struct -- codec never imports from rhi. Returns non-null (no-cap fallback to rgba8unorm/rgba16float). |
+| `initBasisTranscoder` | `() => Promise<BasisTranscoderModule>` | Lazy-init singleton (main-thread, D-10). First call dynamic-imports + initializes the basis_transcoder WASM; subsequent calls return the cached instance. |
+| `transcodeKtx2` | `(parsed: Ktx2Parsed, targetFormat: GPUTextureFormat) => Promise<CodecResult<TranscodedMips>>` | Transcode a scheme=1 (BasisLZ) KTX2 payload to a native block format. Iterates every mip level through the transcoder, returning `TranscodedMips { format, mips: { data, width, height }[] }`. Calls init on first use. |
+| `bytesPerRow` | `(width: number, format: GPUTextureFormat) => number` | Block-aligned bytes-per-row: `ceil(width / blockW) * bytesPerBlock`. Returns `width * 4` for non-compressed formats. SSOT with `blockFormatInfo`. |
+| `rowsPerImage` | `(height: number, format: GPUTextureFormat) => number` | Block-aligned rows-per-image: `ceil(height / blockH)`. Returns `height` for non-compressed formats. |
+| `blockFormatInfo` | `(format: GPUTextureFormat) => { blockW: number, blockH: number, bytesPerBlock: number } \| undefined` | Block dimension lookup table covering BC1-BC7, ETC2, ASTC4x4, EAC, BC6H. Returns undefined for non-compressed formats. |
+| `isCompressedFormat` | `(format: GPUTextureFormat) => boolean` | Type guard returning true for all block-compressed formats in `blockFormatInfo`. |
+
+**Priority chain rules** (D-4 BC-first, D-8 local TranscodeCaps):
+
+| Source (channels, color, srgb) | BC cap | ETC2 cap | ASTC cap | Target format |
+|:--|:--|:--|:--|:--|
+| RGBA, LDR, srgb | yes | yes | yes | `bc7-rgba-unorm-srgb` |
+| RGBA, LDR, srgb | no | yes | -- | `etc2-rgba8unorm-srgb` |
+| RGBA, LDR, srgb | no | no | yes | `astc-4x4-unorm-srgb` |
+| RGBA, LDR, srgb | no | no | no | `rgba8unorm-srgb` |
+| R, LDR | yes | -- | -- | `bc4-r-unorm` |
+| R, LDR | no | yes | -- | `eac-r11unorm` |
+| R, LDR | no | no | -- | `r8unorm` |
+| RG, LDR | yes | -- | -- | `bc5-rg-unorm` |
+| RG, LDR | no | yes | -- | `eac-rg11unorm` |
+| RG, LDR | no | no | -- | `rg8unorm` |
+| HDR | yes | -- | -- | `bc6h-rgb-ufloat` |
+| HDR | no | -- | -- | `rgba16float` |
+
+**Scheme support** (extended in Loop 2):
+
+| Scheme | Name | Supported | Path |
+|:--|:--|:--|:--|
+| 0 | None (uncompressed) | yes | `ktx2LevelsToRGBA` pass-through |
+| 1 | BasisLZ | yes | `parseKtx2` -> `transcodeKtx2` |
+| 2 | Zstandard | yes | `ktx2LevelsToRGBA` + `decompressZstd` |
+| 3 | ZLIB / DEFLATE | no | returns `ktx2-unsupported-scheme` |
+
+Usage example:
+
+```ts
+import { decompressZstd, parseKtx2, ktx2LevelsToRGBA, codecError }
+  from '@forgeax/engine-codec';
+
+// Decompress zstd bytes
+const res = await decompressZstd(compressedBytes);
+if (res.ok) {
+  const original = res.value; // Uint8Array
+} else {
+  switch (res.error.code) {
+    case 'decompression-failed':  // res.error.detail: { reason }
+    case 'codec-init-failed':     // res.error.detail: { stage }
+    case 'ktx2-parse-failed':     // res.error.detail: { reason }
+    case 'ktx2-unsupported-scheme': // res.error.detail: { scheme }
+  }
+}
+
+// Parse KTX2 container and extract RGBA
+const k = await parseKtx2(ktx2Bytes);
+if (k.ok) {
+  const rgba = await ktx2LevelsToRGBA(k.value, 0);
+}
+```
+
+### Build-time encode (`/encode` subpath)
+
+| Export | Signature | Description |
+|:--|:--|:--|
+| `compressZstd` | `(bytes: Uint8Array) => Promise<CodecResult<Uint8Array>>` | Compress bytes with zstd (pinned WASM, fixed level, no dictionary, no timestamp -- deterministic per AC-07). Build-time only; gated from runtime import by `check-image-pipeline-isolation.mjs` path d. |
+
+Import path:
+
+```ts
+import { compressZstd } from '@forgeax/engine-codec/encode';
+//                                       ^^^^^^^^^^^^^^^
+//                                       build-time only, blocked from runtime
+```
+
+### Type exports
+
+| Export | Description |
+|:--|:--|
+| `CodecErrorCode` | Closed union: `'decompression-failed' \| 'codec-init-failed' \| 'ktx2-parse-failed' \| 'ktx2-unsupported-scheme' \| 'transcode-failed' \| 'ktx2-encode-failed'` (order-locked, add-only-minor) |
+| `CodecError` | Structured error: `{ ok: false, error: { code, expected, hint, detail } }` with per-code narrowed `detail` |
+| `CodecOk<T>` | Success branch: `{ ok: true, value: T }` |
+| `CodecResult<T>` | Discriminated union: `CodecOk<T> \| CodecError` |
+| `Ktx2Header` | Parsed KTX2 header (9 u32 fields + supercompressionScheme) |
+| `Ktx2Index` | Parsed KTX2 index (dfd/kvd/sgd byte offsets and lengths) |
+| `Ktx2LevelEntry` | Per-level byte offset, byte length, uncompressed byte length |
+| `Ktx2Dfd` / `Ktx2DfdSample` | Parsed DFD (data format descriptor) block |
+| `Ktx2KvEntry` | Key-value metadata entry (key string + raw value bytes) |
+| `Ktx2Parsed` | Fully parsed KTX2 container: `{ header, index, levelIndex, dfd, kvEntries, sgd }` |
+
+## Error codes
+
+All codec errors use the `CodecErrorCode` closed union. Consume with exhaustive
+`switch (err.code)` -- no `default` branch, TypeScript guards completeness.
+
+| Code | Trigger condition | `.hint` (executable recovery) | `.detail` payload |
+|:--|:--|:--|:--|
+| `decompression-failed` | Corrupted/malformed zstd input, or encode failure surfaced as decompression error | "Check catalog row compression field and asset binary consistency; re-run asset import." | `{ reason: string }` -- failure cause |
+| `codec-init-failed` | Dynamic import of fzstd decode module failed (network / bundling) | "Uncompressed assets are still loadable. Verify the codec module is installed correctly." | `{ stage: string }` -- failed initialization stage |
+| `ktx2-parse-failed` | KTX2 magic mismatch, header truncation, level index out of bounds (E5) | "Check that the KTX2 file is valid and not truncated. Re-import the texture asset." | `{ reason: string }` -- parse failure location |
+| `ktx2-unsupported-scheme` | KTX2 supercompression scheme is ZLIB (=3) or other unsupported scheme. Scheme 1 (BasisLZ) and 2 (Zstd) are accepted. | "This supercompression scheme requires a future codec upgrade. Check the codec README Loop 2 extension points." | `{ scheme: number }` -- the unsupported scheme value |
+| `transcode-failed` | Basis transcoder returned 0 bytes or threw an error during transcode. The payload may be corrupt or the target format incompatible with the DFD model. | "Verify the KTX2/Basis asset payload is valid. Check that selectTranscodeTarget returned a compatible format." | `{ sourceFormat: GPUTextureFormat, targetFormat: GPUTextureFormat }` -- the source + requested target |
+| `ktx2-encode-failed` | Basis encoder returned 0 bytes or threw. May indicate invalid dimensions, incompatible pixel format, or encoder-side memory exhaustion. | "Check input texture dimensions and pixel format. Verify the Basis encoder WASM was built correctly (pnpm --filter @forgeax/engine-codec build:wasm)." | `{ mode: string, reason: string }` -- the encode mode + failure reason |
+
+### Error propagation
+
+Codec errors are consumed in two contexts:
+
+1. **Direct consumption** -- AI users calling `decompressZstd` / `parseKtx2` directly
+   get the full `CodecError` with per-code narrowed `detail`.
+
+2. **Runtime transparent pass-through** -- in the runtime's `fetchBinary` gate,
+   codec errors are nested in the existing `asset-fetch-failed` error's `.detail`
+   field. The types-shared `ErrorCode` union is NOT extended (D-8). AI users
+   doing a typed `AssetRegistry.load(guid, kind)` never see `CodecErrorCode` directly; they see the standard
+   asset error surface.
+
+## Loop 2 extension points
+
+> [!NOTE]
+> This section documents the 3 frozen contract seams that Loop 2
+> ("texture block-compression") consumes without re-designing (AC-13).
+> Do not delete or rearrange these sections -- they are the hand-off interface.
+
+### Contract seam 1: `compression` sidecar field
+
+The `AssetCompression` union (`packages/types/src/index.ts`) currently has:
+
+```ts
+type AssetCompression = 'none' | 'zstd';
+```
+
+**Loop 2 extension**: May add combination literal members such as `'zstd+bc7'`,
+`'zstd+astc'`, or `'basis-uastc'` to represent block-compressed payloads wrapped
+in zstd supercompression. The field is consumed in `PackIndexEntry.compression?`,
+`ImageMetadata.compression?`, `LoaderEntry.compression?`, `listCatalog()` return
+rows, and `importSettings`. Loop 2 adds members here; runtime `fetchBinary`
+gate branches on the string value.
+
+### Contract seam 2: runtime single decompression gate
+
+The runtime decompression happens in exactly one place:
+`fetchBinary(url, { compression })` in `asset-registry.ts`. The gate currently
+branches on `compression === 'zstd'` to call `decompressZstd`. Raw bytes are
+returned to loaders unchanged in all other cases.
+
+**Loop 2 extension**: After zstd decompression returns raw bytes, Loop 2 adds a
+second gate for block-compressed payloads: `basis_transcoder.wasm` transcode from
+the universal intermediate format to the platform's native block format.
+The transcoder hangs **after** the zstd gate -- same `fetchBinary` entry point,
+no second decompression point (contract seam 2 constraint).
+
+### Contract seam 3: KTX2 container parser
+
+`parseKtx2(bytes)` returns `Ktx2Parsed` with `header.supercompressionScheme`,
+`levelIndex` (per-level `byteOffset` / `byteLength` / `uncompressedByteLength`),
+`dfd.colorModel`, and `sgd`. `ktx2LevelsToRGBA` handles scheme=0 (uncompressed)
+and scheme=2 (zstd) only.
+
+**Loop 2 extension**: For scheme=1 (BasisLZ), `parseKtx2` already provides:
+- `levelIndex[].byteOffset` and `levelIndex[].byteLength` -- the block payload
+  bytes to feed into `basis_transcoder.wasm`
+- `dfd.colorModel` and `dfd.colorPrimaries` -- color space metadata for upload
+- `sgd` (supercompression global data) -- the BasisLZ codebook
+
+Loop 2 adds a third arm to `ktx2LevelsToRGBA` for scheme=1 that calls the
+transcoder instead of `decompressZstd`. The container parser itself does NOT
+change -- Loop 2 reuses the same `parseKtx2` export (contract seam 3 constraint).
+
+### Compression ratio baseline (AC-05)
+
+zstd compression on representative mesh `.bin` data achieves approximately 30-60%
+size reduction (f32 vertex data). The AC-05 assertion floor is `>= 30%` on the
+compression ratio (compressed / original <= 0.70). Loop 2 may establish separate
+ratios for block-compressed textures.
+
+## Package metrics (AC-11)
+
+The codec package declares all 5 `MetricKind` entries in
+`package.json#forgeax.metrics`:
+
+| Metric | Status | Reason |
+|:--|:--|:--|
+| `bundle-size` | enabled | Measures decode entry dist bundle (`dist/index.mjs` gzip). fzstd is pure JS (no WASM), so this captures the full decode cost. |
+| `fps` | disabled | Pure-function library, no render-loop impact |
+| `bench` | disabled | No performance-sensitive hot paths to benchmark in isolation |
+| `gate` | disabled | No codec-specific gates beyond metric declaration itself |
+| `spike-report` | disabled | No spiking concerns for a deterministic pure-function library |
+
+## Build-time encode subpath
+
+The `/encode` subpath (`@forgeax/engine-codec/encode`) exports `compressZstd`
+for build-time use only. It is consumed by `vite-plugin-pack`'s
+`compress-artifact.ts` SSOT function. Runtime code must never import from this
+subpath -- enforced by `check-image-pipeline-isolation.mjs` path d (AC-09).
+
+## Related documentation
+
+- `packages/runtime/README.md` -- `fetchBinary` automatic decompression gate
+- `packages/pack/README.md` -- `compression` field in pack-index row schema
+- `skills/forgeax-engine-assets/SKILL.md` -- AI user-facing asset pipeline
+- `docs/superpowers/specs/2026-07-06-asset-compression-pipeline-roadmap-design.md` -- two-loop roadmap