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