JPEG Encode Interface

Interface for JPEG encode functions. More...

Data Structures
struct	jpeg_encode_raw_image_parameters
struct	jpeg_encode_callback_args_t
struct	jpeg_encode_cfg_t
struct	jpeg_encode_api_t
struct	jpeg_encode_instance_t

Macros
#define	JPEG_ENCODE_API_VERSION_MAJOR   (2U)

Typedefs
typedef void	jpeg_encode_ctrl_t

Enumerations
enum	jpeg_encode_data_format_t {   JPEG_ENCODE_DATA_FORMAT_NORMAL = 0, JPEG_ENCODE_DATA_FORMAT_BYTE_SWAP, JPEG_ENCODE_DATA_FORMAT_WORD_SWAP, JPEG_ENCODE_DATA_FORMAT_WORD_BYTE_SWAP,   JPEG_ENCODE_DATA_FORMAT_LONGWORD_SWAP, JPEG_ENCODE_DATA_FORMAT_LONGWORD_BYTE_SWAP, JPEG_ENCODE_DATA_FORMAT_LONGWORD_WORD_SWAP, JPEG_ENCODE_DATA_FORMAT_LONGWORD_WORD_BYTE_SWAP,   JPEG_ENCODE_DATA_FORMAT_MAX }
enum	jpeg_encode_status_t {   JPEG_ENCODE_STATUS_FREE = 0x0, JPEG_ENCODE_STATUS_IDLE = 0x1, JPEG_ENCODE_STATUS_RUNNING = 0x2, JPEG_ENCODE_STATUS_DONE = 0x4,   JPEG_ENCODE_STATUS_INPUT_PAUSE = 0x8 }
enum	jpeg_encode_count_t { JPEG_ENCODE_COUNT_DISABLE = 0, JPEG_ENCODE_COUNT_ENABLE }
enum	jpeg_encode_resume_mode_t { JPEG_ENCODE_COUNT_MODE_ADDRESS_CONTINUE = 0, JPEG_ENCODE_COUNT_MODE_ADDRESS_REINITIALIZE }

Detailed Description

Interface for JPEG encode functions.

Summary

The JPEG ENCODE interface provides JPEG encoder functionality. It allows application to convert a JPEG image into bitmap data suitable for display frame buffer.

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

JPEG ENCODE Interface description: JPEG Encode Driver

Macro Definition Documentation

JPEG_ENCODE_API_VERSION_MAJOR

#define JPEG_ENCODE_API_VERSION_MAJOR   (2U)

Register definitions, common services and error codes.

Typedef Documentation

jpeg_encode_ctrl_t

typedef void jpeg_encode_ctrl_t

JPEG encode control block. Allocate an instance specific control block to pass into the JPEG encode API calls.

Implemented as

• jpeg_encode_instance_ctrl_t

Enumeration Type Documentation

jpeg_encode_count_t

enum jpeg_encode_count_t

Data type for encoding count mode enable.

Enumerator
JPEG_ENCODE_COUNT_DISABLE	Count mode disable.
JPEG_ENCODE_COUNT_ENABLE	Count mode enable.

jpeg_encode_data_format_t

enum jpeg_encode_data_format_t

Multi-byte Data Format

Enumerator
JPEG_ENCODE_DATA_FORMAT_NORMAL	(1)(2)(3)(4)(5)(6)(7)(8) Normal byte order
JPEG_ENCODE_DATA_FORMAT_BYTE_SWAP	(2)(1)(4)(3)(6)(5)(8)(7) Byte Swap
JPEG_ENCODE_DATA_FORMAT_WORD_SWAP	(3)(4)(1)(2)(7)(8)(5)(6) Word Swap
JPEG_ENCODE_DATA_FORMAT_WORD_BYTE_SWAP	(4)(3)(2)(1)(8)(7)(6)(5) Word-Byte Swap
JPEG_ENCODE_DATA_FORMAT_LONGWORD_SWAP	(5)(6)(7)(8)(1)(2)(3)(4) Longword Swap
JPEG_ENCODE_DATA_FORMAT_LONGWORD_BYTE_SWAP	(6)(5)(8)(7)(2)(1)(4)(3) Longword Byte Swap
JPEG_ENCODE_DATA_FORMAT_LONGWORD_WORD_SWAP	(7)(8)(5)(6)(3)(4)(1)(2) Longword Word Swap
JPEG_ENCODE_DATA_FORMAT_LONGWORD_WORD_BYTE_SWAP	(8)(7)(6)(5)(4)(3)(2)(1) Longword Word Byte Swap
JPEG_ENCODE_DATA_FORMAT_MAX	Maximum value of data format.

jpeg_encode_resume_mode_t

enum jpeg_encode_resume_mode_t

Data type for encoding resume mode

Enumerator
JPEG_ENCODE_COUNT_MODE_ADDRESS_CONTINUE	The data buffer address will not be initialized when resuming image data lines.
JPEG_ENCODE_COUNT_MODE_ADDRESS_REINITIALIZE	The data buffer address will be initialized when resuming image data lines.

jpeg_encode_status_t

enum jpeg_encode_status_t

JPEG HLD driver internal status information. The driver can simultaneously be in more than any one status at the same time. Parse the status bit-fields using the definitions in this enum to determine driver status

Enumerator
JPEG_ENCODE_STATUS_FREE	JPEG codec module is not yet open.
JPEG_ENCODE_STATUS_IDLE	JPEG Codec module is open, and is not operational.
JPEG_ENCODE_STATUS_RUNNING	JPEG Codec is running.
JPEG_ENCODE_STATUS_DONE	JPEG Codec has successfully finished the operation.
JPEG_ENCODE_STATUS_INPUT_PAUSE	JPEG Codec paused waiting for more input data.