USD File Format Plugins

These USD file-format-plugins allow the interchange between Pixar's USD (.usd, .usda, .usdz) and the following file formats, with cross platform support (windows, macos, and linux):

Each file format's readme contains what they support.

Supported features legend:

    ✅ Supported
    ⚠️ Supported with known issues
    ❌ Not supported
    ⦸ Not applicable/no support planned

Dependencies

The following tools are needed:

• C/C++ compiler (MSVC 19/22, GCC, Clang, Xcode)
• clang-format 16.0.0
• Python 3.10
• CMake 3.24
• Doxygen 1.9.8

The following dependencies are needed:
|Dependency|Version|Affects|Optional|
|--|--|--|--|
| Pixar USD | 23.08 | all | no |
| GTest | 1.11.0 | all tests | yes |
| Eigen | 3.4.0 | usdply, usdspz | no |
| FBX SDK | 2020.3.7 | usdfbx | no |
| LibXml2 | 2.10.0 | usdfbx | no |
| Zlib | 1.2.11 | usdfbx, usdgltf | no |
| TinyGltf | 2.8.21 | usdgltf | no |
| Draco | 1.56 | usdgltf | yes |
| Fmt | 10.1.1 | usdobj | no |
| FastFloat | 1.1.2 | usdobj | no |
| Happly | cfa2611 | usdply | no |
| Spherical Harmonics | ccb6c7f | usdply, usdspz | no |
| Spz | fd4e2a5 | usdspz | no |
| Substance | 9.1.2 | usdsbsar | no |

Build

1. Setup dependencies

• Install a C/C++ compiler.

• Install clang-format.

• Install cmake.

• Install python and the following pip components: pyside6, pyopengl.

• Build and install USD entering in a terminal (in windows a x64 Native Tools Command prompt):

    python /build_scripts/build_usd.py  --onetbb --no-examples --draco --openimageio --build-variant release

  --no-examples is needed to omit the example plugin usdObj that ships with USD from the install, as it will conflict with our usdObj plugin.

  Add --build-target universal for universal binaries in macos.

  If adding --openimageio you may need these fixes:

  • https://github.com/PixarAnimationStudios/OpenUSD/pull/2517
  • https://github.com/PixarAnimationStudios/OpenUSD/pull/2079

  Setup USD environment variables:

  • /bin to PATH
  • /lib to PATH in windows, or to LD_LIBRARY_PATH in linux, mac
  • /lib64 to LD_LIBRARY_PATH in linux
  • /lib/python to PYTHONPATH

  In linux you may need these other dependencies:

    sudo apt update
    sudo apt install libgl1-mesa-dev mesa-common-dev

• Install FBX SDK.

• You can install GTest, ZLIB, TinyGltf, Draco, fmt, FastFloat, Happly and OpenImageIO, or let cmake fetch them in the next steps (except for OpenImageIO). Also, you can leverage the installation of ZLIB, Draco and OpenImageIO included in USD.

• Substance SDK Integration

  1. Download the SDK: Visit the Adobe Developer Console and log in or create an account if necessary.
  2. Locate the SDK: Use the search bar to find the ‘Adobe Substance 3D Materials SDK’. Version 9.1.2

2. Get it

git clone https://github.com/adobe/USD-Fileformat-plugins

3. Configure, build and install it

To configure, build and install go to the project root folder and,
using a multi-configuration backend (MSVC, ...) enter:

cmake -S . -B build -DCMAKE_INSTALL_PREFIX=bin 
cmake --build   build --config release
cmake --install build --config release

or using a single-configuration backend (Make, ...) enter:

cmake -S . -B build -DCMAKE_INSTALL_PREFIX=bin -DCMAKE_BUILD_TYPE=Release 
cmake --build   build
cmake --install build

where:

• `` is a list of extra options, as follows:

ZLIB, Draco and OpenImageIO packages are hinted to search into the USD installation by default. Override this by setting their ROOT or their FETCH variables (no fetch for OIIO).

The previous commands will place intermediate files into the folder build and install binaries into the folder bin.
Also, make the plugins discoverable by USD to complete installation, by adding the path /plugin/usd to the PXR_PLUGINPATH_NAME environment variable (in this example: USD-Fileformat-plugins/bin/plugin/usd).

• Note when building on Linux: -DUSD_FILEFORMATS_ENABLE_CXX11_ABI=ON

