Skip to main content
Version: v5.9.0

LibXCoder API Error Classification

libxcoder API Error Definition​

The libxcoder API error definition is defined in ni_defs.h like follow table:

ERROR TYPEVALUEERROR DETIAL
NI_RETCODE_FAILURE-1* unrecoverable failure *
NI_RETCODE_INVALID_PARAM-2* invalid parameter encountered *
* uninitialized parameter encounted *
* null pointer parameter encounted *
NI_RETCODE_ERROR_MEM_ALOC-3* host memory allocation failure *
NI_RETCODE_ERROR_NVME_CMD_FAILED-4* nvme command failure *
NI_RETCODE_ERROR_INVALID_SESSION-5* invalid session ID*
NI_RETCODE_ERROR_RESOURCE_UNAVAILABLE-6* HW resource currently unavailable *
NI_RETCODE_PARAM_INVALID_NAME-7* invalid parameter name *
NI_RETCODE_PARAM_INVALID_VALUE-8* invalid parameter value *
NI_RETCODE_PARAM_ERROR_FRATE-9* invalid frame rate parameter value *
NI_RETCODE_PARAM_ERROR_BRATE-10* invalid bit rate parameter value *
NI_RETCODE_PARAM_ERROR_TRATE-11not used
NI_RETCODE_PARAM_ERROR_VBV_BUFFER_SIZE-12* Invalid VBV BufferSize *
NI_RETCODE_PARAM_ERROR_INTRA_PERIOD-13* invalid intra period parameter value *
NI_RETCODE_PARAM_ERROR_INTRA_QP-14* invalid qp parameter value *
NI_RETCODE_PARAM_ERROR_GOP_PRESET-15* invalid gop preset parameter value *
NI_RETCODE_PARAM_ERROR_CU_SIZE_MODE-16* Invalid cu_size_mode: out of range *
NI_RETCODE_PARAM_ERROR_MX_NUM_MERGE-17not used
NI_RETCODE_PARAM_ERROR_DY_MERGE_8X8_EN-18not used
NI_RETCODE_PARAM_ERROR_DY_MERGE_16X16_EN-19not used
NI_RETCODE_PARAM_ERROR_DY_MERGE_32X32_EN-20not used
NI_RETCODE_PARAM_ERROR_CU_LVL_RC_EN-21* invalid cu level rate control parameter value *
NI_RETCODE_PARAM_ERROR_HVS_QP_EN-22* Invalid enable_hvs_qp *
NI_RETCODE_PARAM_ERROR_HVS_QP_SCL-23not used
NI_RETCODE_PARAM_ERROR_MN_QP-24* invalid minimum qp parameter value *
NI_RETCODE_PARAM_ERROR_MX_QP-25* invalid maximum qp parameter value *
NI_RETCODE_PARAM_ERROR_MX_DELTA_QP-26* invalid maximum delta qp parameter value *
NI_RETCODE_PARAM_ERROR_CONF_WIN_TOP-27* invalid top offset of conformance window parameter value *
NI_RETCODE_PARAM_ERROR_CONF_WIN_BOT-28* invalid bottom offset of conformance window parameter value *
NI_RETCODE_PARAM_ERROR_CONF_WIN_L-29* invalid left offset of conformance window parameter value *
NI_RETCODE_PARAM_ERROR_CONF_WIN_R-30* invalid right offset of conformance window parameter value *
NI_RETCODE_PARAM_ERROR_USR_RMD_ENC_PARAM-31* invalid user recommended parameter value *
NI_RETCODE_PARAM_ERROR_BRATE_LT_TRATE-32not used
NI_RETCODE_PARAM_ERROR_RCENABLE-33* Invalid enable_mb_level_rc: out of range *
NI_RETCODE_PARAM_ERROR_MAXNUMMERGE-34* Invalid max_num_merge: out of range *
NI_RETCODE_PARAM_ERROR_CUSTOM_GOP-35* invalid custom gop preset parameter value *
NI_RETCODE_PARAM_ERROR_PIC_WIDTH-36* invalid picture width parameter value *
NI_RETCODE_PARAM_ERROR_PIC_HEIGHT-37* invalid picture height parameter value *
NI_RETCODE_PARAM_ERROR_DECODING_REFRESH_TYPE-38* invalid decoding refresh type parameter value *
NI_RETCODE_PARAM_ERROR_CUSIZE_MODE_8X8_EN-39* Invalid use_recommend_enc_params and cu_size_mode*
NI_RETCODE_PARAM_ERROR_CUSIZE_MODE_16X16_EN-40
NI_RETCODE_PARAM_ERROR_CUSIZE_MODE_32X32_EN-41
NI_RETCODE_PARAM_ERROR_TOO_BIG-42* parameter value is too big *
NI_RETCODE_PARAM_ERROR_TOO_SMALL-43* parameter value is too small *
NI_RETCODE_PARAM_ERROR_ZERO-44* parameter value is zero *
NI_RETCODE_PARAM_ERROR_OOR-45* parameter value is out of range *
NI_RETCODE_PARAM_ERROR_WIDTH_TOO_BIG-46* parameter width value is too big *
NI_RETCODE_PARAM_ERROR_WIDTH_TOO_SMALL-47* parameter width value is too small *
NI_RETCODE_PARAM_ERROR_HEIGHT_TOO_BIG-48* parameter height value is too big *
NI_RETCODE_PARAM_ERROR_HEIGHT_TOO_SMALL-49* parameter height value is too small *
NI_RETCODE_PARAM_ERROR_AREA_TOO_BIG-50* parameter height x width value is too big *
NI_RETCODE_ERROR_EXCEED_MAX_NUM_SESSIONS-51not used
NI_RETCODE_ERROR_GET_DEVICE_POOL-52* cannot get info from device *
NI_RETCODE_ERROR_LOCK_DOWN_DEVICE-53* cannot obtain the file lock across all the process for query *
NI_RETCODE_ERROR_UNLOCK_DEVICE-54* cannot unlock the lock *
NI_RETCODE_ERROR_OPEN_DEVICE-55* cannot open the device *
NI_RETCODE_ERROR_INVALID_HANDLE-56* device handles that passed in is wrong *
NI_RETCODE_ERROR_INVALID_ALLOCATION_METHOD-57not used
NI_RETCODE_PARAM_WARNING_DEPRECATED-59* deprecated parameter *
NI_RETCODE_PARAM_ERROR_LOOK_AHEAD_DEPTH-60* invalid lookahead depth *
NI_RETCODE_PARAM_ERROR_FILLER-61not used
NI_RETCODE_PARAM_ERROR_PICSKIP-62not used
NI_RETCODE_ERROR_UNSUPPORTED_FW_VERSION-63* FW version is not supported *
NI_RETCODE_ERROR_UNSUPPORTED_FEATURE-64* feature is not supported *
NI_RETCODE_ERROR_PERMISSION_DENIED-65* admin priviledge needed *
NI_RETCODE_ERROR_STREAM_ERROR-66* decoder detect stream error *
NI_RETCODE_PARAM_WARN0x100* just a warning to print *
NI_RETCODE_EAGAIN0x101* memory buffer allocation/query failed*
NI_RETCODE_NVME_SC_RESOURCE_UNAVAILABLE0x301* FW subsystem init failed *
NI_RETCODE_NVME_SC_RESOURCE_IS_EMPTY0x302* FW subsystem resource is empty *
NI_RETCODE_NVME_SC_RESOURCE_NOT_FOUND0x303* FW subsystem Id is not found *
NI_RETCODE_NVME_SC_REQUEST_NOT_COMPLETED0x304* FW subsytem request is not completed *
NI_RETCODE_NVME_SC_REQUEST_IN_PROGRESS0x305not used
NI_RETCODE_NVME_SC_INVALID_PARAMETER0x306* FW subsystem get invalid param *
NI_RETCODE_NVME_SC_STREAM_ERROR0x307* FW subsystem detect stream error *
NI_RETCODE_NVME_SC_VPU_RSRC_INSUFFICIENT0x3FE* FW subsystem insufficient resource *
NI_RETCODE_NVME_SC_VPU_GENERAL_ERROR0x3FF* FW subsystem error occurred *