zxc_buffer.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause */
/*
 * ZXC - High-performance lossless compression
 *
 * Copyright (c) Bertrand Lebonnois and contributors.
 */
 
#ifndef ZXC_BUFFER_H
#define ZXC_BUFFER_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "zxc_export.h"
#include "zxc_opts.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
ZXC_EXPORT int zxc_min_level(void);
 
ZXC_EXPORT int zxc_max_level(void);
 
ZXC_EXPORT int zxc_default_level(void);
 
ZXC_EXPORT const char* zxc_version_string(void);
 
 
ZXC_EXPORT uint64_t zxc_compress_bound(const size_t input_size);
 
ZXC_EXPORT int64_t zxc_compress(const void* src, const size_t src_size, void* dst,
                                const size_t dst_capacity, const zxc_compress_opts_t* opts);
 
ZXC_EXPORT int64_t zxc_decompress(const void* src, const size_t src_size, void* dst,
                                  const size_t dst_capacity, const zxc_decompress_opts_t* opts);
 
ZXC_EXPORT size_t zxc_decompress_inplace_bound(const void* src, const size_t src_size);
 
ZXC_EXPORT int64_t zxc_decompress_inplace(void* buffer, const size_t buffer_capacity,
                                          const size_t comp_size,
                                          const zxc_decompress_opts_t* opts);
 
ZXC_EXPORT uint64_t zxc_get_decompressed_size(const void* src, const size_t src_size);
 
ZXC_EXPORT uint32_t zxc_get_dict_id(const void* src, size_t src_size);
 
typedef struct {
    uint64_t decompressed_size; 
    uint64_t compressed_size;   
    uint64_t digest;            
    size_t block_size;          
    uint32_t dict_id;           
    uint8_t format_version;     
    uint8_t has_checksum;       
    uint8_t has_seek_table;     
} zxc_frame_info_t;
 
ZXC_EXPORT int zxc_get_frame_info(const void* src, size_t src_size, zxc_frame_info_t* info,
                                  size_t info_size);
 
ZXC_EXPORT int zxc_get_last_frame_info(const void* src, size_t src_size, zxc_frame_info_t* info,
                                       size_t info_size);
 
ZXC_EXPORT size_t zxc_frame_info_size(void);
 
/* ========================================================================= */
/*  Block-Level API (no file framing)                                        */
/* ========================================================================= */
 
/* Forward declarations for context types (defined below). */
typedef struct zxc_cctx_s zxc_cctx;
typedef struct zxc_dctx_s zxc_dctx;
 
ZXC_EXPORT uint64_t zxc_compress_block_bound(size_t input_size);
 
ZXC_EXPORT uint64_t zxc_decompress_block_bound(const size_t uncompressed_size);
 
ZXC_EXPORT int64_t zxc_compress_block(zxc_cctx* cctx, const void* src, size_t src_size, void* dst,
                                      size_t dst_capacity, const zxc_compress_opts_t* opts);
 
ZXC_EXPORT int64_t zxc_decompress_block(zxc_dctx* dctx, const void* src, size_t src_size, void* dst,
                                        size_t dst_capacity, const zxc_decompress_opts_t* opts);
 
ZXC_EXPORT int64_t zxc_decompress_block_safe(zxc_dctx* dctx, const void* src, const size_t src_size,
                                             void* dst, const size_t dst_capacity,
                                             const zxc_decompress_opts_t* opts);
 
ZXC_EXPORT uint64_t zxc_estimate_cctx_size(size_t src_size, int level);
 
 
/* ========================================================================= */
/*  Reusable Context API (opaque, heap-allocated)                            */
/* ========================================================================= */
 
/* --- Compression context ------------------------------------------------- */
 
ZXC_EXPORT zxc_cctx* zxc_create_cctx(const zxc_compress_opts_t* opts);
 
ZXC_EXPORT void zxc_free_cctx(zxc_cctx* cctx);
 
ZXC_EXPORT int64_t zxc_compress_cctx(zxc_cctx* cctx, const void* src, size_t src_size, void* dst,
                                     size_t dst_capacity, const zxc_compress_opts_t* opts);
 
/* --- Decompression context ----------------------------------------------- */
 
ZXC_EXPORT zxc_dctx* zxc_create_dctx(void);
 
ZXC_EXPORT void zxc_free_dctx(zxc_dctx* dctx);
 
ZXC_EXPORT int64_t zxc_decompress_dctx(zxc_dctx* dctx, const void* src, size_t src_size, void* dst,
                                       size_t dst_capacity, const zxc_decompress_opts_t* opts);
 
ZXC_EXPORT int64_t zxc_decompress_inplace_dctx(zxc_dctx* dctx, void* buffer,
                                               const size_t buffer_capacity, const size_t comp_size,
                                               const zxc_decompress_opts_t* opts);
 
/* ========================================================================= */
/*  Static Context API (caller-allocated workspace)                          */
/* ========================================================================= */
 
ZXC_EXPORT size_t zxc_static_cctx_workspace_size(const size_t block_size, const int level);
 
ZXC_EXPORT zxc_cctx* zxc_init_static_cctx(void* workspace, const size_t workspace_size,
                                          const zxc_compress_opts_t* opts);
 
ZXC_EXPORT size_t zxc_static_dctx_workspace_size(const size_t block_size);
 
ZXC_EXPORT zxc_dctx* zxc_init_static_dctx(void* workspace, const size_t workspace_size,
                                          const size_t block_size);
 
 
#ifdef __cplusplus
}
#endif
 
#endif  // ZXC_BUFFER_H