summaryrefslogtreecommitdiff
path: root/libavcodec
diff options
context:
space:
mode:
authorStefano Sabatini <stefano.sabatini-lala@poste.it>2008-05-26 23:19:26 +0000
committerDiego Biurrun <diego@biurrun.de>2008-05-26 23:19:26 +0000
commit5231f101d156bbc6000f0555cf80abc3d966a814 (patch)
tree6a75ffe27c9566c3a435c21f5c325c901eb9cf86 /libavcodec
parentf4433de9ef53b78397c58828e9bf84fb59160aed (diff)
Clarify avcodec_encode_audio() vs. PCM audio.
patch by Stefano Sabatini, stefano.sabatini-lala poste it Originally committed as revision 13445 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavcodec')
-rw-r--r--libavcodec/avcodec.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index e9d21321e7..6aa71ba011 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -2750,6 +2750,8 @@ int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
* @param[in] samples the input buffer containing the samples
* The number of samples read from this buffer is frame_size*channels,
* both of which are defined in \p avctx.
+ * For PCM audio the number of samples read from \p samples is equal to
+ * \p buf_size * input_sample_size / output_sample_size.
* @return On error a negative value is returned, on success zero or the number
* of bytes used to encode the data read from the input buffer.
*/