Intel® Integrated Performance Primitives Developer Guide and Reference

ID 790148
Date 11/07/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

EncodeLZ4Safe

Performs LZ4 encoding.

Syntax

IppStatus ippsEncodeLZ4Safe_8u(const Ipp8u* pSrc, int* srcLen, Ipp8u* pDst, int* pDstLen, Ipp8u* pHashTable);

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.

srcLen

Length of the source data for compression.

pDst

Pointer to the compressed data.

pDstLen

Pointer to the length of the destination buffer and the length of the compressed data.

pHashTable

Pointer to the LZ4 hash table.

Description

This function performs encoding of the source data pSrc using the LZ4 algorithm. The length of the compressed data is set to pDstLen. The length of the processed source data is set to pSrcLen

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

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

ippStsSizeErr

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

ippStsDstSizeLessExpectedErr

Indicates an error if the destination buffer has insufficient length.