nvmedia_ldc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2019, 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_LDC_H
#define NVMEDIA_LDC_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_common.h"
#include "nvmedia_core.h"
#include "nvmedia_image.h"
#include "nvmedia_surface.h"

#define NVMEDIA_LDC_VERSION_MAJOR   2

#define NVMEDIA_LDC_VERSION_MINOR   0

typedef struct NvMediaLDC NvMediaLDC;

#define NVMEDIA_LDC_MAX_HOR_REGION    4u

#define NVMEDIA_LDC_MAX_VER_REGION    4u

#define NVMEDIA_LDC_MIN_REGION_WIDTH  64u

#define NVMEDIA_LDC_MIN_REGION_HEIGHT 16u

typedef enum {
    NVMEDIA_LDC_MODE_GEOTRANS,

    NVMEDIA_LDC_MODE_TNR3,

    NVMEDIA_LDC_MODE_GEOTRANS_TNR3,

    NVMEDIA_LDC_MODE_TNR2
} NvMediaLDCMode;

typedef enum {
    NVMEDIA_GEOTRANS_MODE_GEN_MAPPING = 0,

    NVMEDIA_GEOTRANS_MODE_FEED_MAPPING,

    NVMEDIA_GEOTRANS_MODE_AFFINE_TRANSFORM,

    NVMEDIA_GEOTRANS_MODE_PERSPECTIVE_TRANSFORM
} NvMediaGeoTransMode;

typedef enum {
    NVMEDIA_LDC_MODEL_POLYNOMIAL_DISTORTION,

    NVMEDIA_LDC_MODEL_FISHEYE_EQUIDISTANT,

    NVMEDIA_LDC_MODEL_FISHEYE_EQUISOLID,

    NVMEDIA_LDC_MODEL_FISHEYE_ORTHOGRAPHIC,

    NVMEDIA_LDC_MODEL_FISHEYE_STEREOGRAPHIC
} NvMediaLensModel;

typedef struct {
    float_t fx;

    float_t fy;

    float_t cx;

    float_t cy;
} NvMediaCamIntriParams;

typedef struct {
    float_t k1;

    float_t k2;

    float_t k3;

    float_t k4;

    float_t k5;

    float_t k6;

    float_t p1;

    float_t p2;
} NvMediaLensDistortion;

typedef struct {
    NvMediaLensModel model;

    NvMediaLensDistortion distCoeffs;

    NvMediaCamIntriParams K;

    float_t R[3][3];

    float_t T[3];

    NvMediaCamIntriParams targetK;
} NvMediaCameraModel;

typedef struct {
    uint8_t numHorRegion;

    uint8_t numVerRegion;

    uint16_t horRegionWidth[NVMEDIA_LDC_MAX_HOR_REGION];

    uint16_t verRegionHeight[NVMEDIA_LDC_MAX_VER_REGION];

    uint16_t log2horSpace[NVMEDIA_LDC_MAX_HOR_REGION];

    uint16_t log2verSpace[NVMEDIA_LDC_MAX_VER_REGION];
} NvMediaLDCRegionConfig;

typedef struct {
    uint16_t width;

    uint16_t height;

    void *mapPtr;

    NvMediaBool maskedPixelFillColor;
} NvMediaLDCBitMaskMap;

typedef struct {
    NvMediaGeoTransMode geoTransMode;

    NvMediaFilterQuality filter;

    NvMediaCameraModel cameraModel;

    float_t ptMatrix[3][3];

    NvMediaLDCRegionConfig regionConfig;

    float_t maskY;

    float_t maskU;

    float_t maskV;

    NvMediaBool bitMaskEnable;

    NvMediaLDCBitMaskMap bitMaskMap;
} NvMediaGeoTransParams;

typedef struct {
    uint16_t spatialSigmaLuma;

    uint16_t spatialSigmaChroma;

    uint16_t rangeSigmaLuma;

    uint16_t rangeSigmaChroma;

    float_t sadMultiplier;

    float_t sadWeightLuma;

    NvMediaBool alphaSmoothEnable;

    float_t alphaIncreaseCap;

    float_t alphaScaleIIR;

    float_t alphaMaxLuma;

    float_t alphaMinLuma;

    float_t alphaMaxChroma;

    float_t alphaMinChroma;

    float_t betaX1;

    float_t betaX2;

    float_t minBeta;

    float_t maxBeta;
} NvMediaTNR3Params;

