Abstract base class for image compression codecs. More...

#include <compression_codec.h>

Inheritance diagram for kcenon::pacs::encoding::compression::compression_codec:

Collaboration diagram for kcenon::pacs::encoding::compression::compression_codec:

Public Member Functions
virtual	~compression_codec ()=default

Codec Information
virtual std::string_view	transfer_syntax_uid () const noexcept=0
	Returns the Transfer Syntax UID supported by this codec.

virtual std::string_view	name () const noexcept=0
	Returns a human-readable name for the codec.

virtual bool	is_lossy () const noexcept=0
	Checks if this codec produces lossy compression.

virtual bool	can_encode (const image_params &params) const noexcept=0
	Checks if this codec supports the given image parameters.

virtual bool	can_decode (const image_params &params) const noexcept=0
	Checks if this codec can decode data with given parameters.

Compression Operations
virtual codec_result	encode (std::span< const uint8_t > pixel_data, const image_params &params, const compression_options &options={}) const =0
	Compresses uncompressed pixel data.

virtual codec_result	decode (std::span< const uint8_t > compressed_data, const image_params &params) const =0
	Decompresses compressed pixel data.

Protected Member Functions
	compression_codec ()=default

	compression_codec (const compression_codec &)=default

compression_codec &	operator= (const compression_codec &)=default

	compression_codec (compression_codec &&)=default

compression_codec &	operator= (compression_codec &&)=default

Detailed Description

Abstract base class for image compression codecs.

Provides a unified interface for DICOM image compression and decompression. Implementations wrap external libraries (libjpeg-turbo, OpenJPEG, etc.).

Thread Safety:

Codec instances are NOT thread-safe by themselves
Use separate instances per thread or external synchronization
Factory methods are thread-safe

See also: DICOM PS3.5 Section 8.2 - Native and Encapsulated Pixel Data

Definition at line 82 of file compression_codec.h.

Constructor & Destructor Documentation

◆ ~compression_codec()

virtual kcenon::pacs::encoding::compression::compression_codec::~compression_codec ( )

virtualdefault

◆ compression_codec() [1/3]

kcenon::pacs::encoding::compression::compression_codec::compression_codec ( )

protecteddefault

◆ compression_codec() [2/3]

kcenon::pacs::encoding::compression::compression_codec::compression_codec ( const compression_codec & )

protecteddefault

◆ compression_codec() [3/3]

kcenon::pacs::encoding::compression::compression_codec::compression_codec ( compression_codec && )

protecteddefault

Member Function Documentation

◆ can_decode()

virtual bool kcenon::pacs::encoding::compression::compression_codec::can_decode ( const image_params & params ) const

nodiscardpure virtualnoexcept

Checks if this codec can decode data with given parameters.

Parameters

params The image parameters

Returns: true if decoding is supported

Implemented in kcenon::pacs::encoding::compression::frame_deflate_codec, kcenon::pacs::encoding::compression::hevc_codec, kcenon::pacs::encoding::compression::htj2k_codec, kcenon::pacs::encoding::compression::jpeg2000_codec, kcenon::pacs::encoding::compression::jpeg_baseline_codec, kcenon::pacs::encoding::compression::jpeg_lossless_codec, kcenon::pacs::encoding::compression::jpeg_ls_codec, kcenon::pacs::encoding::compression::jpegxl_codec, and kcenon::pacs::encoding::compression::rle_codec.

◆ can_encode()

virtual bool kcenon::pacs::encoding::compression::compression_codec::can_encode ( const image_params & params ) const

nodiscardpure virtualnoexcept

Checks if this codec supports the given image parameters.

Parameters

params The image parameters to check

Returns: true if the codec can handle these parameters

Implemented in kcenon::pacs::encoding::compression::frame_deflate_codec, kcenon::pacs::encoding::compression::hevc_codec, kcenon::pacs::encoding::compression::htj2k_codec, kcenon::pacs::encoding::compression::jpeg2000_codec, kcenon::pacs::encoding::compression::jpeg_baseline_codec, kcenon::pacs::encoding::compression::jpeg_lossless_codec, kcenon::pacs::encoding::compression::jpeg_ls_codec, kcenon::pacs::encoding::compression::jpegxl_codec, and kcenon::pacs::encoding::compression::rle_codec.

◆ decode()

virtual codec_result kcenon::pacs::encoding::compression::compression_codec::decode	(	std::span< const uint8_t >	compressed_data,
		const image_params &	params ) const

nodiscardpure virtual

Decompresses compressed pixel data.

Parameters

compressed_data	The compressed pixel data (single frame)
params	Image parameters (width, height, samples_per_pixel)

Returns: codec_result containing decompressed data or error

The output pixel data is always in interleaved format (planar_configuration=0).

