Passing data to and from liblzma. More...

#include <base.h>

Data Fields
const uint8_t *	next_in
size_t	avail_in
uint64_t	total_in
uint8_t *	next_out
size_t	avail_out
uint64_t	total_out
lzma_allocator *	allocator
	Custom memory allocation functions.
lzma_internal *	internal
void *	reserved_ptr1
void *	reserved_ptr2
uint64_t	reserved_int1
uint64_t	reserved_int2
lzma_reserved_enum	reserved_enum1
lzma_reserved_enum	reserved_enum2

Detailed Description

Passing data to and from liblzma.

The lzma_stream structure is used for

passing pointers to input and output buffers to liblzma;
defining custom memory hander functions; and
holding a pointer to coder-specific internal data structures.

Typical usage:

After allocating lzma_stream (on stack or with malloc()), it must be initialized to LZMA_STREAM_INIT (see LZMA_STREAM_INIT for details).

Initialize a coder to the lzma_stream, for example by using lzma_easy_encoder() or lzma_auto_decoder(). Some notes:
- In contrast to zlib, strm->next_in and strm->next_out are ignored by all initialization functions, thus it is safe to not initialize them yet.
- The initialization functions always set strm->total_in and strm->total_out to zero.
- If the initialization function fails, no memory is left allocated that would require freeing with lzma_end() even if some memory was associated with the lzma_stream structure when the initialization function was called.

Use lzma_code() to do the actual work.

Once the coding has been finished, the existing lzma_stream can be reused. It is OK to reuse lzma_stream with different initialization function without calling lzma_end() first. Old allocations are automatically freed.

Finally, use lzma_end() to free the allocated memory. lzma_end() never frees the lzma_stream structure itself.

Application may modify the values of total_in and total_out as it wants. They are updated by liblzma to match the amount of data read and written, but aren't used for anything else.