diff options
| author | Timothy B. Terriberry <tterribe@xiph.org> | 2015-06-23 11:41:11 -0700 |
|---|---|---|
| committer | Timothy B. Terriberry <tterribe@xiph.org> | 2015-06-23 11:41:11 -0700 |
| commit | 25c2f620b6de0f47a9d7e6e7859c035b31031122 (patch) | |
| tree | 5fe4d5a5b191b1cf3bc4f0c2c1b8f6d71ebbcfa7 | |
| parent | 3bd0231be14b77ab83f3afe2785f82338a1418b8 (diff) | |
| download | opus-25c2f620b6de0f47a9d7e6e7859c035b31031122.tar.gz | |
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.
| -rw-r--r-- | include/opus_defines.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/include/opus_defines.h b/include/opus_defines.h index 41e81f08..10ff838d 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). |