FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
NV_ENC_PIC_PARAMS_H264 Struct Reference

#include <nvEncodeAPI.h>

Data Fields

uint32_t displayPOCSyntax
 [in]: Specifies the display POC syntax This is required to be set if client is handling the picture type decision. More...
 
uint32_t reserved3
 [in]: Reserved and must be set to 0 More...
 
uint32_t refPicFlag
 [in]: Set to 1 for a reference picture. More...
 
uint32_t colourPlaneId
 [in]: Specifies the colour plane ID associated with the current input. More...
 
uint32_t forceIntraRefreshWithFrameCnt
 [in]: Forces an intra refresh with duration equal to intraRefreshFrameCnt. More...
 
uint32_t constrainedFrame:1
 [in]: Set to 1 if client wants to encode this frame with each slice completely independent of other slices in the frame. More...
 
uint32_t sliceModeDataUpdate:1
 [in]: Set to 1 if client wants to change the sliceModeData field to specify new sliceSize Parameter When forceIntraRefreshWithFrameCnt is set it will have priority over sliceMode setting More...
 
uint32_t ltrMarkFrame:1
 [in]: Set to 1 if client wants to mark this frame as LTR More...
 
uint32_t ltrUseFrames:1
 [in]: Set to 1 if client allows encoding this frame using the LTR frames specified in ltrFrameBitmap More...
 
uint32_t reservedBitFields:28
 [in]: Reserved bit fields and must be set to 0 More...
 
uint8_tsliceTypeData
 
uint32_t sliceTypeArrayCnt
 
uint32_t seiPayloadArrayCnt
 [in]: Specifies the number of elements allocated in seiPayloadArray array. More...
 
NV_ENC_SEI_PAYLOADseiPayloadArray
 [in]: Array of SEI payloads which will be inserted for this frame. More...
 
uint32_t sliceMode
 [in]: This parameter in conjunction with sliceModeData specifies the way in which the picture is divided into slices sliceMode = 0 MB based slices, sliceMode = 1 Byte based slices, sliceMode = 2 MB row based slices, sliceMode = 3, numSlices in Picture When forceIntraRefreshWithFrameCnt is set it will have priority over sliceMode setting When sliceMode == 0 and sliceModeData == 0 whole picture will be coded with one slice More...
 
uint32_t sliceModeData
 [in]: Specifies the parameter needed for sliceMode. More...
 
uint32_t ltrMarkFrameIdx
 [in]: Specifies the long term referenceframe index to use for marking this frame as LTR. More...
 
uint32_t ltrUseFrameBitmap
 [in]: Specifies the the associated bitmap of LTR frame indices when encoding this frame. More...
 
uint32_t ltrUsageMode
 [in]: Specifies additional usage constraints for encoding using LTR frames from this point further. More...
 
uint32_t reserved [243]
 [in]: Reserved and must be set to 0. More...
 
voidreserved2 [62]
 [in]: Reserved and must be set to NULL. More...
 

Detailed Description

Definition at line 1401 of file nvEncodeAPI.h.

Field Documentation

uint32_t NV_ENC_PIC_PARAMS_H264::displayPOCSyntax

[in]: Specifies the display POC syntax This is required to be set if client is handling the picture type decision.

Definition at line 1403 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::reserved3

[in]: Reserved and must be set to 0

Definition at line 1404 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::refPicFlag

[in]: Set to 1 for a reference picture.

This is ignored if NV_ENC_INITIALIZE_PARAMS::enablePTD is set to 1.

Definition at line 1405 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::colourPlaneId

[in]: Specifies the colour plane ID associated with the current input.

Definition at line 1406 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::forceIntraRefreshWithFrameCnt

[in]: Forces an intra refresh with duration equal to intraRefreshFrameCnt.

When outputRecoveryPointSEI is set this is value is used for recovery_frame_cnt in recovery point SEI message forceIntraRefreshWithFrameCnt cannot be used if B frames are used in the GOP structure specified

Definition at line 1407 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::constrainedFrame

[in]: Set to 1 if client wants to encode this frame with each slice completely independent of other slices in the frame.

NV_ENC_INITIALIZE_PARAMS::enableConstrainedEncoding should be set to 1

Definition at line 1410 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::sliceModeDataUpdate

[in]: Set to 1 if client wants to change the sliceModeData field to specify new sliceSize Parameter When forceIntraRefreshWithFrameCnt is set it will have priority over sliceMode setting

Definition at line 1412 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::ltrMarkFrame

[in]: Set to 1 if client wants to mark this frame as LTR

Definition at line 1414 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::ltrUseFrames

[in]: Set to 1 if client allows encoding this frame using the LTR frames specified in ltrFrameBitmap

Definition at line 1415 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::reservedBitFields

[in]: Reserved bit fields and must be set to 0

Definition at line 1416 of file nvEncodeAPI.h.

uint8_t* NV_ENC_PIC_PARAMS_H264::sliceTypeData

Definition at line 1417 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::sliceTypeArrayCnt

Definition at line 1418 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::seiPayloadArrayCnt

[in]: Specifies the number of elements allocated in seiPayloadArray array.

Definition at line 1419 of file nvEncodeAPI.h.

NV_ENC_SEI_PAYLOAD* NV_ENC_PIC_PARAMS_H264::seiPayloadArray

[in]: Array of SEI payloads which will be inserted for this frame.

Definition at line 1420 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::sliceMode

[in]: This parameter in conjunction with sliceModeData specifies the way in which the picture is divided into slices sliceMode = 0 MB based slices, sliceMode = 1 Byte based slices, sliceMode = 2 MB row based slices, sliceMode = 3, numSlices in Picture When forceIntraRefreshWithFrameCnt is set it will have priority over sliceMode setting When sliceMode == 0 and sliceModeData == 0 whole picture will be coded with one slice

Definition at line 1421 of file nvEncodeAPI.h.

Referenced by nvenc_codec_specific_pic_params().

uint32_t NV_ENC_PIC_PARAMS_H264::sliceModeData

[in]: Specifies the parameter needed for sliceMode.

For: sliceMode = 0, sliceModeData specifies # of MBs in each slice (except last slice) sliceMode = 1, sliceModeData specifies maximum # of bytes in each slice (except last slice) sliceMode = 2, sliceModeData specifies # of MB rows in each slice (except last slice) sliceMode = 3, sliceModeData specifies number of slices in the picture. Driver will divide picture into slices optimally

Definition at line 1425 of file nvEncodeAPI.h.

Referenced by nvenc_codec_specific_pic_params().

uint32_t NV_ENC_PIC_PARAMS_H264::ltrMarkFrameIdx

[in]: Specifies the long term referenceframe index to use for marking this frame as LTR.

Definition at line 1430 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::ltrUseFrameBitmap

[in]: Specifies the the associated bitmap of LTR frame indices when encoding this frame.

Definition at line 1431 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::ltrUsageMode

[in]: Specifies additional usage constraints for encoding using LTR frames from this point further.

0: no constraints, 1: no short term refs older than current, no previous LTR frames.

Definition at line 1432 of file nvEncodeAPI.h.

uint32_t NV_ENC_PIC_PARAMS_H264::reserved[243]

[in]: Reserved and must be set to 0.

Definition at line 1433 of file nvEncodeAPI.h.

void* NV_ENC_PIC_PARAMS_H264::reserved2[62]

[in]: Reserved and must be set to NULL.

Definition at line 1434 of file nvEncodeAPI.h.


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