Expand description
Public JPEG 2000 Part 1 and HTJ2K Part 15 CPU codec facade.
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§
- Backend
Error - Structured backend failure details.
- Decode
Outcome - Successful decode metadata plus non-fatal warnings.
- Decoder
Context - Wrapper that owns codec context state for repeated decode calls.
- Device
Decode Plan - Normalized device decode plan derived from source dimensions and request.
- Encoded
J2k - Encoded JPEG 2000 lossless codestream and encode metadata.
- Encoded
Lossy J2k - Encoded JPEG 2000 lossy codestream and encode metadata.
- J2kChannel
Definition - Parsed JP2/JPH Channel Definition box entry.
- J2kCodec
- Marker type used by generic tile-batch decode traits.
- J2kCodestream
Payload - Borrowed raw codestream slice extracted from raw JPEG 2000 bytes or a JP2/JPH wrapper.
- J2kComponent
Info - Per-component JPEG 2000 SIZ metadata.
- J2kComponent
Mapping - Parsed JP2/JPH Component Mapping box entry.
- J2kComponent
Plane - One borrowed decoded component plane.
- J2kContext
- Reusable JPEG 2000 decode context and cache state.
- J2kDecoded
Components - Borrowed decoded component planes for an image.
- J2kDecoded
Native Components - Owned decoded native-bit-depth component planes for an image.
- J2kDecoder
- JPEG 2000 / HTJ2K decoder with full-frame, ROI, and scaled output methods.
- J2kFile
BoxMetadata - Optional JP2/JPH metadata boxes to write in the JP2 Header box.
- J2kFile
Metadata - JP2/JPH file-wrapper metadata preserved by public inspection.
- J2kFile
Wrap Options - Options for wrapping a raw JPEG 2000 / HTJ2K codestream as a JP2/JPH file.
- J2kLossless
Component Plane - Borrowed samples for one lossless component plane.
- J2kLossless
Component Samples - Borrowed component-plane samples and reference-grid image geometry for lossless encoding.
- J2kLossless
Encode Options - Options controlling JPEG 2000 lossless encoding.
- J2kLossless
Samples - Borrowed interleaved samples and image geometry for lossless encoding.
- J2kLossless
Typed Component Plane - Borrowed samples for one typed lossless component plane.
- J2kLossless
Typed Component Samples - Borrowed typed component-plane samples and reference-grid image geometry for lossless encoding.
- J2kLossy
Encode Options - Options controlling stable lossy JPEG 2000 encoding.
- J2kLossy
Encode Report - Metrics reported by stable lossy JPEG 2000 encoding.
- J2kLossy
Samples - Borrowed interleaved samples and image geometry for lossy encoding.
- J2kNative
Component Plane - One owned decoded component plane at native bit depth.
- J2kPalette
Column - Parsed JP2/JPH Palette column descriptor.
- J2kPalette
Metadata - Parsed JP2/JPH Palette box.
- J2kQuality
Layer - One cumulative lossy quality layer request.
- J2kRoi
Region - Rectangular region-of-interest request for lossless JPEG 2000 maxshift encoding.
- J2kRow
Decode Options - Options for bounded J2K row decoding.
- J2kScratch
Pool - Caller-owned reusable scratch for
j2k. - J2kSupport
Info - Full parsed JPEG 2000 / HTJ2K support metadata.
- J2kTo
Htj2k Options - Options for classic JPEG 2000 reversible 5/3 to HTJ2K lossless recoding.
- J2kTo
Htj2k Report - Metadata describing a J2K/JP2 to HTJ2K recode.
- J2kView
- Borrowed parse result for a JP2 or raw JPEG 2000 / HTJ2K codestream.
- Native
Backend Error - Opaque, facade-owned source for failures raised by the native codec.
- Passthrough
Candidate - A borrowed compressed frame/tile that may be copied unchanged.
- Passthrough
Requirements - Destination requirements for copying compressed bytes unchanged.
- Rect
- Rectangle in source pixel coordinates.
- Reencoded
Htj2k - HTJ2K codestream bytes and recode metadata.
- Tile
Batch Options - Worker configuration for CPU tile batches.
- Tile
Decode Output - Caller-owned output target for one context-reused J2K/HTJ2K tile decode helper.
Enums§
- Backend
Error Kind - Machine-readable class for backend failures surfaced by the facade.
- Backend
Kind - Runtime backend that executes codec work.
- Backend
Request - Caller preference for backend selection.
- Buffer
Error - Buffer validation and copy errors.
- Compressed
Payload Kind - Encapsulation shape of the compressed bytes.
- Compressed
Transfer Syntax - Compressed syntax carried by a source frame or accepted by a destination.
- CpuDecode
Parallelism - CPU parallelism policy for JPEG 2000 decode.
- Decode
Rows Error - Error wrapper used by row-streaming decode when either the codec or the caller-provided row sink can fail.
- Device
Decode Request - Device decode shape requested by a GPU adapter.
- Downscale
- Power-of-two downscale requested during decode.
- Encode
Backend Preference - Backend preference for JPEG 2000 lossless encoding.
- J2kBlock
Coding Mode - Supported code-block coding modes for the lossless encode facade.
- J2kChannel
Association - JP2/JPH channel association.
- J2kChannel
Type - JP2/JPH channel type.
- J2kColor
Spec - Parsed JP2/JPH Colour Specification box.
- J2kComponent
Mapping Type - JP2/JPH Component Mapping operation.
- J2kDecode
Warning - Non-fatal JPEG 2000 decode warning surfaced through decode outcomes.
- J2kDecoded
Color Space - Decoded JPEG 2000 color space metadata for component-plane outputs.
- J2kEncode
Validation - Validation policy for the lossless encode facade.
- J2kError
- Error returned by JPEG 2000 inspect, decode, encode, and recode APIs.
- J2kFile
Color Spec - Color metadata to write into a JP2/JPH Colour Specification box.
- J2kMarker
Segment - Optional JPEG 2000 marker segment requested for lossy encode output.
- J2kProgression
Order - Supported JPEG 2000 progression orders for the lossless encode facade.
- J2kRate
Target - Rate target for stable lossy JPEG 2000 encoding.
- J2kTo
Htj2k Mode - Recode path used for a J2K/JP2 to HTJ2K request.
- Passthrough
Decision - Result of a passthrough eligibility check.
- Passthrough
Reject Reason - First reason a compressed payload was rejected for byte-preserving copy.
- Pixel
Format - Concrete interleaved pixel format.
- Reversible
Transform - Reversible transform profile for lossless JPEG 2000 output.
Traits§
- Codec
Error - Shared error classification used by facade traits.
- Image
Codec - Common associated types shared by image codecs.
- Image
Decode - Borrowed-image decode API for codecs that parse compressed bytes directly.
- Image
Decode Rows - Row-streaming decode API for large images or stripe-oriented callers.
- RowSink
- Destination for row-streaming decode output.
- Tile
Batch Decode - 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.
- 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§
- Tile
Batch Error - Error returned by J2K CPU tile batches.
- Tile
Decode Job - One full-tile decode request for
decode_tiles_into. - Tile
Region Decode Job - One ROI tile decode request for
decode_tiles_region_into. - Tile
Region Scaled Decode Job - One ROI+scaled tile decode request for
decode_tiles_region_scaled_into. - Tile
Scaled Decode Job - One scaled tile decode request for
decode_tiles_scaled_into.