WebARKitLib-rs 🦀

WebARKitLib-rs is a high-performance, memory-safe Rust port of the WebARKitLib (originally C/C++).

This project aims to provide a pure-Rust implementation of the core ARToolKit algorithms, targeting both native systems and WebAssembly (WASM) for high-performance augmented reality in the browser.

[!NOTE] This project is currently a Work in Progress. While the core marker detection and pose estimation are functional, we are continuously optimizing and expanding the feature set.

🌟 Key Features

• Pure Rust: Built for safety, speed, and modern concurrency. (crates.io)
• Dual WASM Strategy: Automated release of both Standard and SIMD binaries to maximize performance and compatibility.
• Barcode Marker Support: Robust decoding for square matrix markers (3x3 to 6x6) with ECC.
• WASM Ready: High-performance tracking in the browser via WebAssembly. (@webarkit/webarkitlib-wasm)
• Side-Effect Free: Pure mathematical engine, easy to test and integrate.
• CI-Integrated Benchmarking: Performance parity with original C implementation.

🚀 Getting Started

Native Rust Example

To see the marker detection in action on your local machine, run the provided simple example:

cargo run --example simple
# or for barcode markers
cargo run --example barcode_4x4

This example loads a camera parameter file, a marker (pattern or barcode), and a sample image, performing detection and outputting the 3D pose extrinsics.

WebAssembly (WASM) Demo

The WASM port allows you to run the AR engine directly in most modern browsers.

1. Build the modules: Use the dual-build script to generate both Standard and SIMD bundles:

   cd crates/wasm
   ./scripts/build-dual.sh
   

2. Run the demo: The www folder contains a diagnostic demo with an engine selector and threshold visualization.

   cd www
   # Serve using any local HTTP server, e.g.:
   npx serve .
   

📊 Benchmarking

We maintain a strict performance comparison with the original C library to ensure our Rust port remains competitive.

Running the Comparison

1. Bootstrap the C library:

   cd benchmarks/c_benchmark
   python ../bootstrap.py --bootstrap-file libraries.json
   

2. Execute the Suite:

   # Rust Benchmark
   cargo bench -p webarkitlib-rs --bench marker_bench
   
   # C Benchmark (Manual build required once)
   cd benchmarks/c_benchmark/build
   cmake --build . --config Release
   ./c_benchmark ../../data/camera_para.dat ../../data/patt.hiro ../../data/hiro.raw 429 317
   

Tracking Performance

We use criterion to track performance over time. You can save specific snapshots as "baselines":

# Save a milestone baseline
cargo bench -- --save-baseline milestone-20260307

🏗️ Project Structure

• crates/core: The core AR engine (pure Rust).
• crates/wasm: WASM bindings, dual-build scripts, and diagnostic web demo.
• benchmarks: C vs Rust performance comparison suite.
• examples: Usage demonstrations for patterns and barcodes.

🗺️ Roadmap

🎯 Near-term Goals (v1.0.0+)

• Enhanced Documentation: Expand API reference, integration walkthroughs for JS/TS, and provide detailed usage examples.
• WASM Memory Management: Improve resource cleanup when switching engines or markers in long-running browser sessions.

🔭 Long-term Vision

• Multi-Marker Support: Port arMulti logic to enable tracking of multiple markers simultaneously.
• KPM/NFT (Natural Feature Tracking): Implement robust tracking of arbitrary images and surfaces.
• Advanced Video Abstraction: Develop a cross-platform video handling layer to simplify integration with various input sources.

📜 Credits

This project is a port of the excellent WebARKitLib project. Special thanks to the original ARToolKit contributors.

📄 License

This project is licensed under the LGPLv3 License - see the LICENSE file for details.