[FFmpeg-cvslog] r18449 - trunk/libavcodec/avcodec.h

[stefano]

Author: stefano
Date: Sat Apr 11 23:14:29 2009
New Revision: 18449

Log:
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.

Modified:
   trunk/libavcodec/avcodec.h

Modified: trunk/libavcodec/avcodec.h
==============================================================================
--- trunk/libavcodec/avcodec.h	Sat Apr 11 23:04:26 2009	(r18448)
+++ trunk/libavcodec/avcodec.h	Sat Apr 11 23:14:29 2009	(r18449)
@@ -3223,6 +3223,9 @@ int avcodec_parse_frame(AVCodecContext *
  * 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