Clarify documentation for avcodec_encode_audio.
authorStefano Sabatini <stefano.sabatini-lala@poste.it>
Wed, 28 Nov 2007 12:41:35 +0000 (12:41 +0000)
committerDiego Biurrun <diego@biurrun.de>
Wed, 28 Nov 2007 12:41:35 +0000 (12:41 +0000)
patch by Stefano Sabatini, stefano.sabatini-lala poste it

Originally committed as revision 11108 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavcodec/avcodec.h

index 035728d..1c43ea4 100644 (file)
@@ -2674,8 +2674,10 @@ int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
  * @param[out] buf the output buffer
  * @param[in] buf_size the output buffer size
  * @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.
  * @return On error a negative value is returned, on succes zero or the number
- * of bytes used from the input buffer.
+ * of bytes used to encode the data read from the input buffer.
  */
 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
                          const short *samples);