source: 3DVCSoftware/branches/HTM-DEV-0.1-dev/source/Lib/TLibCommon/TypeDef.h @ 367

Last change on this file since 367 was 367, checked in by tech, 11 years ago

Further minor cleanups.

  • Property svn:eol-style set to native
File size: 19.5 KB
Line 
1/* The copyright in this software is being made available under the BSD
2 * License, included below. This software may be subject to other third party
3 * and contributor rights, including patent rights, and no such rights are
4 * granted under this license. 
5 *
6 * Copyright (c) 2010-2013, ITU/ISO/IEC
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 *
12 *  * Redistributions of source code must retain the above copyright notice,
13 *    this list of conditions and the following disclaimer.
14 *  * Redistributions in binary form must reproduce the above copyright notice,
15 *    this list of conditions and the following disclaimer in the documentation
16 *    and/or other materials provided with the distribution.
17 *  * Neither the name of the ITU/ISO/IEC nor the names of its contributors may
18 *    be used to endorse or promote products derived from this software without
19 *    specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31 * THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34/** \file     TypeDef.h
35    \brief    Define basic types, new types and enumerations
36*/
37
38#ifndef _TYPEDEF__
39#define _TYPEDEF__
40
41//! \ingroup TLibCommon
42//! \{
43
44#define H_MV                        1
45
46
47
48///// ***** HM 10.1 *********
49#define FIX1071 1 ///< Temporary fix for issue #1071
50
51#define L0208_SOP_DESCRIPTION_SEI     1 ///< L0208: add SOP descrioption SEI
52#define MAX_NUM_PICS_IN_SOP           1024
53
54#define K0180_SCALABLE_NESTING_SEI  1   ///JCTVC-K0180 scalable nesting sei message
55#define MAX_NESTING_NUM_OPS         1024
56#define MAX_NESTING_NUM_LAYER       64
57
58#define J0149_TONE_MAPPING_SEI        1 ///< J0149: Tone mapping information SEI
59#define L0363_DU_BIT_RATE             1 ///< L0363: add bit_rate_du_value_minus1 to HRD parameters
60#define L0328_SPLICING                1 ///< L0328: splicing support in HRD
61#define L0044_DU_DPB_OUTPUT_DELAY_HRD 1 ///< L0044: Include dpb_output_delay_du_length_minus1 in hrd_parameters(), dpb_output_du_delay in
62                                        ///<        picture timing SEI and DU information SEI
63#define L0045_PERSISTENCE_FLAGS  1      ///< L0045: Replace "repetition_period" syntax elements in SEI with "persistence_flag"
64#define L0045_NON_NESTED_SEI_RESTRICTIONS 1 ///< L0045; Include restriction on the order of APS and non-nested BP, PT and DU info SEI messages
65#define L0044_CPB_DPB_DELAY_OFFSET 1  ///< L0044: Include syntax elements cpb_delay_offset and dpb_delay_offset in the BP SEI message
66#define L0047_APS_FLAGS            1  ///< L0047: Include full_random_access_flag and no_param_set_update_flag in the active parameter set SEI message
67#define L0043_TIMING_INFO          1  ///< L0043: Timing information is signalled in VUI outside hrd_parameters()
68#define L0046_RENAME_PROG_SRC_IDC  1  ///< L0046: Rename progressive_source_idc to source_scan_type
69#define L0045_CONDITION_SIGNALLING 1  ///< L0045: Condition the signaling of some syntax elements in picture timing SEI message
70#define L0043_MSS_IDC 1
71#define L0116_ENTRY_POINT 1
72#define L0363_MORE_BITS 1
73#define L0363_MVP_POC 1
74#define L0363_BYTE_ALIGN 1
75#define L0363_SEI_ALLOW_SUFFIX 1
76#define L0323_LIMIT_DEFAULT_LIST_SIZE 1
77#define L0046_CONSTRAINT_FLAGS 1
78#define L0255_MOVE_PPS_FLAGS       1  ///< move some flags to earlier positions in the PPS
79#define L0444_FPA_TYPE             1  ///< allow only FPA types 3, 4 and 5
80#define L0372 1
81#define SIGNAL_BITRATE_PICRATE_IN_VPS               0  ///< K0125: Signal bit_rate and pic_rate in VPS
82#define L0232_RD_PENALTY           1  ///< L0232: RD-penalty for 32x32 TU for intra in non-intra slices
83#define L0386_DB_METRIC            1  ///< L0386: non-normative blockiness metric (automatically configures deblocking parameters in bitstream)
84#define L0323_DPB                     1 ///< L0323: Specification of active reference indices and decoded picture buffer
85
86#define L0034_COMBINED_LIST_CLEANUP 1
87
88#define MAX_VPS_NUM_HRD_PARAMETERS                1
89#define MAX_VPS_OP_SETS_PLUS1                     1024
90#define MAX_VPS_NUH_RESERVED_ZERO_LAYER_ID_PLUS1  1
91
92#define RATE_CONTROL_LAMBDA_DOMAIN                  1  ///< JCTVC-K0103, rate control by R-lambda model
93#define L0033_RC_BUGFIX                             1  ///< JCTVC-L0033, bug fix for R-lambda model based rate control
94
95#define MAX_CPB_CNT                     32  ///< Upper bound of (cpb_cnt_minus1 + 1)
96#define MAX_NUM_LAYER_IDS               64
97
98#define COEF_REMAIN_BIN_REDUCTION        3 ///< indicates the level at which the VLC
99                                           ///< transitions from Golomb-Rice to TU+EG(k)
100
101#define CU_DQP_TU_CMAX 5                   ///< max number bins for truncated unary
102#define CU_DQP_EG_k 0                      ///< expgolomb order
103
104#define SBH_THRESHOLD                    4  ///< I0156: value of the fixed SBH controlling threshold
105 
106#define SEQUENCE_LEVEL_LOSSLESS           0  ///< H0530: used only for sequence or frame-level lossless coding
107
108#define DISABLING_CLIP_FOR_BIPREDME         1  ///< Ticket #175
109 
110#define C1FLAG_NUMBER               8 // maximum number of largerThan1 flag coded in one chunk :  16 in HM5
111#define C2FLAG_NUMBER               1 // maximum number of largerThan2 flag coded in one chunk:  16 in HM5
112
113#define REMOVE_SAO_LCU_ENC_CONSTRAINTS_3 1  ///< disable the encoder constraint that conditionally disable SAO for chroma for entire slice in interleaved mode
114
115#define REMOVE_SINGLE_SEI_EXTENSION_FLAGS 1 ///< remove display orientation SEI extension flag (there is a generic SEI extension mechanism now)
116
117#define SAO_ENCODING_CHOICE              1  ///< I0184: picture early termination
118#if SAO_ENCODING_CHOICE
119#define SAO_ENCODING_RATE                0.75
120#define SAO_ENCODING_CHOICE_CHROMA       1 ///< J0044: picture early termination Luma and Chroma are handled separately
121#if SAO_ENCODING_CHOICE_CHROMA
122#define SAO_ENCODING_RATE_CHROMA         0.5
123#endif
124#endif
125
126#define MAX_NUM_VPS                16
127#define MAX_NUM_SPS                16
128#define MAX_NUM_PPS                64
129
130
131
132#define WEIGHTED_CHROMA_DISTORTION  1   ///< F386: weighting of chroma for RDO
133#define RDOQ_CHROMA_LAMBDA          1   ///< F386: weighting of chroma for RDOQ
134#define SAO_CHROMA_LAMBDA           1   ///< F386: weighting of chroma for SAO
135
136#define MIN_SCAN_POS_CROSS          4
137
138#define FAST_BIT_EST                1   ///< G763: Table-based bit estimation for CABAC
139
140#define MLS_GRP_NUM                         64     ///< G644 : Max number of coefficient groups, max(16, 64)
141#define MLS_CG_SIZE                         4      ///< G644 : Coefficient group size of 4x4
142
143#define ADAPTIVE_QP_SELECTION               1      ///< G382: Adaptive reconstruction levels, non-normative part for adaptive QP selection
144#if ADAPTIVE_QP_SELECTION
145#define ARL_C_PRECISION                     7      ///< G382: 7-bit arithmetic precision
146#define LEVEL_RANGE                         30     ///< G382: max coefficient level in statistics collection
147#endif
148
149#define NS_HAD                               0
150
151#define HHI_RQT_INTRA_SPEEDUP             1           ///< tests one best mode with full rqt
152#define HHI_RQT_INTRA_SPEEDUP_MOD         0           ///< tests two best modes with full rqt
153
154#if HHI_RQT_INTRA_SPEEDUP_MOD && !HHI_RQT_INTRA_SPEEDUP
155#error
156#endif
157
158#define VERBOSE_RATE 0 ///< Print additional rate information in encoder
159
160#define AMVP_DECIMATION_FACTOR            4
161
162#define SCAN_SET_SIZE                     16
163#define LOG2_SCAN_SET_SIZE                4
164
165#define FAST_UDI_MAX_RDMODE_NUM               35          ///< maximum number of RD comparison in fast-UDI estimation loop
166
167#define ZERO_MVD_EST                          0           ///< Zero Mvd Estimation in normal mode
168
169#define NUM_INTRA_MODE 36
170#if !REMOVE_LM_CHROMA
171#define LM_CHROMA_IDX  35
172#endif
173
174#define WRITE_BACK                      1           ///< Enable/disable the encoder to replace the deltaPOC and Used by current from the config file with the values derived by the refIdc parameter.
175#define AUTO_INTER_RPS                  1           ///< Enable/disable the automatic generation of refIdc from the deltaPOC and Used by current from the config file.
176#define PRINT_RPS_INFO                  0           ///< Enable/disable the printing of bits used to send the RPS.
177                                                    // using one nearest frame as reference frame, and the other frames are high quality (POC%4==0) frames (1+X)
178                                                    // this should be done with encoder only decision
179                                                    // but because of the absence of reference frame management, the related code was hard coded currently
180
181#define RVM_VCEGAM10_M 4
182
183#define PLANAR_IDX             0
184#define VER_IDX                26                    // index for intra VERTICAL   mode
185#define HOR_IDX                10                    // index for intra HORIZONTAL mode
186#define DC_IDX                 1                     // index for intra DC mode
187#define NUM_CHROMA_MODE        5                     // total number of chroma modes
188#define DM_CHROMA_IDX          36                    // chroma mode index for derived from luma intra mode
189
190
191#define FAST_UDI_USE_MPM 1
192
193#define RDO_WITHOUT_DQP_BITS              0           ///< Disable counting dQP bits in RDO-based mode decision
194
195#define FULL_NBIT 0 ///< When enabled, compute costs using full sample bitdepth.  When disabled, compute costs as if it is 8-bit source video.
196#if FULL_NBIT
197# define DISTORTION_PRECISION_ADJUSTMENT(x) 0
198#else
199# define DISTORTION_PRECISION_ADJUSTMENT(x) (x)
200#endif
201
202#define LOG2_MAX_NUM_COLUMNS_MINUS1        7
203#define LOG2_MAX_NUM_ROWS_MINUS1           7
204#define LOG2_MAX_COLUMN_WIDTH              13
205#define LOG2_MAX_ROW_HEIGHT                13
206
207#define MATRIX_MULT                             0   // Brute force matrix multiplication instead of partial butterfly
208
209#define REG_DCT 65535
210
211#define AMP_SAD                               1           ///< dedicated SAD functions for AMP
212#define AMP_ENC_SPEEDUP                       1           ///< encoder only speed-up by AMP mode skipping
213#if AMP_ENC_SPEEDUP
214#define AMP_MRG                               1           ///< encoder only force merge for AMP partition (no motion search for AMP)
215#endif
216
217#define SCALING_LIST_OUTPUT_RESULT    0 //JCTVC-G880/JCTVC-G1016 quantization matrices
218
219#define CABAC_INIT_PRESENT_FLAG     1
220
221// ====================================================================================================================
222// Basic type redefinition
223// ====================================================================================================================
224
225typedef       void                Void;
226typedef       bool                Bool;
227
228typedef       char                Char;
229typedef       unsigned char       UChar;
230typedef       short               Short;
231typedef       unsigned short      UShort;
232typedef       int                 Int;
233typedef       unsigned int        UInt;
234typedef       double              Double;
235typedef       float               Float;
236
237// ====================================================================================================================
238// 64-bit integer type
239// ====================================================================================================================
240
241#ifdef _MSC_VER
242typedef       __int64             Int64;
243
244#if _MSC_VER <= 1200 // MS VC6
245typedef       __int64             UInt64;   // MS VC6 does not support unsigned __int64 to double conversion
246#else
247typedef       unsigned __int64    UInt64;
248#endif
249
250#else
251
252typedef       long long           Int64;
253typedef       unsigned long long  UInt64;
254
255#endif
256
257// ====================================================================================================================
258// Type definition
259// ====================================================================================================================
260
261typedef       UChar           Pxl;        ///< 8-bit pixel type
262typedef       Short           Pel;        ///< 16-bit pixel type
263typedef       Int             TCoeff;     ///< transform coefficient
264
265/// parameters for adaptive loop filter
266class TComPicSym;
267
268// Slice / Slice segment encoding modes
269enum SliceConstraint
270{
271  NO_SLICES              = 0,          ///< don't use slices / slice segments
272  FIXED_NUMBER_OF_LCU    = 1,          ///< Limit maximum number of largest coding tree blocks in a slice / slice segments
273  FIXED_NUMBER_OF_BYTES  = 2,          ///< Limit maximum number of bytes in a slice / slice segment
274  FIXED_NUMBER_OF_TILES  = 3,          ///< slices / slice segments span an integer number of tiles
275};
276
277#define NUM_DOWN_PART 4
278
279enum SAOTypeLen
280{
281  SAO_EO_LEN    = 4, 
282  SAO_BO_LEN    = 4,
283  SAO_MAX_BO_CLASSES = 32
284};
285
286enum SAOType
287{
288  SAO_EO_0 = 0, 
289  SAO_EO_1,
290  SAO_EO_2, 
291  SAO_EO_3,
292  SAO_BO,
293  MAX_NUM_SAO_TYPE
294};
295
296typedef struct _SaoQTPart
297{
298  Int         iBestType;
299  Int         iLength;
300  Int         subTypeIdx ;                 ///< indicates EO class or BO band position
301  Int         iOffset[4];
302  Int         StartCUX;
303  Int         StartCUY;
304  Int         EndCUX;
305  Int         EndCUY;
306
307  Int         PartIdx;
308  Int         PartLevel;
309  Int         PartCol;
310  Int         PartRow;
311
312  Int         DownPartsIdx[NUM_DOWN_PART];
313  Int         UpPartIdx;
314
315  Bool        bSplit;
316
317  //---- encoder only start -----//
318  Bool        bProcessed;
319  Double      dMinCost;
320  Int64       iMinDist;
321  Int         iMinRate;
322  //---- encoder only end -----//
323} SAOQTPart;
324
325typedef struct _SaoLcuParam
326{
327  Bool       mergeUpFlag;
328  Bool       mergeLeftFlag;
329  Int        typeIdx;
330  Int        subTypeIdx;                  ///< indicates EO class or BO band position
331  Int        offset[4];
332  Int        partIdx;
333  Int        partIdxTmp;
334  Int        length;
335} SaoLcuParam;
336
337struct SAOParam
338{
339  Bool       bSaoFlag[2];
340  SAOQTPart* psSaoPart[3];
341  Int        iMaxSplitLevel;
342  Bool         oneUnitFlag[3];
343  SaoLcuParam* saoLcuParam[3];
344  Int          numCuInHeight;
345  Int          numCuInWidth;
346  ~SAOParam();
347};
348
349/// parameters for deblocking filter
350typedef struct _LFCUParam
351{
352  Bool bInternalEdge;                     ///< indicates internal edge
353  Bool bLeftEdge;                         ///< indicates left edge
354  Bool bTopEdge;                          ///< indicates top edge
355} LFCUParam;
356
357// ====================================================================================================================
358// Enumeration
359// ====================================================================================================================
360
361/// supported slice type
362enum SliceType
363{
364  B_SLICE,
365  P_SLICE,
366  I_SLICE
367};
368
369/// chroma formats (according to semantics of chroma_format_idc)
370enum ChromaFormat
371{
372  CHROMA_400  = 0,
373  CHROMA_420  = 1,
374  CHROMA_422  = 2,
375  CHROMA_444  = 3
376};
377
378/// supported partition shape
379enum PartSize
380{
381  SIZE_2Nx2N,           ///< symmetric motion partition,  2Nx2N
382  SIZE_2NxN,            ///< symmetric motion partition,  2Nx N
383  SIZE_Nx2N,            ///< symmetric motion partition,   Nx2N
384  SIZE_NxN,             ///< symmetric motion partition,   Nx N
385  SIZE_2NxnU,           ///< asymmetric motion partition, 2Nx( N/2) + 2Nx(3N/2)
386  SIZE_2NxnD,           ///< asymmetric motion partition, 2Nx(3N/2) + 2Nx( N/2)
387  SIZE_nLx2N,           ///< asymmetric motion partition, ( N/2)x2N + (3N/2)x2N
388  SIZE_nRx2N,           ///< asymmetric motion partition, (3N/2)x2N + ( N/2)x2N
389  SIZE_NONE = 15
390};
391
392/// supported prediction type
393enum PredMode
394{
395  MODE_INTER,           ///< inter-prediction mode
396  MODE_INTRA,           ///< intra-prediction mode
397  MODE_NONE = 15
398};
399
400/// texture component type
401enum TextType
402{
403  TEXT_LUMA,            ///< luma
404  TEXT_CHROMA,          ///< chroma (U+V)
405  TEXT_CHROMA_U,        ///< chroma U
406  TEXT_CHROMA_V,        ///< chroma V
407  TEXT_ALL,             ///< Y+U+V
408  TEXT_NONE = 15
409};
410
411/// reference list index
412enum RefPicList
413{
414  REF_PIC_LIST_0 = 0,   ///< reference list 0
415  REF_PIC_LIST_1 = 1,   ///< reference list 1
416#if !L0034_COMBINED_LIST_CLEANUP
417  REF_PIC_LIST_C = 2,   ///< combined reference list for uni-prediction in B-Slices
418#endif
419  REF_PIC_LIST_X = 100  ///< special mark
420};
421
422/// distortion function index
423enum DFunc
424{
425  DF_DEFAULT  = 0,
426  DF_SSE      = 1,      ///< general size SSE
427  DF_SSE4     = 2,      ///<   4xM SSE
428  DF_SSE8     = 3,      ///<   8xM SSE
429  DF_SSE16    = 4,      ///<  16xM SSE
430  DF_SSE32    = 5,      ///<  32xM SSE
431  DF_SSE64    = 6,      ///<  64xM SSE
432  DF_SSE16N   = 7,      ///< 16NxM SSE
433 
434  DF_SAD      = 8,      ///< general size SAD
435  DF_SAD4     = 9,      ///<   4xM SAD
436  DF_SAD8     = 10,     ///<   8xM SAD
437  DF_SAD16    = 11,     ///<  16xM SAD
438  DF_SAD32    = 12,     ///<  32xM SAD
439  DF_SAD64    = 13,     ///<  64xM SAD
440  DF_SAD16N   = 14,     ///< 16NxM SAD
441 
442  DF_SADS     = 15,     ///< general size SAD with step
443  DF_SADS4    = 16,     ///<   4xM SAD with step
444  DF_SADS8    = 17,     ///<   8xM SAD with step
445  DF_SADS16   = 18,     ///<  16xM SAD with step
446  DF_SADS32   = 19,     ///<  32xM SAD with step
447  DF_SADS64   = 20,     ///<  64xM SAD with step
448  DF_SADS16N  = 21,     ///< 16NxM SAD with step
449 
450  DF_HADS     = 22,     ///< general size Hadamard with step
451  DF_HADS4    = 23,     ///<   4xM HAD with step
452  DF_HADS8    = 24,     ///<   8xM HAD with step
453  DF_HADS16   = 25,     ///<  16xM HAD with step
454  DF_HADS32   = 26,     ///<  32xM HAD with step
455  DF_HADS64   = 27,     ///<  64xM HAD with step
456  DF_HADS16N  = 28,     ///< 16NxM HAD with step
457 
458#if AMP_SAD
459  DF_SAD12    = 43,
460  DF_SAD24    = 44,
461  DF_SAD48    = 45,
462
463  DF_SADS12   = 46,
464  DF_SADS24   = 47,
465  DF_SADS48   = 48,
466
467  DF_SSE_FRAME = 50     ///< Frame-based SSE
468#else
469  DF_SSE_FRAME = 33     ///< Frame-based SSE
470#endif
471};
472
473/// index for SBAC based RD optimization
474enum CI_IDX
475{
476  CI_CURR_BEST = 0,     ///< best mode index
477  CI_NEXT_BEST,         ///< next best index
478  CI_TEMP_BEST,         ///< temporal index
479  CI_CHROMA_INTRA,      ///< chroma intra index
480  CI_QT_TRAFO_TEST,
481  CI_QT_TRAFO_ROOT,
482  CI_NUM,               ///< total number
483};
484
485/// motion vector predictor direction used in AMVP
486enum MVP_DIR
487{
488  MD_LEFT = 0,          ///< MVP of left block
489  MD_ABOVE,             ///< MVP of above block
490  MD_ABOVE_RIGHT,       ///< MVP of above right block
491  MD_BELOW_LEFT,        ///< MVP of below left block
492  MD_ABOVE_LEFT         ///< MVP of above left block
493};
494
495/// coefficient scanning type used in ACS
496enum COEFF_SCAN_TYPE
497{
498  SCAN_DIAG = 0,         ///< up-right diagonal scan
499  SCAN_HOR,              ///< horizontal first scan
500  SCAN_VER               ///< vertical first scan
501};
502
503namespace Profile
504{
505  enum Name
506  {
507    NONE = 0,
508    MAIN = 1,
509    MAIN10 = 2,
510    MAINSTILLPICTURE = 3,
511  };
512}
513
514namespace Level
515{
516  enum Tier
517  {
518    MAIN = 0,
519    HIGH = 1,
520  };
521
522  enum Name
523  {
524    NONE     = 0,
525    LEVEL1   = 30,
526    LEVEL2   = 60,
527    LEVEL2_1 = 63,
528    LEVEL3   = 90,
529    LEVEL3_1 = 93,
530    LEVEL4   = 120,
531    LEVEL4_1 = 123,
532    LEVEL5   = 150,
533    LEVEL5_1 = 153,
534    LEVEL5_2 = 156,
535    LEVEL6   = 180,
536    LEVEL6_1 = 183,
537    LEVEL6_2 = 186,
538  };
539}
540//! \}
541
542#endif
Note: See TracBrowser for help on using the repository browser.