Package org.lwjgl.util.lz4

Class LZ4Frame

java.lang.Object

org.lwjgl.util.lz4.LZ4Frame

public class LZ4Frame
extends Object

Native bindings to the frame API of LZ4.

LZ4F is a stand-alone API to create LZ4-compressed frames conformant with specification v1.6.1. It also offers streaming capabilities. lz4.h is not required when using lz4frame.h, except to get constant such as VERSION_NUMBER.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LZ4F_BLOCK_CHECKSUM_SIZE	Size in bytes of a block checksum footer in little-endian format.
static final int	LZ4F_BLOCK_HEADER_SIZE	Size in bytes of a block header in little-endian format.
static final int	LZ4F_blockChecksumEnabled	LZ4F_blockChecksum_t
static final int	LZ4F_blockIndependent	LZ4F_blockMode_t
static final int	LZ4F_blockLinked	LZ4F_blockMode_t
static final int	LZ4F_CONTENT_CHECKSUM_SIZE	Size in bytes of the content checksum.
static final int	LZ4F_contentChecksumEnabled	LZ4F_contentChecksum_t
static final int	LZ4F_default	LZ4F_blockSizeID_t
static final LZ4FCustomMem	LZ4F_defaultCMem	This constant defers to stdlib's functions
static final int	LZ4F_ERROR_allocation_failed	Error code.
static final int	LZ4F_ERROR_blockChecksum_invalid	Error code.
static final int	LZ4F_ERROR_blockMode_invalid	Error code.
static final int	LZ4F_ERROR_compressionLevel_invalid	Error code.
static final int	LZ4F_ERROR_compressionState_uninitialized	Error code.
static final int	LZ4F_ERROR_contentChecksum_invalid	Error code.
static final int	LZ4F_ERROR_decompressionFailed	Error code.
static final int	LZ4F_ERROR_dstMaxSize_tooSmall	Error code.
static final int	LZ4F_ERROR_frameDecoding_alreadyStarted	Error code.
static final int	LZ4F_ERROR_frameHeader_incomplete	Error code.
static final int	LZ4F_ERROR_frameSize_wrong	Error code.
static final int	LZ4F_ERROR_frameType_unknown	Error code.
static final int	LZ4F_ERROR_GENERIC	Error code.
static final int	LZ4F_ERROR_headerChecksum_invalid	Error code.
static final int	LZ4F_ERROR_headerVersion_wrong	Error code.
static final int	LZ4F_ERROR_io_read	Error code.
static final int	LZ4F_ERROR_io_write	Error code.
static final int	LZ4F_ERROR_maxBlockSize_invalid	Error code.
static final int	LZ4F_ERROR_maxCode	Error code.
static final int	LZ4F_ERROR_parameter_invalid	Error code.
static final int	LZ4F_ERROR_parameter_null	Error code.
static final int	LZ4F_ERROR_reservedFlag_set	Error code.
static final int	LZ4F_ERROR_srcPtr_wrong	Error code.
static final int	LZ4F_ERROR_srcSize_tooLarge	Error code.
static final int	LZ4F_frame	LZ4F_frameType_t
static final int	LZ4F_HEADER_SIZE_MAX	Maximum header size.
static final int	LZ4F_HEADER_SIZE_MIN	Minimum header size.
static final int	LZ4F_MAGIC_SKIPPABLE_START
static final int	LZ4F_MAGICNUMBER
static final int	LZ4F_max1MB	LZ4F_blockSizeID_t
static final int	LZ4F_max256KB	LZ4F_blockSizeID_t
static final int	LZ4F_max4MB	LZ4F_blockSizeID_t
static final int	LZ4F_max64KB	LZ4F_blockSizeID_t
static final int	LZ4F_MIN_SIZE_TO_KNOW_HEADER_LENGTH
static final int	LZ4F_noBlockChecksum	LZ4F_blockChecksum_t
static final int	LZ4F_noContentChecksum	LZ4F_contentChecksum_t
static final int	LZ4F_OK_NoError	Error code.
static final int	LZ4F_skippableFrame	LZ4F_frameType_t
static final int	LZ4F_VERSION	Version number.

Method Summary

