nvmedia_isp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2018, NVIDIA CORPORATION.  All rights reserved.  All
 * information contained herein is proprietary and confidential to NVIDIA
 * Corporation.  Any use, reproduction, or disclosure without the written
 * permission of NVIDIA Corporation is prohibited.
 */

#ifndef _NVMEDIA_ISP_H
#define _NVMEDIA_ISP_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_core.h"
#include "nvmedia_image.h"

#define NVMEDIA_ISP_VERSION_MAJOR   1

#define NVMEDIA_ISP_VERSION_MINOR   7

typedef enum {
    NVMEDIA_ISP_SELECT_ISP_A,
    NVMEDIA_ISP_SELECT_ISP_B
} NvMediaISPSelect;

enum {
    NVMEDIA_ISP_COLOR_COMPONENT_NUM = 4
};

enum {
    NVMEDIA_ISP_COLOR_COMPONENT_0 = 0
};
enum {
    NVMEDIA_ISP_COLOR_COMPONENT_1 = 1
};
enum {
    NVMEDIA_ISP_COLOR_COMPONENT_2 = 2
};
enum {
    NVMEDIA_ISP_COLOR_COMPONENT_3 = 3
};
enum {
    NVMEDIA_ISP_COLOR_COMPONENT_MAX = 4
};

enum {
    NVMEDIA_ISP_COLOR_COMPONENT_TL = NVMEDIA_ISP_COLOR_COMPONENT_0,
    NVMEDIA_ISP_COLOR_COMPONENT_TR = NVMEDIA_ISP_COLOR_COMPONENT_1,
    NVMEDIA_ISP_COLOR_COMPONENT_BL = NVMEDIA_ISP_COLOR_COMPONENT_2,
    NVMEDIA_ISP_COLOR_COMPONENT_BR = NVMEDIA_ISP_COLOR_COMPONENT_3
};

enum {
    NVMEDIA_ISP_COLOR_COMPONENT_TRIPLET_NUM = 3
};


enum {
    NVMEDIA_ISP_HDR_SAMPLE_MAP_NUM = 16
};

enum {
    NVMEDIA_ISP_HIST_RANGE_CFG_NUM = 8
};
enum {
    NVMEDIA_ISP_LAC_ROI_NUM = 4
};
enum {
    NVMEDIA_ISP_AFM_ROI_NUM = 8
};
enum {
    NVMEDIA_ISP_AFM_FILTER_COEFF_NUM = 6
};

typedef enum
{
    NVMEDIA_ISP_COLORCHANNEL_TL_R_V = NVMEDIA_ISP_COLOR_COMPONENT_0,
    NVMEDIA_ISP_COLORCHANNEL_TR_G_Y,
    NVMEDIA_ISP_COLORCHANNEL_BL_B_U,
    NVMEDIA_ISP_COLORCHANNEL_BR,
    NVMEDIA_ISP_COLORCHANNEL_LUMINANCE,

    NVMEDIA_ISP_COLORCHANNEL_FORCE32 = 0x7FFFFFFF
} NvMediaISPColorChannel;

typedef enum {
    NVMEDIA_ISP_PIXELFORMAT_RGB = 0x1,
    NVMEDIA_ISP_PIXELFORMAT_YUV,
    NVMEDIA_ISP_PIXELFORMAT_QUAD
} NvMediaISPPixelFormat;

typedef enum
{
    NVMEDIA_ISP_HDR_MODE_NORMAL = 0x1,
    NVMEDIA_ISP_HDR_MODE_SHORT,
    NVMEDIA_ISP_HDR_MODE_LONG,
    NVMEDIA_ISP_HDR_MODE_BOTH,
    NVMEDIA_ISP_HDR_MODE_SEPARATE,

    NVMEDIA_ISP_HDR_MODE_FORCE32 = 0x7FFFFFFF
} NvMediaISPHdrMode;

typedef struct
{
    int low;
    int high;
} NvMediaISPRange;

typedef struct
{
    float low;
    float high;
} NvMediaISPRangeFloat;

typedef struct
{
    int width;
    int height;
} NvMediaISPSize;

typedef struct
{
    int x;
    int y;
} NvMediaISPPoint;

