LZ4 API Guide  1.00.01.00
Data Structures | Macros | Typedefs | Enumerations | Functions
lz4.h File Reference
#include <stdint.h>
#include <stdbool.h>
Include dependency graph for lz4.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  LZ4_compressParams
 Compression parameters for a LZ4 frame. More...
 
struct  LZ4_compressBlockParams
 Compression parameters for a single LZ4 block. More...
 
struct  LZ4_decompressParams
 Decompression parameters for a LZ4 frame. More...
 
struct  LZ4_decompressBlockParams
 Decompression parameters for a single LZ4 block. More...
 

Macros

#define LZ4_COMPRESS_MAX_SIZE(n)   ((size_t)((n * 101) / 100) + 27)
 Maximum size of a compressed file, one percent plus 27 bytes larger than uncompressed data. More...
 

Typedefs

typedef struct LZ4_compressParams LZ4_compressParams
 Compression parameters for a LZ4 frame. More...
 
typedef struct LZ4_compressBlockParams LZ4_compressBlockParams
 Compression parameters for a single LZ4 block. More...
 
typedef struct LZ4_decompressParams LZ4_decompressParams
 Decompression parameters for a LZ4 frame. More...
 
typedef struct LZ4_decompressBlockParams LZ4_decompressBlockParams
 Decompression parameters for a single LZ4 block. More...
 

Enumerations

enum  LZ4_status {
  LZ4_SUCCESS, LZ4_PARTIAL_SUCCESS, LZ4_NO_CONTENT_SIZE, LZ4_FRAMING_ERROR,
  LZ4_BLOCK_CHECKSUM_ERROR, LZ4_CONTENT_CHECKSUM_ERROR
}
 LZ4 status return types. More...
 

Functions

uint32_t LZ4_compress (const LZ4_compressParams *params, LZ4_status *status)
 Compress a block of data to a LZ4 frame. More...
 
uint32_t LZ4_compressBlock (const LZ4_compressBlockParams *params, LZ4_status *status)
 Compress a block of data to a single LZ4 block without framing. More...
 
uint32_t LZ4_decompress (const LZ4_decompressParams *params, LZ4_status *status)
 Decompress a LZ4 frame to a block of data. More...
 
uint32_t LZ4_decompressBlock (const LZ4_decompressBlockParams *params, LZ4_status *status)
 Decompress a single LZ4 block without framing to a block of data. More...
 
uint32_t LZ4_getContentSize (const uint8_t *src, LZ4_status *status)
 Get the content size of a compressed LZ4 frame. More...
 
© Copyright 1995-2018, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale