@drawcall/lod 0.1.2 → 0.3.0

package/dist/impostor/ktx2/transcode.js

@@ -0,0 +1,99 @@
+import { inflateSync } from "fflate";
+import { KTX2Loader } from "three/addons/loaders/KTX2Loader.js";
+import { LoadingManager } from "three/webgpu";
+/** The page's one KTX2Loader for impostor layers: process-wide, as its transcoder workers are, and freed when idle. */
+let shared;
+/** Transcodes not yet answered, and the timer that disposes the loader once none has been for IDLE_MS. */
+let active = 0;
+let idle;
+/** How long the loader outlives its last transcode. Its workers and their transcoders are freed then, so
+ *  another library's KTX2Loader (each has one) is the page's only one but while both transcode. */
+const IDLE_MS = 1000;
+/**
+ * One KTX2Loader for every impostor at a time, as three asks: made at the first transcode, disposed once idle.
+ * It transcodes to the formats the GPU adapter takes, which are those
+ * of any WebGPURenderer device on it: three's WebGPURenderer requests every feature the adapter has, unless it is given
+ * a `device`, which then needs the same texture-compression features. Without WebGPU it transcodes to RGBA. The loader would fetch the Basis transcoder from three's `libs/basis` folder; it reads the copy
+ * this package carries instead (see scripts/basis.ts).
+ */
+function loader() {
+    shared ??= (async () => {
+        const [has, files] = await Promise.all([adapterFeatures(), carriedFiles()]);
+        const manager = new LoadingManager().setURLModifier((url) => files.get(url) ?? url);
+        // given no path, the loader reads files next to its own module, which a build emits under hashed names
+        const loader = new KTX2Loader(manager).setTranscoderPath(BASIS);
+        // What detectSupport finds on a WebGPURenderer; WebGPU has no ETC1, S3TC or PVRTC features.
+        loader.workerConfig = {
+            astcSupported: has("texture-compression-astc"),
+            astcHDRSupported: false,
+            etc1Supported: false,
+            etc2Supported: has("texture-compression-etc2"),
+            dxtSupported: false,
+            bptcSupported: has("texture-compression-bc"),
+            pvrtcSupported: false,
+        };
+        return loader;
+    })();
+    return shared;
+}
+/** A map's KTX2 file as the blocks of a GPU format, transcoded in three's workers. */
+export async function transcode(file) {
+    const texture = await parse(file);
+    const mipmaps = texture.mipmaps.map(({ data }) => {
+        if (!(data instanceof Uint8Array))
+            throw new Error(`transcoded to ${data.constructor.name}, not bytes`);
+        return data;
+    });
+    return { format: texture.format, mipmaps };
+}
+async function parse(file) {
+    clearTimeout(idle);
+    active++;
+    try {
+        const ktx2 = await loader();
+        // The loader hands its buffer to a worker.
+        return await new Promise((resolve, reject) => ktx2.parse(file.slice().buffer, resolve, reject));
+    }
+    finally {
+        if (--active === 0) {
+            idle = setTimeout(release, IDLE_MS);
+            // Releasing frees memory; it must not keep Node.js running once nothing else does.
+            const timer = idle;
+            if (typeof timer === "object" && timer !== null && "unref" in timer && typeof timer.unref === "function")
+                timer.unref();
+        }
+    }
+}
+function release() {
+    const released = shared;
+    shared = undefined;
+    void released?.then((loader) => loader.dispose());
+}
+/** The bundled transcoder's files, inflated once: immutable, and shared by every loader made after. */
+let carried;
+/** The carried transcoder's files by the URLs the loader asks for: made once, for every loader made after. */
+function carriedFiles() {
+    carried ??= import("./wasm/transcoder.js").then(({ TRANSCODER_JS, TRANSCODER_WASM }) => new Map([
+        [`${BASIS}basis_transcoder.js`, blob(TRANSCODER_JS, "text/javascript")],
+        [`${BASIS}basis_transcoder.wasm`, blob(TRANSCODER_WASM, "application/wasm")],
+    ]));
+    return carried;
+}
+/** Where the loader is told its transcoder lies: the URLs it then asks for map to the carried copy. */
+const BASIS = "lod-basis:/";
+/** A URL of `base64`'s deflated bytes. */
+const blob = (base64, type) => URL.createObjectURL(new Blob([inflateSync(Uint8Array.from(atob(base64), (c) => c.charCodeAt(0)))], { type }));
+/** Whether the default WebGPU adapter has a feature; none without WebGPU. The package's types leave WebGPU's out. */
+async function adapterFeatures() {
+    const gpu = typeof navigator === "undefined" ? undefined : Reflect.get(navigator, "gpu");
+    const request = typeof gpu === "object" && gpu !== null ? Reflect.get(gpu, "requestAdapter") : undefined;
+    if (typeof request !== "function")
+        return () => false;
+    const adapter = await Reflect.apply(request, gpu, []);
+    const features = typeof adapter === "object" && adapter !== null ? Reflect.get(adapter, "features") : undefined;
+    const has = typeof features === "object" && features !== null ? Reflect.get(features, "has") : undefined;
+    if (typeof has !== "function")
+        return () => false;
+    return (feature) => Reflect.apply(has, features, [feature]) === true;
+}
+//# sourceMappingURL=transcode.js.map

