Struct J2kDecoder 

pub struct J2kDecoder<'a> { /* private fields */ }

JPEG 2000 decoder that can return host or Metal-resident surfaces.

Implementations

impl<'a> J2kDecoder<'a>

pub fn new(input: &'a [u8]) -> Result<Self, Error>

Parse a J2K or HTJ2K codestream into a decoder.

pub fn from_view(view: J2kView<'a>) -> Result<Self, Error>

Create a decoder from an already parsed J2K view.

pub fn inner(&self) -> &CpuDecoder<'a>

Borrow the underlying CPU J2K decoder.

pub fn decode_to_device_with_session( &mut self, fmt: PixelFormat, session: &MetalBackendSession, ) -> Result<Surface, Error>

Decode a full image into a Metal-resident device surface.

pub fn decode_to_host_surface( &mut self, fmt: PixelFormat, ) -> Result<Surface, Error>

Decode a full image into a host-backed surface.

pub fn decode_region_to_host_surface( &mut self, fmt: PixelFormat, roi: Rect, ) -> Result<Surface, Error>

Decode a source region into a host-backed surface.

pub fn decode_scaled_to_host_surface( &mut self, fmt: PixelFormat, scale: Downscale, ) -> Result<Surface, Error>

Decode a full image at reduced resolution into a host-backed surface.

pub fn decode_region_scaled_to_host_surface( &mut self, fmt: PixelFormat, roi: Rect, scale: Downscale, ) -> Result<Surface, Error>

Decode a source region at reduced resolution into a host-backed surface.

pub fn decode_to_cpu_staged_metal_surface_with_session( &mut self, fmt: PixelFormat, session: &MetalBackendSession, ) -> Result<Surface, Error>

Decode a full image on CPU and upload the result into a Metal surface.

pub fn decode_region_to_cpu_staged_metal_surface_with_session( &mut self, fmt: PixelFormat, roi: Rect, session: &MetalBackendSession, ) -> Result<Surface, Error>

Decode a source region on CPU and upload the result into a Metal surface.

pub fn decode_scaled_to_cpu_staged_metal_surface_with_session( &mut self, fmt: PixelFormat, scale: Downscale, session: &MetalBackendSession, ) -> Result<Surface, Error>

Decode a full image at reduced resolution on CPU and upload it into Metal.

pub fn decode_region_scaled_to_cpu_staged_metal_surface_with_session( &mut self, fmt: PixelFormat, roi: Rect, scale: Downscale, session: &MetalBackendSession, ) -> Result<Surface, Error>

Decode a scaled source region on CPU and upload it into a Metal surface.

pub fn decode_region_to_device_with_session( &mut self, fmt: PixelFormat, roi: Rect, session: &MetalBackendSession, ) -> Result<Surface, Error>

Decode a source region into a Metal-resident device surface.

pub fn decode_scaled_to_device_with_session( &mut self, fmt: PixelFormat, scale: Downscale, session: &MetalBackendSession, ) -> Result<Surface, Error>

Decode a full image at reduced resolution into a Metal-resident surface.

pub fn decode_region_scaled_to_device_with_session( &mut self, fmt: PixelFormat, roi: Rect, scale: Downscale, session: &MetalBackendSession, ) -> Result<Surface, Error>

Decode a scaled source region into a Metal-resident device surface.

Trait Implementations

impl ImageCodec for J2kDecoder<'_>

type Error = Error

Codec-specific error type.

type Warning = Infallible

Non-fatal warning type returned in successful decode outcomes.

type Pool = J2kScratchPool

Caller-owned scratch pool type used to reuse allocations.

impl<'a> ImageDecode<'a> for J2kDecoder<'a>

type View = J2kView<'a>

Borrowed parse product that can later construct a decoder.

fn inspect(input: &'a [u8]) -> Result<Info, Self::Error>

Inspect metadata without decoding pixels.

fn parse(input: &'a [u8]) -> Result<Self::View, Self::Error>

Parse compressed bytes into a borrowed view.

fn from_view(view: Self::View) -> Result<Self, Self::Error>

Build a decoder from a parsed view.

fn decode_into( &mut self, out: &mut [u8], stride: usize, fmt: PixelFormat, ) -> Result<DecodeOutcome<Self::Warning>, Self::Error>

Decode the full image into caller-owned output.

fn decode_into_with_scratch( &mut self, pool: &mut Self::Pool, out: &mut [u8], stride: usize, fmt: PixelFormat, ) -> Result<DecodeOutcome<Self::Warning>, Self::Error>

Decode the full image into caller-owned output with reusable scratch.

fn decode_region_into( &mut self, pool: &mut Self::Pool, out: &mut [u8], stride: usize, fmt: PixelFormat, roi: Rect, ) -> Result<DecodeOutcome<Self::Warning>, Self::Error>

Decode a source-coordinate region into caller-owned output.

fn decode_scaled_into( &mut self, pool: &mut Self::Pool, out: &mut [u8], stride: usize, fmt: PixelFormat, scale: Downscale, ) -> Result<DecodeOutcome<Self::Warning>, Self::Error>

Decode the full image at reduced resolution into caller-owned output.

fn decode_region_scaled_into( &mut self, pool: &mut Self::Pool, out: &mut [u8], stride: usize, fmt: PixelFormat, roi: Rect, scale: Downscale, ) -> Result<DecodeOutcome<Self::Warning>, Self::Error>

Decode a source-coordinate region at reduced resolution into caller-owned output.

fn decode_request_into( &mut self, pool: &mut Self::Pool, out: &mut [u8], stride: usize, fmt: PixelFormat, request: DecodeRequest, ) -> Result<DecodeOutcome<Self::Warning>, Self::Error>

Decode a normalized full/ROI/scaled request into caller-owned output.

impl<'a> ImageDecodeDevice<'a> for J2kDecoder<'a>

type DeviceSurface = Surface

Device surface returned by decode calls.

fn decode_to_device( &mut self, fmt: PixelFormat, backend: BackendRequest, ) -> Result<Self::DeviceSurface, Self::Error>

where Self: ImageDecodeSubmit<'a, DeviceSurface = Self::DeviceSurface>,

Decode the full image to the requested backend.

fn decode_region_to_device( &mut self, fmt: PixelFormat, roi: Rect, backend: BackendRequest, ) -> Result<Self::DeviceSurface, Self::Error>

where Self: ImageDecodeSubmit<'a, DeviceSurface = Self::DeviceSurface>,

Decode a source-coordinate region to the requested backend.

fn decode_scaled_to_device( &mut self, fmt: PixelFormat, scale: Downscale, backend: BackendRequest, ) -> Result<Self::DeviceSurface, Self::Error>

where Self: ImageDecodeSubmit<'a, DeviceSurface = Self::DeviceSurface>,

Decode the full image at reduced resolution to the requested backend.

fn decode_region_scaled_to_device( &mut self, fmt: PixelFormat, roi: Rect, scale: Downscale, backend: BackendRequest, ) -> Result<Self::DeviceSurface, Self::Error>

where Self: ImageDecodeSubmit<'a, DeviceSurface = Self::DeviceSurface>,

Decode a source-coordinate region at reduced resolution to the requested backend.

impl<'a> ImageDecodeSubmit<'a> for J2kDecoder<'a>

type Session = MetalSession

Mutable session state shared across submissions.

type DeviceSurface = Surface

Device surface returned by completed submissions.

type SubmittedSurface = ReadySubmission<Surface, Error>

Submission handle type.

fn submit_to_device( &mut self, session: &mut Self::Session, fmt: PixelFormat, backend: BackendRequest, ) -> Result<Self::SubmittedSurface, Self::Error>

Submit full-image decode to the requested backend.

fn submit_region_to_device( &mut self, session: &mut Self::Session, fmt: PixelFormat, roi: Rect, backend: BackendRequest, ) -> Result<Self::SubmittedSurface, Self::Error>

Submit region decode to the requested backend.

fn submit_scaled_to_device( &mut self, session: &mut Self::Session, fmt: PixelFormat, scale: Downscale, backend: BackendRequest, ) -> Result<Self::SubmittedSurface, Self::Error>

Submit reduced-resolution decode to the requested backend.

fn submit_region_scaled_to_device( &mut self, session: &mut Self::Session, fmt: PixelFormat, roi: Rect, scale: Downscale, backend: BackendRequest, ) -> Result<Self::SubmittedSurface, Self::Error>

Submit region decode at reduced resolution to the requested backend.

fn submit_request_to_device( &mut self, session: &mut Self::Session, fmt: PixelFormat, backend: BackendRequest, request: DecodeRequest, ) -> Result<Self::SubmittedSurface, Self::Error>

Submit a normalized full/ROI/scaled decode request to a device backend.