VLCDecodeUTupleInit

Initializes the VLCDecodeUTuple structure.

Syntax

IppStatus ippsVLCDecodeUTupleInit_32s(const IppsVLCTable_32s* pInputTable, int inputTableSize, Ipp32s* pSubTablesSizes, int numSubTables, int numElements, int numValueBit, IppsVLCDecodeUTupleSpec_32s* pVLCSpec);

Parameters

pInputTable	Pointer to the input VLC table.
inputTableSize	Size of the input VLC table.
pSubTablesSizes	Pointer to the sizes of the subtables.
numSubTables	Number of the subtables.
numElements	Number of the elements in the tuple.
numValueBit	Size of one element in bits.
pVLCSpec	Pointer to the VLC decoder specification structure.

Description

The function ippsVLCDecodeUTupleInit is declared in the ippdc.h file. This function initializes the VLC decoder structure with U-tuple pVLCSpec that is specified by the following parameters: the VLC table pInputTable of size inputTableSize, the number of internal subtables numSubTables and their sizes pSubTablesSizes, number of elements in tuple numElements, and size of one element numValueBit.

Size values for the subtables must be greater than 0. The sum of these values must be greater than or preferably equal to the maximum code length in the VLC table.

The VLC decoder specification structure is used by the functions ippsVLCDecodeUTupleBlock and ippsVLCDecodeUTupleOne.

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error if one of the specified pointers is NULL.
ippStsVLCUsrTblCodeLengthErr	Indicates an error if the maximum code length in the input table exceeds 32; or if any size value for the subtables in pSubTablesSizes is less than 0; or if the sum of these values is less than the maximum code length in the input table.