From 4faf628f2015b7c04510d39a99a2c52f11b765f3 Mon Sep 17 00:00:00 2001 From: Michael Niedermayer Date: Tue, 14 Sep 2010 22:20:46 +0000 Subject: Clarify what av_read_frame() returns. Originally committed as revision 25123 to svn://svn.ffmpeg.org/ffmpeg/trunk --- libavformat/avformat.h | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'libavformat/avformat.h') diff --git a/libavformat/avformat.h b/libavformat/avformat.h index ed9dfb36ce..0520530323 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -1088,6 +1088,11 @@ int av_read_packet(AVFormatContext *s, AVPacket *pkt); /** * Return the next frame of a stream. + * This function returns what is stored in the file, and does not validate + * that what is there are valid frames for the decoder. It will split what is + * stored in the file into frames and return one for each call. It will not + * omit invalid data between valid frames so as to give the decoder the maximum + * information possible for decoding. * * The returned packet is valid * until the next av_read_frame() or until av_close_input_file() and -- cgit v1.2.3