@reearth/ezu 0.4.1 → 0.4.2

package/README.md

@@ -24,6 +24,9 @@ The package ships four builds and picks one automatically via the
 | Node.js              | `nodejs`    |
 | Cloudflare Workers   | `workerd` (via the `workerd` condition) |
 
+Every build also exists in a wasm SIMD128 flavor under
+`@reearth/ezu/simd` — see [SIMD](#simd).
+
 ### Bundler / Cloudflare Workers / Node.js
 
 ```js
@@ -60,6 +63,42 @@ The raw artifacts are exported too, for hosts that need to wire up
 instantiation themselves: `@reearth/ezu/bundler/ezu_bg.js`,
 `@reearth/ezu/bundler/ezu_bg.wasm`, and `@reearth/ezu/web/ezu_bg.wasm`.
 
+## SIMD
+
+The same four builds are shipped a second time compiled with
+`-C target-feature=+simd128`, under the `simd` subpath. It resolves by
+the same conditions as the default entry, so one import covers every
+runtime:
+
+```js
+import { Renderer } from "@reearth/ezu/simd";
+```
+
+The default entry (`.`) stays **non-SIMD** on purpose. Safari gained
+wasm SIMD128 only in 16.4, and a module that uses SIMD instructions
+fails to *compile* on older engines rather than degrading — so making
+SIMD the package default would hard-break those browsers. Opt in where
+you know the engine supports it: Cloudflare Workers (workerd), Node 16+,
+and Chrome/Firefox/Safari 16.4+.
+
+`simdEnabled()` reports which flavor is loaded — `true` only in the
+`simd` builds:
+
+```js
+import { simdEnabled } from "@reearth/ezu/simd";
+simdEnabled(); // true
+```
+
+Individual builds and raw artifacts mirror the default layout:
+`@reearth/ezu/simd/web`, `/simd/bundler`, `/simd/nodejs`,
+`/simd/workerd`, `@reearth/ezu/simd/bundler/ezu_bg.js`,
+`@reearth/ezu/simd/bundler/ezu_bg.wasm`, and
+`@reearth/ezu/simd/web/ezu_bg.wasm`.
+
+A future version could ship a single entry that feature-detects SIMD at
+load time and instantiates the matching wasm; that would double the
+bytes a browser may download, so for now the choice is explicit.
+
 ## API
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reearth/ezu",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Painterly map renderer — WebAssembly bindings",
   "license": "MIT OR Apache-2.0",
   "repository": {
@@ -60,6 +60,44 @@
     "./bundler/ezu_bg.js": "./bundler/ezu_bg.js",
     "./bundler/ezu_bg.wasm": "./bundler/ezu_bg.wasm",
     "./web/ezu_bg.wasm": "./web/ezu_bg.wasm",
+    "./simd": {
+      "workerd": {
+        "types": "./simd/workerd/ezu.d.ts",
+        "default": "./simd/workerd/ezu.js"
+      },
+      "browser": {
+        "types": "./simd/web/ezu.d.ts",
+        "default": "./simd/web/ezu.js"
+      },
+      "node": {
+        "types": "./simd/nodejs/ezu.d.ts",
+        "default": "./simd/nodejs/ezu.js"
+      },
+      "import": {
+        "types": "./simd/bundler/ezu.d.ts",
+        "default": "./simd/bundler/ezu.js"
+      }
+    },
+    "./simd/web": {
+      "types": "./simd/web/ezu.d.ts",
+      "default": "./simd/web/ezu.js"
+    },
+    "./simd/bundler": {
+      "types": "./simd/bundler/ezu.d.ts",
+      "default": "./simd/bundler/ezu.js"
+    },
+    "./simd/nodejs": {
+      "types": "./simd/nodejs/ezu.d.ts",
+      "default": "./simd/nodejs/ezu.js"
+    },
+    "./simd/workerd": {
+      "types": "./simd/workerd/ezu.d.ts",
+      "default": "./simd/workerd/ezu.js"
+    },
+    "./simd/workerd/ezu.js": "./simd/workerd/ezu.js",
+    "./simd/bundler/ezu_bg.js": "./simd/bundler/ezu_bg.js",
+    "./simd/bundler/ezu_bg.wasm": "./simd/bundler/ezu_bg.wasm",
+    "./simd/web/ezu_bg.wasm": "./simd/web/ezu_bg.wasm",
     "./package.json": "./package.json"
   },
   "files": [
@@ -67,6 +105,7 @@
     "bundler",
     "nodejs",
     "workerd",
+    "simd",
     "README.md",
     "LICENSE-MIT",
     "LICENSE-APACHE"
@@ -76,6 +115,10 @@
     "./web/ezu.js",
     "./bundler/ezu.js",
     "./nodejs/ezu.js",
-    "./workerd/ezu.js"
+    "./workerd/ezu.js",
+    "./simd/web/ezu.js",
+    "./simd/bundler/ezu.js",
+    "./simd/nodejs/ezu.js",
+    "./simd/workerd/ezu.js"
   ]
 }

package/simd/bundler/ezu.d.ts

@@ -0,0 +1,176 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Buffered log sink that captures `tracing` events from the renderer.
+ *
+ * Construct once near the top of your bootstrap, then either set a
+ * callback for live forwarding (`onEvent(e => console.log(e))`) or
+ * `drainLines()` periodically to flush into a UI panel.
+ */
+export class LogSink {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Drop all buffered records without returning them.
+     */
+    clear(): void;
+    /**
+     * Drain every buffered record. Returns a JS array of structured
+     * objects `{ level, target, message, fields, timestampMs }`.
+     */
+    drain(): Array<any>;
+    /**
+     * Drain buffered records and return pre-formatted strings — the
+     * same shape the CLI prints. Convenient for `console.log(lines.join('\n'))`.
+     */
+    drainLines(): string[];
+    /**
+     * `true` if no records are buffered.
+     */
+    isEmpty(): boolean;
+    /**
+     * Install (idempotently) the global tracing subscriber. `level` is
+     * an `EnvFilter` string — e.g. `"info"`, `"debug"`,
+     * `"info,ezu_graph::eval=debug"`. Honoured on first call only.
+     */
+    constructor(level: string);
+    /**
+     * Set (or clear with `null` / `undefined`) the per-event JS
+     * callback. The callback receives a structured record object.
+     *
+     * No-op in multithreaded (`threads`) builds — events can originate
+     * on rayon worker threads, so live forwarding to a main-thread JS
+     * callback isn't available. Use `drain` / `drainLines` instead.
+     */
+    onEvent(callback?: Function | null): void;
+    /**
+     * Resize the ring-buffer cap. Older entries are evicted FIFO once
+     * the buffer reaches the new cap. Default is 4096.
+     */
+    setCapacity(cap: number): void;
+    /**
+     * Number of records currently buffered.
+     */
+    readonly len: number;
+}
+
+/**
+ * Stateful WASM renderer.
+ */
+export class Renderer {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Bind raw tile bytes under a `sources.<name>` entry from the style.
+     * The renderer dispatches on the source's declared `type`:
+     *
+     * - `mvt` / `pmtiles` → store raw MVT bytes per `(dx, dy)` neighbour
+     *   offset (centre `coord: [0, 0]`, the default). Layers are bound as
+     *   `<source>.<layer>` (centre) or `<source>.<layer>@dx,dy`
+     *   (neighbours) when [`render_tile`] runs. Binding only the centre
+     *   degrades cross-tile label collision to centre-only at borders.
+     * - `dem` / `raster` → store the raw bytes per `(dx, dy)` neighbour
+     *   offset. The centre tile is `coord: [0, 0]` (default). Decoding
+     *   and 3×3 stitching happen at render time once the tile id is known.
+     * - `geojson` (remote) → store raw bytes per `(dx, dy)` offset;
+     *   projected per tile (and neighbour) at render time.
+     *
+     * `opts` is a JS object: `{ coord?: [dx, dy] }`. Throws
+     * `UnknownSource` if `name` doesn't match any entry in the style's
+     * `sources` block, `MvtDecode` if MVT bytes don't parse, and
+     * `DemDecode` for non-image DEM bytes (the decode itself runs at
+     * render time, but obvious cases are caught here).
+     */
+    bindSource(name: string, bytes: Uint8Array, opts?: object | null): void;
+    /**
+     * Names of every source with at least one pending binding.
+     * Order matches the style's `sources` declaration order.
+     */
+    boundSources(): string[];
+    /**
+     * Drop every pending source binding. Call between tile renders.
+     */
+    clearSources(): void;
+    /**
+     * Glyph ranges the currently bound features can require, as
+     * `{ [glyphsSourceName]: number[] }` where each number is a range
+     * start (`0`, `256`, `512`, …) — i.e. the `{range}` in a
+     * `…/{fontstack}/{range}.pbf` URL is `<start>-<start + 255>`.
+     *
+     * This host cannot fetch glyph ranges lazily, so every range a
+     * tile's labels touch must be bound before `renderTile`. Rather than
+     * scraping every string in the MVT, call this after binding the
+     * vector sources and bind exactly the listed ranges.
+     *
+     * It is an over-approximation, deliberately: a range is listed if
+     * *any* feature in a text layer carries the codepoint in a property
+     * the layer's `text` expression reads, without evaluating filters,
+     * zoom ranges, or the expression itself, and it is listed for every
+     * fontstack in that layer's fallback chain. So it never omits a
+     * range a label needs, and it may name a few that go unused. Text
+     * layers that build their string from something other than a `get`
+     * of a feature property (a literal, a `concat` of formatted values)
+     * contribute their literal text where it is a plain string.
+     */
+    neededGlyphRanges(): object;
+    /**
+     * Build a renderer from a style JSON document.
+     */
+    constructor(style_json: string);
+    /**
+     * Render a single tile using whatever sources are currently bound.
+     *
+     * `opts` (JS object, all fields optional):
+     * - `format`: `"png"` (default) / `"webp"` / `"rgba"`
+     * - `tileSize`, `pad`: override the style's canvas size for this
+     *   call (hi-DPI / preview)
+     * - `png`: `{ compression?: "fast" | "default" | "best" }`
+     */
+    renderTile(z: number, x: number, y: number, opts?: object | null): Uint8Array;
+    /**
+     * Neighbour tile offsets the active style actually asks for from
+     * `source`, as an array of `[dx, dy]` pairs (never including the
+     * centre `[0, 0]`).
+     *
+     * Cross-tile label collision and edge-continuous DEM shading are the
+     * only things that read neighbours, and only for the sources they
+     * name. A host that fetches the full 3×3 window unconditionally
+     * therefore pays for up to eight tiles it will not look at; passing
+     * each offset from this list to `bindSource(name, bytes, { coord })`
+     * fetches exactly what the recipe needs. An empty array means the
+     * centre tile is enough.
+     *
+     * Throws `UnknownSource` if `name` is not declared in the style.
+     */
+    requestedNeighborOffsets(name: string): Array<any>;
+    /**
+     * Replace the active style. Returns the new node count. Invalidates
+     * the intermediate cache and drops any pending source bindings.
+     */
+    setStyle(style_json: string): number;
+    /**
+     * Effective attribution declared by the style (document +
+     * sources), joined with ` | `. Upstream TileJSON / PMTiles
+     * metadata is the JS host's concern — merge it on that side.
+     */
+    readonly attribution: string | undefined;
+    /**
+     * `tile-size` declared by the current style.
+     */
+    readonly tileSize: number;
+}
+
+/**
+ * Whether the wasm binary was compiled with `+simd128`. Lets the demo
+ * page label the renderer build accurately.
+ */
+export function simdEnabled(): boolean;
+
+/**
+ * Whether this build supports multithreaded rendering (compiled with
+ * the `threads` feature). When `false`, `initThreadPool` is absent and
+ * `renderTile`'s `parallel` option is a no-op. Mirrors `simdEnabled` so
+ * the host can label the build.
+ */
+export function threadsEnabled(): boolean;

package/simd/bundler/ezu.js

@@ -0,0 +1,9 @@
+/* @ts-self-types="./ezu.d.ts" */
+import * as wasm from "./ezu_bg.wasm";
+import { __wbg_set_wasm } from "./ezu_bg.js";
+
+__wbg_set_wasm(wasm);
+wasm.__wbindgen_start();
+export {
+    LogSink, Renderer, simdEnabled, threadsEnabled
+} from "./ezu_bg.js";