MPP Programming Interface Reference Manual  jpl-r3.4.15
mpi_dip_alg.h File Reference

MPI for DIP algorithms. More...

#include "mpi_dip_sns.h"

Data Structures

struct  MPI_AE_ROI_WEIGHT_S
 Structure for parameters of weight distribution of AE metering. More...
 
struct  MPI_AE_DELAY_S
 Structure for parameters of AE delayed. More...
 
struct  MPI_AE_ANTI_FLICKER_S
 Structure for parameters of AE anti-flicker. More...
 
struct  MPI_AE_EXP_STRATEGY_S
 Structure for parameters of AE exposure strategy. More...
 
struct  MPI_AE_MANUAL_S
 Structure for parameters of AE manual mode. More...
 
struct  MPI_AWB_COLOR_TEMP_BIAS_S
 Structure for parameters of AWB color temperature bias. More...
 
struct  MPI_ROI_ATTR_S
 Defines the region of interest(ROI) attribute. More...
 
struct  MPI_AE_ZONE_WEIGHT_TABLE_S
 Structure for parameters of AE zone weight table. More...
 
struct  MPI_AE_ATTR_S
 Defines auto exposure(AE) attribute. More...
 
struct  MPI_AWB_ATTR_S
 Defines auto white balance(AWB) attribure. More...
 
struct  MPI_CAL_ATTR_S
 Defines calibration(CAL) module attribute. More...
 
struct  MPI_DCC_ATTR_S
 Defines device color correction(DCC) attribute. More...
 
struct  MPI_DBC_BLACK_LEVLE_S
 Structure for parameters of DBC black level. More...
 
struct  MPI_DBC_MANUAL_S
 Structure for parameters of manual dbc. More...
 
struct  MPI_DBC_AUTO_S
 Structure for parameters of auto dbc. More...
 
struct  MPI_DBC_ATTR_S
 Defines device black-level correction(DBC) attribute. More...
 
struct  MPI_LSC_ATTR_S
 Defines lens shadding correction(LSC) attribute. More...
 
struct  MPI_ISO_AUTO_S
 Structure for parameters of automatic effective iso. More...
 
struct  MPI_ISO_MANUAL_S
 Structure for parameters of manual effective iso. More...
 
struct  MPI_ISO_ATTR_S
 Defines effective iso attribute. More...
 
struct  MPI_PTA_AUTO_S
 Structure for paramters of automatic post tone adjustment. More...
 
struct  MPI_PTA_MANUAL_S
 Structure for paramters of manual post tone adjustment. More...
 
struct  MPI_PTA_ATTR_S
 Defines post tone adjustment(PTA) attribute. More...
 
struct  MPI_CSM_AUTO_S
 Structure for paramters of automatic color saturation. More...
 
struct  MPI_CSM_MANUAL_S
 Structure for paramters of manual color saturation. More...
 
struct  MPI_CSM_ATTR_S
 Defines color saturation ma nagement(CSM) attribute. More...
 
struct  MPI_SHP_AUTO_S
 Structure for paramters of automatic sharpness. More...
 
struct  MPI_SHP_MANUAL_S
 Structure for paramters of manual sharpness. More...
 
struct  MPI_SHP_ATTR_S
 Defines sharpness(SHP) attribute. More...
 
struct  MPI_SHP_AUTO_V2_S
 Structure for paramters of automatic sharpness V2. More...
 
struct  MPI_SHP_MANUAL_V2_S
 Structure for paramters of manual sharpness V2. More...
 
struct  MPI_SHP_ATTR_V2_S
 Defines sharpness V2(SHP_V2) attribute.. More...
 
struct  MPI_NR_AUTO_S
 Structure for paramters of automatic noise reduction. More...
 
struct  MPI_NR_MANUAL_S
 Structure for paramters of manual noise reduction. More...
 
struct  MPI_NR_ATTR_S
 Defines noise reduction(NR) attribute. More...
 
struct  MPI_CORING_AUTO_S
 Structure for paramters of automatic coring. More...
 
struct  MPI_CORING_MANUAL_S
 Structure for paramters of manual coring. More...
 
struct  MPI_CORING_ATTR_S
 Defines coring(CORING) attribute. More...
 
struct  MPI_GAMMA_CURVE_S
 Structure of the gamma curve for manual mode. More...
 
struct  MPI_GAMMA_ATTR_S
 Defines gamma(GAMMA) attribute. More...
 
struct  MPI_ENH_AUTO_S
 Structure for paramters of automatic enhancement. More...
 
struct  MPI_ENH_MANUAL_S
 Structure for paramters of manual enhancement. More...
 
struct  MPI_ENH_ATTR_S
 Defines enhancement(ENH) attribute. More...
 
