Merge commit 'c359d624d3efc3fd1d83210d78c4152bd329b765'
[ffmpeg.git] / libavcodec / hevcdec.h
1 /*
2  * HEVC video decoder
3  *
4  * Copyright (C) 2012 - 2013 Guillaume Martres
5  *
6  * This file is part of FFmpeg.
7  *
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.
12  *
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.
17  *
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
21  */
22
23 #ifndef AVCODEC_HEVCDEC_H
24 #define AVCODEC_HEVCDEC_H
25
26 #include <stdatomic.h>
27
28 #include "libavutil/buffer.h"
29 #include "libavutil/md5.h"
30
31 #include "avcodec.h"
32 #include "bswapdsp.h"
33 #include "cabac.h"
34 #include "get_bits.h"
35 #include "hevcpred.h"
36 #include "h2645_parse.h"
37 #include "hevc.h"
38 #include "hevcdsp.h"
39 #include "internal.h"
40 #include "thread.h"
41 #include "videodsp.h"
42
43 #define MAX_DPB_SIZE 16 // A.4.1
44 #define MAX_REFS 16
45
46 #define MAX_NB_THREADS 16
47 #define SHIFT_CTB_WPP 2
48
49 //TODO: check if this is really the maximum
50 #define MAX_TRANSFORM_DEPTH 5
51
52 #define MAX_TB_SIZE 32
53 #define MAX_LOG2_CTB_SIZE 6
54 #define MAX_QP 51
55 #define DEFAULT_INTRA_TC_OFFSET 2
56
57 #define HEVC_CONTEXTS 199
58
59 #define MRG_MAX_NUM_CANDS     5
60
61 #define L0 0
62 #define L1 1
63
64 #define EPEL_EXTRA_BEFORE 1
65 #define EPEL_EXTRA_AFTER  2
66 #define EPEL_EXTRA        3
67 #define QPEL_EXTRA_BEFORE 3
68 #define QPEL_EXTRA_AFTER  4
69 #define QPEL_EXTRA        7
70
71 #define EDGE_EMU_BUFFER_STRIDE 80
72
73 /**
74  * Value of the luma sample at position (x, y) in the 2D array tab.
75  */
76 #define SAMPLE(tab, x, y) ((tab)[(y) * s->sps->width + (x)])
77 #define SAMPLE_CTB(tab, x, y) ((tab)[(y) * min_cb_width + (x)])
78
79 #define IS_IDR(s) ((s)->nal_unit_type == HEVC_NAL_IDR_W_RADL || (s)->nal_unit_type == HEVC_NAL_IDR_N_LP)
80 #define IS_BLA(s) ((s)->nal_unit_type == HEVC_NAL_BLA_W_RADL || (s)->nal_unit_type == HEVC_NAL_BLA_W_LP || \
81                    (s)->nal_unit_type == HEVC_NAL_BLA_N_LP)
82 #define IS_IRAP(s) ((s)->nal_unit_type >= 16 && (s)->nal_unit_type <= 23)
83
84 enum RPSType {
85     ST_CURR_BEF = 0,
86     ST_CURR_AFT,
87     ST_FOLL,
88     LT_CURR,
89     LT_FOLL,
90     NB_RPS_TYPE,
91 };
92
93 enum SliceType {
94     B_SLICE = 0,
95     P_SLICE = 1,
96     I_SLICE = 2,
97 };
98
99 enum SyntaxElement {
100     SAO_MERGE_FLAG = 0,
101     SAO_TYPE_IDX,
102     SAO_EO_CLASS,
103     SAO_BAND_POSITION,
104     SAO_OFFSET_ABS,
105     SAO_OFFSET_SIGN,
106     END_OF_SLICE_FLAG,
107     SPLIT_CODING_UNIT_FLAG,
108     CU_TRANSQUANT_BYPASS_FLAG,
109     SKIP_FLAG,
110     CU_QP_DELTA,
111     PRED_MODE_FLAG,
112     PART_MODE,
113     PCM_FLAG,
114     PREV_INTRA_LUMA_PRED_FLAG,
115     MPM_IDX,
116     REM_INTRA_LUMA_PRED_MODE,
117     INTRA_CHROMA_PRED_MODE,
118     MERGE_FLAG,
119     MERGE_IDX,
120     INTER_PRED_IDC,
121     REF_IDX_L0,
122     REF_IDX_L1,
123     ABS_MVD_GREATER0_FLAG,
124     ABS_MVD_GREATER1_FLAG,
125     ABS_MVD_MINUS2,
126     MVD_SIGN_FLAG,
127     MVP_LX_FLAG,
128     NO_RESIDUAL_DATA_FLAG,
129     SPLIT_TRANSFORM_FLAG,
130     CBF_LUMA,
131     CBF_CB_CR,
132     TRANSFORM_SKIP_FLAG,
133     EXPLICIT_RDPCM_FLAG,
134     EXPLICIT_RDPCM_DIR_FLAG,
135     LAST_SIGNIFICANT_COEFF_X_PREFIX,
136     LAST_SIGNIFICANT_COEFF_Y_PREFIX,
137     LAST_SIGNIFICANT_COEFF_X_SUFFIX,
138     LAST_SIGNIFICANT_COEFF_Y_SUFFIX,
139     SIGNIFICANT_COEFF_GROUP_FLAG,
140     SIGNIFICANT_COEFF_FLAG,
141     COEFF_ABS_LEVEL_GREATER1_FLAG,
142     COEFF_ABS_LEVEL_GREATER2_FLAG,
143     COEFF_ABS_LEVEL_REMAINING,
144     COEFF_SIGN_FLAG,
145     LOG2_RES_SCALE_ABS,
146     RES_SCALE_SIGN_FLAG,
147     CU_CHROMA_QP_OFFSET_FLAG,
148     CU_CHROMA_QP_OFFSET_IDX,
149 };
150
151 enum PartMode {
152     PART_2Nx2N = 0,
153     PART_2NxN  = 1,
154     PART_Nx2N  = 2,
155     PART_NxN   = 3,
156     PART_2NxnU = 4,
157     PART_2NxnD = 5,
158     PART_nLx2N = 6,
159     PART_nRx2N = 7,
160 };
161
162 enum PredMode {
163     MODE_INTER = 0,
164     MODE_INTRA,
165     MODE_SKIP,
166 };
167
168 enum InterPredIdc {
169     PRED_L0 = 0,
170     PRED_L1,
171     PRED_BI,
172 };
173
174 enum PredFlag {
175     PF_INTRA = 0,
176     PF_L0,
177     PF_L1,
178     PF_BI,
179 };
180
181 enum IntraPredMode {
182     INTRA_PLANAR = 0,
183     INTRA_DC,
184     INTRA_ANGULAR_2,
185     INTRA_ANGULAR_3,
186     INTRA_ANGULAR_4,
187     INTRA_ANGULAR_5,
188     INTRA_ANGULAR_6,
189     INTRA_ANGULAR_7,
190     INTRA_ANGULAR_8,
191     INTRA_ANGULAR_9,
192     INTRA_ANGULAR_10,
193     INTRA_ANGULAR_11,
194     INTRA_ANGULAR_12,
195     INTRA_ANGULAR_13,
196     INTRA_ANGULAR_14,
197     INTRA_ANGULAR_15,
198     INTRA_ANGULAR_16,
199     INTRA_ANGULAR_17,
200     INTRA_ANGULAR_18,
201     INTRA_ANGULAR_19,
202     INTRA_ANGULAR_20,
203     INTRA_ANGULAR_21,
204     INTRA_ANGULAR_22,
205     INTRA_ANGULAR_23,
206     INTRA_ANGULAR_24,
207     INTRA_ANGULAR_25,
208     INTRA_ANGULAR_26,
209     INTRA_ANGULAR_27,
210     INTRA_ANGULAR_28,
211     INTRA_ANGULAR_29,
212     INTRA_ANGULAR_30,
213     INTRA_ANGULAR_31,
214     INTRA_ANGULAR_32,
215     INTRA_ANGULAR_33,
216     INTRA_ANGULAR_34,
217 };
218
219 enum SAOType {
220     SAO_NOT_APPLIED = 0,
221     SAO_BAND,
222     SAO_EDGE,
223     SAO_APPLIED
224 };
225
226 enum SAOEOClass {
227     SAO_EO_HORIZ = 0,
228     SAO_EO_VERT,
229     SAO_EO_135D,
230     SAO_EO_45D,
231 };
232
233 enum ScanType {
234     SCAN_DIAG = 0,
235     SCAN_HORIZ,
236     SCAN_VERT,
237 };
238
239 typedef struct ShortTermRPS {
240     unsigned int num_negative_pics;
241     int num_delta_pocs;
242     int rps_idx_num_delta_pocs;
243     int32_t delta_poc[32];
244     uint8_t used[32];
245 } ShortTermRPS;
246
247 typedef struct LongTermRPS {
248     int     poc[32];
249     uint8_t used[32];
250     uint8_t nb_refs;
251 } LongTermRPS;
252
253 typedef struct RefPicList {
254     struct HEVCFrame *ref[MAX_REFS];
255     int list[MAX_REFS];
256     int isLongTerm[MAX_REFS];
257     int nb_refs;
258 } RefPicList;
259
260 typedef struct RefPicListTab {
261     RefPicList refPicList[2];
262 } RefPicListTab;
263
264 typedef struct HEVCWindow {
265     unsigned int left_offset;
266     unsigned int right_offset;
267     unsigned int top_offset;
268     unsigned int bottom_offset;
269 } HEVCWindow;
270
271 typedef struct VUI {
272     AVRational sar;
273
274     int overscan_info_present_flag;
275     int overscan_appropriate_flag;
276
277     int video_signal_type_present_flag;
278     int video_format;
279     int video_full_range_flag;
280     int colour_description_present_flag;
281     uint8_t colour_primaries;
282     uint8_t transfer_characteristic;
283     uint8_t matrix_coeffs;
284
285     int chroma_loc_info_present_flag;
286     int chroma_sample_loc_type_top_field;
287     int chroma_sample_loc_type_bottom_field;
288     int neutra_chroma_indication_flag;
289
290     int field_seq_flag;
291     int frame_field_info_present_flag;
292
293     int default_display_window_flag;
294     HEVCWindow def_disp_win;
295
296     int vui_timing_info_present_flag;
297     uint32_t vui_num_units_in_tick;
298     uint32_t vui_time_scale;
299     int vui_poc_proportional_to_timing_flag;
300     int vui_num_ticks_poc_diff_one_minus1;
301     int vui_hrd_parameters_present_flag;
302
303     int bitstream_restriction_flag;
304     int tiles_fixed_structure_flag;
305     int motion_vectors_over_pic_boundaries_flag;
306     int restricted_ref_pic_lists_flag;
307     int min_spatial_segmentation_idc;
308     int max_bytes_per_pic_denom;
309     int max_bits_per_min_cu_denom;
310     int log2_max_mv_length_horizontal;
311     int log2_max_mv_length_vertical;
312 } VUI;
313
314 typedef struct PTLCommon {
315     uint8_t profile_space;
316     uint8_t tier_flag;
317     uint8_t profile_idc;
318     uint8_t profile_compatibility_flag[32];
319     uint8_t level_idc;
320     uint8_t progressive_source_flag;
321     uint8_t interlaced_source_flag;
322     uint8_t non_packed_constraint_flag;
323     uint8_t frame_only_constraint_flag;
324 } PTLCommon;
325
326 typedef struct PTL {
327     PTLCommon general_ptl;
328     PTLCommon sub_layer_ptl[HEVC_MAX_SUB_LAYERS];
329
330     uint8_t sub_layer_profile_present_flag[HEVC_MAX_SUB_LAYERS];
331     uint8_t sub_layer_level_present_flag[HEVC_MAX_SUB_LAYERS];
332 } PTL;
333
334 typedef struct HEVCVPS {
335     uint8_t vps_temporal_id_nesting_flag;
336     int vps_max_layers;
337     int vps_max_sub_layers; ///< vps_max_temporal_layers_minus1 + 1
338
339     PTL ptl;
340     int vps_sub_layer_ordering_info_present_flag;
341     unsigned int vps_max_dec_pic_buffering[HEVC_MAX_SUB_LAYERS];
342     unsigned int vps_num_reorder_pics[HEVC_MAX_SUB_LAYERS];
343     unsigned int vps_max_latency_increase[HEVC_MAX_SUB_LAYERS];
344     int vps_max_layer_id;
345     int vps_num_layer_sets; ///< vps_num_layer_sets_minus1 + 1
346     uint8_t vps_timing_info_present_flag;
347     uint32_t vps_num_units_in_tick;
348     uint32_t vps_time_scale;
349     uint8_t vps_poc_proportional_to_timing_flag;
350     int vps_num_ticks_poc_diff_one; ///< vps_num_ticks_poc_diff_one_minus1 + 1
351     int vps_num_hrd_parameters;
352
353     uint8_t data[4096];
354     int data_size;
355 } HEVCVPS;
356
357 typedef struct ScalingList {
358     /* This is a little wasteful, since sizeID 0 only needs 8 coeffs,
359      * and size ID 3 only has 2 arrays, not 6. */
360     uint8_t sl[4][6][64];
361     uint8_t sl_dc[2][6];
362 } ScalingList;
363
364 typedef struct HEVCSPS {
365     unsigned vps_id;
366     int chroma_format_idc;
367     uint8_t separate_colour_plane_flag;
368
369     ///< output (i.e. cropped) values
370     int output_width, output_height;
371     HEVCWindow output_window;
372
373     HEVCWindow pic_conf_win;
374
375     int bit_depth;
376     int pixel_shift;
377     enum AVPixelFormat pix_fmt;
378
379     unsigned int log2_max_poc_lsb;
380     int pcm_enabled_flag;
381
382     int max_sub_layers;
383     struct {
384         int max_dec_pic_buffering;
385         int num_reorder_pics;
386         int max_latency_increase;
387     } temporal_layer[HEVC_MAX_SUB_LAYERS];
388
389     VUI vui;
390     PTL ptl;
391
392     uint8_t scaling_list_enable_flag;
393     ScalingList scaling_list;
394
395     unsigned int nb_st_rps;
396     ShortTermRPS st_rps[HEVC_MAX_SHORT_TERM_RPS_COUNT];
397
398     uint8_t amp_enabled_flag;
399     uint8_t sao_enabled;
400
401     uint8_t long_term_ref_pics_present_flag;
402     uint16_t lt_ref_pic_poc_lsb_sps[32];
403     uint8_t used_by_curr_pic_lt_sps_flag[32];
404     uint8_t num_long_term_ref_pics_sps;
405
406     struct {
407         uint8_t bit_depth;
408         uint8_t bit_depth_chroma;
409         unsigned int log2_min_pcm_cb_size;
410         unsigned int log2_max_pcm_cb_size;
411         uint8_t loop_filter_disable_flag;
412     } pcm;
413     uint8_t sps_temporal_mvp_enabled_flag;
414     uint8_t sps_strong_intra_smoothing_enable_flag;
415
416     unsigned int log2_min_cb_size;
417     unsigned int log2_diff_max_min_coding_block_size;
418     unsigned int log2_min_tb_size;
419     unsigned int log2_max_trafo_size;
420     unsigned int log2_ctb_size;
421     unsigned int log2_min_pu_size;
422
423     int max_transform_hierarchy_depth_inter;
424     int max_transform_hierarchy_depth_intra;
425
426     int transform_skip_rotation_enabled_flag;
427     int transform_skip_context_enabled_flag;
428     int implicit_rdpcm_enabled_flag;
429     int explicit_rdpcm_enabled_flag;
430     int intra_smoothing_disabled_flag;
431     int persistent_rice_adaptation_enabled_flag;
432
433     ///< coded frame dimension in various units
434     int width;
435     int height;
436     int ctb_width;
437     int ctb_height;
438     int ctb_size;
439     int min_cb_width;
440     int min_cb_height;
441     int min_tb_width;
442     int min_tb_height;
443     int min_pu_width;
444     int min_pu_height;
445     int tb_mask;
446
447     int hshift[3];
448     int vshift[3];
449
450     int qp_bd_offset;
451
452     uint8_t data[4096];
453     int data_size;
454 } HEVCSPS;
455
456 typedef struct HEVCPPS {
457     unsigned int sps_id; ///< seq_parameter_set_id
458
459     uint8_t sign_data_hiding_flag;
460
461     uint8_t cabac_init_present_flag;
462
463     int num_ref_idx_l0_default_active; ///< num_ref_idx_l0_default_active_minus1 + 1
464     int num_ref_idx_l1_default_active; ///< num_ref_idx_l1_default_active_minus1 + 1
465     int pic_init_qp_minus26;
466
467     uint8_t constrained_intra_pred_flag;
468     uint8_t transform_skip_enabled_flag;
469
470     uint8_t cu_qp_delta_enabled_flag;
471     int diff_cu_qp_delta_depth;
472
473     int cb_qp_offset;
474     int cr_qp_offset;
475     uint8_t pic_slice_level_chroma_qp_offsets_present_flag;
476     uint8_t weighted_pred_flag;
477     uint8_t weighted_bipred_flag;
478     uint8_t output_flag_present_flag;
479     uint8_t transquant_bypass_enable_flag;
480
481     uint8_t dependent_slice_segments_enabled_flag;
482     uint8_t tiles_enabled_flag;
483     uint8_t entropy_coding_sync_enabled_flag;
484
485     int num_tile_columns;   ///< num_tile_columns_minus1 + 1
486     int num_tile_rows;      ///< num_tile_rows_minus1 + 1
487     uint8_t uniform_spacing_flag;
488     uint8_t loop_filter_across_tiles_enabled_flag;
489
490     uint8_t seq_loop_filter_across_slices_enabled_flag;
491
492     uint8_t deblocking_filter_control_present_flag;
493     uint8_t deblocking_filter_override_enabled_flag;
494     uint8_t disable_dbf;
495     int beta_offset;    ///< beta_offset_div2 * 2
496     int tc_offset;      ///< tc_offset_div2 * 2
497
498     uint8_t scaling_list_data_present_flag;
499     ScalingList scaling_list;
500
501     uint8_t lists_modification_present_flag;
502     int log2_parallel_merge_level; ///< log2_parallel_merge_level_minus2 + 2
503     int num_extra_slice_header_bits;
504     uint8_t slice_header_extension_present_flag;
505     uint8_t log2_max_transform_skip_block_size;
506     uint8_t cross_component_prediction_enabled_flag;
507     uint8_t chroma_qp_offset_list_enabled_flag;
508     uint8_t diff_cu_chroma_qp_offset_depth;
509     uint8_t chroma_qp_offset_list_len_minus1;
510     int8_t  cb_qp_offset_list[5];
511     int8_t  cr_qp_offset_list[5];
512     uint8_t log2_sao_offset_scale_luma;
513     uint8_t log2_sao_offset_scale_chroma;
514
515     // Inferred parameters
516     unsigned int *column_width;  ///< ColumnWidth
517     unsigned int *row_height;    ///< RowHeight
518     unsigned int *col_bd;        ///< ColBd
519     unsigned int *row_bd;        ///< RowBd
520     int *col_idxX;
521
522     int *ctb_addr_rs_to_ts; ///< CtbAddrRSToTS
523     int *ctb_addr_ts_to_rs; ///< CtbAddrTSToRS
524     int *tile_id;           ///< TileId
525     int *tile_pos_rs;       ///< TilePosRS
526     int *min_tb_addr_zs;    ///< MinTbAddrZS
527     int *min_tb_addr_zs_tab;///< MinTbAddrZS
528
529     uint8_t data[4096];
530     int data_size;
531 } HEVCPPS;
532
533 typedef struct HEVCParamSets {
534     AVBufferRef *vps_list[HEVC_MAX_VPS_COUNT];
535     AVBufferRef *sps_list[HEVC_MAX_SPS_COUNT];
536     AVBufferRef *pps_list[HEVC_MAX_PPS_COUNT];
537
538     /* currently active parameter sets */
539     const HEVCVPS *vps;
540     const HEVCSPS *sps;
541     const HEVCPPS *pps;
542 } HEVCParamSets;
543
544 typedef struct SliceHeader {
545     unsigned int pps_id;
546
547     ///< address (in raster order) of the first block in the current slice segment
548     unsigned int   slice_segment_addr;
549     ///< address (in raster order) of the first block in the current slice
550     unsigned int   slice_addr;
551
552     enum SliceType slice_type;
553
554     int pic_order_cnt_lsb;
555
556     uint8_t first_slice_in_pic_flag;
557     uint8_t dependent_slice_segment_flag;
558     uint8_t pic_output_flag;
559     uint8_t colour_plane_id;
560
561     ///< RPS coded in the slice header itself is stored here
562     int short_term_ref_pic_set_sps_flag;
563     int short_term_ref_pic_set_size;
564     ShortTermRPS slice_rps;
565     const ShortTermRPS *short_term_rps;
566     int long_term_ref_pic_set_size;
567     LongTermRPS long_term_rps;
568     unsigned int list_entry_lx[2][32];
569
570     uint8_t rpl_modification_flag[2];
571     uint8_t no_output_of_prior_pics_flag;
572     uint8_t slice_temporal_mvp_enabled_flag;
573
574     unsigned int nb_refs[2];
575
576     uint8_t slice_sample_adaptive_offset_flag[3];
577     uint8_t mvd_l1_zero_flag;
578
579     uint8_t cabac_init_flag;
580     uint8_t disable_deblocking_filter_flag; ///< slice_header_disable_deblocking_filter_flag
581     uint8_t slice_loop_filter_across_slices_enabled_flag;
582     uint8_t collocated_list;
583
584     unsigned int collocated_ref_idx;
585
586     int slice_qp_delta;
587     int slice_cb_qp_offset;
588     int slice_cr_qp_offset;
589
590     uint8_t cu_chroma_qp_offset_enabled_flag;
591
592     int beta_offset;    ///< beta_offset_div2 * 2
593     int tc_offset;      ///< tc_offset_div2 * 2
594
595     unsigned int max_num_merge_cand; ///< 5 - 5_minus_max_num_merge_cand
596
597     unsigned *entry_point_offset;
598     int * offset;
599     int * size;
600     int num_entry_point_offsets;
601
602     int8_t slice_qp;
603
604     uint8_t luma_log2_weight_denom;
605     int16_t chroma_log2_weight_denom;
606
607     int16_t luma_weight_l0[16];
608     int16_t chroma_weight_l0[16][2];
609     int16_t chroma_weight_l1[16][2];
610     int16_t luma_weight_l1[16];
611
612     int16_t luma_offset_l0[16];
613     int16_t chroma_offset_l0[16][2];
614
615     int16_t luma_offset_l1[16];
616     int16_t chroma_offset_l1[16][2];
617
618     int slice_ctb_addr_rs;
619 } SliceHeader;
620
621 typedef struct CodingUnit {
622     int x;
623     int y;
624
625     enum PredMode pred_mode;    ///< PredMode
626     enum PartMode part_mode;    ///< PartMode
627
628     // Inferred parameters
629     uint8_t intra_split_flag;   ///< IntraSplitFlag
630     uint8_t max_trafo_depth;    ///< MaxTrafoDepth
631     uint8_t cu_transquant_bypass_flag;
632 } CodingUnit;
633
634 typedef struct Mv {
635     int16_t x;  ///< horizontal component of motion vector
636     int16_t y;  ///< vertical component of motion vector
637 } Mv;
638
639 typedef struct MvField {
640     DECLARE_ALIGNED(4, Mv, mv)[2];
641     int8_t ref_idx[2];
642     int8_t pred_flag;
643 } MvField;
644
645 typedef struct NeighbourAvailable {
646     int cand_bottom_left;
647     int cand_left;
648     int cand_up;
649     int cand_up_left;
650     int cand_up_right;
651     int cand_up_right_sap;
652 } NeighbourAvailable;
653
654 typedef struct PredictionUnit {
655     int mpm_idx;
656     int rem_intra_luma_pred_mode;
657     uint8_t intra_pred_mode[4];
658     Mv mvd;
659     uint8_t merge_flag;
660     uint8_t intra_pred_mode_c[4];
661     uint8_t chroma_mode_c[4];
662 } PredictionUnit;
663
664 typedef struct TransformUnit {
665     int cu_qp_delta;
666
667     int res_scale_val;
668
669     // Inferred parameters;
670     int intra_pred_mode;
671     int intra_pred_mode_c;
672     int chroma_mode_c;
673     uint8_t is_cu_qp_delta_coded;
674     uint8_t is_cu_chroma_qp_offset_coded;
675     int8_t  cu_qp_offset_cb;
676     int8_t  cu_qp_offset_cr;
677     uint8_t cross_pf;
678 } TransformUnit;
679
680 typedef struct DBParams {
681     int beta_offset;
682     int tc_offset;
683 } DBParams;
684
685 #define HEVC_FRAME_FLAG_OUTPUT    (1 << 0)
686 #define HEVC_FRAME_FLAG_SHORT_REF (1 << 1)
687 #define HEVC_FRAME_FLAG_LONG_REF  (1 << 2)
688 #define HEVC_FRAME_FLAG_BUMPING   (1 << 3)
689
690 typedef struct HEVCFrame {
691     AVFrame *frame;
692     ThreadFrame tf;
693     MvField *tab_mvf;
694     RefPicList *refPicList;
695     RefPicListTab **rpl_tab;
696     int ctb_count;
697     int poc;
698     struct HEVCFrame *collocated_ref;
699
700     HEVCWindow window;
701
702     AVBufferRef *tab_mvf_buf;
703     AVBufferRef *rpl_tab_buf;
704     AVBufferRef *rpl_buf;
705
706     AVBufferRef *hwaccel_priv_buf;
707     void *hwaccel_picture_private;
708
709     /**
710      * A sequence counter, so that old frames are output first
711      * after a POC reset
712      */
713     uint16_t sequence;
714
715     /**
716      * A combination of HEVC_FRAME_FLAG_*
717      */
718     uint8_t flags;
719 } HEVCFrame;
720
721 typedef struct HEVCLocalContext {
722     uint8_t cabac_state[HEVC_CONTEXTS];
723
724     uint8_t stat_coeff[4];
725
726     uint8_t first_qp_group;
727
728     GetBitContext gb;
729     CABACContext cc;
730
731     int8_t qp_y;
732     int8_t curr_qp_y;
733
734     int qPy_pred;
735
736     TransformUnit tu;
737
738     uint8_t ctb_left_flag;
739     uint8_t ctb_up_flag;
740     uint8_t ctb_up_right_flag;
741     uint8_t ctb_up_left_flag;
742     int     end_of_tiles_x;
743     int     end_of_tiles_y;
744     /* +7 is for subpixel interpolation, *2 for high bit depths */
745     DECLARE_ALIGNED(32, uint8_t, edge_emu_buffer)[(MAX_PB_SIZE + 7) * EDGE_EMU_BUFFER_STRIDE * 2];
746     /* The extended size between the new edge emu buffer is abused by SAO */
747     DECLARE_ALIGNED(32, uint8_t, edge_emu_buffer2)[(MAX_PB_SIZE + 7) * EDGE_EMU_BUFFER_STRIDE * 2];
748     DECLARE_ALIGNED(32, int16_t, tmp [MAX_PB_SIZE * MAX_PB_SIZE]);
749
750     int ct_depth;
751     CodingUnit cu;
752     PredictionUnit pu;
753     NeighbourAvailable na;
754
755 #define BOUNDARY_LEFT_SLICE     (1 << 0)
756 #define BOUNDARY_LEFT_TILE      (1 << 1)
757 #define BOUNDARY_UPPER_SLICE    (1 << 2)
758 #define BOUNDARY_UPPER_TILE     (1 << 3)
759     /* properties of the boundary of the current CTB for the purposes
760      * of the deblocking filter */
761     int boundary_flags;
762 } HEVCLocalContext;
763
764 typedef struct HEVCContext {
765     const AVClass *c;  // needed by private avoptions
766     AVCodecContext *avctx;
767
768     struct HEVCContext  *sList[MAX_NB_THREADS];
769
770     HEVCLocalContext    *HEVClcList[MAX_NB_THREADS];
771     HEVCLocalContext    *HEVClc;
772
773     uint8_t             threads_type;
774     uint8_t             threads_number;
775
776     int                 width;
777     int                 height;
778
779     uint8_t *cabac_state;
780
781     /** 1 if the independent slice segment header was successfully parsed */
782     uint8_t slice_initialized;
783
784     AVFrame *frame;
785     AVFrame *output_frame;
786     uint8_t *sao_pixel_buffer_h[3];
787     uint8_t *sao_pixel_buffer_v[3];
788
789     HEVCParamSets ps;
790
791     AVBufferPool *tab_mvf_pool;
792     AVBufferPool *rpl_tab_pool;
793
794     ///< candidate references for the current frame
795     RefPicList rps[5];
796
797     SliceHeader sh;
798     SAOParams *sao;
799     DBParams *deblock;
800     enum HEVCNALUnitType nal_unit_type;
801     int temporal_id;  ///< temporal_id_plus1 - 1
802     HEVCFrame *ref;
803     HEVCFrame DPB[32];
804     int poc;
805     int pocTid0;
806     int slice_idx; ///< number of the slice being currently decoded
807     int eos;       ///< current packet contains an EOS/EOB NAL
808     int last_eos;  ///< last packet contains an EOS/EOB NAL
809     int max_ra;
810     int bs_width;
811     int bs_height;
812
813     int is_decoded;
814     int no_rasl_output_flag;
815
816     HEVCPredContext hpc;
817     HEVCDSPContext hevcdsp;
818     VideoDSPContext vdsp;
819     BswapDSPContext bdsp;
820     int8_t *qp_y_tab;
821     uint8_t *horizontal_bs;
822     uint8_t *vertical_bs;
823
824     int32_t *tab_slice_address;
825
826     //  CU
827     uint8_t *skip_flag;
828     uint8_t *tab_ct_depth;
829     // PU
830     uint8_t *tab_ipm;
831
832     uint8_t *cbf_luma; // cbf_luma of colocated TU
833     uint8_t *is_pcm;
834
835     // CTB-level flags affecting loop filter operation
836     uint8_t *filter_slice_edges;
837
838     /** used on BE to byteswap the lines for checksumming */
839     uint8_t *checksum_buf;
840     int      checksum_buf_size;
841
842     /**
843      * Sequence counters for decoded and output frames, so that old
844      * frames are output first after a POC reset
845      */
846     uint16_t seq_decode;
847     uint16_t seq_output;
848
849     int enable_parallel_tiles;
850     atomic_int wpp_err;
851
852     const uint8_t *data;
853
854     H2645Packet pkt;
855     // type of the first VCL NAL of the current frame
856     enum HEVCNALUnitType first_nal_type;
857
858     // for checking the frame checksums
859     struct AVMD5 *md5_ctx;
860     uint8_t       md5[3][16];
861     uint8_t is_md5;
862
863     uint8_t context_initialized;
864     uint8_t is_nalff;       ///< this flag is != 0 if bitstream is encapsulated
865                             ///< as a format defined in 14496-15
866     int apply_defdispwin;
867
868     int active_seq_parameter_set_id;
869
870     int nal_length_size;    ///< Number of bytes used for nal length (1, 2 or 4)
871     int nuh_layer_id;
872
873     /** frame packing arrangement variables */
874     int sei_frame_packing_present;
875     int frame_packing_arrangement_type;
876     int content_interpretation_type;
877     int quincunx_subsampling;
878
879     /** display orientation */
880     int sei_display_orientation_present;
881     int sei_anticlockwise_rotation;
882     int sei_hflip, sei_vflip;
883
884     int picture_struct;
885
886     uint8_t* a53_caption;
887     int a53_caption_size;
888
889     /** mastering display */
890     int sei_mastering_display_info_present;
891     uint16_t display_primaries[3][2];
892     uint16_t white_point[2];
893     uint32_t max_mastering_luminance;
894     uint32_t min_mastering_luminance;
895
896 } HEVCContext;
897
898 int ff_hevc_decode_short_term_rps(GetBitContext *gb, AVCodecContext *avctx,
899                                   ShortTermRPS *rps, const HEVCSPS *sps, int is_slice_header);
900
901 /**
902  * Parse the SPS from the bitstream into the provided HEVCSPS struct.
903  *
904  * @param sps_id the SPS id will be written here
905  * @param apply_defdispwin if set 1, the default display window from the VUI
906  *                         will be applied to the video dimensions
907  * @param vps_list if non-NULL, this function will validate that the SPS refers
908  *                 to an existing VPS
909  */
910 int ff_hevc_parse_sps(HEVCSPS *sps, GetBitContext *gb, unsigned int *sps_id,
911                       int apply_defdispwin, AVBufferRef **vps_list, AVCodecContext *avctx);
912
913 int ff_hevc_decode_nal_vps(GetBitContext *gb, AVCodecContext *avctx,
914                            HEVCParamSets *ps);
915 int ff_hevc_decode_nal_sps(GetBitContext *gb, AVCodecContext *avctx,
916                            HEVCParamSets *ps, int apply_defdispwin);
917 int ff_hevc_decode_nal_pps(GetBitContext *gb, AVCodecContext *avctx,
918                            HEVCParamSets *ps);
919 int ff_hevc_decode_nal_sei(HEVCContext *s);
920
921 /**
922  * Mark all frames in DPB as unused for reference.
923  */
924 void ff_hevc_clear_refs(HEVCContext *s);
925
926 /**
927  * Drop all frames currently in DPB.
928  */
929 void ff_hevc_flush_dpb(HEVCContext *s);
930
931 /**
932  * Compute POC of the current frame and return it.
933  */
934 int ff_hevc_compute_poc(HEVCContext *s, int poc_lsb);
935
936 RefPicList *ff_hevc_get_ref_list(HEVCContext *s, HEVCFrame *frame,
937                                  int x0, int y0);
938
939 /**
940  * Construct the reference picture sets for the current frame.
941  */
942 int ff_hevc_frame_rps(HEVCContext *s);
943
944 /**
945  * Construct the reference picture list(s) for the current slice.
946  */
947 int ff_hevc_slice_rpl(HEVCContext *s);
948
949 void ff_hevc_save_states(HEVCContext *s, int ctb_addr_ts);
950 void ff_hevc_cabac_init(HEVCContext *s, int ctb_addr_ts);
951 int ff_hevc_sao_merge_flag_decode(HEVCContext *s);
952 int ff_hevc_sao_type_idx_decode(HEVCContext *s);
953 int ff_hevc_sao_band_position_decode(HEVCContext *s);
954 int ff_hevc_sao_offset_abs_decode(HEVCContext *s);
955 int ff_hevc_sao_offset_sign_decode(HEVCContext *s);
956 int ff_hevc_sao_eo_class_decode(HEVCContext *s);
957 int ff_hevc_end_of_slice_flag_decode(HEVCContext *s);
958 int ff_hevc_cu_transquant_bypass_flag_decode(HEVCContext *s);
959 int ff_hevc_skip_flag_decode(HEVCContext *s, int x0, int y0,
960                              int x_cb, int y_cb);
961 int ff_hevc_pred_mode_decode(HEVCContext *s);
962 int ff_hevc_split_coding_unit_flag_decode(HEVCContext *s, int ct_depth,
963                                           int x0, int y0);
964 int ff_hevc_part_mode_decode(HEVCContext *s, int log2_cb_size);
965 int ff_hevc_pcm_flag_decode(HEVCContext *s);
966 int ff_hevc_prev_intra_luma_pred_flag_decode(HEVCContext *s);
967 int ff_hevc_mpm_idx_decode(HEVCContext *s);
968 int ff_hevc_rem_intra_luma_pred_mode_decode(HEVCContext *s);
969 int ff_hevc_intra_chroma_pred_mode_decode(HEVCContext *s);
970 int ff_hevc_merge_idx_decode(HEVCContext *s);
971 int ff_hevc_merge_flag_decode(HEVCContext *s);
972 int ff_hevc_inter_pred_idc_decode(HEVCContext *s, int nPbW, int nPbH);
973 int ff_hevc_ref_idx_lx_decode(HEVCContext *s, int num_ref_idx_lx);
974 int ff_hevc_mvp_lx_flag_decode(HEVCContext *s);
975 int ff_hevc_no_residual_syntax_flag_decode(HEVCContext *s);
976 int ff_hevc_split_transform_flag_decode(HEVCContext *s, int log2_trafo_size);
977 int ff_hevc_cbf_cb_cr_decode(HEVCContext *s, int trafo_depth);
978 int ff_hevc_cbf_luma_decode(HEVCContext *s, int trafo_depth);
979 int ff_hevc_log2_res_scale_abs(HEVCContext *s, int idx);
980 int ff_hevc_res_scale_sign_flag(HEVCContext *s, int idx);
981
982 /**
983  * Get the number of candidate references for the current frame.
984  */
985 int ff_hevc_frame_nb_refs(HEVCContext *s);
986
987 int ff_hevc_set_new_ref(HEVCContext *s, AVFrame **frame, int poc);
988
989 /**
990  * Find next frame in output order and put a reference to it in frame.
991  * @return 1 if a frame was output, 0 otherwise
992  */
993 int ff_hevc_output_frame(HEVCContext *s, AVFrame *frame, int flush);
994
995 void ff_hevc_bump_frame(HEVCContext *s);
996
997 void ff_hevc_unref_frame(HEVCContext *s, HEVCFrame *frame, int flags);
998
999 void ff_hevc_set_neighbour_available(HEVCContext *s, int x0, int y0,
1000                                      int nPbW, int nPbH);
1001 void ff_hevc_luma_mv_merge_mode(HEVCContext *s, int x0, int y0,
1002                                 int nPbW, int nPbH, int log2_cb_size,
1003                                 int part_idx, int merge_idx, MvField *mv);
1004 void ff_hevc_luma_mv_mvp_mode(HEVCContext *s, int x0, int y0,
1005                               int nPbW, int nPbH, int log2_cb_size,
1006                               int part_idx, int merge_idx,
1007                               MvField *mv, int mvp_lx_flag, int LX);
1008 void ff_hevc_set_qPy(HEVCContext *s, int xBase, int yBase,
1009                      int log2_cb_size);
1010 void ff_hevc_deblocking_boundary_strengths(HEVCContext *s, int x0, int y0,
1011                                            int log2_trafo_size);
1012 int ff_hevc_cu_qp_delta_sign_flag(HEVCContext *s);
1013 int ff_hevc_cu_qp_delta_abs(HEVCContext *s);
1014 int ff_hevc_cu_chroma_qp_offset_flag(HEVCContext *s);
1015 int ff_hevc_cu_chroma_qp_offset_idx(HEVCContext *s);
1016 void ff_hevc_hls_filter(HEVCContext *s, int x, int y, int ctb_size);
1017 void ff_hevc_hls_filters(HEVCContext *s, int x_ctb, int y_ctb, int ctb_size);
1018 void ff_hevc_hls_residual_coding(HEVCContext *s, int x0, int y0,
1019                                  int log2_trafo_size, enum ScanType scan_idx,
1020                                  int c_idx);
1021
1022 void ff_hevc_hls_mvd_coding(HEVCContext *s, int x0, int y0, int log2_cb_size);
1023
1024
1025 int ff_hevc_encode_nal_vps(HEVCVPS *vps, unsigned int id,
1026                            uint8_t *buf, int buf_size);
1027
1028 /**
1029  * Reset SEI values that are stored on the Context.
1030  * e.g. Caption data that was extracted during NAL
1031  * parsing.
1032  *
1033  * @param s HEVCContext.
1034  */
1035 void ff_hevc_reset_sei(HEVCContext *s);
1036
1037 extern const uint8_t ff_hevc_qpel_extra_before[4];
1038 extern const uint8_t ff_hevc_qpel_extra_after[4];
1039 extern const uint8_t ff_hevc_qpel_extra[4];
1040
1041 extern const uint8_t ff_hevc_diag_scan4x4_x[16];
1042 extern const uint8_t ff_hevc_diag_scan4x4_y[16];
1043 extern const uint8_t ff_hevc_diag_scan8x8_x[64];
1044 extern const uint8_t ff_hevc_diag_scan8x8_y[64];
1045
1046 #endif /* AVCODEC_HEVCDEC_H */