include/media/hevc-ctrls.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * These are the HEVC state controls for use with stateless HEVC
   4  * codec drivers.
   5  *
   6  * It turns out that these structs are not stable yet and will undergo
   7  * more changes. So keep them private until they are stable and ready to
   8  * become part of the official public API.
   9  */
  10
  11 #ifndef _HEVC_CTRLS_H_
  12 #define _HEVC_CTRLS_H_
  13
  14 #include <linux/videodev2.h>
  15
  16 /* The pixel format isn't stable at the moment and will likely be renamed. */
  17 #define V4L2_PIX_FMT_HEVC_SLICE v4l2_fourcc('S', '2', '6', '5') /* HEVC parsed slices */
  18
  19 #define V4L2_CID_MPEG_VIDEO_HEVC_SPS            (V4L2_CID_CODEC_BASE + 1008)
  20 #define V4L2_CID_MPEG_VIDEO_HEVC_PPS            (V4L2_CID_CODEC_BASE + 1009)
  21 #define V4L2_CID_MPEG_VIDEO_HEVC_SLICE_PARAMS   (V4L2_CID_CODEC_BASE + 1010)
  22 #define V4L2_CID_MPEG_VIDEO_HEVC_DECODE_PARAMS  (V4L2_CID_CODEC_BASE + 1012)
  23 #define V4L2_CID_MPEG_VIDEO_HEVC_DECODE_MODE    (V4L2_CID_CODEC_BASE + 1015)
  24 #define V4L2_CID_MPEG_VIDEO_HEVC_START_CODE     (V4L2_CID_CODEC_BASE + 1016)
  25
  26 /* enum v4l2_ctrl_type type values */
  27 #define V4L2_CTRL_TYPE_HEVC_SPS 0x0120
  28 #define V4L2_CTRL_TYPE_HEVC_PPS 0x0121
  29 #define V4L2_CTRL_TYPE_HEVC_SLICE_PARAMS 0x0122
  30 #define V4L2_CTRL_TYPE_HEVC_DECODE_PARAMS 0x0124
  31
  32 enum v4l2_mpeg_video_hevc_decode_mode {
  33         V4L2_MPEG_VIDEO_HEVC_DECODE_MODE_SLICE_BASED,
  34         V4L2_MPEG_VIDEO_HEVC_DECODE_MODE_FRAME_BASED,
  35 };
  36
  37 enum v4l2_mpeg_video_hevc_start_code {
  38         V4L2_MPEG_VIDEO_HEVC_START_CODE_NONE,
  39         V4L2_MPEG_VIDEO_HEVC_START_CODE_ANNEX_B,
  40 };
  41
  42 #define V4L2_HEVC_SLICE_TYPE_B  0
  43 #define V4L2_HEVC_SLICE_TYPE_P  1
  44 #define V4L2_HEVC_SLICE_TYPE_I  2
  45
  46 #define V4L2_HEVC_SPS_FLAG_SEPARATE_COLOUR_PLANE                (1ULL << 0)
  47 #define V4L2_HEVC_SPS_FLAG_SCALING_LIST_ENABLED                 (1ULL << 1)
  48 #define V4L2_HEVC_SPS_FLAG_AMP_ENABLED                          (1ULL << 2)
  49 #define V4L2_HEVC_SPS_FLAG_SAMPLE_ADAPTIVE_OFFSET               (1ULL << 3)
  50 #define V4L2_HEVC_SPS_FLAG_PCM_ENABLED                          (1ULL << 4)
  51 #define V4L2_HEVC_SPS_FLAG_PCM_LOOP_FILTER_DISABLED             (1ULL << 5)
  52 #define V4L2_HEVC_SPS_FLAG_LONG_TERM_REF_PICS_PRESENT           (1ULL << 6)
  53 #define V4L2_HEVC_SPS_FLAG_SPS_TEMPORAL_MVP_ENABLED             (1ULL << 7)
  54 #define V4L2_HEVC_SPS_FLAG_STRONG_INTRA_SMOOTHING_ENABLED       (1ULL << 8)
  55
  56 /* The controls are not stable at the moment and will likely be reworked. */
  57 struct v4l2_ctrl_hevc_sps {
  58         /* ISO/IEC 23008-2, ITU-T Rec. H.265: Sequence parameter set */
  59         __u16   pic_width_in_luma_samples;
  60         __u16   pic_height_in_luma_samples;
  61         __u8    bit_depth_luma_minus8;
  62         __u8    bit_depth_chroma_minus8;
  63         __u8    log2_max_pic_order_cnt_lsb_minus4;
  64         __u8    sps_max_dec_pic_buffering_minus1;
  65         __u8    sps_max_num_reorder_pics;
  66         __u8    sps_max_latency_increase_plus1;
  67         __u8    log2_min_luma_coding_block_size_minus3;
  68         __u8    log2_diff_max_min_luma_coding_block_size;
  69         __u8    log2_min_luma_transform_block_size_minus2;
  70         __u8    log2_diff_max_min_luma_transform_block_size;
  71         __u8    max_transform_hierarchy_depth_inter;
  72         __u8    max_transform_hierarchy_depth_intra;
  73         __u8    pcm_sample_bit_depth_luma_minus1;
  74         __u8    pcm_sample_bit_depth_chroma_minus1;
  75         __u8    log2_min_pcm_luma_coding_block_size_minus3;
  76         __u8    log2_diff_max_min_pcm_luma_coding_block_size;
  77         __u8    num_short_term_ref_pic_sets;
  78         __u8    num_long_term_ref_pics_sps;
  79         __u8    chroma_format_idc;
  80         __u8    sps_max_sub_layers_minus1;
  81
  82         __u64   flags;
  83 };
  84
  85 #define V4L2_HEVC_PPS_FLAG_DEPENDENT_SLICE_SEGMENT_ENABLED      (1ULL << 0)
  86 #define V4L2_HEVC_PPS_FLAG_OUTPUT_FLAG_PRESENT                  (1ULL << 1)
  87 #define V4L2_HEVC_PPS_FLAG_SIGN_DATA_HIDING_ENABLED             (1ULL << 2)
  88 #define V4L2_HEVC_PPS_FLAG_CABAC_INIT_PRESENT                   (1ULL << 3)
  89 #define V4L2_HEVC_PPS_FLAG_CONSTRAINED_INTRA_PRED               (1ULL << 4)
  90 #define V4L2_HEVC_PPS_FLAG_TRANSFORM_SKIP_ENABLED               (1ULL << 5)
  91 #define V4L2_HEVC_PPS_FLAG_CU_QP_DELTA_ENABLED                  (1ULL << 6)
  92 #define V4L2_HEVC_PPS_FLAG_PPS_SLICE_CHROMA_QP_OFFSETS_PRESENT  (1ULL << 7)
  93 #define V4L2_HEVC_PPS_FLAG_WEIGHTED_PRED                        (1ULL << 8)
  94 #define V4L2_HEVC_PPS_FLAG_WEIGHTED_BIPRED                      (1ULL << 9)
  95 #define V4L2_HEVC_PPS_FLAG_TRANSQUANT_BYPASS_ENABLED            (1ULL << 10)
  96 #define V4L2_HEVC_PPS_FLAG_TILES_ENABLED                        (1ULL << 11)
  97 #define V4L2_HEVC_PPS_FLAG_ENTROPY_CODING_SYNC_ENABLED          (1ULL << 12)
  98 #define V4L2_HEVC_PPS_FLAG_LOOP_FILTER_ACROSS_TILES_ENABLED     (1ULL << 13)
  99 #define V4L2_HEVC_PPS_FLAG_PPS_LOOP_FILTER_ACROSS_SLICES_ENABLED (1ULL << 14)
 100 #define V4L2_HEVC_PPS_FLAG_DEBLOCKING_FILTER_OVERRIDE_ENABLED   (1ULL << 15)
 101 #define V4L2_HEVC_PPS_FLAG_PPS_DISABLE_DEBLOCKING_FILTER        (1ULL << 16)
 102 #define V4L2_HEVC_PPS_FLAG_LISTS_MODIFICATION_PRESENT           (1ULL << 17)
 103 #define V4L2_HEVC_PPS_FLAG_SLICE_SEGMENT_HEADER_EXTENSION_PRESENT (1ULL << 18)
 104 #define V4L2_HEVC_PPS_FLAG_DEBLOCKING_FILTER_CONTROL_PRESENT    (1ULL << 19)
 105 #define V4L2_HEVC_PPS_FLAG_UNIFORM_SPACING                      (1ULL << 20)
 106
 107 struct v4l2_ctrl_hevc_pps {
 108         /* ISO/IEC 23008-2, ITU-T Rec. H.265: Picture parameter set */
 109         __u8    num_extra_slice_header_bits;
 110         __u8    num_ref_idx_l0_default_active_minus1;
 111         __u8    num_ref_idx_l1_default_active_minus1;
 112         __s8    init_qp_minus26;
 113         __u8    diff_cu_qp_delta_depth;
 114         __s8    pps_cb_qp_offset;
 115         __s8    pps_cr_qp_offset;
 116         __u8    num_tile_columns_minus1;
 117         __u8    num_tile_rows_minus1;
 118         __u8    column_width_minus1[20];
 119         __u8    row_height_minus1[22];
 120         __s8    pps_beta_offset_div2;
 121         __s8    pps_tc_offset_div2;
 122         __u8    log2_parallel_merge_level_minus2;
 123
 124         __u8    padding[4];
 125         __u64   flags;
 126 };
 127
 128 #define V4L2_HEVC_DPB_ENTRY_RPS_ST_CURR_BEFORE  0x01
 129 #define V4L2_HEVC_DPB_ENTRY_RPS_ST_CURR_AFTER   0x02
 130 #define V4L2_HEVC_DPB_ENTRY_RPS_LT_CURR         0x03
 131
 132 #define V4L2_HEVC_DPB_ENTRIES_NUM_MAX           16
 133
 134 struct v4l2_hevc_dpb_entry {
 135         __u64   timestamp;
 136         __u8    rps;
 137         __u8    field_pic;
 138         __u16   pic_order_cnt[2];
 139         __u8    padding[2];
 140 };
 141
 142 struct v4l2_hevc_pred_weight_table {
 143         __s8    delta_luma_weight_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX];
 144         __s8    luma_offset_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX];
 145         __s8    delta_chroma_weight_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2];
 146         __s8    chroma_offset_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2];
 147
 148         __s8    delta_luma_weight_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX];
 149         __s8    luma_offset_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX];
 150         __s8    delta_chroma_weight_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2];
 151         __s8    chroma_offset_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2];
 152
 153         __u8    padding[6];
 154
 155         __u8    luma_log2_weight_denom;
 156         __s8    delta_chroma_log2_weight_denom;
 157 };
 158
 159 #define V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_SAO_LUMA              (1ULL << 0)
 160 #define V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_SAO_CHROMA            (1ULL << 1)
 161 #define V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_TEMPORAL_MVP_ENABLED  (1ULL << 2)
 162 #define V4L2_HEVC_SLICE_PARAMS_FLAG_MVD_L1_ZERO                 (1ULL << 3)
 163 #define V4L2_HEVC_SLICE_PARAMS_FLAG_CABAC_INIT                  (1ULL << 4)
 164 #define V4L2_HEVC_SLICE_PARAMS_FLAG_COLLOCATED_FROM_L0          (1ULL << 5)
 165 #define V4L2_HEVC_SLICE_PARAMS_FLAG_USE_INTEGER_MV              (1ULL << 6)
 166 #define V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_DEBLOCKING_FILTER_DISABLED (1ULL << 7)
 167 #define V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_LOOP_FILTER_ACROSS_SLICES_ENABLED (1ULL << 8)
 168 #define V4L2_HEVC_SLICE_PARAMS_FLAG_DEPENDENT_SLICE_SEGMENT     (1ULL << 9)
 169
 170 struct v4l2_ctrl_hevc_slice_params {
 171         __u32   bit_size;
 172         __u32   data_bit_offset;
 173
 174         /* ISO/IEC 23008-2, ITU-T Rec. H.265: NAL unit header */
 175         __u8    nal_unit_type;
 176         __u8    nuh_temporal_id_plus1;
 177
 178         /* ISO/IEC 23008-2, ITU-T Rec. H.265: General slice segment header */
 179         __u8    slice_type;
 180         __u8    colour_plane_id;
 181         __u16   slice_pic_order_cnt;
 182         __u8    num_ref_idx_l0_active_minus1;
 183         __u8    num_ref_idx_l1_active_minus1;
 184         __u8    collocated_ref_idx;
 185         __u8    five_minus_max_num_merge_cand;
 186         __s8    slice_qp_delta;
 187         __s8    slice_cb_qp_offset;
 188         __s8    slice_cr_qp_offset;
 189         __s8    slice_act_y_qp_offset;
 190         __s8    slice_act_cb_qp_offset;
 191         __s8    slice_act_cr_qp_offset;
 192         __s8    slice_beta_offset_div2;
 193         __s8    slice_tc_offset_div2;
 194
 195         /* ISO/IEC 23008-2, ITU-T Rec. H.265: Picture timing SEI message */
 196         __u8    pic_struct;
 197
 198         /* ISO/IEC 23008-2, ITU-T Rec. H.265: General slice segment header */
 199         __u8    ref_idx_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX];
 200         __u8    ref_idx_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX];
 201
 202         __u8    padding[5];
 203
 204         /* ISO/IEC 23008-2, ITU-T Rec. H.265: Weighted prediction parameter */
 205         struct v4l2_hevc_pred_weight_table pred_weight_table;
 206
 207         __u64   flags;
 208 };
 209
 210 #define V4L2_HEVC_DECODE_PARAM_FLAG_IRAP_PIC            0x1
 211 #define V4L2_HEVC_DECODE_PARAM_FLAG_IDR_PIC             0x2
 212 #define V4L2_HEVC_DECODE_PARAM_FLAG_NO_OUTPUT_OF_PRIOR  0x4
 213
 214 struct v4l2_ctrl_hevc_decode_params {
 215         __s32   pic_order_cnt_val;
 216         __u8    num_active_dpb_entries;
 217         struct  v4l2_hevc_dpb_entry dpb[V4L2_HEVC_DPB_ENTRIES_NUM_MAX];
 218         __u8    num_poc_st_curr_before;
 219         __u8    num_poc_st_curr_after;
 220         __u8    num_poc_lt_curr;
 221         __u8    poc_st_curr_before[V4L2_HEVC_DPB_ENTRIES_NUM_MAX];
 222         __u8    poc_st_curr_after[V4L2_HEVC_DPB_ENTRIES_NUM_MAX];
 223         __u8    poc_lt_curr[V4L2_HEVC_DPB_ENTRIES_NUM_MAX];
 224         __u64   flags;
 225 };
 226
 227 /*  MPEG-class control IDs specific to the Hantro driver as defined by V4L2 */
 228 #define V4L2_CID_CODEC_HANTRO_BASE                              (V4L2_CTRL_CLASS_CODEC | 0x1200)
 229 /*
 230  * V4L2_CID_HANTRO_HEVC_SLICE_HEADER_SKIP -
 231  * the number of data (in bits) to skip in the
 232  * slice segment header.
 233  * If non-IDR, the bits to be skipped go from syntax element "pic_output_flag"
 234  * to before syntax element "slice_temporal_mvp_enabled_flag".
 235  * If IDR, the skipped bits are just "pic_output_flag"
 236  * (separate_colour_plane_flag is not supported).
 237  */
 238 #define V4L2_CID_HANTRO_HEVC_SLICE_HEADER_SKIP  (V4L2_CID_CODEC_HANTRO_BASE + 0)
 239
 240 #endif