typedef struct
{
    float x;
    float y;
} NvMediaISPFloatPoint;
typedef enum
{
    NVMEDIA_ISP_STATS_HISTOGRAM = 1,
    NVMEDIA_ISP_STATS_LAC,
    NVMEDIA_ISP_STATS_FLICKER_BAND,
    NVMEDIA_ISP_STATS_FOCUS_METRIC,
    NVMEDIA_ISP_STATS_HISTOGRAM_V4,
    NVMEDIA_ISP_STATS_LAC_V4,
    NVMEDIA_ISP_STATS_FLICKER_BAND_V4,
    NVMEDIA_ISP_STATS_FOCUS_METRIC_V4,
    NVMEDIA_ISP_STATS_HISTOGRAM_V5,
    NVMEDIA_ISP_STATS_LAC_V5,
    NVMEDIA_ISP_STATS_FLICKER_BAND_V5,
    NVMEDIA_ISP_STATS_LTM_V5,
    NVMEDIA_ISP_STATS_OR_V5
} NvMediaISPStats;

typedef struct
{
    NvMediaBool enable;

    NvMediaISPPixelFormat pixelFormat;

    unsigned char range[NVMEDIA_ISP_HIST_RANGE_CFG_NUM];

    unsigned char knee[NVMEDIA_ISP_HIST_RANGE_CFG_NUM];

    float offset;

    NvMediaRect window;

    unsigned char  hdrSampleMap[NVMEDIA_ISP_HDR_SAMPLE_MAP_NUM];

    NvMediaISPHdrMode   hdrMode;
} NvMediaISPStatsHistogramSettingsV4;

typedef struct
{
    unsigned int numBins;

    unsigned int *data[NVMEDIA_ISP_COLOR_COMPONENT_NUM];
} NvMediaISPStatsHistogramMeasurement;

typedef struct
{
    NvMediaISPSize size;

    unsigned int horizontalNum;
    unsigned int verticalNum;

    unsigned int horizontalInterval;

    unsigned int verticalInterval;

    NvMediaISPPoint startOffset;
} NvMediaISPStatsWindows;

typedef struct
{
    NvMediaBool enable;

    NvMediaBool ROIEnable[NVMEDIA_ISP_LAC_ROI_NUM];

    NvMediaISPPixelFormat pixelFormat;

    float rgbToYOffset[NVMEDIA_ISP_COLOR_COMPONENT_NUM];

    float rgbToYGain[NVMEDIA_ISP_COLOR_COMPONENT_NUM];

    NvMediaISPRangeFloat range[NVMEDIA_ISP_COLOR_COMPONENT_NUM];

    NvMediaISPStatsWindows windows[NVMEDIA_ISP_LAC_ROI_NUM];

    unsigned char  hdrSampleMap[NVMEDIA_ISP_HDR_SAMPLE_MAP_NUM];

    NvMediaISPHdrMode   hdrMode[NVMEDIA_ISP_LAC_ROI_NUM];

    float   hdrShort;

    float   hdrLong;
} NvMediaISPStatsLacSettingsV4;

typedef struct
{
    NvMediaBool ROIEnable[NVMEDIA_ISP_LAC_ROI_NUM];

    NvMediaISPPoint startOffset[NVMEDIA_ISP_LAC_ROI_NUM];

    NvMediaISPSize windowSize[NVMEDIA_ISP_LAC_ROI_NUM];

    unsigned int numWindows[NVMEDIA_ISP_LAC_ROI_NUM];

    unsigned int numWindowsH[NVMEDIA_ISP_LAC_ROI_NUM];

    unsigned int numWindowsV[NVMEDIA_ISP_LAC_ROI_NUM];

    float *average[NVMEDIA_ISP_LAC_ROI_NUM][NVMEDIA_ISP_COLOR_COMPONENT_NUM];

    unsigned int *numPixels[NVMEDIA_ISP_LAC_ROI_NUM][NVMEDIA_ISP_COLOR_COMPONENT_NUM];
} NvMediaISPStatsLacMeasurementV4;

typedef struct
{
    NvMediaBool enable;

    NvMediaISPStatsWindows windows;

    NvMediaISPColorChannel colorChannel;

    unsigned char hdrSampleMap[NVMEDIA_ISP_HDR_SAMPLE_MAP_NUM];

    NvMediaISPHdrMode   hdrMode;
} NvMediaISPStatsFlickerBandSettingsV4;

typedef struct
{
    unsigned int numWindows;

    int *luminance;
} NvMediaISPStatsFlickerBandMeasurement;

typedef struct
{
    NvMediaBool enable;

    NvMediaBool noiseCompensation;

    float noiseCompensationGain;

    float metricGain;

    unsigned int numCoefficients;

    float *coefficient[NVMEDIA_ISP_COLOR_COMPONENT_NUM];

    float metricLowerLimit;

    float inputThreshold;

    NvMediaISPStatsWindows windows;
} NvMediaISPStatsFocusMetricSettings;

