v4l2_nv_extensions.h File Reference

Detailed Description

NVIDIA V4L2 API Extensions

Description: This file declares NVIDIA V4L2 extensions, controls and structures.

Definition in file v4l2_nv_extensions.h.

Go to the source code of this file.

Data Structures
struct	v4l2_ctrl_videodec_statusmetadata_
	Holds the decoder error status metadata for the frame. More...
struct	v4l2_ctrl_videodec_refframe_metadata_
	Holds the the frame specific metadata for a reference frame. More...
struct	v4l2_ctrl_videodec_currentframe_metadata_
	Holds the the frame specific metadata for the current frame. More...
struct	v4l2_ctrl_videodec_dpbinfometadata_
	Holds the decoder DPB info metadata. More...
struct	v4l2_ctrl_h264dec_bufmetadata_
	Holds H.264 specific decoder metadata for the frame. More...
struct	v4l2_ctrl_hevcdec_bufmetadata_
	Holds H.265 specific decoder metadata for the frame. More...
struct	v4l2_ctrl_videodec_outputbuf_metadata_
	Holds the video decoder output metadata for a frame. More...
struct	v4l2_enc_hw_preset_type_param_
	Holds encoder HW Preset type parameters to be used with V4L2_CID_MPEG_VIDEOENC_HW_PRESET_TYPE_PARAM IOCTL. More...
struct	v4l2_enc_slice_length_param_
	Holds encoder slice length parameters, to be used with V4L2_CID_MPEG_VIDEOENC_SLICE_LENGTH_PARAM IOCTL. More...
struct	v4l2_enc_virtual_buffer_size_
	Holds encoder virtual buffer size parameters, to be used with V4L2_CID_MPEG_VIDEOENC_VIRTUALBUFFER_SIZE IOCTL. More...
struct	v4l2_enc_num_ref_frames_
	Holds encoder number of reference frame parameters, to be used with V4L2_CID_MPEG_VIDEOENC_NUM_REFERENCE_FRAMES IOCTL. More...
struct	v4l2_enc_slice_intrarefresh_param_
	Holds encoder slice intrareferesh parameters, to be used with V4L2_CID_MPEG_VIDEOENC_SLICE_INTRAREFRESH_PARAM IOCTL. More...
struct	v4l2_enc_ROI_param_
	Holds the encoder quality parameters for a single ROI region. More...
struct	v4l2_enc_frame_ROI_params_
	Holds the encoder frame ROI parameters to be used with V4L2_CID_MPEG_VIDEOENC_ROI_PARAMS IOCTL. More...
struct	MVInfo_
	Holds the motion vector parameters for a single macro block. More...
struct	v4l2_ctrl_videoenc_outputbuf_metadata_MV_
	Holds the motion vector parameters for one complete frame. More...
struct	v4l2_enc_frame_full_prop_
	Holds the RPS List parameters of encoded frame. More...
struct	v4l2_ctrl_videoenc_outputbuf_metadata_
	Holds the encoder output metadata for a frame, to be used with V4L2_CID_MPEG_VIDEOENC_METADATA IOCTL. More...
struct	v4l2_ctrl_video_metadata_
	Holds the metadata parameters for video encoder and decoder. More...
struct	v4l2_enc_gdr_params_
	Holds the encoder GDR parameters to be used with V4L2_CID_MPEG_VIDEOENC_INPUT_METADATA IOCTL. More...
struct	v4l2_enc_enable_ext_rps_ctrl_
	Holds the params to configure encoder for external rps control to be used with V4L2_CID_MPEG_VIDEOENC_ENABLE_EXTERNAL_RPS_CONTROL IOCTL. More...
struct	_v4l2_enc_frame_prop
	Holds the encoder frame property. More...
struct	v4l2_enc_frame_ext_rps_ctrl_params_
	Holds the encoder frame external rps control parameters to be used with V4L2_CID_MPEG_VIDEOENC_INPUT_METADATA IOCTL. More...
struct	v4l2_enc_enable_ext_rate_ctrl_
	Holds the params to configure encoder for external rate control mode to be used with V4L2_CID_MPEG_VIDEOENC_ENABLE_EXTERNAL_RATE_CONTROL IOCTL. More...
