nvmedia_iofa.h File Reference

Detailed Description

NVIDIA Media Interface: NvMedia Image Optical Flow Accelerator (IOFA) APIs

Definition in file nvmedia_iofa.h.

Go to the source code of this file.

Data Structures
struct	NvMediaIofaEpipolarInfo
	Structure holds Epipolar information. More...
struct	NvMediaIofaROIRectParams
	Holds Co-ordinates for Region of Interest. More...
struct	NvMediaIofaROIParams
	Structure holds ROI information. More...
struct	NvMediaIofaCapability
	Nvmedia Iofa Capability structure. More...
struct	NvMediaIofa
	Holds an IOFA object created and returned by NvMediaIOFACreate(). More...
struct	NvMediaIofaInitParams
	Holds IOFA Initialization API parameters. More...
struct	NvMediaIofaSGMParams
	Holds SGM parameters TBD: Add more details about SGM Params with input range. More...
struct	NvMediaIofaBufArray
	Holds pointers to NvMedia bufObjs containing input and output surfaces. More...
struct	NvMediaIofaPydHintParams
	Parameters related to input pyramid hint surface. More...
struct	NvMediaIofaProcessParams
	Holds IOFA Process Frame API parameters. More...
struct	NvMediaIofaProfileData
	IOFA Profile Data structure. More...

Macros
#define	NVMEDIA_IOFA_VERSION_MAJOR   1
	Major version number. More...
#define	NVMEDIA_IOFA_VERSION_MINOR   1
	Minor version number. More...
#define	NVMEDIA_IOFA_VERSION_PATCH   0
	Patch version number. More...
#define	NVMEDIA_IOFA_MAX_PYD_LEVEL   5U
	Maximum number of Pyramid level supported in Pyramid OF mode. More...
#define	NVMEDIA_IOFA_MAX_ROI_SUPPORTED   32U
	Maximum number of Region of Interest supported on IOFA. More...
#define	NVMEDIA_IOFA_MAX_PRENVSCISYNCFENCES   (8U)
	Specifies the maximum number of times NvMediaIOFAInsertPreNvSciSyncFence() can be called before each call to NvMediaIOFAProcessFrame(). More...

Typedefs
typedef struct NvMediaIofa	NvMediaIofa
	Holds an IOFA object created and returned by NvMediaIOFACreate(). More...

Enumerations
enum	NvMediaIofaMode {   NVMEDIA_IOFA_MODE_STEREO = 0U,   NVMEDIA_IOFA_MODE_PYDOF = 1U,   NVMEDIA_IOFA_MODE_EPIOF = 2U }
	Defines mode supported by IOFA Driver. More...
enum	NvMediaIofaGridSize {   NVMEDIA_IOFA_GRIDSIZE_1X1 = 0U,   NVMEDIA_IOFA_GRIDSIZE_2X2 = 1U,   NVMEDIA_IOFA_GRIDSIZE_4X4 = 2U,   NVMEDIA_IOFA_GRIDSIZE_8X8 = 3U }
	Defines the Output Grid Size. More...
enum	NvMediaIofaPydMode {   NVMEDIA_IOFA_PYD_FRAME_MODE = 0U,   NVMEDIA_IOFA_PYD_LEVEL_MODE = 1U }
	Modes for pyramid SGM Applicable to Pyramid SGM IOFA mode only. More...
enum	NvMediaIofaDisparityRange {   NVMEDIA_IOFA_DISPARITY_RANGE_128 = 0U,   NVMEDIA_IOFA_DISPARITY_RANGE_256 = 1U }
	Defines IOFA Stereo DISPARITY RANGE. More...
enum	NvMediaIofaProfileMode {   NVMEDIA_IOFA_PROFILE_DISABLED = 0U,   NVMEDIA_IOFA_PROFILE_ENABLED = 1U,   NVMEDIA_IOFA_PROFILE_SYNC_ENABLED = 2U }
	Defines NvMedia Iofa Profile Mode. More...
enum	NvMediaIofaPreset {   NVMEDIA_IOFA_PRESET_HQ = 0U,   NVMEDIA_IOFA_PRESET_HP = 1U }
	Nvmedia Iofa Preset. More...
enum	NvSciSyncTaskStatusOFA {   NvSciSyncTaskStatusOFA_Success = 0U,   NvSciSyncTaskStatusOFA_Error = 1U,   NvSciSyncTaskStatusOFA_Execution_Start = 2U,   NvSciSyncTaskStatusOFA_Error_CRC_Mismatch = 3U,   NvSciSyncTaskStatusOFA_Error_Timeout = 4U,   NvSciSyncTaskStatusOFA_Error_HW = 5U,   NvSciSyncTaskStatusOFA_Error_Input_TaskStatus = 6U,   NvSciSyncTaskStatusOFA_Error_SW = 7U,   NvSciSyncTaskStatusOFA_Invalid = 0XFFFFU }
	NvMedia Iofa task status error codes. More...

