Detailed Description

The Image Signal Processing API encompasses all NvMedia image processing functions that are necessary to produce a processed image from image data captured from an image sensor.

Data Structures
struct	NvMediaISPLinearization
	Holds controls for ISP linearization (LIN) block. More...

struct	NvMediaISPBlackLevelCorrection
	Holds controls for ISP black level correction (BLC) block. More...

struct	NvMediaISPWhiteBalanceCorrection
	Holds controls for ISP white balance correction (WBC) block. More...

struct	NvMediaISPExposureFusion
	Holds controls for ISP exposure fusion (Fusion) block. More...

struct	NvMediaISPBadPixelCorrection
	Holds controls for ISP bad pixel correction (BPC) block. More...

struct	NvMediaISPSplineControlPoint
	Defines spline control point. More...

struct	NvMediaISPEllipse
	Defines an ellipse. More...

struct	NvMediaISPRadialTF
	Defines a radial transform. More...

struct	NvMediaISPLensShadingCorrection
	Holds controls for ISP lens shading correction (LSC) block. More...

struct	NvMediaISPDemosaic
	Holds controls for ISP demosaic (DM) block. More...

struct	NvMediaISPLevelAdjSat
	Holds controls for ISP level adjusted saturation (LAS) block. More...

struct	NvMediaISPNoiseReduction
	Holds controls for ISP noise reduction (NR) block. More...

struct	NvMediaISPColorCorrectionMatrix
	Holds controls for ISP color correction matrix (CCM) block. More...

struct	NvMediaISPGlobalToneMap
	Holds controls for ISP global tone map (GTM) block. More...

struct	NvMediaISPLocalToneMap
	Holds controls for ISP local tone map (LTM) block. More...

struct	NvMediaISPColorSpaceConversion
	Holds controls for ISP color space conversion (CSC) block. More...

struct	NvMediaISPSaturation
	Holds controls for ISP saturation (SAT) block. More...

struct	NvMediaISPSharpness
	Holds controls for ISP sharpness (Sharp) block. More...

struct	NvMediaISPDownscale
	Holds controls for ISP downscale (DS) block. More...

struct	NvMediaISPClip
	Holds controls for ISP clip (Clip) block. More...

struct	NvMediaISPOffset
	Holds controls for ISP offset (Offset) block. More...

struct	NvMediaISPDigitalGain
	Holds controls for ISP digital gain (DG) block. More...

struct	NvMediaISPHistogramStats
	Holds controls for histogram statistics (HIST Stats). More...

struct	NvMediaISPStatisticsWindows
	Defines the windows used in ISP stats calculations. More...

struct	NvMediaISPLocalAvgClipStats
	Holds controls for local average & clip statistics (LAC Stats) More...

struct	NvMediaISPBadPixelStats
	Holds controls for bad pixel statistics (BP Stats). More...

struct	NvMediaISPLocalToneMapStats
	Holds controls for local tone map statistics (LTM Stats). More...

struct	NvMediaISPProcessParams
	Holds ISP processing parameters. More...

struct	NvMediaISPHistogramStatsData
	Holds histogram statistics (HIST Stats) data. More...

struct	NvMediaISPLocalAvgClipStatsROIData
	Holds local average & clip statistics data for a region of interest. More...

struct	NvMediaISPLocalAvgClipStatsData
	Holds local average & clip statistics block (LAC Stats) data. More...

struct	NvMediaISPLocalToneMapStatsData
	Holds local tone map statistics block (LTM Stats) data. More...

struct	NvMediaISPBadPixelStatsData
	Holds bad pixel statistics (BP Stats) data. More...

Macros
#define	NVM_ISP_VERSION_MAJOR 1
	Major Version number. More...

#define	NVM_ISP_VERSION_MINOR 0
	Minor Version number. More...

#define	NVM_ISP_MAX_OUTPUTS (3u)
	Maximum supported simultaneous outputs. More...

#define	NVM_ISP_MAX_INPUT_PLANES (3u)
	Maximum number of input planes. More...

