Binding the OTIO C API to Rust

.devcontainer/devcontainer.json

@@ -0,0 +1,26 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/docker-existing-dockerfile
+{
+ "name": "Existing Dockerfile",
+
+ // Sets the run context to one level up instead of the .devcontainer folder.
+ "context": "..",
+
+ // Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
+ "dockerFile": "../Dockerfile",
+
+ // Use 'forwardPorts' to make a list of ports inside the container available locally.
+ // "forwardPorts": [],
+
+ // Uncomment the next line to run commands after the container is created - for example installing curl.
+ // "postCreateCommand": "apt-get update && apt-get install -y curl",
+
+ // Uncomment when using a ptrace-based debugger like C++, Go, and Rust
+ // "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],
+
+ // Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
+ // "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ],
+
+ // Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
+ "remoteUser": "vfxrs"
+}

.gitignore

@@ -12,3 +12,6 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+
+# Editor
+.vscode/

Cargo.toml

@@ -1,10 +1,5 @@
-[package]
-name = "opentimelineio-bind"
-version = "0.1.0"
-build = "build.rs"
-edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
-libc = "0.2"
+[workspace]
+members = [
+ "opentimelineio",
+ "opentimelineio-sys",
+]

Dockerfile

@@ -0,0 +1,66 @@
+FROM aswf/ci-otio:2022.2
+
+ARG USERNAME=vfxrs
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+
+# Create the user
+RUN groupadd --gid $USER_GID $USERNAME && \
+ useradd --uid $USER_UID --gid $USER_GID -m $USERNAME && \
+ echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME && \
+ chmod 0440 /etc/sudoers.d/$USERNAME
+
+# Install Rust
+ENV RUSTUP_HOME=/usr/local/rustup \
+ CARGO_HOME=/usr/local/cargo \
+ PATH=/usr/local/cargo/bin:$PATH \
+ RUST_VERSION=1.63.0 \
+ RUST_ARCH=x86_64-unknown-linux-gnu \
+ RUST_ANALYZER_VERSION=2022-09-12
+RUN curl -O "https://static.rust-lang.org/rustup/archive/1.25.1/${RUST_ARCH}/rustup-init" && \
+ chmod +x rustup-init && \
+ ./rustup-init -y --no-modify-path --profile default --default-toolchain $RUST_VERSION --default-host ${RUST_ARCH} && \
+ rm rustup-init && \
+ chmod -R a+w $RUSTUP_HOME $CARGO_HOME && \
+ chgrp -R $USERNAME $RUSTUP_HOME $CARGO_HOME && \
+ rustup --version && \
+ cargo --version && \
+ rustc --version
+
+# Install Rust Analyzer
+RUN cd /tmp && \
+ git clone https://github.com/rust-lang/rust-analyzer.git && \
+ cd rust-analyzer && \
+ git checkout $RUST_ANALYZER_VERSION && \
+ cargo xtask install --server && \
+ cd ../ && \
+ rm -rf rust-analyzer
+# Gets installed to /usr/local/cargo/bin/rust-analyzer
+
+# # Compile OpenTimelineIO
+ENV OTIO_VERSION=v0.14.1 \
+ COTIO_VERSION=9745fe5911d3d6495184da1ce3a6efba1d68b389
+RUN mkdir -p /tmp/otio
+# Compile OpenTimelineIO C bindings
+RUN cd /tmp/otio && \
+ git clone --recurse-submodules https://github.com/OpenTimelineIO/OpenTimelineIO-C-Bindings.git && \
+ cd OpenTimelineIO-C-Bindings && \
+ git checkout $COTIO_VERSION && \
+ mkdir build && \
+ cd build && \
+ cmake -DCMAKE_INSTALL_PREFIX=/opt/otio -DCOTIO_SHARED_LIBS=ON ../ && \
+ make -j $(nproc --all) && \
+ make install && \
+ cp /tmp/otio/OpenTimelineIO-C-Bindings/include/copentimelineio/typeInfo.h /opt/otio/include/copentimelineio/typeInfo.h
+# Cleanup
+RUN rm -rf /tmp/otio
+
+ENV LD_LIBRARY_PATH=/usr/local/lib:/usr/local/lib64:$LD_LIBRARY_PATH
+
+# Add useful tools
+RUN rustup component add llvm-tools-preview && \
+ cargo install bindgen && \
+ cargo install cargo-valgrind && \
+ cargo install cargo-llvm-cov
+
+USER $USERNAME

