zxc_seekable.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_SEEKABLE_H
#define ZXC_SEEKABLE_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "zxc_export.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================= */
/*  Seekable Reader (Random-Access Decompression)                            */
/* ========================================================================= */
 
typedef struct zxc_seekable_s zxc_seekable;
 
ZXC_EXPORT zxc_seekable* zxc_seekable_open(const void* src, const size_t src_size);
 
typedef struct {
    int64_t (*read_at)(void* ctx, void* dst, size_t len, uint64_t offset);
 
    void* ctx;
 
    uint64_t size;
} zxc_reader_t;
 
ZXC_EXPORT zxc_seekable* zxc_seekable_open_reader(const zxc_reader_t* r);
 
ZXC_EXPORT uint64_t zxc_seekable_get_num_blocks(const zxc_seekable* s);
 
ZXC_EXPORT uint64_t zxc_seekable_get_decompressed_size(const zxc_seekable* s);
 
ZXC_EXPORT uint32_t zxc_seekable_get_block_comp_size(const zxc_seekable* s,
                                                     const uint64_t block_idx);
 
ZXC_EXPORT uint32_t zxc_seekable_get_block_decomp_size(const zxc_seekable* s,
                                                       const uint64_t block_idx);
 
ZXC_EXPORT int64_t zxc_seekable_decompress_range(zxc_seekable* s, void* dst,
                                                 const size_t dst_capacity, const uint64_t offset,
                                                 const size_t len);
 
ZXC_EXPORT int64_t zxc_seekable_decompress_range_mt(zxc_seekable* s, void* dst,
                                                    const size_t dst_capacity,
                                                    const uint64_t offset, const size_t len,
                                                    int n_threads);
 
ZXC_EXPORT void zxc_seekable_free(zxc_seekable* s);
 
ZXC_EXPORT int zxc_seekable_set_checksum(zxc_seekable* s, int enabled);
 
ZXC_EXPORT int zxc_seekable_set_dict(zxc_seekable* s, const void* dict, size_t dict_size,
                                     const void* dict_huf);
 
/* ========================================================================= */
/*  Seek Table Writer (low-level)                                            */
/* ========================================================================= */
 
ZXC_EXPORT int64_t zxc_write_seek_table(uint8_t* dst, const size_t dst_capacity,
                                        const uint32_t* comp_sizes, const uint64_t num_blocks);
 
ZXC_EXPORT size_t zxc_seek_table_size(const uint64_t num_blocks);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZXC_SEEKABLE_H */