NVIDIA DRIVE OS Linux SDK API Reference

6.0.6 Release

Detailed Description

Types and declarations for H.264 Encoding.

6

Data Structures

struct  NvMediaNalData
 This is used to get header info (SPS/PPS/VPS) using GetAttribute call. More...
 
struct  NvMediaEncodeConfigH264VUIParams
 Holds H264 video usability information parameters. More...
 
struct  NvMediaEncodeExternalMeHintCountsPerBlocktype
 Holds an external motion vector hint with counts per block type. More...
 
struct  NvMediaEncodeExternalMEHint
 Holds an External Motion Vector hint. More...
 
struct  NvMediaEncodeConfigH264
 Holds an H264 encoder configuration. More...
 
struct  NvMediaEncodeH264SEIPayload
 H.264 specific User SEI message. More...
 
struct  NvMediaEncodeInitializeParamsH264
 Holds H264-specific encode initialization parameters. More...
 
struct  NvMediaEncodePicParamsH264
 H264 specific encoder picture params. More...
 

Modules

 Data types for AV1 encoding
 Types and declarations for AV1 Encoding.
 
 Data types for H.265/HEVC encoding
 Types and declarations for H.265/HEVC Encoding.
 
 Data types for VP9 encoding
 Types and declarations for VP9 Encoding.
 

Variables

int16_t NvMediaEncodeQP::qpInterP
 QP value for P frames. More...
 
int16_t NvMediaEncodeQP::qpInterB
 QP value for B frames. More...
 
int16_t NvMediaEncodeQP::qpIntra
 QP value for Intra frames. More...
 
int16_t NvMediaEncodeQP::reserved [3]
 
NvMediaEncodeParamsRCMode NvMediaEncodeRCParams::rateControlMode
 Holds the rate control mode. More...
 
uint32_t NvMediaEncodeRCParams::numBFrames
 Specified number of B frames between two reference frames. More...
 
uint32_t   NvMediaEncodeRCParams::averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
uint32_t   NvMediaEncodeRCParams::vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
uint32_t   NvMediaEncodeRCParams::vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
struct {
   uint32_t   NvMediaEncodeRCParams::averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
   uint32_t   NvMediaEncodeRCParams::vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
   uint32_t   NvMediaEncodeRCParams::vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
}   NvMediaEncodeRCParams::cbr
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_CBR mode. More...
 
NvMediaEncodeQP   NvMediaEncodeRCParams::constQP
 Holds the initial QP to be used for encoding, these values would be used for all frames in Constant QP mode. More...
 
struct {
   NvMediaEncodeQP   NvMediaEncodeRCParams::constQP
 Holds the initial QP to be used for encoding, these values would be used for all frames in Constant QP mode. More...
 
}   NvMediaEncodeRCParams::const_qp
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_CONSTQP mode. More...
 
uint32_t   NvMediaEncodeRCParams::averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
uint32_t   NvMediaEncodeRCParams::maxBitRate
 Holds the maximum bitrate for the encoded output. More...
 
uint32_t   NvMediaEncodeRCParams::vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
uint32_t   NvMediaEncodeRCParams::vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
struct {
   uint32_t   NvMediaEncodeRCParams::averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
   uint32_t   NvMediaEncodeRCParams::maxBitRate
 Holds the maximum bitrate for the encoded output. More...
 
   uint32_t   NvMediaEncodeRCParams::vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
   uint32_t   NvMediaEncodeRCParams::vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
}   NvMediaEncodeRCParams::vbr
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_VBR mode. More...
 
uint32_t   NvMediaEncodeRCParams::averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
uint32_t   NvMediaEncodeRCParams::maxBitRate
 Holds the maximum bitrate for the encoded output. More...
 
uint32_t   NvMediaEncodeRCParams::vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
uint32_t   NvMediaEncodeRCParams::vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
NvMediaEncodeQP   NvMediaEncodeRCParams::minQP
 Holds the minimum QP used for rate control. More...
 
struct {
   uint32_t   NvMediaEncodeRCParams::averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
   uint32_t   NvMediaEncodeRCParams::maxBitRate
 Holds the maximum bitrate for the encoded output. More...
 
   uint32_t   NvMediaEncodeRCParams::vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
   uint32_t   NvMediaEncodeRCParams::vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
   NvMediaEncodeQP   NvMediaEncodeRCParams::minQP
 Holds the minimum QP used for rate control. More...
 
}   NvMediaEncodeRCParams::vbr_minqp
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_VBR_MINQP mode. More...
 
uint32_t   NvMediaEncodeRCParams::averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
uint32_t   NvMediaEncodeRCParams::vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
uint32_t   NvMediaEncodeRCParams::vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
NvMediaEncodeQP   NvMediaEncodeRCParams::minQP
 Holds the minimum QP used for rate control. More...
 
struct {
   uint32_t   NvMediaEncodeRCParams::averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
   uint32_t   NvMediaEncodeRCParams::vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
   uint32_t   NvMediaEncodeRCParams::vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
   NvMediaEncodeQP   NvMediaEncodeRCParams::minQP
 Holds the minimum QP used for rate control. More...
 
}   NvMediaEncodeRCParams::cbr_minqp
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_CBR_MINQP mode. More...
 
union {
   struct {
      uint32_t   NvMediaEncodeRCParams::averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
      uint32_t   NvMediaEncodeRCParams::vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
      uint32_t   NvMediaEncodeRCParams::vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
   }   NvMediaEncodeRCParams::cbr
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_CBR mode. More...
 
   struct {
      NvMediaEncodeQP   NvMediaEncodeRCParams::constQP
 Holds the initial QP to be used for encoding, these values would be used for all frames in Constant QP mode. More...
 
   }   NvMediaEncodeRCParams::const_qp
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_CONSTQP mode. More...
 
   struct {
      uint32_t   NvMediaEncodeRCParams::averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
      uint32_t   NvMediaEncodeRCParams::maxBitRate
 Holds the maximum bitrate for the encoded output. More...
 
      uint32_t   NvMediaEncodeRCParams::vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
      uint32_t   NvMediaEncodeRCParams::vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
   }   NvMediaEncodeRCParams::vbr
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_VBR mode. More...
 
   struct {
      uint32_t   NvMediaEncodeRCParams::averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
      uint32_t   NvMediaEncodeRCParams::maxBitRate
 Holds the maximum bitrate for the encoded output. More...
 
      uint32_t   NvMediaEncodeRCParams::vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
      uint32_t   NvMediaEncodeRCParams::vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
      NvMediaEncodeQP   NvMediaEncodeRCParams::minQP
 Holds the minimum QP used for rate control. More...
 
   }   NvMediaEncodeRCParams::vbr_minqp
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_VBR_MINQP mode. More...
 