struct  MPI_TE_NORMAL_S
 Structure for tone enhancement under normal mode. More...
 
struct  MPI_TE_WDR_S
 Structure for tone enhancement under WDR mode. More...
 
struct  MPI_TE_WDR_AUTO_S
 Structure for tone enhancement under WDR auto mode. More...
 
struct  MPI_TE_ATTR_S
 Defines tone enhancement(TE) attribute. More...
 
struct  MPI_HDR_SYNTH_WEIGHT_S
 Structure for high dynamic range synthesis weight. More...
 
struct  MPI_HDR_SYNTH_ATTR_S
 Defines high dynamic range synthesis(HDR_SYNTH) attribute. More...
 
struct  MPI_DIP_ATTR_S
 Defines DIP module attribute. More...
 
struct  MPI_EXPOSURE_INFO_S
 Defines the internal exposure status information. More...
 
struct  MPI_WHITE_BALANCE_INFO_S
 Defines the internal white balance status information. More...
 
struct  MPI_FOCUS_STAT_S
 Structure for focus statistics. More...
 
struct  MPI_WB_STAT_S
 Structure of white balance statistics. More...
 
struct  MPI_AE_STAT_S
 Structure of auto exposure statistics. More...
 
struct  MPI_DIP_STAT_S
 Defines DIP statistics. More...
 
struct  MPI_WB_STAT_CFG_S
 Structure of white balance statistics configurations. More...
 
struct  MPI_STAT_CFG_S
 Structure of different MPI statistics configurations. More...
 
struct  MPI_PCA_TABLE_S
 Defines preference color adjustment(PCA) table. More...
 
struct  MPI_FCS_AUTO_S
 Structure for paramters of automatic false color suppression. More...
 
struct  MPI_FCS_MANUAL_S
 Structure for paramters of manual sharpness. More...
 
struct  MPI_FCS_ATTR_S
 Defines false color suppression(FCS) attribute. More...
 

Macros

#define AE_MANUAL_ENABLE_EXP_VALUE   (0x1)
 
#define AE_MANUAL_ENABLE_INTTIME   (0x2)
 
#define AE_MANUAL_ENABLE_SENSOR_GAIN   (0x4)
 
#define AE_MANUAL_ENABLE_ISP_GAIN   (0x8)
 
#define AE_MANUAL_ENABLE_SYS_GAIN   (0x10)
 
#define MPI_WB_RB_POINT_NUM   (5)
 

Enumerations

enum  MPI_AE_FPS_MODE_E { AE_FPS_DROP = 0, AE_FPS_FIXED, AE_FPS_NUM }
 Enumeration of AE frame rate mode. More...
 
enum  MPI_PTA_MODE_E { PTA_NORMAL = 0, PTA_MANUAL, PTA_MODE_NUM }
 Enumeration of PTA mode. More...
 
enum  MPI_GAMMA_MODE_E { GAMMA_BT709 = 0, GAMMA_CRT, GAMMA_MANUAL, GAMMA_MODE_NUM }
 Enumeration of gamma mode. More...
 
enum  MPI_TE_MODE_E { TE_NORMAL = 0, TE_WDR, TE_WDR_AUTO, TE_MODE_NUM }
 Enumeration of tone enhancement mode. More...
 
enum  MPI_AE_EXP_STRATEGY_MODE_E { AE_EXP_NORMAL = 0, AE_EXP_HIGHLIGHT_PRIOR, AE_STRATEGY_NUM }
 Enumeration of AE exposure strategy mode. More...
 
enum  MPI_AE_ZONE_WEIGHT_TABLE_MODE_E {
  MPI_AE_ZONE_WEIGHT_TABLE_MODE_AVG = 0, MPI_AE_ZONE_WEIGHT_TABLE_MODE_CENTRAL, MPI_AE_ZONE_WEIGHT_TABLE_MODE_SPOT, MPI_AE_ZONE_WEIGHT_TABLE_MODE_MANUAL,
  MPI_AE_ZONE_WEIGHT_TABLE_MODE_NUM
}
 Enumeration of AE zone weight table mode. More...
 
enum  MPI_DBC_TYPE_E { DBC_TYPE_CHN_SAME_BLACK_LEVEL = 0, DBC_TYPE_CHN_IND_BLACK_LEVEL, DEC_TYPE_NUM }
 Enumeration of device black-level correction algorithm opreating type. More...
 
enum  MPI_TE_DRI_TYPE_E { TE_DRI_TYPE_GAMMA_DOMAIN_HIST_CV, TE_DRI_TYPE_LINEAR_DOMAIN_HIST_CV, TE_DRI_TYPE_NUM }
 Enumeration of tone enhancement dynamic range index type. More...
 

