DecodeCBProgrSetPassCounter

Sets the value of internal coding pass counter.

Syntax

IppStatus ippiDecodeCBProgrSetPassCounter_JPEG2K(int nOfPasses, IppiDecodeCBProgrState_JPEG2K* pState);

Parameters

nOfPasses	Number of coding passes.
pState	Pointer to the decode state structure.

Description

The function ippiDecodeCBProgrSetPassCounter_JPEG2K is declared in the ippj.h file. This function sets the value of internal coding pass counter.

The single coding pass is “sub-atom” for coding progression, but their counts in a single terminated segment (for example, the segment filled to the byte boundary) is available from the JPEG 2000 stream or file. During decoding step, pass counter is decremented by one or some other number depending on coding options. If pass counter is set to zero, decoding process will be blocked internally. Externally the pass counter value can be obtained by calling ippiDecodeCBProgrGetPassCounter_JPEG2K function.

The coding pass counter value can be set before any progression step as well as before series of steps.

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.