MPP Programming Interface Reference Manual  jpl-r3.0.0-rc1
mpi_dev.h File Reference

MPI for video device. More...

#include "mpi_index.h"

Data Structures

struct  MPI_PATH_ATTR_S
 Struct for input path attributes. More...
 
struct  MPI_DEV_ATTR_S
 Struct for the attribute of video device. More...
 
struct  MPI_CHN_ATTR_S
 Struct for video channel attributes. More...
 
struct  MPI_CHN_STAT_S
 Struct for channel state. More...
 
struct  MPI_CROP_INFO_S
 Struct for crop information. More...
 
struct  MPI_ROI_INFO_S
 Struct for ROI information. More...
 
struct  MPI_MIRROR_FLIP_S
 Struct for image mirror and flip. More...
 
struct  MPI_SPH_VIDEO_ATTR_S
 Struct for the attribute of spherical video. More...
 
struct  MPI_LDC_ATTR_S
 Struct for the attribute of LDC(Lens Distortion Correction). More...
 
struct  MPI_PANORAMA_ATTR_S
 Struct for the attribute of fisheye panorama. More...
 
struct  MPI_PANNING_ATTR_S
 Struct for the attribute of fisheye panning. More...
 
struct  MPI_SURROUND_ATTR_S
 Struct for the attribute of fisheye surround. More...
 
struct  MPI_STITCH_DIST_S
 Struct for stitch parmeters at certain distance. More...
 
struct  MPI_STITCH_ATTR_S
 Struct for the attribute of content adaptive stitching. More...
 
struct  MPI_WIN_ATTR_S
 Struct for the video channel window attributes. More...
 
struct  MPI_CHN_LAYOUT_S
 Struct for the video window layout. More...
 
struct  MPI_ISP_MV_HIST_CFG_S
 Struct for the configuration of ISP MV hist. More...
 
struct  MPI_ISP_MV_HIST_S
 Struct for the of ISP MV hist. More...
 
struct  MPI_ISP_VAR_CFG_S
 Struct for the of ISP variance configuration. More...
 
struct  MPI_ISP_VAR_S
 Struct for the of ISP variance. More...
 
struct  MPI_ISP_Y_AVG_CFG_S
 Struct for the of ISP variance configuration. More...
 
struct  MPI_VIDEO_FRAME_INFO_S
 Struct for the video frame information. More...
 

Macros

#define MPI_VENC_ROI_NUM   (8)
 
#define MPI_SPH_VIDEO_SENSOR_NUM   (2)
 
#define MPI_STITCH_SENSOR_NUM   (2)
 
#define MPI_STITCH_TABLE_NUM   (3)
 
#define MPI_LDC_OFFSET_MIN   (-8192)
 
#define MPI_LDC_OFFSET_MAX   (8192)
 
#define MPI_LDC_RATIO_MIN   (0)
 
#define MPI_LDC_RATIO_MAX   (32767)
 
#define MPI_MAX_ISP_MV_HIST_BIN_NUM   (32)
 
#define MPI_MAX_ISP_MV_HIST_CFG_NUM   (1)
 
#define MPI_MAX_ISP_VAR_CFG_NUM   (1)
 
#define MPI_MAX_ISP_Y_AVG_CFG_NUM   (5)
 
#define MPI_MIN_ROI_VAL   (0)
 
#define MPI_MAX_ROI_VAL   (1024)
 
#define MPI_CHN_RES_ALIGN   (8)
 
#define MPI_CHN_LAYOUT_HOR_ALIGN   (16)
 
#define MPI_CHN_LAYOUT_VER_ALIGN   (32)
 
#define MPI_SENSOR_BMP(i)   (0x1 << (i))
 marco to transform path index to bitmap. More...
 

Typedefs

typedef UINT16 MPI_ISP_Y_AVG
 

Enumerations

enum  MPI_HDR_MODE_E {
  MPI_HDR_MODE_NONE, MPI_HDR_MODE_FRAME_PARL, MPI_HDR_MODE_FRAME_ITLV, MPI_HDR_MODE_TOP_N_BTM,
  MPI_HDR_MODE_SIDE_BY_SIDE, MPI_HDR_MODE_LINE_COLOC, MPI_HDR_MODE_LINE_ITLV, MPI_HDR_MODE_PIX_COLOC,
  MPI_HDR_MODE_PIX_ITLV, MPI_HDR_MODE_NUM
}
 Enumeration of HDR mode. More...
 
