Crate j2k 

Pure-Rust JPEG 2000 Part 1 and HTJ2K Part 15 codec APIs.

This crate provides inspection, decode, encode, lossless J2K-to-HTJ2K recoding, still-image container wrapping, and device-decode planning. Shared encode-stage SPI types are re-exported at the crate root for adapter interoperability, while concrete CUDA and Metal device surfaces and runtime integration live in the j2k-cuda and j2k-metal crates.

Structs

BackendError

Structured backend failure details.

BatchDecodeOptions

Options shared by preparation and CPU batch decode.

BatchGroupInfo

Metadata shared by every image in one homogeneous output group.

ClassicCodeBlockPayload

Ordered encoded-input fragment span for one classic JPEG 2000 code block.

CpuBatchDecodeResult

CPU batch decode successes and indexed item failures.

CpuBatchDecoder

Persistent CPU facade for repeated owned/prepared batch decode.

CpuBatchGroup

One successfully decoded homogeneous CPU output group.

CpuBatchWorkspaceStats

Aggregate reuse counters for native workspaces retained by a CPU batch session.

DecodeOutcome

Successful decode metadata plus non-fatal warnings.

DecodeSettings

Validation policy used by prepared and one-shot J2K batch decoding.

DeviceDecodePlan

Normalized device decode plan derived from source dimensions and request.

EncodedImage

One owned encoded image submitted to a batch decoder.

EncodedJ2k

Encoded JPEG 2000 lossless codestream and encode metadata.

EncodedLossyJ2k

Encoded JPEG 2000 lossy codestream and encode metadata.

Htj2kPayloadRanges

Cleanup and optional refinement byte ranges for one HTJ2K code block.

IndexedBatchError

One batch item error retaining the caller’s input index.

J2kChannelDefinition

Parsed JP2/JPH Channel Definition box entry.

J2kCodec

Marker type used by generic tile-batch decode traits.

J2kCodestreamPayload

Borrowed raw codestream slice extracted from raw JPEG 2000 bytes or a JP2/JPH wrapper.

J2kCodestreamRange

Byte range inside a complete encoded J2K, JP2, or JPH input.

J2kComponentInfo

Per-component JPEG 2000 SIZ metadata.

J2kComponentMapping

Parsed JP2/JPH Component Mapping box entry.

J2kComponentPlane

One borrowed decoded component plane.

J2kContext

Reusable JPEG 2000 decode context and cache state.

J2kDecodedComponents

Borrowed decoded component planes for an image.

J2kDecodedNativeComponents

Owned decoded native-bit-depth component planes for an image.

J2kDecoder

JPEG 2000 / HTJ2K decoder with full-frame, ROI, and scaled output methods.

J2kFileBoxMetadata

Optional JP2/JPH metadata boxes to write in the JP2 Header box.

J2kFileMetadata

JP2/JPH file-wrapper metadata preserved by public inspection.

J2kFileWrapOptions

Options for wrapping a raw JPEG 2000 / HTJ2K codestream as a JP2/JPH file.

J2kLosslessComponentPlane

Borrowed samples for one lossless component plane.

J2kLosslessComponentSamples

Borrowed component-plane samples and reference-grid image geometry for lossless encoding.

J2kLosslessEncodeOptions

Options controlling JPEG 2000 lossless encoding.

J2kLosslessSamples

Borrowed interleaved samples and image geometry for lossless encoding.

J2kLosslessTypedComponentPlane

Borrowed samples for one typed lossless component plane.

J2kLosslessTypedComponentSamples

Borrowed typed component-plane samples and reference-grid image geometry for lossless encoding.

J2kLossyEncodeOptions

Options controlling stable lossy JPEG 2000 encoding.

J2kLossyEncodeReport

Metrics reported by stable lossy JPEG 2000 encoding.

J2kLossySamples

Borrowed interleaved samples and image geometry for lossy encoding.

J2kNativeComponentPlane

One owned decoded component plane at native bit depth.

J2kPaletteColumn

Parsed JP2/JPH Palette column descriptor.

J2kPaletteMetadata

