summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Fletcher <john.fletcher@rd.bbc.co.uk>2009-04-11 21:14:29 +0000
committerStefano Sabatini <stefano.sabatini-lala@poste.it>2009-04-11 21:14:29 +0000
commitdae2434928bf0f86817740e276b297d86d112c4f (patch)
tree43e5f36b866a90e5c0564043789a87293ac99316
parent4af615b81e99cc3897c4106b71d28ccc617b2391 (diff)
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
-rw-r--r--libavcodec/avcodec.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index cb64d82f93..8edcc01340 100644
--- 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