nvmedia_ipp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-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_IPP_H
#define _NVMEDIA_IPP_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_core.h"
#include "nvmedia_surface.h"
#include "nvmedia_image.h"
#include "nvmedia_icp.h"
#include "nvmedia_isc.h"
#include "nvmedia_isp_legacy.h"

#define NVMEDIA_IPP_VERSION_MAJOR   2u

#define NVMEDIA_IPP_VERSION_MINOR   18u

#define NVMEDIA_IPP_VERSION_INFO    (((uint8_t)'N' << 24) | ((uint8_t)'V' << 16) | (NVMEDIA_IPP_VERSION_MAJOR << 8) | NVMEDIA_IPP_VERSION_MINOR)

typedef void NvMediaIPPManager;

#define NVMEDIA_MAX_COMPONENTS_PER_PIPELINE 32

#define NVMEDIA_MAX_PIPELINES_PER_MANAGER   16

typedef void NvMediaIPPPipeline;

typedef void NvMediaIPPComponent;

typedef enum {
    NVMEDIA_IPP_ISP_VERSION_4,
    NVMEDIA_IPP_ISP_VERSION_5
} NvMediaIPPISPVersion;

typedef enum {
    NVMEDIA_IPP_COMPONENT_ICP = 0,
    NVMEDIA_IPP_COMPONENT_ISP,
    NVMEDIA_IPP_COMPONENT_ALG,
    NVMEDIA_IPP_COMPONENT_ISC,
    NVMEDIA_IPP_COMPONENT_OUTPUT,
    NVMEDIA_IPP_COMPONENT_FILE_READER,
    NVMEDIA_IPP_COMPONENT_ICP_EX,
} NvMediaIPPComponentType;

#define NVMEDIA_IPP_STREAM_MAX_TYPES    2

typedef struct {
    uint32_t frameId;
    uint32_t cameraId;
    NvMediaGlobalTime frameCaptureGlobalTimeStamp;
    NvMediaTimeBase frameCaptureTimeBase;
    uint64_t frameCaptureTSC;
    uint32_t frameSequenceNumber;
} NvMediaIPPImageInformation;

typedef enum {
    NVMEDIA_RAW_PIXEL_ORDER_RGGB = 0,
    NVMEDIA_RAW_PIXEL_ORDER_BGGR,
    NVMEDIA_RAW_PIXEL_ORDER_GRBG,
    NVMEDIA_RAW_PIXEL_ORDER_GBRG,
    NVMEDIA_RAW_PIXEL_ORDER_RCCB,
    NVMEDIA_RAW_PIXEL_ORDER_BCCR,
    NVMEDIA_RAW_PIXEL_ORDER_CRBC,
    NVMEDIA_RAW_PIXEL_ORDER_CBRC,
    NVMEDIA_RAW_PIXEL_ORDER_RCCC,
    NVMEDIA_RAW_PIXEL_ORDER_CCCR,
    NVMEDIA_RAW_PIXEL_ORDER_CRCC,
    NVMEDIA_RAW_PIXEL_ORDER_CCRC,
    NVMEDIA_RAW_PIXEL_ORDER_CCCC,
    NVMEDIA_RAW_PIXEL_ORDER_COUNT
} NvMediaRawPixelOrder;

typedef enum
{
    NVMEDIA_IPP_AE_ANTI_FLICKER_MODE_OFF,
    NVMEDIA_IPP_AE_ANTI_FLICKER_MODE_50Hz,
    NVMEDIA_IPP_AE_ANTI_FLICKER_MODE_60Hz,
    NVMEDIA_IPP_AE_ANTI_FLICKER_MODE_AUTO
} NvMediaIPPAeAntiFlickerMode;

typedef enum
{
    NVMEDIA_IPP_COMPUTED_ANTI_FLICKER_MODE_NONE,
    NVMEDIA_IPP_COMPUTED_ANTI_FLICKER_MODE_50Hz,
    NVMEDIA_IPP_COMPUTED_ANTI_FLICKER_MODE_60Hz
} NvMediaIPPComputedAntiFlicker;

typedef struct
{
    float_t array[4][4];
} NvMediaIPPMathFloatMatrix;

typedef enum
{
    NVMEDIA_IPP_AE_STATE_INACTIVE,
    NVMEDIA_IPP_AE_STATE_SEARCHING,
    NVMEDIA_IPP_AE_STATE_CONVERGED,
    NVMEDIA_IPP_AE_STATE_TIMEOUT
} NvMediaIPPAeState;

