Implement `dav1d-rs`'s Rust API by leo030303 · Pull Request #1439 · memorysafety/rav1d

leo030303 · 2025-07-06T15:29:36Z

I've copy pasted the PR from #1362 and updated it with some of the suggestions made on that pull request. The main changes are:

Have all the public-facing Rust API code in its own file.
Used some enums from rav1d instead of redefining new ones, and added in doc comments from the original dav1d-rs library to a few items.
Removed as much unsafe code as I could and replaced it with the Rust methods from rav1d as much as possible.

It currently works as a drop-in replacement for dav1d-rs; adding in use rav1d as dav1d; to my fork of image makes everything work fine.

The only functional changes I made are I removed the unsafe impls of Send and Sync for InnerPicture so Picture is no longer Sync or Send. I looked through the code and I don't believe DisjointMut<Rav1dPictureDataComponentInner>, which is a field of one of its children, is thread safe, though I'm open to correction there; I'm pretty unfamiliar with unsafe Rust.

I also don't have safety comments on the two unsafe blocks in rust_api.rs; I'm unsure what these would look like, so open to suggestions there. These are mostly taken verbatim from the old pull request.

Closes Provide Rust API #1252.

kkysen

Thanks for the much safer implementation! I'm still taking a closer look at the unsafes, as the few remaining are still quite critical, but I wanted to give some initial feedback in general first.

src/rust_api.rs

src/include/dav1d/headers.rs

src/rust_api.rs

Pulled out the docs additions from #1439 into its own PR.

src/rust_api.rs

…1442) Pulled out the `Rav1dError` changes from #1439 into a separate PR.