enum  MPI_LDC_VIEW_TYPE_E { MPI_LDC_VIEW_TYPE_CROP, MPI_LDC_VIEW_TYPE_ALL, MPI_LDC_VIEW_TYPE_NUM }
 Enumeration of LDC mode. More...
 
enum  MPI_WIN_VIEW_TYPE_E {
  MPI_WIN_VIEW_TYPE_NORMAL, MPI_WIN_VIEW_TYPE_LDC, MPI_WIN_VIEW_TYPE_PANORAMA, MPI_WIN_VIEW_TYPE_PANNING,
  MPI_WIN_VIEW_TYPE_SURROUND, MPI_WIN_VIEW_TYPE_STITCH, MPI_WIN_VIEW_TYPE_GRAPHICS, MPI_WIN_VIEW_TYPE_NUM
}
 Enumeration of window view type. More...
 

Functions

INT32 MPI_DEV_addPath (MPI_PATH idx, const MPI_PATH_ATTR_S *p_path_attr)
 Add a input path and set its attributes. More...
 
INT32 MPI_DEV_deletePath (MPI_PATH idx)
 Delete a input path. More...
 
INT32 MPI_DEV_setPathAttr (MPI_PATH idx, const MPI_PATH_ATTR_S *p_path_attr)
 Set the input path attributes. More...
 
INT32 MPI_DEV_getPathAttr (MPI_PATH idx, MPI_PATH_ATTR_S *p_path_attr)
 Get the input path attributes. More...
 
INT32 MPI_DEV_createDev (MPI_DEV idx, const MPI_DEV_ATTR_S *p_dev_attr)
 Create a video device. More...
 
INT32 MPI_DEV_destroyDev (MPI_DEV idx)
 Delete a video device. More...
 
INT32 MPI_DEV_setDevAttr (MPI_DEV idx, const MPI_DEV_ATTR_S *p_dev_attr)
 Set the attributes of a video device. More...
 
INT32 MPI_DEV_getDevAttr (MPI_DEV idx, MPI_DEV_ATTR_S *p_dev_attr)
 Get the attributes of a video device. More...
 
INT32 MPI_DEV_startDev (MPI_DEV idx)
 Start the video device. More...
 
INT32 MPI_DEV_stopDev (MPI_DEV idx)
 Stop a video device. More...
 
INT32 MPI_DEV_addChn (MPI_CHN idx, const MPI_CHN_ATTR_S *p_chn_attr)
 Add a video channel and set its attributes. More...
 
INT32 MPI_DEV_deleteChn (MPI_CHN idx)
 Delete a video channel. More...
 
INT32 MPI_DEV_setChnAttr (MPI_CHN idx, const MPI_CHN_ATTR_S *p_chn_attr)
 Set the video channel attribute. More...
 
INT32 MPI_DEV_getChnAttr (MPI_CHN idx, MPI_CHN_ATTR_S *p_chn_attr)
 Get the video channel attributes. More...
 
INT32 MPI_DEV_setChnLayout (MPI_CHN idx, const MPI_CHN_LAYOUT_S *p_chn_layout)
 Set the video channel layout. More...
 
INT32 MPI_DEV_getChnLayout (MPI_CHN idx, MPI_CHN_LAYOUT_S *p_chn_layout)
 Get the video channel layout. More...
 
INT32 MPI_DEV_setWindowAttr (MPI_WIN idx, const MPI_WIN_ATTR_S *p_window_attr)
 Set the video window attribute. More...
 
INT32 MPI_DEV_getWindowAttr (MPI_WIN idx, MPI_WIN_ATTR_S *p_window_attr)
 Get the video window attribute. More...
 
INT32 MPI_DEV_setWindowRoi (MPI_WIN idx, const MPI_RECT_S *p_roi)
 Set the video window roi. More...
 
INT32 MPI_DEV_getWindowRoi (MPI_WIN idx, MPI_RECT_S *p_roi)
 Get the video window roi. More...
 
INT32 MPI_DEV_setStitchAttr (MPI_WIN idx, const MPI_STITCH_ATTR_S *p_stitch_attr)
 Set content adaptive stitching attribute. More...
 
INT32 MPI_DEV_getStitchAttr (MPI_WIN idx, MPI_STITCH_ATTR_S *p_stitch_attr)
 Get content adaptive stitching attribute. More...
 
