nvmedia_iep_input_extradata.h File Reference

Detailed Description

NVIDIA Media Interface: NvMedia Image Encode Processing Input ExtraData

This file contains the input extradata definition for "Image Encode Processing API".

Definition in file nvmedia_iep_input_extradata.h.

Go to the source code of this file.

Data Structures
struct	NvMediaEncROIParams
struct	NvMediaEncodeInputExtradata
	Holds an Video encoder input extradata configuration. More...
struct	NvMediaEncodeDRCConfig
	Defines the resolution change parameters. More...
struct	NvMediaEncodeCfgFiles
	Defines the structure for holding the encoding attributes for HW validation. More...

Macros
#define	NVMEDIA_ENCODE_MAX_RPS_SIZE   17U
	Maximum number of reference pictures including current frame. More...
#define	NVMEDIA_MAX_ROI_REGIONS   8U
	Maximum number of region of interests. More...

Enumerations
enum	NvMediaVideoEncEncFrameFlags {   NvMediaVideoEncFrame_PPEMetadata,   NvMediaVideoEncFrame_QPDeltaBuffer,   NvMediaVideoEncFrame_ROIParams }
	Defines video frame flags. More...
enum	NvMediaEncSetAttrType {   NvMediaEncSetAttr_DRCParams,   NvMediaEncSetAttr_HWConfigFiles }
	Specifies the Video encoder set attribute type. More...

Functions
NvMediaStatus	NvMediaIEPSetInputExtraData (const NvMediaIEP *encoder, const void *extradata)
	Set the encoder extra data for current frame for encoding. More...
NvMediaStatus	NvMediaIEPSetAttribute (const NvMediaIEP *encoder, NvMediaEncSetAttrType attrType, uint32_t attrSize, const void *AttributeData)
	Set the encoder attribute for current encoding session. More...

Macro Definition Documentation

NVMEDIA_ENCODE_MAX_RPS_SIZE

#define NVMEDIA_ENCODE_MAX_RPS_SIZE   17U

Maximum number of reference pictures including current frame.

Definition at line 27 of file nvmedia_iep_input_extradata.h.

NVMEDIA_MAX_ROI_REGIONS

#define NVMEDIA_MAX_ROI_REGIONS   8U

Maximum number of region of interests.

Definition at line 30 of file nvmedia_iep_input_extradata.h.

Enumeration Type Documentation

NvMediaEncSetAttrType

enum NvMediaEncSetAttrType

Specifies the Video encoder set attribute type.

This can be extended to set other encoding parameter information.

Enumerator
NvMediaEncSetAttr_DRCParams	This is used to pass dynamic resolution change specific information NvMediaEncodeDRCConfig. Driver will update encode resolution specific parameters for encoding with new specified resolution. Supported for H264 and H265 Encoding.
NvMediaEncSetAttr_HWConfigFiles	This attribute is used to pass HW config files as specified in NvVideoEncodeCfgFiles for current encoding session. This is only required for HW validation. This attribute must be set before first frame of encoding.

Definition at line 92 of file nvmedia_iep_input_extradata.h.

NvMediaVideoEncEncFrameFlags

enum NvMediaVideoEncEncFrameFlags

Defines video frame flags.

Each bit of bEncodeParamsFlag indicate parameter for specific featue.

Enumerator
NvMediaVideoEncFrame_PPEMetadata	enable preprocessing enhancements buffer
NvMediaVideoEncFrame_QPDeltaBuffer	enable QP Delta Buffer
NvMediaVideoEncFrame_ROIParams	passing region of interest parameters

Definition at line 42 of file nvmedia_iep_input_extradata.h.

Function Documentation

NvMediaIEPSetAttribute()

NvMediaStatus NvMediaIEPSetAttribute	(	const NvMediaIEP *	encoder,
		NvMediaEncSetAttrType	attrType,
		uint32_t	attrSize,
		const void *	AttributeData
	)

Set the encoder attribute for current encoding session.

This can be called before passing the first frame for encoding.

Parameters

[in]	encoder	The encoder to use.
[in]	attrType	attribute type as defined in NvMediaEncSetAttrType
[in]	attrSize	size of the data structure associated with attribute Possible values are: NvMediaEncSetAttr_DRCParams if resolution of encoding changes.
[in]	pointer	to data structure associated with attribute

Returns

NvMediaStatus The completion status of the operation. Possible values are:
NVMEDIA_STATUS_OK
NVMEDIA_STATUS_BAD_PARAMETER if any of the input parameter is NULL.

NvMediaIEPSetInputExtraData()

NvMediaStatus NvMediaIEPSetInputExtraData	(	const NvMediaIEP *	encoder,
		const void *	extradata
	)

Set the encoder extra data for current frame for encoding.

This should be called before before every NvMediaIEPFeedFrame so that parameters can be applied for current frame. This should be called from same thread from where NvMediaIEPFeedFrame is called.

Parameters

[in]	encoder	The encoder to use.
[in]	extradata	encode input extra data for current frame. Input extradata ia defined as NvMediaEncodeInputExtradata

Returns

NvMediaStatus The completion status of the operation. Possible values are:
NVMEDIA_STATUS_OK
NVMEDIA_STATUS_BAD_PARAMETER if any of the input parameter is NULL.