NVIDIA DRIVE OS Linux SDK API Reference

6.0.3 Release
API Modules
Here is a list of all modules:
[detail level 12345]
 Camera Control ProtocolDescribes an API that uses the NVIDIA® Camera Control Protocol (NVCCP) to send messages from NVIDIA® Tegra® to AURIX MCU and receive acknowledgement back. For more information, search for "CCP" in NVIDIA DRIVE 5.0 Development Guide
 Camera Device InterfaceThe Camera Device Interface API encompasses all DevBlk I2C control related functions, including programming of all I2C controlled components such as deserializers, serializers, EEPROMs, and image sensors
 Basic CDI TypesThe Camera Device Interface API provides common CDI processing functions
 CDI DeviceAn CDI device represents a device that is attached or linked to the root I2C port
 CDI Device DriverProgram elements related to DevBlkCDIDeviceDriver, which defines a device driver. The core DevBlkCDI calls the driver when the client calls the related public DevBlkCDI function
 CDI Root DeviceManage DevBlkCDIRootDevice objects, which represent the root of the SIPL device block
 Camera Device Interface I2C ProgrammerThe Camera Device Interface I2C Programmer API encompasses all I2C related functions for programming all I2C controlled components such as deserializers, serializers, EEPROMs, and image sensors
 Common DeclarationsContains standard definitions used by various interfaces
 Error HandlingNverror.h contains our error code enumeration and helper macros
 GPU access APIGPU management and access API
 GPU access API: Device managementDevice control, device capabilities, and device memory management
 GPU access API: Device management (safety subset)
 GPU access API: LibraryLibrary management and device discovery
 GPU access API: Library (safety subset)
 GPU access API (safety subset)
 GPU access API: Device management (safety subset)
 GPU access API: Library (safety subset)
 Graphics APIsGraphics APIs in this section include NVIDIA and 3rd-party APIs
 EGL Specifications and Extensions
 OpenGL ES 2.x/3.x Specs and Extensions
 OpenGL Specifications
 Vulkan Specs and Extensions
 NvMedia APINVIDIA NvMedia technology provides powerful processing of multimedia data that enables true hardware acceleration across NVIDIA SoCs. NvMedia is a C-based, frame level API library that provides framework agnostic, distinctive software components, to realize various multimedia use case scenarios
 Common DeclarationsDefines basic types used for video and images throughout the NvMedia API
 Basic NvMedia Types and StructuresDefines basic types used throughout the NvMedia API
 EGL Stream APIThe EGL Stream API encompasses all NvMedia EGL Stream related functionality. EGL Stream support enables interaction with EGL based surfaces
 Image/Video Encode and OFSTDefines common types and declarations for image/video encode and OFST operations
 Parser APIProvides parsing for decoder frame handling
 Surface Handling APIDefines and manages image and video surface objects
 Video and Image Decode: Common TypesDefines common types and declarations for image and video decode operations
 Video and Image Encode/Decode: Common TypesDefines common types and declarations for image and video decode and encode operations
 Video and Image Encode: Common TypesDefines common types and declarations for image and video encode operations
 Deep Learning AcceleratorThe NvMedia Deep Learning Accelerator (DLA) API encompasses all NvMedia functions that access the DLA hardware engine for deep learning operations
 Deep Learning AcceleratorNvMedia DLA runtime APIs for accessing the DLA hardware engine for deep learning operations
 Deep Learning Accelerator SynchronizationThe NvMedia DLA NvSciSync API encompasses all NvMediaDla NvSciSync handling functions
 Image Handling APIThe Image Processing API encompasses all NvMedia image-related functionality
 Image 2D ProcessingThe Image 2D Processing API encompasses all NvMedia 2D image processing related functionality
 Image 2D Processing SynchronizationThe NvMedia 2D NvSciSync API encompasses all NvMedia 2D NvSciSync handling functions
 Image CreationDefines and manages image objects
 Image EncoderThe NvMediaIEP object takes uncompressed image data and turns it into a codec specific bitstream. Only H.264, H.265 and VP9 encoding is supported
 Image Encoder SynchronizationThe NvMedia IEP NvSciSync API encompasses all NvMediaIEP NvSciSync handling functions
 Image Handling with Buffer Allocation APIThe NvMedia Image NvSciBuf API encompasses all NvMediaImage NvSciBuf handling functions
 Image JPEG DecoderThe NvMediaIJPD object takes a JPEG bitstream and decompress it to image data
 Image JPEG EncoderThe NvMediaIJPE object takes uncompressed image data and turns it into a jpeg bitstream
 Image Locking and UnlockingLocking and unlocking controls access to the image surfaces
 Image Read and Write by ClientProvides image surface read and write by the client application for diagnostic purposes
 Image Signal Processing (ISP) StatisticsNvMedia ISP Defines NvMedia ISP Stat structures
 SIPLSIPL provides abstract and simple API to capture the output of image sensors with optional image processing. SIPL is implemented on top of NvMedia API
 Lens Distortion CorrectionThe NvMedia Lens Distortion Correction (LDC) API contains NvMedia functions for accessing the LDC hardware engine for geometric transform and temporal noise reduction (TNR3)
 Lens Distortion Correction SynchronizationThe NvMedia LDC NvSciSync API encompasses all NvMediaLDC NvSciSync handling functions
 NvMedia ArrayThe NvMedia Array and NvSciBuf API encompasses all NvMedia functions that create, destroy, access and update arrays used in media processing and computer vision applications
 NvMedia ArrayThe NvMedia Array API encompasses all NvMedia functions that create, destroy, access and update arrays used in media processing and computer vision applications
 NvMedia Array for NvSciBufThe NvMedia Array NvSciBuf API encompasses all NvMediaArray NvSciBuf handling functions
 NvMedia CVScratchpadThe NvMedia CVScratchpad API creates and destroys CVScratchpad objects for use as scratch memory for internal operation in media processing and computer vision pipelines
 Tensor Handling APIThe Tensor Processing API encompasses all NvMedia tensor related functionality
 Tensor Handling APIThe Tensor Processing API encompasses all NvMedia tensor related functionality
 Tensor Handling Buffer Allocation APIThe NvMedia Tensor NvSciSync API encompasses all NvMedia Tensor Buffer Allocation processing
 Tensor Metadata APIThe NvMedia Tensor Metadata API encompasses all NvMedia Tensor metadata processing
 Video Surface Handling APIThe Video Processing API encompasses all NvMedia video surface related functionality
 AV1 Encoder: Common TypesThe AV1 Encoder API provides AV1 related functions
 VC1 Structures
 VP8 Encoder: Common TypesThe VP8 Encoder API provides VP8 related functions
 VP8 Structures
 VP9 Encoder: Common TypesThe VP9 Encoder API provides VP9 related functions
 VP9 Structures
 Video DecoderDefines and manages objects that decode video
 Video Decoder: Common Types
 Video Decryptor (DRM) APIDecrypts and re-encrypts video data with supported formats for the hardware in a video stream
 Video Mixer
 Video Surface
 NvMedia API for DRIVE OS 6.0NVIDIA NvMedia technology provides powerful processing of multimedia data that enables true hardware acceleration across NVIDIA SoCs. NvMedia is a C-based, frame level API library that provides framework agnostic, distinctive software components, to realize various multimedia use case scenarios
 2D ProcessingThe 2D Processing API encompasses all NvMedia 2D image processing related functionality
 2D Surface and SynchronizationThe NvMedia 2D NvSci API encompasses all NvMedia 2D handling for NvSciBuf NvSciSync related functions
 Common DeclarationsDefines basic types used for video and images throughout the NvMedia API
 Basic NvMedia Types and StructuresDefines basic types used throughout the NvMedia API
 Encode/Decode: Common TypesDefines common types and declarations for decode and encode operations
 Parser APIProvides parsing for decoder frame handling
 Image Handling APIThe Image Processing API encompasses all NvMedia image-related functionality
 Image Decoder
 Image EncoderThe NvMediaIEP object takes uncompressed image data and turns it into a codec specific bitstream. Only H.264, H.265 and VP9 encoding is supported
 Image JPEG DecoderThe NvMediaIJPD object takes a JPEG bitstream and decompress it to image data
 Image JPEG EncoderThe NvMediaIJPE object takes uncompressed image data and turns it into a jpeg bitstream
 Image Optical Flow Accelerator (IOFA)The NvMediaIofa object takes an uncompressed bufObj frame pair and turns them into optical flow / stereo disparity estimation data
 Screen CaptureThe Screen Capture API is implemented by the Screen Capture wrapper library, libnvscrncapt.so
 Screen Capture APIThe Screen Capture API is implemented by the Screen Capture wrapper library, libnvscrncapt.so. Its functions and data structures are declared by the this header file, which applications must include to use the Screen Capture API
 Software Communication InterfacesThe NVIDIA® Software Communication Interfaces (NvSci) libraries serve two primary purposes:
 Inter-Process CommunicationIPC and Event Service APIs
 Event Service APIs
 IPC APIs
 NvStreamsContains the buffer allocation, synchronization, and streaming APIs
 Buffer Allocation APIsThe NvSciBuf library contains the APIs for applications to allocate and exchange buffers in memory
 Streaming APIsThe NvSciStream library is a layer on top of NvSciBuf and NvSciSync libraries that provides utilities for streaming sequences of data packets between multiple application modules to support a wide variety of use cases
 Synchronization APIs
 SCI Error HandlingContains error code enumeration and helper macros