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