lzma12.h

Go to the documentation of this file.

/* SPDX-License-Identifier: 0BSD */
 
/*
 * Author: Lasse Collin
 */
 
#ifndef LZMA_H_INTERNAL
#   error Never include this file directly. Use <lzma.h> instead.
#endif
 
 
#define LZMA_FILTER_LZMA1       LZMA_VLI_C(0x4000000000000001)
 
#define LZMA_FILTER_LZMA1EXT    LZMA_VLI_C(0x4000000000000002)
 
#define LZMA_FILTER_LZMA2       LZMA_VLI_C(0x21)
 
 
typedef enum {
    LZMA_MF_HC3     = 0x03,
    LZMA_MF_HC4     = 0x04,
    LZMA_MF_BT2     = 0x12,
    LZMA_MF_BT3     = 0x13,
    LZMA_MF_BT4     = 0x14
} lzma_match_finder;
 
 
extern LZMA_API(lzma_bool) lzma_mf_is_supported(lzma_match_finder match_finder)
        lzma_nothrow lzma_attr_const;
 
 
typedef enum {
    LZMA_MODE_FAST = 1,
    LZMA_MODE_NORMAL = 2
} lzma_mode;
 
 
extern LZMA_API(lzma_bool) lzma_mode_is_supported(lzma_mode mode)
        lzma_nothrow lzma_attr_const;
 
 
typedef struct {
    uint32_t dict_size;
#   define LZMA_DICT_SIZE_MIN       UINT32_C(4096)
#   define LZMA_DICT_SIZE_DEFAULT   (UINT32_C(1) << 23)
 
    const uint8_t *preset_dict;
 
    uint32_t preset_dict_size;
 
    uint32_t lc;
#   define LZMA_LCLP_MIN    0
#   define LZMA_LCLP_MAX    4
#   define LZMA_LC_DEFAULT  3
 
    uint32_t lp;
#   define LZMA_LP_DEFAULT  0
 
    uint32_t pb;
#   define LZMA_PB_MIN      0
#   define LZMA_PB_MAX      4
#   define LZMA_PB_DEFAULT  2
 
    lzma_mode mode;
 
    uint32_t nice_len;
 
    lzma_match_finder mf;
 
    uint32_t depth;
 
    uint32_t ext_flags;
#   define LZMA_LZMA1EXT_ALLOW_EOPM   UINT32_C(0x01)
 
    uint32_t ext_size_low;
 
    uint32_t ext_size_high;
 
    /*
     * Reserved space to allow possible future extensions without
     * breaking the ABI. You should not touch these, because the names
     * of these variables may change. These are and will never be used
     * with the currently supported options, so it is safe to leave these
     * uninitialized.
     */
 
    uint32_t reserved_int4;
 
    uint32_t reserved_int5;
 
    uint32_t reserved_int6;
 
    uint32_t reserved_int7;
 
    uint32_t reserved_int8;
 
    lzma_reserved_enum reserved_enum1;
 
    lzma_reserved_enum reserved_enum2;
 
    lzma_reserved_enum reserved_enum3;
 
    lzma_reserved_enum reserved_enum4;
 
    void *reserved_ptr1;
 
    void *reserved_ptr2;
 
} lzma_options_lzma;
 
 
#define lzma_set_ext_size(opt_lzma2, u64size) \
do { \
    (opt_lzma2).ext_size_low = (uint32_t)(u64size); \
    (opt_lzma2).ext_size_high = (uint32_t)((uint64_t)(u64size) >> 32); \
} while (0)
 
 
extern LZMA_API(lzma_bool) lzma_lzma_preset(
        lzma_options_lzma *options, uint32_t preset) lzma_nothrow;