NVIDIA DRIVE OS Linux SDK API Reference

5.2.6 Release
For Test and Development only
nvsipl Namespace Reference

Detailed Description

Contains the classes and variables for implementation of SIPL.

Data Structures

struct  CameraModuleInfo
 Defines information for the camera module. More...
 
struct  DeserInfo
 Defines the deserializer information. More...
 
struct  DeviceBlockInfo
 Defines the DeviceBlock information. More...
 
struct  DeviceInfoList
 Defines a list of all external image devices supported by NvSIPL Query and SIPL Device Block drivers. More...
 
struct  EEPROMInfo
 Defines the EEPROM information. More...
 
class  INvSIPLCamera
 Defines public data structures and describes the interfaces for NvSIPLCamera. More...
 
class  INvSIPLClient
 Defines the public data structures and describes the interfaces for NvSIPL Client. More...
 
class  INvSIPLFrameCompletionQueue
 The interface to the frame completion queue. More...
 
class  INvSIPLNotificationQueue
 The interface to the notification queue. More...
 
class  INvSIPLQuery
 Defines the public data structures and describes the interfaces for NvSIPLQuery. More...
 
class  INvSIPLQueryTrace
 
class  INvSIPLTrace
 Defines the public interfaces to control the logging/tracing of SIPL. More...
 
class  ISiplControlAuto
 Defines SIPL Control Auto Interface Class. More...
 
struct  NvSIPLDeviceBlockQueues
 Holds the queues used by the client to receive device block event notifications. More...
 
struct  NvSIPLDownscaleCropCfg
 Downscale and crop configuration. More...
 
struct  NvSIPLImageAttr
 Describes attributes of images used in image processing pipeline. More...
 
class  NvSIPLImageGroupWriter
 Describes the interfaces of SIPL pipeline feeder. More...
 
struct  NvSIPLNitoMetadata
 NvSIPLNitoMetadata defines the 3-tuple returned by a successful call to GetNitoMetadataFromMemory(). More...
 
struct  NvSIPLPipelineConfiguration
 Defines the camera pipeline configuration. More...
 
class  NvSIPLPipelineNotifier
 Describes the interfaces of the SIPL pipeline notification handler. More...
 
struct  NvSIPLPipelineQueues
 This is the output structure for SetPipelineCfg(). More...
 
struct  NvSIPLVersion
 Holds the version information of NvSIPL Camera and NvSIPL Client. More...
 
struct  PlatformCfg
 Defines the camera platform configuration. More...
 
struct  SensorInfo
 Defines the image sensor information. More...
 
struct  SerdesGPIOPinMap
 Defines GPIO mapping from the serializer to the deserializer. More...
 
struct  SerInfo
 Defines the serializer information. More...
 
struct  SiplControlAutoAwbGain
 Color Gains assuming order RGGB, RCCB, RCCC. More...
 
struct  SiplControlAutoAwbSetting
 Automatic white balance settings. More...
 
struct  SiplControlAutoInputParam
 Input parameters for processing AE/AWB. More...
 
struct  SiplControlAutoOutputParam
 AE/AWB Output parameters. More...
 
struct  SiplControlAutoSensorSetting
 Sensor settings. More...
 
struct  SiplControlEmbedData
 Embedded data and parsed information. More...
 
struct  SiplControlEmbedInfo
 Parsed frame embedded information. More...
 
struct  SiplControlIspStatsInfo
 Structure containing ISP Stats information. More...
 
struct  SiplControlIspStatsSetting
 Structure containing ISP stats settings. More...
 
struct  SIPLErrorDetails
 Error details for a particular device. More...
 

Enumerations

enum  SIPLStatus {
  NVSIPL_STATUS_OK = 0,
  NVSIPL_STATUS_BAD_ARGUMENT,
  NVSIPL_STATUS_NOT_SUPPORTED,
  NVSIPL_STATUS_OUT_OF_MEMORY,
  NVSIPL_STATUS_RESOURCE_ERROR,
  NVSIPL_STATUS_TIMED_OUT,
  NVSIPL_STATUS_INVALID_STATE,
  NVSIPL_STATUS_EOF,
  NVSIPL_STATUS_NOT_INITIALIZED,
  NVSIPL_STATUS_ERROR =127
}
 Defines the status codes returned by functions in SIPL modules. More...
 
enum  SIPLGpioEvent {
  NVSIPL_GPIO_EVENT_NOTHING = 0,
  NVSIPL_GPIO_EVENT_INTR,
  NVSIPL_GPIO_EVENT_ERROR_WAIT_CANCELLED,
  NVSIPL_GPIO_EVENT_ERROR_CDAC,
  NVSIPL_GPIO_EVENT_ERROR_BACKEND,
  NVSIPL_GPIO_EVENT_ERROR_UNKNOWN
}
 CDAC GPIO event codes. More...
 
enum  SIPLModuleErrorReadFlag {
  NVSIPL_MODULE_ERROR_READ_SENSOR,
  NVSIPL_MODULE_ERROR_READ_SERIALIZER,
  NVSIPL_MODULE_ERROR_READ_ALL
}
 Flag indicating which module errors to read. More...
 
enum  PluginType {
  NV_PLUGIN = 0,
  CUSTOM_PLUGIN0,
  MAX_NUM_PLUGINS
}
 Defines types of SIPL Control Auto plug-ins. More...
 

Functions

void NvSIPLGetVersion (NvSIPLVersion &rVersion)
 Gets the library version. More...
 

Variables

static const uint32_t MAX_DEVICEBLOCKS_PER_PLATFORM = 4U
 Indicates the maximum number of device blocks per platform. More...
 
static const uint32_t MAX_CAMERAMODULES_PER_BLOCK = 4U
 Indicates the maximum number of camera modules per device block. More...
 
static const uint32_t MAX_CAMERAMODULES_PER_PLATFORM = MAX_DEVICEBLOCKS_PER_PLATFORM * MAX_CAMERAMODULES_PER_BLOCK
 Indicates the maximum number of camera modules per platform. More...
 
static const uint32_t MAX_SENSORS_PER_PLATFORM = MAX_CAMERAMODULES_PER_PLATFORM
 Indicates the maximum number of sensors per platform. More...
 
static const std::uint32_t MAX_CSI_LANE_CONFIGURATION = 2U
 Indicates the maximum number of CSI lane configurations. More...
 
static const std::uint32_t X2_CSI_LANE_CONFIGURATION = 0U
 Indicates the index for CSI 2 lanes. More...
 
static const std::uint32_t X4_CSI_LANE_CONFIGURATION = 1U
 Indicates the index for CSI 4 lanes. More...
 
constexpr uint32_t NVSIPL_MAJOR_VER = 1U
 Indicates the major revision. More...
 
constexpr uint32_t NVSIPL_MINOR_VER = 0U
 Indicates the minor revision. More...
 
constexpr uint32_t NVSIPL_PATCH_VER = 0U
 Indicates the patch revision. More...
 
const size_t NITO_PARAMETER_SET_ID_SIZE = 16U
 
const size_t NITO_SCHEMA_HASH_SIZE = 32U
 
const size_t NITO_DATA_HASH_SIZE = 32U
 
SIPLStatus GetNitoMetadataFromMemory (uint8_t const *const nitoMem, size_t const nitoMemLength, NvSIPLNitoMetadata *const metadataArray, size_t const metadataArrayLength, size_t *const metadataCount)
 Get NITO Metadata (knobset UUID, schema hash, data hash) from a NITO memory buffer. More...