Implement dav1d-rs's Rust API

Cargo.toml

@@ -19,13 +19,15 @@ crate-type = ["staticlib", "rlib"]
 [dependencies]
 assert_matches = "1.5.0"
 atomig = { version = "0.4.0", features = ["derive"] }
+av-data = "0.4.2"
 bitflags = "2.4.0"
 cfg-if = "1.0.0"
 libc = "0.2"
 parking_lot = "0.12.2"
 paste = "1.0.14"
 raw-cpuid = "11.0.1"
 strum = { version = "0.27", features = ["derive"] }
+static_assertions = "1.0.0"
 to_method = "1.1.0"
 zerocopy = { version = "0.7.32", features = ["derive"] }
 

src/include/dav1d/common.rs

@@ -42,7 +42,7 @@ pub struct Dav1dDataProps {
 
 #[derive(Clone)]
 #[repr(C)]
-pub(crate) struct Rav1dDataProps {
+pub struct Rav1dDataProps {
     pub timestamp: i64,
     pub duration: i64,
     pub offset: i64,

src/include/dav1d/dav1d.rs

@@ -36,7 +36,7 @@ pub const DAV1D_INLOOPFILTER_RESTORATION: Dav1dInloopFilterType =
 
 bitflags! {
     #[derive(Clone, Copy, PartialEq, Eq, Hash, Default)]
-    pub(crate) struct Rav1dInloopFilterType: u8 {
+    pub struct Rav1dInloopFilterType: u8 {
         const DEBLOCK = 1 << 1;
         const CDEF = 1 << 2;
         const RESTORATION = 1 << 3;
@@ -66,7 +66,7 @@ pub const DAV1D_DECODEFRAMETYPE_KEY: Dav1dDecodeFrameType =
     Rav1dDecodeFrameType::Key as Dav1dDecodeFrameType;
 
 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, FromRepr, Default)]
-pub(crate) enum Rav1dDecodeFrameType {
+pub enum Rav1dDecodeFrameType {
     /// decode and return all frames
     #[default]
     All = 0,

src/include/dav1d/headers.rs

@@ -4,10 +4,12 @@ use std::fmt::{Debug, Display, Formatter};
 use std::ops::{BitAnd, Deref, Sub};
 use std::sync::Arc;
 
+use av_data::pixel;
 use strum::{EnumCount, FromRepr};
 
 use crate::align::ArrayDefault;
 use crate::enum_map::EnumKey;
+use crate::error::Rav1dError;
 use crate::levels::SegmentId;
 use crate::relaxed_atomic::RelaxedAtomic;
 
@@ -379,7 +381,7 @@ impl From<Rav1dWarpedMotionParams> for Dav1dWarpedMotionParams {
 
 // TODO(kkysen) Eventually the [`impl Default`] might not be needed.
 /// Pixel layout of a frame.
-#[derive(Clone, Copy, PartialEq, Eq, EnumCount, FromRepr, Default)]
+#[derive(Clone, Copy, PartialEq, Eq, EnumCount, FromRepr, Default, Debug)]
 pub enum Rav1dPixelLayout {
     /// Monochrome.
     #[default]
@@ -567,6 +569,25 @@ impl Rav1dColorPrimaries {
     }
 }
 
+impl From<Rav1dColorPrimaries> for pixel::ColorPrimaries {
+    fn from(val: Rav1dColorPrimaries) -> Self {
+        match val {
+            Rav1dColorPrimaries::BT709 => pixel::ColorPrimaries::BT709,
+            Rav1dColorPrimaries::Unspecified => pixel::ColorPrimaries::Unspecified,
+            Rav1dColorPrimaries::BT470M => pixel::ColorPrimaries::BT470M,
+            Rav1dColorPrimaries::BT470BG => pixel::ColorPrimaries::BT470BG,
+            Rav1dColorPrimaries::BT601 => pixel::ColorPrimaries::BT470BG,
+            Rav1dColorPrimaries::SMPTE240 => pixel::ColorPrimaries::ST240M,
+            Rav1dColorPrimaries::Film => pixel::ColorPrimaries::Film,
+            Rav1dColorPrimaries::BT2020 => pixel::ColorPrimaries::BT2020,
+            Rav1dColorPrimaries::XYZ => pixel::ColorPrimaries::ST428,
+            Rav1dColorPrimaries::SMPTE431 => pixel::ColorPrimaries::P3DCI,
+            Rav1dColorPrimaries::SMPTE432 => pixel::ColorPrimaries::P3Display,
+            Rav1dColorPrimaries::EBU3213 => pixel::ColorPrimaries::Tech3213,
+        }
+    }
+}
+
 impl From<Rav1dColorPrimaries> for Dav1dColorPrimaries {
     fn from(value: Rav1dColorPrimaries) -> Self {
         value.to_dav1d()
@@ -649,6 +670,36 @@ impl Rav1dTransferCharacteristics {
     }
 }
 
+impl From<Rav1dTransferCharacteristics> for pixel::TransferCharacteristic {
+    fn from(val: Rav1dTransferCharacteristics) -> Self {
+        match val {
+            Rav1dTransferCharacteristics::BT709 => pixel::TransferCharacteristic::BT1886,
+            Rav1dTransferCharacteristics::Unspecified => pixel::TransferCharacteristic::Unspecified,
+            Rav1dTransferCharacteristics::BT470M => pixel::TransferCharacteristic::BT470M,
+            Rav1dTransferCharacteristics::BT470BG => pixel::TransferCharacteristic::BT470BG,
+            Rav1dTransferCharacteristics::BT601 => pixel::TransferCharacteristic::ST170M,
+            Rav1dTransferCharacteristics::SMPTE240 => pixel::TransferCharacteristic::ST240M,
+            Rav1dTransferCharacteristics::Linear => pixel::TransferCharacteristic::Linear,
+            Rav1dTransferCharacteristics::Log100 => pixel::TransferCharacteristic::Logarithmic100,
+            Rav1dTransferCharacteristics::Log100Sqrt10 => {
+                pixel::TransferCharacteristic::Logarithmic316
+            }
+            Rav1dTransferCharacteristics::IEC61966 => pixel::TransferCharacteristic::SRGB,
+            Rav1dTransferCharacteristics::BT1361 => pixel::TransferCharacteristic::BT1886,
+            Rav1dTransferCharacteristics::SRGB => pixel::TransferCharacteristic::SRGB,
+            Rav1dTransferCharacteristics::BT2020_10Bit => pixel::TransferCharacteristic::BT2020Ten,
+            Rav1dTransferCharacteristics::BT2020_12Bit => {
+                pixel::TransferCharacteristic::BT2020Twelve
+            }
+            Rav1dTransferCharacteristics::SMPTE2084 => {
+                pixel::TransferCharacteristic::PerceptualQuantizer
+            }
+            Rav1dTransferCharacteristics::SMPTE428 => pixel::TransferCharacteristic::ST428,
+            Rav1dTransferCharacteristics::HLG => pixel::TransferCharacteristic::HybridLogGamma,
+        }
+    }
+}
+
 impl From<Rav1dTransferCharacteristics> for Dav1dTransferCharacteristics {
     fn from(value: Rav1dTransferCharacteristics) -> Self {
         value.to_dav1d()
@@ -715,6 +766,33 @@ impl Rav1dMatrixCoefficients {
     }
 }
 
+impl From<Rav1dMatrixCoefficients> for pixel::MatrixCoefficients {
+    fn from(val: Rav1dMatrixCoefficients) -> Self {
+        match val {
+            Rav1dMatrixCoefficients::Identity => pixel::MatrixCoefficients::Identity,
+            Rav1dMatrixCoefficients::BT709 => pixel::MatrixCoefficients::BT709,
+            Rav1dMatrixCoefficients::Unspecified => pixel::MatrixCoefficients::Unspecified,
+            Rav1dMatrixCoefficients::FCC => pixel::MatrixCoefficients::BT470M,
+            Rav1dMatrixCoefficients::BT470BG => pixel::MatrixCoefficients::BT470BG,
+            Rav1dMatrixCoefficients::BT601 => pixel::MatrixCoefficients::BT470BG,
+            Rav1dMatrixCoefficients::SMPTE240 => pixel::MatrixCoefficients::ST240M,
+            Rav1dMatrixCoefficients::SMPTE_YCgCo => pixel::MatrixCoefficients::YCgCo,
+            Rav1dMatrixCoefficients::BT2020NCL => {
+                pixel::MatrixCoefficients::BT2020NonConstantLuminance
+            }
+            Rav1dMatrixCoefficients::BT2020CL => pixel::MatrixCoefficients::BT2020ConstantLuminance,
+            Rav1dMatrixCoefficients::SMPTE2085 => pixel::MatrixCoefficients::ST2085,
+            Rav1dMatrixCoefficients::ChromatNCL => {
+                pixel::MatrixCoefficients::ChromaticityDerivedNonConstantLuminance
+            }
+            Rav1dMatrixCoefficients::ChromatCL => {
+                pixel::MatrixCoefficients::ChromaticityDerivedConstantLuminance
+            }
+            Rav1dMatrixCoefficients::ICtCp => pixel::MatrixCoefficients::ICtCp,
+        }
+    }
+}
+
 impl From<Rav1dMatrixCoefficients> for Dav1dMatrixCoefficients {
     fn from(value: Rav1dMatrixCoefficients) -> Self {
         value.to_dav1d()
@@ -754,6 +832,21 @@ impl From<Rav1dChromaSamplePosition> for Dav1dChromaSamplePosition {
     }
 }
 
+impl TryInto<pixel::ChromaLocation> for Rav1dChromaSamplePosition {
+    type Error = Rav1dError;
+
+    fn try_into(self) -> Result<pixel::ChromaLocation, Self::Error> {
+        // According to y4m mapping declared in dav1d's output/y4m2.c and applied from FFmpeg's yuv4mpegdec.c
+        match self {
+            Rav1dChromaSamplePosition::Unknown | Rav1dChromaSamplePosition::Colocated => {
+                Ok(pixel::ChromaLocation::Center)
+            }
+            Rav1dChromaSamplePosition::Vertical => Ok(pixel::ChromaLocation::Left),
+            Rav1dChromaSamplePosition::_Reserved => Err(Rav1dError::InvalidArgument),
+        }
+    }
+}
+
 impl TryFrom<Dav1dChromaSamplePosition> for Rav1dChromaSamplePosition {
     type Error = ();
 

src/include/dav1d/picture.rs

@@ -32,7 +32,7 @@ use crate::with_offset::WithOffset;
 // Number of bytes to align AND pad picture memory buffers by, so that SIMD
 // implementations can over-read by a few bytes, and use aligned read/write
 // instructions.
-pub(crate) const RAV1D_PICTURE_ALIGNMENT: usize = 64;
+pub const RAV1D_PICTURE_ALIGNMENT: usize = 64;
 pub const DAV1D_PICTURE_ALIGNMENT: usize = RAV1D_PICTURE_ALIGNMENT;
 
 #[derive(Default)]
@@ -47,7 +47,7 @@ pub struct Dav1dPictureParameters {
 // TODO(kkysen) Eventually the [`impl Default`] might not be needed.
 #[derive(Clone, Default)]
 #[repr(C)]
-pub(crate) struct Rav1dPictureParameters {
+pub struct Rav1dPictureParameters {
     pub w: c_int,
     pub h: c_int,
     pub layout: Rav1dPixelLayout,
@@ -404,7 +404,7 @@ impl Drop for Rav1dPictureData {
 // on [`Rav1dPictureParameters`] and [`Rav1dPixelLayout`].
 #[derive(Clone, Default)]
 #[repr(C)]
-pub(crate) struct Rav1dPicture {
+pub struct Rav1dPicture {
     pub seq_hdr: Option<Arc<DRav1d<Rav1dSequenceHeader, Dav1dSequenceHeader>>>,
     pub frame_hdr: Option<Arc<DRav1d<Rav1dFrameHeader, Dav1dFrameHeader>>>,
     pub data: Option<Arc<Rav1dPictureData>>,
@@ -657,7 +657,7 @@ pub struct Dav1dPicAllocator {
 
 #[derive(Clone)]
 #[repr(C)]
-pub(crate) struct Rav1dPicAllocator {
+pub struct Rav1dPicAllocator {
     /// See [`Dav1dPicAllocator::cookie`].
     ///
     /// # Safety

src/lib.rs

@@ -139,6 +139,8 @@ mod pool;
 mod qm;
 mod recon;
 mod refmvs;
+/// This API copies that of `dav1d-rs`, and should function as a drop-in replacement, aside from `dav1d::Error` being renamed to `Rav1dError`
+pub mod rust_api;
 mod scan;
 mod tables;
 mod thread_task;
@@ -152,14 +154,14 @@ use std::sync::{Arc, Once};
 use std::{cmp, mem, ptr, slice, thread};
 
 use parking_lot::Mutex;
+pub use rust_api::*;
 use to_method::To as _;
 
 use crate::c_arc::RawArc;
 use crate::c_box::{CBox, CRef, FnFree};
 use crate::cpu::{rav1d_init_cpu, rav1d_num_logical_processors};
 use crate::decode::rav1d_decode_frame_exit;
-pub use crate::error::Dav1dResult;
-use crate::error::{Rav1dError, Rav1dResult};
+pub use crate::error::{Dav1dResult, Rav1dError, Rav1dResult};
 use crate::extensions::OptionError as _;
 use crate::in_range::InRange;
 #[cfg(feature = "bitdepth_16")]