jpeg_decode_api_t Struct Reference

#include <r_jpeg_decode_api.h>

Data Fields
ssp_err_t(*	open )(jpeg_decode_ctrl_t *const p_ctrl, jpeg_decode_cfg_t const *const p_cfg)
ssp_err_t(*	outputBufferSet )(jpeg_decode_ctrl_t *const p_ctrl, void *p_buffer, uint32_t buffer_size)
ssp_err_t(*	horizontalStrideSet )(jpeg_decode_ctrl_t *const p_ctrl, uint32_t horizontal_stride)
ssp_err_t(*	imageSubsampleSet )(jpeg_decode_ctrl_t *const p_ctrl, jpeg_decode_subsample_t horizontal_subsample, jpeg_decode_subsample_t vertical_subsample)
ssp_err_t(*	inputBufferSet )(jpeg_decode_ctrl_t *const p_ctrl, void *p_buffer, uint32_t buffer_size)
ssp_err_t(*	linesDecodedGet )(jpeg_decode_ctrl_t *const p_ctrl, uint32_t *const p_lines)
ssp_err_t(*	imageSizeGet )(jpeg_decode_ctrl_t *const p_ctrl, uint16_t *p_horizontal_size, uint16_t *p_vertical_size)
ssp_err_t(*	statusGet )(jpeg_decode_ctrl_t *const p_ctrl, jpeg_decode_status_t *const p_status)
ssp_err_t(*	close )(jpeg_decode_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *p_version)
ssp_err_t(*	pixelFormatGet )(jpeg_decode_ctrl_t *const p_ctrl, jpeg_decode_color_space_t *const p_color_space)

Detailed Description

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

Field Documentation

close

ssp_err_t(* jpeg_decode_api_t::close) (jpeg_decode_ctrl_t *const p_ctrl)

Cancel an outstanding operation.

Implemented as

• R_JPEG_Decode_Close()

Precondition

the JPEG codec module must have been opened properly.

Note

If the encoding or the decoding operation is finished without errors, the HLD driver automatically closes the device. In this case, application does not need to explicitly close the JPEG device.

Parameters

[in]

p_ctrl

Control block set in jpeg_decode_api_t::Open call.

horizontalStrideSet

ssp_err_t(* jpeg_decode_api_t::horizontalStrideSet) (jpeg_decode_ctrl_t *const p_ctrl, uint32_t horizontal_stride)

Configure the horizontal stride value.

Implemented as

• R_JPEG_Decode_HorizontalStrideSet()

Precondition

The JPEG codec module must have been opened properly.

Parameters

[in]	p_ctrl	Control block set in jpeg_decode_api_t::open call.
[in]	horizontal_stride	Horizontal stride value to be used for the decoded image data.
[in]	buffer_size	Size of the output buffer

imageSizeGet

ssp_err_t(* jpeg_decode_api_t::imageSizeGet) (jpeg_decode_ctrl_t *const p_ctrl, uint16_t *p_horizontal_size, uint16_t *p_vertical_size)

Retrieve image size during decoding operation.

Implemented as

• R_JPEG_Decode_ImageSizeGet()

Precondition

the JPEG codec module must have been opened properly.

Note

If the encoding or the decoding operation is finished without errors, the HLD driver automatically closes the device. In this case, application does not need to explicitly close the JPEG device.

Parameters

[in]	p_ctrl	Control block set in jpeg_decode_api_t::open call.
[out]	p_horizontal_size	Image horizontal size, in number of pixels.
[out]	p_vertical_size	Image vertical size, in number of pixels.

imageSubsampleSet

ssp_err_t(* jpeg_decode_api_t::imageSubsampleSet) (jpeg_decode_ctrl_t *const p_ctrl, jpeg_decode_subsample_t horizontal_subsample, jpeg_decode_subsample_t vertical_subsample)

Configure the horizontal and vertical subsample settings.

Implemented as

• R_JPEG_Decode_ImageSubsampleSet()

Precondition

The JPEG codec module must have been opened properly.

Parameters

[in]	p_ctrl	Control block set in jpeg_decode_api_t::open call.
[in]	horizontal_subsample	Horizontal subsample value
[in]	vertical_subsample	Vertical subsample value

inputBufferSet

ssp_err_t(* jpeg_decode_api_t::inputBufferSet) (jpeg_decode_ctrl_t *const p_ctrl, void *p_buffer, uint32_t buffer_size)

Assign input data buffer to JPEG codec.

Implemented as

• R_JPEG_Decode_InputBufferSet()

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_decode_api_t::open call.
[in]	p_buffer	Pointer to the input buffer space
[in]	buffer_size	Size of the input buffer

linesDecodedGet

ssp_err_t(* jpeg_decode_api_t::linesDecodedGet) (jpeg_decode_ctrl_t *const p_ctrl, uint32_t *const p_lines)

Return the number of lines decoded into the output buffer.

Implemented as

• R_JPEG_Decode_LinesDecodedGet()

Precondition

the JPEG codec module must have been opened properly.

Parameters

[in]	p_ctrl	Control block set in jpeg_decode_api_t::open call.
[out]	p_lines	Number of lines decoded

open

ssp_err_t(* jpeg_decode_api_t::open) (jpeg_decode_ctrl_t *const p_ctrl, jpeg_decode_cfg_t const *const p_cfg)

Initial configuration

Implemented as

• R_JPEG_Decode_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_decode_api_t::outputBufferSet) (jpeg_decode_ctrl_t *const p_ctrl, void *p_buffer, uint32_t buffer_size)

Assign output buffer to JPEG codec for storing output data.

Implemented as

• R_JPEG_Decode_OutputBufferSet()

Precondition

The JPEG codec module must have been opened properly.

Note

The buffer starting address must be 8-byte aligned. For the decoding process, the HLD driver automatically computes the number of lines of the image to decoded so the output data fits into the given space. If the supplied output buffer is not able to hold the entire frame, the application should call the Output Full Callback function so it can be notified when additional buffer space is needed.

Parameters

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

pixelFormatGet

ssp_err_t(* jpeg_decode_api_t::pixelFormatGet) (jpeg_decode_ctrl_t *const p_ctrl, jpeg_decode_color_space_t *const p_color_space)

Get the input pixel format.

Implemented as

• R_JPEG_Decode_PixelFormatGet()

Precondition

the JPEG codec module must have been opened properly.

Parameters

[in]	p_ctrl	Control block set in jpeg_decode_api_t::open call.
[out]	p_color_space	JPEG input format.

statusGet

ssp_err_t(* jpeg_decode_api_t::statusGet) (jpeg_decode_ctrl_t *const p_ctrl, jpeg_decode_status_t *const p_status)

Retrieve current status of the JPEG codec module.

Implemented as

• R_JPEG_Decode_StatusGet()

Precondition

the JPEG codec module must have been opened properly.

Parameters

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

versionGet

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

Get version and store it in provided pointer p_version.

Implemented as

• R_JPEG_Decode_VersionGet()

Parameters

[out]

p_version

Code and API version used.

---

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

• r_jpeg_decode_api.h