NVIDIA DRIVE OS Linux SDK API Reference

6.0.9 Release
Data Structures
Here are the data structures with brief descriptions:
[detail level 123]
 NnvsiplContains the classes and variables for implementation of SIPL
 C_NvMediaPicEntry_AV1
 C_NvMediaPicEntry_AV1_Short
 C_NvMediaPictureInfo_AV1Holds picture parameter information for AV1 picture
 C_NvMediaTile_AV1
 Cether_exported_ifr_dataStruct ether_exported_ifr_data - Private data of struct ifreq
 Cether_l2_filterStructure for L2 filters input
 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
 CNvMedia2DAttributesAttributes structure for NvMedia2DCreate()
 CNvMedia2DComposeResultStores information returned from NvMedia2DCompose()
 CNvMedia2DFilterCoefficients10TapCoefficients values structure for 10-tap custom filter
 CNvMedia2DFilterCoefficients5TapCoefficients values structure for 5-tap custom filter
 CNvMediaBitstreamBufferHolds an application data buffer containing compressed video data
 CNvMediaBitStreamPktHolds the bitstream packet input for parsing
 CNvMediaContentLightLevelInfoContent Light Level info for an H.265 picture
 CNvMediaDecCurrFrameHolds decoded current frame information
 CNvMediaDecRefFrameHolds decoded reference frame information
 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
 CNvMediaEncodeCfgFilesDefines the structure for holding the encoding attributes for HW validation
 CNvMediaEncodeCodecExDataHolds a codec-specific extradata output
 CNvMediaEncodeConfigAV1Holds AV1 encoder configuration parameters
 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
 CNvMediaEncodeConfigVP9Holds VP9 encoder configuration parameters
 CNvMediaEncodeDRCConfigDefines the resolution change parameters
 CNvMediaEncodeExternalMEHintHolds an External Motion Vector hint
 CNvMediaEncodeExternalMeHintCountsPerBlocktypeHolds an external motion vector hint with counts per block type
 CNvMediaEncodeFrameFullPropHolds a encoder frames property
 CNvMediaEncodeH264SEIPayloadH.264 specific User SEI message
 CNvMediaEncodeH265SEIPayloadHolds an H265-specific User SEI message
 CNvMediaEncodeInitializeParamsAV1Holds AV1-specific encode initialization parameters
 CNvMediaEncodeInitializeParamsH264Holds H264-specific encode initialization parameters
 CNvMediaEncodeInitializeParamsH265Holds H265-specific encode initialization parameters
 CNvMediaEncodeInitializeParamsVP9Holds VP9-specific encode initialization parameters
 CNvMediaEncodeInputExtradataHolds an Video encoder input extradata configuration
 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 the encoder output extradata configuration
 CNvMediaEncodePicParamsAV1Holds AV1-specific encoder picture parameters, which are sent on a per frame basis
 CNvMediaEncodePicParamsH264H264 specific encoder picture params
 CNvMediaEncodePicParamsH265Holds H265-specific encoder picture parameters
 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
 CNvMediaEncROIParams
 CNvMediaFrameStatsHolds the statistics from encode profiling
 CNvMediaIDEFrameStatsFrame stats structure to get get ring entry idx and motion vector dump
 CNvMediaIDEFrameStatusTo Get the decoding status from HW decoder
 CNvMediaIofaHolds an IOFA object created and returned by NvMediaIOFACreate()
 CNvMediaIofaBufArrayHolds pointers to NvMedia bufObjs containing input and output surfaces
 CNvMediaIofaCapabilityNvmedia Iofa Capability structure
 CNvMediaIofaEpipolarInfoStructure holds Epipolar information
 CNvMediaIofaInitParamsHolds IOFA Initialization API parameters
 CNvMediaIofaProcessParamsHolds IOFA Process Frame API parameters
 CNvMediaIofaPydHintParamsParameters related to input pyramid hint surface
 CNvMediaIofaROIParamsStructure holds ROI information
 CNvMediaIofaROIRectParamsHolds Co-ordinates for Region of Interest
 CNvMediaIofaSGMParamsHolds SGM parameters
TBD: Add more details about SGM Params with input range
 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
 CNvMediaLdcAttributesAttributes structure for NvMediaLdcCreate()
 CNvMediaLdcCameraExtrinsicExtrinsic camera parameters
 CNvMediaLdcCameraIntrinsicInstrinsic camera parameters
 CNvMediaLdcChecksumRepresents a checksum
 CNvMediaLdcControlPointRepresents a control point
 CNvMediaLdcIptParametersHolds inverse perspective transformation configuration
 CNvMediaLdcLensDistortionDistortion coefficients for the lens model
 CNvMediaLdcMaskMapParametersHolds the Mask Map information
 CNvMediaLdcParametersAttributesAttributes that specify resources needed for NvMediaLdcParameters instance
 CNvMediaLdcRegionParametersHolds the NvMedia LDC region configuration
 CNvMediaLdcResultStores information returned from NvMediaLdcProcess()
 CNvMediaLdcTnrParametersHolds the TNR3 initialization parameters
 CNvMediaLdcWarpMapParametersHolds the NvMedia LDC definition of a Warp Map
 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
 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
 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
 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
 CNvMediaVersionHolds NvMedia version information
 CNvMediaVP9BackwardUpdatesHolds VP9 counters for adaptive entropy contexts
 CNvmediaVP9EntropyProbsHolds VP9 entropy contexts
 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 with floating point coordinates
 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()
 CNvRmGpuLibVersionInfoRecThe version information structure returned by NvRmGpuLibGetVersionInfo()
 CNvSciBufAttrKeyValuePairThis structure defines a key/value pair used to get or set the NvSciBufAttrKey(s) and their corresponding values from or to NvSciBufAttrList
 CNvSciBufAttrValGpuCacheDatatype specifying GPU cacheability preference for a particular GPU ID
 CNvSciBufAttrValGpuCompressionDatatype specifying compression type needed for a particular GPU ID
 CNvSciBufRectDatatype specifying the surface co-ordinates for NvSciBufObjGetPixels / NvSciBufObjPutPixels functionality
 CNvSciEventLoopServiceAn abstract interface that event consumer can wait for events using event notifier in event loop
 CNvSciEventNotifierAn abstract interface to notify event to event consumer and to register event handler of the event consumer client process
 CNvSciEventServiceAn abstract interface for a program's event handling infrastructure
 CNvSciIpcEndpointInfoDefines information about the NvSciIpc endpoint
 CNvSciLocalEventAn OS-agnostic object that sends signal to another thread in the same process
 CNvSciRmGpuIdDefines GPU ID structure
 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
 CNvSiplCapInputFormatHolds the capture input format
 CNvSizeRecThis structure is used to define a 2-dimensional surface where the surface is determined by it's height and width in pixels
 Cosi_core_avb_algorithmOSI Core avb data structure per queue
 Cosi_core_frp_cmdFRP command structure for OSD to OSI
 Cosi_est_configOSI Core EST structure
 Cosi_fpe_configOSI Core FPE structure
 Cosi_mmc_countersOsi_mmc_counters - The structure to hold RMON counter values
 Cosi_statsOSI Core error stats structure