@adobe/spz

中文文档
0.2.3发布于 2026/09/02ISCTypeScriptCommonJS零依赖近 30 天下载 16.4万

WebAssembly module for loading Gaussian splat (SPZ) files

原始使用文档
文档目录24 节
  1. Internals
  2. Coordinate System
  3. Implementations
  4. C++
  5. Typescript
  6. API
  7. C++
  8. Typescript
  9. PackOptions
  10. File Format
  11. File layout (version 4)
  12. Header (version 4)
  13. Format detection (load path)
  14. Positions
  15. Scales
  16. Rotation
  17. Alphas
  18. Colors
  19. Spherical Harmonics
  20. Extensions
  21. Camera Orbit Limitation
  22. Python Bindings
  23. Installation
  24. Web Utility

spz

.spz is a file format for compressed 3D gaussian splats. This directory contains a C++ library for saving and loading data in the .spz format.

spz encoded splats are typically around 10x smaller than the corresponding .ply files, with minimal visual differences between the two.

Internals

Coordinate System

By default, SPZ stores data in an RUB coordinate system following the OpenGL and three.js convention. This can be overridden via the SPZ_ADOBE_coordinate_system extension, which allows data to be stored in any named coordinate system (see extensions/README.md). This differs from other data formats such as PLY (which typically uses RDF), GLB (which typically uses LUF), or Unity (which typically uses RUF). To aid with coordinate system conversions, callers should specify the coordinate system their Gaussian Cloud data is represented in when saving and what coordinate system their rendering system uses when loading. These are specified in the PackOptions and UnpackOptions respectively. If the coordinate system is UNSPECIFIED, data will be saved and loaded without conversion, which may harm interoperability.

There are 16 named coordinate systems organised in two families:

  • Standard family — letters denote the X, Y, Z axis directions (e.g. RUB = Right, Up, Back): LDB, RDB, LUB, RUB, LDF, RDF, LUF, RUF
  • Rotated family — axes are permuted by a 90-degree rotation about X (Y and Z are swapped): LFD, RFD, LFU, RFU, LBD, RBD, LBU, RBU

Converting between families applies a 90-degree rotation about the X axis in addition to any axis flips, which also rotates spherical-harmonics coefficients via the appropriate Wigner D-matrix.

Implementations

C++

Requires libz and libzstd as dependent libraries, otherwise the code is completely self-contained. A CMake build system is provided for convenience.

Note: If libz or libzstd are not found on the system, the CMake build system will automatically download them using FetchContent. This ensures consistent builds across different environments.

Typescript

To build the Typescript interface through Web-Assembly (WASM), an Emscripten environment needs to be setup before compilation. One may install the Emscripten SDK following the instructions here.

Under an emscripten environment, the Makefile can be generated through:

emcmake cmake -B build-wasm .

Then one can build through

cmake --build build-wasm

The package will be built and installed into the dist folder.

API

C++

bool saveSpz(
   const GaussianCloud &gaussians, const PackOptions &options, std::vector<uint8_t> *output);

Converts a cloud of Gaussians to .spz format and writes the result to a vector of bytes.

  • gaussians: The Gaussians to save
  • options: Flags that control the packing behavior, including SH quantization parameters.
  • output: A vector that will be populated with bytes encoded in .spz format
  • Returns true on success and false on failure.

bool saveSpz(
   const GaussianCloud &gaussians, const PackOptions &options, const std::string
&filename);

Saves a cloud of Gaussians in .spz format to a file

  • gaussians: The Gaussians to save
  • options: Flags that control the packing behavior, including SH quantization parameters.
  • filename: The path to the file to save to.
  • Returns true on success and false on failure.

GaussianCloud loadSpz(const std::vector<uint8_t> &data, const UnpackOptions &opti
ons);

Loads a cloud of Gaussians from bytes in .spz format.

  • data: A vector containing the encoded spz data
  • options: Flags that control the unpacking behavior.
  • Returns a GaussianCloud decoded from the vector. In case of an error, this will return a result with no gaussians

GaussianCloud loadSpz(const std::string &filename, const UnpackOptions &options);

