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

DeflateLZ77Fastest

Performs LZ77 encoding according to the fastest algorithm.

Syntax

IppStatus ippsDeflateLZ77Fastest_8u(const Ipp8u** ppSrc, Ipp32u* pSrcLen, Ipp32u* pSrcIdx, const Ipp8u* pWindow, Ipp32u winSize, Ipp32s* pHashHead, Ipp32u hashSize, Ipp16u* pCode, Ipp32u* pCodeLenBits, Ipp8u* pDst, Ipp32u dstLen, Ipp32u* pDstIdx, IppDeflateHuffCode pLitHuffCodes[286], IppDeflateHuffCode pDistHuffCodes[30], IppLZ77Flush flush);

Include Files

ippdc.h

Domain Dependencies

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

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

Parameters

ppSrc

Double pointer to the source vector.

pSrcLen

Pointer to the length of the source vector.

pSrcIdx

Pointer to the index of the current position in the source vector.

pWindow

Pointer to the sliding window (the dictionary for the LZ77 algorithm).

winSize

Size of the sliding window and the pHashPrev table.

pHashHead

Pointer to the table containing heads of the hash chains.

hashSize

Size of the pHashHead table.

pCode

Pointer to the bit buffer.

pCodeLenBits

Pointer to the number of valid bits in the bit buffer.

pDst

Pointer to the destination vector.

dstLen

Lenght of the destination vector.

pDstIdx

Pointer to the index in the destination vector.

pLitHuffCodes

Pointer to the literals/lengths Huffman codes.

pDistHuffCodes

Pointer to the distances Huffman codes.

flush

Specifies the encoding mode for data blocks (see flush parameter).

Description

This function performs LZ77 encoding of the ppSrc data according to the fastest algorithm.

To correctly process the first bytes of the source vector, initialize the pHashHead table with the winSize value.

The pSrcIdx parameter returns the index of the current position in the source vector, and is used to establish a correlation between the current position in the source vector and indexes in hash tables. After processing each 2GB of source data, the index and hash tables must be normalized (instead of 64K of source data in ZLIB).

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

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

ippStsSizeErr

Indicates an error if winSize is less than 256, or more than 32768; or hashSize is less than 256, or more than 65536.