mpi_osd.h File Reference

MPI for OSD (On-Screen Display) More...

#include "mpi_index.h"
#include <time.h>

Data Structures
struct	MPI_OSD_POLYGON_ATTR_S
	Structure for the attribute of OSD polygon. More...
struct	MPI_OSD_LINE_ATTR_S
	Structure for the attribute of OSD line. More...
struct	MPI_OSD_BIND_ATTR_S
	Structure for the attribute of OSD bind. More...
struct	MPI_OSD_CANVAS_ATTR_S
	Structure for the attribute of canvas information. More...
struct	MPI_OSD_RGN_ATTR_S
	Structure for the attribute of OSD region. More...

Macros
#define	MPI_OSD_MAX_HANDLE   (128)
#define	MPI_OSD_MAX_BIND_CHANNEL   (4)
#define	MPI_OSD_MAX_U1_POLYGON_BIND_CHANNEL   (8)
#define	MPI_OSD_MAX_TOTAL_BIND_CHANNEL   (MPI_OSD_MAX_BIND_CHANNEL + MPI_OSD_MAX_U1_POLYGON_BIND_CHANNEL)
#define	MPI_OSD_MODE2_MAX_L10_BIND_CHANNEL   (8)
#define	MPI_OSD_MODE2_MAX_L30_BIND_CHANNEL   (16)
#define	MPI_OSD_MODE2_MAX_L50_BIND_CHANNEL   (8)
#define	MPI_OSD_MODE2_MAX_TOTAL_BIND_CHANNEL
#define	MPI_OSD_MAX_POLYGON_POINT_NUM   (32)
#define	MPI_OSD_MAX_LINE_POINT_NUM   (2)
#define	MPI_OSD_MAX_WIDTH   (8192)
#define	MPI_OSD_MAX_HEIGHT   (8192)
#define	MPI_OSD_QP_OFFSET_MAX   (51)
#define	MPI_OSD_QP_OFFSET_MIN   (-51)
#define	MPI_OSD_THICKNESS_MIN   (2)
#define	MPI_OSD_THICKNESS_MAX   (8)

Typedefs
typedef INT32	OSD_HANDLE
	a typedef for OSD handle.
typedef INT32	OSD_MODULE
	a typedef for OSD bind module.

Enumerations
enum	MPI_OSD_COLOR_FORMAT_E { MPI_OSD_COLOR_FORMAT_AYUV_3544 = 0, MPI_OSD_COLOR_FORMAT_PALETTE_16, MPI_OSD_COLOR_FORMAT_PALETTE_8, MPI_OSD_COLOR_FORMAT_NUM }
	OSD color format. More...
enum	MPI_OSD_OVERLAY_E {   MPI_OSD_OVERLAY_POLYGON = 0, MPI_OSD_OVERLAY_LINE, MPI_OSD_OVERLAY_BITMAP, MPI_OSD_OVERLAY_BITMAP_BYPASS,   MPI_OSD_OVERLAY_U1_POLYGON, MPI_OSD_OVERLAY_L10_BITMAP, MPI_OSD_OVERLAY_L40_BITMAP, MPI_OSD_OVERLAY_NUM,   MPI_OSD_OVERLAY_L50_POLYGON = MPI_OSD_OVERLAY_U1_POLYGON, MPI_OSD_OVERLAY_L30_POLYGON = MPI_OSD_OVERLAY_POLYGON, MPI_OSD_OVERLAY_L30_LINE = MPI_OSD_OVERLAY_LINE, MPI_OSD_OVERLAY_L30_BITMAP = MPI_OSD_OVERLAY_BITMAP }
	OSD overlay type. More...

Functions
INT32	MPI_createOsdRgn (OSD_HANDLE *handle, const MPI_OSD_RGN_ATTR_S *p_osd_attr)
	Create an OSD region. More...
INT32	MPI_destroyOsdRgn (OSD_HANDLE handle)
	Destroy an OSD region. More...
INT32	MPI_bindOsdToChn (OSD_HANDLE handle, const MPI_OSD_BIND_ATTR_S *p_osd_bind)
	Binding an OSD region to an encoder channel. More...
INT32	MPI_unbindOsdFromChn (OSD_HANDLE handle, const MPI_OSD_BIND_ATTR_S *p_osd_bind)
	Unbind OSD region from an encoder channel. More...
INT32	MPI_getOsdBindAttr (OSD_HANDLE handle, MPI_OSD_BIND_ATTR_S *p_osd_bind)
	Get OSD bind attributes. More...
