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>
This commit is contained in:
Andreas Rheinhardt
2019-12-01 08:45:05 +01:00
parent 3c138e5ceb
commit 4cb0dda555
2 changed files with 18 additions and 16 deletions

View File

@@ -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.