Functions

INT32 MPI_updateSnsParam (MPI_PATH idx)
 Obtain sensor related parameters. More...
 
INT32 MPI_regAeDftLib (MPI_PATH idx)
 Registers the default AE algorithm library. More...
 
INT32 MPI_regAwbDftLib (MPI_PATH idx)
 Registers the default AWB algorithm library. More...
 
INT32 MPI_deregAeDftLib (MPI_PATH idx)
 Deregisters the AE default algorithm library. More...
 
INT32 MPI_deregAwbDftLib (MPI_PATH idx)
 Deregisters the AWB default algorithm library. More...
 
INT32 MPI_getRoiAttr (MPI_PATH idx, MPI_ROI_ATTR_S *attr)
 Get ROI attribute. More...
 
INT32 MPI_getAeAttr (MPI_PATH idx, MPI_AE_ATTR_S *attr)
 Get Auto Exposure(AE) attribute. More...
 
INT32 MPI_getNrAttr (MPI_PATH idx, MPI_NR_ATTR_S *attr)
 Get Noise Reduction(NR) attribute. More...
 
INT32 MPI_getTeAttr (MPI_PATH idx, MPI_TE_ATTR_S *attr)
 Get Tone Enhancement(TE) attribute. More...
 
INT32 MPI_getAwbAttr (MPI_PATH idx, MPI_AWB_ATTR_S *attr)
 Get Auto White Balance(AWB) attribute. More...
 
INT32 MPI_getPtaAttr (MPI_PATH idx, MPI_PTA_ATTR_S *attr)
 Get Post Tone Enhancement(PTA) attribute. More...
 
INT32 MPI_getCsmAttr (MPI_PATH idx, MPI_CSM_ATTR_S *attr)
 Get Color Saturation Management(CSM) attribute. More...
 
INT32 MPI_getShpAttr (MPI_PATH idx, MPI_SHP_ATTR_S *attr)
 Get Sharpness(SHP) attribute. More...
 
INT32 MPI_getShpAttrV2 (MPI_PATH idx, MPI_SHP_ATTR_V2_S *attr)
 Get Sharpness(SHP_V2) attribute. More...
 
INT32 MPI_getDipAttr (MPI_PATH idx, MPI_DIP_ATTR_S *attr)
 Get Digital Image Processing enable(DIP) attribute. More...
 
INT32 MPI_getGammaAttr (MPI_PATH idx, MPI_GAMMA_ATTR_S *attr)
 Get Gamma attribute. More...
 
INT32 MPI_getIsoAttr (MPI_PATH idx, MPI_ISO_ATTR_S *attr)
 Get DIP effective iso(DIP_ISO) attribute. More...
 
INT32 MPI_getEnhAttr (MPI_PATH idx, MPI_ENH_ATTR_S *attr)
 Get Enhancement(ENH) attribute. More...
 
INT32 MPI_getCoringAttr (MPI_PATH idx, MPI_CORING_ATTR_S *attr)
 Get coring(CORING) attribute. More...
 
INT32 MPI_getHdrSynthAttr (MPI_PATH idx, MPI_HDR_SYNTH_ATTR_S *attr)
 Get High Dynamic Range Synthesis(HDR_SYNTH) attribute. More...
 
INT32 MPI_getFcsAttr (MPI_PATH idx, MPI_FCS_ATTR_S *attr)
 Get False Color Suppression(FCS) attribute. More...
 
INT32 MPI_setRoiAttr (MPI_PATH idx, const MPI_ROI_ATTR_S *attr)
 Set ROI attribute. More...
 
INT32 MPI_setAeAttr (MPI_PATH idx, const MPI_AE_ATTR_S *attr)
 Set Auto Exposure(AE) attribute. More...
 
INT32 MPI_setTeAttr (MPI_PATH idx, const MPI_TE_ATTR_S *attr)
 Set Tone Enhancement(TE) attribute. More...
 
INT32 MPI_setNrAttr (MPI_PATH idx, const MPI_NR_ATTR_S *attr)
 Set Noise Reduction(NR) attribute. More...
 
INT32 MPI_setAwbAttr (MPI_PATH idx, const MPI_AWB_ATTR_S *attr)
 Set Auto White Balance(AWB) attribute. More...
 
INT32 MPI_setPtaAttr (MPI_PATH idx, const MPI_PTA_ATTR_S *attr)
 Set Post Tone Enhancement(PTA) attribute. More...
 
INT32 MPI_setCsmAttr (MPI_PATH idx, const MPI_CSM_ATTR_S *attr)
 Set Color Saturation Management(CSM) attribute. More...
 
INT32 MPI_setShpAttr (MPI_PATH idx, const MPI_SHP_ATTR_S *attr)
 Set Sharpness(SHP) attribute. More...
 