   struct {
      uint32_t   NvMediaEncodeRCParams::averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
      uint32_t   NvMediaEncodeRCParams::vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
      uint32_t   NvMediaEncodeRCParams::vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
      NvMediaEncodeQP   NvMediaEncodeRCParams::minQP
 Holds the minimum QP used for rate control. More...
 
   }   NvMediaEncodeRCParams::cbr_minqp
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_CBR_MINQP mode. More...
 
NvMediaEncodeRCParams::params
 Rate Control parameters. More...
 
bool NvMediaEncodeRCParams::bConstFrameQP
 Use constant QP at frame level or MB row level. More...
 
int8_t NvMediaEncodeRCParams::maxSessionQP
 Holds the max QP for encoding session when external picture RC hint is used. More...
 
int8_t NvMediaEncodeRCParams::reserved [3]
 
uint32_t NvMediaNalData::ulNalSize
 Nal size for header. More...
 
uint8_t NvMediaNalData::data [MAX_NON_SLICE_DATA_SIZE]
 header data passed on this buffer More...
 
bool NvMediaEncodeConfigH264VUIParams::aspectRatioInfoPresentFlag
 If set to true, it specifies that the aspectRatioIdc is present. More...
 
uint8_t NvMediaEncodeConfigH264VUIParams::aspectRatioIdc
 Holds the aspect ratio IDC (as defined in Annex E of the ITU-T Specification). More...
 
uint16_t NvMediaEncodeConfigH264VUIParams::aspectSARWidth
 If aspectRatioIdc is Extended SAR then it indicates horizontal size of the sample aspect ratio (in arbitrary units). More...
 
uint16_t NvMediaEncodeConfigH264VUIParams::aspectSARHeight
 If aspectRatioIdc is Extended SAR then it indicates vertical size of the sample aspect ratio (in the same arbitrary units as aspectSARWidth) More...
 
bool NvMediaEncodeConfigH264VUIParams::overscanInfoPresentFlag
 If set to true, it specifies that the overscanInfo is present. More...
 
bool NvMediaEncodeConfigH264VUIParams::overscanAppropriateFlag
 Holds the overscan info (as defined in Annex E of the ITU-T Specification). More...
 
bool NvMediaEncodeConfigH264VUIParams::videoSignalTypePresentFlag
 If set to true, it specifies that the videoFormat, videoFullRangeFlag and colourDescriptionPresentFlag are present. More...
 
uint8_t NvMediaEncodeConfigH264VUIParams::videoFormat
 Holds the source video format (as defined in Annex E of the ITU-T Specification). More...
 
bool NvMediaEncodeConfigH264VUIParams::videoFullRangeFlag
 Holds the output range of the luma and chroma samples (as defined in Annex E of the ITU-T Specification). More...
 
bool NvMediaEncodeConfigH264VUIParams::colourDescriptionPresentFlag
 If set to true, it specifies that the colourPrimaries, transferCharacteristics and colourMatrix are present. More...
 
uint8_t NvMediaEncodeConfigH264VUIParams::colourPrimaries
 Holds color primaries for converting to RGB (as defined in Annex E of the ITU-T Specification). More...
 
uint8_t NvMediaEncodeConfigH264VUIParams::transferCharacteristics
 Holds the opto-electronic transfer characteristics to use (as defined in Annex E of the ITU-T Specification). More...
 
uint8_t NvMediaEncodeConfigH264VUIParams::colourMatrix
 Holds the matrix coefficients used in deriving the luma and chroma from the RGB primaries (as defined in Annex E of the ITU-T Specification). More...
 
bool NvMediaEncodeConfigH264VUIParams::timingInfoPresentFlag
 Holds that num_units_in_tick, time_scale and fixed_frame_rate_flag are present in the bitstream (as defined in Annex E of the ITU-T Specification). More...
 
bool NvMediaEncodeConfigH264VUIParams::bitstreamRestrictionFlag
 Holds the bitstream restriction info (as defined in Annex E of the ITU-T Specification). More...
 
uint32_t NvMediaEncodeExternalMeHintCountsPerBlocktype::numCandsPerBlk16x16
 Holds the number of candidates per 16x16 block. More...
 
uint32_t NvMediaEncodeExternalMeHintCountsPerBlocktype::numCandsPerBlk16x8
 Holds the number of candidates per 16x8 block. More...
 
uint32_t NvMediaEncodeExternalMeHintCountsPerBlocktype::numCandsPerBlk8x16
 Holds the number of candidates per 8x16 block. More...
 
uint32_t NvMediaEncodeExternalMeHintCountsPerBlocktype::numCandsPerBlk8x8
 Holds the number of candidates per 8x8 block. More...
 
int32_t NvMediaEncodeExternalMEHint::mvx: 12
 Holds the x component of integer pixel MV (relative to current MB) S12.0. More...
 
int32_t NvMediaEncodeExternalMEHint::mvy: 10
 Holds the y component of integer pixel MV (relative to current MB) S10.0 . More...
 
uint32_t NvMediaEncodeExternalMEHint::refidx: 5
 Holds the reference index (31=invalid). More...
 
uint32_t NvMediaEncodeExternalMEHint::dir: 1
 Holds the direction of motion estimation . More...
 
uint32_t NvMediaEncodeExternalMEHint::partType: 2
 Holds the block partition type. More...
 
uint32_t NvMediaEncodeExternalMEHint::lastofPart: 1
 Set to true for the last MV of (sub) partition
More...
 
uint32_t NvMediaEncodeExternalMEHint::lastOfMB: 1
 Set to true for the last MV of macroblock. More...
 
uint32_t NvMediaEncodeConfigH264::features
 Holds bit-wise OR`ed configuration feature flags. More...
 
uint32_t NvMediaEncodeConfigH264::gopLength
 Holds the number of pictures in one GOP. More...
 
NvMediaEncodeRCParams NvMediaEncodeConfigH264::rcParams
 Holds the rate control parameters for the current encoding session. More...
 
NvMediaEncodeH264SPSPPSRepeatMode NvMediaEncodeConfigH264::repeatSPSPPS
 Holds the frequency of the writing of Sequence and Picture parameters. More...
 
uint32_t NvMediaEncodeConfigH264::idrPeriod
 Holds the IDR interval. More...
 
uint16_t NvMediaEncodeConfigH264::numSliceCountMinus1
 Holds a number that is 1 less than the desired number of slices per frame. More...
 
uint8_t NvMediaEncodeConfigH264::disableDeblockingFilterIDC
 Holds the deblocking filter mode. More...
 
NvMediaEncodeH264AdaptiveTransformMode NvMediaEncodeConfigH264::adaptiveTransformMode
 Holds the Adaptive Transform Mode. More...
 
NvMediaEncodeH264BDirectMode NvMediaEncodeConfigH264::bdirectMode
 Holds the BDirect mode. More...
 
NvMediaEncodeH264EntropyCodingMode NvMediaEncodeConfigH264::entropyCodingMode
 Holds the entropy coding mode. More...
 
uint32_t NvMediaEncodeConfigH264::intraRefreshPeriod
 Holds the interval between frames that triggers a new intra refresh cycle. More...
 
uint32_t NvMediaEncodeConfigH264::intraRefreshCnt
 Holds the number of frames over which intra refresh happens. More...
 
uint32_t NvMediaEncodeConfigH264::maxSliceSizeInBytes
 Holds the maximum slice size in bytes for dynamic slice mode. More...
 
uint32_t NvMediaEncodeConfigH264::numMacroblocksPerSlice
 Holds the number of macroblocks per slice. More...
 
NvMediaEncodeConfigH264VUIParamsNvMediaEncodeConfigH264::h264VUIParameters
 Holds the H.264 video usability information pamameters. More...
 
uint32_t NvMediaEncodeConfigH264::motionPredictionExclusionFlags
 Holds bitwise OR`ed exclusion flags. More...
 
NvMediaEncodeQuality NvMediaEncodeConfigH264::quality
 Holds the encode quality pre-set. More...
 
NvMediaEncodeH264POCType NvMediaEncodeConfigH264::pocType
 Holds pic_ordec_cnt_type. More...
 
NvMediaEncodeQP NvMediaEncodeConfigH264::initQP
 Holds the initial QP parameters. More...
 
NvMediaEncodeQP NvMediaEncodeConfigH264::maxQP
 Holds the maximum QP parameters. More...
 
uint8_t NvMediaEncodeConfigH264::enableWeightedPrediction
 Enable/disable weighted prediction. More...
 
NvMediaEncPreset NvMediaEncodeConfigH264::encPreset
 Holds the encode quality pre-set. More...
 
bool NvMediaEncodeConfigH264::enableNewPreset
 Set to true to use encPreset instead of quality. More...
 
uint32_t NvMediaEncodeH264SEIPayload::payloadSize
 SEI payload size in bytes. More...
 
uint32_t NvMediaEncodeH264SEIPayload::payloadType
 SEI payload types and syntax can be found in Annex D of the H.264 Specification. More...
 
uint8_t * NvMediaEncodeH264SEIPayload::payload
 Pointer to user data. More...
 
uint16_t NvMediaEncodeInitializeParamsH264::encodeWidth
 Holds the encode width. More...
 
uint16_t NvMediaEncodeInitializeParamsH264::reserved1
 
uint16_t NvMediaEncodeInitializeParamsH264::encodeHeight
 Holds the encode height. More...
 
uint16_t NvMediaEncodeInitializeParamsH264::reserved2
 
bool NvMediaEncodeInitializeParamsH264::enableLimitedRGB
 Set this to true for limited-RGB (16-235) input. More...
 
uint32_t NvMediaEncodeInitializeParamsH264::frameRateNum
 Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint32_t NvMediaEncodeInitializeParamsH264::frameRateDen
 Holds the denominator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint8_t NvMediaEncodeInitializeParamsH264::profile
 Holds the encoding profile. More...
 
uint8_t NvMediaEncodeInitializeParamsH264::level
 Holds the encoding level. More...
 
uint8_t NvMediaEncodeInitializeParamsH264::maxNumRefFrames
 Holds the maximum number of reference frames used for encoding. More...
 
bool NvMediaEncodeInitializeParamsH264::enableExternalMEHints
 Set to true to enable external ME hints. More...
 
NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodeInitializeParamsH264::maxMEHintCountsPerBlock [2]
 If Client wants to pass external motion vectors in NvMediaEncodePicParamsH264 meExternalHints buffer it must specify the maximum number of hint candidates per block per direction for the encode session. More...
 
bool NvMediaEncodeInitializeParamsH264::enableReconCRC
 Enable support for recon CRC generation. More...
 
bool NvMediaEncodeInitializeParamsH264::enableMVC
 If client want to do MVC encoding then this flag need to be set. More...
 
bool NvMediaEncodeInitializeParamsH264::enableROIEncode
 Enable region of interest encoding. More...
 
bool NvMediaEncodeInitializeParamsH264::enableSliceEncode
 Use slice encode to reduce latency in getting encoded buffers. More...
 
uint8_t NvMediaEncodeInitializeParamsH264::useBFramesAsRef
 Enables B frames to be used as reference frames. More...
 
uint8_t NvMediaEncodeInitializeParamsH264::reserved3 [3]
 
bool NvMediaEncodeInitializeParamsH264::enableTwoPassRC
 Enable 2 pass RC support. More...
 
bool NvMediaEncodeInitializeParamsH264::enableSourceHalfScaled
 Enable 2 pass RC with quarter resolution first pass. More...
 
uint32_t NvMediaEncodeInitializeParamsH264::mvcNumViews: 4
 Number of views used for MVC. More...
 
uint32_t NvMediaEncodeInitializeParamsH264::enableExternalPictureRC: 1
 Enable external picture rate control. More...
 
uint32_t NvMediaEncodeInitializeParamsH264::enableAllIFrames: 1
 Encode all frames as I frames. More...
 
uint32_t NvMediaEncodeInitializeParamsH264::reserved: 26
 Add padding. More...
 
NvMediaEncodePicType NvMediaEncodePicParamsH264::pictureType
 Holds input picture type. More...
 
uint32_t NvMediaEncodePicParamsH264::encodePicFlags
 Holds bit-wise OR`ed encode pic flags. More...
 
uint32_t NvMediaEncodePicParamsH264::nextBFrames
 Specifies the number of B-frames that follow the current frame. More...
 
NvMediaEncodeRCParams NvMediaEncodePicParamsH264::rcParams
 Holds the rate control parameters from the current frame onward if the NVMEDIA_ENCODE_PIC_FLAG_RATECONTROL_CHANGE is set in the encodePicFlags. More...
 
uint32_t NvMediaEncodePicParamsH264::seiPayloadArrayCnt
 Holds the number of elements allocated in seiPayloadArray array. More...
 
NvMediaEncodeH264SEIPayloadNvMediaEncodePicParamsH264::seiPayloadArray
 Array of SEI payloads which will be inserted for this frame. More...
 
NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodePicParamsH264::meHintCountsPerBlock [2]
 Holds the number of hint candidates per block per direction for the current frame. More...
 
NvMediaEncodeExternalMEHint *   NvMediaEncodePicParamsH264::meExternalHints
 
uint8_t *   NvMediaEncodePicParamsH264::meHints
 
union {
   NvMediaEncodeExternalMEHint *   NvMediaEncodePicParamsH264::meExternalHints
 
   uint8_t *   NvMediaEncodePicParamsH264::meHints
 
}; 
 Holds the pointer to ME external hints for the current frame. More...
 
uint32_t NvMediaEncodePicParamsH264::frameRateNum
 Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint32_t NvMediaEncodePicParamsH264::frameRateDen
 Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint32_t NvMediaEncodePicParamsH264::viewId
 Holds the viewId of current picture. More...
 
bool NvMediaEncodeConfigH265VUIParams::aspectRatioInfoPresentFlag
 If set to true, specifies the aspectRatioIdc is present. More...
 
uint8_t NvMediaEncodeConfigH265VUIParams::aspectRatioIdc
 Holds the aspect ratio IDC (as defined in Annex E of the ITU-T specification). More...
 
uint16_t NvMediaEncodeConfigH265VUIParams::aspectSARWidth
 If aspectRatioIdc is Extended SAR it indicates horizontal size of the sample aspect ratio (in arbitrary units). More...
 
uint16_t NvMediaEncodeConfigH265VUIParams::aspectSARHeight
 If aspectRatioIdc is Extended SAR it indicates vertical size of the sample aspect ratio (in the same arbitrary units as aspectSARWidth). More...
 
bool NvMediaEncodeConfigH265VUIParams::overscanInfoPresentFlag
 If set to true, it specifies that the overscanInfo is present. More...
 
bool NvMediaEncodeConfigH265VUIParams::overscanAppropriateFlag
 Holds the overscan info (as defined in Annex E of the ITU-T Specification). More...
 
bool NvMediaEncodeConfigH265VUIParams::videoSignalTypePresentFlag
 If set to true, it specifies that the videoFormat, videoFullRangeFlag, and colourDescriptionPresentFlag are present. More...
 
uint8_t NvMediaEncodeConfigH265VUIParams::videoFormat
 Holds the source video format (as defined in Annex E of the ITU-T Specification). More...
 
bool NvMediaEncodeConfigH265VUIParams::videoFullRangeFlag
 Holds the output range of the luma and chroma samples (as defined in Annex E of the ITU-T Specification). More...
 
bool NvMediaEncodeConfigH265VUIParams::colourDescriptionPresentFlag
 If set to true, it specifies that the colourPrimaries, transferCharacteristics, and colourMatrix are present. More...
 
uint8_t NvMediaEncodeConfigH265VUIParams::colourPrimaries
 Holds color primaries for converting to RGB (as defined in Annex E of the ITU-T Specification). More...
 
uint8_t NvMediaEncodeConfigH265VUIParams::transferCharacteristics
 Holds the opto-electronic transfer characteristics to use (as defined in Annex E of the ITU-T Specification). More...
 
uint8_t NvMediaEncodeConfigH265VUIParams::matrixCoeffs
 Holds the matrix coefficients used in deriving the luma and chroma from the RGB primaries (as defined in Annex E of the ITU-T Specification). More...
 
bool NvMediaEncodeConfigH265VUIParams::vuiTimingInfoPresentFlag
 Holds that num_units_in_tick, time_scale and fixed_frame_rate_flag are present in the bitstream (as defined in Annex E of the ITU-T Specification). More...
 
bool NvMediaEncodeConfigH265VUIParams::bitstreamRestrictionFlag
 Specified the bitstream restriction info (as defined in Annex E of the ITU-T Specification). More...
 
uint32_t NvMediaEncodeConfigH265::features
 Holds bit-wise OR`ed configuration feature flags. More...
 
uint32_t NvMediaEncodeConfigH265::gopLength
 Holds the number of pictures in one GOP. More...
 
NvMediaEncodeRCParams NvMediaEncodeConfigH265::rcParams
 Holds the rate control parameters for the current encoding session. More...
 
NvMediaEncodeH264SPSPPSRepeatMode NvMediaEncodeConfigH265::repeatSPSPPS
 Holds the frequency of the writing of Sequence and Picture parameters. More...
 
uint32_t NvMediaEncodeConfigH265::idrPeriod
 Holds the IDR interval. More...
 
uint16_t NvMediaEncodeConfigH265::numSliceCountMinus1
 Holds a number that is 1 less than the desired number of slices per frame. More...
 
uint8_t NvMediaEncodeConfigH265::disableDeblockingFilter
 Holds disable the deblocking filter. More...
 
uint8_t NvMediaEncodeConfigH265::enableWeightedPrediction
 Holds enable weighted prediction. More...
 
uint32_t NvMediaEncodeConfigH265::intraRefreshPeriod
 Holds the interval between frames that trigger a new intra refresh cycle and this cycle lasts for intraRefreshCnt frames. More...
 
uint32_t NvMediaEncodeConfigH265::intraRefreshCnt
 Holds the number of frames over which intra refresh will happen. More...
 
uint32_t NvMediaEncodeConfigH265::maxSliceSizeInBytes
 Holds the maximum slice size in bytes for dynamic slice mode. More...
 
uint32_t NvMediaEncodeConfigH265::numCTUsPerSlice
 Number of CTU per slice. More...
 
NvMediaEncodeConfigH265VUIParamsNvMediaEncodeConfigH265::h265VUIParameters
 Holds the H265 video usability info pamameters. More...
 
NvMediaEncodeQuality NvMediaEncodeConfigH265::quality
 Holds encode quality pre-set. More...
 
NvMediaEncodeQP NvMediaEncodeConfigH265::initQP
 Holds Initial QP parameters. More...
 
NvMediaEncodeQP NvMediaEncodeConfigH265::maxQP
 Holds maximum QP parameters. More...
 
NvMediaEncPreset NvMediaEncodeConfigH265::encPreset
 Holds the encode quality pre-set. More...
 
bool NvMediaEncodeConfigH265::enableNewPreset
 Set to true to use encPreset instead of quality. More...
 
uint16_t NvMediaEncodeInitializeParamsH265::encodeWidth
 Holds the encode width. More...
 
uint16_t NvMediaEncodeInitializeParamsH265::reserved1
 
uint16_t NvMediaEncodeInitializeParamsH265::encodeHeight
 Holds the encode height. More...
 
uint16_t NvMediaEncodeInitializeParamsH265::reserved2
 
bool NvMediaEncodeInitializeParamsH265::enableLimitedRGB
 Set this to true for limited-RGB (16-235) input. More...
 
bool NvMediaEncodeInitializeParamsH265::enableSliceLevelEncode
 Set this to true for slice level encode. More...
 
uint32_t NvMediaEncodeInitializeParamsH265::frameRateNum
 Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint32_t NvMediaEncodeInitializeParamsH265::frameRateDen
 Holds the denominator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint8_t NvMediaEncodeInitializeParamsH265::profile
 Holds the encoding profile. More...
 
uint8_t NvMediaEncodeInitializeParamsH265::level
 Holds the encoding level. More...
 
uint8_t NvMediaEncodeInitializeParamsH265::levelTier
 Holds the level tier information. More...
 
uint8_t NvMediaEncodeInitializeParamsH265::maxNumRefFrames
 Holds the maximum number of reference frames used for encoding. More...
 
bool NvMediaEncodeInitializeParamsH265::enableExternalMEHints
 Set to true to enable external ME hints. More...
 
NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodeInitializeParamsH265::maxMEHintCountsPerBlock [2]
 If Client wants to pass external motion vectors in NvMediaEncodePicParamsH265 meExternalHints buffer it must specify the maximum number of hint candidates per block per direction for the encode session. More...
 
bool NvMediaEncodeInitializeParamsH265::enableReconCRC
 Enable support for recon CRC generation. More...
 
bool NvMediaEncodeInitializeParamsH265::enableMVC
 If client want to do MVC encoding then this flag need to be set. More...
 
bool NvMediaEncodeInitializeParamsH265::enableROIEncode
 Enable region of interest encoding. More...
 
bool NvMediaEncodeInitializeParamsH265::enableSliceEncode
 use slice encode to reduce latency in getting encoded buffers. More...
 
uint32_t NvMediaEncodeInitializeParamsH265::useBFramesAsRef
 Enables B frames to be used as reference frames. More...
 
bool NvMediaEncodeInitializeParamsH265::enableTwoPassRC
 Enable 2 pass RC support. More...
 
bool NvMediaEncodeInitializeParamsH265::enableSourceHalfScaled
 Enable 2 pass RC with quarter resolution first pass. More...
 
uint32_t NvMediaEncodeInitializeParamsH265::mvNumViews: 4
 Number of views used for MV-Hevc. More...
 
uint32_t NvMediaEncodeInitializeParamsH265::enableExternalPictureRC: 1
 Enable external picture rate control. More...
 
uint32_t NvMediaEncodeInitializeParamsH265::enableAllIFrames: 1
 Encode all frames as I frames. More...
 
uint32_t NvMediaEncodeInitializeParamsH265::reserved: 26
 Add padding. More...
 
bool NvMediaEncodeInitializeParamsH265::ampDisable
 Use ampDisable to enable or disable assymetric partition types. More...
 
uint32_t NvMediaEncodeH265SEIPayload::payloadSize
 SEI payload size in bytes. More...
 
uint32_t NvMediaEncodeH265SEIPayload::payloadType
 SEI payload types and syntax can be found in Annex D of the H265 Specification. More...
 
uint32_t NvMediaEncodeH265SEIPayload::nalUnitType
 SEI nal_unit_type. More...
 
uint8_t * NvMediaEncodeH265SEIPayload::payload
 pointer to user data More...
 
NvMediaEncodePicType NvMediaEncodePicParamsH265::pictureType
 Holds input picture type. More...
 
uint32_t NvMediaEncodePicParamsH265::encodePicFlags
 Holds bit-wise OR`ed encode pic flags. More...
 
uint32_t NvMediaEncodePicParamsH265::nextBFrames
 Specifies the number of B-frames that follow the current frame. More...
 
NvMediaEncodeRCParams NvMediaEncodePicParamsH265::rcParams
 Holds the rate control parameters from the current frame onward if the NVMEDIA_ENCODE_PIC_FLAG_RATECONTROL_CHANGE is set in the encodePicFlags. More...
 
uint32_t NvMediaEncodePicParamsH265::seiPayloadArrayCnt
 Holds the number of elements allocated in seiPayloadArray array. More...
 
NvMediaEncodeH265SEIPayloadNvMediaEncodePicParamsH265::seiPayloadArray
 Array of SEI payloads which will be inserted for this frame. More...
 
NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodePicParamsH265::meHintCountsPerBlock [2]
 Holds the number of hint candidates per block per direction for the current frame. More...
 
NvMediaEncodeExternalMEHintNvMediaEncodePicParamsH265::meExternalHints
 Holds the pointer to ME external hints for the current frame. More...
 
uint32_t NvMediaEncodePicParamsH265::frameRateNum
 Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint32_t NvMediaEncodePicParamsH265::frameRateDen
 Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint32_t NvMediaEncodePicParamsH265::viewId
 Holds the viewId of current picture. More...
 
uint32_t NvMediaEncodeConfigVP9::features
 Holds bit-wise OR`ed configuration feature flags. More...
 
uint32_t NvMediaEncodeConfigVP9::gopLength
 Holds the number of pictures in one GOP. More...
 
NvMediaEncodeRCParams NvMediaEncodeConfigVP9::rcParams
 Holds the rate control parameters for the current encoding session. More...
 
uint32_t NvMediaEncodeConfigVP9::idrPeriod
 Holds the IDR interval. More...
 
uint32_t NvMediaEncodeConfigVP9::filter_type
 Set the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_LOOP_FILTER_PARAMS to change the following parameters. More...
 
uint32_t NvMediaEncodeConfigVP9::filter_level
 Specifies the loop filter strength for each segment. More...
 
uint32_t NvMediaEncodeConfigVP9::sharpness_level
 Specifies Sharpness level. More...
 
int8_t NvMediaEncodeConfigVP9::ref_lf_deltas [4]
 Specifies the Loop filter strength adjustments based on frame type (intra, inter). More...
 
int8_t NvMediaEncodeConfigVP9::mode_lf_deltas [2]
 Specifies the Loop filter strength adjustments based on mode (zero, new mv). More...
 
bool NvMediaEncodeConfigVP9::bmode_ref_lf_delta_enabled
 Set it to true if MB-level loop filter adjustment is on. More...
 
bool NvMediaEncodeConfigVP9::bmode_ref_lf_delta_update
 Set it to true if MB-level loop filter adjustment delta values are updated. More...
 
uint32_t NvMediaEncodeConfigVP9::base_qindex
 Set the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_QUANTIZATION_PARAMS to set the following parameters. More...
 
int32_t NvMediaEncodeConfigVP9::delta_y_dc_q
 Specifies explicit qindex adjustment for y dccoefficient, -15...15. More...
 
int32_t NvMediaEncodeConfigVP9::delta_uv_dc
 Specifies qindex adjustment for uv accoefficient, -15...15. More...
 
int32_t NvMediaEncodeConfigVP9::delta_uv_ac
 Specifies qindex adjustment for uv dccoefficient, -15...15. More...
 
uint32_t NvMediaEncodeConfigVP9::transform_mode
 Set the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_TRANSFORM_MODE to set the following parameter. More...
 
uint32_t NvMediaEncodeConfigVP9::high_prec_mv
 Set the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_HIGH_PRECISION_MV to set the following parameter. More...
 
bool NvMediaEncodeConfigVP9::error_resilient
 Set the feature flag NVMEDIA_ENCODE_CONFIG_VP9_DISABLE_ERROR_RESILIENT to set the following parameter. More...
 
NvMediaEncodeQP NvMediaEncodeConfigVP9::initQP
 Holds Initial QP parameters. More...
 
NvMediaEncodeQP NvMediaEncodeConfigVP9::maxQP
 Holds maximum QP parameters. More...
 
uint32_t NvMediaEncodeInitializeParamsVP9::encodeWidth
 Holds the encode width. More...
 
uint32_t NvMediaEncodeInitializeParamsVP9::encodeHeight
 Holds the encode height. More...
 
bool NvMediaEncodeInitializeParamsVP9::enableLimitedRGB
 Holds a flag indicating whether input is limited-RGB (16-235). More...
 
uint32_t NvMediaEncodeInitializeParamsVP9::frameRateNum
 Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint32_t NvMediaEncodeInitializeParamsVP9::frameRateDen
 Holds the denominator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint8_t NvMediaEncodeInitializeParamsVP9::maxNumRefFrames
 Holds the max reference numbers used for encoding. More...
 
bool NvMediaEncodeInitializeParamsVP9::enableExternalMEHints
 Holds a flag indicating whether to enable or disable the external ME hints. More...
 
NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodeInitializeParamsVP9::maxMEHintCountsPerBlock [2]
 If Client wants to pass external motion vectors in NvMediaEncodePicParamsVP9 meExternalHints buffer it must specify the maximum number of hint candidates, per block and per direction, for the encode session. More...
 
uint8_t NvMediaEncodeInitializeParamsVP9::numEpCores
 Holds number of HW entropy cores for encoding. More...
 
uint32_t NvMediaEncodeInitializeParamsVP9::log2TileRows
 Holds number of log2Rows used in a frame. More...
 
uint32_t NvMediaEncodeInitializeParamsVP9::log2TileCols
 Holds number of log2Cols used in a frame. More...
 
uint32_t NvMediaEncodeInitializeParamsVP9::vp9SkipChroma
 Skip Chroma Processing. More...
 
NvMediaEncodePicType NvMediaEncodePicParamsVP9::pictureType
 Holds input picture type. More...
 
uint32_t NvMediaEncodePicParamsVP9::encodePicFlags
 Holds bit-wise OR`ed encode pic flags. More...
 
uint32_t NvMediaEncodePicParamsVP9::nextBFrames
 Holds the number of B-frames that follow the current frame. More...
 
NvMediaEncodeRCParams NvMediaEncodePicParamsVP9::rcParams
 Holds the rate control parameters from the current frame onward if the NVMEDIA_ENCODE_PIC_FLAG_RATECONTROL_CHANGE is set in the encodePicFlags. More...
 
NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodePicParamsVP9::meHintCountsPerBlock [2]
 Holds the number of hint candidates per block per direction for the current frame. More...
 
NvMediaEncodeExternalMEHintNvMediaEncodePicParamsVP9::meExternalHints
 Holds the pointer to ME external hints for the current frame. More...
 
uint32_t NvMediaEncodeConfigAV1::features
 Holds bit-wise OR`ed configuration feature flags. More...
 
uint32_t NvMediaEncodeConfigAV1::gopLength
 Holds the number of pictures in one GOP. More...
 
NvMediaEncodeRCParams NvMediaEncodeConfigAV1::rcParams
 Holds the rate control parameters for the current encoding session. More...
 
uint32_t NvMediaEncodeConfigAV1::idrPeriod
 Holds the IDR interval. More...
 
uint32_t NvMediaEncodeConfigAV1::base_qindex
 Specifies quant base index (used only when rc_mode = 0) for each segment 0...255. More...
 
int32_t NvMediaEncodeConfigAV1::delta_y_dc_q
 Specifies explicit qindex adjustment for y dccoefficient, -15...15. More...
 
int32_t NvMediaEncodeConfigAV1::delta_uv_dc
 Specifies qindex adjustment for uv accoefficient, -15...15. More...
 
int32_t NvMediaEncodeConfigAV1::delta_uv_ac
 Specifies qindex adjustment for uv dccoefficient, -15...15. More...
 
NvMediaEncodeQP NvMediaEncodeConfigAV1::initQP
 Holds Initial QP parameters. More...
 
NvMediaEncodeQP NvMediaEncodeConfigAV1::maxQP
 Holds maximum QP parameters. More...
 
NvMediaEncodeQuality NvMediaEncodeConfigAV1::quality
 Holds the encode quality pre-set. More...
 
NvMediaBool NvMediaEncodeConfigAV1::disableCdfUpdate
 Set to true to disable CDF update. More...
 
NvMediaEncPreset NvMediaEncodeConfigAV1::encPreset
 Holds the encode quality pre-set. More...
 
bool NvMediaEncodeConfigAV1::enableNewPreset
 Set to true to use encPreset instead of quality. More...
 
uint32_t NvMediaEncodeConfigAV1::reserved [17]
 Reserved Bytes. More...
 
uint32_t NvMediaEncodeInitializeParamsAV1::encodeWidth
 Holds the encode width. More...
 
uint32_t NvMediaEncodeInitializeParamsAV1::encodeHeight
 Holds the encode height. More...
 
bool NvMediaEncodeInitializeParamsAV1::enableLimitedRGB
 Holds a flag indicating whether input is limited-RGB (16-235). More...
 
uint32_t NvMediaEncodeInitializeParamsAV1::frameRateNum
 Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint32_t NvMediaEncodeInitializeParamsAV1::frameRateDen
 Holds the denominator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint8_t NvMediaEncodeInitializeParamsAV1::profile
 Holds the encoding profile. More...
 
uint8_t NvMediaEncodeInitializeParamsAV1::level
 Holds the encoding level. More...
 
uint8_t NvMediaEncodeInitializeParamsAV1::maxNumRefFrames
 Holds the max reference numbers used for encoding. More...
 
bool NvMediaEncodeInitializeParamsAV1::enableSsimRdo
 Set to true to enable SSIM RDO. More...
 
bool NvMediaEncodeInitializeParamsAV1::enableTileEncode
 Set to true to enable Multiple tile mode. More...
 
uint8_t NvMediaEncodeInitializeParamsAV1::log2NumTilesInRow
 Holds the log2 value of number of tiles used in a row. More...
 
uint8_t NvMediaEncodeInitializeParamsAV1::log2NumTilesInCol
 Holds the log2 value of number of tiles used in a column. More...
 
uint8_t NvMediaEncodeInitializeParamsAV1::frameRestorationType
 
bool NvMediaEncodeInitializeParamsAV1::enableBiCompound
 
bool NvMediaEncodeInitializeParamsAV1::enableUniCompound
 
bool NvMediaEncodeInitializeParamsAV1::enableInternalHighBitDepth
 
bool NvMediaEncodeInitializeParamsAV1::enableExternalMEHints
 Holds a flag indicating whether to enable or disable the external ME hints. More...
 
NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodeInitializeParamsAV1::maxMEHintCountsPerBlock [2]
 If Client wants to pass external motion vectors in NvMediaEncodePicParamsVP9 meExternalHints buffer it must specify the maximum number of hint candidates, per block and per direction, for the encode session. More...
 
uint32_t NvMediaEncodeInitializeParamsAV1::reserved [20]
 Reserved Bytes. More...
 
NvMediaEncodePicType NvMediaEncodePicParamsAV1::pictureType
 Holds input picture type. More...
 
uint32_t NvMediaEncodePicParamsAV1::encodePicFlags
 Holds bit-wise OR`ed encode pic flags. More...
 
uint32_t NvMediaEncodePicParamsAV1::nextBFrames
 Holds the number of B-frames that follow the current frame. More...
 
NvMediaEncodeRCParams NvMediaEncodePicParamsAV1::rcParams
 Holds the rate control parameters from the current frame onward if the NVMEDIA_ENCODE_PIC_FLAG_RATECONTROL_CHANGE is set in the encodePicFlags. More...
 
NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodePicParamsAV1::meHintCountsPerBlock [2]
 Holds the number of hint candidates per block per direction for the current frame. More...
 
NvMediaEncodeExternalMEHintNvMediaEncodePicParamsAV1::meExternalHints
 Holds the pointer to ME external hints for the current frame. More...
 
uint32_t NvMediaEncodePicParamsAV1::frameRateNum
 Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint32_t NvMediaEncodePicParamsAV1::frameRateDen
 Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ). More...
 
uint32_t NvMediaEncodePicParamsAV1::reserved [18]
 Reserved Bytes. More...
 
enum  NvMediaEncodePicType {
  NVMEDIA_ENCODE_PIC_TYPE_AUTOSELECT = 0,
  NVMEDIA_ENCODE_PIC_TYPE_P = 1,
  NVMEDIA_ENCODE_PIC_TYPE_B = 2,
  NVMEDIA_ENCODE_PIC_TYPE_I = 3,
  NVMEDIA_ENCODE_PIC_TYPE_IDR = 4,
  NVMEDIA_ENCODE_PIC_TYPE_P_INTRA_REFRESH = 5
}
 Input picture type. More...
 
enum  NvMediaEncodeProfile {
  NVMEDIA_ENCODE_PROFILE_AUTOSELECT = 0,
  NVMEDIA_ENCODE_PROFILE_BASELINE = 66,
  NVMEDIA_ENCODE_PROFILE_MAIN = 77,
  NVMEDIA_ENCODE_PROFILE_EXTENDED = 88,
  NVMEDIA_ENCODE_PROFILE_HIGH = 100,
  NVMEDIA_ENCODE_PROFILE_HIGH444 = 244
}
 Defines encoding profiles. More...
 
enum  NvMediaEncodeLevel {
  NVMEDIA_ENCODE_LEVEL_AUTOSELECT = 0,
  NVMEDIA_ENCODE_LEVEL_H264_1 = 10,
  NVMEDIA_ENCODE_LEVEL_H264_1b = 9,
  NVMEDIA_ENCODE_LEVEL_H264_11 = 11,
  NVMEDIA_ENCODE_LEVEL_H264_12 = 12,
  NVMEDIA_ENCODE_LEVEL_H264_13 = 13,
  NVMEDIA_ENCODE_LEVEL_H264_2 = 20,
  NVMEDIA_ENCODE_LEVEL_H264_21 = 21,
  NVMEDIA_ENCODE_LEVEL_H264_22 = 22,
  NVMEDIA_ENCODE_LEVEL_H264_3 = 30,
  NVMEDIA_ENCODE_LEVEL_H264_31 = 31,
  NVMEDIA_ENCODE_LEVEL_H264_32 = 32,
  NVMEDIA_ENCODE_LEVEL_H264_4 = 40,
  NVMEDIA_ENCODE_LEVEL_H264_41 = 41,
  NVMEDIA_ENCODE_LEVEL_H264_42 = 42,
  NVMEDIA_ENCODE_LEVEL_H264_5 = 50,
  NVMEDIA_ENCODE_LEVEL_H264_51 = 51,
  NVMEDIA_ENCODE_LEVEL_H264_52 = 52,
  NVMEDIA_ENCODE_LEVEL_H264_END = 255
}
 Defines encoding levels for H264 encoder. More...
 
enum  NvMediaEncodeLevelH265 {
  NVMEDIA_ENCODE_LEVEL_H265_AUTOSELECT = 0,
  NVMEDIA_ENCODE_LEVEL_H265_1 = 30,
  NVMEDIA_ENCODE_LEVEL_H265_2 = 60,
  NVMEDIA_ENCODE_LEVEL_H265_21 = 63,
  NVMEDIA_ENCODE_LEVEL_H265_3 = 90,
  NVMEDIA_ENCODE_LEVEL_H265_31 = 93,
  NVMEDIA_ENCODE_LEVEL_H265_4 = 120,
  NVMEDIA_ENCODE_LEVEL_H265_41 = 123,
  NVMEDIA_ENCODE_LEVEL_H265_5 = 150,
  NVMEDIA_ENCODE_LEVEL_H265_51 = 153,
  NVMEDIA_ENCODE_LEVEL_H265_52 = 156,
  NVMEDIA_ENCODE_LEVEL_H265_6 = 180,
  NVMEDIA_ENCODE_LEVEL_H265_61 = 183,
  NVMEDIA_ENCODE_LEVEL_H265_62 = 186,
  NVMEDIA_ENCODE_LEVEL_H265_END = 255
}
 Defines encoding levels for H265 encoder. More...
 
enum  NvMediaEncodePicFlags {
  NVMEDIA_ENCODE_PIC_FLAG_OUTPUT_SPSPPS = (1 << 0),
  NVMEDIA_ENCODE_PIC_FLAG_RATECONTROL_CHANGE = (1 << 1),
  NVMEDIA_ENCODE_PIC_FLAG_CONSTRAINED_FRAME = (1 << 2)
}
 Defines encoding Picture encode flags. More...
 
enum  NvMediaEncodeQuality {
  NVMEDIA_ENCODE_QUALITY_L0 = 0,
  NVMEDIA_ENCODE_QUALITY_L1 = 1,
  NVMEDIA_ENCODE_QUALITY_L2 = 2,
  NVMEDIA_ENCODE_QUALITY_DEFAULT = 3
}
 Defines encode quality level pre-settings. More...
 
enum  NvMediaEncPreset {
  NVMEDIA_ENC_PRESET_HQ = 0x0,
  NVMEDIA_ENC_PRESET_HP = 0x10,
  NVMEDIA_ENC_PRESET_UHP = 0x20,
  NVMEDIA_ENC_PRESET_DEFAULT = 0x7FFFFFFF
}
 Defines encode preset level settings. More...
 
enum  NvMediaEncodeH264EntropyCodingMode {
  NVMEDIA_ENCODE_H264_ENTROPY_CODING_MODE_CAVLC = 0,
  NVMEDIA_ENCODE_H264_ENTROPY_CODING_MODE_CABAC = 1
}
 Defines H.264 entropy coding modes. More...
 
enum  NvMediaEncodeH264BDirectMode {
  NVMEDIA_ENCODE_H264_BDIRECT_MODE_SPATIAL = 0,
  NVMEDIA_ENCODE_H264_BDIRECT_MODE_DISABLE = 1,
  NVMEDIA_ENCODE_H264_BDIRECT_MODE_TEMPORAL = 2
}
 Defines H.264 specific Bdirect modes. More...
 
enum  NvMediaEncodeH264AdaptiveTransformMode {
  NVMEDIA_ENCODE_H264_ADAPTIVE_TRANSFORM_AUTOSELECT = 0,
  NVMEDIA_ENCODE_H264_ADAPTIVE_TRANSFORM_DISABLE = 1,
  NVMEDIA_ENCODE_H264_ADAPTIVE_TRANSFORM_ENABLE = 2
}
 Defines H.264 specific Adaptive Transform modes. More...
 
enum  NvMediaEncodeH264MotionPredictionExclusionFlags {
  NVMEDIA_ENCODE_DISABLE_INTRA_4x4_VERTICAL_PREDICTION = (1 << 0),
  NVMEDIA_ENCODE_DISABLE_INTRA_4x4_HORIZONTAL_PREDICTION = (1 << 1),
  NVMEDIA_ENCODE_DISABLE_INTRA_4x4_DC_PREDICTION = (1 << 2),
  NVMEDIA_ENCODE_DISABLE_INTRA_4x4_DIAGONAL_DOWN_LEFT_PREDICTION = (1 << 3),
  NVMEDIA_ENCODE_DISABLE_INTRA_4x4_DIAGONAL_DOWN_RIGHT_PREDICTION = (1 << 4),
  NVMEDIA_ENCODE_DISABLE_INTRA_4x4_VERTICAL_RIGHT_PREDICTION = (1 << 5),
  NVMEDIA_ENCODE_DISABLE_INTRA_4x4_HORIZONTAL_DOWN_PREDICTION = (1 << 6),
  NVMEDIA_ENCODE_DISABLE_INTRA_4x4_VERTICAL_LEFT_PREDICTION = (1 << 7),
  NVMEDIA_ENCODE_DISABLE_INTRA_4x4_HORIZONTAL_UP_PREDICTION = (1 << 8),
  NVMEDIA_ENCODE_DISABLE_INTRA_8x8_VERTICAL_PREDICTION = (1 << 9),
  NVMEDIA_ENCODE_DISABLE_INTRA_8x8_HORIZONTAL_PREDICTION = (1 << 10),
  NVMEDIA_ENCODE_DISABLE_INTRA_8x8_DC_PREDICTION = (1 << 11),
  NVMEDIA_ENCODE_DISABLE_INTRA_8x8_DIAGONAL_DOWN_LEFT_PREDICTION = (1 << 12),
  NVMEDIA_ENCODE_DISABLE_INTRA_8x8_DIAGONAL_DOWN_RIGHT_PREDICTION = (1 << 13),
  NVMEDIA_ENCODE_DISABLE_INTRA_8x8_VERTICAL_RIGHT_PREDICTION = (1 << 14),
  NVMEDIA_ENCODE_DISABLE_INTRA_8x8_HORIZONTAL_DOWN_PREDICTION = (1 << 15),
  NVMEDIA_ENCODE_DISABLE_INTRA_8x8_VERTICAL_LEFT_PREDICTION = (1 << 16),
  NVMEDIA_ENCODE_DISABLE_INTRA_8x8_HORIZONTAL_UP_PREDICTION = (1 << 17),
  NVMEDIA_ENCODE_DISABLE_INTRA_16x16_VERTICAL_PREDICTION = (1 << 18),
  NVMEDIA_ENCODE_DISABLE_INTRA_16x16_HORIZONTAL_PREDICTION = (1 << 19),
  NVMEDIA_ENCODE_DISABLE_INTRA_16x16_DC_PREDICTION = (1 << 20),
  NVMEDIA_ENCODE_DISABLE_INTRA_16x16_PLANE_PREDICTION = (1 << 21),
  NVMEDIA_ENCODE_DISABLE_INTRA_CHROMA_VERTICAL_PREDICTION = (1 << 22),
  NVMEDIA_ENCODE_DISABLE_INTRA_CHROMA_HORIZONTAL_PREDICTION = (1 << 23),
  NVMEDIA_ENCODE_DISABLE_INTRA_CHROMA_DC_PREDICTION = (1 << 24),
  NVMEDIA_ENCODE_DISABLE_INTRA_CHROMA_PLANE_PREDICTION = (1 << 25),
  NVMEDIA_ENCODE_DISABLE_INTER_L0_16x16_PREDICTION = (1 << 26),
  NVMEDIA_ENCODE_DISABLE_INTER_L0_16x8_PREDICTION = (1 << 27),
  NVMEDIA_ENCODE_DISABLE_INTER_L0_8x16_PREDICTION = (1 << 28),
  NVMEDIA_ENCODE_DISABLE_INTER_L0_8x8_PREDICTION = (1 << 29)
}
 Defines motion prediction exclusion flags for H.264. More...
 
enum  NvMediaEncodeH264MotionSearchControlFlags {
  NVMEDIA_ENCODE_ENABLE_IP_SEARCH_INTRA_4x4 = (1 << 0),
  NVMEDIA_ENCODE_ENABLE_IP_SEARCH_INTRA_8x8 = (1 << 1),
  NVMEDIA_ENCODE_ENABLE_IP_SEARCH_INTRA_16x16 = (1 << 2),
  NVMEDIA_ENCODE_ENABLE_SELF_TEMPORAL_REFINE = (1 << 3),
  NVMEDIA_ENCODE_ENABLE_SELF_SPATIAL_REFINE = (1 << 4),
  NVMEDIA_ENCODE_ENABLE_COLOC_REFINE = (1 << 5),
  NVMEDIA_ENCODE_ENABLE_EXTERNAL_REFINE = (1 << 6),
  NVMEDIA_ENCODE_ENABLE_CONST_MV_REFINE = (1 << 7),
  NVMEDIA_ENCODE_MOTION_SEARCH_CONTROL_FLAG_VALID = (1 << 31)
}
 Defines motion search mode control flags for H.264. More...
 
enum  NvMediaEncodeH264SPSPPSRepeatMode {
  NVMEDIA_ENCODE_SPSPPS_REPEAT_DISABLED = 0,
  NVMEDIA_ENCODE_SPSPPS_REPEAT_INTRA_FRAMES = 1,
  NVMEDIA_ENCODE_SPSPPS_REPEAT_IDR_FRAMES = 2
}
 Specifies the frequency of the writing of Sequence and Picture parameters for H.264. More...
 
enum  NvMediaEncAttrType {
  NvMediaEncAttr_GetSPS = 1,
  NvMediaEncAttr_GetPPS,
  NvMediaEncAttr_GetVPS
}
 Specifies the encoder get attribute type. More...
 
enum  NvMediaEncodeH264POCType {
  NVMEDIA_ENCODE_H264_POC_TYPE_AUTOSELECT = 0,
  NVMEDIA_ENCODE_H264_POC_TYPE_0 = 1,
  NVMEDIA_ENCODE_H264_POC_TYPE_2 = 2
}
 Define H.264 pic_order_cnt_type. More...
 
enum  NvMediaEncodeH264Features {
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_OUTPUT_AUD = (1 << 0),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_INTRA_REFRESH = (1 << 1),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_DYNAMIC_SLICE_MODE = (1 << 2),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_CONSTRANED_ENCODING = (1 << 3),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_LOSSLESS_COMPRESSION = (1 << 4),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_SLICE_LEVEL_OUTPUT = (1 << 5),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_RTP_MODE_OUTPUT = (1 << 6),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_EXT_PIC_RC_HINT = (1 << 7),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_DYNAMIC_RPS = (1 << 8),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_MV_BUFFER_DUMP = (1 << 9),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_PROFILING = (1 << 10),
  NVMEDIA_ENCODE_CONFIG_H264_INIT_QP = (1 << 11),
  NVMEDIA_ENCODE_CONFIG_H264_QP_MAX = (1 << 12),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_FOUR_BYTE_START_CODE = (1 << 13),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_ULTRA_FAST_ENCODE = (1 << 14),
  NVMEDIA_ENCODE_CONFIG_H264_ENABLE_MV_BUFFER_DUMP_V2 = (1 << 15)
}
 Defines H264 encoder configuration features. More...
 
#define MAX_NON_SLICE_DATA_SIZE
 Maximum encoded header info size. More...
 

Macro Definition Documentation

◆ MAX_NON_SLICE_DATA_SIZE

#define MAX_NON_SLICE_DATA_SIZE

Maximum encoded header info size.

Definition at line 595 of file nvmedia_common_encode.h.

Enumeration Type Documentation

◆ NvMediaEncAttrType

Specifies the encoder get attribute type.

This can be extended to get other encoding parameter information.

Enumerator
NvMediaEncAttr_GetSPS 

This attribute is used to get SPS data for current encoding session.

NvMediaEncAttr_GetPPS 

This attribute is used to get PPS data for current encoding session.

NvMediaEncAttr_GetVPS 

This attribute is used to get VPS data for current h265 encoding session.

Definition at line 568 of file nvmedia_common_encode.h.

◆ NvMediaEncodeH264AdaptiveTransformMode

Defines H.264 specific Adaptive Transform modes.

Enumerator
NVMEDIA_ENCODE_H264_ADAPTIVE_TRANSFORM_AUTOSELECT 

Specifies that Adaptive Transform 8x8 mode is auto selected by the encoder driver.

NVMEDIA_ENCODE_H264_ADAPTIVE_TRANSFORM_DISABLE 

Specifies that Adaptive Transform 8x8 mode is disabled.

NVMEDIA_ENCODE_H264_ADAPTIVE_TRANSFORM_ENABLE 

Specifies that Adaptive Transform 8x8 mode must be used.

Definition at line 441 of file nvmedia_common_encode.h.

◆ NvMediaEncodeH264BDirectMode

Defines H.264 specific Bdirect modes.

Enumerator
NVMEDIA_ENCODE_H264_BDIRECT_MODE_SPATIAL 

Spatial BDirect mode.

This value is not supported in the QNX Safety build.

NVMEDIA_ENCODE_H264_BDIRECT_MODE_DISABLE 

Disable BDirect mode.

NVMEDIA_ENCODE_H264_BDIRECT_MODE_TEMPORAL 

Temporal BDirect mode.

This value is not supported in the QNX Safety build.

Definition at line 426 of file nvmedia_common_encode.h.

◆ NvMediaEncodeH264EntropyCodingMode

Defines H.264 entropy coding modes.

Enumerator
NVMEDIA_ENCODE_H264_ENTROPY_CODING_MODE_CAVLC 

Entropy coding mode is CAVLC.

NVMEDIA_ENCODE_H264_ENTROPY_CODING_MODE_CABAC 

Entropy coding mode is CABAC.

Definition at line 415 of file nvmedia_common_encode.h.

◆ NvMediaEncodeH264Features

Defines H264 encoder configuration features.

Enumerator
NVMEDIA_ENCODE_CONFIG_H264_ENABLE_OUTPUT_AUD 

Enable to write access unit delimiter syntax in bitstream.

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_INTRA_REFRESH 

Enable gradual decoder refresh or intra refresh.

If the GOP structure uses B frames this will be ignored

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_DYNAMIC_SLICE_MODE 

Enable dynamic slice mode.

Client must specify max slice size using the NvMediaEncodeConfigH264::maxSliceSizeInBytes field. This setting is not supported in the QNX Safety build.

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_CONSTRANED_ENCODING 

Enable constrainedFrame encoding where each slice in the constrained picture is independent of other slices.

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_LOSSLESS_COMPRESSION 

Enable lossless compression.

Note
This feature is not supported.
NVMEDIA_ENCODE_CONFIG_H264_ENABLE_SLICE_LEVEL_OUTPUT 

Enable slice level output encoding.

This enables delivery encoded data slice by slice to client to reduce encode latency. This setting is not supported in the QNX Safety build.

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_RTP_MODE_OUTPUT 

Enable RTP mode output.

NAL unit start code will be replaced with NAL size for the NAL units.

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_EXT_PIC_RC_HINT 

Enable support for external picture RC hint.

Note
This feature is not supported.
NVMEDIA_ENCODE_CONFIG_H264_ENABLE_DYNAMIC_RPS 

Enable support for dynamic reference picture set RPS/DPB control support.

After receiving an input buffer and result of previous frame encoding, based on real time information, Some client software determines properties for the new input buffer (long term/short term/non-referenced, frame number/poc/LT index). This setting is not supported in the QNX Safety build.

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_MV_BUFFER_DUMP 

Enable support for motion vector buffer dump.

This will enable motion vector dump. Motion vector buffer will be appended at the end of encoded bitstream data. This setting is not supported in the QNX Safety build.

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_PROFILING 

Enable encoder profiling.

Profiling information would be added as part of output extradata. This setting is not supported in the QNX Safety build.

NVMEDIA_ENCODE_CONFIG_H264_INIT_QP 

Enable support to use client provided Initial QP for all frame types.

NVMEDIA_ENCODE_CONFIG_H264_QP_MAX 

Enable support to use client provided QP max for all frame types.

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_FOUR_BYTE_START_CODE 

Enable support to use 4 byte start code in all the slices in a picture.

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_ULTRA_FAST_ENCODE 

Enable ultra fast encoding.

It overrides some of the quality settings to achieve ultra fast encoding. This is equivalent to setting NVMEDIA_ENCODE_QUALITY_L0 as the NvMediaEncodeQuality.

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_MV_BUFFER_DUMP_V2 

Enable support for motion vector buffer dump in a simplified (V2) format.

Motion vector buffer will be appended to the end of encoded bitstream data retrieved using NvMediaIEPGetBits. Refer NvMediaEncodeOutputExtradata for more information regarding the format of the dumped MV output. Either NVMEDIA_ENCODE_CONFIG_H264_ENABLE_MV_BUFFER_DUMP_V2 or NVMEDIA_ENCODE_CONFIG_H264_ENABLE_MV_BUFFER_DUMP should be enabled at a given time. If both are enabled, V2 format will be used.

It should be ensured that size of NvMediaBitstreamBuffer passed to NvMediaIEPGetBits has sufficient space to store the MV buffer dump. The numBytesAvailable returned by NvMediaIEPBitsAvailable or numBytes returned by NvMediaIEPGetBits does not take MV buffer dump size into account - represents only the size of the encoded bits that are available. While allocating bitstream buffers, the additional amount of space required in bitstream to accommodate MV buffer data needs to be added. This can be calculated as follows:

mvBufferSize = sizeof(NvMediaEncodeMVBufferHeader) +
ALIGN_256(numMacroBlocks * sizeof(NvMediaEncodeMVData))
where,
NumMacroBlocks =
(ALIGN_16(InputWidth)/16) * (ALIGN_16(InputHeight)/16)
bitstreamSize = ALIGN_8(bitsAvailable) + mvBufferSize

ALIGN_N refers to an operation which returns a multiple of N, greater than or equal to a number, closest to the number.

Note
This setting is not supported in the QNX Safety build.

Definition at line 702 of file nvmedia_common_encode.h.

◆ NvMediaEncodeH264MotionPredictionExclusionFlags

Defines motion prediction exclusion flags for H.264.

Deprecated:
This feature will be deprecated in a future release.
Enumerator
NVMEDIA_ENCODE_DISABLE_INTRA_4x4_VERTICAL_PREDICTION 

Disable Intra 4x4 vertical prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_4x4_HORIZONTAL_PREDICTION 

Disable Intra 4x4 horizontal prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_4x4_DC_PREDICTION 

Disable Intra 4x4 DC prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_4x4_DIAGONAL_DOWN_LEFT_PREDICTION 

Disable Intra 4x4 diagonal down left prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_4x4_DIAGONAL_DOWN_RIGHT_PREDICTION 

Disable Intra 4x4 diagonal down right prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_4x4_VERTICAL_RIGHT_PREDICTION 

Disable Intra 4x4 vertical right prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_4x4_HORIZONTAL_DOWN_PREDICTION 

Disable Intra 4x4 horizontal down prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_4x4_VERTICAL_LEFT_PREDICTION 

Disable Intra 4x4 vertical left prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_4x4_HORIZONTAL_UP_PREDICTION 

Disable Intra 4x4 horizontal up prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_8x8_VERTICAL_PREDICTION 

Disable Intra 8x8 vertical prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_8x8_HORIZONTAL_PREDICTION 

Disable Intra 8x8 horizontal prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_8x8_DC_PREDICTION 

Disable Intra 8x8 DC prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_8x8_DIAGONAL_DOWN_LEFT_PREDICTION 

Disable Intra 8x8 diagonal down left prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_8x8_DIAGONAL_DOWN_RIGHT_PREDICTION 

Disable Intra 8x8 diagonal down right prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_8x8_VERTICAL_RIGHT_PREDICTION 

Disable Intra 8x8 vertical right prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_8x8_HORIZONTAL_DOWN_PREDICTION 

Disable Intra 8x8 horizontal down prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_8x8_VERTICAL_LEFT_PREDICTION 

Disable Intra 8x8 vertical left prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_8x8_HORIZONTAL_UP_PREDICTION 

Disable Intra 8x8 horizontal up prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_16x16_VERTICAL_PREDICTION 

Disable Intra 16x16 vertical prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_16x16_HORIZONTAL_PREDICTION 

Disable Intra 16x16 horizontal prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_16x16_DC_PREDICTION 

Disable Intra 16x16 DC prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_16x16_PLANE_PREDICTION 

Disable Intra 16x16 plane prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_CHROMA_VERTICAL_PREDICTION 

Disable Intra chroma vertical prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_CHROMA_HORIZONTAL_PREDICTION 

Disable Intra chroma horizontal prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_CHROMA_DC_PREDICTION 

Disable Intra chroma DC prediction.

NVMEDIA_ENCODE_DISABLE_INTRA_CHROMA_PLANE_PREDICTION 

Disable Intra chroma plane prediction.

NVMEDIA_ENCODE_DISABLE_INTER_L0_16x16_PREDICTION 

Disable Inter L0 partition 16x16 prediction.

NVMEDIA_ENCODE_DISABLE_INTER_L0_16x8_PREDICTION 

Disable Inter L0 partition 16x8 prediction.

NVMEDIA_ENCODE_DISABLE_INTER_L0_8x16_PREDICTION 

Disable Inter L0 partition 8x16 prediction.

NVMEDIA_ENCODE_DISABLE_INTER_L0_8x8_PREDICTION 

Disable Inter L0 partition 8x8 prediction.

Definition at line 456 of file nvmedia_common_encode.h.

◆ NvMediaEncodeH264MotionSearchControlFlags

Defines motion search mode control flags for H.264.

Deprecated:
This feature will be deprecated in a future release.
Enumerator
NVMEDIA_ENCODE_ENABLE_IP_SEARCH_INTRA_4x4 

IP Search mode bit Intra 4x4.

NVMEDIA_ENCODE_ENABLE_IP_SEARCH_INTRA_8x8 

IP Search mode bit Intra 8x8.

NVMEDIA_ENCODE_ENABLE_IP_SEARCH_INTRA_16x16 

IP Search mode bit Intra 16x16.

NVMEDIA_ENCODE_ENABLE_SELF_TEMPORAL_REFINE 

Enable self_temporal_refine.

NVMEDIA_ENCODE_ENABLE_SELF_SPATIAL_REFINE 

Enable self_spatial_refine.

NVMEDIA_ENCODE_ENABLE_COLOC_REFINE 

Enable coloc_refine.

NVMEDIA_ENCODE_ENABLE_EXTERNAL_REFINE 

Enable external_refine.

NVMEDIA_ENCODE_ENABLE_CONST_MV_REFINE 

Enable const_mv_refine.

NVMEDIA_ENCODE_MOTION_SEARCH_CONTROL_FLAG_VALID 

Enable the flag set.

Definition at line 528 of file nvmedia_common_encode.h.

◆ NvMediaEncodeH264POCType

Define H.264 pic_order_cnt_type.

Enumerator
NVMEDIA_ENCODE_H264_POC_TYPE_AUTOSELECT 

Automatic level selection.

NVMEDIA_ENCODE_H264_POC_TYPE_0 

Pic_order_cnt_type 0.

NVMEDIA_ENCODE_H264_POC_TYPE_2 

Pic_order_cnt_type 2.

Definition at line 582 of file nvmedia_common_encode.h.

◆ NvMediaEncodeH264SPSPPSRepeatMode

Specifies the frequency of the writing of Sequence and Picture parameters for H.264.

Enumerator
NVMEDIA_ENCODE_SPSPPS_REPEAT_DISABLED 

Repeating of SPS/PPS is disabled.

NVMEDIA_ENCODE_SPSPPS_REPEAT_INTRA_FRAMES 

SPS/PPS is repeated for every intra frame.

NVMEDIA_ENCODE_SPSPPS_REPEAT_IDR_FRAMES 

SPS/PPS is repeated for every IDR frame.

Definition at line 554 of file nvmedia_common_encode.h.

◆ NvMediaEncodeLevel

Defines encoding levels for H264 encoder.

Enumerator
NVMEDIA_ENCODE_LEVEL_AUTOSELECT 

Automatic level selection.

NVMEDIA_ENCODE_LEVEL_H264_1 

H.264 Level 1.

NVMEDIA_ENCODE_LEVEL_H264_1b 

H.264 Level 1b.

NVMEDIA_ENCODE_LEVEL_H264_11 

H.264 Level 1.1.

NVMEDIA_ENCODE_LEVEL_H264_12 

H.264 Level 1.2.

NVMEDIA_ENCODE_LEVEL_H264_13 

H.264 Level 1.3.

NVMEDIA_ENCODE_LEVEL_H264_2 

H.264 Level 2.

NVMEDIA_ENCODE_LEVEL_H264_21 

H.264 Level 2.1.

NVMEDIA_ENCODE_LEVEL_H264_22 

H.264 Level 2.2.

NVMEDIA_ENCODE_LEVEL_H264_3 

H.264 Level 3.

NVMEDIA_ENCODE_LEVEL_H264_31 

H.264 Level 3.1.

NVMEDIA_ENCODE_LEVEL_H264_32 

H.264 Level 3.2.

NVMEDIA_ENCODE_LEVEL_H264_4 

H.264 Level 4.

NVMEDIA_ENCODE_LEVEL_H264_41 

H.264 Level 4.1.

NVMEDIA_ENCODE_LEVEL_H264_42 

H.264 Level 4.2.

NVMEDIA_ENCODE_LEVEL_H264_5 

H.264 Level 5.0.

NVMEDIA_ENCODE_LEVEL_H264_51 

H.264 Level 5.1.

NVMEDIA_ENCODE_LEVEL_H264_52 

H.264 Level 5.2.

NVMEDIA_ENCODE_LEVEL_H264_END 
Note
This value is for internal use only.

Definition at line 263 of file nvmedia_common_encode.h.

◆ NvMediaEncodeLevelH265

Defines encoding levels for H265 encoder.

Enumerator
NVMEDIA_ENCODE_LEVEL_H265_AUTOSELECT 

Automatic level selection.

NVMEDIA_ENCODE_LEVEL_H265_1 

H.265 Level 1.0.

NVMEDIA_ENCODE_LEVEL_H265_2 

H.265 Level 2.0.

NVMEDIA_ENCODE_LEVEL_H265_21 

H.265 Level 2.1.

NVMEDIA_ENCODE_LEVEL_H265_3 

H.265 Level 3.0.

NVMEDIA_ENCODE_LEVEL_H265_31 

H.265 Level 3.1.

NVMEDIA_ENCODE_LEVEL_H265_4 

H.265 Level 4.0.

NVMEDIA_ENCODE_LEVEL_H265_41 

H.265 Level 4.1.

NVMEDIA_ENCODE_LEVEL_H265_5 

H.265 Level 5.0.

NVMEDIA_ENCODE_LEVEL_H265_51 

H.265 Level 5.1.

NVMEDIA_ENCODE_LEVEL_H265_52 

H.265 Level 5.2.

NVMEDIA_ENCODE_LEVEL_H265_6 

H.265 Level 6.0.

NVMEDIA_ENCODE_LEVEL_H265_61 

H.265 Level 6.1.

NVMEDIA_ENCODE_LEVEL_H265_62 

H.265 Level 6.2.

NVMEDIA_ENCODE_LEVEL_H265_END 
Note
This value is for internal use only.

Definition at line 309 of file nvmedia_common_encode.h.

◆ NvMediaEncodePicFlags

Defines encoding Picture encode flags.

Enumerator
NVMEDIA_ENCODE_PIC_FLAG_OUTPUT_SPSPPS 

Writes the sequence and picture header in encoded bitstream of the current picture.

NVMEDIA_ENCODE_PIC_FLAG_RATECONTROL_CHANGE 

Indicates change in rate control parameters from the current picture onwards.

NVMEDIA_ENCODE_PIC_FLAG_CONSTRAINED_FRAME 

Indicates that this frame is encoded with each slice completely independent of other slices in the frame.

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_CONSTRANED_ENCODING must be set to support this encode mode

Definition at line 348 of file nvmedia_common_encode.h.

◆ NvMediaEncodePicType

Input picture type.

Enumerator
NVMEDIA_ENCODE_PIC_TYPE_AUTOSELECT 

Auto selected picture type.

NVMEDIA_ENCODE_PIC_TYPE_P 

Forward predicted.

NVMEDIA_ENCODE_PIC_TYPE_B 

Bi-directionally predicted picture.

NVMEDIA_ENCODE_PIC_TYPE_I 

Intra predicted picture.

NVMEDIA_ENCODE_PIC_TYPE_IDR 

IDR picture.

NVMEDIA_ENCODE_PIC_TYPE_P_INTRA_REFRESH 

Starts a new intra refresh cycle if intra refresh support is enabled otherwise it indicates a P frame.

Definition at line 219 of file nvmedia_common_encode.h.

◆ NvMediaEncodeProfile

Defines encoding profiles.

Enumerator
NVMEDIA_ENCODE_PROFILE_AUTOSELECT 

Automatic profile selection.

NVMEDIA_ENCODE_PROFILE_BASELINE 

Baseline profile.

NVMEDIA_ENCODE_PROFILE_MAIN 

Main profile.

NVMEDIA_ENCODE_PROFILE_EXTENDED 

Extended profile.

This value is not supported in the QNX Safety build.

NVMEDIA_ENCODE_PROFILE_HIGH 

High profile.

NVMEDIA_ENCODE_PROFILE_HIGH444 

High 444 profile.

H.264 High444 profile support lossless encode (trans-quant bypass) for YUV444 and YUV420 input. Lossy encode is not supported with High444 profile.

Definition at line 239 of file nvmedia_common_encode.h.

◆ NvMediaEncodeQuality

Defines encode quality level pre-settings.

Enumerator
NVMEDIA_ENCODE_QUALITY_L0 

Quality Level 0 Preset.


Relative comparison with respect to other presets:

  • Performance: High
  • Quality: Low
NVMEDIA_ENCODE_QUALITY_L1 

Quality Level 1 Preset.


Relative comparison with respect to other presets:

  • Performance: Medium
  • Quality: Medium
NVMEDIA_ENCODE_QUALITY_L2 

Quality Level 2 Preset.


Relative comparison with respect to other presets:

  • Performance: Low
  • Quality: High
NVMEDIA_ENCODE_QUALITY_DEFAULT 

Quality Level Default.

Default Encoder settings applied

Definition at line 365 of file nvmedia_common_encode.h.

◆ NvMediaEncPreset

Defines encode preset level settings.

Enumerator
NVMEDIA_ENC_PRESET_HQ 

Encoder Quality Preset HQ
Relative comparison with respect to other presets:

  • Performance: Low
  • Quality: High
NVMEDIA_ENC_PRESET_HP 

Encoder Quality Preset HP
Relative comparison with respect to other presets:

  • Performance: Medium
  • Quality: Medium
NVMEDIA_ENC_PRESET_UHP 

Encoder Quality Preset UHP
Relative comparison with respect to other presets:

  • Performance: High
  • Quality: Low
NVMEDIA_ENC_PRESET_DEFAULT 

Encoder Quality Preset Default.

Default Encoder settings applied

Definition at line 389 of file nvmedia_common_encode.h.

Variable Documentation

◆ @7

union { ... }

Holds the pointer to ME external hints for the current frame.

The size of ME hint buffer must be equal to number of macroblocks multiplied by the total number of candidates per macroblock. The total number of candidates per MB per direction =

1*meHintCountsPerBlock[Lx].numCandsPerBlk16x16 +
2*meHintCountsPerBlock[Lx].numCandsPerBlk16x8 +
2*meHintCountsPerBlock[Lx].numCandsPerBlk8x16 +
4*meHintCountsPerBlock[Lx].numCandsPerBlk8x8

For frames using bidirectional ME, the total number of candidates for a single macroblock is the sum of the total number of candidates per MB for each direction (L0 and L1).

If no external ME hints are needed, set this field to NULL.

Deprecated:
This feature will be deprecated in a future release.

◆ adaptiveTransformMode

NvMediaEncodeH264AdaptiveTransformMode NvMediaEncodeConfigH264::adaptiveTransformMode

Holds the Adaptive Transform Mode.

Definition at line 823 of file nvmedia_common_encode.h.

◆ ampDisable

bool NvMediaEncodeInitializeParamsH265::ampDisable

Use ampDisable to enable or disable assymetric partition types.

  • 0: enable AMP block paritions
  • 1: disble AMP block paritions

Definition at line 1487 of file nvmedia_common_encode.h.

◆ aspectRatioIdc [1/2]

uint8_t NvMediaEncodeConfigH264VUIParams::aspectRatioIdc

Holds the aspect ratio IDC (as defined in Annex E of the ITU-T Specification).

Definition at line 617 of file nvmedia_common_encode.h.

◆ aspectRatioIdc [2/2]

uint8_t NvMediaEncodeConfigH265VUIParams::aspectRatioIdc

Holds the aspect ratio IDC (as defined in Annex E of the ITU-T specification).

Definition at line 1131 of file nvmedia_common_encode.h.

◆ aspectRatioInfoPresentFlag [1/2]

bool NvMediaEncodeConfigH264VUIParams::aspectRatioInfoPresentFlag

If set to true, it specifies that the aspectRatioIdc is present.

Definition at line 614 of file nvmedia_common_encode.h.

◆ aspectRatioInfoPresentFlag [2/2]

bool NvMediaEncodeConfigH265VUIParams::aspectRatioInfoPresentFlag

If set to true, specifies the aspectRatioIdc is present.

Definition at line 1128 of file nvmedia_common_encode.h.

◆ aspectSARHeight [1/2]

uint16_t NvMediaEncodeConfigH264VUIParams::aspectSARHeight

If aspectRatioIdc is Extended SAR then it indicates vertical size of the sample aspect ratio (in the same arbitrary units as aspectSARWidth)

Definition at line 624 of file nvmedia_common_encode.h.

◆ aspectSARHeight [2/2]

uint16_t NvMediaEncodeConfigH265VUIParams::aspectSARHeight

If aspectRatioIdc is Extended SAR it indicates vertical size of the sample aspect ratio (in the same arbitrary units as aspectSARWidth).

Definition at line 1138 of file nvmedia_common_encode.h.

◆ aspectSARWidth [1/2]

uint16_t NvMediaEncodeConfigH264VUIParams::aspectSARWidth

If aspectRatioIdc is Extended SAR then it indicates horizontal size of the sample aspect ratio (in arbitrary units).

Definition at line 620 of file nvmedia_common_encode.h.

◆ aspectSARWidth [2/2]

uint16_t NvMediaEncodeConfigH265VUIParams::aspectSARWidth

If aspectRatioIdc is Extended SAR it indicates horizontal size of the sample aspect ratio (in arbitrary units).

Definition at line 1134 of file nvmedia_common_encode.h.

◆ averageBitRate [1/5]

uint32_t NvMediaEncodeRCParams::averageBitRate

Holds the average bitrate (in bits/sec) used for encoding.

Definition at line 115 of file nvmedia_common_encode.h.

◆ averageBitRate [2/5]

uint32_t { ... } ::averageBitRate

Holds the average bitrate (in bits/sec) used for encoding.

Definition at line 115 of file nvmedia_common_encode.h.

◆ averageBitRate [3/5]

uint32_t { ... } ::averageBitRate

Holds the average bitrate (in bits/sec) used for encoding.

Definition at line 133 of file nvmedia_common_encode.h.

◆ averageBitRate [4/5]

uint32_t { ... } ::averageBitRate

Holds the average bitrate (in bits/sec) used for encoding.

Definition at line 148 of file nvmedia_common_encode.h.

◆ averageBitRate [5/5]

uint32_t { ... } ::averageBitRate

Holds the average bitrate (in bits/sec) used for encoding.

Definition at line 165 of file nvmedia_common_encode.h.

◆ base_qindex [1/2]

uint32_t NvMediaEncodeConfigVP9::base_qindex

Set the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_QUANTIZATION_PARAMS to set the following parameters.

Specifies quant base index (used only when rc_mode = 0) for each segment 0...255. This is for setting the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_QUANTIZATION_PARAMS.

Definition at line 1654 of file nvmedia_common_encode.h.

◆ base_qindex [2/2]

uint32_t NvMediaEncodeConfigAV1::base_qindex

Specifies quant base index (used only when rc_mode = 0) for each segment 0...255.

This is for setting the feature flag NVMEDIA_ENCODE_CONFIG_AV1_ENABLE_QUANTIZATION_PARAMS.

Definition at line 1857 of file nvmedia_common_encode.h.

◆ bConstFrameQP

bool NvMediaEncodeRCParams::bConstFrameQP

Use constant QP at frame level or MB row level.


Value range: One of the following:

  • true for constant QP at frame level.
  • false for constant QP at MB row level.
    Note
    This field is taken into consideration when the rate control mode is anything other than constQP.

Definition at line 185 of file nvmedia_common_encode.h.

◆ bdirectMode

NvMediaEncodeH264BDirectMode NvMediaEncodeConfigH264::bdirectMode

Holds the BDirect mode.

Definition at line 825 of file nvmedia_common_encode.h.

◆ bitstreamRestrictionFlag [1/2]

bool NvMediaEncodeConfigH264VUIParams::bitstreamRestrictionFlag

Holds the bitstream restriction info (as defined in Annex E of the ITU-T Specification).

Definition at line 657 of file nvmedia_common_encode.h.

◆ bitstreamRestrictionFlag [2/2]

bool NvMediaEncodeConfigH265VUIParams::bitstreamRestrictionFlag

Specified the bitstream restriction info (as defined in Annex E of the ITU-T Specification).

Definition at line 1173 of file nvmedia_common_encode.h.

◆ bmode_ref_lf_delta_enabled

bool NvMediaEncodeConfigVP9::bmode_ref_lf_delta_enabled

Set it to true if MB-level loop filter adjustment is on.

Definition at line 1643 of file nvmedia_common_encode.h.

◆ bmode_ref_lf_delta_update

bool NvMediaEncodeConfigVP9::bmode_ref_lf_delta_update

Set it to true if MB-level loop filter adjustment delta values are updated.

Definition at line 1646 of file nvmedia_common_encode.h.

◆ cbr [1/2]

struct { ... } NvMediaEncodeRCParams::cbr

Parameters for NVMEDIA_ENCODE_PARAMS_RC_CBR mode.

◆ cbr [2/2]

struct { ... } ::cbr

Parameters for NVMEDIA_ENCODE_PARAMS_RC_CBR mode.

◆ cbr_minqp [1/2]

struct { ... } NvMediaEncodeRCParams::cbr_minqp

Parameters for NVMEDIA_ENCODE_PARAMS_RC_CBR_MINQP mode.

◆ cbr_minqp [2/2]

struct { ... } ::cbr_minqp

Parameters for NVMEDIA_ENCODE_PARAMS_RC_CBR_MINQP mode.

◆ colourDescriptionPresentFlag [1/2]

bool NvMediaEncodeConfigH264VUIParams::colourDescriptionPresentFlag

If set to true, it specifies that the colourPrimaries, transferCharacteristics and colourMatrix are present.

Definition at line 641 of file nvmedia_common_encode.h.

◆ colourDescriptionPresentFlag [2/2]

bool NvMediaEncodeConfigH265VUIParams::colourDescriptionPresentFlag

If set to true, it specifies that the colourPrimaries, transferCharacteristics, and colourMatrix are present.

Definition at line 1157 of file nvmedia_common_encode.h.

◆ colourMatrix

uint8_t NvMediaEncodeConfigH264VUIParams::colourMatrix

Holds the matrix coefficients used in deriving the luma and chroma from the RGB primaries (as defined in Annex E of the ITU-T Specification).

Definition at line 650 of file nvmedia_common_encode.h.

◆ colourPrimaries [1/2]

uint8_t NvMediaEncodeConfigH264VUIParams::colourPrimaries

Holds color primaries for converting to RGB (as defined in Annex E of the ITU-T Specification).

Definition at line 644 of file nvmedia_common_encode.h.

◆ colourPrimaries [2/2]

uint8_t NvMediaEncodeConfigH265VUIParams::colourPrimaries

Holds color primaries for converting to RGB (as defined in Annex E of the ITU-T Specification).

Definition at line 1160 of file nvmedia_common_encode.h.

◆ const_qp [1/2]

struct { ... } ::const_qp

Parameters for NVMEDIA_ENCODE_PARAMS_RC_CONSTQP mode.

◆ const_qp [2/2]

struct { ... } NvMediaEncodeRCParams::const_qp

Parameters for NVMEDIA_ENCODE_PARAMS_RC_CONSTQP mode.

◆ constQP [1/2]

NvMediaEncodeQP { ... } ::constQP

Holds the initial QP to be used for encoding, these values would be used for all frames in Constant QP mode.

Definition at line 129 of file nvmedia_common_encode.h.

◆ constQP [2/2]

NvMediaEncodeQP NvMediaEncodeRCParams::constQP

Holds the initial QP to be used for encoding, these values would be used for all frames in Constant QP mode.

Definition at line 129 of file nvmedia_common_encode.h.

◆ data

uint8_t NvMediaNalData::data[MAX_NON_SLICE_DATA_SIZE]

header data passed on this buffer

Definition at line 605 of file nvmedia_common_encode.h.

◆ delta_uv_ac [1/2]

int32_t NvMediaEncodeConfigVP9::delta_uv_ac

Specifies qindex adjustment for uv dccoefficient, -15...15.

This is for setting the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_QUANTIZATION_PARAMS.

Definition at line 1666 of file nvmedia_common_encode.h.

◆ delta_uv_ac [2/2]

int32_t NvMediaEncodeConfigAV1::delta_uv_ac

Specifies qindex adjustment for uv dccoefficient, -15...15.

This is for setting the feature flag NVMEDIA_ENCODE_CONFIG_AV1_ENABLE_QUANTIZATION_PARAMS.

Definition at line 1869 of file nvmedia_common_encode.h.

◆ delta_uv_dc [1/2]

int32_t NvMediaEncodeConfigVP9::delta_uv_dc

Specifies qindex adjustment for uv accoefficient, -15...15.

This is for setting the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_QUANTIZATION_PARAMS.

Definition at line 1662 of file nvmedia_common_encode.h.

◆ delta_uv_dc [2/2]

int32_t NvMediaEncodeConfigAV1::delta_uv_dc

Specifies qindex adjustment for uv accoefficient, -15...15.

This is for setting the feature flag NVMEDIA_ENCODE_CONFIG_AV1_ENABLE_QUANTIZATION_PARAMS.

Definition at line 1865 of file nvmedia_common_encode.h.

◆ delta_y_dc_q [1/2]

int32_t NvMediaEncodeConfigVP9::delta_y_dc_q

Specifies explicit qindex adjustment for y dccoefficient, -15...15.

This is for setting the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_QUANTIZATION_PARAMS.

Definition at line 1658 of file nvmedia_common_encode.h.

◆ delta_y_dc_q [2/2]

int32_t NvMediaEncodeConfigAV1::delta_y_dc_q

Specifies explicit qindex adjustment for y dccoefficient, -15...15.

This is for setting the feature flag NVMEDIA_ENCODE_CONFIG_AV1_ENABLE_QUANTIZATION_PARAMS.

Definition at line 1861 of file nvmedia_common_encode.h.

◆ dir

uint32_t NvMediaEncodeExternalMEHint::dir

Holds the direction of motion estimation .

0=L0 1=L1.

Definition at line 688 of file nvmedia_common_encode.h.

◆ disableCdfUpdate

NvMediaBool NvMediaEncodeConfigAV1::disableCdfUpdate

Set to true to disable CDF update.

Definition at line 1884 of file nvmedia_common_encode.h.

◆ disableDeblockingFilter

uint8_t NvMediaEncodeConfigH265::disableDeblockingFilter

Holds disable the deblocking filter.

Note
This feature is not supported.

Definition at line 1292 of file nvmedia_common_encode.h.

◆ disableDeblockingFilterIDC

uint8_t NvMediaEncodeConfigH264::disableDeblockingFilterIDC

Holds the deblocking filter mode.


Value range: 0 to 2 in increments of 1.

Definition at line 821 of file nvmedia_common_encode.h.

◆ enableAllIFrames [1/2]

uint32_t NvMediaEncodeInitializeParamsH264::enableAllIFrames

Encode all frames as I frames.


Value range: 0 to disable, non-zero value to enable

Definition at line 1042 of file nvmedia_common_encode.h.

◆ enableAllIFrames [2/2]

uint32_t NvMediaEncodeInitializeParamsH265::enableAllIFrames

Encode all frames as I frames.


Value range: 0 to disable, non-zero value to enable

Definition at line 1481 of file nvmedia_common_encode.h.

◆ enableBiCompound

bool NvMediaEncodeInitializeParamsAV1::enableBiCompound

Definition at line 1944 of file nvmedia_common_encode.h.

◆ enableExternalMEHints [1/4]

bool NvMediaEncodeInitializeParamsH264::enableExternalMEHints

Set to true to enable external ME hints.

Currently this feature is not supported if B frames are used. This setting is not supported in the QNX Safety build.

Deprecated:
This feature will be deprecated in a future release.

Definition at line 974 of file nvmedia_common_encode.h.

◆ enableExternalMEHints [2/4]

bool NvMediaEncodeInitializeParamsH265::enableExternalMEHints

Set to true to enable external ME hints.

Currently this feature is not supported if B frames are used.

Deprecated:
This feature will be deprecated in a future release.

Definition at line 1419 of file nvmedia_common_encode.h.

◆ enableExternalMEHints [3/4]

bool NvMediaEncodeInitializeParamsVP9::enableExternalMEHints

Holds a flag indicating whether to enable or disable the external ME hints.

Set to true to enable external ME hints. Currently this feature is not supported if B frames are used.

Deprecated:
This feature will be deprecated in a future release.

Definition at line 1733 of file nvmedia_common_encode.h.

◆ enableExternalMEHints [4/4]

bool NvMediaEncodeInitializeParamsAV1::enableExternalMEHints

Holds a flag indicating whether to enable or disable the external ME hints.

Set to true to enable external ME hints. Currently this feature is not supported if B frames are used.

Definition at line 1953 of file nvmedia_common_encode.h.

◆ enableExternalPictureRC [1/2]

uint32_t NvMediaEncodeInitializeParamsH264::enableExternalPictureRC

Enable external picture rate control.

Note
This feature is not supported.

Definition at line 1039 of file nvmedia_common_encode.h.

◆ enableExternalPictureRC [2/2]

uint32_t NvMediaEncodeInitializeParamsH265::enableExternalPictureRC

Enable external picture rate control.

Note
This feature is not supported.

Definition at line 1478 of file nvmedia_common_encode.h.

◆ enableInternalHighBitDepth

bool NvMediaEncodeInitializeParamsAV1::enableInternalHighBitDepth

Definition at line 1949 of file nvmedia_common_encode.h.

◆ enableLimitedRGB [1/4]

bool NvMediaEncodeInitializeParamsH264::enableLimitedRGB

Set this to true for limited-RGB (16-235) input.

Note
This feature is not supported.

Definition at line 924 of file nvmedia_common_encode.h.

◆ enableLimitedRGB [2/4]

bool NvMediaEncodeInitializeParamsH265::enableLimitedRGB

Set this to true for limited-RGB (16-235) input.

Note
This feature is not supported.

Definition at line 1364 of file nvmedia_common_encode.h.

◆ enableLimitedRGB [3/4]

bool NvMediaEncodeInitializeParamsVP9::enableLimitedRGB

Holds a flag indicating whether input is limited-RGB (16-235).

Set this to true for limited-RGB (16-235) input.

Note
This feature is not supported.

Definition at line 1716 of file nvmedia_common_encode.h.

◆ enableLimitedRGB [4/4]

bool NvMediaEncodeInitializeParamsAV1::enableLimitedRGB

Holds a flag indicating whether input is limited-RGB (16-235).

Set this to true for limited-RGB (16-235) input.

Definition at line 1905 of file nvmedia_common_encode.h.

◆ enableMVC [1/2]

bool NvMediaEncodeInitializeParamsH264::enableMVC

If client want to do MVC encoding then this flag need to be set.

Note
This feature is not supported.

Definition at line 999 of file nvmedia_common_encode.h.

◆ enableMVC [2/2]

bool NvMediaEncodeInitializeParamsH265::enableMVC

If client want to do MVC encoding then this flag need to be set.

Note
This feature is not supported.

Definition at line 1444 of file nvmedia_common_encode.h.

◆ enableNewPreset [1/3]

bool NvMediaEncodeConfigH264::enableNewPreset

Set to true to use encPreset instead of quality.

Definition at line 887 of file nvmedia_common_encode.h.

◆ enableNewPreset [2/3]

bool NvMediaEncodeConfigH265::enableNewPreset

Set to true to use encPreset instead of quality.

Definition at line 1341 of file nvmedia_common_encode.h.

◆ enableNewPreset [3/3]

bool NvMediaEncodeConfigAV1::enableNewPreset

Set to true to use encPreset instead of quality.

Definition at line 1889 of file nvmedia_common_encode.h.

◆ enableReconCRC [1/2]

bool NvMediaEncodeInitializeParamsH264::enableReconCRC

Enable support for recon CRC generation.

NVMEDIA will allocate extra surface for recon CRC calculation. This can be enabled at run time for any frame by enabling recon CRC and passing recon CRC rectangle.

Note
This feature is not supported.

Definition at line 996 of file nvmedia_common_encode.h.

◆ enableReconCRC [2/2]

bool NvMediaEncodeInitializeParamsH265::enableReconCRC

Enable support for recon CRC generation.

NVMEDIA will allocate extra surface for recon CRC calculation. This can be enabled at run time for any frame by enabling recon CRC and passing recon CRC rectangle.

Note
This feature is not supported.

Definition at line 1441 of file nvmedia_common_encode.h.

◆ enableROIEncode [1/2]

bool NvMediaEncodeInitializeParamsH264::enableROIEncode

Enable region of interest encoding.

Region of interest encoding parameters are passed with Input extra data parameters.

Note
This feature is not supported.

Definition at line 1008 of file nvmedia_common_encode.h.

◆ enableROIEncode [2/2]

bool NvMediaEncodeInitializeParamsH265::enableROIEncode

Enable region of interest encoding.

Region of interest encoding parameters are passed with Input extra data parameters

Note
Setting input extra data is an internal feature. As a result, enableROIEncode is only supported internally.

Definition at line 1449 of file nvmedia_common_encode.h.

◆ enableSliceEncode [1/2]

bool NvMediaEncodeInitializeParamsH264::enableSliceEncode

Use slice encode to reduce latency in getting encoded buffers.

This setting is not supported in the QNX Safety build.

Definition at line 1011 of file nvmedia_common_encode.h.

◆ enableSliceEncode [2/2]

bool NvMediaEncodeInitializeParamsH265::enableSliceEncode

use slice encode to reduce latency in getting encoded buffers.

Definition at line 1451 of file nvmedia_common_encode.h.

◆ enableSliceLevelEncode

bool NvMediaEncodeInitializeParamsH265::enableSliceLevelEncode

Set this to true for slice level encode.

Definition at line 1366 of file nvmedia_common_encode.h.

◆ enableSourceHalfScaled [1/2]

bool NvMediaEncodeInitializeParamsH264::enableSourceHalfScaled

Enable 2 pass RC with quarter resolution first pass.

Note
This feature is not supported.

Definition at line 1033 of file nvmedia_common_encode.h.

◆ enableSourceHalfScaled [2/2]

bool NvMediaEncodeInitializeParamsH265::enableSourceHalfScaled

Enable 2 pass RC with quarter resolution first pass.

Note
This feature is not supported.

Definition at line 1472 of file nvmedia_common_encode.h.

◆ enableSsimRdo

bool NvMediaEncodeInitializeParamsAV1::enableSsimRdo

Set to true to enable SSIM RDO.

Definition at line 1933 of file nvmedia_common_encode.h.

◆ enableTileEncode

bool NvMediaEncodeInitializeParamsAV1::enableTileEncode

Set to true to enable Multiple tile mode.

Definition at line 1935 of file nvmedia_common_encode.h.

◆ enableTwoPassRC [1/2]

bool NvMediaEncodeInitializeParamsH264::enableTwoPassRC

Enable 2 pass RC support.

First pass RC can be run on full or quarter resolution.

Note
enableTwoPassRC is an internal feature.

Definition at line 1025 of file nvmedia_common_encode.h.

◆ enableTwoPassRC [2/2]

bool NvMediaEncodeInitializeParamsH265::enableTwoPassRC

Enable 2 pass RC support.

First pass RC can be run on full or quarter resolution.

Note
enableTwoPassRC is an internal feature.

Definition at line 1464 of file nvmedia_common_encode.h.

◆ enableUniCompound

bool NvMediaEncodeInitializeParamsAV1::enableUniCompound

Definition at line 1947 of file nvmedia_common_encode.h.

◆ enableWeightedPrediction [1/2]

uint8_t NvMediaEncodeConfigH264::enableWeightedPrediction

Enable/disable weighted prediction.


Value range: 0 to disable, non-zero value to enable

Definition at line 882 of file nvmedia_common_encode.h.

◆ enableWeightedPrediction [2/2]

uint8_t NvMediaEncodeConfigH265::enableWeightedPrediction

Holds enable weighted prediction.

Note
This feature is not supported.

Definition at line 1295 of file nvmedia_common_encode.h.

◆ encodeHeight [1/4]

uint16_t NvMediaEncodeInitializeParamsH264::encodeHeight

Holds the encode height.


Value range: 64 to 4096 in increments of 2.

Definition at line 920 of file nvmedia_common_encode.h.

◆ encodeHeight [2/4]

uint16_t NvMediaEncodeInitializeParamsH265::encodeHeight

Holds the encode height.


Value range: 64 to 4096 in increments of 2.

Definition at line 1360 of file nvmedia_common_encode.h.

◆ encodeHeight [3/4]

uint32_t NvMediaEncodeInitializeParamsVP9::encodeHeight

Holds the encode height.

Definition at line 1712 of file nvmedia_common_encode.h.

◆ encodeHeight [4/4]

uint32_t NvMediaEncodeInitializeParamsAV1::encodeHeight

Holds the encode height.

Definition at line 1902 of file nvmedia_common_encode.h.

◆ encodePicFlags [1/4]

uint32_t NvMediaEncodePicParamsH264::encodePicFlags

Holds bit-wise OR`ed encode pic flags.

See enum NvMediaEncodePicFlags.

Definition at line 1055 of file nvmedia_common_encode.h.

◆ encodePicFlags [2/4]

uint32_t NvMediaEncodePicParamsH265::encodePicFlags

Holds bit-wise OR`ed encode pic flags.

See enum NvMediaEncodePicFlags.

Definition at line 1514 of file nvmedia_common_encode.h.

◆ encodePicFlags [3/4]

uint32_t NvMediaEncodePicParamsVP9::encodePicFlags

Holds bit-wise OR`ed encode pic flags.

See enum NvMediaEncodePicFlags.

Definition at line 1767 of file nvmedia_common_encode.h.

◆ encodePicFlags [4/4]

uint32_t NvMediaEncodePicParamsAV1::encodePicFlags

Holds bit-wise OR`ed encode pic flags.

See enum NvMediaEncodePicFlags.

Definition at line 1977 of file nvmedia_common_encode.h.

◆ encodeWidth [1/4]

uint16_t NvMediaEncodeInitializeParamsH264::encodeWidth

Holds the encode width.


Value range: 160 to 4096 in increments of 2.

Definition at line 913 of file nvmedia_common_encode.h.

◆ encodeWidth [2/4]

uint16_t NvMediaEncodeInitializeParamsH265::encodeWidth

Holds the encode width.


Value range: 160 to 4096 in increments of 2.

Definition at line 1353 of file nvmedia_common_encode.h.

◆ encodeWidth [3/4]

uint32_t NvMediaEncodeInitializeParamsVP9::encodeWidth

Holds the encode width.

Definition at line 1710 of file nvmedia_common_encode.h.

◆ encodeWidth [4/4]

uint32_t NvMediaEncodeInitializeParamsAV1::encodeWidth

Holds the encode width.

Definition at line 1900 of file nvmedia_common_encode.h.

◆ encPreset [1/3]

NvMediaEncPreset NvMediaEncodeConfigH264::encPreset

Holds the encode quality pre-set.

See enum NvMediaEncPreset. Recommended pre-setting is NVMEDIA_ENC_PRESET_HP

Definition at line 885 of file nvmedia_common_encode.h.

◆ encPreset [2/3]

NvMediaEncPreset NvMediaEncodeConfigH265::encPreset

Holds the encode quality pre-set.

See enum NvMediaEncPreset. Recommended pre-setting is NVMEDIA_ENC_PRESET_HP.

Definition at line 1339 of file nvmedia_common_encode.h.

◆ encPreset [3/3]

NvMediaEncPreset NvMediaEncodeConfigAV1::encPreset

Holds the encode quality pre-set.

See enum NvMediaEncPreset. Recommended pre-setting is NVMEDIA_ENC_PRESET_HP.

Definition at line 1887 of file nvmedia_common_encode.h.

◆ entropyCodingMode

NvMediaEncodeH264EntropyCodingMode NvMediaEncodeConfigH264::entropyCodingMode

Holds the entropy coding mode.

Definition at line 827 of file nvmedia_common_encode.h.

◆ error_resilient

bool NvMediaEncodeConfigVP9::error_resilient

Set the feature flag NVMEDIA_ENCODE_CONFIG_VP9_DISABLE_ERROR_RESILIENT to set the following parameter.

Enable Error resiliency. This is for setting the feature flag NVMEDIA_ENCODE_CONFIG_VP9_DISABLE_ERROR_RESILIENT.

Definition at line 1692 of file nvmedia_common_encode.h.

◆ features [1/4]

uint32_t NvMediaEncodeConfigH264::features

Holds bit-wise OR`ed configuration feature flags.

See enum NvMediaEncodeH264Features.

Definition at line 799 of file nvmedia_common_encode.h.

◆ features [2/4]

uint32_t NvMediaEncodeConfigH265::features

Holds bit-wise OR`ed configuration feature flags.

See the NvMediaEncodeH265Features enum.

Definition at line 1270 of file nvmedia_common_encode.h.

◆ features [3/4]

uint32_t NvMediaEncodeConfigVP9::features

Holds bit-wise OR`ed configuration feature flags.

See the NvMediaEncodeVP9Features enum.

Definition at line 1609 of file nvmedia_common_encode.h.

◆ features [4/4]

uint32_t NvMediaEncodeConfigAV1::features

Holds bit-wise OR`ed configuration feature flags.

TBD

Definition at line 1838 of file nvmedia_common_encode.h.

◆ filter_level

uint32_t NvMediaEncodeConfigVP9::filter_level

Specifies the loop filter strength for each segment.

Definition at line 1633 of file nvmedia_common_encode.h.

◆ filter_type

uint32_t NvMediaEncodeConfigVP9::filter_type

Set the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_LOOP_FILTER_PARAMS to change the following parameters.

Specifies the type of the filter used.
Value range: One of the following filter types:

  • 0: Eight-tap smooth
  • 1: Eight-tap
  • 2: Eight-tap sharp
  • 3: Bilinear
  • 4: Switchable

Definition at line 1631 of file nvmedia_common_encode.h.

◆ frameRateDen [1/7]

uint32_t NvMediaEncodeInitializeParamsH264::frameRateDen

Holds the denominator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).


Value range: Frame rate can lie between 1 and 60 (float value).

Definition at line 932 of file nvmedia_common_encode.h.

◆ frameRateDen [2/7]

uint32_t NvMediaEncodePicParamsH264::frameRateDen

Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).


Value range: Frame rate can lie between 1 and 60 (float value).

Definition at line 1111 of file nvmedia_common_encode.h.

◆ frameRateDen [3/7]

uint32_t NvMediaEncodeInitializeParamsH265::frameRateDen

Holds the denominator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).


Value range: Frame rate can lie between 1 and 60 (float value).

Definition at line 1374 of file nvmedia_common_encode.h.

◆ frameRateDen [4/7]

uint32_t NvMediaEncodePicParamsH265::frameRateDen

Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).


Value range: Frame rate can lie between 1 and 60 (float value).

Definition at line 1566 of file nvmedia_common_encode.h.

◆ frameRateDen [5/7]

uint32_t NvMediaEncodeInitializeParamsVP9::frameRateDen

Holds the denominator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).

Definition at line 1722 of file nvmedia_common_encode.h.

◆ frameRateDen [6/7]

uint32_t NvMediaEncodeInitializeParamsAV1::frameRateDen

Holds the denominator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).

Definition at line 1911 of file nvmedia_common_encode.h.

◆ frameRateDen [7/7]

uint32_t NvMediaEncodePicParamsAV1::frameRateDen

Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).


Value range: Frame rate can lie between 1 and 60 (float value).

Definition at line 2020 of file nvmedia_common_encode.h.

◆ frameRateNum [1/7]

uint32_t NvMediaEncodeInitializeParamsH264::frameRateNum

Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).


Value range: Frame rate can lie between 1 and 60 (float value).

Definition at line 928 of file nvmedia_common_encode.h.

◆ frameRateNum [2/7]

uint32_t NvMediaEncodePicParamsH264::frameRateNum

Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).


Value range: Frame rate can lie between 1 and 60 (float value).

Definition at line 1107 of file nvmedia_common_encode.h.

◆ frameRateNum [3/7]

uint32_t NvMediaEncodeInitializeParamsH265::frameRateNum

Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).


Value range: Frame rate can lie between 1 and 60 (float value).

Definition at line 1370 of file nvmedia_common_encode.h.

◆ frameRateNum [4/7]

uint32_t NvMediaEncodePicParamsH265::frameRateNum

Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).


Value range: Frame rate can lie between 1 and 60 (float value).

Definition at line 1562 of file nvmedia_common_encode.h.

◆ frameRateNum [5/7]

uint32_t NvMediaEncodeInitializeParamsVP9::frameRateNum

Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).

Definition at line 1719 of file nvmedia_common_encode.h.

◆ frameRateNum [6/7]

uint32_t NvMediaEncodeInitializeParamsAV1::frameRateNum

Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).

Definition at line 1908 of file nvmedia_common_encode.h.

◆ frameRateNum [7/7]

uint32_t NvMediaEncodePicParamsAV1::frameRateNum

Holds the numerator for frame rate used for encoding in frames per second ( Frame rate = frameRateNum / frameRateDen ).


Value range: Frame rate can lie between 1 and 60 (float value).

Definition at line 2016 of file nvmedia_common_encode.h.

◆ frameRestorationType

uint8_t NvMediaEncodeInitializeParamsAV1::frameRestorationType

Definition at line 1941 of file nvmedia_common_encode.h.

◆ gopLength [1/4]

uint32_t NvMediaEncodeConfigH264::gopLength

Holds the number of pictures in one GOP.

A low-latency application client can set goplength to NVMEDIA_ENCODE_INFINITE_GOPLENGTH so that keyframes are not inserted automatically.

Definition at line 803 of file nvmedia_common_encode.h.

◆ gopLength [2/4]

uint32_t NvMediaEncodeConfigH265::gopLength

Holds the number of pictures in one GOP.

Low latency application client can set the goplength field to NVMEDIA_ENCODE_INFINITE_GOPLENGTH so that keyframes are not inserted automatically.

Definition at line 1275 of file nvmedia_common_encode.h.

◆ gopLength [3/4]

uint32_t NvMediaEncodeConfigVP9::gopLength

Holds the number of pictures in one GOP.

Low-latency application client can set goplength to NVMEDIA_ENCODE_INFINITE_GOPLENGTH so that keyframes are not inserted automatically.

Definition at line 1613 of file nvmedia_common_encode.h.

◆ gopLength [4/4]

uint32_t NvMediaEncodeConfigAV1::gopLength

Holds the number of pictures in one GOP.

Low-latency application client can set goplength to NVMEDIA_ENCODE_INFINITE_GOPLENGTH so that keyframes are not inserted automatically.

Definition at line 1842 of file nvmedia_common_encode.h.

◆ h264VUIParameters

NvMediaEncodeConfigH264VUIParams* NvMediaEncodeConfigH264::h264VUIParameters

Holds the H.264 video usability information pamameters.

Set to NULL if VUI is not needed.

Definition at line 860 of file nvmedia_common_encode.h.

◆ h265VUIParameters

NvMediaEncodeConfigH265VUIParams* NvMediaEncodeConfigH265::h265VUIParameters

Holds the H265 video usability info pamameters.

Set to NULL if VUI is not needed

Definition at line 1324 of file nvmedia_common_encode.h.

◆ high_prec_mv

uint32_t NvMediaEncodeConfigVP9::high_prec_mv

Set the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_HIGH_PRECISION_MV to set the following parameter.

Specifies to enable high precision MV. This is for setting the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_HIGH_PRECISION_MV.

Definition at line 1684 of file nvmedia_common_encode.h.

◆ idrPeriod [1/4]

uint32_t NvMediaEncodeConfigH264::idrPeriod

Holds the IDR interval.

If not set, the interval is made equal to gopLength. A low-latency application client can set the IDR interval to NVMEDIA_ENCODE_INFINITE_GOPLENGTH so that IDR frames are not inserted automatically.

Definition at line 813 of file nvmedia_common_encode.h.

◆ idrPeriod [2/4]

uint32_t NvMediaEncodeConfigH265::idrPeriod

Holds the IDR interval.

If not set, this is made equal to NvMediaEncodeConfigH265::gopLength. Low latency application client can set IDR interval to NVMEDIA_ENCODE_INFINITE_GOPLENGTH so that IDR frames are not inserted automatically.

Definition at line 1284 of file nvmedia_common_encode.h.

◆ idrPeriod [3/4]

uint32_t NvMediaEncodeConfigVP9::idrPeriod

Holds the IDR interval.

If not set, this is made equal to gopLength in NvMediaEncodeConfigVP9. Low-latency application client can set IDR interval to NVMEDIA_ENCODE_INFINITE_GOPLENGTH so that IDR frames are not inserted automatically.

Definition at line 1620 of file nvmedia_common_encode.h.

◆ idrPeriod [4/4]

uint32_t NvMediaEncodeConfigAV1::idrPeriod

Holds the IDR interval.

If not set, this is made equal to gopLength in NvMediaEncodeConfigVP9. Low-latency application client can set IDR interval to NVMEDIA_ENCODE_INFINITE_GOPLENGTH so that IDR frames are not inserted automatically.

Definition at line 1849 of file nvmedia_common_encode.h.

◆ initQP [1/4]

NvMediaEncodeQP NvMediaEncodeConfigH264::initQP

Holds the initial QP parameters.

The client must set NVMEDIA_ENCODE_CONFIG_H264_INIT_QP in features to use this.
Value range: QP values can lie between 1 to 51 in increments of 1.

Definition at line 874 of file nvmedia_common_encode.h.

◆ initQP [2/4]

NvMediaEncodeQP NvMediaEncodeConfigH265::initQP

Holds Initial QP parameters.

Client must set NVMEDIA_ENCODE_CONFIG_H265_INIT_QP in features to use this.
Value range: QP values can lie between 1 to 51 in increments of 1.

Definition at line 1331 of file nvmedia_common_encode.h.

◆ initQP [3/4]

NvMediaEncodeQP NvMediaEncodeConfigVP9::initQP

Holds Initial QP parameters.

Client must set NVMEDIA_ENCODE_CONFIG_VP9_INIT_QP in features to use this. QP values should be within the range of 1 to 255

Definition at line 1697 of file nvmedia_common_encode.h.

◆ initQP [4/4]

NvMediaEncodeQP NvMediaEncodeConfigAV1::initQP

Holds Initial QP parameters.

Client must set NVMEDIA_ENCODE_CONFIG_VP9_INIT_QP in features to use this. QP values should be within the range of 1 to 255

Definition at line 1874 of file nvmedia_common_encode.h.

◆ intraRefreshCnt [1/2]

uint32_t NvMediaEncodeConfigH264::intraRefreshCnt

Holds the number of frames over which intra refresh happens.

This value must be less than or equal to intraRefreshPeriod. Set to zero to disable intra refresh functionality. If it is set to one, then after every intraRefreshPeriod frames the encoded P frame contains only intra predicted macroblocks. This value is used only if NVMEDIA_ENCODE_CONFIG_H264_ENABLE_INTRA_REFRESH is set in features.

Definition at line 848 of file nvmedia_common_encode.h.

◆ intraRefreshCnt [2/2]

uint32_t NvMediaEncodeConfigH265::intraRefreshCnt

Holds the number of frames over which intra refresh will happen.

This value must be less than or equal to intraRefreshPeriod. Setting it to zero turns off the intra refresh functionality. Setting it to one essentially means that after every intraRefreshPeriod frames the encoded P frame contains only intra predicted macroblocks. This value is used only if the NVMEDIA_ENCODE_CONFIG_H265_ENABLE_INTRA_REFRESH is set in features.

Definition at line 1313 of file nvmedia_common_encode.h.

◆ intraRefreshPeriod [1/2]

uint32_t NvMediaEncodeConfigH264::intraRefreshPeriod

Holds the interval between frames that triggers a new intra refresh cycle.

This cycle lasts for intraRefreshCnt frames. This value is used only if NVMEDIA_ENCODE_CONFIG_H264_ENABLE_INTRA_REFRESH is set in features. NVMEDIA_ENCODE_PIC_TYPE_P_INTRA_REFRESH picture type also triggers a new intra refresh cycle and resets the current intra refresh period. Set to zero to suppress triggering of automatic refresh cycles. In this case only NVMEDIA_ENCODE_PIC_TYPE_P_INTRA_REFRESH picture type can trigger a new refresh cycle.

Definition at line 839 of file nvmedia_common_encode.h.

◆ intraRefreshPeriod [2/2]

uint32_t NvMediaEncodeConfigH265::intraRefreshPeriod

Holds the interval between frames that trigger a new intra refresh cycle and this cycle lasts for intraRefreshCnt frames.

This value is used only if the NVMEDIA_ENCODE_CONFIG_H265_ENABLE_INTRA_REFRESH is set in features. The NVMEDIA_ENCODE_PIC_TYPE_P_INTRA_REFRESH picture type also triggers a new intra-refresh cycle and resets the current intra-refresh period. Setting it to zero results in that no automatic refresh cycles are triggered. In this case only NVMEDIA_ENCODE_PIC_TYPE_P_INTRA_REFRESH picture type can trigger a new refresh cycle.

Definition at line 1305 of file nvmedia_common_encode.h.

◆ lastOfMB

uint32_t NvMediaEncodeExternalMEHint::lastOfMB

Set to true for the last MV of macroblock.

Definition at line 695 of file nvmedia_common_encode.h.

◆ lastofPart

uint32_t NvMediaEncodeExternalMEHint::lastofPart

Set to true for the last MV of (sub) partition

Definition at line 693 of file nvmedia_common_encode.h.

◆ level [1/3]

uint8_t NvMediaEncodeInitializeParamsH264::level

Holds the encoding level.

Client is recommended to set this to NVMEDIA_ENCODE_LEVEL_AUTOSELECT in order to enable the Encode interface to select the correct level. If a specific level needs to be configured, this field can be set to one of the enumerations from NvMediaEncodeLevel. If the specified level is lower than that which is required by the H264 standard, the encoder auto-corrects it to the minimum required level.

Definition at line 946 of file nvmedia_common_encode.h.

◆ level [2/3]

uint8_t NvMediaEncodeInitializeParamsH265::level

Holds the encoding level.

Client is recommended to set this to NVMEDIA_ENCODE_LEVEL_H265_AUTOSELECT in order to enable the Encode interface to select the correct level. If a specific level needs to be configured, this field can be set to one of the enumerations from NvMediaEncodeLevelH265. If the specified level is lower than that which is required by the H265 standard, the encoder auto-corrects it to the minimum required level.

Definition at line 1388 of file nvmedia_common_encode.h.

◆ level [3/3]

uint8_t NvMediaEncodeInitializeParamsAV1::level

Holds the encoding level.

Client is recommended to set this to NVMEDIA_ENCODE_LEVEL_AUTOSELECT in order to enable the Encode interface to select the correct level. If a specific level needs to be configured, this field can be set to one of the enumerations from NvMediaEncodeLevel. If the specified level is lower than that which is required by the H264 standard, the encoder auto-corrects it to the minimum required level.

Definition at line 1925 of file nvmedia_common_encode.h.

◆ levelTier

uint8_t NvMediaEncodeInitializeParamsH265::levelTier

Holds the level tier information.

This is set to 0 for main tier and 1 for high tier. This is valid only when level is not selected as NVMEDIA_ENCODE_LEVEL_H265_AUTOSELECT.

Definition at line 1392 of file nvmedia_common_encode.h.

◆ log2NumTilesInCol

uint8_t NvMediaEncodeInitializeParamsAV1::log2NumTilesInCol

Holds the log2 value of number of tiles used in a column.

Definition at line 1939 of file nvmedia_common_encode.h.

◆ log2NumTilesInRow

uint8_t NvMediaEncodeInitializeParamsAV1::log2NumTilesInRow

Holds the log2 value of number of tiles used in a row.

Definition at line 1937 of file nvmedia_common_encode.h.

◆ log2TileCols

uint32_t NvMediaEncodeInitializeParamsVP9::log2TileCols

Holds number of log2Cols used in a frame.

Supported values are from 0 to 4

Definition at line 1753 of file nvmedia_common_encode.h.

◆ log2TileRows

uint32_t NvMediaEncodeInitializeParamsVP9::log2TileRows

Holds number of log2Rows used in a frame.

Supported values are from 0 to 4

Definition at line 1750 of file nvmedia_common_encode.h.

◆ matrixCoeffs

uint8_t NvMediaEncodeConfigH265VUIParams::matrixCoeffs

Holds the matrix coefficients used in deriving the luma and chroma from the RGB primaries (as defined in Annex E of the ITU-T Specification).

Definition at line 1166 of file nvmedia_common_encode.h.

◆ maxBitRate [1/3]

uint32_t NvMediaEncodeRCParams::maxBitRate

Holds the maximum bitrate for the encoded output.

Definition at line 135 of file nvmedia_common_encode.h.

◆ maxBitRate [2/3]

uint32_t { ... } ::maxBitRate

Holds the maximum bitrate for the encoded output.

Definition at line 135 of file nvmedia_common_encode.h.

◆ maxBitRate [3/3]

uint32_t { ... } ::maxBitRate

Holds the maximum bitrate for the encoded output.

Definition at line 150 of file nvmedia_common_encode.h.

◆ maxMEHintCountsPerBlock [1/4]

NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodeInitializeParamsH264::maxMEHintCountsPerBlock[2]

If Client wants to pass external motion vectors in NvMediaEncodePicParamsH264 meExternalHints buffer it must specify the maximum number of hint candidates per block per direction for the encode session.

The NvMediaEncodeInitializeParamsH264 maxMEHintCountsPerBlock[0] is for L0 predictors and NvMediaEncodeInitializeParamsH264 maxMEHintCountsPerBlock[1] is for L1 predictors. This client must also set NvMediaEncodeInitializeParamsH264 enableExternalMEHints to true.

Deprecated:
This feature will be deprecated in a future release.

Definition at line 985 of file nvmedia_common_encode.h.

◆ maxMEHintCountsPerBlock [2/4]

NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodeInitializeParamsH265::maxMEHintCountsPerBlock[2]

If Client wants to pass external motion vectors in NvMediaEncodePicParamsH265 meExternalHints buffer it must specify the maximum number of hint candidates per block per direction for the encode session.

The NvMediaEncodeInitializeParamsH265 maxMEHintCountsPerBlock[0] is for L0 predictors and NvMediaEncodeInitializeParamsH265 maxMEHintCountsPerBlock[1] is for L1 predictors. This client must also set NvMediaEncodeInitializeParamsH265 enableExternalMEHints to true.

Deprecated:
This feature will be deprecated in a future release.

Definition at line 1430 of file nvmedia_common_encode.h.

◆ maxMEHintCountsPerBlock [3/4]

NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodeInitializeParamsVP9::maxMEHintCountsPerBlock[2]

If Client wants to pass external motion vectors in NvMediaEncodePicParamsVP9 meExternalHints buffer it must specify the maximum number of hint candidates, per block and per direction, for the encode session.

The NvMediaEncodeInitializeParamsVP9 maxMEHintCountsPerBlock[0] is for L0 predictors and NvMediaEncodeInitializeParamsVP9 maxMEHintCountsPerBlock[1] is for L1 predictors. This client must also set NvMediaEncodeInitializeParamsVP9 enableExternalMEHints to true.

Deprecated:
This feature will be deprecated in a future release.

Definition at line 1744 of file nvmedia_common_encode.h.

◆ maxMEHintCountsPerBlock [4/4]

NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodeInitializeParamsAV1::maxMEHintCountsPerBlock[2]

If Client wants to pass external motion vectors in NvMediaEncodePicParamsVP9 meExternalHints buffer it must specify the maximum number of hint candidates, per block and per direction, for the encode session.

The NvMediaEncodeInitializeParamsVP9 maxMEHintCountsPerBlock[0] is for L0 predictors and NvMediaEncodeInitializeParamsVP9 maxMEHintCountsPerBlock[1] is for L1 predictors. This client must also set NvMediaEncodeInitializeParamsVP9 enableExternalMEHints to true.

Definition at line 1963 of file nvmedia_common_encode.h.

◆ maxNumRefFrames [1/4]

uint8_t NvMediaEncodeInitializeParamsH264::maxNumRefFrames

Holds the maximum number of reference frames used for encoding.


Value range: 0
For I-frame only mode (no reference frames), i.e., NvMediaEncodeInitializeParamsH264::enableAllIFrames is set to 1 and NvMediaEncodeRCParams::numBFrames is set to 0.
Value range: 1 to 8
For encoding with I and P frame types (p-frames as reference), i.e., NvMediaEncodeInitializeParamsH264::enableAllIFrames is set to 0 and NvMediaEncodeRCParams::numBFrames is set to 0.
Value range: 2 to 8
For encoding with I, P and B frame types (p and b-frames as reference), i.e., NvMediaEncodeInitializeParamsH264::enableAllIFrames is set to 0, NvMediaEncodeRCParams::numBFrames is set to a non-zero value and NvMediaEncodeInitializeParamsH264::useBFramesAsRef is set to 1.
Value range: 2 to 8
For encoding with I, P and B frame types (only p-frames as reference), i.e., NvMediaEncodeInitializeParamsH264::enableAllIFrames is set to 0, NvMediaEncodeRCParams::numBFrames is set to a non-zero value and NvMediaEncodeInitializeParamsH264::useBFramesAsRef is set to 0.

Definition at line 969 of file nvmedia_common_encode.h.

◆ maxNumRefFrames [2/4]

uint8_t NvMediaEncodeInitializeParamsH265::maxNumRefFrames

Holds the maximum number of reference frames used for encoding.


Value range: 0
For I-frame only mode (no reference frames), i.e., NvMediaEncodeInitializeParamsH265::enableAllIFrames is set to 1 and NvMediaEncodeRCParams::numBFrames is set to 0.
Value range: 1 to 8
For encoding with I and P frame types (p-frames as reference), i.e., NvMediaEncodeInitializeParamsH265::enableAllIFrames is set to 0 and NvMediaEncodeRCParams::numBFrames is set to 0.
Value range: 2 to 8
For encoding with I, P and B frame types (p and b-frames as reference), i.e., NvMediaEncodeInitializeParamsH265::enableAllIFrames is set to 0, NvMediaEncodeRCParams::numBFrames is set to a non-zero value and NvMediaEncodeInitializeParamsH265::useBFramesAsRef is set to 1.
Value range: 2 to 8
For encoding with I, P and B frame types (only p-frames as reference), i.e., NvMediaEncodeInitializeParamsH265::enableAllIFrames is set to 0, NvMediaEncodeRCParams::numBFrames is set to a non-zero value and NvMediaEncodeInitializeParamsH265::useBFramesAsRef is set to 0.

Definition at line 1415 of file nvmedia_common_encode.h.

◆ maxNumRefFrames [3/4]

uint8_t NvMediaEncodeInitializeParamsVP9::maxNumRefFrames

Holds the max reference numbers used for encoding.

Allowed range is [0, 2]. Values:

  • 0 allows only I frame encode
  • 1 allows I and IP encode
  • 2 allows I, IP and IBP encode

Definition at line 1728 of file nvmedia_common_encode.h.

◆ maxNumRefFrames [4/4]

uint8_t NvMediaEncodeInitializeParamsAV1::maxNumRefFrames

Holds the max reference numbers used for encoding.

Allowed range is [0, 2]. Values:

  • 0 allows only I frame encode
  • 1 allows I and IP encode
  • 2 allows I, IP and IBP encode

Definition at line 1931 of file nvmedia_common_encode.h.

◆ maxQP [1/4]

NvMediaEncodeQP NvMediaEncodeConfigH264::maxQP

Holds the maximum QP parameters.

The client must set NVMEDIA_ENCODE_CONFIG_H264_QP_MAX in features to use this.
Value range: QP values can lie between 1 to 51 in increments of 1, must be greater than NvMediaEncodeRCParams::minQP.

Definition at line 879 of file nvmedia_common_encode.h.

◆ maxQP [2/4]

NvMediaEncodeQP NvMediaEncodeConfigH265::maxQP

Holds maximum QP parameters.

Client must set NVMEDIA_ENCODE_CONFIG_H265_QP_MAX in features to use this.
Value range: QP values can lie between 1 to 51 in increments of 1, must be greater than NvMediaEncodeRCParams::minQP.

Definition at line 1336 of file nvmedia_common_encode.h.

◆ maxQP [3/4]

NvMediaEncodeQP NvMediaEncodeConfigVP9::maxQP

Holds maximum QP parameters.

Client must set NVMEDIA_ENCODE_CONFIG_VP9_QP_MAX in features to use this. The maximum QP values must be within the range of 1 to 255 and must be set to a value greater than NvMediaEncodeRCParams::minQP.

Definition at line 1702 of file nvmedia_common_encode.h.

◆ maxQP [4/4]

NvMediaEncodeQP NvMediaEncodeConfigAV1::maxQP

Holds maximum QP parameters.

Client must set NVMEDIA_ENCODE_CONFIG_VP9_QP_MAX in features to use this. The maximum QP values must be within the range of 1 to 255 and must be set to a value greater than NvMediaEncodeRCParams::minQP.

Definition at line 1879 of file nvmedia_common_encode.h.

◆ maxSessionQP

int8_t NvMediaEncodeRCParams::maxSessionQP

Holds the max QP for encoding session when external picture RC hint is used.

Note
This feature is not supported.

Definition at line 194 of file nvmedia_common_encode.h.

◆ maxSliceSizeInBytes [1/2]

uint32_t NvMediaEncodeConfigH264::maxSliceSizeInBytes

Holds the maximum slice size in bytes for dynamic slice mode.

The client must set NVMEDIA_ENCODE_CONFIG_H264_ENABLE_DYNAMIC_SLICE_MODE in features for this setting to take effect.

Definition at line 853 of file nvmedia_common_encode.h.

◆ maxSliceSizeInBytes [2/2]

uint32_t NvMediaEncodeConfigH265::maxSliceSizeInBytes

Holds the maximum slice size in bytes for dynamic slice mode.

The Client must set NVMEDIA_ENCODE_CONFIG_H265_ENABLE_DYNAMIC_SLICE_MODE in features in order for this to take effect.

Definition at line 1317 of file nvmedia_common_encode.h.

◆ meExternalHints [1/5]

NvMediaEncodeExternalMEHint* { ... } ::meExternalHints

Definition at line 1101 of file nvmedia_common_encode.h.

◆ meExternalHints [2/5]

NvMediaEncodeExternalMEHint* NvMediaEncodePicParamsH264::meExternalHints

Definition at line 1101 of file nvmedia_common_encode.h.

◆ meExternalHints [3/5]

NvMediaEncodeExternalMEHint* NvMediaEncodePicParamsH265::meExternalHints

Holds the pointer to ME external hints for the current frame.

The size of ME hint buffer must be equal to number of macroblocks multiplied by the total number of candidates per macroblock. The total number of candidates per MB per direction =

  1*meHintCountsPerBlock[Lx].numCandsPerBlk16x16 +
  2*meHintCountsPerBlock[Lx].numCandsPerBlk16x8 +
  2*meHintCountsPerBlock[Lx].numCandsPerBlk8x16 +
  4*meHintCountsPerBlock[Lx].numCandsPerBlk8x8

For frames using bidirectional ME, the total number of candidates for a single macroblock is the sum of the total number of candidates per MB for each direction (L0 and L1).

If no external ME hints are needed, set this field to NULL.

Deprecated:
This feature will be deprecated in a future release.

Definition at line 1558 of file nvmedia_common_encode.h.

◆ meExternalHints [4/5]

NvMediaEncodeExternalMEHint* NvMediaEncodePicParamsVP9::meExternalHints

Holds the pointer to ME external hints for the current frame.

The size of ME hint buffer must be equal to number of macroblocks multiplied by the total number of candidates per macroblock. The total number of candidates per MB per direction =

 1*meHintCountsPerBlock[Lx].numCandsPerBlk16x16 +
 2*meHintCountsPerBlock[Lx].numCandsPerBlk16x8 +
 2*meHintCountsPerBlock[Lx].numCandsPerBlk8x16 +
 4*meHintCountsPerBlock[Lx].numCandsPerBlk8x8

For frames using bidirectional ME , the total number of candidates for a single macroblock is the sum of the total number of candidates per MB for each direction (L0 and L1).

If no external ME hints are needed, set this field to NULL.

Definition at line 1802 of file nvmedia_common_encode.h.

◆ meExternalHints [5/5]

NvMediaEncodeExternalMEHint* NvMediaEncodePicParamsAV1::meExternalHints

Holds the pointer to ME external hints for the current frame.

The size of ME hint buffer must be equal to number of macroblocks multiplied by the total number of candidates per macroblock. The total number of candidates per MB per direction =

 1*meHintCountsPerBlock[Lx].numCandsPerBlk16x16 +
 2*meHintCountsPerBlock[Lx].numCandsPerBlk16x8 +
 2*meHintCountsPerBlock[Lx].numCandsPerBlk8x16 +
 4*meHintCountsPerBlock[Lx].numCandsPerBlk8x8

For frames using bidirectional ME , the total number of candidates for a single macroblock is the sum of the total number of candidates per MB for each direction (L0 and L1).

If no external ME hints are needed, set this field to NULL.

Definition at line 2012 of file nvmedia_common_encode.h.

◆ meHintCountsPerBlock [1/4]

NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodePicParamsH264::meHintCountsPerBlock[2]

Holds the number of hint candidates per block per direction for the current frame.

meHintCountsPerBlock[0] is for L0 predictors and meHintCountsPerBlock[1] is for L1 predictors. The candidate count in NvMediaEncodePicParamsH264 meHintCountsPerBlock[lx] must never exceed NvMediaEncodeInitializeParamsH264 maxMEHintCountsPerBlock[lx] provided during encoder initialization.

Deprecated:
This feature will be deprecated in a future release.

Definition at line 1082 of file nvmedia_common_encode.h.

◆ meHintCountsPerBlock [2/4]

NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodePicParamsH265::meHintCountsPerBlock[2]

Holds the number of hint candidates per block per direction for the current frame.

meHintCountsPerBlock[0] is for L0 predictors and meHintCountsPerBlock[1] is for L1 predictors. The candidate count in NvMediaEncodePicParamsH265 meHintCountsPerBlock[lx] must never exceed NvMediaEncodeInitializeParamsH265 maxMEHintCountsPerBlock[lx] provided during encoder initialization.

Deprecated:
This feature will be deprecated in a future release.

Definition at line 1541 of file nvmedia_common_encode.h.

◆ meHintCountsPerBlock [3/4]

NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodePicParamsVP9::meHintCountsPerBlock[2]

Holds the number of hint candidates per block per direction for the current frame.

meHintCountsPerBlock[0] is for L0 predictors and meHintCountsPerBlock[1] is for L1 predictors. The candidate count in NvMediaEncodePicParamsVP9 meHintCountsPerBlock[lx] must never exceed NvMediaEncodeInitializeParamsVP9 maxMEHintCountsPerBlock[lx] provided during encoder initialization.

Definition at line 1786 of file nvmedia_common_encode.h.

◆ meHintCountsPerBlock [4/4]

NvMediaEncodeExternalMeHintCountsPerBlocktype NvMediaEncodePicParamsAV1::meHintCountsPerBlock[2]

Holds the number of hint candidates per block per direction for the current frame.

meHintCountsPerBlock[0] is for L0 predictors and meHintCountsPerBlock[1] is for L1 predictors. The candidate count in NvMediaEncodePicParamsVP9 meHintCountsPerBlock[lx] must never exceed NvMediaEncodeInitializeParamsVP9 maxMEHintCountsPerBlock[lx] provided during encoder initialization.

Definition at line 1996 of file nvmedia_common_encode.h.

◆ meHints [1/2]

uint8_t* NvMediaEncodePicParamsH264::meHints

Definition at line 1102 of file nvmedia_common_encode.h.

◆ meHints [2/2]

uint8_t* { ... } ::meHints

Definition at line 1102 of file nvmedia_common_encode.h.

◆ minQP [1/3]

NvMediaEncodeQP NvMediaEncodeRCParams::minQP

Holds the minimum QP used for rate control.

Definition at line 161 of file nvmedia_common_encode.h.

◆ minQP [2/3]

NvMediaEncodeQP { ... } ::minQP

Holds the minimum QP used for rate control.

Definition at line 161 of file nvmedia_common_encode.h.

◆ minQP [3/3]

NvMediaEncodeQP { ... } ::minQP

Holds the minimum QP used for rate control.

Definition at line 176 of file nvmedia_common_encode.h.

◆ mode_lf_deltas

int8_t NvMediaEncodeConfigVP9::mode_lf_deltas[2]

Specifies the Loop filter strength adjustments based on mode (zero, new mv).

Definition at line 1641 of file nvmedia_common_encode.h.

◆ motionPredictionExclusionFlags

uint32_t NvMediaEncodeConfigH264::motionPredictionExclusionFlags

Holds bitwise OR`ed exclusion flags.

See enum NvMediaEncodeH264MotionPredictionExclusionFlags.

Deprecated:
This feature will be deprecated in a future release.

Definition at line 864 of file nvmedia_common_encode.h.

◆ mvcNumViews

uint32_t NvMediaEncodeInitializeParamsH264::mvcNumViews

Number of views used for MVC.

Note
This feature is not supported.

Definition at line 1036 of file nvmedia_common_encode.h.

◆ mvNumViews

uint32_t NvMediaEncodeInitializeParamsH265::mvNumViews

Number of views used for MV-Hevc.

Note
This feature is not supported.

Definition at line 1475 of file nvmedia_common_encode.h.

◆ mvx

int32_t NvMediaEncodeExternalMEHint::mvx

Holds the x component of integer pixel MV (relative to current MB) S12.0.

Definition at line 681 of file nvmedia_common_encode.h.

◆ mvy

int32_t NvMediaEncodeExternalMEHint::mvy

Holds the y component of integer pixel MV (relative to current MB) S10.0 .

Definition at line 683 of file nvmedia_common_encode.h.

◆ nalUnitType

uint32_t NvMediaEncodeH265SEIPayload::nalUnitType

SEI nal_unit_type.

Definition at line 1501 of file nvmedia_common_encode.h.

◆ nextBFrames [1/4]

uint32_t NvMediaEncodePicParamsH264::nextBFrames

Specifies the number of B-frames that follow the current frame.

This number can be set only for reference frames and the frames that follow the current frame must be nextBFrames count of B-frames. B-frames are supported only if the profile is greater than NVMEDIA_ENCODE_PROFILE_BASELINE and the maxNumRefFrames is set to 2. Set to zero if no B-frames are needed.

Definition at line 1062 of file nvmedia_common_encode.h.

◆ nextBFrames [2/4]

uint32_t NvMediaEncodePicParamsH265::nextBFrames

Specifies the number of B-frames that follow the current frame.

This number can be set only for reference frames and the frames that follow the current frame must be nextBFrames count of B-frames. B-frames are supported only if the profile is greater than NVMEDIA_ENCODE_PROFILE_BASELINE and the maxNumRefFrames is set to 2. Set to zero if no B-frames are needed.

Definition at line 1521 of file nvmedia_common_encode.h.

◆ nextBFrames [3/4]

uint32_t NvMediaEncodePicParamsVP9::nextBFrames

Holds the number of B-frames that follow the current frame.

This number can be set only for reference frames and the frames that follow the current frame must be nextBFrames count of B-frames. B-frames are supported only if the profile is greater than NVMEDIA_ENCODE_PROFILE_BASELINE and the maxNumRefFrames is set to 2. Set to zero if no B-frames are needed.

Definition at line 1774 of file nvmedia_common_encode.h.

◆ nextBFrames [4/4]

uint32_t NvMediaEncodePicParamsAV1::nextBFrames

Holds the number of B-frames that follow the current frame.

This number can be set only for reference frames and the frames that follow the current frame must be nextBFrames count of B-frames. B-frames are supported only if the profile is greater than NVMEDIA_ENCODE_PROFILE_BASELINE and the maxNumRefFrames is set to 2. Set to zero if no B-frames are needed.

Definition at line 1984 of file nvmedia_common_encode.h.

◆ numBFrames

uint32_t NvMediaEncodeRCParams::numBFrames

Specified number of B frames between two reference frames.


Value range: The values between 0 to 10, in increments of 1.

Definition at line 111 of file nvmedia_common_encode.h.

◆ numCandsPerBlk16x16

uint32_t NvMediaEncodeExternalMeHintCountsPerBlocktype::numCandsPerBlk16x16

Holds the number of candidates per 16x16 block.

Definition at line 666 of file nvmedia_common_encode.h.

◆ numCandsPerBlk16x8

uint32_t NvMediaEncodeExternalMeHintCountsPerBlocktype::numCandsPerBlk16x8

Holds the number of candidates per 16x8 block.

Definition at line 668 of file nvmedia_common_encode.h.

◆ numCandsPerBlk8x16

uint32_t NvMediaEncodeExternalMeHintCountsPerBlocktype::numCandsPerBlk8x16

Holds the number of candidates per 8x16 block.

Definition at line 670 of file nvmedia_common_encode.h.

◆ numCandsPerBlk8x8

uint32_t NvMediaEncodeExternalMeHintCountsPerBlocktype::numCandsPerBlk8x8

Holds the number of candidates per 8x8 block.

Definition at line 672 of file nvmedia_common_encode.h.

◆ numCTUsPerSlice

uint32_t NvMediaEncodeConfigH265::numCTUsPerSlice

Number of CTU per slice.

Set to 0 if fix number of macroblocks not required or maxSliceSizeInBytes or numSliceCountMinus1 is set to non-zero value.

Definition at line 1321 of file nvmedia_common_encode.h.

◆ numEpCores

uint8_t NvMediaEncodeInitializeParamsVP9::numEpCores

Holds number of HW entropy cores for encoding.

Supported cores are 1 and 4 cores

Definition at line 1747 of file nvmedia_common_encode.h.

◆ numMacroblocksPerSlice

uint32_t NvMediaEncodeConfigH264::numMacroblocksPerSlice

Holds the number of macroblocks per slice.

Set to 0 if a fixed number of macroblocks not required or if maxSliceSizeInBytes or numSliceCountMinus1 is set to a non-zero value.

Definition at line 857 of file nvmedia_common_encode.h.

◆ numSliceCountMinus1 [1/2]

uint16_t NvMediaEncodeConfigH264::numSliceCountMinus1

Holds a number that is 1 less than the desired number of slices per frame.

NVMEDIA_ENCODE_CONFIG_H264_ENABLE_DYNAMIC_SLICE_MODE should NOT be set in features for this setting to take effect.
Value range: 0 to 31 in increments of 1.

Definition at line 818 of file nvmedia_common_encode.h.

◆ numSliceCountMinus1 [2/2]

uint16_t NvMediaEncodeConfigH265::numSliceCountMinus1

Holds a number that is 1 less than the desired number of slices per frame.

NVMEDIA_ENCODE_CONFIG_H265_ENABLE_DYNAMIC_SLICE_MODE should NOT be set in features for this setting to take effect.
Value range: 0 to 31 in increments of 1.

Definition at line 1289 of file nvmedia_common_encode.h.

◆ overscanAppropriateFlag [1/2]

bool NvMediaEncodeConfigH264VUIParams::overscanAppropriateFlag

Holds the overscan info (as defined in Annex E of the ITU-T Specification).

Definition at line 629 of file nvmedia_common_encode.h.

◆ overscanAppropriateFlag [2/2]

bool NvMediaEncodeConfigH265VUIParams::overscanAppropriateFlag

Holds the overscan info (as defined in Annex E of the ITU-T Specification).

Definition at line 1144 of file nvmedia_common_encode.h.

◆ overscanInfoPresentFlag [1/2]

bool NvMediaEncodeConfigH264VUIParams::overscanInfoPresentFlag

If set to true, it specifies that the overscanInfo is present.

Definition at line 626 of file nvmedia_common_encode.h.

◆ overscanInfoPresentFlag [2/2]

bool NvMediaEncodeConfigH265VUIParams::overscanInfoPresentFlag

If set to true, it specifies that the overscanInfo is present.

Definition at line 1141 of file nvmedia_common_encode.h.

◆ params

union { ... } NvMediaEncodeRCParams::params

Rate Control parameters.

◆ partType

uint32_t NvMediaEncodeExternalMEHint::partType

Holds the block partition type.

0=16x16 1=16x8 2=8x16 3=8x8 (blocks in partition must be consecutive).

Definition at line 691 of file nvmedia_common_encode.h.

◆ payload [1/2]

uint8_t* NvMediaEncodeH264SEIPayload::payload

Pointer to user data.

Definition at line 901 of file nvmedia_common_encode.h.

◆ payload [2/2]

uint8_t* NvMediaEncodeH265SEIPayload::payload

pointer to user data

Definition at line 1503 of file nvmedia_common_encode.h.

◆ payloadSize [1/2]

uint32_t NvMediaEncodeH264SEIPayload::payloadSize

SEI payload size in bytes.

SEI payload must be byte aligned, as described in Annex D

Definition at line 896 of file nvmedia_common_encode.h.

◆ payloadSize [2/2]

uint32_t NvMediaEncodeH265SEIPayload::payloadSize

SEI payload size in bytes.

SEI payload must be byte aligned, as described in Annex D

Definition at line 1496 of file nvmedia_common_encode.h.

◆ payloadType [1/2]

uint32_t NvMediaEncodeH264SEIPayload::payloadType

SEI payload types and syntax can be found in Annex D of the H.264 Specification.

Definition at line 899 of file nvmedia_common_encode.h.

◆ payloadType [2/2]

uint32_t NvMediaEncodeH265SEIPayload::payloadType

SEI payload types and syntax can be found in Annex D of the H265 Specification.

Definition at line 1499 of file nvmedia_common_encode.h.

◆ pictureType [1/4]

NvMediaEncodePicType NvMediaEncodePicParamsH264::pictureType

Holds input picture type.

Definition at line 1052 of file nvmedia_common_encode.h.

◆ pictureType [2/4]

NvMediaEncodePicType NvMediaEncodePicParamsH265::pictureType

Holds input picture type.

Definition at line 1511 of file nvmedia_common_encode.h.

◆ pictureType [3/4]

NvMediaEncodePicType NvMediaEncodePicParamsVP9::pictureType

Holds input picture type.

Definition at line 1764 of file nvmedia_common_encode.h.

◆ pictureType [4/4]

NvMediaEncodePicType NvMediaEncodePicParamsAV1::pictureType

Holds input picture type.

Definition at line 1974 of file nvmedia_common_encode.h.

◆ pocType

NvMediaEncodeH264POCType NvMediaEncodeConfigH264::pocType

Holds pic_ordec_cnt_type.

Definition at line 869 of file nvmedia_common_encode.h.

◆ profile [1/3]

uint8_t NvMediaEncodeInitializeParamsH264::profile

Holds the encoding profile.

Client is recommended to set this to NVMEDIA_ENCODE_PROFILE_AUTOSELECT in order to enable the Encode interface to select the correct profile. If a specific profile needs to be configured, this field can be set to one of the supported enumerations from NvMediaEncodeProfile.

Definition at line 938 of file nvmedia_common_encode.h.

◆ profile [2/3]

uint8_t NvMediaEncodeInitializeParamsH265::profile

Holds the encoding profile.

Client is recommended to set this to NVMEDIA_ENCODE_PROFILE_AUTOSELECT in order to enable the Encode interface to select the correct profile. If a specific profile needs to be configured, this field can be set to one of the supported enumerations from NvMediaEncodeProfile.

Definition at line 1380 of file nvmedia_common_encode.h.

◆ profile [3/3]

uint8_t NvMediaEncodeInitializeParamsAV1::profile

Holds the encoding profile.

Client is recommended to set this to NVMEDIA_ENCODE_PROFILE_AUTOSELECT in order to enable the Encode interface to select the correct profile. If a specific profile needs to be configured, this field can be set to one of the supported enumerations from NvMediaEncodeProfile.

Definition at line 1917 of file nvmedia_common_encode.h.

◆ qpInterB

int16_t NvMediaEncodeQP::qpInterB

QP value for B frames.

Definition at line 74 of file nvmedia_common_encode.h.

◆ qpInterP

int16_t NvMediaEncodeQP::qpInterP

QP value for P frames.

Definition at line 72 of file nvmedia_common_encode.h.

◆ qpIntra

int16_t NvMediaEncodeQP::qpIntra

QP value for Intra frames.

Definition at line 76 of file nvmedia_common_encode.h.

◆ quality [1/3]

NvMediaEncodeQuality NvMediaEncodeConfigH264::quality

Holds the encode quality pre-set.

See enum NvMediaEncodeQuality. Recommended pre-setting is NVMEDIA_ENCODE_QUALITY_L1.

Definition at line 867 of file nvmedia_common_encode.h.

◆ quality [2/3]

NvMediaEncodeQuality NvMediaEncodeConfigH265::quality

Holds encode quality pre-set.

See NvMediaEncodeQuality enum. Recommended pre-setting is NVMEDIA_ENCODE_QUALITY_L0.

Definition at line 1327 of file nvmedia_common_encode.h.

◆ quality [3/3]

NvMediaEncodeQuality NvMediaEncodeConfigAV1::quality

Holds the encode quality pre-set.

See enum NvMediaEncodeQuality. Recommended pre-setting is NVMEDIA_ENCODE_QUALITY_L1.

Definition at line 1882 of file nvmedia_common_encode.h.

◆ rateControlMode

NvMediaEncodeParamsRCMode NvMediaEncodeRCParams::rateControlMode

Holds the rate control mode.

Definition at line 108 of file nvmedia_common_encode.h.

◆ rcParams [1/8]

NvMediaEncodeRCParams NvMediaEncodeConfigH264::rcParams

Holds the rate control parameters for the current encoding session.

Definition at line 805 of file nvmedia_common_encode.h.

◆ rcParams [2/8]

NvMediaEncodeRCParams NvMediaEncodePicParamsH264::rcParams

Holds the rate control parameters from the current frame onward if the NVMEDIA_ENCODE_PIC_FLAG_RATECONTROL_CHANGE is set in the encodePicFlags.

Note
The NvMediaEncodeRCParams::rateControlMode cannot be changed on a per-frame basis. Only the associated rate control parameters can be changed.

Definition at line 1069 of file nvmedia_common_encode.h.

◆ rcParams [3/8]

NvMediaEncodeRCParams NvMediaEncodeConfigH265::rcParams

Holds the rate control parameters for the current encoding session.

Definition at line 1277 of file nvmedia_common_encode.h.

◆ rcParams [4/8]

NvMediaEncodeRCParams NvMediaEncodePicParamsH265::rcParams

Holds the rate control parameters from the current frame onward if the NVMEDIA_ENCODE_PIC_FLAG_RATECONTROL_CHANGE is set in the encodePicFlags.

Note
The NvMediaEncodeRCParams::rateControlMode cannot be changed on a per-frame basis. Only the associated rate control parameters can be changed.

Definition at line 1528 of file nvmedia_common_encode.h.

◆ rcParams [5/8]

NvMediaEncodeRCParams NvMediaEncodeConfigVP9::rcParams

Holds the rate control parameters for the current encoding session.

Definition at line 1615 of file nvmedia_common_encode.h.

◆ rcParams [6/8]

NvMediaEncodeRCParams NvMediaEncodePicParamsVP9::rcParams

Holds the rate control parameters from the current frame onward if the NVMEDIA_ENCODE_PIC_FLAG_RATECONTROL_CHANGE is set in the encodePicFlags.

Please note that the rateControlMode cannot be changed on a per frame basis only the associated rate control parameters.

Definition at line 1779 of file nvmedia_common_encode.h.

◆ rcParams [7/8]

NvMediaEncodeRCParams NvMediaEncodeConfigAV1::rcParams

Holds the rate control parameters for the current encoding session.

Definition at line 1844 of file nvmedia_common_encode.h.

◆ rcParams [8/8]

NvMediaEncodeRCParams NvMediaEncodePicParamsAV1::rcParams

Holds the rate control parameters from the current frame onward if the NVMEDIA_ENCODE_PIC_FLAG_RATECONTROL_CHANGE is set in the encodePicFlags.

Please note that the rateControlMode cannot be changed on a per frame basis only the associated rate control parameters.

Definition at line 1989 of file nvmedia_common_encode.h.

◆ ref_lf_deltas

int8_t NvMediaEncodeConfigVP9::ref_lf_deltas[4]

Specifies the Loop filter strength adjustments based on frame type (intra, inter).

Definition at line 1638 of file nvmedia_common_encode.h.

◆ refidx

uint32_t NvMediaEncodeExternalMEHint::refidx

Holds the reference index (31=invalid).

Current we support only 1 reference frame per direction for external hints, so refidx must be 0.

Definition at line 686 of file nvmedia_common_encode.h.

◆ repeatSPSPPS [1/2]

NvMediaEncodeH264SPSPPSRepeatMode NvMediaEncodeConfigH264::repeatSPSPPS

Holds the frequency of the writing of Sequence and Picture parameters.

Definition at line 808 of file nvmedia_common_encode.h.

◆ repeatSPSPPS [2/2]

NvMediaEncodeH264SPSPPSRepeatMode NvMediaEncodeConfigH265::repeatSPSPPS

Holds the frequency of the writing of Sequence and Picture parameters.

Definition at line 1279 of file nvmedia_common_encode.h.

◆ reserved [1/7]

uint32_t NvMediaEncodeConfigAV1::reserved[17]

Reserved Bytes.

Definition at line 1892 of file nvmedia_common_encode.h.

◆ reserved [2/7]

uint32_t NvMediaEncodePicParamsAV1::reserved[18]

Reserved Bytes.

Definition at line 2022 of file nvmedia_common_encode.h.

◆ reserved [3/7]

uint32_t NvMediaEncodeInitializeParamsAV1::reserved[20]

Reserved Bytes.

Definition at line 1965 of file nvmedia_common_encode.h.

◆ reserved [4/7]

int16_t NvMediaEncodeQP::reserved[3]

Definition at line 78 of file nvmedia_common_encode.h.

◆ reserved [5/7]

int8_t NvMediaEncodeRCParams::reserved[3]

Definition at line 195 of file nvmedia_common_encode.h.

◆ reserved [6/7]

uint32_t NvMediaEncodeInitializeParamsH264::reserved

Add padding.

Definition at line 1044 of file nvmedia_common_encode.h.

◆ reserved [7/7]

uint32_t NvMediaEncodeInitializeParamsH265::reserved

Add padding.

Definition at line 1483 of file nvmedia_common_encode.h.

◆ reserved1 [1/2]

uint16_t NvMediaEncodeInitializeParamsH264::reserved1

Definition at line 914 of file nvmedia_common_encode.h.

◆ reserved1 [2/2]

uint16_t NvMediaEncodeInitializeParamsH265::reserved1

Definition at line 1354 of file nvmedia_common_encode.h.

◆ reserved2 [1/2]

uint16_t NvMediaEncodeInitializeParamsH264::reserved2

Definition at line 921 of file nvmedia_common_encode.h.

◆ reserved2 [2/2]

uint16_t NvMediaEncodeInitializeParamsH265::reserved2

Definition at line 1361 of file nvmedia_common_encode.h.

◆ reserved3

uint8_t NvMediaEncodeInitializeParamsH264::reserved3[3]

Definition at line 1021 of file nvmedia_common_encode.h.

◆ seiPayloadArray [1/2]

NvMediaEncodeH264SEIPayload* NvMediaEncodePicParamsH264::seiPayloadArray

Array of SEI payloads which will be inserted for this frame.

Definition at line 1074 of file nvmedia_common_encode.h.

◆ seiPayloadArray [2/2]

NvMediaEncodeH265SEIPayload* NvMediaEncodePicParamsH265::seiPayloadArray

Array of SEI payloads which will be inserted for this frame.

Definition at line 1533 of file nvmedia_common_encode.h.

◆ seiPayloadArrayCnt [1/2]

uint32_t NvMediaEncodePicParamsH264::seiPayloadArrayCnt

Holds the number of elements allocated in seiPayloadArray array.

Set to 0 if no SEI messages are needed

Definition at line 1072 of file nvmedia_common_encode.h.

◆ seiPayloadArrayCnt [2/2]

uint32_t NvMediaEncodePicParamsH265::seiPayloadArrayCnt

Holds the number of elements allocated in seiPayloadArray array.

Set to 0 if no SEI messages are needed

Definition at line 1531 of file nvmedia_common_encode.h.

◆ sharpness_level

uint32_t NvMediaEncodeConfigVP9::sharpness_level

Specifies Sharpness level.

Definition at line 1635 of file nvmedia_common_encode.h.

◆ timingInfoPresentFlag

bool NvMediaEncodeConfigH264VUIParams::timingInfoPresentFlag

Holds that num_units_in_tick, time_scale and fixed_frame_rate_flag are present in the bitstream (as defined in Annex E of the ITU-T Specification).

Definition at line 654 of file nvmedia_common_encode.h.

◆ transferCharacteristics [1/2]

uint8_t NvMediaEncodeConfigH264VUIParams::transferCharacteristics

Holds the opto-electronic transfer characteristics to use (as defined in Annex E of the ITU-T Specification).

Definition at line 647 of file nvmedia_common_encode.h.

◆ transferCharacteristics [2/2]

uint8_t NvMediaEncodeConfigH265VUIParams::transferCharacteristics

Holds the opto-electronic transfer characteristics to use (as defined in Annex E of the ITU-T Specification).

Definition at line 1163 of file nvmedia_common_encode.h.

◆ transform_mode

uint32_t NvMediaEncodeConfigVP9::transform_mode

Set the feature flag NVMEDIA_ENCODE_CONFIG_VP9_ENABLE_TRANSFORM_MODE to set the following parameter.

Specifies transform_mode.
Value range: One of the following modes:

