NVIDIA DRIVE OS Linux API Reference

5.1.3.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Common Declarations

Detailed Description

Defines common values and error codes for NvROS related functions and NVIDIA® CUDA® processing on the EGL CUDA IO pipeline.

Macros

#define DEFAULT_DISPLAY_WIDTH   1920
 Default width of the display. More...
 
#define DEFAULT_DISPLAY_HEIGHT   1080
 Default height of the display. More...
 
#define DEFAULT_WINDOW_OFFSET_X   0
 Default horizontal offset. More...
 
#define DEFAULT_WINDOW_OFFSET_Y   0
 Default vertical offset. More...
 
#define DEFAULT_DISPLAY_ID   0
 Default display ID. More...
 
#define SECONDARY_DISPLAY_ID   2
 Secondary display ID. More...
 
#define DEFAULT_WINDOW_ID   0
 Default window ID. More...
 
#define DEFAULT_EGLSTREAM_MODE   1
 Sets the EGLStream mode to EGLDEVICE by default. More...
 
#define CUDA_KERNEL_RGBA_TO_GREY   1
 Default CUDA kernel ID to select rgba_to_grey CUDA processing kernel for EGL CUDA IO pipeline. More...
 
#define CUDA_KERNEL_SOBEL   2
 CUDA kernel ID to select sobel CUDA processing kernel for EGL CUDA IO pipeline. More...
 
#define CUDA_KERNEL_NEGATIVE_RGBA   3
 CUDA kernel ID to select negative_rgba CUDA processing kernel for EGL CUDA IO pipeline. More...
 
#define DEFAULT_CSI_PORT_ID   0
 Selects 0th port of group A on NVIDIA DRIVE AGX for CSI camera by default. More...
 
#define ONE_FRAME_TIME_US_30_FPS   33334
 Time, in microseconds, for one frame at 30 FPS frame rate. More...
 
#define MAX_WAIT_TIMEOUT_FRAMES   100
 Maximum wait time in number of frames. More...
 
#define MAX_SERVICE_WAIT_TIMEOUT_MS   100
 Maximum wait time for a service to become available after the node is launched. More...
 
#define IS_RGBA_CONVERSION   1
 Default value to enable yuv422p frame conversion to RGBA frame on capture from GMSL camera before passing to EGLStream for further processing. More...
 

Typedefs

typedef enum nvros::_NvRosErrCode nvros::NvRosErr
 Declares error codes for all NvROS modules and packages. More...
 

Enumerations

enum  nvros::_NvRosErrCode {
  nvros::NVROS_SUCCESS =0,
  nvros::NVROS_ERR_NO_MEM =-1,
  nvros::NVROS_ERR_NVMEDIA =-2,
  nvros::NVROS_ERR =-3,
  nvros::NVROS_ERR_BAD_PARAMS =-4
}
 Declares error codes for all NvROS modules and packages. More...
 

Functions

const std::string nvros::InitCamPreviewService ("nvros_init_cam_preview")
 Constant string for initializing camera preview services. More...
 
const std::string nvros::CloseCamPreviewService ("nvros_close_cam_preview")
 Constant string for closing camera preview services. More...
 
const std::string nvros::StartCameraCaptureService ("camera_start")
 Constant string for starting camera capture services. More...
 
const std::string nvros::StopCameraCaptureService ("camera_stop")
 Constant string for closing camera capture services. More...
 
const std::string nvros::InitCudaProcessingService ("nvros_init_cuda_processing")
 Constant string for initializing CUDA processing services. More...
 
const std::string nvros::CloseCudaProcessingService ("nvros_close_cuda_processing")
 Constant string for closing CUDA processing services. More...
 
const std::string nvros::SocketPathOutput ("/tmp/nvmedia_egl_socket_out")
 Constant string for default output EGL socket_path value for the cuda_processor node. More...
 
const std::string nvros::Default_GroupName ("A")
 Default group name for the camera capture node. More...
 
const std::string nvros::Default_FileName ("drive-px2-a.conf")
 Default configuration file for OV10635 camera parameters. More...
 

Macro Definition Documentation

#define CUDA_KERNEL_NEGATIVE_RGBA   3

CUDA kernel ID to select negative_rgba CUDA processing kernel for EGL CUDA IO pipeline.

Definition at line 97 of file nvroscommon.h.

#define CUDA_KERNEL_RGBA_TO_GREY   1

Default CUDA kernel ID to select rgba_to_grey CUDA processing kernel for EGL CUDA IO pipeline.

