va_enc_av1.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 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.
 */

 
#ifndef VA_ENC_AV1_H
#define VA_ENC_AV1_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>


typedef union _VAConfigAttribValEncAV1 {
    struct {
        uint32_t support_128x128_superblock     : 2;
        uint32_t support_filter_intra           : 2;
        uint32_t support_intra_edge_filter      : 2;
        uint32_t support_interintra_compound    : 2;
        uint32_t support_masked_compound        : 2;
        uint32_t support_warped_motion          : 2;
        uint32_t support_palette_mode           : 2;
        uint32_t support_dual_filter            : 2;
        uint32_t support_jnt_comp               : 2;
        uint32_t support_ref_frame_mvs          : 2;
        uint32_t support_superres               : 2;
        uint32_t support_restoration            : 2;
        uint32_t support_allow_intrabc          : 2;
        uint32_t support_cdef_channel_strength  : 2;
        uint32_t reserved                       : 4;
    } bits;
    uint32_t value;
} VAConfigAttribValEncAV1;

typedef union _VAConfigAttribValEncAV1Ext1 {
    struct {
        uint32_t interpolation_filter          : 5;
        uint32_t min_segid_block_size_accepted : 8;
        uint32_t segment_feature_support       : 8;
        uint32_t reserved                      : 11;
    } bits;
    uint32_t value;
} VAConfigAttribValEncAV1Ext1;

typedef union _VAConfigAttribValEncAV1Ext2 {
    struct {
        uint32_t tile_size_bytes_minus1        : 2;
        uint32_t obu_size_bytes_minus1         : 2;
        uint32_t tx_mode_support               : 3;
        uint32_t max_tile_num_minus1           : 13;
        uint32_t reserved                      : 12;
    } bits;
    uint32_t value;
} VAConfigAttribValEncAV1Ext2;

typedef enum {
    VAEncPackedHeaderAV1_SPS = VAEncPackedHeaderSequence,
    VAEncPackedHeaderAV1_PPS = VAEncPackedHeaderPicture,
} VAEncPackedHeaderTypeAV1;

typedef struct  _VAEncSequenceParameterBufferAV1 {
    uint8_t     seq_profile;

    uint8_t     seq_level_idx;

    uint8_t     seq_tier;

    uint8_t     hierarchical_flag;

    uint32_t    intra_period;

    uint32_t    ip_period;
 
    /* \brief RC related fields. RC modes are set with VAConfigAttribRateControl. */
    /* For AV1, CBR implies HRD conformance and VBR implies no HRD conformance. */

    uint32_t    bits_per_second;
 
    union {
        struct {
            uint32_t    still_picture                               : 1;
            uint32_t    use_128x128_superblock                      : 1;
            uint32_t    enable_filter_intra                         : 1;
            uint32_t    enable_intra_edge_filter                    : 1;
            uint32_t    enable_interintra_compound                  : 1;
            uint32_t    enable_masked_compound                      : 1;
            uint32_t    enable_warped_motion                        : 1;
            uint32_t    enable_dual_filter                          : 1;
            uint32_t    enable_order_hint                           : 1;
            uint32_t    enable_jnt_comp                             : 1;
            uint32_t    enable_ref_frame_mvs                        : 1;
            uint32_t    enable_superres                             : 1;
            uint32_t    enable_cdef                                 : 1;
            uint32_t    enable_restoration                          : 1;
            uint32_t    bit_depth_minus8                            : 3;
            uint32_t    subsampling_x                               : 1;
            uint32_t    subsampling_y                               : 1;
            uint32_t    mono_chrome                                 : 1;
            uint32_t    reserved_bits                               : 12;
        } bits;
        uint32_t value;
    } seq_fields;

    uint8_t     order_hint_bits_minus_1;

    uint32_t                va_reserved[VA_PADDING_HIGH];
} VAEncSequenceParameterBufferAV1;
 
#define VA_AV1_MAX_SEGMENTS    8
#define VA_AV1_SEG_LVL_MAX     8