INT32 MPI_setShpAttrV2 (MPI_PATH idx, const MPI_SHP_ATTR_V2_S *attr)
 Set Sharpness(SHP_V2) attribute. More...
 
INT32 MPI_setDipAttr (MPI_PATH idx, const MPI_DIP_ATTR_S *attr)
 Set Digital Image Processing(DIP) enable attribute. More...
 
INT32 MPI_setGammaAttr (MPI_PATH idx, const MPI_GAMMA_ATTR_S *attr)
 Set Gamma attribute. More...
 
INT32 MPI_setIsoAttr (MPI_PATH idx, const MPI_ISO_ATTR_S *attr)
 Set DIP effective iso(DIP_ISO) attribute. More...
 
INT32 MPI_setEnhAttr (MPI_PATH idx, const MPI_ENH_ATTR_S *attr)
 Set Enhancement(ENH) attribute. More...
 
INT32 MPI_setCoringAttr (MPI_PATH idx, const MPI_CORING_ATTR_S *attr)
 Set coring(CORING) attribute. More...
 
INT32 MPI_setHdrSynthAttr (MPI_PATH idx, const MPI_HDR_SYNTH_ATTR_S *attr)
 Set High Dynamic Range Synthesis(HDR_SYNTH) attribute. More...
 
INT32 MPI_setFcsAttr (MPI_PATH idx, const MPI_FCS_ATTR_S *attr)
 Set False Color Suppression(FCS) attribute. More...
 
INT32 MPI_getDbcAttr (MPI_PATH idx, MPI_DBC_ATTR_S *attr)
 Get Digital Black Correction(DBC) attribute. More...
 
INT32 MPI_getDccAttr (MPI_PATH idx, MPI_DCC_ATTR_S *attr)
 Get Device Color Correction(DCC) attribute. More...
 
INT32 MPI_getLscAttr (MPI_PATH idx, MPI_LSC_ATTR_S *attr)
 Get Lens Shading Correction(LSC) attribute. More...
 
INT32 MPI_getCalAttr (MPI_PATH idx, MPI_CAL_ATTR_S *attr)
 Get Calibration enbale(CAL) attribute. More...
 
INT32 MPI_setDbcAttr (MPI_PATH idx, const MPI_DBC_ATTR_S *attr)
 Set Digital Black Correction(DBC) attribute. More...
 
INT32 MPI_setDccAttr (MPI_PATH idx, const MPI_DCC_ATTR_S *attr)
 Set Device Color Correction(DCC) attribute. More...
 
INT32 MPI_setLscAttr (MPI_PATH idx, const MPI_LSC_ATTR_S *attr)
 Set Lens Shading Correction(LSC) attribute. More...
 
INT32 MPI_setCalAttr (MPI_PATH idx, const MPI_CAL_ATTR_S *attr)
 Set Calibration enbale(CAL) attribute. More...
 
INT32 MPI_queryExposureInfo (MPI_PATH idx, MPI_EXPOSURE_INFO_S *info)
 Query internal exposure status information. More...
 
INT32 MPI_queryWhiteBalanceInfo (MPI_PATH idx, MPI_WHITE_BALANCE_INFO_S *info)
 Query internal white balance status information. More...
 
INT32 MPI_setAeFps (MPI_PATH idx, const FLOAT fps, FLOAT *fps_out)
 set AE FPS More...
 
INT32 MPI_getStatistics (MPI_PATH idx, MPI_DIP_STAT_S *stat)
 get DIP statistics. More...
 
INT32 MPI_getStatisticsConfig (MPI_PATH idx, MPI_STAT_CFG_S *stat_config)
 get DIP statistics configs. More...
 
INT32 MPI_setStatisticsConfig (MPI_PATH idx, const MPI_STAT_CFG_S *stat_config)
 set DIP statistics configs. More...
 
INT32 MPI_getPcaTable (MPI_PATH idx, MPI_PCA_TABLE_S *table)
 Get Preference Color Adjustment(PCA) table. More...
 
INT32 MPI_setPcaTable (MPI_PATH idx, const MPI_PCA_TABLE_S *table)
 Set Preference Color Adjustment(PCA) table. More...
 
INT32 MPI_getWinShpAttr (MPI_WIN idx, MPI_SHP_ATTR_S *attr)
 Get window Sharpness(SHP) attribute. More...
 
INT32 MPI_getWinShpAttrV2 (MPI_WIN idx, MPI_SHP_ATTR_V2_S *attr)
 Get window Sharpness(SHP_V2) attribute. More...
 
INT32 MPI_getWinNrAttr (MPI_WIN idx, MPI_NR_ATTR_S *attr)
 Get window Noise Reduction(NR) attribute. More...
 