Modifier and Type	Method	Description
static long	LZ4F_compressBegin(long cctx, ByteBuffer dstBuffer, @Nullable LZ4FPreferences prefsPtr)	Will write the frame header into dstBuffer.
static long	LZ4F_compressBegin_usingCDict(long cctx, ByteBuffer dstBuffer, long cdict, LZ4FPreferences prefsPtr)	Inits streaming dictionary compression, and writes the frame header into dstBuffer.
static long	LZ4F_compressBegin_usingDict(long cctx, ByteBuffer dstBuffer, ByteBuffer dictBuffer, @Nullable LZ4FPreferences prefsPtr)	Inits dictionary compression streaming, and writes the frame header into dstBuffer.
static long	LZ4F_compressBound(long srcSize, @Nullable LZ4FPreferences prefsPtr)	Provides minimum dstCapacity required to guarantee success of compressUpdate, given a srcSize and preferences, for a worst case scenario.
static long	LZ4F_compressEnd(long cctx, ByteBuffer dstBuffer, @Nullable LZ4FCompressOptions cOptPtr)	To properly finish an LZ4 frame, invoke compressEnd.
static long	LZ4F_compressFrame(ByteBuffer dstBuffer, ByteBuffer srcBuffer, @Nullable LZ4FPreferences preferencesPtr)	Compress srcBuffer content into an LZ4-compressed frame.
static long	LZ4F_compressFrame_usingCDict(long cctx, ByteBuffer dst, ByteBuffer src, long cdict, LZ4FPreferences preferencesPtr)	Compress an entire srcBuffer into a valid LZ4 frame using a digested Dictionary.
static long	LZ4F_compressFrameBound(long srcSize, @Nullable LZ4FPreferences preferencesPtr)	Returns the maximum possible size of a frame compressed with compressFrame given srcSize content and preferences.
static int	LZ4F_compressionLevel_max()
static long	LZ4F_compressUpdate(long cctx, ByteBuffer dstBuffer, ByteBuffer srcBuffer, @Nullable LZ4FCompressOptions cOptPtr)	LZ4F_compressUpdate() can be called repetitively to compress as much data as necessary.
static long	LZ4F_createCDict(ByteBuffer dictBuffer)	When compressing multiple messages / blocks with the same dictionary, it's recommended to load it just once.
static long	LZ4F_createCDict_advanced(LZ4FCustomMem customMem, ByteBuffer dictBuffer)	createCDict with custom allocation/free functions.
static long	LZ4F_createCompressionContext(org.lwjgl.PointerBuffer cctxPtr, int version)	The first thing to do is to create a compressionContext object, which will keep track of operation state during streaming compression.
static long	LZ4F_createCompressionContext_advanced(LZ4FCustomMem customMem, int version)	createCompressionContext with custom allocation/free functions.
static long	LZ4F_createDecompressionContext(org.lwjgl.PointerBuffer dctxPtr, int version)	Create an LZ4F_dctx object, to track all decompression operations.
static long	LZ4F_createDecompressionContext_advanced(LZ4FCustomMem customMem, int version)	createDecompressionContext with custom allocation/free functions.
static long	LZ4F_decompress(long dctx, ByteBuffer dstBuffer, org.lwjgl.PointerBuffer dstSizePtr, ByteBuffer srcBuffer, org.lwjgl.PointerBuffer srcSizePtr, LZ4FDecompressOptions dOptPtr)	Call this function repetitively to regenerate data compressed in srcBuffer.
static long	LZ4F_decompress_usingDict(long dctxPtr, ByteBuffer dstBuffer, org.lwjgl.PointerBuffer dstSizePtr, ByteBuffer srcBuffer, org.lwjgl.PointerBuffer srcSizePtr, ByteBuffer dict, LZ4FDecompressOptions decompressOptionsPtr)	Same as decompress, using a predefined dictionary.
static long	LZ4F_flush(long cctx, ByteBuffer dstBuffer, @Nullable LZ4FCompressOptions cOptPtr)	When data must be generated and sent immediately, without waiting for a block to be completely filled, it's possible to call flush.
static void	LZ4F_freeCDict(long CDict)
static long	LZ4F_freeCompressionContext(long cctx)	Frees an LZ4F_cctx object.
static long	LZ4F_freeDecompressionContext(long dctx)	Frees an LZ4F_dctx object.
static long	LZ4F_getBlockSize(int blockSizeID)	Return, in scalar format (size_t), the maximum block size associated with blockSizeID, or an error code (can be tested using isError) if blockSizeID is invalid.
static int	LZ4F_getErrorCode(long functionResult)
static @Nullable String	LZ4F_getErrorName(long code)	Return error code string; for debugging.
static long	LZ4F_getFrameInfo(long dctx, LZ4FFrameInfo frameInfoPtr, ByteBuffer srcBuffer, org.lwjgl.PointerBuffer srcSizePtr)	This function extracts frame parameters (max blockSize, dictID, etc.).
static int	LZ4F_getVersion()
static long	LZ4F_headerSize(ByteBuffer src)	Provide the header size of a frame starting at src.
static boolean	LZ4F_isError(long code)	Tells when a function result is an error code.
static void	LZ4F_resetDecompressionContext(long dctx)	In case of an error, the context is left in "undefined" state.
static long	LZ4F_uncompressedUpdate(long cctx, ByteBuffer dstBuffer, ByteBuffer srcBuffer, @Nullable LZ4FCompressOptions cOptPtr)	Can be called repetitively to add data stored as uncompressed blocks.
static long	nLZ4F_compressBegin(long cctx, long dstBuffer, long dstCapacity, long prefsPtr)	Unsafe version of: compressBegin
static long	nLZ4F_compressBegin_usingCDict(long cctx, long dstBuffer, long dstCapacity, long cdict, long prefsPtr)	Unsafe version of: compressBegin_usingCDict
static long	nLZ4F_compressBegin_usingDict(long cctx, long dstBuffer, long dstCapacity, long dictBuffer, long dictSize, long prefsPtr)	Unsafe version of: compressBegin_usingDict
static long	nLZ4F_compressBound(long srcSize, long prefsPtr)	Unsafe version of: compressBound
static long	nLZ4F_compressEnd(long cctx, long dstBuffer, long dstCapacity, long cOptPtr)	Unsafe version of: compressEnd
static long	nLZ4F_compressFrame(long dstBuffer, long dstCapacity, long srcBuffer, long srcSize, long preferencesPtr)	Unsafe version of: compressFrame
static long	nLZ4F_compressFrame_usingCDict(long cctx, long dst, long dstCapacity, long src, long srcSize, long cdict, long preferencesPtr)	Unsafe version of: compressFrame_usingCDict
static long	nLZ4F_compressFrameBound(long srcSize, long preferencesPtr)	Unsafe version of: compressFrameBound
static long	nLZ4F_compressUpdate(long cctx, long dstBuffer, long dstCapacity, long srcBuffer, long srcSize, long cOptPtr)	Unsafe version of: compressUpdate
static long	nLZ4F_createCDict(long dictBuffer, long dictSize)	Unsafe version of: createCDict
static long	nLZ4F_createCDict_advanced(long customMem, long dictBuffer, long dictSize)	Unsafe version of: createCDict_advanced
static long	nLZ4F_createCompressionContext(long cctxPtr, int version)	Unsafe version of: createCompressionContext
static long	nLZ4F_createCompressionContext_advanced(long customMem, int version)	Unsafe version of: createCompressionContext_advanced
static long	nLZ4F_createDecompressionContext(long dctxPtr, int version)	Unsafe version of: createDecompressionContext
static long	nLZ4F_createDecompressionContext_advanced(long customMem, int version)	Unsafe version of: createDecompressionContext_advanced
static long	nLZ4F_decompress(long dctx, long dstBuffer, long dstSizePtr, long srcBuffer, long srcSizePtr, long dOptPtr)	Unsafe version of: decompress
static long	nLZ4F_decompress_usingDict(long dctxPtr, long dstBuffer, long dstSizePtr, long srcBuffer, long srcSizePtr, long dict, long dictSize, long decompressOptionsPtr)	Unsafe version of: decompress_usingDict
static long	nLZ4F_flush(long cctx, long dstBuffer, long dstCapacity, long cOptPtr)	Unsafe version of: flush
static void	nLZ4F_freeCDict(long CDict)
static long	nLZ4F_freeDecompressionContext(long dctx)	Unsafe version of: freeDecompressionContext
static long	nLZ4F_getErrorName(long code)	Unsafe version of: getErrorName
static long	nLZ4F_getFrameInfo(long dctx, long frameInfoPtr, long srcBuffer, long srcSizePtr)	Unsafe version of: getFrameInfo
static long	nLZ4F_headerSize(long src, long srcSize)	Unsafe version of: headerSize
static int	nLZ4F_isError(long code)	Unsafe version of: isError
static void	nLZ4F_resetDecompressionContext(long dctx)	Unsafe version of: resetDecompressionContext
static long	nLZ4F_uncompressedUpdate(long cctx, long dstBuffer, long dstCapacity, long srcBuffer, long srcSize, long cOptPtr)	Unsafe version of: uncompressedUpdate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LZ4F_VERSION