#define	NVM_ISP_MAX_QUEUED_REQUESTS (32u)
	Maximum number of queued requests. More...

#define	NVM_ISP_MAX_COLOR_COMPONENT (4u)
	Maximum number of color components. More...

#define	NVM_ISP_RADTF_POINTS (6u)
	Number of radial transfer function control points. More...

#define	NVM_ISP_MAX_LIN_KNEE_POINTS (10u)
	Maximum number of linearization knee points. More...

#define	NVM_ISP_LAS_TF_POINTS (9u)
	Number of transfer function control points for level adjusted saturation block. More...

#define	NVM_ISP_GTM_TF_POINTS (18u)
	Number of transfer function control points for global tone map. More...

#define	NVM_ISP_LTM_SOFT_KEY_WIDTH (8u)
	Local tone map soft key width. More...

#define	NVM_ISP_LTM_SOFT_KEY_HEIGHT (8u)
	Local tone map soft key height. More...

#define	NVM_ISP_LTM_GAIN_POINTS (9u)
	Local tone map gain points. More...

#define	NVM_ISP_HIST_KNEE_POINTS (8u)
	Number of histogram knee points. More...

#define	NVM_ISP_MAX_LAC_ROI (4u)
	Maximum number of local average & clip stats block regions of interest. More...

#define	NVM_ISP_MAX_LAC_ROI_WINDOWS (32u * 32u)
	Maximum number of windows for local average & clip in a region of interest. More...

#define	NVM_ISP_HIST_BINS (256u)
	Number of bins for histogram. More...

#define	NVM_ISP_LTM_HIST_BINS (128u)
	Number of histogram bins for local tone map stats block. More...

#define	NVM_ISP_LTM_AVG_WINDOWS (8u)
	Number of averaging windows for local tone map stats block. More...

Typedefs
typedef struct _NvMediaISP	NvMediaISP
	A handle representing ISP object. More...

typedef struct _NvMediaISPStatsSurface	NvMediaISPStatsSurface
	A handle representing ISP stats surface object. More...

typedef struct _NvMediaISPSettings	NvMediaISPSettings
	A handle representing ISP settings object. More...

Enumerations
enum	NvMediaISPPipelineEnum { NVM_ISP_PIPELINE_X1 = (('X' << 24) \| 0x01) }
	Defines supported ISP pipelines. More...

enum	NvMediaISPExposureFusionMode { 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 }
	Defines supported exposure fusion modes. More...

Functions
NvMediaStatus	NvMediaISPGetVersion (NvMediaVersion *version)
	Gives the version information for the NvMedia ISP library. More...

NvMediaISP *	NvMediaISPCreate (uint32_t instanceId, NvMediaISPPipelineEnum pipelineEnum, uint32_t maxQueuedRequests)
	Allocates an Image Signal Processing object. More...

NvMediaStatus	NvMediaISPStop (NvMediaISP *isp)
	Stops the image processing. More...

NvMediaStatus	NvMediaISPDestroy (NvMediaISP *isp)
	Destroys an Image Signal Processing object. More...

NvMediaISPStatsSurface *	NvMediaISPStatsSurfaceCreate (NvMediaISP *isp)
	Allocates an ISP statistics surface object. More...

NvMediaStatus	NvMediaISPStatsSurfaceDestroy (NvMediaISPStatsSurface *statsSurface)
	Destroys an ISP statistics surface object. More...

NvMediaISPSettings *	NvMediaISPSettingsCreate (NvMediaISP *isp, NvMediaISPPipelineEnum pipelineEnum)
	Allocates an ISP settings object. More...

NvMediaStatus	NvMediaISPSettingsDestroy (NvMediaISPSettings *settings)
	Destroys an ISP settings object. More...

NvMediaStatus	NvMediaISPSetLinearization (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPLinearization controls, size_t size)
	Programs linearizartion block controls. More...

NvMediaStatus	NvMediaISPSetBlackLevelCorrection (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPBlackLevelCorrection controls, size_t size)
	Programs black level correction block controls. More...