Loads a cloud of Gaussians from a file in .spz format.

  • filename: The path to the file to load from.
  • options: Flags that control the unpacking behavior.
  • Returns a GaussianCloud decoded from the file. In case of an error, this will return a result with no gaussians

Typescript

Check src/emscripten/spz.d.ts.in (source) or dist/spz.d.ts (after building with CMake) for the TypeScript interface. Since the Emscripten and Javascript memory are separately handled, we only expose limited functionalities for the Typescript interface.

PackOptions

The PackOptions struct supports the following fields:

  • from: Source coordinate system (default: UNSPECIFIED)
  • version: Version of the packed format (default: 4)
  • sh1Bits: Number of quantization bits for SH degree 1 coefficients (default: 5, range: 1-8)
  • shRestBits: Number of quantization bits for SH degree 2+ coefficients (default: 4, range: 1-8)

File Format

Version 4 uses ZSTD compression with a 32-byte plaintext header. Each attribute stream is compressed independently and in parallel, improving both compression and decompression throughput. Files from versions 1–3 (gzip-compressed single-stream format) can still be read. There is no maximum point count enforced during loading.

File layout (version 4)

Bytes  0–31:              NgspFileHeader (32 bytes, plaintext)
Bytes  32..(tbo-1):       Extension ILV records, if flags & 0x2  (variable)
Bytes  tbo..(tbo+N*16-1): TOC — N × [compressedSize u64, uncompressedSize u64]
Bytes  (tbo+N*16)..end:   N independent ZSTD-compressed attribute streams

tbo = tocByteOffset from the header. When no extensions are present, tbo = 32.

Header (version 4)

struct NgspFileHeader {        // 32 bytes, all fields little-endian
  uint32_t magic;              // 0x5053474e ("NGSP")
  uint32_t version;            // 4
  uint32_t numPoints;
  uint8_t  shDegree;
  uint8_t  fractionalBits;
  uint8_t  flags;
  uint8_t  numStreams;         // number of ZSTD-compressed attribute streams (typically 6)
  uint32_t tocByteOffset;     // byte offset from file start to the TOC
  uint8_t  reserved[12];      // zero, reserved for future use
};

All values are little-endian.

  1. magic: Always 0x5053474e (bytes N, G, S, P in file order).
  2. version: 4 (current). Versions 1–3 use the legacy gzip format (read-only).
  3. numPoints: The number of gaussians.
  4. shDegree: The degree of spherical harmonics. Must be between 0 and 4 (inclusive).
  5. fractionalBits: The number of bits used for the fractional part of fixed-point coordinates.
  6. flags: Bit field.
    • 0x1: splat was trained with antialiasing.
    • 0x2: the header zone contains vendor-specific extension records (see Extensions).
  7. numStreams: Number of ZSTD-compressed attribute streams following the TOC. Typically 6 (positions, alphas, colors, scales, rotations, spherical harmonics).
  8. tocByteOffset: Byte offset from the start of the file to the Table of Contents. Everything before tocByteOffset is plaintext.
  9. reserved: Must be zero.

Format detection (load path)

bytes[0..3] == "NGSP"  →  version 4 ZSTD format
bytes[0..1] == 0x1f 0x8b  →  legacy gzip format (versions 1–3, read-only)

Positions

Positions are represented as (x, y, z) coordinates, each as a 24-bit fixed point signed integer. The number of fractional bits is determined by the fractionalBits field in the header.

Scales

Scales are represented as (x, y, z) components, each represented as an 8-bit log-encoded integer.

Rotation

In version 3 and 4, rotations are represented as the smallest three components of the normalized rotation quaternion, for optimal rotation accuracy. The largest component can be derived from the others and is not stored. Its index is stored on 2 bits and each of the smallest three components is encoded as a 10-bit signed integer.

In version 2, rotations are represented as the (x, y, z) components of the normalized rotation quaternion. The w component can be derived from the others and is not stored. Each component is encoded as an 8-bit signed integer.

Alphas

Alphas are represented as 8-bit unsigned integers.

Colors

Colors are stored as (r, g, b) values, where each color component is represented as an unsigned 8-bit integer.

Spherical Harmonics

