Expand description
A decoder for CCITT fax-encoded images.
This crate implements the CCITT Group 3 and Group 4 fax compression algorithms as defined in ITU-T Recommendations T.4 and T.6. These encodings are commonly used for bi-level (black and white) images in PDF documents and fax transmissions.
The main entry point is the decode function, which takes encoded data and
decoding settings, and outputs the decoded pixels through a Decoder trait
that can be implemented according to your needs.
The crate is no_std compatible but requires an allocator to be available.
§Safety
Unsafe code is forbidden via a crate-level attribute.
§License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Structs§
- Decode
Settings - Settings to apply during decoding.
Enums§
- Decode
Error - An error that can occur during CCITT decoding.
- Encoding
Mode - The encoding mode for CCITT fax decoding.
Traits§
- Decoder
- A decoder for CCITT images.
Functions§
- decode
- Decode the given image using the provided settings and the decoder.
Type Aliases§
- Result
- A specialized Result type for CCITT decoding operations.