NvMediaStatus	NvMediaISPSetWhiteBalanceCorrection (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPWhiteBalanceCorrection controls, size_t size)
	Programs white balance correction block controls. More...

NvMediaStatus	NvMediaISPSetExposureFusion (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPExposureFusion controls, size_t size)
	Programs exposure fusion block controls. More...

NvMediaStatus	NvMediaISPSetBadPixelCorrection (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPBadPixelCorrection controls, size_t size)
	Programs bad pixel correction block controls. More...

NvMediaStatus	NvMediaISPSetLensShadingCorrection (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPLensShadingCorrection controls, size_t size)
	Programs lens shading correction block controls. More...

NvMediaStatus	NvMediaISPSetDemosaic (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPDemosaic controls, size_t size)
	Programs demosaic block controls. More...

NvMediaStatus	NvMediaISPSetLevelAdjSat (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPLevelAdjSat controls, size_t size)
	Programs level adjusted saturation block controls. More...

NvMediaStatus	NvMediaISPSetNoiseReduction (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPNoiseReduction controls, size_t size)
	Programs noise reduction block controls. More...

NvMediaStatus	NvMediaISPSetColorCorrectionMatrix (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPColorCorrectionMatrix controls, size_t size)
	Programs color correction matrix block controls. More...

NvMediaStatus	NvMediaISPSetGlobalToneMap (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPGlobalToneMap controls, size_t size)
	Programs global tone map block controls. More...

NvMediaStatus	NvMediaISPSetLocalToneMap (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPLocalToneMap controls, size_t size)
	Programs local tone map block controls. More...

NvMediaStatus	NvMediaISPSetColorSpaceConversion (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPColorSpaceConversion controls, size_t size)
	Programs color space conversion block controls. More...

NvMediaStatus	NvMediaISPSetInvColorSpaceConversion (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPColorSpaceConversion controls, size_t size)
	Programs inverse color space conversion block controls. More...

NvMediaStatus	NvMediaISPSetSaturation (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPSaturation controls, size_t size)
	Programs saturation block controls. More...

NvMediaStatus	NvMediaISPSetSharpness (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPSharpness controls, size_t size)
	Programs sharpness block controls. More...

NvMediaStatus	NvMediaISPSetDownscale (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPDownscale controls, size_t size)
	Programs downscale block controls. More...

NvMediaStatus	NvMediaISPSetClip (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPClip controls, size_t size)
	Programs clip block controls. More...

NvMediaStatus	NvMediaISPSetOffset (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPOffset controls, size_t size)
	Programs offset block controls. More...

NvMediaStatus	NvMediaISPSetDigitalGain (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPDigitalGain controls, size_t size)
	Programs digital gain block controls. More...

NvMediaStatus	NvMediaISPSetHistogramStats (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPHistogramStats controls, size_t size)
	Programs histogram statistics block controls. More...

NvMediaStatus	NvMediaISPSetLocalAvgClipStats (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPLocalAvgClipStats controls, size_t size)
	Programs local average and clip statistics block controls. More...

NvMediaStatus	NvMediaISPSetBadPixelStats (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPBadPixelStats controls, size_t size)
	Programs bad pixel statistics block controls. More...

NvMediaStatus	NvMediaISPSetLocalToneMapStats (NvMediaISPSettings settings, uint32_t instance, const NvMediaISPLocalToneMapStats controls, size_t size)
	Programs local tone map statistics block controls. More...

NvMediaStatus	NvMediaISPProcess (NvMediaISP isp, const NvMediaISPProcessParams params)
	ISP processing function. More...

NvMediaStatus	NvMediaISPGetHistogramStatsData (NvMediaISPStatsSurface statsSurface, uint32_t instance, NvMediaISPHistogramStatsData statsData)
	Gets the histogram statistics data. More...

NvMediaStatus	NvMediaISPGetLocalAvgClipStatsData (NvMediaISPStatsSurface statsSurface, uint32_t instance, NvMediaISPLocalAvgClipStatsData statsData)
	Gets the local average & clip statistics data. More...

