[FFmpeg-cvslog] avcodec: document the use of AVCodecContext.delay for audio encoders

[Justin Ruggles]

ffmpeg | branch: master | Justin Ruggles <justin.ruggles at gmail.com> | Mon Feb 20 16:52:27 2012 -0500| [7600e5c5aa1d48c781f1ed363b754c3a0a631eb7] | committer: Justin Ruggles

avcodec: document the use of AVCodecContext.delay for audio encoders

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=7600e5c5aa1d48c781f1ed363b754c3a0a631eb7
---

 libavcodec/avcodec.h |   16 ++++++++++++++--
 1 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 7128a83..d1df5b4 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -1315,8 +1315,20 @@ typedef struct AVCodecContext {
     int frame_number;   ///< audio or video frame number
 
     /**
-     * Number of frames the decoded output will be delayed relative to
-     * the encoded input.
+     * Encoder delay.
+     *
+     * Video:
+     *   Number of frames the decoded output will be delayed relative to the
+     *   encoded input.
+     *
+     * Audio:
+     *   Number of "priming" samples added to the beginning of the stream
+     *   during encoding. The decoded output will be delayed by this many
+     *   samples relative to the input to the encoder. Note that this field is
+     *   purely informational and does not directly affect the pts output by
+     *   the encoder, which should always be based on the actual presentation
+     *   time, including any delay.
+     *
      * - encoding: Set by libavcodec.
      * - decoding: unused
      */