comparison avcodec.h @ 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 d322325fc00e
children 141badec76fc
comparison
equal deleted inserted replaced
9408:e74131a0652d 9409:e6ade5c8a750
3221 * buffer \p samples. To encode it, it makes use of the audio codec which was 3221 * buffer \p samples. To encode it, it makes use of the audio codec which was
3222 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is 3222 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
3223 * stored in output buffer \p buf. 3223 * stored in output buffer \p buf.
3224 * 3224 *
3225 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large. 3225 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
3226 * However, for PCM audio the user will know how much space is needed
3227 * because it depends on the value passed in \p buf_size as described
3228 * below. In that case a lower value can be used.
3226 * 3229 *
3227 * @param avctx the codec context 3230 * @param avctx the codec context
3228 * @param[out] buf the output buffer 3231 * @param[out] buf the output buffer
3229 * @param[in] buf_size the output buffer size 3232 * @param[in] buf_size the output buffer size
3230 * @param[in] samples the input buffer containing the samples 3233 * @param[in] samples the input buffer containing the samples