Definition at line 91 of file nvroscommon.h.

#define CUDA_KERNEL_SOBEL   2

CUDA kernel ID to select sobel CUDA processing kernel for EGL CUDA IO pipeline.

Definition at line 94 of file nvroscommon.h.

#define DEFAULT_CSI_PORT_ID   0

Selects 0th port of group A on NVIDIA DRIVE AGX for CSI camera by default.

Definition at line 101 of file nvroscommon.h.

#define DEFAULT_DISPLAY_HEIGHT   1080

Default height of the display.

Definition at line 69 of file nvroscommon.h.

#define DEFAULT_DISPLAY_ID   0

Default display ID.

Definition at line 78 of file nvroscommon.h.

#define DEFAULT_DISPLAY_WIDTH   1920

Default width of the display.

Definition at line 66 of file nvroscommon.h.

#define DEFAULT_EGLSTREAM_MODE   1

Sets the EGLStream mode to EGLDEVICE by default.

Definition at line 87 of file nvroscommon.h.

#define DEFAULT_WINDOW_ID   0

Default window ID.

Definition at line 84 of file nvroscommon.h.

#define DEFAULT_WINDOW_OFFSET_X   0

Default horizontal offset.

Definition at line 72 of file nvroscommon.h.

#define DEFAULT_WINDOW_OFFSET_Y   0

Default vertical offset.

Definition at line 75 of file nvroscommon.h.

#define IS_RGBA_CONVERSION   1

Default value to enable yuv422p frame conversion to RGBA frame on capture from GMSL camera before passing to EGLStream for further processing.

Definition at line 124 of file nvroscommon.h.

#define MAX_SERVICE_WAIT_TIMEOUT_MS   100

Maximum wait time for a service to become available after the node is launched.

Note
The value of this macro is not perfectly tuned but observed to be good for many use cases. This may likely cause some performance issues in unexplored use cases.

Definition at line 119 of file nvroscommon.h.

#define MAX_WAIT_TIMEOUT_FRAMES   100

Maximum wait time in number of frames.

Note
The value of this macro is not perfectly tuned but is observed to be good for many use cases. This may likely cause some performance issue in unexplored use cases.

Definition at line 111 of file nvroscommon.h.

#define ONE_FRAME_TIME_US_30_FPS   33334

Time, in microseconds, for one frame at 30 FPS frame rate.

Definition at line 104 of file nvroscommon.h.

#define SECONDARY_DISPLAY_ID   2

Secondary display ID.

Definition at line 81 of file nvroscommon.h.

Typedef Documentation

Declares error codes for all NvROS modules and packages.

Enumeration Type Documentation

Declares error codes for all NvROS modules and packages.

Enumerator
NVROS_SUCCESS 

Indicates the API was successfully executed.

NVROS_ERR_NO_MEM 

Indicates dynamic memory allocation failed during API execution.

NVROS_ERR_NVMEDIA 

Indicates an error occurred while executing one or more NvMedia API.

NVROS_ERR 

Indicates an error occurred due to a miscellaneous reason other than NVROS_ERR_NO_MEM and NVROS_ERR_NVMEDIA.

NVROS_ERR_BAD_PARAMS 

Indicates an error occurred due to bad parameters passed in the API.

Definition at line 42 of file nvroscommon.h.

Function Documentation

const std::string nvros::CloseCamPreviewService ( "nvros_close_cam_preview"  )

Constant string for closing camera preview services.

const std::string nvros::CloseCudaProcessingService ( "nvros_close_cuda_processing"  )

Constant string for closing CUDA processing services.

const std::string nvros::Default_FileName ( "drive-px2-a.conf"  )

Default configuration file for OV10635 camera parameters.

const std::string nvros::Default_GroupName ( "A"  )

Default group name for the camera capture node.

const std::string nvros::InitCamPreviewService ( "nvros_init_cam_preview"  )

Constant string for initializing camera preview services.

const std::string nvros::InitCudaProcessingService ( "nvros_init_cuda_processing"  )

Constant string for initializing CUDA processing services.

const std::string nvros::SocketPathOutput ( "/tmp/nvmedia_egl_socket_out"  )

Constant string for default output EGL socket_path value for the cuda_processor node.

const std::string nvros::StartCameraCaptureService ( "camera_start"  )

Constant string for starting camera capture services.

const std::string nvros::StopCameraCaptureService ( "camera_stop"  )

Constant string for closing camera capture services.