INT32	MPI_setOsdBindAttr (OSD_HANDLE handle, const MPI_OSD_BIND_ATTR_S *p_osd_bind)
	Set OSD bind attributes. More...
INT32	MPI_getOsdRgnAttr (OSD_HANDLE handle, MPI_OSD_RGN_ATTR_S *p_osd_attr)
	Get OSD region attributes. More...
INT32	MPI_setOsdRgnAttr (OSD_HANDLE handle, const MPI_OSD_RGN_ATTR_S *p_osd_attr)
	Set OSD region attributes. More...
INT32	MPI_getOsdCanvas (OSD_HANDLE handle, MPI_OSD_CANVAS_ATTR_S *p_canvas_attr)
	Get the canvas information. More...
INT32	MPI_updateOsdCanvas (OSD_HANDLE handle)
	Update canvas to OSD. More...
INT32	MPI_updateOsdCanvasAtTime (OSD_HANDLE handle, struct timespec *update_time)
	Update canvas to OSD with specific time. More...
INT32	MPI_updateOsdCanvasAtTimeV2 (OSD_HANDLE handle, struct timespec *update_time, INT32 timed_out_ms)
	Update canvas to OSD with specific time and timeout. More...

Detailed Description

MPI for OSD (On-Screen Display)

Macro Definition Documentation

#define MPI_OSD_MAX_BIND_CHANNEL   (4)

Maximum nubmer of canvas OSDs can be bound in encoder channel.

#define MPI_OSD_MAX_HANDLE   (128)

Maximun number of OSD handle.

#define MPI_OSD_MAX_HEIGHT   (8192)

OSD region max height.

#define MPI_OSD_MAX_LINE_POINT_NUM   (2)

Number of points in OSD line.

#define MPI_OSD_MAX_POLYGON_POINT_NUM   (32)

Maximum number of points in OSD polygon.

#define MPI_OSD_MAX_TOTAL_BIND_CHANNEL   (MPI_OSD_MAX_BIND_CHANNEL + MPI_OSD_MAX_U1_POLYGON_BIND_CHANNEL)

Maximum nubmer of OSDs can be bound in encoder channel.

#define MPI_OSD_MAX_U1_POLYGON_BIND_CHANNEL   (8)

Maximum nubmer of hardware OSDs can be bound in encoder channel.

#define MPI_OSD_MAX_WIDTH   (8192)

OSD region max width.

#define MPI_OSD_MODE2_MAX_L10_BIND_CHANNEL   (8)

Maximum nubmer of OSDs can be bound with mode 2 at layer 10 in encoder channel.

#define MPI_OSD_MODE2_MAX_L30_BIND_CHANNEL   (16)

Maximum nubmer of OSDs can be bound with mode 2 at layer 30 in encoder channel.

#define MPI_OSD_MODE2_MAX_L50_BIND_CHANNEL   (8)

Maximum nubmer of hardware OSDs can be bound with mode 2 at layer 50 in encoder channel.

#define MPI_OSD_MODE2_MAX_TOTAL_BIND_CHANNEL

Value:

(MPI_OSD_MODE2_MAX_L10_BIND_CHANNEL + MPI_OSD_MODE2_MAX_L30_BIND_CHANNEL + \
	 MPI_OSD_MODE2_MAX_L50_BIND_CHANNEL)

Maximum nubmer of canvas OSDs can be bound with mode 2 in encoder channel.

#define MPI_OSD_QP_OFFSET_MAX   (51)

OSD max qp offset.

#define MPI_OSD_QP_OFFSET_MIN   (-51)

OSD min qp offset.

#define MPI_OSD_THICKNESS_MAX   (8)

OSD max thickness.

#define MPI_OSD_THICKNESS_MIN   (2)

OSD min thickness.

Enumeration Type Documentation

enum MPI_OSD_COLOR_FORMAT_E

OSD color format.

• AYUV format represents color in 16bits for a pixel. 3 bits for alpha, 5 bits for Y, 4 bits for U and 4 bits for V.

Enumerator
MPI_OSD_COLOR_FORMAT_AYUV_3544	AYUV 3544 color format.
MPI_OSD_COLOR_FORMAT_PALETTE_16	Palette 16 bits color format.
MPI_OSD_COLOR_FORMAT_PALETTE_8	Palette 8 bits color format.

enum MPI_OSD_OVERLAY_E

OSD overlay type.

