NVIDIA DriveWorks API: Cameras
Description: This file defines camera methods. 
Definition in file Camera.h.
|  | 
| enum | dwCameraOutputType { DW_CAMERA_OUTPUT_NATIVE_PROCESSED = 1 << 0,
 DW_CAMERA_OUTPUT_NATIVE_RAW = 1 << 1,
 DW_CAMERA_OUTPUT_CUDA_RGBA_UINT8 = 1 << 2,
 DW_CAMERA_OUTPUT_CUDA_YUV420_UINT8_PLANAR = 1 << 3,
 DW_CAMERA_OUTPUT_CUDA_RAW_UINT16 = 1 << 4,
 DW_CAMERA_OUTPUT_CUDA_YUV420_UINT16_SEMIPLANAR = 1 << 5,
 DW_CAMERA_OUTPUT_CUDA_YUV444_UINT8_PLANAR = 1 << 6,
 DW_CAMERA_OUTPUT_CUDA_YUV444_UINT16_PLANAR = 1 << 7,
 DW_CAMERA_OUTPUT_CUDA_YUV420_UINT8_SEMIPLANAR = 1 << 8,
 DW_CAMERA_OUTPUT_NATIVE_PROCESSED1 = 1 << 9,
 DW_CAMERA_OUTPUT_NATIVE_PROCESSED2 = 1 << 10,
 DW_CAMERA_OUTPUT_UNSUPPORTED = 1 << 11
 }
 | 
|  | Output types supported by the camera.  More... 
 | 
|  | 
| enum | dwCameraRawFormat { DW_CAMERA_RAW_FORMAT_UNKNOWN = 0,
 DW_CAMERA_RAW_FORMAT_RGGB = 7000,
 DW_CAMERA_RAW_FORMAT_BGGR = 7100,
 DW_CAMERA_RAW_FORMAT_GRBG = 7200,
 DW_CAMERA_RAW_FORMAT_GBRG = 7300,
 DW_CAMERA_RAW_FORMAT_RCCB = 8000,
 DW_CAMERA_RAW_FORMAT_BCCR = 8100,
 DW_CAMERA_RAW_FORMAT_CRBC = 8200,
 DW_CAMERA_RAW_FORMAT_CBRC = 8300,
 DW_CAMERA_RAW_FORMAT_RCCC = 9000,
 DW_CAMERA_RAW_FORMAT_CRCC = 9100,
 DW_CAMERA_RAW_FORMAT_CCRC = 9200,
 DW_CAMERA_RAW_FORMAT_CCCR = 9300,
 DW_CAMERA_RAW_FORMAT_CCCC = 10000,
 DW_CAMERA_RAW_FORMAT_BGGI_RGGI = 0x0000002EU,
 DW_CAMERA_RAW_FORMAT_TOF = 20000,
 DW_CAMERA_RAW_FORMAT_KINECT = 30000,
 DW_CAMERA_RAW_FORMAT_KINECT_IR = 30010,
 DW_CAMERA_RAW_FORMAT_KINECT_DEPTH = 30020
 }
 | 
|  | Raw encoding formats pixel-order.  More... 
 | 
|  | 
| enum | dwCameraType { DW_CAMERA_GENERIC = 0,
 DW_CAMERA_GMSL_AR0231 = 3,
 DW_CAMERA_USB_GENERIC = 4,
 DW_CAMERA_GMSL_AR0144 = 5,
 DW_CAMERA_GMSL_AR0138 = 6,
 DW_CAMERA_GMSL_AR0220 = 7,
 DW_CAMERA_GMSL_AR0820 = 8,
 DW_CAMERA_GMSL_MN34906 = 9,
 DW_CAMERA_GMSL_OV2311 = 10,
 DW_CAMERA_GMSL_IMX390 = 11,
 DW_CAMERA_USB_KINECT = 12,
 DW_CAMERA_GMSL_CUSTOM = 99
 }
 | 
|  | Enum of available camera sensors.  More... 
 | 
