Struct StatelessDecoder

pub struct StatelessDecoder<C, B>
where
    C: StatelessCodec,
    B: StatelessDecoderBackend + StatelessDecoderBackendPicture<C>,
{ /* private fields */ }

A struct that serves as a basis to implement a stateless decoder.

A stateless decoder is defined by three generic parameters:

• A codec, represented by a type that implements StatelessCodec. This type defines the codec-specific decoder state and other codec properties.
• A backend, i.e. an interface to talk to the hardware that accelerates decoding. An example is the VAAPI backend that uses VAAPI for acceleration. The backend will typically itself be typed against a memory decriptor, defining how memory is provided for decoded frames.

So for instance, a decoder for the H264 codec, using VAAPI for acceleration with self-managed memory, will have the following type:

let decoder: StatelessDecoder<H264, VaapiBackend<()>>;

This struct just manages the high-level decoder state as well as the queue of decoded frames. All the rest is left to codec-specific code.

Implementations

impl<M: SurfaceMemoryDescriptor + 'static> StatelessDecoder<Av1, VaapiBackend<M>>

pub fn new_vaapi<S>( display: Rc<Display>, blocking_mode: BlockingMode, ) -> Result<Self, NewStatelessDecoderError>

where M: From<S>, S: From<M>,

impl<M: SurfaceMemoryDescriptor + 'static> StatelessDecoder<H264, VaapiBackend<M>>

pub fn new_vaapi<S>( display: Rc<Display>, blocking_mode: BlockingMode, ) -> Result<Self, NewStatelessDecoderError>

where M: From<S>, S: From<M>,

impl<M: SurfaceMemoryDescriptor + 'static> StatelessDecoder<H265, VaapiBackend<M>>

pub fn new_vaapi<S>( display: Rc<Display>, blocking_mode: BlockingMode, ) -> Result<Self, NewStatelessDecoderError>

where M: From<S>, S: From<M>,

impl<M: SurfaceMemoryDescriptor + 'static> StatelessDecoder<Vp8, VaapiBackend<M>>

pub fn new_vaapi<S>( display: Rc<Display>, blocking_mode: BlockingMode, ) -> Result<Self, NewStatelessDecoderError>

where M: From<S>, S: From<M>,

impl<M: SurfaceMemoryDescriptor + 'static> StatelessDecoder<Vp9, VaapiBackend<M>>

pub fn new_vaapi<S>( display: Rc<Display>, blocking_mode: BlockingMode, ) -> Result<Self, NewStatelessDecoderError>

where M: From<S>, S: From<M>,

impl<C, B> StatelessDecoder<C, B>

where C: StatelessCodec, B: StatelessDecoderBackend + StatelessDecoderBackendPicture<C> + TryFormat<C>, C::DecoderState<B::Handle, B::Picture>: Default,

pub fn new( backend: B, blocking_mode: BlockingMode, ) -> Result<Self, NewStatelessDecoderError>

Trait Implementations

impl<B> StatelessVideoDecoder for StatelessDecoder<Av1, B>

where B: StatelessAV1DecoderBackend + TryFormat<Av1>, B::Handle: Clone + 'static,

fn decode( &mut self, timestamp: u64, bitstream: &[u8], ) -> Result<usize, DecodeError>

Decode an AV1 stream.

bitstream should initially be submitted as a whole temporal unit, however a call to this method will only consume a single OBU. The caller must be careful to check the return value and resubmit the remainder if the whole bitstream has not been consumed.

type Handle = <B as StatelessDecoderBackend>::Handle

Type of the DecodedHandles that decoded frames are returned into.

type FramePool = <B as StatelessDecoderBackend>::FramePool

FramePool providing frames to decode into. Its descriptor must be the same as StatelessVideoDecoder::Handle.

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

Flush the decoder i.e. finish processing all pending decode requests and make sure the resulting frames are ready to be retrieved via next_event.

fn frame_pool(&mut self, layer: PoolLayer) -> Vec<&mut B::FramePool>

Returns the frame pool for resolution in use with the decoder. If resolution is None, the pool of the highest resolution is returned.

fn stream_info(&self) -> Option<&StreamInfo>

fn next_event(&mut self) -> Option<DecoderEvent<'_, B::Handle>>

Returns the next event, if there is any pending.

fn poll_fd(&self) -> BorrowedFd<'_>

Returns a file descriptor that signals POLLIN whenever an event is pending on this decoder.

fn into_trait_object( self, ) -> DynStatelessVideoDecoder<<Self::Handle as DecodedHandle>::Descriptor>

where Self: Sized + 'static, Self::FramePool: Sized + 'static, Self::Handle: 'static,

Transforms the decoder into a StatelessVideoDecoder trait object.

impl<B> StatelessVideoDecoder for StatelessDecoder<H264, B>

where B: StatelessH264DecoderBackend + TryFormat<H264>, B::Handle: Clone + 'static,

type Handle = <B as StatelessDecoderBackend>::Handle

Type of the DecodedHandles that decoded frames are returned into.

type FramePool = <B as StatelessDecoderBackend>::FramePool

FramePool providing frames to decode into. Its descriptor must be the same as StatelessVideoDecoder::Handle.

fn decode( &mut self, timestamp: u64, bitstream: &[u8], ) -> Result<usize, DecodeError>

Attempts to decode bitstream if the current conditions allow it.

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

Flush the decoder i.e. finish processing all pending decode requests and make sure the resulting frames are ready to be retrieved via next_event.

fn next_event(&mut self) -> Option<DecoderEvent<'_, B::Handle>>