typedef struct _VAEncSegParamAV1 {
    union {
        struct {
            uint8_t     segmentation_enabled            : 1;

            uint8_t     segmentation_update_map         : 1;
            uint8_t     segmentation_temporal_update    : 1;
            uint8_t     reserved                        : 5;
 
        } bits;
        uint8_t value;
    } seg_flags;

    uint8_t      segment_number;

    int16_t     feature_data[VA_AV1_MAX_SEGMENTS][VA_AV1_SEG_LVL_MAX];

    uint8_t     feature_mask[VA_AV1_MAX_SEGMENTS];

    uint32_t                va_reserved[VA_PADDING_LOW];
} VAEncSegParamAV1;

typedef struct _VAEncSegMapBufferAV1 {
    uint32_t    segmentMapDataSize;

    uint8_t    *pSegmentMap;
} VAEncSegMapBufferAV1;
 
typedef enum {
    VAAV1EncTransformationIdentity           = 0,
    VAAV1EncTransformationTranslation        = 1,
    VAAV1EncTransformationRotzoom            = 2,
    VAAV1EncTransformationAffine             = 3,
    VAAV1EncTransformationCount
} VAEncTransformationTypeAV1;
 
typedef struct _VAEncWarpedMotionParamsAV1 {

    VAEncTransformationTypeAV1  wmtype;

    int32_t                 wmmat[8];

    uint8_t                 invalid;

    uint32_t                va_reserved[VA_PADDING_LOW];
 
} VAEncWarpedMotionParamsAV1;

typedef union {
    struct {
        uint32_t search_idx0 : 3;
        uint32_t search_idx1 : 3;
        uint32_t search_idx2 : 3;
        uint32_t search_idx3 : 3;
        uint32_t search_idx4 : 3;
        uint32_t search_idx5 : 3;
        uint32_t search_idx6 : 3;

        uint32_t Reserved    : 11;
    } fields;
    uint32_t value;
} VARefFrameCtrlAV1;