Implemented in kcenon::pacs::encoding::compression::frame_deflate_codec, kcenon::pacs::encoding::compression::hevc_codec, kcenon::pacs::encoding::compression::htj2k_codec, kcenon::pacs::encoding::compression::jpeg2000_codec, kcenon::pacs::encoding::compression::jpeg_baseline_codec, kcenon::pacs::encoding::compression::jpeg_lossless_codec, kcenon::pacs::encoding::compression::jpeg_ls_codec, kcenon::pacs::encoding::compression::jpegxl_codec, and kcenon::pacs::encoding::compression::rle_codec.

◆ encode()

virtual codec_result kcenon::pacs::encoding::compression::compression_codec::encode	(	std::span< const uint8_t >	pixel_data,
		const image_params &	params,
		const compression_options &	options = {} ) const

nodiscardpure virtual

Compresses uncompressed pixel data.

Parameters

pixel_data	The raw, uncompressed pixel data
params	Image parameters describing the pixel data
options	Compression settings

Returns: codec_result containing compressed data or error

The input pixel_data must match the format specified by params:

For planar_configuration=0: interleaved (RGBRGB...)
For planar_configuration=1: separate planes (RRR...GGG...BBB...)

Note: This is a potentially expensive operation. Consider using thread_pool_adapter for batch processing.

Implemented in kcenon::pacs::encoding::compression::frame_deflate_codec, kcenon::pacs::encoding::compression::hevc_codec, kcenon::pacs::encoding::compression::htj2k_codec, kcenon::pacs::encoding::compression::jpeg2000_codec, kcenon::pacs::encoding::compression::jpeg_baseline_codec, kcenon::pacs::encoding::compression::jpeg_lossless_codec, kcenon::pacs::encoding::compression::jpeg_ls_codec, kcenon::pacs::encoding::compression::jpegxl_codec, and kcenon::pacs::encoding::compression::rle_codec.

◆ is_lossy()

virtual bool kcenon::pacs::encoding::compression::compression_codec::is_lossy ( ) const

nodiscardpure virtualnoexcept

Checks if this codec produces lossy compression.

Returns: true if lossy, false if lossless

Implemented in kcenon::pacs::encoding::compression::frame_deflate_codec, kcenon::pacs::encoding::compression::hevc_codec, kcenon::pacs::encoding::compression::htj2k_codec, kcenon::pacs::encoding::compression::jpeg2000_codec, kcenon::pacs::encoding::compression::jpeg_baseline_codec, kcenon::pacs::encoding::compression::jpeg_lossless_codec, kcenon::pacs::encoding::compression::jpeg_ls_codec, kcenon::pacs::encoding::compression::jpegxl_codec, and kcenon::pacs::encoding::compression::rle_codec.

◆ name()

virtual std::string_view kcenon::pacs::encoding::compression::compression_codec::name ( ) const

nodiscardpure virtualnoexcept

Returns a human-readable name for the codec.

Returns: The codec name (e.g., "JPEG Baseline")

Implemented in kcenon::pacs::encoding::compression::frame_deflate_codec, kcenon::pacs::encoding::compression::hevc_codec, kcenon::pacs::encoding::compression::htj2k_codec, kcenon::pacs::encoding::compression::jpeg2000_codec, kcenon::pacs::encoding::compression::jpeg_baseline_codec, kcenon::pacs::encoding::compression::jpeg_lossless_codec, kcenon::pacs::encoding::compression::jpeg_ls_codec, kcenon::pacs::encoding::compression::jpegxl_codec, and kcenon::pacs::encoding::compression::rle_codec.

◆ operator=() [1/2]

compression_codec & kcenon::pacs::encoding::compression::compression_codec::operator= ( compression_codec && )

protecteddefault

◆ operator=() [2/2]

compression_codec & kcenon::pacs::encoding::compression::compression_codec::operator= ( const compression_codec & )

protecteddefault

◆ transfer_syntax_uid()

virtual std::string_view kcenon::pacs::encoding::compression::compression_codec::transfer_syntax_uid ( ) const

nodiscardpure virtualnoexcept

Returns the Transfer Syntax UID supported by this codec.

Returns: The DICOM Transfer Syntax UID

Implemented in kcenon::pacs::encoding::compression::frame_deflate_codec, kcenon::pacs::encoding::compression::hevc_codec, kcenon::pacs::encoding::compression::htj2k_codec, kcenon::pacs::encoding::compression::jpeg2000_codec, kcenon::pacs::encoding::compression::jpeg_baseline_codec, kcenon::pacs::encoding::compression::jpeg_lossless_codec, kcenon::pacs::encoding::compression::jpeg_ls_codec, kcenon::pacs::encoding::compression::jpegxl_codec, and kcenon::pacs::encoding::compression::rle_codec.

The documentation for this class was generated from the following file:

include/kcenon/pacs/encoding/compression/compression_codec.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~compression_codec()

◆ compression_codec() [1/3]

◆ compression_codec() [2/3]

◆ compression_codec() [3/3]

Member Function Documentation

◆ can_decode()

◆ can_encode()

◆ decode()

◆ encode()

◆ is_lossy()

◆ name()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ transfer_syntax_uid()