raiiaf.chunks.image

Image chunk utilities for RAIIAF.

Provides validation, packing (compression) and parsing for image data chunks (DATA). Uses zstd for compression.

Classes

raiiafImage()

Operations for RAIIAF image (DATA) chunks.
class raiiaf.chunks.image.raiiafImage[source]

Bases: object

Operations for RAIIAF image (DATA) chunks.

image_bytes_validator(image_bytes: bytes)[source]

Validate image bytes.

Parameters:

image_bytes (bytes) – Image bytes to validate.

Returns:

True if the image bytes form a valid image.

Return type:

bool

Raises:

raiiafImageError – If validation fails.

image_data_chunk_builder(image_binary: bytes)[source]

Build a compressed image DATA chunk from raw image bytes.

Parameters:

image_binary (bytes) – Raw PNG image bytes to store.

Returns:

Compressed chunk bytes suitable for writing to the RAIIAF file.

Return type:

bytes

Raises:

raiiafImageError – If the chunk cannot be constructed.

image_data_chunk_parser(compressed_chunk)[source]

Parse a compressed image DATA chunk.

Parameters:

compressed_chunk (bytes) – Compressed image data chunk.

Returns:

Parsed info with keys ‘chunk_type’, ‘chunk_flags’, ‘chunk_size’, ‘image_data’.

Return type:

dict

Raises:

raiiafImageError – If decompression or parsing fails.