mpi_sys.h File Reference

MPI for MPP system. More...

#include "mpi_base_types.h"
#include "mpi_ver.h"

Data Structures
struct	MPI_VB_POOL_CONF_S
	Struct for pool configuration. More...
struct	MPI_VB_CONF_S
	Struct for video buffer configuration. More...

Macros
#define	MPI_MAX_POOL_NAME_LEN   16
#define	MPI_MAX_PUB_POOL   16
#define	MPI_SYS_init()   _MPI_SYS_init(MPI_VER)
#define	MPI_SYS_exit()   _MPI_SYS_exit()

Functions
INT32	MPI_VB_setConf (const MPI_VB_CONF_S *p_vb_conf)
	Set video buffer attributes. More...
INT32	MPI_VB_getConf (MPI_VB_CONF_S *p_vb_conf)
	Obtain video buffer attributes. More...
INT32	MPI_VB_init (VOID)
	Initialize video buffer system. More...
INT32	MPI_VB_exit (VOID)
	Exit video buffer system. More...
INT32	_MPI_SYS_init (const char *p_ver_str)
	Initialize MPP system. More...
INT32	_MPI_SYS_exit (VOID)
	Exit MPP system. More...

Detailed Description

MPI for MPP system.

Macro Definition Documentation

#define MPI_MAX_POOL_NAME_LEN   16

Maximum string length for pool name.

#define MPI_MAX_PUB_POOL   16

Maximum number of public pool.

Function Documentation

INT32 _MPI_SYS_exit

(

VOID

)

Exit MPP system.

Release the resources allocated by _MPI_SYS_init().

Returns

The execution result.

Return values

MPI_SUCCESS	success
others	unexpected failure

Note

• User should call this API to release the resources allocated by _MPI_SYS_init().
• The return value should be used only for diagnostics. User should reallocate resources by _MPI_SYS_init() if need to accessing MPP system again, even some error occurs in MPI_SYS_exit().
• This API can be called multiple times and it's thread safely.

See also

_MPI_SYS_init()

INT32 _MPI_SYS_init

(

const char *

p_ver_str

)

Initialize MPP system.

Allocate the resources for the folloing operations.

Parameters

[in]

p_ver_str

Version of application

Returns

The execution result.

Return values

MPI_SUCCESS	success
others	unexpected failure

Note

• User must call this API at least once in any process which needs to access MPP system.
• When MPP is no longer used in a process, user should call _MPI_SYS_exit() to release the resources.
• This API can be called multiple times. If do so, user should call _MPI_SYS_exit() same times to exit the MPP system.

See also

_MPI_SYS_exit()

INT32 MPI_VB_exit

(

VOID

)

Exit video buffer system.

Returns

The execution result.

Return values

MPI_SUCCESS	success
others	unexpected failure

See also

MPI_VB_init()

INT32 MPI_VB_getConf

(

MPI_VB_CONF_S *

p_vb_conf

)

Obtain video buffer attributes.

Parameters

[out]

p_vb_conf

pointer to video buffer attributes.

Returns

The execution result.

Return values

MPI_SUCCESS	success
-EFAULT	the argument p_vb_conf is NULL
others	unexpected failure

See also

MPI_VB_setConf()

INT32 MPI_VB_init

(

VOID

)

Initialize video buffer system.

Returns

The execution result.

Return values

MPI_SUCCESS	success
others	unexpected failure

Note

• User must set the VB configuration with MPI_VB_setConf() before initializing it.

See also

MPI_VB_setConf()

MPI_VB_exit()

INT32 MPI_VB_setConf

(

const MPI_VB_CONF_S *

p_vb_conf

)

Set video buffer attributes.

Parameters

[in]

p_vb_conf

pointer to video buffer attributes.

Returns

The execution result.

Return values

MPI_SUCCESS	success
-EFAULT	the argument p_vb_conf is NULL
others	unexpected failure

See also

MPI_VB_getConf()