source: 3DVCSoftware/branches/HTM-14.1-update-dev4-Qualcomm/source/Lib/TLibCommon/TComCodingStatistics.h @ 1262

Last change on this file since 1262 was 1262, checked in by qualcomm, 10 years ago
  1. enable ARP by NH_3D_ARP with simulation results included; 2. address Gerhard's comments on setBaseViewRefPicList; 3. align the software with the specification of checking the correct reference picture list proposed in JCT3V-F105
  • Property svn:eol-style set to native
File size: 17.1 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-2015, 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#ifndef __TCOMCODINGSTATISTICS__
35#define __TCOMCODINGSTATISTICS__
36
37#include "CommonDef.h"
38#include <stdio.h>
39#include <string>
40#include <map>
41#include <math.h>
42#include "TComChromaFormat.h"
43
44static const Int64 TCOMCODINGSTATISTICS_ENTROPYSCALE=32768;
45
46
47enum TComCodingStatisticsType
48{
49  STATS__NAL_UNIT_TOTAL_BODY,// This is a special case and is not included in the total sums.
50  STATS__NAL_UNIT_PACKING,
51  STATS__EMULATION_PREVENTION_3_BYTES,
52  STATS__NAL_UNIT_HEADER_BITS,
53  STATS__CABAC_INITIALISATION,
54  STATS__CABAC_BITS__TQ_BYPASS_FLAG,
55  STATS__CABAC_BITS__SKIP_FLAG,
56  STATS__CABAC_BITS__MERGE_FLAG,
57  STATS__CABAC_BITS__MERGE_INDEX,
58  STATS__CABAC_BITS__MVP_IDX,
59  STATS__CABAC_BITS__SPLIT_FLAG,
60  STATS__CABAC_BITS__PART_SIZE,
61  STATS__CABAC_BITS__PRED_MODE,
62  STATS__CABAC_BITS__INTRA_DIR_ANG,
63  STATS__CABAC_BITS__INTER_DIR,
64  STATS__CABAC_BITS__REF_FRM_IDX,
65  STATS__CABAC_BITS__MVD,
66  STATS__CABAC_BITS__MVD_EP,
67  STATS__CABAC_BITS__TRANSFORM_SUBDIV_FLAG,
68  STATS__CABAC_BITS__QT_ROOT_CBF,
69  STATS__CABAC_BITS__DELTA_QP_EP,
70  STATS__CABAC_BITS__CHROMA_QP_ADJUSTMENT,
71  STATS__CABAC_BITS__QT_CBF,
72  STATS__CABAC_BITS__CROSS_COMPONENT_PREDICTION,
73  STATS__CABAC_BITS__TRANSFORM_SKIP_FLAGS,
74
75  STATS__CABAC_BITS__LAST_SIG_X_Y,
76  STATS__CABAC_BITS__SIG_COEFF_GROUP_FLAG,
77  STATS__CABAC_BITS__SIG_COEFF_MAP_FLAG,
78  STATS__CABAC_BITS__GT1_FLAG,
79  STATS__CABAC_BITS__GT2_FLAG,
80  STATS__CABAC_BITS__SIGN_BIT,
81  STATS__CABAC_BITS__ESCAPE_BITS,
82#if NH_3D_DBBP
83  STATS__CABAC_BITS__DBBP_FLAG,
84#endif
85#if NH_3D_ARP
86  STATS__CABAC_BITS__ARP_FLAG,
87#endif
88  STATS__CABAC_BITS__SAO,
89  STATS__CABAC_TRM_BITS,
90  STATS__CABAC_FIXED_BITS,
91  STATS__CABAC_PCM_ALIGN_BITS,
92  STATS__CABAC_PCM_CODE_BITS,
93  STATS__BYTE_ALIGNMENT_BITS,
94  STATS__TRAILING_BITS,
95  STATS__EXPLICIT_RDPCM_BITS,
96  STATS__CABAC_EP_BIT_ALIGNMENT,
97  STATS__CABAC_BITS__ALIGNED_SIGN_BIT,
98  STATS__CABAC_BITS__ALIGNED_ESCAPE_BITS,
99  STATS__NUM_STATS
100};
101
102static inline const Char* getName(TComCodingStatisticsType name)
103{
104  static const Char *statNames[]=
105  {
106    "NAL_UNIT_TOTAL_BODY", // This is a special case and is not included in the total sums.
107    "NAL_UNIT_PACKING",
108    "EMULATION_PREVENTION_3_BYTES",
109    "NAL_UNIT_HEADER_BITS",
110    "CABAC_INITIALISATION-and-rounding",
111    "CABAC_BITS__TQ_BYPASS_FLAG",
112    "CABAC_BITS__SKIP_FLAG",
113    "CABAC_BITS__MERGE_FLAG",
114    "CABAC_BITS__MERGE_INDEX",
115    "CABAC_BITS__MVP_IDX",
116    "CABAC_BITS__SPLIT_FLAG",
117    "CABAC_BITS__PART_SIZE",
118    "CABAC_BITS__PRED_MODE",
119    "CABAC_BITS__INTRA_DIR_ANG",
120    "CABAC_BITS__INTER_DIR",
121    "CABAC_BITS__REF_FRM_IDX",
122    "CABAC_BITS__MVD",
123    "CABAC_BITS__MVD_EP",
124    "CABAC_BITS__TRANSFORM_SUBDIV_FLAG",
125    "CABAC_BITS__QT_ROOT_CBF",
126    "CABAC_BITS__DELTA_QP_EP",
127    "CABAC_BITS__CHROMA_QP_ADJUSTMENT",
128    "CABAC_BITS__QT_CBF",
129    "CABAC_BITS__CROSS_COMPONENT_PREDICTION",
130    "CABAC_BITS__TRANSFORM_SKIP_FLAGS",
131    "CABAC_BITS__LAST_SIG_X_Y",
132    "CABAC_BITS__SIG_COEFF_GROUP_FLAG",
133    "CABAC_BITS__SIG_COEFF_MAP_FLAG",
134    "CABAC_BITS__GT1_FLAG",
135    "CABAC_BITS__GT2_FLAG",
136    "CABAC_BITS__SIGN_BIT",
137    "CABAC_BITS__ESCAPE_BITS",
138#if NH_3D_DBBP
139    "CABAC_BITS__DBBP_FLAG",
140#endif
141    "CABAC_BITS__SAO",
142    "CABAC_TRM_BITS",
143    "CABAC_FIXED_BITS",
144    "CABAC_PCM_ALIGN_BITS",
145    "CABAC_PCM_CODE_BITS",
146    "BYTE_ALIGNMENT_BITS",
147    "TRAILING_BITS",
148    "EXPLICIT_RDPCM_BITS",
149    "CABAC_EP_BIT_ALIGNMENT",
150    "CABAC_BITS__ALIGNED_SIGN_BIT",
151    "CABAC_BITS__ALIGNED_ESCAPE_BITS"
152  };
153  assert(STATS__NUM_STATS == sizeof(statNames)/sizeof(Char *) && name < STATS__NUM_STATS);
154  return statNames[name];
155}
156
157static inline Bool isAlignedBins(TComCodingStatisticsType statT) { return statT==STATS__CABAC_BITS__ALIGNED_SIGN_BIT || statT==STATS__CABAC_BITS__ALIGNED_ESCAPE_BITS; }
158
159static const UInt CODING_STATS_NUM_WIDTHS=7;
160static const UInt CODING_STATS_NUM_SUBCLASSES=CODING_STATS_NUM_WIDTHS*(1+MAX_NUM_COMPONENT+MAX_NUM_CHANNEL_TYPE);
161
162class TComCodingStatisticsClassType
163{
164public:
165
166  TComCodingStatisticsClassType(const TComCodingStatisticsType t)
167    : type(t), subClass(0)
168  { }
169  TComCodingStatisticsClassType(const TComCodingStatisticsType t, const UInt log2w )
170    : type(t), subClass(log2w)
171  { }
172  TComCodingStatisticsClassType(const TComCodingStatisticsType t, const Int log2w )
173    : type(t), subClass(log2w)
174  { }
175  TComCodingStatisticsClassType(const TComCodingStatisticsType t, const ComponentID cid )
176    : type(t), subClass((cid+1)*CODING_STATS_NUM_WIDTHS)
177  { }
178  TComCodingStatisticsClassType(const TComCodingStatisticsType t, const ChannelType chid )
179    : type(t), subClass((chid+MAX_NUM_COMPONENT+1)*CODING_STATS_NUM_WIDTHS)
180  { }
181  TComCodingStatisticsClassType(const TComCodingStatisticsType t, const UInt log2w, const ComponentID cid )
182    : type(t), subClass((cid+1)*CODING_STATS_NUM_WIDTHS + log2w)
183  { }
184  TComCodingStatisticsClassType(const TComCodingStatisticsType t, const UInt log2w, const ChannelType chid )
185    : type(t), subClass((chid+MAX_NUM_COMPONENT+1)*CODING_STATS_NUM_WIDTHS + log2w)
186  { }
187
188  static UInt GetSubClassWidth(const UInt subClass)
189  {
190    return subClass%CODING_STATS_NUM_WIDTHS;
191  }
192
193  static const Char *GetSubClassString(const UInt subClass)
194  {
195    assert (subClass<CODING_STATS_NUM_SUBCLASSES);
196    static const Char *strings[1+MAX_NUM_COMPONENT+MAX_NUM_CHANNEL_TYPE]={"-", "Y", "Cb", "Cr", "Luma", "Chroma"};
197    return strings[subClass/CODING_STATS_NUM_WIDTHS];
198  }
199
200  TComCodingStatisticsType type;
201  UInt subClass;
202};
203
204
205
206class TComCodingStatistics
207{
208  public:
209
210
211    struct StatLogValue
212    {
213      UInt values[512+1];
214      StatLogValue()
215      {
216        const Double es=Double(TCOMCODINGSTATISTICS_ENTROPYSCALE);
217        values[0]=0;
218        for(UInt i=1; i<sizeof(values)/sizeof(UInt); i++)
219        {
220          values[i]=UInt(    log(Double(i))*es/log(2.0)  );
221        }
222      }
223    };
224
225    struct SStat
226    {
227      SStat() : bits(0), count(0), sum(0) { }
228      Int64 bits;
229      Int64 count;
230      Int64 sum;
231      Void clear() { bits=0; count=0; sum=0; }
232
233      SStat &operator+=(const SStat &src)
234      { bits+=src.bits; count+=src.count; sum+=src.sum; return *this; }
235    };
236
237    class TComCodingStatisticsData
238    {
239      private:
240        SStat statistics[STATS__NUM_STATS+1][CODING_STATS_NUM_SUBCLASSES];
241        SStat statistics_ep[STATS__NUM_STATS+1][CODING_STATS_NUM_SUBCLASSES ];
242        std::map<std::string, SStat> mappings_ep;
243        friend class TComCodingStatistics;
244    };
245
246  private:
247
248    TComCodingStatisticsData data;
249
250    TComCodingStatistics() : data()
251    { }
252
253    static Void OutputLine(const Char *pName, const Char sep, UInt width, const Char *pSubClassStr, const SStat &sCABAC, const SStat &sEP)
254    {
255      if (width==0)
256      {
257        OutputLine(pName, sep, "-", pSubClassStr, sCABAC, sEP);
258      }
259      else
260      {
261        printf("%c%-45s%c  %6d %6s %12lld %12lld %12lld %12lld %12lld %12lld %12lld (%12lld)%c\n",
262          sep=='~'?'[':' ', pName, sep, 1<<width, pSubClassStr,
263              sCABAC.count, sCABAC.sum, sCABAC.bits, sEP.count, sEP.sum, sEP.bits, sCABAC.bits+sEP.bits, (sCABAC.bits+sEP.bits)/8, sep=='~'?']':' ');
264      }
265    }
266    static Void OutputLine(const Char *pName, const Char sep, const Char *pWidthString, const Char *pSubClassStr, const SStat &sCABAC, const SStat &sEP)
267    {
268      printf("%c%-45s%c  %6s %6s %12lld %12lld %12lld %12lld %12lld %12lld %12lld (%12lld)%c\n",
269          sep=='~'?'[':' ', pName, sep, pWidthString, pSubClassStr,
270              sCABAC.count, sCABAC.sum, sCABAC.bits, sEP.count, sEP.sum, sEP.bits, sCABAC.bits+sEP.bits, (sCABAC.bits+sEP.bits)/8, sep=='~'?']':' ');
271    }
272    static Void OutputLine(const Char *pName, const Char sep, const Char *pWidthString, const Char *pSubClassStr,  const SStat &sEP)
273    {
274      printf("%c%-45s%c  %6s %6s %12s %12s %12s %12lld %12lld %12lld %12lld (%12lld)%c\n",
275          sep=='~'?'[':' ', pName, sep, pWidthString, pSubClassStr,
276              "", "", "", sEP.count, sEP.sum, sEP.bits, sEP.bits, (sEP.bits)/8, sep=='~'?']':' ');
277    }
278
279    static Void OutputDashedLine(const Char *pText)
280    {
281      printf("--%s",pText);
282      UInt tot=0;
283      for(;pText[tot]!=0; tot++);
284
285      tot+=2;
286      for (; tot<168; tot++)
287      {
288        printf("-");
289      }
290      printf("\n");
291    }
292
293    ~TComCodingStatistics()
294    {
295      const Int64 es=TCOMCODINGSTATISTICS_ENTROPYSCALE;
296
297      Int64 cr=0; // CABAC remainder, which is added to "STATS__CABAC_INITIALISATION"
298      {
299        Int64 totalCABACbits=0, roundedCABACbits=0;
300        for(Int i=STATS__NAL_UNIT_PACKING; i<STATS__NUM_STATS; i++)
301        {
302          for(UInt c=0; c<CODING_STATS_NUM_SUBCLASSES; c++)
303          {
304            totalCABACbits+=data.statistics[i][c].bits;
305            roundedCABACbits+=data.statistics[i][c].bits/es;
306          }
307        }
308        Int64 remainder=totalCABACbits - roundedCABACbits*es;
309        cr=(remainder+es/2)/es;
310      }
311
312      printf("Note %s will be excluded from the total as it should be the sum of all the other entries (except for %s)\n", getName(STATS__NAL_UNIT_TOTAL_BODY), getName(STATS__NAL_UNIT_PACKING));
313      printf(" %-45s-   Width   Type  CABAC Count    CABAC Sum   CABAC bits     EP Count       EP Sum      EP bits   Total bits ( Total bytes)\n", "Decoder statistics");
314
315      OutputDashedLine("");
316      SStat cabacTotalBits, epTotalBits;
317      SStat statTotals_cabac[CODING_STATS_NUM_SUBCLASSES];
318      SStat statTotals_ep[CODING_STATS_NUM_SUBCLASSES];
319
320      for(Int i=0; i<STATS__NUM_STATS; i++)
321      {
322        SStat cabacSubTotal, epSubTotal;
323        Bool bHadClassifiedEntry=false;
324        const Char *pName=getName(TComCodingStatisticsType(i));
325
326        for(UInt c=0; c<CODING_STATS_NUM_SUBCLASSES; c++)
327        {
328          SStat &sCABACorig=data.statistics[i][c];
329          SStat &sEP=data.statistics_ep[i][c];
330
331          if (sCABACorig.bits==0 && sEP.bits==0)
332          {
333            continue;
334          }
335
336          SStat sCABAC;
337          {
338            Int64 thisCABACbits=sCABACorig.bits/es;
339            if (i==STATS__CABAC_INITIALISATION && sCABACorig.bits!=0)
340            {
341              thisCABACbits+=cr;
342              cr=0;
343            }
344            sCABAC.bits=thisCABACbits;
345            sCABAC.count=sCABACorig.count;
346            sCABAC.sum=sCABACorig.sum;
347          }
348          UInt width=TComCodingStatisticsClassType::GetSubClassWidth(c);
349          OutputLine(pName, ':', width, TComCodingStatisticsClassType::GetSubClassString(c), sCABAC, sEP);
350          cabacSubTotal+=sCABAC;
351          epSubTotal+=sEP;
352          if (i!=STATS__NAL_UNIT_TOTAL_BODY)
353          {
354            cabacTotalBits+=sCABAC;
355            epTotalBits+=sEP;
356            statTotals_cabac[c]+=sCABAC;
357            statTotals_ep[c]+=sEP;
358          }
359          bHadClassifiedEntry=bHadClassifiedEntry||(c!=0);
360        }
361        if (bHadClassifiedEntry)
362        {
363          OutputLine(pName, '~', "~~ST~~", "~~ST~~", cabacSubTotal, epSubTotal);
364        }
365        if (i==STATS__NAL_UNIT_TOTAL_BODY)
366        {
367          OutputDashedLine("");
368        }
369      }
370      OutputDashedLine("");
371      OutputLine("CABAC Sub-total", '~', "~~ST~~", "~~ST~~", cabacTotalBits, epTotalBits);
372
373      OutputDashedLine("CAVLC HEADER BITS");
374      SStat cavlcTotalBits;
375      for(std::map<std::string, SStat>::iterator it=data.mappings_ep.begin(); it!=data.mappings_ep.end(); it++)
376      {
377        SStat s=it->second;
378        cavlcTotalBits+=s;
379        OutputLine(it->first.c_str(), ':', "-", "-", s);
380      }
381
382      OutputDashedLine("");
383      OutputLine("CAVLC Header Sub-total", '~', "~~ST~~", "~~ST~~", cavlcTotalBits);
384
385      // Now output the breakdowns
386      OutputDashedLine("CABAC Break down by size");
387      for(UInt s=0; s<CODING_STATS_NUM_WIDTHS; s++)
388      {
389        SStat subTotalCabac, subTotalEP;
390        for(UInt c=0; c<CODING_STATS_NUM_SUBCLASSES; c+=CODING_STATS_NUM_WIDTHS)
391        {
392          subTotalCabac+=statTotals_cabac[c+s];
393          subTotalEP+=statTotals_ep[c+s];
394        }
395        if (subTotalCabac.bits!=0 || subTotalEP.bits!=0)
396        {
397          OutputLine("CABAC by size Sub-total", '=', s, "All", subTotalCabac, subTotalEP);
398        }
399      }
400      OutputDashedLine("Break down by component/Channel type");
401      for(UInt c=0; c<CODING_STATS_NUM_SUBCLASSES; c+=CODING_STATS_NUM_WIDTHS)
402      {
403        SStat subTotalCabac, subTotalEP;
404        for(UInt s=0; s<CODING_STATS_NUM_WIDTHS; s++)
405        {
406          subTotalCabac+=statTotals_cabac[c+s];
407          subTotalEP+=statTotals_ep[c+s];
408        }
409        if (subTotalCabac.bits!=0 || subTotalEP.bits!=0)
410        {
411          OutputLine("CABAC by type Sub-total", '=', "-", TComCodingStatisticsClassType::GetSubClassString(c), subTotalCabac, subTotalEP);
412        }
413      }
414      OutputDashedLine("Break down by size and component/Channel type");
415      for(UInt c=0; c<CODING_STATS_NUM_SUBCLASSES; c+=CODING_STATS_NUM_WIDTHS)
416      {
417        for(UInt s=0; s<CODING_STATS_NUM_WIDTHS; s++)
418        {
419          SStat subTotalCabac, subTotalEP;
420          subTotalCabac+=statTotals_cabac[c+s];
421          subTotalEP+=statTotals_ep[c+s];
422          if (subTotalCabac.bits!=0 || subTotalEP.bits!=0)
423          {
424            OutputLine("CABAC by size and type Sub-total", '=', s, TComCodingStatisticsClassType::GetSubClassString(c), subTotalCabac, subTotalEP);
425          }
426        }
427      }
428
429      OutputDashedLine("");
430      OutputLine("CABAC Sub-total", '~', "~~ST~~", "~~ST~~", cabacTotalBits, epTotalBits);
431      OutputLine("CAVLC Header Sub-total", '~', "~~ST~~", "~~ST~~", cavlcTotalBits);
432      OutputDashedLine("GRAND TOTAL");
433      epTotalBits+=cavlcTotalBits;
434      OutputLine("TOTAL", '~', "~~GT~~", "~~GT~~", cabacTotalBits, epTotalBits);
435    }
436
437
438  public:
439    static TComCodingStatistics& GetSingletonInstance()
440    {
441      static TComCodingStatistics inst;
442      return inst;
443    }
444
445    static const TComCodingStatisticsData &GetStatistics()         { return GetSingletonInstance().data; }
446    static Void SetStatistics(const TComCodingStatisticsData &src) { GetSingletonInstance().data=src; }
447
448    static SStat &GetStatisticEP(const TComCodingStatisticsClassType &stat) { return GetSingletonInstance().data.statistics_ep[stat.type][stat.subClass]; }
449
450    static SStat &GetStatisticEP(const std::string &str) { return GetSingletonInstance().data.mappings_ep[str]; }
451
452    static SStat &GetStatisticEP(const Char *pKey) {return GetStatisticEP(std::string(pKey)); }
453
454    static Void IncrementStatisticEP(const TComCodingStatisticsClassType &stat, const Int numBits, const Int value)
455    {
456      SStat &s=GetStatisticEP(stat);
457      s.bits+=numBits;
458      s.count++;
459      s.sum+=value;
460    }
461
462    static Void IncrementStatisticEP(const std::string &str, const Int numBits, const Int value)
463    {
464      SStat &s=GetStatisticEP(str);
465      s.bits+=numBits;
466      s.count++;
467      s.sum+=value;
468    }
469
470    static Void IncrementStatisticEP(const Char *pKey, const Int numBits, const Int value)
471    {
472      SStat &s=GetStatisticEP(pKey);
473      s.bits+=numBits;
474      s.count++;
475      s.sum+=value;
476    }
477
478    StatLogValue values;
479
480    static Void UpdateCABACStat(const TComCodingStatisticsClassType &stat, UInt uiRangeBefore, UInt uiRangeAfter, Int val)
481    {
482      TComCodingStatistics &inst=GetSingletonInstance();
483      // doing rangeBefore*p(x)=rangeAfter
484      // p(x)=rangeAfter/rangeBefore
485      // entropy = -log2(p(x))=-log(p(x))/log(2) = -(log rangeAfter - log rangeBefore) / log(2) = (log rangeBefore / log 2 - log rangeAfter / log 2)
486      SStat &s=inst.data.statistics[stat.type][stat.subClass];
487      s.bits+=inst.values.values[uiRangeBefore]-inst.values.values[uiRangeAfter];
488      s.count++;
489      s.sum+=val;
490    }
491};
492
493#endif
Note: See TracBrowser for help on using the repository browser.