Struct NativeExportDecoder 

pub struct NativeExportDecoder { /* private fields */ }

Export decoder producing NativeVideoFrames from one FFmpeg session.

Software and hardware sessions share the same demux, seek, and timing logic (NativeDecoder); a hardware backend changes only where the frame’s pixels live.

Implementations

impl NativeExportDecoder

pub fn take_stage_timings(&mut self) -> DecodeStageTimings

Takes the decode-stage spans accumulated since the last call.

A hardware session reports no conversion time because it produces a surface rather than pixels; its cost is in receive_frame.

pub const fn is_hardware(&self) -> bool

Whether this session currently produces device-resident frames.

pub fn open(path: impl AsRef<Path>) -> Result<Self, DecodeError>

Opens the selected video stream using the software implementation.

Errors

Returns a native decode error if the input or selected stream cannot be opened.

pub fn open_with_threads( path: impl AsRef<Path>, threads: i64, ) -> Result<Self, DecodeError>

Opens with an explicit codec worker allocation.

Errors

Returns a native decode error for invalid worker counts or stream setup failures.

pub fn open_vulkan( path: impl AsRef<Path>, threads: i64, context: &SharedVulkanContext, generation: u64, ) -> Result<Self, HardwareOpenError>

Opens a Vulkan hardware decoder on the renderer’s logical device.

Errors

Returns a native decode error if the stream lacks a compatible Vulkan hardware configuration or the decoder cannot use the shared device.

pub fn streams(&self) -> &[StreamInfo]

Stream descriptions from the common decode session.

pub fn video_duration(&self) -> Option<MediaTime>

Effective end of the selected video source.

pub fn flush(&mut self) -> Result<(), DecodeError>

Resets codec and demux state.

Errors

Returns a native decode error if the codec state cannot be reset.

pub fn seek_video( &mut self, request: DecodeRequest, cancel: &CancelToken, ) -> Result<NativeVideoFrame, DecodeError>

Seeks and returns the selected native frame.

Errors

Returns a native decode error for cancellation, seek, decode, or timestamp failures.

pub fn decode_video_next( &mut self, cancel: &CancelToken, ) -> Result<Option<NativeVideoFrame>, DecodeError>

Decodes the next native frame, or None at end of stream.

Errors

Returns a native decode error for cancellation or codec failures.

pub fn peek_video_pts( &mut self, cancel: &CancelToken, ) -> Result<Option<MediaTime>, DecodeError>

When the frame Self::decode_video_next returns next is presented, or None at the end of the stream.

The frame is decoded now and kept for that call, so a caller can find the frame presented at a time (the last one at or before its Self::presentation_deadline) without consuming the one after.

Errors

Returns a native decode error for cancellation or codec failures.

pub fn set_decode_policy(&mut self, policy: DecodePolicy)

Configures corruption handling on the selected native backend.

pub fn with_declared_color( self, color: Option<ColorMetadata>, ) -> Result<Self, HardwareOpenError>

Takes the color a project declares for this source, which every frame then carries (NativeDecoder::declare_color).

Errors

Returns HardwareDecodeFallback::UnsupportedColor for a hardware session declared HDR: the hardware path presents SDR only, as it refuses a stream tagged HDR when it opens.

pub fn set_decode_reporter( &mut self, reporter: impl Fn(DecodeDiagnostic) + Send + Sync + 'static, )

Reports damage before any recovery or terminal error.

pub fn decode_diagnostics(&mut self) -> &DecodeDiagnostics

Cumulative corruption diagnostics for this session.

pub fn presentation_deadline(&self, time: MediaTime) -> MediaTime

The latest timestamp a frame of this stream may carry and still be the one shown at time (NativeDecoder::presentation_deadline).

pub const fn hardware_failure(&self) -> Option<HardwareDecodeFallback>

Why this session’s hardware path gave up, once a call has returned DecodeError::Unsupported for it.