docs update

7128dc5c · Mathis Rosenhauer · 63bcbe00 · 7128dc5c · 7128dc5c · 7128dc5c
Commit 7128dc5c authored Feb 11, 2014 by Mathis Rosenhauer
Hide whitespace changes
Inline Side-by-side

Showing with 11 additions and 5 deletions

README README +7 -1

src/decode.c src/decode.c +1 -1

src/decode.h src/decode.h +1 -1

src/encode.c src/encode.c +1 -1

src/encode.h src/encode.h +1 -1

No files found.
--- a/README
+++ b/README
@@ -113,7 +113,13 @@ architectures.

 AEC_DATA_3BYTE: the 24 bit input data is stored in three bytes.

-AEC_DATA_RESTRICT: use a restricted set of code options.
+AEC_RESTRICTED: use a restricted set of code options. This option is
+only valid for bits_per_sample <= 4.
+
+AEC_PAD_RSI: assume that the encoded RSI is padded to the next byte
+boundary while decoding. The preprocessor macro ENABLE_RSI_PADDING
+needs to be defined while compiling for the encoder to honour this
+flag.

 Data size:


--- a/src/decode.c
+++ b/src/decode.c
@@ -47,7 +47,7 @@
 * @section DESCRIPTION
 *
 * Adaptive Entropy Decoder
- * Based on CCSDS documents 121.0-B-2 and 120.0-G-2
+ * Based on CCSDS documents 121.0-B-2 and 120.0-G-3
 *
 */


--- a/src/decode.h
+++ b/src/decode.h
@@ -47,7 +47,7 @@
 * @section DESCRIPTION
 *
 * Adaptive Entropy Decoder
- * Based on CCSDS documents 121.0-B-2 and 120.0-G-2
+ * Based on CCSDS documents 121.0-B-2 and 120.0-G-3
 *
 */


--- a/src/encode.c
+++ b/src/encode.c
@@ -47,7 +47,7 @@
 * @section DESCRIPTION
 *
 * Adaptive Entropy Encoder
- * Based on CCSDS documents 121.0-B-2 and 120.0-G-2
+ * Based on CCSDS documents 121.0-B-2 and 120.0-G-3
 *
 */


--- a/src/encode.h
+++ b/src/encode.h
@@ -47,7 +47,7 @@
 * @section DESCRIPTION
 *
 * Adaptive Entropy Encoder
- * Based on CCSDS documents 121.0-B-2 and 120.0-G-2
+ * Based on CCSDS documents 121.0-B-2 and 120.0-G-3
 *
 */