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 document 121.0-B-2 [1], [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 Data size:
 117
 118 Except for the AEC_DATA_3BYTE case for 24 bit data, the following
 119 rules apply for deducing storage size from sample size
 120 (bits_per_sample):
 121
 122 sample size   storage size
 123  1 -  8 bit   1 byte
 124  9 - 16 bit   2 bytes
 125 17 - 32 bit   4 bytes (also for 24bit if AEC_DATA_3BYTE is not set)
 126
 127 If you use less bits than the storage size provides, then you have to
 128 make sure that unused bits are not set. Libaec does not check this for
 129 performance reasons and will produce undefined output if unused bits
 130 are set.
 131
 132 Libaec accesses next_in and next_out buffers only bytewise. There are
 133 no alignment requirements for these buffers.
 134
 135 Flushing:
 136
 137 aec_encode can be used in a streaming fashion by chunking input and
 138 output and specifying AEC_NO_FLUSH. The function will return if either
 139 the input runs empty or the output buffer is full. The calling
 140 function can check avail_in and avail_out to see what occcurred. The
 141 last call to aec_encode() must set AEC_FLUSH to drain all
 142 output. aec.c is an example of streaming usage of encoding and
 143 decoding.
 144
 145 Output:
 146
 147 Encoded data will be written to the buffer submitted with
 148 next_out. The length of the compressed data is total_out.
 149
 150 See libaec.h for a detailed description of all relevant structure
 151 members and constants.
 152
 153
 154 **********************************************************************
 155  Decoding
 156 **********************************************************************
 157
 158 Using decoding is very similar to encoding, only the meaning of input
 159 and output is reversed.
 160
 161 #include <libaec.h>
 162
 163 ...
 164     struct aec_stream strm;
 165     /* this is now the compressed data */
 166     unsigned char *source;
 167     /* here goes the uncompressed result */
 168     int32_t *dest;
 169
 170     strm.bits_per_sample = 32;
 171     strm.block_size = 16;
 172     strm.rsi = 128;
 173     strm.flags = AEC_DATA_SIGNED | AEC_DATA_PREPROCESS;
 174     strm.next_in = source;
 175     strm.avail_in = source_length;
 176     strm.next_out = (unsigned char *)dest;
 177     strm.avail_out = dest_lenth * sizeof(int32_t);
 178     if (aec_decode_init(&strm) != AEC_OK)
 179         return 1;
 180     if (aec_decode(&strm, AEC_FLUSH) != AEC_OK)
 181         return 1;
 182     aec_decode_end(&strm);
 183 ...
 184
 185 It is essential for decoding that parameters like bits_per_sample,
 186 block_size, rsi, and flags are exactly the same as they were for
 187 encoding. Libaec does not store these parameters in the coded stream
 188 so it is up to the calling program to keep the correct parameters
 189 between encoding and decoding.
 190
 191 The actual values of coding parameters are in fact only relevant for
 192 efficiency and performance. Data integrity only depends on consistency
 193 of the parameters.
 194
 195
 196 **********************************************************************
 197  References
 198 **********************************************************************
 199
 200 [1] Consultative Committee for Space Data Systems. Lossless Data
 201 Compression. Recommendation for Space Data System Standards, CCSDS
 202 121.0-B-2. Blue Book. Issue 2. Washington, D.C.: CCSDS, May 2012.
 203 http://public.ccsds.org/publications/archive/121x0b2.pdf
 204
 205 [2] Consultative Committee for Space Data Systems. Lossless Data
 206 Compression.  Recommendation for Space Data System Standards, CCSDS
 207 120.0-G-2. Green Book. Issue 2. Washington, D.C.: CCSDS, December
 208 2006.
 209 http://public.ccsds.org/publications/archive/120x0g2.pdf