va/va_dec_vp9.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_vp9.h
  27  * \brief The VP9 decoding API
  28  *
  29  * This file contains the \ref api_dec_vp9 "VP9 decoding API".
  30  */
  31
  32 #ifndef VA_DEC_VP9_H
  33 #define VA_DEC_VP9_H
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /**
  40  * \defgroup api_dec_vp9 VP9 decoding API
  41  *
  42  * This VP9 decoding API supports 8-bit 420 format only.
  43  *
  44  * @{
  45  */
  46
  47
  48
  49
  50 /**
  51  * \brief VP9 Decoding Picture Parameter Buffer Structure
  52  *
  53  * This structure conveys picture level parameters.
  54  * App should send a surface with this data structure down to VAAPI once
  55  * per frame.
  56  *
  57  */
  58 typedef struct  _VADecPictureParameterBufferVP9
  59 {
  60     /**@{*/
  61
  62     /** \brief picture width
  63      *  Picture original resolution. The value may not be multiple of 8.
  64      */
  65     uint16_t                frame_width;
  66     /** \brief picture height
  67      *  Picture original resolution. The value may not be multiple of 8.
  68      */
  69     uint16_t                frame_height;
  70
  71     /** \brief Surface indices of reference frames in DPB.
  72      *
  73      *  Each entry of the list specifies the surface index of the picture
  74      *  that is referred by current picture or will be referred by any future
  75      *  picture.
  76      *  Application who calls this API should update this list based on the
  77      *  refreshing information from VP9 bitstream.
  78      */
  79     VASurfaceID             reference_frames[8];
  80
  81     union
  82     {
  83         struct
  84         {
  85             /** \brief flags for current picture
  86              *  same syntax and semantic as those in VP9 code
  87              */
  88             uint32_t        subsampling_x                               : 1;
  89             uint32_t        subsampling_y                               : 1;
  90             uint32_t        frame_type                                  : 1;
  91             uint32_t        show_frame                                  : 1;
  92             uint32_t        error_resilient_mode                        : 1;
  93             uint32_t        intra_only                                  : 1;
  94             uint32_t        allow_high_precision_mv                     : 1;
  95             uint32_t        mcomp_filter_type                           : 3;
  96             uint32_t        frame_parallel_decoding_mode                : 1;
  97             uint32_t        reset_frame_context                         : 2;
  98             uint32_t        refresh_frame_context                       : 1;
  99             uint32_t        frame_context_idx                           : 2;
 100             uint32_t        segmentation_enabled                        : 1;
 101
 102             /** \brief corresponds to variable temporal_update in VP9 code.
 103              */
 104             uint32_t        segmentation_temporal_update                : 1;
 105             /** \brief corresponds to variable update_mb_segmentation_map
 106              *  in VP9 code.
 107              */
 108             uint32_t        segmentation_update_map                     : 1;
 109
 110             /** \brief Index of reference_frames[] and points to the
 111              *  LAST reference frame.
 112              *  It corresponds to active_ref_idx[0] in VP9 code.
 113              */
 114             uint32_t        last_ref_frame                              : 3;
 115             /** \brief Sign Bias of the LAST reference frame.
 116              *  It corresponds to ref_frame_sign_bias[LAST_FRAME] in VP9 code.
 117              */
 118             uint32_t        last_ref_frame_sign_bias                    : 1;
 119             /** \brief Index of reference_frames[] and points to the
 120              *  GOLDERN reference frame.
 121              *  It corresponds to active_ref_idx[1] in VP9 code.
 122              */
 123             uint32_t        golden_ref_frame                            : 3;
 124             /** \brief Sign Bias of the GOLDERN reference frame.
 125              *  Corresponds to ref_frame_sign_bias[GOLDERN_FRAME] in VP9 code.
 126              */
 127             uint32_t        golden_ref_frame_sign_bias                  : 1;
 128             /** \brief Index of reference_frames[] and points to the
 129              *  ALTERNATE reference frame.
 130              *  Corresponds to active_ref_idx[2] in VP9 code.
 131              */
 132             uint32_t        alt_ref_frame                               : 3;
 133             /** \brief Sign Bias of the ALTERNATE reference frame.
 134              *  Corresponds to ref_frame_sign_bias[ALTREF_FRAME] in VP9 code.
 135              */
 136             uint32_t        alt_ref_frame_sign_bias                     : 1;
 137             /** \brief Lossless Mode
 138              *  LosslessFlag = base_qindex == 0 &&
 139              *                 y_dc_delta_q == 0 &&
 140              *                 uv_dc_delta_q == 0 &&
 141              *                 uv_ac_delta_q == 0;
 142              *  Where base_qindex, y_dc_delta_q, uv_dc_delta_q and uv_ac_delta_q
 143              *  are all variables in VP9 code.
 144              */
 145             uint32_t        lossless_flag                               : 1;
 146         } bits;
 147         uint32_t            value;
 148     } pic_fields;
 149
 150     /* following parameters have same syntax with those in VP9 code */
 151     uint8_t                 filter_level;
 152     uint8_t                 sharpness_level;
 153
 154     /** \brief number of tile rows specified by (1 << log2_tile_rows).
 155      *  It corresponds the variable with same name in VP9 code.
 156      */
 157     uint8_t                 log2_tile_rows;
 158     /** \brief number of tile columns specified by (1 << log2_tile_columns).
 159      *  It corresponds the variable with same name in VP9 code.
 160      */
 161     uint8_t                 log2_tile_columns;
 162     /** \brief Number of bytes taken up by the uncompressed frame header,
 163      *  which corresponds to byte length of function
 164      *  read_uncompressed_header() in VP9 code.
 165      *  Specifically, it is the byte count from bit stream buffer start to
 166      *  the last byte of uncompressed frame header.
 167      *  If there are other meta data in the buffer before uncompressed header,
 168      *  its size should be also included here.
 169      */
 170     uint8_t                 frame_header_length_in_bytes;
 171
 172     /** \brief The byte count of compressed header the bitstream buffer,
 173      *  which corresponds to syntax first_partition_size in code.
 174      */
 175     uint16_t                first_partition_size;
 176
 177     /** These values are segment probabilities with same names in VP9
 178      *  function setup_segmentation(). They should be parsed directly from
 179      *  bitstream by application.
 180      */
 181     uint8_t                 mb_segment_tree_probs[7];
 182     uint8_t                 segment_pred_probs[3];
 183
 184     /** \brief VP9 Profile definition
 185      *  value range [0..3].
 186       */
 187     uint8_t                 profile;
 188
 189     /** \brief VP9 bit depth per sample
 190      *  same for both luma and chroma samples.
 191      */
 192     uint8_t                 bit_depth;
 193
 194     /**@}*/
 195
 196 } VADecPictureParameterBufferVP9;
 197
 198
 199
 200 /**
 201  * \brief VP9 Segmentation Parameter Data Structure
 202  *
 203  * This structure conveys per segment parameters.
 204  * 8 of this data structure will be included in VASegmentationParameterBufferVP9
 205  * and sent to API in a single buffer.
 206  *
 207  */
 208 typedef struct  _VASegmentParameterVP9
 209 {
 210     /**@{*/
 211
 212     union
 213     {
 214         struct
 215         {
 216             /** \brief Indicates if per segment reference frame indicator
 217              *  is enabled.
 218              *  Corresponding to variable feature_enabled when
 219              *  j == SEG_LVL_REF_FRAME in function setup_segmentation() VP9 code.
 220              */
 221             uint16_t        segment_reference_enabled                   : 1;
 222             /** \brief Specifies per segment reference indication.
 223              *  0: reserved
 224              *  1: Last ref
 225              *  2: golden
 226              *  3: altref
 227              *  Value can be derived from variable data when
 228              *  j == SEG_LVL_REF_FRAME in function setup_segmentation() VP9 code.
 229              */
 230             uint16_t        segment_reference                           : 2;
 231             /** \brief Indicates if per segment skip feature is enabled.
 232              *  Corresponding to variable feature_enabled when
 233              *  j == SEG_LVL_SKIP in function setup_segmentation() VP9 code.
 234              */
 235             uint16_t        segment_reference_skipped                   : 1;
 236         } fields;
 237         uint16_t            value;
 238     } segment_flags;
 239
 240     /** \brief Specifies the filter level information per segment.
 241      *  The value corresponds to variable lfi->lvl[seg][ref][mode] in VP9 code,
 242      *  where m is [ref], and n is [mode] in FilterLevel[m][n].
 243      */
 244     uint8_t                 filter_level[4][2];
 245     /** \brief Specifies per segment Luma AC quantization scale.
 246      *  Corresponding to y_dequant[qindex][1] in vp9_mb_init_quantizer()
 247      *  function of VP9 code.
 248      */
 249     int16_t                 luma_ac_quant_scale;
 250     /** \brief Specifies per segment Luma DC quantization scale.
 251      *  Corresponding to y_dequant[qindex][0] in vp9_mb_init_quantizer()
 252      *  function of VP9 code.
 253      */
 254     int16_t                 luma_dc_quant_scale;
 255     /** \brief Specifies per segment Chroma AC quantization scale.
 256      *  Corresponding to uv_dequant[qindex][1] in vp9_mb_init_quantizer()
 257      *  function of VP9 code.
 258      */
 259     int16_t                 chroma_ac_quant_scale;
 260     /** \brief Specifies per segment Chroma DC quantization scale.
 261      *  Corresponding to uv_dequant[qindex][0] in vp9_mb_init_quantizer()
 262      *  function of VP9 code.
 263      */
 264     int16_t                 chroma_dc_quant_scale;
 265
 266     /**@}*/
 267
 268 } VASegmentParameterVP9;
 269
 270
 271
 272 /**
 273  * \brief VP9 Slice Parameter Buffer Structure
 274  *
 275  * This structure conveys parameters related to segmentation data and should be
 276  * sent once per frame.
 277  *
 278  * When segmentation is disabled, only SegParam[0] has valid values,
 279  * all other entries should be populated with 0.
 280  * Otherwise, all eight entries should be valid.
 281  *
 282  * Slice data buffer of VASliceDataBufferType is used
 283  * to send the bitstream which should include whole or part of partition 0
 284  * (at least compressed header) to the end of frame.
 285  *
 286  */
 287 typedef struct _VASliceParameterBufferVP9
 288 {
 289     /**@{*/
 290     /** \brief The byte count of current frame in the bitstream buffer,
 291      *  starting from first byte of the buffer.
 292      *  It uses the name slice_data_size to be consitent with other codec,
 293      *  but actually means frame_data_size.
 294      */
 295     uint32_t slice_data_size;
 296     /**
 297      * offset to the first byte of partition data (control partition)
 298      */
 299     uint32_t slice_data_offset;
 300     /**
 301      * see VA_SLICE_DATA_FLAG_XXX definitions
 302      */
 303     uint32_t slice_data_flag;
 304
 305     /**
 306      * \brief per segment information
 307      */
 308     VASegmentParameterVP9   seg_param[8];
 309
 310     /**@}*/
 311
 312 } VASliceParameterBufferVP9;
 313
 314
 315 /**@}*/
 316
 317 #ifdef __cplusplus
 318 }
 319 #endif
 320
 321 #endif /* VA_DEC_VP9_H */