Skip to main content

FramePool

Struct FramePool 

Source
pub struct FramePool { /* private fields */ }
Expand description

Frame pool for reusing frame allocations.

Supports both typed VideoFrame/AudioFrame recycling and a raw byte-buffer free-list that can be pre-allocated via FramePoolConfig.

Implementations§

Source§

impl FramePool

Source

pub fn new(capacity: usize) -> Self

Create a new frame pool with the given capacity for typed frames.

Source

pub fn with_config(config: FramePoolConfig) -> Self

Create a pool pre-populated according to config.

config.pre_allocate zeroed buffers of config.frame_bytes bytes are placed in the internal free-list immediately, so the first pre_allocate calls to Self::acquire_raw return without any heap allocation.

Source

pub fn acquire_raw(&mut self) -> Vec<u8>

Acquire a raw byte buffer from the free-list, or allocate a new one.

If frame_bytes was set in the config, the returned buffer is exactly that size. Otherwise a zero-length buffer is returned for newly allocated entries — callers should resize as needed.

Source

pub fn release_raw(&mut self, buf: Vec<u8>)

Return a raw byte buffer to the free-list for reuse.

Silently drops the buffer when the free-list is at capacity.

Source

pub fn pre_allocated_count(&self) -> usize

Number of raw buffers currently available in the free-list.

Source

pub fn get_video_frame( &mut self, format: PixelFormat, width: u32, height: u32, ) -> VideoFrame

Get a video frame from the pool or create a new one.

Source

pub fn return_video_frame(&mut self, frame: VideoFrame)

Return a video frame to the pool.

Source

pub fn get_audio_frame( &mut self, format: SampleFormat, sample_rate: u32, channels: ChannelLayout, ) -> AudioFrame

Get an audio frame from the pool or create a new one.

Source

pub fn return_audio_frame(&mut self, frame: AudioFrame)

Return an audio frame to the pool.

Source

pub fn clear(&mut self)

Clear all pooled frames.

Source

pub fn video_frame_count(&self) -> usize

Get the number of video frames in the pool.

Source

pub fn audio_frame_count(&self) -> usize

Get the number of audio frames in the pool.

Trait Implementations§

Source§

impl Default for FramePool

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.