Enumerator
MPI_OSD_OVERLAY_POLYGON	Overlay polygon.
MPI_OSD_OVERLAY_LINE	Overlay line.
MPI_OSD_OVERLAY_BITMAP	Overlay bitmap.
MPI_OSD_OVERLAY_BITMAP_BYPASS	Overlay bitmap.
MPI_OSD_OVERLAY_U1_POLYGON	Overlay polygon by hardware on upper layer 1.
MPI_OSD_OVERLAY_L10_BITMAP	Overlay bitmap on lower layer 10.
MPI_OSD_OVERLAY_L40_BITMAP	Overlay bitmap on layer 40.

Function Documentation

INT32 MPI_bindOsdToChn	(	OSD_HANDLE	handle,
		const MPI_OSD_BIND_ATTR_S *	p_osd_bind
	)

Binding an OSD region to an encoder channel.

Parameters

[in]	handle	Handle of the OSD that is to be configured. Range [0, MPI_OSD_MAX_HANDLE - 1]
[in]	p_osd_bind	the attributes of binding.

Returns

The execution result.

Return values

MPI_SUCCESS	success
MPI_ERR_PLAT_NULL_POINTER	input pointer is NULL.
MPI_ERR_PLAT_INVALID_PARAM	invalid parameters.
MPI_ERR_INVALID_CHN	invalid OSD handle or encoder channel.
others	failure

Note

• Please do not manipulate OSD across processes.

See also

MPI_unbindOsdFromChn()

INT32 MPI_createOsdRgn	(	OSD_HANDLE *	handle,
		const MPI_OSD_RGN_ATTR_S *	p_osd_attr
	)

Create an OSD region.

Parameters

[out]	handle	pointer to OSD handle.
[in]	p_osd_attr	the attributes of an OSD.

Returns

The execution result.

Return values

MPI_SUCCESS	success
MPI_ERR_PLAT_NULL_POINTER	input pointer is NULL.
MPI_ERR_PLAT_INVALID_PARAM	invalid parameters.
others	failure

Note

• Please do not manipulate OSD across processes.
• OSD region cannot be created when video pipeline is running.

See also

MPI_destroyOsdRgn()

INT32 MPI_destroyOsdRgn

(

OSD_HANDLE

handle

)

Destroy an OSD region.

Parameters

[in]

handle

Handle of the OSD that is to be destoryed. Range [0, MPI_OSD_MAX_HANDLE - 1]

Returns

The execution result.

Return values

MPI_SUCCESS	success
MPI_ERR_INVALID_CHN	invalid OSD handle.
others	failure

Note

• Please do not manipulate OSD across processes.
• OSD region cannot be destoryed when video pipeline is running or it's bound to some encoder channel.

See also

MPI_createOsdRgn()

INT32 MPI_getOsdBindAttr	(	OSD_HANDLE	handle,
		MPI_OSD_BIND_ATTR_S *	p_osd_bind
	)

Get OSD bind attributes.

Support chips : HC1703, HC1723, HC1753 and HC1783s or later product chip.

Parameters

[in]	handle	Handle of the OSD that is to retrieve setting. Range [0, MPI_OSD_MAX_HANDLE - 1]
[in]	p_osd_bind	the attributes of an OSD.

Returns

The execution result.

Return values

MPI_SUCCESS	success
MPI_ERR_PLAT_NULL_POINTER	input pointer is NULL.
MPI_ERR_INVALID_CHN	invalid OSD handle.
others	failure

Note

• Please do not manipulate OSD across processes.

See also

MPI_setOsdRgnAttr()

INT32 MPI_getOsdCanvas	(	OSD_HANDLE	handle,
		MPI_OSD_CANVAS_ATTR_S *	p_canvas_attr
	)

Get the canvas information.

Parameters

[in]	handle	Handle of the OSD that is to be configured. Range [0, MPI_OSD_MAX_HANDLE - 1]
[out]	p_canvas_attr	the information of a canvas.

Returns

The execution result.

Return values

MPI_SUCCESS	success
MPI_ERR_INVALID_CHN	invalid OSD handle.
others	failure

Note

• Please do not manipulate OSD across processes.

See also

MPI_updateOsdCanvas()

INT32 MPI_getOsdRgnAttr	(	OSD_HANDLE	handle,
		MPI_OSD_RGN_ATTR_S *	p_osd_attr
	)

Get OSD region attributes.

Parameters

[in]	handle	Handle of the OSD that is to retrieve setting. Range [0, MPI_OSD_MAX_HANDLE - 1]
[in]	p_osd_attr	the attributes of an OSD.

Returns

The execution result.

Return values

MPI_SUCCESS	success
MPI_ERR_PLAT_NULL_POINTER	input pointer is NULL.
MPI_ERR_INVALID_CHN	invalid OSD handle.
others	failure

Note

• Please do not manipulate OSD across processes.

See also