Parsed JP2/JPH Palette box.

J2kQualityLayer

One cumulative lossy quality layer request.

J2kRoiRegion

Rectangular region-of-interest request for lossless JPEG 2000 maxshift encoding.

J2kRowDecodeOptions

Options for bounded J2K row decoding.

J2kScratchPool

Caller-owned reusable scratch for j2k.

J2kSupportInfo

Full parsed JPEG 2000 / HTJ2K support metadata.

J2kToHtj2kOptions

Options for classic JPEG 2000 reversible 5/3 to HTJ2K lossless recoding.

J2kToHtj2kReport

Metadata describing a J2K/JP2 to HTJ2K recode.

J2kView

Borrowed parse result for a JP2 or raw JPEG 2000 / HTJ2K codestream.

NativeBackendError

Opaque, facade-owned source for failures raised by the native codec.

PassthroughCandidate

A borrowed compressed frame/tile that may be copied unchanged.

PassthroughRequirements

Destination requirements for copying compressed bytes unchanged.

PreparedBatch

Cheaply cloneable parsed and grouped batch reusable across decode calls.

PreparedBatchGroup

One homogeneous set of prepared images.

PreparedClassicPlan

Opaque retained classic JPEG 2000 execution plan for one prepared image.

PreparedHtj2kPlan

Opaque retained HTJ2K execution plan for one prepared image.

PreparedImage

Cheaply cloneable preparation result for one image.

Rect

Rectangle in source pixel coordinates.

ReencodedHtj2k

HTJ2K codestream bytes and recode metadata.

TileBatchOptions

Worker configuration for CPU tile batches.

TileDecodeOutput

Caller-owned output target for one context-reused J2K/HTJ2K tile decode helper.

Enums

BackendErrorKind

Machine-readable class for backend failures surfaced by the facade.

BackendKind

Runtime backend that executes codec work.

BackendRequest

Caller preference for backend selection.

BatchAlpha

Interpretation of an output alpha channel.

BatchCodecRoute

Compressed block-coding route selected during preparation.

BatchColor

Channel layout independent of sample width.

BatchErrorStage

Stage at which an indexed image failed.

BatchInfrastructureError

Failure in batch scheduling, allocation, or worker-result collection.

BatchItemError

Structured error for one submitted image.

BatchLayout

Tensor-compatible channel ordering requested from a batch decoder.

BatchWaveletTransform

Wavelet transform declared by the compressed syntax.

BufferError

Buffer validation and copy errors.

CompressedPayloadKind

Encapsulation shape of the compressed bytes.

CompressedTransferSyntax

Compressed syntax carried by a source frame or accepted by a destination.

CpuBatchSamples

Native-width contiguous samples returned by the CPU batch decoder.

CpuDecodeParallelism

CPU parallelism policy for JPEG 2000 decode.

DecodeRequest

Requested pixels from one encoded image.

DecodeRowsError

Error wrapper used by row-streaming decode when either the codec or the caller-provided row sink can fail.

DeviceDecodeRequest

Device decode shape requested by a GPU adapter.

Downscale

Power-of-two downscale requested during decode.

EncodeBackendPreference

Backend preference for JPEG 2000 lossless encoding.

J2kBlockCodingMode

Supported code-block coding modes for the lossless encode facade.

J2kChannelAssociation

JP2/JPH channel association.

J2kChannelType

JP2/JPH channel type.

J2kColorSpec

Parsed JP2/JPH Colour Specification box.

J2kComponentMappingType

JP2/JPH Component Mapping operation.

J2kDecodeWarning

Non-fatal JPEG 2000 decode warning surfaced through decode outcomes.

J2kDecodedColorSpace

Decoded JPEG 2000 color space metadata for component-plane outputs.

J2kEncodeValidation

Validation policy for the lossless encode facade.

J2kError

Error returned by JPEG 2000 inspect, decode, encode, and recode APIs.

J2kFileColorSpec

Color metadata to write into a JP2/JPH Colour Specification box.

J2kMarkerSegment

Optional JPEG 2000 marker segment requested for lossy encode output.

