[FFmpeg-cvslog] avcodec: be more explicit about the buffer size in get_encode_buffer documentation

[James Almer]

ffmpeg | branch: master | James Almer <jamrial at gmail.com> | Tue May  4 23:10:41 2021 -0300| [5b5398722ef96510e8f9419c49490c92449075ce] | committer: James Almer

avcodec: be more explicit about the buffer size in get_encode_buffer documentation

Signed-off-by: James Almer <jamrial at gmail.com>

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

 libavcodec/avcodec.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 0ef1676daf..3cf131d0a5 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -2097,6 +2097,10 @@ typedef struct AVCodecContext {
      * This callback must use the above value to calculate the required buffer size,
      * which must padded by at least AV_INPUT_BUFFER_PADDING_SIZE bytes.
      *
+     * In some specific cases, the encoder may not use the entire buffer allocated by this
+     * callback. This will be reflected in the size value in the packet once returned by
+     * avcodec_receive_packet().
+     *
      * This callback must fill the following fields in the packet:
      * - data: alignment requirements for AVPacket apply, if any. Some architectures and
      *   encoders may benefit from having aligned data.