Functions
NvMediaStatus	NvMediaIOFAGetVersion (NvMediaVersion *version)
	Retrieves the version information for the NvMedia IOFA library. More...
NvMediaIofa *	NvMediaIOFACreate (void)
	Creates an NvMediaIofa object that can compute optical flow or stereo disparity using two bufObjs. More...
NvMediaStatus	NvMediaIOFAInit (NvMediaIofa *ofaPubl, const NvMediaIofaInitParams *initParams, const uint8_t maxInputBuffering)
	Initializes the parameters for optical flow and stereo estimation. More...
NvMediaStatus	NvMediaIOFAProcessFrame (const NvMediaIofa *ofaPubl, const NvMediaIofaBufArray *pSurfArray, const NvMediaIofaProcessParams *processParams, const NvMediaIofaEpipolarInfo *pEpiInfo, const NvMediaIofaROIParams *pROIParams)
	Performs IOFA estimation on a specified frame pair. More...
NvMediaStatus	NvMediaIOFADestroy (const NvMediaIofa *ofaPubl)
	Destroys the created NvMediaIofa object and frees associated resources. More...
NvMediaStatus	NvMediaIOFARegisterNvSciBufObj (const NvMediaIofa *ofaPubl, NvSciBufObj bufObj)
	Registers an NvSciBufObj for use with an NvMediaIofa handle. More...
NvMediaStatus	NvMediaIOFAUnregisterNvSciBufObj (const NvMediaIofa *ofaPubl, NvSciBufObj bufObj)
	Un-registers NvSciBufObj which was previously registered with NvMediaIofa using NvMediaIOFARegisterNvSciBufObj(). More...
NvMediaStatus	NvMediaIOFAGetSGMConfigParams (const NvMediaIofa *ofaPubl, NvMediaIofaSGMParams *pSGMParams)
	Get the SGM configuration parameters being used. More...
NvMediaStatus	NvMediaIOFASetSGMConfigParams (const NvMediaIofa *ofaPubl, const NvMediaIofaSGMParams *pSGMParams)
	Set the SGM configuration parameters to be used. More...
NvMediaStatus	NvMediaIOFAGetProfileData (const NvMediaIofa *ofaPubl, NvMediaIofaProfileData *pProfData)
	Get IOFA Profile Data. More...
NvMediaStatus	NvMediaIOFAGetCapability (const NvMediaIofa *ofaPubl, const NvMediaIofaMode mode, NvMediaIofaCapability *pCapability)
	Get IOFA Capability. More...
NvMediaStatus	NvMediaIOFAFillNvSciBufAttrList (NvSciBufAttrList attrlist)
	Fills the NvMediaIofa specific NvSciBuf attributes which than then be used to allocate an NvSciBufObj that NvMediaIofa can consume. More...
NvMediaStatus	NvMediaIOFAFillNvSciSyncAttrList (const NvMediaIofa *ofaPubl, NvSciSyncAttrList attrlist, NvMediaNvSciSyncClientType clienttype)
	Fills the NvMediaIofa specific NvSciSync attributes. More...
NvMediaStatus	NvMediaIOFARegisterNvSciSyncObj (const NvMediaIofa *ofaPubl, NvMediaNvSciSyncObjType syncobjtype, NvSciSyncObj nvscisync)
	Registers an NvSciSyncObj with NvMediaIofa. More...
NvMediaStatus	NvMediaIOFAUnregisterNvSciSyncObj (const NvMediaIofa *ofaPubl, NvSciSyncObj nvscisync)
	Unregisters an NvSciSyncObj with NvMediaIofa. More...
NvMediaStatus	NvMediaIOFASetNvSciSyncObjforEOF (const NvMediaIofa *ofaPubl, NvSciSyncObj nvscisyncEOF)
	Specifies the NvSciSyncObj to be used for an EOF NvSciSyncFence. More...
NvMediaStatus	NvMediaIOFAInsertPreNvSciSyncFence (const NvMediaIofa *ofaPubl, const NvSciSyncFence *prenvscisyncfence)
	Sets an NvSciSyncFence as a prefence for an NvMediaIOFAProcessFrame() NvSciSyncFence operation. More...
NvMediaStatus	NvMediaIOFAGetEOFNvSciSyncFence (const NvMediaIofa *ofaPubl, NvSciSyncObj eofnvscisyncobj, NvSciSyncFence *eofnvscisyncfence)
	Gets EOF NvSciSyncFence for an NvMediaIOFAProcessFrame() operation. More...
NvMediaStatus	NvMediaIOFASetNvSciSyncObjforSOF (const NvMediaIofa *ofaPubl, NvSciSyncObj nvscisyncSOF)
	Specifies the NvSciSyncObj to be used for an SOF NvSciSyncFence. More...
NvMediaStatus	NvMediaIOFAGetSOFNvSciSyncFence (const NvMediaIofa *ofaPubl, NvSciSyncObj sofnvscisyncobj, NvSciSyncFence *sofnvscisyncfence)
	Gets SOF NvSciSyncFence for an NvMediaIOFAProcessFrame() operation. More...