DecodeCBProgrGetCurBitPlane

Returns the number of the current bit plane.

Syntax

IppStatus ippiDecodeCBProgrGetCurBitPlaneNum_JPEG2K(IppiDecodeCBProgrState_JPEG2K* pState, int* pBitPlaneNum);

Parameters

pState	Pointer to the decode state structure.
pBitPlaneNum	Pointer to the variable containing current bit plane number.

Description

The function ippiDecodeCBProgrGetCurBitPlane_JPEG2K is declared in the ippj.h file. This function returns the current bit plane number. Initially the bit plane counter is set to (sfBits - 1) value (see the function ippiDecodeCBProgrAttach_JPEG2K). During successful decoding step, the bit plane counter is decremented by one or some other number depending on coding options.

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error if pState pointer is `NULL`.
ippStsContextMatchErr	Indicates an error condition if a pointer to the invalid structure is passed.