nvmedia_icp.h File Reference

Detailed Description

NVIDIA Media Interface: Image Capture Processing

This file contains the Image Capture Processing API.

Definition in file nvmedia_icp.h.

Go to the source code of this file.

Data Structures
struct	NvMediaICPInputFormat
	Capture input format. More...
struct	NvMediaICPSettings
	Holds image capture settings for the CSI format. More...
struct	NvMediaICPSettingsEx
	Holds the image capture settings for the CSI format. More...
struct	NvMediaICPEx
	Holds the image capture object created by NvMediaICPCreateEx. More...
struct	NvMediaICPErrorInfo
	Holds the capture error information populated by NvMediaICPGetErrorInfo. More...

Macros
#define	NVMEDIA_ICP_VERSION_MAJOR   4
	Major Version number. More...
#define	NVMEDIA_ICP_VERSION_MINOR   8
	Minor Version number. More...
#define	NVMEDIA_IMAGE_CAPTURE_TIMEOUT_INFINITE
	Defines an infinite time-out for NvMediaICPGetFrameEx. More...
#define	NVMEDIA_ICP_MAX_VIRTUAL_GROUPS   4u
	Defines the maximum number of virtual groups. More...
#define	NVMEDIA_ICP_MAX_VIRTUAL_CHANNELS   3u
	Defines the maximum number of virtual channels per virtual group. More...
#define	NVMEDIA_ICP_HANDLER(icpEx, groupIdx)   (icpEx->icp[groupIdx].hIcp)
	Defines a macro that gets NvMediaICP handler from NvMediaICPEx handler. More...
#define	NVMEDIA_ICP_SETTINGS_HANDLER(icpSettingsEx, groupIdx, vcIdx)   (&icpSettingsEx.virtualGroups[groupIdx].virtualChannels[vcIdx].icpSettings)
	Defines a macro that gets the NvMediaICPSettings handler from the NvMediaICPSettingsEx object. More...
#define	NVMEDIA_ICP_ERROR(_type_, _error_, _value_, _desc_)   NVMEDIA_ICP_##_type_##_ERROR_##_error_ = _value_,
	Defines a macro that creates an enumerator in enum NvMediaICPErrorStatus. More...

Typedefs
typedef void	NvMediaICP
	Image capture object per virtual group. More...

Enumerations
enum	NvMediaICPInterfaceType {   NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_A,   NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_B,   NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_AB,   NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_C,   NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_D,   NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_CD,   NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_E,   NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_F,   NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_EF,   NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_G,   NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_H,   NVMEDIA_IMAGE_CAPTURE_CSI_INTERFACE_TYPE_CSI_GH }
	Determines the image capture interface type for CSI interface. More...
enum	NvMediaICPInputFormatType {   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_YUV422,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_YUV422_10,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_YUV444,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_RGB888,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_RAW6,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_RAW7,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_RAW8,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_RAW10,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_RAW12,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_RAW14,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_RAW16,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_RAW20,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_USER_DEFINED_1,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_USER_DEFINED_2,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_USER_DEFINED_3,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_USER_DEFINED_4,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_USER_DEFINED_5,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_USER_DEFINED_6,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_USER_DEFINED_7,   NVMEDIA_IMAGE_CAPTURE_INPUT_FORMAT_TYPE_USER_DEFINED_8 }
	Determines the image capture input format type. More...
enum	NvMediaICPCsiPhyMode {   NVMEDIA_ICP_CSI_DPHY_MODE = 0,   NVMEDIA_ICP_CSI_CPHY_MODE }
	Specifies CSI phy mode. More...
enum	NvMediaICPErrorStatus
	Defines codes that describe error status. More...

Functions
NvMediaStatus	NvMediaICPGetVersion (NvMediaVersion *version)
	Checks the version compatibility for the NvMedia ICP library. More...
NvMediaICPEx *	NvMediaICPCreateEx (NvMediaICPSettingsEx *settings)
	Creates an image capture object used to capture various formats of input into an NvMediaImage. More...
void	NvMediaICPDestroyEx (NvMediaICPEx *icpEx)
	Destroys the image capture object created by NvMediaICPCreateEx. More...
NvMediaStatus	NvMediaICPFeedFrame (NvMediaICP *icp, NvMediaImage *image, uint32_t millisecondTimeout)
	Adds an image to the image capture pool. More...
NvMediaStatus	NvMediaICPFeedImageGroup (NvMediaICP *icp, NvMediaImageGroup *imageGrp, unsigned int millisecondTimeout)
	Adds an image group to the image capture pool. More...
NvMediaStatus	NvMediaICPStop (NvMediaICP *icp)
	Stops the image capture. More...
NvMediaStatus	NvMediaICPResume (NvMediaICP *icp)
	Resumes the image capture. More...
NvMediaStatus	NvMediaICPGetFrameEx (NvMediaICP *icp, uint32_t millisecondTimeout, NvMediaImage **image)
	Gets a captured frame with frame status. More...
NvMediaStatus	NvMediaICPGetImageGroup (NvMediaICP *icp, uint32_t millisecondTimeout, NvMediaImageGroup **imageGrp)
	Gets a captured image group with frame status. More...
NvMediaStatus	NvMediaICPReleaseFrame (NvMediaICP *icp, NvMediaImage **image)
	Gets a frame from the internal pool that the client previously supplied with NvMediaICPFeedFrame(). More...
NvMediaStatus	NvMediaICPReleaseImageGroup (NvMediaICP *icp, NvMediaImageGroup **imageGrp)
	Gets an image group from the internal pool that the client previously supplied with NvMediaICPFeedImageGroup(). More...
NvMediaStatus	NvMediaICPGetErrorInfo (NvMediaICP *icp, NvMediaICPErrorInfo *icpErrorInfo)
	Gets the capture error information. More...
NvMediaStatus	NvMediaICPWaitForSoF (NvMediaICP *icp)
	Waits for next SoF(Start of Frame). More...