Returns the next event, if there is any pending.

fn frame_pool(&mut self, layer: PoolLayer) -> Vec<&mut B::FramePool>

Returns the frame pool for resolution in use with the decoder. If resolution is None, the pool of the highest resolution is returned.

fn stream_info(&self) -> Option<&StreamInfo>

fn poll_fd(&self) -> BorrowedFd<'_>

Returns a file descriptor that signals POLLIN whenever an event is pending on this decoder.

fn into_trait_object( self, ) -> DynStatelessVideoDecoder<<Self::Handle as DecodedHandle>::Descriptor>

where Self: Sized + 'static, Self::FramePool: Sized + 'static, Self::Handle: 'static,

Transforms the decoder into a StatelessVideoDecoder trait object.

impl<B> StatelessVideoDecoder for StatelessDecoder<H265, B>

where B: StatelessH265DecoderBackend + TryFormat<H265>, B::Handle: Clone + 'static,

type Handle = <B as StatelessDecoderBackend>::Handle

Type of the DecodedHandles that decoded frames are returned into.

type FramePool = <B as StatelessDecoderBackend>::FramePool

FramePool providing frames to decode into. Its descriptor must be the same as StatelessVideoDecoder::Handle.

fn decode( &mut self, timestamp: u64, bitstream: &[u8], ) -> Result<usize, DecodeError>

Attempts to decode bitstream if the current conditions allow it.

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

Flush the decoder i.e. finish processing all pending decode requests and make sure the resulting frames are ready to be retrieved via next_event.

fn next_event(&mut self) -> Option<DecoderEvent<'_, B::Handle>>

Returns the next event, if there is any pending.

fn frame_pool(&mut self, layer: PoolLayer) -> Vec<&mut B::FramePool>

Returns the frame pool for resolution in use with the decoder. If resolution is None, the pool of the highest resolution is returned.

fn stream_info(&self) -> Option<&StreamInfo>

fn poll_fd(&self) -> BorrowedFd<'_>

Returns a file descriptor that signals POLLIN whenever an event is pending on this decoder.

fn into_trait_object( self, ) -> DynStatelessVideoDecoder<<Self::Handle as DecodedHandle>::Descriptor>

where Self: Sized + 'static, Self::FramePool: Sized + 'static, Self::Handle: 'static,

Transforms the decoder into a StatelessVideoDecoder trait object.

impl<B> StatelessVideoDecoder for StatelessDecoder<Vp8, B>

where B: StatelessVp8DecoderBackend + TryFormat<Vp8>, B::Handle: Clone + 'static,

type Handle = <B as StatelessDecoderBackend>::Handle

Type of the DecodedHandles that decoded frames are returned into.

type FramePool = <B as StatelessDecoderBackend>::FramePool

FramePool providing frames to decode into. Its descriptor must be the same as StatelessVideoDecoder::Handle.

fn decode( &mut self, timestamp: u64, bitstream: &[u8], ) -> Result<usize, DecodeError>

Attempts to decode bitstream if the current conditions allow it.

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

Flush the decoder i.e. finish processing all pending decode requests and make sure the resulting frames are ready to be retrieved via next_event.

fn next_event(&mut self) -> Option<DecoderEvent<'_, B::Handle>>

Returns the next event, if there is any pending.

fn frame_pool(&mut self, layer: PoolLayer) -> Vec<&mut B::FramePool>

Returns the frame pool for resolution in use with the decoder. If resolution is None, the pool of the highest resolution is returned.

fn stream_info(&self) -> Option<&StreamInfo>

fn poll_fd(&self) -> BorrowedFd<'_>

Returns a file descriptor that signals POLLIN whenever an event is pending on this decoder.

fn into_trait_object( self, ) -> DynStatelessVideoDecoder<<Self::Handle as DecodedHandle>::Descriptor>

where Self: Sized + 'static, Self::FramePool: Sized + 'static, Self::Handle: 'static,

Transforms the decoder into a StatelessVideoDecoder trait object.

impl<B> StatelessVideoDecoder for StatelessDecoder<Vp9, B>

where B: StatelessVp9DecoderBackend + TryFormat<Vp9>, B::Handle: Clone + 'static,

type Handle = <B as StatelessDecoderBackend>::Handle

Type of the DecodedHandles that decoded frames are returned into.

type FramePool = <B as StatelessDecoderBackend>::FramePool

FramePool providing frames to decode into. Its descriptor must be the same as StatelessVideoDecoder::Handle.

fn decode( &mut self, timestamp: u64, bitstream: &[u8], ) -> Result<usize, DecodeError>

Attempts to decode bitstream if the current conditions allow it.

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

Flush the decoder i.e. finish processing all pending decode requests and make sure the resulting frames are ready to be retrieved via next_event.

fn next_event(&mut self) -> Option<DecoderEvent<'_, B::Handle>>

Returns the next event, if there is any pending.

fn frame_pool(&mut self, layer: PoolLayer) -> Vec<&mut B::FramePool>

Returns the frame pool for resolution in use with the decoder. If resolution is None, the pool of the highest resolution is returned.

fn stream_info(&self) -> Option<&StreamInfo>

fn poll_fd(&self) -> BorrowedFd<'_>

Returns a file descriptor that signals POLLIN whenever an event is pending on this decoder.

fn into_trait_object( self, ) -> DynStatelessVideoDecoder<<Self::Handle as DecodedHandle>::Descriptor>

where Self: Sized + 'static, Self::FramePool: Sized + 'static, Self::Handle: 'static,

Transforms the decoder into a StatelessVideoDecoder trait object.