compression.h

Go to the documentation of this file.

#ifndef LIBCLOD_COMPRESSION_H
#define LIBCLOD_COMPRESSION_H
 
#include <clod/lib.h>
#include <stddef.h>

enum clod_compression_method {
    CLOD_UNCOMPRESSED = 1,

    CLOD_ZSTD = 2,

    CLOD_LZ4F = 3,

    CLOD_XZ = 4,

    CLOD_DEFLATE = 5,

    CLOD_ZLIB = 6,

    CLOD_GZIP = 7,

    CLOD_MINECRAFT_LZ4 = 9
};

enum clod_compression_level {
    CLOD_COMPRESSION_LOWEST = 0,
    CLOD_COMPRESSION_LOW = 1,
    CLOD_COMPRESSION_NORMAL = 2,
    CLOD_COMPRESSION_HIGH = 3,
    CLOD_COMPRESSION_HIGHEST = 4,
    CLOD_COMPRESSION_LEVELS
};

enum clod_compression_result {
    CLOD_COMPRESSION_SUCCESS = 0,
    CLOD_COMPRESSION_INVALID = 1,
    CLOD_COMPRESSION_MALFORMED = 2,
    CLOD_COMPRESSION_SHORT_BUFFER = 3,
    CLOD_COMPRESSION_SHORT_OUTPUT = 4,
    CLOD_COMPRESSION_ALLOC_FAILED = 5
};

struct clod_compressor;

struct clod_decompressor;

CLOD_API CLOD_USE_RETURN
struct clod_compressor *clod_compressor_init();

CLOD_API CLOD_NONNULL(1)
void clod_compressor_free(struct clod_compressor *ctx);

CLOD_API CLOD_NONNULL(1, 2, 4, 6)
enum clod_compression_result clod_compress(
    struct clod_compressor *ctx,
    void *dst, size_t dst_max_size,
    const void *src, size_t src_size,
    size_t *actual_size,
    enum clod_compression_method method,
    enum clod_compression_level level
);

CLOD_API CLOD_USE_RETURN
struct clod_decompressor *clod_decompressor_init();

CLOD_API CLOD_NONNULL(1)
void clod_decompressor_free(struct clod_decompressor *ctx);

CLOD_API CLOD_NONNULL(1, 2, 4)
enum clod_compression_result clod_decompress(
    struct clod_decompressor *ctx,
    void *dst, size_t dst_size,
    const void *src, size_t src_size,
    size_t *actual_size,
    enum clod_compression_method method
);

#endif