source: 3DVCSoftware/branches/HTM-14.1-update-dev3/source/Lib/TLibCommon/TComCodingStatistics.h @ 1270

Last change on this file since 1270 was 1270, checked in by tech, 9 years ago

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