package/dist/impostor/ktx2/transcode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transcode.js","sourceRoot":"","sources":["../../../src/impostor/ktx2/transcode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EAAE,cAAc,EAA0B,MAAM,cAAc,CAAC;AAGtE,uHAAuH;AACvH,IAAI,MAAuC,CAAC;AAC5C,0GAA0G;AAC1G,IAAI,MAAM,GAAG,CAAC,CAAC;AACf,IAAI,IAA+C,CAAC;AACpD;mGACmG;AACnG,MAAM,OAAO,GAAG,IAAI,CAAC;AAErB;;;;;;GAMG;AACH,SAAS,MAAM;IACb,MAAM,KAAK,CAAC,KAAK,IAAI,EAAE;QACrB,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;QAC5E,MAAM,OAAO,GAAG,IAAI,cAAc,EAAE,CAAC,cAAc,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC;QACpF,uGAAuG;QACvG,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAChE,4FAA4F;QAC5F,MAAM,CAAC,YAAY,GAAG;YACpB,aAAa,EAAE,GAAG,CAAC,0BAA0B,CAAC;YAC9C,gBAAgB,EAAE,KAAK;YACvB,aAAa,EAAE,KAAK;YACpB,aAAa,EAAE,GAAG,CAAC,0BAA0B,CAAC;YAC9C,YAAY,EAAE,KAAK;YACnB,aAAa,EAAE,GAAG,CAAC,wBAAwB,CAAC;YAC5C,cAAc,EAAE,KAAK;SACtB,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,EAAE,CAAC;IACL,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,sFAAsF;AACtF,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,IAAgB;IAC9C,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;IAClC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;QAC/C,IAAI,CAAC,CAAC,IAAI,YAAY,UAAU,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,CAAC,WAAW,CAAC,IAAI,aAAa,CAAC,CAAC;QACxG,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;AAC7C,CAAC;AAED,KAAK,UAAU,KAAK,CAAC,IAAgB;IACnC,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,MAAM,EAAE,CAAC;IACT,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,MAAM,EAAE,CAAC;QAC5B,2CAA2C;QAC3C,OAAO,MAAM,IAAI,OAAO,CAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IACrH,CAAC;YAAS,CAAC;QACT,IAAI,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;YACnB,IAAI,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACpC,mFAAmF;YACnF,MAAM,KAAK,GAAY,IAAI,CAAC;YAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,UAAU;gBAAE,KAAK,CAAC,KAAK,EAAE,CAAC;QAC1H,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,OAAO;IACd,MAAM,QAAQ,GAAG,MAAM,CAAC;IACxB,MAAM,GAAG,SAAS,CAAC;IACnB,KAAK,QAAQ,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AACpD,CAAC;AAED,uGAAuG;AACvG,IAAI,OAAiD,CAAC;AAEtD,8GAA8G;AAC9G,SAAS,YAAY;IACnB,OAAO,KAAK,MAAM,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAC7C,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,EAAE,CACrC,IAAI,GAAG,CAAC;QACN,CAAC,GAAG,KAAK,qBAAqB,EAAE,IAAI,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;QACvE,CAAC,GAAG,KAAK,uBAAuB,EAAE,IAAI,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC;KAC7E,CAAC,CACL,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,uGAAuG;AACvG,MAAM,KAAK,GAAG,aAAa,CAAC;AAE5B,0CAA0C;AAC1C,MAAM,IAAI,GAAG,CAAC,MAAc,EAAE,IAAY,EAAE,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAE7J,qHAAqH;AACrH,KAAK,UAAU,eAAe;IAC5B,MAAM,GAAG,GAAY,OAAO,SAAS,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAClG,MAAM,OAAO,GAAY,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAClH,IAAI,OAAO,OAAO,KAAK,UAAU;QAAE,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC;IACtD,MAAM,OAAO,GAAY,MAAM,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAC/D,MAAM,QAAQ,GAAY,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzH,MAAM,GAAG,GAAY,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAClH,IAAI,OAAO,GAAG,KAAK,UAAU;QAAE,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC;IAClD,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC;AACvE,CAAC"}

package/dist/impostor/ktx2/uastc.d.ts

@@ -0,0 +1,7 @@
+import type { Job } from "./encode.js";
+/**
+ * Rows of a mip level as a KTX2 file of UASTC LDR 4x4 with Zstandard supercompression, at level 1 (see PACK_FLAGS) and
+ * without RDO, which would trade normal accuracy for size. The encoder's own mips would filter level 0, so each baked
+ * level is encoded on its own (see `encodeLayer`).
+ */
+export declare function encode({ data, width, height, srgb }: Job): Promise<Uint8Array>;

package/dist/impostor/ktx2/uastc.js

