diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2b7f7e6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing + +Setup is in the [README](README.md) and [DEVELOPING](docs/DEVELOPING.md). You need Bun, and uv for +Python. + +Before opening a PR: + +```sh +bun run format:check +bun run lint:python +bun run test +``` + +If you touch walking, XR, audio or the interactive scene, run the matching browser check from +DEVELOPING too. + +- One thing per PR. +- No footage, generated scenes, weights, run outputs, screenshots or credentials in Git. Media goes + in shared storage (`docs/shared-assets.md`). +- No per-clip constants in runtime code; use scene manifests. +- Don't weaken or delete tests to get green. +- Label invented geometry and appearance. Check visual changes in the real viewer. +- New models or libraries get a row in [docs/licences.md](docs/licences.md). + +Contributions are licensed under Apache-2.0. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..57bc88a --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + 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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/README.md b/README.md index cefc7b4..b47360a 100644 --- a/README.md +++ b/README.md @@ -132,3 +132,7 @@ Aayan Karmali, Austin Jian, Daniel Pu and James Li. The Tears of Steel scene uses excerpts of **(CC) Blender Foundation | [mango.blender.org](https://mango.blender.org/)**, [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/). Phone clips are our own footage. Movie excerpts used in testing are not redistributed here. + +## License + +Apache-2.0. Some models the pipeline uses are research-only; see [licences](docs/licences.md). diff --git a/docs/licences.md b/docs/licences.md new file mode 100644 index 0000000..de5bc7f --- /dev/null +++ b/docs/licences.md @@ -0,0 +1,50 @@ +# Licences + +Our code is Apache-2.0. The models and libraries below keep their own terms, and several are +research-only, so worlds from the full pipeline can't be used commercially yet. + +"Verify" means we haven't confirmed the terms. Check upstream before relying on any row. + +## Pipeline components + +| Component | Used for | Where | Terms | +| ---------------------------------------------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| Pi3X weights (`yyfz233/Pi3X`) | Cameras and depth | `worker/stages/dense_pi3x.py` | Non-commercial (CC BY-NC) | +| SegFormer-b0 (`nvidia/segformer-b0-finetuned-ade-512-512`) | People masks for room cleaning, every run | `worker/wander_worker/masks.py` | Non-commercial (NVIDIA Source Code License) | +| Mask R-CNN (torchvision) | Person prep and tracking | `worker/stages/track_people.py` | BSD-3-Clause | +| LaMa via simple-lama-inpainting | Filling where people stood | `worker/modal_clean_video.py` | Apache-2.0 | +| World Labs Marble | Room generation | `scripts/marble_world.py` | Paid API; World Labs terms govern outputs | +| OpenAI API | World prompt, VLM judge, character voice | `scripts/world_prompt.py`, `worker/stages/vlm_judge.py`, `server/bottle-agent.ts` | Paid API | +| LHM (`3DAIGC/LHM-500M-HF`) | Animated person avatars | `worker/modal_lhm.py` | Code Apache-2.0; weights and bundled priors: verify (likely includes Sapiens, CC BY-NC) | +| SMPL-X body model | Person pose and shape | `worker/modal_lhm.py`, `worker/stages/lhm_animate.py` | Non-commercial (MPI licence) | +| Multi-HMR | Per-person pose | `worker/stages/track_people.py` | Non-commercial (CC BY-NC-SA 4.0) | +| GVHMR outputs | World-space body motion | `scripts/package_multiperson.py` | Verify | +| GFPGAN, facexlib, BasicSR | Face restoration for avatars | `worker/modal_lhm.py` | Apache-2.0 / MIT / Apache-2.0; verify weights | +| diff-gaussian-rasterization, simple-knn | Gaussian rendering in LHM and image-to-3D | `worker/modal_lhm.py`, `worker/modal_image_to_3d.py` | Non-commercial (Inria Gaussian-Splatting licence) | +| nvdiffrast | Rasterization in image-to-3D | `worker/modal_image_to_3d.py` | Non-commercial (NVIDIA Source Code License) | +| mip-splatting | Image-to-3D | `worker/modal_image_to_3d.py` | Non-commercial (Inria-derived); verify | +| TRELLIS | Object image-to-3D | `worker/modal_image_to_3d.py` | MIT | +| Stable Diffusion XL base | Object image-to-3D | `worker/modal_image_to_3d.py` | CreativeML OpenRAIL++-M (use restrictions) | +| PyTorch3D | Geometry utilities | worker images | BSD-3-Clause | +| gsplat | Optional fine-tune against real frames | `scripts/finetune_*.py` | Apache-2.0 | +| VGGT, V-DPM | Abandoned experiments still in `worker/modal_motion.py` | `worker/stages/vdpm_person.py` | VGGT non-commercial; V-DPM verify. Slated for removal | + +## Viewer + +| Component | Terms | +| --------------------------- | ---------- | +| three.js | MIT | +| Spark (`@sparkjsdev/spark`) | MIT | +| webxr-polyfill | Apache-2.0 | +| OpenAI Agents SDK | MIT | + +## Footage + +Tears of Steel: (CC) Blender Foundation, CC BY 3.0. Phone clips are our own. Neither phone clips +nor movie excerpts are redistributed. Get consent from anyone rebuilt as an avatar. + +## Possible replacements + +- SegFormer: Mask R-CNN or SAM +- Pi3X: MapAnything or Depth Anything 3 (Apache checkpoints) +- SMPL-X: SAM 3D Body + MHR