Synergy Software Package User's Manual

Interface for JPEG decode functions. More...

Data Structures

struct  jpeg_decode_callback_args_t
 
struct  jpeg_decode_cfg_t
 
struct  jpeg_decode_api_t
 
struct  jpeg_decode_instance_t
 

Macros

#define JPEG_DECODE_API_VERSION_MAJOR   (2U)
 

Typedefs

typedef void jpeg_decode_ctrl_t
 

Enumerations

enum  jpeg_decode_color_space_t { JPEG_DECODE_COLOR_SPACE_YCBCR444 = 0, JPEG_DECODE_COLOR_SPACE_YCBCR422 = 1, JPEG_DECODE_COLOR_SPACE_YCBCR420 = 2, JPEG_DECODE_COLOR_SPACE_YCBCR411 = 6 }
 
enum  jpeg_decode_data_format_t {
  JPEG_DECODE_DATA_FORMAT_NORMAL = 0, JPEG_DECODE_DATA_FORMAT_BYTE_SWAP, JPEG_DECODE_DATA_FORMAT_WORD_SWAP, JPEG_DECODE_DATA_FORMAT_WORD_BYTE_SWAP,
  JPEG_DECODE_DATA_FORMAT_LONGWORD_SWAP, JPEG_DECODE_DATA_FORMAT_LONGWORD_BYTE_SWAP, JPEG_DECODE_DATA_FORMAT_LONGWORD_WORD_SWAP, JPEG_DECODE_DATA_FORMAT_LONGWORD_WORD_BYTE_SWAP
}
 
enum  jpeg_decode_pixel_format_t { JPEG_DECODE_PIXEL_FORMAT_ARGB8888 = 1, JPEG_DECODE_PIXEL_FORMAT_RGB565 }
 
enum  jpeg_decode_status_t {
  JPEG_DECODE_STATUS_FREE = 0x0, JPEG_DECODE_STATUS_IDLE = 0x1, JPEG_DECODE_STATUS_RUNNING = 0x2, JPEG_DECODE_STATUS_DONE = 0x4,
  JPEG_DECODE_STATUS_INPUT_PAUSE = 0x8, JPEG_DECODE_STATUS_OUTPUT_PAUSE = 0x10, JPEG_DECODE_STATUS_IMAGE_SIZE_READY = 0x20, JPEG_DECODE_STATUS_ERROR = 0x40,
  JPEG_DECODE_STATUS_HEADER_PROCESSING = 0x80
}
 
enum  jpeg_decode_subsample_t { JPEG_DECODE_OUTPUT_NO_SUBSAMPLE = 0, JPEG_DECODE_OUTPUT_SUBSAMPLE_HALF, JPEG_DECODE_OUTPUT_SUBSAMPLE_ONE_QUARTER, JPEG_DECODE_OUTPUT_SUBSAMPLE_ONE_EIGHTH }
 
enum  jpeg_decode_count_enable_t { JPEG_DECODE_COUNT_DISABLE = 0, JPEG_DECODE_COUNT_ENABLE }
 
enum  jpeg_decode_resume_mode_t { JPEG_DECODE_COUNT_MODE_ADDRESS_CONTINUE = 0, JPEG_DECODE_COUNT_MODE_ADDRESS_REINITIALIZE }
 

Detailed Description

Interface for JPEG decode functions.

Summary

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

Related SSP architecture topics:

JPEG DECODE Interface description: JPEG Decode Driver

Macro Definition Documentation

◆ JPEG_DECODE_API_VERSION_MAJOR

#define JPEG_DECODE_API_VERSION_MAJOR   (2U)

Register definitions, common services and error codes. Configuration for this module

Typedef Documentation

◆ jpeg_decode_ctrl_t

typedef void jpeg_decode_ctrl_t

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

Implemented as

Enumeration Type Documentation

◆ jpeg_decode_color_space_t

Image color space definitions

Enumerator
JPEG_DECODE_COLOR_SPACE_YCBCR444 

Color Space YCbCr 444.

JPEG_DECODE_COLOR_SPACE_YCBCR422 

Color Space YCbCr 422.

