4 * Copyright (C) 2012 - 2013 Guillaume Martres
6 * This file is part of FFmpeg.
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #ifndef AVCODEC_HEVCDEC_H
24 #define AVCODEC_HEVCDEC_H
26 #include <stdatomic.h>
28 #include "libavutil/buffer.h"
29 #include "libavutil/md5.h"
36 #include "h2645_parse.h"
45 #define SHIFT_CTB_WPP 2
47 //TODO: check if this is really the maximum
48 #define MAX_TRANSFORM_DEPTH 5
50 #define MAX_TB_SIZE 32
52 #define DEFAULT_INTRA_TC_OFFSET 2
54 #define HEVC_CONTEXTS 199
56 #define MRG_MAX_NUM_CANDS 5
61 #define EPEL_EXTRA_BEFORE 1
62 #define EPEL_EXTRA_AFTER 2
64 #define QPEL_EXTRA_BEFORE 3
65 #define QPEL_EXTRA_AFTER 4
68 #define EDGE_EMU_BUFFER_STRIDE 80
71 * Value of the luma sample at position (x, y) in the 2D array tab.
73 #define SAMPLE(tab, x, y) ((tab)[(y) * s->sps->width + (x)])
74 #define SAMPLE_CTB(tab, x, y) ((tab)[(y) * min_cb_width + (x)])
76 #define IS_IDR(s) ((s)->nal_unit_type == HEVC_NAL_IDR_W_RADL || (s)->nal_unit_type == HEVC_NAL_IDR_N_LP)
77 #define IS_BLA(s) ((s)->nal_unit_type == HEVC_NAL_BLA_W_RADL || (s)->nal_unit_type == HEVC_NAL_BLA_W_LP || \
78 (s)->nal_unit_type == HEVC_NAL_BLA_N_LP)
79 #define IS_IRAP(s) ((s)->nal_unit_type >= 16 && (s)->nal_unit_type <= 23)
98 SPLIT_CODING_UNIT_FLAG,
99 CU_TRANSQUANT_BYPASS_FLAG,
105 PREV_INTRA_LUMA_PRED_FLAG,
107 REM_INTRA_LUMA_PRED_MODE,
108 INTRA_CHROMA_PRED_MODE,
114 ABS_MVD_GREATER0_FLAG,
115 ABS_MVD_GREATER1_FLAG,
119 NO_RESIDUAL_DATA_FLAG,
120 SPLIT_TRANSFORM_FLAG,
125 EXPLICIT_RDPCM_DIR_FLAG,
126 LAST_SIGNIFICANT_COEFF_X_PREFIX,
127 LAST_SIGNIFICANT_COEFF_Y_PREFIX,
128 LAST_SIGNIFICANT_COEFF_X_SUFFIX,
129 LAST_SIGNIFICANT_COEFF_Y_SUFFIX,
130 SIGNIFICANT_COEFF_GROUP_FLAG,
131 SIGNIFICANT_COEFF_FLAG,
132 COEFF_ABS_LEVEL_GREATER1_FLAG,
133 COEFF_ABS_LEVEL_GREATER2_FLAG,
134 COEFF_ABS_LEVEL_REMAINING,
138 CU_CHROMA_QP_OFFSET_FLAG,
139 CU_CHROMA_QP_OFFSET_IDX,
230 typedef struct LongTermRPS {
232 uint8_t poc_msb_present[32];
237 typedef struct RefPicList {
238 struct HEVCFrame *ref[HEVC_MAX_REFS];
239 int list[HEVC_MAX_REFS];
240 int isLongTerm[HEVC_MAX_REFS];
244 typedef struct RefPicListTab {
245 RefPicList refPicList[2];
248 typedef struct SliceHeader {
251 ///< address (in raster order) of the first block in the current slice segment
252 unsigned int slice_segment_addr;
253 ///< address (in raster order) of the first block in the current slice
254 unsigned int slice_addr;
256 enum HEVCSliceType slice_type;
258 int pic_order_cnt_lsb;
260 uint8_t first_slice_in_pic_flag;
261 uint8_t dependent_slice_segment_flag;
262 uint8_t pic_output_flag;
263 uint8_t colour_plane_id;
265 ///< RPS coded in the slice header itself is stored here
266 int short_term_ref_pic_set_sps_flag;
267 int short_term_ref_pic_set_size;
268 ShortTermRPS slice_rps;
269 const ShortTermRPS *short_term_rps;
270 int long_term_ref_pic_set_size;
271 LongTermRPS long_term_rps;
272 unsigned int list_entry_lx[2][32];
274 uint8_t rpl_modification_flag[2];
275 uint8_t no_output_of_prior_pics_flag;
276 uint8_t slice_temporal_mvp_enabled_flag;
278 unsigned int nb_refs[2];
280 uint8_t slice_sample_adaptive_offset_flag[3];
281 uint8_t mvd_l1_zero_flag;
283 uint8_t cabac_init_flag;
284 uint8_t disable_deblocking_filter_flag; ///< slice_header_disable_deblocking_filter_flag
285 uint8_t slice_loop_filter_across_slices_enabled_flag;
286 uint8_t collocated_list;
288 unsigned int collocated_ref_idx;
291 int slice_cb_qp_offset;
292 int slice_cr_qp_offset;
294 uint8_t cu_chroma_qp_offset_enabled_flag;
296 int beta_offset; ///< beta_offset_div2 * 2
297 int tc_offset; ///< tc_offset_div2 * 2
299 unsigned int max_num_merge_cand; ///< 5 - 5_minus_max_num_merge_cand
301 unsigned *entry_point_offset;
304 int num_entry_point_offsets;
308 uint8_t luma_log2_weight_denom;
309 int16_t chroma_log2_weight_denom;
311 int16_t luma_weight_l0[16];
312 int16_t chroma_weight_l0[16][2];
313 int16_t chroma_weight_l1[16][2];
314 int16_t luma_weight_l1[16];
316 int16_t luma_offset_l0[16];
317 int16_t chroma_offset_l0[16][2];
319 int16_t luma_offset_l1[16];
320 int16_t chroma_offset_l1[16][2];
322 int slice_ctb_addr_rs;
325 typedef struct CodingUnit {
329 enum PredMode pred_mode; ///< PredMode
330 enum PartMode part_mode; ///< PartMode
332 // Inferred parameters
333 uint8_t intra_split_flag; ///< IntraSplitFlag
334 uint8_t max_trafo_depth; ///< MaxTrafoDepth
335 uint8_t cu_transquant_bypass_flag;
339 int16_t x; ///< horizontal component of motion vector
340 int16_t y; ///< vertical component of motion vector
343 typedef struct MvField {
344 DECLARE_ALIGNED(4, Mv, mv)[2];
349 typedef struct NeighbourAvailable {
350 int cand_bottom_left;
355 int cand_up_right_sap;
356 } NeighbourAvailable;
358 typedef struct PredictionUnit {
360 int rem_intra_luma_pred_mode;
361 uint8_t intra_pred_mode[4];
364 uint8_t intra_pred_mode_c[4];
365 uint8_t chroma_mode_c[4];
368 typedef struct TransformUnit {
373 // Inferred parameters;
375 int intra_pred_mode_c;
377 uint8_t is_cu_qp_delta_coded;
378 uint8_t is_cu_chroma_qp_offset_coded;
379 int8_t cu_qp_offset_cb;
380 int8_t cu_qp_offset_cr;
384 typedef struct DBParams {
389 #define HEVC_FRAME_FLAG_OUTPUT (1 << 0)
390 #define HEVC_FRAME_FLAG_SHORT_REF (1 << 1)
391 #define HEVC_FRAME_FLAG_LONG_REF (1 << 2)
392 #define HEVC_FRAME_FLAG_BUMPING (1 << 3)
394 typedef struct HEVCFrame {
398 RefPicList *refPicList;
399 RefPicListTab **rpl_tab;
402 struct HEVCFrame *collocated_ref;
404 AVBufferRef *tab_mvf_buf;
405 AVBufferRef *rpl_tab_buf;
406 AVBufferRef *rpl_buf;
408 AVBufferRef *hwaccel_priv_buf;
409 void *hwaccel_picture_private;
412 * A sequence counter, so that old frames are output first
418 * A combination of HEVC_FRAME_FLAG_*
423 typedef struct HEVCLocalContext {
424 uint8_t cabac_state[HEVC_CONTEXTS];
426 uint8_t stat_coeff[4];
428 uint8_t first_qp_group;
440 uint8_t ctb_left_flag;
442 uint8_t ctb_up_right_flag;
443 uint8_t ctb_up_left_flag;
446 /* +7 is for subpixel interpolation, *2 for high bit depths */
447 DECLARE_ALIGNED(32, uint8_t, edge_emu_buffer)[(MAX_PB_SIZE + 7) * EDGE_EMU_BUFFER_STRIDE * 2];
448 /* The extended size between the new edge emu buffer is abused by SAO */
449 DECLARE_ALIGNED(32, uint8_t, edge_emu_buffer2)[(MAX_PB_SIZE + 7) * EDGE_EMU_BUFFER_STRIDE * 2];
450 DECLARE_ALIGNED(32, int16_t, tmp)[MAX_PB_SIZE * MAX_PB_SIZE];
455 NeighbourAvailable na;
457 #define BOUNDARY_LEFT_SLICE (1 << 0)
458 #define BOUNDARY_LEFT_TILE (1 << 1)
459 #define BOUNDARY_UPPER_SLICE (1 << 2)
460 #define BOUNDARY_UPPER_TILE (1 << 3)
461 /* properties of the boundary of the current CTB for the purposes
462 * of the deblocking filter */
466 typedef struct HEVCContext {
467 const AVClass *c; // needed by private avoptions
468 AVCodecContext *avctx;
470 struct HEVCContext **sList;
472 HEVCLocalContext **HEVClcList;
473 HEVCLocalContext *HEVClc;
475 uint8_t threads_type;
476 uint8_t threads_number;
481 uint8_t *cabac_state;
483 /** 1 if the independent slice segment header was successfully parsed */
484 uint8_t slice_initialized;
487 AVFrame *output_frame;
488 uint8_t *sao_pixel_buffer_h[3];
489 uint8_t *sao_pixel_buffer_v[3];
493 struct AVMD5 *md5_ctx;
495 AVBufferPool *tab_mvf_pool;
496 AVBufferPool *rpl_tab_pool;
498 ///< candidate references for the current frame
504 enum HEVCNALUnitType nal_unit_type;
505 int temporal_id; ///< temporal_id_plus1 - 1
510 int slice_idx; ///< number of the slice being currently decoded
511 int eos; ///< current packet contains an EOS/EOB NAL
512 int last_eos; ///< last packet contains an EOS/EOB NAL
519 int no_rasl_output_flag;
522 HEVCDSPContext hevcdsp;
523 VideoDSPContext vdsp;
524 BswapDSPContext bdsp;
526 uint8_t *horizontal_bs;
527 uint8_t *vertical_bs;
529 int32_t *tab_slice_address;
533 uint8_t *tab_ct_depth;
537 uint8_t *cbf_luma; // cbf_luma of colocated TU
540 // CTB-level flags affecting loop filter operation
541 uint8_t *filter_slice_edges;
543 /** used on BE to byteswap the lines for checksumming */
544 uint8_t *checksum_buf;
545 int checksum_buf_size;
548 * Sequence counters for decoded and output frames, so that old
549 * frames are output first after a POC reset
554 int enable_parallel_tiles;
560 // type of the first VCL NAL of the current frame
561 enum HEVCNALUnitType first_nal_type;
563 uint8_t context_initialized;
564 int is_nalff; ///< this flag is != 0 if bitstream is encapsulated
565 ///< as a format defined in 14496-15
566 int apply_defdispwin;
568 int nal_length_size; ///< Number of bytes used for nal length (1, 2 or 4)
573 * Mark all frames in DPB as unused for reference.
575 void ff_hevc_clear_refs(HEVCContext *s);
578 * Drop all frames currently in DPB.
580 void ff_hevc_flush_dpb(HEVCContext *s);
582 RefPicList *ff_hevc_get_ref_list(HEVCContext *s, HEVCFrame *frame,
586 * Construct the reference picture sets for the current frame.
588 int ff_hevc_frame_rps(HEVCContext *s);
591 * Construct the reference picture list(s) for the current slice.
593 int ff_hevc_slice_rpl(HEVCContext *s);
595 void ff_hevc_save_states(HEVCContext *s, int ctb_addr_ts);
596 int ff_hevc_cabac_init(HEVCContext *s, int ctb_addr_ts);
597 int ff_hevc_sao_merge_flag_decode(HEVCContext *s);
598 int ff_hevc_sao_type_idx_decode(HEVCContext *s);
599 int ff_hevc_sao_band_position_decode(HEVCContext *s);
600 int ff_hevc_sao_offset_abs_decode(HEVCContext *s);
601 int ff_hevc_sao_offset_sign_decode(HEVCContext *s);
602 int ff_hevc_sao_eo_class_decode(HEVCContext *s);
603 int ff_hevc_end_of_slice_flag_decode(HEVCContext *s);
604 int ff_hevc_cu_transquant_bypass_flag_decode(HEVCContext *s);
605 int ff_hevc_skip_flag_decode(HEVCContext *s, int x0, int y0,
607 int ff_hevc_pred_mode_decode(HEVCContext *s);
608 int ff_hevc_split_coding_unit_flag_decode(HEVCContext *s, int ct_depth,
610 int ff_hevc_part_mode_decode(HEVCContext *s, int log2_cb_size);
611 int ff_hevc_pcm_flag_decode(HEVCContext *s);
612 int ff_hevc_prev_intra_luma_pred_flag_decode(HEVCContext *s);
613 int ff_hevc_mpm_idx_decode(HEVCContext *s);
614 int ff_hevc_rem_intra_luma_pred_mode_decode(HEVCContext *s);
615 int ff_hevc_intra_chroma_pred_mode_decode(HEVCContext *s);
616 int ff_hevc_merge_idx_decode(HEVCContext *s);
617 int ff_hevc_merge_flag_decode(HEVCContext *s);
618 int ff_hevc_inter_pred_idc_decode(HEVCContext *s, int nPbW, int nPbH);
619 int ff_hevc_ref_idx_lx_decode(HEVCContext *s, int num_ref_idx_lx);
620 int ff_hevc_mvp_lx_flag_decode(HEVCContext *s);
621 int ff_hevc_no_residual_syntax_flag_decode(HEVCContext *s);
622 int ff_hevc_split_transform_flag_decode(HEVCContext *s, int log2_trafo_size);
623 int ff_hevc_cbf_cb_cr_decode(HEVCContext *s, int trafo_depth);
624 int ff_hevc_cbf_luma_decode(HEVCContext *s, int trafo_depth);
625 int ff_hevc_log2_res_scale_abs(HEVCContext *s, int idx);
626 int ff_hevc_res_scale_sign_flag(HEVCContext *s, int idx);
629 * Get the number of candidate references for the current frame.
631 int ff_hevc_frame_nb_refs(const HEVCContext *s);
633 int ff_hevc_set_new_ref(HEVCContext *s, AVFrame **frame, int poc);
635 static av_always_inline int ff_hevc_nal_is_nonref(enum HEVCNALUnitType type)
638 case HEVC_NAL_TRAIL_N:
640 case HEVC_NAL_STSA_N:
641 case HEVC_NAL_RADL_N:
642 case HEVC_NAL_RASL_N:
643 case HEVC_NAL_VCL_N10:
644 case HEVC_NAL_VCL_N12:
645 case HEVC_NAL_VCL_N14:
653 * Find next frame in output order and put a reference to it in frame.
654 * @return 1 if a frame was output, 0 otherwise
656 int ff_hevc_output_frame(HEVCContext *s, AVFrame *frame, int flush);
658 void ff_hevc_bump_frame(HEVCContext *s);
660 void ff_hevc_unref_frame(HEVCContext *s, HEVCFrame *frame, int flags);
662 void ff_hevc_set_neighbour_available(HEVCContext *s, int x0, int y0,
664 void ff_hevc_luma_mv_merge_mode(HEVCContext *s, int x0, int y0,
665 int nPbW, int nPbH, int log2_cb_size,
666 int part_idx, int merge_idx, MvField *mv);
667 void ff_hevc_luma_mv_mvp_mode(HEVCContext *s, int x0, int y0,
668 int nPbW, int nPbH, int log2_cb_size,
669 int part_idx, int merge_idx,
670 MvField *mv, int mvp_lx_flag, int LX);
671 void ff_hevc_set_qPy(HEVCContext *s, int xBase, int yBase,
673 void ff_hevc_deblocking_boundary_strengths(HEVCContext *s, int x0, int y0,
674 int log2_trafo_size);
675 int ff_hevc_cu_qp_delta_sign_flag(HEVCContext *s);
676 int ff_hevc_cu_qp_delta_abs(HEVCContext *s);
677 int ff_hevc_cu_chroma_qp_offset_flag(HEVCContext *s);
678 int ff_hevc_cu_chroma_qp_offset_idx(HEVCContext *s);
679 void ff_hevc_hls_filter(HEVCContext *s, int x, int y, int ctb_size);
680 void ff_hevc_hls_filters(HEVCContext *s, int x_ctb, int y_ctb, int ctb_size);
681 void ff_hevc_hls_residual_coding(HEVCContext *s, int x0, int y0,
682 int log2_trafo_size, enum ScanType scan_idx,
685 void ff_hevc_hls_mvd_coding(HEVCContext *s, int x0, int y0, int log2_cb_size);
687 extern const uint8_t ff_hevc_qpel_extra_before[4];
688 extern const uint8_t ff_hevc_qpel_extra_after[4];
689 extern const uint8_t ff_hevc_qpel_extra[4];
691 #endif /* AVCODEC_HEVCDEC_H */