va/va_fei_hevc.h

   1 /*
   2  * Copyright (c) 2007-2017 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_fei_hevc.h
  27  * \brief The FEI encoding HEVC special API
  28  */
  29
  30
  31 #ifndef  __VA_FEI_HEVC_H__
  32 #define  __VA_FEI_HEVC_H__
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 #include <stdint.h>
  39 #include "va_fei.h"
  40
  41 /** \brief FEI frame level control buffer for HEVC */
  42 typedef struct _VAEncMiscParameterFEIFrameControlHEVC
  43 {
  44     /* one of the VAConfigAttribFEIFunctionType values */
  45     uint32_t      function;
  46     /** \brief CTB control input buffer. It is valid only when per_ctb_input
  47      * is set to 1. The data in this buffer correspond to the input source. CTB is in raster scan order,
  48      * each CTB control data structure is defined by VAEncFEICTBControlHEVC.
  49      * Buffer size shall not be less than the number of CTBs multiplied by
  50      * sizeof(VAEncFEICTBControlHEVC).
  51      */
  52     VABufferID    ctb_ctrl;
  53     /** \brief CTB cmd per CTB data output of ENC
  54      *  it is reserved for CTB level information
  55      * it should include CU split information and other CTB datas .
  56      * Each CTB block has one CTB cmd data.
  57      */
  58     VABufferID    ctb_cmd;
  59     /** \brief CU record data output of ENC
  60      *  it is reserved for CU level information
  61      * it should include CU detail data. include mode,MV, reference etc.
  62      * Each CTB block has one CU record data.
  63      */
  64     VABufferID    cu_record;
  65     /** \brief distortion output of ENC or ENC_PAK.
  66      * Each CTB has one distortion data with VAEncFEIDistortionHevc
  67      * Buffer size shall not be less than the number of CTBs multiplied by
  68      * sizeof(VAEncFEIDistortionHevc).
  69      */
  70     VABufferID    distortion;
  71     /** \brief Qp input buffer. It is valid only when per_block_qp is set to 1.
  72      * The data in this buffer correspond to the input source.
  73      * One Qp per block block is in raster scan order, each Qp is a signed char (8-bit) value.
  74      **/
  75     VABufferID    qp;
  76     /** \brief MV predictor. It is valid only when mv_predictor_input is set to non-zero.
  77      * Each CTB block has one or more pair of motion vectors and the corresponding
  78      * reference indexes as defined by VAEncFEIMVPredictorHEVC. 32x32 block is in raster scan order.
  79      * Buffer size shall not be less than the number of 16x16 blocks multiplied by
  80      * sizeof(VAEncFEIMVPredictorHEVC). */
  81     VABufferID    mv_predictor;
  82
  83     /** \brief number of MV predictors L0 and L1. the maximum number of motion vector predictor for a 16x16, 32x32 or
  84      * 64x64 block is four, it must not be greater than maximum supported MV predictor,
  85      **/
  86     uint32_t      num_mv_predictors_l0      : 16;
  87     uint32_t      num_mv_predictors_l1      : 16;
  88
  89     /** \brief control parameters */
  90     uint32_t      search_path               : 8;
  91     uint32_t      len_sp                    : 8;
  92     uint32_t      reserved0                     : 16;
  93
  94     /** \brief multi pred l0/1
  95      * 0000: no internal MV predictor will be used
  96      * 0001: spatial MV predictors
  97      * 0100/1000: Reserved
  98      **/
  99     uint32_t      multi_pred_l0             : 4;
 100     uint32_t      multi_pred_l1             : 4;
 101     /** \brief defines the motion vector precision, like integer/half/quarter pel.
 102      *  00b: integer pel
 103      *  01b: half-pel
 104      *  10b: reserved
 105      *  11b: quarter-pel
 106     */
 107     uint32_t      sub_pel_mode              : 2;
 108     uint32_t      adaptive_search           : 1;
 109     /** \brief mv_predictor_input
 110      * 000: MV predictor disabled
 111      * 001: MV predictor enabled per 16x16 block
 112      * 010: MV predictor enabled per 32x32 block
 113      * 011: MV predictor enabled per 64x64 block
 114      * 111: MV predictor enabled, block size can vary and is determined by BlockSize in motion vector predictor buffer
 115      * 100/101/110: Reserved
 116      **/
 117     uint32_t      mv_predictor_input        : 3;
 118     /** \brief enables per CTB or CU qp */
 119     uint32_t      per_block_qp              : 1;
 120     /** \brief enables the per CTB input , if 1, need ctb_ctrl to be a real surface ID*/
 121     uint32_t      per_ctb_input             : 1;
 122     /** when this flag is set, extra distortion between current CTB and co-located CTB is provided.
 123      * Extra distortion output has performance impact, set it only when it is needed */
 124     uint32_t      colocated_ctb_distortion  : 1;
 125     /** brief specifies whether this CTB should be forced to split to remove Inter big LCU: do not check Inter 32x32
 126      * PUs. Every 32x32 LCU is split at least once. It can be used to improved performance.
 127      * 0: ENC determined block type
 128      * 1: Force to split
 129      **/
 130     uint32_t      force_lcu_split           : 1;
 131     /** \brief enables CU64x64 check */
 132     uint32_t      enable_cu64_check         : 1;
 133     /** \brief enables CU64x64 asymmetric motion partition check */
 134     uint32_t      enable_cu64_amp_check     : 1;
 135     /** \brief specifies if check the 64x64 merge candidate
 136      * 0: after skip check,
 137      * 1: only skip check for 64x64
 138      Default: 0. This field is used by LCU64 bi-directional.
 139      **/
 140     uint32_t      cu64_skip_check_only      : 1;
 141     uint32_t      reserved1                 : 11;
 142     /** specifies the search region width in pixels.
 143      *  When bidirectional search is enabled, this applies to both search regions */
 144     uint32_t      ref_width                 : 8;
 145     /** specifies the reference region height in pixels. When bidirectional search is enabled,
 146      * this applies to both search regions. */
 147     uint32_t      ref_height                : 8;
 148     /** \brief search window similar for AVC
 149      *  defines predefined search windows. If it is selected, RefWidth, RefHeight, LenSP and SearchPath are ignored.
 150      *  0 : not use predefined search window
 151      *  1 : Tiny – (4 SUs) 24x24 window diamond search
 152      *  2 : Small – (9 SUs) 28x28 window diamond search
 153      *  3 : Diamond – (16 SUs) 48x40 window diamond search
 154      *  4 : Large Diamond – (32 SUs) 48x40 window diamond search
 155      *  5 : Exhaustive – 48x40 window full search
 156      *  6 : (64 SUs) 64x64 window full search
 157      *  Note: option 1, 2, 3 and 4 are valid only when CAP parameter SearchWindow64Support is 0.
 158      *  And option 6 is valid only when SearchWindow64Support is 1.*/
 159     uint32_t      search_window             : 8;
 160     /** \brief number of internal MV predictors for IME searches */
 161     uint32_t      max_num_ime_search_center : 3;
 162     uint32_t      reserved2                 : 5;
 163
 164     /** \brief specifies number of splits that encoder could be run concurrently
 165      * 1: level 1, default value
 166      * 2: level 2
 167      * 4: level 3
 168      **/
 169     uint32_t      num_concurrent_enc_frame_partition : 8;
 170     uint32_t      reserved3                 : 24;
 171
 172     /** \brief max frame size control with multi passes QP setting */
 173     uint32_t      max_frame_size;
 174     /** \brief number of passes, every pass has different QP */
 175     uint32_t      num_passes;
 176     /** \brief delta QP list for every pass */
 177     uint8_t       *delta_qp;
 178
 179     uint32_t      reserved4[2];
 180 } VAEncMiscParameterFEIFrameControlHEVC;
 181
 182 /** \brief Application can use this definition as reference to allocate the buffer
 183  * based on MaxNumPredictor returned from attribute VAConfigAttribFEIMVPredictors query.
 184  * this buffer allocation is always based on 16x16 block even block size is indicated as 32x32 or 64x64, and buffer
 185  * layout is always in 32x32 block raster scan order even block size is 16x16 or 64x64. If 32x32 block size is set,
 186  * only the data in the first 16x16 block (block 0) is used for 32x32 block. If 64x64 block size is set
 187  * MV layout is still in 32x32 raster scan order, the same as 32x32 and the first 16x16
 188  * block within each 32x32 block needs to have intended MV data (four 32x32 blocks will have the same MV data in the
 189  * correspondent first 16x16 block). Data structure for each 16x16 block is defined as below (same as AVC except
 190  * BlockSize/Reserved bits).
 191  **/
 192 typedef struct _VAEncFEIMVPredictorHEVC
 193 {
 194     /** \brief Feference index corresponding to the entry of RefPicList0 & RefPicList1 in slice header (final reference
 195      * list). Note that RefPicList0 & RefPicList1 needs to be the same for all slices.
 196      * Ref0xIndex – RefPicList0; Ref1xIndex – RefPicList1; x – 0 ~ MaxNumPredictor */
 197     struct {
 198         uint8_t   ref_idx_l0    : 4;
 199         uint8_t   ref_idx_l1    : 4;
 200     } ref_idx[4]; /* index is predictor number */
 201     /** \brief Valid only when MVPredictor is set to 011 for HEVC. Only valid in the first 16x16 block.
 202      * 00: MV predictor disabled for this 32x32 block
 203      * 01: MV predictor enabled per 16x16 block for this 32x32 block
 204      * 10: MV predictor enabled per 32x32 block, the rest of 16x16 block data within this 32x32 block are ignored
 205      * 11: Reserved */
 206     uint32_t block_size         : 2;
 207     uint32_t reserved           : 30;
 208
 209     VAMotionVector mv[4]; /* MaxNumPredictor is 4 */
 210 } VAEncFEIMVPredictorHEVC;    //40 bytes
 211
 212 /** \brief FEI CTB level control data structure */
 213 typedef struct _VAEncFEICTBControlHEVC
 214 {
 215     // DWORD 0
 216     uint32_t    force_to_intra      : 1;
 217     uint32_t    force_to_inter      : 1;
 218     uint32_t    force_to_skip       : 1;
 219     /** \brief force all coeff to zero */
 220     uint32_t    force_to_zero_coeff : 1;
 221     uint32_t    reserved0           : 28;
 222     // DWORD 1
 223     uint32_t    reserved1;
 224     // DWORD 2
 225     uint32_t    reserved2;
 226     // DWORD 3
 227     uint32_t    reserved3;
 228 } VAEncFEICTBControlHEVC;
 229
 230 /** \brief VAEncFEIDistortionHevc defines the data structure for VAEncFEIDistortionBufferType per CTB block.
 231  * It is output buffer of ENC and ENC_PAK modes, The CTB block is in raster scan order.
 232  * Buffer size shall not be less than the number of CTB blocks multiple by sizeof(VAEncFEIDistortionHevc).
 233  **/
 234 typedef struct _VAEncFEIDistortionHevc
 235 {
 236     /** best CTB distortion */
 237     uint32_t    best_distortion;
 238     /** only when colocated_ctb_distortion in VAEncMiscParameterFEIFrameControlHEVC is set */
 239     uint32_t    colocated_ctb_distortion;
 240 } VAEncFEIDistortionHevc;
 241 #ifdef __cplusplus
 242 }
 243 #endif
 244
 245 #endif
 246