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 MAX_NB_THREADS 16
46 #define SHIFT_CTB_WPP 2
48 //TODO: check if this is really the maximum
49 #define MAX_TRANSFORM_DEPTH 5
51 #define MAX_TB_SIZE 32
53 #define DEFAULT_INTRA_TC_OFFSET 2
55 #define HEVC_CONTEXTS 199
57 #define MRG_MAX_NUM_CANDS 5
62 #define EPEL_EXTRA_BEFORE 1
63 #define EPEL_EXTRA_AFTER 2
65 #define QPEL_EXTRA_BEFORE 3
66 #define QPEL_EXTRA_AFTER 4
69 #define EDGE_EMU_BUFFER_STRIDE 80
72 * Value of the luma sample at position (x, y) in the 2D array tab.
74 #define SAMPLE(tab, x, y) ((tab)[(y) * s->sps->width + (x)])
75 #define SAMPLE_CTB(tab, x, y) ((tab)[(y) * min_cb_width + (x)])
77 #define IS_IDR(s) ((s)->nal_unit_type == HEVC_NAL_IDR_W_RADL || (s)->nal_unit_type == HEVC_NAL_IDR_N_LP)
78 #define IS_BLA(s) ((s)->nal_unit_type == HEVC_NAL_BLA_W_RADL || (s)->nal_unit_type == HEVC_NAL_BLA_W_LP || \
79 (s)->nal_unit_type == HEVC_NAL_BLA_N_LP)
80 #define IS_IRAP(s) ((s)->nal_unit_type >= 16 && (s)->nal_unit_type <= 23)
99 SPLIT_CODING_UNIT_FLAG,
100 CU_TRANSQUANT_BYPASS_FLAG,
106 PREV_INTRA_LUMA_PRED_FLAG,
108 REM_INTRA_LUMA_PRED_MODE,
109 INTRA_CHROMA_PRED_MODE,
115 ABS_MVD_GREATER0_FLAG,
116 ABS_MVD_GREATER1_FLAG,
120 NO_RESIDUAL_DATA_FLAG,
121 SPLIT_TRANSFORM_FLAG,
126 EXPLICIT_RDPCM_DIR_FLAG,
127 LAST_SIGNIFICANT_COEFF_X_PREFIX,
128 LAST_SIGNIFICANT_COEFF_Y_PREFIX,
129 LAST_SIGNIFICANT_COEFF_X_SUFFIX,
130 LAST_SIGNIFICANT_COEFF_Y_SUFFIX,
131 SIGNIFICANT_COEFF_GROUP_FLAG,
132 SIGNIFICANT_COEFF_FLAG,
133 COEFF_ABS_LEVEL_GREATER1_FLAG,
134 COEFF_ABS_LEVEL_GREATER2_FLAG,
135 COEFF_ABS_LEVEL_REMAINING,
139 CU_CHROMA_QP_OFFSET_FLAG,
140 CU_CHROMA_QP_OFFSET_IDX,
231 typedef struct RefPicList {
232 struct HEVCFrame *ref[HEVC_MAX_REFS];
233 int list[HEVC_MAX_REFS];
234 int isLongTerm[HEVC_MAX_REFS];
238 typedef struct RefPicListTab {
239 RefPicList refPicList[2];
242 typedef struct CodingUnit {
246 enum PredMode pred_mode; ///< PredMode
247 enum PartMode part_mode; ///< PartMode
249 // Inferred parameters
250 uint8_t intra_split_flag; ///< IntraSplitFlag
251 uint8_t max_trafo_depth; ///< MaxTrafoDepth
252 uint8_t cu_transquant_bypass_flag;
256 int16_t x; ///< horizontal component of motion vector
257 int16_t y; ///< vertical component of motion vector
260 typedef struct MvField {
261 DECLARE_ALIGNED(4, Mv, mv)[2];
266 typedef struct NeighbourAvailable {
267 int cand_bottom_left;
272 int cand_up_right_sap;
273 } NeighbourAvailable;
275 typedef struct PredictionUnit {
277 int rem_intra_luma_pred_mode;
278 uint8_t intra_pred_mode[4];
281 uint8_t intra_pred_mode_c[4];
282 uint8_t chroma_mode_c[4];
285 typedef struct TransformUnit {
290 // Inferred parameters;
292 int intra_pred_mode_c;
294 uint8_t is_cu_qp_delta_coded;
295 uint8_t is_cu_chroma_qp_offset_coded;
296 int8_t cu_qp_offset_cb;
297 int8_t cu_qp_offset_cr;
301 typedef struct DBParams {
306 #define HEVC_FRAME_FLAG_OUTPUT (1 << 0)
307 #define HEVC_FRAME_FLAG_SHORT_REF (1 << 1)
308 #define HEVC_FRAME_FLAG_LONG_REF (1 << 2)
309 #define HEVC_FRAME_FLAG_BUMPING (1 << 3)
311 typedef struct HEVCFrame {
315 RefPicList *refPicList;
316 RefPicListTab **rpl_tab;
319 struct HEVCFrame *collocated_ref;
321 AVBufferRef *tab_mvf_buf;
322 AVBufferRef *rpl_tab_buf;
323 AVBufferRef *rpl_buf;
325 AVBufferRef *hwaccel_priv_buf;
326 void *hwaccel_picture_private;
329 * A sequence counter, so that old frames are output first
335 * A combination of HEVC_FRAME_FLAG_*
340 typedef struct HEVCLocalContext {
341 uint8_t cabac_state[HEVC_CONTEXTS];
343 uint8_t stat_coeff[4];
345 uint8_t first_qp_group;
357 uint8_t ctb_left_flag;
359 uint8_t ctb_up_right_flag;
360 uint8_t ctb_up_left_flag;
363 /* +7 is for subpixel interpolation, *2 for high bit depths */
364 DECLARE_ALIGNED(32, uint8_t, edge_emu_buffer)[(MAX_PB_SIZE + 7) * EDGE_EMU_BUFFER_STRIDE * 2];
365 /* The extended size between the new edge emu buffer is abused by SAO */
366 DECLARE_ALIGNED(32, uint8_t, edge_emu_buffer2)[(MAX_PB_SIZE + 7) * EDGE_EMU_BUFFER_STRIDE * 2];
367 DECLARE_ALIGNED(32, int16_t, tmp)[MAX_PB_SIZE * MAX_PB_SIZE];
372 NeighbourAvailable na;
374 #define BOUNDARY_LEFT_SLICE (1 << 0)
375 #define BOUNDARY_LEFT_TILE (1 << 1)
376 #define BOUNDARY_UPPER_SLICE (1 << 2)
377 #define BOUNDARY_UPPER_TILE (1 << 3)
378 /* properties of the boundary of the current CTB for the purposes
379 * of the deblocking filter */
383 typedef struct HEVCContext {
384 const AVClass *c; // needed by private avoptions
385 AVCodecContext *avctx;
387 struct HEVCContext *sList[MAX_NB_THREADS];
389 HEVCLocalContext *HEVClcList[MAX_NB_THREADS];
390 HEVCLocalContext *HEVClc;
392 uint8_t threads_type;
393 uint8_t threads_number;
398 uint8_t *cabac_state;
400 /** 1 if the independent slice segment header was successfully parsed */
401 uint8_t slice_initialized;
404 AVFrame *output_frame;
405 uint8_t *sao_pixel_buffer_h[3];
406 uint8_t *sao_pixel_buffer_v[3];
410 struct AVMD5 *md5_ctx;
412 AVBufferPool *tab_mvf_pool;
413 AVBufferPool *rpl_tab_pool;
415 ///< candidate references for the current frame
421 enum HEVCNALUnitType nal_unit_type;
422 int temporal_id; ///< temporal_id_plus1 - 1
427 int slice_idx; ///< number of the slice being currently decoded
428 int eos; ///< current packet contains an EOS/EOB NAL
429 int last_eos; ///< last packet contains an EOS/EOB NAL
435 int no_rasl_output_flag;
438 HEVCDSPContext hevcdsp;
439 VideoDSPContext vdsp;
440 BswapDSPContext bdsp;
442 uint8_t *horizontal_bs;
443 uint8_t *vertical_bs;
445 int32_t *tab_slice_address;
449 uint8_t *tab_ct_depth;
453 uint8_t *cbf_luma; // cbf_luma of colocated TU
456 // CTB-level flags affecting loop filter operation
457 uint8_t *filter_slice_edges;
459 /** used on BE to byteswap the lines for checksumming */
460 uint8_t *checksum_buf;
461 int checksum_buf_size;
464 * Sequence counters for decoded and output frames, so that old
465 * frames are output first after a POC reset
470 int enable_parallel_tiles;
476 // type of the first VCL NAL of the current frame
477 enum HEVCNALUnitType first_nal_type;
479 uint8_t context_initialized;
480 int is_nalff; ///< this flag is != 0 if bitstream is encapsulated
481 ///< as a format defined in 14496-15
482 int apply_defdispwin;
484 int nal_length_size; ///< Number of bytes used for nal length (1, 2 or 4)
489 * Mark all frames in DPB as unused for reference.
491 void ff_hevc_clear_refs(HEVCContext *s);
494 * Drop all frames currently in DPB.
496 void ff_hevc_flush_dpb(HEVCContext *s);
498 RefPicList *ff_hevc_get_ref_list(HEVCContext *s, HEVCFrame *frame,
502 * Construct the reference picture sets for the current frame.
504 int ff_hevc_frame_rps(HEVCContext *s);
507 * Construct the reference picture list(s) for the current slice.
509 int ff_hevc_slice_rpl(HEVCContext *s);
511 void ff_hevc_save_states(HEVCContext *s, int ctb_addr_ts);
512 int ff_hevc_cabac_init(HEVCContext *s, int ctb_addr_ts);
513 int ff_hevc_sao_merge_flag_decode(HEVCContext *s);
514 int ff_hevc_sao_type_idx_decode(HEVCContext *s);
515 int ff_hevc_sao_band_position_decode(HEVCContext *s);
516 int ff_hevc_sao_offset_abs_decode(HEVCContext *s);
517 int ff_hevc_sao_offset_sign_decode(HEVCContext *s);
518 int ff_hevc_sao_eo_class_decode(HEVCContext *s);
519 int ff_hevc_end_of_slice_flag_decode(HEVCContext *s);
520 int ff_hevc_cu_transquant_bypass_flag_decode(HEVCContext *s);
521 int ff_hevc_skip_flag_decode(HEVCContext *s, int x0, int y0,
523 int ff_hevc_pred_mode_decode(HEVCContext *s);
524 int ff_hevc_split_coding_unit_flag_decode(HEVCContext *s, int ct_depth,
526 int ff_hevc_part_mode_decode(HEVCContext *s, int log2_cb_size);
527 int ff_hevc_pcm_flag_decode(HEVCContext *s);
528 int ff_hevc_prev_intra_luma_pred_flag_decode(HEVCContext *s);
529 int ff_hevc_mpm_idx_decode(HEVCContext *s);
530 int ff_hevc_rem_intra_luma_pred_mode_decode(HEVCContext *s);
531 int ff_hevc_intra_chroma_pred_mode_decode(HEVCContext *s);
532 int ff_hevc_merge_idx_decode(HEVCContext *s);
533 int ff_hevc_merge_flag_decode(HEVCContext *s);
534 int ff_hevc_inter_pred_idc_decode(HEVCContext *s, int nPbW, int nPbH);
535 int ff_hevc_ref_idx_lx_decode(HEVCContext *s, int num_ref_idx_lx);
536 int ff_hevc_mvp_lx_flag_decode(HEVCContext *s);
537 int ff_hevc_no_residual_syntax_flag_decode(HEVCContext *s);
538 int ff_hevc_split_transform_flag_decode(HEVCContext *s, int log2_trafo_size);
539 int ff_hevc_cbf_cb_cr_decode(HEVCContext *s, int trafo_depth);
540 int ff_hevc_cbf_luma_decode(HEVCContext *s, int trafo_depth);
541 int ff_hevc_log2_res_scale_abs(HEVCContext *s, int idx);
542 int ff_hevc_res_scale_sign_flag(HEVCContext *s, int idx);
545 * Get the number of candidate references for the current frame.
547 int ff_hevc_frame_nb_refs(HEVCContext *s);
549 int ff_hevc_set_new_ref(HEVCContext *s, AVFrame **frame, int poc);
552 * Find next frame in output order and put a reference to it in frame.
553 * @return 1 if a frame was output, 0 otherwise
555 int ff_hevc_output_frame(HEVCContext *s, AVFrame *frame, int flush);
557 void ff_hevc_bump_frame(HEVCContext *s);
559 void ff_hevc_unref_frame(HEVCContext *s, HEVCFrame *frame, int flags);
561 void ff_hevc_set_neighbour_available(HEVCContext *s, int x0, int y0,
563 void ff_hevc_luma_mv_merge_mode(HEVCContext *s, int x0, int y0,
564 int nPbW, int nPbH, int log2_cb_size,
565 int part_idx, int merge_idx, MvField *mv);
566 void ff_hevc_luma_mv_mvp_mode(HEVCContext *s, int x0, int y0,
567 int nPbW, int nPbH, int log2_cb_size,
568 int part_idx, int merge_idx,
569 MvField *mv, int mvp_lx_flag, int LX);
570 void ff_hevc_set_qPy(HEVCContext *s, int xBase, int yBase,
572 void ff_hevc_deblocking_boundary_strengths(HEVCContext *s, int x0, int y0,
573 int log2_trafo_size);
574 int ff_hevc_cu_qp_delta_sign_flag(HEVCContext *s);
575 int ff_hevc_cu_qp_delta_abs(HEVCContext *s);
576 int ff_hevc_cu_chroma_qp_offset_flag(HEVCContext *s);
577 int ff_hevc_cu_chroma_qp_offset_idx(HEVCContext *s);
578 void ff_hevc_hls_filter(HEVCContext *s, int x, int y, int ctb_size);
579 void ff_hevc_hls_filters(HEVCContext *s, int x_ctb, int y_ctb, int ctb_size);
580 void ff_hevc_hls_residual_coding(HEVCContext *s, int x0, int y0,
581 int log2_trafo_size, enum ScanType scan_idx,
584 void ff_hevc_hls_mvd_coding(HEVCContext *s, int x0, int y0, int log2_cb_size);
586 extern const uint8_t ff_hevc_qpel_extra_before[4];
587 extern const uint8_t ff_hevc_qpel_extra_after[4];
588 extern const uint8_t ff_hevc_qpel_extra[4];
590 #endif /* AVCODEC_HEVCDEC_H */