lavc: add a HEVC decoder.
[ffmpeg.git] / libavcodec / hevc.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_HEVC_H
24 #define AVCODEC_HEVC_H
25
26 #include "libavutil/buffer.h"
27 #include "libavutil/md5.h"
28
29 #include "avcodec.h"
30 #include "cabac.h"
31 #include "dsputil.h"
32 #include "get_bits.h"
33 #include "hevcpred.h"
34 #include "hevcdsp.h"
35 #include "internal.h"
36 #include "thread.h"
37 #include "videodsp.h"
38
39 #define MAX_DPB_SIZE 16 // A.4.1
40 #define MAX_REFS 16
41
42 /**
43  * 7.4.2.1
44  */
45 #define MAX_SUB_LAYERS 7
46 #define MAX_VPS_COUNT 16
47 #define MAX_SPS_COUNT 32
48 #define MAX_PPS_COUNT 256
49 #define MAX_SHORT_TERM_RPS_COUNT 64
50 #define MAX_CU_SIZE 128
51
52 //TODO: check if this is really the maximum
53 #define MAX_TRANSFORM_DEPTH 5
54
55 #define MAX_TB_SIZE 32
56 #define MAX_PB_SIZE 64
57 #define MAX_LOG2_CTB_SIZE 6
58 #define MAX_QP 51
59 #define DEFAULT_INTRA_TC_OFFSET 2
60
61 #define HEVC_CONTEXTS 183
62
63 #define MRG_MAX_NUM_CANDS     5
64
65 #define L0 0
66 #define L1 1
67
68 #define EPEL_EXTRA_BEFORE 1
69 #define EPEL_EXTRA_AFTER  2
70 #define EPEL_EXTRA        3
71
72 /**
73  * Value of the luma sample at position (x, y) in the 2D array tab.
74  */
75 #define SAMPLE(tab, x, y) ((tab)[(y) * s->sps->width + (x)])
76 #define SAMPLE_CTB(tab, x, y) ((tab)[(y) * pic_width_in_ctb + (x)])
77 #define SAMPLE_CBF(tab, x, y) ((tab)[((y) & ((1<<log2_trafo_size)-1)) * MAX_CU_SIZE + ((x) & ((1<<log2_trafo_size)-1))])
78
79 #define IS_IDR(s) (s->nal_unit_type == NAL_IDR_W_RADL || s->nal_unit_type == NAL_IDR_N_LP)
80 #define IS_BLA(s) (s->nal_unit_type == NAL_BLA_W_RADL || s->nal_unit_type == NAL_BLA_W_LP || \
81                    s->nal_unit_type == NAL_BLA_N_LP)
82
83 /**
84  * Table 7-3: NAL unit type codes
85  */
86 enum NALUnitType {
87     NAL_TRAIL_N     =  0,
88     NAL_TRAIL_R     =  1,
89     NAL_TSA_N       =  2,
90     NAL_TSA_R       =  3,
91     NAL_STSA_N      =  4,
92     NAL_STSA_R      =  5,
93     NAL_RADL_N      =  6,
94     NAL_RADL_R      =  7,
95     NAL_RASL_N      =  8,
96     NAL_RASL_R      =  9,
97     NAL_BLA_W_LP    = 16,
98     NAL_BLA_W_RADL  = 17,
99     NAL_BLA_N_LP    = 18,
100     NAL_IDR_W_RADL  = 19,
101     NAL_IDR_N_LP    = 20,
102     NAL_CRA_NUT     = 21,
103     NAL_VPS         = 32,
104     NAL_SPS         = 33,
105     NAL_PPS         = 34,
106     NAL_AUD         = 35,
107     NAL_EOS_NUT     = 36,
108     NAL_EOB_NUT     = 37,
109     NAL_FD_NUT      = 38,
110     NAL_SEI_PREFIX  = 39,
111     NAL_SEI_SUFFIX  = 40,
112 };
113
114 enum RPSType {
115     ST_CURR_BEF = 0,
116     ST_CURR_AFT,
117     ST_FOLL,
118     LT_CURR,
119     LT_FOLL,
120     NB_RPS_TYPE,
121 };
122
123 enum SliceType {
124     B_SLICE = 0,
125     P_SLICE = 1,
126     I_SLICE = 2,
127 };
128
129 enum SyntaxElement {
130     SAO_MERGE_FLAG = 0,
131     SAO_TYPE_IDX,
132     SAO_EO_CLASS,
133     SAO_BAND_POSITION,
134     SAO_OFFSET_ABS,
135     SAO_OFFSET_SIGN,
136     END_OF_SLICE_FLAG,
137     SPLIT_CODING_UNIT_FLAG,
138     CU_TRANSQUANT_BYPASS_FLAG,
139     SKIP_FLAG,
140     CU_QP_DELTA,
141     PRED_MODE_FLAG,
142     PART_MODE,
143     PCM_FLAG,
144     PREV_INTRA_LUMA_PRED_FLAG,
145     MPM_IDX,
146     REM_INTRA_LUMA_PRED_MODE,
147     INTRA_CHROMA_PRED_MODE,
148     MERGE_FLAG,
149     MERGE_IDX,
150     INTER_PRED_IDC,
151     REF_IDX_L0,
152     REF_IDX_L1,
153     ABS_MVD_GREATER0_FLAG,
154     ABS_MVD_GREATER1_FLAG,
155     ABS_MVD_MINUS2,
156     MVD_SIGN_FLAG,
157     MVP_LX_FLAG,
158     NO_RESIDUAL_DATA_FLAG,
159     SPLIT_TRANSFORM_FLAG,
160     CBF_LUMA,
161     CBF_CB_CR,
162     TRANSFORM_SKIP_FLAG,
163     LAST_SIGNIFICANT_COEFF_X_PREFIX,
164     LAST_SIGNIFICANT_COEFF_Y_PREFIX,
165     LAST_SIGNIFICANT_COEFF_X_SUFFIX,
166     LAST_SIGNIFICANT_COEFF_Y_SUFFIX,
167     SIGNIFICANT_COEFF_GROUP_FLAG,
168     SIGNIFICANT_COEFF_FLAG,
169     COEFF_ABS_LEVEL_GREATER1_FLAG,
170     COEFF_ABS_LEVEL_GREATER2_FLAG,
171     COEFF_ABS_LEVEL_REMAINING,
172     COEFF_SIGN_FLAG,
173 };
174
175 enum PartMode {
176     PART_2Nx2N = 0,
177     PART_2NxN  = 1,
178     PART_Nx2N  = 2,
179     PART_NxN   = 3,
180     PART_2NxnU = 4,
181     PART_2NxnD = 5,
182     PART_nLx2N = 6,
183     PART_nRx2N = 7,
184 };
185
186 enum PredMode {
187     MODE_INTER = 0,
188     MODE_INTRA,
189     MODE_SKIP,
190 };
191
192 enum InterPredIdc {
193     PRED_L0 = 0,
194     PRED_L1,
195     PRED_BI,
196 };
197
198 enum IntraPredMode {
199     INTRA_PLANAR = 0,
200     INTRA_DC,
201     INTRA_ANGULAR_2,
202     INTRA_ANGULAR_3,
203     INTRA_ANGULAR_4,
204     INTRA_ANGULAR_5,
205     INTRA_ANGULAR_6,
206     INTRA_ANGULAR_7,
207     INTRA_ANGULAR_8,
208     INTRA_ANGULAR_9,
209     INTRA_ANGULAR_10,
210     INTRA_ANGULAR_11,
211     INTRA_ANGULAR_12,
212     INTRA_ANGULAR_13,
213     INTRA_ANGULAR_14,
214     INTRA_ANGULAR_15,
215     INTRA_ANGULAR_16,
216     INTRA_ANGULAR_17,
217     INTRA_ANGULAR_18,
218     INTRA_ANGULAR_19,
219     INTRA_ANGULAR_20,
220     INTRA_ANGULAR_21,
221     INTRA_ANGULAR_22,
222     INTRA_ANGULAR_23,
223     INTRA_ANGULAR_24,
224     INTRA_ANGULAR_25,
225     INTRA_ANGULAR_26,
226     INTRA_ANGULAR_27,
227     INTRA_ANGULAR_28,
228     INTRA_ANGULAR_29,
229     INTRA_ANGULAR_30,
230     INTRA_ANGULAR_31,
231     INTRA_ANGULAR_32,
232     INTRA_ANGULAR_33,
233     INTRA_ANGULAR_34,
234 };
235
236 enum SAOType {
237     SAO_NOT_APPLIED = 0,
238     SAO_BAND,
239     SAO_EDGE,
240 };
241
242 enum SAOEOClass {
243     SAO_EO_HORIZ = 0,
244     SAO_EO_VERT,
245     SAO_EO_135D,
246     SAO_EO_45D,
247 };
248
249 enum ScanType {
250     SCAN_DIAG = 0,
251     SCAN_HORIZ,
252     SCAN_VERT,
253 };
254
255 typedef struct ShortTermRPS {
256     int num_negative_pics;
257     int num_delta_pocs;
258     int32_t delta_poc[32];
259     uint8_t used[32];
260 } ShortTermRPS;
261
262 typedef struct LongTermRPS {
263     int     poc[32];
264     uint8_t used[32];
265     uint8_t nb_refs;
266 } LongTermRPS;
267
268 typedef struct RefPicList {
269     struct HEVCFrame *ref[MAX_REFS];
270     int list[MAX_REFS];
271     int isLongTerm[MAX_REFS];
272     int nb_refs;
273 } RefPicList;
274
275 typedef struct RefPicListTab {
276     RefPicList refPicList[2];
277 } RefPicListTab;
278
279 typedef struct HEVCWindow {
280     int left_offset;
281     int right_offset;
282     int top_offset;
283     int bottom_offset;
284 } HEVCWindow;
285
286 typedef struct VUI {
287     AVRational sar;
288
289     int overscan_info_present_flag;
290     int overscan_appropriate_flag;
291
292     int video_signal_type_present_flag;
293     int video_format;
294     int video_full_range_flag;
295     int colour_description_present_flag;
296     uint8_t colour_primaries;
297     uint8_t transfer_characteristic;
298     uint8_t matrix_coeffs;
299
300     int chroma_loc_info_present_flag;
301     int chroma_sample_loc_type_top_field;
302     int chroma_sample_loc_type_bottom_field;
303     int neutra_chroma_indication_flag;
304
305     int field_seq_flag;
306     int frame_field_info_present_flag;
307
308     int default_display_window_flag;
309     HEVCWindow def_disp_win;
310
311     int vui_timing_info_present_flag;
312     uint32_t vui_num_units_in_tick;
313     uint32_t vui_time_scale;
314     int vui_poc_proportional_to_timing_flag;
315     int vui_num_ticks_poc_diff_one_minus1;
316     int vui_hrd_parameters_present_flag;
317
318     int bitstream_restriction_flag;
319     int tiles_fixed_structure_flag;
320     int motion_vectors_over_pic_boundaries_flag;
321     int restricted_ref_pic_lists_flag;
322     int min_spatial_segmentation_idc;
323     int max_bytes_per_pic_denom;
324     int max_bits_per_min_cu_denom;
325     int log2_max_mv_length_horizontal;
326     int log2_max_mv_length_vertical;
327 } VUI;
328
329 typedef struct PTL {
330     int general_profile_space;
331     uint8_t general_tier_flag;
332     int general_profile_idc;
333     int general_profile_compatibility_flag[32];
334     int general_level_idc;
335
336     uint8_t sub_layer_profile_present_flag[MAX_SUB_LAYERS];
337     uint8_t sub_layer_level_present_flag[MAX_SUB_LAYERS];
338
339     int sub_layer_profile_space[MAX_SUB_LAYERS];
340     uint8_t sub_layer_tier_flag[MAX_SUB_LAYERS];
341     int sub_layer_profile_idc[MAX_SUB_LAYERS];
342     uint8_t sub_layer_profile_compatibility_flags[MAX_SUB_LAYERS][32];
343     int sub_layer_level_idc[MAX_SUB_LAYERS];
344 } PTL;
345
346 typedef struct VPS {
347     uint8_t vps_temporal_id_nesting_flag;
348     int vps_max_layers;
349     int vps_max_sub_layers; ///< vps_max_temporal_layers_minus1 + 1
350
351     PTL ptl;
352     int vps_sub_layer_ordering_info_present_flag;
353     unsigned int vps_max_dec_pic_buffering[MAX_SUB_LAYERS];
354     unsigned int vps_num_reorder_pics[MAX_SUB_LAYERS];
355     unsigned int vps_max_latency_increase[MAX_SUB_LAYERS];
356     int vps_max_layer_id;
357     int vps_num_layer_sets; ///< vps_num_layer_sets_minus1 + 1
358     uint8_t vps_timing_info_present_flag;
359     uint32_t vps_num_units_in_tick;
360     uint32_t vps_time_scale;
361     uint8_t vps_poc_proportional_to_timing_flag;
362     int vps_num_ticks_poc_diff_one; ///< vps_num_ticks_poc_diff_one_minus1 + 1
363     int vps_num_hrd_parameters;
364 } VPS;
365
366 typedef struct ScalingList {
367     // This is a little wasteful, since sizeID 0 only needs 8 coeffs, and size ID 3 only has 2 arrays, not 6.
368     uint8_t sl[4][6][64];
369     uint8_t sl_dc[2][6];
370 } ScalingList;
371
372 typedef struct HEVCSPS {
373     int vps_id;
374     int chroma_format_idc;
375     uint8_t separate_colour_plane_flag;
376
377     ///< output (i.e. cropped) values
378     int output_width, output_height;
379     HEVCWindow output_window;
380
381     HEVCWindow pic_conf_win;
382
383     int bit_depth;
384     int pixel_shift;
385     enum AVPixelFormat pix_fmt;
386
387     unsigned int log2_max_poc_lsb;
388     int pcm_enabled_flag;
389
390     int max_sub_layers;
391     struct {
392         int max_dec_pic_buffering;
393         int num_reorder_pics;
394         int max_latency_increase;
395     } temporal_layer[MAX_SUB_LAYERS];
396
397     VUI vui;
398     PTL ptl;
399
400     uint8_t scaling_list_enable_flag;
401     ScalingList scaling_list;
402
403     unsigned int nb_st_rps;
404     ShortTermRPS st_rps[MAX_SHORT_TERM_RPS_COUNT];
405
406     uint8_t amp_enabled_flag;
407     uint8_t sao_enabled;
408
409     uint8_t long_term_ref_pics_present_flag;
410     uint16_t lt_ref_pic_poc_lsb_sps[32];
411     uint8_t used_by_curr_pic_lt_sps_flag[32];
412     uint8_t num_long_term_ref_pics_sps;
413
414     struct {
415         uint8_t bit_depth;
416         unsigned int log2_min_pcm_cb_size;
417         unsigned int log2_max_pcm_cb_size;
418         uint8_t loop_filter_disable_flag;
419     } pcm;
420     uint8_t sps_temporal_mvp_enabled_flag;
421     uint8_t sps_strong_intra_smoothing_enable_flag;
422
423     unsigned int log2_min_coding_block_size;
424     unsigned int log2_diff_max_min_coding_block_size;
425     unsigned int log2_min_transform_block_size;
426     unsigned int log2_max_trafo_size;
427     unsigned int log2_ctb_size;
428     unsigned int log2_min_pu_size;
429
430     int max_transform_hierarchy_depth_inter;
431     int max_transform_hierarchy_depth_intra;
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
444     int hshift[3];
445     int vshift[3];
446
447     int qp_bd_offset;
448 } HEVCSPS;
449
450 typedef struct HEVCPPS {
451     int sps_id; ///< seq_parameter_set_id
452
453     uint8_t sign_data_hiding_flag;
454
455     uint8_t cabac_init_present_flag;
456
457     int num_ref_idx_l0_default_active; ///< num_ref_idx_l0_default_active_minus1 + 1
458     int num_ref_idx_l1_default_active; ///< num_ref_idx_l1_default_active_minus1 + 1
459     int pic_init_qp_minus26;
460
461     uint8_t constrained_intra_pred_flag;
462     uint8_t transform_skip_enabled_flag;
463
464     uint8_t cu_qp_delta_enabled_flag;
465     int diff_cu_qp_delta_depth;
466
467     int cb_qp_offset;
468     int cr_qp_offset;
469     uint8_t pic_slice_level_chroma_qp_offsets_present_flag;
470     uint8_t weighted_pred_flag;
471     uint8_t weighted_bipred_flag;
472     uint8_t output_flag_present_flag;
473     uint8_t transquant_bypass_enable_flag;
474
475     uint8_t dependent_slice_segments_enabled_flag;
476     uint8_t tiles_enabled_flag;
477     uint8_t entropy_coding_sync_enabled_flag;
478
479     int num_tile_columns; ///< num_tile_columns_minus1 + 1
480     int num_tile_rows; ///< num_tile_rows_minus1 + 1
481     uint8_t uniform_spacing_flag;
482     uint8_t loop_filter_across_tiles_enabled_flag;
483
484     uint8_t seq_loop_filter_across_slices_enabled_flag;
485
486     uint8_t deblocking_filter_control_present_flag;
487     uint8_t deblocking_filter_override_enabled_flag;
488     uint8_t pps_disable_deblocking_filter_flag;
489     int beta_offset; ///< beta_offset_div2 * 2
490     int tc_offset; ///< tc_offset_div2 * 2
491
492     int pps_scaling_list_data_present_flag;
493     ScalingList scaling_list;
494
495     uint8_t lists_modification_present_flag;
496     int log2_parallel_merge_level; ///< log2_parallel_merge_level_minus2 + 2
497     int num_extra_slice_header_bits;
498     uint8_t slice_header_extension_present_flag;
499
500     uint8_t pps_extension_flag;
501     uint8_t pps_extension_data_flag;
502
503     // Inferred parameters
504     int *column_width; ///< ColumnWidth
505     int *row_height; ///< RowHeight
506     int *col_bd; ///< ColBd
507     int *row_bd; ///< RowBd
508     int *col_idxX;
509
510     int *ctb_addr_rs_to_ts; ///< CtbAddrRSToTS
511     int *ctb_addr_ts_to_rs; ///< CtbAddrTSToRS
512     int *tile_id; ///< TileId
513     int *tile_pos_rs; ///< TilePosRS
514     int *min_cb_addr_zs; ///< MinCbAddrZS
515     int *min_tb_addr_zs; ///< MinTbAddrZS
516 } HEVCPPS;
517
518 typedef struct SliceHeader {
519     int pps_id;
520
521     ///< address (in raster order) of the first block in the current slice segment
522     unsigned int   slice_segment_addr;
523     ///< address (in raster order) of the first block in the current slice
524     unsigned int   slice_addr;
525
526     enum SliceType slice_type;
527
528     int pic_order_cnt_lsb;
529
530     uint8_t first_slice_in_pic_flag;
531     uint8_t dependent_slice_segment_flag;
532     uint8_t pic_output_flag;
533     uint8_t colour_plane_id;
534
535     ///< RPS coded in the slice header itself is stored here
536     ShortTermRPS slice_rps;
537     const ShortTermRPS *short_term_rps;
538     LongTermRPS long_term_rps;
539     uint8_t rpl_modification_flag[2];
540     unsigned int list_entry_lx[2][32];
541
542     uint8_t no_output_of_prior_pics_flag;
543
544     uint8_t slice_sample_adaptive_offset_flag[3];
545
546     uint8_t slice_temporal_mvp_enabled_flag;
547     unsigned int nb_refs[2];
548
549     uint8_t mvd_l1_zero_flag;
550     uint8_t cabac_init_flag;
551     uint8_t collocated_list;
552     unsigned int collocated_ref_idx;
553     int slice_qp_delta;
554     int slice_cb_qp_offset;
555     int slice_cr_qp_offset;
556
557     uint8_t disable_deblocking_filter_flag; ///< slice_header_disable_deblocking_filter_flag
558     int beta_offset; ///< beta_offset_div2 * 2
559     int tc_offset; ///< tc_offset_div2 * 2
560
561     int max_num_merge_cand; ///< 5 - 5_minus_max_num_merge_cand
562
563     uint8_t slice_loop_filter_across_slices_enabled_flag;
564
565     int num_entry_point_offsets;
566
567     uint8_t luma_log2_weight_denom;
568     int16_t chroma_log2_weight_denom;
569
570     int16_t luma_weight_l0[16];
571     int16_t chroma_weight_l0[16][2];
572     int16_t chroma_weight_l1[16][2];
573     int16_t luma_weight_l1[16];
574
575
576     int16_t luma_offset_l0[16];
577     int16_t chroma_offset_l0[16][2];
578
579     int16_t luma_offset_l1[16];
580     int16_t chroma_offset_l1[16][2];
581
582     // Inferred parameters
583     int8_t slice_qp;
584     int    slice_ctb_addr_rs;
585 } SliceHeader;
586
587 typedef struct CodingTree {
588     int depth; ///< ctDepth
589 } CodingTree;
590
591 typedef struct CodingUnit {
592     uint8_t cu_transquant_bypass_flag;
593
594     enum PredMode pred_mode; ///< PredMode
595     enum PartMode part_mode; ///< PartMode
596     uint8_t rqt_root_cbf;
597
598     uint8_t pcm_flag;
599
600     // Inferred parameters
601     uint8_t intra_split_flag; ///< IntraSplitFlag
602     uint8_t max_trafo_depth; ///< MaxTrafoDepth
603
604     int x;
605     int y;
606
607 } CodingUnit;
608
609 typedef struct Mv {
610     int16_t x;     ///< horizontal component of motion vector
611     int16_t y;     ///< vertical component of motion vector
612 } Mv;
613
614 typedef struct MvField {
615       Mv  mv[2];
616       int8_t ref_idx[2];
617       int8_t pred_flag[2];
618       uint8_t is_intra;
619 } MvField;
620
621 typedef struct NeighbourAvailable {
622     int cand_bottom_left;
623     int cand_left;
624     int cand_up;
625     int cand_up_left;
626     int cand_up_right;
627     int cand_up_right_sap;
628 } NeighbourAvailable;
629
630 typedef struct PredictionUnit {
631     uint8_t merge_flag;
632     int mpm_idx;
633     int rem_intra_luma_pred_mode;
634     uint8_t intra_pred_mode[4];
635     uint8_t intra_pred_mode_c;
636     Mv mvd;
637 } PredictionUnit;
638
639 typedef struct TransformTree {
640     uint8_t cbf_cb[MAX_TRANSFORM_DEPTH][MAX_CU_SIZE * MAX_CU_SIZE];
641     uint8_t cbf_cr[MAX_TRANSFORM_DEPTH][MAX_CU_SIZE * MAX_CU_SIZE];
642     uint8_t cbf_luma;
643
644     // Inferred parameters
645     uint8_t inter_split_flag;
646 } TransformTree;
647
648 typedef struct TransformUnit {
649     int cu_qp_delta;
650
651     // Inferred parameters;
652     uint8_t is_cu_qp_delta_coded;
653     int cur_intra_pred_mode;
654 } TransformUnit;
655
656 typedef struct ResidualCoding {
657     uint8_t significant_coeff_group_flag[8][8];
658 } ResidualCoding;
659
660 typedef struct SAOParams {
661     uint8_t type_idx[3]; ///< sao_type_idx
662
663     int offset_abs[3][4]; ///< sao_offset_abs
664     int offset_sign[3][4]; ///< sao_offset_sign
665
666     int band_position[3]; ///< sao_band_position
667
668     int eo_class[3]; ///< sao_eo_class
669
670     // Inferred parameters
671     int offset_val[3][5]; ///<SaoOffsetVal
672 } SAOParams;
673
674 typedef struct DBParams {
675     uint8_t disable;
676     int beta_offset;
677     int tc_offset;
678 } DBParams;
679
680 #define HEVC_FRAME_FLAG_OUTPUT    (1 << 0)
681 #define HEVC_FRAME_FLAG_SHORT_REF (1 << 1)
682 #define HEVC_FRAME_FLAG_LONG_REF  (1 << 2)
683
684 typedef struct HEVCFrame {
685     AVFrame *frame;
686     ThreadFrame tf;
687     int poc;
688     MvField *tab_mvf;
689     RefPicList *refPicList;
690     RefPicListTab **rpl_tab;
691     int ctb_count;
692     struct HEVCFrame *collocated_ref;
693
694     /**
695      * A combination of HEVC_FRAME_FLAG_*
696      */
697     uint8_t flags;
698
699     /**
700      * A sequence counter, so that old frames are output first
701      * after a POC reset
702      */
703     uint16_t sequence;
704
705     HEVCWindow window;
706
707     AVBufferRef *tab_mvf_buf;
708     AVBufferRef *rpl_tab_buf;
709     AVBufferRef *rpl_buf;
710 } HEVCFrame;
711
712 typedef struct FilterData {
713         int x;
714         int y;
715         int size;
716     int slice_or_tiles_left_boundary;
717     int slice_or_tiles_up_boundary;
718 } FilterData;
719
720 typedef struct HEVCNAL {
721     uint8_t *rbsp_buffer;
722     int rbsp_buffer_size;
723     const uint8_t *data;
724     int size;
725 } HEVCNAL;
726
727 typedef struct HEVCLocalContext {
728     uint8_t cabac_state[HEVC_CONTEXTS];
729     int ctx_set;
730     int greater1_ctx;
731     int last_coeff_abs_level_greater1_flag;
732     int c_rice_param;
733     int last_coeff_abs_level_remaining;
734     GetBitContext gb;
735     CABACContext cc;
736     TransformTree tt;
737     TransformUnit tu;
738     ResidualCoding rc;
739     uint8_t first_qp_group;
740     int8_t qp_y;
741     int8_t curr_qp_y;
742     uint8_t slice_or_tiles_left_boundary;
743     uint8_t slice_or_tiles_up_boundary;
744     uint8_t ctb_left_flag;
745     uint8_t ctb_up_flag;
746     uint8_t ctb_up_right_flag;
747     uint8_t ctb_up_left_flag;
748     int     start_of_tiles_x;
749     int     end_of_tiles_x;
750     int     end_of_tiles_y;
751     uint8_t *edge_emu_buffer;
752     int      edge_emu_buffer_size;
753     CodingTree ct;
754     CodingUnit cu;
755     PredictionUnit pu;
756     NeighbourAvailable na;
757     DECLARE_ALIGNED(16, int16_t, mc_buffer[(MAX_PB_SIZE + 7) * MAX_PB_SIZE]);
758     FilterData *save_boundary_strengths;
759     int nb_saved;
760 } HEVCLocalContext;
761
762 typedef struct HEVCContext {
763     const AVClass *c;  // needed by private avoptions
764     AVCodecContext      *avctx;
765
766     HEVCLocalContext     HEVClc;
767
768     int                 disable_au;
769     int                 width;
770     int                 height;
771
772     uint8_t cabac_state[HEVC_CONTEXTS];
773
774     AVFrame *frame;
775     AVFrame *sao_frame;
776     AVFrame *tmp_frame;
777     AVFrame *output_frame;
778     VPS *vps;
779     const HEVCSPS *sps;
780     HEVCPPS *pps;
781     VPS *vps_list[MAX_VPS_COUNT];
782     AVBufferRef *sps_list[MAX_SPS_COUNT];
783     AVBufferRef *pps_list[MAX_PPS_COUNT];
784
785     ///< candidate references for the current frame
786     RefPicList rps[5];
787
788     SliceHeader sh;
789     SAOParams *sao;
790     DBParams *deblock;
791     enum NALUnitType nal_unit_type;
792     int temporal_id;  ///< temporal_id_plus1 - 1
793     HEVCFrame *ref;
794     HEVCFrame DPB[32];
795     int poc;
796     int pocTid0;
797     int slice_idx; ///< number of the slice being currently decoded
798     int eos;       ///< current packet contains an EOS/EOB NAL
799     int max_ra;
800     int bs_width;
801     int bs_height;
802
803     int is_decoded;
804
805     HEVCPredContext hpc;
806     HEVCDSPContext hevcdsp;
807     VideoDSPContext vdsp;
808     DSPContext dsp;
809     int8_t *qp_y_tab;
810     uint8_t *split_cu_flag;
811     uint8_t *horizontal_bs;
812     uint8_t *vertical_bs;
813
814     int32_t *tab_slice_address;
815
816     //  CU
817     uint8_t *skip_flag;
818     uint8_t *tab_ct_depth;
819     // PU
820     uint8_t *tab_ipm;
821
822
823     uint8_t *cbf_luma; // cbf_luma of colocated TU
824     uint8_t *is_pcm;
825
826     // CTB-level flags affecting loop filter operation
827     uint8_t *filter_slice_edges;
828
829     /** used on BE to byteswap the lines for checksumming */
830     uint8_t *checksum_buf;
831     int      checksum_buf_size;
832
833     /**
834      * Sequence counters for decoded and output frames, so that old
835      * frames are output first after a POC reset
836      */
837     uint16_t seq_decode;
838     uint16_t seq_output;
839
840     HEVCNAL *nals;
841     int nb_nals;
842     int nals_allocated;
843
844     int nuh_layer_id;
845
846     // for checking the frame checksums
847     struct AVMD5 *md5_ctx;
848     uint8_t       md5[3][16];
849     uint8_t is_md5;
850
851     /** 1 if the independent slice segment header was successfully parsed */
852     uint8_t slice_initialized;
853     int strict_def_disp_win;
854
855     int context_initialized;
856     int is_nalff;         ///< this flag is != 0 if bitstream is encapsulated
857                           ///< as a format defined in 14496-15
858     int nal_length_size;  ///< Number of bytes used for nal length (1, 2 or 4)
859
860
861     AVBufferPool *tab_mvf_pool;
862     AVBufferPool *rpl_tab_pool;
863 } HEVCContext;
864
865 int ff_hevc_decode_short_term_rps(HEVCContext *s, ShortTermRPS *rps,
866                                   const HEVCSPS *sps, int is_slice_header);
867 int ff_hevc_decode_nal_vps(HEVCContext *s);
868 int ff_hevc_decode_nal_sps(HEVCContext *s);
869 int ff_hevc_decode_nal_pps(HEVCContext *s);
870 int ff_hevc_decode_nal_sei(HEVCContext *s);
871
872 /**
873  * Mark all frames in DPB as unused for reference.
874  */
875 void ff_hevc_clear_refs(HEVCContext *s);
876
877 /**
878  * Drop all frames currently in DPB.
879  */
880 void ff_hevc_flush_dpb(HEVCContext *s);
881
882 /**
883  * Compute POC of the current frame and return it.
884  */
885 int ff_hevc_compute_poc(HEVCContext *s, int poc_lsb);
886
887 RefPicList* ff_hevc_get_ref_list(HEVCContext *s, HEVCFrame *frame, int x0, int y0);
888
889 /**
890  * Construct the reference picture sets for the current frame.
891  */
892 int ff_hevc_frame_rps(HEVCContext *s);
893
894 /**
895  * Construct the reference picture list(s) for the current slice.
896  */
897 int ff_hevc_slice_rpl(HEVCContext *s);
898
899 void ff_hevc_save_states(HEVCContext *s, int ctb_addr_ts);
900 void ff_hevc_cabac_init(HEVCContext *s, int ctb_addr_ts);
901 int ff_hevc_sao_merge_flag_decode(HEVCContext *s);
902 int ff_hevc_sao_type_idx_decode(HEVCContext *s);
903 int ff_hevc_sao_band_position_decode(HEVCContext *s);
904 int ff_hevc_sao_offset_abs_decode(HEVCContext *s);
905 int ff_hevc_sao_offset_sign_decode(HEVCContext *s);
906 int ff_hevc_sao_eo_class_decode(HEVCContext *s);
907 int ff_hevc_end_of_slice_flag_decode(HEVCContext *s);
908 int ff_hevc_cu_transquant_bypass_flag_decode(HEVCContext *s);
909 int ff_hevc_skip_flag_decode(HEVCContext *s, int x0, int y0, int x_cb, int y_cb);
910 int ff_hevc_pred_mode_decode(HEVCContext *s);
911 int ff_hevc_split_coding_unit_flag_decode(HEVCContext *s, int ct_depth, int x0, int y0);
912 int ff_hevc_part_mode_decode(HEVCContext *s, int log2_cb_size);
913 int ff_hevc_pcm_flag_decode(HEVCContext *s);
914 int ff_hevc_prev_intra_luma_pred_flag_decode(HEVCContext *s);
915 int ff_hevc_mpm_idx_decode(HEVCContext *s);
916 int ff_hevc_rem_intra_luma_pred_mode_decode(HEVCContext *s);
917 int ff_hevc_intra_chroma_pred_mode_decode(HEVCContext *s);
918 int ff_hevc_merge_idx_decode(HEVCContext *s);
919 int ff_hevc_merge_flag_decode(HEVCContext *s);
920 int ff_hevc_inter_pred_idc_decode(HEVCContext *s, int nPbW, int nPbH);
921 int ff_hevc_ref_idx_lx_decode(HEVCContext *s, int num_ref_idx_lx);
922 int ff_hevc_mvp_lx_flag_decode(HEVCContext *s);
923 int ff_hevc_no_residual_syntax_flag_decode(HEVCContext *s);
924 int ff_hevc_abs_mvd_greater0_flag_decode(HEVCContext *s);
925 int ff_hevc_abs_mvd_greater1_flag_decode(HEVCContext *s);
926 int ff_hevc_mvd_decode(HEVCContext *s);
927 int ff_hevc_mvd_sign_flag_decode(HEVCContext *s);
928 int ff_hevc_split_transform_flag_decode(HEVCContext *s, int log2_trafo_size);
929 int ff_hevc_cbf_cb_cr_decode(HEVCContext *s, int trafo_depth);
930 int ff_hevc_cbf_luma_decode(HEVCContext *s, int trafo_depth);
931 int ff_hevc_transform_skip_flag_decode(HEVCContext *s, int c_idx);
932 int ff_hevc_last_significant_coeff_x_prefix_decode(HEVCContext *s, int c_idx,
933                                                    int log2_size);
934 int ff_hevc_last_significant_coeff_y_prefix_decode(HEVCContext *s, int c_idx,
935                                                    int log2_size);
936 int ff_hevc_last_significant_coeff_suffix_decode(HEVCContext *s,
937                                                  int last_significant_coeff_prefix);
938 int ff_hevc_significant_coeff_group_flag_decode(HEVCContext *s, int c_idx, int x_cg,
939                                                 int y_cg, int log2_trafo_size);
940 int ff_hevc_significant_coeff_flag_decode(HEVCContext *s, int c_idx, int x_c, int y_c,
941                                           int log2_trafo_size, int scan_idx);
942 int ff_hevc_coeff_abs_level_greater1_flag_decode(HEVCContext *s, int c_idx,
943                                                  int i, int n,
944                                                  int first_greater1_coeff_idx,
945                                                  int first_subset);
946 int ff_hevc_coeff_abs_level_greater2_flag_decode(HEVCContext *s, int c_idx,
947                                                  int i, int n);
948 int ff_hevc_coeff_abs_level_remaining(HEVCContext *s, int n, int base_level);
949 int ff_hevc_coeff_sign_flag(HEVCContext *s, uint8_t nb);
950
951 /**
952  * Get the number of candidate references for the current frame.
953  */
954 int ff_hevc_frame_nb_refs(HEVCContext *s);
955
956 int ff_hevc_set_new_ref(HEVCContext *s, AVFrame **frame, int poc);
957
958 /**
959  * Find next frame in output order and put a reference to it in frame.
960  * @return 1 if a frame was output, 0 otherwise
961  */
962 int ff_hevc_output_frame(HEVCContext *s, AVFrame *frame, int flush);
963
964 void ff_hevc_unref_frame(HEVCContext *s, HEVCFrame *frame, int flags);
965
966 void ff_hevc_set_neighbour_available(HEVCContext *s, int x0, int y0, int nPbW, int nPbH);
967 void ff_hevc_luma_mv_merge_mode(HEVCContext *s, int x0, int y0, int nPbW, int nPbH, int log2_cb_size, int part_idx, int merge_idx, MvField *mv);
968 void ff_hevc_luma_mv_mvp_mode(HEVCContext *s, int x0, int y0, int nPbW, int nPbH, int log2_cb_size, int part_idx, int merge_idx, MvField *mv , int mvp_lx_flag, int LX);
969 void ff_hevc_set_qPy(HEVCContext *s, int xC, int yC, int xBase, int yBase, int log2_cb_size);
970 void ff_hevc_deblocking_boundary_strengths(HEVCContext *s, int x0, int y0, int log2_trafo_size,
971                                            int slice_or_tiles_up_boundary, int slice_or_tiles_left_boundary);
972 int ff_hevc_cu_qp_delta_sign_flag(HEVCContext *s);
973 int ff_hevc_cu_qp_delta_abs(HEVCContext *s);
974 void ff_hevc_hls_filter(HEVCContext *s, int x, int y);
975 void ff_hevc_hls_filters(HEVCContext *s, int x_ctb, int y_ctb, int ctb_size);
976
977 void ff_hevc_pps_free(HEVCPPS **ppps);
978
979 extern const uint8_t ff_hevc_qpel_extra_before[4];
980 extern const uint8_t ff_hevc_qpel_extra_after[4];
981 extern const uint8_t ff_hevc_qpel_extra[4];
982
983 extern const uint8_t ff_hevc_diag_scan4x4_x[16];
984 extern const uint8_t ff_hevc_diag_scan4x4_y[16];
985 extern const uint8_t ff_hevc_diag_scan8x8_x[64];
986 extern const uint8_t ff_hevc_diag_scan8x8_y[64];
987
988 #endif // AVCODEC_HEVC_H