…e `u32` (#1443) Pulled out type changes from here #1439 into its own PR.

kkysen

@leo030303, could you rebase this on main? There are a lot of other commits in here now, so it's harder to review.

Co-authored-by: Khyber Sen <kkysen@gmail.com>

kkysen

Since CRef isn't Send or Sync, if its trivial to add that back in then we should

I've added it back in #1472 now. Once that merges you can rebase/merge.

src/rust_api.rs

leo030303 · 2026-02-21T11:46:16Z

Think that's most of the outstanding issues wrapped up!

plops · 2026-03-01T12:16:24Z

I can't wait for this to be finished!

src/rust_api.rs

leo030303 · 2026-03-14T11:23:20Z

@kkysen if fixing the API for that to never be null isn't straightforward then it could probably be left for a follow up pr since I think the core of this pr should be good to go

Shnatsel · 2026-03-14T13:16:38Z

I've opened a proof-of-concept PR for image to use rav1d via this PR: image-rs/image#2849

It's not quite a drop-in replacement but the conversion was fairly straightforward.

I've wired everything up to wondermagick and it seems to work great!

src/rust_api.rs

Co-authored-by: Khyber Sen <kkysen@gmail.com>

…=> `pixel::ChromaLocation` conversion

…mageComponent> for usize`

kkysen · 2026-03-23T22:49:43Z

src/rust_api.rs

+impl TryFrom<usize> for PlanarImageComponent {
+    type Error = Rav1dError;
+    fn try_from(index: usize) -> Result<Self, Self::Error> {
+        match index {
+            0 => Ok(PlanarImageComponent::Y),
+            1 => Ok(PlanarImageComponent::U),
+            2 => Ok(PlanarImageComponent::V),
+            _ => Err(Rav1dError::InvalidArgument),
+        }
+    }
+}


Is this needed by image-rs or something?

kkysen

I think it all LGTM now. I added a couple of small changes, and I left one last (🤞) about needing impl TryFrom<usize> for PlanarImageComponent. The safety all looks good now. Thanks for working on this for so long! Once #1479 and #1480 merge, we should be able to merge this finally!

…dColorRange` instead of `u8` (#1480) For use by #1439.

kkysen requested changes Jul 7, 2025

View reviewed changes

leo030303 mentioned this pull request Jul 7, 2025

Add some docs on AV1 items #1441

Merged

kkysen changed the title ~~Implement Rust API~~ Implement dav1d-rs's Rust API Jul 7, 2025

This was referenced Jul 7, 2025

enum Rav1dError: rename fields to more Rusty versions and add docs #1442

Merged

struct Rav1dSettings: change n_threads and max_frame_delay to be u32 #1443

Merged

kkysen added a commit that referenced this pull request Jul 7, 2025

Add some docs on AV1 items (#1441)

6ccfb84

Pulled out the docs additions from #1439 into its own PR.

kkysen requested changes Jul 8, 2025

View reviewed changes

leo030303 requested a review from kkysen July 8, 2025 22:23

kkysen added a commit that referenced this pull request Jul 15, 2025

enum Rav1dError: rename fields to more Rusty versions and add docs (#…

fb56c0e

…1442) Pulled out the `Rav1dError` changes from #1439 into a separate PR.

kkysen added a commit that referenced this pull request Jul 15, 2025

struct Rav1dSettings: change n_threads and max_frame_delay to b…

ab750d8

…e `u32` (#1443) Pulled out type changes from here #1439 into its own PR.

kkysen reviewed Jul 18, 2025

View reviewed changes

leo030303 and others added 19 commits July 19, 2025 12:29

Implement Rust API

3d6a828

Update src/rust_api.rs

f616c50

Co-authored-by: Khyber Sen <kkysen@gmail.com>

Update src/rust_api.rs

14c32b6

Co-authored-by: Khyber Sen <kkysen@gmail.com>

Update src/rust_api.rs

f5ae0e8

Co-authored-by: Khyber Sen <kkysen@gmail.com>

Replaced Error type with Rav1dError and added better enum names and docs

1aae7a8

Changed types to more reasonable ones

7c10775

Update src/rust_api.rs

a654fc4

Co-authored-by: Khyber Sen <kkysen@gmail.com>

Cleaned up imports, expose DecodeFrameType publicly

282b6d8

Removed option_nonnull

0b85bd8

Update src/rust_api.rs

391c557

Co-authored-by: Khyber Sen <kkysen@gmail.com>

Remove TryFromEnumError as its no longer used

fa961b2

Rename Decoder.dec to Decoder.ctx

7895fda

Cleanup

86c41fb

Update src/rust_api.rs

f2fc387

Co-authored-by: Khyber Sen <kkysen@gmail.com>

Update src/rust_api.rs

fab1bb1

Co-authored-by: Khyber Sen <kkysen@gmail.com>

Update src/rust_api.rs

3a41838

Co-authored-by: Khyber Sen <kkysen@gmail.com>

Cleanup

7c69894

Update src/rust_api.rs

9953560

Co-authored-by: Khyber Sen <kkysen@gmail.com>

Removed an unsafe block

f0540e8

kkysen reviewed Feb 19, 2026

View reviewed changes

src/rust_api.rs Outdated Show resolved Hide resolved

kkysen reviewed Feb 19, 2026

View reviewed changes

src/rust_api.rs Outdated Show resolved Hide resolved

leo030303 and others added 4 commits February 20, 2026 17:12

Pull error handling out of unsafe block in rust_api

edcb5a1

Fix nit

2ea4ce6

Merge branch 'memorysafety:main' into add-rust-api

8241252

Add back in Send Sync assertion for Decoder

3a50834

leo030303 requested a review from kkysen February 21, 2026 11:45

kkysen reviewed Mar 2, 2026

View reviewed changes

src/rust_api.rs Outdated Show resolved Hide resolved

leo030303 requested a review from kkysen March 14, 2026 11:23

Shnatsel mentioned this pull request Mar 14, 2026

PoC: switch to rav1d for AVIF decoding image-rs/image#2849

Draft

Shnatsel mentioned this pull request Mar 14, 2026

Fuzzing via cargo-fuzz #1475

Draft

kkysen reviewed Mar 17, 2026

View reviewed changes

src/rust_api.rs Outdated Show resolved Hide resolved

kkysen mentioned this pull request Mar 18, 2026

fn DisjointImmutGuard::unchecked_disjoint_mut: add unsafe fn to bypass DisjointMut #1479

Open

leo030303 and others added 2 commits March 21, 2026 11:56

Safer rewrite of plane_data

df03c0b

Co-authored-by: Khyber Sen <kkysen@gmail.com>

Fix up last commit

e7296b8

leo030303 requested a review from kkysen March 21, 2026 12:02

kkysen added 4 commits March 23, 2026 15:24

use TryFrom (instead of TryInto) for Rav1dChromaSamplePosition …

f8d1430

…=> `pixel::ChromaLocation` conversion

use Self:: in conversion functions

f9e73bd

use fn PlanarImageComponent::as_index instead of `impl From<PlanarI…

67bfa80

…mageComponent> for usize`

add enum Rav1dColorRange

080e31f

kkysen reviewed Mar 23, 2026

View reviewed changes

use use T::* for matchs in impl Froms

a510ef3

kkysen mentioned this pull request Mar 23, 2026

enum Rav1dColorRange: make Rav1dSequenceHeader::color_range Rav1dColorRange instead of u8 #1480

Merged

kkysen approved these changes Mar 23, 2026

View reviewed changes

kkysen added a commit that referenced this pull request Mar 24, 2026

enum Rav1dColorRange: make Rav1dSequenceHeader::color_range `Rav1…

90bb4a3

…dColorRange` instead of `u8` (#1480) For use by #1439.

Conversation

leo030303 commented Jul 6, 2025 • edited by kkysen Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kkysen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kkysen left a comment

Choose a reason for hiding this comment

Uh oh!

kkysen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

leo030303 commented Feb 21, 2026

Uh oh!

plops commented Mar 1, 2026

Uh oh!

Uh oh!

leo030303 commented Mar 14, 2026

Uh oh!

Shnatsel commented Mar 14, 2026

Uh oh!

Uh oh!

kkysen Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

kkysen left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

leo030303 commented Jul 6, 2025 •

edited by kkysen

Loading