INT32 MPI_setWinShpAttr (MPI_WIN idx, const MPI_SHP_ATTR_S *attr)
 Set window Sharpness(SHP) attribute. More...
 
INT32 MPI_setWinShpAttrV2 (MPI_WIN idx, const MPI_SHP_ATTR_V2_S *attr)
 Set window Sharpness(SHP_V2) attribute. More...
 
INT32 MPI_setWinNrAttr (MPI_WIN idx, const MPI_NR_ATTR_S *attr)
 Set window Noise Reduction(NR) attribute. More...
 

Detailed Description

MPI for DIP algorithms.

Macro Definition Documentation

#define AE_MANUAL_ENABLE_EXP_VALUE   (0x1)

Toggle AE exposure value for manual mode

#define AE_MANUAL_ENABLE_INTTIME   (0x2)

Toggle AE manual integration time for manual mode

#define AE_MANUAL_ENABLE_ISP_GAIN   (0x8)

Toggle AE ISP gain for manual mode

#define AE_MANUAL_ENABLE_SENSOR_GAIN   (0x4)

Toggle AE sensore gain for manual mode

#define AE_MANUAL_ENABLE_SYS_GAIN   (0x10)

Toggle AE system gain for manual mode

Enumeration Type Documentation

Enumeration of AE exposure strategy mode.

Enumerator
AE_EXP_NORMAL 

Noramal mode.

AE_EXP_HIGHLIGHT_PRIOR 

Highlight first exposure mode.

Enumeration of AE frame rate mode.

Enumerator
AE_FPS_DROP 

Frame-rate drops mode in low-light scene (Slow shutter mode).

AE_FPS_FIXED 

Fixed frame-rate mode.

Enumeration of AE zone weight table mode.

Note
  • The MPI_AE_ZONE_WEIGHT_TABLE_MODE_AVG as follow:
    {
    {1,1,1,1,1,1,1,1},
    {1,1,1,1,1,1,1,1},
    {1,1,1,1,1,1,1,1},
    {1,1,1,1,1,1,1,1},
    {1,1,1,1,1,1,1,1},
    {1,1,1,1,1,1,1,1},
    {1,1,1,1,1,1,1,1},
    {1,1,1,1,1,1,1,1},
    }
  • The MPI_AE_ZONE_WEIGHT_TABLE_MODE_CENTRAL as follow:
    {
    {1,1,1,1,1,1,1,1},
    {1,1,1,2,2,1,1,1},
    {1,1,2,3,3,2,1,1},
    {1,2,3,4,4,3,2,1},
    {1,2,3,4,4,3,2,1},
    {1,1,2,3,3,2,1,1},
    {1,1,1,2,2,1,1,1},
    {1,1,1,1,1,1,1,1},
    }
  • The MPI_AE_ZONE_WEIGHT_TABLE_MODE_SPOT as follow:
    {
    {1,1,1,1,1,1,1,1},
    {1,1,1,1,1,1,1,1},
    {1,1,1,1,1,1,1,1},
    {1,1,1,2,2,1,1,1},
    {1,1,1,2,2,1,1,1},
    {1,1,1,1,1,1,1,1},
    {1,1,1,1,1,1,1,1},
    {1,1,1,1,1,1,1,1},
    }
Enumerator
MPI_AE_ZONE_WEIGHT_TABLE_MODE_AVG 

Using average metering weight table mode.

MPI_AE_ZONE_WEIGHT_TABLE_MODE_CENTRAL 

Using central metering weight table mode.

MPI_AE_ZONE_WEIGHT_TABLE_MODE_SPOT 

Using spot metering weight table mdoe.

MPI_AE_ZONE_WEIGHT_TABLE_MODE_MANUAL 

Using manual zone weight table mode.

Enumeration of device black-level correction algorithm opreating type.

Enumerator
DBC_TYPE_CHN_SAME_BLACK_LEVEL 

All channel using same black level.

DBC_TYPE_CHN_IND_BLACK_LEVEL 

Each channel using independent black level.

Enumeration of gamma mode.

Enumerator
GAMMA_BT709 

Gamma BT-709.

GAMMA_CRT 

Gamma 2.2.

GAMMA_MANUAL 

Manual gamma curve.

Enumeration of PTA mode.

Enumerator
PTA_NORMAL 

Normal mode.

PTA_MANUAL 

Manual mode.

Enumeration of tone enhancement dynamic range index type.

Enumerator
TE_DRI_TYPE_GAMMA_DOMAIN_HIST_CV 

Coefficient of variation under gamma domain. The mean value is the average value of gamma histogram.

TE_DRI_TYPE_LINEAR_DOMAIN_HIST_CV 