JPEG_DECODE_COLOR_SPACE_YCBCR420 

Color Space YCbCr 420.

JPEG_DECODE_COLOR_SPACE_YCBCR411 

Color Space YCbCr 411.

◆ jpeg_decode_count_enable_t

Data type for decoding count mode enable.

Enumerator
JPEG_DECODE_COUNT_DISABLE 

Count mode disable.

JPEG_DECODE_COUNT_ENABLE 

Count mode enable.

◆ jpeg_decode_data_format_t

Multi-byte Data Format

Enumerator
JPEG_DECODE_DATA_FORMAT_NORMAL 

(1)(2)(3)(4)(5)(6)(7)(8) Normal byte order

JPEG_DECODE_DATA_FORMAT_BYTE_SWAP 

(2)(1)(4)(3)(6)(5)(8)(7) Byte Swap

JPEG_DECODE_DATA_FORMAT_WORD_SWAP 

(3)(4)(1)(2)(7)(8)(5)(6) Word Swap

JPEG_DECODE_DATA_FORMAT_WORD_BYTE_SWAP 

(4)(3)(2)(1)(8)(7)(6)(5) Word-Byte Swap

JPEG_DECODE_DATA_FORMAT_LONGWORD_SWAP 

(5)(6)(7)(8)(1)(2)(3)(4) Longword Swap

JPEG_DECODE_DATA_FORMAT_LONGWORD_BYTE_SWAP 

(6)(5)(8)(7)(2)(1)(4)(3) Longword Byte Swap

JPEG_DECODE_DATA_FORMAT_LONGWORD_WORD_SWAP 

(7)(8)(5)(6)(3)(4)(1)(2) Longword Word Swap

JPEG_DECODE_DATA_FORMAT_LONGWORD_WORD_BYTE_SWAP 

(8)(7)(6)(5)(4)(3)(2)(1) Longword Word Byte Swap

◆ jpeg_decode_pixel_format_t

Pixel Data Format

Enumerator
JPEG_DECODE_PIXEL_FORMAT_ARGB8888 

Pixel Data ARGB8888 format.

JPEG_DECODE_PIXEL_FORMAT_RGB565 

Pixel Data RGB565 format.

◆ jpeg_decode_resume_mode_t

Data type for decoding count mode enable.

Enumerator
JPEG_DECODE_COUNT_MODE_ADDRESS_CONTINUE 

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

JPEG_DECODE_COUNT_MODE_ADDRESS_REINITIALIZE 

The data buffer address will be initialized when resuming image data lines.

◆ jpeg_decode_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_DECODE_STATUS_FREE 

JPEG codec module is not yet open.

JPEG_DECODE_STATUS_IDLE 

JPEG Codec module is open, and is not operational.

JPEG_DECODE_STATUS_RUNNING 

JPEG Codec is running.

JPEG_DECODE_STATUS_DONE 

JPEG Codec has successfully finished the operation.

JPEG_DECODE_STATUS_INPUT_PAUSE 

JPEG Codec paused waiting for more input data.

JPEG_DECODE_STATUS_OUTPUT_PAUSE 

JPEG Codec paused after decoded the number of lines specified by user.

JPEG_DECODE_STATUS_IMAGE_SIZE_READY 

JPEG decoding operation obtained image size, and paused.

JPEG_DECODE_STATUS_ERROR 

JPEG Codec module encountered an error.

JPEG_DECODE_STATUS_HEADER_PROCESSING 

JPEG Codec module is reading the JPEG header information.

◆ jpeg_decode_subsample_t

Data type for horizontal and vertical subsample settings. This setting applies only to the decoding operation.

Enumerator
JPEG_DECODE_OUTPUT_NO_SUBSAMPLE 

No subsample. The image is decoded with no reduction in size.

JPEG_DECODE_OUTPUT_SUBSAMPLE_HALF 

The output image size is reduced by half.

JPEG_DECODE_OUTPUT_SUBSAMPLE_ONE_QUARTER 

The output image size is reduced to one-quarter.

JPEG_DECODE_OUTPUT_SUBSAMPLE_ONE_EIGHTH 

The output image size is reduced to one-eighth.