aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames Almer <jamrial@gmail.com>2021-05-04 23:10:41 -0300
committerJames Almer <jamrial@gmail.com>2021-05-07 13:16:14 -0300
commit5b5398722ef96510e8f9419c49490c92449075ce (patch)
tree5a8bfd93b2601d944b41866324fb355cdc121645
parentf7987ce966aaad841d584988e00454c685bff36f (diff)
downloadffmpeg-5b5398722ef96510e8f9419c49490c92449075ce.tar.gz
avcodec: be more explicit about the buffer size in get_encode_buffer documentation
Signed-off-by: James Almer <jamrial@gmail.com>
-rw-r--r--libavcodec/avcodec.h4
1 files changed, 4 insertions, 0 deletions
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.