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

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