Options for the Block and Block Header encoders and decoders. More...
#include <block.h>
Data Fields | |
| uint32_t | version |
| Block format version. | |
| uint32_t | header_size |
| Size of the Block Header field. | |
| lzma_check | check |
| Type of integrity Check. | |
| lzma_vli | compressed_size |
| Size of the Compressed Data in bytes. | |
| lzma_vli | uncompressed_size |
| Uncompressed Size in bytes. | |
| lzma_filter * | filters |
| Array of filters. | |
| uint8_t | raw_check [LZMA_CHECK_SIZE_MAX] |
| Raw value stored in the Check field. | |
| void * | reserved_ptr1 |
| void * | reserved_ptr2 |
| void * | reserved_ptr3 |
| uint32_t | reserved_int1 |
| uint32_t | reserved_int2 |
| lzma_vli | reserved_int3 |
| lzma_vli | reserved_int4 |
| lzma_vli | reserved_int5 |
| lzma_vli | reserved_int6 |
| lzma_vli | reserved_int7 |
| lzma_vli | reserved_int8 |
| lzma_reserved_enum | reserved_enum1 |
| lzma_reserved_enum | reserved_enum2 |
| lzma_reserved_enum | reserved_enum3 |
| lzma_reserved_enum | reserved_enum4 |
| lzma_bool | reserved_bool1 |
| lzma_bool | reserved_bool2 |
| lzma_bool | reserved_bool3 |
| lzma_bool | reserved_bool4 |
| lzma_bool | reserved_bool5 |
| lzma_bool | reserved_bool6 |
| lzma_bool | reserved_bool7 |
| lzma_bool | reserved_bool8 |
Options for the Block and Block Header encoders and decoders.
Different Block handling functions use different parts of this structure. Some read some members, other functions write, and some do both. Only the members listed for reading need to be initialized when the specified functions are called. The members marked for writing will be assigned new values at some point either by calling the given function or by later calls to lzma_code().
| uint32_t lzma_block::version |
Block format version.
To prevent API and ABI breakages if new features are needed in the Block field, a version number is used to indicate which fields in this structure are in use. For now, version must always be zero. With non-zero version, most Block related functions will return LZMA_OPTIONS_ERROR.
Read by:
Written by:
Referenced by parse_block_header().
| uint32_t lzma_block::header_size |
Size of the Block Header field.
This is always a multiple of four.
Read by:
Written by:
Referenced by parse_block_header().
Type of integrity Check.
The Check ID is not stored into the Block Header, thus its value must be provided also when decoding.
Read by:
Referenced by parse_block_header().
Size of the Compressed Data in bytes.
Encoding: If this is not LZMA_VLI_UNKNOWN, Block Header encoder will store this value to the Block Header. Block encoder doesn't care about this value, but will set it once the encoding has been finished.
Decoding: If this is not LZMA_VLI_UNKNOWN, Block decoder will verify that the size of the Compressed Data field matches compressed_size.
Usually you don't know this value when encoding in streamed mode, and thus cannot write this field into the Block Header.
In non-streamed mode you can reserve space for this field before encoding the actual Block. After encoding the data, finish the Block by encoding the Block Header. Steps in detail:
Read by:
Written by:
Referenced by parse_block_header().
Uncompressed Size in bytes.
This is handled very similarly to compressed_size above.
uncompressed_size is needed by fewer functions than compressed_size. This is because uncompressed_size isn't needed to validate that Block stays within proper limits.
Read by:
Written by:
Referenced by lzma_stream_buffer_encode(), and parse_block_header().
Array of filters.
There can be 1-4 filters. The end of the array is marked with .id = LZMA_VLI_UNKNOWN.
Read by:
Written by:
Referenced by parse_block_header().
| uint8_t lzma_block::raw_check[LZMA_CHECK_SIZE_MAX] |
Raw value stored in the Check field.
After successful coding, the first lzma_check_size(check) bytes of this array contain the raw value stored in the Check field.
Note that CRC32 and CRC64 are stored in little endian byte order. Take it into account if you display the Check values to the user.
Written by:
1.7.1