ci: Add rustfmt

It will run rustfmt on the diffs and fail if it finds any
failures.

Note that this action does not work as intended with PRs
created with forked repositories (because of a github
limitation). But it will still fail and we can see the
failures in the logs instead of it being posted as a review
comment.

Sample failing action:

https://github.com/webmproject/CrabbyAvif/actions/runs/8053598990
1 file changed
tree: 6244b022ab6df1f5c3f7550aa3f7395de6665324
  1. .github/
  2. c_api_tests/
  3. examples/
  4. include/
  5. src/
  6. sys/
  7. tests/
  8. third_party/
  9. .gitignore
  10. .rustfmt.toml
  11. build.rs
  12. cargo-config.toml
  13. Cargo.toml
  14. cbindgen.toml
  15. README.md
README.md

Crabby Avif 🦀

Avif parser/decoder implementation in Rust.

Features

  • Supports dav1d, libgav1 or android mediacodec as the underlying AV1 decoder.
  • C API compatible with libavif
  • ..and more

Build

git clone https://github.com/webmproject/CrabbyAvif.git
# If dav1d system library can be found with pkg-config, this step can be skipped.
cd CrabbyAvif/sys/dav1d-sys
./dav1d.cmd
# If libyuv system library can be found with pkg-config, this step can be skipped.
cd ../libyuv-sys
./libyuv.cmd
cd ../..
cargo build

Tests

cargo test -- --skip test_conformance

Conformance Tests

git clone https://github.com/AOMediaCodec/av1-avif.git third_party/av1-avif
git clone https://github.com/AOMediaCodec/libavif.git third_party/libavif
cd third_party/libavif/ext
./dav1d.cmd
cd ..
cmake -S . -B build -DAVIF_CODEC_DAV1D=LOCAL -DAVIF_LIBYUV=OFF -DAVIF_BUILD_APPS=ON
cmake --build build --parallel -t avifdec
cd ../..
cargo test -- test_conformance

C API Tests

# Build google test
cd third_party
./googletest.cmd
cd ..
# Build the library with C API enabled
cargo build --features capi --release
# Build and run the C/C++ Tests
mkdir c_build
cd c_build
cmake ../c_api_tests/
make
make test

Android Tests

The decoder tests can be run on Android using dinghy.

# One time set up
cargo install cargo-dinghy
# Set path to NDK
export ANDROID_NDK_HOME=<path_to_ndk>
# Install rust toolchain for target
rustup target add aarch64-linux-android
# End of One time set up
# Make sure the device/emulator is available via adb.
cargo dinghy -d android test --no-default-features --features android_mediacodec,libyuv --target aarch64-linux-android --test decoder_tests