src/stats1b.h

   1 /* stats1b.h -- statistics for the the LZO library
   2
   3    This file is part of the LZO real-time data compression library.
   4
   5    Copyright (C) 2008 Markus Franz Xaver Johannes Oberhumer
   6    Copyright (C) 2007 Markus Franz Xaver Johannes Oberhumer
   7    Copyright (C) 2006 Markus Franz Xaver Johannes Oberhumer
   8    Copyright (C) 2005 Markus Franz Xaver Johannes Oberhumer
   9    Copyright (C) 2004 Markus Franz Xaver Johannes Oberhumer
  10    Copyright (C) 2003 Markus Franz Xaver Johannes Oberhumer
  11    Copyright (C) 2002 Markus Franz Xaver Johannes Oberhumer
  12    Copyright (C) 2001 Markus Franz Xaver Johannes Oberhumer
  13    Copyright (C) 2000 Markus Franz Xaver Johannes Oberhumer
  14    Copyright (C) 1999 Markus Franz Xaver Johannes Oberhumer
  15    Copyright (C) 1998 Markus Franz Xaver Johannes Oberhumer
  16    Copyright (C) 1997 Markus Franz Xaver Johannes Oberhumer
  17    Copyright (C) 1996 Markus Franz Xaver Johannes Oberhumer
  18    All Rights Reserved.
  19
  20    The LZO library is free software; you can redistribute it and/or
  21    modify it under the terms of the GNU General Public License as
  22    published by the Free Software Foundation; either version 2 of
  23    the License, or (at your option) any later version.
  24
  25    The LZO library is distributed in the hope that it will be useful,
  26    but WITHOUT ANY WARRANTY; without even the implied warranty of
  27    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28    GNU General Public License for more details.
  29
  30    You should have received a copy of the GNU General Public License
  31    along with the LZO library; see the file COPYING.
  32    If not, write to the Free Software Foundation, Inc.,
  33    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  34
  35    Markus F.X.J. Oberhumer
  36    <markus@oberhumer.com>
  37    http://www.oberhumer.com/opensource/lzo/
  38  */
  39
  40
  41 /* WARNING: this file should *not* be used by applications. It is
  42    part of the implementation of the library and is subject
  43    to change.
  44  */
  45
  46
  47 #ifndef __LZO_STATS1B_H
  48 #define __LZO_STATS1B_H
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54
  55 /***********************************************************************
  56 // Collect statistical information when compressing.
  57 // Useful for finetuning the compression algorithm.
  58 // Examine the symbol 'lzo1b_stats' with a debugger.
  59 ************************************************************************/
  60
  61 #if defined(LZO_COLLECT_STATS)
  62 #  define LZO_STATS(expr)   expr
  63 #else
  64 #  define LZO_STATS(expr)   ((void) 0)
  65 #endif
  66
  67
  68 #if defined(LZO_COLLECT_STATS)
  69
  70 typedef struct
  71 {
  72 /* algorithm configuration */
  73     unsigned r_bits;
  74     unsigned m3o_bits;
  75     unsigned dd_bits;
  76     unsigned clevel;
  77
  78 /* internal configuration */
  79     unsigned d_bits;
  80     long min_lookahead;
  81     long max_lookbehind;
  82     const char *compress_id;
  83
  84 /* counts */
  85     long lit_runs;
  86     long r0short_runs;
  87     long r0fast_runs;
  88     long r0long_runs;
  89     long m1_matches;
  90     long m2_matches;
  91     long m3_matches;
  92     long m4_matches;
  93     long r1_matches;
  94
  95 /* */
  96     long lit_run[R0MIN];
  97     long m2_match[M2_MAX_LEN + 1];
  98     long m3_match[M3_MAX_LEN + 1];
  99 #if (M3O_BITS < 8)
 100     long lit_runs_after_m3_match;
 101     long lit_run_after_m3_match[LZO_SIZE(8-M3O_BITS)];
 102 #endif
 103
 104 /* */
 105     long matches;
 106     long match_bytes;
 107     long literals;
 108     long literal_overhead;
 109     long literal_bytes;
 110     double literal_overhead_percent;
 111
 112 /* */
 113     long unused_dict_entries;
 114     double unused_dict_entries_percent;
 115
 116 /* */
 117     long in_len;
 118     long out_len;
 119 }
 120 lzo1b_stats_t;
 121
 122
 123 void _lzo1b_stats_init(lzo1b_stats_t *lzo_stats);
 124 void _lzo1b_stats_calc(lzo1b_stats_t *lzo_stats);
 125
 126 extern lzo1b_stats_t * const lzo1b_stats;
 127
 128 #define lzo_stats_t     lzo1b_stats_t
 129 #define lzo_stats       lzo1b_stats
 130
 131 #endif
 132
 133
 134 #ifdef __cplusplus
 135 } /* extern "C" */
 136 #endif
 137
 138 #endif /* already included */
 139
 140 /*
 141 vi:ts=4:et
 142 */