nvmedia_isp.h

Go to the documentation of this file.

/*
 * Copyright (c) 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

#include <stdint.h>

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

#ifdef __cplusplus
extern "C" {
#endif

#define NVM_ISP_VERSION_MAJOR   1

#define NVM_ISP_VERSION_MINOR   0

#define NVM_ISP_MAX_OUTPUTS                 (3u)

#define NVM_ISP_MAX_INPUT_PLANES            (3u)

#define NVM_ISP_MAX_QUEUED_REQUESTS         (32u)

#define NVM_ISP_MAX_COLOR_COMPONENT         (4u)

#define NVM_ISP_RADTF_POINTS                (6u)

#define NVM_ISP_MAX_LIN_KNEE_POINTS         (10u)

#define NVM_ISP_LAS_TF_POINTS               (9u)

#define NVM_ISP_GTM_TF_POINTS               (18u)

#define NVM_ISP_LTM_SOFT_KEY_WIDTH          (8u)

#define NVM_ISP_LTM_SOFT_KEY_HEIGHT         (8u)

#define NVM_ISP_LTM_GAIN_POINTS             (9u)

#define NVM_ISP_HIST_KNEE_POINTS            (8u)

#define NVM_ISP_MAX_LAC_ROI                 (4u)

#define NVM_ISP_MAX_LAC_ROI_WINDOWS         (32u * 32u)

#define NVM_ISP_HIST_BINS                   (256u)

#define NVM_ISP_LTM_HIST_BINS               (128u)

#define NVM_ISP_LTM_AVG_WINDOWS             (8u)

typedef struct _NvMediaISP NvMediaISP;

typedef struct _NvMediaISPStatsSurface NvMediaISPStatsSurface;

typedef struct _NvMediaISPSettings NvMediaISPSettings;

typedef enum {
    NVM_ISP_PIPELINE_X1 = (('X' << 24) | 0x01),
} NvMediaISPPipelineEnum;

NvMediaStatus
NvMediaISPGetVersion(
    NvMediaVersion *version
);

NvMediaISP *
NvMediaISPCreate(
    uint32_t instanceId,
    NvMediaISPPipelineEnum pipelineEnum,
    uint32_t maxQueuedRequests
);

NvMediaStatus
NvMediaISPStop(
    NvMediaISP *isp
);

NvMediaStatus
NvMediaISPDestroy(
    NvMediaISP *isp
);

NvMediaISPStatsSurface *
NvMediaISPStatsSurfaceCreate(
    NvMediaISP *isp
);

NvMediaStatus
NvMediaISPStatsSurfaceDestroy(
    NvMediaISPStatsSurface *statsSurface
);

NvMediaISPSettings *
NvMediaISPSettingsCreate(
    NvMediaISP *isp,
    NvMediaISPPipelineEnum pipelineEnum
);

NvMediaStatus
NvMediaISPSettingsDestroy(
    NvMediaISPSettings *settings
);

typedef struct {
    NvMediaBool enable;
    uint32_t numPlanes;
    uint32_t numKneePoints[NVM_ISP_MAX_INPUT_PLANES];
    NvMediaPointDouble kneePoints[NVM_ISP_MAX_INPUT_PLANES][NVM_ISP_MAX_LIN_KNEE_POINTS];
} NvMediaISPLinearization;

NvMediaStatus
NvMediaISPSetLinearization(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPLinearization *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    double_t pedestal[NVM_ISP_MAX_INPUT_PLANES][NVM_ISP_MAX_COLOR_COMPONENT];
} NvMediaISPBlackLevelCorrection;

NvMediaStatus
NvMediaISPSetBlackLevelCorrection(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPBlackLevelCorrection *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    float_t wbGain[NVM_ISP_MAX_INPUT_PLANES][NVM_ISP_MAX_COLOR_COMPONENT];
} NvMediaISPWhiteBalanceCorrection;

NvMediaStatus
NvMediaISPSetWhiteBalanceCorrection(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPWhiteBalanceCorrection *controls,
    size_t size
);

typedef enum {
    NVM_ISP_EXP_FUSION_USE_0 = 0,
    NVM_ISP_EXP_FUSION_USE_1 = 1,
    NVM_ISP_EXP_FUSION_USE_2 = 2,
    NVM_ISP_EXP_FUSION_BLEND_01 = 3,
    NVM_ISP_EXP_FUSION_BLEND_ALL = 4,
} NvMediaISPExposureFusionMode;

typedef struct {
    NvMediaBool enable;
    float_t scaleFactors[NVM_ISP_MAX_INPUT_PLANES];
    NvMediaISPExposureFusionMode fusionMode;
} NvMediaISPExposureFusion;

NvMediaStatus
NvMediaISPSetExposureFusion(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPExposureFusion *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    float_t strength;
    NvMediaBool noiseProfileEnable;
    uint32_t profileNum;
    float_t sensorGain;
    float_t wbGain[NVM_ISP_MAX_COLOR_COMPONENT];
} NvMediaISPBadPixelCorrection;

NvMediaStatus
NvMediaISPSetBadPixelCorrection(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPBadPixelCorrection *controls,
    size_t size
);

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

typedef struct {
    NvMediaPoint center;
    uint32_t horizontalAxis;
    uint32_t verticalAxis;
    float_t angle;
} NvMediaISPEllipse;

typedef struct {
    NvMediaISPEllipse radialTransform;
    NvMediaISPSplineControlPoint controlPoints[NVM_ISP_RADTF_POINTS];
} NvMediaISPRadialTF;

typedef struct {
    NvMediaBool cctBasedLSCEnable;
    float_t cct;
    float_t fallOff;
} NvMediaISPLensShadingCorrection;

NvMediaStatus
NvMediaISPSetLensShadingCorrection(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPLensShadingCorrection *controls,
    size_t size
);

typedef struct {
    float_t strength;
} NvMediaISPDemosaic;

NvMediaStatus
NvMediaISPSetDemosaic(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPDemosaic *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    NvMediaISPSplineControlPoint controlPoints[NVM_ISP_LAS_TF_POINTS];
} NvMediaISPLevelAdjSat;

NvMediaStatus
NvMediaISPSetLevelAdjSat(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPLevelAdjSat *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    float_t strength;
    NvMediaBool noiseProfileEnable;
    uint32_t profileNum;
    float_t sensorGain;
    float_t wbGain[NVM_ISP_MAX_COLOR_COMPONENT];
    NvMediaBool radialTFEnable;
    NvMediaISPRadialTF radialTF;
} NvMediaISPNoiseReduction;

NvMediaStatus
NvMediaISPSetNoiseReduction(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPNoiseReduction *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    float_t matrix[3][3];
} NvMediaISPColorCorrectionMatrix;

NvMediaStatus
NvMediaISPSetColorCorrectionMatrix(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPColorCorrectionMatrix *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    NvMediaISPSplineControlPoint controlPoints[NVM_ISP_GTM_TF_POINTS];
} NvMediaISPGlobalToneMap;

NvMediaStatus
NvMediaISPSetGlobalToneMap(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPGlobalToneMap *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    float_t softKey[NVM_ISP_LTM_SOFT_KEY_HEIGHT][NVM_ISP_LTM_SOFT_KEY_WIDTH];
    float_t largeScaleContrastGain[NVM_ISP_LTM_GAIN_POINTS];
    float_t smallScaleContrastGain[NVM_ISP_LTM_GAIN_POINTS];
    float_t saturation[NVM_ISP_LTM_GAIN_POINTS];
} NvMediaISPLocalToneMap;

NvMediaStatus
NvMediaISPSetLocalToneMap(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPLocalToneMap *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    float_t matrix[3][3];
} NvMediaISPColorSpaceConversion;

NvMediaStatus
NvMediaISPSetColorSpaceConversion(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPColorSpaceConversion *controls,
    size_t size
);

NvMediaStatus
NvMediaISPSetInvColorSpaceConversion(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPColorSpaceConversion *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    float_t saturation;
} NvMediaISPSaturation;

NvMediaStatus
NvMediaISPSetSaturation(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPSaturation *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    float_t strength;
} NvMediaISPSharpness;

NvMediaStatus
NvMediaISPSetSharpness(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPSharpness *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    uint32_t downscaledWidth;
    uint32_t downscaledHeight;
} NvMediaISPDownscale;

NvMediaStatus
NvMediaISPSetDownscale(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPDownscale *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    float_t min[NVM_ISP_MAX_COLOR_COMPONENT];
    float_t max[NVM_ISP_MAX_COLOR_COMPONENT];
} NvMediaISPClip;

NvMediaStatus
NvMediaISPSetClip(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPClip *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    float_t offset[NVM_ISP_MAX_COLOR_COMPONENT];
} NvMediaISPOffset;

NvMediaStatus
NvMediaISPSetOffset(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPOffset *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    float_t digitalGain;
} NvMediaISPDigitalGain;

NvMediaStatus
NvMediaISPSetDigitalGain(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPDigitalGain *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    float_t offset;
    uint8_t knees[NVM_ISP_HIST_KNEE_POINTS];
    uint8_t ranges[NVM_ISP_HIST_KNEE_POINTS];
    NvMediaRect rectangularMask;
    NvMediaBool ellipticalMaskEnable;
    NvMediaISPEllipse ellipticalMask;
    NvMediaBool ellipticalWeightEnable;
    NvMediaISPRadialTF radialTF;
} NvMediaISPHistogramStats;

NvMediaStatus
NvMediaISPSetHistogramStats(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPHistogramStats *controls,
    size_t size
);

typedef struct {
    uint32_t width;
    uint32_t height;
    uint32_t numWindowsH;
    uint32_t numWindowsV;
    uint32_t horizontalInterval;
    uint32_t verticalInterval;
    NvMediaPoint startOffset;
} NvMediaISPStatisticsWindows;

typedef struct {
    NvMediaBool enable;
    float_t min[NVM_ISP_MAX_COLOR_COMPONENT];
    float_t max[NVM_ISP_MAX_COLOR_COMPONENT];
    NvMediaBool roiEnable[NVM_ISP_MAX_LAC_ROI];
    NvMediaISPStatisticsWindows windows[NVM_ISP_MAX_LAC_ROI];
    NvMediaBool ellipticalMaskEnable[NVM_ISP_MAX_LAC_ROI];
    NvMediaISPEllipse ellipticalMask;
} NvMediaISPLocalAvgClipStats;

NvMediaStatus
NvMediaISPSetLocalAvgClipStats(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPLocalAvgClipStats *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    NvMediaRect rectangularMask;
} NvMediaISPBadPixelStats;

NvMediaStatus
NvMediaISPSetBadPixelStats(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPBadPixelStats *controls,
    size_t size
);

typedef struct {
    NvMediaBool enable;
    NvMediaRect rectangularMask;
    NvMediaBool ellipticalMaskEnable;
    NvMediaISPEllipse ellipticalMask;
} NvMediaISPLocalToneMapStats;

NvMediaStatus
NvMediaISPSetLocalToneMapStats(
    NvMediaISPSettings *settings,
    uint32_t instance,
    const NvMediaISPLocalToneMapStats *controls,
    size_t size
);

typedef struct {
    NvMediaImageGroup input;
    NvMediaRect inputCropRect;
    NvMediaImage *output[NVM_ISP_MAX_OUTPUTS];
    NvMediaRect outputCropRect[NVM_ISP_MAX_OUTPUTS];
    NvMediaISPStatsSurface *statsSurface;
    const NvMediaISPSettings *settings;
} NvMediaISPProcessParams;

NvMediaStatus
NvMediaISPProcess(
    NvMediaISP *isp,
    const NvMediaISPProcessParams *params
);

typedef struct {
    uint32_t data[NVM_ISP_HIST_BINS][NVM_ISP_MAX_COLOR_COMPONENT];
    uint32_t excludedCount[NVM_ISP_MAX_COLOR_COMPONENT];
} NvMediaISPHistogramStatsData;

NvMediaStatus
NvMediaISPGetHistogramStatsData(
    NvMediaISPStatsSurface *statsSurface,
    uint32_t instance,
    NvMediaISPHistogramStatsData *statsData
);

typedef struct {
    uint32_t numWindows;
    float_t average[NVM_ISP_MAX_LAC_ROI_WINDOWS][NVM_ISP_MAX_COLOR_COMPONENT];
    uint32_t maskedOffCount[NVM_ISP_MAX_LAC_ROI_WINDOWS][NVM_ISP_MAX_COLOR_COMPONENT];
    uint32_t clippedCount[NVM_ISP_MAX_LAC_ROI_WINDOWS][NVM_ISP_MAX_COLOR_COMPONENT];
} NvMediaISPLocalAvgClipStatsROIData;

typedef struct {
    NvMediaISPLocalAvgClipStatsROIData data[NVM_ISP_MAX_LAC_ROI];
} NvMediaISPLocalAvgClipStatsData;

NvMediaStatus
NvMediaISPGetLocalAvgClipStatsData(
    NvMediaISPStatsSurface *statsSurface,
    uint32_t instance,
    NvMediaISPLocalAvgClipStatsData *statsData
);

typedef struct {
    uint32_t histogram[NVM_ISP_LTM_HIST_BINS];
    float_t localAverageTone[NVM_ISP_LTM_AVG_WINDOWS][NVM_ISP_LTM_AVG_WINDOWS];
    uint32_t nonMaskedCount[NVM_ISP_LTM_AVG_WINDOWS][NVM_ISP_LTM_AVG_WINDOWS];
} NvMediaISPLocalToneMapStatsData;

NvMediaStatus
NvMediaISPGetLocalToneMapStatsData(
    NvMediaISPStatsSurface *statsSurface,
    uint32_t instance,
    NvMediaISPLocalToneMapStatsData *statsData
);

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;
} NvMediaISPBadPixelStatsData;

NvMediaStatus
NvMediaISPGetBadPixelStatsData(
    NvMediaISPStatsSurface *statsSurface,
    uint32_t instance,
    NvMediaISPBadPixelStatsData *statsData
);

#ifdef __cplusplus
};     /* extern "C" */
#endif

#endif /* NVMEDIA_ISP_H */