changeset 9409:e6ade5c8a750 libavcodec

Fix documentation for avcodec_encode_audio(), in the case of PCM audio the output buffer size may be less than FF_MIN_BUFFER_SIZE. Patch by John Fletcher john.surname AT rd . bbc . co . uk.
author stefano
date Sat, 11 Apr 2009 21:14:29 +0000
parents e74131a0652d
children f7bd7e90ef9f
files avcodec.h
diffstat 1 files changed, 3 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/avcodec.h	Sat Apr 11 21:04:26 2009 +0000
+++ b/avcodec.h	Sat Apr 11 21:14:29 2009 +0000
@@ -3223,6 +3223,9 @@
  * stored in output buffer \p buf.
  *
  * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
+ * However, for PCM audio the user will know how much space is needed
+ * because it depends on the value passed in \p buf_size as described
+ * below. In that case a lower value can be used.
  *
  * @param avctx the codec context
  * @param[out] buf the output buffer