NvMediaStatus	NvMediaISPGetLocalToneMapStatsData (NvMediaISPStatsSurface statsSurface, uint32_t instance, NvMediaISPLocalToneMapStatsData statsData)
	Gets the local tone map statistics data. More...

NvMediaStatus	NvMediaISPGetBadPixelStatsData (NvMediaISPStatsSurface statsSurface, uint32_t instance, NvMediaISPBadPixelStatsData statsData)
	Gets the bad pixel statistics data. More...

Macro Definition Documentation

#define NVM_ISP_GTM_TF_POINTS (18u)

Number of transfer function control points for global tone map.

Definition at line 83 of file nvmedia_isp.h.

#define NVM_ISP_HIST_BINS (256u)

Number of bins for histogram.

Definition at line 119 of file nvmedia_isp.h.

#define NVM_ISP_HIST_KNEE_POINTS (8u)

Number of histogram knee points.

Definition at line 103 of file nvmedia_isp.h.

#define NVM_ISP_LAS_TF_POINTS (9u)

Number of transfer function control points for level adjusted saturation block.

Definition at line 78 of file nvmedia_isp.h.

#define NVM_ISP_LTM_AVG_WINDOWS (8u)

Number of averaging windows for local tone map stats block.

Definition at line 129 of file nvmedia_isp.h.

#define NVM_ISP_LTM_GAIN_POINTS (9u)

Local tone map gain points.

Definition at line 98 of file nvmedia_isp.h.

#define NVM_ISP_LTM_HIST_BINS (128u)

Number of histogram bins for local tone map stats block.

Definition at line 124 of file nvmedia_isp.h.

#define NVM_ISP_LTM_SOFT_KEY_HEIGHT (8u)

Local tone map soft key height.

Definition at line 93 of file nvmedia_isp.h.

#define NVM_ISP_LTM_SOFT_KEY_WIDTH (8u)

Local tone map soft key width.

Definition at line 88 of file nvmedia_isp.h.

#define NVM_ISP_MAX_COLOR_COMPONENT (4u)

Maximum number of color components.

Definition at line 62 of file nvmedia_isp.h.

#define NVM_ISP_MAX_INPUT_PLANES (3u)

Maximum number of input planes.

Definition at line 52 of file nvmedia_isp.h.

#define NVM_ISP_MAX_LAC_ROI (4u)

Maximum number of local average & clip stats block regions of interest.

Definition at line 108 of file nvmedia_isp.h.

#define NVM_ISP_MAX_LAC_ROI_WINDOWS (32u * 32u)

Maximum number of windows for local average & clip in a region of interest.

Definition at line 114 of file nvmedia_isp.h.

#define NVM_ISP_MAX_LIN_KNEE_POINTS (10u)

Maximum number of linearization knee points.

Definition at line 72 of file nvmedia_isp.h.

#define NVM_ISP_MAX_OUTPUTS (3u)

Maximum supported simultaneous outputs.

Definition at line 47 of file nvmedia_isp.h.

#define NVM_ISP_MAX_QUEUED_REQUESTS (32u)

Maximum number of queued requests.

Definition at line 57 of file nvmedia_isp.h.

#define NVM_ISP_RADTF_POINTS (6u)

Number of radial transfer function control points.

Definition at line 67 of file nvmedia_isp.h.

#define NVM_ISP_VERSION_MAJOR 1

Major Version number.

Definition at line 39 of file nvmedia_isp.h.

#define NVM_ISP_VERSION_MINOR 0

Minor Version number.

Definition at line 42 of file nvmedia_isp.h.

Typedef Documentation

typedef struct _NvMediaISP NvMediaISP

A handle representing ISP object.

Definition at line 134 of file nvmedia_isp.h.

typedef struct _NvMediaISPSettings NvMediaISPSettings

A handle representing ISP settings object.

Definition at line 144 of file nvmedia_isp.h.

typedef struct _NvMediaISPStatsSurface NvMediaISPStatsSurface