  • 0: only4x4
  • 1: allow_8x8
  • 2: allow_16x16
  • 3: allow_32x32
  • 4:transform_mode_select.

Definition at line 1677 of file nvmedia_common_encode.h.

◆ ulNalSize

uint32_t NvMediaNalData::ulNalSize

Nal size for header.

Definition at line 603 of file nvmedia_common_encode.h.

◆ useBFramesAsRef [1/2]

uint8_t NvMediaEncodeInitializeParamsH264::useBFramesAsRef

Enables B frames to be used as reference frames.


Value range: 0 to 1

Definition at line 1020 of file nvmedia_common_encode.h.

◆ useBFramesAsRef [2/2]

uint32_t NvMediaEncodeInitializeParamsH265::useBFramesAsRef

Enables B frames to be used as reference frames.


Value range: 0 to 1

Definition at line 1460 of file nvmedia_common_encode.h.

◆ vbr [1/2]

struct { ... } ::vbr

Parameters for NVMEDIA_ENCODE_PARAMS_RC_VBR mode.

◆ vbr [2/2]

struct { ... } NvMediaEncodeRCParams::vbr

Parameters for NVMEDIA_ENCODE_PARAMS_RC_VBR mode.

◆ vbr_minqp [1/2]

struct { ... } NvMediaEncodeRCParams::vbr_minqp

Parameters for NVMEDIA_ENCODE_PARAMS_RC_VBR_MINQP mode.

◆ vbr_minqp [2/2]

struct { ... } ::vbr_minqp

Parameters for NVMEDIA_ENCODE_PARAMS_RC_VBR_MINQP mode.

◆ vbvBufferSize [1/5]

uint32_t { ... } ::vbvBufferSize

Holds the VBV(HRD) buffer size, in bits.

Set to 0 (zero) to automatically determine the right VBV buffer size as per tier and level limits specified in the relevant coding standard.

Definition at line 120 of file nvmedia_common_encode.h.

◆ vbvBufferSize [2/5]

uint32_t NvMediaEncodeRCParams::vbvBufferSize

Holds the VBV(HRD) buffer size, in bits.

Set to 0 (zero) to automatically determine the right VBV buffer size as per tier and level limits specified in the relevant coding standard.

Definition at line 120 of file nvmedia_common_encode.h.

◆ vbvBufferSize [3/5]

uint32_t { ... } ::vbvBufferSize

Holds the VBV(HRD) buffer size, in bits.

Set to 0 (zero) to automatically determine the right VBV buffer size as per tier and level limits specified in the relevant coding standard.

Definition at line 140 of file nvmedia_common_encode.h.

◆ vbvBufferSize [4/5]

uint32_t { ... } ::vbvBufferSize

Holds the VBV(HRD) buffer size, in bits.

Set to 0 (zero) to automatically determine the right VBV buffer size as per tier and level limits specified in the relevant coding standard.

Definition at line 155 of file nvmedia_common_encode.h.

◆ vbvBufferSize [5/5]

uint32_t { ... } ::vbvBufferSize

Holds the VBV(HRD) buffer size, in bits.

Set to 0 (zero) to automatically determine the right VBV buffer size as per tier and level limits specified in the relevant coding standard.

Definition at line 170 of file nvmedia_common_encode.h.

◆ vbvInitialDelay [1/5]

uint32_t { ... } ::vbvInitialDelay

Holds the VBV(HRD) initial delay in bits.

Set to 0 (zero) to use the internally determined VBV initial delay.

Definition at line 124 of file nvmedia_common_encode.h.

◆ vbvInitialDelay [2/5]

uint32_t NvMediaEncodeRCParams::vbvInitialDelay

Holds the VBV(HRD) initial delay in bits.

Set to 0 (zero) to use the internally determined VBV initial delay.

Definition at line 124 of file nvmedia_common_encode.h.

◆ vbvInitialDelay [3/5]

uint32_t { ... } ::vbvInitialDelay

Holds the VBV(HRD) initial delay in bits.

Set to 0 (zero) to use the internally determined VBV initial delay.

Definition at line 144 of file nvmedia_common_encode.h.

◆ vbvInitialDelay [4/5]

uint32_t { ... } ::vbvInitialDelay

Holds the VBV(HRD) initial delay in bits.

Set to 0 (zero) to use the internally determined VBV initial delay.

Definition at line 159 of file nvmedia_common_encode.h.

◆ vbvInitialDelay [5/5]

uint32_t { ... } ::vbvInitialDelay

Holds the VBV(HRD) initial delay in bits.

Set to 0 (zero) to use the internally determined VBV initial delay.

Definition at line 174 of file nvmedia_common_encode.h.

◆ videoFormat [1/2]

uint8_t NvMediaEncodeConfigH264VUIParams::videoFormat

Holds the source video format (as defined in Annex E of the ITU-T Specification).

Definition at line 635 of file nvmedia_common_encode.h.

◆ videoFormat [2/2]

uint8_t NvMediaEncodeConfigH265VUIParams::videoFormat

Holds the source video format (as defined in Annex E of the ITU-T Specification).

Definition at line 1151 of file nvmedia_common_encode.h.

◆ videoFullRangeFlag [1/2]

bool NvMediaEncodeConfigH264VUIParams::videoFullRangeFlag

Holds the output range of the luma and chroma samples (as defined in Annex E of the ITU-T Specification).

Definition at line 638 of file nvmedia_common_encode.h.

◆ videoFullRangeFlag [2/2]

bool NvMediaEncodeConfigH265VUIParams::videoFullRangeFlag

Holds the output range of the luma and chroma samples (as defined in Annex E of the ITU-T Specification).

Definition at line 1154 of file nvmedia_common_encode.h.

◆ videoSignalTypePresentFlag [1/2]

bool NvMediaEncodeConfigH264VUIParams::videoSignalTypePresentFlag

If set to true, it specifies that the videoFormat, videoFullRangeFlag and colourDescriptionPresentFlag are present.

Definition at line 632 of file nvmedia_common_encode.h.

◆ videoSignalTypePresentFlag [2/2]

bool NvMediaEncodeConfigH265VUIParams::videoSignalTypePresentFlag

If set to true, it specifies that the videoFormat, videoFullRangeFlag, and colourDescriptionPresentFlag are present.

Definition at line 1148 of file nvmedia_common_encode.h.

◆ viewId [1/2]

uint32_t NvMediaEncodePicParamsH264::viewId

Holds the viewId of current picture.

Definition at line 1113 of file nvmedia_common_encode.h.

◆ viewId [2/2]

uint32_t NvMediaEncodePicParamsH265::viewId

Holds the viewId of current picture.

Definition at line 1568 of file nvmedia_common_encode.h.

◆ vp9SkipChroma

uint32_t NvMediaEncodeInitializeParamsVP9::vp9SkipChroma

Skip Chroma Processing.

Supported values are 0 and 1.

Definition at line 1755 of file nvmedia_common_encode.h.

◆ vuiTimingInfoPresentFlag

bool NvMediaEncodeConfigH265VUIParams::vuiTimingInfoPresentFlag

Holds that num_units_in_tick, time_scale and fixed_frame_rate_flag are present in the bitstream (as defined in Annex E of the ITU-T Specification).

Definition at line 1170 of file nvmedia_common_encode.h.