diff options
| author | Michael Bradshaw <mbradshaw@sorensonmedia.com> | 2012-06-27 12:19:00 -0600 |
|---|---|---|
| committer | Michael Niedermayer <michaelni@gmx.at> | 2012-06-27 22:29:54 +0200 |
| commit | 54942c238356f1e4c6fcce04b67f216dafd819c5 (patch) | |
| tree | 57d9cb83dbea138059a22abe50fbf777385c4098 /libavcodec/avcodec.h | |
| parent | b536e2facfa0872adeb6aaae4189f9b90d907e36 (diff) | |
| download | ffmpeg-54942c238356f1e4c6fcce04b67f216dafd819c5.tar.gz | |
lavc: clarify docs for avpkt->destruct
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>
Diffstat (limited to 'libavcodec/avcodec.h')
| -rw-r--r-- | libavcodec/avcodec.h | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h index 21a0ed90eb..625bdc613c 100644 --- a/libavcodec/avcodec.h +++ b/libavcodec/avcodec.h @@ -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 |