INT32 MPI_DEV_setLdcAttr (MPI_WIN idx, const MPI_LDC_ATTR_S *p_ldc_attr)
 Set lens distortion correction attribute. More...
 
INT32 MPI_DEV_getLdcAttr (MPI_WIN idx, MPI_LDC_ATTR_S *p_ldc_attr)
 Get lens distortion correction attribute. More...
 
INT32 MPI_DEV_setPanoramaAttr (MPI_WIN idx, const MPI_PANORAMA_ATTR_S *p_panorama_attr)
 Set fisheye panorama attribute. More...
 
INT32 MPI_DEV_getPanoramaAttr (MPI_WIN idx, MPI_PANORAMA_ATTR_S *p_panorama_attr)
 Get fisheye panorama attribute. More...
 
INT32 MPI_DEV_setPanningAttr (MPI_WIN idx, const MPI_PANNING_ATTR_S *p_panning_attr)
 Set fisheye panning attribute. More...
 
INT32 MPI_DEV_getPanningAttr (MPI_WIN idx, MPI_PANNING_ATTR_S *p_panning_attr)
 Get fisheye panning attribute. More...
 
INT32 MPI_DEV_setSurroundAttr (MPI_WIN idx, const MPI_SURROUND_ATTR_S *p_surround_attr)
 Set fisheye surround attribute. More...
 
INT32 MPI_DEV_getSurroundAttr (MPI_WIN idx, MPI_SURROUND_ATTR_S *p_surround_attr)
 Get fisheye surround attribute. More...
 
INT32 MPI_DEV_startChn (MPI_CHN idx)
 Start a video channel. More...
 
INT32 MPI_DEV_stopChn (MPI_CHN idx)
 Stop a video channel. More...
 
INT32 MPI_DEV_startAllChn (MPI_DEV idx)
 Start all video channels that are configured but not active. More...
 
INT32 MPI_DEV_stopAllChn (MPI_DEV idx)
 Stop all video channels that are running. More...
 
INT32 MPI_DEV_queryChnState (MPI_CHN idx, MPI_CHN_STAT_S *stat)
 Query a video channel state. More...
 
INT32 MPI_DEV_addIspMvHistCfg (MPI_WIN idx, const MPI_ISP_MV_HIST_CFG_S *cfg, UINT8 *cfg_idx)
 Add ISP MV hist configuration. More...
 
INT32 MPI_DEV_rmIspMvHistCfg (MPI_WIN idx, UINT8 cfg_idx)
 Remove ISP MV hist configuration. More...
 
INT32 MPI_DEV_getIspMvHistCfg (MPI_WIN idx, UINT8 cfg_idx, MPI_ISP_MV_HIST_CFG_S *cfg)
 Get ISP MV hist configuration. More...
 
INT32 MPI_DEV_getIspMvHist (MPI_WIN idx, UINT8 roi_idx, MPI_ISP_MV_HIST_S *stat)
 Get ISP MV hist. More...
 
INT32 MPI_DEV_addIspVarCfg (MPI_WIN idx, const MPI_ISP_VAR_CFG_S *cfg, UINT8 *cfg_idx)
 Add ISP variance configuration. More...
 
INT32 MPI_DEV_rmIspVarCfg (MPI_WIN idx, UINT8 cfg_idx)
 Remove ISP variance configuration. More...
 
INT32 MPI_DEV_getIspVarCfg (MPI_WIN idx, UINT8 cfg_idx, MPI_ISP_VAR_CFG_S *cfg)
 Get ISP variance configuration. More...
 
INT32 MPI_DEV_getIspVar (MPI_WIN idx, UINT8 cfg_idx, MPI_ISP_VAR_S *stat)
 Get ISP variance. More...
 
INT32 MPI_DEV_addIspYAvgCfg (MPI_WIN idx, const MPI_ISP_Y_AVG_CFG_S *cfg, UINT8 *cfg_idx)
 Add ISP Y average configuration. More...
 
INT32 MPI_DEV_rmIspYAvgCfg (MPI_WIN idx, UINT8 cfg_idx)
 Remove ISP Y average configuration. More...
 
INT32 MPI_DEV_getIspYAvgCfg (MPI_WIN idx, UINT8 cfg_idx, MPI_ISP_Y_AVG_CFG_S *cfg)
 Get ISP Y average configuration. More...
 
