Skip to content

xuzhaozheng/ilpd-extract

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ilpd-extract

English简体中文

ILPD (Immersive Lens Profile Data) is a file format used in the Apple Immersive Video production system to describe the imaging characteristics of immersive cameras and lenses. It is essentially a JSON file with the .ilpd extension.

ILPD files are typically provided by immersive camera manufacturers and may be embedded in original camera files (such as .braw). Extracted ILPD files can be used to generate AIME files or STMap.

BRAW to ILPD Extractor

A command-line tool for extracting ILPD from Blackmagic RAW files created with URSA Cine Immersive. Currently, only the macOS version is available.

macOS Dependencies

  • Blackmagic RAW SDK for macOS, version 5.0 or above
  • Xcode Command Line Tools or Xcode
  • CMake 3.10 or above
  • CoreFoundation framework

How to Run

Before you start, please make sure you have downloaded and installed the correct version of the Blackmagic RAW SDK. Download it from the Blackmagic Developer Website.

For macOS, the SDK is located at /Applications/Blackmagic RAW/Blackmagic RAW SDK.

Then choose one of the following methods:

  • Use the pre-built version in the Release

    • macOS: Copy Blackmagic RAW SDK/Mac/Libraries/BlackmagicRawAPI.framework next to the braw2ilpd executable.
  • Build the binary yourself: You can customize the SDK location and specify it in CMakeLists.txt. The current CMakeLists.txt assumes the Blackmagic RAW SDK folder is in the project root.

Basic Usage

# Extract ILPD with automatic naming (recommended)
./braw2ilpd <input.braw>
# Creates: [cameraID].[uuid].ilpd in current directory

# Specify custom ilpd filename
./braw2ilpd <input.braw> -o <custom_profile_name.ilpd>
# Creates: custom_profile_name.ilpd in current directory

# Specify output directory (keeps automatic naming)
./braw2ilpd <input.braw> -o </path/to/output/>
# Creates: /path/to/output/[cameraID].[uuid].ilpd

# Extract with detailed attributes file
./braw2ilpd <input.braw> -a
# Creates two files:
# [cameraID].[uuid].ilpd
# [cameraID].[uuid]_detailed_attributes.txt

Parameters

  • <input.braw>: Path to the input Blackmagic RAW immersive video file
  • -o, --output <path>: Specify output file or directory. If omitted, uses automatic naming ([cameraID].[uuid].ilpd)
  • -a, --all: Optional parameter to also generate a detailed immersive attributes txt file
  • -v, --verbose: Enable verbose logging
  • -s, --silent: Suppress non-error output
  • -h, --help: Show help message

Supported Attributes

The *_detailed_attributes.txt file contains the following BRAW immersive video attributes:

Attribute Description
OpticalLensProcessingDataFileUUID UUID of the ILPD file
OpticalILPDFileName ILPD file name in camera
OpticalInteraxial Lens optical axis distance
OpticalProjectionKind Projection type ('fish' indicates Apple Immersive Video)
OpticalCalibrationType Calibration type ('meiRives' indicates ILPD lens projection)
OpticalProjectionData Actual ILPD data content

Development

1. Clone/Download the Project

git clone <repository-url>
cd ilpd-extract

2. Download Blackmagic RAW SDK

Download the Blackmagic RAW SDK and make sure BRAW_SDK_PATH in CMakeLists.txt points to the SDK location.

3. Build with CMake

mkdir build
cd build
cmake ..
make

The executable braw2ilpd will be generated in the build directory.

License

This project uses the Blackmagic RAW SDK. For license information, please refer to the SDK license files in Blackmagic RAW SDK/Documents/.

Known Issues

  • For some BRAW files, the extracted OpticalInteraxial value is 0. This may be caused by a camera firmware bug or an issue with the current reading method.
  • In DaVinci Resolve Studio 20.1, ILPD files need to follow the a.b.ilpd naming format to be designated to media pool clips. Therefore, using automatic naming is recommended (check the Calibration File Name, Calibration UUID and other options in Media Pool clip properties for more details).

References

About

Tools to extract ILPD data for Apple Immersive Video from camera footage.

Resources

License

Stars

Watchers

Forks

Languages