va/va_dec_hevc.h

   1 /*
   2  * Copyright (c) 2014 Intel Corporation. All Rights Reserved.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sub license, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the
  13  * next paragraph) shall be included in all copies or substantial portions
  14  * of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  19  * IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
  20  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  21  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  22  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 /**
  26  * \file va_dec_hevc.h
  27  * \brief The HEVC decoding API
  28  *
  29  * This file contains the \ref api_dec_hevc "HEVC decoding API".
  30  */
  31
  32 #ifndef VA_DEC_HEVC_H
  33 #define VA_DEC_HEVC_H
  34
  35 #include <stdint.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /**
  42  * \defgroup api_dec_hevc HEVC decoding API
  43  *
  44  * This HEVC decoding API supports Main and Main Still Picture profiles.
  45  * And it supports both short slice format and long slice format.
  46  *
  47  * @{
  48  */
  49
  50 /**
  51  * \brief HEVC Decoding Picture Parameter Buffer Structure
  52  *
  53  * This structure conveys picture level parameters and should be sent once
  54  * per frame.
  55  *
  56  */
  57 typedef struct  _VAPictureParameterBufferHEVC
  58 {
  59     /** \brief buffer description of decoded current picture
  60      * only VA_PICTURE_HEVC_FIELD_PIC and VA_PICTURE_HEVC_BOTTOM_FIELD
  61      * of "flags" fields are meaningful.
  62      */
  63     VAPictureHEVC           CurrPic;
  64     /** \brief buffer description of reference frames in DPB */
  65     VAPictureHEVC           ReferenceFrames[15];
  66     /** \brief picture width, shall be integer multiple of minimum CB size. */
  67     uint16_t                pic_width_in_luma_samples;
  68     /** \brief picture height, shall be integer multiple of minimum CB size. */
  69     uint16_t                pic_height_in_luma_samples;
  70
  71
  72     union
  73     {
  74         struct
  75         {
  76         /** following flags have same syntax and semantic as those in HEVC spec */
  77             uint32_t        chroma_format_idc                           : 2;
  78             uint32_t        separate_colour_plane_flag                  : 1;
  79             uint32_t        pcm_enabled_flag                            : 1;
  80             uint32_t        scaling_list_enabled_flag                   : 1;
  81             uint32_t        transform_skip_enabled_flag                 : 1;
  82             uint32_t        amp_enabled_flag                            : 1;
  83             uint32_t        strong_intra_smoothing_enabled_flag         : 1;
  84             uint32_t        sign_data_hiding_enabled_flag               : 1;
  85             uint32_t        constrained_intra_pred_flag                 : 1;
  86             uint32_t        cu_qp_delta_enabled_flag                    : 1;
  87             uint32_t        weighted_pred_flag                          : 1;
  88             uint32_t        weighted_bipred_flag                        : 1;
  89             uint32_t        transquant_bypass_enabled_flag              : 1;
  90             uint32_t        tiles_enabled_flag                          : 1;
  91             uint32_t        entropy_coding_sync_enabled_flag            : 1;
  92             uint32_t        pps_loop_filter_across_slices_enabled_flag  : 1;
  93             uint32_t        loop_filter_across_tiles_enabled_flag       : 1;
  94             uint32_t        pcm_loop_filter_disabled_flag               : 1;
  95             /** set based on sps_max_num_reorder_pics of current temporal layer. */
  96             uint32_t        NoPicReorderingFlag                         : 1;
  97             /** picture has no B slices */
  98             uint32_t        NoBiPredFlag                                : 1;
  99
 100             uint32_t        ReservedBits                                : 11;
 101         } bits;
 102         uint32_t            value;
 103     } pic_fields;
 104
 105     /** following parameters have same syntax with those in HEVC spec */
 106     /** \brief DPB size for current temporal layer */
 107     uint8_t                 sps_max_dec_pic_buffering_minus1;
 108     uint8_t                 bit_depth_luma_minus8;
 109     uint8_t                 bit_depth_chroma_minus8;
 110     uint8_t                 pcm_sample_bit_depth_luma_minus1;
 111     uint8_t                 pcm_sample_bit_depth_chroma_minus1;
 112     uint8_t                 log2_min_luma_coding_block_size_minus3;
 113     uint8_t                 log2_diff_max_min_luma_coding_block_size;
 114     uint8_t                 log2_min_transform_block_size_minus2;
 115     uint8_t                 log2_diff_max_min_transform_block_size;
 116     uint8_t                 log2_min_pcm_luma_coding_block_size_minus3;
 117     uint8_t                 log2_diff_max_min_pcm_luma_coding_block_size;
 118     uint8_t                 max_transform_hierarchy_depth_intra;
 119     uint8_t                 max_transform_hierarchy_depth_inter;
 120     int8_t                  init_qp_minus26;
 121     uint8_t                 diff_cu_qp_delta_depth;
 122     int8_t                  pps_cb_qp_offset;
 123     int8_t                  pps_cr_qp_offset;
 124     uint8_t                 log2_parallel_merge_level_minus2;
 125     uint8_t                 num_tile_columns_minus1;
 126     uint8_t                 num_tile_rows_minus1;
 127     /**
 128      * when uniform_spacing_flag equals 1, application should populate
 129      * column_width_minus[], and row_height_minus1[] with approperiate values.
 130      */
 131     uint16_t                column_width_minus1[19];
 132     uint16_t                row_height_minus1[21];
 133
 134     /**
 135      *  The Following Parameters are needed for Short Slice Format Only.
 136      *  Only format decoding can ignore them.
 137      */
 138
 139     /**
 140      * \brief Parameters needed for parsing slice segment headers
 141      */
 142     union
 143     {
 144         struct
 145         {
 146             /** following parameters have same syntax with those in HEVC spec */
 147             uint32_t        lists_modification_present_flag             : 1;
 148             uint32_t        long_term_ref_pics_present_flag             : 1;
 149             uint32_t        sps_temporal_mvp_enabled_flag               : 1;
 150             uint32_t        cabac_init_present_flag                     : 1;
 151             uint32_t        output_flag_present_flag                    : 1;
 152             uint32_t        dependent_slice_segments_enabled_flag       : 1;
 153             uint32_t        pps_slice_chroma_qp_offsets_present_flag    : 1;
 154             uint32_t        sample_adaptive_offset_enabled_flag         : 1;
 155             uint32_t        deblocking_filter_override_enabled_flag     : 1;
 156             uint32_t        pps_disable_deblocking_filter_flag          : 1;
 157             uint32_t        slice_segment_header_extension_present_flag : 1;
 158
 159             /** current picture with NUT between 16 and 21 inclusive */
 160             uint32_t        RapPicFlag                                  : 1;
 161             /** current picture with NUT between 19 and 20 inclusive */
 162             uint32_t        IdrPicFlag                                  : 1;
 163             /** current picture has only intra slices */
 164             uint32_t        IntraPicFlag                                : 1;
 165
 166             uint32_t        ReservedBits                                : 18;
 167         } bits;
 168         uint32_t            value;
 169     } slice_parsing_fields;
 170
 171     /** following parameters have same syntax with those in HEVC spec */
 172     uint8_t                 log2_max_pic_order_cnt_lsb_minus4;
 173     uint8_t                 num_short_term_ref_pic_sets;
 174     uint8_t                 num_long_term_ref_pic_sps;
 175     uint8_t                 num_ref_idx_l0_default_active_minus1;
 176     uint8_t                 num_ref_idx_l1_default_active_minus1;
 177     int8_t                  pps_beta_offset_div2;
 178     int8_t                  pps_tc_offset_div2;
 179     uint8_t                 num_extra_slice_header_bits;
 180
 181     /**
 182      * \brief number of bits that structure
 183      * short_term_ref_pic_set( num_short_term_ref_pic_sets ) takes in slice
 184      * segment header when short_term_ref_pic_set_sps_flag equals 0.
 185      * if short_term_ref_pic_set_sps_flag equals 1, the value should be 0.
 186      * the bit count is calculated after emulation prevention bytes are removed
 187      * from bit streams.
 188      * This variable is used for accelorater to skip parsing the
 189      * short_term_ref_pic_set( num_short_term_ref_pic_sets ) structure.
 190      */
 191     uint32_t                st_rps_bits;
 192
 193     /** \brief Reserved bytes for future use, must be zero */
 194     uint32_t                va_reserved[VA_PADDING_MEDIUM];
 195 } VAPictureParameterBufferHEVC;
 196
 197 /**
 198  * \brief HEVC Slice Parameter Buffer Structure For Long Format
 199  *
 200  * VASliceParameterBufferHEVC structure should be accompanied by a
 201  * slice data buffer, which holds the whole raw slice NAL unit bit streams
 202  * including start code prefix and emulation prevention bytes not removed.
 203  *
 204  * This structure conveys parameters related to slice segment header and should
 205  * be sent once per slice.
 206  *
 207  * For short format, this data structure is not sent by application.
 208  *
 209  */
 210 typedef struct  _VASliceParameterBufferHEVC
 211 {
 212     /** @name Codec-independent Slice Parameter Buffer base. */
 213
 214     /**@{*/
 215
 216     /** \brief Number of bytes in the slice data buffer for this slice
 217      * counting from and including NAL unit header.
 218      */
 219     uint32_t                slice_data_size;
 220     /** \brief The offset to the NAL unit header for this slice */
 221     uint32_t                slice_data_offset;
 222     /** \brief Slice data buffer flags. See \c VA_SLICE_DATA_FLAG_XXX. */
 223     uint32_t                slice_data_flag;
 224     /**
 225      * \brief Byte offset from NAL unit header to the begining of slice_data().
 226      *
 227      * This byte offset is relative to and includes the NAL unit header
 228      * and represents the number of bytes parsed in the slice_header()
 229      * after the removal of any emulation prevention bytes in
 230      * there. However, the slice data buffer passed to the hardware is
 231      * the original bitstream, thus including any emulation prevention
 232      * bytes.
 233      */
 234     uint32_t                slice_data_byte_offset;
 235     /** HEVC syntax element. */
 236     uint32_t                slice_segment_address;
 237     /** \brief index into ReferenceFrames[]
 238      * RefPicList[0][] corresponds to RefPicList0[] of HEVC variable.
 239      * RefPicList[1][] corresponds to RefPicList1[] of HEVC variable.
 240      * value range [0..14, 0xFF], where 0xFF indicates invalid entry.
 241      */
 242     uint8_t                 RefPicList[2][15];
 243     union
 244     {
 245         uint32_t            value;
 246         struct
 247         {
 248             /** current slice is last slice of picture. */
 249             uint32_t        LastSliceOfPic                              : 1;
 250     /** HEVC syntax element. */
 251             uint32_t        dependent_slice_segment_flag                : 1;
 252     /** HEVC syntax element. */
 253             uint32_t        slice_type                                  : 2;
 254     /** HEVC syntax element. */
 255             uint32_t        color_plane_id                              : 2;
 256     /** HEVC syntax element. */
 257             uint32_t        slice_sao_luma_flag                         : 1;
 258     /** HEVC syntax element. */
 259             uint32_t        slice_sao_chroma_flag                       : 1;
 260     /** HEVC syntax element. */
 261             uint32_t        mvd_l1_zero_flag                            : 1;
 262     /** HEVC syntax element. */
 263             uint32_t        cabac_init_flag                             : 1;
 264     /** HEVC syntax element. */
 265             uint32_t        slice_temporal_mvp_enabled_flag             : 1;
 266     /** HEVC syntax element. */
 267             uint32_t        slice_deblocking_filter_disabled_flag       : 1;
 268     /** HEVC syntax element. */
 269             uint32_t        collocated_from_l0_flag                     : 1;
 270     /** HEVC syntax element. */
 271             uint32_t        slice_loop_filter_across_slices_enabled_flag : 1;
 272             uint32_t        reserved                                    : 18;
 273         } fields;
 274     } LongSliceFlags;
 275
 276     /** HEVC syntax element. Collocated Reference Picture Index.
 277      * index to RefPicList[0][] or RefPicList[1][].
 278      * when slice_temporal_mvp_enabled_flag equals 0, it should take value 0xFF.
 279      * value range [0..14, 0xFF].
 280      */
 281     uint8_t                 collocated_ref_idx;
 282     /** HEVC syntax element.
 283      * if num_ref_idx_active_override_flag equals 0, host decoder should
 284      * set its value to num_ref_idx_l0_default_active_minus1.
 285      */
 286     uint8_t                 num_ref_idx_l0_active_minus1;
 287     /** HEVC syntax element.
 288      * if num_ref_idx_active_override_flag equals 0, host decoder should
 289      * set its value to num_ref_idx_l1_default_active_minus1.
 290      */
 291     uint8_t                 num_ref_idx_l1_active_minus1;
 292     /** HEVC syntax element. */
 293     int8_t                  slice_qp_delta;
 294     /** HEVC syntax element. */
 295     int8_t                  slice_cb_qp_offset;
 296     /** HEVC syntax element. */
 297     int8_t                  slice_cr_qp_offset;
 298     /** HEVC syntax element. */
 299     int8_t                  slice_beta_offset_div2;
 300     /** HEVC syntax element. */
 301     int8_t                  slice_tc_offset_div2;
 302     /** HEVC syntax element. */
 303     uint8_t                 luma_log2_weight_denom;
 304     /** HEVC syntax element. */
 305     int8_t                  delta_chroma_log2_weight_denom;
 306     /** HEVC syntax element. */
 307     int8_t                  delta_luma_weight_l0[15];
 308     /** HEVC syntax element. */
 309     int8_t                  luma_offset_l0[15];
 310     /** HEVC syntax element. */
 311     int8_t                  delta_chroma_weight_l0[15][2];
 312     /** corresponds to HEVC spec variable of the same name. */
 313     int8_t                  ChromaOffsetL0[15][2];
 314     /** HEVC syntax element. */
 315     int8_t                  delta_luma_weight_l1[15];
 316     /** HEVC syntax element. */
 317     int8_t                  luma_offset_l1[15];
 318     /** HEVC syntax element. */
 319     int8_t                  delta_chroma_weight_l1[15][2];
 320     /** corresponds to HEVC spec variable of the same name. */
 321     int8_t                  ChromaOffsetL1[15][2];
 322     /** HEVC syntax element. */
 323     uint8_t                 five_minus_max_num_merge_cand;
 324     /**@}*/
 325
 326     /** \brief Reserved bytes for future use, must be zero */
 327     uint32_t                va_reserved[VA_PADDING_LOW];
 328 } VASliceParameterBufferHEVC;
 329
 330
 331
 332 /**
 333  * \brief HEVC Inverse Quantization Matrix Buffer Structure
 334  *
 335  * This structure is sent once per frame,
 336  * and only when scaling_list_enabled_flag = 1.
 337  * When sps_scaling_list_data_present_flag = 0, app still
 338  * needs to send in this structure with default matrix values.
 339  *
 340  * Matrix entries are in raster scan order which follows HEVC spec.
 341  */
 342 typedef struct _VAIQMatrixBufferHEVC
 343 {
 344     /**
 345      * \brief scaling lists,
 346      * corresponds to same HEVC spec syntax element
 347      * ScalingList[ i ][ MatrixID ][ j ].
 348      *
 349      * \brief 4x4 scaling,
 350      * correspongs i = 0, MatrixID is in the range of 0 to 5,
 351      * inclusive. And j is in the range of 0 to 15, inclusive.
 352      */
 353     uint8_t                 ScalingList4x4[6][16];
 354     /**
 355      * \brief 8x8 scaling,
 356      * correspongs i = 1, MatrixID is in the range of 0 to 5,
 357      * inclusive. And j is in the range of 0 to 63, inclusive.
 358      */
 359     uint8_t                 ScalingList8x8[6][64];
 360     /**
 361      * \brief 16x16 scaling,
 362      * correspongs i = 2, MatrixID is in the range of 0 to 5,
 363      * inclusive. And j is in the range of 0 to 63, inclusive.
 364      */
 365     uint8_t                 ScalingList16x16[6][64];
 366     /**
 367      * \brief 32x32 scaling,
 368      * correspongs i = 3, MatrixID is in the range of 0 to 1,
 369      * inclusive. And j is in the range of 0 to 63, inclusive.
 370      */
 371     uint8_t                 ScalingList32x32[2][64];
 372     /**
 373      * \brief DC values of the 16x16 scaling lists,
 374      * corresponds to HEVC spec syntax
 375      * scaling_list_dc_coef_minus8[ sizeID - 2 ][ matrixID ] + 8
 376      * with sizeID = 2 and matrixID in the range of 0 to 5, inclusive.
 377      */
 378     uint8_t                 ScalingListDC16x16[6];
 379     /**
 380      * \brief DC values of the 32x32 scaling lists,
 381      * corresponds to HEVC spec syntax
 382      * scaling_list_dc_coef_minus8[ sizeID - 2 ][ matrixID ] + 8
 383      * with sizeID = 3 and matrixID in the range of 0 to 1, inclusive.
 384      */
 385     uint8_t                 ScalingListDC32x32[2];
 386
 387     /** \brief Reserved bytes for future use, must be zero */
 388     uint32_t                va_reserved[VA_PADDING_LOW];
 389 } VAIQMatrixBufferHEVC;
 390
 391
 392 /**@}*/
 393
 394 #ifdef __cplusplus
 395 }
 396 #endif
 397
 398 #endif /* VA_DEC_HEVC_H */