public static final int LZ4F_VERSION

Version number.

This number can be used to check for an incompatible API breaking change.

See Also:

• Constant Field Values

LZ4F_HEADER_SIZE_MIN

public static final int LZ4F_HEADER_SIZE_MIN

Minimum header size.

See Also:

• Constant Field Values

LZ4F_HEADER_SIZE_MAX

public static final int LZ4F_HEADER_SIZE_MAX

Maximum header size.

See Also:

• Constant Field Values

LZ4F_BLOCK_HEADER_SIZE

public static final int LZ4F_BLOCK_HEADER_SIZE

Size in bytes of a block header in little-endian format. Highest bit indicates if block data is uncompressed.

See Also:

• Constant Field Values

LZ4F_BLOCK_CHECKSUM_SIZE

public static final int LZ4F_BLOCK_CHECKSUM_SIZE

Size in bytes of a block checksum footer in little-endian format.

See Also:

• Constant Field Values

LZ4F_CONTENT_CHECKSUM_SIZE

public static final int LZ4F_CONTENT_CHECKSUM_SIZE

Size in bytes of the content checksum.

See Also:

• Constant Field Values

LZ4F_default

public static final int LZ4F_default

LZ4F_blockSizeID_t

The larger the block size, the (slightly) better the compression ratio, though there are diminishing returns. Larger blocks also increase memory usage on both compression and decompression sides.

Enum values:

• default
• max64KB
• max256KB
• max1MB
• max4MB

See Also:

• Constant Field Values

LZ4F_max64KB

public static final int LZ4F_max64KB

LZ4F_blockSizeID_t

The larger the block size, the (slightly) better the compression ratio, though there are diminishing returns. Larger blocks also increase memory usage on both compression and decompression sides.

Enum values:

• default
• max64KB
• max256KB
• max1MB
• max4MB

See Also:

• Constant Field Values

LZ4F_max256KB

public static final int LZ4F_max256KB

LZ4F_blockSizeID_t

The larger the block size, the (slightly) better the compression ratio, though there are diminishing returns. Larger blocks also increase memory usage on both compression and decompression sides.

Enum values:

• default
• max64KB
• max256KB
• max1MB
• max4MB

See Also:

• Constant Field Values

LZ4F_max1MB

public static final int LZ4F_max1MB

LZ4F_blockSizeID_t

The larger the block size, the (slightly) better the compression ratio, though there are diminishing returns. Larger blocks also increase memory usage on both compression and decompression sides.

Enum values:

• default
• max64KB
• max256KB
• max1MB
• max4MB

See Also:

• Constant Field Values

LZ4F_max4MB

public static final int LZ4F_max4MB

LZ4F_blockSizeID_t

The larger the block size, the (slightly) better the compression ratio, though there are diminishing returns. Larger blocks also increase memory usage on both compression and decompression sides.

Enum values:

• default
• max64KB
• max256KB
• max1MB
• max4MB

See Also:

• Constant Field Values

LZ4F_blockLinked

public static final int LZ4F_blockLinked

LZ4F_blockMode_t

Linked blocks sharply reduce inefficiencies when using small blocks, they compress better. However, some LZ4 decoders are only compatible with independent blocks

Enum values:

• blockLinked
• blockIndependent

See Also:

