generic-library/ffmpeg
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

lavc: clarify docs for avpkt->destruct

Browse Source 
avcodec_encode_audio2 docs are ambiguous about avpkt->destruct and imply
it gets reset.

Signed-off-by: Michael Bradshaw <mbradshaw@sorensonmedia.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
This commit is contained in:
Michael Bradshaw 2012-06-27 12:19:00 -06:00 committed by Michael Niedermayer
parent b536e2facf
commit 54942c2383
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
libavcodec/avcodec.h
View File

@ -4053,11 +4053,12 @@ int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
* The user can supply an output buffer by setting
* avpkt->data and avpkt->size prior to calling the
* function, but if the size of the user-provided data is not
* large enough, encoding will fail. All other AVPacket fields
* will be reset by the encoder using av_init_packet(). If
* avpkt->data is NULL, the encoder will allocate it.
* The encoder will set avpkt->size to the size of the
* output packet.
* large enough, encoding will fail. If avpkt->data and
* avpkt->size are set, avpkt->destruct must also be set. All
* other AVPacket fields will be reset by the encoder using
* av_init_packet(). If avpkt->data is NULL, the encoder will
* allocate it. The encoder will set avpkt->size to the size
* of the output packet.
*
* If this function fails or produces no output, avpkt will be
* freed using av_free_packet() (i.e. avpkt->destruct will be