From ba2fb3d35bedffdf78b45a7ac45ea738dff9f0f8 Mon Sep 17 00:00:00 2001
From: Mathis Rosenhauer <rosenhauer@dkrz.de>
Date: Thu, 28 Jul 2022 16:30:14 +0200
Subject: [PATCH] docs: mention upper limit for total_out

---
 README.md | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index ebabe42..782310e 100644
--- a/README.md
+++ b/README.md
@@ -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
 compression to adapt more rapidly to changing source
 statistics. Larger blocks create less overhead but can be less
@@ -160,8 +163,13 @@ decoding.
 Encoded data will be written to the buffer submitted with
 `next_out`. The length of the compressed data is `total_out`.
 
-See libaec.h for a detailed description of all relevant structure
-members and constants.
+In rare cases, like for random data, `total_out` can be larger than
+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
-- 
GitLab