typedef struct
{
    NvMediaISPPoint startOffset;

    NvMediaISPSize windowSize;

    unsigned int numWindows;

    unsigned int *metric[NVMEDIA_ISP_COLOR_COMPONENT_NUM];
} NvMediaISPStatsFocusMetricMeasurement;

#define NVMEDIA_ISP5_RADTF_CP_COUNT             6
#define NVMEDIA_ISP5_FB_WINDOWS                 256
#define NVMEDIA_ISP5_HIST_TF_KNEE_POINT_COUNT   8
#define NVMEDIA_ISP5_HIST_BIN_COUNT             256
#define NVMEDIA_ISP_LAC_ROI_WIN_NUM             (32 * 32)
#define NVMEDIA_ISP5_LTM_HIST_BIN_COUNT         128
#define NVMEDIA_ISP5_LTM_AVG_WIN_COUNT          8

typedef enum
{
    NVMEDIA_ISP_MULTI_EXP_LANE_RV = 0,
    NVMEDIA_ISP_MULTI_EXP_LANE_GY = 1,
    NVMEDIA_ISP_MULTI_EXP_LANE_BU = 2,
} NvMediaIsp5MultiExpLane;

typedef struct
{
    double_t x;
    double_t y;
    double_t kxx;
    double_t kxy;
    double_t kyx;
    double_t kyy;
} NvMediaIsp5RadialMask;

typedef struct
{
    uint16_t top;
    uint16_t bottom;
    uint16_t left;
    uint16_t right;
} NvMediaIsp5RectMask;

typedef struct
{
    float_t x;
    float_t y;
    double_t slope;
} NvMediaISP5CubicSplineCtrlPoint;

typedef struct
{
    NvMediaIsp5RadialMask ellipse;
    NvMediaISP5CubicSplineCtrlPoint tf[NVMEDIA_ISP5_RADTF_CP_COUNT];
} NvMediaIsp5RadialTf;

typedef enum
{
    NVMEDIA_ISP_HIST_CH_R_V = 0,
    NVMEDIA_ISP_HIST_CH_G_Y = 1,
    NVMEDIA_ISP_HIST_CH_B_U = 2,
    NVMEDIA_ISP_HIST_CH_Y   = 3,
} NvMediaIsp5HistChannel;

typedef enum {
    NVMEDIA_ISP_HIST_CH_MAXORY_MAX = 0,
    NVMEDIA_ISP_HIST_CH_MAXORY_Y   = 3,
} NvMediaIsp5HistChannelMaxOrY;

typedef struct
{
    NvMediaBool enable;

    NvMediaISPColorChannel chSelect;

    NvMediaBool radialMaskEnable;

    uint8_t bandCount;

    NvMediaISPPoint offset;

    NvMediaISPSize bandSize;

    NvMediaISPRangeFloat range;
    NvMediaISPRangeFloat chromaRange;

    NvMediaIsp5RadialMask radialMask;

} NvMediaISPStatsFlickerBandSettingsV5;

typedef struct
{
    uint32_t numWindows;

    float_t luminance[NVMEDIA_ISP5_FB_WINDOWS];
} NvMediaISPStatsFlickerBandMeasurementV5;

typedef struct
{
    NvMediaBool enable;

    NvMediaBool radialMaskEnable;

    NvMediaBool radialWeigthEnable;

    NvMediaIsp5MultiExpLane laneSelect;

    NvMediaRect window;

    NvMediaIsp5HistChannel channel0;
    NvMediaIsp5HistChannel channel1;
    NvMediaIsp5HistChannel channel2;
    NvMediaIsp5HistChannelMaxOrY channel3;

    float_t R2YGain;
    float_t G2YGain;
    float_t B2YGain;
    float_t R2YOffset;
    float_t G2YOffset;
    float_t B2YOffset;

    float_t offset;

    float_t chromaOffset;

    uint8_t kneePoints[NVMEDIA_ISP5_HIST_TF_KNEE_POINT_COUNT];

    uint8_t ranges[NVMEDIA_ISP5_HIST_TF_KNEE_POINT_COUNT];

    uint8_t chromaKneePoints[NVMEDIA_ISP5_HIST_TF_KNEE_POINT_COUNT];

    uint8_t chromaRanges[NVMEDIA_ISP5_HIST_TF_KNEE_POINT_COUNT];

    NvMediaIsp5RadialMask radialMask;

    NvMediaIsp5RadialTf radialWeightTf;

} NvMediaISPStatsHistogramSettingsV5;