typedef struct  _VAEncPictureParameterBufferAV1 {
    uint16_t    frame_width_minus_1;
    uint16_t    frame_height_minus_1;

    VASurfaceID reconstructed_frame;

    VABufferID  coded_buf;

    VASurfaceID reference_frames[8];

    uint8_t     ref_frame_idx[7];

    uint8_t     hierarchical_level_plus1;

    uint8_t     primary_ref_frame;

    uint8_t     order_hint;

    uint8_t     refresh_frame_flags;

    uint8_t     reserved8bits1;

    VARefFrameCtrlAV1     ref_frame_ctrl_l0;
    VARefFrameCtrlAV1     ref_frame_ctrl_l1;
 
    union {
        struct {
            uint32_t    frame_type                      : 2;
            uint32_t    error_resilient_mode            : 1;
            uint32_t    disable_cdf_update              : 1;
            uint32_t    use_superres                    : 1;
            uint32_t    allow_high_precision_mv         : 1;
            uint32_t    use_ref_frame_mvs               : 1;
            uint32_t    disable_frame_end_update_cdf    : 1;
            uint32_t    reduced_tx_set                  : 1;

            uint32_t    enable_frame_obu                : 1;

            uint32_t    long_term_reference             : 1;
            uint32_t    disable_frame_recon             : 1;
            uint32_t    allow_intrabc                   : 1;
            uint32_t    palette_mode_enable             : 1;
            uint32_t    allow_screen_content_tools      : 1;
            uint32_t    force_integer_mv                : 1;
            uint32_t    reserved                        : 16;
        } bits;
        uint32_t value;
    } picture_flags;

    uint8_t     seg_id_block_size;

    uint8_t     num_tile_groups_minus1;

    uint8_t     temporal_id;

    uint8_t     filter_level[2];
    uint8_t     filter_level_u;
    uint8_t     filter_level_v;
 
    union {
        struct {
            uint8_t     sharpness_level                 : 3;
            uint8_t     mode_ref_delta_enabled          : 1;
            uint8_t     mode_ref_delta_update           : 1;
            uint8_t     reserved                        : 3;
        } bits;
        uint8_t    value;
    } loop_filter_flags;

    uint8_t     superres_scale_denominator;
    uint8_t     interpolation_filter;

    int8_t      ref_deltas[8];

    int8_t      mode_deltas[2];

    uint8_t     base_qindex;
    int8_t      y_dc_delta_q;
    int8_t      u_dc_delta_q;
    int8_t      u_ac_delta_q;
    int8_t      v_dc_delta_q;
    int8_t      v_ac_delta_q;

    uint8_t     min_base_qindex;

    uint8_t     max_base_qindex;

    union {
        struct {
            uint16_t    using_qmatrix                   : 1;
            uint16_t    qm_y                            : 4;
            uint16_t    qm_u                            : 4;
            uint16_t    qm_v                            : 4;
            uint16_t    reserved                        : 3;
        } bits;
        uint16_t    value;
    } qmatrix_flags;

    uint16_t reserved16bits1;
 
    union {
        struct {
            uint32_t    delta_q_present                 : 1;
            uint32_t    delta_q_res                     : 2;

            uint32_t    delta_lf_present                : 1;
            uint32_t    delta_lf_res                    : 2;
            uint32_t    delta_lf_multi                  : 1;

            uint32_t    tx_mode                         : 2;

            uint32_t    reference_mode                  : 2;
            uint32_t    skip_mode_present               : 1;
            uint32_t    reserved                        : 20;
        } bits;
        uint32_t    value;
    } mode_control_flags;

    VAEncSegParamAV1    segments;

    uint8_t     tile_cols;
    uint8_t     tile_rows;

    uint16_t    reserved16bits2;

    uint16_t    width_in_sbs_minus_1[63];
    uint16_t    height_in_sbs_minus_1[63];

    uint16_t     context_update_tile_id;

    uint8_t     cdef_damping_minus_3;
    uint8_t     cdef_bits;
    uint8_t     cdef_y_strengths[8];
    uint8_t     cdef_uv_strengths[8];
 
    union {
        struct {
            uint16_t    yframe_restoration_type         : 2;
            uint16_t    cbframe_restoration_type        : 2;
            uint16_t    crframe_restoration_type        : 2;
            uint16_t    lr_unit_shift                   : 2;
            uint16_t    lr_uv_shift                     : 1;
            uint16_t    reserved                        : 7;
        } bits;
        uint16_t    value;
    } loop_restoration_flags;

    VAEncWarpedMotionParamsAV1    wm[7];

    uint32_t    bit_offset_qindex;
    uint32_t    bit_offset_segmentation;
    uint32_t    bit_offset_loopfilter_params;
    uint32_t    bit_offset_cdef_params;
    uint32_t    size_in_bits_cdef_params;

    uint32_t    byte_offset_frame_hdr_obu_size;

    uint32_t    size_in_bits_frame_hdr_obu;

    union {
        struct {
            uint8_t     obu_extension_flag              : 1;
            uint8_t     obu_has_size_field              : 1;
            uint8_t     temporal_id                     : 3;
            uint8_t     spatial_id                      : 2;
            uint8_t     reserved                        : 1;
        } bits;
        uint8_t     value;
    } tile_group_obu_hdr_info;

    uint8_t     number_skip_frames;

    uint16_t    reserved16bits3;

    int32_t    skip_frames_reduced_size;

    uint32_t    va_reserved[VA_PADDING_HIGH];
} VAEncPictureParameterBufferAV1;

typedef struct _VAEncTileGroupBufferAV1 {
    uint8_t  tg_start;
    uint8_t  tg_end;

    uint32_t                va_reserved[VA_PADDING_LOW];
} VAEncTileGroupBufferAV1;

 
#ifdef __cplusplus
}
#endif
 
#endif /* VA_ENC_AV1_H */