A handle representing ISP stats surface object.

Definition at line 139 of file nvmedia_isp.h.

Enumeration Type Documentation

enum NvMediaISPExposureFusionMode

Defines supported exposure fusion modes.

Enumerator
NVM_ISP_EXP_FUSION_USE_0	Specifies use plane 0.
NVM_ISP_EXP_FUSION_USE_1	Specifies use plane 1.
NVM_ISP_EXP_FUSION_USE_2	Specifies use plane 2.
NVM_ISP_EXP_FUSION_BLEND_01	Specifies blend plane 0 & 1.
NVM_ISP_EXP_FUSION_BLEND_ALL	Specifies blend all planes.

Definition at line 396 of file nvmedia_isp.h.

enum NvMediaISPPipelineEnum

Defines supported ISP pipelines.

Enumerator
NVM_ISP_PIPELINE_X1	Xavier ISP pipeline.

Definition at line 149 of file nvmedia_isp.h.

Function Documentation

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

Allocates an Image Signal Processing object.

Parameters

[in]	instanceId	ISP instance ID. Valid values: 0
[in]	pipelineEnum	ISP pipeline configuration.
[in]	maxQueuedRequests	Determines number of processing requests can be pending for an ISP instance at a time. Supported values: [1, NVM_ISP_MAX_QUEUED_REQUESTS]

Returns: NvMediaISP handle to specified isp engine instance or NULL if unsuccessful.

NvMediaStatus NvMediaISPDestroy ( NvMediaISP * isp )

Destroys an Image Signal Processing object.

Parameters

[in] isp ISP object.

Returns

NvMediaStatus The status of the operation. Possible values are:

NVMEDIA_STATUS_OK
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer is NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Gets the bad pixel statistics data.

Parameters

[in]	statsSurface	A pointer to a statistics surface.
[in]	instance	Instance of the block to get statistics.
[in,out]	statsData	A pointer to bad pixel statistics data.

Returns

NvMediaStatus The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if any of the input arguments were invalid.
NVMEDIA_STATUS_ERROR if there is any error.

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

Gets the histogram statistics data.

Parameters

[in]	statsSurface	Statistics surface.
[in]	instance	Instance of the block to get statistics.
[in,out]	statsData	A pointer to histogram statistics data.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if any of the input arguments were invalid.
NVMEDIA_STATUS_ERROR if there is any error.

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

Gets the local average & clip statistics data.

Parameters

[in]	statsSurface	A pointer to a statistics surface.
[in]	instance	Instance of the block to get statistics.
[in,out]	statsData	A pointer to local average & clip statistics data.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if any of the input arguments were invalid.
NVMEDIA_STATUS_ERROR if there is any error.

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

Gets the local tone map statistics data.

Parameters

[in]	statsSurface	A pointer to a statistics surface.
[in]	instance	Instance of the block to get statistics.
[in,out]	statsData	A pointer to local tone map statistics data.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if any of the input arguments were invalid.
NVMEDIA_STATUS_ERROR if there is any error.

NvMediaStatus NvMediaISPGetVersion ( NvMediaVersion * version )

Gives the version information for the NvMedia ISP library.

Parameters

[in,out] version NvMediaVersion structure which will be populated.

Returns: NvMediaStatus The status of the operation. Possible values are:
NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the pointer was invalid.

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

ISP processing function.

Parameters

[in]	isp	ISP object.
[in]	params	ISP processing parameters.

Returns

NvMediaStatus The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if any of the input arguments were invalid.
NVMEDIA_STATUS_ERROR if there is any error.

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