struct	v4l2_enc_frame_ext_rate_ctrl_params_
	Holds the encoder frame external rate control parameters to be used with V4L2_CID_MPEG_VIDEOENC_INPUT_METADATA ioctl. More...
struct	v4l2_enc_enable_roi_param_
	Holds the params to configure encoder for ROI parameters encoding. More...
struct	v4l2_enc_enable_reconcrc_param_
	Holds the params to configure encoder for Reconstructed CRC encoding. More...
struct	v4l2_enc_frame_ReconCRC_params_
	Holds the encoder frame Reconstructed CRC parameters. More...
struct	v4l2_ctrl_videoenc_input_metadata_
	Holds the encoder frame input metadata parameters. More...
struct	_v4l2_ctrl_video_qp_range
	Holds the encoder frame min/max QP parameters. More...

Macros
#define	V4L2_PIX_FMT_H265   v4l2_fourcc('H', '2', '6', '5')
	Defines V4L2 pixel format for H.265. More...
#define	V4L2_PIX_FMT_VP9   v4l2_fourcc('V', 'P', '9', '0')
	Defines the V4L2 pixel format for VP9. More...
#define	V4L2_EVENT_RESOLUTION_CHANGE   5
	Defines the V4L2 event type for decoder resolution event change. More...
#define	V4L2_CID_MPEG_VIDEO_H265_PROFILE   (V4L2_CID_MPEG_BASE+513)
	Defines the control ID to set the H.265 encoder profile. More...
#define	V4L2_CID_MPEG_VIDEO_IDR_INTERVAL   (V4L2_CID_MPEG_BASE+514)
	Defines the control ID to set the encoder IDR frame interval. More...
#define	V4L2_CID_MPEG_VIDEO_DISABLE_COMPLETE_FRAME_INPUT   (V4L2_CID_MPEG_BASE+515)
	Defines the Control ID to indicate to the decoder that the input buffers do not contain complete buffers. More...
#define	V4L2_CID_MPEG_VIDEO_DISABLE_DPB   (V4L2_CID_MPEG_BASE+516)
	Defines the Control ID to disable decoder DPB management. More...
#define	V4L2_CID_MPEG_VIDEO_ERROR_REPORTING   (V4L2_CID_MPEG_BASE+517)
	Defines the Control ID to enable decoder error and metadata reporting. More...
#define	V4L2_CID_MPEG_VIDEO_SKIP_FRAMES   (V4L2_CID_MPEG_BASE+518)
	Defines the Control ID to set the skip frames property of the decoder. More...
#define	V4L2_CID_MPEG_VIDEODEC_METADATA   (V4L2_CID_MPEG_BASE+519)
	Defines the Control ID to get the decoder output metadata. More...
#define	V4L2_CID_VIDEO_CONVERT_OUTPUT_PLANE_LAYOUT   (V4L2_CID_MPEG_BASE+520)
	Defines the Control ID to set converter output plane buffer layout. More...
#define	V4L2_CID_VIDEO_CONVERT_CAPTURE_PLANE_LAYOUT   (V4L2_CID_MPEG_BASE+521)
	Defines the Control ID to set converter capture plane buffer layout. More...
#define	V4L2_CID_VIDEO_CONVERT_FLIP_METHOD   (V4L2_CID_MPEG_BASE+522)
	Defines the Control ID to set the converter flip/rotation method. More...
#define	V4L2_CID_VIDEO_CONVERT_INTERPOLATION_METHOD   (V4L2_CID_MPEG_BASE+523)
	Defines the Control ID to set the converter interpolation method. More...
#define	V4L2_CID_VIDEO_CONVERT_TNR_ALGORITHM   (V4L2_CID_MPEG_BASE+524)
	Defines the Control ID to set the converter Temporal Noise Reduction (TNR) algorithm. More...
#define	V4L2_CID_MPEG_VIDEOENC_TEMPORAL_TRADEOFF_LEVEL   (V4L2_CID_MPEG_BASE+525)
	Defines the Control ID to configure encoder to drop frames while encoding. More...
#define	V4L2_CID_MPEG_VIDEOENC_SLICE_LENGTH_PARAM   (V4L2_CID_MPEG_BASE+526)
	Defines the Control ID to configure encoder slice length either in terms of MBs or bits. More...
