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