NVIDIA DRIVE OS Linux SDK API Reference

5.1.12.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nvsipl::NvSIPLPipelineNotifier Class Reference

Detailed Description

Describes the interfaces of the SIPL pipeline notification handler.

This class defines data structures and interfaces that must be implemented by a SIPL pipeline notification handler.

Definition at line 51 of file NvSIPLPipelineMgr.hpp.

Data Structures

struct  NotificationData
 Defines the notification data. More...
 

Public Types

enum  NotificationType {
  NOTIF_INFO_ISP_PROCESSING_DONE = 0,
  NOTIF_INFO_ISC_PROCESSING_DONE,
  NOTIF_INFO_ALG_PROCESSING_DONE,
  NOTIF_INFO_FRAME_CAPTURE,
  NOTIF_INFO_EOF,
  NOTIF_WARNING_CAPTURE_FRAME_DROP = 100,
  NOTIF_WARNING_CSI_FRAME_DISCONTINUITY,
  NOTIF_ERROR_INTERNAL_FAILURE = 200,
  NOTIF_ERROR_I2C_TRANSMISSION_FAILURE,
  NOTIF_ERROR_CSI_INPUT_STREAM_FAILURE,
  NOTIF_ERROR_CSI_LINK_FAILURE,
  NOTIF_ERROR_DESER_LINK_FAILURE,
  NOTIF_ERROR_DESER_LINK_RECOVERY_FAILURE
}
 Defines the events of the image processing pipeline. More...
 
enum  ActionType {
  ACTION_NONE = 0,
  ACTION_ATTEMPT_RECOVERY
}
 Defines the actions to be performed after certain events. More...
 

Public Member Functions

virtual ActionType OnEvent (NotificationData &oNotificationData)
 Handles a pipeline event. More...
 
virtual ~NvSIPLPipelineNotifier (void)=default
 Default destructor. More...
 

Member Enumeration Documentation

Defines the actions to be performed after certain events.

Enumerator
ACTION_NONE 

Specifies no action is to be taken.

ACTION_ATTEMPT_RECOVERY 

Specifies an attempt to recover the pipeline.

Definition at line 88 of file NvSIPLPipelineMgr.hpp.

Defines the events of the image processing pipeline.

Enumerator
NOTIF_INFO_ISP_PROCESSING_DONE 

Indicates ISP processing is finished.

NOTIF_INFO_ISC_PROCESSING_DONE 

Indicates sensor programming is finished.

NOTIF_INFO_ALG_PROCESSING_DONE 

Indicates algorithm processing is finished.

NOTIF_INFO_FRAME_CAPTURE 

Indicates a frame was captured.

NOTIF_INFO_EOF 

Indicates an end-of-file was encountered.

NOTIF_WARNING_CAPTURE_FRAME_DROP 

Indicates pipeline was forced to drop a frame due to a slow consumer or system issues.

NOTIF_WARNING_CSI_FRAME_DISCONTINUITY 

Indicates a CSI frame discontinuity was detected.

NOTIF_ERROR_INTERNAL_FAILURE 

Indicates an unspecified internal failure.

NOTIF_ERROR_I2C_TRANSMISSION_FAILURE 

Indicates I2C transmission failure.

NOTIF_ERROR_CSI_INPUT_STREAM_FAILURE 

Indicates a CSI input stream error.

NOTIF_ERROR_CSI_LINK_FAILURE 

Indicates a CSI link error.

NOTIF_ERROR_DESER_LINK_FAILURE 

Indicates a Deserializer link error.

NOTIF_ERROR_DESER_LINK_RECOVERY_FAILURE 

Indicates a Deserializer link error recovery failure.

Definition at line 55 of file NvSIPLPipelineMgr.hpp.

Constructor & Destructor Documentation

virtual nvsipl::NvSIPLPipelineNotifier::~NvSIPLPipelineNotifier ( void  )
virtualdefault

Default destructor.

Member Function Documentation

virtual ActionType nvsipl::NvSIPLPipelineNotifier::OnEvent ( NotificationData oNotificationData)
inlinevirtual

Handles a pipeline event.

The consumer's implementation overrides this method. The method is called by the SIPL pipeline thread.

The consumer can use pipeline events to track the flow of buffers in the image processing pipeline and take any necessary corrective action in case of an error or unexpected events.

Parameters
[in]oNotificationDataA reference to NotificationData.

Definition at line 116 of file NvSIPLPipelineMgr.hpp.

References ACTION_NONE.


The documentation for this class was generated from the following file: