lzma_decoder.h File Reference

LZMA decoder API. More...

#include "common.h"

Go to the source code of this file.

Functions
lzma_ret	lzma_lzma_decoder_init (lzma_next_coder *next, const lzma_allocator *allocator, const lzma_filter_info *filters)
	Allocates and initializes LZMA decoder. More...
uint64_t	lzma_lzma_decoder_memusage (const void *options)
lzma_ret	lzma_lzma_props_decode (void **options, const lzma_allocator *allocator, const uint8_t *props, size_t props_size)
bool	lzma_lzma_lclppb_decode (lzma_options_lzma *options, uint8_t byte)
	Decodes the LZMA Properties byte (lc/lp/pb) More...

Detailed Description

LZMA decoder API.

Definition in file lzma_decoder.h.

Function Documentation

lzma_lzma_decoder_init()

lzma_ret lzma_lzma_decoder_init	(	lzma_next_coder *	next,
		const lzma_allocator *	allocator,
		const lzma_filter_info *	filters
	)

Allocates and initializes LZMA decoder.

Definition at line 987 of file lzma_decoder.c.

{
    // LZMA can only be the last filter in the chain. This is enforced
    // by the raw_decoder initialization.
    assert(filters[1].init == NULL);
 
    return lzma_lz_decoder_init(next, allocator, filters,
            &lzma_decoder_init);
}

References allocator, assert(), filters, init, lzma_decoder_init(), lzma_lz_decoder_init(), and NULL.

Referenced by alone_decode().

lzma_lzma_decoder_memusage()

uint64_t lzma_lzma_decoder_memusage

(

const void *

options

)

Definition at line 1025 of file lzma_decoder.c.

{
    if (!is_lclppb_valid(options))
        return UINT64_MAX;
 
    return lzma_lzma_decoder_memusage_nocheck(options);
}

References is_lclppb_valid(), lzma_lzma_decoder_memusage_nocheck(), options, and UINT64_MAX.

Referenced by alone_decode().

lzma_lzma_lclppb_decode()

bool lzma_lzma_lclppb_decode	(	lzma_options_lzma *	options,
		uint8_t	byte
	)

Decodes the LZMA Properties byte (lc/lp/pb)

Returns

true if error occurred, false on success

Definition at line 1000 of file lzma_decoder.c.

{
    if (byte > (4 * 5 + 4) * 9 + 8)
        return true;
 
    // See the file format specification to understand this.
    options->pb = byte / (9 * 5);
    byte -= options->pb * 9 * 5;
    options->lp = byte / 9;
    options->lc = byte - options->lp * 9;
 
    return options->lc + options->lp > LZMA_LCLP_MAX;
}

References LZMA_LCLP_MAX, and options.

Referenced by alone_decode(), lzma2_decode(), and lzma_lzma_props_decode().

lzma_lzma_props_decode()

lzma_ret lzma_lzma_props_decode	(	void **	options,
		const lzma_allocator *	allocator,
		const uint8_t *	props,
		size_t	props_size
	)

Definition at line 1035 of file lzma_decoder.c.

{
    if (props_size != 5)
        return LZMA_OPTIONS_ERROR;
 
    lzma_options_lzma *opt
            = lzma_alloc(sizeof(lzma_options_lzma), allocator);
    if (opt == NULL)
        return LZMA_MEM_ERROR;
 
    if (lzma_lzma_lclppb_decode(opt, props[0]))
        goto error;
 
    // All dictionary sizes are accepted, including zero. LZ decoder
    // will automatically use a dictionary at least a few KiB even if
    // a smaller dictionary is requested.
    opt->dict_size = read32le(props + 1);
 
    opt->preset_dict = NULL;
    opt->preset_dict_size = 0;
 
    *options = opt;
 
    return LZMA_OK;
 
error:
    lzma_free(opt, allocator);
    return LZMA_OPTIONS_ERROR;
}

References allocator, lzma_options_lzma::dict_size, error(), lzma_alloc(), lzma_free(), lzma_lzma_lclppb_decode(), LZMA_MEM_ERROR, LZMA_OK, LZMA_OPTIONS_ERROR, NULL, options, lzma_options_lzma::preset_dict, lzma_options_lzma::preset_dict_size, props, and read32le().