- Generated by
1.9.1
|
Rizin
unix-like reverse engineering framework and cli tools
|
Options for the Block and Block Header encoders and decoders. More...
#include <block.h>
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().
| lzma_check lzma_block::check |
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:
Definition at line 93 of file block.h.
Referenced by block_buffer_encode(), block_decode(), block_encode(), code(), LZMA_API(), lzma_block_decoder_init(), lzma_block_encoder_init(), main(), parse_block_header(), stream_decode(), stream_encode(), stream_encoder_init(), test1(), test2(), and test3().
| lzma_vli lzma_block::compressed_size |
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:
Definition at line 148 of file block.h.
Referenced by block_buffer_encode(), block_decode(), block_encode(), block_encode_normal(), block_encode_uncompressed(), block_encoder_init(), code(), LZMA_API(), lzma_block_decoder_init(), parse_block_header(), test1(), and test2().
| lzma_filter* lzma_block::filters |
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:
Definition at line 200 of file block.h.
Referenced by block_buffer_encode(), block_encode_normal(), block_encode_uncompressed(), code(), free_properties(), LZMA_API(), lzma_block_decoder_init(), lzma_block_encoder_init(), parse_block_header(), stream_decode(), stream_encoder_update(), test1(), and test3().
| uint32_t lzma_block::header_size |
Size of the Block Header field.
This is always a multiple of four.
Read by:
Written by:
Definition at line 72 of file block.h.
Referenced by block_encode_normal(), block_encode_uncompressed(), code(), LZMA_API(), lzma_block_decoder_init(), main(), parse_block_header(), stream_decode(), stream_encode(), test3(), and worker_encode().
| lzma_bool lzma_block::ignore_check |
A flag to Block decoder to not verify the Check field.
This field is supported by liblzma >= 5.1.4beta if .version >= 1.
If this is set to true, the integrity check won't be calculated and verified. Unless you know what you are doing, you should leave this to false. (A reason to set this to true is when the file integrity is verified externally anyway and you want to speed up the decompression, which matters mostly when using SHA-256 as the integrity check.)
If .version >= 1, read by:
Written by (.version is ignored):
Definition at line 261 of file block.h.
Referenced by LZMA_API(), lzma_block_decoder_init(), and stream_decode().
| 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:
Definition at line 217 of file block.h.
Referenced by block_buffer_encode(), block_decode(), and block_encode().
| lzma_reserved_enum lzma_block::reserved_enum1 |
| lzma_reserved_enum lzma_block::reserved_enum2 |
| lzma_reserved_enum lzma_block::reserved_enum3 |
| lzma_reserved_enum lzma_block::reserved_enum4 |
| lzma_vli lzma_block::uncompressed_size |
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:
Definition at line 172 of file block.h.
Referenced by block_buffer_encode(), block_decode(), block_encode(), block_encoder_init(), code(), LZMA_API(), lzma_block_decoder_init(), parse_block_header(), stream_decode(), stream_encode(), test1(), test2(), and worker_encode().
| uint32_t lzma_block::version |
Block format version.
To prevent API and ABI breakages when new features are needed, a version number is used to indicate which fields in this structure are in use:
If version is greater than one, most Block related functions will return LZMA_OPTIONS_ERROR (lzma_block_header_decode() works with any version value).
Read by:
Written by:
Definition at line 52 of file block.h.
Referenced by block_buffer_encode(), LZMA_API(), lzma_block_decoder_init(), lzma_block_encoder_init(), parse_block_header(), stream_decode(), stream_encoder_init(), and worker_encode().
1.9.1