Data Structures
struct	_psx_image_frame
	A frame image data. More...

struct	_psx_image
	A image object. More...

struct	_psx_image_header
	Image reader header define. More...

struct	_psx_image_operator
	The image operator define. More...

Macros
#define	IMG_OBJ(image) IMG_OBJ_AT_INDEX(image, 0)
	Get first ps_image obj. More...

#define	IMG_DATA(image) IMG_DATA_AT_INDEX(image, 0)
	Get first image frame data. More...

#define	IMG_DATA_SIZE(image) IMG_DATA_SIZE_AT_INDEX(image, 0)
	Get first image frame data size. More...

#define	IMG_OBJ_AT_INDEX(image, idx) (image->frames[idx].img)
	Get ps_image obj at index. More...

#define	IMG_DATA_AT_INDEX(image, idx) (image->frames[idx].data)
	Get image frame data at index. More...

#define	IMG_DATA_SIZE_AT_INDEX(img, idx) (img->frames[idx].size)
	Get image frame data size at index. More...

#define	IMG_DURATION_AT_INDEX(img, idx) (img->frames[idx].duration)
	Get image frame duration at index. More...

Typedefs
typedef struct _psx_image_frame	psx_image_frame
	A frame image data.

typedef struct _psx_image	psx_image
	A image object.

typedef struct _psx_image_header	psx_image_header
	Image reader header define.

typedef struct _psx_image_operator	psx_image_operator
	The image operator define. More...

typedef enum _psx_priority_level	psx_priority_level
	Priority level for image_operator. More...

Enumerations
enum	{ S_OK = 0, S_BAD_PARAMS = 1, S_NOT_SUPPORT = 2, S_OUT_OF_MEMORY = 3, S_INIT_FAILURE = 4, S_FAILURE = 5 }
	Status code return by call APIs. More...

enum	_psx_priority_level { PRIORITY_EXTENTED = -1, PRIORITY_DEFAULT = 0, PRIORITY_MASTER = 1 }
	Priority level for image_operator. More...

Detailed Description

Macro Definition Documentation

◆ IMG_DATA

#define IMG_DATA ( image ) IMG_DATA_AT_INDEX(image, 0)

Get first image frame data.

See also: IMG_DATA_AT_INDEX

Definition at line 84 of file psx_image.h.

◆ IMG_DATA_AT_INDEX

#define IMG_DATA_AT_INDEX	(	image,
		idx
	)	(image->frames[idx].data)

Get image frame data at index.

See also: IMG_DATA

Definition at line 105 of file psx_image.h.

◆ IMG_DATA_SIZE

#define IMG_DATA_SIZE ( image ) IMG_DATA_SIZE_AT_INDEX(image, 0)

Get first image frame data size.

See also: IMG_DATA_SIZE_AT_INDEX

Definition at line 91 of file psx_image.h.

◆ IMG_DATA_SIZE_AT_INDEX

#define IMG_DATA_SIZE_AT_INDEX	(	img,
		idx
	)	(img->frames[idx].size)

Get image frame data size at index.

See also: IMG_DATA_SIZE

Definition at line 112 of file psx_image.h.

◆ IMG_DURATION_AT_INDEX

#define IMG_DURATION_AT_INDEX	(	img,
		idx
	)	(img->frames[idx].duration)

Get image frame duration at index.

See also: IMG_DATA_SIZE, IMG_DATA

Definition at line 119 of file psx_image.h.

◆ IMG_OBJ

#define IMG_OBJ ( image ) IMG_OBJ_AT_INDEX(image, 0)

Get first ps_image obj.

See also: IMG_OBJ_AT_INDEX

Definition at line 77 of file psx_image.h.

◆ IMG_OBJ_AT_INDEX

#define IMG_OBJ_AT_INDEX	(	image,
		idx
	)	(image->frames[idx].img)

Get ps_image obj at index.

See also: IMG_OBJ

Definition at line 98 of file psx_image.h.

Typedef Documentation

◆ psx_image_operator

typedef struct _psx_image_operator psx_image_operator

The image operator define.

See also: psx_image_register_operator psx_image_unregister_operator

◆ psx_priority_level

typedef enum _psx_priority_level psx_priority_level

Priority level for image_operator.

See also: psx_image_register_operator

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Status code return by call APIs.

Enumerator
S_OK	Successful no errors.
S_BAD_PARAMS	Invalid params input.
S_NOT_SUPPORT	Not support format or decoder module not found.
S_OUT_OF_MEMORY	Not enough memory.
S_INIT_FAILURE	Not initialize system.
S_FAILURE	Operation failed by internal errors.

Definition at line 124 of file psx_image.h.

◆ _psx_priority_level

enum _psx_priority_level