NVIDIA DRIVE OS Linux SDK API Reference

5.2.3 Release
For Test and Development only
Data Structures
Here are the data structures with brief descriptions:
[detail level 123]
 NnvsiplContains the classes and variables for implementation of SIPL
 C_NvMediaAESParamsHolds encrypted metadata information that the client sends to the parser
 CNvData32RecUnion that can be used to view a 32-bit word as your choice of a 32-bit unsigned integer, a 32-bit signed integer, or an IEEE single-precision float
 CNvData64RecGeneric data representation for both 32 and 64 bits data
 CNvMedia2DBlitParametersHolds the additional parameters for a blit
 CNvMedia2DBlitParametersOutHolds additional values returned from a blit
 CNvMediaAESIvHolds encryption intialization vector information
 CNvMediaAESMetaDataHolds re-encrypted data information that the video decoder returns to the parser
 CNvMediaAlphaSurfaceHolds an Alpha Surface descriptor for video mixing
 CNvMediaArrayAllocAttrHolds array allocation attributes
 CNvMediaBackgroundBackground descriptor for video mixing
 CNvMediaBitstreamBufferHolds an application data buffer containing compressed video data
 CNvMediaBitStreamPktHolds the bitstream packet input for parsing
 CNvMediaCameraModelHolds NvMedia LDC camera parameter info
 CNvMediaCamIntriParamsHolds NvMedia camera intrinsic parameters
 CNvMediaColorHolds a constant RGBA color
 CNvMediaContentLightLevelInfoContent Light Level info for an H.265 picture
 CNvMediaDecCurrFrameHolds decoded current frame information
 CNvMediaDecRefFrameHolds decoded reference frame information
 CNvMediaDispAttributesHolds NvMedia display attributes
 CNvMediaDlaArgsHolds input and output DLA data
 CNvMediaDlaBinaryLoadableHolds attributes for populating binary loadables for NvMediaDla
 CNvMediaDlaDataSpecifies the data type and data pointer
 CNvMediaDlaDataPointerHolds pointers to the DLA data
 CNvMediaDlaTensorDescriptorHolds tensor attributes
 CNvMediaDlaUMDVersionHolds the DLA UMD version
 CNvMediaDPBInfoHolds decoded Picture Buffer information
 CNvMediaEGLStreamConsumerA handle representing an EGL stream consumer object
 CNvMediaEGLStreamProducerA handle representing an EGL stream producer object
 CNvMediaEglStreamProducerAttributesHolds the attributes for an EGL stream producer
 CNvMediaEncodeCodecExDataHolds a codec-specific extradata output
 CNvMediaEncodeConfigH264Holds an H264 encoder configuration
 CNvMediaEncodeConfigH264VUIParamsHolds H264 video usability information parameters
 CNvMediaEncodeConfigH265Holds the H265 encoder configuration parameters
 CNvMediaEncodeConfigH265VUIParamsHolds the H.265 video usability information parameters
 CNvMediaEncodeConfigVP8Holds VP8 encoder configuration parameters
 CNvMediaEncodeConfigVP9Holds VP9 encoder configuration parameters
 CNvMediaEncodeExternalMEHintHolds an External Motion Vector hint
 CNvMediaEncodeExternalMeHintCountsPerBlocktypeHolds an external motion vector hint with counts per block type
 CNvMediaEncodeFrameFullPropHolds a Video encoder frames property
 CNvMediaEncodeH264SEIPayloadH.264 specific User SEI message
 CNvMediaEncodeH265SEIPayloadHolds an H265-specific User SEI message
 CNvMediaEncodeInitializeParamsH264Holds H264-specific encode initialization parameters
 CNvMediaEncodeInitializeParamsH265Holds H265-specific encode initialization parameters
 CNvMediaEncodeInitializeParamsVP8Holds VP8-specific encode initialization parameters
 CNvMediaEncodeInitializeParamsVP9Holds VP9-specific encode initialization parameters
 CNvMediaEncodeMVBufferHeaderHeader format that defines motion vector output
 CNvMediaEncodeMVDataMotion Vector format - motion vectors for each of the macro blocks are dumped in this format contiguously in memory, beyond the NvMediaEncodeMVBufferHeader in the bitstream
 CNvMediaEncodeOutputExtradataHolds a Video encoder output extradata configuration
 CNvMediaEncodePicParamsH264H264 specific encoder picture params
 CNvMediaEncodePicParamsH265Holds H265-specific encoder picture parameters
 CNvMediaEncodePicParamsVP8Holds VP8-specific encoder picture parameters, which are sent on a per frame basis
 CNvMediaEncodePicParamsVP9Holds VP9-specific encoder picture parameters, which are sent on a per frame basis
 CNvMediaEncodeQPHolds quantization parameters(QP) value for frames
 CNvMediaEncodeRCParamsHolds rate control configuration parameters
 CNvMediaEncryptParamsHolds encrypted metadata information that the parser passes to the video decoder component
 CNvMediaFrameStatsHolds Video Encoder Profiling Information
 CNvMediaGeoTransParamsHolds geometric transform initialization paramters
 CNvMediaIDPImage display object created by NvMediaIDPCreate
 CNvMediaIDPDeviceParamsDevice parameters returned by NvMediaIDPQuery function
 CNvMediaIDPPreferencesSets the preferences for the image display creation
 CNvMediaIEPRecHolds the image encoder object created by NvMediaIEPCreate
 CNvMediaIJPDHolds information for decoding a JPEG stream into an image surface
 CNvMediaIJPEImage JPEG encoder object created by NvMediaIJPECreate
 CNvMediaImageDecoderA handle representing a IMAGE decoder object
 CNvMediaImageGroupHolds a handle representing an image group
 CNvMediaImageRecHolds a handle representing image objects
 CNvMediaImageSurfaceHolds an image surface descriptor used by NvMediaImageLock()
 CNvMediaImageSurfaceMapHolds an image surface map descriptor used by NvMediaImageLock()
 CNvMediaIOFSTHolds an OFST object created and returned by NvMediaIOFSTCreate()
 CNvMediaISPBadPixelStatsHolds controls for bad pixel statistics (BP Stats)
 CNvMediaISPBadPixelStatsDataHolds bad pixel statistics (BP Stats)
 CNvMediaISPEllipseDefines an ellipse
 CNvMediaISPFlickerBandStatsHolds controls for flicker band statistics (FB Stats)
 CNvMediaISPFlickerBandStatsDataHolds flicker band statistics (FB Stats)
 CNvMediaISPHistogramStatsHolds controls for histogram statistics (HIST Stats)
 CNvMediaISPHistogramStatsDataHolds histogram statistics (HIST Stats)
 CNvMediaISPLocalAvgClipStatsHolds controls for local average and clip statistics (LAC Stats)
 CNvMediaISPLocalAvgClipStatsDataHolds local average and clip statistics block (LAC Stats)
 CNvMediaISPLocalAvgClipStatsROIDataHolds local average and clip statistics data for a region of interest
 CNvMediaISPLocalToneMapStatsHolds controls for local tone map statistics (LTM Stats)
 CNvMediaISPLocalToneMapStatsDataHolds local tone map statistics block (LTM Stats)
 CNvMediaISPRadialTFDefines a radial transform
 CNvMediaISPSplineControlPointDefines a spline control point
 CNvMediaISPStatisticsWindowsDefines the windows used in ISP stats calculations
 CNvMediaJPEGAppMarkerInfoHolds image JPEG decoder marker Info
 CNVMEDIAJPEGDecAttributesHolds image JPEG decoder attributes
 CNVMEDIAJPEGDecInfoHolds image JPEG decoder stream information
 CNvMediaJPEncAttributesImage JPEG encoder attributes
 CNvMediaJPHuffmanTableSpecficationImage JPEG encoder HuffmanTable
 CNvMediaLDCBitMaskMapHolds the NvMedia mask map surface
 CNvMediaLDCCtrlParamsHolds runtime control parameters for NvMediaLDCProcess()
 CNvMediaLDCInitParamsHolds the NvMedia LDC initialization paramters
 CNvMediaLDCRegionConfigHolds the NvMedia LDC region configuration
 CNvMediaLDCSparseWarpMapHolds the NvMedia LDC defintion of a sparse warp map
 CNvMediaLensDistortionHolds distortion coefficients for the lens model
 CNvMediaMasteringDisplayDataMastering display data for an H.265 picture
 CNvMediaMotionVectorFrameMetaDataMotion vector array to get the required current frame stats
 CNvMediaMotionVectorMB_MetadataPer Macroblock header information
 CNvMediaNalDataThis is used to get header info (SPS/PPS/VPS) using GetAttribute call
 CNvMediaOFSTExternalHintParamsHolds OFST estimation parameters
 CNvMediaOFSTInitializeParamsHolds OFST estimation initialization parameters
 CNvMediaParserClientCb
 CNvMediaParserParamsHolds initialization parameters for the decoder class
 CNvMediaParserPictureDataHolds picture information for the current frame decode operation
 CNvMediaParserSeqInfoHolds video sequence information
 CNvMediaPictureInfoH264Picture parameter information for an H.264 picture
 CNvMediaPictureInfoH265Holds picture parameter information for an H.265 picture
 CNvMediaPictureInfoMPEG1Or2Holds picture parameter information for an MPEG 1 or MPEG 2 picture
 CNvMediaPictureInfoMPEG4Part2Holds picture parameter information for an MPEG-4 Part 2 picture
 CNvMediaPictureInfoVC1Holds picture parameter information for a VC1 picture
 CNvMediaPictureInfoVP8Picture parameter information for a VP8 picture
 CNvMediaPictureInfoVP9Holds picture parameter information for a VP9 picture
 CNvMediaPointDefines the location of a point on a two-dimensional object
 CNvMediaPointDoubleDefines the double-precision location of a point on a two-dimensional object
 CNvMediaPointFloatDefines the float-precision location of a point on a two-dimensional object
 CNvMediaRectHolds a rectangular region of a surface
 CNvMediaReferenceFrameH264Information about an H.264 reference frame
 CNvMediaSEIPayloadH264H.264 SEI payload information Used by the parser only
 CNvMediaSliceDecodeDataSlice level data used with slice level decoding
 CNvMediaSurfAllocAttrHolds NvMedia Surface allocation attributes
 CNvMediaSurfFormatAttrHolds NvMedia Surface format attributes
 CNvMediaTaskStatusHolds status of latest operation for NvMedia managed data structure
 CNvMediaTensorAttrHolds tensor creation attributes
 CNvMediaTensorMetaDataHolds the tensor metadata
 CNvMediaTensorSurfaceMapDefines the tensor surface map descriptor used by NvMediaTensorLock()
 CNvMediaTensorTaskStatusHolds the status of the latest operation for a tensor
 CNvMediaTNR2ParamsHolds the TNR2 initialization paramters
 CNvMediaTNR3ParamsHolds the TNR3 initialization paramters
 CNvMediaVersionHolds NvMedia version information
 CNvMediaVideoCaptureVideo capture object created by NvMediaVideoCaptureCreate
 CNvMediaVideoCaptureSettingsVideo capture settings for CSI format
 CNvMediaVideoDecodeFrameStatusTo Get the decoding status from HW decoder
 CNvMediaVideoDecoderA handle representing a video decoder object
 CNvMediaVideoDecodeStatsFrame stats structure to get get ring entry idx and motion vector dump
 CNvMediaVideoDecrypterHolds the video decrypter object
 CNvMediaVideoDescVideo descriptor for video mixing
 CNvMediaVideoEncoderVideo encoder object created by NvMediaVideoEncoderCreate
 CNvMediaVideoMixerAttributesHolds video mixer attributes
 CNvMediaVideoOutputVideo output object created by NvMediaVideoOutputCreate
 CNvMediaVideoOutputDeviceParamsDevice parameters returned by NvMediaVideoOutputDevicesQuery function
 CNvMediaVideoOutputPreferencesSets the preferences for the video output creation
 CNvMediaVideoSurfaceA handle representing a video surface object
 CNvMediaVideoSurfaceMapA handle representing a video surface map
 CNvMediaVP9BackwardUpdatesHolds VP9 counters for adaptive entropy contexts
 CNvmediaVP9EntropyProbsHolds VP9 entropy contexts
 CNvMediaVPI2DTransform3x3 transform matrix
 CNvMediaVPIAABBAxis Aligned Bounding Box
 CNvMediaVPIBoundingBoxWithTransformHolds bounding box definition
 CNvMediaVPIGetKeyPointsHarrisParamsHolds Harris keypoint parameters
 CNvMediaVPIGetSparseFlowPyrLKParamsNvMediaVPIGetSparseFlowPyrLKParams
 CNvMediaVPIKLTParamsHolds the KLT parameters
 CNvMediaVPIPoint2DfHolds 2D floating point definition
 CNvMediaVPIPoint2DFracHolds 2D point fractional representation
 CNvMediaVPIStereoPostprocessParamsHolds stereo postprocess parameters
 CNvMediaVPIStereoPreprocessParamsHolds stereo preprocessing parameters
 CNvMediaVPITranslationWithScaleTranslation with Scale parameters
 CNvPointF32Rec
 CNvPointRecThis structure is used to determine a location on a 2-dimensional object, where the coordinate (0,0) is located at the top-left of the object
 CNvRectF32RecThis structure is used to define a 2-dimensional rectangle relative to some containing rectangle
 CNvRectRecThis structure is used to define a 2-dimensional rectangle where the rectangle is bottom right exclusive (that is, the right most column, and the bottom row of the rectangle is not included)
 CNvRmGpuClockAsyncNotImplementedOS-specific type of asynchronous clock request handle (unimplemented)
 CNvRmGpuClockDomainInfoRecClock domain info
 CNvRmGpuClockGetEntryRecEntry for clock get request
 CNvRmGpuClockPointRecClock voltage/frequency point
 CNvRmGpuClockRangeRecFrequency range for clock domain
 CNvRmGpuClockSetEntryRecEntry for clock set request
 CNvRmGpuDeviceEventInfoRecGPU device event
 CNvRmGpuDeviceEventSessionOpenAttrRecExtensible attribute structure for NvRmGpuDeviceEventSessionOpen()
 CNvRmGpuDeviceOpenAttrRecExtensible attribute structure for NvRmGpuDeviceOpen()
 CNvRmGpuLibDeviceListEntryRecDevice list entry
 CNvRmGpuLibOpenAttrRecExtensible attribute structure for NvRmGpuLibOpen()
 CNvSciBufAttrKeyValuePairThis structure defines a key/value pair used to get or set the NvSciBufAttrKey(s) and their corresponding values from or to NvSciBufAttrList
 CNvSciBufObjIpcExportDescriptorDefines the exported form of NvSciBufObj intended to be shared across an NvSciIpc channel
 CNvSciIpcEndpointInfoDefines information about the NvSciIpc endpoint
 CNvSciRmGpuIdDefines GPU ID structure
 CNvSciStreamElementAttrThe following data structures are no longer used by any interfaces and are deprecated
 CNvSciStreamElementDesc
 CNvSciStreamEventDescribes an event triggered by the blocks
 CNvSciStreamPayload
 CNvSciStreamSyncAttr
 CNvSciStreamSyncDesc
 CNvSciSyncAttrKeyValuePairThis structure defines a key/value pair used to get or set the NvSciSyncAttrKey(s) and their corresponding values from or to NvSciSyncAttrList
 CNvSciSyncFenceDefines the opaque NvSciSyncFence
 CNvSciSyncFenceIpcExportDescriptorDefines the exported form of NvSciSyncFence intended to be shared across an NvSciIpc channel
 CNvSciSyncObjIpcExportDescriptorDefines the exported form of NvSciSyncObj intended to be shared across an NvSciIpc channel
 CNvScrncaptApertureHolds the representation of a display aperture
 CNvScrncaptHeadStateHolds a head's current state
 CNvScrncaptPixelHolds a pixel value
 CNvScrncaptResultHolds the screen capture result
 CNvScrncaptStatisticsHolds statistics for a single capture
 CNvScrncaptSurfaceMapHolds planes within the frame buffer
 CNvScrncaptWindowStateHolds the representation of a window's current state
 CNvSizeRecThis structure is used to define a 2-dimensional surface where the surface is determined by it's height and width in pixels
 CTEE_AttributeA TEE_Attribute can either define a buffer or a value
 CTEE_ObjectInfoA TEE_ObjectInfo structure contains information about a storage object:
 CTEE_OperationInfoHolds information about a cryptographic operation handle
 CTEE_ParamDescribes one parameter passed by the trusted core framework to the entry points TA_OpenSessionEntryPoint or TA_InvokeCommandEntryPoint or by the TA to the functions TEE_OpenTASession or TEE_InvokeTACommand
 CTEE_TimeThe TEE_Time structure holds a time value as defined in the GP spec
 CTEEC_ContextThis type denotes a TEE Context, the main logical container linking a Client Application with a particular TEE
 CTEEC_OperationThis type defines the payload of either an open Session operation or an invoke Command operation
 CTEEC_ParameterThis type defines a Parameter of a TEEC_Operation
 CTEEC_SessionThis type denotes a TEE Session, the logical container linking a Client Application with a particular Trusted Application
 CTEEC_TempMemoryReferenceThis type defines a Temporary Memory Reference
 CTEEC_UUIDThis type contains a Universally Unique Resource Identifier (UUID) type as defined in RFC4122
 CTEEC_ValueThis type defines a parameter that is not referencing shared memory, but carries instead small raw data passed by value