Coefficient of variation under linear domain. The mean value is the average value of liner histogram.

Enumeration of tone enhancement mode.

Enumerator
TE_NORMAL 

Noramal mode.

TE_WDR 

Wide dynamic range mode.

TE_WDR_AUTO 

Wide dynamic range in auto mode.

Function Documentation

INT32 MPI_deregAeDftLib ( MPI_PATH  idx)

Deregisters the AE default algorithm library.

Parameters
[in]idxIndex of the input path.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_regAeDftLib()
INT32 MPI_deregAwbDftLib ( MPI_PATH  idx)

Deregisters the AWB default algorithm library.

Parameters
[in]idxIndex of the input path.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_regAwbDftLib()
INT32 MPI_getAeAttr ( MPI_PATH  idx,
MPI_AE_ATTR_S attr 
)

Get Auto Exposure(AE) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrAE attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setAeAttr()
INT32 MPI_getAwbAttr ( MPI_PATH  idx,
MPI_AWB_ATTR_S attr 
)

Get Auto White Balance(AWB) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrAWB attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setAwbAttr()
INT32 MPI_getCalAttr ( MPI_PATH  idx,
MPI_CAL_ATTR_S attr 
)

Get Calibration enbale(CAL) attribute.

Parameters
[in]idxpath index.
[out]attrCAL attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setCalAttr()
INT32 MPI_getCoringAttr ( MPI_PATH  idx,
MPI_CORING_ATTR_S attr 
)

Get coring(CORING) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrCORING attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setCoringAttr()
INT32 MPI_getCsmAttr ( MPI_PATH  idx,
MPI_CSM_ATTR_S attr 
)

Get Color Saturation Management(CSM) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrCSM attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setCsmAttr()
INT32 MPI_getDbcAttr ( MPI_PATH  idx,
MPI_DBC_ATTR_S attr 
)

Get Digital Black Correction(DBC) attribute.

Parameters
[in]idxpath index.
[out]attrDBC attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setDbcAttr()
INT32 MPI_getDccAttr ( MPI_PATH  idx,
MPI_DCC_ATTR_S attr 
)

Get Device Color Correction(DCC) attribute.

Parameters
[in]idxpath index.
[out]attrDCC attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setDccAttr()
INT32 MPI_getDipAttr ( MPI_PATH  idx,
MPI_DIP_ATTR_S attr 
)

Get Digital Image Processing enable(DIP) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrDIP attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setDipAttr()
INT32 MPI_getEnhAttr ( MPI_PATH  idx,
MPI_ENH_ATTR_S attr 
)

Get Enhancement(ENH) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrENH attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setEnhAttr()
INT32 MPI_getFcsAttr ( MPI_PATH  idx,
MPI_FCS_ATTR_S attr 
)

Get False Color Suppression(FCS) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrFCS attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setFcsAttr()
INT32 MPI_getGammaAttr ( MPI_PATH  idx,
MPI_GAMMA_ATTR_S attr 
)

Get Gamma attribute.

Parameters
[in]idxIndex of the input path.
[out]attrGamma attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setGammaAttr()
INT32 MPI_getHdrSynthAttr ( MPI_PATH  idx,
MPI_HDR_SYNTH_ATTR_S attr 
)

Get High Dynamic Range Synthesis(HDR_SYNTH) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrHDR_SYNTH attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setHdrSynthAttr()
INT32 MPI_getIsoAttr ( MPI_PATH  idx,
MPI_ISO_ATTR_S attr 
)

Get DIP effective iso(DIP_ISO) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrDIP_ISO attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setIsoAttr()
INT32 MPI_getLscAttr ( MPI_PATH  idx,
MPI_LSC_ATTR_S attr 
)

Get Lens Shading Correction(LSC) attribute.

Parameters
[in]idxpath index.
[out]attrLSC attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setLscAttr()
INT32 MPI_getNrAttr ( MPI_PATH  idx,
MPI_NR_ATTR_S attr 
)

Get Noise Reduction(NR) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrNR attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setNrAttr()
INT32 MPI_getPcaTable ( MPI_PATH  idx,
MPI_PCA_TABLE_S table 
)

Get Preference Color Adjustment(PCA) table.

Parameters
[in]idxpath index.
[out]tablePCA table.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setPcaTable()
INT32 MPI_getPtaAttr ( MPI_PATH  idx,
MPI_PTA_ATTR_S attr 
)

Get Post Tone Enhancement(PTA) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrPTA attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setPtaAttr()
INT32 MPI_getRoiAttr ( MPI_PATH  idx,
MPI_ROI_ATTR_S attr 
)

Get ROI attribute.

