source: 3DVCSoftware/branches/HTM-16.0-MV-draft-5/source/Lib/TLibCommon/TComCodingStatistics.h

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

Removed 3D.

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