diff options
| author | Gregory Maxwell <greg@xiph.org> | 2012-09-28 02:36:51 +0400 |
|---|---|---|
| committer | Gregory Maxwell <greg@xiph.org> | 2012-09-28 02:36:51 +0400 |
| commit | 9fec9bb39103a2e945b7099ad906c7fe9a9a8c3d (patch) | |
| tree | 9bd3a478a2fe1526737df54057e8b3114831da8c /include | |
| parent | ba28403a04c8911bd728bf09e57567cc6080f682 (diff) | |
Belabor OPUS_SET_BITRATE instead of max_packet, as this is a common trap.
Diffstat (limited to 'include')
| -rw-r--r-- | include/opus.h | 13 | ||||
| -rw-r--r-- | include/opus_multistream.h | 28 |
2 files changed, 24 insertions, 17 deletions
diff --git a/include/opus.h b/include/opus.h index cdd9677f..bb07a16a 100644 --- a/include/opus.h +++ b/include/opus.h @@ -136,7 +136,8 @@ extern "C" { * <li>audio_frame is the audio data in opus_int16 (or float for opus_encode_float())</li> * <li>frame_size is the duration of the frame in samples (per channel)</li> * <li>packet is the byte array to which the compressed data is written</li> - * <li>max_packet is the maximum number of bytes that can be written in the packet (4000 bytes is recommended)</li> + * <li>max_packet is the maximum number of bytes that can be written in the packet (4000 bytes is recommended). + * Do not use max_packet to control VBR target bitrate, instead use the #OPUS_SET_BITRATE CTL.</li> * </ul> * * opus_encode() and opus_encode_float() return the number of bytes actually written to the packet. @@ -252,9 +253,10 @@ OPUS_EXPORT int opus_encoder_init( * memory for the output * payload. This may be * used to impose an upper limit on - * the variable bitrate, but should + * the instant bitrate, but should * not be used as the only bitrate - * control. + * control. Use #OPUS_SET_BITRATE to + * control the bitrate. * @returns The length of the encoded packet (in bytes) on success or a * negative error code (see @ref opus_errorcodes) on failure. */ @@ -292,9 +294,10 @@ OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_encode( * memory for the output * payload. This may be * used to impose an upper limit on - * the variable bitrate, but should + * the instant bitrate, but should * not be used as the only bitrate - * control. + * control. Use #OPUS_SET_BITRATE to + * control the bitrate. * @returns The length of the encoded packet (in bytes) on success or a * negative error code (see @ref opus_errorcodes) on failure. */ diff --git a/include/opus_multistream.h b/include/opus_multistream.h index 2bf1dff7..bd816b45 100644 --- a/include/opus_multistream.h +++ b/include/opus_multistream.h @@ -335,12 +335,14 @@ OPUS_EXPORT int opus_multistream_encoder_init( * @param[out] data <tt>unsigned char*</tt>: Output payload. * This must contain storage for at * least \a max_data_bytes. - * @param max_data_bytes <tt>opus_int32</tt>: Size of the allocated memory for - * the output payload. This may be - * used to impose an upper limit on - * the variable bitrate, but should - * not be used as the only bitrate - * control. + * @param [in] max_data_bytes <tt>opus_int32</tt>: Size of the allocated + * memory for the output + * payload. This may be + * used to impose an upper limit on + * the instant bitrate, but should + * not be used as the only bitrate + * control. Use #OPUS_SET_BITRATE to + * control the bitrate. * @returns The length of the encoded packet (in bytes) on success or a * negative error code (see @ref opus_errorcodes) on failure. */ @@ -378,12 +380,14 @@ OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_multistream_encode( * @param[out] data <tt>unsigned char*</tt>: Output payload. * This must contain storage for at * least \a max_data_bytes. - * @param max_data_bytes <tt>opus_int32</tt>: Size of the allocated memory for - * the output payload. This may be - * used to impose an upper limit on - * the variable bitrate, but should - * not be used as the only bitrate - * control. + * @param [in] max_data_bytes <tt>opus_int32</tt>: Size of the allocated + * memory for the output + * payload. This may be + * used to impose an upper limit on + * the instant bitrate, but should + * not be used as the only bitrate + * control. Use #OPUS_SET_BITRATE to + * control the bitrate. * @returns The length of the encoded packet (in bytes) on success or a * negative error code (see @ref opus_errorcodes) on failure. */ |