1/******************************************************************************
2 *
3 * Copyright (C) 2015 The Android Open Source Project
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 *****************************************************************************
18 * Originally developed and contributed by Ittiam Systems Pvt. Ltd, Bangalore
19*/
20#ifndef _IH264D_DEFS_H_
21#define _IH264D_DEFS_H_
22
23/**
24 ************************************************************************
25 * \file ih264d_defs.h
26 *
27 * \brief
28 *    Type definitions used in the code
29 *
30 * \date
31 *    19/11/2002
32 *
33 * \author  Sriram Sethuraman
34 *
35 ************************************************************************
36 */
37#define H264_MAX_FRAME_WIDTH                3840
38#define H264_MAX_FRAME_HEIGHT               2176
39
40#define H264_MIN_FRAME_WIDTH                16
41#define H264_MIN_FRAME_HEIGHT               16
42
43#define FMT_CONV_NUM_ROWS       16
44
45/** Bit manipulation macros */
46#define CHECKBIT(a,i) ((a) &  (1 << i))
47#define CLEARBIT(a,i) ((a) &= ~(1 << i))
48
49/** Macro to convert a integer to a boolean value */
50#define BOOLEAN(x) (!!(x))
51
52/** Arithmetic operations */
53#define MOD(x,y) ((x)%(y))
54#define DIV(x,y) ((x)/(y))
55#define MUL(x,y) ((x)*(y))
56#define SIGN_POW2_DIV(x, y) (((x) < 0) ? (-((-(x)) >> (y))) : ((x) >> (y)))
57
58#define MB_ENABLE_FILTERING           0x00
59#define MB_DISABLE_FILTERING          0x01
60#define MB_DISABLE_TOP_EDGE           0x02
61#define MB_DISABLE_LEFT_EDGE          0x04
62
63/** Maximum number of reference pics */
64#define MAX_REF_BUFS    32
65#define MAX_DISP_BUFS_NEW 64
66#define MAX_FRAMES              16
67
68#define INVALID_FRAME_NUM       0x0fffffff
69#define GAP_FRAME_NUM           0x1fffffff
70
71/** macros for reference picture lists, refIdx to POC mapping */
72// 1 extra entry into reference picture lists for refIdx = -1.
73// this entry is always 0. this saves conditional checks in
74// FillBs modules.
75#define POC_LIST_L0_TO_L1_DIFF  (( 2*MAX_FRAMES) + 1)
76#define POC_LIST_L0_TO_L1_DIFF_1  ((MAX_FRAMES) + 1)
77
78#define FRM_LIST_L0             0                                               //0
79#define FRM_LIST_L1             1 * POC_LIST_L0_TO_L1_DIFF//FRM_LIST_L0 + POC_LIST_L0_TO_L1_DIFF        //0+33                  //(1 * POC_LIST_L0_TO_L1_DIFF)
80#define TOP_LIST_FLD_L0         2 * POC_LIST_L0_TO_L1_DIFF//FRM_LIST_L1 + POC_LIST_L0_TO_L1_DIFF        //0+33+33                   //(2 * POC_LIST_L0_TO_L1_DIFF)
81#define TOP_LIST_FLD_L1         3 * POC_LIST_L0_TO_L1_DIFF//TOP_LIST_FLD_L0 + POC_LIST_L0_TO_L1_DIFF_1  //0+33+33+17                //(3 * POC_LIST_L0_TO_L1_DIFF)
82#define BOT_LIST_FLD_L0         4 * POC_LIST_L0_TO_L1_DIFF//TOP_LIST_FLD_L1 + POC_LIST_L0_TO_L1_DIFF_1  //0+33+33+17+17
83#define BOT_LIST_FLD_L1         5 * POC_LIST_L0_TO_L1_DIFF//BOT_LIST_FLD_L0 + POC_LIST_L0_TO_L1_DIFF_1  //0+33+33+17+17+17
84#define TOTAL_LIST_ENTRIES      6 * POC_LIST_L0_TO_L1_DIFF//BOT_LIST_FLD_L1 + POC_LIST_L0_TO_L1_DIFF_1  //0+33+33+17+17+17+17
85#define PAD_MV_BANK_ROW             64
86#define OFFSET_MV_BANK_ROW          ((PAD_MV_BANK_ROW)>>1)
87#define PAD_PUC_CURNNZ              32
88#define OFFSET_PUC_CURNNZ           (PAD_PUC_CURNNZ)
89#define PAD_MAP_IDX_POC             (1)
90#define OFFSET_MAP_IDX_POC          (1)
91
92#define OFFSET_MAP_IDX_POC          (1)
93
94#define NAL_REF_IDC(nal_first_byte)       ((nal_first_byte >> 5) & 0x3)
95#define NAL_FORBIDDEN_BIT(nal_first_byte) (nal_first_byte>>7)
96#define NAL_UNIT_TYPE(nal_first_byte)     (nal_first_byte & 0x1F)
97
98#define INT_PIC_TYPE_I        (0x00)
99
100#define YIELD_CNT_THRESHOLD  8
101
102
103#define OK        0
104#define END       1
105#define NOT_OK    -1
106
107/* For 420SP */
108#define YUV420SP_FACTOR 2
109
110
111/**
112 ***************************************************************************
113 * Enum to hold various mem records being request
114 ****************************************************************************
115 */
116enum
117{
118    /**
119     * Codec Object at API level
120     */
121    MEM_REC_IV_OBJ,
122
123    /**
124     * Codec context
125     */
126    MEM_REC_CODEC,
127
128    /**
129     * Bitstream buffer which holds emulation prevention removed bytes
130     */
131    MEM_REC_BITSBUF,
132
133    /**
134     * Buffer to hold  coeff data
135     */
136    MEM_REC_COEFF_DATA,
137
138    /**
139     * Motion vector bank
140     */
141    MEM_REC_MVBANK,
142
143    /**
144     * Holds mem records passed to the codec.
145     */
146    MEM_REC_BACKUP,
147
148    /**
149     * Holds SPS
150     */
151    MEM_REC_SPS,
152
153    /**
154     * Holds PPS
155     */
156    MEM_REC_PPS,
157
158    /**
159     * Holds Slice Headers
160     */
161    MEM_REC_SLICE_HDR,
162
163    /**
164     * Holds thread handles
165     */
166    MEM_REC_THREAD_HANDLE,
167
168    /**
169     * Contains i4_status map indicating parse i4_status per MB basis
170     */
171    MEM_REC_PARSE_MAP,
172
173    /**
174     * Contains i4_status map indicating processing i4_status per MB basis
175     */
176    MEM_REC_PROC_MAP,
177
178    /**
179     * Contains slice number info for each MB
180     */
181
182    MEM_REC_SLICE_NUM_MAP,
183
184    /**
185     * Holds dpb manager context
186     */
187    MEM_REC_DPB_MGR,
188
189    /**
190     * Holds neighbors' info
191     */
192    MEM_REC_NEIGHBOR_INFO,
193
194    /**
195     * Holds neighbors' info
196     */
197    MEM_REC_PRED_INFO,
198
199
200    /**
201     * Holds inter pred inforamation on packed format info
202     */
203    MEM_REC_PRED_INFO_PKD,
204    /**
205     * Holds neighbors' info
206     */
207    MEM_REC_MB_INFO,
208
209    /**
210     * Holds deblock Mb info structure frame level)
211     */
212    MEM_REC_DEBLK_MB_INFO,
213
214    /**
215     * Holds  reference picture buffers in non-shared mode
216     */
217    MEM_REC_REF_PIC,
218
219    /**
220     * Holds  some misc intermediate_buffers
221     */
222    MEM_REC_EXTRA_MEM,
223
224    /**
225     * Holds  some misc intermediate_buffers
226     */
227    MEM_REC_INTERNAL_SCRATCH,
228
229    /**
230     * Holds  some misc intermediate_buffers
231     */
232    MEM_REC_INTERNAL_PERSIST,
233
234    /* holds structures related to picture buffer manager*/
235    MEM_REC_PIC_BUF_MGR,
236
237    /*holds structure related to MV buffer manager*/
238    MEM_REC_MV_BUF_MGR,
239
240    /**
241     * Place holder to compute number of memory records.
242     */
243    MEM_REC_CNT
244/* Do not add anything below */
245};
246
247#ifdef DEBLOCK_THREAD
248#define H264_MUTEX_LOCK(lock) ithread_mutex_lock(lock)
249#define H264_MUTEX_UNLOCK(lock) ithread_mutex_unlock(lock)
250#else //DEBLOCK_THREAD
251#define H264_MUTEX_LOCK(lock)
252#define H264_MUTEX_UNLOCK(lock)
253
254#define DEBUG_THREADS_PRINTF(...)
255#define DEBUG_PERF_PRINTF(...)
256
257/** Profile Types*/
258#define BASE_PROFILE_IDC    66
259#define MAIN_PROFILE_IDC    77
260#define EXTENDED_PROFILE_IDC    88
261#define HIGH_PROFILE_IDC   100
262
263
264#define MB_SIZE             16
265#define BLK8x8SIZE           8
266#define BLK_SIZE             4
267#define NUM_BLKS_PER_MB     24
268#define NUM_LUM_BLKS_PER_MB 16
269#define LUM_BLK              0
270#define CHROM_BLK            1
271#define NUM_PELS_IN_MB      64
272
273/* Level Types */
274#define H264_LEVEL_1_0     10
275#define H264_LEVEL_1_1     11
276#define H264_LEVEL_1_2     12
277#define H264_LEVEL_1_3     13
278#define H264_LEVEL_2_0     20
279#define H264_LEVEL_2_1     21
280#define H264_LEVEL_2_2     22
281#define H264_LEVEL_3_0     30
282#define H264_LEVEL_3_1     31
283#define H264_LEVEL_3_2     32
284#define H264_LEVEL_4_0     40
285#define H264_LEVEL_4_1     41
286#define H264_LEVEL_4_2     42
287#define H264_LEVEL_5_0     50
288#define H264_LEVEL_5_1     51
289
290#define MAX_MBS_LEVEL_51 36864
291#define MAX_MBS_LEVEL_50 22080
292#define MAX_MBS_LEVEL_42 8704
293#define MAX_MBS_LEVEL_41 8192
294#define MAX_MBS_LEVEL_40 8192
295#define MAX_MBS_LEVEL_32 5120
296#define MAX_MBS_LEVEL_31 3600
297#define MAX_MBS_LEVEL_30 1620
298#define MAX_MBS_LEVEL_22 1620
299#define MAX_MBS_LEVEL_21 792
300#define MAX_MBS_LEVEL_20 396
301#define MAX_MBS_LEVEL_13 396
302#define MAX_MBS_LEVEL_12 396
303#define MAX_MBS_LEVEL_11 396
304#define MAX_MBS_LEVEL_10 99
305
306/** NAL Types */
307#define SLICE_NAL                       1
308#define SLICE_DATA_PARTITION_A_NAL      2
309#define SLICE_DATA_PARTITION_B_NAL      3
310#define SLICE_DATA_PARTITION_C_NAL      4
311#define IDR_SLICE_NAL                   5
312#define SEI_NAL                         6
313#define SEQ_PARAM_NAL                   7
314#define PIC_PARAM_NAL                   8
315#define ACCESS_UNIT_DELIMITER_RBSP      9
316#define END_OF_SEQ_RBSP                 10
317#define END_OF_STREAM_RBSP              11
318#define FILLER_DATA_NAL                 12
319
320/** Entropy coding modes */
321#define CAVLC  0
322#define CABAC  1
323
324/** Picture Types */
325#define I_PIC       0
326#define IP_PIC      1
327#define IPB_PIC     2
328#define SI_PIC      3
329#define SIP_PIC     4
330#define ISI_PIC     5
331#define ISI_PSP_PIC 6
332#define ALL_PIC     7
333
334/* Frame or field picture type */
335#define FRM_PIC         0x00
336#define TOP_FLD         0x01
337#define BOT_FLD         0x02
338#define COMP_FLD_PAIR   0x03 /* TOP_FLD | BOT_FLD */
339#define AFRM_PIC        0x04
340#define TOP_REF         0x08
341#define BOT_REF         0x10
342#define PIC_MASK        0x03
343#define NON_EXISTING    0xff
344
345/* field picture type for display */
346#define DISP_TOP_FLD    0x00
347#define DISP_BOT_FLD    0x01
348
349/** Slice Types */
350#define P_SLICE  0
351#define B_SLICE  1
352#define I_SLICE  2
353#define SP_SLICE 3
354#define SI_SLICE 4
355
356/* Definition for picture skip */
357#define SKIP_NONE  (0x0)
358#define I_SLC_BIT  (0x1)
359#define P_SLC_BIT  (0x2)
360#define B_SLC_BIT  (0x4)
361
362/** Macros used for Deblocking */
363#define D_INTER_MB        0
364#define D_INTRA_MB        1
365#define D_PRED_NON_16x16  2
366#define D_B_SLICE         4
367#define D_B_SUBMB         6 //D_B_SLICE | D_PRED_NON_16x16 | D_INTER_MB
368#define D_FLD_MB          0x80
369
370/** Macros for Cabac checks */
371/** MbType */
372/** |x|x|I_PCM|SKIP|
373 |S|Inter/Intra|P/B|NON-BD16x16/BD16x16,I16x16/I4x4| */
374#define CAB_INTRA         0x00 /* 0000 00xx */
375#define CAB_INTER         0x04 /* 0000 01xx */
376#define CAB_I4x4          0x00 /* 0000 00x0 */
377#define CAB_I16x16        0x01 /* 0000 00x1 */
378#define CAB_BD16x16       0x04 /* 0000 0100 */
379#define CAB_NON_BD16x16   0x05 /* 0000 0101 */
380#define CAB_P             0x07 /* 0000 0111 */
381#define CAB_SI4x4         0x08 /* 0000 10x0 */
382#define CAB_SI16x16       0x09 /* 0000 10x1 */
383#define CAB_SKIP_MASK     0x10 /* 0001 0000 */
384#define CAB_SKIP          0x10 /* 0001 0000 */
385#define CAB_P_SKIP        0x16 /* 0001 x11x */
386#define CAB_B_SKIP        0x14 /* 0001 x100 */
387#define CAB_BD16x16_MASK  0x07 /* 0000 0111 */
388#define CAB_INTRA_MASK    0x04 /* 0000 0100 */
389#define CAB_I_PCM         0x20 /* 001x xxxx */
390
391/**< Binarization types for CABAC */
392/* |x|x|x|x|MSB_FIRST_FLC|FLC|TUNARY|UNARY| */
393#define UNARY           1
394#define TUNARY          2
395#define FLC             4
396#define MSB_FIRST_FLC   12
397
398/** Macroblock Types */
399#define I_4x4_MB    0
400#define I_16x16_MB  1
401#define P_MB        2
402#define B_MB        3
403#define SI_MB       4
404#define SP_MB       5
405#define I_PCM_MB    6
406
407#define SI4x4_MB 0xFF
408
409/** Intra luma 16x16 and chroma 8x8 prediction modes */
410#define NUM_INTRA_PRED_MODES  4
411#define VERT    0
412#define HORIZ   1
413#define DC      2
414#define PLANE   3
415#define NOT_VALID -1
416#define DC_DC_DC_DC   0x02020202 /*packed 4 bytes used in Decode Intra Mb*/
417
418/** Intra luma 4x4 prediction modes */
419#define NUM_INTRA4x4_PRED_MODES 9
420
421/** VERT, HORIZ, DC are applicable to 4x4 as well */
422/** D - Down; U - Up; L - Left; R - Right */
423#define DIAG_DL   3
424#define DIAG_DR   4
425#define VERT_R    5
426#define HORIZ_D   6
427#define VERT_L    7
428#define HORIZ_U   8
429
430/** P_MB prediction modes */
431#define NUM_INTER_MB_PRED_MODES 5
432#define PRED_16x16  0
433#define PRED_16x8   1
434#define PRED_8x16   2
435#define PRED_8x8    3
436#define PRED_8x8R0  4
437#define MAGIC_16x16 5
438#define MB_SKIP     255
439
440/* P_MB submb modes */
441#define P_L0_8x8    0
442#define P_L0_8x4    1
443#define P_L0_4x8    2
444#define P_L0_4x4    3
445
446/* B_MB submb modes */
447#define B_DIRECT_8x8    0
448#define B_L0_8x8        1
449#define B_L1_8x8        2
450#define B_BI_8x8        3
451#define B_L0_8x4        4
452#define B_L0_4x8        5
453#define B_L1_8x4        6
454#define B_L1_4x8        7
455#define B_BI_8x4        8
456#define B_BI_4x8        9
457#define B_L0_4x4        10
458#define B_L1_4x4        11
459#define B_BI_4x4        12
460
461/** B_MB prediction modes */
462#define B_8x8    22
463#define PRED_INVALID  -1
464#define B_DIRECT  0
465#define PRED_L0   1
466#define PRED_L1   2
467#define BI_PRED   3
468#define B_DIRECT_BI_PRED  23
469#define B_DIRECT_PRED_L0  24
470#define B_DIRECT_PRED_L1  25
471#define B_DIRECT_SPATIAL  26
472
473#define B_DIRECT8x8_BI_PRED  13
474#define B_DIRECT8x8_PRED_L0  14
475#define B_DIRECT8x8_PRED_L1  15
476
477#define ONE_TO_ONE  0
478#define FRM_TO_FLD  1
479#define FLD_TO_FRM  2
480
481/** Inter Sub MB Pred modes */
482#define NUM_INTER_SUBMB_PRED_MODES 4
483#define SUBMB_8x8    0
484#define SUBMB_8x4    1
485#define SUBMB_4x8    2
486#define SUBMB_4x4    3
487
488/** Coded Block Pattern - Chroma */
489#define CBPC_ALLZERO    0
490#define CBPC_ACZERO     1
491#define CBPC_NONZERO    2
492
493/** Index for accessing the left MB in the MV predictor array */
494#define LEFT  0
495/** Index for accessing the top MB in the MV predictor array */
496#define TOP   1
497/** Index for accessing the top right MB in the MV predictor array */
498#define TOP_R 2
499/** Index for accessing the top Left MB in the MV predictor array */
500#define TOP_L 3
501
502/** Maximum number of Sequence Parameter sets */
503#define MAX_NUM_SEQ_PARAMS 32
504
505/** Maximum number of Picture Parameter sets */
506#define MAX_NUM_PIC_PARAMS 256
507
508#define MASK_ERR_SEQ_SET_ID   (0xFFFFFFE0)
509#define MASK_ERR_PIC_SET_ID   (0xFFFFFF00)
510
511#define MAX_PIC_ORDER_CNT_TYPE    2
512
513#define MAX_BITS_IN_FRAME_NUM     16
514#define MAX_BITS_IN_POC_LSB       16
515
516#define H264_MAX_REF_PICS         16
517#define H264_MAX_REF_IDX          32
518#define MAX_WEIGHT_BIPRED_IDC     2
519#define MAX_CABAC_INIT_IDC        2
520
521#define H264_DEFAULT_NUM_CORES 1
522#define DEFAULT_SEPARATE_PARSE (H264_DEFAULT_NUM_CORES == 2)? 1 :0
523
524/** Maximum number of Slice groups */
525#define MAX_NUM_SLICE_GROUPS 8
526#define MAX_NUM_REF_FRAMES_OFFSET 255
527
528/** Deblocking modes for a slice */
529#define SLICE_BOUNDARY_DBLK_DISABLED  2
530#define DBLK_DISABLED                 1
531#define DBLK_ENABLED                  0
532#define MIN_DBLK_FIL_OFF              -12
533#define MAX_DBLK_FIL_OFF              12
534
535/** Width of the predictor buffers used for MC */
536#define MB_SIZE             16
537#define BLK8x8SIZE          8
538#define BLK_SIZE             4
539#define NUM_BLKS_PER_MB     24
540#define NUM_LUM_BLKS_PER_MB 16
541
542#define SUB_BLK_WIDTH                 4
543#define SUB_SUB_BLK_SIZE              4 /* 2x2 pixel i4_size */
544#define SUB_BLK_SIZE                  ((SUB_BLK_WIDTH) * (SUB_BLK_WIDTH))
545#define MB_LUM_SIZE                   256
546#define MB_CHROM_SIZE                 64
547
548/**< Width to pad the luminance frame buff    */
549/**< Height to pad the luminance frame buff   */
550/**< Width to pad the chrominance frame buff  */
551/**< Height to pad the chrominance frame buff */
552
553#define PAD_LEN_Y_H                   32
554#define PAD_LEN_Y_V                   20
555#define PAD_LEN_UV_H                  16
556#define PAD_LEN_UV_V                  8
557
558#define PAD_MV_BANK_ROW             64
559
560/**< Maimum u4_ofst by which the Mvs could point outside the frame buffers
561 horizontally in the left and vertically in the top direction */
562#define MAX_OFFSET_OUTSIDE_X_FRM      -20
563#define MAX_OFFSET_OUTSIDE_Y_FRM      -20
564#define MAX_OFFSET_OUTSIDE_UV_FRM     -8
565
566/** UVLC parsing macros */
567#define   UEV     1
568#define   SEV     2
569#define   TEV     3
570
571/** Defines for Boolean values */
572#ifndef TRUE
573#define TRUE    1
574#define FALSE   0
575#endif
576
577#define UNUSED_FOR_REF 0
578#define IS_SHORT_TERM  1
579#define IS_LONG_TERM   2
580
581/** Defines for which field gets displayed first */
582#define MAX_FRAMES              16
583#define INVALID_FRAME_NUM       0x0fffffff
584#define DO_NOT_DISP             254
585#define DISP_FLD_FIRST_UNDEF  0
586#define DISP_TOP_FLD_FIRST   1
587#define DISP_BOT_FLD_FIRST   2
588
589/** Misc error resilience requirements*/
590#define MASK_LOG2_WEIGHT_DENOM      0xFFFFFFF8
591#define MASK_PRED_WEIGHT_OFFSET     0xFFFFFF00
592#define MAX_REDUNDANT_PIC_CNT       127
593
594
595
596#endif //DEBLOCK_THREAD
597
598#define NUM_COEFFS_IN_4x4BLK 16
599
600
601#define MEMSET_16BYTES(pu4_start,value)                         \
602{                                                               \
603    memset(pu4_start,value,16);                                 \
604}
605
606#define MEMCPY_16BYTES(dst,src)                                 \
607{                                                               \
608    memcpy(dst,src,16);                                         \
609}
610
611
612#endif /*_IH264D_DEFS_H_*/
613