summaryrefslogtreecommitdiff
path: root/libavformat/avformat.h
diff options
context:
space:
mode:
authorAndreas Rheinhardt <andreas.rheinhardt@gmail.com>2020-01-07 14:55:39 +0100
committerMichael Niedermayer <michael@niedermayer.cc>2020-01-14 23:00:35 +0100
commitb55c6b8c40e09a1a8076bbc8b4a804801bec530c (patch)
tree0f8591248400fceb0875a340d11e6a5ed843142e /libavformat/avformat.h
parent56a04b7c38e15b5a698ca15bc3e940f06777e315 (diff)
avformat/avformat: Update AVInputFormat.read_packet documentation
Since bae8844e351, the packet is automatically unreferenced in ff_read_packet() when an error is returned; but the documentation of this of AVInputFormat.read_packet has not been updated accordingly. Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com> Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
Diffstat (limited to 'libavformat/avformat.h')
-rw-r--r--libavformat/avformat.h3
1 files changed, 1 insertions, 2 deletions
diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index d4d9a3b06e..9b9b634ec3 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -715,8 +715,7 @@ typedef struct AVInputFormat {
* AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
* background thread).
* @return 0 on success, < 0 on error.
- * When returning an error, pkt must not have been allocated
- * or must be freed before returning
+ * Upon returning an error, pkt must be unreferenced by the caller.
*/
int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);