Defines public data structures and describes the interfaces for NvSIPLCamera.
Definition at line 57 of file NvSIPLCamera.hpp.
Data Structures | |
struct | PoolCookies |
Vector of buffer cookies and associated producer NvSciStreamBlock. More... | |
Public Member Functions | |
virtual SIPLStatus | SetPlatformCfg (const PlatformCfg *platformCfg)=0 |
Sets a platform configuration. More... | |
virtual SIPLStatus | SetPipelineCfg (std::uint32_t index, const NvSIPLPipelineCfg &pipelineCfg)=0 |
Sets a pipeline configuration. More... | |
virtual SIPLStatus | RegisterAutoControlPlugin (std::uint32_t index, INvSIPLAutoControl::PluginType type, INvSIPLAutoControl *autoControl, const std::vector< std::uint8_t > &blob)=0 |
Register Auto Control plugin to be used for specific pipeline. More... | |
virtual SIPLStatus | Init (void)=0 |
Initializes NvSIPL Camera (libnvsipl.so) for the selected platform configuration. More... | |
virtual SIPLStatus | SetISPConfig (std::uint32_t index, INvSIPLAutoControl::PluginType autoPluginType)=0 |
Set ISP configuration for a pipeline. More... | |
virtual SIPLStatus | GetImageAttributes (std::uint32_t index, INvSIPLClient::ConsumerDesc::OutputType outType, NvSIPLImageAttr &imageAttr)=0 |
Gets Image Attributes. More... | |
virtual NvMediaISCDevice * | GetE2PHandle (std::uint32_t index)=0 |
Get EEPROM ISC handle. More... | |
virtual SIPLStatus | RegisterImageGroups (std::uint32_t index, const std::vector< NvMediaImageGroup * > &imageGroups, PoolCookies *poolCookies=nullptr)=0 |
Registers image groups. More... | |
virtual SIPLStatus | RegisterImages (std::uint32_t index, INvSIPLClient::ConsumerDesc::OutputType outType, const std::vector< NvMediaImage * > &images, PoolCookies *poolCookies=nullptr)=0 |
Registers images. More... | |
virtual SIPLStatus | Start (void)=0 |
Starts NvSIPL Camera (libnvsipl.so) for the selected platform configuration. More... | |
virtual SIPLStatus | Stop (void)=0 |
Stops NvSIPL Camera (libnvsipl.so) for the selected platform configuration. More... | |
virtual SIPLStatus | Deinit (void)=0 |
De-initializes NvSIPL Camera (libnvsipl.so) for the selected platform configuration. More... | |
virtual SIPLStatus | RecoverLink (std::uint32_t index)=0 |
Attempts to recover a given link. More... | |
virtual | ~INvSIPLCamera (void)=default |
Default destructor. More... | |
virtual SIPLStatus | FillNvSciSyncAttrList (std::uint32_t index, INvSIPLClient::ConsumerDesc::OutputType outType, NvSciSyncAttrList attrList, NvMediaNvSciSyncClientType clientType)=0 |
Fills an NvSciSyncAttrList. More... | |
virtual SIPLStatus | RegisterNvSciSyncObj (std::uint32_t index, INvSIPLClient::ConsumerDesc::OutputType outType, NvMediaNvSciSyncObjType syncobjtype, NvSciSyncObj syncobj)=0 |
Register an NvSciSyncObj. More... | |
virtual SIPLStatus | SetNvSciSyncObjForEOF (std::uint32_t index, INvSIPLClient::ConsumerDesc::OutputType outType, NvSciSyncObj syncobj)=0 |
Set the EOF NvSciSyncObj. More... | |
Static Public Member Functions | |
static std::unique_ptr< INvSIPLCamera > | GetInstance (void) |
Gets a handle to INvSIPLCamera instance. More... | |
|
virtualdefault |
Default destructor.
|
pure virtual |
De-initializes NvSIPL Camera (libnvsipl.so) for the selected platform configuration.
The method internally De-initializes the NvSIPL DeviceBlock (libnvsipl_devblk.so) for each device block in the selected platform configuration and De-initializes and destroys the image processing pipelines.
Any registered images are automatically de-registered and can be safely destroyed.
This method must be called after Stop().
|
pure virtual |
Fills an NvSciSyncAttrList.
The method can be used to fetch the NvSciSync attributes required for compatiblility with the underlying image processing pipelines.
If using NvSci, this method must be called after Init() and before RegisterNvSciSyncObj().
[in] | index | The ID of the sensor. |
[in] | outType | nvsipl::INvSIPLClient::ConsumerDesc::OutputType. |
[out] | attrList | NvSciSyncAttrList to be filled. |
[in] | clientType | Waiter, signaler, or both. |
|
pure virtual |
Get EEPROM ISC handle.
This method can be used to get EEPROM ISC handle.
[in] | index | ID of the sensor |
|
pure virtual |
Gets Image Attributes.
The method can be used to get the attributes of the images to be used with image processing pipelines. User must reconcile the attributes returned by this function with the attributes required by the downstream consumers of the output of pipeline and allocate the images.
This method must be called after Init() but before Start().
[in] | index | The ID of the sensor. |
[in] | outType | nvsipl::INvSIPLClient::ConsumerDesc::OutputType. |
[out] | imageAttr | reference to the image attributes structures. |
|
static |
Gets a handle to INvSIPLCamera instance.
Static function to create an instance of implementation class and return the handle. The object is automatically destroyed when the variable holding the return value goes out of scope.
|
pure virtual |
Initializes NvSIPL Camera (libnvsipl.so) for the selected platform configuration.
The method internally initializes the NvSIPL DeviceBlock (libnvsipl_devblk.so) for each device block in the selected platform configuration and creates and initializes the image processing pipelines based on the number and type of the consumers set via SetPipelineCfg.
This method must be called after SetPlatformCfg and SetPipelineCfg.
|
pure virtual |
Attempts to recover a given link.
The method tries to recover a link that has failed.
If this method is called on a link that has not failed, nothing will happen.
This method should only be called after Start() and before Stop().
[in] | index | The ID of the sensor. |
|
pure virtual |
Register Auto Control plugin to be used for specific pipeline.
This method must be called for every pipeline with ISP output enabled.
[in] | index | The ID of the sensor. |
[in] | type | Type of plugin type. |
[in] | autoControl | INvSIPLAutoControl Handle to plugin implementation. |
[in] | blob | Reference to binary blob containing the ISP configuration. |
|
pure virtual |
Registers image groups.
The method can be used to register the NvMedia image groups to be used within image processing pipelines. NvMediaImageGroup serve as output of ICP and input to ISP.
This method must be called after Init() but before Start() and before RegisterAutoControlPlugin().
[in] | index | The ID of the sensor. |
[in] | imageGroups | Vector of NvMediaImageGroup pointers to be registered. |
[in] | poolCookies | Vector of NvSciStream cookies in the same order as imageGroups . |
|
pure virtual |
Registers images.
The method can be used to register the images to be used within image processing pipelines. Images serve as output of ISP.
This method must be called after Init() but before Start() and before RegisterAutoControlPlugin().
[in] | index | The ID of the sensor. |
[in] | outType | nvsipl::INvSIPLClient::ConsumerDesc::OutputType, can be ISP0 or ISP1. |
[in] | images | Vector of NvMediaImage pointers to be registered. |
[in] | poolCookies | Vector of NvSciStream cookies in the same order as images . |
|
pure virtual |
Register an NvSciSyncObj.
If using NvSci, this method must be called after FillNvSciSyncAttrList() and before SetNvSciSyncObjForEOF().
[in] | index | The ID of the sensor. |
[in] | outType | nvsipl::INvSIPLClient::ConsumerDesc::OutputType. |
[in] | syncobjtype | Presync, EOF sync, or presync and EOF. |
[in] | syncobj | NvSciSyncObj to be registered. |
|
pure virtual |
Set ISP configuration for a pipeline.
This method can be used to set ISP configuration for a pipeline. This function can be called only after RegisterAutoControlPlugin() and Init().
[in] | index | ID of the pipeline. |
[in] | autoPluginType | type of the Auto Plug-in type. |
|
pure virtual |
Set the EOF NvSciSyncObj.
Set the engine's current EOF NvSciSync object.
If using NvSci, this method must be called after RegisterNvSciSyncObj() and before Start().
[in] | index | The ID of the sensor. |
[in] | outType | nvsipl::INvSIPLClient::ConsumerDesc::OutputType. |
[in] | syncobj | NvSciSyncObj to be registered. |
|
pure virtual |
Sets a pipeline configuration.
The method sets a camera pipeline configuration. NvSIPLCamera uses the information in the pipeline configuration to initialize the Pipeline Manager.
[in] | index | The ID of the sensor. |
[in] | pipelineCfg | An NvSIPLPipelineCfg to set. |
|
pure virtual |
Sets a platform configuration.
The method sets a PlatformCfg camera platform configuration. NvSIPLCamera uses the information in the platform configuration to create the necessary DeviceBlock(s) and Pipeline Manager(s).
[in] | platformCfg | PlatformCfg The external devices referenced in the platform configuration must be supported by the NvSIPL DeviceBlock (libnvsipl_devblk.so). |
|
pure virtual |
Starts NvSIPL Camera (libnvsipl.so) for the selected platform configuration.
The method internally starts the streaming from sensors belonging to each device block in the selected platform configuration and starts the associated image processing pipelines.
This method must be called after Init(), RegisterImageGroups() and/or RegisterImages(), and (only if using NvSci) SetNvSciSyncObjForEOF().
|
pure virtual |
Stops NvSIPL Camera (libnvsipl.so) for the selected platform configuration.
The method internally stops the streaming from sensors belonging to each device block in the selected platform configuration and stops the associated image processing pipelines.
This method must be called after Start().