NVIDIA DRIVE OS Linux SDK API Reference

5.2.0 Release
For Test and Development only
API Modules
Here is a list of all modules:
[detail level 12345]
 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 management
 GPU access API: Device management (safety subset)
 GPU access API: Library
 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
 Direct Rendering Manager
 EGL Specifications and Extensions
 OpenGL ES 2.x/3.x Specs and Extensions
 OpenGL Specifications
 Vulkan Specs and Extensions
 NvMedia API for TegraNVIDIA NvMedia technology provides powerful processing of multimedia data that enables true hardware acceleration across NVIDIA Tegra 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 NvMedia2D NvSciSync handling functions
 Image CaptureCaptures uncompressed image data, writing the results to an NvMediaImage
 Image Capture SynchronizationThe NvMedia ICP NvSciSync API encompasses all NvMediaICP NvSciSync handling functions
 Image CreationDefines and manages image objects
 Image Decoder
 Image Display Processing (IDP)Displays NvMediaImage type surfaces
 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 OFST SynchronizationThe NvMedia IOFST NvSciSync API encompasses all NvMediaIOFST NvSciSync handling functions
 Image OpticalFlow/StereoDisparity (OFST) EstimatorThe NvMediaIOFST object takes an uncompressed image frame pair and turns them into opticalflow/stereodisparity estimation data
 Image Read and Write by ClientProvides image surface read and write by the client application for diagnostic purposes
 Image Sensor Control (ISC)
 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
 Image Pyramid Handling APIThe Image Pyramid Processing API encompasses all NvMedia-related functionality for handling pyramids of NvMediaImage objects
 Image PyramidImage Pyramid Processing API
 Image Pyramid with Buffer Allocation APIThe Image Pyramid with Buffer Allocation API encompasses all NvMedia-related functionality for handling pyramids of NvMediaImage objects with buffer allocation
 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
 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 Capture
 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 Encoder
 Video Mixer
 Video Output
 Video Surface
 Vision Programming InterfaceThe NvMedia Vision Programming Interface (VPI) API contains NvMedia functions for accessing the Computer Vision (CV) hardware accelerated algorithms
 NvMedia VPIAPIs for accessing Computer Vision (CV) hardware-accelerated algorithms
 NvMedia VPI SynchronizationThe NvMedia VPI NvSciSync API encompasses NvMedia VPI functions using synchronization
 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 Communication
 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
 Streaming data typesThe 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