typedef struct
{
    uint32_t histData[NVMEDIA_ISP5_HIST_BIN_COUNT][NVMEDIA_ISP_COLOR_COMPONENT_NUM];

    uint32_t excludedCount[NVMEDIA_ISP_COLOR_COMPONENT_NUM];

} NvMediaISPStatsHistogramMeasurementV5;

typedef struct
{
    NvMediaBool enable;

    NvMediaBool ROIEnable[NVMEDIA_ISP_LAC_ROI_NUM];

    NvMediaBool radialMaskEnable[NVMEDIA_ISP_LAC_ROI_NUM];

    NvMediaIsp5MultiExpLane laneSelect;

    float_t R2YGain;
    float_t G2YGain;
    float_t B2YGain;
    float_t R2YOffset;
    float_t G2YOffset;
    float_t B2YOffset;

    NvMediaISPRangeFloat range[NVMEDIA_ISP_COLOR_COMPONENT_NUM];

    NvMediaISPStatsWindows windows[NVMEDIA_ISP_LAC_ROI_NUM];

    NvMediaIsp5RadialMask radialMask;

} NvMediaISPStatsLacSettingsV5;

typedef struct
{
    uint32_t numWindows;

    uint32_t numWindowsH;

    uint32_t numWindowsV;

    float_t average[NVMEDIA_ISP_LAC_ROI_WIN_NUM][NVMEDIA_ISP_COLOR_COMPONENT_NUM];

    uint32_t maskedOffCnt[NVMEDIA_ISP_LAC_ROI_WIN_NUM][NVMEDIA_ISP_COLOR_COMPONENT_NUM];

    uint32_t clippedCnt[NVMEDIA_ISP_LAC_ROI_WIN_NUM][NVMEDIA_ISP_COLOR_COMPONENT_NUM];

} NvMediaISPStatsLacROIDataV5;

typedef struct
{
    NvMediaBool ROIEnable[NVMEDIA_ISP_LAC_ROI_NUM];

    NvMediaISPSize windowSize[NVMEDIA_ISP_LAC_ROI_NUM];

    NvMediaISPStatsLacROIDataV5 ROIData[NVMEDIA_ISP_LAC_ROI_NUM];

} NvMediaISPStatsLacMeasurementV5;

typedef struct
{
    NvMediaBool enable;

    NvMediaBool rectMaskEnable;

    NvMediaIsp5RectMask rectMask;

    NvMediaBool radialMaskEnable;

    NvMediaIsp5RadialMask radialMask;

    uint16_t localAvgWndWidth;

    uint16_t localAvgWndHeight;

} NvMediaISPStatsLTMSettingsV5;

typedef struct
{
    uint32_t histogram[NVMEDIA_ISP5_LTM_HIST_BIN_COUNT];

    float_t localAverageTone[NVMEDIA_ISP5_LTM_AVG_WIN_COUNT][NVMEDIA_ISP5_LTM_AVG_WIN_COUNT];

    uint32_t nonMaskedPixelCount[NVMEDIA_ISP5_LTM_AVG_WIN_COUNT][NVMEDIA_ISP5_LTM_AVG_WIN_COUNT];

} NvMediaISPStatsLTMMeasurementV5;

typedef struct
{
    uint32_t highInWin;
    uint32_t lowInWin;
    uint32_t highMagInWin;
    uint32_t lowMagInWin;
    uint32_t highOutWin;
    uint32_t lowOutWin;
    uint32_t highMagOutWin;
    uint32_t lowMagOutWin;
} NvMediaISPStatsORMeasurementV5;

/*
 * \defgroup history_isp History
 * Provides change history for the NvMedia ISP API.
 *
 * \section history_isp Version History
 *
 * <b> Version 1.0 </b> July 8, 2014
 * - Initial release
 *
 * <b> Version 1.1 </b> March 13, 2015
 * - Added ISP version 3 support
 *
 * <b> Version 1.2 </b> November 17, 2015
 * - Added ISP version 4 support
 *
 * <b> Version 1.3 </b> March 31, 2017
 * - Removed ISP version 3 support
 *
 * <b> Version 1.4 </b> August 15, 2017
 * - Added ISP version 5 support
 *
 * <b> Version 1.5 </b> December 1, 2017
 * - Added windowSize to NvMediaISPStatsLacMeasurementV5 for ISP version 5
 *
 * <b> Version 1.6 </b> Febuary 22, 2018
 * - Renamed unClippedCnt to maskedOffCnt
 *
 * <b> Version 1.7 </b> April 10, 2018
 * - Change slope to double point in NvMediaISP5CubicSplineCtrlPoint
 */
#ifdef __cplusplus
};     /* extern "C" */
#endif

#endif /* _NVMEDIA_ISP_H */