Merge pull request #77 from SoZ0/v0.6.0

Near Complete Parity with Libcamera (and support for v0.6.0)

Author: chemicstry

.github/workflows/ci.yaml

@@ -13,7 +13,7 @@ jobs:
     name: Build and test
     strategy:
       matrix:
-        libcamera_version: ["v0.4.0", "v0.5.0", "v0.5.1"]
+        libcamera_version: ["v0.4.0", "v0.5.0", "v0.5.1", "v0.5.2", "v0.6.0"]
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

Cargo.lock

@@ -12,6 +12,8 @@ Project structure:
   - [libcamera-meta](./libcamera-meta/) - Scripts for generating C and Rust code from libcamera controls, properties and formats YAMLs. Mostly used by the [regenerate.sh](./regenerate.sh) script.
   - [libcamera](./libcamera/) - Safe libcamera Rust interface on top of `libcamera-sys`.
 
+Code generation uses a cached clone under `libcamera-git`; run `cargo run --bin generate_from_git` (or `./regenerate.sh`) occasionally to fetch the latest upstream tags before regenerating `versioned_files`. These bindings intentionally track libcamera’s public, application-facing API; pipeline-handler internals aren’t surfaced.
+
 Unreleased documentation for `main`: [here](https://lit-robotics.github.io/libcamera-rs/libcamera/index.html)
 
 ## Building
@@ -133,6 +135,21 @@ FrameBuffer metadata: Immutable(
 Written 4147789 bytes to target/image.jpg
 ```
 
+Inspect generated pixel format constants and layout info ([code](./libcamera/examples/formats_constants.rs)):
+```console
+$ cargo run --example formats_constants
+Using constant formats::NV12 => NV12 (NV12)
+bits_per_pixel=12 planes=2 pixels_per_group=2
+frame size for 640x480 (align=0): 460800 bytes
+```
+
+Apply a generated pixel format constant to a stream configuration ([code](./libcamera/examples/configure_formats.rs)):
+```console
+$ cargo run --example configure_formats
+validate status: Valid
+configured: StreamConfigurationRef { pixel_format: NV12, size: Size { width: 640, height: 480 }, stride: 640, frame_size: 460800, buffer_count: 4, color_space: None }, stride=640 frame_size=460800
+```
+
 ## Notes on safety
 
 `libcamera-rs` is intended to be a fully memory-safe wrapper, however, due to `libcamera`'s complexity and many cross-references between objects it is quite hard to ensure total safety so there is very likely to be bugs. Issues and pull requests are welcome.

README.md

@@ -0,0 +1,44 @@
+# Minimal CI runner image that matches the GitHub Actions workflow.
+# Build per libcamera version:
+#   docker build -f docker/ci/Dockerfile --build-arg LIBCAMERA_VERSION=v0.5.1 -t libcamera-ci:v0.5.1 .
+#
+# Then run against your workspace:
+#   docker run --rm -v "$PWD:/workspace" -w /workspace libcamera-ci:v0.5.1 ./docker/ci/entrypoint.sh
+
+ARG UBUNTU_VERSION=22.04
+FROM ubuntu:${UBUNTU_VERSION}
+
+ARG LIBCAMERA_VERSION=v0.6.0
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Install build prerequisites for libcamera and Rust.
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+        build-essential git ninja-build pkg-config clang \
+        python3 python3-pip python3-jinja2 python3-yaml python3-ply \
+        libyaml-dev libssl-dev curl ca-certificates && \
+    rm -rf /var/lib/apt/lists/*
+
+# Meson from apt on 22.04 is too old for older libcamera tags; upgrade via pip.
+RUN pip3 install --no-cache-dir --upgrade pip meson
+
+# Install libcamera (matching the workflow: only vimc pipeline for speed).
+RUN git clone --depth 1 --branch ${LIBCAMERA_VERSION} https://git.libcamera.org/libcamera/libcamera.git /tmp/libcamera && \
+    cd /tmp/libcamera && \
+    meson build -Dipas=vimc -Dpipelines=vimc && \
+    ninja -C build install && \
+    rm -rf /tmp/libcamera
+
+# Install Rust toolchain (stable) with rustfmt/clippy.
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs \
+        | sh -s -- -y --profile minimal --component rustfmt,clippy && \
+    . "$HOME/.cargo/env" && \
+    rustc --version && cargo --version
+
+ENV PATH="/root/.cargo/bin:${PATH}"
+# Ensure pkg-config can find the installed libcamera.
+ENV PKG_CONFIG_PATH="/usr/local/lib/pkgconfig:/usr/local/lib/x86_64-linux-gnu/pkgconfig:${PKG_CONFIG_PATH}"
+
+WORKDIR /workspace
+COPY docker/ci/entrypoint.sh /usr/local/bin/entrypoint.sh
+ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]

docker/ci/Dockerfile

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Allow skipping doc build for speed/debugging.
+: "${RUN_DOCS:=true}"
+
+LIBCAMERA_VERSION=$(pkg-config --modversion libcamera || true)
+echo "Using libcamera from pkg-config: ${LIBCAMERA_VERSION}"
+
+# Keep build artifacts separate per libcamera version to avoid cross-version cache issues.
+if [ -z "${CARGO_TARGET_DIR:-}" ] && [ -n "${LIBCAMERA_VERSION}" ]; then
+  export CARGO_TARGET_DIR="target/${LIBCAMERA_VERSION}"
+fi
+echo "Using CARGO_TARGET_DIR=${CARGO_TARGET_DIR:-target}"
+
+cargo build
+cargo fmt --all -- --check
+cargo test
+cargo clippy --no-deps -- -D warnings
+
+if [ "$RUN_DOCS" = "true" ]; then
+  RUSTDOCFLAGS="-Dwarnings" cargo doc --no-deps --lib
+fi

docker/ci/entrypoint.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Run the CI steps locally for each libcamera version (same matrix as GitHub Actions).
+VERSIONS=(
+  v0.4.0
+  v0.5.0
+  v0.5.1
+  v0.5.2
+  v0.6.0
+)
+
+for ver in "${VERSIONS[@]}"; do
+  echo "=== Building CI image for libcamera ${ver} ==="
+  docker build -f docker/ci/Dockerfile --build-arg LIBCAMERA_VERSION="${ver}" -t "libcamera-ci:${ver}" .
+  echo "=== Running CI steps for libcamera ${ver} ==="
+  docker run --rm -v "$PWD:/workspace" -w /workspace "libcamera-ci:${ver}" ./docker/ci/entrypoint.sh
+done

docker/ci/run-local.sh

@@ -11,3 +11,4 @@ prettyplease = "0.2.17"
 semver = "1.0.22"
 syn = "2.0.58"
 yaml-rust = "0.4"
+regex = "1"