AMD ROCm Decode API#
|
Rocprofiler SDK Developer API 0.6.0
ROCm Profiling API and tools
|
AMD The rocDecode is a toolkit to decode videos and images using a hardware-accelerated video decoder on AMD’s GPUs. More...
Data Structures | |
| struct | RocdecDecodeCaps |
| This structure is used in rocDecGetDecoderCaps API. More... | |
| struct | RocDecoderCreateInfo |
| This structure is used in rocDecCreateDecoder API. More... | |
| struct | RocdecDecodeStatus |
| Struct for reporting decode status. This structure is used in RocdecGetDecodeStatus API. More... | |
| struct | RocdecReconfigureDecoderInfo |
| Struct for decoder reset This structure is used in rocDecReconfigureDecoder() API. More... | |
| struct | RocdecAvcPicture |
| AVC/H.264 Picture Entry This structure is used in RocdecAvcPicParams structure. More... | |
| struct | RocdecHevcPicture |
| HEVC Picture Entry This structure is used in RocdecHevcPicParams structure. More... | |
| struct | RocdecJPEGPicParams |
| JPEG picture parameters This structure is used in RocdecPicParams structure. More... | |
| struct | RocdecMpeg2QMatrix |
| MPEG2 QMatrix This structure is used in _RocdecMpeg2PicParams structure. More... | |
| struct | RocdecMpeg2PicParams |
| MPEG2 picture parameters This structure is used in RocdecMpeg2PicParams structure. More... | |
| struct | RocdecVc1PicParams |
| JPEG picture parameters This structure is used in RocdecVc1PicParams structure. More... | |
| struct | RocdecAvcPicParams |
| AVC picture parameters This structure is used in RocdecAvcPicParams structure This structure is configured to be the same as VA-API VAPictureParameterBufferH264 structure. More... | |
| struct | RocdecAvcSliceParams |
| AVC slice parameter buffer This structure is configured to be the same as VA-API VASliceParameterBufferH264 structure. More... | |
| struct | RocdecAvcIQMatrix |
| AVC Inverse Quantization Matrix This structure is configured to be the same as VA-API VAIQMatrixBufferH264 structure. More... | |
| struct | RocdecHevcPicParams |
| HEVC picture parameters This structure is used in RocdecHevcPicParams structure. More... | |
| struct | RocdecHevcSliceParams |
| HEVC slice parameters This structure is used in RocdecPicParams structure. More... | |
| struct | RocdecHevcIQMatrix |
| HEVC IQMatrix This structure is sent once per frame, and only when scaling_list_enabled_flag = 1. When sps_scaling_list_data_present_flag = 0, app still needs to send in this structure with default matrix values. This structure is used in RocdecHevcQMatrix structure. More... | |
| struct | RocdecVp9PicParams |
| VP9 picture parameters This structure is configured to be the same as VA-API VADecPictureParameterBufferVP9 structure. More... | |
| struct | RocdecVp9SliceParams |
| VP9 slice parameter buffer This structure is configured to be the same as VA-API VASliceParameterBufferVP9 structure. More... | |
| struct | RocdecAv1PicParams |
| AV1 picture parameters This structure is used in RocdecAv1PicParams structure. More... | |
| struct | RocdecAv1SliceParams |
| AV1 slice parameter buffer This structure is configured to be the same as VA-API VASliceParameterBufferAV1 structure. This structure conveys parameters related to bit stream data and should be sent once per tile. It uses the name RocdecAv1SliceParams to be consistent with other codec, but actually means RocdecTileParameterAV1. Slice data buffer of VASliceDataBufferType is used to send the bitstream. More... | |
| struct | _RocdecPicParams |
| Picture parameters for decoding This structure is used in rocDecDecodePicture API IN for rocDecDecodePicture. More... | |
| struct | RocdecProcParams |
| Picture parameters for postprocessing This structure is used in rocDecGetVideoFrame API. More... | |
| struct | RocDecoderCreateInfo.display_rect |
| struct | RocDecoderCreateInfo.target_rect |
| struct | RocdecReconfigureDecoderInfo.display_rect |
| struct | RocdecReconfigureDecoderInfo.target_rect |
| union | RocdecMpeg2PicParams.picture_coding_extension |
| struct | RocdecMpeg2PicParams.picture_coding_extension.bits |
| union | RocdecAvcPicParams.seq_fields |
| struct | RocdecAvcPicParams.seq_fields.bits |
| union | RocdecAvcPicParams.pic_fields |
| struct | RocdecAvcPicParams.pic_fields.bits |
| union | RocdecHevcPicParams.pic_fields |
| struct | RocdecHevcPicParams.pic_fields.bits |
| union | RocdecHevcPicParams.slice_parsing_fields |
| struct | RocdecHevcPicParams.slice_parsing_fields.bits |
| union | RocdecHevcSliceParams.long_slice_flags |
| struct | RocdecHevcSliceParams.long_slice_flags.fields |
| union | RocdecVp9PicParams.pic_fields |
| struct | RocdecVp9PicParams.pic_fields.bits |
| union | RocdecAv1PicParams.seq_info_fields |
| struct | RocdecAv1PicParams.seq_info_fields.fields |
| union | RocdecAv1PicParams.pic_info_fields |
| struct | RocdecAv1PicParams.pic_info_fields.bits |
| flags for current picture same syntax and semantic as those in AV1 code More... | |
| union | RocdecAv1PicParams.loop_filter_info_fields |
| struct | RocdecAv1PicParams.loop_filter_info_fields.bits |
| union | RocdecAv1PicParams.qmatrix_fields |
| quantization_matrix More... | |
| struct | RocdecAv1PicParams.qmatrix_fields.bits |
| union | RocdecAv1PicParams.mode_control_fields |
| struct | RocdecAv1PicParams.mode_control_fields.bits |
| union | RocdecAv1PicParams.loop_restoration_fields |
| loop restoration parameters More... | |
| struct | RocdecAv1PicParams.loop_restoration_fields.bits |
Variables | |
| int | RocdecHevcPicture::poc |
| picture order count. ! in HEVC, POCs for top and bottom fields of same picture should take different values. | |
Detailed Description
AMD The rocDecode is a toolkit to decode videos and images using a hardware-accelerated video decoder on AMD’s GPUs.
Data Structure Documentation
◆ RocdecDecodeCaps
| struct RocdecDecodeCaps |
This structure is used in rocDecGetDecoderCaps API.
Definition at line 181 of file rocdecode.h.
Collaboration diagram for RocdecDecodeCaps:| Data Fields | ||
|---|---|---|
| uint32_t | bit_depth_minus_8 |
IN: The Value "BitDepth minus 8" |
| rocDecVideoChromaFormat | chroma_format |
IN: rocDecVideoChromaFormat_XXX |
| rocDecVideoCodec | codec_type |
IN: rocDecVideoCodec_XXX |
| uint8_t | device_id |
IN: the device id for which query the decode capability 0 for the first device, 1 for the second device on the system, etc. |
| uint8_t | is_supported |
OUT: 1 if codec supported, 0 if not supported |
| uint32_t | max_height |
OUT: Max supported coded height in pixels |
| uint32_t | max_width |
OUT: Max supported coded width in pixels |
| uint16_t | min_height |
OUT: Min supported coded height in pixels |
| uint16_t | min_width |
OUT: Min supported coded width in pixels |
| uint8_t | num_decoders |
OUT: Number of Decoders that can support IN params |
| uint16_t | output_format_mask |
OUT: each bit represents corresponding rocDecVideoSurfaceFormat enum |
| uint32_t | reserved_1[3] |
Reserved for future use - set to zero |
| uint32_t | reserved_2[6] |
Reserved for future use - set to zero |
◆ RocDecoderCreateInfo
| struct RocDecoderCreateInfo |
This structure is used in rocDecCreateDecoder API.
Definition at line 205 of file rocdecode.h.
Collaboration diagram for RocDecoderCreateInfo:| Data Fields | ||
|---|---|---|
| uint32_t | bit_depth_minus_8 |
IN: The value "BitDepth minus 8" |
| rocDecVideoChromaFormat | chroma_format |
IN: rocDecVideoChromaFormat_XXX |
| rocDecVideoCodec | codec_type |
IN: rocDecVideoCodec_XXX |
| uint8_t | device_id |
IN: the device id for which a decoder should be created 0 for the first device, 1 for the second device on the system, etc. |
| struct RocDecoderCreateInfo.display_rect | display_rect |
IN: area of the frame that should be displayed |
| uint32_t | height |
IN: Coded sequence height in pixels |
| uint32_t | intra_decode_only |
IN: Set 1 only if video has all intra frames (default value is 0). This will optimize video memory for Intra frames only decoding. The support is limited to specific codecs - AVC/H264, HEVC, VP9, the flag will be ignored for codecs which are not supported. However decoding might fail if the flag is enabled in case of supported codecs for regular bit streams having P and/or B frames. |
| uint32_t | max_height |
IN: Coded sequence max height in pixels used with reconfigure Decoder |
| uint32_t | max_width |
IN: Coded sequence max width in pixels used with reconfigure Decoder |
| uint32_t | num_decode_surfaces |
IN: Maximum number of internal decode surfaces |
| uint32_t | num_output_surfaces |
IN: Maximum number of output surfaces simultaneously mapped |
| rocDecVideoSurfaceFormat | output_format |
IN: rocDecVideoSurfaceFormat_XXX |
| uint32_t | reserved_2[4] |
Reserved for future use - set to zero |
| uint32_t | target_height |
IN: Post-processed output height (Should be aligned to 2) |
| struct RocDecoderCreateInfo.target_rect | target_rect |
IN: (for future use) target rectangle in the output frame (for aspect ratio conversion) if a null rectangle is specified, {0,0,target_width,target_height} will be used |
| uint32_t | target_width |
IN: Post-processed output width (Should be aligned to 2) |
| uint32_t | width |
IN: Coded sequence width in pixels |
◆ RocdecDecodeStatus
| struct RocdecDecodeStatus |
Struct for reporting decode status. This structure is used in RocdecGetDecodeStatus API.
Definition at line 256 of file rocdecode.h.
Collaboration diagram for RocdecDecodeStatus:| Data Fields | ||
|---|---|---|
| rocDecDecodeStatus | decode_status | |
| void * | p_reserved[8] | |
| uint32_t | reserved[31] | |
◆ RocdecReconfigureDecoderInfo
| struct RocdecReconfigureDecoderInfo |
Struct for decoder reset This structure is used in rocDecReconfigureDecoder() API.
Definition at line 269 of file rocdecode.h.
Collaboration diagram for RocdecReconfigureDecoderInfo:| Data Fields | ||
|---|---|---|
| struct RocdecReconfigureDecoderInfo.display_rect | display_rect |
IN: area of the frame that should be displayed |
| uint32_t | height |
IN: Coded sequence height in pixels, MUST be < = max_height defined at RocDecoderCreateInfo |
| uint32_t | num_decode_surfaces |
IN: Maximum number of internal decode surfaces |
| uint32_t | reserved_1[12] |
Reserved for future use. Set to Zero |
| uint32_t | reserved_2[11] |
Reserved for future use. Set to Zero |
| uint32_t | target_height |
IN: Post Processed output height |
| struct RocdecReconfigureDecoderInfo.target_rect | target_rect |
IN: (for future use) target rectangle in the output frame (for aspect ratio conversion) if a null rectangle is specified, {0,0,target_width,target_height} will be used |
| uint32_t | target_width |
IN: Post processed output width |
| uint32_t | width |
IN: Coded sequence width in pixels, MUST be < = max_width defined at RocDecoderCreateInfo |
◆ RocdecAvcPicture
| struct RocdecAvcPicture |
AVC/H.264 Picture Entry This structure is used in RocdecAvcPicParams structure.
Definition at line 305 of file rocdecode.h.
Collaboration diagram for RocdecAvcPicture:◆ RocdecHevcPicture
| struct RocdecHevcPicture |
HEVC Picture Entry This structure is used in RocdecHevcPicParams structure.
Definition at line 329 of file rocdecode.h.
Collaboration diagram for RocdecHevcPicture:◆ RocdecJPEGPicParams
| struct RocdecJPEGPicParams |
JPEG picture parameters This structure is used in RocdecPicParams structure.
Definition at line 387 of file rocdecode.h.
Collaboration diagram for RocdecJPEGPicParams:| Data Fields | ||
|---|---|---|
| int | reserved | |
◆ RocdecMpeg2QMatrix
| struct RocdecMpeg2QMatrix |
MPEG2 QMatrix This structure is used in _RocdecMpeg2PicParams structure.
Definition at line 398 of file rocdecode.h.
Collaboration diagram for RocdecMpeg2QMatrix:◆ RocdecMpeg2PicParams
| struct RocdecMpeg2PicParams |
MPEG2 picture parameters This structure is used in RocdecMpeg2PicParams structure.
Definition at line 416 of file rocdecode.h.
Collaboration diagram for RocdecMpeg2PicParams:| Data Fields | ||
|---|---|---|
| uint32_t | backward_reference_picture | |
| int32_t | f_code | |
| uint32_t | forward_reference_pic | |
| uint16_t | horizontal_size | |
| union RocdecMpeg2PicParams.picture_coding_extension | picture_coding_extension | |
| int32_t | picture_coding_type | |
| RocdecMpeg2QMatrix | q_matrix | |
| uint32_t | reserved[4] | |
| uint16_t | vertical_size | |
◆ RocdecVc1PicParams
| struct RocdecVc1PicParams |
JPEG picture parameters This structure is used in RocdecVc1PicParams structure.
Definition at line 455 of file rocdecode.h.
Collaboration diagram for RocdecVc1PicParams:| Data Fields | ||
|---|---|---|
| int | reserved | |
◆ RocdecAvcPicParams
| struct RocdecAvcPicParams |
AVC picture parameters This structure is used in RocdecAvcPicParams structure This structure is configured to be the same as VA-API VAPictureParameterBufferH264 structure.
Definition at line 467 of file rocdecode.h.
Collaboration diagram for RocdecAvcPicParams:| Data Fields | ||
|---|---|---|
| uint8_t | bit_depth_chroma_minus8 | |
| uint8_t | bit_depth_luma_minus8 | |
| int8_t | chroma_qp_index_offset | |
| RocdecAvcPicture | curr_pic | |
| uint16_t | frame_num | |
| uint8_t | num_ref_frames | |
| uint8_t | num_slice_groups_minus1 | |
| union RocdecAvcPicParams.pic_fields | pic_fields | |
| int8_t | pic_init_qp_minus26 | |
| int8_t | pic_init_qs_minus26 | |
| uint16_t | picture_height_in_mbs_minus1 | |
| uint16_t | picture_width_in_mbs_minus1 | |
| RocdecAvcPicture | ref_frames[16] | |
| uint32_t | reserved[8] | |
| int8_t | second_chroma_qp_index_offset | |
| union RocdecAvcPicParams.seq_fields | seq_fields | |
| uint16_t | slice_group_change_rate_minus1 | |
| uint8_t | slice_group_map_type | |
◆ RocdecAvcSliceParams
| struct RocdecAvcSliceParams |
AVC slice parameter buffer This structure is configured to be the same as VA-API VASliceParameterBufferH264 structure.
Definition at line 531 of file rocdecode.h.
Collaboration diagram for RocdecAvcSliceParams:| Data Fields | ||
|---|---|---|
| uint8_t | cabac_init_idc | |
| uint8_t | chroma_log2_weight_denom | |
| int16_t | chroma_offset_l0[32][2] | |
| int16_t | chroma_offset_l1[32][2] | |
| int16_t | chroma_weight_l0[32][2] | |
| uint8_t | chroma_weight_l0_flag | |
| int16_t | chroma_weight_l1[32][2] | |
| uint8_t | chroma_weight_l1_flag | |
| uint8_t | direct_spatial_mv_pred_flag | |
| uint8_t | disable_deblocking_filter_idc | |
| uint16_t | first_mb_in_slice | |
| uint8_t | luma_log2_weight_denom | |
| int16_t | luma_offset_l0[32] | |
| int16_t | luma_offset_l1[32] | |
| int16_t | luma_weight_l0[32] | |
| uint8_t | luma_weight_l0_flag | |
| int16_t | luma_weight_l1[32] | |
| uint8_t | luma_weight_l1_flag | |
| uint8_t | num_ref_idx_l0_active_minus1 | |
| uint8_t | num_ref_idx_l1_active_minus1 | |
| RocdecAvcPicture | ref_pic_list_0[32] | |
| RocdecAvcPicture | ref_pic_list_1[32] | |
| uint32_t | reserved[4] | |
| int8_t | slice_alpha_c0_offset_div2 | |
| int8_t | slice_beta_offset_div2 | |
| uint16_t | slice_data_bit_offset |
Bit offset from NAL Header Unit to the begining of slice_data(). This bit offset is relative to and includes the NAL unit byte and represents the number of bits parsed in the slice_header() after the removal of any emulation prevention bytes in there. However, the slice data buffer passed to the hardware is the original bitstream, thus including any emulation prevention bytes. |
| uint32_t | slice_data_flag | |
| uint32_t | slice_data_offset | |
| uint32_t | slice_data_size | |
| int8_t | slice_qp_delta | |
| uint8_t | slice_type | |
◆ RocdecAvcIQMatrix
| struct RocdecAvcIQMatrix |
AVC Inverse Quantization Matrix This structure is configured to be the same as VA-API VAIQMatrixBufferH264 structure.
Definition at line 582 of file rocdecode.h.
Collaboration diagram for RocdecAvcIQMatrix:◆ RocdecHevcPicParams
| struct RocdecHevcPicParams |
HEVC picture parameters This structure is used in RocdecHevcPicParams structure.
Definition at line 598 of file rocdecode.h.
Collaboration diagram for RocdecHevcPicParams:| Data Fields | ||
|---|---|---|
| uint8_t | bit_depth_chroma_minus8 | |
| uint8_t | bit_depth_luma_minus8 | |
| uint16_t | column_width_minus1[19] |
when uniform_spacing_flag equals 1, application should populate column_width_minus[], and row_height_minus1[] with approperiate values. |
| RocdecHevcPicture | curr_pic | |
| uint8_t | diff_cu_qp_delta_depth | |
| int8_t | init_qp_minus26 | |
| uint8_t | log2_diff_max_min_luma_coding_block_size | |
| uint8_t | log2_diff_max_min_pcm_luma_coding_block_size | |
| uint8_t | log2_diff_max_min_transform_block_size | |
| uint8_t | log2_max_pic_order_cnt_lsb_minus4 |
following parameters have same syntax with those in HEVC spec |
| uint8_t | log2_min_luma_coding_block_size_minus3 | |
| uint8_t | log2_min_pcm_luma_coding_block_size_minus3 | |
| uint8_t | log2_min_transform_block_size_minus2 | |
| uint8_t | log2_parallel_merge_level_minus2 | |
| uint8_t | max_transform_hierarchy_depth_inter | |
| uint8_t | max_transform_hierarchy_depth_intra | |
| uint8_t | num_extra_slice_header_bits | |
| uint8_t | num_long_term_ref_pic_sps | |
| uint8_t | num_ref_idx_l0_default_active_minus1 | |
| uint8_t | num_ref_idx_l1_default_active_minus1 | |
| uint8_t | num_short_term_ref_pic_sets | |
| uint8_t | num_tile_columns_minus1 | |
| uint8_t | num_tile_rows_minus1 | |
| uint8_t | pcm_sample_bit_depth_chroma_minus1 | |
| uint8_t | pcm_sample_bit_depth_luma_minus1 | |
| union RocdecHevcPicParams.pic_fields | pic_fields | |
| uint16_t | picture_height_in_luma_samples | |
| uint16_t | picture_width_in_luma_samples | |
| int8_t | pps_beta_offset_div2 | |
| int8_t | pps_cb_qp_offset | |
| int8_t | pps_cr_qp_offset | |
| int8_t | pps_tc_offset_div2 | |
| RocdecHevcPicture | ref_frames[15] | |
| uint32_t | reserved[8] | |
| uint16_t | row_height_minus1[21] | |
| union RocdecHevcPicParams.slice_parsing_fields | slice_parsing_fields | |
| uint8_t | sps_max_dec_pic_buffering_minus1 |
SPS fields: the following parameters have same syntax with those in HEVC spec IN: DPB size for current temporal layer |
| uint32_t | st_rps_bits | number of bits that structure short_term_ref_pic_set( num_short_term_ref_pic_sets ) takes in slice segment header when short_term_ref_pic_set_sps_flag equals 0. if short_term_ref_pic_set_sps_flag equals 1, the value should be 0. the bit count is calculated after emulation prevention bytes are removed from bit streams. This variable is used for accelorater to skip parsing the short_term_ref_pic_set( num_short_term_ref_pic_sets ) structure. |
◆ RocdecHevcSliceParams
| struct RocdecHevcSliceParams |
HEVC slice parameters This structure is used in RocdecPicParams structure.
Definition at line 722 of file rocdecode.h.
Collaboration diagram for RocdecHevcSliceParams:| Data Fields | ||
|---|---|---|
| int8_t | chroma_offset_l0[15][2] |
corresponds to HEVC spec variable of the same name. |
| int8_t | chroma_offset_l1[15][2] |
corresponds to HEVC spec variable of the same name. |
| uint8_t | collocated_ref_idx |
HEVC syntax element. |
| int8_t | delta_chroma_log2_weight_denom | |
| int8_t | delta_chroma_weight_l0[15][2] | |
| int8_t | delta_chroma_weight_l1[15][2] | |
| int8_t | delta_luma_weight_l0[15] | |
| int8_t | delta_luma_weight_l1[15] |
HEVC syntax element. |
| uint16_t | entry_offset_to_subset_array | |
| uint8_t | five_minus_max_num_merge_cand |
HEVC syntax element. |
| union RocdecHevcSliceParams.long_slice_flags | long_slice_flags | |
| uint8_t | luma_log2_weight_denom | |
| int8_t | luma_offset_l0[15] | |
| int8_t | luma_offset_l1[15] | |
| uint16_t | num_entry_point_offsets | |
| uint8_t | num_ref_idx_l0_active_minus1 | |
| uint8_t | num_ref_idx_l1_active_minus1 | |
| uint8_t | ref_pic_list[2][15] | index into ReferenceFrames[] ref_pic_list[0][] corresponds to RefPicList0[] of HEVC variable. ref_pic_list[1][] corresponds to RefPicList1[] of HEVC variable. value range [0..14, 0xFF], where 0xFF indicates invalid entry. |
| uint32_t | reserved[2] | |
| int8_t | slice_beta_offset_div2 | |
| int8_t | slice_cb_qp_offset | |
| int8_t | slice_cr_qp_offset | |
| uint32_t | slice_data_byte_offset |
Byte offset from NAL unit header to the begining of slice_data(). This byte offset is relative to and includes the NAL unit header and represents the number of bytes parsed in the slice_header() after the removal of any emulation prevention bytes in there. However, the slice data buffer passed to the hardware is the original bitstream, thus including any emulation prevention bytes. |
| uint32_t | slice_data_flag |
Slice data buffer flags. See VA_SLICE_DATA_FLAG_XXX. |
| uint16_t | slice_data_num_emu_prevn_bytes | Number of emulation prevention bytes in slice header. |
| uint32_t | slice_data_offset | The offset to the NAL unit header for this slice. |
| uint32_t | slice_data_size | Number of bytes in the slice data buffer for this slice counting from and including NAL unit header. |
| int8_t | slice_qp_delta | |
| uint32_t | slice_segment_address |
HEVC syntax element. |
| int8_t | slice_tc_offset_div2 | |
◆ RocdecHevcIQMatrix
| struct RocdecHevcIQMatrix |
HEVC IQMatrix This structure is sent once per frame, and only when scaling_list_enabled_flag = 1. When sps_scaling_list_data_present_flag = 0, app still needs to send in this structure with default matrix values. This structure is used in RocdecHevcQMatrix structure.
Definition at line 816 of file rocdecode.h.
Collaboration diagram for RocdecHevcIQMatrix:◆ RocdecVp9PicParams
| struct RocdecVp9PicParams |
VP9 picture parameters This structure is configured to be the same as VA-API VADecPictureParameterBufferVP9 structure.
Definition at line 865 of file rocdecode.h.
Collaboration diagram for RocdecVp9PicParams:| Data Fields | ||
|---|---|---|
| uint8_t | bit_depth | VP9 bit depth per sample same for both luma and chroma samples. |
| uint8_t | filter_level | |
| uint16_t | first_partition_size | The byte count of compressed header the bitstream buffer, which corresponds to syntax first_partition_size in code. |
| uint8_t | frame_header_length_in_bytes | Number of bytes taken up by the uncompressed frame header, which corresponds to byte length of function read_uncompressed_header() in VP9 code. Specifically, it is the byte count from bit stream buffer start to the last byte of uncompressed frame header. If there are other meta data in the buffer before uncompressed header, its size should be also included here. |
| uint16_t | frame_height | picture height Picture original resolution. The value may not be multiple of 8. |
| uint16_t | frame_width | picture width Picture original resolution. The value may not be multiple of 8. |
| uint8_t | log2_tile_columns | number of tile columns specified by (1 << log2_tile_columns). It corresponds the variable with same name in VP9 code. |
| uint8_t | log2_tile_rows | number of tile rows specified by (1 << log2_tile_rows). It corresponds the variable with same name in VP9 code. |
| uint8_t | mb_segment_tree_probs[7] |
These values are segment probabilities with same names in VP9 function setup_segmentation(). They should be parsed directly from bitstream by application. |
| union RocdecVp9PicParams.pic_fields | pic_fields | |
| uint8_t | profile | VP9 Profile definition value range [0..3]. |
| uint32_t | reference_frames[8] |
Surface indices of reference frames in DPB. Each entry of the list specifies the surface index of the picture that is referred by current picture or will be referred by any future picture. Application who calls this API should update this list based on the refreshing information from VP9 bitstream. |
| uint8_t | segment_pred_probs[3] | |
| uint8_t | sharpness_level | |
| uint32_t | va_reserved[8] | Reserved bytes for future use, must be zero. |
◆ RocdecVp9SliceParams
| struct RocdecVp9SliceParams |
VP9 slice parameter buffer This structure is configured to be the same as VA-API VASliceParameterBufferVP9 structure.
Definition at line 1075 of file rocdecode.h.
Collaboration diagram for RocdecVp9SliceParams:| Data Fields | ||
|---|---|---|
| RocdecVp9SegmentParameter | seg_param[8] | per segment information |
| uint32_t | slice_data_flag |
see VA_SLICE_DATA_FLAG_XXX definitions |
| uint32_t | slice_data_offset |
offset to the first byte of partition data (control partition) |
| uint32_t | slice_data_size | The byte count of current frame in the bitstream buffer, starting from first byte of the buffer. It uses the name slice_data_size to be consitent with other codec, but actually means frame_data_size. |
| uint32_t | va_reserved[4] | Reserved bytes for future use, must be zero. |
◆ RocdecAv1PicParams
| struct RocdecAv1PicParams |
AV1 picture parameters This structure is used in RocdecAv1PicParams structure.
Definition at line 1270 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams:| Data Fields | ||
|---|---|---|
| int * | anchor_frames_list | anchor frame list for large scale tile For large scale tile applications, the anchor frames could come from previously decoded frames in current sequence (aka. internal), or from external sources. For external anchor frames, application should call API vaCreateBuffer() to generate frame buffers and populate them with pixel frames. And this process may happen multiple times. The array anchor_frames_list[] is used to register all the available anchor frames from both external and internal, up to the current frame instance. If a previously registerred anchor frame is no longer needed, it should be removed from the list. But it does not prevent applications from relacing the frame buffer with new anchor frames. Please note that the internal anchor frames may not still be present in the current DPB buffer. But if it is in the anchor_frames_list[], it should not be replaced with other frames or removed from memory until it is not shown in the list. This number of entries of the list is given by parameter anchor_frames_num. |
| uint8_t | anchor_frames_num | number of anchor frames for large scale tile This parameter gives the number of entries of anchor_frames_list[]. Value range [0..128]. |
| uint8_t | base_qindex |
quantization Y AC index value range [0..255] |
| uint8_t | bit_depth_idx | bit depth index value range [0..2] 0 - bit depth 8; 1 - bit depth 10; 2 - bit depth 12; |
| uint8_t | cdef_bits | |
| uint8_t | cdef_damping_minus_3 | CDEF parameters. |
| uint8_t | cdef_uv_strengths[8] | |
| uint8_t | cdef_y_strengths[8] |
Encode cdef strength: The cdef_y_strengths[] and cdef_uv_strengths[] are expected to be packed with both primary and secondary strength. The secondary strength is given in the lower two bits and the primary strength is given in the next four bits. cdef_y_strengths[] & cdef_uv_strengths[] should be derived as: (cdef_y_strengths[]) = (cdef_y_pri_strength[] << 2) | (cdef_y_sec_strength[] & 0x03) (cdef_uv_strengths[]) = (cdef_uv_pri_strength[] << 2) | (cdef_uv_sec_strength[] & 0x03) In which, cdef_y_pri_strength[]/cdef_y_sec_strength[]/cdef_uv_pri_strength[]/cdef_uv_sec_strength[] are variables defined in AV1 Spec 5.9.19. The cdef_y_strengths[] & cdef_uv_strengths[] are corresponding to LIBAOM variables cm->cdef_strengths[] & cm->cdef_uv_strengths[] respectively. |
| uint16_t | context_update_tile_id | |
| int | current_display_picture | display buffer of current picture Used for film grain applied decoded picture. Valid only when apply_grain equals 1. |
| int | current_frame |
Picture level information. buffer description of decoded current picture |
| RocdecAv1FilmGrainStruct | film_grain_info | |
| uint8_t | filter_level[2] | luma loop filter levels. value range [0..63]. |
| uint8_t | filter_level_u | chroma loop filter levels. value range [0..63]. |
| uint8_t | filter_level_v | |
| uint16_t | frame_height_minus1 | |
| uint16_t | frame_width_minus1 | Picture resolution minus 1 Picture original resolution. If SuperRes is enabled, this is the upscaled resolution. value range [0..65535]. |
| uint16_t | height_in_sbs_minus_1[63] | |
| uint8_t | interp_filter | Interpolation filter. value range [0..4]. |
| union RocdecAv1PicParams.loop_filter_info_fields | loop_filter_info_fields | |
| union RocdecAv1PicParams.loop_restoration_fields | loop_restoration_fields | loop restoration parameters |
| uint8_t | matrix_coefficients | corresponds to AV1 spec variable of the same name. |
| union RocdecAv1PicParams.mode_control_fields | mode_control_fields | |
| int8_t | mode_deltas[2] | The adjustment needed for the filter level based on the chosen mode. value range [-64..63]. |
| uint8_t | order_hint | |
| uint8_t | order_hint_bits_minus_1 | |
| uint16_t | output_frame_height_in_tiles_minus_1 | |
| uint16_t | output_frame_width_in_tiles_minus_1 | Output frame buffer size in unit of tiles Valid only when large_scale_tile equals 1. value range [0..65535]. |
| union RocdecAv1PicParams.pic_info_fields | pic_info_fields | |
| uint8_t | primary_ref_frame | primary reference frame index Index into ref_frame_idx[], specifying which reference frame contains propagated info that should be loaded at the start of the frame. When value equals PRIMARY_REF_NONE (7), it indicates there is no primary reference frame. value range [0..7] |
| uint8_t | profile |
sequence level information AV1 bit stream profile |
| union RocdecAv1PicParams.qmatrix_fields | qmatrix_fields | quantization_matrix |
| int8_t | ref_deltas[8] | The adjustment needed for the filter level based on the chosen reference frame. value range [-64..63]. |
| uint8_t | ref_frame_idx[7] |
Reference frame indices. Contains a list of indices into ref_frame_map[8]. It specifies the reference frame correspondence. The indices of the array are defined as [LAST_FRAME – LAST_FRAME, LAST2_FRAME – LAST_FRAME, …, ALTREF_FRAME – LAST_FRAME], where each symbol is defined as: enum{INTRA_FRAME = 0, LAST_FRAME, LAST2_FRAME, LAST3_FRAME, GOLDEN_FRAME, BWDREF_FRAME, ALTREF2_FRAME, ALTREF_FRAME}; |
| int | ref_frame_map[8] |
Surface indices of reference frames in DPB. Contains a list of uncompressed frame buffer surface indices as references. Application needs to make sure all the entries point to valid frames except for intra frames by checking ref_frame_id[]. If missing frame is identified, application may choose to perform error recovery by pointing problematic index to an alternative frame buffer. Driver is not responsible to validate reference frames' id. |
| uint32_t | reserved[8] | Reserved bytes for future use, must be zero. |
| RocdecAv1SegmentationStruct | seg_info | |
| union RocdecAv1PicParams.seq_info_fields | seq_info_fields | |
| uint8_t | superres_scale_denominator | Supper resolution scale denominator. When use_superres=1, superres_scale_denominator must be in the range [9..16]. When use_superres=0, superres_scale_denominator must be 8. |
| uint8_t | tile_cols | tile structure When uniform_tile_spacing_flag == 1, width_in_sbs_minus_1[] and height_in_sbs_minus_1[] should be ignored, which will be generated by driver based on tile_cols and tile_rows. |
| uint16_t | tile_count_minus_1 | number of tiles minus 1 in large scale tile list Same as AV1 semantic element. Valid only when large_scale_tiles == 1. |
| uint8_t | tile_rows | |
| int8_t | u_ac_delta_q | U AC delta from Y AC value range [-64..63]. |
| int8_t | u_dc_delta_q | U DC delta from Y AC value range [-64..63]. |
| int8_t | v_ac_delta_q | V AC delta from Y AC value range [-64..63]. |
| int8_t | v_dc_delta_q | V DC delta from Y AC value range [-64..63]. |
| uint16_t | width_in_sbs_minus_1[63] | |
| RocdecAv1WarpedMotionParams | wm[7] | global motion |
| int8_t | y_dc_delta_q | Y DC delta from Y AC value range [-64..63]. |
◆ RocdecAv1SliceParams
| struct RocdecAv1SliceParams |
AV1 slice parameter buffer This structure is configured to be the same as VA-API VASliceParameterBufferAV1 structure. This structure conveys parameters related to bit stream data and should be sent once per tile. It uses the name RocdecAv1SliceParams to be consistent with other codec, but actually means RocdecTileParameterAV1. Slice data buffer of VASliceDataBufferType is used to send the bitstream.
Definition at line 1678 of file rocdecode.h.
Collaboration diagram for RocdecAv1SliceParams:◆ _RocdecPicParams
| struct _RocdecPicParams |
Picture parameters for decoding This structure is used in rocDecDecodePicture API IN for rocDecDecodePicture.
Collaboration diagram for _RocdecPicParams:◆ RocdecProcParams
| struct RocdecProcParams |
Picture parameters for postprocessing This structure is used in rocDecGetVideoFrame API.
Definition at line 1780 of file rocdecode.h.
Collaboration diagram for RocdecProcParams:◆ RocDecoderCreateInfo.display_rect
| struct RocDecoderCreateInfo.display_rect |
Definition at line 225 of file rocdecode.h.
Collaboration diagram for RocDecoderCreateInfo.display_rect:| Data Fields | ||
|---|---|---|
| int16_t | bottom | |
| int16_t | left | |
| int16_t | right | |
| int16_t | top | |
◆ RocDecoderCreateInfo.target_rect
| struct RocDecoderCreateInfo.target_rect |
Definition at line 237 of file rocdecode.h.
Collaboration diagram for RocDecoderCreateInfo.target_rect:| Data Fields | ||
|---|---|---|
| int16_t | bottom | |
| int16_t | left | |
| int16_t | right | |
| int16_t | top | |
◆ RocdecReconfigureDecoderInfo.display_rect
| struct RocdecReconfigureDecoderInfo.display_rect |
Definition at line 279 of file rocdecode.h.
Collaboration diagram for RocdecReconfigureDecoderInfo.display_rect:| Data Fields | ||
|---|---|---|
| int16_t | bottom | |
| int16_t | left | |
| int16_t | right | |
| int16_t | top | |
◆ RocdecReconfigureDecoderInfo.target_rect
| struct RocdecReconfigureDecoderInfo.target_rect |
Definition at line 286 of file rocdecode.h.
Collaboration diagram for RocdecReconfigureDecoderInfo.target_rect:| Data Fields | ||
|---|---|---|
| int16_t | bottom | |
| int16_t | left | |
| int16_t | right | |
| int16_t | top | |
◆ RocdecMpeg2PicParams.picture_coding_extension
| union RocdecMpeg2PicParams.picture_coding_extension |
Definition at line 425 of file rocdecode.h.
Collaboration diagram for RocdecMpeg2PicParams.picture_coding_extension:| Data Fields | ||
|---|---|---|
| struct RocdecMpeg2PicParams.picture_coding_extension.bits | bits | |
| uint32_t | value | |
◆ RocdecMpeg2PicParams.picture_coding_extension.bits
| struct RocdecMpeg2PicParams.picture_coding_extension.bits |
Definition at line 427 of file rocdecode.h.
Collaboration diagram for RocdecMpeg2PicParams.picture_coding_extension.bits:◆ RocdecAvcPicParams.seq_fields
| union RocdecAvcPicParams.seq_fields |
Definition at line 476 of file rocdecode.h.
Collaboration diagram for RocdecAvcPicParams.seq_fields:| Data Fields | ||
|---|---|---|
| struct RocdecAvcPicParams.seq_fields.bits | bits | |
| uint32_t | value | |
◆ RocdecAvcPicParams.seq_fields.bits
| struct RocdecAvcPicParams.seq_fields.bits |
Definition at line 478 of file rocdecode.h.
Collaboration diagram for RocdecAvcPicParams.seq_fields.bits:◆ RocdecAvcPicParams.pic_fields
| union RocdecAvcPicParams.pic_fields |
Definition at line 503 of file rocdecode.h.
Collaboration diagram for RocdecAvcPicParams.pic_fields:| Data Fields | ||
|---|---|---|
| struct RocdecAvcPicParams.pic_fields.bits | bits | |
| uint32_t | value | |
◆ RocdecAvcPicParams.pic_fields.bits
| struct RocdecAvcPicParams.pic_fields.bits |
Definition at line 505 of file rocdecode.h.
Collaboration diagram for RocdecAvcPicParams.pic_fields.bits:◆ RocdecHevcPicParams.pic_fields
| union RocdecHevcPicParams.pic_fields |
Definition at line 604 of file rocdecode.h.
Collaboration diagram for RocdecHevcPicParams.pic_fields:| Data Fields | ||
|---|---|---|
| struct RocdecHevcPicParams.pic_fields.bits | bits | |
| uint32_t | value | |
◆ RocdecHevcPicParams.pic_fields.bits
| struct RocdecHevcPicParams.pic_fields.bits |
Definition at line 606 of file rocdecode.h.
Collaboration diagram for RocdecHevcPicParams.pic_fields.bits:◆ RocdecHevcPicParams.slice_parsing_fields
| union RocdecHevcPicParams.slice_parsing_fields |
Definition at line 664 of file rocdecode.h.
Collaboration diagram for RocdecHevcPicParams.slice_parsing_fields:| Data Fields | ||
|---|---|---|
| struct RocdecHevcPicParams.slice_parsing_fields.bits | bits | |
| uint32_t | value | |
◆ RocdecHevcPicParams.slice_parsing_fields.bits
| struct RocdecHevcPicParams.slice_parsing_fields.bits |
Definition at line 666 of file rocdecode.h.
Collaboration diagram for RocdecHevcPicParams.slice_parsing_fields.bits:◆ RocdecHevcSliceParams.long_slice_flags
| union RocdecHevcSliceParams.long_slice_flags |
Definition at line 751 of file rocdecode.h.
Collaboration diagram for RocdecHevcSliceParams.long_slice_flags:| Data Fields | ||
|---|---|---|
| struct RocdecHevcSliceParams.long_slice_flags.fields | fields | |
| uint32_t | value | |
◆ RocdecHevcSliceParams.long_slice_flags.fields
| struct RocdecHevcSliceParams.long_slice_flags.fields |
Definition at line 754 of file rocdecode.h.
Collaboration diagram for RocdecHevcSliceParams.long_slice_flags.fields:◆ RocdecVp9PicParams.pic_fields
| union RocdecVp9PicParams.pic_fields |
Definition at line 886 of file rocdecode.h.
Collaboration diagram for RocdecVp9PicParams.pic_fields:| Data Fields | ||
|---|---|---|
| struct RocdecVp9PicParams.pic_fields.bits | bits | |
| uint32_t | value | |
◆ RocdecVp9PicParams.pic_fields.bits
| struct RocdecVp9PicParams.pic_fields.bits |
Definition at line 888 of file rocdecode.h.
Collaboration diagram for RocdecVp9PicParams.pic_fields.bits:◆ RocdecAv1PicParams.seq_info_fields
| union RocdecAv1PicParams.seq_info_fields |
Definition at line 1292 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams.seq_info_fields:| Data Fields | ||
|---|---|---|
| struct RocdecAv1PicParams.seq_info_fields.fields | fields | |
| uint32_t | value | |
◆ RocdecAv1PicParams.seq_info_fields.fields
| struct RocdecAv1PicParams.seq_info_fields.fields |
Definition at line 1294 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams.seq_info_fields.fields:◆ RocdecAv1PicParams.pic_info_fields
| union RocdecAv1PicParams.pic_info_fields |
Definition at line 1436 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams.pic_info_fields:| Data Fields | ||
|---|---|---|
| struct RocdecAv1PicParams.pic_info_fields.bits | bits | flags for current picture same syntax and semantic as those in AV1 code |
| uint32_t | value | |
◆ RocdecAv1PicParams.pic_info_fields.bits
| struct RocdecAv1PicParams.pic_info_fields.bits |
flags for current picture same syntax and semantic as those in AV1 code
Definition at line 1441 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams.pic_info_fields.bits:◆ RocdecAv1PicParams.loop_filter_info_fields
| union RocdecAv1PicParams.loop_filter_info_fields |
Definition at line 1499 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams.loop_filter_info_fields:| Data Fields | ||
|---|---|---|
| struct RocdecAv1PicParams.loop_filter_info_fields.bits | bits | |
| uint8_t | value | |
◆ RocdecAv1PicParams.loop_filter_info_fields.bits
| struct RocdecAv1PicParams.loop_filter_info_fields.bits |
Definition at line 1501 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams.loop_filter_info_fields.bits:◆ RocdecAv1PicParams.qmatrix_fields
| union RocdecAv1PicParams.qmatrix_fields |
quantization_matrix
Definition at line 1557 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams.qmatrix_fields:| Data Fields | ||
|---|---|---|
| struct RocdecAv1PicParams.qmatrix_fields.bits | bits | |
| uint16_t | value | |
◆ RocdecAv1PicParams.qmatrix_fields.bits
| struct RocdecAv1PicParams.qmatrix_fields.bits |
Definition at line 1559 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams.qmatrix_fields.bits:◆ RocdecAv1PicParams.mode_control_fields
| union RocdecAv1PicParams.mode_control_fields |
Definition at line 1576 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams.mode_control_fields:| Data Fields | ||
|---|---|---|
| struct RocdecAv1PicParams.mode_control_fields.bits | bits | |
| uint32_t | value | |
◆ RocdecAv1PicParams.mode_control_fields.bits
| struct RocdecAv1PicParams.mode_control_fields.bits |
Definition at line 1578 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams.mode_control_fields.bits:◆ RocdecAv1PicParams.loop_restoration_fields
| union RocdecAv1PicParams.loop_restoration_fields |
loop restoration parameters
Definition at line 1642 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams.loop_restoration_fields:| Data Fields | ||
|---|---|---|
| struct RocdecAv1PicParams.loop_restoration_fields.bits | bits | |
| uint16_t | value | |
◆ RocdecAv1PicParams.loop_restoration_fields.bits
| struct RocdecAv1PicParams.loop_restoration_fields.bits |
Definition at line 1644 of file rocdecode.h.
Collaboration diagram for RocdecAv1PicParams.loop_restoration_fields.bits:Variable Documentation
◆ poc
| int RocdecHevcPicture::poc |
picture order count. ! in HEVC, POCs for top and bottom fields of same picture should take different values.
Definition at line 337 of file rocdecode.h.
Generated by