@@ -0,0 +1,64 @@
+import { inflateSync } from "fflate";
+import { ENCODER_JS, ENCODER_WASM } from "./wasm/encoder.js";
+/** basisu's encoder module, instantiated once: a process-wide WASM module, as three's decoders are. */
+let basis;
+/**
+ * basisu's pack flags: level 1, which encodes about twice as fast as the default level 2 and loses under 0.1 dB on
+ * albedo and normal maps (level 0 loses 1 to 4 dB), with the fastest ETC1 hints (128), which only transcodes to ETC1
+ * and ETC2 read; three picks those only on a GPU without ASTC and BC texture compression, which WebGPU adapters on
+ * desktops and most phones have.
+ */
+const PACK_FLAGS = 1 | 128;
+/**
+ * Rows of a mip level as a KTX2 file of UASTC LDR 4x4 with Zstandard supercompression, at level 1 (see PACK_FLAGS) and
+ * without RDO, which would trade normal accuracy for size. The encoder's own mips would filter level 0, so each baked
+ * level is encoded on its own (see `encodeLayer`).
+ */
+export async function encode({ data, width, height, srgb }) {
+    const encoder = new (await (basis ??= load())).BasisEncoder();
+    try {
+        encoder.setCreateKTX2File(true);
+        encoder.setUASTC(true);
+        // basisu's enums: texture type 0 is a 2D texture; image format 0 is raw RGBA8
+        encoder.setTexType(0);
+        if (!encoder.setSliceSourceImage(0, data, width, height, 0))
+            throw new Error(`the Basis encoder took no ${width}x${height} image`);
+        encoder.setPerceptual(srgb);
+        encoder.setKTX2AndBasisSRGBTransferFunc(srgb);
+        encoder.setMipGen(false);
+        encoder.setPackUASTCFlags(PACK_FLAGS);
+        encoder.setKTX2UASTCSupercompression(true);
+        const out = new Uint8Array(4 * width * height + 65536);
+        const length = encoder.encode(out);
+        if (length === 0)
+            throw new Error(`the Basis encoder failed on a ${width}x${height} image`);
+        return out.slice(0, length);
+    }
+    finally {
+        encoder.delete();
+    }
+}
+/**
+ * The encoder's Emscripten module (see scripts/basis.ts), started on its binary. Imported from a data: URL, which
+ * browsers and Node both import, unlike a blob: URL.
+ */
+async function load() {
+    const url = `data:text/javascript,${encodeURIComponent(new TextDecoder().decode(inflate(ENCODER_JS)))}`;
+    const factory = (await import(/* @vite-ignore */ url)).default;
+    if (typeof factory !== "function")
+        throw new Error("the Basis encoder module has no factory");
+    // the module names its binary relative to its own URL, which a data: URL's is not: named, then given
+    const basis = await factory({ wasmBinary: inflate(ENCODER_WASM), locateFile: (name) => name });
+    if (!isBasis(basis))
+        throw new Error("the Basis encoder module lacks its bindings");
+    basis.initializeBasis();
+    return basis;
+}
+function isBasis(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        typeof Reflect.get(value, "BasisEncoder") === "function" &&
+        typeof Reflect.get(value, "initializeBasis") === "function");
+}
+const inflate = (base64) => inflateSync(Uint8Array.from(atob(base64), (c) => c.charCodeAt(0)));
+//# sourceMappingURL=uastc.js.map

package/dist/impostor/ktx2/uastc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uastc.js","sourceRoot":"","sources":["../../../src/impostor/ktx2/uastc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAqB7D,uGAAuG;AACvG,IAAI,KAAiC,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,UAAU,GAAG,CAAC,GAAG,GAAG,CAAC;AAE3B;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAO;IAC7D,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;IAC9D,IAAI,CAAC;QACH,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvB,8EAA8E;QAC9E,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,KAAK,IAAI,MAAM,QAAQ,CAAC,CAAC;QACnI,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,CAAC,+BAA+B,CAAC,IAAI,CAAC,CAAC;QAC9C,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC,CAAC;QACvD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,IAAI,MAAM,QAAQ,CAAC,CAAC;QAC5F,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAC9B,CAAC;YAAS,CAAC;QACT,OAAO,CAAC,MAAM,EAAE,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,IAAI;IACjB,MAAM,GAAG,GAAG,wBAAwB,kBAAkB,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;IACxG,MAAM,OAAO,GAAY,CAAC,MAAM,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC;IACxE,IAAI,OAAO,OAAO,KAAK,UAAU;QAAE,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC9F,qGAAqG;IACrG,MAAM,KAAK,GAAY,MAAM,OAAO,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,EAAE,UAAU,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;IAChH,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACpF,KAAK,CAAC,eAAe,EAAE,CAAC;IACxB,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,OAAO,CAAC,KAAc;IAC7B,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,cAAc,CAAC,KAAK,UAAU;QACxD,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,iBAAiB,CAAC,KAAK,UAAU,CAC5D,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC"}