oa::video

video module in the OA Vision public surface.

MdRust public API

Public Types

Public Functions

pub fn emit_nal_annex_b(units: &[NalUnit<'_>]) -> Result<Vec<u8>>

pub fn extract_pps(bytes: &[u8]) -> Option<Vec<u8>>

pub fn extract_pps_h265(bytes: &[u8]) -> Option<Vec<u8>>

pub fn extract_sps(bytes: &[u8]) -> Option<Vec<u8>>

pub fn extract_sps_h265(bytes: &[u8]) -> Option<Vec<u8>>

pub fn extract_vps_h265(bytes: &[u8]) -> Option<Vec<u8>>

pub fn from_texture( texture: &Texture, timing: VideoFrameTiming, color: VideoColorInfo, ) -> Result<VideoFrame>

pub fn from_texture_with_ready( texture: &Texture, timing: VideoFrameTiming, color: VideoColorInfo, ready: &Event, ) -> Result<VideoFrame>

pub fn inspect_av1_access_unit(bytes: &[u8]) -> Result<Av1AccessUnitInfo>

pub fn length_prefixed_to_annex_b( sample: &[u8], length_size: usize, ) -> Result<Vec<u8>>

pub fn parse_av1_frame_header( payload: &[u8], sequence: &Av1SequenceHeader, references: &Av1ReferenceState, ) -> Result<Av1FrameHeader>

pub fn parse_av1_obus(bytes: &[u8]) -> Result<Vec<Av1Obu<'_>>>

pub fn parse_av1_sequence_header(payload: &[u8]) -> Result<Av1SequenceHeader>

pub fn parse_av1_tile_group( obu: Av1Obu<'_>, frame: &Av1FrameHeader, ) -> Result<Av1TileGroup>

pub fn parse_h264_pps( nal: &[u8], sps: &H264SequenceParameterSet, ) -> Result<H264PictureParameterSet>

pub fn parse_h264_slice_header( nal: &[u8], sps: &H264SequenceParameterSet, pps: &H264PictureParameterSet, ) -> Result<H264SliceHeader>

pub fn parse_h264_sps(nal: &[u8]) -> Result<H264SequenceParameterSet>

pub fn parse_h265_pps(nal: &[u8]) -> Result<H265PictureParameterSet>

pub fn parse_h265_slice_header( nal: &[u8], sps: &H265SequenceParameterSet, pps: &H265PictureParameterSet, ) -> Result<H265SliceHeader>

pub fn parse_h265_sps(nal: &[u8]) -> Result<H265SequenceParameterSet>

pub fn parse_h265_vps(nal: &[u8]) -> Result<H265VideoParameterSet>

pub fn parse_nal_annex_b(bytes: &[u8]) -> Vec<NalUnit<'_>>

pub fn query_decode_capabilities( engine: &Engine, profile: VideoDecodeProfile, ) -> Result<VideoDecodeCapabilities>

pub fn query_decode_formats( engine: &Engine, profile: VideoDecodeProfile, ) -> Result<VideoDecodeFormats>

pub fn query_device_capabilities( engine: &Engine, ) -> Result<VideoDeviceCapabilities>

pub fn query_encode_capabilities( engine: &Engine, profile: VideoEncodeProfile, ) -> Result<VideoEncodeCapabilities>

pub fn query_encode_formats( engine: &Engine, profile: VideoEncodeProfile, ) -> Result<VideoEncodeFormats>

Function Documentation

pub fn emit_nal_annex_b(
	units: &[NalUnit<'_>]
) -> Result<Vec<u8>>

Emit borrowed NAL payloads as canonical four-byte-start-code Annex-B. Errors Returns an error when the output size overflows or host allocation fails.

pub fn extract_pps(
	bytes: &[u8]
) -> Option<Vec<u8>>

Copy the first H.264 picture parameter set payload.

pub fn extract_pps_h265(
	bytes: &[u8]
) -> Option<Vec<u8>>

Copy the first H.265 picture parameter set payload.

pub fn extract_sps(
	bytes: &[u8]
) -> Option<Vec<u8>>

Copy the first H.264 sequence parameter set payload.

pub fn extract_sps_h265(
	bytes: &[u8]
) -> Option<Vec<u8>>

Copy the first H.265 sequence parameter set payload.

pub fn extract_vps_h265(
	bytes: &[u8]
) -> Option<Vec<u8>>

Copy the first H.265 video parameter set payload.

pub fn from_texture(
	texture: &Texture,
	timing: VideoFrameTiming,
	color: VideoColorInfo
) -> Result<VideoFrame>

Retain a render Texture as one timestamped video frame. The returned frame shares a buffer-backed Texture’s packed RGBA8 storage, semantic identity, and exact Matrix producer readiness. It performs no pixel copy, submission, wait, or Image conversion. Render targets require from_texture_with_ready so their producer completion is not lost. Errors Returns an error for a render-target-backed Texture.

pub fn from_texture_with_ready(
	texture: &Texture,
	timing: VideoFrameTiming,
	color: VideoColorInfo,
	ready: &Event
) -> Result<VideoFrame>

Retain a texture and its exact producer completion in one video frame. This is the render-target path: it shares the texture and event without a readback, wait, or pixel copy. The event must belong to the texture’s Engine. Errors Returns an error when ready comes from a different Engine.

pub fn inspect_av1_access_unit(
	bytes: &[u8]
) -> Result<Av1AccessUnitInfo>

Inspect one raw access unit or the first frame of an IVF byte stream. Errors Returns an error for malformed IVF framing, invalid OBU structure, count overflow, or an empty frame payload.

pub fn length_prefixed_to_annex_b(
	sample: &[u8],
	length_size: usize
) -> Result<Vec<u8>>

Convert an MP4 length-prefixed H.264/H.265 sample into Annex-B NAL units. Errors Returns an error for a length width other than 1, 2, or 4, a truncated length field, a zero-sized NAL unit, arithmetic overflow, or payload overrun.

pub fn parse_av1_frame_header(
	payload: &[u8],
	sequence: &Av1SequenceHeader,
	references: &Av1ReferenceState
) -> Result<Av1FrameHeader>

Parse one AV1 frame or frame-header OBU payload against explicit reference state. Errors Returns an error for truncated or inconsistent syntax and for donor features that are not yet represented: frame IDs, decoder-model removal timing, short reference signaling, non-uniform tiles, global motion, and film grain.

pub fn parse_av1_obus(
	bytes: &[u8]
) -> Result<Vec<Av1Obu<'_>>>

Split one raw AV1 access-unit payload into borrowed OBUs. Errors Returns an error for forbidden/reserved header bits, truncated extensions or LEB128 sizes, payload overruns, empty input, and arithmetic overflow.

pub fn parse_av1_sequence_header(
	payload: &[u8]
) -> Result<Av1SequenceHeader>

Parse one AV1 sequence-header OBU payload. Pass Av1Obu::payload from an OBU whose type is Av1ObuType::SequenceHeader. The returned representation is independent of Vulkan’s standard-video C structures and retains the stream metadata needed to create exact backend profiles and session parameters. Errors Returns an error when the payload is empty or truncated, declares a reserved profile, carries an invalid frame-ID length, or encodes a chroma layout outside the AV1 profile rules.

pub fn parse_av1_tile_group(
	obu: Av1Obu<'_>,
	frame: &Av1FrameHeader
) -> Result<Av1TileGroup>

Parse the tile ranges carried by one frame or tile-group OBU. Returned offsets are relative to the access-unit byte slice originally passed to super::parse_av1_obus, matching Vulkan Video’s source-buffer offset convention. Errors Returns an error for an incompatible OBU type, missing payload, invalid tile count/range/size width, truncated size fields, payload overruns, or offsets that do not fit Vulkan’s 32-bit tile arrays.

pub fn parse_h264_pps(
	nal: &[u8],
	sps: &H264SequenceParameterSet
) -> Result<H264PictureParameterSet>

Parse one raw H.264 PPS NAL unit without an Annex-B start code.

pub fn parse_h264_slice_header(
	nal: &[u8],
	sps: &H264SequenceParameterSet,
	pps: &H264PictureParameterSet
) -> Result<H264SliceHeader>

Parse one raw H.264 coded-slice NAL using its resolved SPS and PPS. The returned picture-order-count field contains the coded LSB for POC type zero. POC types one and two require prior-picture state and therefore return None; the decoder session must derive the final POC rather than inventing a stateless approximation.

pub fn parse_h264_sps(
	nal: &[u8]
) -> Result<H264SequenceParameterSet>

Parse one raw H.264 SPS NAL unit without an Annex-B start code.

pub fn parse_h265_pps(
	nal: &[u8]
) -> Result<H265PictureParameterSet>

Parse one raw H.265 PPS NAL unit without an Annex-B start code.

pub fn parse_h265_slice_header(
	nal: &[u8],
	sps: &H265SequenceParameterSet,
	pps: &H265PictureParameterSet
) -> Result<H265SliceHeader>

Parse one raw H.265 coded-slice NAL using its resolved SPS and PPS. Dependent slice segments and inline inter-predicted short-term reference sets require additional retained state and fail with MissingCapability.

pub fn parse_h265_sps(
	nal: &[u8]
) -> Result<H265SequenceParameterSet>

Parse one raw H.265 SPS NAL unit without an Annex-B start code.

pub fn parse_h265_vps(
	nal: &[u8]
) -> Result<H265VideoParameterSet>

Parse one raw H.265 VPS NAL unit without an Annex-B start code.

pub fn parse_nal_annex_b(
	bytes: &[u8]
) -> Vec<NalUnit<'_>>

Split an Annex-B byte stream into borrowed H.264 NAL payloads. Both 00 00 01 and 00 00 00 01 start codes are recognized. Bytes before the first start code and empty units are ignored, matching the donor oa::FnVideo::parseNalAnnexB contract.

pub fn query_decode_capabilities(
	engine: &Engine,
	profile: VideoDecodeProfile
) -> Result<VideoDecodeCapabilities>

Query the selected device’s exact limits for one decoder profile. Extension advertisement alone does not prove that a particular profile, chroma layout, bit depth, or codec option is usable. This query presents the complete profile to Vulkan and returns MissingCapability when rejected. Errors Returns an error when the codec extension is unavailable, the exact profile is unsupported, or the Vulkan capability query fails.

pub fn query_decode_formats(
	engine: &Engine,
	profile: VideoDecodeProfile
) -> Result<VideoDecodeFormats>

Enumerate decoded-output and DPB image formats for one exact profile. Errors Returns an error when the profile or its codec extension is unsupported, a Vulkan enumeration fails, or the driver reports an unreasonable result size.

pub fn query_device_capabilities(
	engine: &Engine
) -> Result<VideoDeviceCapabilities>

Query Vulkan Video queues and codec extensions on the Engine’s selected device. This query reports both physical-device advertisement and whether Engine creation enabled video queues, and whether at least one qualified codec session path exists. Errors Returns an error when Vulkan device-extension or queue-family enumeration fails.

pub fn query_encode_capabilities(
	engine: &Engine,
	profile: VideoEncodeProfile
) -> Result<VideoEncodeCapabilities>

Query exact H.264 or H.265 encoder limits without creating a session.

pub fn query_encode_formats(
	engine: &Engine,
	profile: VideoEncodeProfile
) -> Result<VideoEncodeFormats>

Enumerate encode-input and DPB formats for one exact profile.