README

   1 **********************************************************************
   2  libaec - Adaptive Entropy Coding library
   3 **********************************************************************
   4
   5 Libaec provides fast lossless compression of 1 up to 32 bit wide
   6 signed or unsigned integers (samples). The library achieves best
   7 results for low entropy data as often encountered in space imaging
   8 instrument data or numerical model output from weather or climate
   9 simulations. While floating point representations are not directly
  10 supported, they can also be efficiently coded by grouping exponents
  11 and mantissa.
  12
  13 Libaec implements Golomb Rice coding as defined in the Space Data
  14 System Standard documents 121.0-B-2 [1] and 120.0-G-2[2].
  15
  16
  17 **********************************************************************
  18  Patents
  19 **********************************************************************
  20
  21 In doc/license.txt a clarification on potentially applying
  22 intellectual property rights is given.
  23
  24
  25 **********************************************************************
  26  Installation
  27 **********************************************************************
  28
  29 See INSTALL for details.
  30
  31
  32 **********************************************************************
  33  Encoding
  34 **********************************************************************
  35
  36 In this context efficiency refers to the size of the encoded
  37 data. Performance refers to the time it takes to encode data.
  38
  39 Suppose you have an array of 32 bit signed integers you want to
  40 compress. The pointer pointing to the data shall be called *source,
  41 output goes into *dest.
  42
  43 #include <libaec.h>
  44
  45 ...
  46     struct aec_stream strm;
  47     int32_t *source;
  48     unsigned char *dest;
  49
  50     /* input data is 32 bits wide */
  51     strm.bits_per_sample = 32;
  52
  53     /* define a block size of 16 */
  54     strm.block_size = 16;
  55
  56     /* the reference sample interval is set to 128 blocks */
  57     strm.rsi = 128;
  58
  59     /* input data is signed and needs to be preprocessed */
  60     strm.flags = AEC_DATA_SIGNED | AEC_DATA_PREPROCESS;
  61
  62     /* pointer to input */
  63     strm.next_in = (unsigned char *)source;
  64
  65     /* length of input in bytes */
  66     strm.avail_in = source_length * sizeof(int32_t);
  67
  68     /* pointer to output buffer */
  69     strm.next_out = dest;
  70
  71     /* length of output buffer in bytes */
  72     strm.avail_out = dest_length;
  73
  74     /* initialize encoding */
  75     if (aec_encode_init(&strm) != AEC_OK)
  76         return 1;
  77
  78     /* Perform encoding in one call and flush output. */
  79     /* In this example you must be sure that the output */
  80     /* buffer is large enough for all compressed output */
  81     if (aec_encode(&strm, AEC_FLUSH) != AEC_OK)
  82         return 1;
  83
  84     /* free all resources used by encoder */
  85     aec_encode_end(&strm);
  86 ...
  87
  88 block_size can vary from 8 to 64 samples. Smaller blocks allow the
  89 compression to adapt to rapid changes in entropy. Larger blocks create
  90 less overhead but can be less efficient if entropy changes across the
  91 block.
  92
  93 rsi sets the reference sample interval. A large RSI will improve
  94 performance and efficiency. It will also increase memory requirements
  95 since internal buffering is based on RSI size. A smaller RSI may be
  96 desirable in situations where each RSI will be packetized and possible
  97 error propagation has to be minimized (e.g. on board a spacecraft[2]).
  98
  99 Flags:
 100
 101 AEC_DATA_SIGNED: input data are signed integers. Specifying this
 102 correctly increases compression efficiency. Default is unsigned.
 103
 104 AEC_DATA_PREPROCESS: preprocessing input will improve compression
 105 efficiency if data samples are correlated. It will only cost
 106 performance for no gain in efficiency if the data is already
 107 uncorrelated.
 108
 109 AEC_DATA_MSB: input data is stored most significant byte first
 110 i.e. big endian. You have to specify AEC_DATA_MSB even if your host
 111 architecture is big endian. Default is little endian on all
 112 architectures.
 113
 114 AEC_DATA_3BYTE: the 24 bit input data is stored in three bytes.
 115
 116 AEC_DATA_RESTRICT: use a restricted set of code options.
 117
 118 Data size:
 119
 120 Except for the AEC_DATA_3BYTE case for 24 bit data, the following
 121 rules apply for deducing storage size from sample size
 122 (bits_per_sample):
 123
 124 sample size   storage size
 125  1 -  8 bits  1 byte
 126  9 - 16 bits  2 bytes
 127 17 - 32 bits  4 bytes (also for 24bit if AEC_DATA_3BYTE is not set)
 128
 129 If a sample requires less bits than the storage size provides, then
 130 you have to make sure that unused bits are not set. Libaec does not
 131 check this for performance reasons and will produce undefined output
 132 if unused bits are set. All input data must be a multiple of the
 133 storage size in bytes. Remaining bytes which do not form a complete
 134 sample will be ignored.
 135
 136 Libaec accesses next_in and next_out buffers only bytewise. There are
 137 no alignment requirements for these buffers.
 138
 139 Flushing:
 140
 141 aec_encode can be used in a streaming fashion by chunking input and
 142 output and specifying AEC_NO_FLUSH. The function will return if either
 143 the input runs empty or the output buffer is full. The calling
 144 function can check avail_in and avail_out to see what occcurred. The
 145 last call to aec_encode() must set AEC_FLUSH to drain all
 146 output. aec.c is an example of streaming usage of encoding and
 147 decoding.
 148
 149 Output:
 150
 151 Encoded data will be written to the buffer submitted with
 152 next_out. The length of the compressed data is total_out.
 153
 154 See libaec.h for a detailed description of all relevant structure
 155 members and constants.
 156
 157
 158 **********************************************************************
 159  Decoding
 160 **********************************************************************
 161
 162 Using decoding is very similar to encoding, only the meaning of input
 163 and output is reversed.
 164
 165 #include <libaec.h>
 166
 167 ...
 168     struct aec_stream strm;
 169     /* this is now the compressed data */
 170     unsigned char *source;
 171     /* here goes the uncompressed result */
 172     int32_t *dest;
 173
 174     strm.bits_per_sample = 32;
 175     strm.block_size = 16;
 176     strm.rsi = 128;
 177     strm.flags = AEC_DATA_SIGNED | AEC_DATA_PREPROCESS;
 178     strm.next_in = source;
 179     strm.avail_in = source_length;
 180     strm.next_out = (unsigned char *)dest;
 181     strm.avail_out = dest_lenth * sizeof(int32_t);
 182     if (aec_decode_init(&strm) != AEC_OK)
 183         return 1;
 184     if (aec_decode(&strm, AEC_FLUSH) != AEC_OK)
 185         return 1;
 186     aec_decode_end(&strm);
 187 ...
 188
 189 It is essential for decoding that parameters like bits_per_sample,
 190 block_size, rsi, and flags are exactly the same as they were for
 191 encoding. Libaec does not store these parameters in the coded stream
 192 so it is up to the calling program to keep the correct parameters
 193 between encoding and decoding.
 194
 195 The actual values of coding parameters are in fact only relevant for
 196 efficiency and performance. Data integrity only depends on consistency
 197 of the parameters.
 198
 199
 200 **********************************************************************
 201  References
 202 **********************************************************************
 203
 204 [1] Consultative Committee for Space Data Systems. Lossless Data
 205 Compression. Recommendation for Space Data System Standards, CCSDS
 206 121.0-B-2. Blue Book. Issue 2. Washington, D.C.: CCSDS, May 2012.
 207 http://public.ccsds.org/publications/archive/121x0b2.pdf
 208
 209 [2] Consultative Committee for Space Data Systems. Lossless Data
 210 Compression.  Recommendation for Space Data System Standards, CCSDS
 211 120.0-G-2. Green Book. Issue 2. Washington, D.C.: CCSDS, December
 212 2006.
 213 http://public.ccsds.org/publications/archive/120x0g2s.pdf