Trait cros_codecs::decoder::FramePool

pub trait FramePool<M> {
    // Required methods
    fn coded_resolution(&self) -> Resolution;
    fn set_coded_resolution(&mut self, resolution: Resolution);
    fn add_frames(&mut self, descriptors: Vec<M>) -> Result<(), Error>;
    fn num_free_frames(&self) -> usize;
    fn num_managed_frames(&self) -> usize;
    fn clear(&mut self);
    fn take_free_frame(&mut self) -> Option<Box<dyn AsRef<M>>>;
}

Trait for a pool of frames in a particular format.

This is mostly useful for the decoder where the user is expected to manage how the decoded frames buffers are allocated and when.

The M generic parameter is the type of the descriptors for the memory backing the frames.

Required Methods

fn coded_resolution(&self) -> Resolution

Returns the coded resolution of the pool.

All the frames maintained by this pool are guaranteed to be able to contain the coded resolution.

fn set_coded_resolution(&mut self, resolution: Resolution)

Update the coded resolution of the pool.

Frames managed by this pool that can not contain the new resolution are dropped.

fn add_frames(&mut self, descriptors: Vec<M>) -> Result<(), Error>

Add new frames to the pool, using descriptors as backing memory.

fn num_free_frames(&self) -> usize

Returns new number of frames currently available in this pool.

fn num_managed_frames(&self) -> usize

Returns the total number of managed frames in this pool.

fn clear(&mut self)

Remove all frames from this pool.

fn take_free_frame(&mut self) -> Option<Box<dyn AsRef<M>>>

Returns an object holding one of the available frames from this pool. The frame will be available for rendering again once the returned object is dropped.

This is useful to prevent decoding from happening by holding all the available frames.

Returns None if there is no free frame at the time of calling.

Implementations on Foreign Types

impl<M: SurfaceMemoryDescriptor + 'static> FramePool<M> for Rc<RefCell<SurfacePool<M>>>

fn coded_resolution(&self) -> Resolution

fn set_coded_resolution(&mut self, resolution: Resolution)

fn add_frames(&mut self, descriptors: Vec<M>) -> Result<(), Error>

fn num_free_frames(&self) -> usize

fn num_managed_frames(&self) -> usize

fn clear(&mut self)

fn take_free_frame(&mut self) -> Option<Box<dyn AsRef<M>>>

Implementors