2 * Copyright (c) 2014 Intel Corporation. All Rights Reserved.
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:
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial portions
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.
27 * \brief The HEVC decoding API
29 * This file contains the \ref api_dec_hevc "HEVC decoding API".
42 * \defgroup api_dec_hevc HEVC decoding API
44 * This HEVC decoding API supports Main and Main Still Picture profiles.
45 * And it supports both short slice format and long slice format.
51 * \brief HEVC Decoding Picture Parameter Buffer Structure
53 * This structure conveys picture level parameters and should be sent once
57 typedef struct _VAPictureParameterBufferHEVC
59 /** \brief buffer description of decoded current picture
60 * only VA_PICTURE_HEVC_FIELD_PIC and VA_PICTURE_HEVC_BOTTOM_FIELD
61 * of "flags" fields are meaningful.
63 VAPictureHEVC CurrPic;
64 /** \brief buffer description of reference frames in DPB */
65 VAPictureHEVC ReferenceFrames[15];
66 /** \brief picture width, shall be integer multiple of minimum CB size. */
67 uint16_t pic_width_in_luma_samples;
68 /** \brief picture height, shall be integer multiple of minimum CB size. */
69 uint16_t pic_height_in_luma_samples;
76 /** following flags have same syntax and semantic as those in HEVC spec */
77 uint32_t chroma_format_idc : 2;
78 uint32_t separate_colour_plane_flag : 1;
79 uint32_t pcm_enabled_flag : 1;
80 uint32_t scaling_list_enabled_flag : 1;
81 uint32_t transform_skip_enabled_flag : 1;
82 uint32_t amp_enabled_flag : 1;
83 uint32_t strong_intra_smoothing_enabled_flag : 1;
84 uint32_t sign_data_hiding_enabled_flag : 1;
85 uint32_t constrained_intra_pred_flag : 1;
86 uint32_t cu_qp_delta_enabled_flag : 1;
87 uint32_t weighted_pred_flag : 1;
88 uint32_t weighted_bipred_flag : 1;
89 uint32_t transquant_bypass_enabled_flag : 1;
90 uint32_t tiles_enabled_flag : 1;
91 uint32_t entropy_coding_sync_enabled_flag : 1;
92 uint32_t pps_loop_filter_across_slices_enabled_flag : 1;
93 uint32_t loop_filter_across_tiles_enabled_flag : 1;
94 uint32_t pcm_loop_filter_disabled_flag : 1;
95 /** set based on sps_max_num_reorder_pics of current temporal layer. */
96 uint32_t NoPicReorderingFlag : 1;
97 /** picture has no B slices */
98 uint32_t NoBiPredFlag : 1;
100 uint32_t ReservedBits : 11;
105 /** following parameters have same syntax with those in HEVC spec */
106 /** \brief DPB size for current temporal layer */
107 uint8_t sps_max_dec_pic_buffering_minus1;
108 uint8_t bit_depth_luma_minus8;
109 uint8_t bit_depth_chroma_minus8;
110 uint8_t pcm_sample_bit_depth_luma_minus1;
111 uint8_t pcm_sample_bit_depth_chroma_minus1;
112 uint8_t log2_min_luma_coding_block_size_minus3;
113 uint8_t log2_diff_max_min_luma_coding_block_size;
114 uint8_t log2_min_transform_block_size_minus2;
115 uint8_t log2_diff_max_min_transform_block_size;
116 uint8_t log2_min_pcm_luma_coding_block_size_minus3;
117 uint8_t log2_diff_max_min_pcm_luma_coding_block_size;
118 uint8_t max_transform_hierarchy_depth_intra;
119 uint8_t max_transform_hierarchy_depth_inter;
120 int8_t init_qp_minus26;
121 uint8_t diff_cu_qp_delta_depth;
122 int8_t pps_cb_qp_offset;
123 int8_t pps_cr_qp_offset;
124 uint8_t log2_parallel_merge_level_minus2;
125 uint8_t num_tile_columns_minus1;
126 uint8_t num_tile_rows_minus1;
128 * when uniform_spacing_flag equals 1, application should populate
129 * column_width_minus[], and row_height_minus1[] with approperiate values.
131 uint16_t column_width_minus1[19];
132 uint16_t row_height_minus1[21];
135 * The Following Parameters are needed for Short Slice Format Only.
136 * Only format decoding can ignore them.
140 * \brief Parameters needed for parsing slice segment headers
146 /** following parameters have same syntax with those in HEVC spec */
147 uint32_t lists_modification_present_flag : 1;
148 uint32_t long_term_ref_pics_present_flag : 1;
149 uint32_t sps_temporal_mvp_enabled_flag : 1;
150 uint32_t cabac_init_present_flag : 1;
151 uint32_t output_flag_present_flag : 1;
152 uint32_t dependent_slice_segments_enabled_flag : 1;
153 uint32_t pps_slice_chroma_qp_offsets_present_flag : 1;
154 uint32_t sample_adaptive_offset_enabled_flag : 1;
155 uint32_t deblocking_filter_override_enabled_flag : 1;
156 uint32_t pps_disable_deblocking_filter_flag : 1;
157 uint32_t slice_segment_header_extension_present_flag : 1;
159 /** current picture with NUT between 16 and 21 inclusive */
160 uint32_t RapPicFlag : 1;
161 /** current picture with NUT between 19 and 20 inclusive */
162 uint32_t IdrPicFlag : 1;
163 /** current picture has only intra slices */
164 uint32_t IntraPicFlag : 1;
166 uint32_t ReservedBits : 18;
169 } slice_parsing_fields;
171 /** following parameters have same syntax with those in HEVC spec */
172 uint8_t log2_max_pic_order_cnt_lsb_minus4;
173 uint8_t num_short_term_ref_pic_sets;
174 uint8_t num_long_term_ref_pic_sps;
175 uint8_t num_ref_idx_l0_default_active_minus1;
176 uint8_t num_ref_idx_l1_default_active_minus1;
177 int8_t pps_beta_offset_div2;
178 int8_t pps_tc_offset_div2;
179 uint8_t num_extra_slice_header_bits;
182 * \brief number of bits that structure
183 * short_term_ref_pic_set( num_short_term_ref_pic_sets ) takes in slice
184 * segment header when short_term_ref_pic_set_sps_flag equals 0.
185 * if short_term_ref_pic_set_sps_flag equals 1, the value should be 0.
186 * the bit count is calculated after emulation prevention bytes are removed
188 * This variable is used for accelorater to skip parsing the
189 * short_term_ref_pic_set( num_short_term_ref_pic_sets ) structure.
191 uint32_t st_rps_bits;
193 /** \brief Reserved bytes for future use, must be zero */
194 uint32_t va_reserved[VA_PADDING_MEDIUM];
195 } VAPictureParameterBufferHEVC;
198 * \brief HEVC Decoding Picture Parameter Buffer Structure for Range Extension
200 * This structure conveys picture level HEVC Range Extension parameters
201 * and should be sent once per frame. This data structure should be sent
202 * together with VAPictureParameterBufferHEVC in a single buffer of
203 * \ref VAPictureParameterBufferHEVCExtension since each frame
204 * of HEVC range extension contains both picture level parameters and picture
205 * level range extension parameters. They should be parsed together. The buffer
206 * type is same as \ref VAPictureParameterBufferHEVC.
209 typedef struct _VAPictureParameterBufferHEVCRext
215 /** \brief HEVC range extension flags
216 * The following flags bears the same syntax and semantics as
217 * those defined in HEVC bit stream spec.
219 uint32_t transform_skip_rotation_enabled_flag : 1;
220 uint32_t transform_skip_context_enabled_flag : 1;
221 uint32_t implicit_rdpcm_enabled_flag : 1;
222 uint32_t explicit_rdpcm_enabled_flag : 1;
223 uint32_t extended_precision_processing_flag : 1;
224 uint32_t intra_smoothing_disabled_flag : 1;
225 uint32_t high_precision_offsets_enabled_flag : 1;
226 uint32_t persistent_rice_adaptation_enabled_flag : 1;
227 uint32_t cabac_bypass_alignment_enabled_flag : 1;
228 uint32_t cross_component_prediction_enabled_flag : 1;
229 uint32_t chroma_qp_offset_list_enabled_flag : 1;
231 /** \brief Reserved bytes for future use, must be zero */
232 uint32_t reserved : 21;
235 } range_extension_pic_fields;
237 /** \brief HEVC range extension flags
238 * The following flags bears the same syntax and semantics as
239 * those defined in HEVC bit stream spec.
241 uint8_t diff_cu_chroma_qp_offset_depth;
242 uint8_t chroma_qp_offset_list_len_minus1;
243 uint8_t log2_sao_offset_scale_luma;
244 uint8_t log2_sao_offset_scale_chroma;
245 uint8_t log2_max_transform_skip_block_size_minus2;
246 int8_t cb_qp_offset_list[6];
247 int8_t cr_qp_offset_list[6];
248 } VAPictureParameterBufferHEVCRext;
251 *\brief HEVC Decoding Picture Parameter Buffer Structure for
252 *Screen Content extension
254 *This structure conveys picture level HEVC Scc parameters
255 *and should be sent once per frame. This data structure should be sent
256 *together with VAPictureParameterBufferHEVC and VAPictureParameterBufferHEVCRext
257 *in a single buffer of \ref VAPictureParameterBufferHEVCExtension since each
258 *frame of HEVC SCC contains picture level parameters, picture level range
259 *extension parameters and picture level Scc parameters. They should be parsed
260 *together and the buffer type is same as \ref VAPictureParameterBufferHEVC.
263 typedef struct _VAPictureParameterBufferHEVCScc
269 /** \brief HEVC Scc extension flags
270 * The following flags bears the same syntax and semantics as
271 * those defined in HEVC bit stream spec.
273 /* indicates if intra block copy (IBC) is enabled or not. */
274 uint32_t pps_curr_pic_ref_enabled_flag : 1;
275 /* indicates if Palette Mode is enabled or not. */
276 uint32_t palette_mode_enabled_flag : 1;
277 /* controls the presence and inference of the use_integer_mv_flag syntax
278 * in slice segment header that specifies the resolution of motion
279 * vectors for inter prediction.
281 uint32_t motion_vector_resolution_control_idc : 2;
282 /* specifies that the intra boundary filtering process is
283 * disabled or not for intra prediction.
285 uint32_t intra_boundary_filtering_disabled_flag : 1;
286 /* specifies that an adaptive colour transform may be applied
287 * to the residual in the decoding process.
289 uint32_t residual_adaptive_colour_transform_enabled_flag : 1;
291 /* specifies that slice_act_y_qp_offset, slice_act_cb_qp_offset,
292 * slice_act_cr_qp_offset are present in the slice header
294 uint32_t pps_slice_act_qp_offsets_present_flag : 1;
296 /** \brief Reserved bytes for future use, must be zero */
297 uint32_t reserved : 25;
300 } screen_content_pic_fields;
302 /* specifies the maximum allowed palette size. */
303 uint8_t palette_max_size;
304 /* Correspond to HEVC syntax elements of the same names.
305 * It specifies the difference between the maximum allowed palette
306 * predictor size and the maximum allowed palette size.
307 * App needs to enforce that the variable PaletteMaxPredictorSize,
308 * which is derived as follows:
309 * PaletteMaxPredictorSize = palette_max_size + delta_palette_max_predictor_size
310 * should have a value range of [0..128].
312 uint8_t delta_palette_max_predictor_size;
313 /** \brief Size of initial palette predictor.
314 * It is derived from pps_num_palette_predictor_initializer or
315 * sps_num_palette_predictor_initializer_minus1.
316 * Details in HEVC SCC spec section 9.3.2.3.
318 uint8_t predictor_palette_size;
319 /** \brief Palette predictor initializer.
320 * It is derived from pps_palette_predictor_initializers[][]
321 * or sps_palette_predictor_initializers[][].
322 * Details in HEVC SCC spec section 9.3.2.3.
324 uint16_t predictor_palette_entries[3][128];
325 /* are used to determine the offsets that are applied to the
326 * quantization parameter values for the luma, Cb and Cr
327 * components, respectively.
329 int8_t pps_act_y_qp_offset_plus5;
330 int8_t pps_act_cb_qp_offset_plus5;
331 int8_t pps_act_cr_qp_offset_plus3;
332 } VAPictureParameterBufferHEVCScc;
335 * \brief HEVC Decoding Picture Parameter Buffer Structure including Extensions
337 * This structure conveys picture level HEVC parameters including basic version 1
338 * and range extension and screen content extension.
339 * The data buffer should be sent once per frame.
342 typedef struct _VAPictureParameterBufferHEVCExtension
344 /** \brief basic HEVC picture parameters data structure
346 VAPictureParameterBufferHEVC base;
348 /** \brief HEVC range extension picture parameters data structure
350 VAPictureParameterBufferHEVCRext rext;
352 /** \brief HEVC screen content picture parameters data structure
354 VAPictureParameterBufferHEVCScc scc;
355 } VAPictureParameterBufferHEVCExtension;
358 * \brief HEVC Slice Parameter Buffer Structure For Long Format
360 * VASliceParameterBufferHEVC structure should be accompanied by a
361 * slice data buffer, which holds the whole raw slice NAL unit bit streams
362 * including start code prefix and emulation prevention bytes not removed.
364 * This structure conveys parameters related to slice segment header and should
365 * be sent once per slice.
367 * For short format, this data structure is not sent by application.
370 typedef struct _VASliceParameterBufferHEVC
372 /** @name Codec-independent Slice Parameter Buffer base. */
376 /** \brief Number of bytes in the slice data buffer for this slice
377 * counting from and including NAL unit header.
379 uint32_t slice_data_size;
380 /** \brief The offset to the NAL unit header for this slice */
381 uint32_t slice_data_offset;
382 /** \brief Slice data buffer flags. See \c VA_SLICE_DATA_FLAG_XXX. */
383 uint32_t slice_data_flag;
385 * \brief Byte offset from NAL unit header to the begining of slice_data().
387 * This byte offset is relative to and includes the NAL unit header
388 * and represents the number of bytes parsed in the slice_header()
389 * after the removal of any emulation prevention bytes in
390 * there. However, the slice data buffer passed to the hardware is
391 * the original bitstream, thus including any emulation prevention
394 uint32_t slice_data_byte_offset;
395 /** HEVC syntax element. */
396 uint32_t slice_segment_address;
397 /** \brief index into ReferenceFrames[]
398 * RefPicList[0][] corresponds to RefPicList0[] of HEVC variable.
399 * RefPicList[1][] corresponds to RefPicList1[] of HEVC variable.
400 * value range [0..14, 0xFF], where 0xFF indicates invalid entry.
402 uint8_t RefPicList[2][15];
408 /** current slice is last slice of picture. */
409 uint32_t LastSliceOfPic : 1;
410 /** HEVC syntax element. */
411 uint32_t dependent_slice_segment_flag : 1;
412 /** HEVC syntax element. */
413 uint32_t slice_type : 2;
414 /** HEVC syntax element. */
415 uint32_t color_plane_id : 2;
416 /** HEVC syntax element. */
417 uint32_t slice_sao_luma_flag : 1;
418 /** HEVC syntax element. */
419 uint32_t slice_sao_chroma_flag : 1;
420 /** HEVC syntax element. */
421 uint32_t mvd_l1_zero_flag : 1;
422 /** HEVC syntax element. */
423 uint32_t cabac_init_flag : 1;
424 /** HEVC syntax element. */
425 uint32_t slice_temporal_mvp_enabled_flag : 1;
426 /** HEVC syntax element. */
427 uint32_t slice_deblocking_filter_disabled_flag : 1;
428 /** HEVC syntax element. */
429 uint32_t collocated_from_l0_flag : 1;
430 /** HEVC syntax element. */
431 uint32_t slice_loop_filter_across_slices_enabled_flag : 1;
432 uint32_t reserved : 18;
436 /** HEVC syntax element. Collocated Reference Picture Index.
437 * index to RefPicList[0][] or RefPicList[1][].
438 * when slice_temporal_mvp_enabled_flag equals 0, it should take value 0xFF.
439 * value range [0..14, 0xFF].
441 uint8_t collocated_ref_idx;
442 /** HEVC syntax element.
443 * if num_ref_idx_active_override_flag equals 0, host decoder should
444 * set its value to num_ref_idx_l0_default_active_minus1.
446 uint8_t num_ref_idx_l0_active_minus1;
447 /** HEVC syntax element.
448 * if num_ref_idx_active_override_flag equals 0, host decoder should
449 * set its value to num_ref_idx_l1_default_active_minus1.
451 uint8_t num_ref_idx_l1_active_minus1;
452 /** HEVC syntax element. */
453 int8_t slice_qp_delta;
454 /** HEVC syntax element. */
455 int8_t slice_cb_qp_offset;
456 /** HEVC syntax element. */
457 int8_t slice_cr_qp_offset;
458 /** HEVC syntax element. */
459 int8_t slice_beta_offset_div2;
460 /** HEVC syntax element. */
461 int8_t slice_tc_offset_div2;
462 /** HEVC syntax element. */
463 uint8_t luma_log2_weight_denom;
464 /** HEVC syntax element. */
465 int8_t delta_chroma_log2_weight_denom;
466 /** HEVC syntax element. */
467 int8_t delta_luma_weight_l0[15];
468 /** HEVC syntax element. */
469 int8_t luma_offset_l0[15];
470 /** HEVC syntax element. */
471 int8_t delta_chroma_weight_l0[15][2];
472 /** corresponds to HEVC spec variable of the same name. */
473 int8_t ChromaOffsetL0[15][2];
474 /** HEVC syntax element. */
475 int8_t delta_luma_weight_l1[15];
476 /** HEVC syntax element. */
477 int8_t luma_offset_l1[15];
478 /** HEVC syntax element. */
479 int8_t delta_chroma_weight_l1[15][2];
480 /** corresponds to HEVC spec variable of the same name. */
481 int8_t ChromaOffsetL1[15][2];
482 /** HEVC syntax element. */
483 uint8_t five_minus_max_num_merge_cand;
486 /** \brief Reserved bytes for future use, must be zero */
487 uint32_t va_reserved[VA_PADDING_LOW];
488 } VASliceParameterBufferHEVC;
491 * \brief HEVC Extented Slice Parameter Buffer Structure For Long Format
493 * This data structure contains extension profiles (range extension and screen content).
495 * VASliceParameterBufferHEVCRext structure should be accompanied by a
496 * slice data buffer, which holds the whole raw slice NAL unit bit streams
497 * including start code prefix and emulation prevention bytes not removed.
499 * This structure conveys parameters related to slice segment header and should
500 * be sent once per slice with VASliceParameterBufferHEVC in a single buffer of
501 * \ref VASliceParameterBufferHEVCExtension and the buffer type is same as \ref
502 * VASliceParameterBufferHEVC.
504 * For short format, this data structure is not sent by application.
507 typedef struct _VASliceParameterBufferHEVCRext
509 /* below four parameters are used to replace data types of the
510 * corresponding parameters of those in \# VASliceParameterBufferHEVC.
512 int16_t luma_offset_l0[15];
513 int16_t ChromaOffsetL0[15][2];
514 int16_t luma_offset_l1[15];
515 int16_t ChromaOffsetL1[15][2];
521 uint32_t cu_chroma_qp_offset_enabled_flag : 1;
522 uint32_t use_integer_mv_flag : 1;
523 /** \brief Reserved bytes for future use, must be zero */
524 uint32_t reserved : 30;
529 /** \brief Screen Content Extension parameters.
530 * data range [-12..12]
532 int8_t slice_act_y_qp_offset;
533 int8_t slice_act_cb_qp_offset;
534 int8_t slice_act_cr_qp_offset;
535 } VASliceParameterBufferHEVCRext;
538 * \brief HEVC Decoding Slice Parameter Buffer Structure For Long Format including Extensions
540 * This data structure contains both baseline HEVC profiles (main, main10)
541 * and extension profiles (range extension and screen content).
543 * VASliceParameterBufferHEVCExtension structure should be accompanied by a
544 * slice data buffer, which holds the whole raw slice NAL unit bit streams
545 * including start code prefix and emulation prevention bytes not removed.
547 * This structure conveys parameters related to slice segment header and should
548 * be sent once per slice. For HEVC range extension and HEVC Scc decoding,
549 * application should parse both basic slice parameters and extented slice
550 * parameters into this buffer structure and sent it.
552 * For short format, this data structure is not sent by application.
555 typedef struct _VASliceParameterBufferHEVCExtension
557 /** \brief baseline HEVC slice parameters data structure */
558 VASliceParameterBufferHEVC base;
560 /** \brief extented HEVC slice parameters data structure */
561 VASliceParameterBufferHEVCRext rext;
562 } VASliceParameterBufferHEVCExtension;
565 * \brief HEVC Inverse Quantization Matrix Buffer Structure
567 * This structure is sent once per frame,
568 * and only when scaling_list_enabled_flag = 1.
569 * When sps_scaling_list_data_present_flag = 0, app still
570 * needs to send in this structure with default matrix values.
572 * Matrix entries are in raster scan order which follows HEVC spec.
574 typedef struct _VAIQMatrixBufferHEVC
577 * \brief scaling lists,
578 * corresponds to same HEVC spec syntax element
579 * ScalingList[ i ][ MatrixID ][ j ].
581 * \brief 4x4 scaling,
582 * correspongs i = 0, MatrixID is in the range of 0 to 5,
583 * inclusive. And j is in the range of 0 to 15, inclusive.
585 uint8_t ScalingList4x4[6][16];
587 * \brief 8x8 scaling,
588 * correspongs i = 1, MatrixID is in the range of 0 to 5,
589 * inclusive. And j is in the range of 0 to 63, inclusive.
591 uint8_t ScalingList8x8[6][64];
593 * \brief 16x16 scaling,
594 * correspongs i = 2, MatrixID is in the range of 0 to 5,
595 * inclusive. And j is in the range of 0 to 63, inclusive.
597 uint8_t ScalingList16x16[6][64];
599 * \brief 32x32 scaling,
600 * correspongs i = 3, MatrixID is in the range of 0 to 1,
601 * inclusive. And j is in the range of 0 to 63, inclusive.
603 uint8_t ScalingList32x32[2][64];
605 * \brief DC values of the 16x16 scaling lists,
606 * corresponds to HEVC spec syntax
607 * scaling_list_dc_coef_minus8[ sizeID - 2 ][ matrixID ] + 8
608 * with sizeID = 2 and matrixID in the range of 0 to 5, inclusive.
610 uint8_t ScalingListDC16x16[6];
612 * \brief DC values of the 32x32 scaling lists,
613 * corresponds to HEVC spec syntax
614 * scaling_list_dc_coef_minus8[ sizeID - 2 ][ matrixID ] + 8
615 * with sizeID = 3 and matrixID in the range of 0 to 1, inclusive.
617 uint8_t ScalingListDC32x32[2];
619 /** \brief Reserved bytes for future use, must be zero */
620 uint32_t va_reserved[VA_PADDING_LOW];
621 } VAIQMatrixBufferHEVC;
630 #endif /* VA_DEC_HEVC_H */