Struct ffmpeg::avcodec::AvFrameBuilder

pub struct AvFrameBuilder(AvFrame);

A builder for AVFrame that allows specifying buffers and image metadata.

Tuple Fields

0: AvFrame

Implementations

impl AvFrameBuilder

pub fn set_dimensions( &mut self, dimensions: Dimensions ) -> Result<(), AvFrameError>

Set the frame’s width and height.

The dimensions must not be greater than i32::MAX.

pub fn set_format(&mut self, format: AvPixelFormat) -> Result<(), AvFrameError>

Set the frame’s format.

pub fn build_owned<BI: IntoIterator<Item = AvBuffer>, PI: IntoIterator<Item = PlaneDescriptor>>( self, buffers: BI, planes: PI ) -> Result<AvFrame, AvFrameError>

Build an AvFrame from iterators of AvBuffers and subslice of buffers describing the planes.

The frame will own the buffers.

This function checks that:

• Each plane fits inside the bounds of the associated buffer.
• Different planes do not overlap each other’s buffer slice. In this check, all planes are assumed to be potentially mutable, regardless of whether the AvFrame is actually used for read or write access. Aliasing reference to the same buffer will be rejected, since it can potentially allow routines to overwrite each An exception to this is when the same buffer is passed multiple times in buffers. In this case, each buffer is treated as a different buffer. Since clones have to be made to be passed multiple times in buffers, the frame will not be considered writable. Hence aliasing is safe in this case, but the caller is required to explicit opt-in to this read-only handling by passing clones of the buffer into buffers and have a different buffer index for each plane combination that could overlap in their range.