FFmpeg  3.3.9
Data Fields
NV_ENC_LOCK_BITSTREAM Struct Reference

#include <compat/nvenc/nvEncodeAPI.h>

Data Fields

uint32_t version
 [in]: Struct version. More...
 
uint32_t doNotWait:1
 [in]: If this flag is set, the NvEncodeAPI interface will return buffer pointer even if operation is not completed. More...
 
uint32_t ltrFrame:1
 [out]: Flag indicating this frame is marked as LTR frame More...
 
uint32_t reservedBitFields:30
 [in]: Reserved bit fields and must be set to 0 More...
 
voidoutputBitstream
 [in]: Pointer to the bitstream buffer being locked. More...
 
uint32_t * sliceOffsets
 [in,out]: Array which receives the slice offsets. More...
 
uint32_t frameIdx
 [out]: Frame no. More...
 
uint32_t hwEncodeStatus
 [out]: The NvEncodeAPI interface status for the locked picture. More...
 
uint32_t numSlices
 [out]: Number of slices in the encoded picture. More...
 
uint32_t bitstreamSizeInBytes
 [out]: Actual number of bytes generated and copied to the memory pointed by bitstreamBufferPtr. More...
 
uint64_t outputTimeStamp
 [out]: Presentation timestamp associated with the encoded output. More...
 
uint64_t outputDuration
 [out]: Presentation duration associates with the encoded output. More...
 
voidbitstreamBufferPtr
 [out]: Pointer to the generated output bitstream. More...
 
NV_ENC_PIC_TYPE pictureType
 [out]: Picture type of the encoded picture. More...
 
NV_ENC_PIC_STRUCT pictureStruct
 [out]: Structure of the generated output picture. More...
 
uint32_t frameAvgQP
 [out]: Average QP of the frame. More...
 
uint32_t frameSatd
 [out]: Total SATD cost for whole frame. More...
 
uint32_t ltrFrameIdx
 [out]: Frame index associated with this LTR frame. More...
 
uint32_t ltrFrameBitmap
 [out]: Bitmap of LTR frames indices which were used for encoding this frame. More...
 
uint32_t reserved [236]
 [in]: Reserved and must be set to 0 More...
 
voidreserved2 [64]
 [in]: Reserved and must be set to NULL More...
 

Detailed Description

Definition at line 1560 of file nvEncodeAPI.h.

Field Documentation

◆ version

uint32_t NV_ENC_LOCK_BITSTREAM::version

[in]: Struct version.

Must be set to NV_ENC_LOCK_BITSTREAM_VER.

Definition at line 1562 of file nvEncodeAPI.h.

Referenced by process_output_surface().

◆ doNotWait

uint32_t NV_ENC_LOCK_BITSTREAM::doNotWait

[in]: If this flag is set, the NvEncodeAPI interface will return buffer pointer even if operation is not completed.

If not set, the call will block until operation completes.

Definition at line 1563 of file nvEncodeAPI.h.

Referenced by process_output_surface().

◆ ltrFrame

uint32_t NV_ENC_LOCK_BITSTREAM::ltrFrame

[out]: Flag indicating this frame is marked as LTR frame

Definition at line 1564 of file nvEncodeAPI.h.

◆ reservedBitFields

uint32_t NV_ENC_LOCK_BITSTREAM::reservedBitFields

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

Definition at line 1565 of file nvEncodeAPI.h.

◆ outputBitstream

void* NV_ENC_LOCK_BITSTREAM::outputBitstream

[in]: Pointer to the bitstream buffer being locked.

Definition at line 1566 of file nvEncodeAPI.h.

Referenced by process_output_surface().

◆ sliceOffsets

uint32_t* NV_ENC_LOCK_BITSTREAM::sliceOffsets

[in,out]: Array which receives the slice offsets.

This is not supported if NV_ENC_CONFIG_H264::sliceMode is 1 on Kepler GPUs. Array size must be equal to size of frame in MBs.

Definition at line 1567 of file nvEncodeAPI.h.

