lz4.h

Go to the documentation of this file.

#ifndef LZ4_H_
#define LZ4_H_

//******************************************************************************
//
//
//******************************************************************************

//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif

#include <stdint.h>
#include <stdbool.h>

//******************************************************************************
//
//
//******************************************************************************
#define LZ4_COMPRESS_MAX_SIZE(n)        ((size_t)((n * 101) / 100) + 27)

//******************************************************************************
//
//
//******************************************************************************
typedef enum {
    LZ4_SUCCESS,
    LZ4_PARTIAL_SUCCESS,
    LZ4_NO_CONTENT_SIZE,
    LZ4_FRAMING_ERROR,
    LZ4_BLOCK_CHECKSUM_ERROR,
    LZ4_CONTENT_CHECKSUM_ERROR
} LZ4_status;

//******************************************************************************
//
//
//******************************************************************************
typedef struct LZ4_compressParams {
    const void *src;
    void *dst;
    uint32_t length;
    void *hashTable;
    uint16_t hashLog2Size;
    bool addBlockChecksum;
    bool addContentChecksum;
    bool addContentSize;
} LZ4_compressParams;

//******************************************************************************
//
//
//******************************************************************************
typedef struct LZ4_compressBlockParams {
    const void *src;
    void *dst;
    uint32_t length;
    void *hashTable;
    uint16_t hashLog2Size;
    bool addBlockChecksum;
} LZ4_compressBlockParams;

//******************************************************************************
//
//
//******************************************************************************
typedef struct LZ4_decompressParams {
    const void *src;
    void *dst;
    uint32_t dstLength;
    bool verifyBlockChecksum;
    bool verifyContentChecksum;
} LZ4_decompressParams;

//******************************************************************************
//
//
//******************************************************************************
typedef struct LZ4_decompressBlockParams {
    const void *src;
    void *dst;
    uint32_t dstLength;
    bool verifyBlockChecksum;
} LZ4_decompressBlockParams;

//******************************************************************************
//
//
//******************************************************************************
extern uint32_t LZ4_compress(const LZ4_compressParams *params, LZ4_status *status);

//******************************************************************************
//
//
//******************************************************************************
extern uint32_t LZ4_compressBlock(const LZ4_compressBlockParams *params, LZ4_status *status);

//******************************************************************************
//
//
//******************************************************************************
extern uint32_t LZ4_decompress(const LZ4_decompressParams *params, LZ4_status *status);

//******************************************************************************
//
//
//******************************************************************************
extern uint32_t LZ4_decompressBlock(const LZ4_decompressBlockParams *params, LZ4_status *status);

//******************************************************************************
//
//
//******************************************************************************
extern uint32_t LZ4_getContentSize(const uint8_t *src, LZ4_status *status);

//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

//******************************************************************************
//
// Close the Doxygen group.
//
//******************************************************************************

#endif /* LZ4_H_ */