MPI_setOsdRgnAttr()

INT32 MPI_setOsdBindAttr	(	OSD_HANDLE	handle,
		const MPI_OSD_BIND_ATTR_S *	p_osd_bind
	)

Set OSD bind attributes.

Support chips : HC1703, HC1723, HC1753 and HC1783s or later product chip.

Parameters

[in]	handle	Handle of the OSD that is to be configured. Range [0, MPI_OSD_MAX_HANDLE - 1]
[in]	p_osd_bind	the attributes of binding.

Returns

The execution result.

Return values

MPI_SUCCESS	success
MPI_ERR_PLAT_NULL_POINTER	input pointer is NULL.
MPI_ERR_PLAT_INVALID_PARAM	invalid parameters.
MPI_ERR_INVALID_CHN	invalid OSD handle or encoder channel.
-ENOTSUP	API is not supported in this chip.
others	failure

Note

• Please do not manipulate OSD across processes.
• This API is supported in HC17x3 or later product chips only.

See also

MPI_unbindOsdFromChn()

INT32 MPI_setOsdRgnAttr	(	OSD_HANDLE	handle,
		const MPI_OSD_RGN_ATTR_S *	p_osd_attr
	)

Set OSD region attributes.

Parameters

[in]	handle	Handle of the OSD that is to be configured. Range [0, MPI_OSD_MAX_HANDLE - 1]
[in]	p_osd_attr	the attributes of an OSD.

Returns

The execution result.

Return values

MPI_SUCCESS	success
MPI_ERR_PLAT_NULL_POINTER	input pointer is NULL.
MPI_ERR_PLAT_INVALID_PARAM	invalid parameters.
MPI_ERR_INVALID_CHN	invalid OSD handle.
others	failure

Note

• Please do not manipulate OSD across processes.

See also

MPI_getOsdRgnAttr()

INT32 MPI_unbindOsdFromChn	(	OSD_HANDLE	handle,
		const MPI_OSD_BIND_ATTR_S *	p_osd_bind
	)

Unbind OSD region from an encoder channel.

Parameters

[in]	handle	Handle of the OSD that is to be configured. Range [0, MPI_OSD_MAX_HANDLE - 1]
[in]	p_osd_bind	the attributes of OSD binding info.

Returns

The execution result.

Return values

MPI_SUCCESS	success
MPI_ERR_PLAT_NULL_POINTER	input pointer is NULL.
MPI_ERR_PLAT_INVALID_PARAM	invalid parameters.
MPI_ERR_INVALID_CHN	invalid OSD handle or encoder channel.
others	failure

Note

• Please do not manipulate OSD across processes.

See also

MPI_bindOsdToChn()

INT32 MPI_updateOsdCanvas

(

OSD_HANDLE

handle

)

Update canvas to OSD.

Parameters

[in]

handle

Handle of the OSD that is to be configured. Range [0, MPI_OSD_MAX_HANDLE - 1]

Returns

The execution result.

Return values

MPI_SUCCESS	success
MPI_ERR_INVALID_CHN	invalid OSD handle.
others	failure

Note

• Please do not manipulate OSD across processes.

See also

MPI_getOsdCanvas()

INT32 MPI_updateOsdCanvasAtTime	(	OSD_HANDLE	handle,
		struct timespec *	update_time
	)

Update canvas to OSD with specific time.

Parameters

[in]	handle	Handle of the OSD that is to be configured. Range [0, MPI_OSD_MAX_HANDLE - 1]
[in]	update_time	wall time that OSD canvas should be updated.

Returns

The execution result.

Return values

MPI_SUCCESS	success
MPI_ERR_INVALID_CHN	invalid OSD handle.
-ETIMEDOUT	wait time expires
others	failure

Note

• Please do not manipulate OSD across processes.
• timeout is 2 seconds

See also

MPI_getOsdCanvas()

INT32 MPI_updateOsdCanvasAtTimeV2	(	OSD_HANDLE	handle,
		struct timespec *	update_time,
		int32_t	timed_out_ms
	)

Update canvas to OSD with specific time and timeout.

Parameters

[in]	handle	Handle of the OSD that is to be configured. Range [0, MPI_OSD_MAX_HANDLE - 1]
[in]	update_time	wall time that OSD canvas should be updated.
[in]	timed_out_ms	timed out in milliseconds.

Returns

The execution result.

Return values

MPI_SUCCESS	success
MPI_ERR_INVALID_CHN	invalid OSD handle.
-ETIMEDOUT	wait time expires
others	failure

Note

• Please do not manipulate OSD across processes.

See also

MPI_getOsdCanvas()