|  | 
| enum | dwCameraExposureControl { DW_CAMERA_EXPOSURE_NONE,
 DW_CAMERA_EXPOSURE_UNKNOWN,
 DW_CAMERA_EXPOSURE_AE,
 DW_CAMERA_EXPOSURE_BAE,
 DW_CAMERA_EXPOSURE_CUSTOM
 }
 | 
|  | Enum of exposure control types.  More... 
 | 
|  | 
| enum | dwCameraFOV { DW_CAMERA_FOV_UNKNOWN = 0,
 DW_CAMERA_FOV_30 = 30,
 DW_CAMERA_FOV_48 = 48,
 DW_CAMERA_FOV_50 = 50,
 DW_CAMERA_FOV_55 = 55,
 DW_CAMERA_FOV_60 = 60,
 DW_CAMERA_FOV_65 = 65,
 DW_CAMERA_FOV_90 = 90,
 DW_CAMERA_FOV_100 = 100,
 DW_CAMERA_FOV_110 = 110,
 DW_CAMERA_FOV_120 = 120,
 DW_CAMERA_FOV_185 = 185
 }
 | 
|  | Enum of available FOV in degrees for camera lenses.  More... 
 | 
|  | 
| enum | dwCameraSIPLInterfaceProviderType { DW_SIPL_CAMERA_INTERFACE_PROVIDER_TYPE_DESERIALIZER,
 DW_SIPL_CAMERA_INTERFACE_PROVIDER_TYPE_MODULE,
 DW_SIPL_CAMERA_INTERFACE_PROVIDER_TYPE_COUNT
 }
 | 
|  | Enum of available SIPL interface provider types.  More... 
 | 
|  | 
| enum | dwCameraISPType { DW_CAMERA_ISP0 = 0,
 DW_CAMERA_ISP1,
 DW_CAMERA_ISP2,
 DW_CAMERA_MAX_ISP_COUNT,
 DW_CAMERA_ISP_UNKNOWN
 }
 | 
|  | ISP types supported by the camera.  More... 
 | 
|  | 
| enum | dwCameraSIPLNotificationData { DW_NOTIF_INFO_ICP_PROCESSING_DONE = 0,
 DW_NOTIF_INFO_ISP_PROCESSING_DONE = 1,
 DW_NOTIF_INFO_ACP_PROCESSING_DONE = 2,
 DW_NOTIF_INFO_CDI_PROCESSING_DONE = 3,
 DW_NOTIF_INFO_ICP_AUTH_SUCCESS = 4,
 DW_NOTIF_WARN_ICP_FRAME_DROP = 100,
 DW_NOTIF_WARN_ICP_FRAME_DISCONTINUITY = 101,
 DW_NOTIF_WARN_ICP_CAPTURE_TIMEOUT = 102,
 DW_NOTIF_ERROR_ICP_BAD_INPUT_STREAM = 200,
 DW_NOTIF_ERROR_ICP_CAPTURE_FAILURE = 201,
 DW_NOTIF_ERROR_ICP_EMB_DATA_PARSE_FAILURE = 202,
 DW_NOTIF_ERROR_ISP_PROCESSING_FAILURE = 203,
 DW_NOTIF_ERROR_ACP_PROCESSING_FAILURE = 204,
 DW_NOTIF_ERROR_CDI_SET_SENSOR_CTRL_FAILURE = 205,
 DW_NOTIF_ERROR_DESER_LINK_FAILURE = 206,
 DW_NOTIF_ERROR_DESERIALIZER_FAILURE = 207,
 DW_NOTIF_ERROR_SERIALIZER_FAILURE = 208,
 DW_NOTIF_ERROR_SENSOR_FAILURE = 209,
 DW_NOTIF_ERROR_ICP_AUTH_FAILURE = 211,
 DW_NOTIF_ERROR_ICP_AUTH_OUT_OF_ORDER = 212,
 DW_NOTIF_ERROR_INTERNAL_FAILURE = 300
 }
 | 
|  | Enum of available SIPL event notification type (Copy from nvsipl::NvSIPLPipelineNotifier::NotificationType).  More... 
 | 