Referenced by process_output_surface().

◆ frameIdx

uint32_t NV_ENC_LOCK_BITSTREAM::frameIdx

[out]: Frame no.

for which the bitstream is being retrieved.

Definition at line 1568 of file nvEncodeAPI.h.

◆ hwEncodeStatus

uint32_t NV_ENC_LOCK_BITSTREAM::hwEncodeStatus

[out]: The NvEncodeAPI interface status for the locked picture.

Definition at line 1569 of file nvEncodeAPI.h.

◆ numSlices

uint32_t NV_ENC_LOCK_BITSTREAM::numSlices

[out]: Number of slices in the encoded picture.

Will be reported only if NV_ENC_INITIALIZE_PARAMS::reportSliceOffsets set to 1.

Definition at line 1570 of file nvEncodeAPI.h.

◆ bitstreamSizeInBytes

uint32_t NV_ENC_LOCK_BITSTREAM::bitstreamSizeInBytes

[out]: Actual number of bytes generated and copied to the memory pointed by bitstreamBufferPtr.

Definition at line 1571 of file nvEncodeAPI.h.

Referenced by process_output_surface().

◆ outputTimeStamp

uint64_t NV_ENC_LOCK_BITSTREAM::outputTimeStamp

[out]: Presentation timestamp associated with the encoded output.

Definition at line 1572 of file nvEncodeAPI.h.

Referenced by nvenc_set_timestamp().

◆ outputDuration

uint64_t NV_ENC_LOCK_BITSTREAM::outputDuration

[out]: Presentation duration associates with the encoded output.

Definition at line 1573 of file nvEncodeAPI.h.

◆ bitstreamBufferPtr

void* NV_ENC_LOCK_BITSTREAM::bitstreamBufferPtr

[out]: Pointer to the generated output bitstream.

For MEOnly mode _NV_ENC_LOCK_BITSTREAM::bitstreamBufferPtr should be typecast to NV_ENC_H264_MV_DATA/NV_ENC_HEVC_MV_DATA pointer respectively for H264/HEVC

Definition at line 1574 of file nvEncodeAPI.h.

Referenced by process_output_surface().

◆ pictureType

NV_ENC_PIC_TYPE NV_ENC_LOCK_BITSTREAM::pictureType

[out]: Picture type of the encoded picture.

Definition at line 1577 of file nvEncodeAPI.h.

Referenced by process_output_surface().

◆ pictureStruct

NV_ENC_PIC_STRUCT NV_ENC_LOCK_BITSTREAM::pictureStruct

[out]: Structure of the generated output picture.

Definition at line 1578 of file nvEncodeAPI.h.

◆ frameAvgQP

uint32_t NV_ENC_LOCK_BITSTREAM::frameAvgQP

[out]: Average QP of the frame.

Definition at line 1579 of file nvEncodeAPI.h.

Referenced by process_output_surface().

◆ frameSatd

uint32_t NV_ENC_LOCK_BITSTREAM::frameSatd

[out]: Total SATD cost for whole frame.

Definition at line 1580 of file nvEncodeAPI.h.

◆ ltrFrameIdx

uint32_t NV_ENC_LOCK_BITSTREAM::ltrFrameIdx

[out]: Frame index associated with this LTR frame.

Definition at line 1581 of file nvEncodeAPI.h.

◆ ltrFrameBitmap

uint32_t NV_ENC_LOCK_BITSTREAM::ltrFrameBitmap

[out]: Bitmap of LTR frames indices which were used for encoding this frame.

Value of 0 if no LTR frames were used.

Definition at line 1582 of file nvEncodeAPI.h.

◆ reserved

uint32_t NV_ENC_LOCK_BITSTREAM::reserved[236]

[in]: Reserved and must be set to 0

Definition at line 1583 of file nvEncodeAPI.h.

◆ reserved2

void* NV_ENC_LOCK_BITSTREAM::reserved2[64]

[in]: Reserved and must be set to NULL

Definition at line 1584 of file nvEncodeAPI.h.


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