EncodeGetRate

Returns estimated bit rate for the specified coding pass.

Syntax

IppStatus ippiEncodeGetRate_JPEG2K(IppiEncodeState_JPEG2K* pState, int passNumber, int* pRate);

Parameters

pState	Pointer to the allocated and initialized encoder state structure.
passNumber	Number of the specified coding pass.
pRate	Pointer to the variable that returns the estimated rate for the specified coding pass.

Description

The function ippiEncodeGetRate_JPEG2K is declared in the ippj.h file. This function returns the estimated target bit rate pRate for the coding pass of a given number passNumber. The estimated bit rate is computed during the encoding procedure and then stored in the pState state structure. Therefore it is available only after completing both encoding procedures.

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error when any of the specified pointers is `NULL`.
ippStsContextMatchErr	Indicates an error condition if a pointer to an invalid state structure is passed.
ippStsJPEG2KBadPassNumber	Indicates an error condition if passNumber exceeds the allowed boundaries.