compressor.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-3.0-or-later */
/*
 * compressor.h - This file is part of libsquashfs
 *
 * Copyright (C) 2019 David Oberhollenzer <goliath@infraroot.at>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
#ifndef SQFS_COMPRESSOR_H
#define SQFS_COMPRESSOR_H
 
#include "sqfs/predef.h"
#include "sqfs/super.h"
 
struct sqfs_compressor_t {
    sqfs_object_t base;
 
    void (*get_configuration)(const sqfs_compressor_t *cmp,
                  sqfs_compressor_config_t *cfg);
 
    int (*write_options)(sqfs_compressor_t *cmp, sqfs_file_t *file);
 
    int (*read_options)(sqfs_compressor_t *cmp, sqfs_file_t *file);
 
    sqfs_s32 (*do_block)(sqfs_compressor_t *cmp, const sqfs_u8 *in,
                 sqfs_u32 size, sqfs_u8 *out, sqfs_u32 outsize);
};
 
struct sqfs_compressor_config_t {
    sqfs_u16 id;
 
    sqfs_u16 flags;
 
    sqfs_u32 block_size;
 
    sqfs_u32 level;
 
    union {
        struct {
            sqfs_u16 window_size;
 
            sqfs_u8 padd0[14];
        } gzip;
 
        struct {
            sqfs_u16 algorithm;
 
            sqfs_u8 padd0[14];
        } lzo;
 
        struct {
            sqfs_u32 dict_size;
 
            sqfs_u8 lc;
 
            sqfs_u8 lp;
 
            sqfs_u8 pb;
 
            sqfs_u8 padd0[9];
        } xz, lzma;
 
        sqfs_u64 padd0[2];
    } opt;
};
 
typedef enum {
    SQFS_COMP_FLAG_LZ4_HC = 0x0001,
    SQFS_COMP_FLAG_LZ4_ALL = 0x0001,
 
    SQFS_COMP_FLAG_LZMA_EXTREME = 0x0001,
    SQFS_COMP_FLAG_LZMA_ALL = 0x0001,
 
    SQFS_COMP_FLAG_XZ_X86 = 0x0001,
 
    SQFS_COMP_FLAG_XZ_POWERPC = 0x0002,
 
    SQFS_COMP_FLAG_XZ_IA64 = 0x0004,
 
    SQFS_COMP_FLAG_XZ_ARM = 0x0008,
 
    SQFS_COMP_FLAG_XZ_ARMTHUMB = 0x0010,
 
    SQFS_COMP_FLAG_XZ_SPARC = 0x0020,
 
    SQFS_COMP_FLAG_XZ_EXTREME = 0x0100,
 
    SQFS_COMP_FLAG_XZ_ALL = 0x013F,
 
    SQFS_COMP_FLAG_GZIP_DEFAULT = 0x0001,
 
    SQFS_COMP_FLAG_GZIP_FILTERED = 0x0002,
 
    SQFS_COMP_FLAG_GZIP_HUFFMAN = 0x0004,
 
    SQFS_COMP_FLAG_GZIP_RLE = 0x0008,
 
    SQFS_COMP_FLAG_GZIP_FIXED = 0x0010,
    SQFS_COMP_FLAG_GZIP_ALL = 0x001F,
 
    SQFS_COMP_FLAG_UNCOMPRESS = 0x8000,
    SQFS_COMP_FLAG_GENERIC_ALL = 0x8000,
} SQFS_COMP_FLAG;
 
typedef enum {
    SQFS_LZO1X_1 = 0,
    SQFS_LZO1X_1_11 = 1,
    SQFS_LZO1X_1_12 = 2,
    SQFS_LZO1X_1_15 = 3,
    SQFS_LZO1X_999  = 4,
} SQFS_LZO_ALGORITHM;
 
#define SQFS_GZIP_DEFAULT_LEVEL (9)
#define SQFS_GZIP_DEFAULT_WINDOW (15)
 
#define SQFS_LZO_DEFAULT_ALG SQFS_LZO1X_999
#define SQFS_LZO_DEFAULT_LEVEL (8)
 
#define SQFS_ZSTD_DEFAULT_LEVEL (15)
 
#define SQFS_GZIP_MIN_LEVEL (1)
#define SQFS_GZIP_MAX_LEVEL (9)
 
#define SQFS_LZO_MIN_LEVEL (0)
#define SQFS_LZO_MAX_LEVEL (9)
 
#define SQFS_ZSTD_MIN_LEVEL (1)
#define SQFS_ZSTD_MAX_LEVEL (22)
 
#define SQFS_GZIP_MIN_WINDOW (8)
#define SQFS_GZIP_MAX_WINDOW (15)
 
#define SQFS_XZ_MIN_LEVEL (0)
#define SQFS_XZ_MAX_LEVEL (9)
#define SQFS_XZ_DEFAULT_LEVEL (6)
 
#define SQFS_XZ_MIN_LC 0
#define SQFS_XZ_MAX_LC 4
#define SQFS_XZ_DEFAULT_LC 3
 
#define SQFS_XZ_MIN_LP 0
#define SQFS_XZ_MAX_LP 4
#define SQFS_XZ_DEFAULT_LP 0
 
#define SQFS_XZ_MIN_PB 0
#define SQFS_XZ_MAX_PB 4
#define SQFS_XZ_DEFAULT_PB 2
 
#define SQFS_LZMA_MIN_LEVEL (0)
#define SQFS_LZMA_MAX_LEVEL (9)
#define SQFS_LZMA_DEFAULT_LEVEL (5)
 
#define SQFS_LZMA_MIN_LC 0
#define SQFS_LZMA_MAX_LC 4
#define SQFS_LZMA_DEFAULT_LC 3
 
#define SQFS_LZMA_MIN_LP 0
#define SQFS_LZMA_MAX_LP 4
#define SQFS_LZMA_DEFAULT_LP 0
 
#define SQFS_LZMA_MIN_PB 0
#define SQFS_LZMA_MAX_PB 4
#define SQFS_LZMA_DEFAULT_PB 2
 
#define SQFS_LZMA_MIN_DICT_SIZE SQFS_META_BLOCK_SIZE
#define SQFS_LZMA_MAX_DICT_SIZE SQFS_MAX_BLOCK_SIZE
 
#define SQFS_XZ_MIN_DICT_SIZE SQFS_META_BLOCK_SIZE
#define SQFS_XZ_MAX_DICT_SIZE SQFS_MAX_BLOCK_SIZE
 
#ifdef __cplusplus
extern "C" {
#endif
 
SQFS_API int sqfs_compressor_config_init(sqfs_compressor_config_t *cfg,
                     SQFS_COMPRESSOR id,
                     size_t block_size, sqfs_u16 flags);
 
SQFS_API int sqfs_compressor_create(const sqfs_compressor_config_t *cfg,
                    sqfs_compressor_t **out);
 
SQFS_API const char *sqfs_compressor_name_from_id(SQFS_COMPRESSOR id);
 
SQFS_API int sqfs_compressor_id_from_name(const char *name);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SQFS_COMPRESSOR_H */