Skip to main content

ImageDecoder

Struct ImageDecoder 

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

Reusable image decoder with internal scratch buffers.

Create one ImageDecoder at program initialisation and pass it to ImageLoad::load_image in the hot loop. The scratch buffers grow to the high-water mark and are reused across calls — no per-frame allocations after the first few frames.

The decoder always produces the source’s native format and configures the destination tensor’s dimensions + pixel format accordingly (JPEG → Nv12/Grey, PNG → Rgb/Rgba/Grey). It never colour-converts or rotates; use ImageProcessor::convert() for that.

§Example

use edgefirst_codec::{ImageDecoder, ImageLoad};
use edgefirst_tensor::{Tensor, TensorTrait, TensorMemory, PixelFormat};

let mut decoder = ImageDecoder::new();
// Allocate a buffer large enough for the biggest expected image.
let mut tensor = Tensor::<u8>::image(1920, 1080, PixelFormat::Nv12, Some(TensorMemory::Mem))
    .expect("alloc");

for _ in 0..100 {
    let frame = std::fs::read("frame.jpg").unwrap();
    let _info = tensor.load_image(&mut decoder, &frame);
}

Implementations§

Source§

impl ImageDecoder

Source

pub fn new() -> Self

Create a new decoder with empty scratch buffers.

Source

pub fn decode_into<T: ImagePixel>( &mut self, data: &[u8], dst: &mut Tensor<T>, ) -> Result<ImageInfo>

Decode image data into a typed tensor, configuring its dimensions and pixel format to the decoded native format.

Detects the image format (JPEG or PNG) from magic bytes.

§Errors
Source

pub fn decode_into_dyn( &mut self, data: &[u8], dst: &mut TensorDyn, ) -> Result<ImageInfo>

Decode image data into a type-erased tensor.

Source

pub fn decode_from_reader<T: ImagePixel, R: Read>( &mut self, reader: R, dst: &mut Tensor<T>, ) -> Result<ImageInfo>

Read all bytes from a Read source into the internal input buffer, then decode. The input buffer is reused across calls.

Source

pub fn decode_from_reader_dyn<R: Read>( &mut self, reader: R, dst: &mut TensorDyn, ) -> Result<ImageInfo>

Read all bytes from a Read source, then decode into a type-erased tensor.

Trait Implementations§

Source§

impl Default for ImageDecoder

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more