|  | 
| enum | dwCameraEvent { DW_CAMERA_EVENT_WARN_ICP_FRAME_DISCONTINUITY = 4,
 DW_CAMERA_EVENT_WARN_ICP_CAPTURE_TIMEOUT,
 DW_CAMERA_EVENT_ERROR_ICP_BAD_INPUT_STREAM,
 DW_CAMERA_EVENT_ERROR_ICP_CAPTURE_FAILURE,
 DW_CAMERA_EVENT_ERROR_ICP_EMB_DATA_PARSE_FAILURE,
 DW_CAMERA_EVENT_ERROR_ISP_PROCESSING_FAILURE,
 DW_CAMERA_EVENT_ERROR_ACP_PROCESSING_FAILURE,
 DW_CAMERA_EVENT_ERROR_CDI_SET_SENSOR_CTRL_FAILURE,
 DW_CAMERA_EVENT_ERROR_DESER_LINK_FAILURE,
 DW_CAMERA_EVENT_ERROR_DESERIALIZER_FAILURE,
 DW_CAMERA_EVENT_ERROR_SERIALIZER_FAILURE,
 DW_CAMERA_EVENT_ERROR_SENSOR_FAILURE,
 DW_CAMERA_EVENT_ERROR_INTERNAL_FAILURE,
 DW_CAMERA_EVENT_ERROR_FRAME_OVERRUN,
 DW_CAMERA_EVENT_ERROR_FRAME_COUNTER
 }
 | 
|  | defines camera events exposed by dwCamera  More... 
 | 
|  | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_readFrame (dwCameraFrameHandle_t *const frameHandle, dwTime_t const timeoutUs, dwSensorHandle_t const sensor) | 
|  | Reads a frame handle from the camera sensor.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_returnFrame (dwCameraFrameHandle_t *const frameHandle) | 
|  | Returns a frame to the camera after it has been consumed.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_getImage (dwImageHandle_t *const image, dwCameraOutputType const type, dwCameraFrameHandle_t const frame) | 
|  | Gets the output image/s image in a format specified by the output type.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_getImageAsync (dwImageHandle_t *const image, dwCameraOutputType const type, dwCameraFrameHandle_t const frame) | 
|  | Gets the output image/s image in a format specified by the output type.  More... 
 | 
