mlz4frame.h File Reference

#include <stddef.h>

Include dependency graph for mlz4frame.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	MLZ4F_frameInfo_t
struct	MLZ4F_preferences_t
struct	MLZ4F_compressOptions_t
struct	MLZ4F_decompressOptions_t

Macros
#define	MLZ4F_OBSOLETE_ENUM(x)   ,x
#define	MLZ4F_VERSION   100

Typedefs
typedef size_t	MLZ4F_errorCode_t
typedef MLZ4F_blockSizeID_t	blockSizeID_t
typedef MLZ4F_blockMode_t	blockMode_t
typedef MLZ4F_frameType_t	frameType_t
typedef MLZ4F_contentChecksum_t	contentChecksum_t
typedef struct MLZ4F_cctx_s *	MLZ4F_compressionContext_t
typedef struct MLZ4F_dctx_s *	MLZ4F_decompressionContext_t

Enumerations
enum	MLZ4F_blockSizeID_t {   MLZ4F_default =0 , MLZ4F_max64KB =4 , MLZ4F_max256KB =5 , MLZ4F_max1MB =6 ,   MLZ4F_max4MB =7 }
enum	MLZ4F_blockMode_t { MLZ4F_blockLinked =0 , MLZ4F_blockIndependent }
enum	MLZ4F_contentChecksum_t { MLZ4F_noContentChecksum =0 , MLZ4F_contentChecksumEnabled }
enum	MLZ4F_frameType_t { MLZ4F_frame =0 , MLZ4F_skippableFrame }

Functions
unsigned	MLZ4F_isError (MLZ4F_errorCode_t code)
const char *	MLZ4F_getErrorName (MLZ4F_errorCode_t code)
size_t	MLZ4F_compressFrameBound (size_t srcSize, const MLZ4F_preferences_t *preferencesPtr)
size_t	MLZ4F_compressFrame (void *dstBuffer, size_t dstMaxSize, const void *srcBuffer, size_t srcSize, const MLZ4F_preferences_t *preferencesPtr)
MLZ4F_errorCode_t	MLZ4F_createCompressionContext (MLZ4F_compressionContext_t *cctxPtr, unsigned version)
MLZ4F_errorCode_t	MLZ4F_freeCompressionContext (MLZ4F_compressionContext_t cctx)
size_t	MLZ4F_compressBegin (MLZ4F_compressionContext_t cctx, void *dstBuffer, size_t dstMaxSize, const MLZ4F_preferences_t *prefsPtr)
size_t	MLZ4F_compressBound (size_t srcSize, const MLZ4F_preferences_t *prefsPtr)
size_t	MLZ4F_compressUpdate (MLZ4F_compressionContext_t cctx, void *dstBuffer, size_t dstMaxSize, const void *srcBuffer, size_t srcSize, const MLZ4F_compressOptions_t *cOptPtr)
size_t	MLZ4F_flush (MLZ4F_compressionContext_t cctx, void *dstBuffer, size_t dstMaxSize, const MLZ4F_compressOptions_t *cOptPtr)
size_t	MLZ4F_compressEnd (MLZ4F_compressionContext_t cctx, void *dstBuffer, size_t dstMaxSize, const MLZ4F_compressOptions_t *cOptPtr)
MLZ4F_errorCode_t	MLZ4F_createDecompressionContext (MLZ4F_decompressionContext_t *dctxPtr, unsigned version)
MLZ4F_errorCode_t	MLZ4F_freeDecompressionContext (MLZ4F_decompressionContext_t dctx)
size_t	MLZ4F_getFrameInfo (MLZ4F_decompressionContext_t dctx, MLZ4F_frameInfo_t *frameInfoPtr, const void *srcBuffer, size_t *srcSizePtr)
size_t	MLZ4F_decompress (MLZ4F_decompressionContext_t dctx, void *dstBuffer, size_t *dstSizePtr, const void *srcBuffer, size_t *srcSizePtr, const MLZ4F_decompressOptions_t *dOptPtr)

Macro Definition Documentation

MLZ4F_OBSOLETE_ENUM

#define MLZ4F_OBSOLETE_ENUM

(

x

)

,x

Definition at line 67 of file mlz4frame.h.

MLZ4F_VERSION

#define MLZ4F_VERSION   100

Definition at line 158 of file mlz4frame.h.

Typedef Documentation

blockMode_t

typedef MLZ4F_blockMode_t blockMode_t

Definition at line 106 of file mlz4frame.h.

blockSizeID_t

typedef MLZ4F_blockSizeID_t blockSizeID_t

Definition at line 105 of file mlz4frame.h.

contentChecksum_t

typedef MLZ4F_contentChecksum_t contentChecksum_t

Definition at line 108 of file mlz4frame.h.

frameType_t

typedef MLZ4F_frameType_t frameType_t

Definition at line 107 of file mlz4frame.h.

MLZ4F_compressionContext_t

typedef struct MLZ4F_cctx_s* MLZ4F_compressionContext_t

Definition at line 149 of file mlz4frame.h.

MLZ4F_decompressionContext_t

typedef struct MLZ4F_dctx_s* MLZ4F_decompressionContext_t

Definition at line 229 of file mlz4frame.h.

MLZ4F_errorCode_t

typedef size_t MLZ4F_errorCode_t

Definition at line 56 of file mlz4frame.h.

Enumeration Type Documentation

MLZ4F_blockMode_t

enum MLZ4F_blockMode_t

