/*
* Copyright (c) 2014 Intel Corporation. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sub license, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial portions
* of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
* IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
* ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/**
* \file va_dec_hevc.h
* \brief The HEVC decoding API
*
* This file contains the \ref api_dec_hevc "HEVC decoding API".
*/
#ifndef VA_DEC_HEVC_H
#define VA_DEC_HEVC_H
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* \defgroup api_dec_hevc HEVC decoding API
*
* This HEVC decoding API supports Main and Main Still Picture profiles.
* And it supports both short slice format and long slice format.
*
* @{
*/
/****************************
* HEVC data structures
****************************/
/**
* \brief Description of picture properties of those in DPB surfaces.
*
* If only progressive scan is supported, each surface contains one whole
* frame picture.
* Otherwise, each surface contains two fields of whole picture.
* In this case, two entries of ReferenceFrames[] may share same picture_id
* value.
*/
typedef struct _VAPictureHEVC
{
/** \brief reconstructed picture buffer surface index
* invalid when taking value VA_INVALID_SURFACE.
*/
VASurfaceID picture_id;
/** \brief picture order count.
* in HEVC, POCs for top and bottom fields of same picture should
* take different values.
*/
int32_t PicOrderCnt;
/* described below */
uint32_t flags;
} VAPictureHEVC;
/** flags in VAPictureHEVC could be OR of the following */
#define VA_PICTURE_HEVC_INVALID 0x00000001
/** \brief indication of interlace scan picture.
* should take same value for all the pictures in sequence.
*/
#define VA_PICTURE_HEVC_FIELD_PIC 0x00000002
/** \brief polarity of the field picture.
* top field takes even lines of buffer surface.
* bottom field takes odd lines of buffer surface.
*/
#define VA_PICTURE_HEVC_BOTTOM_FIELD 0x00000004
/** \brief Long term reference picture */
#define VA_PICTURE_HEVC_LONG_TERM_REFERENCE 0x00000008
/** \brief RefPicSetStCurrBefore of HEVC spec variable
* Number of ReferenceFrames[] entries with this bit set equals
* NumPocStCurrBefore.
*/
#define VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE 0x00000010
/** \brief RefPicSetStCurrAfter of HEVC spec variable
* Number of ReferenceFrames[] entries with this bit set equals
* NumPocStCurrAfter.
*/
#define VA_PICTURE_HEVC_RPS_ST_CURR_AFTER 0x00000020
/** \brief RefPicSetLtCurr of HEVC spec variable
* Number of ReferenceFrames[] entries with this bit set equals
* NumPocLtCurr.
*/
#define VA_PICTURE_HEVC_RPS_LT_CURR 0x00000040
/**
* VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE, VA_PICTURE_HEVC_RPS_ST_CURR_AFTER
* and VA_PICTURE_HEVC_RPS_LT_CURR of any picture in ReferenceFrames[] should
* be exclusive. No more than one of them can be set for any picture.
* Sum of NumPocStCurrBefore, NumPocStCurrAfter and NumPocLtCurr
* equals NumPocTotalCurr, which should be equal to or smaller than 8.
* Application should provide valid values for both short format and long format.
* The pictures in DPB with any of these three flags turned on are referred by
* the current picture.
*/
/**
* \brief HEVC Decoding Picture Parameter Buffer Structure
*
* This structure conveys picture level parameters and should be sent once
* per frame.
*
*/
typedef struct _VADecPictureParameterBufferHEVC
{
/** \brief buffer description of decoded current picture
* only VA_PICTURE_HEVC_FIELD_PIC and VA_PICTURE_HEVC_BOTTOM_FIELD
* of "flags" fields are meaningful.
*/
VAPictureHEVC CurrPic;
/** \brief buffer description of reference frames in DPB */
VAPictureHEVC ReferenceFrames[15];
/** \brief picture width, shall be integer multiple of minimum CB size. */
uint16_t pic_width_in_luma_samples;
/** \brief picture height, shall be integer multiple of minimum CB size. */
uint16_t pic_height_in_luma_samples;
union
{
struct
{
/** following flags have same syntax and semantic as those in HEVC spec */
uint32_t chroma_format_idc : 2;
uint32_t separate_colour_plane_flag : 1;
uint32_t pcm_enabled_flag : 1;
uint32_t scaling_list_enabled_flag : 1;
uint32_t transform_skip_enabled_flag : 1;
uint32_t amp_enabled_flag : 1;
uint32_t strong_intra_smoothing_enabled_flag : 1;
uint32_t sign_data_hiding_enabled_flag : 1;
uint32_t constrained_intra_pred_flag : 1;
uint32_t cu_qp_delta_enabled_flag : 1;
uint32_t weighted_pred_flag : 1;
uint32_t weighted_bipred_flag : 1;
uint32_t transquant_bypass_enabled_flag : 1;
uint32_t tiles_enabled_flag : 1;
uint32_t entropy_coding_sync_enabled_flag : 1;
uint32_t pps_loop_filter_across_slices_enabled_flag : 1;
uint32_t loop_filter_across_tiles_enabled_flag : 1;
uint32_t pcm_loop_filter_disabled_flag : 1;
/** set based on sps_max_num_reorder_pics of current temporal layer. */
uint32_t NoPicReorderingFlag : 1;
/** picture has no B slices */
uint32_t NoBiPredFlag : 1;
uint32_t ReservedBits : 11;
} bits;
uint32_t value;
} pic_fields;
/** following parameters have same syntax with those in HEVC spec */
/** \brief DPB size for current temporal layer */
uint8_t sps_max_dec_pic_buffering_minus1;
uint8_t bit_depth_luma_minus8;
uint8_t bit_depth_chroma_minus8;
uint8_t pcm_sample_bit_depth_luma_minus1;
uint8_t pcm_sample_bit_depth_chroma_minus1;
uint8_t log2_min_luma_coding_block_size_minus3;
uint8_t log2_diff_max_min_luma_coding_block_size;
uint8_t log2_min_transform_block_size_minus2;
uint8_t log2_diff_max_min_transform_block_size;
uint8_t log2_min_pcm_luma_coding_block_size_minus3;
uint8_t log2_diff_max_min_pcm_luma_coding_block_size;
uint8_t max_transform_hierarchy_depth_intra;
uint8_t max_transform_hierarchy_depth_inter;
int8_t init_qp_minus26;
uint8_t diff_cu_qp_delta_depth;
int8_t pps_cb_qp_offset;
int8_t pps_cr_qp_offset;
uint8_t log2_parallel_merge_level_minus2;
uint8_t num_tile_columns_minus1;
uint8_t num_tile_rows_minus1;
/**
* when uniform_spacing_flag equals 1, application should populate
* column_width_minus[], and row_height_minus1[] with approperiate values.
*/
uint16_t column_width_minus1[19];
uint16_t row_height_minus1[21];
/**
* The Following Parameters are needed for Short Slice Format Only.
* Only format decoding can ignore them.
*/
/**
* \brief Parameters needed for parsing slice segment headers
*/
union
{
struct
{
/** following parameters have same syntax with those in HEVC spec */
uint32_t lists_modification_present_flag : 1;
uint32_t long_term_ref_pics_present_flag : 1;
uint32_t sps_temporal_mvp_enabled_flag : 1;
uint32_t cabac_init_present_flag : 1;
uint32_t output_flag_present_flag : 1;
uint32_t dependent_slice_segments_enabled_flag : 1;
uint32_t pps_slice_chroma_qp_offsets_present_flag : 1;
uint32_t sample_adaptive_offset_enabled_flag : 1;
uint32_t deblocking_filter_override_enabled_flag : 1;
uint32_t pps_disable_deblocking_filter_flag : 1;
uint32_t slice_segment_header_extension_present_flag : 1;
/** current picture with NUT between 16 and 21 inclusive */
uint32_t RapPicFlag : 1;
/** current picture with NUT between 19 and 20 inclusive */
uint32_t IdrPicFlag : 1;
/** current picture has only intra slices */
uint32_t IntraPicFlag : 1;
uint32_t ReservedBits : 18;
} bits;
uint32_t value;
} slice_parsing_fields;
/** following parameters have same syntax with those in HEVC spec */
uint8_t log2_max_pic_order_cnt_lsb_minus4;
uint8_t num_short_term_ref_pic_sets;
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;
int8_t pps_beta_offset_div2;
int8_t pps_tc_offset_div2;
uint8_t num_extra_slice_header_bits;
/**
* \brief 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.
*/
uint32_t st_rps_bits;
} VADecPictureParameterBufferHEVC;
/**
* \brief HEVC Slice Parameter Buffer Structure For Short Format
*
* VASliceParameterBufferBaseHEVC structure should be accompanied by a
* slice data buffer, which holds the whole raw slice NAL unit bit streams
* including start code prefix and emulation prevention bytes not removed.
*
* This structure conveys parameters related to slice segment header and should
* be sent once per slice.
*
* For long format, this data structure is not sent by application.
*
*/
typedef struct _VASliceParameterBufferBaseHEVC
{
/** @name Codec-independent Slice Parameter Buffer base. */
/**@{*/
/** \brief Number of bytes in the slice data buffer for this slice
* counting from and including NAL unit header.
*/
uint32_t slice_data_size;
/** \brief The offset to the NAL unit header for this slice */
uint32_t slice_data_offset;
/** \brief Slice data buffer flags. See \c VA_SLICE_DATA_FLAG_XXX. */
uint16_t slice_data_flag;
/**@}*/
} VASliceParameterBufferBaseHEVC;
/**
* \brief HEVC Slice Parameter Buffer Structure For Long Format
*
* VASliceParameterBufferHEVC structure should be accompanied by a
* slice data buffer, which holds the whole raw slice NAL unit bit streams
* including start code prefix and emulation prevention bytes not removed.
*
* This structure conveys parameters related to slice segment header and should
* be sent once per slice.
*
* For short format, this data structure is not sent by application.
*
*/
typedef struct _VASliceParameterBufferHEVC
{
/** @name Codec-independent Slice Parameter Buffer base. */
/**@{*/
/** \brief Number of bytes in the slice data buffer for this slice
* counting from and including NAL unit header.
*/
uint32_t slice_data_size;
/** \brief The offset to the NAL unit header for this slice */
uint32_t slice_data_offset;
/** \brief Slice data buffer flags. See \c VA_SLICE_DATA_FLAG_XXX. */
uint16_t slice_data_flag;
/**
* \brief 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.
* The slice bit stream may or may not include the start code prefix.
*/
uint32_t slice_data_byte_offset;
/** HEVC syntax element. */
uint32_t slice_segment_address;
/** \brief index into ReferenceFrames[]
* RefPicList[0][] corresponds to RefPicList0[] of HEVC variable.
* RefPicList[1][] corresponds to RefPicList1[] of HEVC variable.
* value range [0..14, 0xFF], where 0xFF indicates invalid entry.
*/
uint8_t RefPicList[2][15];
union
{
uint32_t value;
struct
{
/** current slice is last slice of picture. */
uint32_t LastSliceOfPic : 1;
/** HEVC syntax element. */
uint32_t dependent_slice_segment_flag : 1;
/** HEVC syntax element. */
uint32_t slice_type : 2;
/** HEVC syntax element. */
uint32_t color_plane_id : 2;
/** HEVC syntax element. */
uint32_t slice_sao_luma_flag : 1;
/** HEVC syntax element. */
uint32_t slice_sao_chroma_flag : 1;
/** HEVC syntax element. */
uint32_t mvd_l1_zero_flag : 1;
/** HEVC syntax element. */
uint32_t cabac_init_flag : 1;
/** HEVC syntax element. */
uint32_t slice_temporal_mvp_enabled_flag : 1;
/** HEVC syntax element. */
uint32_t slice_deblocking_filter_disabled_flag : 1;
/** HEVC syntax element. */
uint32_t collocated_from_l0_flag : 1;
/** HEVC syntax element. */
uint32_t slice_loop_filter_across_slices_enabled_flag : 1;
uint32_t reserved : 18;
} fields;
} LongSliceFlags;
/** HEVC syntax element. Collocated Reference Picture Index.
* index to RefPicList[0][] or RefPicList[1][].
* when slice_temporal_mvp_enabled_flag equals 0, it should take value 0xFF.
* value range [0..14, 0xFF].
*/
uint8_t collocated_ref_idx;
/** HEVC syntax element.
* if num_ref_idx_active_override_flag equals 0, host decoder should
* set its value to num_ref_idx_l0_default_minus1.
*/
uint8_t num_ref_idx_l0_active_minus1;
/** HEVC syntax element.
* if num_ref_idx_active_override_flag equals 0, host decoder should
* set its value to num_ref_idx_l1_default_minus1.
*/
uint8_t num_ref_idx_l1_active_minus1;
/** HEVC syntax element. */
int8_t slice_qp_delta;
/** HEVC syntax element. */
int8_t slice_cb_qp_offset;
/** HEVC syntax element. */
int8_t slice_cr_qp_offset;
/** HEVC syntax element. */
int8_t slice_beta_offset_div2;
/** HEVC syntax element. */
int8_t slice_tc_offset_div2;
/** HEVC syntax element. */
uint8_t luma_log2_weight_denom;
/** HEVC syntax element. */
uint8_t delta_chroma_log2_weight_denom;
/** HEVC syntax element. */
int8_t delta_luma_weight_l0[15];
/** HEVC syntax element. */
int8_t luma_offset_l0[15];
/** HEVC syntax element. */
int8_t delta_chroma_weight_l0[15][2];
/** corresponds to HEVC spec variable of the same name. */
int8_t ChromaOffsetL0[15][2];
/** HEVC syntax element. */
int8_t delta_luma_weight_l1[15];
/** HEVC syntax element. */
int8_t luma_offset_l1[15];
/** HEVC syntax element. */
int8_t delta_chroma_weight_l1[15][2];
/** corresponds to HEVC spec variable of the same name. */
int8_t ChromaOffsetL1[15][2];
/** HEVC syntax element. */
uint8_t five_minus_max_num_merge_cand;
/**@}*/
} VASliceParameterBufferHEVC;
/**
* \brief HEVC Inverse Quantization Matrix Buffer Structure
*
* 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.
*
* Matrix entries are in raster scan order which follows HEVC spec.
*/
typedef struct _VAIQMatrixBufferHEVC
{
/**
* \brief scaling lists,
* corresponds to same HEVC spec syntax element
* ScalingList[ i ][ MatrixID ][ j ].
*
* \brief 4x4 scaling,
* correspongs i = 0, MatrixID is in the range of 0 to 5,
* inclusive. And j is in the range of 0 to 15, inclusive.
*/
uint8_t ScalingList4x4[6][16];
/**
* \brief 8x8 scaling,
* correspongs i = 1, MatrixID is in the range of 0 to 5,
* inclusive. And j is in the range of 0 to 63, inclusive.
*/
uint8_t ScalingList8x8[6][64];
/**
* \brief 16x16 scaling,
* correspongs i = 2, MatrixID is in the range of 0 to 5,
* inclusive. And j is in the range of 0 to 63, inclusive.
*/
uint8_t ScalingList16x16[6][64];
/**
* \brief 32x32 scaling,
* correspongs i = 3, MatrixID is in the range of 0 to 1,
* inclusive. And j is in the range of 0 to 63, inclusive.
*/
uint8_t ScalingList32x32[2][64];
/**
* \brief DC values of the 16x16 scaling lists,
* corresponds to HEVC spec syntax
* scaling_list_dc_coef_minus8[ sizeID - 2 ][ matrixID ] + 8
* with sizeID = 2 and matrixID in the range of 0 to 5, inclusive.
*/
uint8_t ScalingListDC16x16[6];
/**
* \brief DC values of the 32x32 scaling lists,
* corresponds to HEVC spec syntax
* scaling_list_dc_coef_minus8[ sizeID - 2 ][ matrixID ] + 8
* with sizeID = 3 and matrixID in the range of 0 to 1, inclusive.
*/
uint8_t ScalingListDC32x32[2];
} VAIQMatrixBufferHEVC;
/**@}*/
#ifdef __cplusplus
}
#endif
#endif /* VA_DEC_HEVC_H */