INT32 MPI_DEV_getIspYAvg (MPI_WIN idx, UINT8 cfg_idx, MPI_ISP_Y_AVG *y_avg)
 Get ISP Y average. More...
 
INT32 MPI_DEV_getWinFrame (MPI_WIN idx, MPI_VIDEO_FRAME_INFO_S *frame_info, INT32 time_ms)
 
INT32 MPI_DEV_releaseWinFrame (MPI_WIN idx, MPI_VIDEO_FRAME_INFO_S *frame_info)
 
INT32 MPI_DEV_waitWin (MPI_WIN idx, UINT32 *timestamp, INT32 timeout)
 Wait until processing done of a video window. More...
 
INT32 MPI_DEV_waitIspStat (MPI_WIN idx)
 Wait until ISP statistics is ready. More...
 

Detailed Description

MPI for video device.

Macro Definition Documentation

#define MPI_CHN_LAYOUT_HOR_ALIGN   (16)

Horizontal alignment of channel layout.

#define MPI_CHN_LAYOUT_VER_ALIGN   (32)

Vertical alignment of channel layout.

#define MPI_CHN_RES_ALIGN   (8)

Alignment of channel resolution.

#define MPI_LDC_OFFSET_MAX   (8192)

LDC maximal ratio.

#define MPI_LDC_OFFSET_MIN   (-8192)

LDC minimal ratio.

#define MPI_LDC_RATIO_MAX   (32767)

LDC maximal ratio.

#define MPI_LDC_RATIO_MIN   (0)

LDC minimal ratio.

#define MPI_SENSOR_BMP (   i)    (0x1 << (i))

marco to transform path index to bitmap.

i sensor path index.

#define MPI_SPH_VIDEO_SENSOR_NUM   (2)

Number of spherical video sensor.

#define MPI_STITCH_SENSOR_NUM   (2)

Number of STITCH sensor.

#define MPI_STITCH_TABLE_NUM   (3)

Number of STITCH table.

#define MPI_VENC_ROI_NUM   (8)

Number of video encode ROI.

Enumeration Type Documentation

Enumeration of HDR mode.

Enumerator
MPI_HDR_MODE_NONE 

NO HDR mode.

MPI_HDR_MODE_FRAME_PARL 

Frame parallel HDR mode.

MPI_HDR_MODE_FRAME_ITLV 

Frame interleave HDR mode.

MPI_HDR_MODE_TOP_N_BTM 

TOP and bottom HDR mode.

MPI_HDR_MODE_SIDE_BY_SIDE 

Side by side HDR mode.

MPI_HDR_MODE_LINE_COLOC 

Line colocated HDR mode.

MPI_HDR_MODE_LINE_ITLV 

Line interleave HDR mode.

MPI_HDR_MODE_PIX_COLOC 

Pixel colocated HDR mode.

MPI_HDR_MODE_PIX_ITLV 

Pixel interleave HDR mode.

Enumeration of LDC mode.

Enumerator
MPI_LDC_VIEW_TYPE_CROP 

The corrected picture is cropped and the size of the cropped region is equal to that of the source picture.

MPI_LDC_VIEW_TYPE_ALL 

The maximum rectangle is obtained based on the edges of the corrected picture.

MPI_LDC_VIEW_TYPE_NUM 

The max numbers of LDC mode.

Enumeration of window view type.

Enumerator
MPI_WIN_VIEW_TYPE_NORMAL 

Normal view without GFX.

MPI_WIN_VIEW_TYPE_LDC 

LDC view.

MPI_WIN_VIEW_TYPE_PANORAMA 

Panorama view.

MPI_WIN_VIEW_TYPE_PANNING 

Panning view.

MPI_WIN_VIEW_TYPE_SURROUND 

Surround view.

MPI_WIN_VIEW_TYPE_STITCH 

Stitch view.

MPI_WIN_VIEW_TYPE_GRAPHICS 

Graphics view.

MPI_WIN_VIEW_TYPE_NUM 

Number of window view type.

Function Documentation

INT32 MPI_DEV_addChn ( MPI_CHN  idx,
const MPI_CHN_ATTR_S p_chn_attr 
)

Add a video channel and set its attributes.