• Constant Field Values

LZ4F_blockIndependent

public static final int LZ4F_blockIndependent

LZ4F_blockMode_t

Linked blocks sharply reduce inefficiencies when using small blocks, they compress better. However, some LZ4 decoders are only compatible with independent blocks

Enum values:

• blockLinked
• blockIndependent

See Also:

• Constant Field Values

LZ4F_noContentChecksum

public static final int LZ4F_noContentChecksum

LZ4F_contentChecksum_t

Enum values:

• noContentChecksum
• contentChecksumEnabled

See Also:

• Constant Field Values

LZ4F_contentChecksumEnabled

public static final int LZ4F_contentChecksumEnabled

LZ4F_contentChecksum_t

Enum values:

• noContentChecksum
• contentChecksumEnabled

See Also:

• Constant Field Values

LZ4F_noBlockChecksum

public static final int LZ4F_noBlockChecksum

LZ4F_blockChecksum_t

Enum values:

• noBlockChecksum
• blockChecksumEnabled

See Also:

• Constant Field Values

LZ4F_blockChecksumEnabled

public static final int LZ4F_blockChecksumEnabled

LZ4F_blockChecksum_t

Enum values:

• noBlockChecksum
• blockChecksumEnabled

See Also:

• Constant Field Values

LZ4F_frame

public static final int LZ4F_frame

LZ4F_frameType_t

Enum values:

• frame
• skippableFrame

See Also:

• Constant Field Values

LZ4F_skippableFrame

public static final int LZ4F_skippableFrame

LZ4F_frameType_t

Enum values:

• frame
• skippableFrame

See Also:

• Constant Field Values

LZ4F_MAGICNUMBER

public static final int LZ4F_MAGICNUMBER

See Also:

• Constant Field Values

LZ4F_MAGIC_SKIPPABLE_START

public static final int LZ4F_MAGIC_SKIPPABLE_START

See Also:

• Constant Field Values

LZ4F_MIN_SIZE_TO_KNOW_HEADER_LENGTH

public static final int LZ4F_MIN_SIZE_TO_KNOW_HEADER_LENGTH

See Also:

• Constant Field Values

LZ4F_OK_NoError

public static final int LZ4F_OK_NoError

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_GENERIC

public static final int LZ4F_ERROR_GENERIC

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_maxBlockSize_invalid

public static final int LZ4F_ERROR_maxBlockSize_invalid

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_blockMode_invalid

public static final int LZ4F_ERROR_blockMode_invalid

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_parameter_invalid

public static final int LZ4F_ERROR_parameter_invalid

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_compressionLevel_invalid

public static final int LZ4F_ERROR_compressionLevel_invalid

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_headerVersion_wrong

public static final int LZ4F_ERROR_headerVersion_wrong

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_blockChecksum_invalid

public static final int LZ4F_ERROR_blockChecksum_invalid

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_reservedFlag_set

public static final int LZ4F_ERROR_reservedFlag_set

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_allocation_failed

public static final int LZ4F_ERROR_allocation_failed

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_srcSize_tooLarge

public static final int LZ4F_ERROR_srcSize_tooLarge

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_dstMaxSize_tooSmall

public static final int LZ4F_ERROR_dstMaxSize_tooSmall

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_frameHeader_incomplete

public static final int LZ4F_ERROR_frameHeader_incomplete

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_frameType_unknown

public static final int LZ4F_ERROR_frameType_unknown

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_frameSize_wrong

public static final int LZ4F_ERROR_frameSize_wrong

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_srcPtr_wrong

public static final int LZ4F_ERROR_srcPtr_wrong

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_decompressionFailed

public static final int LZ4F_ERROR_decompressionFailed

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_headerChecksum_invalid

public static final int LZ4F_ERROR_headerChecksum_invalid

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_contentChecksum_invalid

public static final int LZ4F_ERROR_contentChecksum_invalid

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_frameDecoding_alreadyStarted

public static final int LZ4F_ERROR_frameDecoding_alreadyStarted

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_compressionState_uninitialized

public static final int LZ4F_ERROR_compressionState_uninitialized

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_parameter_null

public static final int LZ4F_ERROR_parameter_null

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_io_write

public static final int LZ4F_ERROR_io_write

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_io_read

public static final int LZ4F_ERROR_io_read

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_ERROR_maxCode

public static final int LZ4F_ERROR_maxCode

Error code.

Enum values:

• OK_NoError
• ERROR_GENERIC
• ERROR_maxBlockSize_invalid
• ERROR_blockMode_invalid
• ERROR_parameter_invalid
• ERROR_compressionLevel_invalid
• ERROR_headerVersion_wrong
• ERROR_blockChecksum_invalid
• ERROR_reservedFlag_set
• ERROR_allocation_failed
• ERROR_srcSize_tooLarge
• ERROR_dstMaxSize_tooSmall
• ERROR_frameHeader_incomplete
• ERROR_frameType_unknown
• ERROR_frameSize_wrong
• ERROR_srcPtr_wrong
• ERROR_decompressionFailed
• ERROR_headerChecksum_invalid
• ERROR_contentChecksum_invalid
• ERROR_frameDecoding_alreadyStarted
• ERROR_compressionState_uninitialized
• ERROR_parameter_null
• ERROR_io_write
• ERROR_io_read
• ERROR_maxCode

See Also:

• Constant Field Values

LZ4F_defaultCMem

public static final LZ4FCustomMem LZ4F_defaultCMem

This constant defers to stdlib's functions

Method Details

nLZ4F_isError

public static int nLZ4F_isError(long code)