Depending on the degree of spherical harmonics for the splat, this can contain 0 (for degree 0), 9 (for degree 1), 24 (for degree 2), 45 (for degree 3), or 72 (for degree 4) coefficients per gaussian.

The coefficients for a gaussian are organized such that the color channel is the inner (faster varying) axis, and the coefficient is the outer (slower varying) axis, i.e. for degree 1, the order of the 9 values is:

sh1n1_r, sh1n1_g, sh1n1_b, sh10_r, sh10_g, sh10_b, sh1p1_r, sh1p1_g, sh1p1_b

Each coefficient is represented as an 8-bit signed integer.

Quantization:

SPZ supports configurable spherical harmonics quantization. By default, a fixed-precision quantization is adopted:

  • Assumes SH coefficients are in the [-1, 1] range
  • Fixed 5 bits of precision for degree 1 and 4 bits for degrees 2, 3, and 4
  • Maintained for backward compatibility

The quantization precision can be configured via PackOptions:

  • sh1Bits: Number of quantization bits for SH degree 1 coefficients (default: 5, range: 1-8)
  • shRestBits: Number of quantization bits for SH degree 2+ coefficients (default: 4, range: 1-8)

Note: Quantization bits are only used during packing to reduce information entropy for better compression. The unpacking process does not need to know the exact quantization bits, as decompression fills zero bits for quantized data automatically.

This allows users to trade off between file size and quality. The library maintains full backward compatibility with default quantization settings.

Extensions

SPZ supports vendor-specific extensions (e.g. camera limits) so multiple vendors can coexist in the same file. In version 4, extensions are stored as ILV (type + length + value) records in the plaintext header zone between the fixed header and the TOC — parsers that don't recognize an extension type skip it by length. For the extension format and how to add or use extensions, see extensions/README.md.

Camera Orbit Limitation

With extension SPZ_ADOBE_safe_orbit_camera, SPZ supports storing camera limits which can be used to restrict the view in a render. This extension includes:

Attributes

This extension has the following attributes and default values:

  float safeOrbitElevationMin = 0.0f;  // Minimum elevation for safe orbit (radians)
  float safeOrbitElevationMax = 0.0f;  // Maximum elevation for safe orbit (radians)
  float safeOrbitRadiusMin = 0.0f;     // Minimum radius for safe orbit

Python Bindings

The SPZ library provides Python bindings built with nanobind that offer a convenient interface for loading, manipulating, and saving 3D Gaussian splats from Python.

Installation

git clone https://github.com/nianticlabs/spz.git
cd spz
pip install .

Please see src/python/README.md for more details and usage examples

Web Utility

A browser-based utility is available at nianticlabs.github.io/spz. It uses the latest WASM build and allows you to inspect file metadata for .spz and .ply files and convert between the two formats without installing anything. As it runs entirely in the browser, it is subject to browser memory limits and is intended for files up to around 2 GB. For larger files, clone the repository and use the command-line tools directly.

版本与发布记录

@adobe/spz 共发布 6 个版本,首次发布于 2026/03/26;过去 12 个月发布了 6 个版本。

版本发布日期距今
0.2.3latest2026/09/022 个月前
0.2.22026/05/145 个月前
0.2.12026/05/076 个月前
0.2.02026/04/106 个月前
0.1.92026/04/106 个月前
0.1.82026/03/267 个月前

关于 @adobe/spz 的常见问题

@adobe/spz 是什么?

WebAssembly module for loading Gaussian splat (SPZ) files

如何安装 @adobe/spz?

在项目目录运行 npm install @adobe/spz,或使用 pnpm add / yarn add / bun add。

@adobe/spz 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@adobe/spz 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@adobe/spz 可以商用吗?

@adobe/spz 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@adobe/spz 的下载量有多少?

根据 npm 官方下载统计,@adobe/spz 在 2026/10/05 – 2026/11/03 这 30 天内被下载 164,258 次,日均约 5,475 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@adobe/spz 还在维护吗?

最新版本 0.2.3 发布于 2026/09/02(2 个月前);至今共发布 6 个版本,其中过去 12 个月发布了 6 个;首次发布于 2026/03/26。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。