README.md

@@ -33,3 +33,11 @@ Cloning into 'opentimelineio-bind'...
 ```
 > cargo build
 ```
+
+Testing
+
+```bash
+clear && LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/otio/lib:/opt/otio/lib64 cargo llvm-cov --html
+clear && LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/otio/lib:/opt/otio/lib64 cargo valgrind test
+
+```

opentimelineio-sys/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "opentimelineio-sys"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

opentimelineio-sys/bindgen.py

@@ -0,0 +1,27 @@
+import os
+import subprocess
+import sys
+from pathlib import Path
+
+_SYS_SRC_PATH = Path(os.path.dirname(__file__)) / "src"
+
+
+def main(include_dir: Path):
+ rust_path = _SYS_SRC_PATH / "lib.rs"
+ header_path = _SYS_SRC_PATH / "lib.h"
+
+ subprocess.check_call(
+ [
+ "bindgen",
+ "-o",
+ str(rust_path),
+ str(header_path),
+ "--",
+ f"-I{str(include_dir)}",
+ ],
+ cwd=_SYS_SRC_PATH,
+ )
+
+
+if __name__ == "__main__":
+ main(Path(sys.argv[1]))

opentimelineio-sys/build.rs

@@ -0,0 +1,7 @@
+fn main() {
+ // TODO: Use proper way to get the search paths and libraries.
+ println!("cargo:rustc-link-search=native=/opt/otio/lib");
+ println!("cargo:rustc-link-search=native=/opt/otio/lib64");
+ println!("cargo:rustc-link-lib=dylib=copentime");
+ println!("cargo:rustc-link-lib=dylib=copentimelineio");
+}

opentimelineio-sys/src/lib.h

@@ -0,0 +1,56 @@
+#pragma once
+
+// #include <cmocka.h>
+// #include <cmocka_pbc.h>
+
+#include <copentime/errorStatus.h>
+#include <copentime/optionalOpenTime.h>
+#include <copentime/rationalTime.h>
+#include <copentime/timeRange.h>
+#include <copentime/timeTransform.h>
+
+#include <copentimelineio/any.h>
+#include <copentimelineio/anyDictionary.h>
+#include <copentimelineio/anyVector.h>
+#include <copentimelineio/clip.h>
+#include <copentimelineio/composable.h>
+#include <copentimelineio/composableRetainerVector.h>
+#include <copentimelineio/composableVector.h>
+#include <copentimelineio/composition.h>
+#include <copentimelineio/deserialization.h>
+#include <copentimelineio/effect.h>
+#include <copentimelineio/effectRetainerVector.h>
+#include <copentimelineio/effectVector.h>
+#include <copentimelineio/errorStatus.h>
+#include <copentimelineio/externalReference.h>
+#include <copentimelineio/freezeFrame.h>
+#include <copentimelineio/gap.h>
+#include <copentimelineio/generatorReference.h>
+#include <copentimelineio/item.h>
+#include <copentimelineio/linearTimeWarp.h>
+#include <copentimelineio/mapComposableTimeRange.h>
+#include <copentimelineio/marker.h>
+#include <copentimelineio/markerRetainerVector.h>
+#include <copentimelineio/markerVector.h>
+#include <copentimelineio/mediaReference.h>
+#include <copentimelineio/missingReference.h>
+#include <copentimelineio/optionalPairRationalTime.h>
+#include <copentimelineio/retainerPairComposable.h>
+#include <copentimelineio/safely_typed_any.h>
+#include <copentimelineio/serializableCollection.h>
+#include <copentimelineio/serializableObject.h>
+#include <copentimelineio/serializableObjectRetainerVector.h>
+#include <copentimelineio/serializableObjectVector.h>
+#include <copentimelineio/serializableObjectWithMetadata.h>
+#include <copentimelineio/serialization.h>
+#include <copentimelineio/stack.h>
+#include <copentimelineio/stackAlgorithm.h>
+#include <copentimelineio/timeEffect.h>
+#include <copentimelineio/timeline.h>
+#include <copentimelineio/track.h>
+#include <copentimelineio/trackAlgorithm.h>
+#include <copentimelineio/trackVector.h>
+#include <copentimelineio/transition.h>
+#include <copentimelineio/typeInfo.h>
+#include <copentimelineio/typeRegistry.h>
+#include <copentimelineio/unknownSchema.h>