Unsafe version of: isError

LZ4F_isError

public static boolean LZ4F_isError(long code)

Tells when a function result is an error code.

nLZ4F_getErrorName

public static long nLZ4F_getErrorName(long code)

Unsafe version of: getErrorName

LZ4F_getErrorName

public static @Nullable String LZ4F_getErrorName(long code)

Return error code string; for debugging.

nLZ4F_compressFrame

public static long nLZ4F_compressFrame(long dstBuffer,
 long dstCapacity,
 long srcBuffer,
 long srcSize,
 long preferencesPtr)

Unsafe version of: compressFrame

Parameters:

dstCapacity - MUST be ≥ compressFrameBound(srcSize, preferencesPtr)

LZ4F_compressFrame

public static long LZ4F_compressFrame(ByteBuffer dstBuffer,
 ByteBuffer srcBuffer,
 @Nullable LZ4FPreferences preferencesPtr)

Compress srcBuffer content into an LZ4-compressed frame. It's a one shot operation, all input content is consumed, and all output is\ generated.

Note : it's a stateless operation (no LZ4F_cctx state needed). In order to reduce load on the allocator, LZ4F_compressFrame(), by default, uses the stack to allocate space for the compression state and some table. If this usage of the stack is too much for your application, consider compiling lz4frame.c with compile-time macro LZ4F_HEAPMODE set to 1 instead. All state allocations will use the Heap. It also means each invocation of LZ4F_compressFrame() will trigger several internal alloc/free invocations.

Parameters:

preferencesPtr - optional: one can provide NULL, in which case all preferences are set to default

Returns:

number of bytes written into dstBuffer or an error code if it fails (can be tested using isError)

nLZ4F_compressFrameBound

public static long nLZ4F_compressFrameBound(long srcSize,
 long preferencesPtr)

Unsafe version of: compressFrameBound

LZ4F_compressFrameBound

public static long LZ4F_compressFrameBound(long srcSize,
 @Nullable LZ4FPreferences preferencesPtr)

Returns the maximum possible size of a frame compressed with compressFrame given srcSize content and preferences.

Returns the maximum possible compressed size with compressFrame given srcSize and preferences. preferencesPtr is optional. It can be replaced by NULL, in which case, the function will assume default preferences.

Note

this result is only usable with compressFrame. It may also be relevant to compressUpdate only if no flush operation is ever performed.

LZ4F_compressionLevel_max

public static int LZ4F_compressionLevel_max()

Returns:

maximum allowed compression level (currently: 12)

LZ4F_getVersion

public static int LZ4F_getVersion()

nLZ4F_createCompressionContext

public static long nLZ4F_createCompressionContext(long cctxPtr,
 int version)

Unsafe version of: createCompressionContext

LZ4F_createCompressionContext

public static long LZ4F_createCompressionContext(org.lwjgl.PointerBuffer cctxPtr,
 int version)

The first thing to do is to create a compressionContext object, which will keep track of operation state during streaming compression. This is achieved using LZ4F_createCompressionContext(), which takes as argument a version, and a pointer to LZ4F_cctx*, to write the resulting pointer into.

The function provides a pointer to a fully allocated LZ4F_cctx object.

A created compression context can be employed multiple times for consecutive streaming operations. Once all streaming compression jobs are completed, the state object can be released using freeCompressionContext.

Parameters:

cctxPtr - MUST be != NULL

version - MUST be VERSION. It is intended to track potential version mismatch, notably when using DLL. Must be:

VERSION

Returns:

if != zero, context creation failed.

LZ4F_freeCompressionContext

public static long LZ4F_freeCompressionContext(long cctx)

Frees an LZ4F_cctx object. Notes:

• LZ4F_freeCompressionContext() is always successful. Its return value can be ignored.
• LZ4F_freeCompressionContext() works fine with NULL input pointers (do nothing).

nLZ4F_compressBegin

public static long nLZ4F_compressBegin(long cctx,
 long dstBuffer,
 long dstCapacity,
 long prefsPtr)

Unsafe version of: compressBegin

Parameters:

dstCapacity - must be ≥ HEADER_SIZE_MAX bytes

LZ4F_compressBegin

public static long LZ4F_compressBegin(long cctx,
 ByteBuffer dstBuffer,
 @Nullable LZ4FPreferences prefsPtr)

Will write the frame header into dstBuffer.

Parameters:

prefsPtr - optional: NULL can be provided to set all preferences to default

Returns:

number of bytes written into dstBuffer for the header or an error code (which can be tested using isError)

nLZ4F_compressBound

public static long nLZ4F_compressBound(long srcSize,
 long prefsPtr)

Unsafe version of: compressBound

LZ4F_compressBound

public static long LZ4F_compressBound(long srcSize,
 @Nullable LZ4FPreferences prefsPtr)

Provides minimum dstCapacity required to guarantee success of compressUpdate, given a srcSize and preferences, for a worst case scenario.

When srcSize==0, LZ4F_compressBound() provides an upper bound for flush and compressEnd instead. Note that the result is only valid for a single invocation of LZ4F_compressUpdate(). When invoking LZ4F_compressUpdate() multiple times, if the output buffer is gradually filled up instead of emptied and re-used from its start, one must check if there is enough remaining capacity before each invocation, using LZ4F_compressBound().

Result is always the same for a srcSize and prefsPtr. If automatic flushing is not enabled, includes the possibility that internal buffer might already be filled by up to (blockSize-1) bytes. It also includes frame footer (ending + checksum), since it might be generated by LZ4F_compressEnd(). The result doesn't include frame header, as it was already generated by LZ4F_compressBegin().

