Developer Reference for Intel® Integrated Performance Primitives 2019

EncodeLZ4HC

Performs LZ4 encoding in HC mode.

Syntax

IppStatus ippsEncodeLZ4HC_8u(const Ipp8u* pSrc, int srcIdx, int* pSrcLen, Ipp8u* pDst, int* pDstLen, Ipp8u** ppHashTables, const Ipp8u* pDict, int dictLen, int level);

Include Files

ippdc.h

Domain Dependencies

Headers: ippcore.h, ippvm.h, ipps.h

Libraries: ippcore.lib, ippvm.lib, ipps.lib

Parameters

pSrc

Pointer to the source data.

srcIdx

Index of the starting byte in the source vector.

pSrcLen

Pointer to the length of the source data for compression.

pDst

Pointer to the compressed data.

pDstLen

Pointer to the length of the compressed data.

ppHashTables

Pointer to an array of pointers to the LZ4 hash tables for HC mode; ppHashTables[0] = pHashTable, ppHashTables[1]=pPrevTable .

pDict

Pointer to the dictionary.

dictLen

Length to the dictionary.

level

Compression level.

Description

This function performs encoding of the source data pSrc using the LZ4 algorithm. The destination buffer must have sufficient length for the operation. The length of the compressed data is set to pDstLen.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

Indicates an error if at least one of the specified pointers is NULL.

ippStsSizeErr

Indicates an error if the srcLen value is less than, or equal to zero.

ippStsBadArgErr

Indicates an error if the index of the starting byte is less than zero.

ippStsNotSupportedModeErr

Indicates an error if the function does not support the specified combination of parameters' values.

Example

LZ4HC.c