Skip to main content

ImageProcessor

Struct ImageProcessor 

Source
pub struct ImageProcessor {
    pub cpu: Option<CPUProcessor>,
    pub g2d: Option<G2DProcessor>,
    pub opengl: Option<GLProcessorThreaded>,
    /* private fields */
}
Expand description

Image converter that uses available hardware acceleration or CPU as a fallback.

Fields§

§cpu: Option<CPUProcessor>

CPU-based image converter as a fallback. This is only None if the EDGEFIRST_DISABLE_CPU environment variable is set.

§g2d: Option<G2DProcessor>

G2D-based image converter for Linux systems. This is only available if the EDGEFIRST_DISABLE_G2D environment variable is not set and libg2d.so is available.

§opengl: Option<GLProcessorThreaded>

OpenGL-based image converter for Linux systems. This is only available if the EDGEFIRST_DISABLE_GL environment variable is not set and OpenGL ES is available.

Implementations§

Source§

impl ImageProcessor

Source

pub fn new() -> Result<Self>

Creates a new ImageProcessor instance, initializing available hardware converters based on the system capabilities and environment variables.

§Examples
let image = include_bytes!(concat!(env!("CARGO_MANIFEST_DIR"), "/../../testdata/zidane.jpg"));
let src = load_image(image, Some(PixelFormat::Rgba), None)?;
let mut converter = ImageProcessor::new()?;
let mut dst = converter.create_image(640, 480, PixelFormat::Rgb, DType::U8, None)?;
converter.convert(&src, &mut dst, Rotation::None, Flip::None, Crop::default())?;
Source

pub fn with_config(config: ImageProcessorConfig) -> Result<Self>

Creates a new ImageProcessor with the given configuration.

When ImageProcessorConfig::backend is set to a specific backend, environment variables are ignored and the processor initializes the requested backend plus CPU as a fallback.

When Auto, the existing EDGEFIRST_FORCE_BACKEND and EDGEFIRST_DISABLE_* environment variables apply.

Source

pub fn set_int8_interpolation_mode( &mut self, mode: Int8InterpolationMode, ) -> Result<()>

Sets the interpolation mode for int8 proto textures on the OpenGL backend. No-op if OpenGL is not available.

Source

pub fn create_image( &self, width: usize, height: usize, format: PixelFormat, dtype: DType, memory: Option<TensorMemory>, ) -> Result<TensorDyn>

Create a TensorDyn image with the best available memory backend.

Priority: DMA-buf → PBO (byte-sized types: u8, i8) → system memory.

Use this method instead of TensorDyn::image() when the tensor will be used with ImageProcessor::convert(). It selects the optimal memory backing (including PBO for GPU zero-copy) which direct allocation cannot achieve.

This method is on ImageProcessor rather than ImageProcessorTrait because optimal allocation requires knowledge of the active compute backends (e.g. the GL context handle for PBO allocation). Individual backend implementations (CPUProcessor, etc.) do not have this cross-backend visibility.

§Arguments
  • width - Image width in pixels
  • height - Image height in pixels
  • format - Pixel format
  • dtype - Element data type (e.g. DType::U8, DType::I8)
  • memory - Optional memory type override; when None, the best available backend is selected automatically.
§Returns

A TensorDyn backed by the highest-performance memory type available on this system.

§Errors

Returns an error if all allocation strategies fail.

Source

pub fn import_image( &self, image: PlaneDescriptor, chroma: Option<PlaneDescriptor>, width: usize, height: usize, format: PixelFormat, dtype: DType, ) -> Result<TensorDyn>

Import an external DMA-BUF image.

Each [PlaneDescriptor] owns an already-duped fd; this method consumes the descriptors and takes ownership of those fds (whether the call succeeds or fails).

The caller must ensure the DMA-BUF allocation is large enough for the specified width, height, format, and any stride/offset on the plane descriptors. No buffer-size validation is performed; an undersized buffer may cause GPU faults or EGL import failure.

§Arguments
  • image - Plane descriptor for the primary (or only) plane
  • chroma - Optional plane descriptor for the UV chroma plane (required for multiplane NV12)
  • width - Image width in pixels
  • height - Image height in pixels
  • format - Pixel format of the buffer
  • dtype - Element data type (e.g. DType::U8)
§Returns

A TensorDyn configured as an image.

§Errors
§Platform

Linux only.

§Examples
use edgefirst_tensor::PlaneDescriptor;

// Single-plane RGBA
let pd = PlaneDescriptor::new(fd.as_fd())?;
let src = proc.import_image(pd, None, 1920, 1080, PixelFormat::Rgba, DType::U8)?;

// Multi-plane NV12 with stride
let y_pd = PlaneDescriptor::new(y_fd.as_fd())?.with_stride(2048);
let uv_pd = PlaneDescriptor::new(uv_fd.as_fd())?.with_stride(2048);
let src = proc.import_image(y_pd, Some(uv_pd), 1920, 1080,
                            PixelFormat::Nv12, DType::U8)?;

Trait Implementations§

Source§

impl Debug for ImageProcessor

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl ImageProcessorTrait for ImageProcessor

Source§

fn convert( &mut self, src: &TensorDyn, dst: &mut TensorDyn, rotation: Rotation, flip: Flip, crop: Crop, ) -> Result<()>

Converts the source image to the destination image format and size. The image is cropped first, then flipped, then rotated

Prefer hardware accelerators when available, falling back to CPU if necessary.

Source§

fn draw_masks( &mut self, dst: &mut TensorDyn, detect: &[DetectBox], segmentation: &[Segmentation], ) -> Result<()>

Draw pre-decoded detection boxes and segmentation masks onto dst. Read more
Source§

fn draw_masks_proto( &mut self, dst: &mut TensorDyn, detect: &[DetectBox], proto_data: &ProtoData, ) -> Result<()>

Draw masks from proto data onto image (fused decode+draw). Read more
Source§

fn set_class_colors(&mut self, colors: &[[u8; 4]]) -> Result<()>

Sets the colors used for rendering segmentation masks. Up to 20 colors can be set.
Source§

fn decode_masks_atlas( &mut self, detect: &[DetectBox], proto_data: ProtoData, output_width: usize, output_height: usize, ) -> Result<(Vec<u8>, Vec<MaskRegion>)>

Decode masks into a compact atlas buffer. Read more
Source§

impl Send for ImageProcessor

Source§

impl Sync for ImageProcessor

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V