typedef enum
{
    NVMEDIA_IPP_AWB_STATE_INACTIVE,
    NVMEDIA_IPP_AWB_STATE_SEARCHING,
    NVMEDIA_IPP_AWB_STATE_CONVERGED,
    NVMEDIA_IPP_AWB_STATE_TIMEOUT
} NvMediaIPPAwbState;

typedef struct
{
    NvMediaBool manualAE;

    NvMediaISCExposureControl exposureControl;

    NvMediaBool manualAWB;

    NvMediaISCWBGainControl wbGains;

    NvMediaIPPAeAntiFlickerMode aeAntiFlickerMode;

    float_t ispDigitalGain;
} NvMediaIPPPropertyControls;

typedef struct
{
    NvMediaIPPAeState aeState;

    NvMediaISCExposureControl exposureControl;

    NvMediaIPPAwbState awbState;

    NvMediaISCWBGainControl wbGains[2];

    float_t ispDigitalGain;

    float_t brightness;

    uint32_t awbCCT;

    NvMediaIPPMathFloatMatrix colorCorrectionMatrix;

    NvMediaIPPComputedAntiFlicker computedAntiFlicker;
} NvMediaIPPPropertyDynamic;

#define NVMEDIA_IPP_MAX_KNEEPOINTS 24

typedef struct
{
    NvMediaISPSize activeArraySize;

    float_t ispMaxDigitalGain;

     unsigned int numKneePoints;

     NvMediaPoint kneePoints[NVMEDIA_IPP_MAX_KNEEPOINTS];

    NvMediaISCModuleConfig *moduleConfig;

} NvMediaIPPPropertyStatic;

typedef enum {
    NVMEDIA_IPP_PIPELINE_PROPERTY_ONLY_EMB_STATS = 0,
    NVMEDIA_IPP_PIPELINE_PROPERTY_TRIGGER_BASED_CAPTURE,
    NVMEDIA_IPP_PIPELINE_PROPERTY_SETTINGS_DELAY,
} NvMediaIPPPipelinePropertyType;

typedef struct {
    NvMediaIPPPipelinePropertyType type;
    void *value;
} NvMediaIPPPipelineProperty;

NvMediaStatus
NvMediaIPPPipelineSetProperties(
    NvMediaIPPPipeline *ippPipeline,
    uint32_t numProperties,
    NvMediaIPPPipelineProperty *properties);

typedef struct {
    NvMediaVersion libVersion;
} NvMediaIPPVersionInfo;

NvMediaStatus
NvMediaIPPGetVersionInfo(
    NvMediaIPPVersionInfo *versionInfo
);

NvMediaIPPManager *
NvMediaIPPManagerCreate(
    uint32_t versionInfo,
    NvMediaDevice *device
);

void
NvMediaIPPManagerDestroy(
    NvMediaIPPManager *ippManager
);

typedef NvMediaStatus NvMediaIPPGetAbsoluteGlobalTime(
        void *clientContext,
        NvMediaGlobalTime *timeValue);

NvMediaStatus
NvMediaIPPManagerSetTimeSource(
    NvMediaIPPManager *ippManager,
    void *clientContext,
    NvMediaIPPGetAbsoluteGlobalTime getAbsoluteGlobalTime
);
NvMediaIPPPipeline *
NvMediaIPPPipelineCreate(
    NvMediaIPPManager *ippManager
);

void
NvMediaIPPPipelineDestroy(
    NvMediaIPPPipeline *ippPipeline
);

NvMediaStatus
NvMediaIPPPipelineSingleCapture(
    NvMediaIPPPipeline *ippPipeline
);

typedef enum {
    NVMEDIA_IPP_EVENT_INFO_EOF,
    NVMEDIA_IPP_EVENT_INFO_PROCESSING_DONE,
    NVMEDIA_IPP_EVENT_INFO_FRAME_CAPTURE,
    NVMEDIA_IPP_EVENT_WARNING_CAPTURE_FRAME_DROP,
    NVMEDIA_IPP_EVENT_ERROR_INTERNAL_FAILURE,
    NVMEDIA_IPP_EVENT_ERROR_I2C_TRANSMISSION_FAILURE,
    NVMEDIA_IPP_EVENT_WARNING_CSI_FRAME_DISCONTINUITY,
    NVMEDIA_IPP_EVENT_ERROR_CSI_INPUT_STREAM_FAILURE
} NvMediaIPPEventType;

typedef struct {
    NvMediaIPPImageInformation imageInformation;
    NvMediaICPErrorInfo captureErrorInfo;
} NvMediaIPPEventData;