Parameters
[in]idxvideo channel index.
[in]p_chn_attrpointer to the video channel attribute.
See also
MPI_DEV_deleteChn()
Returns
The execution result.
INT32 MPI_DEV_addIspMvHistCfg ( MPI_WIN  idx,
const MPI_ISP_MV_HIST_CFG_S cfg,
UINT8 cfg_idx 
)

Add ISP MV hist configuration.

Parameters
[in]idxvideo window index.
[in]cfgisp mv hist configuration.
[out]cfg_idxconfiguration index.
See also
MPI_DEV_rmIspMvHistCfg()
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_NULL_POINTERinput pointer is NULL.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
Warning
The number of added configuration should be less than MPI_MAX_ISP_MV_HIST_CFG_NUM which currently is 1. Otherwise, only the latest configuration is applied.
INT32 MPI_DEV_addIspVarCfg ( MPI_WIN  idx,
const MPI_ISP_VAR_CFG_S cfg,
UINT8 cfg_idx 
)

Add ISP variance configuration.

Parameters
[in]idxvideo window index.
[in]cfgisp variance configuration.
[out]cfg_idxconfiguration index.
See also
MPI_DEV_rmIspVarCfg()
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_NULL_POINTERinput pointer is NULL.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
Warning
The number of added configuration should be less than MPI_MAX_ISP_VAR_CFG_NUM which currently is 1. Otherwise, only the latest configuration is applied.
INT32 MPI_DEV_addIspYAvgCfg ( MPI_WIN  idx,
const MPI_ISP_Y_AVG_CFG_S cfg,
UINT8 cfg_idx 
)

Add ISP Y average configuration.

Parameters
[in]idxvideo window index.
[in]cfgisp Y average configuration.
[out]cfg_idxconfiguration index.
See also
MPI_DEV_rmIspYAvgCfg()
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_NULL_POINTERinput pointer is NULL.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
INT32 MPI_DEV_addPath ( MPI_PATH  idx,
const MPI_PATH_ATTR_S p_path_attr 
)

Add a input path and set its attributes.

Parameters
[in]idxinput path index.
[in]p_path_attrpointer to the input path attribute.
See also
MPI_DEV_deletePath()
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
MPI_ERR_DEV_INVALID_PARAMinvalid attributes
INT32 MPI_DEV_createDev ( MPI_DEV  idx,
const MPI_DEV_ATTR_S p_dev_attr 
)

Create a video device.

Parameters
[in]idxvideo device index.
[in]p_dev_attrpointer to the device attribute.
See also
MPI_DEV_destroyDev()
Returns
The execution result.
INT32 MPI_DEV_deleteChn ( MPI_CHN  idx)

Delete a video channel.

Parameters
[in]idxvideo channel index.
See also
MPI_DEV_addChn()
Returns
The execution result.
INT32 MPI_DEV_deletePath ( MPI_PATH  idx)

Delete a input path.

Parameters
[in]idxinput path index.
See also
MPI_DEV_addPath()
Returns
The execution result.
INT32 MPI_DEV_destroyDev ( MPI_DEV  idx)

Delete a video device.

Parameters
[in]idxvideo device index.
See also
MPI_DEV_createDev()
Returns
The execution result.
INT32 MPI_DEV_getChnAttr ( MPI_CHN  idx,
MPI_CHN_ATTR_S p_chn_attr 
)

Get the video channel attributes.

Parameters
[in]idxvideo channel index.
[out]p_chn_attrpointer to the video channel attribute.
See also
MPI_DEV_setChnAttr()
Returns
The execution result.
INT32 MPI_DEV_getChnLayout ( MPI_CHN  idx,
MPI_CHN_LAYOUT_S p_chn_layout 
)

Get the video channel layout.

Parameters
[in]idxvideo channel index.
[out]p_chn_layoutpointer to the video channel layout.
See also
MPI_DEV_setChnLayout()
Returns
The execution result.
INT32 MPI_DEV_getDevAttr ( MPI_DEV  idx,
MPI_DEV_ATTR_S p_dev_attr 
)

Get the attributes of a video device.

Parameters
[in]idxvideo device index.
[out]p_dev_attrpointer to the video device attribute.
See also
MPI_DEV_setDevAttr()
Returns
The execution result.
INT32 MPI_DEV_getIspMvHist ( MPI_WIN  idx,
UINT8  cfg_idx,
MPI_ISP_MV_HIST_S stat 
)

Get ISP MV hist.

