From 25c2f620b6de0f47a9d7e6e7859c035b31031122 Mon Sep 17 00:00:00 2001
From: "Timothy B. Terriberry" <tterribe@xiph.org>
Date: Tue, 23 Jun 2015 11:41:11 -0700
Subject: [PATCH] Improve OPUS_GET_LSB_DEPTH documentation.
We use at most 16 when using fixed-point (for the API or the
internal implementation), but we didn't tell anyone this.
---
include/opus_defines.h | 3 +++
1 file changed, 3 insertions(+)
diff --git a/include/opus_defines.h b/include/opus_defines.h
index 41e81f084..10ff838d1 100644
--- a/include/opus_defines.h
+++ b/include/opus_defines.h
@@ -525,6 +525,9 @@ extern "C" {
#define OPUS_GET_DTX(x) OPUS_GET_DTX_REQUEST, __opus_check_int_ptr(x)
/** Configures the depth of signal being encoded.
* This is a hint which helps the encoder identify silence and near-silence.
+ * When using opus_encode() * instead of opus_encode_float(), or when libopus
+ * is compiled for fixed-point, the encoder uses the minimum of the value
+ * set here and the value 16.
* @see OPUS_GET_LSB_DEPTH
* @param[in] x <tt>opus_int32</tt>: Input precision in bits, between 8 and 24
* (default: 24).
--
GitLab