diff mbox series

[FFmpeg-devel,v2] avcodec: add a mention about get_encode_buffer in the old encode API doxy

Message ID 20210313133405.1034-1-jamrial@gmail.com
State Accepted
Commit 1af4885014f7d80abbd28613a2939fbcada94ecd
Headers show
Series [FFmpeg-devel,v2] avcodec: add a mention about get_encode_buffer in the old encode API doxy | expand

Checks

Context Check Description
andriy/x86_make success Make finished
andriy/x86_make_fate success Make fate finished
andriy/PPC64_make success Make finished
andriy/PPC64_make_fate success Make fate finished

Commit Message

James Almer March 13, 2021, 1:34 p.m. UTC
Direct users to the callback that should be used to keep supporting user
provided buffers with the new encode API.

Signed-off-by: James Almer <jamrial@gmail.com>
---
 libavcodec/avcodec.h | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

Comments

Anton Khirnov March 14, 2021, 11:09 a.m. UTC | #1
Quoting James Almer (2021-03-13 14:34:05)
> Direct users to the callback that should be used to keep supporting user
> provided buffers with the new encode API.
> 
> Signed-off-by: James Almer <jamrial@gmail.com>
> ---
>  libavcodec/avcodec.h | 8 ++++++--
>  1 file changed, 6 insertions(+), 2 deletions(-)

Looks ok
James Almer March 14, 2021, 4:38 p.m. UTC | #2
On 3/14/2021 8:09 AM, Anton Khirnov wrote:
> Quoting James Almer (2021-03-13 14:34:05)
>> Direct users to the callback that should be used to keep supporting user
>> provided buffers with the new encode API.
>>
>> Signed-off-by: James Almer <jamrial@gmail.com>
>> ---
>>   libavcodec/avcodec.h | 8 ++++++--
>>   1 file changed, 6 insertions(+), 2 deletions(-)
> 
> Looks ok

Applied, thanks.
diff mbox series

Patch

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index fbd4804160..8a71c04230 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -3680,7 +3680,9 @@  void av_parser_close(AVCodecParserContext *s);
  *                            not be used.
  * @return          0 on success, negative error code on failure
  *
- * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
+ * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead.
+ *             If allowed and required, set AVCodecContext.get_encode_buffer to
+ *             a custom function to pass user supplied output buffers.
  */
 attribute_deprecated
 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
@@ -3719,7 +3721,9 @@  int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
  *                            not be used.
  * @return          0 on success, negative error code on failure
  *
- * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
+ * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead.
+ *             If allowed and required, set AVCodecContext.get_encode_buffer to
+ *             a custom function to pass user supplied output buffers.
  */
 attribute_deprecated
 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,