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