Parameters
[in]idxIndex of the input path.
[out]attrROI attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setRoiAttr()
INT32 MPI_getShpAttr ( MPI_PATH  idx,
MPI_SHP_ATTR_S attr 
)

Get Sharpness(SHP) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrSHP attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setShpAttr()
INT32 MPI_getShpAttrV2 ( MPI_PATH  idx,
MPI_SHP_ATTR_V2_S attr 
)

Get Sharpness(SHP_V2) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrSHP_V2 attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setShpAttrV2()
INT32 MPI_getStatistics ( MPI_PATH  idx,
MPI_DIP_STAT_S stat 
)

get DIP statistics.

This function can be used to get the statistics of the input image given by our underlying statistics system. The statistics system can be configured to get a more preferrable outcome.

Parameters
[in]idxpath index of the video system.
[in]statpointer of the statistics data structure that will be filled.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
INT32 MPI_getStatisticsConfig ( MPI_PATH  idx,
MPI_STAT_CFG_S stat_config 
)

get DIP statistics configs.

This function can be used to get the statistics configs of our statistics system.

Parameters
[in]idxpath index of the video system.
[in]stat_configpointer to MPI_STAT_CFG_S that will be filled.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
INT32 MPI_getTeAttr ( MPI_PATH  idx,
MPI_TE_ATTR_S attr 
)

Get Tone Enhancement(TE) attribute.

Parameters
[in]idxIndex of the input path.
[out]attrTE attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setTeAttr()
INT32 MPI_getWinNrAttr ( MPI_WIN  idx,
MPI_NR_ATTR_S attr 
)

Get window Noise Reduction(NR) attribute.

Parameters
[in]idxwindow index.
[out]attrNR attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setWinNrAttr()
INT32 MPI_getWinShpAttr ( MPI_WIN  idx,
MPI_SHP_ATTR_S attr 
)

Get window Sharpness(SHP) attribute.

Parameters
[in]idxwindow index.
[out]attrSHP attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setWinShpAttr()
INT32 MPI_getWinShpAttrV2 ( MPI_WIN  idx,
MPI_SHP_ATTR_V2_S attr 
)

Get window Sharpness(SHP_V2) attribute.

Parameters
[in]idxwindow index.
[out]attrSHP_V2 attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setWinShpAttrV2()
INT32 MPI_queryExposureInfo ( MPI_PATH  idx,
MPI_EXPOSURE_INFO_S info 
)

Query internal exposure status information.

Parameters
[in]idxIndex of the input path.
[out]infointernal exposure status information.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
INT32 MPI_queryWhiteBalanceInfo ( MPI_PATH  idx,
MPI_WHITE_BALANCE_INFO_S info 
)

Query internal white balance status information.

Parameters
[in]idxIndex of the input path.
[out]infointernal white balance status information.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
INT32 MPI_regAeDftLib ( MPI_PATH  idx)

Registers the default AE algorithm library.

Parameters
[in]idxIndex of the input path.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_deregAeDftLib()
INT32 MPI_regAwbDftLib ( MPI_PATH  idx)

Registers the default AWB algorithm library.

Parameters
[in]idxIndex of the input path.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_deregAwbDftLib()
INT32 MPI_setAeAttr ( MPI_PATH  idx,
const MPI_AE_ATTR_S attr 
)

Set Auto Exposure(AE) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrAE attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getAeAttr()
INT32 MPI_setAeFps ( MPI_PATH  idx,
const FLOAT  fps,
FLOAT fps_out 
)

set AE FPS

Parameters
[in]idxIndex of the input path.
[in]fpswhish fps.
[out]fps_outeffective fps.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
INT32 MPI_setAwbAttr ( MPI_PATH  idx,
const MPI_AWB_ATTR_S attr 
)

Set Auto White Balance(AWB) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrAWB attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getAwbAttr()
INT32 MPI_setCalAttr ( MPI_PATH  idx,
const MPI_CAL_ATTR_S attr 
)

Set Calibration enbale(CAL) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrCAL attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getCalAttr()
INT32 MPI_setCoringAttr ( MPI_PATH  idx,
const MPI_CORING_ATTR_S attr 
)

Set coring(CORING) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrCORING attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getCoringAttr()
INT32 MPI_setCsmAttr ( MPI_PATH  idx,
const MPI_CSM_ATTR_S attr 
)

Set Color Saturation Management(CSM) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrCSM attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getCsmAttr()
INT32 MPI_setDbcAttr ( MPI_PATH  idx,
const MPI_DBC_ATTR_S attr 
)

Set Digital Black Correction(DBC) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrDBC attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getDbcAttr()
INT32 MPI_setDccAttr ( MPI_PATH  idx,
const MPI_DCC_ATTR_S attr 
)