#define	V4L2_CID_MPEG_VIDEOENC_ROI_PARAMS   (V4L2_CID_MPEG_BASE+527)
	Defines the Control ID to configure encoder to encode particular region of frame in high quality. More...
#define	V4L2_CID_MPEG_VIDEOENC_VIRTUALBUFFER_SIZE   (V4L2_CID_MPEG_BASE+528)
	Defines the Control ID to specify virtual buffer size in bits for encoder. More...
#define	V4L2_CID_MPEG_VIDEOENC_NUM_REFERENCE_FRAMES   (V4L2_CID_MPEG_BASE+529)
	Defines the Control ID to specify maximum number of reference frames that can be used. More...
#define	V4L2_CID_MPEG_VIDEOENC_SLICE_INTRAREFRESH_PARAM   (V4L2_CID_MPEG_BASE+530)
	Defines the Control ID to specify the encoder slice intra refresh interval. More...
#define	V4L2_CID_MPEG_VIDEOENC_NUM_BFRAMES   (V4L2_CID_MPEG_BASE+531)
	Defines the Control ID to set number of B frames to be encoded between two P frames. More...
#define	V4L2_CID_MPEG_VIDEOENC_INSERT_SPS_PPS_AT_IDR   (V4L2_CID_MPEG_BASE+532)
	Defines the Control ID to enable/disable inserting SPS and PPS explicitly at IDR interval. More...
#define	V4L2_CID_MPEG_VIDEOENC_METADATA   (V4L2_CID_MPEG_BASE+533)
	Defines the Control ID to get encoder output metadata. More...
#define	V4L2_CID_MPEG_VIDEOENC_ENABLE_METADATA_MV   (V4L2_CID_MPEG_BASE+534)
	Defines the Control ID to enable/disable encoder motion vector reporting. More...
#define	V4L2_CID_MPEG_VIDEOENC_METADATA_MV   (V4L2_CID_MPEG_BASE+535)
	Defines the Control ID to get encoder output motion vector metadata. More...
#define	V4L2_CID_MPEG_VIDEOENC_QP_RANGE   (V4L2_CID_MPEG_BASE+536)
	Defines the Control ID to set QP range for I/P/B frames. More...
#define	V4L2_CID_MPEG_VIDEOENC_HW_PRESET_TYPE_PARAM   (V4L2_CID_MPEG_BASE+537)
	Defines the Control ID to set encoder HW Preset type. More...
#define	V4L2_CID_MPEG_VIDEOENC_INPUT_METADATA   (V4L2_CID_MPEG_BASE+538)
	Defines the Control ID to provide input metadata for encoder buffer. More...
#define	V4L2_CID_MPEG_VIDEOENC_ENABLE_EXTERNAL_RPS_CONTROL   (V4L2_CID_MPEG_BASE+539)
	Defines the Control ID to configure encoder for external RPS control. More...
#define	V4L2_CID_MPEG_VIDEOENC_ENABLE_EXTERNAL_RATE_CONTROL   (V4L2_CID_MPEG_BASE+540)
	Defines the Control ID to configure encoder for external rate control. More...
#define	V4L2_CID_MPEG_VIDEOENC_ENABLE_ROI_PARAM   (V4L2_CID_MPEG_BASE+541)
	Defines the Control ID to configure ROI encoding for a session. More...
#define	V4L2_CID_MPEG_VIDEOENC_ENABLE_RECONCRC_PARAM   (V4L2_CID_MPEG_BASE+542)
	Defines the Control ID to configure Reconstructed CRC for a session. More...
#define	V4L2_CID_MPEG_VIDEOENC_INSERT_VUI   (V4L2_CID_MPEG_BASE+543)
	Control ID to enable/disable inserting VUI in SPS. More...
#define	V4L2_CID_MPEG_VIDEOENC_INSERT_AUD   (V4L2_CID_MPEG_BASE+544)
	Control ID to enable/disable inserting AUD(Access Unit Delimiter). More...
#define	V4L2_MAX_ROI_REGIONS   8
	Defines the maximum number of ROI regions supported by the encoder. More...
#define	V4L2_MAX_REF_FRAMES   8
	Maximum number of reference frames supported by the encoder. More...
