Project Name  Version 1.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Structures | Typedefs | Functions
Encoder Interface

Defines the API for the JPEG-HDR mobile encoder library. More...

Data Structures

struct  jh_encoder_params_ts
 Defines the JPEG-HDR mobile encoder parameters. More...

Typedefs

typedef struct jh_encoder_params_ts jh_encoder_params_t
 Defines the JPEG-HDR mobile encoder parameters.

Functions

int jh_encode (const jh_encoder_params_t *encoder_params, jh_monitor_t *monitor, jh_image_t *hdri, jh_image_t *sdri, jh_stream_t *stream, jh_error_t *error)
 Encodes the HDR data into JPEG-HDR.
int jh_enc_memory_estimate (const size_t pixels, const jh_encoder_params_t *encoder_params, int *mem, jh_error_t *error)
 Provides the memory requirements estimate for the encoder and tonemapper.
const char * jh_encoder_version ()
 Returns the encoder library version in a formatted string of major.minor.build.
int jh_encoder_set_default (jh_encoder_params_t *params, jh_error_t *error)
 Sets the default value of the encoder parameters.

Detailed Description

Defines the API for the JPEG-HDR mobile encoder library.

Function Documentation

int jh_enc_memory_estimate ( const size_t  pixels,
const jh_encoder_params_t encoder_params,
int *  mem,
jh_error_t error 
)

Provides the memory requirements estimate for the encoder and tonemapper.

Returns
0 if the function does not succeed.
Parameters
[in]pixelsImage size, in pixels.
[in]encoder_paramsEncoder parameters. Can be NULL to exclude encoder memory.
[in,out]memUser-allocated variable that returns the amount of required memory, in bytes.
[in,out]errorUser-allocated error-reporting structure that contains information about the error.
int jh_encode ( const jh_encoder_params_t encoder_params,
jh_monitor_t monitor,
jh_image_t hdri,
jh_image_t sdri,
jh_stream_t stream,
jh_error_t error 
)

Encodes the HDR data into JPEG-HDR.

Returns
0 if the function does not succeed.
Parameters
[in]encoder_paramsEncoder parameters.
[in]monitorProgress status of the function. The initial value of jh_monitor_ts cancel field must be 0.
[in]hdriInput HDR image. If specified, the memory can be reused during encoding.
[in]sdriInput tone-mapped SDRI image.
[out]streamOutput data stream.
[in,out]errorUser-allocated error-reporting structure that contains information about the error.
int jh_encoder_set_default ( jh_encoder_params_t params,
jh_error_t error 
)

Sets the default value of the encoder parameters.

Returns
0 if the function does not succeed.
Parameters
[out]paramsUser-allocated encoder parameters.
[in,out]errorUser-allocated error-reporting structure that contains information about the error.
const char* jh_encoder_version ( )

Returns the encoder library version in a formatted string of major.minor.build.

Returns
The library version in a null-terminated character string.