Crate styx_capture 

styx-capture

Capture descriptors/config validation and the CaptureSource trait for zero-copy frame producers. Includes helpers for building frames from buffer pools and a simple virtual backend for tests.

Documentation

• https://docs.rs/styx-capture

Install

[dependencies]
styx-capture = "0.1.0"

Key types

• Mode / ModeId: advertised capture modes (FourCc + resolution + intervals).
• CaptureDescriptor: modes + control metadata for a device/source.
• CaptureConfig: user-selected mode/interval/controls with validation.
• CaptureSource: trait yielding FrameLease frames (sync-first).

Building descriptors

modes_from_formats converts a list of MediaFormat values into modes, or build them manually:

use styx_capture::prelude::*;

let mode = Mode {
    id: ModeId(0),
    format: MediaFormat::new(FourCc::new(*b"RG24"), Resolution::new(640, 480).unwrap(), ColorSpace::Srgb),
    intervals: smallvec::smallvec![],
    interval_stepwise: None,
};
let descriptor = CaptureDescriptor { modes: vec![mode], controls: Vec::new() };
let cfg = CaptureConfig { mode: ModeId(0), interval: None, controls: vec![] };
cfg.validate(&descriptor).unwrap();

Virtual capture

virtual_backend::VirtualCapture emits patterned frames from a pool:

use styx_capture::prelude::*;

let pool = BufferPool::with_limits(4, 1 << 20, 8);
let mode = modes_from_formats([MediaFormat::new(FourCc::new(*b"RG24"), Resolution::new(320, 180).unwrap(), ColorSpace::Srgb)])[0].clone();
let cap = virtual_backend::VirtualCapture::new(mode.clone(), pool, 3);
let frame = cap.next_frame().unwrap();
assert_eq!(frame.meta().format.code, FourCc::new(*b"RG24"));

Frame helpers

build_frame_from_pool constructs a single-plane frame with the correct layout/stride for a given FourCc/resolution, returning a pooled FrameLease ready for downstream codecs or pipelines.

Modules

prelude

virtual_backend

Virtual capture backend that emits patterned frames from a buffer pool.

Structs

CaptureConfig

User-selected configuration validated against a descriptor.

CaptureDescriptor

Descriptor for a capture device/source.

Mode

Descriptor for a single capture mode (format + intervals).

ModeId

Identifier for a capture mode keyed by its format and optional interval.

Traits

CaptureSource

Trait implemented by capture backends that yield zero-copy frames.

Functions

build_frame_from_pool

Helper to construct a simple frame from a pooled buffer.

modes_from_formats

Utility to create a mode id list from formats.