typedef void NvMediaIPPEventCallback(
        void *clientContext,
        NvMediaIPPComponentType componentType,
        NvMediaIPPComponent *ippComponent,
        NvMediaIPPEventType eventType,
        NvMediaIPPEventData *eventData);

NvMediaStatus
NvMediaIPPManagerSetEventCallback(
    NvMediaIPPManager *ippManager,
    void *clientContext,
    NvMediaIPPEventCallback eventCallback
);

NvMediaStatus
NvMediaIPPPipelineStart(
    NvMediaIPPPipeline *ippPipeline
);

NvMediaStatus
NvMediaIPPPipelineStop(
    NvMediaIPPPipeline *ippPipeline
);

NvMediaStatus
NvMediaIPPPipelineApplyControlProperties(
    NvMediaIPPPipeline *ippPipeline,
    NvMediaIPPPropertyControls *controlProperties
);

NvMediaStatus
NvMediaIPPPipelineGetStaticProperties(
    NvMediaIPPPipeline *ippPipeline,
    NvMediaIPPPropertyStatic *staticProperties
);

NvMediaStatus
NvMediaIPPPipelineGetDefaultControlsProperties(
    NvMediaIPPPipeline *ippPipeline,
    NvMediaIPPPropertyControls *defaultControlsProperties
);

typedef void NvMediaIPPPlugin;

typedef struct
{
    NvMediaBool enabled;
    union {
        struct {
            NvMediaISPStatsHistogramMeasurement *histogramStats[2];
            NvMediaISPStatsLacMeasurementV4 *lacStats[2];
            NvMediaISPStatsFlickerBandMeasurement *flickerBandStats;
        } v4;
        struct {
            NvMediaISPStatsHistogramMeasurementV5 *histogramStats[2];
            NvMediaISPStatsLacMeasurementV5 *lacStats[2];
            NvMediaISPStatsFlickerBandMeasurementV5 *flickerBandStats;
        } v5;
    };
} NvMediaIPPPluginInputStreamData;

typedef struct
{
    NvMediaIPPImageInformation imageInfo;
    NvMediaIPPPropertyControls *controlsProperties;
    NvMediaISCExposureControl exposureControl;
    NvMediaISCWBGainControl whiteBalanceGainControl[2];
    NvMediaISCEmbeddedDataBuffer topEmbeddedData;
    NvMediaISCEmbeddedDataBuffer bottomEmbeddedData;
    NvMediaIPPPluginInputStreamData streamData[NVMEDIA_IPP_STREAM_MAX_TYPES];
    NvMediaBool firstRun;
     float_t brightness;
} NvMediaIPPPluginInput;

typedef struct
{
    union {
        struct {
            NvMediaBool histogramSettingsValid[2];
            NvMediaISPStatsHistogramSettingsV4 histogramSettings[2];
            NvMediaBool lacSettingsValid[2];
            NvMediaISPStatsLacSettingsV4 lacSettings[2];
            NvMediaBool flickerBandSettingsValid;
            NvMediaISPStatsFlickerBandSettingsV4 flickerBandSettings;
        } v4;
        struct {
            NvMediaBool histogramSettingsValid[2];
            NvMediaISPStatsHistogramSettingsV5 histogramSettings[2];
            NvMediaBool lacSettingsValid[2];
            NvMediaISPStatsLacSettingsV5 lacSettings[2];
            NvMediaBool flickerBandSettingsValid;
            NvMediaISPStatsFlickerBandSettingsV5 flickerBandSettings;
        } v5;
    };
} NvMediaIPPPluginOutputStreamSettings;

#define NVMEDIA_IPP_MAX_EXPOSURE_SETS 8

typedef struct
{
    NvMediaBool useBracketedExp;
    NvMediaIPPAeState aeState;
    uint32_t numExposureControl;
    NvMediaISCExposureControl exposureControl[NVMEDIA_IPP_MAX_EXPOSURE_SETS];
    NvMediaIPPAwbState awbState;
    NvMediaISCWBGainControl whiteBalanceGainControl[2];
    NvMediaIPPMathFloatMatrix colorCorrectionMatrix;
    NvMediaIPPMathFloatMatrix colorCorrectionsMatrixRec2020;
    float_t ispDigitalGain;
    NvMediaIPPPluginOutputStreamSettings streamSettings[NVMEDIA_IPP_STREAM_MAX_TYPES];
    float_t awbCCT;
} NvMediaIPPPluginOutputEx;

typedef NvMediaStatus NvMediaIPPGetSensorAttr(
        NvMediaIPPComponent *parentControlAlgorithmHandle,
        NvMediaISCSensorAttrType type,
        uint32_t size,
        void *attribute);

