mod obu: Deduplicate macros (#596)

Deduplicate these macros:
* `offsetof` (requires `#![feature(offsetof)]`, but this way is `unsafe`
and will be replace soon)
* `is_key_or_intra`
* `is_inter_or_switch`
* `RAV1D_MAX_SEGMENTS`
* `DAV1D_MAX_SEGMENTS`

include/dav1d/headers.rs

@@ -421,8 +421,10 @@ pub(crate) const RAV1D_CHR_UNKNOWN: Rav1dChromaSamplePosition = DAV1D_CHR_UNKNOW
 
 // Constants from Section 3. "Symbols and abbreviated terms"
 pub const DAV1D_MAX_SEGMENTS: u8 = 8;
+pub const DAV1D_PRIMARY_REF_NONE: c_int = 7;
 
 pub(crate) const RAV1D_MAX_SEGMENTS: u8 = DAV1D_MAX_SEGMENTS;
+pub(crate) const RAV1D_PRIMARY_REF_NONE: c_int = DAV1D_PRIMARY_REF_NONE;
 
 #[repr(C)]
 pub struct Rav1dContentLightLevel {
@@ -1035,15 +1037,15 @@ impl From<Rav1dSegmentationData> for Dav1dSegmentationData {
 #[derive(Clone)]
 #[repr(C)]
 pub struct Dav1dSegmentationDataSet {
-    pub d: [Dav1dSegmentationData; 8],
+    pub d: [Dav1dSegmentationData; DAV1D_MAX_SEGMENTS as usize],
     pub preskip: c_int,
     pub last_active_segid: c_int,
 }
 
 #[derive(Clone)]
 #[repr(C)]
 pub(crate) struct Rav1dSegmentationDataSet {
-    pub d: [Rav1dSegmentationData; 8],
+    pub d: [Rav1dSegmentationData; RAV1D_MAX_SEGMENTS as usize],
     pub preskip: c_int,
     pub last_active_segid: c_int,
 }
@@ -1607,8 +1609,8 @@ pub struct Dav1dFrameHeader_segmentation {
     pub temporal: c_int,
     pub update_data: c_int,
     pub seg_data: Dav1dSegmentationDataSet,
-    pub lossless: [c_int; 8],
-    pub qidx: [c_int; 8],
+    pub lossless: [c_int; DAV1D_MAX_SEGMENTS as usize],
+    pub qidx: [c_int; DAV1D_MAX_SEGMENTS as usize],
 }
 
 #[derive(Clone)]
@@ -1619,8 +1621,8 @@ pub(crate) struct Rav1dFrameHeader_segmentation {
     pub temporal: c_int,
     pub update_data: c_int,
     pub seg_data: Rav1dSegmentationDataSet,
-    pub lossless: [c_int; 8],
-    pub qidx: [c_int; 8],
+    pub lossless: [c_int; RAV1D_MAX_SEGMENTS as usize],
+    pub qidx: [c_int; RAV1D_MAX_SEGMENTS as usize],
 }
 
 impl From<Dav1dFrameHeader_segmentation> for Rav1dFrameHeader_segmentation {

lib.rs

@@ -3,6 +3,7 @@
 #![allow(non_upper_case_globals)]
 #![feature(c_variadic)]
 #![feature(core_intrinsics)]
+#![feature(offset_of)] // TODO(kkysen) Will be removed shortly.
 #![cfg_attr(target_arch = "arm", feature(stdsimd))]
 #![allow(clippy::all)]
 

src/cdf.rs

@@ -1,4 +1,5 @@
 use crate::include::dav1d::headers::Rav1dFrameHeader;
+use crate::include::dav1d::headers::RAV1D_MAX_SEGMENTS;
 use crate::include::dav1d::headers::RAV1D_N_SWITCHABLE_FILTERS;
 use crate::include::stdatomic::atomic_uint;
 use crate::src::align::Align16;
@@ -89,7 +90,7 @@ pub struct CdfModeContext {
     pub angle_delta: Align16<[[u16; 8]; 8]>,
     pub filter_intra: Align16<[u16; 8]>,
     pub comp_inter_mode: Align16<[[u16; N_COMP_INTER_PRED_MODES]; 8]>,
-    pub seg_id: Align16<[[u16; 8]; 3]>,
+    pub seg_id: Align16<[[u16; RAV1D_MAX_SEGMENTS as usize]; 3]>,
     pub pal_sz: Align16<[[[u16; 8]; 7]; 2]>,
     pub color_map: Align16<[[[[u16; 8]; 5]; 7]; 2]>,
     pub filter: Align8<[[[u16; 4]; 8]; 2]>,
@@ -5186,7 +5187,7 @@ pub(crate) unsafe fn rav1d_cdf_thread_update(
             ((*src).m.seg_id[j_18 as usize]).as_ptr() as *const c_void,
             ::core::mem::size_of::<[u16; 8]>(),
         );
-        (*dst).m.seg_id[j_18 as usize][(8 - 1) as usize] = 0 as c_int as u16;
+        (*dst).m.seg_id[j_18 as usize][(RAV1D_MAX_SEGMENTS - 1) as usize] = 0 as c_int as u16;
         j_18 += 1;
     }
     memcpy(

src/decode.rs

@@ -19,6 +19,7 @@ use crate::include::dav1d::headers::RAV1D_FILTER_8TAP_REGULAR;
 use crate::include::dav1d::headers::RAV1D_FILTER_SWITCHABLE;
 use crate::include::dav1d::headers::RAV1D_MAX_SEGMENTS;
 use crate::include::dav1d::headers::RAV1D_N_SWITCHABLE_FILTERS;
+use crate::include::dav1d::headers::RAV1D_PRIMARY_REF_NONE;
 use crate::include::dav1d::headers::RAV1D_RESTORATION_NONE;
 use crate::include::dav1d::headers::RAV1D_RESTORATION_SGRPROJ;
 use crate::include::dav1d::headers::RAV1D_RESTORATION_SWITCHABLE;
@@ -1158,7 +1159,7 @@ unsafe fn get_prev_frame_segid(
     ref_seg_map: *const u8,
     stride: ptrdiff_t,
 ) -> u8 {
-    assert!((*f.frame_hdr).primary_ref_frame != 7);
+    assert!((*f.frame_hdr).primary_ref_frame != RAV1D_PRIMARY_REF_NONE);
 
     // Need checked casts here because an overflowing cast
     // would give a too large `len` to [`std::slice::from_raw_parts`], which would UB.
@@ -5101,7 +5102,7 @@ pub unsafe fn rav1d_submit_frame(c: &mut Rav1dContext) -> Rav1dResult {
 
     let mut ref_coded_width = <[i32; 7]>::default();
     if is_inter_or_switch(&*f.frame_hdr) {
-        if (*f.frame_hdr).primary_ref_frame != 7 {
+        if (*f.frame_hdr).primary_ref_frame != RAV1D_PRIMARY_REF_NONE {
             let pri_ref = (*f.frame_hdr).refidx[(*f.frame_hdr).primary_ref_frame as usize] as usize;
             if c.refs[pri_ref].p.p.data[0].is_null() {
                 on_error(f, c, out_delayed);
@@ -5145,7 +5146,7 @@ pub unsafe fn rav1d_submit_frame(c: &mut Rav1dContext) -> Rav1dResult {
     }
 
     // setup entropy
-    if (*f.frame_hdr).primary_ref_frame == 7 {
+    if (*f.frame_hdr).primary_ref_frame == RAV1D_PRIMARY_REF_NONE {
         rav1d_cdf_thread_init_static(&mut f.in_cdf, (*f.frame_hdr).quant.yac);
     } else {
         let pri_ref = (*f.frame_hdr).refidx[(*f.frame_hdr).primary_ref_frame as usize] as usize;
@@ -5294,7 +5295,7 @@ pub unsafe fn rav1d_submit_frame(c: &mut Rav1dContext) -> Rav1dResult {
         if (*f.frame_hdr).segmentation.temporal != 0 || (*f.frame_hdr).segmentation.update_map == 0
         {
             let pri_ref = (*f.frame_hdr).primary_ref_frame as usize;
-            assert!(pri_ref != 7);
+            assert!(pri_ref != RAV1D_PRIMARY_REF_NONE as usize);
             let ref_w = (ref_coded_width[pri_ref] + 7 >> 3) << 1;
             let ref_h = (f.refp[pri_ref].p.p.h + 7 >> 3) << 1;
             if ref_w == f.bw && ref_h == f.bh {

src/internal.rs

@@ -15,6 +15,7 @@ use crate::include::dav1d::headers::Rav1dITUTT35;
 use crate::include::dav1d::headers::Rav1dMasteringDisplay;
 use crate::include::dav1d::headers::Rav1dSequenceHeader;
 use crate::include::dav1d::headers::Rav1dWarpedMotionParams;
+use crate::include::dav1d::headers::RAV1D_MAX_SEGMENTS;
 use crate::include::dav1d::picture::Rav1dPicAllocator;
 use crate::include::dav1d::picture::Rav1dPicture;
 use crate::include::stdatomic::atomic_int;
@@ -456,7 +457,7 @@ pub(crate) struct Rav1dFrameContext {
     pub sb_shift: c_int,
     pub sb_step: c_int,
     pub sr_sb128w: c_int,
-    pub dq: [[[u16; 2]; 3]; 8],
+    pub dq: [[[u16; 2]; 3]; RAV1D_MAX_SEGMENTS as usize],
     pub qm: [[*const u8; 3]; 19],
     pub a: *mut BlockContext,
     pub a_sz: c_int,
@@ -493,7 +494,7 @@ pub struct Rav1dTileState {
     pub progress: [atomic_int; 2],
     pub frame_thread: [Rav1dTileState_frame_thread; 2],
     pub lowest_pixel: *mut [[c_int; 2]; 7],
-    pub dqmem: [[[u16; 2]; 3]; 8],
+    pub dqmem: [[[u16; 2]; 3]; RAV1D_MAX_SEGMENTS as usize],
     pub dq: *const [[u16; 2]; 3],
     pub last_qidx: c_int,
     pub last_delta_lf: [i8; 4],

src/obu.rs

@@ -1,3 +1,5 @@
+use crate::include::common::frame::is_inter_or_switch;
+use crate::include::common::frame::is_key_or_intra;
 use crate::include::common::intops::iclip_u8;
 use crate::include::common::intops::ulog2;
 use crate::include::dav1d::data::Rav1dData;
@@ -35,6 +37,7 @@ use crate::include::dav1d::headers::RAV1D_FRAME_TYPE_INTER;
 use crate::include::dav1d::headers::RAV1D_FRAME_TYPE_INTRA;
 use crate::include::dav1d::headers::RAV1D_FRAME_TYPE_KEY;
 use crate::include::dav1d::headers::RAV1D_FRAME_TYPE_SWITCH;
+use crate::include::dav1d::headers::RAV1D_MAX_SEGMENTS;
 use crate::include::dav1d::headers::RAV1D_MC_IDENTITY;
 use crate::include::dav1d::headers::RAV1D_MC_UNKNOWN;
 use crate::include::dav1d::headers::RAV1D_OBU_FRAME;
@@ -45,6 +48,7 @@ use crate::include::dav1d::headers::RAV1D_OBU_REDUNDANT_FRAME_HDR;
 use crate::include::dav1d::headers::RAV1D_OBU_SEQ_HDR;
 use crate::include::dav1d::headers::RAV1D_OBU_TD;
 use crate::include::dav1d::headers::RAV1D_OBU_TILE_GRP;
+use crate::include::dav1d::headers::RAV1D_PRIMARY_REF_NONE;
 use crate::include::dav1d::headers::RAV1D_RESTORATION_NONE;
 use crate::include::dav1d::headers::RAV1D_TRC_SRGB;
 use crate::include::dav1d::headers::RAV1D_TRC_UNKNOWN;
@@ -112,6 +116,7 @@ use std::ffi::c_int;
 use std::ffi::c_uint;
 use std::ffi::c_ulong;
 use std::ffi::c_void;
+use std::mem;
 use std::ptr::addr_of_mut;
 
 #[inline]
@@ -513,7 +518,7 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
         hdr.force_integer_mv = 0;
     }
 
-    if hdr.frame_type & 1 == 0 {
+    if is_key_or_intra(hdr) {
         hdr.force_integer_mv = 1;
     }
 
@@ -533,10 +538,10 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
     } else {
         0
     };
-    hdr.primary_ref_frame = if hdr.error_resilient_mode == 0 && hdr.frame_type as c_uint & 1 != 0 {
+    hdr.primary_ref_frame = if hdr.error_resilient_mode == 0 && is_inter_or_switch(hdr) {
         rav1d_get_bits(gb, 3) as c_int
     } else {
-        7
+        RAV1D_PRIMARY_REF_NONE
     };
 
     if seqhdr.decoder_model_info_present != 0 {
@@ -557,7 +562,7 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
         }
     }
 
-    if hdr.frame_type & 1 == 0 {
+    if is_key_or_intra(hdr) {
         hdr.refresh_frame_flags = if hdr.frame_type == RAV1D_FRAME_TYPE_KEY && hdr.show_frame != 0 {
             0xff
         } else {
@@ -734,7 +739,7 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
         hdr.use_ref_frame_mvs = (hdr.error_resilient_mode == 0
             && seqhdr.ref_frame_mvs != 0
             && seqhdr.order_hint != 0
-            && hdr.frame_type & 1 != 0
+            && is_inter_or_switch(hdr)
             && rav1d_get_bit(gb) != 0) as c_int;
     }
 
@@ -892,7 +897,7 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
     // segmentation data
     hdr.segmentation.enabled = rav1d_get_bit(gb) as c_int;
     if hdr.segmentation.enabled != 0 {
-        if hdr.primary_ref_frame == 7 {
+        if hdr.primary_ref_frame == RAV1D_PRIMARY_REF_NONE {
             hdr.segmentation.update_map = 1;
             hdr.segmentation.temporal = 0;
             hdr.segmentation.update_data = 1;
@@ -909,7 +914,7 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
         if hdr.segmentation.update_data != 0 {
             hdr.segmentation.seg_data.preskip = 0;
             hdr.segmentation.seg_data.last_active_segid = -1;
-            for i in 0..8 {
+            for i in 0..RAV1D_MAX_SEGMENTS as c_int {
                 let seg = &mut hdr.segmentation.seg_data.d[i as usize];
                 if rav1d_get_bit(gb) != 0 {
                     seg.delta_q = rav1d_get_sbits(gb, 9);
@@ -962,7 +967,7 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
         } else {
             // segmentation.update_data was false so we should copy
             // segmentation data from the reference frame.
-            assert!(hdr.primary_ref_frame != 7);
+            assert!(hdr.primary_ref_frame != RAV1D_PRIMARY_REF_NONE);
             let pri_ref = hdr.refidx[hdr.primary_ref_frame as usize];
             if (c.refs[pri_ref as usize].p.p.frame_hdr).is_null() {
                 return error(c);
@@ -978,7 +983,7 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
             0,
             ::core::mem::size_of::<Rav1dSegmentationDataSet>(),
         );
-        for i in 0..8 {
+        for i in 0..RAV1D_MAX_SEGMENTS {
             hdr.segmentation.seg_data.d[i as usize].r#ref = -1;
         }
     }
@@ -1014,7 +1019,7 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
         && hdr.quant.vdc_delta == 0
         && hdr.quant.vac_delta == 0) as c_int;
     hdr.all_lossless = 1;
-    for i in 0..8 {
+    for i in 0..RAV1D_MAX_SEGMENTS {
         hdr.segmentation.qidx[i as usize] = if hdr.segmentation.enabled != 0 {
             iclip_u8(hdr.quant.yac + hdr.segmentation.seg_data.d[i as usize].delta_q)
         } else {
@@ -1046,7 +1051,7 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
         }
         hdr.loopfilter.sharpness = rav1d_get_bits(gb, 3) as c_int;
 
-        if hdr.primary_ref_frame == 7 {
+        if hdr.primary_ref_frame == RAV1D_PRIMARY_REF_NONE {
             hdr.loopfilter.mode_ref_deltas = default_mode_ref_deltas.clone();
         } else {
             let r#ref = hdr.refidx[hdr.primary_ref_frame as usize];
@@ -1143,14 +1148,13 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
     } else {
         RAV1D_TX_LARGEST
     };
-    hdr.switchable_comp_refs = if hdr.frame_type as c_uint & 1 != 0 {
+    hdr.switchable_comp_refs = if is_inter_or_switch(hdr) {
         rav1d_get_bit(gb) as c_int
     } else {
         0
     };
     hdr.skip_mode_allowed = 0;
-    if hdr.switchable_comp_refs != 0 && hdr.frame_type as c_uint & 1 != 0 && seqhdr.order_hint != 0
-    {
+    if hdr.switchable_comp_refs != 0 && is_inter_or_switch(hdr) && seqhdr.order_hint != 0 {
         let poc = hdr.frame_offset as c_uint;
         let mut off_before = 0xffffffff;
         let mut off_after = -1;
@@ -1234,7 +1238,7 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
         0
     };
     hdr.warp_motion = (hdr.error_resilient_mode == 0
-        && hdr.frame_type & 1 != 0
+        && is_inter_or_switch(hdr)
         && seqhdr.warped_motion != 0
         && rav1d_get_bit(gb) != 0) as c_int;
     hdr.reduced_txtp_set = rav1d_get_bit(gb) as c_int;
@@ -1243,7 +1247,7 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
         hdr.gmv[i as usize] = dav1d_default_wm_params.clone();
     }
 
-    if hdr.frame_type & 1 != 0 {
+    if is_inter_or_switch(hdr) {
         for i in 0..7 {
             hdr.gmv[i as usize].r#type = if rav1d_get_bit(gb) == 0 {
                 RAV1D_WM_TYPE_IDENTITY
@@ -1256,7 +1260,7 @@ unsafe fn parse_frame_hdr(c: &mut Rav1dContext, gb: &mut GetBits) -> Rav1dResult
             };
             if !(hdr.gmv[i as usize].r#type == RAV1D_WM_TYPE_IDENTITY) {
                 let ref_gmv;
-                if hdr.primary_ref_frame == 7 {
+                if hdr.primary_ref_frame == RAV1D_PRIMARY_REF_NONE {
                     ref_gmv = &dav1d_default_wm_params;
                 } else {
                     let pri_ref = hdr.refidx[hdr.primary_ref_frame as usize];
@@ -1609,7 +1613,17 @@ pub(crate) unsafe fn rav1d_parse_obus(
             if c.seq_hdr.is_null() {
                 c.frame_hdr = 0 as *mut Rav1dFrameHeader;
                 c.frame_flags |= PICTURE_FLAG_NEW_SEQUENCE;
-            } else if memcmp(seq_hdr as *const c_void, c.seq_hdr as *const c_void, 1100) != 0 {
+            } else if memcmp(
+                seq_hdr as *const c_void,
+                c.seq_hdr as *const c_void,
+                // TODO(kkysen) Remove unstable feature.
+                // Doing it this way also prevents us from removing the `#[repr(C)]`.
+                // We should split [`Rav1dSequenceHeader`] into an inner `struct`
+                // without the `operating_parameter_info` field,
+                // or at least offer safe field-by-field comparison methods.
+                mem::offset_of!(Rav1dSequenceHeader, operating_parameter_info),
+            ) != 0
+            {
                 // See 7.5, `operating_parameter_info` is allowed to change in
                 // sequence headers of a single sequence.
                 c.frame_hdr = 0 as *mut Rav1dFrameHeader;