summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorRalph Giles <giles@mozilla.com>2014-12-20 12:37:48 -0800
committerRalph Giles <giles@mozilla.com>2014-12-20 12:37:48 -0800
commit5b712da9c2faa51ebf3336161138b2d2fa54a47d (patch)
tree916353afacb0c6345a074e48beaa9302eb88eff6 /include
parent7424bb0a247c0692327001addb036f6e2313e970 (diff)
downloadopus-5b712da9c2faa51ebf3336161138b2d2fa54a47d.tar.gz
Document the motivation for the 120 ms repacketizer limit.
See the mailing list discussion at http://lists.xiph.org/pipermail/opus/2014-December/002802.html
Diffstat (limited to 'include')
-rw-r--r--include/opus.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/include/opus.h b/include/opus.h
index 93a53a2f..b0bdf6f2 100644
--- a/include/opus.h
+++ b/include/opus.h
@@ -616,7 +616,10 @@ OPUS_EXPORT void opus_pcm_soft_clip(float *pcm, int frame_size, int channels, fl
* merged. Splitting valid Opus packets is always guaranteed to succeed,
* whereas merging valid packets only succeeds if all frames have the same
* mode, bandwidth, and frame size, and when the total duration of the merged
- * packet is no more than 120 ms.
+ * packet is no more than 120 ms. The 120 ms limit comes from the
+ * specification and limits decoder memory requirements at a point where
+ * framing overhead becomes negligible.
+ *
* The repacketizer currently only operates on elementary Opus
* streams. It will not manipualte multistream packets successfully, except in
* the degenerate case where they consist of data from a single stream.