Programs bad pixel correction block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a control structure for a bad pixel correction block.
[in]	size	Size of the bad pixel correction block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs bad pixel statistics block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a control structure for a bad pixel statistics block.
[in]	size	Size of the bad pixel statistics block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs black level correction block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a black level correction block.
[in]	size	Size of the black level correction block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs clip block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a clip block.
[in]	size	Size of the clip block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs color correction matrix block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a color correction matrix block.
[in]	size	Size of the color correction matrix block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs color space conversion block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a color space conversion block.
[in]	size	Size of the color space conversion block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs demosaic block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a demosaic block.
[in]	size	Size of the demosaic block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs digital gain block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a digital gain block.
[in]	size	Size of the digital gain block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs downscale block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a downscale block.
[in]	size	Size of the downscale block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs exposure fusion block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for an exposure fusion block.
[in]	size	Size of the exposure fusion block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs global tone map block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a global tone map block.
[in]	size	Size of the global tone map block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs histogram statistics block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a histogram statistics block.
[in]	size	Size of the histogram statistics block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs inverse color space conversion block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for an inverse color space conversion block.
[in]	size	Size of the inverse color space conversion block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs lens shading correction block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a lens shading correction block.
[in]	size	Size of the lens shading correction block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs level adjusted saturation block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a level adjusted saturation block.
[in]	size	Size of the level adjusted saturation block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs linearizartion block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a linearization block.
[in]	size	Size of the linearization block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs local average and clip statistics block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a local average and clip statistics block.
[in]	size	Size of the local average and clip statistics block control structure.

Returns

NvMediaStatus The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs local tone map block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a local tone map block.
[in]	size	Size of the local tone map block control structure.

Returns

NvMediaStatus The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs local tone map statistics block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a local tone map statistics block.
[in]	size	Size of the local tone map statistics block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs noise reduction block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a noise reduction block.
[in]	size	Size of the noise reduction block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs offset block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for an offset block.
[in]	size	Size of the offset block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs saturation block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a saturation block.
[in]	size	Size of the saturation block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

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

Programs sharpness block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a sharpness block.
[in]	size	Size of the sharpness block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

NvMediaISPSettings* NvMediaISPSettingsCreate	(	NvMediaISP *	isp,
		NvMediaISPPipelineEnum	pipelineEnum
	)

Allocates an ISP settings object.

Parameters

[in]	isp	ISP object.
[in]	pipelineEnum	ISP pipeline configuration, reserved for future extension. For now this must be same as value given in NvMediaISPCreate

Returns: NvMediaISPSettings handle to ISP settings object or NULL if unsuccessful.

NvMediaStatus NvMediaISPSettingsDestroy ( NvMediaISPSettings * settings )

Destroys an ISP settings object.

Parameters

[in] settings ISP settings object to destroy.

Returns

NvMediaStatus The status of the operation.

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if any of the input arguments were invalid.
NVMEDIA_STATUS_ERROR if there is any error.

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

Programs white balance correction block controls.

Parameters

[in]	settings	Handle representing the ISP settings object.
[in]	instance	Instance of the block to be programmed.
[in]	controls	A pointer to a control structure for a white balance correction block.
[in]	size	Size of the white balance correction block control structure.

Returns

The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

NvMediaISPStatsSurface* NvMediaISPStatsSurfaceCreate ( NvMediaISP * isp )

Allocates an ISP statistics surface object.

Parameters

[in] isp ISP object.

Returns: NvMediaISPStatsSurface handle to ISP statistics surface or NULL if unsuccessful.

NvMediaStatus NvMediaISPStatsSurfaceDestroy ( NvMediaISPStatsSurface * statsSurface )

Destroys an ISP statistics surface object.

Parameters

[in] statsSurface ISP statistics surface object to destroy.

Returns

NvMediaStatus The status of the operation.

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if any of the input arguments were invalid.
NVMEDIA_STATUS_ERROR if there is any error.

NvMediaStatus NvMediaISPStop ( NvMediaISP * isp )

Stops the image processing.

Parameters

[in] isp ISP object to destroy.

Returns

NvMediaStatus The status of the operation. Possible values are:

NVMEDIA_STATUS_OK if the operation was successful.
NVMEDIA_STATUS_BAD_PARAMETER if the input pointer was NULL.
NVMEDIA_STATUS_ERROR for any other error.

NVIDIA DRIVE OS Linux API Reference

5.1.0.2 Release

Detailed Description

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation