diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..2b14c75 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,178 @@ +Copyright [2024] [drumath2237(Kaito Tsutsumi)] + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/README.md b/README.md index 0a3013f..46be190 100644 --- a/README.md +++ b/README.md @@ -1 +1,155 @@ -# spz-wasm +

+

+ ๐ŸฆŽ
spz-loader +

+

+ +

+ + + +
+ + +

+ +## About + + + +spz-loader is a set of npm packages for loading .spz, a type of 3D Gaussian Splatting file format. For more information on the .spz format, see [the blog post](https://scaniverse.com/news/spz-gaussian-splat-open-source-file-format) published by Niantic and the [GitHub repository](https://github.com/nianticlabs/spz). + + + +spz-loader provides `@spz-loader/core`, which is a pure decoding facility using `nianticlabs/spz` converted to wasm by Emscripten, and loader packages for various platforms that depend on it. + +## Install & Usage + +### For Web3D Engines (example for Babylon.js) + +Install like below. `@spz-loader/babylonjs` requires Babylon.js version 7 or later. + +```sh +# for npm +npm i -D @babylonjs/core @spz-loader/babylonjs + +# for pnpm +pnpm add -D @babylonjs/core @spz-loader/babylonjs +``` + +Code example of ESModule or TypeScript. + + +```ts +import "./style.css"; + +import { Engine, Scene } from "@babylonjs/core"; +import { createGaussianSplattingFromSpz } from "@spz-loader/babylonjs"; + +// .spz file path/url +import spzPath from "../assets/hornedlizard.spz?url"; + +const engine = new Engine(renderCanvas); +const scene = new Scene(engine); + +// ... + +const spzBuffer = await fetch(spzPath).then((res) => res.arrayBuffer()); +const splat = await createGaussianSplattingFromSpz(spzBuffer, scene); +``` + +### Core package + +Install like below. + +```sh +# for npm +npm i -D @spz-loader/core + +# for pnpm +pnpm add -D @spz-loader/core +``` + +Usage example of core package. + +```ts +import { loadSpz } from "@spz-loader/core"; + +import spzUrl from "../assets/racoonfamily.spz?url"; + +const spzBuffer = await fetch(spzUrl) + .then((res) => res.arrayBuffer()) + .then((buf) => new Uint8Array(buf)); + +const splat = await loadSpz(spzBuffer); + +console.log(splat.numPoints); +``` + +## Developing spz-loader + +### Environment + +Project author's local environment is below. + +- Windows 11 Home +- Node.js 20.18.1 +- pnpm 9.14.2 +- Docker Desktop + - with VSCode dev container +- Emscripten 3.1.72 (on docker) + +### Setup + +Clone this repo and submodule + +```sh +git clone https://github.com/drumath2237/spz-loader.git + +git submodule update --init --recursive +``` + +Repository structure is below. +spz-loader is a monorepo project setup by pnpm-workspace. + +```txt +/ +โ”œโ”€ packages/ +โ”‚ โ”œโ”€ core/ +โ”‚ โ”‚ โ””โ”€ lib/ +โ”‚ โ”‚ โ”œโ”€ spz-wasm/ +โ”‚ โ”‚ โ”‚ โ””โ”€ spz/ <-- submodule +โ”‚ โ”‚ โ”œโ”€ build.sh +โ”‚ โ”‚ โ””โ”€ index.ts +โ”‚ โ””โ”€ babylonjs/ +โ”‚ โ””โ”€ lib/ +โ”‚ โ””โ”€ index.ts +โ”œโ”€ package.json +โ”œโ”€ pnpm-lock.yaml +โ””โ”€ pnpm-workspace.yaml +``` + +To install dependencies, you can run `pnpm install` on the root directory. + +```sh +pnpm install +``` + +### Build packages + +Run build script `build:all`. +This command does follow: + +1. Build spz(C++) to WebAssembly by Emscripten on a Docker container +2. Build `@spz-loader/core` package by Vite library mode +3. Build `@spz-loader/babylonjs` package by Vite library mode + +```sh +pnpm build:all +``` + +## Author + +[@drumath2237](https://x.com/ninisan_drumath) \ No newline at end of file diff --git a/images/hornedlizard.gif b/images/hornedlizard.gif new file mode 100644 index 0000000..3247d20 Binary files /dev/null and b/images/hornedlizard.gif differ diff --git a/packages/babylonjs/lib/index.ts b/packages/babylonjs/lib/index.ts index 524afec..2a87b28 100644 --- a/packages/babylonjs/lib/index.ts +++ b/packages/babylonjs/lib/index.ts @@ -40,6 +40,13 @@ export const parseSpzToSplat = async ( const _convertGaussianCloudToSplatBuffer = ( gsCloud: GaussianCloud, ): ArrayBuffer => { + /** + * This section of the code is inspired by the implementation found in + * CedricGuillemet/Babylon.js, which is available under the Apache-2.0 License. + * See: + * https://github.com/CedricGuillemet/Babylon.js/blob/17f2f4a768e3dae50ccb1280f734522448879165/packages/dev/loaders/src/SPLAT/splatFileLoader.ts#L184-L308 + */ + // position(3*f32) + scale(3*f32) + color(4*u8) + rotation(4*u8) const rowOutputLength = 3 * 4 + 3 * 4 + 4 + 4; const splatCount = gsCloud.numPoints;