Parameters:

prefsPtr - optional: when NULL is provided, preferences will be set to cover worst case scenario

nLZ4F_compressUpdate

public static long nLZ4F_compressUpdate(long cctx,
 long dstBuffer,
 long dstCapacity,
 long srcBuffer,
 long srcSize,
 long cOptPtr)

Unsafe version of: compressUpdate

LZ4F_compressUpdate

public static long LZ4F_compressUpdate(long cctx,
 ByteBuffer dstBuffer,
 ByteBuffer srcBuffer,
 @Nullable LZ4FCompressOptions cOptPtr)

LZ4F_compressUpdate() can be called repetitively to compress as much data as necessary.

Important rule: dstCapacity MUST be large enough to ensure operation success even in worst case situations. This value is provided by compressBound. If this condition is not respected, LZ4F_compress() will fail (result is an errorCode).

After an error, the state is left in a UB state, and must be re-initialized or freed. If previously an uncompressed block was written, buffered data is flushed before appending compressed data is continued.

Parameters:

cOptPtr - optional: NULL can be provided, in which case all options are set to default

Returns:

number of bytes written into dstBuffer (it can be zero, meaning input data was just buffered) or an error code if it fails (which can be tested using isError)

nLZ4F_flush

public static long nLZ4F_flush(long cctx,
 long dstBuffer,
 long dstCapacity,
 long cOptPtr)

Unsafe version of: flush

Parameters:

dstCapacity - must be large enough to ensure the operation will be successful

LZ4F_flush

public static long LZ4F_flush(long cctx,
 ByteBuffer dstBuffer,
 @Nullable LZ4FCompressOptions cOptPtr)

When data must be generated and sent immediately, without waiting for a block to be completely filled, it's possible to call flush. It will immediately compress any data buffered within cctx.

Parameters:

cOptPtr - optional: it's possible to provide NULL, all options will be set to default

Returns:

nb of bytes written into dstBuffer (can be zero, when there is no data stored within cctx) or an error code if it fails (which can be tested using isError)

nLZ4F_compressEnd

public static long nLZ4F_compressEnd(long cctx,
 long dstBuffer,
 long dstCapacity,
 long cOptPtr)

Unsafe version of: compressEnd

LZ4F_compressEnd

public static long LZ4F_compressEnd(long cctx,
 ByteBuffer dstBuffer,
 @Nullable LZ4FCompressOptions cOptPtr)

To properly finish an LZ4 frame, invoke compressEnd. It will flush whatever data remained within cctx (like flush) and properly finalize the frame, with an endMark and a checksum.

Parameters:

cOptPtr - optional: NULL can be provided, in which case all options will be set to default

Returns:

nb of bytes written into dstBuffer, necessarily ≥ 4 (endMark), or an error code if it fails (which can be tested using isError).

A successful call to compressEnd makes cctx available again for another compression task.

nLZ4F_createDecompressionContext

public static long nLZ4F_createDecompressionContext(long dctxPtr,
 int version)

Unsafe version of: createDecompressionContext

LZ4F_createDecompressionContext

public static long LZ4F_createDecompressionContext(org.lwjgl.PointerBuffer dctxPtr,
 int version)

Create an LZ4F_dctx object, to track all decompression operations.

The function fills dctxPtr with the value of a pointer to an allocated and initialized LZ4F_dctx object.dctx memory can be released using freeDecompressionContext.

Parameters:

dctxPtr - MUST be valid

version - must be:

VERSION

Returns:

an errorCode, which can be tested using isError

nLZ4F_freeDecompressionContext

public static long nLZ4F_freeDecompressionContext(long dctx)

Unsafe version of: freeDecompressionContext

LZ4F_freeDecompressionContext

public static long LZ4F_freeDecompressionContext(long dctx)

Frees an LZ4F_dctx object.

Returns:

an errorCode, which can be tested using isError.

Result of LZ4F_freeDecompressionContext() indicates current state of decompressionContext when being released. That is, it should be == 0 if decompression has been completed fully and correctly.

nLZ4F_headerSize

public static long nLZ4F_headerSize(long src,
 long srcSize)

Unsafe version of: headerSize

Parameters:

srcSize - must be ≥ MIN_SIZE_TO_KNOW_HEADER_LENGTH, which is enough to decode the header length

LZ4F_headerSize

public static long LZ4F_headerSize(ByteBuffer src)

Provide the header size of a frame starting at src.

Note: Frame header size is variable, but is guaranteed to be ≥ HEADER_SIZE_MIN bytes, and ≤ HEADER_SIZE_MAX bytes.

Returns:

size of frame header or an error code, which can be tested using isError

nLZ4F_getFrameInfo

public static long nLZ4F_getFrameInfo(long dctx,
 long frameInfoPtr,
 long srcBuffer,
 long srcSizePtr)

Unsafe version of: getFrameInfo

LZ4F_getFrameInfo

public static long LZ4F_getFrameInfo(long dctx,
 LZ4FFrameInfo frameInfoPtr,
 ByteBuffer srcBuffer,
 org.lwjgl.PointerBuffer srcSizePtr)

This function extracts frame parameters (max blockSize, dictID, etc.). Its usage is optional: user can also invoke decompress directly.

Extracted information is typically useful for allocation and dictionary. This function works in 2 situations:

• At the beginning of a new frame, in which case it will decode information from srcBuffer, starting the decoding process.

  Input size must be large enough to successfully decode the entire frame header. Frame header size is variable, but is guaranteed to be ≤ HEADER_SIZE_MAX bytes. It's allowed to provide more input data than this minimum.

