splats.ts
src/core/splats.ts · raw · all examples · site home
Exports: SplatPbrExtSplatCovSplatExtSplatsCovSplatsPackedSplatsSplatBundleSplatLayoutSplatBundlesPackedEncodingSplatDataSplatTargetSplatReadOptionsLoadedSplatsFoundSplatsBundleLikeSplats
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
import { ArrayData, type ArrayBundle } from "./ArrayData";
import type { CoordinateSystem } from "./axes";
import { defineBundle, type BundleDef } from "./bundles";
import { Encoding } from "./encoding";
import type { TypedArray } from "./formats";
import { SplatMath, type Cov, type Quat, type Rgb, type Vec3 } from "./math";
import type { Progress } from "./progress";
import type { ShPalette, ShTarget } from "./sh";
// CPU splat codecs. Bit layouts (A and B are uint32x4, one per splat):
//
// ext (32 B):
// A.xyz center as float32
// A.w normal, Oct24 (0 = none) | LoD opacity byte << 24
// B.x ext rgb (Encoding.encodeExtRgb)
// B.y half(ln sx) | half(ln sy) << 16
// B.z half(ln sz) | roughness unorm8 << 16 | metallic unorm8 << 24
// B.w quaternion, QuatOct32: axis oct 10 + 10 | angle 12 bits << 20.
// The angle gets the most bits for splats that sit near identity
// and turn slightly: the axis error scales with sin(angle / 2), so
// small turns are as fine as the angle step (pi / 4095).
// Axis-aligned splats benefit when stored as a small turn from
// identity with their scales permuted; near a quarter turn the
// axis decides.
// cov (32 B): A and B.x as ext; B.y half(ln xx) | half(ln yy) << 16,
// B.z half(ln zz) | half(c_xy) << 16, B.w half(c_xz) | half(c_yz) << 16,
// with c = sign * ln|correlation|. No roughness or metallic.
// packed (16 B):
// x rgb over [rgbMin, rgbMax] and opacity as unorm8
// y half(cx) | half(cy) << 16
// z half(cz) | axis oct 8 + 8 << 16 (QuatOct24)
// w three log8 scales over [lnScaleMin, lnScaleMax] (0 = zero) | angle8 << 24
// No normal, roughness or metallic.
//
// Two layers over the same bits: Splats.load / store / loadPbr / storePbr /
// loadCenter take any bundle whose type allows them (the standard 3DGS
// fields for every layout, PBR for ext only); Splats.encode* / decode* read
// or write every word of one splat of one layout.
// The standard 3DGS fields, stored by every layout
export interface Splat {
center: Vec3;
scales: Vec3;
quaternion: Quat;
rgb: Rgb;
// 1 = opaque; up to 255 / 128 in ext and cov (LoD)
opacity: number;
}
// Ext splats only
export interface Pbr {
// Unit, or zero for none
normal: Vec3;
// Perceptual, 0..1
roughness: number;
metallic: number;
}
export type ExtSplat = Splat & Pbr;
export interface CovSplat {
center: Vec3;
cov: Cov;
rgb: Rgb;
opacity: number;
normal: Vec3;
}
const EXT = defineBundle({ extA: "uint32x4", extB: "uint32x4" });
const COV = defineBundle({ covA: "uint32x4", covB: "uint32x4" });
// meta.encoding: a PackedEncoding (defaults below)
const PACKED = defineBundle({ packed: "uint32x4" });
// A LoD tree beside the splats, one node per splat: x = child count,
// y = first child's index
const LOD_TREE = defineBundle({ node: "uint32x2" });
// A layout's name is also its standard bundle name: data.bundles.extSplats
const LAYOUTS = { extSplats: EXT, covSplats: COV, packedSplats: PACKED } as const;
export type ExtSplats = ArrayBundle<typeof EXT>;
export type CovSplats = ArrayBundle<typeof COV>;
export type PackedSplats = ArrayBundle<typeof PACKED>;
export type SplatBundle = ExtSplats | CovSplats | PackedSplats;
export type SplatLayout = keyof typeof LAYOUTS;
export interface SplatBundles {
extSplats: ExtSplats;
covSplats: CovSplats;
packedSplats: PackedSplats;
}
export interface PackedEncoding {
rgbMin: number;
rgbMax: number;
lnScaleMin: number;
lnScaleMax: number;
}
const DEFAULT_PACKED_ENCODING: PackedEncoding = { rgbMin: 0, rgbMax: 1, lnScaleMin: -12, lnScaleMax: 9 };
// ArrayData with the splats of layout L in the bundle of that name
// (data.bundles.extSplats); other bundles, such as lodTree, may sit beside
export type SplatData<L extends SplatLayout = "extSplats"> = ArrayData<{ [K in L]: (typeof LAYOUTS)[K] }>;
// Where splats go when made or loaded. `encoding` is for packedSplats: the
// color and scale ranges of its 8-bit codes (default: the source's
// encoding when it has one, else Splats.DEFAULT_PACKED_ENCODING)
export interface SplatTarget<L extends SplatLayout = SplatLayout> {
layout?: L;
encoding?: Partial<PackedEncoding>;
}
// Options of the splat file readers: the layout to read into (default
// extSplats), for packedSplats its encoding, `sh`, what to do with
// spherical harmonics (a codec, default "ext"; false skips them; RDX keeps
// its stored codec unless `sh` is given), and `coordinateSystem`, the axes
// to convert to (SPZ, whose files say what theirs are; default: as stored)
export type SplatReadOptions<L extends SplatLayout = "extSplats"> = SplatTarget<L> & {
progress?: Progress;
sh?: ShTarget;
coordinateSystem?: CoordinateSystem;
};
// A loaded file: its splats and, when its SH is a palette (RAD's clustered
// SH: bundle shLabel in the splats), the palette
export interface LoadedSplats<L extends SplatLayout = "extSplats"> {
splats: SplatData<L>;
shPalette?: ShPalette;
}
export interface FoundSplats {
name: string;
layout: SplatLayout;
bundle: SplatBundle;
}
// Anything with named channels of formats: an ArrayBundle or a GpuBundle
export interface BundleLike {
channels: Record<string, { format: string } | undefined>;
}
function hasLayout(bundle: BundleLike, layout: SplatLayout) {
const channels = LAYOUTS[layout].channels as Record<string, string>;
const labels = Object.keys(channels);
return labels.length === Object.keys(bundle.channels).length && labels.every((label) => bundle.channels[label]?.format === channels[label]);
}
// One property check per call; the type already fixed the formats
const isExtBundle = (bundle: SplatBundle): bundle is ExtSplats => "extA" in bundle.channels;
const isCovBundle = (bundle: SplatBundle): bundle is CovSplats => "covA" in bundle.channels;
const lnHalf = (v: number) => Encoding.encodeHalf(Math.log(v));
const expHalf = (h: number) => Math.exp(Encoding.decodeHalf(h));
// --- Word A, shared by ext and cov (f: the same words as floats) ---
function storeA(a: Uint32Array, f: Float32Array, i4: number, center: Vec3, opacity: number) {
f[i4] = center.x;
f[i4 + 1] = center.y;
f[i4 + 2] = center.z;
a[i4 + 3] = ((a[i4 + 3] & 0xffffff) | (Encoding.encodeLodOpacity(opacity) << 24)) >>> 0;
}
function storeNormal(a: Uint32Array, i4: number, normal: Vec3) {
a[i4 + 3] = ((a[i4 + 3] & 0xff000000) | Encoding.encodeOct24(normal)) >>> 0;
}
function loadCenterA(f: Float32Array, i4: number, out: Vec3) {
out.x = f[i4];
out.y = f[i4 + 1];
out.z = f[i4 + 2];
return out;
}
// --- Ext ---
function storeExtFields(a: Uint32Array, f: Float32Array, b: Uint32Array, i4: number, s: Splat) {
storeA(a, f, i4, s.center, s.opacity);
b[i4] = Encoding.encodeExtRgb(s.rgb);
b[i4 + 1] = (lnHalf(s.scales.x) | (lnHalf(s.scales.y) << 16)) >>> 0;
b[i4 + 2] = ((b[i4 + 2] & 0xffff0000) | lnHalf(s.scales.z)) >>> 0;
b[i4 + 3] = Encoding.encodeQuatOct32(s.quaternion);
}
function storeExtPbr(a: Uint32Array, b: Uint32Array, i4: number, p: Pbr) {
storeNormal(a, i4, p.normal);
b[i4 + 2] = ((b[i4 + 2] & 0xffff) | (Encoding.encodeUnorm8(p.roughness) << 16) | (Encoding.encodeUnorm8(p.metallic) << 24)) >>> 0;
}
function loadExtFields(a: Uint32Array, f: Float32Array, b: Uint32Array, i4: number, out: Splat) {
loadCenterA(f, i4, out.center);
out.opacity = Encoding.decodeLodOpacity(a[i4 + 3] >>> 24);
Encoding.decodeExtRgb(b[i4], out.rgb);
out.scales.x = expHalf(b[i4 + 1] & 0xffff);
out.scales.y = expHalf(b[i4 + 1] >>> 16);
out.scales.z = expHalf(b[i4 + 2] & 0xffff);
Encoding.decodeQuatOct32(b[i4 + 3], out.quaternion);
return out;
}
function loadExtPbr(a: Uint32Array, b: Uint32Array, i4: number, out: Pbr) {
Encoding.decodeOct24(a[i4 + 3] & 0xffffff, out.normal);
out.roughness = ((b[i4 + 2] >>> 16) & 0xff) / 255;
out.metallic = (b[i4 + 2] >>> 24) / 255;
return out;
}
function encodeExtWords(a: Uint32Array, f: Float32Array, b: Uint32Array, i4: number, s: ExtSplat) {
a[i4 + 3] = 0;
b[i4 + 2] = 0;
storeExtFields(a, f, b, i4, s);
storeExtPbr(a, b, i4, s);
}
function decodeExtWords(a: Uint32Array, f: Float32Array, b: Uint32Array, i4: number, out: ExtSplat) {
loadExtFields(a, f, b, i4, out);
loadExtPbr(a, b, i4, out);
return out;
}
// --- Cov ---
// Correlation c = xy / sqrt(xx yy) as sign(c) * ln|c|, so values near +-1
// keep their precision in a half float
function encodeCorrelation(value: number, a: number, b: number) {
const c = Math.max(-1, Math.min(1, value / Math.sqrt(a * b)));
if (c === 0 || !Number.isFinite(c)) {
return 0;
}
return Math.sign(c) * Math.max(-100, Math.min(-1e-7, Math.log(Math.abs(c))));
}
function decodeCorrelation(encoded: number) {
return encoded === 0 ? 0 : -Math.sign(encoded) * Math.exp(-Math.abs(encoded));
}
// Everything but the normal
function storeCovFields(a: Uint32Array, f: Float32Array, b: Uint32Array, i4: number, center: Vec3, cov: Cov, rgb: Rgb, opacity: number) {
const { xx, yy, zz, xy, xz, yz } = cov;
storeA(a, f, i4, center, opacity);
b[i4] = Encoding.encodeExtRgb(rgb);
b[i4 + 1] = (lnHalf(xx) | (lnHalf(yy) << 16)) >>> 0;
b[i4 + 2] = (lnHalf(zz) | (Encoding.encodeHalf(encodeCorrelation(xy, xx, yy)) << 16)) >>> 0;
b[i4 + 3] = (Encoding.encodeHalf(encodeCorrelation(xz, xx, zz)) | (Encoding.encodeHalf(encodeCorrelation(yz, yy, zz)) << 16)) >>> 0;
}
function encodeCovWords(a: Uint32Array, f: Float32Array, b: Uint32Array, i4: number, c: CovSplat) {
a[i4 + 3] = 0;
storeCovFields(a, f, b, i4, c.center, c.cov, c.rgb, c.opacity);
storeNormal(a, i4, c.normal);
}
function decodeCovWords(a: Uint32Array, f: Float32Array, b: Uint32Array, i4: number, out: CovSplat) {
loadCenterA(f, i4, out.center);
Encoding.decodeOct24(a[i4 + 3] & 0xffffff, out.normal);
out.opacity = Encoding.decodeLodOpacity(a[i4 + 3] >>> 24);
Encoding.decodeExtRgb(b[i4], out.rgb);
const xx = expHalf(b[i4 + 1] & 0xffff);
const yy = expHalf(b[i4 + 1] >>> 16);
const zz = expHalf(b[i4 + 2] & 0xffff);
out.cov.xx = xx;
out.cov.yy = yy;
out.cov.zz = zz;
out.cov.xy = decodeCorrelation(Encoding.decodeHalf(b[i4 + 2] >>> 16)) * Math.sqrt(xx * yy);
out.cov.xz = decodeCorrelation(Encoding.decodeHalf(b[i4 + 3] & 0xffff)) * Math.sqrt(xx * zz);
out.cov.yz = decodeCorrelation(Encoding.decodeHalf(b[i4 + 3] >>> 16)) * Math.sqrt(yy * zz);
return out;
}
// --- Packed: a codec per encoding, its constants computed once ---
function packedCodec({ rgbMin, rgbMax, lnScaleMin, lnScaleMax }: PackedEncoding) {
const rgbRange = rgbMax - rgbMin;
const lnStep = (lnScaleMax - lnScaleMin) / 254;
const color = (v: number) => Encoding.encodeUnorm8((v - rgbMin) / rgbRange);
const scale = (v: number) => (v <= 0 ? 0 : Math.max(1, Math.min(255, Math.round((Math.log(v) - lnScaleMin) / lnStep) + 1)));
const colorOf = (byte: number) => rgbMin + (byte / 255) * rgbRange;
const scaleOf = (code: number) => (code === 0 ? 0 : Math.exp(lnScaleMin + (code - 1) * lnStep));
return {
encode(data: Uint32Array, i4: number, s: Splat) {
const quat = Encoding.encodeQuatOct24(s.quaternion);
data[i4] = (color(s.rgb.r) | (color(s.rgb.g) << 8) | (color(s.rgb.b) << 16) | (Encoding.encodeUnorm8(s.opacity) << 24)) >>> 0;
data[i4 + 1] = (Encoding.encodeHalf(s.center.x) | (Encoding.encodeHalf(s.center.y) << 16)) >>> 0;
data[i4 + 2] = (Encoding.encodeHalf(s.center.z) | ((quat & 0xffff) << 16)) >>> 0;
data[i4 + 3] = (scale(s.scales.x) | (scale(s.scales.y) << 8) | (scale(s.scales.z) << 16) | ((quat >>> 16) << 24)) >>> 0;
},
decode(data: Uint32Array, i4: number, out: Splat): Splat {
const x = data[i4];
const y = data[i4 + 1];
const z = data[i4 + 2];
const w = data[i4 + 3];
out.rgb.r = colorOf(x & 0xff);
out.rgb.g = colorOf((x >>> 8) & 0xff);
out.rgb.b = colorOf((x >>> 16) & 0xff);
out.opacity = (x >>> 24) / 255;
out.center.x = Encoding.decodeHalf(y & 0xffff);
out.center.y = Encoding.decodeHalf(y >>> 16);
out.center.z = Encoding.decodeHalf(z & 0xffff);
out.scales.x = scaleOf(w & 0xff);
out.scales.y = scaleOf((w >>> 8) & 0xff);
out.scales.z = scaleOf((w >>> 16) & 0xff);
Encoding.decodeQuatOct24((z >>> 16) | ((w >>> 24) << 16), out.quaternion);
return out;
},
};
}
const extWords = (bundle: ExtSplats) => {
const a = bundle.channels.extA.data;
return { a, f: Encoding.floatView(a), b: bundle.channels.extB.data };
};
const covWords = (bundle: CovSplats) => {
const a = bundle.channels.covA.data;
return { a, f: Encoding.floatView(a), b: bundle.channels.covB.data };
};
const arraysOf = (bundle: ArrayBundle) => Object.fromEntries(Object.entries(bundle.channels).map(([label, channel]) => [label, channel.data])) as Record<string, TypedArray>;
const covScratch: CovSplat = {
center: { x: 0, y: 0, z: 0 }, cov: { xx: 1, yy: 1, zz: 1, xy: 0, xz: 0, yz: 0 }, rgb: { r: 1, g: 1, b: 1 }, opacity: 1, normal: { x: 0, y: 0, z: 0 },
};
// Splat tables of any layout and the CPU codecs of each: made for a layout,
// found in any data, converted between layouts, read and written one splat
// at a time. GpuSplats is the TSL twin of the codecs.
export class Splats {
static readonly EXT = EXT;
static readonly COV = COV;
static readonly PACKED = PACKED;
static readonly LOD_TREE = LOD_TREE;
static readonly LAYOUTS = LAYOUTS;
static readonly DEFAULT_PACKED_ENCODING: Readonly<PackedEncoding> = DEFAULT_PACKED_ENCODING;
// --- Plain splat records ---
static makeSplat(): Splat {
return { center: { x: 0, y: 0, z: 0 }, scales: { x: 1, y: 1, z: 1 }, quaternion: { x: 0, y: 0, z: 0, w: 1 }, rgb: { r: 1, g: 1, b: 1 }, opacity: 1 };
}
static makePbr(): Pbr {
return { normal: { x: 0, y: 0, z: 0 }, roughness: 1, metallic: 0 };
}
static makeExtSplat(): ExtSplat {
return { ...Splats.makeSplat(), ...Splats.makePbr() };
}
static makeCovSplat(): CovSplat {
return {
center: { x: 0, y: 0, z: 0 }, cov: { xx: 1, yy: 1, zz: 1, xy: 0, xz: 0, yz: 0 }, rgb: { r: 1, g: 1, b: 1 },
opacity: 1, normal: { x: 0, y: 0, z: 0 },
};
}
// --- Bundles and tables ---
static packedEncodingOf(bundle: { meta: Record<string, unknown> }): PackedEncoding {
return { ...DEFAULT_PACKED_ENCODING, ...(bundle.meta.encoding as Partial<PackedEncoding> | undefined) };
}
static isExt(bundle: ArrayBundle): bundle is ExtSplats {
return hasLayout(bundle, "extSplats");
}
static isCov(bundle: ArrayBundle): bundle is CovSplats {
return hasLayout(bundle, "covSplats");
}
static isPacked(bundle: ArrayBundle): bundle is PackedSplats {
return hasLayout(bundle, "packedSplats");
}
// The layout of a bundle by its channel names and formats
static layoutOf(bundle: SplatBundle): SplatLayout;
static layoutOf(bundle: BundleLike): SplatLayout | undefined;
static layoutOf(bundle: BundleLike): SplatLayout | undefined {
return (Object.keys(LAYOUTS) as SplatLayout[]).find((layout) => hasLayout(bundle, layout));
}
// The splat bundle among `bundles` (of an ArrayData or GpuArrays):
// `name` when given, else the standard names first, then any bundle of a
// splat layout
static findBundle(bundles: Record<string, BundleLike>, name?: string): { name: string; layout: SplatLayout } | undefined {
const names = name !== undefined ? [name] : [...Object.keys(LAYOUTS), ...Object.keys(bundles)];
for (const candidate of names) {
const bundle = bundles[candidate];
const layout = bundle && Splats.layoutOf(bundle);
if (layout) {
return { name: candidate, layout };
}
}
return undefined;
}
// The splat bundle of `data` (as findBundle), or undefined
static find(data: ArrayData, name?: string): FoundSplats | undefined {
const found = Splats.findBundle(data.bundles, name);
return found && { ...found, bundle: data.bundles[found.name] as unknown as SplatBundle };
}
// The splat bundle of `data`; throws when there is none
static get(data: ArrayData, name?: string): FoundSplats {
const found = Splats.find(data, name);
if (!found) {
throw new Error(name !== undefined ? `Bundle ${name} is not a splat bundle` : "No extSplats, covSplats or packedSplats bundle");
}
return found;
}
// The tree beside the splats, when the data has one
static findLodTree(data: ArrayData): ArrayBundle<typeof LOD_TREE> | undefined {
const bundle = data.bundles.lodTree;
return bundle?.channels.node?.format === "uint32x2" ? (bundle as ArrayBundle<typeof LOD_TREE>) : undefined;
}
// Adds an empty splat bundle of `layout` (default extSplats), named after it
static add(data: ArrayData, { layout = "extSplats", encoding }: SplatTarget = {}): SplatBundle {
const meta = layout === "packedSplats" ? { encoding: { ...DEFAULT_PACKED_ENCODING, ...encoding } } : {};
data.addBundle(layout, LAYOUTS[layout] as BundleDef, { meta });
return data.bundles[layout] as unknown as SplatBundle;
}
// Empty splats of `layout` in a new ArrayData of `count` elements
static make<L extends SplatLayout = "extSplats">(count: number, { meta, ...target }: SplatTarget<L> & {
meta?: Record<string, unknown>;
} = {}): SplatData<L> {
const data = new ArrayData({ count, meta });
Splats.add(data, target);
return data as unknown as SplatData<L>;
}
// `data` with its splats in `layout` (packed: in `encoding`, default the
// source's): `data` itself when they already are, else a new ArrayData
// sharing every other bundle's arrays
static convert<L extends SplatLayout>(data: ArrayData, { layout, encoding }: SplatTarget<L> & { layout: L }): SplatData<L> {
const found = Splats.get(data);
const source = found.layout === "packedSplats" ? Splats.packedEncodingOf(found.bundle) : undefined;
const sameEncoding = !encoding || layout !== "packedSplats"
|| (source !== undefined && Object.entries(encoding).every(([key, value]) => source[key as keyof PackedEncoding] === value));
if (found.layout === layout && found.name === layout && sameEncoding) {
return data as unknown as SplatData<L>;
}
const out = new ArrayData({ count: data.count, capacity: data.capacity, meta: { ...data.meta } });
for (const [name, bundle] of Object.entries(data.bundles)) {
if (name !== found.name) {
out.addBundle(name, bundle.def, { data: arraysOf(bundle), meta: bundle.meta });
}
}
if (found.layout === layout && sameEncoding) {
out.addBundle(layout, found.bundle.def as BundleDef, { data: arraysOf(found.bundle as ArrayBundle), meta: found.bundle.meta });
return out as unknown as SplatData<L>;
}
const decode = Splats.decoder(found.bundle);
const encode = Splats.encoder(Splats.add(out, { layout, encoding: { ...source, ...encoding } }));
const s = Splats.makeExtSplat();
for (let i = 0; i < data.count; i += 1) {
encode(i, decode(i, s));
}
return out as unknown as SplatData<L>;
}
// --- One layout's words ---
static encodeExt(bundle: ExtSplats, i: number, s: ExtSplat) {
const { a, f, b } = extWords(bundle);
encodeExtWords(a, f, b, i * 4, s);
}
static decodeExt(bundle: ExtSplats, i: number, out: ExtSplat): ExtSplat {
const { a, f, b } = extWords(bundle);
return decodeExtWords(a, f, b, i * 4, out);
}
static encodeCov(bundle: CovSplats, i: number, c: CovSplat) {
const { a, f, b } = covWords(bundle);
encodeCovWords(a, f, b, i * 4, c);
}
static decodeCov(bundle: CovSplats, i: number, out: CovSplat): CovSplat {
const { a, f, b } = covWords(bundle);
return decodeCovWords(a, f, b, i * 4, out);
}
static encodePacked(bundle: PackedSplats, i: number, s: Splat, encoding = Splats.packedEncodingOf(bundle)) {
packedCodec(encoding).encode(bundle.channels.packed.data, i * 4, s);
}
static decodePacked(bundle: PackedSplats, i: number, out: Splat, encoding = Splats.packedEncodingOf(bundle)): Splat {
return packedCodec(encoding).decode(bundle.channels.packed.data, i * 4, out);
}
// --- Any layout, by the bundle's type ---
// The standard 3DGS fields of splat i (cov splats are diagonalized)
static load(bundle: SplatBundle, i: number, out: Splat): Splat {
if (isExtBundle(bundle)) {
const { a, f, b } = extWords(bundle);
return loadExtFields(a, f, b, i * 4, out);
}
if (isCovBundle(bundle)) {
return Splats.fromCov(Splats.decodeCov(bundle, i, covScratch), out);
}
return Splats.decodePacked(bundle, i, out);
}
// Writes the standard 3DGS fields; ext keeps its PBR bits, cov its normal
static store(bundle: SplatBundle, i: number, s: Splat) {
if (isExtBundle(bundle)) {
const { a, f, b } = extWords(bundle);
storeExtFields(a, f, b, i * 4, s);
} else if (isCovBundle(bundle)) {
const { a, f, b } = covWords(bundle);
storeCovFields(a, f, b, i * 4, s.center, SplatMath.covFromScaleQuat(s.scales, s.quaternion, covScratch.cov), s.rgb, s.opacity);
} else {
Splats.encodePacked(bundle, i, s);
}
}
static loadPbr(bundle: ExtSplats, i: number, out: Pbr): Pbr {
return loadExtPbr(bundle.channels.extA.data, bundle.channels.extB.data, i * 4, out);
}
// Writes the PBR fields; keeps the 3DGS bits
static storePbr(bundle: ExtSplats, i: number, p: Pbr) {
storeExtPbr(bundle.channels.extA.data, bundle.channels.extB.data, i * 4, p);
}
static loadCenter(bundle: SplatBundle, i: number, out: Vec3): Vec3 {
if (isExtBundle(bundle)) {
return loadCenterA(Encoding.floatView(bundle.channels.extA.data), i * 4, out);
}
if (isCovBundle(bundle)) {
return loadCenterA(Encoding.floatView(bundle.channels.covA.data), i * 4, out);
}
const data = bundle.channels.packed.data;
out.x = Encoding.decodeHalf(data[i * 4 + 1] & 0xffff);
out.y = Encoding.decodeHalf(data[i * 4 + 1] >>> 16);
out.z = Encoding.decodeHalf(data[i * 4 + 2] & 0xffff);
return out;
}
// The encoder of the bundle's layout, made once for a loop over splats:
// (i, s) writes every field the layout stores (ext all of them, cov the
// covariance and normal, packed the 3DGS fields in its encoding)
static encoder(bundle: SplatBundle): (i: number, s: ExtSplat) => void {
if (isExtBundle(bundle)) {
const { a, f, b } = extWords(bundle);
return (i, s) => encodeExtWords(a, f, b, i * 4, s);
}
if (isCovBundle(bundle)) {
const { a, f, b } = covWords(bundle);
const cov = Splats.makeCovSplat();
return (i, s) => {
Splats.toCov(s, cov);
cov.normal.x = s.normal.x;
cov.normal.y = s.normal.y;
cov.normal.z = s.normal.z;
encodeCovWords(a, f, b, i * 4, cov);
};
}
const data = bundle.channels.packed.data;
const codec = packedCodec(Splats.packedEncodingOf(bundle));
return (i, s) => codec.encode(data, i * 4, s);
}
// The decoder of the bundle's layout: (i, out) fills every field, with the
// defaults for those the layout lacks (no normal, roughness 1, metallic 0)
static decoder(bundle: SplatBundle): (i: number, out: ExtSplat) => ExtSplat {
if (isExtBundle(bundle)) {
const { a, f, b } = extWords(bundle);
return (i, out) => decodeExtWords(a, f, b, i * 4, out);
}
const noPbr = (out: ExtSplat, normal?: Vec3) => {
out.normal.x = normal?.x ?? 0;
out.normal.y = normal?.y ?? 0;
out.normal.z = normal?.z ?? 0;
out.roughness = 1;
out.metallic = 0;
return out;
};
if (isCovBundle(bundle)) {
const { a, f, b } = covWords(bundle);
const cov = Splats.makeCovSplat();
return (i, out) => {
Splats.fromCov(decodeCovWords(a, f, b, i * 4, cov), out);
return noPbr(out, cov.normal);
};
}
const data = bundle.channels.packed.data;
const codec = packedCodec(Splats.packedEncodingOf(bundle));
return (i, out) => noPbr(codec.decode(data, i * 4, out) as ExtSplat);
}
// --- Conversions ---
// The covariance of s; out.normal is left as is
static toCov(s: Splat, out: CovSplat): CovSplat {
out.center.x = s.center.x;
out.center.y = s.center.y;
out.center.z = s.center.z;
out.rgb.r = s.rgb.r;
out.rgb.g = s.rgb.g;
out.rgb.b = s.rgb.b;
out.opacity = s.opacity;
SplatMath.covFromScaleQuat(s.scales, s.quaternion, out.cov);
return out;
}
// Diagonalizes the covariance; the normal is dropped
static fromCov(c: CovSplat, out: Splat): Splat {
const { values, basis } = SplatMath.symEigens(c.cov);
out.center.x = c.center.x;
out.center.y = c.center.y;
out.center.z = c.center.z;
out.rgb.r = c.rgb.r;
out.rgb.g = c.rgb.g;
out.rgb.b = c.rgb.b;
out.opacity = c.opacity;
out.scales.x = Math.sqrt(Math.max(values.x, 0));
out.scales.y = Math.sqrt(Math.max(values.y, 0));
out.scales.z = Math.sqrt(Math.max(values.z, 0));
SplatMath.basisToQuat(basis, out.quaternion);
return out;
}
}