summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAndreas Rheinhardt <andreas.rheinhardt@gmail.com>2019-12-01 08:45:05 +0100
committerAndreas Rheinhardt <andreas.rheinhardt@gmail.com>2020-03-29 03:58:30 +0200
commit4cb0dda55537fe5248d8b1e255e7015805ea0f8f (patch)
tree81c868fde1d2079a7de98b7c76cfc8b39e1fd546 /doc
parent3c138e5ceb487490f88015b1694ce34c1393736c (diff)
downloadffmpeg-4cb0dda55537fe5248d8b1e255e7015805ea0f8f.tar.gz
avformat/avformat: Update av_read_frame() documentation
This commit updates the documentation of av_read_frame() to match its actual behaviour in several ways: 1. On success, av_read_frame() always returns refcounted packets. 2. It can handle uninitialized packets. 3. On error, it always returns blank packets. This will allow callers to not initialize or unref unnecessarily. Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/APIchanges4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/APIchanges b/doc/APIchanges
index f2bb2d242b..f1d7eac2ee 100644
--- a/doc/APIchanges
+++ b/doc/APIchanges
@@ -15,6 +15,10 @@ libavutil: 2017-10-21
API changes, most recent first:
+2020-03-29 - xxxxxxxxxx - lavf 58.42.100 - avformat.h
+ av_read_frame() now guarantees to handle uninitialized input packets
+ and to return refcounted packets on success.
+
2020-03-27 - xxxxxxxxxx - lavc 58.77.100 - avcodec.h
av_packet_ref() now guarantees to return the destination packet
in a blank state on error.