#define	QP_RETAIN_VAL   -1
	Setting Qp values in v4l2_ctrl_video_qp_range to QP_RETAIN_VAL retains default or previously set QP values. More...

Typedefs
typedef struct v4l2_ctrl_videodec_statusmetadata_	v4l2_ctrl_videodec_statusmetadata
	Holds the decoder error status metadata for the frame. More...
typedef struct v4l2_ctrl_videodec_refframe_metadata_	v4l2_ctrl_videodec_refframe_metadata
	Holds the the frame specific metadata for a reference frame. More...
typedef struct v4l2_ctrl_videodec_currentframe_metadata_	v4l2_ctrl_videodec_currentframe_metadata
	Holds the the frame specific metadata for the current frame. More...
typedef struct v4l2_ctrl_videodec_dpbinfometadata_	v4l2_ctrl_videodec_dpbinfometadata
	Holds the decoder DPB info metadata. More...
typedef struct v4l2_ctrl_h264dec_bufmetadata_	v4l2_ctrl_h264dec_bufmetadata
	Holds H.264 specific decoder metadata for the frame. More...
typedef struct v4l2_ctrl_hevcdec_bufmetadata_	v4l2_ctrl_hevcdec_bufmetadata
	Holds H.265 specific decoder metadata for the frame. More...
typedef struct v4l2_ctrl_videodec_outputbuf_metadata_	v4l2_ctrl_videodec_outputbuf_metadata
	Holds the video decoder output metadata for a frame. More...
typedef struct v4l2_enc_hw_preset_type_param_	v4l2_enc_hw_preset_type_param
	Holds encoder HW Preset type parameters to be used with V4L2_CID_MPEG_VIDEOENC_HW_PRESET_TYPE_PARAM IOCTL. More...
typedef struct v4l2_enc_slice_length_param_	v4l2_enc_slice_length_param
	Holds encoder slice length parameters, to be used with V4L2_CID_MPEG_VIDEOENC_SLICE_LENGTH_PARAM IOCTL. More...
typedef struct v4l2_enc_virtual_buffer_size_	v4l2_enc_virtual_buffer_size
	Holds encoder virtual buffer size parameters, to be used with V4L2_CID_MPEG_VIDEOENC_VIRTUALBUFFER_SIZE IOCTL. More...
typedef struct v4l2_enc_num_ref_frames_	v4l2_enc_num_ref_frames
	Holds encoder number of reference frame parameters, to be used with V4L2_CID_MPEG_VIDEOENC_NUM_REFERENCE_FRAMES IOCTL. More...
typedef struct v4l2_enc_slice_intrarefresh_param_	v4l2_enc_slice_intrarefresh_param
	Holds encoder slice intrareferesh parameters, to be used with V4L2_CID_MPEG_VIDEOENC_SLICE_INTRAREFRESH_PARAM IOCTL. More...
typedef struct v4l2_enc_ROI_param_	v4l2_enc_ROI_param
	Holds the encoder quality parameters for a single ROI region. More...
typedef struct v4l2_enc_frame_ROI_params_	v4l2_enc_frame_ROI_params
	Holds the encoder frame ROI parameters to be used with V4L2_CID_MPEG_VIDEOENC_ROI_PARAMS IOCTL. More...
typedef struct MVInfo_	MVInfo
	Holds the motion vector parameters for a single macro block. More...
typedef struct v4l2_ctrl_videoenc_outputbuf_metadata_MV_	v4l2_ctrl_videoenc_outputbuf_metadata_MV
	Holds the motion vector parameters for one complete frame. More...
typedef struct v4l2_enc_frame_full_prop_	v4l2_enc_frame_full_prop
	Holds the RPS List parameters of encoded frame. More...
typedef struct v4l2_ctrl_videoenc_outputbuf_metadata_	v4l2_ctrl_videoenc_outputbuf_metadata
	Holds the encoder output metadata for a frame, to be used with V4L2_CID_MPEG_VIDEOENC_METADATA IOCTL. More...
typedef struct v4l2_ctrl_video_metadata_	v4l2_ctrl_video_metadata
	Holds the metadata parameters for video encoder and decoder. More...
typedef struct v4l2_enc_gdr_params_	v4l2_enc_gdr_params
	Holds the encoder GDR parameters to be used with V4L2_CID_MPEG_VIDEOENC_INPUT_METADATA IOCTL. More...
typedef struct v4l2_enc_enable_ext_rps_ctrl_	v4l2_enc_enable_ext_rps_ctr
	Holds the params to configure encoder for external rps control to be used with V4L2_CID_MPEG_VIDEOENC_ENABLE_EXTERNAL_RPS_CONTROL IOCTL. More...
typedef struct _v4l2_enc_frame_prop	v4l2_enc_frame_prop
	Holds the encoder frame property. More...
typedef struct v4l2_enc_frame_ext_rps_ctrl_params_	v4l2_enc_frame_ext_rps_ctrl_params
	Holds the encoder frame external rps control parameters to be used with V4L2_CID_MPEG_VIDEOENC_INPUT_METADATA IOCTL. More...
typedef struct v4l2_enc_enable_ext_rate_ctrl_	v4l2_enc_enable_ext_rate_ctr
	Holds the params to configure encoder for external rate control mode to be used with V4L2_CID_MPEG_VIDEOENC_ENABLE_EXTERNAL_RATE_CONTROL IOCTL. More...
typedef struct v4l2_enc_frame_ext_rate_ctrl_params_	v4l2_enc_frame_ext_rate_ctrl_params
	Holds the encoder frame external rate control parameters to be used with V4L2_CID_MPEG_VIDEOENC_INPUT_METADATA ioctl. More...
typedef struct v4l2_enc_enable_roi_param_	v4l2_enc_enable_roi_param
	Holds the params to configure encoder for ROI parameters encoding. More...
typedef struct v4l2_enc_enable_reconcrc_param_	v4l2_enc_enable_reconcrc_param
	Holds the params to configure encoder for Reconstructed CRC encoding. More...
typedef struct v4l2_enc_frame_ReconCRC_params_	v4l2_enc_frame_ReconCRC_params
	Holds the encoder frame Reconstructed CRC parameters. More...
typedef struct v4l2_ctrl_videoenc_input_metadata_	v4l2_ctrl_videoenc_input_metadata
	Holds the encoder frame input metadata parameters. More...
typedef struct _v4l2_ctrl_video_qp_range	v4l2_ctrl_video_qp_range
	Holds the encoder frame min/max QP parameters. More...

Enumerations
enum	v4l2_mpeg_video_h265_profile {   V4L2_MPEG_VIDEO_H265_PROFILE_MAIN = 0,   V4L2_MPEG_VIDEO_H265_PROFILE_MAIN10 = 1,   V4L2_MPEG_VIDEO_H265_PROFILE_MAINSTILLPICTURE = 2 }
	Defines the possible profiles for H.265 encoder. More...
enum	v4l2_skip_frames_type {   V4L2_SKIP_FRAMES_TYPE_NONE = 0,   V4L2_SKIP_FRAMES_TYPE_NONREF = 1,   V4L2_SKIP_FRAMES_TYPE_DECODE_IDR_ONLY = 2 }
	Enum v4l2_skip_frames_type, possible methods for decoder skip frames. More...
enum	v4l2_enc_temporal_tradeoff_level_type {   V4L2_ENC_TEMPORAL_TRADEOFF_LEVEL_DROPNONE = 0,   V4L2_ENC_TEMPORAL_TRADEOFF_LEVEL_DROP1IN5,   V4L2_ENC_TEMPORAL_TRADEOFF_LEVEL_DROP1IN3,   V4L2_ENC_TEMPORAL_TRADEOFF_LEVEL_DROP1IN2,   V4L2_ENC_TEMPORAL_TRADEOFF_LEVEL_DROP2IN3 }
	Specifies the types of encoder temporal tradeoff levels. More...
enum	v4l2_enc_hw_preset_type {   V4L2_ENC_HW_PRESET_ULTRAFAST = 1,   V4L2_ENC_HW_PRESET_FAST,   V4L2_ENC_HW_PRESET_MEDIUM,   V4L2_ENC_HW_PRESET_SLOW }
	Specifies the encoder HW Preset type. More...
enum	v4l2_enc_slice_length_type {   V4L2_ENC_SLICE_LENGTH_TYPE_BITS = 0,   V4L2_ENC_SLICE_LENGTH_TYPE_MBLK }
	Enum specifying the type of slice length. More...
enum	v4l2_enc_input_metadata_param {   V4L2_ENC_INPUT_ROI_PARAM_FLAG = 1,   V4L2_ENC_INPUT_GDR_PARAM_FLAG = 1 << 1,   V4L2_ENC_INPUT_RPS_PARAM_FLAG = 1 << 2,   V4L2_ENC_INPUT_RC_PARAM_FLAG = 1 << 3,   V4L2_ENC_INPUT_RECONCRC_PARAM_FLAG = 1 << 4 }
	Specifies the input buffer metadata flag. More...
enum	v4l2_nv_buffer_layout {   V4L2_NV_BUFFER_LAYOUT_PITCH = 0,   V4L2_NV_BUFFER_LAYOUT_BLOCKLINEAR = 1 }
	Enum specifying types of buffer layouts. More...
enum	v4l2_flip_method {   V4L2_FLIP_METHOD_IDENTITY = 0,   V4L2_FLIP_METHOD_90L = 1,   V4L2_FLIP_METHOD_180 = 2,   V4L2_FLIP_METHOD_90R = 3,   V4L2_FLIP_METHOD_HORIZ = 4,   V4L2_FLIP_METHOD_INVTRANS = 5,   V4L2_FLIP_METHOD_VERT = 6,   V4L2_FLIP_METHOD_TRANS = 7 }
	Specifies the types of rotation/flip algorithms. More...
enum	v4l2_interpolation_method {   V4L2_INTERPOLATION_NEAREST = 1,   V4L2_INTERPOLATION_LINEAR = 2,   V4L2_INTERPOLATION_SMART = 3,   V4L2_INTERPOLATION_BILINEAR = 4 }
	Specifies the types of interpolation methods. More...
enum	v4l2_tnr_algorithm {   V4L2_TNR_ALGO_ORIGINAL = 0,   V4L2_TNR_ALGO_OUTDOOR_LOW_LIGHT = 1,   V4L2_TNR_ALGO_OUTDOOR_MEDIUM_LIGHT = 2,   V4L2_TNR_ALGO_OUTDOOR_HIGH_LIGHT = 3,   V4L2_TNR_ALGO_INDOOR_LOW_LIGHT = 4,   V4L2_TNR_ALGO_INDOOR_MEDIUM_LIGHT = 5,   V4L2_TNR_ALGO_INDOOR_HIGH_LIGHT = 6 }
	Specifies the types of TNR algorithms. More...

Macro Definition Documentation

#define V4L2_CID_MPEG_VIDEO_H265_PROFILE   (V4L2_CID_MPEG_BASE+513)

Defines the control ID to set the H.265 encoder profile.

A v4l2_mpeg_video_h265_profile must be passed.

Definition at line 100 of file v4l2_nv_extensions.h.

#define V4L2_CID_MPEG_VIDEO_IDR_INTERVAL   (V4L2_CID_MPEG_BASE+514)

Defines the control ID to set the encoder IDR frame interval.

Must be used with VIDIOC_S_EXT_CTRLS IOCTL.

Definition at line 118 of file v4l2_nv_extensions.h.

#define V4L2_EVENT_RESOLUTION_CHANGE   5

Defines the V4L2 event type for decoder resolution event change.

Definition at line 79 of file v4l2_nv_extensions.h.

#define V4L2_PIX_FMT_H265   v4l2_fourcc('H', '2', '6', '5')

Defines V4L2 pixel format for H.265.

Definition at line 56 of file v4l2_nv_extensions.h.

#define V4L2_PIX_FMT_VP9   v4l2_fourcc('V', 'P', '9', '0')

Defines the V4L2 pixel format for VP9.

Definition at line 61 of file v4l2_nv_extensions.h.

Enumeration Type Documentation

enum v4l2_mpeg_video_h265_profile

Defines the possible profiles for H.265 encoder.

Enumerator
V4L2_MPEG_VIDEO_H265_PROFILE_MAIN	H.265 Main profile.
V4L2_MPEG_VIDEO_H265_PROFILE_MAIN10	H.265 Main10 profile.
V4L2_MPEG_VIDEO_H265_PROFILE_MAINSTILLPICTURE	H.265 MainStillPicture profile.

Definition at line 105 of file v4l2_nv_extensions.h.