NVIDIA DRIVE OS Linux API Reference

5.1.3.0 Release

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

Detailed Description

Creates image capture pipelines for NvROS on the NVIDIA DRIVE AGX platform through AR0231 imaging sensors.

This class internally uses NvMediaIPPComponent to set up the image capture pipeline.

Definition at line 92 of file NvRosImgPipeline.h.

Public Member Functions

NvRosErr SetCaptureConfig (const char *cfgFilePath, const unsigned int camGrp, const unsigned int cameras)
 Sets the configuration parameters for an image capture pipeline and must be called first after the NvRosImgPipeline class is instantiated. More...
 
NvRosErr InitPipeline ()
 Initializes the NvRosImgPipeline which internally initializes the NvMediaIPPPipeline. More...
 
NvRosErr StartPipeline ()
 Starts the NvRosImgPipeline and must be called after SetCaptureConfig and InitPipeline. More...
 
NvRosErr StopPipeline ()
 Stops the NvRosImgPipeline put into execution by StartPipeline. More...
 
NvRosErr ShutdownPipeline ()
 Shuts down the NvRosImgPipeline and uninitializes all settings prior to starting the pipeline. More...
 

Member Function Documentation

NvRosErr nvros::NvRosImgPipeline::InitPipeline ( )

Initializes the NvRosImgPipeline which internally initializes the NvMediaIPPPipeline.

This mainly consists of initializing capture sensor parameters and ISP.

Returns
NVROS_SUCCESS on successful execution, or NVROS_ERR otherwise.
NvRosErr nvros::NvRosImgPipeline::SetCaptureConfig ( const char *  cfgFilePath,
const unsigned int  camGrp,
const unsigned int  cameras 
)

Sets the configuration parameters for an image capture pipeline and must be called first after the NvRosImgPipeline class is instantiated.

Parameters
cfgFilePathFully qualified path of the configuration file. Camera capture configuration is specific to the platform. Currently, NvRosImgPipeline is supported only on NVIDIA DRIVE AGX. The configuration file is located in the target file system at $NVIDIA_HOME/drive-t186ref-linux/samples/nvmedia/ipp_raw/ddpx-a.conf for the Tegra X1 module on DRIVE AGX and $NVIDIA_HOME/drive-t186ref-linux/samples/nvmedia/ipp_raw/ddpx-b.conf for the Tegra X2 module on DRIVE AGX.
camGrpImage capture is intended for this camera group ID. NVIDIA DRIVE AGX has four (4) camera groups. A valid value for this parameter is [0,3].
camerasImage capture is intended for these number of cameras. Each camera group on NVIDIA DRIVE AGX consists of four (4) cameras. A valid value for this parameter is [1,4].
Returns
NVROS_SUCCESS on successful execution, or NVROS_ERR otherwise.
NvRosErr nvros::NvRosImgPipeline::ShutdownPipeline ( )

Shuts down the NvRosImgPipeline and uninitializes all settings prior to starting the pipeline.

Ideally, the function is called at the end of the image capture application.

Returns
NVROS_SUCCESS on successful execution, or NVROS_ERR otherwise.
NvRosErr nvros::NvRosImgPipeline::StartPipeline ( )

Starts the NvRosImgPipeline and must be called after SetCaptureConfig and InitPipeline.

To avoid undefined behavior, follow the correct API sequence.

Returns
NVROS_SUCCESS on successful execution, or NVROS_ERR otherwise.
NvRosErr nvros::NvRosImgPipeline::StopPipeline ( )

Stops the NvRosImgPipeline put into execution by StartPipeline.

This function suspends the pipeline and does not perform a tear down. The pipeline can be restarted by calling StartPipeline. Once StartPipeline is successful, the image stream is available on an EGLStream whose socket path is identified as below: /tmp/nvros_cam_X_Y where X is an identifier for the camera group and Y is an identifier for the camera number in Xth camera group. For example, if SetCaptureConfig is called with camGrp : 0 and cameras : 1, the image stream is available on /tmp/nvros_cam_0_0. If SetCaptureConfig is called with camGrp: 1 and cameras : 4, four (4) image streams are available on: /tmp/nvros_cam_1_0, /tmp/nvros_cam_1_1, /tmp/nvros_cam_1_2, and /tmp/nvros_cam_1_3. You must connect to the EGLStreams to process the image streams.

Returns
NVROS_SUCCESS on successful execution, or NVROS_ERR otherwise.

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