Parameters
[in]idxvideo window index.
[in]cfg_idxconfiguration index.
[out]statISP MV hist.
See also
none
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_NULL_POINTERinput pointer is NULL.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
INT32 MPI_DEV_getIspMvHistCfg ( MPI_WIN  idx,
UINT8  cfg_idx,
MPI_ISP_MV_HIST_CFG_S cfg 
)

Get ISP MV hist configuration.

Parameters
[in]idxvideo window index.
[in]cfg_idxconfiguration index.
[out]cfgISP MV hist configuration.
See also
MPI_DEV_addIspMvHistCfg()
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_NULL_POINTERinput pointer is NULL.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
INT32 MPI_DEV_getIspVar ( MPI_WIN  idx,
UINT8  cfg_idx,
MPI_ISP_VAR_S stat 
)

Get ISP variance.

Parameters
[in]idxvideo window index.
[in]cfg_idxconfiguration index.
[out]statISP variance.
See also
none
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_NULL_POINTERinput pointer is NULL.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
INT32 MPI_DEV_getIspVarCfg ( MPI_WIN  idx,
UINT8  cfg_idx,
MPI_ISP_VAR_CFG_S cfg 
)

Get ISP variance configuration.

Parameters
[in]idxvideo window index.
[in]cfg_idxconfiguration index.
[out]cfgISP variance configuration.
See also
MPI_DEV_addIspVarCfg()
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_NULL_POINTERinput pointer is NULL.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
INT32 MPI_DEV_getIspYAvg ( MPI_WIN  idx,
UINT8  cfg_idx,
MPI_ISP_Y_AVG *  stat 
)

Get ISP Y average.

Parameters
[in]idxvideo window index.
[in]cfg_idxconfiguration index.
[out]statISP Y average.
See also
none
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_NULL_POINTERinput pointer is NULL.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
INT32 MPI_DEV_getIspYAvgCfg ( MPI_WIN  idx,
UINT8  cfg_idx,
MPI_ISP_Y_AVG_CFG_S cfg 
)

Get ISP Y average configuration.

Parameters
[in]idxvideo window index.
[in]cfg_idxconfiguration index.
[out]cfgISP Y average configuration.
See also
MPI_DEV_addIspYAvgCfg()
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_NULL_POINTERinput pointer is NULL.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
INT32 MPI_DEV_getLdcAttr ( MPI_WIN  idx,
MPI_LDC_ATTR_S p_ldc_attr 
)

Get lens distortion correction attribute.

Parameters
[in]idxvideo window index.
[out]p_ldc_attrlens distortion correction attribute.
See also
MPI_DEV_setLdcAttr()
Returns
The execution result.
INT32 MPI_DEV_getPanningAttr ( MPI_WIN  idx,
MPI_PANNING_ATTR_S p_panning_attr 
)

Get fisheye panning attribute.

Parameters
[in]idxvideo window index.
[out]p_panning_attrpointer to fisheye panning attribute.
See also
MPI_DEV_setPanningAttr()
Returns
The execution result.
INT32 MPI_DEV_getPanoramaAttr ( MPI_WIN  idx,
MPI_PANORAMA_ATTR_S p_panorama_attr 
)

Get fisheye panorama attribute.

Parameters
[in]idxvideo window index.
[out]p_panorama_attrpointer to fisheye panorama attribute.
See also
MPI_DEV_setPanoramaAttr()
Returns
The execution result.
INT32 MPI_DEV_getPathAttr ( MPI_PATH  idx,
MPI_PATH_ATTR_S p_path_attr 
)

Get the input path attributes.

Parameters
[in]idxinput path index.
[out]p_path_attrpointer to the input path attribute.
See also
MPI_DEV_setPathAttr()
Returns
The execution result.
INT32 MPI_DEV_getStitchAttr ( MPI_WIN  idx,
MPI_STITCH_ATTR_S p_stitch_attr 
)

Get content adaptive stitching attribute.

Parameters
[in]idxvideo window index.
[out]p_stitch_attrcontent adaptive stitching attribute.
See also
MPI_DEV_setStitchAttr()
Returns
The execution result.
INT32 MPI_DEV_getSurroundAttr ( MPI_WIN  idx,
MPI_SURROUND_ATTR_S p_surround_attr 
)

Get fisheye surround attribute.