J2kProgressionOrder

Supported JPEG 2000 progression orders for the lossless encode facade.

J2kRateTarget

Rate target for stable lossy JPEG 2000 encoding.

J2kToHtj2kMode

Recode path used for a J2K/JP2 to HTJ2K request.

NativeSampleType

Integer sample width used by a pixel format or row sink.

NonRepresentableReason

Reason an otherwise valid image cannot be represented by the fast batch API.

PassthroughDecision

Result of a passthrough eligibility check.

PassthroughRejectReason

First reason a compressed payload was rejected for byte-preserving copy.

PixelFormat

Concrete interleaved pixel format.

PreparationDepth

Amount of native execution planning retained by a prepared image.

ReversibleTransform

Reversible transform profile for lossless JPEG 2000 output.

Traits

BatchDecoder

Common synchronous boundary implemented by persistent codec batch sessions.

CodecError

Shared error classification used by facade traits.

ImageCodec

Common associated types shared by image codecs.

ImageDecode

Borrowed-image decode API for codecs that parse compressed bytes directly.

ImageDecodeRows

Row-streaming decode API for large images or stripe-oriented callers.

RowSink

Destination for row-streaming decode output.

TileBatchDecode

Stateless tile-batch decode helpers that reuse caller-owned context.

Functions

decode_tiles_into

Decode independent J2K/HTJ2K tiles into caller-owned output buffers.

decode_tiles_region_into

Decode independent J2K/HTJ2K tile regions into caller-owned output buffers.

decode_tiles_region_scaled_into

Decode independent J2K/HTJ2K tile regions at reduced resolution into caller-owned output buffers.

decode_tiles_scaled_into

Decode independent J2K/HTJ2K tiles at reduced resolution into caller-owned output buffers.

encode_j2k_lossless

Encode interleaved samples into a raw JPEG 2000 lossless codestream.

encode_j2k_lossless_components

Encode component-plane samples into a raw JPEG 2000 lossless codestream.

encode_j2k_lossless_typed_components

Encode typed component-plane samples into a raw JPEG 2000 lossless codestream.

encode_j2k_lossless_with_accelerator

Encode interleaved samples with an optional device encode-stage accelerator.

encode_j2k_lossless_with_roi_regions

Encode interleaved samples into a raw lossless JPEG 2000 codestream with rectangular ROI maxshift.

encode_j2k_lossy

Encode interleaved samples into a raw JPEG 2000 lossy codestream.

encode_j2k_lossy_with_accelerator

Encode interleaved lossy samples with an optional device encode-stage accelerator.

encode_j2k_lossy_with_roi_regions

Encode interleaved samples into a raw lossy JPEG 2000 codestream with rectangular ROI maxshift.

extract_j2k_codestream_payload

Return the raw JPEG 2000 codestream payload from raw codestream, JP2, or JPH input.

j2k_lossless_decomposition_levels

Return the default lossless decomposition level policy used by the facade.

j2k_lossless_decomposition_levels_for_options

Return the effective lossless decomposition level policy for encode options.

j2k_lossless_decomposition_levels_for_progression

Return the default lossless decomposition level policy for a progression.

prepare_batch

Inspect, validate, and group owned encoded images without decoding pixels.

prepare_batch_from_images

Regroup caller-supplied prepared images without parsing or copying codestreams.

recode_j2k_to_htj2k_lossless

Recode a classic JPEG 2000 reversible 5/3 J2K/JP2 input to lossless HTJ2K.

wrap_j2k_codestream

Wrap a raw JPEG 2000 / HTJ2K codestream in a JP2 or JPH file container.

Type Aliases

TileBatchError

Error returned by J2K CPU tile batches.

TileDecodeJob

One full-tile decode request for decode_tiles_into.

TileRegionDecodeJob

One ROI tile decode request for decode_tiles_region_into.

TileRegionScaledDecodeJob

One ROI+scaled tile decode request for decode_tiles_region_scaled_into.

TileScaledDecodeJob

One scaled tile decode request for decode_tiles_scaled_into.