• After decoding has been started. In which case, no input is read, frame parameters are extracted from dctx.
• If decoding has barely started, but not yet extracted information from header, LZ4F_getFrameInfo() will fail.

The number of bytes consumed from srcBuffer will be updated within *srcSizePtr (necessarily ≤ original value). Decompression must resume from (srcBuffer + *srcSizePtr).

Notes:

1. in case of error, dctx is not modified. Decoding operation can resume from beginning safely
2. frame parameters are copied into an already allocated LZ4F_frameInfo_t structure

Returns:

an hint about how many srcSize bytes LZ4F_decompress() expects for next call, or an error code which can be tested using LZ4F_isError()

nLZ4F_decompress

public static long nLZ4F_decompress(long dctx,
 long dstBuffer,
 long dstSizePtr,
 long srcBuffer,
 long srcSizePtr,
 long dOptPtr)

Unsafe version of: decompress

LZ4F_decompress

public static long LZ4F_decompress(long dctx,
 ByteBuffer dstBuffer,
 org.lwjgl.PointerBuffer dstSizePtr,
 ByteBuffer srcBuffer,
 org.lwjgl.PointerBuffer srcSizePtr,
 LZ4FDecompressOptions dOptPtr)

Call this function repetitively to regenerate data compressed in srcBuffer.

The function requires a valid dctx state. It will read up to *srcSizePtr bytes from srcBuffer, and decompress data into dstBuffer, of capacity *dstSizePtr.

The nb of bytes consumed from srcBuffer will be written into *srcSizePtr (necessarily ≤ original value). The number of bytes decompressed into dstBuffer will be written into *dstSizePtr (necessarily ≤ original value).

The nb of bytes regenerated into dstBuffer is provided within *dstSizePtr (necessarily ≤ original value).

The function does not necessarily read all input bytes, so always check value in *srcSizePtr. Unconsumed source data must be presented again in subsequent invocations.

dstBuffer can freely change between each consecutive function invocation. dstBuffer content will be overwritten.

Note: if getFrameInfo is called before LZ4F_decompress(), srcBuffer must be updated to reflect the number of bytes consumed after reading the frame header. Failure to update srcBuffer before calling LZ4F_decompress() will cause decompression failure or, even worse, successful but incorrect decompression. See the LZ4F_getFrameInfo() docs for details.

After a frame is fully decoded, dctx can be used again to decompress another frame.

After a decompression error, use resetDecompressionContext before re-using dctx, to return to clean state.

Returns:

a hint of how many srcSize bytes LZ4F_decompress() expects for next call.

Schematically, it's the size of the current (or remaining) compressed block + header of next block. Respecting the hint provides some small speed benefit, because it skips intermediate buffers. This is just a hint though, it's always possible to provide any srcSize.

When a frame is fully decoded, return will be 0 (no more data expected). When provided with more bytes than necessary to decode a frame, LZ4F_decompress() will stop reading exactly at end of current frame, and return 0.

If decompression failed, return is an error code, which can be tested using isError. After a decompression error, the dctx context is not resumable. Use resetDecompressionContext to return to clean state.

nLZ4F_resetDecompressionContext

public static void nLZ4F_resetDecompressionContext(long dctx)

Unsafe version of: resetDecompressionContext

LZ4F_resetDecompressionContext

public static void LZ4F_resetDecompressionContext(long dctx)

In case of an error, the context is left in "undefined" state. In which case, it's necessary to reset it, before re-using it.

This method can also be used to abruptly stop an unfinished decompression, and start a new one using the same context resources.

Since:

1.8.0

LZ4F_getErrorCode

public static int LZ4F_getErrorCode(long functionResult)

nLZ4F_compressBegin_usingDict

public static long nLZ4F_compressBegin_usingDict(long cctx,
 long dstBuffer,
 long dstCapacity,
 long dictBuffer,
 long dictSize,
 long prefsPtr)

Unsafe version of: compressBegin_usingDict

Parameters:

dstCapacity - must be ≥ HEADER_SIZE_MAX bytes

dictSize - must outlive the compression session

LZ4F_compressBegin_usingDict

public static long LZ4F_compressBegin_usingDict(long cctx,
 ByteBuffer dstBuffer,
 ByteBuffer dictBuffer,
 @Nullable LZ4FPreferences prefsPtr)

Inits dictionary compression streaming, and writes the frame header into dstBuffer.

NOTE: The LZ4Frame spec allows each independent block to be compressed with the dictionary, but this entry supports a more limited scenario, where only the first block uses the dictionary. This is still useful for small data, which only need one block anyway. For larger inputs, one may be more interested in compressFrame_usingCDict.

Parameters:

prefsPtr - optional: one may provide NULL as argument, however, it's the only way to provide dictID in the frame header.

Returns:

number of bytes written into dstBuffer for the header, or an error code (which can be tested using isError)

nLZ4F_decompress_usingDict

public static long nLZ4F_decompress_usingDict(long dctxPtr,
 long dstBuffer,
 long dstSizePtr,
 long srcBuffer,
 long srcSizePtr,
 long dict,
 long dictSize,
 long decompressOptionsPtr)

Unsafe version of: decompress_usingDict

LZ4F_decompress_usingDict

public static long LZ4F_decompress_usingDict(long dctxPtr,
 ByteBuffer dstBuffer,
 org.lwjgl.PointerBuffer dstSizePtr,
 ByteBuffer srcBuffer,
 org.lwjgl.PointerBuffer srcSizePtr,
 ByteBuffer dict,
 LZ4FDecompressOptions decompressOptionsPtr)

