@draco-rust/decoder 0.1.2 → 0.3.0

package/point-cloud/three.js

@@ -1,123 +1,82 @@
-// What three.js's GLTFLoader and DRACOLoader users call, over the decoder pool.
-// three.js is not imported: the caller hands in the classes, so the package
-// works with whichever copy of three the application bundles.
+// three.js's DRACOLoader, decoding on this entry's worker pool. Everything a
+// caller sees -- load, parse, decodeDracoFile, GLTFLoader's use of it, the
+// geometry it builds -- is three's own class; only the decode is replaced, so
+// the result follows whichever three the application has.
+import { REVISION } from 'three';
+import { DRACOLoader as ThreeDRACOLoader } from 'three/addons/loaders/DRACOLoader.js';
 import { createDecoderPool } from './pool.js';
 
-const SRGB = 'srgb';
-const LINEAR_SRGB = 'srgb-linear';
+// From r181 DRACOLoader pads an attribute whose items are not a multiple of
+// four bytes and builds it interleaved, from the stride its worker reports.
+const PADS = Number.parseInt(REVISION, 10) >= 181;
 
-// DRACOLoader's defaults for a `.drc` file, read by attribute type.
-const defaultAttributes = {
-  position: 'POSITION',
-  normal: 'NORMAL',
-  color: 'COLOR',
-  uv: 'TEX_COORD',
-};
-
-export function createDracoLoader(three, options = {}) {
-  const { BufferGeometry, BufferAttribute, InterleavedBuffer, InterleavedBufferAttribute, Color, ColorManagement } =
-    three;
-  if (typeof BufferGeometry !== 'function' || typeof BufferAttribute !== 'function') {
-    throw new TypeError("createDracoLoader needs three.js's BufferGeometry and BufferAttribute");
+function padded(array, itemSize) {
+  const bytes = array.BYTES_PER_ELEMENT;
+  const stride = (Math.ceil((itemSize * bytes) / 4) * 4) / bytes;
+  if (!PADS || stride === itemSize) return { array, stride: itemSize };
+  const count = array.length / itemSize;
+  const out = new array.constructor(count * stride);
+  for (let i = 0; i < count; i += 1) {
+    out.set(array.subarray(i * itemSize, (i + 1) * itemSize), i * stride);
   }
-  const pool = options.pool ?? createDecoderPool(options);
-  // The buffer goes to the worker by transfer, which leaves nothing here to
-  // decode a second time; GLTFLoader asks again for a primitive it shares, and
-  // gets the first answer, as DRACOLoader gives it.
-  const tasks = new WeakMap();
+  return { array: out, stride };
+}
 
-  // Vertex colours a `.drc` file stores in sRGB become linear, as DRACOLoader
-  // makes them; without Color and ColorManagement they are left as stored.
-  function toWorkingColorSpace(attribute) {
-    const convert = ColorManagement?.colorSpaceToWorking ?? ColorManagement?.toWorkingColorSpace;
-    if (!Color || !convert) return;
-    const color = new Color();
-    for (let i = 0; i < attribute.count; i += 1) {
-      color.fromBufferAttribute(attribute, i);
-      convert.call(ColorManagement, color, SRGB);
-      attribute.setXYZ(i, color.r, color.g, color.b);
-    }
-  }
+export class DRACOLoader extends ThreeDRACOLoader {
+  #tasks = new WeakMap();
 
-  // An item that is not a multiple of four bytes is padded to one, and the
-  // attribute interleaved over the padding, as DRACOLoader does since r181
-  // for glTF's data alignment rule -- when the classes for it were handed in.
-  function attributeOf(array, itemSize) {
-    const bytes = array.BYTES_PER_ELEMENT;
-    const stride = Math.ceil((itemSize * bytes) / 4) * (4 / bytes);
-    if (stride === itemSize || !InterleavedBuffer || !InterleavedBufferAttribute) {
-      return new BufferAttribute(array, itemSize);
-    }
-    const count = array.length / itemSize;
-    const padded = new array.constructor(count * stride);
-    for (let i = 0; i < count; i += 1) {
-      padded.set(array.subarray(i * itemSize, (i + 1) * itemSize), i * stride);
-    }
-    return new InterleavedBufferAttribute(new InterleavedBuffer(padded, stride), itemSize, 0);
+  constructor(manager, options = {}) {
+    super(manager);
+    this.pool = options.pool ?? createDecoderPool(options);
   }
 
-  async function decode(buffer, attributeIDs, attributeTypes, vertexColorSpace) {
-    const byId = !!attributeIDs;
-    const requests = Object.entries(attributeIDs ?? defaultAttributes).map(([name, id]) => ({
+  // The buffer goes to a worker by transfer, which leaves nothing here to
+  // decode again; a second request for it gets the first answer, as three's
+  // own task cache gives it.
+  decodeGeometry(buffer, taskConfig) {
+    const key = JSON.stringify(taskConfig);
+    const cached = this.#tasks.get(buffer);
+    if (cached?.key === key) return cached.promise;
+    if (cached && buffer.byteLength === 0) {
+      return Promise.reject(new Error('THREE.DRACOLoader: Unable to re-decode a buffer with different settings. Buffer has already been transferred.'));
+    }
+    const { attributeIDs, attributeTypes, useUniqueIDs, vertexColorSpace } = taskConfig;
+    const requests = Object.keys(attributeIDs).map((name) => ({
       name,
-      ...(byId ? { id } : { semantic: id }),
-      type: attributeTypes?.[name] ?? 'Float32Array',
+      ...(useUniqueIDs ? { id: attributeIDs[name] } : { semantic: attributeIDs[name] }),
+      type: attributeTypes[name],
     }));
-    const result = await pool.decode(buffer, requests, { transfer: buffer instanceof ArrayBuffer });
-    if (!result.success) throw new Error(result.error);
+    const promise = this.pool.decode(buffer, requests, { transfer: buffer instanceof ArrayBuffer }).then((result) => {
+      if (!result.success) throw new Error(`THREE.DRACOLoader: Decoding failed: ${result.error}`);
+      return this._createGeometry({
+        index: result.index ? { array: result.index, itemSize: 1 } : null,
+        attributes: result.attributes.map(({ name, array, itemSize }) => ({
+          name,
+          itemSize,
+          ...padded(array, itemSize),
+          ...(name === 'color' ? { vertexColorSpace } : {}),
+        })),
+      });
+    });
+    if (buffer instanceof ArrayBuffer) this.#tasks.set(buffer, { key, promise });
+    return promise;
+  }
 
-    const geometry = new BufferGeometry();
-    if (result.index) geometry.setIndex(new BufferAttribute(result.index, 1));
-    for (const { name, array, itemSize } of result.attributes) {
-      const attribute = attributeOf(array, itemSize);
-      if (name === 'color') {
-        if (vertexColorSpace === SRGB) toWorkingColorSpace(attribute);
-        attribute.normalized = !(array instanceof Float32Array);
-      }
-      geometry.setAttribute(name, attribute);
-    }
-    return geometry;
+  setWorkerLimit(workerLimit) {
+    super.setWorkerLimit(workerLimit);
+    this.pool.setWorkerLimit(workerLimit);
+    return this;
   }
 
-  function decodeGeometry(buffer, { attributeIDs, attributeTypes, vertexColorSpace = LINEAR_SRGB } = {}) {
-    const key = JSON.stringify([attributeIDs ?? null, attributeTypes ?? null, vertexColorSpace]);
-    const cached = buffer instanceof ArrayBuffer ? tasks.get(buffer) : undefined;
-    if (cached?.key === key) return cached.promise;
-    if (cached && buffer.byteLength === 0) {
-      return Promise.reject(new Error('this buffer was already decoded with other settings and handed to a worker'));
-    }
-    const promise = decode(buffer, attributeIDs, attributeTypes, vertexColorSpace);
-    if (buffer instanceof ArrayBuffer) tasks.set(buffer, { key, promise });
-    return promise;
+  preload() {
+    // A failure shows again on the first decode, which is where it is handled.
+    this.pool.preload().catch(() => {});
+    return this;
   }
 
-  const loader = {
-    pool,
-    decodeGeometry,
-    /** DRACOLoader's entry for GLTFLoader's `KHR_draco_mesh_compression`. */
-    decodeDracoFile(buffer, callback, attributeIDs, attributeTypes, vertexColorSpace = LINEAR_SRGB, onError = () => {}) {
-      return decodeGeometry(buffer, { attributeIDs, attributeTypes, vertexColorSpace }).then(callback).catch(onError);
-    },
-    /** A `.drc` file's contents, as DRACOLoader's `parse`. */
-    parse(buffer, onLoad, onError = () => {}) {
-      loader.decodeDracoFile(buffer, onLoad, null, null, SRGB, onError);
-    },
-    parseAsync(buffer) {
-      return decodeGeometry(buffer, { vertexColorSpace: SRGB });
-    },
-    preload() {
-      // A failure shows again on the first decode, which is where it is handled.
-      pool.preload().catch(() => {});
-      return loader;
-    },
-    setWorkerLimit(workers) {
-      pool.setWorkerLimit(workers);
-      return loader;
-    },
-    dispose() {
-      pool.dispose();
-      return loader;
-    },
-  };
-  return loader;
+  dispose() {
+    super.dispose();
+    this.pool.dispose();
+    return this;
+  }
 }

package/point-cloud/worker.js

@@ -1,7 +1,9 @@
-// A decoder worker. The pool sends it the compiled module once, then streams
-// to decode; it answers each with its result, handing the arrays back by
-// transfer. Runs as a Web Worker and as a Node worker thread.
-import init, { decode_draco } from './index.js';
+// A pool worker. The pool sends it the compiled module once, then tasks by
+// name from this entry's `tasks.js`; it answers each with its result, handing
+// every array in it back by transfer. Runs as a Web Worker and as a Node
+// worker thread.
+import init from './index.js';
+import * as tasks from './tasks.js';
 
 const web = typeof self !== 'undefined' && typeof self.postMessage === 'function';
 const port = web ? self : process.getBuiltinModule('node:worker_threads').parentPort;
@@ -10,18 +12,30 @@ const listen = (handler) =>
 
 let ready = null;
 
+/** Every buffer in a result, except the module's own memory, which stays. */
+function buffersOf(value, memory, found = new Set()) {
+  if (ArrayBuffer.isView(value)) {
+    if (value.buffer instanceof ArrayBuffer && value.buffer !== memory) found.add(value.buffer);
+  } else if (value instanceof ArrayBuffer) {
+    if (value !== memory) found.add(value);
+  } else if (Array.isArray(value)) {
+    for (const item of value) buffersOf(item, memory, found);
+  } else if (value !== null && typeof value === 'object') {
+    for (const item of Object.values(value)) buffersOf(item, memory, found);
+  }
+  return found;
+}
+
 listen(async (message) => {
   if (message.type === 'init') {
     ready = init({ module_or_path: message.module });
     return;
   }
-  const { id, data, attributes } = message;
+  const { id, task, args } = message;
   try {
-    await ready;
-    const result = decode_draco(data, attributes);
-    const transfer = result.attributes.map((attribute) => attribute.array.buffer);
-    if (result.index) transfer.push(result.index.buffer);
-    port.postMessage({ id, result }, transfer);
+    const { memory } = await ready;
+    const result = await tasks[task](...args);
+    port.postMessage({ id, result }, [...buffersOf(result, memory.buffer)]);
   } catch (error) {
     port.postMessage({ id, error: String(error?.message ?? error) });
   }

package/pool-core.d.ts

@@ -0,0 +1,44 @@
+export interface PoolOptions {
+  /**
+   * How many workers to run at most; they start as work arrives. Defaults to
+   * one less than the cores, between one and four. `0` runs on the calling
+   * thread, as does an environment without workers.
+   */
+  workers?: number;
+  /**
+   * The entry's wasm, when it is not next to this module where the pool looks
+   * for it: a URL, a `Response`, the bytes, or a compiled module.
+   */
+  wasm?: string | URL | Response | BufferSource | WebAssembly.Module;
+}
+
+export interface TaskOptions {
+  /**
+   * Hand the input's buffers to the worker instead of copying them, leaving
+   * them detached here. For buffers nothing else reads afterwards.
+   */
+  transfer?: boolean;
+  /**
+   * Abandons the task: the promise rejects with the signal's reason at once.
+   * A task a worker has already started still runs to its end, and its result
+   * is dropped; one not yet sent is never sent.
+   */
+  signal?: AbortSignal;
+}
+
+export interface Pool {
+  /** Compiles the wasm and starts one worker ahead of the first task. */
+  preload(): Promise<void>;
+  /** Changes the worker limit; idle workers past it stop now, busy ones when done. */
+  setWorkerLimit(workers: number): void;
+  readonly workerLimit: number;
+  /** Stops every worker and rejects what they held. */
+  dispose(): void;
+}
+
+export interface TaskPool extends Pool {
+  /** Runs the task `tasks.js` exports under `name` on a worker. */
+  run(name: string, args?: unknown[], options?: TaskOptions): Promise<any>;
+}
+
+export function createPool(options?: PoolOptions): TaskPool;

package/pool-core.js

@@ -0,0 +1,250 @@
+// Work off the calling thread: a pool of workers, each running this entry's
+// own module and the tasks its `tasks.js` names. The wasm is compiled once here
+// and handed to every worker; inputs go over by transfer of a copy, or of the
+// caller's own buffers when asked, and results come back by transfer, so a
+// task copies nothing it does not have to.
+import init from './index.js';
+import * as tasks from './tasks.js';
+
+/** Leaves a core for the page, and stops at four, past which a page rarely has
+ * that many files in flight at once. */
+const defaultWorkers = () =>
+  Math.max(1, Math.min(4, (globalThis.navigator?.hardwareConcurrency ?? 4) - 1));
+
+const builtin = (name) =>
+  typeof process !== 'undefined' && typeof process.getBuiltinModule === 'function'
+    ? process.getBuiltinModule(name)
+    : undefined;
+
+async function compile(wasm) {
+  if (wasm instanceof WebAssembly.Module) return wasm;
+  let source = wasm ?? new URL('./index_bg.wasm', import.meta.url);
+  if (typeof source === 'string' || source instanceof URL) {
+    const url = new URL(source, import.meta.url);
+    // Node's fetch does not read files.
+    const fs = url.protocol === 'file:' ? builtin('node:fs/promises') : undefined;
+    if (fs) return WebAssembly.compile(await fs.readFile(url));
+    source = await fetch(url);
+  }
+  if (typeof Response !== 'undefined' && source instanceof Response) {
+    if (!source.ok) throw new Error(`failed to fetch ${source.url}: ${source.status}`);
+    if (source.headers.get('content-type') === 'application/wasm') {
+      return WebAssembly.compileStreaming(source);
+    }
+    source = await source.arrayBuffer();
+  }
+  return WebAssembly.compile(source);
+}
+
+/** What the pool needs of a worker, the same over a Web Worker and a Node
+ * worker thread. */
+function spawn(blobUrl) {
+  if (typeof Worker === 'function') {
+    const url = new URL('./worker.js', import.meta.url);
+    // A bundler recognises this exact form and emits the worker as a chunk.
+    const worker =
+      typeof location === 'undefined' || url.origin === location.origin
+        ? new Worker(new URL('./worker.js', import.meta.url), { type: 'module' })
+        : new Worker(blobUrl(url), { type: 'module' });
+    return {
+      post: (message, transfer) => worker.postMessage(message, transfer),
+      listen: (onMessage, onError) => {
+        worker.addEventListener('message', (event) => onMessage(event.data));
+        worker.addEventListener('error', (event) => {
+          event.preventDefault();
+          onError(new Error(event.message || 'the worker failed'));
+        });
+        worker.addEventListener('messageerror', () => onError(new Error('a result could not be read')));
+      },
+      busy: () => {},
+      terminate: () => worker.terminate(),
+    };
+  }
+  const threads = builtin('node:worker_threads');
+  if (!threads) return null;
+  const worker = new threads.Worker(new URL('./worker.js', import.meta.url));
+  // An idle worker does not keep Node running; one with work does.
+  worker.unref();
+  return {
+    post: (message, transfer) => worker.postMessage(message, transfer),
+    listen: (onMessage, onError) => {
+      worker.on('message', onMessage);
+      worker.on('error', onError);
+      worker.on('exit', (code) => onError(new Error(`the worker exited with code ${code}`)));
+    },
+    busy: (busy) => (busy ? worker.ref() : worker.unref()),
+    terminate: () => worker.terminate(),
+  };
+}
+
+const workersAvailable = () =>
+  typeof Worker === 'function' || builtin('node:worker_threads') !== undefined;
+
+const isPlain = (value) => {
+  if (value === null || typeof value !== 'object') return false;
+  const proto = Object.getPrototypeOf(value);
+  return proto === Object.prototype || proto === null;
+};
+
+/**
+ * The arguments as they go to a worker, and the buffers that go with them.
+ * Without `transfer` every typed array is copied first -- just its own bytes,
+ * where structured cloning would copy the whole buffer behind a view -- and
+ * the copy is what moves; with it the caller's buffers move and are left
+ * detached.
+ */
+function outgoing(args, transfer) {
+  const buffers = new Set();
+  const visit = (value) => {
+    if (ArrayBuffer.isView(value)) {
+      const view = transfer ? value : value.slice();
+      if (!(view.buffer instanceof ArrayBuffer)) return view;
+      buffers.add(view.buffer);
+      return view;
+    }
+    if (value instanceof ArrayBuffer) {
+      const buffer = transfer ? value : value.slice(0);
+      buffers.add(buffer);
+      return buffer;
+    }
+    if (Array.isArray(value)) return value.map(visit);
+    if (isPlain(value)) return Object.fromEntries(Object.entries(value).map(([key, item]) => [key, visit(item)]));
+    return value;
+  };
+  const sent = args.map(visit);
+  return { sent, buffers: [...buffers] };
+}
+
+const aborted = (signal) => signal.reason ?? new DOMException('The task was aborted', 'AbortError');
+
+export function createPool(options = {}) {
+  let limit = options.workers ?? defaultWorkers();
+  let compiled = null;
+  let local = null;
+  let blob = null;
+  let disposed = false;
+  let nextId = 0;
+  const slots = [];
+
+  const load = () => (compiled ??= compile(options.wasm));
+  // A worker script must share the page's origin. From a CDN, a worker made
+  // here imports it instead, which a module worker may do across origins.
+  const blobUrl = (url) =>
+    (blob ??= URL.createObjectURL(
+      new Blob([`import ${JSON.stringify(url.href)};`], { type: 'text/javascript' }),
+    ));
+
+  function retire(slot, error) {
+    const at = slots.indexOf(slot);
+    if (at >= 0) slots.splice(at, 1);
+    slot.worker.terminate();
+    for (const { reject } of slot.pending.values()) reject(error);
+    slot.pending.clear();
+  }
+
+  function open(module) {
+    const worker = spawn(blobUrl);
+    if (!worker) return null;
+    const slot = { worker, pending: new Map() };
+    worker.listen(
+      (message) => {
+        const task = slot.pending.get(message.id);
+        if (!task) return;
+        slot.pending.delete(message.id);
+        if (slot.pending.size === 0) {
+          worker.busy(false);
+          if (slots.indexOf(slot) >= limit) retire(slot);
+        }
+        if ('error' in message) task.reject(new Error(message.error));
+        else task.resolve(message.result);
+      },
+      // A worker that fails takes only its own tasks down; the next task
+      // starts another.
+      (error) => {
+        if (slots.includes(slot)) retire(slot, error);
+      },
+    );
+    worker.post({ type: 'init', module });
+    slots.push(slot);
+    return slot;
+  }
+
+  /** The least loaded worker, or a new one while every worker is busy and
+   * the limit allows another. */
+  function pick(module) {
+    let best = null;
+    for (const slot of slots.slice(0, limit)) {
+      if (!best || slot.pending.size < best.pending.size) best = slot;
+    }
+    if ((!best || best.pending.size > 0) && slots.length < limit) return open(module) ?? best;
+    return best;
+  }
+
+  const onThisThread = () =>
+    (local ??= load().then((module) => init({ module_or_path: module })));
+
+  async function run(name, args = [], { transfer = false, signal } = {}) {
+    if (disposed) throw new Error('the pool was disposed');
+    if (typeof tasks[name] !== 'function') throw new TypeError(`no task named ${name}`);
+    signal?.throwIfAborted();
+    if (limit > 0 && workersAvailable()) {
+      const module = await load();
+      if (disposed) throw new Error('the pool was disposed');
+      signal?.throwIfAborted();
+      const slot = pick(module);
+      if (slot) {
+        const id = nextId++;
+        const { sent, buffers } = outgoing(args, transfer);
+        return new Promise((resolve, reject) => {
+          const task = { resolve, reject };
+          if (signal) {
+            // A task a worker has started runs to its end. Aborting it settles
+            // the caller now and drops the result when it comes; the task stays
+            // counted against its worker until then, so the load stays true.
+            const onAbort = () => {
+              task.resolve = task.reject = () => {};
+              reject(aborted(signal));
+            };
+            signal.addEventListener('abort', onAbort, { once: true });
+            const settle = (done) => (value) => {
+              signal.removeEventListener('abort', onAbort);
+              done(value);
+            };
+            task.resolve = settle(resolve);
+            task.reject = settle(reject);
+          }
+          slot.pending.set(id, task);
+          slot.worker.busy(true);
+          slot.worker.post({ id, task: name, args: sent }, buffers);
+        });
+      }
+    }
+    await onThisThread();
+    signal?.throwIfAborted();
+    return tasks[name](...args);
+  }
+
+  return {
+    run,
+    async preload() {
+      if (limit > 0 && workersAvailable()) {
+        const module = await load();
+        if (!disposed && slots.length === 0) open(module);
+      } else {
+        await onThisThread();
+      }
+    },
+    setWorkerLimit(workers) {
+      limit = workers;
+      for (const slot of slots.slice(limit)) if (slot.pending.size === 0) retire(slot);
+    },
+    get workerLimit() {
+      return limit;
+    },
+    dispose() {
+      disposed = true;
+      for (const slot of [...slots]) retire(slot, new Error('the pool was disposed'));
+      if (blob) URL.revokeObjectURL(blob);
+    },
+  };
+}

package/pool.d.ts

@@ -1,28 +1,11 @@
-import type { DracoAttributeRequest, DracoDecodeResult } from './index.js';
+import type { DracoAttributeRequest, DracoDecodeOptions, DracoDecodeResult } from './index.js';
+import type { Pool, PoolOptions, TaskOptions } from './pool-core.js';
 
-export interface DecoderPoolOptions {
-  /**
-   * How many workers to run at most; they start as work arrives. Defaults to
-   * one less than the cores, between one and four. `0` decodes on the calling
-   * thread, as does an environment without workers.
-   */
-  workers?: number;
-  /**
-   * The entry's wasm, when it is not next to this module where the pool looks
-   * for it: a URL, a `Response`, the bytes, or a compiled module.
-   */
-  wasm?: string | URL | Response | BufferSource | WebAssembly.Module;
-}
+export type DecoderPoolOptions = PoolOptions;
 
-export interface DecodeOptions {
-  /**
-   * Hand the stream's buffer to the worker instead of copying it, leaving it
-   * detached here. For a buffer nothing else reads afterwards.
-   */
-  transfer?: boolean;
-}
+export interface DecodeOptions extends DracoDecodeOptions, TaskOptions {}
 
-export interface DecoderPool {
+export interface DecoderPool extends Pool {
   /**
    * `decode_draco` on a worker. A stream that does not decode resolves with
    * `success: false`, as `decode_draco` returns it; a worker that fails rejects
@@ -33,13 +16,7 @@ export interface DecoderPool {
     attributes?: DracoAttributeRequest[],
     options?: DecodeOptions,
   ): Promise<DracoDecodeResult>;
-  /** Compiles the wasm and starts one worker ahead of the first decode. */
-  preload(): Promise<void>;
-  /** Changes the worker limit; idle workers past it stop now, busy ones when done. */
-  setWorkerLimit(workers: number): void;
-  readonly workerLimit: number;
-  /** Stops every worker and rejects what they held. */
-  dispose(): void;
 }
 
 export function createDecoderPool(options?: DecoderPoolOptions): DecoderPool;
+export { createDecoderPool as createPool };