Enumerator
MLZ4F_blockLinked
MLZ4F_blockIndependent

Definition at line 84 of file mlz4frame.h.

MLZ4F_blockSizeID_t

enum MLZ4F_blockSizeID_t

Enumerator
MLZ4F_default
MLZ4F_max64KB
MLZ4F_max256KB
MLZ4F_max1MB
MLZ4F_max4MB

Definition at line 72 of file mlz4frame.h.

MLZ4F_contentChecksum_t

enum MLZ4F_contentChecksum_t

Enumerator
MLZ4F_noContentChecksum
MLZ4F_contentChecksumEnabled

Definition at line 91 of file mlz4frame.h.

MLZ4F_frameType_t

enum MLZ4F_frameType_t

Enumerator
MLZ4F_frame
MLZ4F_skippableFrame

Definition at line 98 of file mlz4frame.h.

Function Documentation

MLZ4F_compressBegin()

size_t MLZ4F_compressBegin	(	MLZ4F_compressionContext_t	cctx,
		void *	dstBuffer,
		size_t	dstMaxSize,
		const MLZ4F_preferences_t *	prefsPtr
	)

Definition at line 392 of file lz4frame.cxx.

Here is the call graph for this function:

MLZ4F_compressBound()

size_t MLZ4F_compressBound	(	size_t	srcSize,
		const MLZ4F_preferences_t *	prefsPtr
	)

Definition at line 477 of file lz4frame.cxx.

Here is the call graph for this function:

MLZ4F_compressEnd()

size_t MLZ4F_compressEnd	(	MLZ4F_compressionContext_t	cctx,
		void *	dstBuffer,
		size_t	dstMaxSize,
		const MLZ4F_compressOptions_t *	cOptPtr
	)

Definition at line 714 of file lz4frame.cxx.

Here is the call graph for this function:

MLZ4F_compressFrame()

size_t MLZ4F_compressFrame	(	void *	dstBuffer,
		size_t	dstMaxSize,
		const void *	srcBuffer,
		size_t	srcSize,
		const MLZ4F_preferences_t *	preferencesPtr
	)

Definition at line 284 of file lz4frame.cxx.

Here is the call graph for this function:

MLZ4F_compressFrameBound()

size_t MLZ4F_compressFrameBound	(	size_t	srcSize,
		const MLZ4F_preferences_t *	preferencesPtr
	)

Definition at line 256 of file lz4frame.cxx.

Here is the call graph for this function:

MLZ4F_compressUpdate()

size_t MLZ4F_compressUpdate	(	MLZ4F_compressionContext_t	cctx,
		void *	dstBuffer,
		size_t	dstMaxSize,
		const void *	srcBuffer,
		size_t	srcSize,
		const MLZ4F_compressOptions_t *	cOptPtr
	)

Definition at line 562 of file lz4frame.cxx.

Here is the call graph for this function:

MLZ4F_createCompressionContext()

MLZ4F_errorCode_t MLZ4F_createCompressionContext	(	MLZ4F_compressionContext_t *	cctxPtr,
		unsigned	version
	)

Definition at line 355 of file lz4frame.cxx.

MLZ4F_createDecompressionContext()

MLZ4F_errorCode_t MLZ4F_createDecompressionContext	(	MLZ4F_decompressionContext_t *	dctxPtr,
		unsigned	version
	)

Definition at line 760 of file lz4frame.cxx.

Here is the caller graph for this function:

MLZ4F_decompress()

size_t MLZ4F_decompress	(	MLZ4F_decompressionContext_t	dctx,
		void *	dstBuffer,
		size_t *	dstSizePtr,
		const void *	srcBuffer,
		size_t *	srcSizePtr,
		const MLZ4F_decompressOptions_t *	dOptPtr
	)

Definition at line 1044 of file lz4frame.cxx.

Here is the call graph for this function:

Here is the caller graph for this function:

MLZ4F_flush()

size_t MLZ4F_flush	(	MLZ4F_compressionContext_t	cctx,
		void *	dstBuffer,
		size_t	dstMaxSize,
		const MLZ4F_compressOptions_t *	cOptPtr
	)

Definition at line 673 of file lz4frame.cxx.

Here is the call graph for this function:

MLZ4F_freeCompressionContext()

MLZ4F_errorCode_t MLZ4F_freeCompressionContext

(

MLZ4F_compressionContext_t

cctx

)

Definition at line 371 of file lz4frame.cxx.

MLZ4F_freeDecompressionContext()

MLZ4F_errorCode_t MLZ4F_freeDecompressionContext

(

MLZ4F_decompressionContext_t

dctx

)

Definition at line 772 of file lz4frame.cxx.

Here is the caller graph for this function:

MLZ4F_getErrorName()

const char * MLZ4F_getErrorName

(

MLZ4F_errorCode_t

code

)

Definition at line 165 of file lz4frame.cxx.

Here is the call graph for this function:

Here is the caller graph for this function:

MLZ4F_getFrameInfo()

size_t MLZ4F_getFrameInfo	(	MLZ4F_decompressionContext_t	dctx,
		MLZ4F_frameInfo_t *	frameInfoPtr,
		const void *	srcBuffer,
		size_t *	srcSizePtr
	)

Definition at line 928 of file lz4frame.cxx.

Here is the call graph for this function:

MLZ4F_isError()

unsigned MLZ4F_isError

(

MLZ4F_errorCode_t

code

)

Definition at line 160 of file lz4frame.cxx.

Here is the caller graph for this function: