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