videoframe 0.2.0

A common vocabulary of pixel-format and color-metadata types for video processing pipelines.
Documentation
use crate::frame::{Grayf32BeFrame, Grayf32Frame, Grayf32FrameError, Grayf32LeFrame};

// Frame `try_new` tests use the explicit `Grayf32LeFrame` alias because Rust
// does not honor const-generic defaults in unbound associated-function
// inference contexts (Phase 4 — Frame BE flag). Consumer call paths that
// thread BE through `MixedSinker` / walker remain unaffected and may use
// the bare `Grayf32Frame::new(...)` form.

#[test]
fn grayf32_frame_try_new_accepts_valid_tight() {
  // stride == width (tight); 4 px × 4 rows = 16 elements
  let buf = [0.0f32; 16];
  let f = Grayf32LeFrame::try_new(&buf, 4, 4, 4).unwrap();
  assert_eq!(f.width(), 4);
  assert_eq!(f.height(), 4);
  assert_eq!(f.y_stride(), 4);
  assert_eq!(f.y().len(), 16);
  // Phase 4: default `<const BE: bool = false>` exposed via `is_be()`.
  assert!(!f.is_be());
}

#[test]
fn grayf32_frame_try_new_accepts_padded_stride() {
  // stride = 8 (padded to 8), 4 px × 4 rows = 32 elements
  let buf = [0.0f32; 32];
  Grayf32LeFrame::try_new(&buf, 4, 4, 8).unwrap();
}

#[test]
fn grayf32_frame_try_new_rejects_zero_width() {
  let buf = [0.0f32; 16];
  assert!(matches!(
    Grayf32LeFrame::try_new(&buf, 0, 4, 4),
    Err(Grayf32FrameError::ZeroDimension(_))
  ));
}

#[test]
fn grayf32_frame_try_new_rejects_zero_height() {
  let buf = [0.0f32; 16];
  assert!(matches!(
    Grayf32LeFrame::try_new(&buf, 4, 0, 4),
    Err(Grayf32FrameError::ZeroDimension(_))
  ));
}

#[test]
fn grayf32_frame_try_new_rejects_stride_too_small() {
  let buf = [0.0f32; 16];
  assert!(matches!(
    Grayf32LeFrame::try_new(&buf, 4, 4, 3),
    Err(Grayf32FrameError::InsufficientYStride(_))
  ));
}

#[test]
fn grayf32_frame_try_new_rejects_plane_too_short() {
  // stride=4, height=4 → need 16 elements; supply only 15
  let buf = [0.0f32; 15];
  assert!(matches!(
    Grayf32LeFrame::try_new(&buf, 4, 4, 4),
    Err(Grayf32FrameError::InsufficientYPlane(_))
  ));
}

#[cfg(feature = "std")]
#[test]
#[cfg(not(target_arch = "wasm32"))] // wasm uses panic=abort; catch_unwind requires unwinding
fn grayf32_frame_new_panics_on_invalid() {
  let result = std::panic::catch_unwind(|| {
    let buf = [0.0f32; 1];
    Grayf32LeFrame::new(&buf, 0, 1, 1);
  });
  assert!(result.is_err(), "expected panic on zero width");
}

#[test]
fn grayf32_frame_accessors_are_correct() {
  let buf: std::vec::Vec<f32> = (0..16).map(|i| i as f32 * 0.1).collect();
  let f: Grayf32Frame<'_> = Grayf32Frame::new(&buf, 4, 4, 4);
  assert_eq!(f.width(), 4);
  assert_eq!(f.height(), 4);
  assert_eq!(f.y_stride(), 4);
  // y() returns the full backing slice
  assert_eq!(f.y().len(), 16);
  assert!((f.y()[5] - 0.5f32).abs() < 1e-6);
  assert!(!f.is_be());
}

#[test]
fn grayf32_be_frame_alias_exposes_be_true() {
  // Phase 4: `Grayf32BeFrame` alias resolves to `Grayf32Frame<'_, true>`.
  let buf = [0.0f32; 16];
  let f = Grayf32BeFrame::try_new(&buf, 4, 4, 4).unwrap();
  assert!(f.is_be());
}