typedef struct
{
    NvMediaIPPGetSensorAttr *getSensorAttribute;
} NvMediaIPPPluginSupportFuncs;

typedef NvMediaStatus NvMediaIPPluginCreateFunc(
        NvMediaIPPComponent *parentControlAlgorithmHandle,
        NvMediaIPPPluginSupportFuncs *supportFunctions,
        NvMediaIPPPropertyStatic *staticProperties,
        void *clientContext,
        NvMediaIPPPlugin **pluginHandle,
        NvMediaIPPISPVersion ispVersion);

typedef void NvMediaIPPPluginDestroyFunc(
        NvMediaIPPPlugin *pluginHandle);

typedef NvMediaStatus NvMediaIPPPluginProcessExFunc(
        NvMediaIPPPlugin *pluginHandle,
        NvMediaIPPPluginInput *pluginInput,
        NvMediaIPPPluginOutputEx *pluginOutput);
typedef struct
{
    NvMediaIPPluginCreateFunc *createFunc;
    NvMediaIPPPluginDestroyFunc *destroyFunc;
    NvMediaIPPPluginProcessExFunc *processExFunc;
} NvMediaIPPPluginFuncs;

typedef enum {
    NVMEDIA_IPP_PORT_IMAGE_1,
    NVMEDIA_IPP_PORT_IMAGE_2,
    NVMEDIA_IPP_PORT_STATS_1,
    NVMEDIA_IPP_PORT_SENSOR_CONTROL_1,
    NVMEDIA_IPP_PORT_IMAGE_CAPTURE_AGGREGATE
} NvMediaIPPPortType;

typedef struct {
    NvMediaIPPPortType portType;
    uint32_t poolBuffersNum;
    uint32_t width;
    uint32_t height;
    NvMediaSurfaceType surfaceType;
    NvMediaSurfAllocAttr surfAllocAttrs[NVM_SURF_ALLOC_ATTR_MAX];
    uint32_t numSurfAllocAttrs;
    uint32_t imagesCount;
} NvMediaIPPBufferPoolParamsNew;

typedef struct {
    NvMediaIPPPortType portType;
    uint32_t poolBuffersNum;
    struct {
        NvMediaSurfaceType surfaceType;
        NvMediaSurfAllocAttr surfAllocAttrs[NVM_SURF_ALLOC_ATTR_MAX];
        uint32_t numSurfAllocAttrs;
        NvMediaBool topEmbeddedDataValid;
        NvMediaBool bottomEmbeddedDataValid;
    } imageConfig[NVMEDIA_MAX_IMAGE_GROUP_SIZE];
    uint32_t numImageConfigs;
} NvMediaIPPBufferPoolParamsImgGrp;

typedef struct {
    NvMediaICPSettings *settings;
    uint32_t siblingsNum;
} NvMediaIPPIcpComponentConfig;

typedef NvMediaStatus (*NvMediaIPPImgGrpReadCallback)(
        void *clientContext,
        NvMediaImageGroup *imageGroup
);

typedef struct {
    void *clientContext;
    NvMediaIPPImgGrpReadCallback imageGroupReadCallback;
    uint32_t siblingsNum;
} NvMediaIPPFileReaderComponentConfig;

typedef struct {
    NvMediaISCDevice           *iscSensorDevice;
} NvMediaIPPIscComponentConfig;

#define NVMEDIA_IPP_ISP_OUTPUT2_MODE_MASK       (7 << 4)
#define NVMEDIA_IPP_ISP_OUTPUT2_MODE_NONE       0

typedef enum {
    NVMEDIA_IPP_ISP_MODE_NONHDR = (1 << 0),
    NVMEDIA_IPP_ISP_SINGLE_PIPELINE_MODE = (1 << 1),
    NVMEDIA_IPP_ISP_OUTPUT2_MODE_1 = (1 << 4),
    NVMEDIA_IPP_ISP_OUTPUT2_MODE_2 = (2 << 4),
    NVMEDIA_IPP_ISP_OUTPUT2_MODE_3 = (3 << 4),
    NVMEDIA_IPP_ISP_OUTPUT2_MODE_4 = (4 << 4),
    NVMEDIA_IPP_ISP_OUTPUT2_MODE_5 = (5 << 4)
} NvMediaIPPIspAttrFlags;

typedef struct {
    NvMediaISPSelect ispSelect;
    uint32_t ispSettingAttr;
} NvMediaIPPIspComponentConfig;