Test (https://github.com/pages/adobe/USD-Fileformat-plugins)

• Requires USD built with "--openimageio"

  For Windows/Mac:

  python ./USD/build_scripts/build_usd.py ./usd-install  --build-shared --usd-imaging --tools --generator  --openimageio --build-variant release

  For Linux:

  python ./USD/build_scripts/build_usd.py ./usd-install  --use-cxx11-abi=1 --build-shared --usd-imaging --tools --generator  --openimageio --build-variant release

1. Install pip components

• Open your terminal and run the following commands to install the required Python packages:

  pip install -r scripts/requirements.txt

2. Install Plugins (Environment variables or Copy plugins to USD install)

Environment Variables

For Windows:

  set PATH=%PATH%;.\USD-Fileformat-plugins\bin\bin;.\USD-Fileformat-plugins\bin\plugin\usd
  set PXR_PLUGINPATH_NAME=%PXR_PLUGINPATH_NAME%;.\USD-Fileformat-plugins\bin\plugin\usd

For Linux

  export PATH=$PATH:./USD-Fileformat-plugins/bin/bin:./USD-Fileformat-plugins/bin/plugin/usd
  export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:./USD-Fileformat-plugins/bin/lib:./USD-Fileformat-plugins/bin/lib64
  export PXR_PLUGINPATH_NAME=$PXR_PLUGINPATH_NAME:./USD-Fileformat-plugins/bin/plugin/usd

For Mac

  export PATH=$PATH:./USD-Fileformat-plugins/bin/bin:./USD-Fileformat-plugins/bin/plugin/usd
  export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:./USD-Fileformat-plugins/bin/lib
  export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:./USD-Fileformat-plugins/bin/lib
  export PXR_PLUGINPATH_NAME=$PXR_PLUGINPATH_NAME:./USD-Fileformat-plugins/bin/plugin/usd

Or Copy plugins:

• Copy the installed plugins and dependent shared libraries to the specified folder:

  mkdir -p ./LOCAL_USD_INSTALL/plugin/usd
  cp -r ./USD-Fileformat-plugins/bin/plugin/usd/* ./LOCAL_USD_INSTALL/plugin/usd/
  cp ./USD-Fileformat-plugins/bin/bin/* ./LOCAL_USD_INSTALL/plugin/usd/

3. Run Tests

• Dependencies

  pip install -r ../USD-Fileformat-plugins/scripts/requirements.txt

• Use pytest to run the tests:

  pytest ./USD-Fileformat-plugins/test/test.py

4. (Optional) Update Tests

• To generate new baseline data for tests, run the following command:

  python ./USD-Fileformat-plugins/test/test.py --generate_baseline

CI Workflow

Our GitHub Actions setup includes two main workflows to support continuous integration.

1. CI Build Workflow

This workflow is triggered by any push or pull request to the main branch and ensures compatibility with Universal Scene Description (USD) versions:

• Versions Tested: Builds against the oldest (23.08) and newest (24.05) supported USD versions regularly.
• Weekly Builds: The workflow builds against all supported USD versions to confirm ongoing compatibility.
• Post-Build Testing: Following the build, each plugin undergoes sanity testing, including loading a cube to check basic functionality.
• Supported Plugins: Currently supports FBXm GLTF, OBJ, PLY, and STL. Note: SBSAR plugin is not supported due to SDK constraints.
  • Individual plugin build result badges are on their respective README pages.

2. Create USD Release Workflow

This manually triggered workflow involves the following steps:

• Build Specification: Takes a specific USD version as input, builds USD with OpenImageIO, and then creates a release.
• Archiving: Compiled USD builds are archived per platform and added as binary data to the release, which keeps the repository's clone size manageable.
• Environment Setup: After downloading and expanding the release archive, users should configure their environment as follows:
  • In the following steps USD_DIR is the directory where the release archive was expanded.
  • Add USD_DIR\lib and USD_DIR\bin to your PATH in windows, or to LD_LIBRARY_PATH in linux, mac
  • Set PYTHONPATH to USD_DIR\lib\python.
  • Set USD_BUILD_DIR as USD_DIR.

Usage

USD will now be able to work with the supported files, for example:

• Use the USD tools on fbx:

  usdview           # Converts FBX to USD
  usdcat            # Converts FBX to USD
  usdcat  -o   # Converts USD to FBX

• Use the C++ USD API:

  #include 
  UsdStageRefPtr stage = UsdStage::Open("cube.fbx")
  stage->Export("cube.usd")

• Use the Python USD API:

  from pxr import Usd
  stage = Usd.Stage.Open("cube.fbx")
  stage.Export("cube.usd")

Refer to each plugin's README for more details.

Documentation

To generate the documentation go to the project root folder and enter:

doxygen

The resulting documentation will be placed at the docs folder.