typedef struct {
    float_t noiseReduction;
    NvMediaNoiseReductionAlgorithm noiseReductionAlgorithm;
} NvMediaTNR2Params;

typedef struct {
    NvMediaLDCMode ldcMode;

    NvMediaGeoTransParams geoTransParams;

    NvMediaTNR3Params tnr3Params;

    NvMediaTNR2Params tnr2Params;

    NvMediaSurfaceType srcSurfaceType;
} NvMediaLDCInitParams;

typedef enum {
    NVMEDIA_LDC_DATAFORMAT_FLOAT_T,

    NVMEDIA_LDC_DATAFORMAT_FIXEDFLOAT_S15_5
} NvMediaLDCDataFormat;

typedef struct {
    uint16_t numHorPoints;

    uint16_t numVerPoints;

    uint16_t mapStride;

    void *mapPtr;

    NvMediaLDCDataFormat dataFormat;
} NvMediaLDCSparseWarpMap;

typedef enum {
    NVMEDIA_GEOTRANS_DISABLE_XSOBEL_DISABLE_DS = 0,

    NVMEDIA_GEOTRANS_DISABLE_XSOBEL_ENABLE_DS,

    NVMEDIA_GEOTRANS_ENABLE_XSOBEL_DISABLE_DS,

    NVMEDIA_GEOTRANS_ENABLE_XSOBEL_ENABLE_DS
} NvMediaLDCSobelMode;

typedef struct {
    NvMediaLDCSobelMode xSobelMode;
} NvMediaLDCCtrlParams;

NvMediaStatus
NvMediaLDCGetVersion(
    NvMediaVersion *version
);

NvMediaStatus
NvMediaLDCCreateNew(
    const NvMediaDevice *device,
    NvMediaLDC **pldc,
    const uint16_t srcWidth,
    const uint16_t srcHeight,
    const NvMediaRect *srcRect,
    const uint16_t dstWidth,
    const uint16_t dstHeight,
    const NvMediaRect *dstRect,
    const NvMediaLDCInitParams *initParams);

NvMediaStatus
NvMediaLDCDestroy(
    NvMediaLDC *ldc
);

NvMediaStatus
NvMediaLDCFeedSparseWarpMap(
    NvMediaLDC *ldc,
    const NvMediaLDCSparseWarpMap *map);

NvMediaStatus
NvMediaLDCMappingGen(
    NvMediaLDC *ldc);

NvMediaStatus
NvMediaLDCUpdateTNR3Params(
    const NvMediaLDC *ldc,
    const NvMediaTNR3Params *tnr3Params);

NvMediaStatus
NvMediaLDCProcess(
    const NvMediaLDC *ldc,
    NvMediaImage *prevSurface,
    NvMediaImage *curSurface,
    NvMediaImage *outputSurface,
    NvMediaImage *xSobel,
    NvMediaImage *downSample,
    const NvMediaLDCCtrlParams *ldcCtrlParams
);

/*
 * \defgroup history_nvmedia_ldc History
 * Provides change history for the NvMedia LDC API.
 *
 * \section history_nvmedia_ldc Version History
 *
 * <b> Version 1.0 </b> May 1, 2017
 * - Initial release.
 *
 * <b> Version 1.1 </b> March 16, 2018
 * - Add support of TNR2
 *
 * <b> version 1.2 </b> September 4, 2018
 * - New member variable srcSurfaceType is added to NvMediaLDCInitParams.
 *
 * <b> version 1.3 </b> December 26, 2018
 * - Adding unsigned tag to macro constants to fix MISRA 10.4 violation.
 * - Fixing MISRA 21.1 violations
 *
 * <b> version 1.4 </b> January 2, 2019
 * - Added deprecated warning message for \ref NvMediaLDCCreate.
 * - Added API \ref NvMediaLDCCreateNew
 *
 * <b> version 1.5 </b> March 6, 2019
 * - Fixing MISRA 8.13 violations.
 *
 * <b> Version 1.6 </b> March 12, 2019
 * - Added required header includes nvmedia_core.h and nvmedia_surface.h
 *
 * <b> version 2.0 </b> March 29, 2019
 * - Deprecated NvMediaLDCCreate API.
 */

#ifdef __cplusplus
}
#endif

#endif // NvMedia_LDC_H