typedef struct {
    uint32_t width;
    uint32_t height;
    NvMediaRawPixelOrder pixelOrder;
    NvMediaBitsPerPixel bitsPerPixel;
    NvMediaIPPPluginFuncs *pluginFuncs;
    /* Holds client context passed to plugin Control Algorithm. */
    void *clientContext;
    NvMediaISCDevice *iscSensorDevice;
    const char* configOverride;
} NvMediaIPPControlAlgorithmComponentConfig;

typedef enum {
    NVMEDIA_IPP_METADATA_IMAGE_INFO,
    NVMEDIA_IPP_METADATA_CONTROL_PROPERTIES,
    NVMEDIA_IPP_METADATA_DYNAMIC_PROPERTIES,
    NVMEDIA_IPP_METADATA_EMBEDDED_DATA_ISC,
    NVMEDIA_IPP_METADATA_EMBEDDED_DATA_TOP,
    NVMEDIA_IPP_METADATA_EMBEDDED_DATA_BOTTOM,
    NVMEDIA_IPP_METADATA_MAX_TYPES
} NvMediaIPPMetadataType;

uint32_t
NvMediaIPPMetadataGetSize(
    void *metadata,
    NvMediaIPPMetadataType type
);

NvMediaStatus
NvMediaIPPMetadataGet(
    void *metadata,
    NvMediaIPPMetadataType type,
    void *buffer,
    uint32_t size);

NvMediaStatus
NvMediaIPPMetadataGetAddress(
    void *metadata,
    NvMediaIPPMetadataType type,
    void **buffer,
    uint32_t *size);

NvMediaIPPComponent *
NvMediaIPPComponentCreateNew(
    NvMediaIPPPipeline *ippPipeline,
    NvMediaIPPComponentType componentType,
    NvMediaIPPBufferPoolParamsNew **bufferPools,
    void *componentConfig
);

NvMediaIPPComponent *
NvMediaIPPComponentCreateImgGrp(
    NvMediaIPPPipeline *ippPipeline,
    NvMediaIPPComponentType componentType,
    NvMediaIPPBufferPoolParamsImgGrp **bufferPools,
    void *componentConfig
);

NvMediaStatus
NvMediaIPPComponentAddToPipeline(
    NvMediaIPPPipeline *ippPipeline,
    NvMediaIPPComponent *ippComponent);

NvMediaStatus
NvMediaIPPComponentAttach(
    NvMediaIPPPipeline *ippPipeline,
    NvMediaIPPComponent *srcComponent,
    NvMediaIPPComponent *dstComponent,
    NvMediaIPPPortType portType
);

typedef struct {
    NvMediaImage *image;
    void *metadata;
    uint32_t metadataSize;
} NvMediaIPPComponentOutput;

NvMediaStatus
NvMediaIPPComponentGetOutput(
    NvMediaIPPComponent *component,
    uint32_t millisecondTimeout,
    NvMediaIPPComponentOutput *output
);

NvMediaStatus
NvMediaIPPComponentReturnOutput(
    NvMediaIPPComponent *component,
    NvMediaIPPComponentOutput *output
);

typedef struct {
    NvMediaImageGroup imageGroup;
    void *metadata;
    uint32_t metadataSize;
} NvMediaIPPComponentOutputImgGrp;

NvMediaStatus
NvMediaIPPComponentGetOutputImgGrp(
    NvMediaIPPComponent *component,
    uint32_t millisecondTimeout,
    NvMediaIPPComponentOutputImgGrp *output
);

NvMediaStatus
NvMediaIPPComponentReturnOutputImgGrp(
    NvMediaIPPComponent *component,
    NvMediaIPPComponentOutputImgGrp *output
);

