Skip to main content

Crate j2k_types

Crate j2k_types 

Source
Expand description

Shared JPEG 2000 and HTJ2K codec contracts for j2k.

Stable codec value types are grouped by transform, Tier-1, packetization, and prepared-plan ownership. The crate’s dispatch contracts form the explicit low-level integration surface for encode-stage accelerators.

Structs§

CpuOnlyJ2kEncodeStageAccelerator
CPU-only encode accelerator that always falls back to native stages.
DecodePlanAllocationError
Retained decode-plan capacity overflow or limit violation.
EncodedHtJ2kCodeBlock
Encoded HTJ2K cleanup/refinement code-block payload.
EncodedJ2kCodeBlock
Encoded classic JPEG 2000 code-block payload.
HtCodeBlockPayloadRanges
One retained cleanup/refinement record for an HTJ2K code block.
HtOwnedCodeBlockBatchJob
Owned HTJ2K code-block decode job.
HtOwnedSubBandPlan
Owned HTJ2K subband decode plan.
IrreversibleQuantizationStep
Public JPEG 2000 irreversible quantization step-size tuple.
IrreversibleQuantizationSubbandScales
Multipliers applied to irreversible 9/7 quantization step sizes by subband.
J2kClassicCodeBlockPayload
Ordered encoded-input fragment span for one classic JPEG 2000 code block.
J2kCodeBlockSegment
One coded segment in a classic JPEG 2000 code block.
J2kCodeBlockStyle
Classic JPEG 2000 code-block style flags.
J2kCodestreamRange
Byte range inside a complete encoded J2K, JP2, or JPH input.
J2kDeinterleaveMctToF32Job
Combined pixel deinterleave, level-shift, and forward MCT job supplied to an accelerator.
J2kDeinterleaveToF32Job
Pixel deinterleave and level-shift job supplied to an accelerator.
J2kDirectColorPlan
Direct-device RGB decode plan.
J2kDirectGrayscalePlan
Direct-device decode plan for one component.
J2kDirectIdwtStep
One inverse-transform step in a direct-device plan.
J2kDirectRgbaPlan
Direct-device RGBA decode plan with RGB-only inverse MCT semantics.
J2kDirectStoreStep
One final component-store step in a direct-device plan.
J2kEncodeContext
Validated image and coding context supplied before encode-stage dispatch.
J2kEncodeDispatchReport
Encode-stage dispatch counters reported by an accelerator.
J2kForwardDwt53Job
Forward reversible 5/3 DWT job.
J2kForwardDwt53Level
One reversible 5/3 DWT detail level.
J2kForwardDwt53Output
Forward reversible 5/3 DWT output.
J2kForwardDwt97Job
Forward irreversible 9/7 DWT job.
J2kForwardDwt97Level
One irreversible 9/7 DWT detail level.
J2kForwardDwt97Output
Forward irreversible 9/7 DWT output.
J2kForwardIctJob
Forward irreversible color transform job.
J2kForwardRctJob
Forward reversible color transform job.
J2kHtCodeBlockEncodeJob
HTJ2K code-block encode job.
J2kHtSubbandEncodeJob
HTJ2K cleanup/refinement encode job for one unquantized subband.
J2kHtj2kTileEncodeJob
HTJ2K tile-body encode job for a backend-resident full-tile path.
J2kOwnedCodeBlockBatchJob
Owned classic JPEG 2000 code-block decode job.
J2kOwnedSubBandPlan
Owned classic JPEG 2000 subband decode plan.
J2kPacketizationCodeBlock
One encoded Tier-1 code-block contribution to a packet.
J2kPacketizationEncodeJob
Packetization encode job.
J2kPacketizationPacketDescriptor
Explicit packet descriptor.
J2kPacketizationResolution
One packetization resolution packet.
J2kPacketizationSubband
One packetization subband precinct.
J2kQuantizeSubbandJob
Subband quantization job.
J2kRect
Integer rectangle in component coordinates.
J2kReferencedImageGeometry
Borrowed image-level geometry shared by classic and HTJ2K plans.
J2kReferencedPayloadRecordSpan
Contiguous range of compressed-payload records belonging to one tile plan.
J2kReferencedTilePlan
One independently executable tile in a referenced direct plan.
J2kTier1CodeBlockEncodeJob
Classic JPEG 2000 Tier-1 code-block encode job.
PrecomputedHtj2k53Component
Precomputed reversible 5/3 wavelet coefficients for one component.
PrecomputedHtj2k53Image
Precomputed reversible 5/3 wavelet image.
PrecomputedHtj2k97Component
Precomputed irreversible 9/7 wavelet coefficients for one component.
PrecomputedHtj2k97Image
Precomputed irreversible 9/7 wavelet image.
PreencodedHtj2k97CodeBlock
One preencoded HTJ2K code block.
PreencodedHtj2k97CompactCodeBlock
One compact preencoded HTJ2K code block.
PreencodedHtj2k97CompactComponent
Preencoded compact irreversible 9/7 HTJ2K component.
PreencodedHtj2k97CompactImage
Preencoded irreversible 9/7 HTJ2K image backed by one compact payload buffer.
PreencodedHtj2k97CompactResolution
One component resolution’s compact preencoded HTJ2K subbands.
PreencodedHtj2k97CompactSubband
One compact preencoded HTJ2K subband split into code blocks.
PreencodedHtj2k97Component
Preencoded irreversible 9/7 HTJ2K component.
PreencodedHtj2k97Image
Preencoded irreversible 9/7 HTJ2K code-block image.
PreencodedHtj2k97Resolution
One component resolution’s preencoded HTJ2K subbands.
PreencodedHtj2k97Subband
One preencoded HTJ2K subband split into code blocks.
PrequantizedHtj2k97CodeBlock
One prequantized HTJ2K code block.
PrequantizedHtj2k97Component
Prequantized irreversible 9/7 HTJ2K component.
PrequantizedHtj2k97Image
Prequantized irreversible 9/7 HTJ2K code-block image.
PrequantizedHtj2k97Resolution
One component resolution’s prequantized HTJ2K subbands.
PrequantizedHtj2k97Subband
One prequantized HTJ2K subband split into code blocks.

Enums§

J2kDirectGrayscaleStep
Ordered direct-device decode step for one component.
J2kEncodeStageError
Failure returned by a shared encode-stage accelerator hook.
J2kEncodeStageErrorKind
Stable category for an encode-stage accelerator failure.
J2kPacketizationBlockCodingMode
Packetization block coding mode.
J2kPacketizationProgressionOrder
JPEG 2000 packet progression order.
J2kReferencedClassicPlan
Owned classic JPEG 2000 execution geometry referencing caller-owned bytes.
J2kReferencedHtj2kPlan
Owned HTJ2K execution geometry referencing caller-owned bytes.
J2kReferencedTileGeometry
Direct execution geometry for one codestream tile.
J2kSubBandType
Classic JPEG 2000 subband kind.
J2kWaveletTransform
Wavelet transform used by retained decode geometry.

Constants§

DEFAULT_MAX_CODEC_BYTES
Default maximum simultaneously retained codec allocation in bytes.
DEFAULT_MAX_DECODE_BYTES
Default maximum retained decode allocation in bytes.

Traits§

J2kEncodeStageAccelerator
Low-level JPEG 2000 encode-stage accelerator integration contract.

Functions§

sort_packet_descriptors_for_progression
Sort packet descriptors in the requested progression order.

Type Aliases§

J2kDirectBandId
Stable identifier for one device-owned grayscale coefficient band.
J2kEncodeStageResult
Result returned by fallible encode-stage accelerator hooks.