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.

Originally committed as revision 18449 to svn://svn.ffmpeg.org/ffmpeg/trunk

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index cb64d82..8edcc01 100644 (file)
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -3223,6 +3223,9 @@ int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
  * 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