void
NvMediaIPPComponentDestroy(
    NvMediaIPPComponent *ippComponent
);
/*
 * \defgroup history_ipp History
 * Provides change history for the NvMedia Image Processing Pipeline API.
 *
 * \section history_ipp Version History
 *
 * <b> Version 1.0 </b> July 8, 2014
 * - Initial release
 *
 * <b> Version 1.1 </b> November 4, 2014
 * - Added IPP control, static and dynamic properties
 *
 * <b> Version 1.2 </b> January 15, 2015
 * - Added fileLoopBackCount to FileReader ComponentConfig
 *
 * <b> Version 1.3 </b> January 16, 2015
 * - Added plugin Control Algorithm related functions and structures
 * - Renamed Camera Driver to Control Algorithm
 * - Added version information to IPP manager create API
 *
 * <b> Version 1.4 </b> January 28, 2015
 * - Added metadata to NvMediaIPPComponentOutput
 *
 * <b> Version 1.5 </b> February 27, 2015
 * - Fixed a typo in NvMediaIPPCompandingControl
 * - Changed pointers in NvMediaIPPPluginOutput to the actual types.
 *
 * <b> Version 1.6 </b> March 25, 2015
 * - Removed list of sensor modes from NvMediaIPPPropertyStatic
 *
 * <b> Version 1.7 </b> March 26, 2015
 * - Added global time-stamp to info structure
 * - Changed the \ref NvMediaIPPGetAbsoluteGlobalTime to use 64-bit
 *   microsecond based time-stamp.
 *
 * <b> Version 1.8 </b> March 30, 2015
 * - Added NVMEDIA_IPP_PORT_IMAGE_CAPTURE_X capture ports
 *
 * <b> Version 1.9 </b> April 14, 2015
 * - Added \ref NvMediaIPPStreamType.
 * - Changed \ref NvMediaIPPPluginInput to have separate stats data for
 *   different streams.
 * - Changed \ref NvMediaIPPPluginOutput to have separate settings for different
 *   streams.
 *
 * <b> Version 1.10 </b> April 23, 2015
 * - Added reserved member to \ref NvMediaIPPLensShadingControl structure to
 *   resolve C and C++ structure size differences.
 *
 * <b> Version 1.11 </b> April 29, 2015
 * - Removed dynamicProperties from \ref NvMediaIPPPluginOutput structure
 * - Added aeLock, aeState, awbLock & awbState in \ref NvMediaIPPPluginOutput
 *   structure.
 *
 * <b> Version 1.12 </b> May 26, 2015
 * - Updated \ref NvMediaIPPEventCallback callback API
 *
 * <b> Version 1.13 </b> June 16, 2015
 * - Added port type NVMEDIA_IPP_PORT_IMAGE_CAPTURE_AGGREGATE
 * - Added metadataFileName to \ref NvMediaIPPFileWriterComponentConfig
 *
 * <b> Version 1.14 </b> July 17, 2015
 * - Added iscSensorDevice to \ref NvMediaIPPFileReaderComponentConfig,
 *   \ref NvMediaIPPIcpComponentConfig and
 *   \ref NvMediaIPPControlAlgorithmComponentConfig.
 *
 * <b> Version 1.15 </b> September 4, 2015
 * - Added sensorMode to \ref NvMediaIPPExposureControl
 *
 * <b> Version 1.16 </b> September 4, 2015
 * - Added NVMEDIA_IPP_EVENT_WARNING_CAPTURE_RECOVERY to
 *   \ref NvMediaIPPEventType.
 *
 * <b> Version 1.17 </b> December 8, 2015
 * - Removed ISP control functions.
 * - Added ISP version 4 support.
 *
 * <b> Version 1.18 </b> January 7, 2016
 * - Added ChannelGainRatio (Gain ratio between exposure channels).
 *
 * <b> Version 1.19 </b> January 27, 2016
 * - Added \ref NvMediaIPPPropertyStatic to \ref NvMediaIPPPluginInput.
 *
 * <b> Version 1.20 </b> Jan 27, 2016
 * - Added firstRun flag to \ref NvMediaIPPPluginInput.
 *
 * <b> Version 1.21 </b> March 11, 2016
 * - Increased maximum IPP pipelines in IPP manager to 12.
 *
 * <b> Version 1.22 </b> March 28, 2016
 * - Added NVMEDIA_IPP_EVENT_ERROR_I2C_TRANSMISSION_FAILURE event type.
 *
 * <b> Version 1.23 </b> March 29, 2016
 * - Added \ref NVMEDIA_IPP_MAX_LTM_DATA_SIZE define for max LTM data size.
 *
 * <b> Version 1.24 </b> May 3, 2016
 * - Added \ref NvMediaIPPIspAttrFlags to \ref NvMediaIPPIspComponentConfig.
 *
 * <b> Version 1.25 </b> May 4, 2016
 * - Added ModuleConfig to static properties
 *
 * <b> Version 1.26 </b> May 11, 2016
 * - Changed \ref NvMediaIPPImageInformation frameSequenceNumber type to
 *   unsigned int.
 *
 * <b> Version 1.27 </b> May 23, 2016
 * - Added NVMEDIA_IPP_EVENT_WARNING_CSI_DISCONTINUITY to
 *   \ref NvMediaIPPEventType.
 *
 * <b> Version 1.28 </b> June 16, 2016
 * - Added NVMEDIA_IPP_COMPONENT_CAPTURE_EX component for virtual channels
 *   capture support.
 *
 * <b> Version 1.29 </b> June 24, 2016
 * - Added \ref NvMediaIPPPipelineSetProperties new API to set pipeline
 *   properties.
 *
 * <b> Version 1.30 </b> June 29, 2016
 * - Added \ref NvMediaIPPPluginProcessExFunc new plugin process function for
 *   bracketed exposure.
 *
 * <b> Version 1.31 </b> July 18, 2016
 * - Added support for event based capture \ref NvMediaIPPPipelineSingleCapture.
 *
 * <b> Version 1.32 </b> September 12, 2016
 * - Added \ref NVMEDIA_IPP_PIPELINE_PROPERTY_SETTINGS_DELAY property to support
 *   sensor without embedded lines
 *
 * <b> Version 1.33 </b> October 10, 2016
 * - Added new support function for getting sensor attributes
 *   \ref NvMediaIPPGetSensorAttr.
 *
 * <b> Version 1.34 </b> February 3, 2017
 * - Added \ref NVMEDIA_IPP_METADATA_EMBEDDED_DATA_ISC for ISC embedded data
 *   inside \ref NvMediaIPPMetadataType.
 *
 * <b> Version 1.35 </b> March 10, 2017
 * - Added capture error info in \ref NvMediaIPPEventData
 * - Added new event type for CSI input stream error in \ref NvMediaIPPEventType
 *
 * <b> Version 1.36 </b> March 31, 2017
 * - Removed ISP stats version 3 support from
 *   \ref NvMediaIPPPluginOutputStreamSettings
 *   and \ref NvMediaIPPPluginInputStreamData.
 *
 * <b> Version 1.37 </b> April 13, 2017
 * - Fixed violation MISRA-C rule 10.1 in NVMEDIA_IPP_VERSION_INFO macro.
 *
 * <b> Version 2.00 </b> April 27, 2017
 * - Removed PRE_PROCESSING, POST_PROCESSING & DISPLAY components
 * - Removed ipaDevice argument from \ref NvMediaIPPManagerCreate
 * - Removed iscSensorDevice & registerImageBuffersWithIPA from CAPTURE &
 *   FILE_READER component config.
 * - Removed iscRootDevice, iscAggregatorDevice & iscSerializerDevice from ISC
 *   component config.
 * - Removed ispSettingsFile & registerImageBuffersWithIPA from ISP component
 *   config.
 * - Removed logging callback \ref NvMediaIPPPluginSupportFuncs
 * - Removed parseConfigurationFunc from \ref NvMediaIPPPluginFuncs
 * - Removed IPP session related APIs. Use
 *   \ref NvMediaIPPPipelineApplyControlProperties to apply control properties.
 * - Removed unused data structures & enums
 * - Removed captureIntent, aeExposureCompensation, requestId from
 *   \ref NvMediaIPPPropertyControls.
 * - Removed exposureTimeRange from \ref NvMediaIPPPropertyControls use
 *   GetSensorAttr API to get the exposure time range.
 * - Removed companding control from \ref NvMediaIPPPluginInput.
 * - Removed lens shading from \ref NvMediaIPPPluginOutput &
 *   \ref NvMediaIPPPluginOutputEx.
 * - Removed ISP stats version 3 support from
 *   \ref NvMediaIPPPluginOutputStreamSettings
     and \ref NvMediaIPPPluginInputStreamData.
 *
 * <b> Version 2.01 </b> May 5, 2017
 * - Removed NvMediaICPInterfaceFormat from \ref NvMediaIPPIcpComponentConfig
 *
 * <b> Version 2.02 </b> April 27, 2017
 * - Replaced NvMediaIPPExposureControl with NvMediaISCExposureControl
     - ISP digital gain is added in impacted plugin structures
     - Sensor mode & hdrRatio have been removed
 * - Replaced NvMediaIPPWBGainControl use NvMediaISCWBGainControl
 * - Removed NvMediaIPPSensorExposureMode use NvMediaISCExposureMode
 * - Removed notion of human & machine vision streams
 * - Removed NvMediaIPPCameraSensorMode
     - ActiveArraySize is added in NvMediaIPPPropertyStatic
     - For frame rate use GetSensorAttr API
     - Suface type have been removed
 * - Removed AE & AWB lock flags
 * - Removed valid flag for color correction
 * - Removed requestId from NvMediaIPPPropertyDynamic
 * - Removed sensorCFA from NvMediaIPPPropertyStatic
 * - Removed exposure time range & sensor analog gain range &
     channelGainRaio from NvMediaIPPPropertyStatic use GetSensorAttr API
 *
 * <b> Version 2.03 </b> May 15, 2017
 * - Added deprecated warning message for \ref NvMediaIPPComponentCreate
 *
 * <b> Version 2.04 </b> May 23, 2017
 * - Replaced NvMediaIPPEmbeddedDataInformation with
 *   \ref NvMediaISCEmbeddedDataBuffer.
 * - Removed frameCaptureTimeStamp from NvMediaIPPImageInformation
 * - Removed AE & AWB modes and replaced with NvMediaBool
 * - Removed unused event types.
 * - Removed NVMEDIA_IPP_PORT_IMAGE_CAPTURE_* ports use Image ports
 * - Renamed NVMEDIA_IPP_COMPONENT_CAPTURE to NVMEDIA_IPP_COMPONENT_ICP
 * - Renamed NVMEDIA_IPP_COMPONENT_CONTROL_ALGORITHM to
 *   NVMEDIA_IPP_COMPONENT_ALG.
 * - Renamed NVMEDIA_IPP_COMPONENT_SENSOR_CONTROL to NVMEDIA_IPP_COMPONENT_ISC.
 * - Renamed NVMEDIA_IPP_COMPONENT_CAPTURE_EX to NVMEDIA_IPP_COMPONENT_ICP.
 * - Changed \ref NvMediaIPPPluginInputStreamData &
 *   \ref NvMediaIPPPluginOutputStreamSettings to have union for all stats.
 *
 * <b> Version 2.05 </b> May 17, 2017
 * - Added companding params in \ref NvMediaIPPPropertyStatic.
 * - Added brightness value in \ref NvMediaIPPPluginInputEx.
 * - Added awbCCT value in \ref NvMediaIPPPluginOutputEx.
 * - Renamed CurrentSceneLux to brightness in \ref NvMediaIPPPropertyDynamic.
 * - Changed whiteBalanceGainControl to be an array of two in
 *   \ref NvMediaIPPPluginOutputEx.
 * - Removed \ref NvMediaIPPPluginOutput struct and processFunc in
 *   \ref NvMediaIPPPluginFuncs.
 * - Added useBracketedExp flag in \ref NvMediaIPPPluginInputEx.
 *
 * <b> Version 2.06 </b> June 27, 2017
 * - Added file read callback functions
 *
 * <b> Version 2.07 </b> July 28, 2017
 * - Removed deprecated file writer component
 *
 * <b> Version 2.08 </b> Aug 17, 2017
 * - Add ISP Version 5 Stats structs to Plugin Interface
 * - Update NvMediaIPPISPVersion enum to add NVMEDIA_IPP_ISP_VERSION_5
 *
 * <b> Version 2.09 </b> August 25, 2017
 * - Add new APIs to support \ref NvMediaImageGroup.
 *
 * <b> Version 2.10 </b> September 05, 2017
 * - Add colorCorrectionsMatrixRec2020 in \ref NvMediaIPPPluginOutputEx.
 *
 * <b> Version 2.11 </b> September 07, 2017
 * - Add new attribute flags in \ref NvMediaIPPIspAttrFlags.
 *
 * <b> Version 2.12 </b> September 12, 2017
 * - Deprecated \ref NvMediaIPPBufferPoolParams, \ref NvMediaIPPComponentCreate
 *
 * <b> Version 2.13 </b> September 14, 2017
 * - Added frameCaptureTimeBase member to \ref NvMediaIPPImageinformation
 *
 * <b> Version 2.14 </b> September 25, 2017
 * - Add new ISP attribute flags in \ref NvMediaIPPIspAttrFlags.
 *
 * <b> Version 2.15 </b> October 13, 2017
 * - Remove NVMEDIA_IPP_METADATA_LTM_DATA metadata enum
 * - Remove NVMEDIA_IPP_MAX_LTM_DATA_SIZE define
 *
 * <b> Version 2.16 </b> January 19, 2018
 * - Added frameCaptureTSC for TSC value in \ref NvMediaIPPImageinformation
 *
 * <b> Version 2.17 </b> November 2, 2018
 * - Updated Maximum number of IPP Pipelines in IPP pipeline manager from 12 to 16.
 * - Fix comments associated with NVMEDIA_MAX_PIPELINES_PER_MANAGER
 *   & NVMEDIA_MAX_COMPONENTS_PER_PIPELINE
 *
 * <b> Version 2.18 </b> April 4, 2019
 * - Add \ref NvMediaRawPixelOrder
 */
#ifdef __cplusplus
};     /* extern "C" */
#endif

#endif /* _NVMEDIA_IPP_H */