# HG changeset patch
# User diego
# Date 1211843966 0
# Node ID be1b0a6ee19afdc4eb5427d6dcc8d5038747a7ba
# Parent  0f63fc62ea8b58b63fb22499c51630ddb08c0191
Clarify avcodec_encode_audio() vs. PCM audio.
patch by Stefano Sabatini, stefano.sabatini-lala poste it

diff -r 0f63fc62ea8b -r be1b0a6ee19a avcodec.h
--- a/avcodec.h	Mon May 26 23:14:25 2008 +0000
+++ b/avcodec.h	Mon May 26 23:19:26 2008 +0000
@@ -2750,6 +2750,8 @@
  * @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.
  */