jpeg_encode_api_t Struct Reference

#include <r_jpeg_encode_api.h>

Data Fields
ssp_err_t(*	open )(jpeg_encode_ctrl_t *const p_ctrl, jpeg_encode_cfg_t const *const p_cfg)
ssp_err_t(*	imageParameterSet )(jpeg_encode_ctrl_t *const p_ctrl, jpeg_encode_raw_image_parameters *p_raw_image_parameters)
ssp_err_t(*	outputBufferSet )(jpeg_encode_ctrl_t *const p_ctrl, void *p_buffer)
ssp_err_t(*	inputBufferSet )(jpeg_encode_ctrl_t *const p_ctrl, void *p_buffer, uint32_t buffer_size)
ssp_err_t(*	statusGet )(jpeg_encode_ctrl_t *const p_ctrl, volatile jpeg_encode_status_t *p_status)
ssp_err_t(*	close )(jpeg_encode_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *p_version)

Detailed Description

JPEG functions implemented at the HAL layer will follow this API.

Field Documentation

close

ssp_err_t(* jpeg_encode_api_t::close) (jpeg_encode_ctrl_t *const p_ctrl)

Cancel an outstanding operation.

Implemented as

• R_JPEG_Encode_Close()

Precondition

the JPEG codec module must have been opened properly.

Parameters

[in]

p_ctrl

Control block set in jpeg_encode_api_t::Open call.

imageParameterSet

ssp_err_t(* jpeg_encode_api_t::imageParameterSet) (jpeg_encode_ctrl_t *const p_ctrl, jpeg_encode_raw_image_parameters *p_raw_image_parameters)

Set image parameters to JPEG Codec

Implemented as

• R_JPEG_Encode_ImageParameterSet()

Precondition

The JPEG codec module must have been opened properly.

Parameters

[in,out]	p_ctrl	Pointer to control block. Must be declared by user. Elements set here.
[in]	p_raw_image_parameters	Pointer to the RAW image parameters

inputBufferSet

ssp_err_t(* jpeg_encode_api_t::inputBufferSet) (jpeg_encode_ctrl_t *const p_ctrl, void *p_buffer, uint32_t buffer_size)

Assign input data buffer to JPEG codec.

Implemented as

• R_JPEG_Encode_InputBufferSet()

Precondition

the JPEG codec module must have been opened properly, output buffer and image parameter must be set prior to call this function.

Note

The buffer starting address must be 8-byte aligned.

Parameters

[in]	p_ctrl	Control block set in jpeg_encode_api_t::open call.
[in]	p_buffer	Pointer to the input buffer space
[in]	buffer_size	Size of the input buffer

open

ssp_err_t(* jpeg_encode_api_t::open) (jpeg_encode_ctrl_t *const p_ctrl, jpeg_encode_cfg_t const *const p_cfg)

Initial configuration

Implemented as

• R_JPEG_Encode_Open()

Precondition

none

Parameters

[in,out]	p_ctrl	Pointer to control block. Must be declared by user. Elements set here.
[in]	p_cfg	Pointer to configuration structure. All elements of this structure must be set by user.

outputBufferSet

ssp_err_t(* jpeg_encode_api_t::outputBufferSet) (jpeg_encode_ctrl_t *const p_ctrl, void *p_buffer)

Assign output buffer to JPEG codec for storing output data.

Implemented as

• R_JPEG_Encode_OutputBufferSet()

Precondition

The JPEG codec module must have been opened properly.

Note

The buffer starting address must be 8-byte aligned.

Parameters

[in]	p_ctrl	Control block set in jpeg_encode_api_t::open call.
[in]	p_buffer	Pointer to the output buffer space

statusGet

ssp_err_t(* jpeg_encode_api_t::statusGet) (jpeg_encode_ctrl_t *const p_ctrl, volatile jpeg_encode_status_t *p_status)

Retrieve current status of the JPEG codec module.

Implemented as

• R_JPEG_Encode_StatusGet()

Precondition

the JPEG codec module must have been opened properly.

Parameters

[in]	p_ctrl	Control block set in jpeg_encode_api_t::open call.
[out]	p_status	JPEG module status

versionGet

ssp_err_t(* jpeg_encode_api_t::versionGet) (ssp_version_t *p_version)

Get version and store it in provided pointer p_version.

Implemented as

• R_JPEG_Encode_VersionGet()

Parameters

[out]

p_version

Code and API version used.

---

The documentation for this struct was generated from the following file:

• r_jpeg_encode_api.h