Parameters
[in]idxvideo window index.
[out]p_surround_attrpointer to fisheye surround attribute.
See also
MPI_DEV_setSurroundAttr()
Returns
The execution result.
INT32 MPI_DEV_getWindowAttr ( MPI_WIN  idx,
MPI_WIN_ATTR_S p_window_attr 
)

Get the video window attribute.

Parameters
[in]idxvideo window index.
[out]p_window_attrpointer to the video window attribute.
See also
MPI_DEV_setWindowAttr()
Returns
The execution result.
INT32 MPI_DEV_getWindowRoi ( MPI_WIN  idx,
MPI_RECT_S p_roi 
)

Get the video window roi.

Parameters
[in]idxvideo window index.
[out]p_roipointer to the video window roi.
See also
MPI_DEV_setWindowRoi()
Returns
The execution result.
INT32 MPI_DEV_queryChnState ( MPI_CHN  idx,
MPI_CHN_STAT_S stat 
)

Query a video channel state.

Parameters
[in]idxvideo channel index.
[out]statVideo channel state.
See also
none
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_NULL_POINTERinput pointer is NULL.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
INT32 MPI_DEV_rmIspMvHistCfg ( MPI_WIN  idx,
UINT8  cfg_idx 
)

Remove ISP MV hist configuration.

Parameters
[in]idxvideo window index.
[in]cfg_idxconfiguration index.
See also
MPI_DEV_addIspMvHistCfg()
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
Warning
Because the number of added configuration is MPI_MAX_ISP_MV_HIST_CFG_NUM which currently is 1, statistics get after removing cfg is undefined.
INT32 MPI_DEV_rmIspVarCfg ( MPI_WIN  idx,
UINT8  cfg_idx 
)

Remove ISP variance configuration.

Parameters
[in]idxvideo window index.
[in]cfg_idxconfiguration index.
See also
MPI_DEV_addIspVarCfg()
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
Warning
Because the number of added configuration is MPI_MAX_ISP_VAR_CFG_NUM which currently is 1, statistics get after removing cfg is undefined.
INT32 MPI_DEV_rmIspYAvgCfg ( MPI_WIN  idx,
UINT8  cfg_idx 
)

Remove ISP Y average configuration.

Parameters
[in]idxvideo window index.
[in]cfg_idxconfiguration index.
See also
MPI_DEV_addIspYAvgCfg()
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist.
MPI_FAILUREunexpected fail.
INT32 MPI_DEV_setChnAttr ( MPI_CHN  idx,
const MPI_CHN_ATTR_S p_chn_attr 
)

Set the video channel attribute.

Parameters
[in]idxvideo channel index.
[in]p_chn_attrpointer to the video channel attribute.
See also
MPI_DEV_getChnAttr()
Returns
The execution result.
INT32 MPI_DEV_setChnLayout ( MPI_CHN  idx,
const MPI_CHN_LAYOUT_S p_chn_layout 
)

Set the video channel layout.

Parameters
[in]idxvideo channel index.
[in]p_chn_layoutpointer to the video channel layout.
See also
MPI_DEV_getChnLayout()
Returns
The execution result.
INT32 MPI_DEV_setDevAttr ( MPI_DEV  idx,
const MPI_DEV_ATTR_S p_dev_attr 
)

Set the attributes of a video device.

Parameters
[in]idxvideo device index.
[in]p_dev_attrpointer to the video device attribute.
See also
MPI_DEV_getDevAttr()
Returns
The execution result.
INT32 MPI_DEV_setLdcAttr ( MPI_WIN  idx,
const MPI_LDC_ATTR_S p_ldc_attr 
)

Set lens distortion correction attribute.

Parameters
[in]idxvideo window index.
[in]p_ldc_attrlens distortion correction attribute.
See also
MPI_DEV_getLdcAttr()
Returns
The execution result.
INT32 MPI_DEV_setPanningAttr ( MPI_WIN  idx,
const MPI_PANNING_ATTR_S p_panning_attr 
)

Set fisheye panning attribute.

Parameters
[in]idxvideo window index.
[in]p_panning_attrpointer to fisheye panning attribute.
See also
MPI_DEV_getPanningAttr()
Returns
The execution result.
INT32 MPI_DEV_setPanoramaAttr ( MPI_WIN  idx,
const MPI_PANORAMA_ATTR_S p_panorama_attr 
)

Set fisheye panorama attribute.

