summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMathis Rosenhauer <rosenhauer@dkrz.de>2016-01-18 09:41:25 +0100
committerMathis Rosenhauer <rosenhauer@dkrz.de>2016-01-18 09:41:25 +0100
commit5701ff83f5d5e6085ce2ac05d7083cd08f09876f (patch)
tree903b39b800dad83e495763bfadccca9b878a7d0d /README
parent52427266b94da18a78ffa0cab1fac810e009eb98 (diff)
downloadlibaec-5701ff83f5d5e6085ce2ac05d7083cd08f09876f.tar.gz
libaec-5701ff83f5d5e6085ce2ac05d7083cd08f09876f.tar.bz2
libaec-5701ff83f5d5e6085ce2ac05d7083cd08f09876f.zip
Wording.
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 8 insertions, 8 deletions
diff --git a/README b/README
index c13755b..4ecae6f 100644
--- a/README
+++ b/README
@@ -124,15 +124,15 @@ flag.
Data size:
-Except for the AEC_DATA_3BYTE case for 17 to 24 bit data, the
-following rules apply for deducing storage size from sample size
+The following rules apply for deducing storage size from sample size
(bits_per_sample):
sample size storage size
1 - 8 bits 1 byte
9 - 16 bits 2 bytes
-17 - 32 bits 4 bytes (also for 17 to 24 bits if AEC_DATA_3BYTE is
- not set)
+17 - 24 bits 3 bytes (only if AEC_DATA_3BYTE is set)
+25 - 32 bits 4 bytes (if AEC_DATA_3BYTE is set)
+17 - 32 bits 4 bytes (if AEC_DATA_3BYTE is not set)
If a sample requires less bits than the storage size provides, then
you have to make sure that unused bits are not set. Libaec does not
@@ -194,10 +194,10 @@ and output is reversed.
aec_decode_end(&strm);
...
-The size of the output buffer (next_out) should be a multiple of the
-storage size in bytes. If the buffer is not a multiple of the storage
-size and the buffer would be filled to the last sample, the error code
-AEC_MEM_ERROR is returned.
+It is strongly recommended that the size of the output buffer
+(next_out) is a multiple of the storage size in bytes. If the buffer
+is not a multiple of the storage size and the buffer gets filled to
+the last sample, the error code AEC_MEM_ERROR is returned.
It is essential for decoding that parameters like bits_per_sample,
block_size, rsi, and flags are exactly the same as they were for