|  | 
| DW_API_PUBLIC | DW_DEPRECATED ("dwSensorCamera_setImagePool() is deprecated and will be removed in the next major release," " use dwSensorCamera_setImagePoolNew() instead") dwStatus dwSensorCamera_setImagePool(dwImagePool imagePool | 
|  | Sets a pool of image to be used as output by the camera layer.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_setImagePoolNew (dwImagePool imagePool, dwCameraOutputType const type, dwSensorHandle_t const sensor) | 
|  | Sets a pool of image to be used as output by the camera layer.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_appendAllocationAttributes (dwImageProperties *const imgProps, dwCameraOutputType const outputType, dwSensorHandle_t const sensor) | 
|  | Append the allocation attribute such that images allocated by the application and given to the camera via dwSensorCamera_setImagePool() can be imported into the underlying driver.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_getSensorProperties (dwCameraProperties *const properties, dwSensorHandle_t const sensor) | 
|  | Gets information about the camera sensor.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_getNumSupportedCaptureModes (uint32_t *const numModes, dwSensorHandle_t const sensor) | 
|  | Gets number of supported capture modes.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_getSupportedCaptureMode (dwCameraProperties *const captureMode, uint32_t const modeIdx, dwSensorHandle_t const sensor) | 
|  | Gets capture modes by specified index.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_getImageProperties (dwImageProperties *const imageProperties, dwCameraOutputType const outputType, dwSensorHandle_t const sensor) | 
|  | Gets information about the image properties for a given 'dwCameraImageOutputType'.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_setImageAttributes (dwImageProperties *const imageProperties, dwCameraOutputType const outputType, dwSensorHandle_t const sensor) | 
|  | Overrides the properties of the images in the internal pool.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_setCUDAStream (cudaStream_t const stream, dwSensorHandle_t const sensor) | 
|  | Sets the CUDA stream used by getImageAsync during internal cuda related operations Cuda stream is a bunch of asynchronous Cuda operations executed on the device in the order that the host code calls.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_getCUDAStream (cudaStream_t *const stream, dwSensorHandle_t const sensor) | 
|  | Gets the CUDA stream used.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_getTimestamp (dwTime_t *const timestamp, dwCameraFrameHandle_t const frameHandle) | 
|  | Gets the timestamp of the current camera frame.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_getImageTimestamps (dwImageTimestamps *const imageTimestamps, dwCameraFrameHandle_t const frameHandle) | 
|  | Gets the timestamps of the current camera frame.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_getSIPLInterfaceProvider (void **const interfaceProvider, dwSensorHandle_t const sensor, dwSIPLCameraInterfaceProviderType const type) | 
|  | Gets SIPL Interface provider for a custom camera sensor.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_readEEPROM (uint32_t const paramId, void *const buffer, uint32_t const size, dwSensorHandle_t const sensor) | 
|  | Read data associated with a parameter stored on the EEPROM device and write to the provided buffer.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_getEOFFence (NvSciSyncFence *syncFence, dwCameraOutputType outputType, dwCameraFrameHandle_t const frameHandle) | 
|  | Get EOF fence of the current camera frame according to the type of dwCameraOutputType.  More... 
 | 
|  | 
| DW_API_PUBLIC | DW_DEPRECATED ("dwSensorCamera_fillSyncAttributes() is deprecated and will be removed in the next major release," " use dwSensorCamera_fillSyncAttributesNew() instead") dwStatus dwSensorCamera_fillSyncAttributes(NvSciSyncAttrList syncAttrList | 
|  | Fill the sync attributes for the camera pipeline to signal EOF fences.  More... 
 | 
|  | 
| DW_API_PUBLIC | DW_DEPRECATED ("dwSensorCamera_setSyncObject() is deprecated and will be removed in the next major release," " use dwSensorCamera_setSyncObjectNew() instead") dwStatus dwSensorCamera_setSyncObject(NvSciSyncObj syncObj | 
|  | Set the sync obj to which the camera pipeline will signal EOF fences.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_setSyncObjectNew (NvSciSyncObj syncObj, dwSyncType syncType, dwCameraOutputType outputType, dwSensorHandle_t sensor) | 
|  | Set the sync obj to which the camera pipeline will signal EOF fences.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_fillSyncAttributesNew (NvSciSyncAttrList syncAttrList, dwSyncType syncType, dwCameraOutputType outputType, dwSensorHandle_t sensor) | 
|  | Fill the sync attributes for the camera pipeline to signal EOF fences.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_addPreFenceArray (NvSciSyncFence *syncFences, uint32_t count, dwCameraOutputType outputType, dwCameraFrameHandle_t const frameHandle) | 
|  | Set array of prefences and a type of dwCameraOutputType so that camera waits on those fences before the use of that output.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_setEventCallback (dwCameraCallback blkCallback, dwCameraCallback lineCallback, dwSensorHandle_t sensor) | 
|  | Set the Camera Error Handling callbacks.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_disableLink (dwSensorHandle_t const sensor) | 
|  | Disable the camera link.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_enableLink (dwSensorHandle_t const sensor, bool const resetModule) | 
|  | Enable the camera link.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_setImageMetaDataStats (dwCameraIspStatsOverrideSetting const *overrideISPStats, dwSensorHandle_t sensor) | 
|  | Overrides ISP statistics (Histogram, Local Average Clip and bad pixel) settings.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_lockImage (dwImageHandle_t image, dwSensorHandle_t const sensor) | 
|  | Locks an image from the camera sensor for processing to add reference to the image.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_unlockImage (dwImageHandle_t image, dwSensorHandle_t const sensor) | 
|  | Unlocks a previously locked image from a camera sensor.  More... 
 | 
|  | 
| DW_API_PUBLIC dwStatus | dwSensorCamera_setHeaterState (dwSensorHandle_t const sensor, bool const state) | 
|  | Turns camera heater on or off.  More... 
 | 
|  |