Same as decompress, using a predefined dictionary.

Dictionary is used "in place", without any preprocessing. It must remain accessible throughout the entire frame decoding.

nLZ4F_createCDict

public static long nLZ4F_createCDict(long dictBuffer,
 long dictSize)

Unsafe version of: createCDict

LZ4F_createCDict

public static long LZ4F_createCDict(ByteBuffer dictBuffer)

When compressing multiple messages / blocks with the same dictionary, it's recommended to load it just once. LZ4_createCDict() will create a digested dictionary, ready to start future compression operations without startup delay.

LZ4_CDict can be created once and shared by multiple threads concurrently, since its usage is read-only.

dictBuffer can be released after LZ4_CDict creation, since its content is copied within CDict.

nLZ4F_freeCDict

public static void nLZ4F_freeCDict(long CDict)

LZ4F_freeCDict

public static void LZ4F_freeCDict(long CDict)

nLZ4F_compressFrame_usingCDict

public static long nLZ4F_compressFrame_usingCDict(long cctx,
 long dst,
 long dstCapacity,
 long src,
 long srcSize,
 long cdict,
 long preferencesPtr)

Unsafe version of: compressFrame_usingCDict

LZ4F_compressFrame_usingCDict

public static long LZ4F_compressFrame_usingCDict(long cctx,
 ByteBuffer dst,
 ByteBuffer src,
 long cdict,
 LZ4FPreferences preferencesPtr)

Compress an entire srcBuffer into a valid LZ4 frame using a digested Dictionary.

dst MUST be ≥ compressFrameBound(srcSize, preferencesPtr). If this condition is not respected, function will fail (return an errorCode).

Parameters:

cctx - must point to a context created by createCompressionContext.

cdict - if NULL, compress without a dictionary

preferencesPtr - optional: you may provide NULL as argument, but it's not recommended, as it's the only way to provide dictID in the frame header

Returns:

number of bytes written into dstBuffer or an error code if it fails (can be tested using isError)

nLZ4F_compressBegin_usingCDict

public static long nLZ4F_compressBegin_usingCDict(long cctx,
 long dstBuffer,
 long dstCapacity,
 long cdict,
 long prefsPtr)

Unsafe version of: compressBegin_usingCDict

Parameters:

dstCapacity - must be ≥ HEADER_SIZE_MAX bytes

LZ4F_compressBegin_usingCDict

public static long LZ4F_compressBegin_usingCDict(long cctx,
 ByteBuffer dstBuffer,
 long cdict,
 LZ4FPreferences prefsPtr)

Inits streaming dictionary compression, and writes the frame header into dstBuffer.

Parameters:

cdict - must outlive the compression session

prefsPtr - optional: you may provide NULL as argument, however, it's the only way to provide dictID in the frame header

Returns:

number of bytes written into dstBuffer for the header, or an error code (which can be tested using isError)

LZ4F_getBlockSize

public static long LZ4F_getBlockSize(int blockSizeID)

Return, in scalar format (size_t), the maximum block size associated with blockSizeID, or an error code (can be tested using isError) if blockSizeID is invalid.

nLZ4F_uncompressedUpdate

public static long nLZ4F_uncompressedUpdate(long cctx,
 long dstBuffer,
 long dstCapacity,
 long srcBuffer,
 long srcSize,
 long cOptPtr)

Unsafe version of: uncompressedUpdate

LZ4F_uncompressedUpdate

public static long LZ4F_uncompressedUpdate(long cctx,
 ByteBuffer dstBuffer,
 ByteBuffer srcBuffer,
 @Nullable LZ4FCompressOptions cOptPtr)

Can be called repetitively to add data stored as uncompressed blocks.

Important rule: dstCapacity MUST be large enough to store the entire source buffer as no compression is done for this operation. If this condition is not respected, LZ4F_uncompressedUpdate() will fail (result is an errorCode). After an error, the state is left in a UB state, and must be re-initialized or freed. If previously a compressed block was written, buffered data is flushed first before appending uncompressed data is continued. This operation is only supported when blockIndependent is used.

Parameters:

cOptPtr - optional : NULL can be provided, in which case all options are set to default

Returns:

number of bytes written into dstBuffer (it can be zero, meaning input data was just buffered), or an error code if it fails (which can be tested using isError)"

nLZ4F_createCompressionContext_advanced

public static long nLZ4F_createCompressionContext_advanced(long customMem,
 int version)

Unsafe version of: createCompressionContext_advanced

LZ4F_createCompressionContext_advanced

public static long LZ4F_createCompressionContext_advanced(LZ4FCustomMem customMem,
 int version)

createCompressionContext with custom allocation/free functions.

nLZ4F_createDecompressionContext_advanced

public static long nLZ4F_createDecompressionContext_advanced(long customMem,
 int version)

Unsafe version of: createDecompressionContext_advanced

LZ4F_createDecompressionContext_advanced

public static long LZ4F_createDecompressionContext_advanced(LZ4FCustomMem customMem,
 int version)

createDecompressionContext with custom allocation/free functions.

nLZ4F_createCDict_advanced

public static long nLZ4F_createCDict_advanced(long customMem,
 long dictBuffer,
 long dictSize)

Unsafe version of: createCDict_advanced

LZ4F_createCDict_advanced

public static long LZ4F_createCDict_advanced(LZ4FCustomMem customMem,
 ByteBuffer dictBuffer)

createCDict with custom allocation/free functions.