Parameters
[in]idxvideo window index.
[in]p_panorama_attrpointer to fisheye panorama attribute.
See also
MPI_DEV_getPanoramaAttr()
Returns
The execution result.
INT32 MPI_DEV_setPathAttr ( MPI_PATH  idx,
const MPI_PATH_ATTR_S p_path_attr 
)

Set the input path attributes.

Parameters
[in]idxinput path index.
[in]p_path_attrpointer to the input path attribute.
See also
MPI_DEV_getPathAttr()
Returns
The execution result.
INT32 MPI_DEV_setStitchAttr ( MPI_WIN  idx,
const MPI_STITCH_ATTR_S p_stitch_attr 
)

Set content adaptive stitching attribute.

Parameters
[in]idxvideo window index.
[in]p_stitch_attrcontent adaptive stitching attribute.
See also
MPI_DEV_getStitchAttr()
Returns
The execution result.
INT32 MPI_DEV_setSurroundAttr ( MPI_WIN  idx,
const MPI_SURROUND_ATTR_S p_surround_attr 
)

Set fisheye surround attribute.

Parameters
[in]idxvideo window index.
[in]p_surround_attrpointer to fisheye surround attribute.
See also
MPI_DEV_getSurroundAttr()
Returns
The execution result.
INT32 MPI_DEV_setWindowAttr ( MPI_WIN  idx,
const MPI_WIN_ATTR_S p_window_attr 
)

Set the video window attribute.

Parameters
[in]idxvideo window index.
[in]p_window_attrpointer to the video window attribute.
See also
MPI_DEV_getWindowAttr()
Returns
The execution result.
INT32 MPI_DEV_setWindowRoi ( MPI_WIN  idx,
const MPI_RECT_S p_roi 
)

Set the video window roi.

Parameters
[in]idxvideo window index.
[in]p_roipointer to the video window roi.
See also
MPI_DEV_getWindowRoi()
Returns
The execution result.
INT32 MPI_DEV_startAllChn ( MPI_DEV  idx)

Start all video channels that are configured but not active.

Parameters
[in]idxdevice index.
See also
MPI_DEV_stopAllChn()
Returns
The execution result.
INT32 MPI_DEV_startChn ( MPI_CHN  idx)

Start a video channel.

Parameters
[in]idxvideo channel index.
See also
MPI_DEV_stopChn()
Returns
The execution result.
INT32 MPI_DEV_startDev ( MPI_DEV  idx)

Start the video device.

Parameters
[in]idxvideo device index.
See also
MPI_DEV_stopDev()
Returns
The execution result.
INT32 MPI_DEV_stopAllChn ( MPI_DEV  idx)

Stop all video channels that are running.

Parameters
[in]idxdevice index.
See also
MPI_DEV_startAllChn()
Returns
The execution result.
INT32 MPI_DEV_stopChn ( MPI_CHN  idx)

Stop a video channel.

Parameters
[in]idxvideo channel index.
See also
MPI_DEV_startChn()
Returns
The execution result.
INT32 MPI_DEV_stopDev ( MPI_DEV  idx)

Stop a video device.

Parameters
[in]idxdevice index.
See also
MPI_DEV_startDev()
Returns
The execution result.
INT32 MPI_DEV_waitIspStat ( MPI_WIN  idx)

Wait until ISP statistics is ready.

Parameters
[in]idxvideo window index
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_NULL_POINTERinput pointer is NULL.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist. //FIXME: to check
MPI_FAILUREunexpected fail.
INT32 MPI_DEV_waitWin ( MPI_WIN  idx,
UINT32 timestamp,
INT32  timeout 
)

Wait until processing done of a video window.

Parameters
[in]idxIndex of the video window to wait for.
[out]timestampTimestamp of the video window just processed.
[in]timeoutWaiting timeout in millisecond. (currently no effect)
Return values
MPI_SUCCESSsuccess.
MPI_ERR_DEV_NULL_POINTERinput pointer is NULL.
MPI_ERR_DEV_INVALID_WINinvalid video window index.
MPI_ERR_DEV_INVALID_CHNinvalid video channel index.
MPI_ERR_DEV_INVALID_DEVinvalid device index.
MPI_ERR_DEV_INVALID_PARAMinvalid parameters.
MPI_ERR_DEV_NOT_EXISTdevice/channel not exist. //FIXME: to check
MPI_FAILUREunexpected fail.