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
This commit is contained in:
John Fletcher 2009-04-11 21:14:29 +00:00 committed by Stefano Sabatini
parent 4af615b81e
commit dae2434928
1 changed files with 3 additions and 0 deletions

View File

@ -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