Set Device Color Correction(DCC) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrDCC attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getDccAttr()
INT32 MPI_setDipAttr ( MPI_PATH  idx,
const MPI_DIP_ATTR_S attr 
)

Set Digital Image Processing(DIP) enable attribute.

Parameters
[in]idxIndex of the input path.
[in]attrDIP attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getDipAttr()
INT32 MPI_setEnhAttr ( MPI_PATH  idx,
const MPI_ENH_ATTR_S attr 
)

Set Enhancement(ENH) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrENH attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getEnhAttr()
INT32 MPI_setFcsAttr ( MPI_PATH  idx,
const MPI_FCS_ATTR_S attr 
)

Set False Color Suppression(FCS) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrFCS attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getFcsAttr()
INT32 MPI_setGammaAttr ( MPI_PATH  idx,
const MPI_GAMMA_ATTR_S attr 
)

Set Gamma attribute.

Parameters
[in]idxIndex of the input path.
[in]attrGamma attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getGammaAttr()
INT32 MPI_setHdrSynthAttr ( MPI_PATH  idx,
const MPI_HDR_SYNTH_ATTR_S attr 
)

Set High Dynamic Range Synthesis(HDR_SYNTH) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrHDR_SYNTH attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getHdrSynthAttr()
INT32 MPI_setIsoAttr ( MPI_PATH  idx,
const MPI_ISO_ATTR_S attr 
)

Set DIP effective iso(DIP_ISO) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrDIP_ISO attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getIsoAttr()
INT32 MPI_setLscAttr ( MPI_PATH  idx,
const MPI_LSC_ATTR_S attr 
)

Set Lens Shading Correction(LSC) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrLSC attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getLscAttr()
INT32 MPI_setNrAttr ( MPI_PATH  idx,
const MPI_NR_ATTR_S attr 
)

Set Noise Reduction(NR) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrNR attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getNrAttr()
INT32 MPI_setPcaTable ( MPI_PATH  idx,
const MPI_PCA_TABLE_S table 
)

Set Preference Color Adjustment(PCA) table.

Parameters
[in]idxIndex of the input path.
[in]tablePCA table.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_setPcaTable()
INT32 MPI_setPtaAttr ( MPI_PATH  idx,
const MPI_PTA_ATTR_S attr 
)

Set Post Tone Enhancement(PTA) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrPTA attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getPtaAttr()
INT32 MPI_setRoiAttr ( MPI_PATH  idx,
const MPI_ROI_ATTR_S attr 
)

Set ROI attribute.

Parameters
[in]idxIndex of the input path.
[out]attrROI attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getRoiAttr()
INT32 MPI_setShpAttr ( MPI_PATH  idx,
const MPI_SHP_ATTR_S attr 
)

Set Sharpness(SHP) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrSHP attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getShpAttr()
INT32 MPI_setShpAttrV2 ( MPI_PATH  idx,
const MPI_SHP_ATTR_V2_S attr 
)

Set Sharpness(SHP_V2) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrSHP_V2 attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getShpAttrV2()
INT32 MPI_setStatisticsConfig ( MPI_PATH  idx,
const MPI_STAT_CFG_S stat_config 
)

set DIP statistics configs.

This function can be used to set the statistics configs of our statistics system.

Parameters
[in]idxpath index of the video system.
[in]stat_configpointer to MPI_STAT_CFG_S that will be set.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
INT32 MPI_setTeAttr ( MPI_PATH  idx,
const MPI_TE_ATTR_S attr 
)

Set Tone Enhancement(TE) attribute.

Parameters
[in]idxIndex of the input path.
[in]attrTE attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getTeAttr()
INT32 MPI_setWinNrAttr ( MPI_WIN  idx,
const MPI_NR_ATTR_S attr 
)

Set window Noise Reduction(NR) attribute.

Parameters
[in]idxwindow index.
[in]attrNR attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getWinNrAttr()
INT32 MPI_setWinShpAttr ( MPI_WIN  idx,
const MPI_SHP_ATTR_S attr 
)

Set window Sharpness(SHP) attribute.

Parameters
[in]idxwindow index.
[in]attrSHP attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getWinShpAttr()
INT32 MPI_setWinShpAttrV2 ( MPI_WIN  idx,
const MPI_SHP_ATTR_V2_S attr 
)

Set window Sharpness(SHP_V2) attribute.

Parameters
[in]idxwindow index.
[in]attrSHP_V2 attribute.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_getWinShpAttrV2()
INT32 MPI_updateSnsParam ( MPI_PATH  idx)

Obtain sensor related parameters.

Parameters
[in]idxIndex of the input path.
Return values
MPI_SUCCESSsuccess
othersfailure
Returns
The execution result.