Skip to content
Snippets Groups Projects
Commit ba2fb3d3 authored by Mathis Rosenhauer's avatar Mathis Rosenhauer
Browse files

docs: mention upper limit for total_out

parent 9ea83102
No related branches found
Tags v1.0.2
1 merge request!1Resolve "Documentation update about maximum compressed size"
...@@ -91,6 +91,9 @@ output goes into `dest`. ...@@ -91,6 +91,9 @@ output goes into `dest`.
... ...
``` ```
See [libaec.h](include/libaec.h) for a detailed description of all
relevant structure members and constants.
`block_size` can vary from 8 to 64 samples. Smaller blocks allow the `block_size` can vary from 8 to 64 samples. Smaller blocks allow the
compression to adapt more rapidly to changing source compression to adapt more rapidly to changing source
statistics. Larger blocks create less overhead but can be less statistics. Larger blocks create less overhead but can be less
...@@ -160,8 +163,13 @@ decoding. ...@@ -160,8 +163,13 @@ decoding.
Encoded data will be written to the buffer submitted with Encoded data will be written to the buffer submitted with
`next_out`. The length of the compressed data is `total_out`. `next_out`. The length of the compressed data is `total_out`.
See libaec.h for a detailed description of all relevant structure In rare cases, like for random data, `total_out` can be larger than
members and constants. the size of the input data `total_in`. The following should hold true
even for pathological cases.
```
total_out <= total_in * 67 / 64 + 256
```
## Decoding ## Decoding
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment