mpi_sys.h File Reference

MPI for MPP system. More...

#include "mpi_base_types.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

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 (VOID)
	Initialize MPI system. More...
INT32	MPI_SYS_exit (VOID)
	Exit MPI system. More...

Detailed Description

MPI for MPP system.

Macro Definition Documentation

#define MPI_MAX_POOL_NAME_LEN   16

Max string length for pool name.

#define MPI_MAX_PUB_POOL   16

Max number of public pool.

Function Documentation

INT32 MPI_SYS_exit

(

VOID

)

Exit MPI system.

User should call this API to release the resources allocated by MPP.

Note

• This API can be called multiple times and it's thread safely.
• This API will release the reference and file descriptor even some unexpected error is occured.
• If MPI system is initialized multiple times in a process, user should call this API same times to exit the MPI system.

See also

MPI_SYS_init()

Returns

The execution result.

Return values

MPI_SUCCESS	success
others	unexpected failure

INT32 MPI_SYS_init

(

VOID

)

Initialize MPI system.

User must call this API at least once in any process which needs to access MPI system. When MPP is no longer used in a process, user should call MPI_SYS_exit() to release the resources.

Note

• This API can be called multiple times and it's thread safely.

See also

MPI_SYS_exit()

Returns

The execution result.

Return values

MPI_SUCCESS	success
others	unexpected failure

INT32 MPI_VB_exit

(

VOID

)

Exit video buffer system.

See also

MPI_VB_init()

Returns

The execution result.

Return values

MPI_SUCCESS	success
others	unexpected failure

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.

See also

MPI_VB_setConf()

Returns

The execution result.

Return values

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

INT32 MPI_VB_init

(

VOID

)

Initialize video buffer system.

Note

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

See also

MPI_VB_exit()

Returns

The execution result.

Return values

MPI_SUCCESS	success
others	unexpected failure

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.

See also

MPI_VB_getConf()

Returns

The execution result.

Return values

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