NVIDIA DRIVE OS Linux SDK API Reference

5.2.6 Release
For Test and Development only

Detailed Description

Holds rate control configuration parameters.

Definition at line 97 of file nvmedia_common_encode.h.

Collaboration diagram for NvMediaEncodeRCParams:

Data Fields

NvMediaEncodeParamsRCMode rateControlMode
 Holds the rate control mode. More...
 
uint32_t numBFrames
 Specified number of B frames between two reference frames. More...
 
union {
   struct {
      uint32_t   averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
      uint32_t   vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
      uint32_t   vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
   }   cbr
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_CBR mode. More...
 
   struct {
      NvMediaEncodeQP   constQP
 Holds the initial QP to be used for encoding, these values would be used for all frames in Constant QP mode. More...
 
   }   const_qp
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_CONSTQP mode. More...
 
   struct {
      uint32_t   averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
      uint32_t   maxBitRate
 Holds the maximum bitrate for the encoded output. More...
 
      uint32_t   vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
      uint32_t   vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
   }   vbr
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_VBR mode. More...
 
   struct {
      uint32_t   averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
      uint32_t   maxBitRate
 Holds the maximum bitrate for the encoded output. More...
 
      uint32_t   vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
      uint32_t   vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
      NvMediaEncodeQP   minQP
 Holds the minimum QP used for rate control. More...
 
   }   vbr_minqp
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_VBR_MINQP mode. More...
 
   struct {
      uint32_t   averageBitRate
 Holds the average bitrate (in bits/sec) used for encoding. More...
 
      uint32_t   vbvBufferSize
 Holds the VBV(HRD) buffer size, in bits. More...
 
      uint32_t   vbvInitialDelay
 Holds the VBV(HRD) initial delay in bits. More...
 
      NvMediaEncodeQP   minQP
 Holds the minimum QP used for rate control. More...
 
   }   cbr_minqp
 Parameters for NVMEDIA_ENCODE_PARAMS_RC_CBR_MINQP mode. More...
 
params
 Rate Control parameters. More...
 
NvMediaBool bConstFrameQP
 Use constant QP at frame level or MB row level. More...
 
int8_t maxSessionQP
 Holds the max QP for encoding session when external picture RC hint is used. More...
 
int8_t reserved [3]
 

Field Documentation

◆ averageBitRate

uint32_t NvMediaEncodeRCParams::averageBitRate

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

Definition at line 106 of file nvmedia_common_encode.h.

◆ bConstFrameQP

NvMediaBool NvMediaEncodeRCParams::bConstFrameQP

Use constant QP at frame level or MB row level.


Value range: One of the following:

  • NVMEDIA_TRUE for constant QP at frame level.
  • NVMEDIA_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 172 of file nvmedia_common_encode.h.

◆ cbr

struct { ... } NvMediaEncodeRCParams::cbr

Parameters for NVMEDIA_ENCODE_PARAMS_RC_CBR mode.

◆ cbr_minqp

struct { ... } NvMediaEncodeRCParams::cbr_minqp

Parameters for NVMEDIA_ENCODE_PARAMS_RC_CBR_MINQP mode.

◆ const_qp

struct { ... } NvMediaEncodeRCParams::const_qp

Parameters for NVMEDIA_ENCODE_PARAMS_RC_CONSTQP mode.

◆ constQP

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 119 of file nvmedia_common_encode.h.

◆ maxBitRate

uint32_t NvMediaEncodeRCParams::maxBitRate

Holds the maximum bitrate for the encoded output.

Definition at line 125 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 181 of file nvmedia_common_encode.h.

◆ minQP

NvMediaEncodeQP NvMediaEncodeRCParams::minQP

Holds the minimum QP used for rate control.

Definition at line 149 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 102 of file nvmedia_common_encode.h.

◆ params

union { ... } NvMediaEncodeRCParams::params

Rate Control parameters.

◆ rateControlMode

NvMediaEncodeParamsRCMode NvMediaEncodeRCParams::rateControlMode

Holds the rate control mode.

Definition at line 99 of file nvmedia_common_encode.h.

◆ reserved

int8_t NvMediaEncodeRCParams::reserved[3]

Definition at line 182 of file nvmedia_common_encode.h.

◆ vbr

struct { ... } NvMediaEncodeRCParams::vbr

Parameters for NVMEDIA_ENCODE_PARAMS_RC_VBR mode.

◆ vbr_minqp

struct { ... } NvMediaEncodeRCParams::vbr_minqp

Parameters for NVMEDIA_ENCODE_PARAMS_RC_VBR_MINQP mode.

◆ vbvBufferSize

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 111 of file nvmedia_common_encode.h.

◆ vbvInitialDelay

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 114 of file nvmedia_common_encode.h.


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